blob: 2b1f90f4f3eb6f81a3d9c8b632634ac84c78d798 [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"
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +020033#include "hash_info.h"
Andrzej Kurekeb342242019-01-29 09:14:33 -050034#endif
Manuel Pégourié-Gonnard07018f92022-09-15 11:29:35 +020035#include "mbedtls/legacy_or_psa.h"
Andrzej Kurekeb342242019-01-29 09:14:33 -050036
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020037#if defined(MBEDTLS_MD5_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010038#include "mbedtls/md5.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020039#endif
40
41#if defined(MBEDTLS_SHA1_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010042#include "mbedtls/sha1.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020043#endif
44
45#if defined(MBEDTLS_SHA256_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010046#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020047#endif
48
49#if defined(MBEDTLS_SHA512_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010050#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020051#endif
52
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +020053#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jaeden Amero6609aef2019-07-04 20:01:14 +010054#include "mbedtls/ecjpake.h"
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +020055#endif
56
Jerry Yu1bab3012022-01-19 17:43:22 +080057#include "common.h"
58
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010059#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
60 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020061#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020062#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020063
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +020064/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020065#if defined(MBEDTLS_ECP_RESTARTABLE) && \
66 defined(MBEDTLS_SSL_CLI_C) && \
67 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
68 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +010069#define MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020070#endif
71
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020072#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
73#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
74#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
75#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
76
Jerry Yud25cab02022-10-31 12:48:30 +080077/* Faked handshake message identity for HelloRetryRequest. */
78#define MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST ( -MBEDTLS_SSL_HS_SERVER_HELLO )
79
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020080/*
Jerry Yuea52ed92022-11-08 21:01:17 +080081 * Internal identity of handshake extensions
Jerry Yu8e7ca042021-08-26 15:31:37 +080082 */
Jerry Yu7a485c12022-10-31 13:08:18 +080083#define MBEDTLS_SSL_EXT_ID_UNRECOGNIZED 0
84#define MBEDTLS_SSL_EXT_ID_SERVERNAME 1
85#define MBEDTLS_SSL_EXT_ID_SERVERNAME_HOSTNAME 1
86#define MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH 2
87#define MBEDTLS_SSL_EXT_ID_STATUS_REQUEST 3
88#define MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS 4
89#define MBEDTLS_SSL_EXT_ID_SUPPORTED_ELLIPTIC_CURVES 4
90#define MBEDTLS_SSL_EXT_ID_SIG_ALG 5
91#define MBEDTLS_SSL_EXT_ID_USE_SRTP 6
92#define MBEDTLS_SSL_EXT_ID_HEARTBEAT 7
93#define MBEDTLS_SSL_EXT_ID_ALPN 8
94#define MBEDTLS_SSL_EXT_ID_SCT 9
95#define MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE 10
96#define MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE 11
97#define MBEDTLS_SSL_EXT_ID_PADDING 12
98#define MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY 13
99#define MBEDTLS_SSL_EXT_ID_EARLY_DATA 14
100#define MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS 15
101#define MBEDTLS_SSL_EXT_ID_COOKIE 16
102#define MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES 17
103#define MBEDTLS_SSL_EXT_ID_CERT_AUTH 18
104#define MBEDTLS_SSL_EXT_ID_OID_FILTERS 19
105#define MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH 20
106#define MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT 21
107#define MBEDTLS_SSL_EXT_ID_KEY_SHARE 22
108#define MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC 23
109#define MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS 24
110#define MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC 25
111#define MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET 26
112#define MBEDTLS_SSL_EXT_ID_SESSION_TICKET 27
Jerry Yu8e7ca042021-08-26 15:31:37 +0800113
Jerry Yu7a485c12022-10-31 13:08:18 +0800114/* Utility for translating IANA extension type. */
115uint32_t mbedtls_ssl_get_extension_id( unsigned int extension_type );
116uint32_t mbedtls_ssl_get_extension_mask( unsigned int extension_type );
117/* Macros used to define mask constants */
118#define MBEDTLS_SSL_EXT_MASK( id ) ( 1ULL << ( MBEDTLS_SSL_EXT_ID_##id ) )
119/* Reset value of extension mask */
120#define MBEDTLS_SSL_EXT_MASK_NONE 0
Jerry Yu93bcd612021-08-18 12:47:24 +0800121
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800122/* In messages containing extension requests, we should ignore unrecognized
123 * extensions. In messages containing extension responses, unrecognized
124 * extensions should result in handshake abortion. Messages containing
125 * extension requests include ClientHello, CertificateRequest and
126 * NewSessionTicket. Messages containing extension responses include
127 * ServerHello, HelloRetryRequest, EncryptedExtensions and Certificate.
Jerry Yue18dc7e2022-08-04 16:29:22 +0800128 *
Jerry Yud15992d2022-08-29 10:58:31 +0800129 * RFC 8446 section 4.1.3
Jerry Yue18dc7e2022-08-04 16:29:22 +0800130 *
131 * The ServerHello MUST only include extensions which are required to establish
132 * the cryptographic context and negotiate the protocol version.
133 *
Jerry Yud15992d2022-08-29 10:58:31 +0800134 * RFC 8446 section 4.2
Jerry Yue18dc7e2022-08-04 16:29:22 +0800135 *
136 * If an implementation receives an extension which it recognizes and which is
137 * not specified for the message in which it appears, it MUST abort the handshake
138 * with an "illegal_parameter" alert.
139 */
Jerry Yudf0ad652022-10-31 13:20:57 +0800140
Jerry Yuea52ed92022-11-08 21:01:17 +0800141/* Extensions that are not recognized by TLS 1.3 */
142#define MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED \
Jerry Yudf0ad652022-10-31 13:20:57 +0800143 ( MBEDTLS_SSL_EXT_MASK( SUPPORTED_POINT_FORMATS ) | \
144 MBEDTLS_SSL_EXT_MASK( ENCRYPT_THEN_MAC ) | \
145 MBEDTLS_SSL_EXT_MASK( EXTENDED_MASTER_SECRET ) | \
146 MBEDTLS_SSL_EXT_MASK( SESSION_TICKET ) | \
Jerry Yub95dd362022-11-08 21:19:34 +0800147 MBEDTLS_SSL_EXT_MASK( TRUNCATED_HMAC ) | \
Jerry Yudf0ad652022-10-31 13:20:57 +0800148 MBEDTLS_SSL_EXT_MASK( UNRECOGNIZED ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800149
Jerry Yud15992d2022-08-29 10:58:31 +0800150/* RFC 8446 section 4.2. Allowed extensions for ClienHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800151#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH \
Jerry Yudf0ad652022-10-31 13:20:57 +0800152 ( MBEDTLS_SSL_EXT_MASK( SERVERNAME ) | \
153 MBEDTLS_SSL_EXT_MASK( MAX_FRAGMENT_LENGTH ) | \
154 MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \
155 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) | \
156 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) | \
157 MBEDTLS_SSL_EXT_MASK( USE_SRTP ) | \
158 MBEDTLS_SSL_EXT_MASK( HEARTBEAT ) | \
159 MBEDTLS_SSL_EXT_MASK( ALPN ) | \
160 MBEDTLS_SSL_EXT_MASK( SCT ) | \
161 MBEDTLS_SSL_EXT_MASK( CLI_CERT_TYPE ) | \
162 MBEDTLS_SSL_EXT_MASK( SERV_CERT_TYPE ) | \
163 MBEDTLS_SSL_EXT_MASK( PADDING ) | \
164 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \
165 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) | \
166 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) | \
167 MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) | \
168 MBEDTLS_SSL_EXT_MASK( COOKIE ) | \
169 MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) | \
170 MBEDTLS_SSL_EXT_MASK( CERT_AUTH ) | \
171 MBEDTLS_SSL_EXT_MASK( POST_HANDSHAKE_AUTH ) | \
172 MBEDTLS_SSL_EXT_MASK( SIG_ALG_CERT ) | \
Jerry Yuea52ed92022-11-08 21:01:17 +0800173 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800174
Jerry Yud15992d2022-08-29 10:58:31 +0800175/* RFC 8446 section 4.2. Allowed extensions for EncryptedExtensions */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800176#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE \
Jerry Yudf0ad652022-10-31 13:20:57 +0800177 ( MBEDTLS_SSL_EXT_MASK( SERVERNAME ) | \
178 MBEDTLS_SSL_EXT_MASK( MAX_FRAGMENT_LENGTH ) | \
179 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) | \
180 MBEDTLS_SSL_EXT_MASK( USE_SRTP ) | \
181 MBEDTLS_SSL_EXT_MASK( HEARTBEAT ) | \
182 MBEDTLS_SSL_EXT_MASK( ALPN ) | \
183 MBEDTLS_SSL_EXT_MASK( CLI_CERT_TYPE ) | \
184 MBEDTLS_SSL_EXT_MASK( SERV_CERT_TYPE ) | \
185 MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800186
Jerry Yud15992d2022-08-29 10:58:31 +0800187/* RFC 8446 section 4.2. Allowed extensions for CertificateRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800188#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR \
Jerry Yudf0ad652022-10-31 13:20:57 +0800189 ( MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \
190 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) | \
191 MBEDTLS_SSL_EXT_MASK( SCT ) | \
192 MBEDTLS_SSL_EXT_MASK( CERT_AUTH ) | \
193 MBEDTLS_SSL_EXT_MASK( OID_FILTERS ) | \
194 MBEDTLS_SSL_EXT_MASK( SIG_ALG_CERT ) | \
Jerry Yuea52ed92022-11-08 21:01:17 +0800195 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800196
Jerry Yud15992d2022-08-29 10:58:31 +0800197/* RFC 8446 section 4.2. Allowed extensions for Certificate */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800198#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CT \
Jerry Yudf0ad652022-10-31 13:20:57 +0800199 ( MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \
200 MBEDTLS_SSL_EXT_MASK( SCT ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800201
Jerry Yud15992d2022-08-29 10:58:31 +0800202/* RFC 8446 section 4.2. Allowed extensions for ServerHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800203#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH \
Jerry Yudf0ad652022-10-31 13:20:57 +0800204 ( MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \
205 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) | \
206 MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800207
Jerry Yud15992d2022-08-29 10:58:31 +0800208/* RFC 8446 section 4.2. Allowed extensions for HelloRetryRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800209#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR \
Jerry Yudf0ad652022-10-31 13:20:57 +0800210 ( MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \
211 MBEDTLS_SSL_EXT_MASK( COOKIE ) | \
212 MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800213
Jerry Yud15992d2022-08-29 10:58:31 +0800214/* RFC 8446 section 4.2. Allowed extensions for NewSessionTicket */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800215#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST \
Jerry Yudf0ad652022-10-31 13:20:57 +0800216 ( MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) | \
Jerry Yuea52ed92022-11-08 21:01:17 +0800217 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800218
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800219/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800220 * Helper macros for function call with return check.
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800221 */
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800222/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800223 * Exit when return non-zero value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800224 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800225#define MBEDTLS_SSL_PROC_CHK( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800226 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800227 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800228 if( ret != 0 ) \
229 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800230 goto cleanup; \
231 } \
232 } while( 0 )
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800233/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800234 * Exit when return negative value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800235 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800236#define MBEDTLS_SSL_PROC_CHK_NEG( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800237 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800238 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800239 if( ret < 0 ) \
240 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800241 goto cleanup; \
242 } \
243 } while( 0 )
244
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200245/*
246 * DTLS retransmission states, see RFC 6347 4.2.4
247 *
248 * The SENDING state is merged in PREPARING for initial sends,
249 * but is distinct for resends.
250 *
251 * Note: initial state is wrong for server, but is not used anyway.
252 */
253#define MBEDTLS_SSL_RETRANS_PREPARING 0
254#define MBEDTLS_SSL_RETRANS_SENDING 1
255#define MBEDTLS_SSL_RETRANS_WAITING 2
256#define MBEDTLS_SSL_RETRANS_FINISHED 3
257
258/*
259 * Allow extra bytes for record, authentication and encryption overhead:
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100260 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256).
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200261 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200262
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200263#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0cc46612020-11-30 08:56:52 +0000264
Manuel Pégourié-Gonnard05579c42020-07-31 12:53:39 +0200265/* This macro determines whether CBC is supported. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200266#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
267 ( defined(MBEDTLS_AES_C) || \
268 defined(MBEDTLS_CAMELLIA_C) || \
269 defined(MBEDTLS_ARIA_C) || \
270 defined(MBEDTLS_DES_C) )
271#define MBEDTLS_SSL_SOME_SUITES_USE_CBC
272#endif
273
Hanno Becker0cc46612020-11-30 08:56:52 +0000274/* This macro determines whether a ciphersuite using a
275 * stream cipher can be used. */
276#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
277#define MBEDTLS_SSL_SOME_SUITES_USE_STREAM
278#endif
279
TRodziewicz0f82ec62021-05-12 17:49:18 +0200280/* This macro determines whether the CBC construct used in TLS 1.2 is supported. */
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200281#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200282 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200283#define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC
284#endif
285
Hanno Becker31351ce2021-03-22 11:05:58 +0000286#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200287 defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000288#define MBEDTLS_SSL_SOME_SUITES_USE_MAC
Hanno Becker52344c22018-01-03 15:24:20 +0000289#endif
290
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200291/* This macro determines whether a ciphersuite uses Encrypt-then-MAC with CBC */
292#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
293 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
294#define MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM
295#endif
296
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200297#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker0cc46612020-11-30 08:56:52 +0000298
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000299#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200300/* Ciphersuites using HMAC */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400301#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200302#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400303#elif defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200304#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
305#else
306#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
307#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000308#else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200309/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
310#define MBEDTLS_SSL_MAC_ADD 16
311#endif
312
313#if defined(MBEDTLS_CIPHER_MODE_CBC)
314#define MBEDTLS_SSL_PADDING_ADD 256
315#else
316#define MBEDTLS_SSL_PADDING_ADD 0
317#endif
318
Hanno Beckera0e20d02019-05-15 14:03:01 +0100319#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
TRodziewicze8dd7092021-05-12 14:19:11 +0200320#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Hanno Becker6cbad552019-05-08 15:40:11 +0100321#else
322#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
323#endif
324
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100325#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_MAX_IV_LENGTH + \
Angus Grattond8213d02016-05-25 20:56:48 +1000326 MBEDTLS_SSL_MAC_ADD + \
Hanno Becker6cbad552019-05-08 15:40:11 +0100327 MBEDTLS_SSL_PADDING_ADD + \
328 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000329 )
330
331#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
332 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
333
334#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
335 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
336
Hanno Becker0271f962018-08-16 13:23:47 +0100337/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100338#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100339
Angus Grattond8213d02016-05-25 20:56:48 +1000340/* Maximum length we can advertise as our max content length for
341 RFC 6066 max_fragment_length extension negotiation purposes
342 (the lesser of both sizes, if they are unequal.)
343 */
344#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
345 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
346 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
347 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
348 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200349
Jerry Yu4131ec12022-01-19 10:36:30 +0800350/* Maximum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
351#define MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN 65534
352
Jerry Yu8afd6e42022-01-20 15:54:26 +0800353/* Minimum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
Jerry Yu4131ec12022-01-19 10:36:30 +0800354#define MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN 2
Hanno Beckere131bfe2017-04-12 14:54:42 +0100355
356/* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */
357#define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535
358
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000359#define MBEDTLS_RECEIVED_SIG_ALGS_SIZE 20
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +0000360
Ronald Crone68ab4f2022-10-05 12:46:29 +0200361#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200362
Gabor Mezei24c7c2b2022-05-10 12:51:14 +0200363#define MBEDTLS_TLS_SIG_NONE MBEDTLS_TLS1_3_SIG_NONE
364
Gabor Mezei15b95a62022-05-09 16:37:58 +0200365#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gabor Mezei3631cf62022-05-10 12:59:00 +0200366#define MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( sig, hash ) (( hash << 8 ) | sig)
367#define MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg & 0xFF)
368#define MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg >> 8)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200369#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
370
Ronald Crone68ab4f2022-10-05 12:46:29 +0200371#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei15b95a62022-05-09 16:37:58 +0200372
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200373/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100374 * Check that we obey the standard's message size bounds
375 */
376
David Horstmann95d516f2021-05-04 18:36:56 +0100377#if MBEDTLS_SSL_IN_CONTENT_LEN > 16384
378#error "Bad configuration - incoming record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100379#endif
380
David Horstmann95d516f2021-05-04 18:36:56 +0100381#if MBEDTLS_SSL_OUT_CONTENT_LEN > 16384
382#error "Bad configuration - outgoing record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100383#endif
384
David Horstmann95d516f2021-05-04 18:36:56 +0100385#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000386#error "Bad configuration - incoming protected record payload too large."
387#endif
388
David Horstmann95d516f2021-05-04 18:36:56 +0100389#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000390#error "Bad configuration - outgoing protected record payload too large."
391#endif
392
393/* Calculate buffer sizes */
394
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000395/* Note: Even though the TLS record header is only 5 bytes
396 long, we're internally using 8 bytes to store the
397 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100398#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100399
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500400#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000401#define MBEDTLS_SSL_IN_BUFFER_LEN \
402 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100403#else
404#define MBEDTLS_SSL_IN_BUFFER_LEN \
405 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
406 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
407#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000408
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500409#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000410#define MBEDTLS_SSL_OUT_BUFFER_LEN \
411 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100412#else
413#define MBEDTLS_SSL_OUT_BUFFER_LEN \
414 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
415 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
416#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000417
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800418#define MBEDTLS_CLIENT_HELLO_RANDOM_LEN 32
419#define MBEDTLS_SERVER_HELLO_RANDOM_LEN 32
420
Hanno Becker9752aad2021-04-21 05:54:33 +0100421#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
422/**
423 * \brief Return the maximum fragment length (payload, in bytes) for
424 * the output buffer. For the client, this is the configured
425 * value. For the server, it is the minimum of two - the
426 * configured value and the negotiated one.
427 *
428 * \sa mbedtls_ssl_conf_max_frag_len()
429 * \sa mbedtls_ssl_get_max_out_record_payload()
430 *
431 * \param ssl SSL context
432 *
433 * \return Current maximum fragment length for the output buffer.
434 */
435size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl );
436
437/**
438 * \brief Return the maximum fragment length (payload, in bytes) for
439 * the input buffer. This is the negotiated maximum fragment
Hanno Beckerdf3b8632021-06-08 05:30:45 +0100440 * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN.
Hanno Becker9752aad2021-04-21 05:54:33 +0100441 * If it is not defined either, the value is 2^14. This function
442 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
443 *
444 * \sa mbedtls_ssl_conf_max_frag_len()
445 * \sa mbedtls_ssl_get_max_in_record_payload()
446 *
447 * \param ssl SSL context
448 *
449 * \return Current maximum fragment length for the output buffer.
450 */
451size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl );
452#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
453
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500454#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500455static inline size_t mbedtls_ssl_get_output_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500456{
457#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500458 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500459 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
460 + MBEDTLS_SSL_CID_OUT_LEN_MAX;
461#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500462 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500463 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
464#endif
465}
466
Andrzej Kurek069fa962021-01-07 08:02:15 -0500467static inline size_t mbedtls_ssl_get_input_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500468{
469#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500470 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500471 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
472 + MBEDTLS_SSL_CID_IN_LEN_MAX;
473#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500474 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500475 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
476#endif
477}
478#endif
479
Hanno Beckera8434e82017-09-18 10:54:39 +0100480/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200481 * TLS extension flags (for extensions with outgoing ServerHello content
482 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
483 * of state of the renegotiation flag, so no indicator is required)
484 */
485#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200486#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200487
Hanno Becker51018aa2017-04-12 14:54:42 +0100488/**
489 * \brief This function checks if the remaining size in a buffer is
490 * greater or equal than a needed space.
491 *
492 * \param cur Pointer to the current position in the buffer.
493 * \param end Pointer to one past the end of the buffer.
494 * \param need Needed space in bytes.
495 *
Ronald Cronb7b35e12020-06-11 09:50:51 +0200496 * \return Zero if the needed space is available in the buffer, non-zero
Hanno Becker51018aa2017-04-12 14:54:42 +0100497 * otherwise.
498 */
Ronald Cronad8c17b2022-06-10 17:18:09 +0200499#if ! defined(MBEDTLS_TEST_HOOKS)
Hanno Becker51018aa2017-04-12 14:54:42 +0100500static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
501 const uint8_t *end, size_t need )
502{
Ronald Cronb7b35e12020-06-11 09:50:51 +0200503 return( ( cur > end ) || ( need > (size_t)( end - cur ) ) );
Hanno Becker51018aa2017-04-12 14:54:42 +0100504}
Ronald Cronad8c17b2022-06-10 17:18:09 +0200505#else
506typedef struct
507{
508 const uint8_t *cur;
509 const uint8_t *end;
510 size_t need;
511} mbedtls_ssl_chk_buf_ptr_args;
512
513void mbedtls_ssl_set_chk_buf_ptr_fail_args(
514 const uint8_t *cur, const uint8_t *end, size_t need );
515void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void );
Ronald Cronce7d76e2022-07-08 18:56:49 +0200516
517MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronad8c17b2022-06-10 17:18:09 +0200518int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args );
519
520static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
521 const uint8_t *end, size_t need )
522{
523 if( ( cur > end ) || ( need > (size_t)( end - cur ) ) )
524 {
525 mbedtls_ssl_set_chk_buf_ptr_fail_args( cur, end, need );
526 return( 1 );
527 }
528 return( 0 );
529}
Ronald Croncf600bc2022-06-17 15:54:16 +0200530#endif /* MBEDTLS_TEST_HOOKS */
Hanno Becker51018aa2017-04-12 14:54:42 +0100531
532/**
533 * \brief This macro checks if the remaining size in a buffer is
534 * greater or equal than a needed space. If it is not the case,
535 * it returns an SSL_BUFFER_TOO_SMALL error.
536 *
537 * \param cur Pointer to the current position in the buffer.
538 * \param end Pointer to one past the end of the buffer.
539 * \param need Needed space in bytes.
540 *
541 */
542#define MBEDTLS_SSL_CHK_BUF_PTR( cur, end, need ) \
543 do { \
Ronald Cronb7b35e12020-06-11 09:50:51 +0200544 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100545 { \
546 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); \
547 } \
548 } while( 0 )
549
Jerry Yu34da3722021-09-19 18:05:08 +0800550/**
Jerry Yue15e6652021-09-28 21:06:07 +0800551 * \brief This macro checks if the remaining length in an input buffer is
552 * greater or equal than a needed length. If it is not the case, it
Jerry Yu205fd822021-10-08 16:16:24 +0800553 * returns #MBEDTLS_ERR_SSL_DECODE_ERROR error and pends a
Jerry Yudca3d5d2021-10-08 14:19:29 +0800554 * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message.
Jerry Yue4eefc72021-10-09 10:40:40 +0800555 *
556 * This is a function-like macro. It is guaranteed to evaluate each
557 * argument exactly once.
Jerry Yu34da3722021-09-19 18:05:08 +0800558 *
559 * \param cur Pointer to the current position in the buffer.
560 * \param end Pointer to one past the end of the buffer.
Jerry Yue15e6652021-09-28 21:06:07 +0800561 * \param need Needed length in bytes.
Jerry Yu34da3722021-09-19 18:05:08 +0800562 *
563 */
564#define MBEDTLS_SSL_CHK_BUF_READ_PTR( cur, end, need ) \
565 do { \
566 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
567 { \
568 MBEDTLS_SSL_DEBUG_MSG( 1, \
569 ( "missing input data in %s", __func__ ) ); \
570 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \
571 MBEDTLS_ERR_SSL_DECODE_ERROR ); \
572 return( MBEDTLS_ERR_SSL_DECODE_ERROR ); \
573 } \
574 } while( 0 )
575
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200576#ifdef __cplusplus
577extern "C" {
578#endif
579
Ron Eldor51d3ab52019-05-12 14:54:30 +0300580typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen,
581 const char *label,
582 const unsigned char *random, size_t rlen,
583 unsigned char *dstbuf, size_t dlen );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100584
Hanno Becker61baae72020-09-16 09:24:14 +0100585/* cipher.h exports the maximum IV, key and block length from
Hanno Becker15889832020-09-08 11:29:11 +0100586 * all ciphers enabled in the config, regardless of whether those
587 * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled
588 * in the default configuration and uses 64 Byte keys, but it is
589 * not used for record protection in SSL/TLS.
590 *
591 * In order to prevent unnecessary inflation of key structures,
592 * we introduce SSL-specific variants of the max-{key,block,IV}
593 * macros here which are meant to only take those ciphers into
594 * account which can be negotiated in SSL/TLS.
595 *
596 * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH
597 * in cipher.h are rough overapproximations of the real maxima, here
Hanno Becker9a7a2ac2020-09-09 09:24:54 +0100598 * we content ourselves with replicating those overapproximations
Hanno Becker15889832020-09-08 11:29:11 +0100599 * for the maximum block and IV length, and excluding XTS from the
600 * computation of the maximum key length. */
601#define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16
602#define MBEDTLS_SSL_MAX_IV_LENGTH 16
603#define MBEDTLS_SSL_MAX_KEY_LENGTH 32
604
Hanno Becker3385a4d2020-08-21 13:03:34 +0100605/**
606 * \brief The data structure holding the cryptographic material (key and IV)
607 * used for record protection in TLS 1.3.
608 */
609struct mbedtls_ssl_key_set
610{
611 /*! The key for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100612 unsigned char client_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100613 /*! The key for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100614 unsigned char server_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100615 /*! The IV for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100616 unsigned char client_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100617 /*! The IV for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100618 unsigned char server_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100619
Hanno Becker493ea7f2020-09-08 11:01:00 +0100620 size_t key_len; /*!< The length of client_write_key and
621 * server_write_key, in Bytes. */
622 size_t iv_len; /*!< The length of client_write_iv and
623 * server_write_iv, in Bytes. */
Hanno Becker3385a4d2020-08-21 13:03:34 +0100624};
625typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100626
Jerry Yu61e35e02021-09-16 18:59:08 +0800627typedef struct
628{
Jerry Yuf532bb22021-10-13 10:34:03 +0800629 unsigned char binder_key [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
630 unsigned char client_early_traffic_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
631 unsigned char early_exporter_master_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000632} mbedtls_ssl_tls13_early_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800633
634typedef struct
635{
Jerry Yuf532bb22021-10-13 10:34:03 +0800636 unsigned char client_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
637 unsigned char server_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000638} mbedtls_ssl_tls13_handshake_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800639
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200640/*
641 * This structure contains the parameters only needed during handshake.
642 */
643struct mbedtls_ssl_handshake_params
644{
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100645 /* Frequently-used boolean or byte fields (placed early to take
646 * advantage of smaller code size for indirect access on Arm Thumb) */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100647 uint8_t resume; /*!< session resume indicator*/
648 uint8_t cli_exts; /*!< client extension presence*/
649
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400650#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
651 uint8_t sni_authmode; /*!< authmode from SNI callback */
652#endif
653
XiaokangQian189ded22022-05-10 08:12:17 +0000654#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQianc3017f62022-05-13 05:55:41 +0000655 /* Flag indicating if a CertificateRequest message has been sent
656 * to the client or not. */
XiaokangQian63e713e2022-05-15 04:26:57 +0000657 uint8_t certificate_request_sent;
XiaokangQian189ded22022-05-10 08:12:17 +0000658#endif /* MBEDTLS_SSL_SRV_C */
659
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400660#if defined(MBEDTLS_SSL_SESSION_TICKETS)
661 uint8_t new_session_ticket; /*!< use NewSessionTicket? */
662#endif /* MBEDTLS_SSL_SESSION_TICKETS */
663
Ronald Cron82c785f2022-03-31 15:44:41 +0200664#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron217d6992022-04-04 10:23:22 +0200665 /** Minimum TLS version to be negotiated.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200666 *
Ronald Cron217d6992022-04-04 10:23:22 +0200667 * It is set up in the ClientHello writing preparation stage and used
668 * throughout the ClientHello writing. Not relevant anymore as soon as
669 * the protocol version has been negotiated thus as soon as the
670 * ServerHello is received.
671 * For a fresh handshake not linked to any previous handshake, it is
672 * equal to the configured minimum minor version to be negotiated. When
673 * renegotiating or resuming a session, it is equal to the previously
674 * negotiated minor version.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200675 *
Ronald Cron217d6992022-04-04 10:23:22 +0200676 * There is no maximum TLS version field in this handshake context.
677 * From the start of the handshake, we need to define a current protocol
678 * version for the record layer which we define as the maximum TLS
679 * version to be negotiated. The `tls_version` field of the SSL context is
680 * used to store this maximum value until it contains the actual
681 * negotiated value.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200682 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400683 mbedtls_ssl_protocol_version min_tls_version;
Ronald Cron82c785f2022-03-31 15:44:41 +0200684#endif
Ronald Cron86a477f2022-02-18 17:45:10 +0100685
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100686#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
687 uint8_t extended_ms; /*!< use Extended Master Secret? */
688#endif
689
690#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
691 uint8_t async_in_progress; /*!< an asynchronous operation is in progress */
692#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
693
694#if defined(MBEDTLS_SSL_PROTO_DTLS)
695 unsigned char retransmit_state; /*!< Retransmission state */
696#endif
697
Gilles Peskine41139a22021-12-08 18:25:39 +0100698#if !defined(MBEDTLS_DEPRECATED_REMOVED)
699 unsigned char group_list_heap_allocated;
Jerry Yuf017ee42022-01-12 15:49:48 +0800700 unsigned char sig_algs_heap_allocated;
Gilles Peskine41139a22021-12-08 18:25:39 +0100701#endif
702
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100703#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
704 uint8_t ecrs_enabled; /*!< Handshake supports EC restart? */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100705 enum { /* this complements ssl->state with info on intra-state operations */
706 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
707 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
708 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
709 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
710 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
711 } ecrs_state; /*!< current (or last) operation */
712 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
713 size_t ecrs_n; /*!< place for saving a length */
714#endif
715
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100716 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
717
718 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
719 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
720 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
721 mbedtls_ssl_tls_prf_cb *tls_prf;
722
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200723 /*
724 * Handshake specific crypto variables
725 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100726#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron85385492022-07-20 16:44:00 +0200727 uint8_t key_exchange_mode; /*!< Selected key exchange mode */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100728
Jerry Yu6a2cd9e2022-05-05 11:14:19 +0800729 /** Number of HelloRetryRequest messages received/sent from/to the server. */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000730 int hello_retry_request_count;
Ronald Cronbc817ba2022-07-21 09:35:20 +0200731
XiaokangQian08037552022-04-20 07:16:41 +0000732#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQian318dc762022-04-20 09:43:51 +0000733 /** selected_group of key_share extension in HelloRetryRequest message. */
XiaokangQian08037552022-04-20 07:16:41 +0000734 uint16_t hrr_selected_group;
Ronald Cron41a443a2022-10-04 16:38:25 +0200735#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cronbc817ba2022-07-21 09:35:20 +0200736 uint8_t tls13_kex_modes; /*!< Key exchange modes supported by the client */
737#endif
Jerry Yud4e75002022-08-09 13:33:50 +0800738#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf3bdf9d2022-09-22 23:30:49 +0800739 uint16_t new_session_tickets_count; /*!< number of session tickets */
Jerry Yud4e75002022-08-09 13:33:50 +0800740#endif
XiaokangQian08037552022-04-20 07:16:41 +0000741#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cronbc817ba2022-07-21 09:35:20 +0200742
Jerry Yu582dd062022-04-22 21:59:01 +0800743#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian08037552022-04-20 07:16:41 +0000744
Ronald Crone68ab4f2022-10-05 12:46:29 +0200745#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000746 uint16_t received_sig_algs[MBEDTLS_RECEIVED_SIG_ALGS_SIZE];
747#endif
748
Gilles Peskine41139a22021-12-08 18:25:39 +0100749#if !defined(MBEDTLS_DEPRECATED_REMOVED)
750 const uint16_t *group_list;
Jerry Yuf017ee42022-01-12 15:49:48 +0800751 const uint16_t *sig_algs;
Gilles Peskine41139a22021-12-08 18:25:39 +0100752#endif
753
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200754#if defined(MBEDTLS_DHM_C)
755 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
756#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100757
John Durkop07cc04a2020-11-16 22:08:34 -0800758/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
Ronald Cronde1adee2022-03-07 16:20:30 +0100759 * to guards in client and server code. There is a gap in functionality that
760 * access to ecdh_ctx structure is needed for MBEDTLS_ECDSA_C which does not
761 * seem correct.
John Durkop07cc04a2020-11-16 22:08:34 -0800762 */
763#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Neil Armstrong769dc052022-04-13 15:12:43 +0200764#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200765 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
Neil Armstrong769dc052022-04-13 15:12:43 +0200766#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000767
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100768#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine42459802019-12-19 13:31:53 +0100769 psa_key_type_t ecdh_psa_type;
Neil Armstrong91477a72022-03-25 15:42:20 +0100770 size_t ecdh_bits;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100771 mbedtls_svc_key_id_t ecdh_psa_privkey;
Neil Armstrongf716a702022-04-04 11:23:46 +0200772 uint8_t ecdh_psa_privkey_is_external;
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000773 unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH];
774 size_t ecdh_psa_peerkey_len;
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100775#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
John Durkop07cc04a2020-11-16 22:08:34 -0800776#endif /* MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000777
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200778#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200779 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200780#if defined(MBEDTLS_SSL_CLI_C)
781 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
782 size_t ecjpake_cache_len; /*!< Length of cached data */
783#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100784#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100785
786#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200787 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200788 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
789#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100790
Ronald Cron73fe8df2022-10-05 14:31:43 +0200791#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100792#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +0100793 mbedtls_svc_key_id_t psk_opaque; /*!< Opaque PSK from the callback */
Neil Armstrong501c9322022-05-03 09:35:09 +0200794 uint8_t psk_opaque_is_internal;
Neil Armstronge952a302022-05-03 10:22:14 +0200795#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200796 unsigned char *psk; /*!< PSK from the callback */
797 size_t psk_len; /*!< Length of PSK from callback */
Neil Armstronge952a302022-05-03 10:22:14 +0200798#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu96a2e362022-07-21 15:11:34 +0800799 uint16_t selected_identity;
Ronald Cron73fe8df2022-10-05 14:31:43 +0200800#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100801
Gilles Peskinecfe74a32021-12-08 18:38:51 +0100802#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
803 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
804#endif
805
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200806#if defined(MBEDTLS_X509_CRT_PARSE_C)
807 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
808#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
809 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
810 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
811 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100812#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200813#endif /* MBEDTLS_X509_CRT_PARSE_C */
Gilles Peskine8716f172021-11-16 15:21:44 +0100814
Gilles Peskine8716f172021-11-16 15:21:44 +0100815#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Hanno Becker75173122019-02-06 16:18:31 +0000816 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
817 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
818#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker2f28c102019-04-25 15:46:59 +0100819
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100820 struct
821 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100822 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
823 * buffers used for message buffering. */
824
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100825 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100826 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100827
Hanno Becker0271f962018-08-16 13:23:47 +0100828 struct mbedtls_ssl_hs_buffer
829 {
Hanno Becker98081a02018-08-22 13:32:50 +0100830 unsigned is_valid : 1;
831 unsigned is_fragmented : 1;
832 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100833 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100834 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100835 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
836
Hanno Becker5f066e72018-08-16 14:56:31 +0100837 struct
838 {
839 unsigned char *data;
840 size_t len;
841 unsigned epoch;
842 } future_record;
843
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100844 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100845
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000846#if defined(MBEDTLS_SSL_CLI_C) && \
847 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
848 unsigned char *cookie; /*!< HelloVerifyRequest cookie for DTLS
849 * HelloRetryRequest cookie for TLS 1.3 */
850#endif /* MBEDTLS_SSL_CLI_C &&
851 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
852#if defined(MBEDTLS_SSL_PROTO_DTLS)
853 unsigned char verify_cookie_len; /*!< Cli: HelloVerifyRequest cookie
854 * length
XiaokangQian34909742022-01-27 02:25:04 +0000855 * Srv: flag for sending a cookie */
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000856#endif /* MBEDTLS_SSL_PROTO_DTLS */
857#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
858 uint16_t hrr_cookie_len; /*!< HelloRetryRequest cookie length */
XiaokangQian20438972022-03-04 08:52:07 +0000859#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian52da5582022-01-26 09:49:29 +0000860
861#if defined(MBEDTLS_SSL_PROTO_DTLS)
862 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
863 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100864
865 uint32_t retransmit_timeout; /*!< Current value of timeout */
866 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
867 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
868 unsigned char *cur_msg_p; /*!< Position in current message */
869 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
870 flight being received */
871 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
872 resending messages */
873 unsigned char alt_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Alternative record epoch/counter
874 for resending messages */
875
876#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
877 /* The state of CID configuration in this handshake. */
878
879 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
880 * has been negotiated. Possible values are
881 * #MBEDTLS_SSL_CID_ENABLED and
882 * #MBEDTLS_SSL_CID_DISABLED. */
883 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
884 uint8_t peer_cid_len; /*!< The length of
885 * \c peer_cid. */
886#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
887
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200888 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100889#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200890
Ronald Cron6f135e12021-12-08 16:57:54 +0100891#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +0100892 /*! TLS 1.3 transforms for 0-RTT and encrypted handshake messages.
893 * Those pointers own the transforms they reference. */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100894 mbedtls_ssl_transform *transform_handshake;
895 mbedtls_ssl_transform *transform_earlydata;
Ronald Cron6f135e12021-12-08 16:57:54 +0100896#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100897
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200898 /*
899 * Checksum contexts
900 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400901#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500902#if defined(MBEDTLS_USE_PSA_CRYPTO)
903 psa_hash_operation_t fin_sha256_psa;
904#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200905 mbedtls_sha256_context fin_sha256;
906#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500907#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400908#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500909#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500910 psa_hash_operation_t fin_sha384_psa;
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400912 mbedtls_sha512_context fin_sha384;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200913#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500914#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200915
Ronald Cron6f135e12021-12-08 16:57:54 +0100916#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800917 uint16_t offered_group_id; /* The NamedGroup value for the group
918 * that is being used for ephemeral
919 * key exchange.
920 *
921 * On the client: Defaults to the first
922 * entry in the client's group list,
923 * but can be overwritten by the HRR. */
Ronald Cron6f135e12021-12-08 16:57:54 +0100924#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800925
Jerry Yufb28b882022-01-28 11:05:58 +0800926#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yu2d9a6942022-02-08 21:07:10 +0800927 uint8_t client_auth; /*!< used to check if CertificateRequest has been
Jerry Yu5c7d1cc2022-02-08 21:08:29 +0800928 received from server side. If CertificateRequest
Jerry Yu0ff8ac82022-02-08 10:10:48 +0800929 has been received, Certificate and CertificateVerify
Jerry Yufb28b882022-01-28 11:05:58 +0800930 should be sent to server */
931#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000932 /*
933 * State-local variables used during the processing
934 * of a specific handshake state.
935 */
936 union
937 {
938 /* Outgoing Finished message */
939 struct
940 {
941 uint8_t preparation_done;
942
943 /* Buffer holding digest of the handshake up to
944 * but excluding the outgoing finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000945 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000946 size_t digest_len;
947 } finished_out;
948
949 /* Incoming Finished message */
950 struct
951 {
XiaokangQian57b2aff2021-11-10 03:12:11 +0000952 uint8_t preparation_done;
953
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000954 /* Buffer holding digest of the handshake up to but
955 * excluding the peer's incoming finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000956 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000957 size_t digest_len;
958 } finished_in;
959
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000960 } state_local;
961
962 /* End of state-local variables. */
963
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800964 unsigned char randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN +
965 MBEDTLS_SERVER_HELLO_RANDOM_LEN];
966 /*!< random bytes */
Ronald Cron3b056202022-10-05 17:20:21 +0200967#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200968 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
969 /*!< premaster secret */
Ronald Cron3b056202022-10-05 17:20:21 +0200970 size_t pmslen; /*!< premaster length */
971#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200972
Ronald Cron6f135e12021-12-08 16:57:54 +0100973#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu0c354a22022-08-29 15:25:36 +0800974 uint32_t sent_extensions; /*!< extensions sent by endpoint */
975 uint32_t received_extensions; /*!< extensions received by endpoint */
Jerry Yu89ea3212021-09-09 14:31:24 +0800976
Ronald Crone68ab4f2022-10-05 12:46:29 +0200977#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baia0ab7772022-01-16 12:14:45 +0000978 unsigned char certificate_request_context_len;
979 unsigned char *certificate_request_context;
Xiaofei Baie1e34422021-12-23 12:09:05 +0000980#endif
981
Jerry Yu89ea3212021-09-09 14:31:24 +0800982 union
983 {
Jerry Yud1ab2622021-10-08 15:36:57 +0800984 unsigned char early [MBEDTLS_TLS1_3_MD_MAX_SIZE];
985 unsigned char handshake[MBEDTLS_TLS1_3_MD_MAX_SIZE];
986 unsigned char app [MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Baid25fab62021-12-02 06:36:27 +0000987 } tls13_master_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800988
Xiaofei Bai746f9482021-11-12 08:53:56 +0000989 mbedtls_ssl_tls13_handshake_secrets tls13_hs_secrets;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +0000990
991#if defined(MBEDTLS_SSL_EARLY_DATA)
992 mbedtls_ssl_tls13_early_secrets early_secrets;
993
994 int early_data; /*!< Early data indication:
995 * 0 -- MBEDTLS_SSL_EARLY_DATA_DISABLED (for no early data), and
996 * 1 -- MBEDTLS_SSL_EARLY_DATA_ENABLED (for use early data)
997 */
998#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +0100999#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001000
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001001#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
1002 /** Asynchronous operation context. This field is meant for use by the
1003 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
1004 * mbedtls_ssl_config::f_async_decrypt_start,
1005 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
1006 * The library does not use it internally. */
1007 void *user_async_ctx;
1008#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Glenn Strauss69894072022-01-24 12:58:00 -05001009
1010#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1011 const unsigned char *sni_name; /*!< raw SNI */
1012 size_t sni_name_len; /*!< raw SNI len */
Glenn Strauss999ef702022-03-11 01:37:23 -05001013#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1014 const mbedtls_x509_crt *dn_hints; /*!< acceptable client cert issuers */
1015#endif
Glenn Strauss69894072022-01-24 12:58:00 -05001016#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001017};
1018
Hanno Becker0271f962018-08-16 13:23:47 +01001019typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
1020
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001021/*
Hanno Beckerd362dc52018-01-03 15:23:11 +00001022 * Representation of decryption/encryption transformations on records
1023 *
1024 * There are the following general types of record transformations:
TRodziewicz2abf03c2021-06-25 14:40:09 +02001025 * - Stream transformations (TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001026 * Transformation adding a MAC and applying a stream-cipher
1027 * to the authenticated message.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001028 * - CBC block cipher transformations ([D]TLS versions == 1.2 only)
1029 * For TLS 1.2, no IV is generated at key extraction time, but every
1030 * encrypted record is explicitly prefixed by the IV with which it was
1031 * encrypted.
1032 * - AEAD transformations ([D]TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001033 * These come in two fundamentally different versions, the first one
1034 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
1035 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
1036 * In the first transformation, the IV to be used for a record is obtained
1037 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
1038 * record sequence number, and explicitly prepending this sequence number
1039 * to the encrypted record. In contrast, in the second transformation
1040 * the IV is obtained by XOR'ing a static IV obtained at key extraction
1041 * time with the 8-byte record sequence number, without prepending the
1042 * latter to the encrypted record.
1043 *
Hanno Becker7d343ec2020-05-04 12:29:05 +01001044 * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext
1045 * which allows to add flexible length padding and to hide a record's true
1046 * content type.
1047 *
Hanno Beckerd362dc52018-01-03 15:23:11 +00001048 * In addition to type and version, the following parameters are relevant:
1049 * - The symmetric cipher algorithm to be used.
1050 * - The (static) encryption/decryption keys for the cipher.
1051 * - For stream/CBC, the type of message digest to be used.
1052 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Becker0db7e0c2018-10-18 15:39:53 +01001053 * - For AEAD transformations, the size (potentially 0) of an explicit,
1054 * random initialization vector placed in encrypted records.
TRodziewicz299510e2021-07-09 16:55:11 +02001055 * - For some transformations (currently AEAD) an implicit IV. It is static
Hanno Beckerd362dc52018-01-03 15:23:11 +00001056 * and (if present) is combined with the explicit IV in a transformation-
TRodziewicz299510e2021-07-09 16:55:11 +02001057 * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
Hanno Beckerd362dc52018-01-03 15:23:11 +00001058 * - For stream/CBC, a flag determining the order of encryption and MAC.
1059 * - The details of the transformation depend on the SSL/TLS version.
1060 * - The length of the authentication tag.
1061 *
1062 * The struct below refines this abstract view as follows:
1063 * - The cipher underlying the transformation is managed in
1064 * cipher contexts cipher_ctx_{enc/dec}, which must have the
1065 * same cipher type. The mode of these cipher contexts determines
1066 * the type of the transformation in the sense above: e.g., if
1067 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
1068 * then the transformation has type CBC resp. AEAD.
1069 * - The cipher keys are never stored explicitly but
1070 * are maintained within cipher_ctx_{enc/dec}.
1071 * - For stream/CBC transformations, the message digest contexts
1072 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
1073 * are unused for AEAD transformations.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001074 * - For stream/CBC transformations, the MAC keys are not stored explicitly
1075 * but maintained within md_ctx_{enc/dec}.
1076 * - The mac_enc and mac_dec fields are unused for EAD transformations.
Hanno Beckerd362dc52018-01-03 15:23:11 +00001077 * - For transformations using an implicit IV maintained within
1078 * the transformation context, its contents are stored within
1079 * iv_{enc/dec}.
1080 * - The value of ivlen indicates the length of the IV.
1081 * This is redundant in case of stream/CBC transformations
1082 * which always use 0 resp. the cipher's block length as the
1083 * IV length, but is needed for AEAD ciphers and may be
1084 * different from the underlying cipher's block length
1085 * in this case.
1086 * - The field fixed_ivlen is nonzero for AEAD transformations only
1087 * and indicates the length of the static part of the IV which is
1088 * constant throughout the communication, and which is stored in
1089 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
Glenn Strauss07c64162022-03-14 12:34:51 -04001090 * - tls_version denotes the 2-byte TLS version
Hanno Beckerd362dc52018-01-03 15:23:11 +00001091 * - For stream/CBC transformations, maclen denotes the length of the
1092 * authentication tag, while taglen is unused and 0.
1093 * - For AEAD transformations, taglen denotes the length of the
1094 * authentication tag, while maclen is unused and 0.
1095 * - For CBC transformations, encrypt_then_mac determines the
1096 * order of encryption and authentication. This field is unused
1097 * in other transformations.
1098 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001099 */
1100struct mbedtls_ssl_transform
1101{
1102 /*
1103 * Session specific crypto layer
1104 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001105 size_t minlen; /*!< min. ciphertext length */
1106 size_t ivlen; /*!< IV length */
1107 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Beckere694c3e2017-12-27 21:34:08 +00001108 size_t maclen; /*!< MAC(CBC) len */
1109 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001110
1111 unsigned char iv_enc[16]; /*!< IV (encryption) */
1112 unsigned char iv_dec[16]; /*!< IV (decryption) */
1113
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001114#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Hanno Beckerd56ed242018-01-03 15:32:51 +00001115
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001116#if defined(MBEDTLS_USE_PSA_CRYPTO)
1117 mbedtls_svc_key_id_t psa_mac_enc; /*!< MAC (encryption) */
1118 mbedtls_svc_key_id_t psa_mac_dec; /*!< MAC (decryption) */
1119 psa_algorithm_t psa_mac_alg; /*!< psa MAC algorithm */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001120#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001121 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
1122 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001123#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001124
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001125#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1126 int encrypt_then_mac; /*!< flag for EtM activation */
1127#endif
1128
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001129#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Beckerd56ed242018-01-03 15:32:51 +00001130
Glenn Strauss07c64162022-03-14 12:34:51 -04001131 mbedtls_ssl_protocol_version tls_version;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001132
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001133#if defined(MBEDTLS_USE_PSA_CRYPTO)
1134 mbedtls_svc_key_id_t psa_key_enc; /*!< psa encryption key */
1135 mbedtls_svc_key_id_t psa_key_dec; /*!< psa decryption key */
1136 psa_algorithm_t psa_alg; /*!< psa algorithm */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001137#else
1138 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
1139 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001140#endif /* MBEDTLS_USE_PSA_CRYPTO */
1141
Hanno Beckera0e20d02019-05-15 14:03:01 +01001142#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker1327fa72019-04-25 15:54:02 +01001143 uint8_t in_cid_len;
1144 uint8_t out_cid_len;
1145 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
1146 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera0e20d02019-05-15 14:03:01 +01001147#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1327fa72019-04-25 15:54:02 +01001148
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001149#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
1150 /* We need the Hello random bytes in order to re-derive keys from the
Hanno Beckerbd257552021-03-22 06:59:27 +00001151 * Master Secret and other session info,
1152 * see ssl_tls12_populate_transform() */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001153 unsigned char randbytes[MBEDTLS_SERVER_HELLO_RANDOM_LEN +
1154 MBEDTLS_CLIENT_HELLO_RANDOM_LEN];
1155 /*!< ServerHello.random+ClientHello.random */
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001156#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001157};
1158
Hanno Becker12a3a862018-01-05 15:42:50 +00001159/*
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001160 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
1161 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
1162 */
1163static inline int mbedtls_ssl_transform_uses_aead(
1164 const mbedtls_ssl_transform *transform )
1165{
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001166#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001167 return( transform->maclen == 0 && transform->taglen != 0 );
1168#else
1169 (void) transform;
1170 return( 1 );
1171#endif
1172}
1173
1174/*
Hanno Becker12a3a862018-01-05 15:42:50 +00001175 * Internal representation of record frames
1176 *
Hanno Becker12a3a862018-01-05 15:42:50 +00001177 * Instances come in two flavors:
1178 * (1) Encrypted
1179 * These always have data_offset = 0
1180 * (2) Unencrypted
Hanno Beckercd430bc2019-04-04 16:29:48 +01001181 * These have data_offset set to the amount of
1182 * pre-expansion during record protection. Concretely,
1183 * this is the length of the fixed part of the explicit IV
1184 * used for encryption, or 0 if no explicit IV is used
TRodziewicz2abf03c2021-06-25 14:40:09 +02001185 * (e.g. for stream ciphers).
Hanno Becker12a3a862018-01-05 15:42:50 +00001186 *
1187 * The reason for the data_offset in the unencrypted case
1188 * is to allow for in-place conversion of an unencrypted to
1189 * an encrypted record. If the offset wasn't included, the
1190 * encrypted content would need to be shifted afterwards to
1191 * make space for the fixed IV.
1192 *
1193 */
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001194#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker75f080f2019-04-30 15:01:51 +01001195#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001196#else
Hanno Becker75f080f2019-04-30 15:01:51 +01001197#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001198#endif
1199
Hanno Becker12a3a862018-01-05 15:42:50 +00001200typedef struct
1201{
Jerry Yuae0b2e22021-10-08 15:21:19 +08001202 uint8_t ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /* In TLS: The implicit record sequence number.
1203 * In DTLS: The 2-byte epoch followed by
1204 * the 6-byte sequence number.
1205 * This is stored as a raw big endian byte array
1206 * as opposed to a uint64_t because we rarely
1207 * need to perform arithmetic on this, but do
1208 * need it as a Byte array for the purpose of
1209 * MAC computations. */
Hanno Beckerd840cea2019-07-11 09:24:36 +01001210 uint8_t type; /* The record content type. */
1211 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
1212 * Convert to internal presentation of versions
1213 * using mbedtls_ssl_read_version() and
1214 * mbedtls_ssl_write_version().
1215 * Keep wire-format for MAC computations. */
Hanno Becker12a3a862018-01-05 15:42:50 +00001216
Hanno Beckerd840cea2019-07-11 09:24:36 +01001217 unsigned char *buf; /* Memory buffer enclosing the record content */
1218 size_t buf_len; /* Buffer length */
1219 size_t data_offset; /* Offset of record content */
1220 size_t data_len; /* Length of record content */
Hanno Becker12a3a862018-01-05 15:42:50 +00001221
Hanno Beckera0e20d02019-05-15 14:03:01 +01001222#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd840cea2019-07-11 09:24:36 +01001223 uint8_t cid_len; /* Length of the CID (0 if not present) */
1224 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001225#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker12a3a862018-01-05 15:42:50 +00001226} mbedtls_record;
1227
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001228#if defined(MBEDTLS_X509_CRT_PARSE_C)
1229/*
1230 * List of certificate + private key pairs
1231 */
1232struct mbedtls_ssl_key_cert
1233{
1234 mbedtls_x509_crt *cert; /*!< cert */
1235 mbedtls_pk_context *key; /*!< private key */
1236 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
1237};
1238#endif /* MBEDTLS_X509_CRT_PARSE_C */
1239
1240#if defined(MBEDTLS_SSL_PROTO_DTLS)
1241/*
1242 * List of handshake messages kept around for resending
1243 */
1244struct mbedtls_ssl_flight_item
1245{
1246 unsigned char *p; /*!< message, including handshake headers */
1247 size_t len; /*!< length of p */
1248 unsigned char type; /*!< type of the message: handshake or CCS */
1249 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
1250};
1251#endif /* MBEDTLS_SSL_PROTO_DTLS */
1252
Ronald Cron4079abc2022-02-20 10:35:26 +01001253#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1254/**
1255 * \brief Given an SSL context and its associated configuration, write the TLS
1256 * 1.2 specific extensions of the ClientHello message.
1257 *
1258 * \param[in] ssl SSL context
1259 * \param[in] buf Base address of the buffer where to write the extensions
1260 * \param[in] end End address of the buffer where to write the extensions
1261 * \param uses_ec Whether one proposed ciphersuite uses an elliptic curve
1262 * (<> 0) or not ( 0 ).
1263 * \param[out] out_len Length of the data written into the buffer \p buf
1264 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001265MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron4079abc2022-02-20 10:35:26 +01001266int mbedtls_ssl_tls12_write_client_hello_exts( mbedtls_ssl_context *ssl,
1267 unsigned char *buf,
1268 const unsigned char *end,
1269 int uses_ec,
1270 size_t *out_len );
1271#endif
1272
Hanno Becker7e5437a2017-04-28 17:15:26 +01001273#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01001274 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01001275
Gabor Mezeia3d016c2022-05-10 12:44:09 +02001276/**
1277 * \brief Find the preferred hash for a given signature algorithm.
1278 *
1279 * \param[in] ssl SSL context
1280 * \param[in] sig_alg A signature algorithm identifier as defined in the
1281 * TLS 1.2 SignatureAlgorithm enumeration.
1282 *
1283 * \return The preferred hash algorithm for \p sig_alg. It is a hash algorithm
1284 * identifier as defined in the TLS 1.2 HashAlgorithm enumeration.
1285 */
1286unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
1287 mbedtls_ssl_context *ssl,
1288 unsigned int sig_alg );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001289
Gabor Mezei078e8032022-04-27 21:17:56 +02001290#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01001291 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001292
1293/**
1294 * \brief Free referenced items in an SSL transform context and clear
1295 * memory
1296 *
1297 * \param transform SSL transform context
1298 */
1299void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
1300
1301/**
1302 * \brief Free referenced items in an SSL handshake context and clear
1303 * memory
1304 *
Gilles Peskine9b562d52018-04-25 20:32:43 +02001305 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001306 */
Gilles Peskine9b562d52018-04-25 20:32:43 +02001307void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001308
Jerry Yuc7875b52021-09-05 21:05:50 +08001309/* set inbound transform of ssl context */
1310void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
1311 mbedtls_ssl_transform *transform );
1312
1313/* set outbound transform of ssl context */
1314void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
1315 mbedtls_ssl_transform *transform );
1316
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001317MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001318int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001319MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001320int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
1321void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001322static inline void mbedtls_ssl_handshake_set_state( mbedtls_ssl_context *ssl,
1323 mbedtls_ssl_states state )
1324{
1325 ssl->state = ( int ) state;
1326}
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001327
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001328MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001329int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
1330
1331void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001332
1333#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001334MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001335int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001336#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001337
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001338MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001339int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001340MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001341int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
1342void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
1343
Hanno Becker4a810fb2017-05-24 16:27:30 +01001344/**
1345 * \brief Update record layer
1346 *
1347 * This function roughly separates the implementation
1348 * of the logic of (D)TLS from the implementation
1349 * of the secure transport.
1350 *
Hanno Becker3a0aad12018-08-20 09:44:02 +01001351 * \param ssl The SSL context to use.
1352 * \param update_hs_digest This indicates if the handshake digest
1353 * should be automatically updated in case
1354 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +01001355 *
1356 * \return 0 or non-zero error code.
1357 *
1358 * \note A clarification on what is called 'record layer' here
1359 * is in order, as many sensible definitions are possible:
1360 *
1361 * The record layer takes as input an untrusted underlying
1362 * transport (stream or datagram) and transforms it into
1363 * a serially multiplexed, secure transport, which
1364 * conceptually provides the following:
1365 *
1366 * (1) Three datagram based, content-agnostic transports
1367 * for handshake, alert and CCS messages.
1368 * (2) One stream- or datagram-based transport
1369 * for application data.
1370 * (3) Functionality for changing the underlying transform
1371 * securing the contents.
1372 *
1373 * The interface to this functionality is given as follows:
1374 *
1375 * a Updating
1376 * [Currently implemented by mbedtls_ssl_read_record]
1377 *
1378 * Check if and on which of the four 'ports' data is pending:
1379 * Nothing, a controlling datagram of type (1), or application
1380 * data (2). In any case data is present, internal buffers
1381 * provide access to the data for the user to process it.
1382 * Consumption of type (1) datagrams is done automatically
1383 * on the next update, invalidating that the internal buffers
1384 * for previous datagrams, while consumption of application
1385 * data (2) is user-controlled.
1386 *
1387 * b Reading of application data
1388 * [Currently manual adaption of ssl->in_offt pointer]
1389 *
1390 * As mentioned in the last paragraph, consumption of data
1391 * is different from the automatic consumption of control
1392 * datagrams (1) because application data is treated as a stream.
1393 *
1394 * c Tracking availability of application data
1395 * [Currently manually through decreasing ssl->in_msglen]
1396 *
1397 * For efficiency and to retain datagram semantics for
1398 * application data in case of DTLS, the record layer
1399 * provides functionality for checking how much application
1400 * data is still available in the internal buffer.
1401 *
1402 * d Changing the transformation securing the communication.
1403 *
1404 * Given an opaque implementation of the record layer in the
1405 * above sense, it should be possible to implement the logic
1406 * of (D)TLS on top of it without the need to know anything
1407 * about the record layer's internals. This is done e.g.
1408 * in all the handshake handling functions, and in the
1409 * application data reading function mbedtls_ssl_read.
1410 *
1411 * \note The above tries to give a conceptual picture of the
1412 * record layer, but the current implementation deviates
1413 * from it in some places. For example, our implementation of
1414 * the update functionality through mbedtls_ssl_read_record
1415 * discards datagrams depending on the current state, which
1416 * wouldn't fall under the record layer's responsibility
1417 * following the above definition.
1418 *
1419 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001420MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker3a0aad12018-08-20 09:44:02 +01001421int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
1422 unsigned update_hs_digest );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001423MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001424int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
1425
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001426/*
1427 * Write handshake message header
1428 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001429MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001430int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
1431 unsigned char **buf, size_t *buf_len );
1432
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001433MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001434int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01001435 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01001436 int force_flush );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001437static inline int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
1438{
Ronald Cron66dbf912022-02-02 15:33:46 +01001439 return( mbedtls_ssl_write_handshake_msg_ext( ssl, 1 /* update checksum */, 1 /* force flush */ ) );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001440}
1441
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001442/*
1443 * Write handshake message tail
1444 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001445MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001446int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
1447 size_t buf_len, size_t msg_len );
1448
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001449MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron00d012f22022-03-08 15:57:12 +01001450int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001451MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001452int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
1453
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001454MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001455int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001456MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001457int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
1458
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001459MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001460int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001461MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001462int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1463
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001464MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001465int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001466MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001467int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1468
1469void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
1470 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
1471
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001472/*
1473 * Update checksum of handshake messages.
1474 */
1475void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
1476 unsigned hs_type,
1477 unsigned char const *msg,
1478 size_t msg_len );
1479
XiaokangQian86981952022-07-19 09:51:50 +00001480void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
1481 unsigned hs_type,
1482 size_t total_hs_len );
1483
Gilles Peskineeccd8882020-03-10 12:19:08 +01001484#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong80f6f322022-05-03 17:56:38 +02001485#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001486MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001487int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl,
1488 mbedtls_key_exchange_type_t key_ex );
Neil Armstrong80f6f322022-05-03 17:56:38 +02001489#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001490#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Ronald Crond29e13e2022-10-19 10:33:48 +02001491
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001492#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_SESSION_TICKETS)
1493MBEDTLS_CHECK_RETURN_CRITICAL
1494int mbedtls_ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl );
1495#endif
1496
Ronald Cron73fe8df2022-10-05 14:31:43 +02001497#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Ronald Crond29e13e2022-10-19 10:33:48 +02001498#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001499MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Crond491c2d2022-02-19 18:30:46 +01001500int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf );
1501#endif
Neil Armstrong044a32c2022-05-03 10:35:56 +02001502#if defined(MBEDTLS_USE_PSA_CRYPTO)
1503/**
1504 * Get the first defined opaque PSK by order of precedence:
1505 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK
1506 * callback
1507 * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque()
1508 * Return an opaque PSK
1509 */
1510static inline mbedtls_svc_key_id_t mbedtls_ssl_get_opaque_psk(
1511 const mbedtls_ssl_context *ssl )
1512{
1513 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
1514 return( ssl->handshake->psk_opaque );
1515
1516 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
1517 return( ssl->conf->psk_opaque );
1518
1519 return( MBEDTLS_SVC_KEY_ID_INIT );
1520}
1521#else
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001522/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001523 * Get the first defined PSK by order of precedence:
1524 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
1525 * 2. static PSK configured by \c mbedtls_ssl_conf_psk()
1526 * Return a code and update the pair (PSK, PSK length) passed to this function
1527 */
1528static inline int mbedtls_ssl_get_psk( const mbedtls_ssl_context *ssl,
1529 const unsigned char **psk, size_t *psk_len )
1530{
1531 if( ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0 )
1532 {
1533 *psk = ssl->handshake->psk;
1534 *psk_len = ssl->handshake->psk_len;
1535 }
1536
1537 else if( ssl->conf->psk != NULL && ssl->conf->psk_len > 0 )
1538 {
1539 *psk = ssl->conf->psk;
1540 *psk_len = ssl->conf->psk_len;
1541 }
1542
1543 else
1544 {
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001545 *psk = NULL;
1546 *psk_len = 0;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001547 return( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED );
1548 }
1549
1550 return( 0 );
1551}
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001552#endif /* MBEDTLS_USE_PSA_CRYPTO */
1553
Ronald Cron73fe8df2022-10-05 14:31:43 +02001554#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001555
1556#if defined(MBEDTLS_PK_C)
1557unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001558unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001559mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1560#endif
1561
1562mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001563unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001564
1565#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001566MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001567int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001568#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001569
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001570MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01001571int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001572#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001573MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001574int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001575#endif
1576
Ron Eldor089c9fe2018-12-06 17:12:49 +02001577#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascal43f94902020-09-22 12:25:52 +02001578static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value
1579 ( const uint16_t srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001580{
Johan Pascal43f94902020-09-22 12:25:52 +02001581 switch( srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001582 {
Johan Pascal85269572020-08-25 10:01:54 +02001583 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001584 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascal85269572020-08-25 10:01:54 +02001585 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001586 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascal43f94902020-09-22 12:25:52 +02001587 return srtp_profile_value;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001588 default: break;
1589 }
Johan Pascal43f94902020-09-22 12:25:52 +02001590 return( MBEDTLS_TLS_SRTP_UNSET );
Ron Eldor089c9fe2018-12-06 17:12:49 +02001591}
1592#endif
1593
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001594#if defined(MBEDTLS_X509_CRT_PARSE_C)
1595static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1596{
1597 mbedtls_ssl_key_cert *key_cert;
1598
1599 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1600 key_cert = ssl->handshake->key_cert;
1601 else
1602 key_cert = ssl->conf->key_cert;
1603
1604 return( key_cert == NULL ? NULL : key_cert->key );
1605}
1606
1607static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1608{
1609 mbedtls_ssl_key_cert *key_cert;
1610
1611 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1612 key_cert = ssl->handshake->key_cert;
1613 else
1614 key_cert = ssl->conf->key_cert;
1615
1616 return( key_cert == NULL ? NULL : key_cert->cert );
1617}
1618
1619/*
1620 * Check usage of a certificate wrt extensions:
1621 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1622 *
1623 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1624 * check a cert we received from them)!
1625 *
1626 * Return 0 if everything is OK, -1 if not.
1627 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001628MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001629int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
1630 const mbedtls_ssl_ciphersuite_t *ciphersuite,
1631 int cert_endpoint,
1632 uint32_t *flags );
1633#endif /* MBEDTLS_X509_CRT_PARSE_C */
1634
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001635void mbedtls_ssl_write_version( unsigned char version[2], int transport,
1636 mbedtls_ssl_protocol_version tls_version );
1637uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
1638 int transport );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001639
Hanno Becker5903de42019-05-03 14:46:38 +01001640static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001641{
Hanno Becker47be7682019-07-12 09:55:46 +01001642#if !defined(MBEDTLS_SSL_PROTO_DTLS)
1643 ((void) ssl);
1644#endif
1645
1646#if defined(MBEDTLS_SSL_PROTO_DTLS)
1647 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1648 {
1649 return( 13 );
1650 }
1651 else
1652#endif /* MBEDTLS_SSL_PROTO_DTLS */
1653 {
1654 return( 5 );
1655 }
Hanno Becker5903de42019-05-03 14:46:38 +01001656}
1657
1658static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1659{
Hanno Becker3b154c12019-05-03 15:05:27 +01001660 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001661}
1662
1663static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1664{
1665#if defined(MBEDTLS_SSL_PROTO_DTLS)
1666 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1667 return( 12 );
1668#else
1669 ((void) ssl);
1670#endif
1671 return( 4 );
1672}
1673
1674#if defined(MBEDTLS_SSL_PROTO_DTLS)
1675void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1676void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001677MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001678int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001679MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001680int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001681#endif
1682
1683/* Visible for testing purposes only */
1684#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001685MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker0183d692019-07-12 08:50:37 +01001686int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001687void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1688#endif
1689
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001690MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker52055ae2019-02-06 14:30:46 +00001691int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1692 const mbedtls_ssl_session *src );
1693
TRodziewicz0f82ec62021-05-12 17:49:18 +02001694#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek814feff2019-01-14 04:35:19 -05001695/* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001696MBEDTLS_CHECK_RETURN_CRITICAL
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001697int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001698 unsigned char *hash, size_t *hashlen,
1699 unsigned char *data, size_t data_len,
1700 mbedtls_md_type_t md_alg );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001701#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001702
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001703#ifdef __cplusplus
1704}
1705#endif
1706
Hanno Beckera18d1322018-01-03 14:27:32 +00001707void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001708MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera18d1322018-01-03 14:27:32 +00001709int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1710 mbedtls_ssl_transform *transform,
1711 mbedtls_record *rec,
1712 int (*f_rng)(void *, unsigned char *, size_t),
1713 void *p_rng );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001714MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker605949f2019-07-12 08:23:59 +01001715int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001716 mbedtls_ssl_transform *transform,
1717 mbedtls_record *rec );
1718
Hanno Beckerdd772292020-02-05 10:38:31 +00001719/* Length of the "epoch" field in the record header */
1720static inline size_t mbedtls_ssl_ep_len( const mbedtls_ssl_context *ssl )
1721{
1722#if defined(MBEDTLS_SSL_PROTO_DTLS)
1723 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1724 return( 2 );
1725#else
1726 ((void) ssl);
1727#endif
1728 return( 0 );
1729}
1730
Hanno Becker08f09132020-02-11 15:40:07 +00001731#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001732MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker786300f2020-02-05 10:46:40 +00001733int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001734#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker0f57a652020-02-05 10:37:26 +00001735
1736void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001737MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7876d122020-02-05 10:39:31 +00001738int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl );
1739
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001740void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl );
1741void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
1742 mbedtls_ssl_transform *transform );
1743void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl );
1744
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001745MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker43aefe22020-02-05 10:44:56 +00001746int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial );
XiaokangQian78b1fa72022-01-19 06:56:30 +00001747void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1748 int partial );
Hanno Becker43aefe22020-02-05 10:44:56 +00001749
Jerry Yue7047812021-09-13 19:26:39 +08001750/*
Jerry Yu394ece62021-09-14 22:17:21 +08001751 * Send pending alert
Jerry Yue7047812021-09-13 19:26:39 +08001752 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001753MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue7047812021-09-13 19:26:39 +08001754int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl );
1755
Jerry Yu394ece62021-09-14 22:17:21 +08001756/*
1757 * Set pending fatal alert flag.
1758 */
1759void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
1760 unsigned char alert_type,
1761 int alert_reason );
1762
1763/* Alias of mbedtls_ssl_pend_fatal_alert */
1764#define MBEDTLS_SSL_PEND_FATAL_ALERT( type, user_return_value ) \
1765 mbedtls_ssl_pend_fatal_alert( ssl, type, user_return_value )
1766
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001767#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1768void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl );
1769#endif
1770
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001771void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl );
1772
Hanno Becker08f09132020-02-11 15:40:07 +00001773#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001774MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40cdaa12020-02-05 10:48:27 +00001775int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001776#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker89490712020-02-05 10:50:12 +00001777
Hanno Becker533ab5f2020-02-05 10:49:13 +00001778#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker08f09132020-02-11 15:40:07 +00001779size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl );
Hanno Becker533ab5f2020-02-05 10:49:13 +00001780void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl );
1781void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight );
1782#endif /* MBEDTLS_SSL_PROTO_DTLS */
1783
Jerry Yu60835a82021-08-04 10:13:52 +08001784/**
1785 * ssl utils functions for checking configuration.
1786 */
1787
Ronald Cron6f135e12021-12-08 16:57:54 +01001788#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001789static inline int mbedtls_ssl_conf_is_tls13_only( const mbedtls_ssl_config *conf )
1790{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001791 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1792 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001793}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001794
Ronald Cron6f135e12021-12-08 16:57:54 +01001795#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001796
1797#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1798static inline int mbedtls_ssl_conf_is_tls12_only( const mbedtls_ssl_config *conf )
1799{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001800 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1801 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu60835a82021-08-04 10:13:52 +08001802}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001803
Jerry Yu60835a82021-08-04 10:13:52 +08001804#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1805
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001806static inline int mbedtls_ssl_conf_is_tls13_enabled( const mbedtls_ssl_config *conf )
1807{
1808#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001809 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_3 &&
1810 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001811#else
1812 ((void) conf);
1813 return( 0 );
1814#endif
1815}
1816
1817static inline int mbedtls_ssl_conf_is_tls12_enabled( const mbedtls_ssl_config *conf )
1818{
1819#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001820 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 &&
1821 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001822#else
1823 ((void) conf);
1824 return( 0 );
1825#endif
1826}
1827
Ronald Cron6f135e12021-12-08 16:57:54 +01001828#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001829static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13( const mbedtls_ssl_config *conf )
1830{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001831 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1832 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001833}
Ronald Cron6f135e12021-12-08 16:57:54 +01001834#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001835
Ronald Cron6f135e12021-12-08 16:57:54 +01001836#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yufbe3e642022-04-25 19:31:51 +08001837extern const uint8_t mbedtls_ssl_tls13_hello_retry_request_magic[
1838 MBEDTLS_SERVER_HELLO_RANDOM_LEN ];
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001839MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001840int mbedtls_ssl_tls13_process_finished_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001841MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001842int mbedtls_ssl_tls13_write_finished_message( mbedtls_ssl_context *ssl );
1843void mbedtls_ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl );
1844
1845/**
Ronald Cron3d580bf2022-02-18 17:24:56 +01001846 * \brief Given an SSL context and its associated configuration, write the TLS
1847 * 1.3 specific extensions of the ClientHello message.
1848 *
1849 * \param[in] ssl SSL context
1850 * \param[in] buf Base address of the buffer where to write the extensions
1851 * \param[in] end End address of the buffer where to write the extensions
1852 * \param[out] out_len Length of the data written into the buffer \p buf
1853 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001854MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron3d580bf2022-02-18 17:24:56 +01001855int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1856 unsigned char *buf,
1857 unsigned char *end,
1858 size_t *out_len );
1859
1860/**
Jerry Yua6e6c272021-11-17 17:54:13 +08001861 * \brief TLS 1.3 client side state machine entry
1862 *
1863 * \param ssl SSL context
1864 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001865MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001866int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl );
1867
1868/**
1869 * \brief TLS 1.3 server side state machine entry
1870 *
1871 * \param ssl SSL context
1872 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001873MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001874int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl );
1875
Jerry Yu26f4d152021-08-23 17:42:37 +08001876
1877/*
1878 * Helper functions around key exchange modes.
1879 */
Jerry Yub60e3cf2021-09-08 16:41:02 +08001880static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001881 int kex_mode_mask )
1882{
1883 return( ( ssl->conf->tls13_kex_modes & kex_mode_mask ) != 0 );
1884}
1885
Jerry Yub60e3cf2021-09-08 16:41:02 +08001886static inline int mbedtls_ssl_conf_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001887{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001888 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001889 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001890}
1891
1892static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( mbedtls_ssl_context *ssl )
1893{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001894 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001895 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001896}
1897
Jerry Yub60e3cf2021-09-08 16:41:02 +08001898static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001899{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001900 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001901 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001902}
1903
1904static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
1905{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001906 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001907 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001908}
1909
1910static inline int mbedtls_ssl_conf_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
1911{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001912 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001913 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001914}
1915
Ronald Cron41a443a2022-10-04 16:38:25 +02001916#if defined(MBEDTLS_SSL_SRV_C) && \
1917 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuadf861a2021-09-29 21:22:08 +08001918/**
1919 * Given a list of key exchange modes, check if at least one of them is
1920 * supported.
1921 *
1922 * \param[in] ssl SSL context
Jerry Yu0cabad32021-09-30 09:52:35 +08001923 * \param kex_modes_mask Mask of the key exchange modes to check
Jerry Yuadf861a2021-09-29 21:22:08 +08001924 *
1925 * \return 0 if at least one of the key exchange modes is supported,
Jerry Yudca3d5d2021-10-08 14:19:29 +08001926 * !=0 otherwise.
Jerry Yuadf861a2021-09-29 21:22:08 +08001927 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001928static inline unsigned mbedtls_ssl_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
1929 int kex_modes_mask )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001930{
Xiaofei Baid25fab62021-12-02 06:36:27 +00001931 return( ( ssl->handshake->tls13_kex_modes & kex_modes_mask ) == 0 );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001932}
1933
Xiaofei Bai746f9482021-11-12 08:53:56 +00001934static inline int mbedtls_ssl_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001935{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001936 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1937 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001938}
1939
Xiaofei Bai746f9482021-11-12 08:53:56 +00001940static inline int mbedtls_ssl_tls13_psk_ephemeral_enabled(
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001941 mbedtls_ssl_context *ssl )
1942{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001943 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1944 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001945}
1946
Xiaofei Bai746f9482021-11-12 08:53:56 +00001947static inline int mbedtls_ssl_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001948{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001949 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1950 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001951}
1952
Xiaofei Bai746f9482021-11-12 08:53:56 +00001953static inline int mbedtls_ssl_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001954{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001955 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1956 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001957}
1958
Xiaofei Bai746f9482021-11-12 08:53:56 +00001959static inline int mbedtls_ssl_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001960{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001961 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1962 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001963}
Ronald Cron41a443a2022-10-04 16:38:25 +02001964#endif /* MBEDTLS_SSL_SRV_C &&
1965 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001966
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001967/*
Jerry Yuea52ed92022-11-08 21:01:17 +08001968 * Helper functions for extensions checking.
Jerry Yue18dc7e2022-08-04 16:29:22 +08001969 */
Jerry Yue18dc7e2022-08-04 16:29:22 +08001970
Jerry Yu0c354a22022-08-29 15:25:36 +08001971MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001972int mbedtls_ssl_tls13_check_received_extension(
1973 mbedtls_ssl_context *ssl,
1974 int hs_msg_type,
1975 unsigned int received_extension_type,
1976 uint32_t hs_msg_allowed_extensions_mask );
Jerry Yu0c354a22022-08-29 15:25:36 +08001977
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001978static inline void mbedtls_ssl_tls13_set_hs_sent_ext_mask(
1979 mbedtls_ssl_context *ssl, unsigned int extension_type )
Jerry Yu0c354a22022-08-29 15:25:36 +08001980{
1981 ssl->handshake->sent_extensions |=
Jerry Yu7a485c12022-10-31 13:08:18 +08001982 mbedtls_ssl_get_extension_mask( extension_type );
Jerry Yu0c354a22022-08-29 15:25:36 +08001983}
Jerry Yue18dc7e2022-08-04 16:29:22 +08001984
1985/*
Ronald Cron85385492022-07-20 16:44:00 +02001986 * Helper functions to check the selected key exchange mode.
1987 */
1988static inline int mbedtls_ssl_tls13_key_exchange_mode_check(
1989 mbedtls_ssl_context *ssl, int kex_mask )
1990{
1991 return( ( ssl->handshake->key_exchange_mode & kex_mask ) != 0 );
1992}
1993
1994static inline int mbedtls_ssl_tls13_key_exchange_mode_with_psk(
1995 mbedtls_ssl_context *ssl )
1996{
1997 return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl,
1998 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
1999}
2000
2001static inline int mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(
2002 mbedtls_ssl_context *ssl )
2003{
2004 return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl,
2005 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
2006}
2007
2008/*
XiaokangQian6b226b02021-09-24 07:51:16 +00002009 * Fetch TLS 1.3 handshake message header
2010 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002011MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002012int mbedtls_ssl_tls13_fetch_handshake_msg( mbedtls_ssl_context *ssl,
2013 unsigned hs_type,
2014 unsigned char **buf,
2015 size_t *buf_len );
XiaokangQian6b226b02021-09-24 07:51:16 +00002016
2017/*
Xiaofei Bai947571e2021-09-29 09:12:03 +00002018 * Handler of TLS 1.3 server certificate message
2019 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002020MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai947571e2021-09-29 09:12:03 +00002021int mbedtls_ssl_tls13_process_certificate( mbedtls_ssl_context *ssl );
2022
Ronald Cron928cbd32022-10-04 16:14:26 +02002023#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002024/*
Jerry Yu3e536442022-02-15 11:05:59 +08002025 * Handler of TLS 1.3 write Certificate message
Jerry Yu5cc35062022-01-28 16:16:08 +08002026 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002027MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5cc35062022-01-28 16:16:08 +08002028int mbedtls_ssl_tls13_write_certificate( mbedtls_ssl_context *ssl );
2029
2030/*
Jerry Yu3e536442022-02-15 11:05:59 +08002031 * Handler of TLS 1.3 write Certificate Verify message
Jerry Yu8511f122022-01-29 10:01:04 +08002032 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002033MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8511f122022-01-29 10:01:04 +08002034int mbedtls_ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl );
Jerry Yu90f152d2022-01-29 22:12:42 +08002035
Ronald Cron928cbd32022-10-04 16:14:26 +02002036#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu90f152d2022-01-29 22:12:42 +08002037
Jerry Yu8511f122022-01-29 10:01:04 +08002038/*
Jerry Yu30b071c2021-09-12 20:16:03 +08002039 * Generic handler of Certificate Verify
2040 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002041MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu30b071c2021-09-12 20:16:03 +08002042int mbedtls_ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl );
2043
2044/*
Ronald Cron49ad6192021-11-24 16:25:31 +01002045 * Write of dummy-CCS's for middlebox compatibility
2046 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002047MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron49ad6192021-11-24 16:25:31 +01002048int mbedtls_ssl_tls13_write_change_cipher_spec( mbedtls_ssl_context *ssl );
2049
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002050MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian647719a2021-12-07 09:16:29 +00002051int mbedtls_ssl_reset_transcript_for_hrr( mbedtls_ssl_context *ssl );
2052
Jerry Yu89e103c2022-03-30 22:43:29 +08002053#if defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002054MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu89e103c2022-03-30 22:43:29 +08002055int mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
2056 mbedtls_ssl_context *ssl,
2057 uint16_t named_group,
2058 unsigned char *buf,
2059 unsigned char *end,
2060 size_t *out_len );
2061#endif /* MBEDTLS_ECDH_C */
2062
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00002063#if defined(MBEDTLS_SSL_EARLY_DATA)
2064int mbedtls_ssl_tls13_write_early_data_ext(
2065 mbedtls_ssl_context *ssl,
2066 unsigned char *buf, const unsigned char *end, size_t *olen);
2067#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu89e103c2022-03-30 22:43:29 +08002068
Jerry Yuf017ee42022-01-12 15:49:48 +08002069#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2070
Ronald Crone68ab4f2022-10-05 12:46:29 +02002071#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002072/*
Gabor Mezei53a3b142022-05-10 13:20:55 +02002073 * Parse TLS Signature Algorithm extension
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002074 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002075MBEDTLS_CHECK_RETURN_CRITICAL
Gabor Mezei078e8032022-04-27 21:17:56 +02002076int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
2077 const unsigned char *buf,
2078 const unsigned char *end );
Ronald Crone68ab4f2022-10-05 12:46:29 +02002079#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002080
Jerry Yu000f9762021-09-14 11:12:51 +08002081/* Get handshake transcript */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002082MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08002083int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
2084 const mbedtls_md_type_t md,
2085 unsigned char *dst,
2086 size_t dst_len,
2087 size_t *olen );
2088
Brett Warrene0edc842021-08-17 09:53:13 +01002089/*
2090 * Return supported groups.
2091 *
2092 * In future, invocations can be changed to ssl->conf->group_list
2093 * when mbedtls_ssl_conf_curves() is deleted.
2094 *
2095 * ssl->handshake->group_list is either a translation of curve_list to IANA TLS group
2096 * identifiers when mbedtls_ssl_conf_curves() has been used, or a pointer to
2097 * ssl->conf->group_list when mbedtls_ssl_conf_groups() has been more recently invoked.
2098 *
2099 */
2100static inline const void *mbedtls_ssl_get_groups( const mbedtls_ssl_context *ssl )
2101{
2102 #if defined(MBEDTLS_DEPRECATED_REMOVED) || !defined(MBEDTLS_ECP_C)
2103 return( ssl->conf->group_list );
2104 #else
2105 if( ( ssl->handshake != NULL ) && ( ssl->handshake->group_list != NULL ) )
2106 return( ssl->handshake->group_list );
2107 else
2108 return( ssl->conf->group_list );
2109 #endif
2110}
2111
Jerry Yuba073422021-12-20 22:22:15 +08002112/*
2113 * Helper functions for NamedGroup.
2114 */
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002115static inline int mbedtls_ssl_tls12_named_group_is_ecdhe( uint16_t named_group )
Jerry Yuba073422021-12-20 22:22:15 +08002116{
2117 /*
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002118 * RFC 8422 section 5.1.1
Jerry Yuba073422021-12-20 22:22:15 +08002119 */
Jerry Yuf0fede52022-01-12 10:57:47 +08002120 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2121 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 ||
2122 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 ||
2123 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 ||
2124 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 ||
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002125 /* Below deprecated curves should be removed with notice to users */
Jerry Yuf0fede52022-01-12 10:57:47 +08002126 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 ||
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002127 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 ||
2128 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 ||
2129 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 ||
2130 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 ||
2131 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
2132 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
Jerry Yuf0fede52022-01-12 10:57:47 +08002133 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 );
Jerry Yuba073422021-12-20 22:22:15 +08002134}
2135
2136static inline int mbedtls_ssl_tls13_named_group_is_ecdhe( uint16_t named_group )
2137{
Jerry Yuf0fede52022-01-12 10:57:47 +08002138 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2139 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08002140 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
2141 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08002142 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 );
2143}
2144
2145static inline int mbedtls_ssl_tls13_named_group_is_dhe( uint16_t named_group )
2146{
2147 return( named_group >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 &&
2148 named_group <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 );
2149}
2150
XiaokangQian08037552022-04-20 07:16:41 +00002151static inline int mbedtls_ssl_named_group_is_offered(
2152 const mbedtls_ssl_context *ssl, uint16_t named_group )
2153{
2154 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
2155
2156 if( group_list == NULL )
2157 return( 0 );
2158
2159 for( ; *group_list != 0; group_list++ )
2160 {
2161 if( *group_list == named_group )
2162 return( 1 );
2163 }
2164
2165 return( 0 );
2166}
2167
2168static inline int mbedtls_ssl_named_group_is_supported( uint16_t named_group )
2169{
2170#if defined(MBEDTLS_ECDH_C)
2171 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
2172 {
2173 const mbedtls_ecp_curve_info *curve_info =
2174 mbedtls_ecp_curve_info_from_tls_id( named_group );
2175 if( curve_info != NULL )
2176 return( 1 );
2177 }
2178#else
2179 ((void) named_group);
2180#endif /* MBEDTLS_ECDH_C */
2181 return( 0 );
2182}
2183
Jerry Yuafdfed12021-12-22 10:49:02 +08002184/*
Jerry Yu713013f2022-01-17 18:16:35 +08002185 * Return supported signature algorithms.
2186 *
2187 * In future, invocations can be changed to ssl->conf->sig_algs when
2188 * mbedtls_ssl_conf_sig_hashes() is deleted.
2189 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002190 * ssl->handshake->sig_algs is either a translation of sig_hashes to IANA TLS
2191 * signature algorithm identifiers when mbedtls_ssl_conf_sig_hashes() has been
2192 * used, or a pointer to ssl->conf->sig_algs when mbedtls_ssl_conf_sig_algs() has
2193 * been more recently invoked.
2194 *
Jerry Yuafdfed12021-12-22 10:49:02 +08002195 */
Jerry Yu713013f2022-01-17 18:16:35 +08002196static inline const void *mbedtls_ssl_get_sig_algs(
2197 const mbedtls_ssl_context *ssl )
Jerry Yuafdfed12021-12-22 10:49:02 +08002198{
Ronald Crone68ab4f2022-10-05 12:46:29 +02002199#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002200
Jerry Yu6106fdc2022-01-12 16:36:14 +08002201#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yucc539102022-06-27 16:27:35 +08002202 if( ssl->handshake != NULL &&
2203 ssl->handshake->sig_algs_heap_allocated == 1 &&
Jerry Yuee28e7a2022-06-24 19:35:40 +08002204 ssl->handshake->sig_algs != NULL )
2205 {
Jerry Yu6106fdc2022-01-12 16:36:14 +08002206 return( ssl->handshake->sig_algs );
Jerry Yuee28e7a2022-06-24 19:35:40 +08002207 }
Jerry Yu6106fdc2022-01-12 16:36:14 +08002208#endif
2209 return( ssl->conf->sig_algs );
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002210
Ronald Crone68ab4f2022-10-05 12:46:29 +02002211#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002212
Jerry Yu6106fdc2022-01-12 16:36:14 +08002213 ((void) ssl);
Jerry Yu713013f2022-01-17 18:16:35 +08002214 return( NULL );
Ronald Crone68ab4f2022-10-05 12:46:29 +02002215#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002216}
Jerry Yuba073422021-12-20 22:22:15 +08002217
Ronald Cron928cbd32022-10-04 16:14:26 +02002218#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu8511f122022-01-29 10:01:04 +08002219static inline int mbedtls_ssl_sig_alg_is_received( const mbedtls_ssl_context *ssl,
2220 uint16_t own_sig_alg )
2221{
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002222 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
2223 if( sig_alg == NULL )
2224 return( 0 );
2225
Gabor Mezei15b95a62022-05-09 16:37:58 +02002226 for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ )
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002227 {
2228 if( *sig_alg == own_sig_alg )
2229 return( 1 );
2230 }
2231 return( 0 );
Jerry Yu8511f122022-01-29 10:01:04 +08002232}
2233
Jerry Yua1255e62022-06-24 10:10:47 +08002234static inline int mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Jerry Yu0ebce952022-06-16 13:54:47 +08002235 const uint16_t sig_alg )
2236{
Jerry Yu96ee23e2022-06-21 16:34:57 +08002237 switch( sig_alg )
2238 {
2239#if defined(MBEDTLS_ECDSA_C)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002240#if defined(PSA_WANT_ALG_SHA_256) && defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002241 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
2242 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002243#endif /* PSA_WANT_ALG_SHA_256 && MBEDTLS_ECP_DP_SECP256R1_ENABLED */
2244#if defined(PSA_WANT_ALG_SHA_384) && defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002245 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
2246 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002247#endif /* PSA_WANT_ALG_SHA_384 && MBEDTLS_ECP_DP_SECP384R1_ENABLED */
2248#if defined(PSA_WANT_ALG_SHA_512) && defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002249 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
2250 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002251#endif /* PSA_WANT_ALG_SHA_512 && MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002252#endif /* MBEDTLS_ECDSA_C */
2253
Jerry Yu52b7d922022-07-01 18:03:31 +08002254#if defined(MBEDTLS_PKCS1_V21)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002255#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002256 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2257 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002258#endif /* PSA_WANT_ALG_SHA_256 */
2259#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002260 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2261 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002262#endif /* PSA_WANT_ALG_SHA_384 */
2263#if defined(PSA_WANT_ALG_SHA_512)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002264 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2265 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002266#endif /* PSA_WANT_ALG_SHA_512 */
Jerry Yu52b7d922022-07-01 18:03:31 +08002267#endif /* MBEDTLS_PKCS1_V21 */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002268 default:
2269 return( 0 );
2270 }
2271 return( 1 );
Jerry Yu80dd5db2022-06-22 19:30:32 +08002272
2273}
2274
2275static inline int mbedtls_ssl_tls13_sig_alg_is_supported(
2276 const uint16_t sig_alg )
2277{
2278 switch( sig_alg )
2279 {
Jerry Yu52b7d922022-07-01 18:03:31 +08002280#if defined(MBEDTLS_PKCS1_V15)
Przemek Stekiel153b4422022-09-05 12:36:25 +02002281#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002282 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
2283 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002284#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2285#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002286 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
2287 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002288#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2289#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002290 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
2291 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002292#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu52b7d922022-07-01 18:03:31 +08002293#endif /* MBEDTLS_PKCS1_V15 */
Jerry Yu80dd5db2022-06-22 19:30:32 +08002294 default:
Jerry Yua1255e62022-06-24 10:10:47 +08002295 return( mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Jerry Yu80dd5db2022-06-22 19:30:32 +08002296 sig_alg ) );
2297 }
2298 return( 1 );
Jerry Yu0ebce952022-06-16 13:54:47 +08002299}
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002300
Ronald Cron928cbd32022-10-04 16:14:26 +02002301MBEDTLS_CHECK_RETURN_CRITICAL
2302int mbedtls_ssl_tls13_check_sig_alg_cert_key_match( uint16_t sig_alg,
2303 mbedtls_pk_context *key );
2304#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
2305
Ronald Crone68ab4f2022-10-05 12:46:29 +02002306#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron928cbd32022-10-04 16:14:26 +02002307static inline int mbedtls_ssl_sig_alg_is_offered( const mbedtls_ssl_context *ssl,
2308 uint16_t proposed_sig_alg )
2309{
2310 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
2311 if( sig_alg == NULL )
2312 return( 0 );
2313
2314 for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ )
2315 {
2316 if( *sig_alg == proposed_sig_alg )
2317 return( 1 );
2318 }
2319 return( 0 );
2320}
2321
2322static inline int mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
2323 uint16_t sig_alg, mbedtls_pk_type_t *pk_type, mbedtls_md_type_t *md_alg )
2324{
2325 *pk_type = mbedtls_ssl_pk_alg_from_sig( sig_alg & 0xff );
2326 *md_alg = mbedtls_ssl_md_alg_from_hash( ( sig_alg >> 8 ) & 0xff );
2327
2328 if( *pk_type != MBEDTLS_PK_NONE && *md_alg != MBEDTLS_MD_NONE )
2329 return( 0 );
2330
2331 switch( sig_alg )
2332 {
2333#if defined(MBEDTLS_PKCS1_V21)
2334#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2335 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2336 *md_alg = MBEDTLS_MD_SHA256;
2337 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2338 break;
2339#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2340#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2341 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2342 *md_alg = MBEDTLS_MD_SHA384;
2343 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2344 break;
2345#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2346#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2347 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2348 *md_alg = MBEDTLS_MD_SHA512;
2349 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2350 break;
2351#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2352#endif /* MBEDTLS_PKCS1_V21 */
2353 default:
2354 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2355 }
2356 return( 0 );
2357}
Jerry Yu8c338862022-03-23 13:34:04 +08002358
Jerry Yu0ebce952022-06-16 13:54:47 +08002359#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2360static inline int mbedtls_ssl_tls12_sig_alg_is_supported(
2361 const uint16_t sig_alg )
2362{
2363 /* High byte is hash */
2364 unsigned char hash = MBEDTLS_BYTE_1( sig_alg );
2365 unsigned char sig = MBEDTLS_BYTE_0( sig_alg );
2366
2367 switch( hash )
2368 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04002369#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002370 case MBEDTLS_SSL_HASH_MD5:
2371 break;
2372#endif
2373
Andrzej Kurek25f27152022-08-17 16:09:31 -04002374#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002375 case MBEDTLS_SSL_HASH_SHA1:
2376 break;
2377#endif
2378
Andrzej Kurek25f27152022-08-17 16:09:31 -04002379#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002380 case MBEDTLS_SSL_HASH_SHA224:
2381 break;
2382#endif
2383
Andrzej Kurek25f27152022-08-17 16:09:31 -04002384#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002385 case MBEDTLS_SSL_HASH_SHA256:
2386 break;
2387#endif
2388
Andrzej Kurek25f27152022-08-17 16:09:31 -04002389#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002390 case MBEDTLS_SSL_HASH_SHA384:
2391 break;
2392#endif
2393
Andrzej Kurek25f27152022-08-17 16:09:31 -04002394#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002395 case MBEDTLS_SSL_HASH_SHA512:
2396 break;
2397#endif
2398
2399 default:
2400 return( 0 );
2401 }
2402
2403 switch( sig )
2404 {
2405#if defined(MBEDTLS_RSA_C)
2406 case MBEDTLS_SSL_SIG_RSA:
2407 break;
2408#endif
2409
2410#if defined(MBEDTLS_ECDSA_C)
2411 case MBEDTLS_SSL_SIG_ECDSA:
2412 break;
2413#endif
2414
2415 default:
2416 return( 0 );
2417 }
2418
2419 return( 1 );
2420}
2421#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2422
Jerry Yu1bab3012022-01-19 17:43:22 +08002423static inline int mbedtls_ssl_sig_alg_is_supported(
2424 const mbedtls_ssl_context *ssl,
2425 const uint16_t sig_alg )
2426{
2427
2428#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002429 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002430 {
Jerry Yu0ebce952022-06-16 13:54:47 +08002431 return( mbedtls_ssl_tls12_sig_alg_is_supported( sig_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002432 }
2433#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2434
Ronald Cron928cbd32022-10-04 16:14:26 +02002435#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002436 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002437 {
Jerry Yu7ab7f2b2022-06-16 19:07:10 +08002438 return( mbedtls_ssl_tls13_sig_alg_is_supported( sig_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002439 }
Ronald Cron928cbd32022-10-04 16:14:26 +02002440#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002441 ((void) ssl);
2442 ((void) sig_alg);
2443 return( 0 );
2444}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002445#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1bab3012022-01-19 17:43:22 +08002446
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002447#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002448/* Corresponding PSA algorithm for MBEDTLS_CIPHER_NULL.
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002449 * Same value is used for PSA_ALG_CATEGORY_CIPHER, hence it is
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002450 * guaranteed to not be a valid PSA algorithm identifier.
2451 */
2452#define MBEDTLS_SSL_NULL_CIPHER 0x04000000
2453
2454/**
2455 * \brief Translate mbedtls cipher type/taglen pair to psa:
2456 * algorithm, key type and key size.
2457 *
2458 * \param mbedtls_cipher_type [in] given mbedtls cipher type
2459 * \param taglen [in] given tag length
2460 * 0 - default tag length
2461 * \param alg [out] corresponding PSA alg
2462 * There is no corresponding PSA
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01002463 * alg for MBEDTLS_CIPHER_NULL, so
2464 * in this case MBEDTLS_SSL_NULL_CIPHER
2465 * is returned via this parameter
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002466 * \param key_type [out] corresponding PSA key type
2467 * \param key_size [out] corresponding PSA key size
2468 *
2469 * \return PSA_SUCCESS on success or PSA_ERROR_NOT_SUPPORTED if
2470 * conversion is not supported.
2471 */
2472psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
2473 size_t taglen,
2474 psa_algorithm_t *alg,
2475 psa_key_type_t *key_type,
2476 size_t *key_size );
2477
2478/**
2479 * \brief Convert given PSA status to mbedtls error code.
2480 *
2481 * \param status [in] given PSA status
2482 *
2483 * \return corresponding mbedtls error code
2484 */
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01002485static inline int psa_ssl_status_to_mbedtls( psa_status_t status )
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002486{
2487 switch( status )
2488 {
2489 case PSA_SUCCESS:
2490 return( 0 );
2491 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002492 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002493 case PSA_ERROR_NOT_SUPPORTED:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002494 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Przemyslaw Stekiel89dad932022-01-31 09:18:07 +01002495 case PSA_ERROR_INVALID_SIGNATURE:
2496 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Gabor Mezeiadfeadc2022-03-21 12:17:49 +01002497 case PSA_ERROR_INVALID_ARGUMENT:
2498 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2499 case PSA_ERROR_BAD_STATE:
2500 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemek Stekiel85836272022-04-05 10:50:53 +02002501 case PSA_ERROR_BUFFER_TOO_SMALL:
2502 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002503 default:
2504 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
2505 }
2506}
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002507#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu1bab3012022-01-19 17:43:22 +08002508
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002509/**
2510 * \brief TLS record protection modes
2511 */
2512typedef enum {
2513 MBEDTLS_SSL_MODE_STREAM = 0,
2514 MBEDTLS_SSL_MODE_CBC,
2515 MBEDTLS_SSL_MODE_CBC_ETM,
2516 MBEDTLS_SSL_MODE_AEAD
2517} mbedtls_ssl_mode_t;
2518
Neil Armstrongab555e02022-04-04 11:07:59 +02002519mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002520 const mbedtls_ssl_transform *transform );
2521
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002522#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrongab555e02022-04-04 11:07:59 +02002523mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002524 int encrypt_then_mac,
2525 const mbedtls_ssl_ciphersuite_t *suite );
2526#else
Neil Armstrongab555e02022-04-04 11:07:59 +02002527mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002528 const mbedtls_ssl_ciphersuite_t *suite );
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002529#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002530
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002531#if defined(MBEDTLS_ECDH_C)
2532
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002533MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002534int mbedtls_ssl_tls13_read_public_ecdhe_share( mbedtls_ssl_context *ssl,
2535 const unsigned char *buf,
2536 size_t buf_len );
2537
2538#endif /* MBEDTLS_ECDH_C */
2539
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002540static inline int mbedtls_ssl_tls13_cipher_suite_is_offered(
2541 mbedtls_ssl_context *ssl, int cipher_suite )
2542{
2543 const int *ciphersuite_list = ssl->conf->ciphersuite_list;
2544
2545 /* Check whether we have offered this ciphersuite */
2546 for ( size_t i = 0; ciphersuite_list[i] != 0; i++ )
2547 {
2548 if( ciphersuite_list[i] == cipher_suite )
2549 {
2550 return( 1 );
2551 }
2552 }
2553 return( 0 );
2554}
2555
2556/**
2557 * \brief Validate cipher suite against config in SSL context.
2558 *
2559 * \param ssl SSL context
2560 * \param suite_info Cipher suite to validate
2561 * \param min_tls_version Minimal TLS version to accept a cipher suite
2562 * \param max_tls_version Maximal TLS version to accept a cipher suite
2563 *
2564 * \return 0 if valid, negative value otherwise.
2565 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002566MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002567int mbedtls_ssl_validate_ciphersuite(
2568 const mbedtls_ssl_context *ssl,
2569 const mbedtls_ssl_ciphersuite_t *suite_info,
2570 mbedtls_ssl_protocol_version min_tls_version,
2571 mbedtls_ssl_protocol_version max_tls_version );
XiaokangQian08037552022-04-20 07:16:41 +00002572
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002573MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeaf36512022-04-24 09:07:44 +00002574int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
2575 const unsigned char *end, size_t *out_len );
2576
XiaokangQian40a35232022-05-07 09:02:40 +00002577#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002578MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00002579int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
2580 const unsigned char *buf,
2581 const unsigned char *end );
XiaokangQian40a35232022-05-07 09:02:40 +00002582#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2583
XiaokangQianacb39922022-06-17 10:18:48 +00002584#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002585MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00002586int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
2587 const unsigned char *buf,
2588 const unsigned char *end );
2589
2590
Ronald Cronce7d76e2022-07-08 18:56:49 +02002591MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00002592int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
2593 unsigned char *buf,
2594 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00002595 size_t *out_len );
XiaokangQianacb39922022-06-17 10:18:48 +00002596#endif /* MBEDTLS_SSL_ALPN */
2597
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002598#if defined(MBEDTLS_TEST_HOOKS)
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04002599int mbedtls_ssl_check_dtls_clihlo_cookie(
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002600 mbedtls_ssl_context *ssl,
2601 const unsigned char *cli_id, size_t cli_id_len,
2602 const unsigned char *in, size_t in_len,
2603 unsigned char *obuf, size_t buf_len, size_t *olen );
2604#endif
2605
Ronald Cron41a443a2022-10-04 16:38:25 +02002606#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00002607/**
2608 * \brief Given an SSL context and its associated configuration, write the TLS
2609 * 1.3 specific Pre-Shared key extension.
2610 *
2611 * \param[in] ssl SSL context
2612 * \param[in] buf Base address of the buffer where to write the extension
2613 * \param[in] end End address of the buffer where to write the extension
XiaokangQian008d2bf2022-07-14 07:54:01 +00002614 * \param[out] out_len Length in bytes of the Pre-Shared key extension: data
2615 * written into the buffer \p buf by this function plus
2616 * the length of the binders to be written.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002617 * \param[out] binders_len Length of the binders to be written at the end of
XiaokangQian008d2bf2022-07-14 07:54:01 +00002618 * the extension.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002619 */
XiaokangQian86981952022-07-19 09:51:50 +00002620MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian3ad67bf2022-07-21 02:26:21 +00002621int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002622 mbedtls_ssl_context *ssl,
2623 unsigned char *buf, unsigned char *end,
2624 size_t *out_len, size_t *binders_len );
2625
2626/**
2627 * \brief Given an SSL context and its associated configuration, write the TLS
2628 * 1.3 specific Pre-Shared key extension binders at the end of the
2629 * ClientHello.
2630 *
2631 * \param[in] ssl SSL context
XiaokangQian008d2bf2022-07-14 07:54:01 +00002632 * \param[in] buf Base address of the buffer where to write the binders
2633 * \param[in] end End address of the buffer where to write the binders
XiaokangQianeb69aee2022-07-05 08:21:43 +00002634 */
XiaokangQian86981952022-07-19 09:51:50 +00002635MBEDTLS_CHECK_RETURN_CRITICAL
2636int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002637 mbedtls_ssl_context *ssl,
2638 unsigned char *buf, unsigned char *end );
Ronald Cron41a443a2022-10-04 16:38:25 +02002639#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00002640
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002641#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00002642 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002643 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00002644 defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qian03409292022-10-12 02:49:52 +00002645MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002646int mbedtls_ssl_session_set_hostname( mbedtls_ssl_session *session,
2647 const char *hostname );
2648#endif
2649
Chris Jones84a773f2021-03-05 18:38:47 +00002650#endif /* ssl_misc.h */