blob: d454ebb51826c72f4f4b12b18d5c1c2719bf092e [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
Xiaokang Qian338f7272022-11-02 07:18:30 +000080/* Early data indication sent or not */
81#define MBEDTLS_SSL_EARLY_DATA_OFF 0
82#define MBEDTLS_SSL_EARLY_DATA_ON 1
83
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020084/*
Jerry Yuea52ed92022-11-08 21:01:17 +080085 * Internal identity of handshake extensions
Jerry Yu8e7ca042021-08-26 15:31:37 +080086 */
Jerry Yu7a485c12022-10-31 13:08:18 +080087#define MBEDTLS_SSL_EXT_ID_UNRECOGNIZED 0
88#define MBEDTLS_SSL_EXT_ID_SERVERNAME 1
89#define MBEDTLS_SSL_EXT_ID_SERVERNAME_HOSTNAME 1
90#define MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH 2
91#define MBEDTLS_SSL_EXT_ID_STATUS_REQUEST 3
92#define MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS 4
93#define MBEDTLS_SSL_EXT_ID_SUPPORTED_ELLIPTIC_CURVES 4
94#define MBEDTLS_SSL_EXT_ID_SIG_ALG 5
95#define MBEDTLS_SSL_EXT_ID_USE_SRTP 6
96#define MBEDTLS_SSL_EXT_ID_HEARTBEAT 7
97#define MBEDTLS_SSL_EXT_ID_ALPN 8
98#define MBEDTLS_SSL_EXT_ID_SCT 9
99#define MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE 10
100#define MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE 11
101#define MBEDTLS_SSL_EXT_ID_PADDING 12
102#define MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY 13
103#define MBEDTLS_SSL_EXT_ID_EARLY_DATA 14
104#define MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS 15
105#define MBEDTLS_SSL_EXT_ID_COOKIE 16
106#define MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES 17
107#define MBEDTLS_SSL_EXT_ID_CERT_AUTH 18
108#define MBEDTLS_SSL_EXT_ID_OID_FILTERS 19
109#define MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH 20
110#define MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT 21
111#define MBEDTLS_SSL_EXT_ID_KEY_SHARE 22
112#define MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC 23
113#define MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS 24
114#define MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC 25
115#define MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET 26
116#define MBEDTLS_SSL_EXT_ID_SESSION_TICKET 27
Jerry Yu8e7ca042021-08-26 15:31:37 +0800117
Jerry Yu7a485c12022-10-31 13:08:18 +0800118/* Utility for translating IANA extension type. */
119uint32_t mbedtls_ssl_get_extension_id( unsigned int extension_type );
120uint32_t mbedtls_ssl_get_extension_mask( unsigned int extension_type );
121/* Macros used to define mask constants */
122#define MBEDTLS_SSL_EXT_MASK( id ) ( 1ULL << ( MBEDTLS_SSL_EXT_ID_##id ) )
123/* Reset value of extension mask */
124#define MBEDTLS_SSL_EXT_MASK_NONE 0
Jerry Yu93bcd612021-08-18 12:47:24 +0800125
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800126/* In messages containing extension requests, we should ignore unrecognized
127 * extensions. In messages containing extension responses, unrecognized
128 * extensions should result in handshake abortion. Messages containing
129 * extension requests include ClientHello, CertificateRequest and
130 * NewSessionTicket. Messages containing extension responses include
131 * ServerHello, HelloRetryRequest, EncryptedExtensions and Certificate.
Jerry Yue18dc7e2022-08-04 16:29:22 +0800132 *
Jerry Yud15992d2022-08-29 10:58:31 +0800133 * RFC 8446 section 4.1.3
Jerry Yue18dc7e2022-08-04 16:29:22 +0800134 *
135 * The ServerHello MUST only include extensions which are required to establish
136 * the cryptographic context and negotiate the protocol version.
137 *
Jerry Yud15992d2022-08-29 10:58:31 +0800138 * RFC 8446 section 4.2
Jerry Yue18dc7e2022-08-04 16:29:22 +0800139 *
140 * If an implementation receives an extension which it recognizes and which is
141 * not specified for the message in which it appears, it MUST abort the handshake
142 * with an "illegal_parameter" alert.
143 */
Jerry Yudf0ad652022-10-31 13:20:57 +0800144
Jerry Yuea52ed92022-11-08 21:01:17 +0800145/* Extensions that are not recognized by TLS 1.3 */
146#define MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED \
Jerry Yudf0ad652022-10-31 13:20:57 +0800147 ( MBEDTLS_SSL_EXT_MASK( SUPPORTED_POINT_FORMATS ) | \
148 MBEDTLS_SSL_EXT_MASK( ENCRYPT_THEN_MAC ) | \
149 MBEDTLS_SSL_EXT_MASK( EXTENDED_MASTER_SECRET ) | \
150 MBEDTLS_SSL_EXT_MASK( SESSION_TICKET ) | \
Jerry Yub95dd362022-11-08 21:19:34 +0800151 MBEDTLS_SSL_EXT_MASK( TRUNCATED_HMAC ) | \
Jerry Yudf0ad652022-10-31 13:20:57 +0800152 MBEDTLS_SSL_EXT_MASK( UNRECOGNIZED ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800153
Jerry Yud15992d2022-08-29 10:58:31 +0800154/* RFC 8446 section 4.2. Allowed extensions for ClienHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800155#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH \
Jerry Yudf0ad652022-10-31 13:20:57 +0800156 ( MBEDTLS_SSL_EXT_MASK( SERVERNAME ) | \
157 MBEDTLS_SSL_EXT_MASK( MAX_FRAGMENT_LENGTH ) | \
158 MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \
159 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) | \
160 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) | \
161 MBEDTLS_SSL_EXT_MASK( USE_SRTP ) | \
162 MBEDTLS_SSL_EXT_MASK( HEARTBEAT ) | \
163 MBEDTLS_SSL_EXT_MASK( ALPN ) | \
164 MBEDTLS_SSL_EXT_MASK( SCT ) | \
165 MBEDTLS_SSL_EXT_MASK( CLI_CERT_TYPE ) | \
166 MBEDTLS_SSL_EXT_MASK( SERV_CERT_TYPE ) | \
167 MBEDTLS_SSL_EXT_MASK( PADDING ) | \
168 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \
169 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) | \
170 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) | \
171 MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) | \
172 MBEDTLS_SSL_EXT_MASK( COOKIE ) | \
173 MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) | \
174 MBEDTLS_SSL_EXT_MASK( CERT_AUTH ) | \
175 MBEDTLS_SSL_EXT_MASK( POST_HANDSHAKE_AUTH ) | \
176 MBEDTLS_SSL_EXT_MASK( SIG_ALG_CERT ) | \
Jerry Yuea52ed92022-11-08 21:01:17 +0800177 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800178
Jerry Yud15992d2022-08-29 10:58:31 +0800179/* RFC 8446 section 4.2. Allowed extensions for EncryptedExtensions */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800180#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE \
Jerry Yudf0ad652022-10-31 13:20:57 +0800181 ( MBEDTLS_SSL_EXT_MASK( SERVERNAME ) | \
182 MBEDTLS_SSL_EXT_MASK( MAX_FRAGMENT_LENGTH ) | \
183 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) | \
184 MBEDTLS_SSL_EXT_MASK( USE_SRTP ) | \
185 MBEDTLS_SSL_EXT_MASK( HEARTBEAT ) | \
186 MBEDTLS_SSL_EXT_MASK( ALPN ) | \
187 MBEDTLS_SSL_EXT_MASK( CLI_CERT_TYPE ) | \
188 MBEDTLS_SSL_EXT_MASK( SERV_CERT_TYPE ) | \
189 MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800190
Jerry Yud15992d2022-08-29 10:58:31 +0800191/* RFC 8446 section 4.2. Allowed extensions for CertificateRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800192#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR \
Jerry Yudf0ad652022-10-31 13:20:57 +0800193 ( MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \
194 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) | \
195 MBEDTLS_SSL_EXT_MASK( SCT ) | \
196 MBEDTLS_SSL_EXT_MASK( CERT_AUTH ) | \
197 MBEDTLS_SSL_EXT_MASK( OID_FILTERS ) | \
198 MBEDTLS_SSL_EXT_MASK( SIG_ALG_CERT ) | \
Jerry Yuea52ed92022-11-08 21:01:17 +0800199 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800200
Jerry Yud15992d2022-08-29 10:58:31 +0800201/* RFC 8446 section 4.2. Allowed extensions for Certificate */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800202#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CT \
Jerry Yudf0ad652022-10-31 13:20:57 +0800203 ( MBEDTLS_SSL_EXT_MASK( STATUS_REQUEST ) | \
204 MBEDTLS_SSL_EXT_MASK( SCT ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800205
Jerry Yud15992d2022-08-29 10:58:31 +0800206/* RFC 8446 section 4.2. Allowed extensions for ServerHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800207#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH \
Jerry Yudf0ad652022-10-31 13:20:57 +0800208 ( MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \
209 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) | \
210 MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800211
Jerry Yud15992d2022-08-29 10:58:31 +0800212/* RFC 8446 section 4.2. Allowed extensions for HelloRetryRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800213#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR \
Jerry Yudf0ad652022-10-31 13:20:57 +0800214 ( MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) | \
215 MBEDTLS_SSL_EXT_MASK( COOKIE ) | \
216 MBEDTLS_SSL_EXT_MASK( SUPPORTED_VERSIONS ) )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800217
Jerry Yud15992d2022-08-29 10:58:31 +0800218/* RFC 8446 section 4.2. Allowed extensions for NewSessionTicket */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800219#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST \
Jerry Yudf0ad652022-10-31 13:20:57 +0800220 ( MBEDTLS_SSL_EXT_MASK( EARLY_DATA ) | \
Jerry Yuea52ed92022-11-08 21:01:17 +0800221 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800222
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800223/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800224 * Helper macros for function call with return check.
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800225 */
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800226/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800227 * Exit when return non-zero value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800228 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800229#define MBEDTLS_SSL_PROC_CHK( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800230 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800231 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800232 if( ret != 0 ) \
233 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800234 goto cleanup; \
235 } \
236 } while( 0 )
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800237/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800238 * Exit when return negative value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800239 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800240#define MBEDTLS_SSL_PROC_CHK_NEG( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800241 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800242 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800243 if( ret < 0 ) \
244 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800245 goto cleanup; \
246 } \
247 } while( 0 )
248
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200249/*
250 * DTLS retransmission states, see RFC 6347 4.2.4
251 *
252 * The SENDING state is merged in PREPARING for initial sends,
253 * but is distinct for resends.
254 *
255 * Note: initial state is wrong for server, but is not used anyway.
256 */
257#define MBEDTLS_SSL_RETRANS_PREPARING 0
258#define MBEDTLS_SSL_RETRANS_SENDING 1
259#define MBEDTLS_SSL_RETRANS_WAITING 2
260#define MBEDTLS_SSL_RETRANS_FINISHED 3
261
262/*
263 * Allow extra bytes for record, authentication and encryption overhead:
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100264 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256).
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200265 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200266
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200267#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0cc46612020-11-30 08:56:52 +0000268
Manuel Pégourié-Gonnard05579c42020-07-31 12:53:39 +0200269/* This macro determines whether CBC is supported. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200270#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
271 ( defined(MBEDTLS_AES_C) || \
272 defined(MBEDTLS_CAMELLIA_C) || \
273 defined(MBEDTLS_ARIA_C) || \
274 defined(MBEDTLS_DES_C) )
275#define MBEDTLS_SSL_SOME_SUITES_USE_CBC
276#endif
277
Hanno Becker0cc46612020-11-30 08:56:52 +0000278/* This macro determines whether a ciphersuite using a
279 * stream cipher can be used. */
280#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
281#define MBEDTLS_SSL_SOME_SUITES_USE_STREAM
282#endif
283
TRodziewicz0f82ec62021-05-12 17:49:18 +0200284/* This macro determines whether the CBC construct used in TLS 1.2 is supported. */
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200285#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200286 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200287#define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC
288#endif
289
Hanno Becker31351ce2021-03-22 11:05:58 +0000290#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200291 defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000292#define MBEDTLS_SSL_SOME_SUITES_USE_MAC
Hanno Becker52344c22018-01-03 15:24:20 +0000293#endif
294
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200295/* This macro determines whether a ciphersuite uses Encrypt-then-MAC with CBC */
296#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
297 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
298#define MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM
299#endif
300
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200301#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker0cc46612020-11-30 08:56:52 +0000302
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000303#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200304/* Ciphersuites using HMAC */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400305#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200306#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400307#elif defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200308#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
309#else
310#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
311#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000312#else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200313/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
314#define MBEDTLS_SSL_MAC_ADD 16
315#endif
316
317#if defined(MBEDTLS_CIPHER_MODE_CBC)
318#define MBEDTLS_SSL_PADDING_ADD 256
319#else
320#define MBEDTLS_SSL_PADDING_ADD 0
321#endif
322
Hanno Beckera0e20d02019-05-15 14:03:01 +0100323#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
TRodziewicze8dd7092021-05-12 14:19:11 +0200324#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Hanno Becker6cbad552019-05-08 15:40:11 +0100325#else
326#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
327#endif
328
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100329#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_MAX_IV_LENGTH + \
Angus Grattond8213d02016-05-25 20:56:48 +1000330 MBEDTLS_SSL_MAC_ADD + \
Hanno Becker6cbad552019-05-08 15:40:11 +0100331 MBEDTLS_SSL_PADDING_ADD + \
332 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000333 )
334
335#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
336 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
337
338#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
339 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
340
Hanno Becker0271f962018-08-16 13:23:47 +0100341/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100342#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100343
Angus Grattond8213d02016-05-25 20:56:48 +1000344/* Maximum length we can advertise as our max content length for
345 RFC 6066 max_fragment_length extension negotiation purposes
346 (the lesser of both sizes, if they are unequal.)
347 */
348#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
349 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
350 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
351 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
352 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200353
Jerry Yu4131ec12022-01-19 10:36:30 +0800354/* Maximum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
355#define MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN 65534
356
Jerry Yu8afd6e42022-01-20 15:54:26 +0800357/* Minimum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
Jerry Yu4131ec12022-01-19 10:36:30 +0800358#define MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN 2
Hanno Beckere131bfe2017-04-12 14:54:42 +0100359
360/* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */
361#define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535
362
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000363#define MBEDTLS_RECEIVED_SIG_ALGS_SIZE 20
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +0000364
Ronald Crone68ab4f2022-10-05 12:46:29 +0200365#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200366
Gabor Mezei24c7c2b2022-05-10 12:51:14 +0200367#define MBEDTLS_TLS_SIG_NONE MBEDTLS_TLS1_3_SIG_NONE
368
Gabor Mezei15b95a62022-05-09 16:37:58 +0200369#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gabor Mezei3631cf62022-05-10 12:59:00 +0200370#define MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( sig, hash ) (( hash << 8 ) | sig)
371#define MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg & 0xFF)
372#define MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg >> 8)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200373#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
374
Ronald Crone68ab4f2022-10-05 12:46:29 +0200375#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei15b95a62022-05-09 16:37:58 +0200376
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200377/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100378 * Check that we obey the standard's message size bounds
379 */
380
David Horstmann95d516f2021-05-04 18:36:56 +0100381#if MBEDTLS_SSL_IN_CONTENT_LEN > 16384
382#error "Bad configuration - incoming 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_OUT_CONTENT_LEN > 16384
386#error "Bad configuration - outgoing record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100387#endif
388
David Horstmann95d516f2021-05-04 18:36:56 +0100389#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000390#error "Bad configuration - incoming protected record payload too large."
391#endif
392
David Horstmann95d516f2021-05-04 18:36:56 +0100393#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000394#error "Bad configuration - outgoing protected record payload too large."
395#endif
396
397/* Calculate buffer sizes */
398
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000399/* Note: Even though the TLS record header is only 5 bytes
400 long, we're internally using 8 bytes to store the
401 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100402#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100403
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500404#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000405#define MBEDTLS_SSL_IN_BUFFER_LEN \
406 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100407#else
408#define MBEDTLS_SSL_IN_BUFFER_LEN \
409 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
410 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
411#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000412
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500413#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000414#define MBEDTLS_SSL_OUT_BUFFER_LEN \
415 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100416#else
417#define MBEDTLS_SSL_OUT_BUFFER_LEN \
418 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
419 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
420#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000421
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800422#define MBEDTLS_CLIENT_HELLO_RANDOM_LEN 32
423#define MBEDTLS_SERVER_HELLO_RANDOM_LEN 32
424
Hanno Becker9752aad2021-04-21 05:54:33 +0100425#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
426/**
427 * \brief Return the maximum fragment length (payload, in bytes) for
428 * the output buffer. For the client, this is the configured
429 * value. For the server, it is the minimum of two - the
430 * configured value and the negotiated one.
431 *
432 * \sa mbedtls_ssl_conf_max_frag_len()
433 * \sa mbedtls_ssl_get_max_out_record_payload()
434 *
435 * \param ssl SSL context
436 *
437 * \return Current maximum fragment length for the output buffer.
438 */
439size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl );
440
441/**
442 * \brief Return the maximum fragment length (payload, in bytes) for
443 * the input buffer. This is the negotiated maximum fragment
Hanno Beckerdf3b8632021-06-08 05:30:45 +0100444 * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN.
Hanno Becker9752aad2021-04-21 05:54:33 +0100445 * If it is not defined either, the value is 2^14. This function
446 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
447 *
448 * \sa mbedtls_ssl_conf_max_frag_len()
449 * \sa mbedtls_ssl_get_max_in_record_payload()
450 *
451 * \param ssl SSL context
452 *
453 * \return Current maximum fragment length for the output buffer.
454 */
455size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl );
456#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
457
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500458#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500459static inline size_t mbedtls_ssl_get_output_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500460{
461#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
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 + MBEDTLS_SSL_CID_OUT_LEN_MAX;
465#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500466 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500467 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
468#endif
469}
470
Andrzej Kurek069fa962021-01-07 08:02:15 -0500471static inline size_t mbedtls_ssl_get_input_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500472{
473#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
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 + MBEDTLS_SSL_CID_IN_LEN_MAX;
477#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500478 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500479 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
480#endif
481}
482#endif
483
Hanno Beckera8434e82017-09-18 10:54:39 +0100484/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200485 * TLS extension flags (for extensions with outgoing ServerHello content
486 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
487 * of state of the renegotiation flag, so no indicator is required)
488 */
489#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200490#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200491
Hanno Becker51018aa2017-04-12 14:54:42 +0100492/**
493 * \brief This function checks if the remaining size in a buffer is
494 * greater or equal than a needed space.
495 *
496 * \param cur Pointer to the current position in the buffer.
497 * \param end Pointer to one past the end of the buffer.
498 * \param need Needed space in bytes.
499 *
Ronald Cronb7b35e12020-06-11 09:50:51 +0200500 * \return Zero if the needed space is available in the buffer, non-zero
Hanno Becker51018aa2017-04-12 14:54:42 +0100501 * otherwise.
502 */
Ronald Cronad8c17b2022-06-10 17:18:09 +0200503#if ! defined(MBEDTLS_TEST_HOOKS)
Hanno Becker51018aa2017-04-12 14:54:42 +0100504static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
505 const uint8_t *end, size_t need )
506{
Ronald Cronb7b35e12020-06-11 09:50:51 +0200507 return( ( cur > end ) || ( need > (size_t)( end - cur ) ) );
Hanno Becker51018aa2017-04-12 14:54:42 +0100508}
Ronald Cronad8c17b2022-06-10 17:18:09 +0200509#else
510typedef struct
511{
512 const uint8_t *cur;
513 const uint8_t *end;
514 size_t need;
515} mbedtls_ssl_chk_buf_ptr_args;
516
517void mbedtls_ssl_set_chk_buf_ptr_fail_args(
518 const uint8_t *cur, const uint8_t *end, size_t need );
519void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void );
Ronald Cronce7d76e2022-07-08 18:56:49 +0200520
521MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronad8c17b2022-06-10 17:18:09 +0200522int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args );
523
524static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
525 const uint8_t *end, size_t need )
526{
527 if( ( cur > end ) || ( need > (size_t)( end - cur ) ) )
528 {
529 mbedtls_ssl_set_chk_buf_ptr_fail_args( cur, end, need );
530 return( 1 );
531 }
532 return( 0 );
533}
Ronald Croncf600bc2022-06-17 15:54:16 +0200534#endif /* MBEDTLS_TEST_HOOKS */
Hanno Becker51018aa2017-04-12 14:54:42 +0100535
536/**
537 * \brief This macro checks if the remaining size in a buffer is
538 * greater or equal than a needed space. If it is not the case,
539 * it returns an SSL_BUFFER_TOO_SMALL error.
540 *
541 * \param cur Pointer to the current position in the buffer.
542 * \param end Pointer to one past the end of the buffer.
543 * \param need Needed space in bytes.
544 *
545 */
546#define MBEDTLS_SSL_CHK_BUF_PTR( cur, end, need ) \
547 do { \
Ronald Cronb7b35e12020-06-11 09:50:51 +0200548 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100549 { \
550 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); \
551 } \
552 } while( 0 )
553
Jerry Yu34da3722021-09-19 18:05:08 +0800554/**
Jerry Yue15e6652021-09-28 21:06:07 +0800555 * \brief This macro checks if the remaining length in an input buffer is
556 * greater or equal than a needed length. If it is not the case, it
Jerry Yu205fd822021-10-08 16:16:24 +0800557 * returns #MBEDTLS_ERR_SSL_DECODE_ERROR error and pends a
Jerry Yudca3d5d2021-10-08 14:19:29 +0800558 * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message.
Jerry Yue4eefc72021-10-09 10:40:40 +0800559 *
560 * This is a function-like macro. It is guaranteed to evaluate each
561 * argument exactly once.
Jerry Yu34da3722021-09-19 18:05:08 +0800562 *
563 * \param cur Pointer to the current position in the buffer.
564 * \param end Pointer to one past the end of the buffer.
Jerry Yue15e6652021-09-28 21:06:07 +0800565 * \param need Needed length in bytes.
Jerry Yu34da3722021-09-19 18:05:08 +0800566 *
567 */
568#define MBEDTLS_SSL_CHK_BUF_READ_PTR( cur, end, need ) \
569 do { \
570 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
571 { \
572 MBEDTLS_SSL_DEBUG_MSG( 1, \
573 ( "missing input data in %s", __func__ ) ); \
574 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \
575 MBEDTLS_ERR_SSL_DECODE_ERROR ); \
576 return( MBEDTLS_ERR_SSL_DECODE_ERROR ); \
577 } \
578 } while( 0 )
579
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200580#ifdef __cplusplus
581extern "C" {
582#endif
583
Ron Eldor51d3ab52019-05-12 14:54:30 +0300584typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen,
585 const char *label,
586 const unsigned char *random, size_t rlen,
587 unsigned char *dstbuf, size_t dlen );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100588
Hanno Becker61baae72020-09-16 09:24:14 +0100589/* cipher.h exports the maximum IV, key and block length from
Hanno Becker15889832020-09-08 11:29:11 +0100590 * all ciphers enabled in the config, regardless of whether those
591 * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled
592 * in the default configuration and uses 64 Byte keys, but it is
593 * not used for record protection in SSL/TLS.
594 *
595 * In order to prevent unnecessary inflation of key structures,
596 * we introduce SSL-specific variants of the max-{key,block,IV}
597 * macros here which are meant to only take those ciphers into
598 * account which can be negotiated in SSL/TLS.
599 *
600 * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH
601 * in cipher.h are rough overapproximations of the real maxima, here
Hanno Becker9a7a2ac2020-09-09 09:24:54 +0100602 * we content ourselves with replicating those overapproximations
Hanno Becker15889832020-09-08 11:29:11 +0100603 * for the maximum block and IV length, and excluding XTS from the
604 * computation of the maximum key length. */
605#define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16
606#define MBEDTLS_SSL_MAX_IV_LENGTH 16
607#define MBEDTLS_SSL_MAX_KEY_LENGTH 32
608
Hanno Becker3385a4d2020-08-21 13:03:34 +0100609/**
610 * \brief The data structure holding the cryptographic material (key and IV)
611 * used for record protection in TLS 1.3.
612 */
613struct mbedtls_ssl_key_set
614{
615 /*! The key for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100616 unsigned char client_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100617 /*! The key for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100618 unsigned char server_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100619 /*! The IV for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100620 unsigned char client_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100621 /*! The IV for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100622 unsigned char server_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100623
Hanno Becker493ea7f2020-09-08 11:01:00 +0100624 size_t key_len; /*!< The length of client_write_key and
625 * server_write_key, in Bytes. */
626 size_t iv_len; /*!< The length of client_write_iv and
627 * server_write_iv, in Bytes. */
Hanno Becker3385a4d2020-08-21 13:03:34 +0100628};
629typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100630
Jerry Yu61e35e02021-09-16 18:59:08 +0800631typedef struct
632{
Jerry Yuf532bb22021-10-13 10:34:03 +0800633 unsigned char binder_key [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
634 unsigned char client_early_traffic_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
635 unsigned char early_exporter_master_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000636} mbedtls_ssl_tls13_early_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800637
638typedef struct
639{
Jerry Yuf532bb22021-10-13 10:34:03 +0800640 unsigned char client_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
641 unsigned char server_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000642} mbedtls_ssl_tls13_handshake_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800643
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200644/*
645 * This structure contains the parameters only needed during handshake.
646 */
647struct mbedtls_ssl_handshake_params
648{
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100649 /* Frequently-used boolean or byte fields (placed early to take
650 * advantage of smaller code size for indirect access on Arm Thumb) */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100651 uint8_t resume; /*!< session resume indicator*/
652 uint8_t cli_exts; /*!< client extension presence*/
653
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400654#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
655 uint8_t sni_authmode; /*!< authmode from SNI callback */
656#endif
657
XiaokangQian189ded22022-05-10 08:12:17 +0000658#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQianc3017f62022-05-13 05:55:41 +0000659 /* Flag indicating if a CertificateRequest message has been sent
660 * to the client or not. */
XiaokangQian63e713e2022-05-15 04:26:57 +0000661 uint8_t certificate_request_sent;
XiaokangQian189ded22022-05-10 08:12:17 +0000662#endif /* MBEDTLS_SSL_SRV_C */
663
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400664#if defined(MBEDTLS_SSL_SESSION_TICKETS)
665 uint8_t new_session_ticket; /*!< use NewSessionTicket? */
666#endif /* MBEDTLS_SSL_SESSION_TICKETS */
667
Ronald Cron82c785f2022-03-31 15:44:41 +0200668#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron217d6992022-04-04 10:23:22 +0200669 /** Minimum TLS version to be negotiated.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200670 *
Ronald Cron217d6992022-04-04 10:23:22 +0200671 * It is set up in the ClientHello writing preparation stage and used
672 * throughout the ClientHello writing. Not relevant anymore as soon as
673 * the protocol version has been negotiated thus as soon as the
674 * ServerHello is received.
675 * For a fresh handshake not linked to any previous handshake, it is
676 * equal to the configured minimum minor version to be negotiated. When
677 * renegotiating or resuming a session, it is equal to the previously
678 * negotiated minor version.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200679 *
Ronald Cron217d6992022-04-04 10:23:22 +0200680 * There is no maximum TLS version field in this handshake context.
681 * From the start of the handshake, we need to define a current protocol
682 * version for the record layer which we define as the maximum TLS
683 * version to be negotiated. The `tls_version` field of the SSL context is
684 * used to store this maximum value until it contains the actual
685 * negotiated value.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200686 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400687 mbedtls_ssl_protocol_version min_tls_version;
Ronald Cron82c785f2022-03-31 15:44:41 +0200688#endif
Ronald Cron86a477f2022-02-18 17:45:10 +0100689
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100690#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
691 uint8_t extended_ms; /*!< use Extended Master Secret? */
692#endif
693
694#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
695 uint8_t async_in_progress; /*!< an asynchronous operation is in progress */
696#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
697
698#if defined(MBEDTLS_SSL_PROTO_DTLS)
699 unsigned char retransmit_state; /*!< Retransmission state */
700#endif
701
Gilles Peskine41139a22021-12-08 18:25:39 +0100702#if !defined(MBEDTLS_DEPRECATED_REMOVED)
703 unsigned char group_list_heap_allocated;
Jerry Yuf017ee42022-01-12 15:49:48 +0800704 unsigned char sig_algs_heap_allocated;
Gilles Peskine41139a22021-12-08 18:25:39 +0100705#endif
706
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100707#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
708 uint8_t ecrs_enabled; /*!< Handshake supports EC restart? */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100709 enum { /* this complements ssl->state with info on intra-state operations */
710 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
711 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
712 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
713 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
714 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
715 } ecrs_state; /*!< current (or last) operation */
716 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
717 size_t ecrs_n; /*!< place for saving a length */
718#endif
719
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100720 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
721
722 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
723 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
724 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
725 mbedtls_ssl_tls_prf_cb *tls_prf;
726
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200727 /*
728 * Handshake specific crypto variables
729 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100730#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron85385492022-07-20 16:44:00 +0200731 uint8_t key_exchange_mode; /*!< Selected key exchange mode */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100732
Jerry Yu6a2cd9e2022-05-05 11:14:19 +0800733 /** Number of HelloRetryRequest messages received/sent from/to the server. */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000734 int hello_retry_request_count;
Ronald Cronbc817ba2022-07-21 09:35:20 +0200735
XiaokangQian08037552022-04-20 07:16:41 +0000736#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQian318dc762022-04-20 09:43:51 +0000737 /** selected_group of key_share extension in HelloRetryRequest message. */
XiaokangQian08037552022-04-20 07:16:41 +0000738 uint16_t hrr_selected_group;
Ronald Cron41a443a2022-10-04 16:38:25 +0200739#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cronbc817ba2022-07-21 09:35:20 +0200740 uint8_t tls13_kex_modes; /*!< Key exchange modes supported by the client */
741#endif
Jerry Yud4e75002022-08-09 13:33:50 +0800742#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf3bdf9d2022-09-22 23:30:49 +0800743 uint16_t new_session_tickets_count; /*!< number of session tickets */
Jerry Yud4e75002022-08-09 13:33:50 +0800744#endif
XiaokangQian08037552022-04-20 07:16:41 +0000745#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cronbc817ba2022-07-21 09:35:20 +0200746
Jerry Yu582dd062022-04-22 21:59:01 +0800747#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian08037552022-04-20 07:16:41 +0000748
Ronald Crone68ab4f2022-10-05 12:46:29 +0200749#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000750 uint16_t received_sig_algs[MBEDTLS_RECEIVED_SIG_ALGS_SIZE];
751#endif
752
Gilles Peskine41139a22021-12-08 18:25:39 +0100753#if !defined(MBEDTLS_DEPRECATED_REMOVED)
754 const uint16_t *group_list;
Jerry Yuf017ee42022-01-12 15:49:48 +0800755 const uint16_t *sig_algs;
Gilles Peskine41139a22021-12-08 18:25:39 +0100756#endif
757
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200758#if defined(MBEDTLS_DHM_C)
759 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
760#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100761
John Durkop07cc04a2020-11-16 22:08:34 -0800762/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
Ronald Cronde1adee2022-03-07 16:20:30 +0100763 * to guards in client and server code. There is a gap in functionality that
764 * access to ecdh_ctx structure is needed for MBEDTLS_ECDSA_C which does not
765 * seem correct.
John Durkop07cc04a2020-11-16 22:08:34 -0800766 */
767#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Neil Armstrong769dc052022-04-13 15:12:43 +0200768#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200769 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
Neil Armstrong769dc052022-04-13 15:12:43 +0200770#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000771
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100772#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine42459802019-12-19 13:31:53 +0100773 psa_key_type_t ecdh_psa_type;
Neil Armstrong91477a72022-03-25 15:42:20 +0100774 size_t ecdh_bits;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100775 mbedtls_svc_key_id_t ecdh_psa_privkey;
Neil Armstrongf716a702022-04-04 11:23:46 +0200776 uint8_t ecdh_psa_privkey_is_external;
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000777 unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH];
778 size_t ecdh_psa_peerkey_len;
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100779#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
John Durkop07cc04a2020-11-16 22:08:34 -0800780#endif /* MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000781
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200782#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200783 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200784#if defined(MBEDTLS_SSL_CLI_C)
785 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
786 size_t ecjpake_cache_len; /*!< Length of cached data */
787#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100788#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100789
790#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200791 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200792 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
793#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100794
Ronald Cron73fe8df2022-10-05 14:31:43 +0200795#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100796#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +0100797 mbedtls_svc_key_id_t psk_opaque; /*!< Opaque PSK from the callback */
Neil Armstrong501c9322022-05-03 09:35:09 +0200798 uint8_t psk_opaque_is_internal;
Neil Armstronge952a302022-05-03 10:22:14 +0200799#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200800 unsigned char *psk; /*!< PSK from the callback */
801 size_t psk_len; /*!< Length of PSK from callback */
Neil Armstronge952a302022-05-03 10:22:14 +0200802#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu96a2e362022-07-21 15:11:34 +0800803 uint16_t selected_identity;
Ronald Cron73fe8df2022-10-05 14:31:43 +0200804#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100805
Gilles Peskinecfe74a32021-12-08 18:38:51 +0100806#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
807 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
808#endif
809
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200810#if defined(MBEDTLS_X509_CRT_PARSE_C)
811 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
812#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
813 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
814 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
815 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100816#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200817#endif /* MBEDTLS_X509_CRT_PARSE_C */
Gilles Peskine8716f172021-11-16 15:21:44 +0100818
Gilles Peskine8716f172021-11-16 15:21:44 +0100819#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Hanno Becker75173122019-02-06 16:18:31 +0000820 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
821 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
822#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker2f28c102019-04-25 15:46:59 +0100823
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100824 struct
825 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100826 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
827 * buffers used for message buffering. */
828
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100829 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100830 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100831
Hanno Becker0271f962018-08-16 13:23:47 +0100832 struct mbedtls_ssl_hs_buffer
833 {
Hanno Becker98081a02018-08-22 13:32:50 +0100834 unsigned is_valid : 1;
835 unsigned is_fragmented : 1;
836 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100837 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100838 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100839 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
840
Hanno Becker5f066e72018-08-16 14:56:31 +0100841 struct
842 {
843 unsigned char *data;
844 size_t len;
845 unsigned epoch;
846 } future_record;
847
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100848 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100849
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000850#if defined(MBEDTLS_SSL_CLI_C) && \
851 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
852 unsigned char *cookie; /*!< HelloVerifyRequest cookie for DTLS
853 * HelloRetryRequest cookie for TLS 1.3 */
854#endif /* MBEDTLS_SSL_CLI_C &&
855 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
856#if defined(MBEDTLS_SSL_PROTO_DTLS)
857 unsigned char verify_cookie_len; /*!< Cli: HelloVerifyRequest cookie
858 * length
XiaokangQian34909742022-01-27 02:25:04 +0000859 * Srv: flag for sending a cookie */
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000860#endif /* MBEDTLS_SSL_PROTO_DTLS */
861#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
862 uint16_t hrr_cookie_len; /*!< HelloRetryRequest cookie length */
XiaokangQian20438972022-03-04 08:52:07 +0000863#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian52da5582022-01-26 09:49:29 +0000864
865#if defined(MBEDTLS_SSL_PROTO_DTLS)
866 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
867 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100868
869 uint32_t retransmit_timeout; /*!< Current value of timeout */
870 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
871 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
872 unsigned char *cur_msg_p; /*!< Position in current message */
873 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
874 flight being received */
875 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
876 resending messages */
877 unsigned char alt_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Alternative record epoch/counter
878 for resending messages */
879
880#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
881 /* The state of CID configuration in this handshake. */
882
883 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
884 * has been negotiated. Possible values are
885 * #MBEDTLS_SSL_CID_ENABLED and
886 * #MBEDTLS_SSL_CID_DISABLED. */
887 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
888 uint8_t peer_cid_len; /*!< The length of
889 * \c peer_cid. */
890#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
891
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200892 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100893#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200894
Ronald Cron6f135e12021-12-08 16:57:54 +0100895#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +0100896 /*! TLS 1.3 transforms for 0-RTT and encrypted handshake messages.
897 * Those pointers own the transforms they reference. */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100898 mbedtls_ssl_transform *transform_handshake;
899 mbedtls_ssl_transform *transform_earlydata;
Ronald Cron6f135e12021-12-08 16:57:54 +0100900#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100901
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200902 /*
903 * Checksum contexts
904 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400905#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500906#if defined(MBEDTLS_USE_PSA_CRYPTO)
907 psa_hash_operation_t fin_sha256_psa;
908#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200909 mbedtls_sha256_context fin_sha256;
910#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500911#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400912#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500913#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500914 psa_hash_operation_t fin_sha384_psa;
Andrzej Kurekeb342242019-01-29 09:14:33 -0500915#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400916 mbedtls_sha512_context fin_sha384;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200917#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500918#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200919
Ronald Cron6f135e12021-12-08 16:57:54 +0100920#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800921 uint16_t offered_group_id; /* The NamedGroup value for the group
922 * that is being used for ephemeral
923 * key exchange.
924 *
925 * On the client: Defaults to the first
926 * entry in the client's group list,
927 * but can be overwritten by the HRR. */
Ronald Cron6f135e12021-12-08 16:57:54 +0100928#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800929
Jerry Yufb28b882022-01-28 11:05:58 +0800930#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yu2d9a6942022-02-08 21:07:10 +0800931 uint8_t client_auth; /*!< used to check if CertificateRequest has been
Jerry Yu5c7d1cc2022-02-08 21:08:29 +0800932 received from server side. If CertificateRequest
Jerry Yu0ff8ac82022-02-08 10:10:48 +0800933 has been received, Certificate and CertificateVerify
Jerry Yufb28b882022-01-28 11:05:58 +0800934 should be sent to server */
935#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000936 /*
937 * State-local variables used during the processing
938 * of a specific handshake state.
939 */
940 union
941 {
942 /* Outgoing Finished message */
943 struct
944 {
945 uint8_t preparation_done;
946
947 /* Buffer holding digest of the handshake up to
948 * but excluding the outgoing finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000949 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000950 size_t digest_len;
951 } finished_out;
952
953 /* Incoming Finished message */
954 struct
955 {
XiaokangQian57b2aff2021-11-10 03:12:11 +0000956 uint8_t preparation_done;
957
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000958 /* Buffer holding digest of the handshake up to but
959 * excluding the peer's incoming finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000960 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000961 size_t digest_len;
962 } finished_in;
963
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000964 } state_local;
965
966 /* End of state-local variables. */
967
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800968 unsigned char randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN +
969 MBEDTLS_SERVER_HELLO_RANDOM_LEN];
970 /*!< random bytes */
Ronald Cron3b056202022-10-05 17:20:21 +0200971#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200972 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
973 /*!< premaster secret */
Ronald Cron3b056202022-10-05 17:20:21 +0200974 size_t pmslen; /*!< premaster length */
975#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200976
Ronald Cron6f135e12021-12-08 16:57:54 +0100977#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu0c354a22022-08-29 15:25:36 +0800978 uint32_t sent_extensions; /*!< extensions sent by endpoint */
979 uint32_t received_extensions; /*!< extensions received by endpoint */
Jerry Yu89ea3212021-09-09 14:31:24 +0800980
Ronald Crone68ab4f2022-10-05 12:46:29 +0200981#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baia0ab7772022-01-16 12:14:45 +0000982 unsigned char certificate_request_context_len;
983 unsigned char *certificate_request_context;
Xiaofei Baie1e34422021-12-23 12:09:05 +0000984#endif
985
Jerry Yu89ea3212021-09-09 14:31:24 +0800986 union
987 {
Jerry Yud1ab2622021-10-08 15:36:57 +0800988 unsigned char early [MBEDTLS_TLS1_3_MD_MAX_SIZE];
989 unsigned char handshake[MBEDTLS_TLS1_3_MD_MAX_SIZE];
990 unsigned char app [MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Baid25fab62021-12-02 06:36:27 +0000991 } tls13_master_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800992
Xiaofei Bai746f9482021-11-12 08:53:56 +0000993 mbedtls_ssl_tls13_handshake_secrets tls13_hs_secrets;
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +0000994
995#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +0000996 int early_data; /*!< Early data indication:
997 * 0 -- MBEDTLS_SSL_EARLY_DATA_DISABLED (for no early data), and
998 * 1 -- MBEDTLS_SSL_EARLY_DATA_ENABLED (for use early data)
999 */
1000#endif /* MBEDTLS_SSL_EARLY_DATA */
Ronald Cron6f135e12021-12-08 16:57:54 +01001001#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001002
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001003#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
1004 /** Asynchronous operation context. This field is meant for use by the
1005 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
1006 * mbedtls_ssl_config::f_async_decrypt_start,
1007 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
1008 * The library does not use it internally. */
1009 void *user_async_ctx;
1010#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Glenn Strauss69894072022-01-24 12:58:00 -05001011
1012#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1013 const unsigned char *sni_name; /*!< raw SNI */
1014 size_t sni_name_len; /*!< raw SNI len */
Glenn Strauss999ef702022-03-11 01:37:23 -05001015#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1016 const mbedtls_x509_crt *dn_hints; /*!< acceptable client cert issuers */
1017#endif
Glenn Strauss69894072022-01-24 12:58:00 -05001018#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001019};
1020
Hanno Becker0271f962018-08-16 13:23:47 +01001021typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
1022
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001023/*
Hanno Beckerd362dc52018-01-03 15:23:11 +00001024 * Representation of decryption/encryption transformations on records
1025 *
1026 * There are the following general types of record transformations:
TRodziewicz2abf03c2021-06-25 14:40:09 +02001027 * - Stream transformations (TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001028 * Transformation adding a MAC and applying a stream-cipher
1029 * to the authenticated message.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001030 * - CBC block cipher transformations ([D]TLS versions == 1.2 only)
1031 * For TLS 1.2, no IV is generated at key extraction time, but every
1032 * encrypted record is explicitly prefixed by the IV with which it was
1033 * encrypted.
1034 * - AEAD transformations ([D]TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001035 * These come in two fundamentally different versions, the first one
1036 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
1037 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
1038 * In the first transformation, the IV to be used for a record is obtained
1039 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
1040 * record sequence number, and explicitly prepending this sequence number
1041 * to the encrypted record. In contrast, in the second transformation
1042 * the IV is obtained by XOR'ing a static IV obtained at key extraction
1043 * time with the 8-byte record sequence number, without prepending the
1044 * latter to the encrypted record.
1045 *
Hanno Becker7d343ec2020-05-04 12:29:05 +01001046 * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext
1047 * which allows to add flexible length padding and to hide a record's true
1048 * content type.
1049 *
Hanno Beckerd362dc52018-01-03 15:23:11 +00001050 * In addition to type and version, the following parameters are relevant:
1051 * - The symmetric cipher algorithm to be used.
1052 * - The (static) encryption/decryption keys for the cipher.
1053 * - For stream/CBC, the type of message digest to be used.
1054 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Becker0db7e0c2018-10-18 15:39:53 +01001055 * - For AEAD transformations, the size (potentially 0) of an explicit,
1056 * random initialization vector placed in encrypted records.
TRodziewicz299510e2021-07-09 16:55:11 +02001057 * - For some transformations (currently AEAD) an implicit IV. It is static
Hanno Beckerd362dc52018-01-03 15:23:11 +00001058 * and (if present) is combined with the explicit IV in a transformation-
TRodziewicz299510e2021-07-09 16:55:11 +02001059 * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
Hanno Beckerd362dc52018-01-03 15:23:11 +00001060 * - For stream/CBC, a flag determining the order of encryption and MAC.
1061 * - The details of the transformation depend on the SSL/TLS version.
1062 * - The length of the authentication tag.
1063 *
1064 * The struct below refines this abstract view as follows:
1065 * - The cipher underlying the transformation is managed in
1066 * cipher contexts cipher_ctx_{enc/dec}, which must have the
1067 * same cipher type. The mode of these cipher contexts determines
1068 * the type of the transformation in the sense above: e.g., if
1069 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
1070 * then the transformation has type CBC resp. AEAD.
1071 * - The cipher keys are never stored explicitly but
1072 * are maintained within cipher_ctx_{enc/dec}.
1073 * - For stream/CBC transformations, the message digest contexts
1074 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
1075 * are unused for AEAD transformations.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001076 * - For stream/CBC transformations, the MAC keys are not stored explicitly
1077 * but maintained within md_ctx_{enc/dec}.
1078 * - The mac_enc and mac_dec fields are unused for EAD transformations.
Hanno Beckerd362dc52018-01-03 15:23:11 +00001079 * - For transformations using an implicit IV maintained within
1080 * the transformation context, its contents are stored within
1081 * iv_{enc/dec}.
1082 * - The value of ivlen indicates the length of the IV.
1083 * This is redundant in case of stream/CBC transformations
1084 * which always use 0 resp. the cipher's block length as the
1085 * IV length, but is needed for AEAD ciphers and may be
1086 * different from the underlying cipher's block length
1087 * in this case.
1088 * - The field fixed_ivlen is nonzero for AEAD transformations only
1089 * and indicates the length of the static part of the IV which is
1090 * constant throughout the communication, and which is stored in
1091 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
Glenn Strauss07c64162022-03-14 12:34:51 -04001092 * - tls_version denotes the 2-byte TLS version
Hanno Beckerd362dc52018-01-03 15:23:11 +00001093 * - For stream/CBC transformations, maclen denotes the length of the
1094 * authentication tag, while taglen is unused and 0.
1095 * - For AEAD transformations, taglen denotes the length of the
1096 * authentication tag, while maclen is unused and 0.
1097 * - For CBC transformations, encrypt_then_mac determines the
1098 * order of encryption and authentication. This field is unused
1099 * in other transformations.
1100 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001101 */
1102struct mbedtls_ssl_transform
1103{
1104 /*
1105 * Session specific crypto layer
1106 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001107 size_t minlen; /*!< min. ciphertext length */
1108 size_t ivlen; /*!< IV length */
1109 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Beckere694c3e2017-12-27 21:34:08 +00001110 size_t maclen; /*!< MAC(CBC) len */
1111 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001112
1113 unsigned char iv_enc[16]; /*!< IV (encryption) */
1114 unsigned char iv_dec[16]; /*!< IV (decryption) */
1115
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001116#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Hanno Beckerd56ed242018-01-03 15:32:51 +00001117
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001118#if defined(MBEDTLS_USE_PSA_CRYPTO)
1119 mbedtls_svc_key_id_t psa_mac_enc; /*!< MAC (encryption) */
1120 mbedtls_svc_key_id_t psa_mac_dec; /*!< MAC (decryption) */
1121 psa_algorithm_t psa_mac_alg; /*!< psa MAC algorithm */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001122#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001123 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
1124 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001125#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001126
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001127#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1128 int encrypt_then_mac; /*!< flag for EtM activation */
1129#endif
1130
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001131#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Beckerd56ed242018-01-03 15:32:51 +00001132
Glenn Strauss07c64162022-03-14 12:34:51 -04001133 mbedtls_ssl_protocol_version tls_version;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001134
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001135#if defined(MBEDTLS_USE_PSA_CRYPTO)
1136 mbedtls_svc_key_id_t psa_key_enc; /*!< psa encryption key */
1137 mbedtls_svc_key_id_t psa_key_dec; /*!< psa decryption key */
1138 psa_algorithm_t psa_alg; /*!< psa algorithm */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001139#else
1140 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
1141 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001142#endif /* MBEDTLS_USE_PSA_CRYPTO */
1143
Hanno Beckera0e20d02019-05-15 14:03:01 +01001144#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker1327fa72019-04-25 15:54:02 +01001145 uint8_t in_cid_len;
1146 uint8_t out_cid_len;
1147 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
1148 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera0e20d02019-05-15 14:03:01 +01001149#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1327fa72019-04-25 15:54:02 +01001150
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001151#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
1152 /* We need the Hello random bytes in order to re-derive keys from the
Hanno Beckerbd257552021-03-22 06:59:27 +00001153 * Master Secret and other session info,
1154 * see ssl_tls12_populate_transform() */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001155 unsigned char randbytes[MBEDTLS_SERVER_HELLO_RANDOM_LEN +
1156 MBEDTLS_CLIENT_HELLO_RANDOM_LEN];
1157 /*!< ServerHello.random+ClientHello.random */
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001158#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001159};
1160
Hanno Becker12a3a862018-01-05 15:42:50 +00001161/*
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001162 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
1163 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
1164 */
1165static inline int mbedtls_ssl_transform_uses_aead(
1166 const mbedtls_ssl_transform *transform )
1167{
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001168#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001169 return( transform->maclen == 0 && transform->taglen != 0 );
1170#else
1171 (void) transform;
1172 return( 1 );
1173#endif
1174}
1175
1176/*
Hanno Becker12a3a862018-01-05 15:42:50 +00001177 * Internal representation of record frames
1178 *
Hanno Becker12a3a862018-01-05 15:42:50 +00001179 * Instances come in two flavors:
1180 * (1) Encrypted
1181 * These always have data_offset = 0
1182 * (2) Unencrypted
Hanno Beckercd430bc2019-04-04 16:29:48 +01001183 * These have data_offset set to the amount of
1184 * pre-expansion during record protection. Concretely,
1185 * this is the length of the fixed part of the explicit IV
1186 * used for encryption, or 0 if no explicit IV is used
TRodziewicz2abf03c2021-06-25 14:40:09 +02001187 * (e.g. for stream ciphers).
Hanno Becker12a3a862018-01-05 15:42:50 +00001188 *
1189 * The reason for the data_offset in the unencrypted case
1190 * is to allow for in-place conversion of an unencrypted to
1191 * an encrypted record. If the offset wasn't included, the
1192 * encrypted content would need to be shifted afterwards to
1193 * make space for the fixed IV.
1194 *
1195 */
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001196#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker75f080f2019-04-30 15:01:51 +01001197#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001198#else
Hanno Becker75f080f2019-04-30 15:01:51 +01001199#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001200#endif
1201
Hanno Becker12a3a862018-01-05 15:42:50 +00001202typedef struct
1203{
Jerry Yuae0b2e22021-10-08 15:21:19 +08001204 uint8_t ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /* In TLS: The implicit record sequence number.
1205 * In DTLS: The 2-byte epoch followed by
1206 * the 6-byte sequence number.
1207 * This is stored as a raw big endian byte array
1208 * as opposed to a uint64_t because we rarely
1209 * need to perform arithmetic on this, but do
1210 * need it as a Byte array for the purpose of
1211 * MAC computations. */
Hanno Beckerd840cea2019-07-11 09:24:36 +01001212 uint8_t type; /* The record content type. */
1213 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
1214 * Convert to internal presentation of versions
1215 * using mbedtls_ssl_read_version() and
1216 * mbedtls_ssl_write_version().
1217 * Keep wire-format for MAC computations. */
Hanno Becker12a3a862018-01-05 15:42:50 +00001218
Hanno Beckerd840cea2019-07-11 09:24:36 +01001219 unsigned char *buf; /* Memory buffer enclosing the record content */
1220 size_t buf_len; /* Buffer length */
1221 size_t data_offset; /* Offset of record content */
1222 size_t data_len; /* Length of record content */
Hanno Becker12a3a862018-01-05 15:42:50 +00001223
Hanno Beckera0e20d02019-05-15 14:03:01 +01001224#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd840cea2019-07-11 09:24:36 +01001225 uint8_t cid_len; /* Length of the CID (0 if not present) */
1226 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001227#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker12a3a862018-01-05 15:42:50 +00001228} mbedtls_record;
1229
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001230#if defined(MBEDTLS_X509_CRT_PARSE_C)
1231/*
1232 * List of certificate + private key pairs
1233 */
1234struct mbedtls_ssl_key_cert
1235{
1236 mbedtls_x509_crt *cert; /*!< cert */
1237 mbedtls_pk_context *key; /*!< private key */
1238 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
1239};
1240#endif /* MBEDTLS_X509_CRT_PARSE_C */
1241
1242#if defined(MBEDTLS_SSL_PROTO_DTLS)
1243/*
1244 * List of handshake messages kept around for resending
1245 */
1246struct mbedtls_ssl_flight_item
1247{
1248 unsigned char *p; /*!< message, including handshake headers */
1249 size_t len; /*!< length of p */
1250 unsigned char type; /*!< type of the message: handshake or CCS */
1251 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
1252};
1253#endif /* MBEDTLS_SSL_PROTO_DTLS */
1254
Ronald Cron4079abc2022-02-20 10:35:26 +01001255#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1256/**
1257 * \brief Given an SSL context and its associated configuration, write the TLS
1258 * 1.2 specific extensions of the ClientHello message.
1259 *
1260 * \param[in] ssl SSL context
1261 * \param[in] buf Base address of the buffer where to write the extensions
1262 * \param[in] end End address of the buffer where to write the extensions
1263 * \param uses_ec Whether one proposed ciphersuite uses an elliptic curve
1264 * (<> 0) or not ( 0 ).
1265 * \param[out] out_len Length of the data written into the buffer \p buf
1266 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001267MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron4079abc2022-02-20 10:35:26 +01001268int mbedtls_ssl_tls12_write_client_hello_exts( mbedtls_ssl_context *ssl,
1269 unsigned char *buf,
1270 const unsigned char *end,
1271 int uses_ec,
1272 size_t *out_len );
1273#endif
1274
Hanno Becker7e5437a2017-04-28 17:15:26 +01001275#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01001276 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01001277
Gabor Mezeia3d016c2022-05-10 12:44:09 +02001278/**
1279 * \brief Find the preferred hash for a given signature algorithm.
1280 *
1281 * \param[in] ssl SSL context
1282 * \param[in] sig_alg A signature algorithm identifier as defined in the
1283 * TLS 1.2 SignatureAlgorithm enumeration.
1284 *
1285 * \return The preferred hash algorithm for \p sig_alg. It is a hash algorithm
1286 * identifier as defined in the TLS 1.2 HashAlgorithm enumeration.
1287 */
1288unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
1289 mbedtls_ssl_context *ssl,
1290 unsigned int sig_alg );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001291
Gabor Mezei078e8032022-04-27 21:17:56 +02001292#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01001293 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001294
1295/**
1296 * \brief Free referenced items in an SSL transform context and clear
1297 * memory
1298 *
1299 * \param transform SSL transform context
1300 */
1301void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
1302
1303/**
1304 * \brief Free referenced items in an SSL handshake context and clear
1305 * memory
1306 *
Gilles Peskine9b562d52018-04-25 20:32:43 +02001307 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001308 */
Gilles Peskine9b562d52018-04-25 20:32:43 +02001309void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001310
Jerry Yuc7875b52021-09-05 21:05:50 +08001311/* set inbound transform of ssl context */
1312void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
1313 mbedtls_ssl_transform *transform );
1314
1315/* set outbound transform of ssl context */
1316void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
1317 mbedtls_ssl_transform *transform );
1318
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_client_step( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001321MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001322int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
1323void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001324static inline void mbedtls_ssl_handshake_set_state( mbedtls_ssl_context *ssl,
1325 mbedtls_ssl_states state )
1326{
1327 ssl->state = ( int ) state;
1328}
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001329
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001330MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001331int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
1332
1333void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001334
1335#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001336MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001337int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001338#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001339
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001340MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001341int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001342MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001343int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
1344void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
1345
Hanno Becker4a810fb2017-05-24 16:27:30 +01001346/**
1347 * \brief Update record layer
1348 *
1349 * This function roughly separates the implementation
1350 * of the logic of (D)TLS from the implementation
1351 * of the secure transport.
1352 *
Hanno Becker3a0aad12018-08-20 09:44:02 +01001353 * \param ssl The SSL context to use.
1354 * \param update_hs_digest This indicates if the handshake digest
1355 * should be automatically updated in case
1356 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +01001357 *
1358 * \return 0 or non-zero error code.
1359 *
1360 * \note A clarification on what is called 'record layer' here
1361 * is in order, as many sensible definitions are possible:
1362 *
1363 * The record layer takes as input an untrusted underlying
1364 * transport (stream or datagram) and transforms it into
1365 * a serially multiplexed, secure transport, which
1366 * conceptually provides the following:
1367 *
1368 * (1) Three datagram based, content-agnostic transports
1369 * for handshake, alert and CCS messages.
1370 * (2) One stream- or datagram-based transport
1371 * for application data.
1372 * (3) Functionality for changing the underlying transform
1373 * securing the contents.
1374 *
1375 * The interface to this functionality is given as follows:
1376 *
1377 * a Updating
1378 * [Currently implemented by mbedtls_ssl_read_record]
1379 *
1380 * Check if and on which of the four 'ports' data is pending:
1381 * Nothing, a controlling datagram of type (1), or application
1382 * data (2). In any case data is present, internal buffers
1383 * provide access to the data for the user to process it.
1384 * Consumption of type (1) datagrams is done automatically
1385 * on the next update, invalidating that the internal buffers
1386 * for previous datagrams, while consumption of application
1387 * data (2) is user-controlled.
1388 *
1389 * b Reading of application data
1390 * [Currently manual adaption of ssl->in_offt pointer]
1391 *
1392 * As mentioned in the last paragraph, consumption of data
1393 * is different from the automatic consumption of control
1394 * datagrams (1) because application data is treated as a stream.
1395 *
1396 * c Tracking availability of application data
1397 * [Currently manually through decreasing ssl->in_msglen]
1398 *
1399 * For efficiency and to retain datagram semantics for
1400 * application data in case of DTLS, the record layer
1401 * provides functionality for checking how much application
1402 * data is still available in the internal buffer.
1403 *
1404 * d Changing the transformation securing the communication.
1405 *
1406 * Given an opaque implementation of the record layer in the
1407 * above sense, it should be possible to implement the logic
1408 * of (D)TLS on top of it without the need to know anything
1409 * about the record layer's internals. This is done e.g.
1410 * in all the handshake handling functions, and in the
1411 * application data reading function mbedtls_ssl_read.
1412 *
1413 * \note The above tries to give a conceptual picture of the
1414 * record layer, but the current implementation deviates
1415 * from it in some places. For example, our implementation of
1416 * the update functionality through mbedtls_ssl_read_record
1417 * discards datagrams depending on the current state, which
1418 * wouldn't fall under the record layer's responsibility
1419 * following the above definition.
1420 *
1421 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001422MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker3a0aad12018-08-20 09:44:02 +01001423int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
1424 unsigned update_hs_digest );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001425MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001426int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
1427
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001428/*
1429 * Write handshake message header
1430 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001431MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001432int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
1433 unsigned char **buf, size_t *buf_len );
1434
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001435MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001436int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01001437 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01001438 int force_flush );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001439static inline int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
1440{
Ronald Cron66dbf912022-02-02 15:33:46 +01001441 return( mbedtls_ssl_write_handshake_msg_ext( ssl, 1 /* update checksum */, 1 /* force flush */ ) );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001442}
1443
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001444/*
1445 * Write handshake message tail
1446 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001447MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001448int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
1449 size_t buf_len, size_t msg_len );
1450
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001451MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron00d012f22022-03-08 15:57:12 +01001452int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001453MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001454int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
1455
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_parse_certificate( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001458MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001459int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
1460
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_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001463MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001464int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1465
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_parse_finished( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001468MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001469int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1470
1471void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
1472 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
1473
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001474/*
1475 * Update checksum of handshake messages.
1476 */
1477void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
1478 unsigned hs_type,
1479 unsigned char const *msg,
1480 size_t msg_len );
1481
XiaokangQian86981952022-07-19 09:51:50 +00001482void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
1483 unsigned hs_type,
1484 size_t total_hs_len );
1485
Gilles Peskineeccd8882020-03-10 12:19:08 +01001486#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong80f6f322022-05-03 17:56:38 +02001487#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001488MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001489int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl,
1490 mbedtls_key_exchange_type_t key_ex );
Neil Armstrong80f6f322022-05-03 17:56:38 +02001491#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001492#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Ronald Crond29e13e2022-10-19 10:33:48 +02001493
Ronald Cron73fe8df2022-10-05 14:31:43 +02001494#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Ronald Crond29e13e2022-10-19 10:33:48 +02001495#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001496MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Crond491c2d2022-02-19 18:30:46 +01001497int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf );
1498#endif
Neil Armstrong044a32c2022-05-03 10:35:56 +02001499#if defined(MBEDTLS_USE_PSA_CRYPTO)
1500/**
1501 * Get the first defined opaque PSK by order of precedence:
1502 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK
1503 * callback
1504 * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque()
1505 * Return an opaque PSK
1506 */
1507static inline mbedtls_svc_key_id_t mbedtls_ssl_get_opaque_psk(
1508 const mbedtls_ssl_context *ssl )
1509{
1510 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
1511 return( ssl->handshake->psk_opaque );
1512
1513 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
1514 return( ssl->conf->psk_opaque );
1515
1516 return( MBEDTLS_SVC_KEY_ID_INIT );
1517}
1518#else
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001519/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001520 * Get the first defined PSK by order of precedence:
1521 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
1522 * 2. static PSK configured by \c mbedtls_ssl_conf_psk()
1523 * Return a code and update the pair (PSK, PSK length) passed to this function
1524 */
1525static inline int mbedtls_ssl_get_psk( const mbedtls_ssl_context *ssl,
1526 const unsigned char **psk, size_t *psk_len )
1527{
1528 if( ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0 )
1529 {
1530 *psk = ssl->handshake->psk;
1531 *psk_len = ssl->handshake->psk_len;
1532 }
1533
1534 else if( ssl->conf->psk != NULL && ssl->conf->psk_len > 0 )
1535 {
1536 *psk = ssl->conf->psk;
1537 *psk_len = ssl->conf->psk_len;
1538 }
1539
1540 else
1541 {
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001542 *psk = NULL;
1543 *psk_len = 0;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001544 return( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED );
1545 }
1546
1547 return( 0 );
1548}
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001549#endif /* MBEDTLS_USE_PSA_CRYPTO */
1550
Ronald Cron73fe8df2022-10-05 14:31:43 +02001551#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001552
1553#if defined(MBEDTLS_PK_C)
1554unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001555unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001556mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1557#endif
1558
1559mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001560unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001561
1562#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001563MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001564int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001565#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001566
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001567MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01001568int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001569#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001570MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001571int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001572#endif
1573
Ron Eldor089c9fe2018-12-06 17:12:49 +02001574#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascal43f94902020-09-22 12:25:52 +02001575static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value
1576 ( const uint16_t srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001577{
Johan Pascal43f94902020-09-22 12:25:52 +02001578 switch( srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001579 {
Johan Pascal85269572020-08-25 10:01:54 +02001580 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001581 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascal85269572020-08-25 10:01:54 +02001582 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001583 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascal43f94902020-09-22 12:25:52 +02001584 return srtp_profile_value;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001585 default: break;
1586 }
Johan Pascal43f94902020-09-22 12:25:52 +02001587 return( MBEDTLS_TLS_SRTP_UNSET );
Ron Eldor089c9fe2018-12-06 17:12:49 +02001588}
1589#endif
1590
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001591#if defined(MBEDTLS_X509_CRT_PARSE_C)
1592static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1593{
1594 mbedtls_ssl_key_cert *key_cert;
1595
1596 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1597 key_cert = ssl->handshake->key_cert;
1598 else
1599 key_cert = ssl->conf->key_cert;
1600
1601 return( key_cert == NULL ? NULL : key_cert->key );
1602}
1603
1604static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1605{
1606 mbedtls_ssl_key_cert *key_cert;
1607
1608 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1609 key_cert = ssl->handshake->key_cert;
1610 else
1611 key_cert = ssl->conf->key_cert;
1612
1613 return( key_cert == NULL ? NULL : key_cert->cert );
1614}
1615
1616/*
1617 * Check usage of a certificate wrt extensions:
1618 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1619 *
1620 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1621 * check a cert we received from them)!
1622 *
1623 * Return 0 if everything is OK, -1 if not.
1624 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001625MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001626int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
1627 const mbedtls_ssl_ciphersuite_t *ciphersuite,
1628 int cert_endpoint,
1629 uint32_t *flags );
1630#endif /* MBEDTLS_X509_CRT_PARSE_C */
1631
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001632void mbedtls_ssl_write_version( unsigned char version[2], int transport,
1633 mbedtls_ssl_protocol_version tls_version );
1634uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
1635 int transport );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001636
Hanno Becker5903de42019-05-03 14:46:38 +01001637static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001638{
Hanno Becker47be7682019-07-12 09:55:46 +01001639#if !defined(MBEDTLS_SSL_PROTO_DTLS)
1640 ((void) ssl);
1641#endif
1642
1643#if defined(MBEDTLS_SSL_PROTO_DTLS)
1644 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1645 {
1646 return( 13 );
1647 }
1648 else
1649#endif /* MBEDTLS_SSL_PROTO_DTLS */
1650 {
1651 return( 5 );
1652 }
Hanno Becker5903de42019-05-03 14:46:38 +01001653}
1654
1655static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1656{
Hanno Becker3b154c12019-05-03 15:05:27 +01001657 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001658}
1659
1660static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1661{
1662#if defined(MBEDTLS_SSL_PROTO_DTLS)
1663 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1664 return( 12 );
1665#else
1666 ((void) ssl);
1667#endif
1668 return( 4 );
1669}
1670
1671#if defined(MBEDTLS_SSL_PROTO_DTLS)
1672void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1673void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001674MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001675int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001676MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001677int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001678#endif
1679
1680/* Visible for testing purposes only */
1681#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001682MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker0183d692019-07-12 08:50:37 +01001683int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001684void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1685#endif
1686
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001687MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker52055ae2019-02-06 14:30:46 +00001688int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1689 const mbedtls_ssl_session *src );
1690
TRodziewicz0f82ec62021-05-12 17:49:18 +02001691#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek814feff2019-01-14 04:35:19 -05001692/* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001693MBEDTLS_CHECK_RETURN_CRITICAL
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001694int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001695 unsigned char *hash, size_t *hashlen,
1696 unsigned char *data, size_t data_len,
1697 mbedtls_md_type_t md_alg );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001698#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001699
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001700#ifdef __cplusplus
1701}
1702#endif
1703
Hanno Beckera18d1322018-01-03 14:27:32 +00001704void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001705MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera18d1322018-01-03 14:27:32 +00001706int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1707 mbedtls_ssl_transform *transform,
1708 mbedtls_record *rec,
1709 int (*f_rng)(void *, unsigned char *, size_t),
1710 void *p_rng );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001711MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker605949f2019-07-12 08:23:59 +01001712int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001713 mbedtls_ssl_transform *transform,
1714 mbedtls_record *rec );
1715
Hanno Beckerdd772292020-02-05 10:38:31 +00001716/* Length of the "epoch" field in the record header */
1717static inline size_t mbedtls_ssl_ep_len( const mbedtls_ssl_context *ssl )
1718{
1719#if defined(MBEDTLS_SSL_PROTO_DTLS)
1720 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1721 return( 2 );
1722#else
1723 ((void) ssl);
1724#endif
1725 return( 0 );
1726}
1727
Hanno Becker08f09132020-02-11 15:40:07 +00001728#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001729MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker786300f2020-02-05 10:46:40 +00001730int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001731#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker0f57a652020-02-05 10:37:26 +00001732
1733void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001734MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7876d122020-02-05 10:39:31 +00001735int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl );
1736
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001737void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl );
1738void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
1739 mbedtls_ssl_transform *transform );
1740void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl );
1741
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001742MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker43aefe22020-02-05 10:44:56 +00001743int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial );
XiaokangQian78b1fa72022-01-19 06:56:30 +00001744void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1745 int partial );
Hanno Becker43aefe22020-02-05 10:44:56 +00001746
Jerry Yue7047812021-09-13 19:26:39 +08001747/*
Jerry Yu394ece62021-09-14 22:17:21 +08001748 * Send pending alert
Jerry Yue7047812021-09-13 19:26:39 +08001749 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001750MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue7047812021-09-13 19:26:39 +08001751int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl );
1752
Jerry Yu394ece62021-09-14 22:17:21 +08001753/*
1754 * Set pending fatal alert flag.
1755 */
1756void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
1757 unsigned char alert_type,
1758 int alert_reason );
1759
1760/* Alias of mbedtls_ssl_pend_fatal_alert */
1761#define MBEDTLS_SSL_PEND_FATAL_ALERT( type, user_return_value ) \
1762 mbedtls_ssl_pend_fatal_alert( ssl, type, user_return_value )
1763
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001764#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1765void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl );
1766#endif
1767
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001768void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl );
1769
Hanno Becker08f09132020-02-11 15:40:07 +00001770#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001771MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40cdaa12020-02-05 10:48:27 +00001772int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001773#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker89490712020-02-05 10:50:12 +00001774
Hanno Becker533ab5f2020-02-05 10:49:13 +00001775#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker08f09132020-02-11 15:40:07 +00001776size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl );
Hanno Becker533ab5f2020-02-05 10:49:13 +00001777void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl );
1778void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight );
1779#endif /* MBEDTLS_SSL_PROTO_DTLS */
1780
Jerry Yu60835a82021-08-04 10:13:52 +08001781/**
1782 * ssl utils functions for checking configuration.
1783 */
1784
Ronald Cron6f135e12021-12-08 16:57:54 +01001785#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001786static inline int mbedtls_ssl_conf_is_tls13_only( const mbedtls_ssl_config *conf )
1787{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001788 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1789 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001790}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001791
Ronald Cron6f135e12021-12-08 16:57:54 +01001792#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001793
1794#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1795static inline int mbedtls_ssl_conf_is_tls12_only( const mbedtls_ssl_config *conf )
1796{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001797 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1798 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu60835a82021-08-04 10:13:52 +08001799}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001800
Jerry Yu60835a82021-08-04 10:13:52 +08001801#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1802
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001803static inline int mbedtls_ssl_conf_is_tls13_enabled( const mbedtls_ssl_config *conf )
1804{
1805#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001806 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_3 &&
1807 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001808#else
1809 ((void) conf);
1810 return( 0 );
1811#endif
1812}
1813
1814static inline int mbedtls_ssl_conf_is_tls12_enabled( const mbedtls_ssl_config *conf )
1815{
1816#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001817 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 &&
1818 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001819#else
1820 ((void) conf);
1821 return( 0 );
1822#endif
1823}
1824
Ronald Cron6f135e12021-12-08 16:57:54 +01001825#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001826static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13( const mbedtls_ssl_config *conf )
1827{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001828 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1829 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001830}
Ronald Cron6f135e12021-12-08 16:57:54 +01001831#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001832
Ronald Cron6f135e12021-12-08 16:57:54 +01001833#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yufbe3e642022-04-25 19:31:51 +08001834extern const uint8_t mbedtls_ssl_tls13_hello_retry_request_magic[
1835 MBEDTLS_SERVER_HELLO_RANDOM_LEN ];
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001836MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001837int mbedtls_ssl_tls13_process_finished_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001838MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001839int mbedtls_ssl_tls13_write_finished_message( mbedtls_ssl_context *ssl );
1840void mbedtls_ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl );
1841
1842/**
Ronald Cron3d580bf2022-02-18 17:24:56 +01001843 * \brief Given an SSL context and its associated configuration, write the TLS
1844 * 1.3 specific extensions of the ClientHello message.
1845 *
1846 * \param[in] ssl SSL context
1847 * \param[in] buf Base address of the buffer where to write the extensions
1848 * \param[in] end End address of the buffer where to write the extensions
1849 * \param[out] out_len Length of the data written into the buffer \p buf
1850 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001851MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron3d580bf2022-02-18 17:24:56 +01001852int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1853 unsigned char *buf,
1854 unsigned char *end,
1855 size_t *out_len );
1856
1857/**
Jerry Yua6e6c272021-11-17 17:54:13 +08001858 * \brief TLS 1.3 client side state machine entry
1859 *
1860 * \param ssl SSL context
1861 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001862MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001863int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl );
1864
1865/**
1866 * \brief TLS 1.3 server side state machine entry
1867 *
1868 * \param ssl SSL context
1869 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001870MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001871int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl );
1872
Jerry Yu26f4d152021-08-23 17:42:37 +08001873
1874/*
1875 * Helper functions around key exchange modes.
1876 */
Jerry Yub60e3cf2021-09-08 16:41:02 +08001877static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001878 int kex_mode_mask )
1879{
1880 return( ( ssl->conf->tls13_kex_modes & kex_mode_mask ) != 0 );
1881}
1882
Jerry Yub60e3cf2021-09-08 16:41:02 +08001883static inline int mbedtls_ssl_conf_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001884{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001885 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001886 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001887}
1888
1889static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( mbedtls_ssl_context *ssl )
1890{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001891 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001892 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001893}
1894
Jerry Yub60e3cf2021-09-08 16:41:02 +08001895static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001896{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001897 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001898 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001899}
1900
1901static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
1902{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001903 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001904 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001905}
1906
1907static inline int mbedtls_ssl_conf_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
1908{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001909 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001910 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001911}
1912
Ronald Cron41a443a2022-10-04 16:38:25 +02001913#if defined(MBEDTLS_SSL_SRV_C) && \
1914 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuadf861a2021-09-29 21:22:08 +08001915/**
1916 * Given a list of key exchange modes, check if at least one of them is
1917 * supported.
1918 *
1919 * \param[in] ssl SSL context
Jerry Yu0cabad32021-09-30 09:52:35 +08001920 * \param kex_modes_mask Mask of the key exchange modes to check
Jerry Yuadf861a2021-09-29 21:22:08 +08001921 *
1922 * \return 0 if at least one of the key exchange modes is supported,
Jerry Yudca3d5d2021-10-08 14:19:29 +08001923 * !=0 otherwise.
Jerry Yuadf861a2021-09-29 21:22:08 +08001924 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001925static inline unsigned mbedtls_ssl_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
1926 int kex_modes_mask )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001927{
Xiaofei Baid25fab62021-12-02 06:36:27 +00001928 return( ( ssl->handshake->tls13_kex_modes & kex_modes_mask ) == 0 );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001929}
1930
Xiaofei Bai746f9482021-11-12 08:53:56 +00001931static inline int mbedtls_ssl_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001932{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001933 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1934 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001935}
1936
Xiaofei Bai746f9482021-11-12 08:53:56 +00001937static inline int mbedtls_ssl_tls13_psk_ephemeral_enabled(
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001938 mbedtls_ssl_context *ssl )
1939{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001940 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1941 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001942}
1943
Xiaofei Bai746f9482021-11-12 08:53:56 +00001944static inline int mbedtls_ssl_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001945{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001946 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1947 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001948}
1949
Xiaofei Bai746f9482021-11-12 08:53:56 +00001950static inline int mbedtls_ssl_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001951{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001952 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1953 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001954}
1955
Xiaofei Bai746f9482021-11-12 08:53:56 +00001956static inline int mbedtls_ssl_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001957{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001958 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1959 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001960}
Ronald Cron41a443a2022-10-04 16:38:25 +02001961#endif /* MBEDTLS_SSL_SRV_C &&
1962 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001963
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001964/*
Jerry Yuea52ed92022-11-08 21:01:17 +08001965 * Helper functions for extensions checking.
Jerry Yue18dc7e2022-08-04 16:29:22 +08001966 */
Jerry Yue18dc7e2022-08-04 16:29:22 +08001967
Jerry Yu0c354a22022-08-29 15:25:36 +08001968MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001969int mbedtls_ssl_tls13_check_received_extension(
1970 mbedtls_ssl_context *ssl,
1971 int hs_msg_type,
1972 unsigned int received_extension_type,
1973 uint32_t hs_msg_allowed_extensions_mask );
Jerry Yu0c354a22022-08-29 15:25:36 +08001974
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001975static inline void mbedtls_ssl_tls13_set_hs_sent_ext_mask(
1976 mbedtls_ssl_context *ssl, unsigned int extension_type )
Jerry Yu0c354a22022-08-29 15:25:36 +08001977{
1978 ssl->handshake->sent_extensions |=
Jerry Yu7a485c12022-10-31 13:08:18 +08001979 mbedtls_ssl_get_extension_mask( extension_type );
Jerry Yu0c354a22022-08-29 15:25:36 +08001980}
Jerry Yue18dc7e2022-08-04 16:29:22 +08001981
1982/*
Ronald Cron85385492022-07-20 16:44:00 +02001983 * Helper functions to check the selected key exchange mode.
1984 */
1985static inline int mbedtls_ssl_tls13_key_exchange_mode_check(
1986 mbedtls_ssl_context *ssl, int kex_mask )
1987{
1988 return( ( ssl->handshake->key_exchange_mode & kex_mask ) != 0 );
1989}
1990
1991static inline int mbedtls_ssl_tls13_key_exchange_mode_with_psk(
1992 mbedtls_ssl_context *ssl )
1993{
1994 return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl,
1995 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
1996}
1997
1998static inline int mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(
1999 mbedtls_ssl_context *ssl )
2000{
2001 return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl,
2002 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
2003}
2004
2005/*
XiaokangQian6b226b02021-09-24 07:51:16 +00002006 * Fetch TLS 1.3 handshake message header
2007 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002008MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002009int mbedtls_ssl_tls13_fetch_handshake_msg( mbedtls_ssl_context *ssl,
2010 unsigned hs_type,
2011 unsigned char **buf,
2012 size_t *buf_len );
XiaokangQian6b226b02021-09-24 07:51:16 +00002013
2014/*
Xiaofei Bai947571e2021-09-29 09:12:03 +00002015 * Handler of TLS 1.3 server certificate message
2016 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002017MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai947571e2021-09-29 09:12:03 +00002018int mbedtls_ssl_tls13_process_certificate( mbedtls_ssl_context *ssl );
2019
Ronald Cron928cbd32022-10-04 16:14:26 +02002020#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002021/*
Jerry Yu3e536442022-02-15 11:05:59 +08002022 * Handler of TLS 1.3 write Certificate message
Jerry Yu5cc35062022-01-28 16:16:08 +08002023 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002024MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5cc35062022-01-28 16:16:08 +08002025int mbedtls_ssl_tls13_write_certificate( mbedtls_ssl_context *ssl );
2026
2027/*
Jerry Yu3e536442022-02-15 11:05:59 +08002028 * Handler of TLS 1.3 write Certificate Verify message
Jerry Yu8511f122022-01-29 10:01:04 +08002029 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002030MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8511f122022-01-29 10:01:04 +08002031int mbedtls_ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl );
Jerry Yu90f152d2022-01-29 22:12:42 +08002032
Ronald Cron928cbd32022-10-04 16:14:26 +02002033#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu90f152d2022-01-29 22:12:42 +08002034
Jerry Yu8511f122022-01-29 10:01:04 +08002035/*
Jerry Yu30b071c2021-09-12 20:16:03 +08002036 * Generic handler of Certificate Verify
2037 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002038MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu30b071c2021-09-12 20:16:03 +08002039int mbedtls_ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl );
2040
2041/*
Ronald Cron49ad6192021-11-24 16:25:31 +01002042 * Write of dummy-CCS's for middlebox compatibility
2043 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002044MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron49ad6192021-11-24 16:25:31 +01002045int mbedtls_ssl_tls13_write_change_cipher_spec( mbedtls_ssl_context *ssl );
2046
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002047MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian647719a2021-12-07 09:16:29 +00002048int mbedtls_ssl_reset_transcript_for_hrr( mbedtls_ssl_context *ssl );
2049
Jerry Yu89e103c2022-03-30 22:43:29 +08002050#if defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002051MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu89e103c2022-03-30 22:43:29 +08002052int mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
2053 mbedtls_ssl_context *ssl,
2054 uint16_t named_group,
2055 unsigned char *buf,
2056 unsigned char *end,
2057 size_t *out_len );
2058#endif /* MBEDTLS_ECDH_C */
2059
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00002060#if defined(MBEDTLS_SSL_EARLY_DATA)
2061int mbedtls_ssl_tls13_write_early_data_ext(
2062 mbedtls_ssl_context *ssl,
2063 unsigned char *buf, const unsigned char *end, size_t *olen);
2064#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu89e103c2022-03-30 22:43:29 +08002065
Jerry Yuf017ee42022-01-12 15:49:48 +08002066#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2067
Ronald Crone68ab4f2022-10-05 12:46:29 +02002068#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002069/*
Gabor Mezei53a3b142022-05-10 13:20:55 +02002070 * Parse TLS Signature Algorithm extension
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002071 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002072MBEDTLS_CHECK_RETURN_CRITICAL
Gabor Mezei078e8032022-04-27 21:17:56 +02002073int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
2074 const unsigned char *buf,
2075 const unsigned char *end );
Ronald Crone68ab4f2022-10-05 12:46:29 +02002076#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002077
Jerry Yu000f9762021-09-14 11:12:51 +08002078/* Get handshake transcript */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002079MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08002080int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
2081 const mbedtls_md_type_t md,
2082 unsigned char *dst,
2083 size_t dst_len,
2084 size_t *olen );
2085
Brett Warrene0edc842021-08-17 09:53:13 +01002086/*
2087 * Return supported groups.
2088 *
2089 * In future, invocations can be changed to ssl->conf->group_list
2090 * when mbedtls_ssl_conf_curves() is deleted.
2091 *
2092 * ssl->handshake->group_list is either a translation of curve_list to IANA TLS group
2093 * identifiers when mbedtls_ssl_conf_curves() has been used, or a pointer to
2094 * ssl->conf->group_list when mbedtls_ssl_conf_groups() has been more recently invoked.
2095 *
2096 */
2097static inline const void *mbedtls_ssl_get_groups( const mbedtls_ssl_context *ssl )
2098{
2099 #if defined(MBEDTLS_DEPRECATED_REMOVED) || !defined(MBEDTLS_ECP_C)
2100 return( ssl->conf->group_list );
2101 #else
2102 if( ( ssl->handshake != NULL ) && ( ssl->handshake->group_list != NULL ) )
2103 return( ssl->handshake->group_list );
2104 else
2105 return( ssl->conf->group_list );
2106 #endif
2107}
2108
Jerry Yuba073422021-12-20 22:22:15 +08002109/*
2110 * Helper functions for NamedGroup.
2111 */
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002112static inline int mbedtls_ssl_tls12_named_group_is_ecdhe( uint16_t named_group )
Jerry Yuba073422021-12-20 22:22:15 +08002113{
2114 /*
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002115 * RFC 8422 section 5.1.1
Jerry Yuba073422021-12-20 22:22:15 +08002116 */
Jerry Yuf0fede52022-01-12 10:57:47 +08002117 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2118 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 ||
2119 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 ||
2120 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 ||
2121 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 ||
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002122 /* Below deprecated curves should be removed with notice to users */
Jerry Yuf0fede52022-01-12 10:57:47 +08002123 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 ||
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002124 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 ||
2125 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 ||
2126 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 ||
2127 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 ||
2128 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
2129 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
Jerry Yuf0fede52022-01-12 10:57:47 +08002130 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 );
Jerry Yuba073422021-12-20 22:22:15 +08002131}
2132
2133static inline int mbedtls_ssl_tls13_named_group_is_ecdhe( uint16_t named_group )
2134{
Jerry Yuf0fede52022-01-12 10:57:47 +08002135 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2136 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08002137 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
2138 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08002139 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 );
2140}
2141
2142static inline int mbedtls_ssl_tls13_named_group_is_dhe( uint16_t named_group )
2143{
2144 return( named_group >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 &&
2145 named_group <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 );
2146}
2147
XiaokangQian08037552022-04-20 07:16:41 +00002148static inline int mbedtls_ssl_named_group_is_offered(
2149 const mbedtls_ssl_context *ssl, uint16_t named_group )
2150{
2151 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
2152
2153 if( group_list == NULL )
2154 return( 0 );
2155
2156 for( ; *group_list != 0; group_list++ )
2157 {
2158 if( *group_list == named_group )
2159 return( 1 );
2160 }
2161
2162 return( 0 );
2163}
2164
2165static inline int mbedtls_ssl_named_group_is_supported( uint16_t named_group )
2166{
2167#if defined(MBEDTLS_ECDH_C)
2168 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
2169 {
2170 const mbedtls_ecp_curve_info *curve_info =
2171 mbedtls_ecp_curve_info_from_tls_id( named_group );
2172 if( curve_info != NULL )
2173 return( 1 );
2174 }
2175#else
2176 ((void) named_group);
2177#endif /* MBEDTLS_ECDH_C */
2178 return( 0 );
2179}
2180
Jerry Yuafdfed12021-12-22 10:49:02 +08002181/*
Jerry Yu713013f2022-01-17 18:16:35 +08002182 * Return supported signature algorithms.
2183 *
2184 * In future, invocations can be changed to ssl->conf->sig_algs when
2185 * mbedtls_ssl_conf_sig_hashes() is deleted.
2186 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002187 * ssl->handshake->sig_algs is either a translation of sig_hashes to IANA TLS
2188 * signature algorithm identifiers when mbedtls_ssl_conf_sig_hashes() has been
2189 * used, or a pointer to ssl->conf->sig_algs when mbedtls_ssl_conf_sig_algs() has
2190 * been more recently invoked.
2191 *
Jerry Yuafdfed12021-12-22 10:49:02 +08002192 */
Jerry Yu713013f2022-01-17 18:16:35 +08002193static inline const void *mbedtls_ssl_get_sig_algs(
2194 const mbedtls_ssl_context *ssl )
Jerry Yuafdfed12021-12-22 10:49:02 +08002195{
Ronald Crone68ab4f2022-10-05 12:46:29 +02002196#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002197
Jerry Yu6106fdc2022-01-12 16:36:14 +08002198#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yucc539102022-06-27 16:27:35 +08002199 if( ssl->handshake != NULL &&
2200 ssl->handshake->sig_algs_heap_allocated == 1 &&
Jerry Yuee28e7a2022-06-24 19:35:40 +08002201 ssl->handshake->sig_algs != NULL )
2202 {
Jerry Yu6106fdc2022-01-12 16:36:14 +08002203 return( ssl->handshake->sig_algs );
Jerry Yuee28e7a2022-06-24 19:35:40 +08002204 }
Jerry Yu6106fdc2022-01-12 16:36:14 +08002205#endif
2206 return( ssl->conf->sig_algs );
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002207
Ronald Crone68ab4f2022-10-05 12:46:29 +02002208#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002209
Jerry Yu6106fdc2022-01-12 16:36:14 +08002210 ((void) ssl);
Jerry Yu713013f2022-01-17 18:16:35 +08002211 return( NULL );
Ronald Crone68ab4f2022-10-05 12:46:29 +02002212#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002213}
Jerry Yuba073422021-12-20 22:22:15 +08002214
Ronald Cron928cbd32022-10-04 16:14:26 +02002215#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu8511f122022-01-29 10:01:04 +08002216static inline int mbedtls_ssl_sig_alg_is_received( const mbedtls_ssl_context *ssl,
2217 uint16_t own_sig_alg )
2218{
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002219 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
2220 if( sig_alg == NULL )
2221 return( 0 );
2222
Gabor Mezei15b95a62022-05-09 16:37:58 +02002223 for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ )
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002224 {
2225 if( *sig_alg == own_sig_alg )
2226 return( 1 );
2227 }
2228 return( 0 );
Jerry Yu8511f122022-01-29 10:01:04 +08002229}
2230
Jerry Yua1255e62022-06-24 10:10:47 +08002231static inline int mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Jerry Yu0ebce952022-06-16 13:54:47 +08002232 const uint16_t sig_alg )
2233{
Jerry Yu96ee23e2022-06-21 16:34:57 +08002234 switch( sig_alg )
2235 {
2236#if defined(MBEDTLS_ECDSA_C)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002237#if defined(PSA_WANT_ALG_SHA_256) && defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002238 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
2239 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002240#endif /* PSA_WANT_ALG_SHA_256 && MBEDTLS_ECP_DP_SECP256R1_ENABLED */
2241#if defined(PSA_WANT_ALG_SHA_384) && defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002242 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
2243 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002244#endif /* PSA_WANT_ALG_SHA_384 && MBEDTLS_ECP_DP_SECP384R1_ENABLED */
2245#if defined(PSA_WANT_ALG_SHA_512) && defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002246 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
2247 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002248#endif /* PSA_WANT_ALG_SHA_512 && MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002249#endif /* MBEDTLS_ECDSA_C */
2250
Jerry Yu52b7d922022-07-01 18:03:31 +08002251#if defined(MBEDTLS_PKCS1_V21)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002252#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002253 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2254 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002255#endif /* PSA_WANT_ALG_SHA_256 */
2256#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002257 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2258 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002259#endif /* PSA_WANT_ALG_SHA_384 */
2260#if defined(PSA_WANT_ALG_SHA_512)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002261 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2262 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002263#endif /* PSA_WANT_ALG_SHA_512 */
Jerry Yu52b7d922022-07-01 18:03:31 +08002264#endif /* MBEDTLS_PKCS1_V21 */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002265 default:
2266 return( 0 );
2267 }
2268 return( 1 );
Jerry Yu80dd5db2022-06-22 19:30:32 +08002269
2270}
2271
2272static inline int mbedtls_ssl_tls13_sig_alg_is_supported(
2273 const uint16_t sig_alg )
2274{
2275 switch( sig_alg )
2276 {
Jerry Yu52b7d922022-07-01 18:03:31 +08002277#if defined(MBEDTLS_PKCS1_V15)
Przemek Stekiel153b4422022-09-05 12:36:25 +02002278#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002279 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
2280 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002281#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2282#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002283 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
2284 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002285#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2286#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002287 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
2288 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002289#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu52b7d922022-07-01 18:03:31 +08002290#endif /* MBEDTLS_PKCS1_V15 */
Jerry Yu80dd5db2022-06-22 19:30:32 +08002291 default:
Jerry Yua1255e62022-06-24 10:10:47 +08002292 return( mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Jerry Yu80dd5db2022-06-22 19:30:32 +08002293 sig_alg ) );
2294 }
2295 return( 1 );
Jerry Yu0ebce952022-06-16 13:54:47 +08002296}
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002297
Ronald Cron928cbd32022-10-04 16:14:26 +02002298MBEDTLS_CHECK_RETURN_CRITICAL
2299int mbedtls_ssl_tls13_check_sig_alg_cert_key_match( uint16_t sig_alg,
2300 mbedtls_pk_context *key );
2301#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
2302
Ronald Crone68ab4f2022-10-05 12:46:29 +02002303#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron928cbd32022-10-04 16:14:26 +02002304static inline int mbedtls_ssl_sig_alg_is_offered( const mbedtls_ssl_context *ssl,
2305 uint16_t proposed_sig_alg )
2306{
2307 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
2308 if( sig_alg == NULL )
2309 return( 0 );
2310
2311 for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ )
2312 {
2313 if( *sig_alg == proposed_sig_alg )
2314 return( 1 );
2315 }
2316 return( 0 );
2317}
2318
2319static inline int mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
2320 uint16_t sig_alg, mbedtls_pk_type_t *pk_type, mbedtls_md_type_t *md_alg )
2321{
2322 *pk_type = mbedtls_ssl_pk_alg_from_sig( sig_alg & 0xff );
2323 *md_alg = mbedtls_ssl_md_alg_from_hash( ( sig_alg >> 8 ) & 0xff );
2324
2325 if( *pk_type != MBEDTLS_PK_NONE && *md_alg != MBEDTLS_MD_NONE )
2326 return( 0 );
2327
2328 switch( sig_alg )
2329 {
2330#if defined(MBEDTLS_PKCS1_V21)
2331#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2332 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2333 *md_alg = MBEDTLS_MD_SHA256;
2334 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2335 break;
2336#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2337#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2338 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2339 *md_alg = MBEDTLS_MD_SHA384;
2340 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2341 break;
2342#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2343#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2344 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2345 *md_alg = MBEDTLS_MD_SHA512;
2346 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2347 break;
2348#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2349#endif /* MBEDTLS_PKCS1_V21 */
2350 default:
2351 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2352 }
2353 return( 0 );
2354}
Jerry Yu8c338862022-03-23 13:34:04 +08002355
Jerry Yu0ebce952022-06-16 13:54:47 +08002356#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2357static inline int mbedtls_ssl_tls12_sig_alg_is_supported(
2358 const uint16_t sig_alg )
2359{
2360 /* High byte is hash */
2361 unsigned char hash = MBEDTLS_BYTE_1( sig_alg );
2362 unsigned char sig = MBEDTLS_BYTE_0( sig_alg );
2363
2364 switch( hash )
2365 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04002366#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002367 case MBEDTLS_SSL_HASH_MD5:
2368 break;
2369#endif
2370
Andrzej Kurek25f27152022-08-17 16:09:31 -04002371#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002372 case MBEDTLS_SSL_HASH_SHA1:
2373 break;
2374#endif
2375
Andrzej Kurek25f27152022-08-17 16:09:31 -04002376#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002377 case MBEDTLS_SSL_HASH_SHA224:
2378 break;
2379#endif
2380
Andrzej Kurek25f27152022-08-17 16:09:31 -04002381#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002382 case MBEDTLS_SSL_HASH_SHA256:
2383 break;
2384#endif
2385
Andrzej Kurek25f27152022-08-17 16:09:31 -04002386#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002387 case MBEDTLS_SSL_HASH_SHA384:
2388 break;
2389#endif
2390
Andrzej Kurek25f27152022-08-17 16:09:31 -04002391#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002392 case MBEDTLS_SSL_HASH_SHA512:
2393 break;
2394#endif
2395
2396 default:
2397 return( 0 );
2398 }
2399
2400 switch( sig )
2401 {
2402#if defined(MBEDTLS_RSA_C)
2403 case MBEDTLS_SSL_SIG_RSA:
2404 break;
2405#endif
2406
2407#if defined(MBEDTLS_ECDSA_C)
2408 case MBEDTLS_SSL_SIG_ECDSA:
2409 break;
2410#endif
2411
2412 default:
2413 return( 0 );
2414 }
2415
2416 return( 1 );
2417}
2418#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2419
Jerry Yu1bab3012022-01-19 17:43:22 +08002420static inline int mbedtls_ssl_sig_alg_is_supported(
2421 const mbedtls_ssl_context *ssl,
2422 const uint16_t sig_alg )
2423{
2424
2425#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002426 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002427 {
Jerry Yu0ebce952022-06-16 13:54:47 +08002428 return( mbedtls_ssl_tls12_sig_alg_is_supported( sig_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002429 }
2430#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2431
Ronald Cron928cbd32022-10-04 16:14:26 +02002432#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002433 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002434 {
Jerry Yu7ab7f2b2022-06-16 19:07:10 +08002435 return( mbedtls_ssl_tls13_sig_alg_is_supported( sig_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002436 }
Ronald Cron928cbd32022-10-04 16:14:26 +02002437#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002438 ((void) ssl);
2439 ((void) sig_alg);
2440 return( 0 );
2441}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002442#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1bab3012022-01-19 17:43:22 +08002443
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002444#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002445/* Corresponding PSA algorithm for MBEDTLS_CIPHER_NULL.
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002446 * Same value is used for PSA_ALG_CATEGORY_CIPHER, hence it is
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002447 * guaranteed to not be a valid PSA algorithm identifier.
2448 */
2449#define MBEDTLS_SSL_NULL_CIPHER 0x04000000
2450
2451/**
2452 * \brief Translate mbedtls cipher type/taglen pair to psa:
2453 * algorithm, key type and key size.
2454 *
2455 * \param mbedtls_cipher_type [in] given mbedtls cipher type
2456 * \param taglen [in] given tag length
2457 * 0 - default tag length
2458 * \param alg [out] corresponding PSA alg
2459 * There is no corresponding PSA
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01002460 * alg for MBEDTLS_CIPHER_NULL, so
2461 * in this case MBEDTLS_SSL_NULL_CIPHER
2462 * is returned via this parameter
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002463 * \param key_type [out] corresponding PSA key type
2464 * \param key_size [out] corresponding PSA key size
2465 *
2466 * \return PSA_SUCCESS on success or PSA_ERROR_NOT_SUPPORTED if
2467 * conversion is not supported.
2468 */
2469psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
2470 size_t taglen,
2471 psa_algorithm_t *alg,
2472 psa_key_type_t *key_type,
2473 size_t *key_size );
2474
2475/**
2476 * \brief Convert given PSA status to mbedtls error code.
2477 *
2478 * \param status [in] given PSA status
2479 *
2480 * \return corresponding mbedtls error code
2481 */
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01002482static inline int psa_ssl_status_to_mbedtls( psa_status_t status )
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002483{
2484 switch( status )
2485 {
2486 case PSA_SUCCESS:
2487 return( 0 );
2488 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002489 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002490 case PSA_ERROR_NOT_SUPPORTED:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002491 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Przemyslaw Stekiel89dad932022-01-31 09:18:07 +01002492 case PSA_ERROR_INVALID_SIGNATURE:
2493 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Gabor Mezeiadfeadc2022-03-21 12:17:49 +01002494 case PSA_ERROR_INVALID_ARGUMENT:
2495 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2496 case PSA_ERROR_BAD_STATE:
2497 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemek Stekiel85836272022-04-05 10:50:53 +02002498 case PSA_ERROR_BUFFER_TOO_SMALL:
2499 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002500 default:
2501 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
2502 }
2503}
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002504#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu1bab3012022-01-19 17:43:22 +08002505
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002506/**
2507 * \brief TLS record protection modes
2508 */
2509typedef enum {
2510 MBEDTLS_SSL_MODE_STREAM = 0,
2511 MBEDTLS_SSL_MODE_CBC,
2512 MBEDTLS_SSL_MODE_CBC_ETM,
2513 MBEDTLS_SSL_MODE_AEAD
2514} mbedtls_ssl_mode_t;
2515
Neil Armstrongab555e02022-04-04 11:07:59 +02002516mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002517 const mbedtls_ssl_transform *transform );
2518
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002519#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrongab555e02022-04-04 11:07:59 +02002520mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002521 int encrypt_then_mac,
2522 const mbedtls_ssl_ciphersuite_t *suite );
2523#else
Neil Armstrongab555e02022-04-04 11:07:59 +02002524mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002525 const mbedtls_ssl_ciphersuite_t *suite );
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002526#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002527
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002528#if defined(MBEDTLS_ECDH_C)
2529
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002530MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002531int mbedtls_ssl_tls13_read_public_ecdhe_share( mbedtls_ssl_context *ssl,
2532 const unsigned char *buf,
2533 size_t buf_len );
2534
2535#endif /* MBEDTLS_ECDH_C */
2536
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002537static inline int mbedtls_ssl_tls13_cipher_suite_is_offered(
2538 mbedtls_ssl_context *ssl, int cipher_suite )
2539{
2540 const int *ciphersuite_list = ssl->conf->ciphersuite_list;
2541
2542 /* Check whether we have offered this ciphersuite */
2543 for ( size_t i = 0; ciphersuite_list[i] != 0; i++ )
2544 {
2545 if( ciphersuite_list[i] == cipher_suite )
2546 {
2547 return( 1 );
2548 }
2549 }
2550 return( 0 );
2551}
2552
2553/**
2554 * \brief Validate cipher suite against config in SSL context.
2555 *
2556 * \param ssl SSL context
2557 * \param suite_info Cipher suite to validate
2558 * \param min_tls_version Minimal TLS version to accept a cipher suite
2559 * \param max_tls_version Maximal TLS version to accept a cipher suite
2560 *
2561 * \return 0 if valid, negative value otherwise.
2562 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002563MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002564int mbedtls_ssl_validate_ciphersuite(
2565 const mbedtls_ssl_context *ssl,
2566 const mbedtls_ssl_ciphersuite_t *suite_info,
2567 mbedtls_ssl_protocol_version min_tls_version,
2568 mbedtls_ssl_protocol_version max_tls_version );
XiaokangQian08037552022-04-20 07:16:41 +00002569
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002570MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeaf36512022-04-24 09:07:44 +00002571int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
2572 const unsigned char *end, size_t *out_len );
2573
XiaokangQian40a35232022-05-07 09:02:40 +00002574#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002575MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00002576int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
2577 const unsigned char *buf,
2578 const unsigned char *end );
XiaokangQian40a35232022-05-07 09:02:40 +00002579#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2580
XiaokangQianacb39922022-06-17 10:18:48 +00002581#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002582MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00002583int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
2584 const unsigned char *buf,
2585 const unsigned char *end );
2586
2587
Ronald Cronce7d76e2022-07-08 18:56:49 +02002588MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00002589int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
2590 unsigned char *buf,
2591 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00002592 size_t *out_len );
XiaokangQianacb39922022-06-17 10:18:48 +00002593#endif /* MBEDTLS_SSL_ALPN */
2594
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002595#if defined(MBEDTLS_TEST_HOOKS)
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04002596int mbedtls_ssl_check_dtls_clihlo_cookie(
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002597 mbedtls_ssl_context *ssl,
2598 const unsigned char *cli_id, size_t cli_id_len,
2599 const unsigned char *in, size_t in_len,
2600 unsigned char *obuf, size_t buf_len, size_t *olen );
2601#endif
2602
Ronald Cron41a443a2022-10-04 16:38:25 +02002603#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00002604/**
2605 * \brief Given an SSL context and its associated configuration, write the TLS
2606 * 1.3 specific Pre-Shared key extension.
2607 *
2608 * \param[in] ssl SSL context
2609 * \param[in] buf Base address of the buffer where to write the extension
2610 * \param[in] end End address of the buffer where to write the extension
XiaokangQian008d2bf2022-07-14 07:54:01 +00002611 * \param[out] out_len Length in bytes of the Pre-Shared key extension: data
2612 * written into the buffer \p buf by this function plus
2613 * the length of the binders to be written.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002614 * \param[out] binders_len Length of the binders to be written at the end of
XiaokangQian008d2bf2022-07-14 07:54:01 +00002615 * the extension.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002616 */
XiaokangQian86981952022-07-19 09:51:50 +00002617MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian3ad67bf2022-07-21 02:26:21 +00002618int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002619 mbedtls_ssl_context *ssl,
2620 unsigned char *buf, unsigned char *end,
2621 size_t *out_len, size_t *binders_len );
2622
2623/**
2624 * \brief Given an SSL context and its associated configuration, write the TLS
2625 * 1.3 specific Pre-Shared key extension binders at the end of the
2626 * ClientHello.
2627 *
2628 * \param[in] ssl SSL context
XiaokangQian008d2bf2022-07-14 07:54:01 +00002629 * \param[in] buf Base address of the buffer where to write the binders
2630 * \param[in] end End address of the buffer where to write the binders
XiaokangQianeb69aee2022-07-05 08:21:43 +00002631 */
XiaokangQian86981952022-07-19 09:51:50 +00002632MBEDTLS_CHECK_RETURN_CRITICAL
2633int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002634 mbedtls_ssl_context *ssl,
2635 unsigned char *buf, unsigned char *end );
Ronald Cron41a443a2022-10-04 16:38:25 +02002636#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00002637
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002638#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00002639 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002640 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00002641 defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qian03409292022-10-12 02:49:52 +00002642MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002643int mbedtls_ssl_session_set_hostname( mbedtls_ssl_session *session,
2644 const char *hostname );
2645#endif
2646
Chris Jones84a773f2021-03-05 18:38:47 +00002647#endif /* ssl_misc.h */