blob: b23fc1df15829a790ba577e8cda16d2dc1aa90ab [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
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +010030#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Andrzej Kurekeb342242019-01-29 09:14:33 -050031#include "psa/crypto.h"
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +010032#include "mbedtls/psa_util.h"
Andrzej Kurekeb342242019-01-29 09:14:33 -050033#endif
34
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020035#if defined(MBEDTLS_MD5_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010036#include "mbedtls/md5.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020037#endif
38
39#if defined(MBEDTLS_SHA1_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010040#include "mbedtls/sha1.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020041#endif
42
43#if defined(MBEDTLS_SHA256_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010044#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020045#endif
46
47#if defined(MBEDTLS_SHA512_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010048#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020049#endif
50
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +020051#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jaeden Amero6609aef2019-07-04 20:01:14 +010052#include "mbedtls/ecjpake.h"
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +020053#endif
54
Jerry Yu1bab3012022-01-19 17:43:22 +080055#include "common.h"
56
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010057#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
58 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020059#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020060#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020061
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +020062/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020063#if defined(MBEDTLS_ECP_RESTARTABLE) && \
64 defined(MBEDTLS_SSL_CLI_C) && \
65 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
66 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +010067#define MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020068#endif
69
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020070#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
71#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
72#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
73#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
74
75/*
Jerry Yu8e7ca042021-08-26 15:31:37 +080076 * Mask of TLS 1.3 handshake extensions used in extensions_present
77 * of mbedtls_ssl_handshake_params.
78 */
79#define MBEDTLS_SSL_EXT_NONE 0
80
81#define MBEDTLS_SSL_EXT_SERVERNAME ( 1 << 0 )
82#define MBEDTLS_SSL_EXT_MAX_FRAGMENT_LENGTH ( 1 << 1 )
83#define MBEDTLS_SSL_EXT_STATUS_REQUEST ( 1 << 2 )
84#define MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ( 1 << 3 )
85#define MBEDTLS_SSL_EXT_SIG_ALG ( 1 << 4 )
86#define MBEDTLS_SSL_EXT_USE_SRTP ( 1 << 5 )
87#define MBEDTLS_SSL_EXT_HEARTBEAT ( 1 << 6 )
88#define MBEDTLS_SSL_EXT_ALPN ( 1 << 7 )
89#define MBEDTLS_SSL_EXT_SCT ( 1 << 8 )
Jerry Yu995ecd32021-08-30 17:53:49 +080090#define MBEDTLS_SSL_EXT_CLI_CERT_TYPE ( 1 << 9 )
91#define MBEDTLS_SSL_EXT_SERV_CERT_TYPE ( 1 << 10 )
Jerry Yu8e7ca042021-08-26 15:31:37 +080092#define MBEDTLS_SSL_EXT_PADDING ( 1 << 11 )
93#define MBEDTLS_SSL_EXT_PRE_SHARED_KEY ( 1 << 12 )
94#define MBEDTLS_SSL_EXT_EARLY_DATA ( 1 << 13 )
95#define MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ( 1 << 14 )
96#define MBEDTLS_SSL_EXT_COOKIE ( 1 << 15 )
97#define MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ( 1 << 16 )
98#define MBEDTLS_SSL_EXT_CERT_AUTH ( 1 << 17 )
99#define MBEDTLS_SSL_EXT_OID_FILTERS ( 1 << 18 )
100#define MBEDTLS_SSL_EXT_POST_HANDSHAKE_AUTH ( 1 << 19 )
101#define MBEDTLS_SSL_EXT_SIG_ALG_CERT ( 1 << 20 )
102#define MBEDTLS_SSL_EXT_KEY_SHARE ( 1 << 21 )
Jerry Yu93bcd612021-08-18 12:47:24 +0800103
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800104/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800105 * Helper macros for function call with return check.
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800106 */
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800107/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800108 * Exit when return non-zero value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800109 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800110#define MBEDTLS_SSL_PROC_CHK( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800111 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800112 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800113 if( ret != 0 ) \
114 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800115 goto cleanup; \
116 } \
117 } while( 0 )
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800118/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800119 * Exit when return negative value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800120 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800121#define MBEDTLS_SSL_PROC_CHK_NEG( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800122 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800123 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800124 if( ret < 0 ) \
125 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800126 goto cleanup; \
127 } \
128 } while( 0 )
129
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200130/*
131 * DTLS retransmission states, see RFC 6347 4.2.4
132 *
133 * The SENDING state is merged in PREPARING for initial sends,
134 * but is distinct for resends.
135 *
136 * Note: initial state is wrong for server, but is not used anyway.
137 */
138#define MBEDTLS_SSL_RETRANS_PREPARING 0
139#define MBEDTLS_SSL_RETRANS_SENDING 1
140#define MBEDTLS_SSL_RETRANS_WAITING 2
141#define MBEDTLS_SSL_RETRANS_FINISHED 3
142
143/*
144 * Allow extra bytes for record, authentication and encryption overhead:
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100145 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256).
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200146 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200147
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200148#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0cc46612020-11-30 08:56:52 +0000149
Manuel Pégourié-Gonnard05579c42020-07-31 12:53:39 +0200150/* This macro determines whether CBC is supported. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200151#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
152 ( defined(MBEDTLS_AES_C) || \
153 defined(MBEDTLS_CAMELLIA_C) || \
154 defined(MBEDTLS_ARIA_C) || \
155 defined(MBEDTLS_DES_C) )
156#define MBEDTLS_SSL_SOME_SUITES_USE_CBC
157#endif
158
Hanno Becker0cc46612020-11-30 08:56:52 +0000159/* This macro determines whether a ciphersuite using a
160 * stream cipher can be used. */
161#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
162#define MBEDTLS_SSL_SOME_SUITES_USE_STREAM
163#endif
164
TRodziewicz0f82ec62021-05-12 17:49:18 +0200165/* This macro determines whether the CBC construct used in TLS 1.2 is supported. */
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200166#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200167 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200168#define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC
169#endif
170
Hanno Becker31351ce2021-03-22 11:05:58 +0000171#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200172 defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000173#define MBEDTLS_SSL_SOME_SUITES_USE_MAC
Hanno Becker52344c22018-01-03 15:24:20 +0000174#endif
175
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200176#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker0cc46612020-11-30 08:56:52 +0000177
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000178#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200179/* Ciphersuites using HMAC */
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200180#if defined(MBEDTLS_SHA384_C)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200181#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
182#elif defined(MBEDTLS_SHA256_C)
183#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
184#else
185#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
186#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000187#else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200188/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
189#define MBEDTLS_SSL_MAC_ADD 16
190#endif
191
192#if defined(MBEDTLS_CIPHER_MODE_CBC)
193#define MBEDTLS_SSL_PADDING_ADD 256
194#else
195#define MBEDTLS_SSL_PADDING_ADD 0
196#endif
197
Hanno Beckera0e20d02019-05-15 14:03:01 +0100198#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
TRodziewicze8dd7092021-05-12 14:19:11 +0200199#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Hanno Becker6cbad552019-05-08 15:40:11 +0100200#else
201#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
202#endif
203
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100204#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_MAX_IV_LENGTH + \
Angus Grattond8213d02016-05-25 20:56:48 +1000205 MBEDTLS_SSL_MAC_ADD + \
Hanno Becker6cbad552019-05-08 15:40:11 +0100206 MBEDTLS_SSL_PADDING_ADD + \
207 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000208 )
209
210#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
211 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
212
213#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
214 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
215
Hanno Becker0271f962018-08-16 13:23:47 +0100216/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100217#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100218
Angus Grattond8213d02016-05-25 20:56:48 +1000219/* Maximum length we can advertise as our max content length for
220 RFC 6066 max_fragment_length extension negotiation purposes
221 (the lesser of both sizes, if they are unequal.)
222 */
223#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
224 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
225 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
226 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
227 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200228
Jerry Yu4131ec12022-01-19 10:36:30 +0800229/* Maximum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
230#define MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN 65534
231
Jerry Yu8afd6e42022-01-20 15:54:26 +0800232/* Minimum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
Jerry Yu4131ec12022-01-19 10:36:30 +0800233#define MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN 2
Hanno Beckere131bfe2017-04-12 14:54:42 +0100234
235/* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */
236#define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535
237
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000238#define MBEDTLS_RECEIVED_SIG_ALGS_SIZE 20
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +0000239
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200240/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100241 * Check that we obey the standard's message size bounds
242 */
243
David Horstmann95d516f2021-05-04 18:36:56 +0100244#if MBEDTLS_SSL_IN_CONTENT_LEN > 16384
245#error "Bad configuration - incoming record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100246#endif
247
David Horstmann95d516f2021-05-04 18:36:56 +0100248#if MBEDTLS_SSL_OUT_CONTENT_LEN > 16384
249#error "Bad configuration - outgoing record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100250#endif
251
David Horstmann95d516f2021-05-04 18:36:56 +0100252#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000253#error "Bad configuration - incoming protected record payload too large."
254#endif
255
David Horstmann95d516f2021-05-04 18:36:56 +0100256#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000257#error "Bad configuration - outgoing protected record payload too large."
258#endif
259
260/* Calculate buffer sizes */
261
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000262/* Note: Even though the TLS record header is only 5 bytes
263 long, we're internally using 8 bytes to store the
264 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100265#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100266
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500267#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000268#define MBEDTLS_SSL_IN_BUFFER_LEN \
269 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100270#else
271#define MBEDTLS_SSL_IN_BUFFER_LEN \
272 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
273 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
274#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000275
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500276#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000277#define MBEDTLS_SSL_OUT_BUFFER_LEN \
278 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100279#else
280#define MBEDTLS_SSL_OUT_BUFFER_LEN \
281 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
282 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
283#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000284
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800285#define MBEDTLS_CLIENT_HELLO_RANDOM_LEN 32
286#define MBEDTLS_SERVER_HELLO_RANDOM_LEN 32
287
Hanno Becker9752aad2021-04-21 05:54:33 +0100288#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
289/**
290 * \brief Return the maximum fragment length (payload, in bytes) for
291 * the output buffer. For the client, this is the configured
292 * value. For the server, it is the minimum of two - the
293 * configured value and the negotiated one.
294 *
295 * \sa mbedtls_ssl_conf_max_frag_len()
296 * \sa mbedtls_ssl_get_max_out_record_payload()
297 *
298 * \param ssl SSL context
299 *
300 * \return Current maximum fragment length for the output buffer.
301 */
302size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl );
303
304/**
305 * \brief Return the maximum fragment length (payload, in bytes) for
306 * the input buffer. This is the negotiated maximum fragment
Hanno Beckerdf3b8632021-06-08 05:30:45 +0100307 * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN.
Hanno Becker9752aad2021-04-21 05:54:33 +0100308 * If it is not defined either, the value is 2^14. This function
309 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
310 *
311 * \sa mbedtls_ssl_conf_max_frag_len()
312 * \sa mbedtls_ssl_get_max_in_record_payload()
313 *
314 * \param ssl SSL context
315 *
316 * \return Current maximum fragment length for the output buffer.
317 */
318size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl );
319#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
320
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500321#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500322static inline size_t mbedtls_ssl_get_output_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500323{
324#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500325 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500326 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
327 + MBEDTLS_SSL_CID_OUT_LEN_MAX;
328#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500329 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500330 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
331#endif
332}
333
Andrzej Kurek069fa962021-01-07 08:02:15 -0500334static inline size_t mbedtls_ssl_get_input_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500335{
336#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500337 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500338 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
339 + MBEDTLS_SSL_CID_IN_LEN_MAX;
340#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500341 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500342 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
343#endif
344}
345#endif
346
Hanno Beckera8434e82017-09-18 10:54:39 +0100347/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200348 * TLS extension flags (for extensions with outgoing ServerHello content
349 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
350 * of state of the renegotiation flag, so no indicator is required)
351 */
352#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200353#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200354
Hanno Becker51018aa2017-04-12 14:54:42 +0100355/**
356 * \brief This function checks if the remaining size in a buffer is
357 * greater or equal than a needed space.
358 *
359 * \param cur Pointer to the current position in the buffer.
360 * \param end Pointer to one past the end of the buffer.
361 * \param need Needed space in bytes.
362 *
Ronald Cronb7b35e12020-06-11 09:50:51 +0200363 * \return Zero if the needed space is available in the buffer, non-zero
Hanno Becker51018aa2017-04-12 14:54:42 +0100364 * otherwise.
365 */
366static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
367 const uint8_t *end, size_t need )
368{
Ronald Cronb7b35e12020-06-11 09:50:51 +0200369 return( ( cur > end ) || ( need > (size_t)( end - cur ) ) );
Hanno Becker51018aa2017-04-12 14:54:42 +0100370}
371
372/**
373 * \brief This macro checks if the remaining size in a buffer is
374 * greater or equal than a needed space. If it is not the case,
375 * it returns an SSL_BUFFER_TOO_SMALL error.
376 *
377 * \param cur Pointer to the current position in the buffer.
378 * \param end Pointer to one past the end of the buffer.
379 * \param need Needed space in bytes.
380 *
381 */
382#define MBEDTLS_SSL_CHK_BUF_PTR( cur, end, need ) \
383 do { \
Ronald Cronb7b35e12020-06-11 09:50:51 +0200384 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100385 { \
386 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); \
387 } \
388 } while( 0 )
389
Jerry Yu34da3722021-09-19 18:05:08 +0800390/**
Jerry Yue15e6652021-09-28 21:06:07 +0800391 * \brief This macro checks if the remaining length in an input buffer is
392 * greater or equal than a needed length. If it is not the case, it
Jerry Yu205fd822021-10-08 16:16:24 +0800393 * returns #MBEDTLS_ERR_SSL_DECODE_ERROR error and pends a
Jerry Yudca3d5d2021-10-08 14:19:29 +0800394 * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message.
Jerry Yue4eefc72021-10-09 10:40:40 +0800395 *
396 * This is a function-like macro. It is guaranteed to evaluate each
397 * argument exactly once.
Jerry Yu34da3722021-09-19 18:05:08 +0800398 *
399 * \param cur Pointer to the current position in the buffer.
400 * \param end Pointer to one past the end of the buffer.
Jerry Yue15e6652021-09-28 21:06:07 +0800401 * \param need Needed length in bytes.
Jerry Yu34da3722021-09-19 18:05:08 +0800402 *
403 */
404#define MBEDTLS_SSL_CHK_BUF_READ_PTR( cur, end, need ) \
405 do { \
406 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
407 { \
408 MBEDTLS_SSL_DEBUG_MSG( 1, \
409 ( "missing input data in %s", __func__ ) ); \
410 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \
411 MBEDTLS_ERR_SSL_DECODE_ERROR ); \
412 return( MBEDTLS_ERR_SSL_DECODE_ERROR ); \
413 } \
414 } while( 0 )
415
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200416#ifdef __cplusplus
417extern "C" {
418#endif
419
Hanno Becker7e5437a2017-04-28 17:15:26 +0100420#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100421 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100422/*
423 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
424 */
425struct mbedtls_ssl_sig_hash_set_t
426{
427 /* At the moment, we only need to remember a single suitable
428 * hash algorithm per signature algorithm. As long as that's
429 * the case - and we don't need a general lookup function -
430 * we can implement the sig-hash-set as a map from signatures
431 * to hash algorithms. */
432 mbedtls_md_type_t rsa;
433 mbedtls_md_type_t ecdsa;
434};
435#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
Gilles Peskineeccd8882020-03-10 12:19:08 +0100436 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100437
Ron Eldor51d3ab52019-05-12 14:54:30 +0300438typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen,
439 const char *label,
440 const unsigned char *random, size_t rlen,
441 unsigned char *dstbuf, size_t dlen );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100442
Hanno Becker61baae72020-09-16 09:24:14 +0100443/* cipher.h exports the maximum IV, key and block length from
Hanno Becker15889832020-09-08 11:29:11 +0100444 * all ciphers enabled in the config, regardless of whether those
445 * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled
446 * in the default configuration and uses 64 Byte keys, but it is
447 * not used for record protection in SSL/TLS.
448 *
449 * In order to prevent unnecessary inflation of key structures,
450 * we introduce SSL-specific variants of the max-{key,block,IV}
451 * macros here which are meant to only take those ciphers into
452 * account which can be negotiated in SSL/TLS.
453 *
454 * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH
455 * in cipher.h are rough overapproximations of the real maxima, here
Hanno Becker9a7a2ac2020-09-09 09:24:54 +0100456 * we content ourselves with replicating those overapproximations
Hanno Becker15889832020-09-08 11:29:11 +0100457 * for the maximum block and IV length, and excluding XTS from the
458 * computation of the maximum key length. */
459#define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16
460#define MBEDTLS_SSL_MAX_IV_LENGTH 16
461#define MBEDTLS_SSL_MAX_KEY_LENGTH 32
462
Hanno Becker3385a4d2020-08-21 13:03:34 +0100463/**
464 * \brief The data structure holding the cryptographic material (key and IV)
465 * used for record protection in TLS 1.3.
466 */
467struct mbedtls_ssl_key_set
468{
469 /*! The key for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100470 unsigned char client_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100471 /*! The key for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100472 unsigned char server_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100473 /*! The IV for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100474 unsigned char client_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100475 /*! The IV for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100476 unsigned char server_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100477
Hanno Becker493ea7f2020-09-08 11:01:00 +0100478 size_t key_len; /*!< The length of client_write_key and
479 * server_write_key, in Bytes. */
480 size_t iv_len; /*!< The length of client_write_iv and
481 * server_write_iv, in Bytes. */
Hanno Becker3385a4d2020-08-21 13:03:34 +0100482};
483typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100484
Jerry Yu61e35e02021-09-16 18:59:08 +0800485typedef struct
486{
Jerry Yuf532bb22021-10-13 10:34:03 +0800487 unsigned char binder_key [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
488 unsigned char client_early_traffic_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
489 unsigned char early_exporter_master_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000490} mbedtls_ssl_tls13_early_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800491
492typedef struct
493{
Jerry Yuf532bb22021-10-13 10:34:03 +0800494 unsigned char client_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
495 unsigned char server_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000496} mbedtls_ssl_tls13_handshake_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800497
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200498/*
499 * This structure contains the parameters only needed during handshake.
500 */
501struct mbedtls_ssl_handshake_params
502{
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100503 /* Frequently-used boolean or byte fields (placed early to take
504 * advantage of smaller code size for indirect access on Arm Thumb) */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100505 uint8_t resume; /*!< session resume indicator*/
506 uint8_t cli_exts; /*!< client extension presence*/
507
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400508#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
509 uint8_t sni_authmode; /*!< authmode from SNI callback */
510#endif
511
512#if defined(MBEDTLS_SSL_SESSION_TICKETS)
513 uint8_t new_session_ticket; /*!< use NewSessionTicket? */
514#endif /* MBEDTLS_SSL_SESSION_TICKETS */
515
Ronald Cron82c785f2022-03-31 15:44:41 +0200516#if defined(MBEDTLS_SSL_CLI_C)
Glenn Strausscd78df62022-04-07 19:07:11 -0400517 /*!< Minimum TLS version to be negotiated.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200518 *
519 * It is set up in the ClientHello writing preparation stage and used
520 * throughout the ClientHello writing. Not relevant anymore as soon as
521 * the protocol version has been negotiated thus as soon as the
522 * ServerHello is received.
523 * For a fresh handshake not linked to any previous handshake, it is
524 * equal to the configured minimum minor version to be negotiated. When
525 * renegotiating or resuming a session, it is equal to the previously
526 * negotiated minor version.
527 *
Glenn Strausscd78df62022-04-07 19:07:11 -0400528 * There is no maximum TLS version field in this handshake context.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200529 * From the start of the handshake, we need to define a current protocol
Glenn Strausscd78df62022-04-07 19:07:11 -0400530 * version for the record layer which we define as the maximum TLS
531 * version to be negotiated. The `tls_version` field of the SSL context is
Ronald Cronbdb4f582022-03-31 15:37:44 +0200532 * used to store this maximum value until it contains the actual
533 * negotiated value.
534 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400535 mbedtls_ssl_protocol_version min_tls_version;
Ronald Cron82c785f2022-03-31 15:44:41 +0200536#endif
Ronald Cron86a477f2022-02-18 17:45:10 +0100537
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100538#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
539 uint8_t extended_ms; /*!< use Extended Master Secret? */
540#endif
541
542#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
543 uint8_t async_in_progress; /*!< an asynchronous operation is in progress */
544#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
545
546#if defined(MBEDTLS_SSL_PROTO_DTLS)
547 unsigned char retransmit_state; /*!< Retransmission state */
548#endif
549
Gilles Peskine41139a22021-12-08 18:25:39 +0100550#if !defined(MBEDTLS_DEPRECATED_REMOVED)
551 unsigned char group_list_heap_allocated;
Jerry Yuf017ee42022-01-12 15:49:48 +0800552 unsigned char sig_algs_heap_allocated;
Gilles Peskine41139a22021-12-08 18:25:39 +0100553#endif
554
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100555#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
556 uint8_t ecrs_enabled; /*!< Handshake supports EC restart? */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100557 enum { /* this complements ssl->state with info on intra-state operations */
558 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
559 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
560 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
561 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
562 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
563 } ecrs_state; /*!< current (or last) operation */
564 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
565 size_t ecrs_n; /*!< place for saving a length */
566#endif
567
568 size_t pmslen; /*!< premaster length */
569
570 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
571
572 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
573 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
574 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
575 mbedtls_ssl_tls_prf_cb *tls_prf;
576
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200577 /*
578 * Handshake specific crypto variables
579 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100580#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Baid25fab62021-12-02 06:36:27 +0000581 int tls13_kex_modes; /*!< key exchange modes for TLS 1.3 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100582#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100583
XiaokangQian647719a2021-12-07 09:16:29 +0000584#if defined(MBEDTLS_SSL_CLI_C)
585 /*!< Number of Hello Retry Request messages received from the server. */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000586 int hello_retry_request_count;
XiaokangQian647719a2021-12-07 09:16:29 +0000587#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQian7ac3ab32022-02-22 04:03:26 +0000588#if defined(MBEDTLS_SSL_SRV_C)
589 /*!< Number of Hello Retry Request messages sent by the server. */
590 int hello_retry_requests_sent;
591#endif /* MBEDTLS_SSL_SRV_C */
XiaokangQian647719a2021-12-07 09:16:29 +0000592
Hanno Becker7e5437a2017-04-28 17:15:26 +0100593#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +0100594 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +0100595 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
596#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100597
Xiaofei Bai51f515a2022-02-08 07:28:04 +0000598#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
599 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000600 uint16_t received_sig_algs[MBEDTLS_RECEIVED_SIG_ALGS_SIZE];
601#endif
602
Gilles Peskine41139a22021-12-08 18:25:39 +0100603#if !defined(MBEDTLS_DEPRECATED_REMOVED)
604 const uint16_t *group_list;
Jerry Yuf017ee42022-01-12 15:49:48 +0800605 const uint16_t *sig_algs;
Gilles Peskine41139a22021-12-08 18:25:39 +0100606#endif
607
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200608#if defined(MBEDTLS_DHM_C)
609 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
610#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100611
John Durkop07cc04a2020-11-16 22:08:34 -0800612/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
Ronald Cronde1adee2022-03-07 16:20:30 +0100613 * to guards in client and server code. There is a gap in functionality that
614 * access to ecdh_ctx structure is needed for MBEDTLS_ECDSA_C which does not
615 * seem correct.
John Durkop07cc04a2020-11-16 22:08:34 -0800616 */
617#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200618 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000619
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100620#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine42459802019-12-19 13:31:53 +0100621 psa_key_type_t ecdh_psa_type;
Neil Armstrong91477a72022-03-25 15:42:20 +0100622 size_t ecdh_bits;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100623 mbedtls_svc_key_id_t ecdh_psa_privkey;
Neil Armstrongf716a702022-04-04 11:23:46 +0200624 uint8_t ecdh_psa_privkey_is_external;
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000625 unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH];
626 size_t ecdh_psa_peerkey_len;
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100627#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
John Durkop07cc04a2020-11-16 22:08:34 -0800628#endif /* MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000629
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200630#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200631 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200632#if defined(MBEDTLS_SSL_CLI_C)
633 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
634 size_t ecjpake_cache_len; /*!< Length of cached data */
635#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100636#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100637
638#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200639 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200640 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
641#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100642
Gilles Peskineeccd8882020-03-10 12:19:08 +0100643#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100644#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +0100645 mbedtls_svc_key_id_t psk_opaque; /*!< Opaque PSK from the callback */
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100646#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200647 unsigned char *psk; /*!< PSK from the callback */
648 size_t psk_len; /*!< Length of PSK from callback */
Gilles Peskineeccd8882020-03-10 12:19:08 +0100649#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100650
Gilles Peskinecfe74a32021-12-08 18:38:51 +0100651#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
652 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
653#endif
654
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200655#if defined(MBEDTLS_X509_CRT_PARSE_C)
656 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
657#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
658 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
659 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
660 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100661#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200662#endif /* MBEDTLS_X509_CRT_PARSE_C */
Gilles Peskine8716f172021-11-16 15:21:44 +0100663
Gilles Peskine8716f172021-11-16 15:21:44 +0100664#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Hanno Becker75173122019-02-06 16:18:31 +0000665 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
666 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
667#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker2f28c102019-04-25 15:46:59 +0100668
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100669 struct
670 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100671 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
672 * buffers used for message buffering. */
673
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100674 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100675 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100676
Hanno Becker0271f962018-08-16 13:23:47 +0100677 struct mbedtls_ssl_hs_buffer
678 {
Hanno Becker98081a02018-08-22 13:32:50 +0100679 unsigned is_valid : 1;
680 unsigned is_fragmented : 1;
681 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100682 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100683 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100684 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
685
Hanno Becker5f066e72018-08-16 14:56:31 +0100686 struct
687 {
688 unsigned char *data;
689 size_t len;
690 unsigned epoch;
691 } future_record;
692
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100693 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100694
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000695#if defined(MBEDTLS_SSL_CLI_C) && \
696 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
697 unsigned char *cookie; /*!< HelloVerifyRequest cookie for DTLS
698 * HelloRetryRequest cookie for TLS 1.3 */
699#endif /* MBEDTLS_SSL_CLI_C &&
700 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
701#if defined(MBEDTLS_SSL_PROTO_DTLS)
702 unsigned char verify_cookie_len; /*!< Cli: HelloVerifyRequest cookie
703 * length
XiaokangQian34909742022-01-27 02:25:04 +0000704 * Srv: flag for sending a cookie */
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000705#endif /* MBEDTLS_SSL_PROTO_DTLS */
706#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
707 uint16_t hrr_cookie_len; /*!< HelloRetryRequest cookie length */
XiaokangQian20438972022-03-04 08:52:07 +0000708#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian52da5582022-01-26 09:49:29 +0000709
710#if defined(MBEDTLS_SSL_PROTO_DTLS)
711 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
712 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100713
714 uint32_t retransmit_timeout; /*!< Current value of timeout */
715 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
716 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
717 unsigned char *cur_msg_p; /*!< Position in current message */
718 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
719 flight being received */
720 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
721 resending messages */
722 unsigned char alt_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Alternative record epoch/counter
723 for resending messages */
724
725#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
726 /* The state of CID configuration in this handshake. */
727
728 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
729 * has been negotiated. Possible values are
730 * #MBEDTLS_SSL_CID_ENABLED and
731 * #MBEDTLS_SSL_CID_DISABLED. */
732 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
733 uint8_t peer_cid_len; /*!< The length of
734 * \c peer_cid. */
735#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
736
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200737 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100738#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200739
Ronald Cron6f135e12021-12-08 16:57:54 +0100740#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +0100741 /*! TLS 1.3 transforms for 0-RTT and encrypted handshake messages.
742 * Those pointers own the transforms they reference. */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100743 mbedtls_ssl_transform *transform_handshake;
744 mbedtls_ssl_transform *transform_earlydata;
Ronald Cron6f135e12021-12-08 16:57:54 +0100745#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100746
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200747 /*
748 * Checksum contexts
749 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200750#if defined(MBEDTLS_SHA256_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500751#if defined(MBEDTLS_USE_PSA_CRYPTO)
752 psa_hash_operation_t fin_sha256_psa;
753#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200754 mbedtls_sha256_context fin_sha256;
755#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500756#endif
Mateusz Starzykc6d94ab2021-05-19 13:31:59 +0200757#if defined(MBEDTLS_SHA384_C)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500758#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500759 psa_hash_operation_t fin_sha384_psa;
Andrzej Kurekeb342242019-01-29 09:14:33 -0500760#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200761 mbedtls_sha512_context fin_sha512;
762#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500763#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200764
Ronald Cron6f135e12021-12-08 16:57:54 +0100765#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800766 uint16_t offered_group_id; /* The NamedGroup value for the group
767 * that is being used for ephemeral
768 * key exchange.
769 *
770 * On the client: Defaults to the first
771 * entry in the client's group list,
772 * but can be overwritten by the HRR. */
Ronald Cron6f135e12021-12-08 16:57:54 +0100773#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800774
Jerry Yufb28b882022-01-28 11:05:58 +0800775#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yu2d9a6942022-02-08 21:07:10 +0800776 uint8_t client_auth; /*!< used to check if CertificateRequest has been
Jerry Yu5c7d1cc2022-02-08 21:08:29 +0800777 received from server side. If CertificateRequest
Jerry Yu0ff8ac82022-02-08 10:10:48 +0800778 has been received, Certificate and CertificateVerify
Jerry Yufb28b882022-01-28 11:05:58 +0800779 should be sent to server */
780#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000781 /*
782 * State-local variables used during the processing
783 * of a specific handshake state.
784 */
785 union
786 {
787 /* Outgoing Finished message */
788 struct
789 {
790 uint8_t preparation_done;
791
792 /* Buffer holding digest of the handshake up to
793 * but excluding the outgoing finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000794 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000795 size_t digest_len;
796 } finished_out;
797
798 /* Incoming Finished message */
799 struct
800 {
XiaokangQian57b2aff2021-11-10 03:12:11 +0000801 uint8_t preparation_done;
802
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000803 /* Buffer holding digest of the handshake up to but
804 * excluding the peer's incoming finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000805 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000806 size_t digest_len;
807 } finished_in;
808
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000809 } state_local;
810
811 /* End of state-local variables. */
812
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800813 unsigned char randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN +
814 MBEDTLS_SERVER_HELLO_RANDOM_LEN];
815 /*!< random bytes */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200816 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
817 /*!< premaster secret */
818
Ronald Cron6f135e12021-12-08 16:57:54 +0100819#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu8e7ca042021-08-26 15:31:37 +0800820 int extensions_present; /*!< extension presence; Each bitfield
821 represents an extension and defined
822 as \c MBEDTLS_SSL_EXT_XXX */
Jerry Yu89ea3212021-09-09 14:31:24 +0800823
Xiaofei Baia0ab7772022-01-16 12:14:45 +0000824#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
825 unsigned char certificate_request_context_len;
826 unsigned char *certificate_request_context;
Xiaofei Baie1e34422021-12-23 12:09:05 +0000827#endif
828
Jerry Yu89ea3212021-09-09 14:31:24 +0800829 union
830 {
Jerry Yud1ab2622021-10-08 15:36:57 +0800831 unsigned char early [MBEDTLS_TLS1_3_MD_MAX_SIZE];
832 unsigned char handshake[MBEDTLS_TLS1_3_MD_MAX_SIZE];
833 unsigned char app [MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Baid25fab62021-12-02 06:36:27 +0000834 } tls13_master_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800835
Xiaofei Bai746f9482021-11-12 08:53:56 +0000836 mbedtls_ssl_tls13_handshake_secrets tls13_hs_secrets;
Ronald Cron6f135e12021-12-08 16:57:54 +0100837#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200838
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200839#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
840 /** Asynchronous operation context. This field is meant for use by the
841 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
842 * mbedtls_ssl_config::f_async_decrypt_start,
843 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
844 * The library does not use it internally. */
845 void *user_async_ctx;
846#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Glenn Strauss69894072022-01-24 12:58:00 -0500847
848#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
849 const unsigned char *sni_name; /*!< raw SNI */
850 size_t sni_name_len; /*!< raw SNI len */
851#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200852};
853
Hanno Becker0271f962018-08-16 13:23:47 +0100854typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
855
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200856/*
Hanno Beckerd362dc52018-01-03 15:23:11 +0000857 * Representation of decryption/encryption transformations on records
858 *
859 * There are the following general types of record transformations:
TRodziewicz2abf03c2021-06-25 14:40:09 +0200860 * - Stream transformations (TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +0000861 * Transformation adding a MAC and applying a stream-cipher
862 * to the authenticated message.
TRodziewicz2abf03c2021-06-25 14:40:09 +0200863 * - CBC block cipher transformations ([D]TLS versions == 1.2 only)
864 * For TLS 1.2, no IV is generated at key extraction time, but every
865 * encrypted record is explicitly prefixed by the IV with which it was
866 * encrypted.
867 * - AEAD transformations ([D]TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +0000868 * These come in two fundamentally different versions, the first one
869 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
870 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
871 * In the first transformation, the IV to be used for a record is obtained
872 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
873 * record sequence number, and explicitly prepending this sequence number
874 * to the encrypted record. In contrast, in the second transformation
875 * the IV is obtained by XOR'ing a static IV obtained at key extraction
876 * time with the 8-byte record sequence number, without prepending the
877 * latter to the encrypted record.
878 *
Hanno Becker7d343ec2020-05-04 12:29:05 +0100879 * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext
880 * which allows to add flexible length padding and to hide a record's true
881 * content type.
882 *
Hanno Beckerd362dc52018-01-03 15:23:11 +0000883 * In addition to type and version, the following parameters are relevant:
884 * - The symmetric cipher algorithm to be used.
885 * - The (static) encryption/decryption keys for the cipher.
886 * - For stream/CBC, the type of message digest to be used.
887 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Becker0db7e0c2018-10-18 15:39:53 +0100888 * - For AEAD transformations, the size (potentially 0) of an explicit,
889 * random initialization vector placed in encrypted records.
TRodziewicz299510e2021-07-09 16:55:11 +0200890 * - For some transformations (currently AEAD) an implicit IV. It is static
Hanno Beckerd362dc52018-01-03 15:23:11 +0000891 * and (if present) is combined with the explicit IV in a transformation-
TRodziewicz299510e2021-07-09 16:55:11 +0200892 * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
Hanno Beckerd362dc52018-01-03 15:23:11 +0000893 * - For stream/CBC, a flag determining the order of encryption and MAC.
894 * - The details of the transformation depend on the SSL/TLS version.
895 * - The length of the authentication tag.
896 *
897 * The struct below refines this abstract view as follows:
898 * - The cipher underlying the transformation is managed in
899 * cipher contexts cipher_ctx_{enc/dec}, which must have the
900 * same cipher type. The mode of these cipher contexts determines
901 * the type of the transformation in the sense above: e.g., if
902 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
903 * then the transformation has type CBC resp. AEAD.
904 * - The cipher keys are never stored explicitly but
905 * are maintained within cipher_ctx_{enc/dec}.
906 * - For stream/CBC transformations, the message digest contexts
907 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
908 * are unused for AEAD transformations.
TRodziewicz2abf03c2021-06-25 14:40:09 +0200909 * - For stream/CBC transformations, the MAC keys are not stored explicitly
910 * but maintained within md_ctx_{enc/dec}.
911 * - The mac_enc and mac_dec fields are unused for EAD transformations.
Hanno Beckerd362dc52018-01-03 15:23:11 +0000912 * - For transformations using an implicit IV maintained within
913 * the transformation context, its contents are stored within
914 * iv_{enc/dec}.
915 * - The value of ivlen indicates the length of the IV.
916 * This is redundant in case of stream/CBC transformations
917 * which always use 0 resp. the cipher's block length as the
918 * IV length, but is needed for AEAD ciphers and may be
919 * different from the underlying cipher's block length
920 * in this case.
921 * - The field fixed_ivlen is nonzero for AEAD transformations only
922 * and indicates the length of the static part of the IV which is
923 * constant throughout the communication, and which is stored in
924 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
Glenn Strauss07c64162022-03-14 12:34:51 -0400925 * - tls_version denotes the 2-byte TLS version
Hanno Beckerd362dc52018-01-03 15:23:11 +0000926 * - For stream/CBC transformations, maclen denotes the length of the
927 * authentication tag, while taglen is unused and 0.
928 * - For AEAD transformations, taglen denotes the length of the
929 * authentication tag, while maclen is unused and 0.
930 * - For CBC transformations, encrypt_then_mac determines the
931 * order of encryption and authentication. This field is unused
932 * in other transformations.
933 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200934 */
935struct mbedtls_ssl_transform
936{
937 /*
938 * Session specific crypto layer
939 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200940 size_t minlen; /*!< min. ciphertext length */
941 size_t ivlen; /*!< IV length */
942 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Beckere694c3e2017-12-27 21:34:08 +0000943 size_t maclen; /*!< MAC(CBC) len */
944 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200945
946 unsigned char iv_enc[16]; /*!< IV (encryption) */
947 unsigned char iv_dec[16]; /*!< IV (decryption) */
948
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000949#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Hanno Beckerd56ed242018-01-03 15:32:51 +0000950
Neil Armstrong39b8e7d2022-02-23 09:24:45 +0100951#if defined(MBEDTLS_USE_PSA_CRYPTO)
952 mbedtls_svc_key_id_t psa_mac_enc; /*!< MAC (encryption) */
953 mbedtls_svc_key_id_t psa_mac_dec; /*!< MAC (decryption) */
954 psa_algorithm_t psa_mac_alg; /*!< psa MAC algorithm */
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100955#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200956 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
957 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
Neil Armstrongcf8841a2022-02-24 11:17:45 +0100958#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200959
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000960#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
961 int encrypt_then_mac; /*!< flag for EtM activation */
962#endif
963
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000964#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Beckerd56ed242018-01-03 15:32:51 +0000965
Glenn Strauss07c64162022-03-14 12:34:51 -0400966 mbedtls_ssl_protocol_version tls_version;
Hanno Becker9eddaeb2017-12-27 21:37:21 +0000967
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +0100968#if defined(MBEDTLS_USE_PSA_CRYPTO)
969 mbedtls_svc_key_id_t psa_key_enc; /*!< psa encryption key */
970 mbedtls_svc_key_id_t psa_key_dec; /*!< psa decryption key */
971 psa_algorithm_t psa_alg; /*!< psa algorithm */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +0100972#else
973 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
974 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +0100975#endif /* MBEDTLS_USE_PSA_CRYPTO */
976
Hanno Beckera0e20d02019-05-15 14:03:01 +0100977#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker1327fa72019-04-25 15:54:02 +0100978 uint8_t in_cid_len;
979 uint8_t out_cid_len;
980 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
981 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera0e20d02019-05-15 14:03:01 +0100982#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1327fa72019-04-25 15:54:02 +0100983
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +0200984#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
985 /* We need the Hello random bytes in order to re-derive keys from the
Hanno Beckerbd257552021-03-22 06:59:27 +0000986 * Master Secret and other session info,
987 * see ssl_tls12_populate_transform() */
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800988 unsigned char randbytes[MBEDTLS_SERVER_HELLO_RANDOM_LEN +
989 MBEDTLS_CLIENT_HELLO_RANDOM_LEN];
990 /*!< ServerHello.random+ClientHello.random */
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +0200991#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200992};
993
Hanno Becker12a3a862018-01-05 15:42:50 +0000994/*
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +0200995 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
996 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
997 */
998static inline int mbedtls_ssl_transform_uses_aead(
999 const mbedtls_ssl_transform *transform )
1000{
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001001#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001002 return( transform->maclen == 0 && transform->taglen != 0 );
1003#else
1004 (void) transform;
1005 return( 1 );
1006#endif
1007}
1008
1009/*
Hanno Becker12a3a862018-01-05 15:42:50 +00001010 * Internal representation of record frames
1011 *
Hanno Becker12a3a862018-01-05 15:42:50 +00001012 * Instances come in two flavors:
1013 * (1) Encrypted
1014 * These always have data_offset = 0
1015 * (2) Unencrypted
Hanno Beckercd430bc2019-04-04 16:29:48 +01001016 * These have data_offset set to the amount of
1017 * pre-expansion during record protection. Concretely,
1018 * this is the length of the fixed part of the explicit IV
1019 * used for encryption, or 0 if no explicit IV is used
TRodziewicz2abf03c2021-06-25 14:40:09 +02001020 * (e.g. for stream ciphers).
Hanno Becker12a3a862018-01-05 15:42:50 +00001021 *
1022 * The reason for the data_offset in the unencrypted case
1023 * is to allow for in-place conversion of an unencrypted to
1024 * an encrypted record. If the offset wasn't included, the
1025 * encrypted content would need to be shifted afterwards to
1026 * make space for the fixed IV.
1027 *
1028 */
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001029#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker75f080f2019-04-30 15:01:51 +01001030#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001031#else
Hanno Becker75f080f2019-04-30 15:01:51 +01001032#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001033#endif
1034
Hanno Becker12a3a862018-01-05 15:42:50 +00001035typedef struct
1036{
Jerry Yuae0b2e22021-10-08 15:21:19 +08001037 uint8_t ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /* In TLS: The implicit record sequence number.
1038 * In DTLS: The 2-byte epoch followed by
1039 * the 6-byte sequence number.
1040 * This is stored as a raw big endian byte array
1041 * as opposed to a uint64_t because we rarely
1042 * need to perform arithmetic on this, but do
1043 * need it as a Byte array for the purpose of
1044 * MAC computations. */
Hanno Beckerd840cea2019-07-11 09:24:36 +01001045 uint8_t type; /* The record content type. */
1046 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
1047 * Convert to internal presentation of versions
1048 * using mbedtls_ssl_read_version() and
1049 * mbedtls_ssl_write_version().
1050 * Keep wire-format for MAC computations. */
Hanno Becker12a3a862018-01-05 15:42:50 +00001051
Hanno Beckerd840cea2019-07-11 09:24:36 +01001052 unsigned char *buf; /* Memory buffer enclosing the record content */
1053 size_t buf_len; /* Buffer length */
1054 size_t data_offset; /* Offset of record content */
1055 size_t data_len; /* Length of record content */
Hanno Becker12a3a862018-01-05 15:42:50 +00001056
Hanno Beckera0e20d02019-05-15 14:03:01 +01001057#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd840cea2019-07-11 09:24:36 +01001058 uint8_t cid_len; /* Length of the CID (0 if not present) */
1059 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001060#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker12a3a862018-01-05 15:42:50 +00001061} mbedtls_record;
1062
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001063#if defined(MBEDTLS_X509_CRT_PARSE_C)
1064/*
1065 * List of certificate + private key pairs
1066 */
1067struct mbedtls_ssl_key_cert
1068{
1069 mbedtls_x509_crt *cert; /*!< cert */
1070 mbedtls_pk_context *key; /*!< private key */
1071 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
1072};
1073#endif /* MBEDTLS_X509_CRT_PARSE_C */
1074
1075#if defined(MBEDTLS_SSL_PROTO_DTLS)
1076/*
1077 * List of handshake messages kept around for resending
1078 */
1079struct mbedtls_ssl_flight_item
1080{
1081 unsigned char *p; /*!< message, including handshake headers */
1082 size_t len; /*!< length of p */
1083 unsigned char type; /*!< type of the message: handshake or CCS */
1084 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
1085};
1086#endif /* MBEDTLS_SSL_PROTO_DTLS */
1087
Ronald Cron4079abc2022-02-20 10:35:26 +01001088#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1089/**
1090 * \brief Given an SSL context and its associated configuration, write the TLS
1091 * 1.2 specific extensions of the ClientHello message.
1092 *
1093 * \param[in] ssl SSL context
1094 * \param[in] buf Base address of the buffer where to write the extensions
1095 * \param[in] end End address of the buffer where to write the extensions
1096 * \param uses_ec Whether one proposed ciphersuite uses an elliptic curve
1097 * (<> 0) or not ( 0 ).
1098 * \param[out] out_len Length of the data written into the buffer \p buf
1099 */
1100int mbedtls_ssl_tls12_write_client_hello_exts( mbedtls_ssl_context *ssl,
1101 unsigned char *buf,
1102 const unsigned char *end,
1103 int uses_ec,
1104 size_t *out_len );
1105#endif
1106
Hanno Becker7e5437a2017-04-28 17:15:26 +01001107#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01001108 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01001109
1110/* Find an entry in a signature-hash set matching a given hash algorithm. */
1111mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
1112 mbedtls_pk_type_t sig_alg );
1113/* Add a signature-hash-pair to a signature-hash set */
1114void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
1115 mbedtls_pk_type_t sig_alg,
1116 mbedtls_md_type_t md_alg );
1117/* Allow exactly one hash algorithm for each signature. */
1118void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
1119 mbedtls_md_type_t md_alg );
1120
1121/* Setup an empty signature-hash set */
1122static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
1123{
1124 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
1125}
1126
1127#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01001128 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001129
1130/**
1131 * \brief Free referenced items in an SSL transform context and clear
1132 * memory
1133 *
1134 * \param transform SSL transform context
1135 */
1136void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
1137
1138/**
1139 * \brief Free referenced items in an SSL handshake context and clear
1140 * memory
1141 *
Gilles Peskine9b562d52018-04-25 20:32:43 +02001142 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001143 */
Gilles Peskine9b562d52018-04-25 20:32:43 +02001144void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001145
Jerry Yuc7875b52021-09-05 21:05:50 +08001146/* set inbound transform of ssl context */
1147void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
1148 mbedtls_ssl_transform *transform );
1149
1150/* set outbound transform of ssl context */
1151void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
1152 mbedtls_ssl_transform *transform );
1153
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001154int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
1155int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
1156void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001157static inline void mbedtls_ssl_handshake_set_state( mbedtls_ssl_context *ssl,
1158 mbedtls_ssl_states state )
1159{
1160 ssl->state = ( int ) state;
1161}
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001162
1163int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
1164
1165void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001166
1167#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001168int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001169#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001170
Simon Butcher99000142016-10-13 17:21:01 +01001171int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
1172int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
1173void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
1174
Hanno Becker4a810fb2017-05-24 16:27:30 +01001175/**
1176 * \brief Update record layer
1177 *
1178 * This function roughly separates the implementation
1179 * of the logic of (D)TLS from the implementation
1180 * of the secure transport.
1181 *
Hanno Becker3a0aad12018-08-20 09:44:02 +01001182 * \param ssl The SSL context to use.
1183 * \param update_hs_digest This indicates if the handshake digest
1184 * should be automatically updated in case
1185 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +01001186 *
1187 * \return 0 or non-zero error code.
1188 *
1189 * \note A clarification on what is called 'record layer' here
1190 * is in order, as many sensible definitions are possible:
1191 *
1192 * The record layer takes as input an untrusted underlying
1193 * transport (stream or datagram) and transforms it into
1194 * a serially multiplexed, secure transport, which
1195 * conceptually provides the following:
1196 *
1197 * (1) Three datagram based, content-agnostic transports
1198 * for handshake, alert and CCS messages.
1199 * (2) One stream- or datagram-based transport
1200 * for application data.
1201 * (3) Functionality for changing the underlying transform
1202 * securing the contents.
1203 *
1204 * The interface to this functionality is given as follows:
1205 *
1206 * a Updating
1207 * [Currently implemented by mbedtls_ssl_read_record]
1208 *
1209 * Check if and on which of the four 'ports' data is pending:
1210 * Nothing, a controlling datagram of type (1), or application
1211 * data (2). In any case data is present, internal buffers
1212 * provide access to the data for the user to process it.
1213 * Consumption of type (1) datagrams is done automatically
1214 * on the next update, invalidating that the internal buffers
1215 * for previous datagrams, while consumption of application
1216 * data (2) is user-controlled.
1217 *
1218 * b Reading of application data
1219 * [Currently manual adaption of ssl->in_offt pointer]
1220 *
1221 * As mentioned in the last paragraph, consumption of data
1222 * is different from the automatic consumption of control
1223 * datagrams (1) because application data is treated as a stream.
1224 *
1225 * c Tracking availability of application data
1226 * [Currently manually through decreasing ssl->in_msglen]
1227 *
1228 * For efficiency and to retain datagram semantics for
1229 * application data in case of DTLS, the record layer
1230 * provides functionality for checking how much application
1231 * data is still available in the internal buffer.
1232 *
1233 * d Changing the transformation securing the communication.
1234 *
1235 * Given an opaque implementation of the record layer in the
1236 * above sense, it should be possible to implement the logic
1237 * of (D)TLS on top of it without the need to know anything
1238 * about the record layer's internals. This is done e.g.
1239 * in all the handshake handling functions, and in the
1240 * application data reading function mbedtls_ssl_read.
1241 *
1242 * \note The above tries to give a conceptual picture of the
1243 * record layer, but the current implementation deviates
1244 * from it in some places. For example, our implementation of
1245 * the update functionality through mbedtls_ssl_read_record
1246 * discards datagrams depending on the current state, which
1247 * wouldn't fall under the record layer's responsibility
1248 * following the above definition.
1249 *
1250 */
Hanno Becker3a0aad12018-08-20 09:44:02 +01001251int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
1252 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001253int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
1254
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001255/*
1256 * Write handshake message header
1257 */
1258int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
1259 unsigned char **buf, size_t *buf_len );
1260
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001261int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01001262 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01001263 int force_flush );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001264static inline int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
1265{
Ronald Cron66dbf912022-02-02 15:33:46 +01001266 return( mbedtls_ssl_write_handshake_msg_ext( ssl, 1 /* update checksum */, 1 /* force flush */ ) );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001267}
1268
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001269/*
1270 * Write handshake message tail
1271 */
1272int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
1273 size_t buf_len, size_t msg_len );
1274
Ronald Cron00d012f22022-03-08 15:57:12 +01001275int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001276int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
1277
1278int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
1279int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
1280
1281int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
1282int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1283
1284int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
1285int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1286
1287void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
1288 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
1289
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001290/*
1291 * Update checksum of handshake messages.
1292 */
1293void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
1294 unsigned hs_type,
1295 unsigned char const *msg,
1296 size_t msg_len );
1297
Gilles Peskineeccd8882020-03-10 12:19:08 +01001298#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001299int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl,
1300 mbedtls_key_exchange_type_t key_ex );
Ronald Crond491c2d2022-02-19 18:30:46 +01001301#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
1302int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf );
1303#endif
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001304
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001305/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001306 * Get the first defined PSK by order of precedence:
1307 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
1308 * 2. static PSK configured by \c mbedtls_ssl_conf_psk()
1309 * Return a code and update the pair (PSK, PSK length) passed to this function
1310 */
1311static inline int mbedtls_ssl_get_psk( const mbedtls_ssl_context *ssl,
1312 const unsigned char **psk, size_t *psk_len )
1313{
1314 if( ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0 )
1315 {
1316 *psk = ssl->handshake->psk;
1317 *psk_len = ssl->handshake->psk_len;
1318 }
1319
1320 else if( ssl->conf->psk != NULL && ssl->conf->psk_len > 0 )
1321 {
1322 *psk = ssl->conf->psk;
1323 *psk_len = ssl->conf->psk_len;
1324 }
1325
1326 else
1327 {
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001328 *psk = NULL;
1329 *psk_len = 0;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001330 return( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED );
1331 }
1332
1333 return( 0 );
1334}
1335
1336#if defined(MBEDTLS_USE_PSA_CRYPTO)
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001337/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001338 * Get the first defined opaque PSK by order of precedence:
1339 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK
1340 * callback
1341 * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque()
1342 * Return an opaque PSK
1343 */
Andrzej Kurek03e01462022-01-03 12:53:24 +01001344static inline mbedtls_svc_key_id_t mbedtls_ssl_get_opaque_psk(
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001345 const mbedtls_ssl_context *ssl )
1346{
Ronald Croncf56a0a2020-08-04 09:51:30 +02001347 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001348 return( ssl->handshake->psk_opaque );
1349
Ronald Croncf56a0a2020-08-04 09:51:30 +02001350 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001351 return( ssl->conf->psk_opaque );
1352
Ronald Croncf56a0a2020-08-04 09:51:30 +02001353 return( MBEDTLS_SVC_KEY_ID_INIT );
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001354}
Przemyslaw Stekiel430f3372022-01-10 11:55:46 +01001355
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001356#endif /* MBEDTLS_USE_PSA_CRYPTO */
1357
1358#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001359
1360#if defined(MBEDTLS_PK_C)
1361unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001362unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001363mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1364#endif
1365
1366mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001367unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001368
1369#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Simon Butcher99000142016-10-13 17:21:01 +01001370int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001371#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001372
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01001373int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001374#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001375int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001376#endif
1377
Ron Eldor089c9fe2018-12-06 17:12:49 +02001378#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascal43f94902020-09-22 12:25:52 +02001379static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value
1380 ( const uint16_t srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001381{
Johan Pascal43f94902020-09-22 12:25:52 +02001382 switch( srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001383 {
Johan Pascal85269572020-08-25 10:01:54 +02001384 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001385 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascal85269572020-08-25 10:01:54 +02001386 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001387 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascal43f94902020-09-22 12:25:52 +02001388 return srtp_profile_value;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001389 default: break;
1390 }
Johan Pascal43f94902020-09-22 12:25:52 +02001391 return( MBEDTLS_TLS_SRTP_UNSET );
Ron Eldor089c9fe2018-12-06 17:12:49 +02001392}
1393#endif
1394
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001395#if defined(MBEDTLS_X509_CRT_PARSE_C)
1396static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1397{
1398 mbedtls_ssl_key_cert *key_cert;
1399
1400 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1401 key_cert = ssl->handshake->key_cert;
1402 else
1403 key_cert = ssl->conf->key_cert;
1404
1405 return( key_cert == NULL ? NULL : key_cert->key );
1406}
1407
1408static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1409{
1410 mbedtls_ssl_key_cert *key_cert;
1411
1412 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1413 key_cert = ssl->handshake->key_cert;
1414 else
1415 key_cert = ssl->conf->key_cert;
1416
1417 return( key_cert == NULL ? NULL : key_cert->cert );
1418}
1419
1420/*
1421 * Check usage of a certificate wrt extensions:
1422 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1423 *
1424 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1425 * check a cert we received from them)!
1426 *
1427 * Return 0 if everything is OK, -1 if not.
1428 */
1429int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
1430 const mbedtls_ssl_ciphersuite_t *ciphersuite,
1431 int cert_endpoint,
1432 uint32_t *flags );
1433#endif /* MBEDTLS_X509_CRT_PARSE_C */
1434
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001435void mbedtls_ssl_write_version( unsigned char version[2], int transport,
1436 mbedtls_ssl_protocol_version tls_version );
1437uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
1438 int transport );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001439
Hanno Becker5903de42019-05-03 14:46:38 +01001440static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001441{
Hanno Becker47be7682019-07-12 09:55:46 +01001442#if !defined(MBEDTLS_SSL_PROTO_DTLS)
1443 ((void) ssl);
1444#endif
1445
1446#if defined(MBEDTLS_SSL_PROTO_DTLS)
1447 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1448 {
1449 return( 13 );
1450 }
1451 else
1452#endif /* MBEDTLS_SSL_PROTO_DTLS */
1453 {
1454 return( 5 );
1455 }
Hanno Becker5903de42019-05-03 14:46:38 +01001456}
1457
1458static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1459{
Hanno Becker3b154c12019-05-03 15:05:27 +01001460 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001461}
1462
1463static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1464{
1465#if defined(MBEDTLS_SSL_PROTO_DTLS)
1466 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1467 return( 12 );
1468#else
1469 ((void) ssl);
1470#endif
1471 return( 4 );
1472}
1473
1474#if defined(MBEDTLS_SSL_PROTO_DTLS)
1475void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1476void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1477int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001478int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001479#endif
1480
1481/* Visible for testing purposes only */
1482#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker0183d692019-07-12 08:50:37 +01001483int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001484void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1485#endif
1486
Hanno Becker52055ae2019-02-06 14:30:46 +00001487int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1488 const mbedtls_ssl_session *src );
1489
TRodziewicz0f82ec62021-05-12 17:49:18 +02001490#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek814feff2019-01-14 04:35:19 -05001491/* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001492int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001493 unsigned char *hash, size_t *hashlen,
1494 unsigned char *data, size_t data_len,
1495 mbedtls_md_type_t md_alg );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001496#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001497
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001498#ifdef __cplusplus
1499}
1500#endif
1501
Hanno Beckera18d1322018-01-03 14:27:32 +00001502void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1503int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1504 mbedtls_ssl_transform *transform,
1505 mbedtls_record *rec,
1506 int (*f_rng)(void *, unsigned char *, size_t),
1507 void *p_rng );
Hanno Becker605949f2019-07-12 08:23:59 +01001508int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001509 mbedtls_ssl_transform *transform,
1510 mbedtls_record *rec );
1511
Hanno Beckerdd772292020-02-05 10:38:31 +00001512/* Length of the "epoch" field in the record header */
1513static inline size_t mbedtls_ssl_ep_len( const mbedtls_ssl_context *ssl )
1514{
1515#if defined(MBEDTLS_SSL_PROTO_DTLS)
1516 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1517 return( 2 );
1518#else
1519 ((void) ssl);
1520#endif
1521 return( 0 );
1522}
1523
Hanno Becker08f09132020-02-11 15:40:07 +00001524#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker786300f2020-02-05 10:46:40 +00001525int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001526#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker0f57a652020-02-05 10:37:26 +00001527
1528void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs );
Hanno Becker7876d122020-02-05 10:39:31 +00001529int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl );
1530
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001531void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl );
1532void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
1533 mbedtls_ssl_transform *transform );
1534void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl );
1535
Hanno Becker43aefe22020-02-05 10:44:56 +00001536int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial );
XiaokangQian78b1fa72022-01-19 06:56:30 +00001537void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1538 int partial );
Hanno Becker43aefe22020-02-05 10:44:56 +00001539
Jerry Yue7047812021-09-13 19:26:39 +08001540/*
Jerry Yu394ece62021-09-14 22:17:21 +08001541 * Send pending alert
Jerry Yue7047812021-09-13 19:26:39 +08001542 */
1543int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl );
1544
Jerry Yu394ece62021-09-14 22:17:21 +08001545/*
1546 * Set pending fatal alert flag.
1547 */
1548void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
1549 unsigned char alert_type,
1550 int alert_reason );
1551
1552/* Alias of mbedtls_ssl_pend_fatal_alert */
1553#define MBEDTLS_SSL_PEND_FATAL_ALERT( type, user_return_value ) \
1554 mbedtls_ssl_pend_fatal_alert( ssl, type, user_return_value )
1555
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001556#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1557void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl );
1558#endif
1559
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001560void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl );
1561
Hanno Becker08f09132020-02-11 15:40:07 +00001562#if defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker40cdaa12020-02-05 10:48:27 +00001563int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001564#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker89490712020-02-05 10:50:12 +00001565
Hanno Becker533ab5f2020-02-05 10:49:13 +00001566#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker08f09132020-02-11 15:40:07 +00001567size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl );
Hanno Becker533ab5f2020-02-05 10:49:13 +00001568void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl );
1569void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight );
1570#endif /* MBEDTLS_SSL_PROTO_DTLS */
1571
Jerry Yu60835a82021-08-04 10:13:52 +08001572/**
1573 * ssl utils functions for checking configuration.
1574 */
1575
Ronald Cron6f135e12021-12-08 16:57:54 +01001576#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001577static inline int mbedtls_ssl_conf_is_tls13_only( const mbedtls_ssl_config *conf )
1578{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001579 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1580 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001581}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001582
Ronald Cron6f135e12021-12-08 16:57:54 +01001583#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001584
1585#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1586static inline int mbedtls_ssl_conf_is_tls12_only( const mbedtls_ssl_config *conf )
1587{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001588 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1589 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu60835a82021-08-04 10:13:52 +08001590}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001591
Jerry Yu60835a82021-08-04 10:13:52 +08001592#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1593
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001594static inline int mbedtls_ssl_conf_is_tls13_enabled( const mbedtls_ssl_config *conf )
1595{
1596#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001597 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_3 &&
1598 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001599#else
1600 ((void) conf);
1601 return( 0 );
1602#endif
1603}
1604
1605static inline int mbedtls_ssl_conf_is_tls12_enabled( const mbedtls_ssl_config *conf )
1606{
1607#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001608 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 &&
1609 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001610#else
1611 ((void) conf);
1612 return( 0 );
1613#endif
1614}
1615
Ronald Cron6f135e12021-12-08 16:57:54 +01001616#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001617static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13( const mbedtls_ssl_config *conf )
1618{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001619 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1620 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001621}
Ronald Cron6f135e12021-12-08 16:57:54 +01001622#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001623
Ronald Cron6f135e12021-12-08 16:57:54 +01001624#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yua6e6c272021-11-17 17:54:13 +08001625
1626int mbedtls_ssl_tls13_process_finished_message( mbedtls_ssl_context *ssl );
1627int mbedtls_ssl_tls13_write_finished_message( mbedtls_ssl_context *ssl );
1628void mbedtls_ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl );
1629
1630/**
Ronald Cron3d580bf2022-02-18 17:24:56 +01001631 * \brief Given an SSL context and its associated configuration, write the TLS
1632 * 1.3 specific extensions of the ClientHello message.
1633 *
1634 * \param[in] ssl SSL context
1635 * \param[in] buf Base address of the buffer where to write the extensions
1636 * \param[in] end End address of the buffer where to write the extensions
1637 * \param[out] out_len Length of the data written into the buffer \p buf
1638 */
1639int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1640 unsigned char *buf,
1641 unsigned char *end,
1642 size_t *out_len );
1643
1644/**
Jerry Yua6e6c272021-11-17 17:54:13 +08001645 * \brief TLS 1.3 client side state machine entry
1646 *
1647 * \param ssl SSL context
1648 */
1649int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl );
1650
1651/**
1652 * \brief TLS 1.3 server side state machine entry
1653 *
1654 * \param ssl SSL context
1655 */
1656int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl );
1657
Jerry Yu26f4d152021-08-23 17:42:37 +08001658
1659/*
1660 * Helper functions around key exchange modes.
1661 */
Jerry Yub60e3cf2021-09-08 16:41:02 +08001662static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001663 int kex_mode_mask )
1664{
1665 return( ( ssl->conf->tls13_kex_modes & kex_mode_mask ) != 0 );
1666}
1667
Jerry Yub60e3cf2021-09-08 16:41:02 +08001668static inline int mbedtls_ssl_conf_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001669{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001670 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001671 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001672}
1673
1674static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( mbedtls_ssl_context *ssl )
1675{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001676 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001677 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001678}
1679
Jerry Yub60e3cf2021-09-08 16:41:02 +08001680static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001681{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001682 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001683 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001684}
1685
1686static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
1687{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001688 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001689 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001690}
1691
1692static inline int mbedtls_ssl_conf_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
1693{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001694 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001695 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001696}
1697
Jerry Yuadf861a2021-09-29 21:22:08 +08001698/**
1699 * Given a list of key exchange modes, check if at least one of them is
1700 * supported.
1701 *
1702 * \param[in] ssl SSL context
Jerry Yu0cabad32021-09-30 09:52:35 +08001703 * \param kex_modes_mask Mask of the key exchange modes to check
Jerry Yuadf861a2021-09-29 21:22:08 +08001704 *
1705 * \return 0 if at least one of the key exchange modes is supported,
Jerry Yudca3d5d2021-10-08 14:19:29 +08001706 * !=0 otherwise.
Jerry Yuadf861a2021-09-29 21:22:08 +08001707 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001708static inline unsigned mbedtls_ssl_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
1709 int kex_modes_mask )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001710{
Xiaofei Baid25fab62021-12-02 06:36:27 +00001711 return( ( ssl->handshake->tls13_kex_modes & kex_modes_mask ) == 0 );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001712}
1713
Xiaofei Bai746f9482021-11-12 08:53:56 +00001714static inline int mbedtls_ssl_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001715{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001716 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1717 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001718}
1719
Xiaofei Bai746f9482021-11-12 08:53:56 +00001720static inline int mbedtls_ssl_tls13_psk_ephemeral_enabled(
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001721 mbedtls_ssl_context *ssl )
1722{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001723 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1724 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001725}
1726
Xiaofei Bai746f9482021-11-12 08:53:56 +00001727static inline int mbedtls_ssl_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001728{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001729 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1730 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001731}
1732
Xiaofei Bai746f9482021-11-12 08:53:56 +00001733static inline int mbedtls_ssl_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001734{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001735 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1736 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001737}
1738
Xiaofei Bai746f9482021-11-12 08:53:56 +00001739static inline int mbedtls_ssl_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001740{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001741 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1742 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001743}
1744
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001745/*
XiaokangQian6b226b02021-09-24 07:51:16 +00001746 * Fetch TLS 1.3 handshake message header
1747 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001748int mbedtls_ssl_tls13_fetch_handshake_msg( mbedtls_ssl_context *ssl,
1749 unsigned hs_type,
1750 unsigned char **buf,
1751 size_t *buf_len );
XiaokangQian6b226b02021-09-24 07:51:16 +00001752
1753/*
Xiaofei Bai947571e2021-09-29 09:12:03 +00001754 * Handler of TLS 1.3 server certificate message
1755 */
1756int mbedtls_ssl_tls13_process_certificate( mbedtls_ssl_context *ssl );
1757
Jerry Yu90f152d2022-01-29 22:12:42 +08001758#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001759/*
Jerry Yu3e536442022-02-15 11:05:59 +08001760 * Handler of TLS 1.3 write Certificate message
Jerry Yu5cc35062022-01-28 16:16:08 +08001761 */
1762int mbedtls_ssl_tls13_write_certificate( mbedtls_ssl_context *ssl );
1763
1764/*
Jerry Yu3e536442022-02-15 11:05:59 +08001765 * Handler of TLS 1.3 write Certificate Verify message
Jerry Yu8511f122022-01-29 10:01:04 +08001766 */
1767int mbedtls_ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl );
Jerry Yu90f152d2022-01-29 22:12:42 +08001768
1769#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1770
Jerry Yu8511f122022-01-29 10:01:04 +08001771/*
Jerry Yu30b071c2021-09-12 20:16:03 +08001772 * Generic handler of Certificate Verify
1773 */
1774int mbedtls_ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl );
1775
1776/*
Ronald Cron49ad6192021-11-24 16:25:31 +01001777 * Write of dummy-CCS's for middlebox compatibility
1778 */
1779int mbedtls_ssl_tls13_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1780
XiaokangQian647719a2021-12-07 09:16:29 +00001781int mbedtls_ssl_reset_transcript_for_hrr( mbedtls_ssl_context *ssl );
1782
Jerry Yuf017ee42022-01-12 15:49:48 +08001783#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
1784
Jerry Yubc20bdd2021-08-24 15:59:48 +08001785#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001786/*
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001787 * Parse TLS 1.3 Signature Algorithm extension
1788 */
1789int mbedtls_ssl_tls13_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
1790 const unsigned char *buf,
1791 const unsigned char *end );
Jerry Yubc20bdd2021-08-24 15:59:48 +08001792#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu65dd2cc2021-08-18 16:38:40 +08001793
Jerry Yu000f9762021-09-14 11:12:51 +08001794/* Get handshake transcript */
1795int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
1796 const mbedtls_md_type_t md,
1797 unsigned char *dst,
1798 size_t dst_len,
1799 size_t *olen );
1800
Brett Warrene0edc842021-08-17 09:53:13 +01001801/*
1802 * Return supported groups.
1803 *
1804 * In future, invocations can be changed to ssl->conf->group_list
1805 * when mbedtls_ssl_conf_curves() is deleted.
1806 *
1807 * ssl->handshake->group_list is either a translation of curve_list to IANA TLS group
1808 * identifiers when mbedtls_ssl_conf_curves() has been used, or a pointer to
1809 * ssl->conf->group_list when mbedtls_ssl_conf_groups() has been more recently invoked.
1810 *
1811 */
1812static inline const void *mbedtls_ssl_get_groups( const mbedtls_ssl_context *ssl )
1813{
1814 #if defined(MBEDTLS_DEPRECATED_REMOVED) || !defined(MBEDTLS_ECP_C)
1815 return( ssl->conf->group_list );
1816 #else
1817 if( ( ssl->handshake != NULL ) && ( ssl->handshake->group_list != NULL ) )
1818 return( ssl->handshake->group_list );
1819 else
1820 return( ssl->conf->group_list );
1821 #endif
1822}
1823
Jerry Yuba073422021-12-20 22:22:15 +08001824/*
1825 * Helper functions for NamedGroup.
1826 */
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001827static inline int mbedtls_ssl_tls12_named_group_is_ecdhe( uint16_t named_group )
Jerry Yuba073422021-12-20 22:22:15 +08001828{
1829 /*
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001830 * RFC 8422 section 5.1.1
Jerry Yuba073422021-12-20 22:22:15 +08001831 */
Jerry Yuf0fede52022-01-12 10:57:47 +08001832 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
1833 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 ||
1834 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 ||
1835 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 ||
1836 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 ||
1837 /* Below deprected curves should be removed with notice to users */
1838 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 ||
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001839 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 ||
1840 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 ||
1841 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 ||
1842 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 ||
1843 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
1844 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
Jerry Yuf0fede52022-01-12 10:57:47 +08001845 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 );
Jerry Yuba073422021-12-20 22:22:15 +08001846}
1847
1848static inline int mbedtls_ssl_tls13_named_group_is_ecdhe( uint16_t named_group )
1849{
Jerry Yuf0fede52022-01-12 10:57:47 +08001850 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
1851 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08001852 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
1853 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08001854 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 );
1855}
1856
1857static inline int mbedtls_ssl_tls13_named_group_is_dhe( uint16_t named_group )
1858{
1859 return( named_group >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 &&
1860 named_group <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 );
1861}
1862
Jerry Yuafdfed12021-12-22 10:49:02 +08001863/*
Jerry Yu713013f2022-01-17 18:16:35 +08001864 * Return supported signature algorithms.
1865 *
1866 * In future, invocations can be changed to ssl->conf->sig_algs when
1867 * mbedtls_ssl_conf_sig_hashes() is deleted.
1868 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08001869 * ssl->handshake->sig_algs is either a translation of sig_hashes to IANA TLS
1870 * signature algorithm identifiers when mbedtls_ssl_conf_sig_hashes() has been
1871 * used, or a pointer to ssl->conf->sig_algs when mbedtls_ssl_conf_sig_algs() has
1872 * been more recently invoked.
1873 *
Jerry Yuafdfed12021-12-22 10:49:02 +08001874 */
Jerry Yu713013f2022-01-17 18:16:35 +08001875static inline const void *mbedtls_ssl_get_sig_algs(
1876 const mbedtls_ssl_context *ssl )
Jerry Yuafdfed12021-12-22 10:49:02 +08001877{
1878#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01001879
Jerry Yu6106fdc2022-01-12 16:36:14 +08001880#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1881 if( ssl->handshake != NULL && ssl->handshake->sig_algs != NULL )
1882 return( ssl->handshake->sig_algs );
1883#endif
1884 return( ssl->conf->sig_algs );
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01001885
1886#else /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08001887
Jerry Yu6106fdc2022-01-12 16:36:14 +08001888 ((void) ssl);
Jerry Yu713013f2022-01-17 18:16:35 +08001889 return( NULL );
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01001890#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08001891}
Jerry Yuba073422021-12-20 22:22:15 +08001892
Jerry Yua23b9d92022-02-09 19:57:53 +08001893
Jerry Yu1bab3012022-01-19 17:43:22 +08001894#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu24811fb2022-01-19 18:02:15 +08001895
Jerry Yua23b9d92022-02-09 19:57:53 +08001896#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu8511f122022-01-29 10:01:04 +08001897static inline int mbedtls_ssl_sig_alg_is_received( const mbedtls_ssl_context *ssl,
1898 uint16_t own_sig_alg )
1899{
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08001900 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
1901 if( sig_alg == NULL )
1902 return( 0 );
1903
1904 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
1905 {
1906 if( *sig_alg == own_sig_alg )
1907 return( 1 );
1908 }
1909 return( 0 );
Jerry Yu8511f122022-01-29 10:01:04 +08001910}
Jerry Yua23b9d92022-02-09 19:57:53 +08001911#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu8511f122022-01-29 10:01:04 +08001912
Jerry Yu24811fb2022-01-19 18:02:15 +08001913static inline int mbedtls_ssl_sig_alg_is_offered( const mbedtls_ssl_context *ssl,
1914 uint16_t proposed_sig_alg )
1915{
1916 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
1917 if( sig_alg == NULL )
1918 return( 0 );
1919
1920 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
1921 {
1922 if( *sig_alg == proposed_sig_alg )
1923 return( 1 );
1924 }
1925 return( 0 );
1926}
1927
Jerry Yu8c338862022-03-23 13:34:04 +08001928#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
1929static inline int mbedtls_ssl_tls13_get_pk_type_and_md_alg_from_sig_alg(
Jerry Yuf8aa9a42022-03-23 20:40:28 +08001930 uint16_t sig_alg, mbedtls_pk_type_t *pk_type, mbedtls_md_type_t *md_alg )
Jerry Yu8c338862022-03-23 13:34:04 +08001931{
1932 *pk_type = MBEDTLS_PK_NONE;
1933 *md_alg = MBEDTLS_MD_NONE;
Jerry Yuf8aa9a42022-03-23 20:40:28 +08001934
Jerry Yu8c338862022-03-23 13:34:04 +08001935 switch( sig_alg )
1936 {
Jerry Yue26acee2022-03-23 21:01:33 +08001937#if defined(MBEDTLS_ECDSA_C)
1938
1939#if defined(MBEDTLS_SHA256_C) && defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Jerry Yu8c338862022-03-23 13:34:04 +08001940 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1941 *md_alg = MBEDTLS_MD_SHA256;
1942 *pk_type = MBEDTLS_PK_ECDSA;
1943 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001944#endif /* MBEDTLS_SHA256_C && MBEDTLS_ECP_DP_SECP256R1_ENABLED */
Jerry Yu8c338862022-03-23 13:34:04 +08001945
Jerry Yue26acee2022-03-23 21:01:33 +08001946#if defined(MBEDTLS_SHA384_C) && defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Jerry Yu8c338862022-03-23 13:34:04 +08001947 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1948 *md_alg = MBEDTLS_MD_SHA384;
1949 *pk_type = MBEDTLS_PK_ECDSA;
1950 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001951#endif /* MBEDTLS_SHA384_C && MBEDTLS_ECP_DP_SECP384R1_ENABLED */
Jerry Yu8c338862022-03-23 13:34:04 +08001952
Jerry Yue26acee2022-03-23 21:01:33 +08001953#if defined(MBEDTLS_SHA512_C) && defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Jerry Yu8c338862022-03-23 13:34:04 +08001954 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1955 *md_alg = MBEDTLS_MD_SHA512;
1956 *pk_type = MBEDTLS_PK_ECDSA;
1957 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001958#endif /* MBEDTLS_SHA512_C && MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu8c338862022-03-23 13:34:04 +08001959
Jerry Yue26acee2022-03-23 21:01:33 +08001960#endif /* MBEDTLS_ECDSA_C */
1961
1962#if defined(MBEDTLS_X509_RSASSA_PSS_SUPPORT)
1963
1964#if defined(MBEDTLS_SHA256_C)
Jerry Yu8c338862022-03-23 13:34:04 +08001965 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1966 *md_alg = MBEDTLS_MD_SHA256;
1967 *pk_type = MBEDTLS_PK_RSASSA_PSS;
1968 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001969#endif /* MBEDTLS_SHA256_C */
Jerry Yu8c338862022-03-23 13:34:04 +08001970
Jerry Yue26acee2022-03-23 21:01:33 +08001971#if defined(MBEDTLS_SHA384_C)
Jerry Yu8c338862022-03-23 13:34:04 +08001972 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1973 *md_alg = MBEDTLS_MD_SHA384;
1974 *pk_type = MBEDTLS_PK_RSASSA_PSS;
1975 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001976#endif /* MBEDTLS_SHA384_C */
Jerry Yu8c338862022-03-23 13:34:04 +08001977
Jerry Yue26acee2022-03-23 21:01:33 +08001978#if defined(MBEDTLS_SHA512_C)
Jerry Yu8c338862022-03-23 13:34:04 +08001979 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1980 *md_alg = MBEDTLS_MD_SHA512;
1981 *pk_type = MBEDTLS_PK_RSASSA_PSS;
1982 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001983#endif /* MBEDTLS_SHA512_C */
Jerry Yu8c338862022-03-23 13:34:04 +08001984
Jerry Yue26acee2022-03-23 21:01:33 +08001985#endif /* MBEDTLS_X509_RSASSA_PSS_SUPPORT */
1986
1987#if defined(MBEDTLS_PKCS1_V15) && defined(MBEDTLS_RSA_C)
1988
1989#if defined(MBEDTLS_SHA256_C)
Jerry Yu8c338862022-03-23 13:34:04 +08001990 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
1991 *md_alg = MBEDTLS_MD_SHA256;
1992 *pk_type = MBEDTLS_PK_RSA;
1993 break;
Jerry Yue26acee2022-03-23 21:01:33 +08001994#endif /* MBEDTLS_SHA256_C */
Jerry Yu8c338862022-03-23 13:34:04 +08001995
Jerry Yue26acee2022-03-23 21:01:33 +08001996#if defined(MBEDTLS_SHA384_C)
Jerry Yu8c338862022-03-23 13:34:04 +08001997 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
1998 *md_alg = MBEDTLS_MD_SHA384;
1999 *pk_type = MBEDTLS_PK_RSA;
2000 break;
Jerry Yue26acee2022-03-23 21:01:33 +08002001#endif /* MBEDTLS_SHA384_C */
Jerry Yu8c338862022-03-23 13:34:04 +08002002
Jerry Yue26acee2022-03-23 21:01:33 +08002003#if defined(MBEDTLS_SHA512_C)
Jerry Yu8c338862022-03-23 13:34:04 +08002004 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
2005 *md_alg = MBEDTLS_MD_SHA512;
2006 *pk_type = MBEDTLS_PK_RSA;
2007 break;
Jerry Yu6c6f1022022-03-25 11:09:50 +08002008#endif /* MBEDTLS_SHA512_C */
Jerry Yue26acee2022-03-23 21:01:33 +08002009
2010#endif /* MBEDTLS_PKCS1_V15 && MBEDTLS_RSA_C */
Jerry Yu8c338862022-03-23 13:34:04 +08002011
2012 default:
Jerry Yuf8aa9a42022-03-23 20:40:28 +08002013 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu8c338862022-03-23 13:34:04 +08002014 }
Jerry Yuf8aa9a42022-03-23 20:40:28 +08002015 return( 0 );
Jerry Yu8c338862022-03-23 13:34:04 +08002016}
2017#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2018
Jerry Yu1bab3012022-01-19 17:43:22 +08002019static inline int mbedtls_ssl_sig_alg_is_supported(
2020 const mbedtls_ssl_context *ssl,
2021 const uint16_t sig_alg )
2022{
2023
2024#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002025 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002026 {
2027 /* High byte is hash */
2028 unsigned char hash = MBEDTLS_BYTE_1( sig_alg );
2029 unsigned char sig = MBEDTLS_BYTE_0( sig_alg );
2030
2031 switch( hash )
2032 {
Jerry Yu97198852022-01-21 16:16:01 +08002033#if defined(MBEDTLS_MD5_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002034 case MBEDTLS_SSL_HASH_MD5:
2035 break;
Jerry Yu97198852022-01-21 16:16:01 +08002036#endif
2037
2038#if defined(MBEDTLS_SHA1_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002039 case MBEDTLS_SSL_HASH_SHA1:
2040 break;
Jerry Yu97198852022-01-21 16:16:01 +08002041#endif
2042
2043#if defined(MBEDTLS_SHA224_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002044 case MBEDTLS_SSL_HASH_SHA224:
2045 break;
Jerry Yu97198852022-01-21 16:16:01 +08002046#endif
2047
2048#if defined(MBEDTLS_SHA256_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002049 case MBEDTLS_SSL_HASH_SHA256:
2050 break;
Jerry Yu97198852022-01-21 16:16:01 +08002051#endif
2052
2053#if defined(MBEDTLS_SHA384_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002054 case MBEDTLS_SSL_HASH_SHA384:
2055 break;
Jerry Yu97198852022-01-21 16:16:01 +08002056#endif
2057
2058#if defined(MBEDTLS_SHA512_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002059 case MBEDTLS_SSL_HASH_SHA512:
2060 break;
Jerry Yu97198852022-01-21 16:16:01 +08002061#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002062
2063 default:
2064 return( 0 );
2065 }
2066
2067 switch( sig )
2068 {
Jerry Yu97198852022-01-21 16:16:01 +08002069#if defined(MBEDTLS_RSA_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002070 case MBEDTLS_SSL_SIG_RSA:
2071 break;
Jerry Yu97198852022-01-21 16:16:01 +08002072#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002073
Jerry Yu97198852022-01-21 16:16:01 +08002074#if defined(MBEDTLS_ECDSA_C)
Jerry Yu1bab3012022-01-19 17:43:22 +08002075 case MBEDTLS_SSL_SIG_ECDSA:
2076 break;
Jerry Yu97198852022-01-21 16:16:01 +08002077#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002078
2079 default:
2080 return( 0 );
2081 }
2082
2083 return( 1 );
2084 }
2085#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2086
2087#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002088 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002089 {
Jerry Yu8c338862022-03-23 13:34:04 +08002090 mbedtls_pk_type_t pk_type;
2091 mbedtls_md_type_t md_alg;
Jerry Yuf8aa9a42022-03-23 20:40:28 +08002092 return( ! mbedtls_ssl_tls13_get_pk_type_and_md_alg_from_sig_alg(
Jerry Yu8c338862022-03-23 13:34:04 +08002093 sig_alg, &pk_type, &md_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002094 }
2095#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2096 ((void) ssl);
2097 ((void) sig_alg);
2098 return( 0 );
2099}
2100#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
2101
Jerry Yue12f1dd2022-01-13 14:38:22 +08002102#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
2103 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2104#if defined(MBEDTLS_ECDSA_C) && defined(MBEDTLS_RSA_C)
2105#define MBEDTLS_SSL_SIG_ALG( hash ) (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA), \
2106 (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA),
2107#elif defined(MBEDTLS_ECDSA_C)
2108#define MBEDTLS_SSL_SIG_ALG( hash ) (( hash << 8 ) | MBEDTLS_SSL_SIG_ECDSA),
2109#elif defined(MBEDTLS_RSA_C)
2110#define MBEDTLS_SSL_SIG_ALG( hash ) (( hash << 8 ) | MBEDTLS_SSL_SIG_RSA),
2111#else
2112#define MBEDTLS_SSL_SIG_ALG( hash )
2113#endif /* MBEDTLS_ECDSA_C && MBEDTLS_RSA_C */
2114#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002115#if defined(MBEDTLS_USE_PSA_CRYPTO)
2116/* Corresponding PSA algorithm for MBEDTLS_CIPHER_NULL.
2117 * Same value is used fo PSA_ALG_CATEGORY_CIPHER, hence it is
2118 * guaranteed to not be a valid PSA algorithm identifier.
2119 */
2120#define MBEDTLS_SSL_NULL_CIPHER 0x04000000
2121
2122/**
2123 * \brief Translate mbedtls cipher type/taglen pair to psa:
2124 * algorithm, key type and key size.
2125 *
2126 * \param mbedtls_cipher_type [in] given mbedtls cipher type
2127 * \param taglen [in] given tag length
2128 * 0 - default tag length
2129 * \param alg [out] corresponding PSA alg
2130 * There is no corresponding PSA
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01002131 * alg for MBEDTLS_CIPHER_NULL, so
2132 * in this case MBEDTLS_SSL_NULL_CIPHER
2133 * is returned via this parameter
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002134 * \param key_type [out] corresponding PSA key type
2135 * \param key_size [out] corresponding PSA key size
2136 *
2137 * \return PSA_SUCCESS on success or PSA_ERROR_NOT_SUPPORTED if
2138 * conversion is not supported.
2139 */
2140psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
2141 size_t taglen,
2142 psa_algorithm_t *alg,
2143 psa_key_type_t *key_type,
2144 size_t *key_size );
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002145#endif /* MBEDTLS_USE_PSA_CRYPTO */
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002146
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002147#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002148/**
2149 * \brief Convert given PSA status to mbedtls error code.
2150 *
2151 * \param status [in] given PSA status
2152 *
2153 * \return corresponding mbedtls error code
2154 */
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01002155static inline int psa_ssl_status_to_mbedtls( psa_status_t status )
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002156{
2157 switch( status )
2158 {
2159 case PSA_SUCCESS:
2160 return( 0 );
2161 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002162 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002163 case PSA_ERROR_NOT_SUPPORTED:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002164 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Przemyslaw Stekiel89dad932022-01-31 09:18:07 +01002165 case PSA_ERROR_INVALID_SIGNATURE:
2166 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Gabor Mezeiadfeadc2022-03-21 12:17:49 +01002167 case PSA_ERROR_INVALID_ARGUMENT:
2168 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2169 case PSA_ERROR_BAD_STATE:
2170 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemek Stekiel85836272022-04-05 10:50:53 +02002171 case PSA_ERROR_BUFFER_TOO_SMALL:
2172 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002173 default:
2174 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
2175 }
2176}
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002177#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu1bab3012022-01-19 17:43:22 +08002178
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002179#if defined(MBEDTLS_ECDH_C)
2180
2181int mbedtls_ssl_tls13_read_public_ecdhe_share( mbedtls_ssl_context *ssl,
2182 const unsigned char *buf,
2183 size_t buf_len );
2184
2185#endif /* MBEDTLS_ECDH_C */
2186
Chris Jones84a773f2021-03-05 18:38:47 +00002187#endif /* ssl_misc.h */