blob: 14a3c7ef0051debdcabbd0d843117187d6812b0e [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
35
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +010036#if defined(MBEDTLS_MD_CAN_MD5)
Jaeden Amero6609aef2019-07-04 20:01:14 +010037#include "mbedtls/md5.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020038#endif
39
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +010040#if defined(MBEDTLS_MD_CAN_SHA1)
Jaeden Amero6609aef2019-07-04 20:01:14 +010041#include "mbedtls/sha1.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020042#endif
43
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +010044#if defined(MBEDTLS_MD_CAN_SHA256)
Jaeden Amero6609aef2019-07-04 20:01:14 +010045#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020046#endif
47
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +010048#if defined(MBEDTLS_MD_CAN_SHA512)
Jaeden Amero6609aef2019-07-04 20:01:14 +010049#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020050#endif
51
Neil Armstrongca7d5062022-05-31 14:43:23 +020052#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
53 !defined(MBEDTLS_USE_PSA_CRYPTO)
Jaeden Amero6609aef2019-07-04 20:01:14 +010054#include "mbedtls/ecjpake.h"
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +020055#endif
56
Valerio Setti2f1d9672023-03-07 18:14:34 +010057#include "mbedtls/pk.h"
Jerry Yu1bab3012022-01-19 17:43:22 +080058#include "common.h"
59
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +020060/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020061#if defined(MBEDTLS_ECP_RESTARTABLE) && \
62 defined(MBEDTLS_SSL_CLI_C) && \
63 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
64 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +010065#define MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020066#endif
67
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020068#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
69#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
70#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
71#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
72
Jerry Yud25cab02022-10-31 12:48:30 +080073/* Faked handshake message identity for HelloRetryRequest. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074#define MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST (-MBEDTLS_SSL_HS_SERVER_HELLO)
Jerry Yud25cab02022-10-31 12:48:30 +080075
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020076/*
Jerry Yuea52ed92022-11-08 21:01:17 +080077 * Internal identity of handshake extensions
Jerry Yu8e7ca042021-08-26 15:31:37 +080078 */
Jerry Yu7a485c12022-10-31 13:08:18 +080079#define MBEDTLS_SSL_EXT_ID_UNRECOGNIZED 0
80#define MBEDTLS_SSL_EXT_ID_SERVERNAME 1
81#define MBEDTLS_SSL_EXT_ID_SERVERNAME_HOSTNAME 1
82#define MBEDTLS_SSL_EXT_ID_MAX_FRAGMENT_LENGTH 2
83#define MBEDTLS_SSL_EXT_ID_STATUS_REQUEST 3
84#define MBEDTLS_SSL_EXT_ID_SUPPORTED_GROUPS 4
85#define MBEDTLS_SSL_EXT_ID_SUPPORTED_ELLIPTIC_CURVES 4
86#define MBEDTLS_SSL_EXT_ID_SIG_ALG 5
87#define MBEDTLS_SSL_EXT_ID_USE_SRTP 6
88#define MBEDTLS_SSL_EXT_ID_HEARTBEAT 7
89#define MBEDTLS_SSL_EXT_ID_ALPN 8
90#define MBEDTLS_SSL_EXT_ID_SCT 9
91#define MBEDTLS_SSL_EXT_ID_CLI_CERT_TYPE 10
92#define MBEDTLS_SSL_EXT_ID_SERV_CERT_TYPE 11
93#define MBEDTLS_SSL_EXT_ID_PADDING 12
94#define MBEDTLS_SSL_EXT_ID_PRE_SHARED_KEY 13
95#define MBEDTLS_SSL_EXT_ID_EARLY_DATA 14
96#define MBEDTLS_SSL_EXT_ID_SUPPORTED_VERSIONS 15
97#define MBEDTLS_SSL_EXT_ID_COOKIE 16
98#define MBEDTLS_SSL_EXT_ID_PSK_KEY_EXCHANGE_MODES 17
99#define MBEDTLS_SSL_EXT_ID_CERT_AUTH 18
100#define MBEDTLS_SSL_EXT_ID_OID_FILTERS 19
101#define MBEDTLS_SSL_EXT_ID_POST_HANDSHAKE_AUTH 20
102#define MBEDTLS_SSL_EXT_ID_SIG_ALG_CERT 21
103#define MBEDTLS_SSL_EXT_ID_KEY_SHARE 22
104#define MBEDTLS_SSL_EXT_ID_TRUNCATED_HMAC 23
105#define MBEDTLS_SSL_EXT_ID_SUPPORTED_POINT_FORMATS 24
106#define MBEDTLS_SSL_EXT_ID_ENCRYPT_THEN_MAC 25
107#define MBEDTLS_SSL_EXT_ID_EXTENDED_MASTER_SECRET 26
108#define MBEDTLS_SSL_EXT_ID_SESSION_TICKET 27
Jan Bruckner151f6422023-02-10 12:45:19 +0100109#define MBEDTLS_SSL_EXT_ID_RECORD_SIZE_LIMIT 28
Jerry Yu8e7ca042021-08-26 15:31:37 +0800110
Jerry Yu7a485c12022-10-31 13:08:18 +0800111/* Utility for translating IANA extension type. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100112uint32_t mbedtls_ssl_get_extension_id(unsigned int extension_type);
113uint32_t mbedtls_ssl_get_extension_mask(unsigned int extension_type);
Jerry Yu7a485c12022-10-31 13:08:18 +0800114/* Macros used to define mask constants */
Gilles Peskine449bd832023-01-11 14:50:10 +0100115#define MBEDTLS_SSL_EXT_MASK(id) (1ULL << (MBEDTLS_SSL_EXT_ID_##id))
Jerry Yu7a485c12022-10-31 13:08:18 +0800116/* Reset value of extension mask */
117#define MBEDTLS_SSL_EXT_MASK_NONE 0
Jerry Yu93bcd612021-08-18 12:47:24 +0800118
Jerry Yuc4bf5d62022-10-29 09:08:47 +0800119/* In messages containing extension requests, we should ignore unrecognized
120 * extensions. In messages containing extension responses, unrecognized
121 * extensions should result in handshake abortion. Messages containing
122 * extension requests include ClientHello, CertificateRequest and
123 * NewSessionTicket. Messages containing extension responses include
124 * ServerHello, HelloRetryRequest, EncryptedExtensions and Certificate.
Jerry Yue18dc7e2022-08-04 16:29:22 +0800125 *
Jerry Yud15992d2022-08-29 10:58:31 +0800126 * RFC 8446 section 4.1.3
Jerry Yue18dc7e2022-08-04 16:29:22 +0800127 *
128 * The ServerHello MUST only include extensions which are required to establish
129 * the cryptographic context and negotiate the protocol version.
130 *
Jerry Yud15992d2022-08-29 10:58:31 +0800131 * RFC 8446 section 4.2
Jerry Yue18dc7e2022-08-04 16:29:22 +0800132 *
133 * If an implementation receives an extension which it recognizes and which is
134 * not specified for the message in which it appears, it MUST abort the handshake
135 * with an "illegal_parameter" alert.
136 */
Jerry Yudf0ad652022-10-31 13:20:57 +0800137
Jerry Yuea52ed92022-11-08 21:01:17 +0800138/* Extensions that are not recognized by TLS 1.3 */
139#define MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED \
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 (MBEDTLS_SSL_EXT_MASK(SUPPORTED_POINT_FORMATS) | \
141 MBEDTLS_SSL_EXT_MASK(ENCRYPT_THEN_MAC) | \
142 MBEDTLS_SSL_EXT_MASK(EXTENDED_MASTER_SECRET) | \
143 MBEDTLS_SSL_EXT_MASK(SESSION_TICKET) | \
144 MBEDTLS_SSL_EXT_MASK(TRUNCATED_HMAC) | \
145 MBEDTLS_SSL_EXT_MASK(UNRECOGNIZED))
Jerry Yue18dc7e2022-08-04 16:29:22 +0800146
Tom Cosgrove1797b052022-12-04 17:19:59 +0000147/* RFC 8446 section 4.2. Allowed extensions for ClientHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800148#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH \
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 (MBEDTLS_SSL_EXT_MASK(SERVERNAME) | \
150 MBEDTLS_SSL_EXT_MASK(MAX_FRAGMENT_LENGTH) | \
151 MBEDTLS_SSL_EXT_MASK(STATUS_REQUEST) | \
152 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) | \
153 MBEDTLS_SSL_EXT_MASK(SIG_ALG) | \
154 MBEDTLS_SSL_EXT_MASK(USE_SRTP) | \
155 MBEDTLS_SSL_EXT_MASK(HEARTBEAT) | \
156 MBEDTLS_SSL_EXT_MASK(ALPN) | \
157 MBEDTLS_SSL_EXT_MASK(SCT) | \
158 MBEDTLS_SSL_EXT_MASK(CLI_CERT_TYPE) | \
159 MBEDTLS_SSL_EXT_MASK(SERV_CERT_TYPE) | \
160 MBEDTLS_SSL_EXT_MASK(PADDING) | \
161 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) | \
162 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | \
163 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES) | \
164 MBEDTLS_SSL_EXT_MASK(EARLY_DATA) | \
165 MBEDTLS_SSL_EXT_MASK(COOKIE) | \
166 MBEDTLS_SSL_EXT_MASK(SUPPORTED_VERSIONS) | \
167 MBEDTLS_SSL_EXT_MASK(CERT_AUTH) | \
168 MBEDTLS_SSL_EXT_MASK(POST_HANDSHAKE_AUTH) | \
169 MBEDTLS_SSL_EXT_MASK(SIG_ALG_CERT) | \
Jan Bruckner151f6422023-02-10 12:45:19 +0100170 MBEDTLS_SSL_EXT_MASK(RECORD_SIZE_LIMIT) | \
Gilles Peskine449bd832023-01-11 14:50:10 +0100171 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED)
Jerry Yue18dc7e2022-08-04 16:29:22 +0800172
Jerry Yud15992d2022-08-29 10:58:31 +0800173/* RFC 8446 section 4.2. Allowed extensions for EncryptedExtensions */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800174#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE \
Gilles Peskine449bd832023-01-11 14:50:10 +0100175 (MBEDTLS_SSL_EXT_MASK(SERVERNAME) | \
176 MBEDTLS_SSL_EXT_MASK(MAX_FRAGMENT_LENGTH) | \
177 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) | \
178 MBEDTLS_SSL_EXT_MASK(USE_SRTP) | \
179 MBEDTLS_SSL_EXT_MASK(HEARTBEAT) | \
180 MBEDTLS_SSL_EXT_MASK(ALPN) | \
181 MBEDTLS_SSL_EXT_MASK(CLI_CERT_TYPE) | \
182 MBEDTLS_SSL_EXT_MASK(SERV_CERT_TYPE) | \
Jan Bruckner151f6422023-02-10 12:45:19 +0100183 MBEDTLS_SSL_EXT_MASK(EARLY_DATA) | \
184 MBEDTLS_SSL_EXT_MASK(RECORD_SIZE_LIMIT))
Jerry Yue18dc7e2022-08-04 16:29:22 +0800185
Jerry Yud15992d2022-08-29 10:58:31 +0800186/* RFC 8446 section 4.2. Allowed extensions for CertificateRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800187#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR \
Gilles Peskine449bd832023-01-11 14:50:10 +0100188 (MBEDTLS_SSL_EXT_MASK(STATUS_REQUEST) | \
189 MBEDTLS_SSL_EXT_MASK(SIG_ALG) | \
190 MBEDTLS_SSL_EXT_MASK(SCT) | \
191 MBEDTLS_SSL_EXT_MASK(CERT_AUTH) | \
192 MBEDTLS_SSL_EXT_MASK(OID_FILTERS) | \
193 MBEDTLS_SSL_EXT_MASK(SIG_ALG_CERT) | \
194 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED)
Jerry Yue18dc7e2022-08-04 16:29:22 +0800195
Jerry Yud15992d2022-08-29 10:58:31 +0800196/* RFC 8446 section 4.2. Allowed extensions for Certificate */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800197#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CT \
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 (MBEDTLS_SSL_EXT_MASK(STATUS_REQUEST) | \
199 MBEDTLS_SSL_EXT_MASK(SCT))
Jerry Yue18dc7e2022-08-04 16:29:22 +0800200
Jerry Yud15992d2022-08-29 10:58:31 +0800201/* RFC 8446 section 4.2. Allowed extensions for ServerHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800202#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH \
Gilles Peskine449bd832023-01-11 14:50:10 +0100203 (MBEDTLS_SSL_EXT_MASK(KEY_SHARE) | \
204 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) | \
205 MBEDTLS_SSL_EXT_MASK(SUPPORTED_VERSIONS))
Jerry Yue18dc7e2022-08-04 16:29:22 +0800206
Jerry Yud15992d2022-08-29 10:58:31 +0800207/* RFC 8446 section 4.2. Allowed extensions for HelloRetryRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800208#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR \
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 (MBEDTLS_SSL_EXT_MASK(KEY_SHARE) | \
210 MBEDTLS_SSL_EXT_MASK(COOKIE) | \
211 MBEDTLS_SSL_EXT_MASK(SUPPORTED_VERSIONS))
Jerry Yue18dc7e2022-08-04 16:29:22 +0800212
Jerry Yud15992d2022-08-29 10:58:31 +0800213/* RFC 8446 section 4.2. Allowed extensions for NewSessionTicket */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800214#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST \
Gilles Peskine449bd832023-01-11 14:50:10 +0100215 (MBEDTLS_SSL_EXT_MASK(EARLY_DATA) | \
216 MBEDTLS_SSL_TLS1_3_EXT_MASK_UNRECOGNIZED)
Jerry Yue18dc7e2022-08-04 16:29:22 +0800217
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800218/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800219 * Helper macros for function call with return check.
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800220 */
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800221/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800222 * Exit when return non-zero value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800223 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100224#define MBEDTLS_SSL_PROC_CHK(f) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800225 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 ret = (f); \
227 if (ret != 0) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800228 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800229 goto cleanup; \
230 } \
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 } while (0)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800232/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800233 * Exit when return negative value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800234 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100235#define MBEDTLS_SSL_PROC_CHK_NEG(f) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800236 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 ret = (f); \
238 if (ret < 0) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800239 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800240 goto cleanup; \
241 } \
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 } while (0)
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800243
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200244/*
245 * DTLS retransmission states, see RFC 6347 4.2.4
246 *
247 * The SENDING state is merged in PREPARING for initial sends,
248 * but is distinct for resends.
249 *
250 * Note: initial state is wrong for server, but is not used anyway.
251 */
252#define MBEDTLS_SSL_RETRANS_PREPARING 0
253#define MBEDTLS_SSL_RETRANS_SENDING 1
254#define MBEDTLS_SSL_RETRANS_WAITING 2
255#define MBEDTLS_SSL_RETRANS_FINISHED 3
256
257/*
258 * Allow extra bytes for record, authentication and encryption overhead:
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100259 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256).
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200260 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200261
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200262#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0cc46612020-11-30 08:56:52 +0000263
Manuel Pégourié-Gonnard05579c42020-07-31 12:53:39 +0200264/* This macro determines whether CBC is supported. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200265#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 (defined(MBEDTLS_AES_C) || \
267 defined(MBEDTLS_CAMELLIA_C) || \
268 defined(MBEDTLS_ARIA_C) || \
269 defined(MBEDTLS_DES_C))
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200270#define MBEDTLS_SSL_SOME_SUITES_USE_CBC
271#endif
272
Hanno Becker0cc46612020-11-30 08:56:52 +0000273/* This macro determines whether a ciphersuite using a
274 * stream cipher can be used. */
275#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
276#define MBEDTLS_SSL_SOME_SUITES_USE_STREAM
277#endif
278
TRodziewicz0f82ec62021-05-12 17:49:18 +0200279/* This macro determines whether the CBC construct used in TLS 1.2 is supported. */
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200280#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200282#define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC
283#endif
284
Hanno Becker31351ce2021-03-22 11:05:58 +0000285#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200286 defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000287#define MBEDTLS_SSL_SOME_SUITES_USE_MAC
Hanno Becker52344c22018-01-03 15:24:20 +0000288#endif
289
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200290/* This macro determines whether a ciphersuite uses Encrypt-then-MAC with CBC */
291#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
292 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
293#define MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM
294#endif
295
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200296#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker0cc46612020-11-30 08:56:52 +0000297
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000298#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200299/* Ciphersuites using HMAC */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100300#if defined(MBEDTLS_MD_CAN_SHA384)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200301#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100302#elif defined(MBEDTLS_MD_CAN_SHA256)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200303#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
304#else
305#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
306#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000307#else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200308/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
309#define MBEDTLS_SSL_MAC_ADD 16
310#endif
311
312#if defined(MBEDTLS_CIPHER_MODE_CBC)
313#define MBEDTLS_SSL_PADDING_ADD 256
314#else
315#define MBEDTLS_SSL_PADDING_ADD 0
316#endif
317
Hanno Beckera0e20d02019-05-15 14:03:01 +0100318#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
TRodziewicze8dd7092021-05-12 14:19:11 +0200319#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Hanno Becker6cbad552019-05-08 15:40:11 +0100320#else
321#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
322#endif
323
Gilles Peskine449bd832023-01-11 14:50:10 +0100324#define MBEDTLS_SSL_PAYLOAD_OVERHEAD (MBEDTLS_MAX_IV_LENGTH + \
325 MBEDTLS_SSL_MAC_ADD + \
326 MBEDTLS_SSL_PADDING_ADD + \
327 MBEDTLS_SSL_MAX_CID_EXPANSION \
328 )
Angus Grattond8213d02016-05-25 20:56:48 +1000329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330#define MBEDTLS_SSL_IN_PAYLOAD_LEN (MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
331 (MBEDTLS_SSL_IN_CONTENT_LEN))
Angus Grattond8213d02016-05-25 20:56:48 +1000332
Gilles Peskine449bd832023-01-11 14:50:10 +0100333#define MBEDTLS_SSL_OUT_PAYLOAD_LEN (MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
334 (MBEDTLS_SSL_OUT_CONTENT_LEN))
Angus Grattond8213d02016-05-25 20:56:48 +1000335
Hanno Becker0271f962018-08-16 13:23:47 +0100336/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100337#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100338
Angus Grattond8213d02016-05-25 20:56:48 +1000339/* Maximum length we can advertise as our max content length for
340 RFC 6066 max_fragment_length extension negotiation purposes
341 (the lesser of both sizes, if they are unequal.)
342 */
343#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
344 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
Gilles Peskine449bd832023-01-11 14:50:10 +0100345 ? (MBEDTLS_SSL_OUT_CONTENT_LEN) \
346 : (MBEDTLS_SSL_IN_CONTENT_LEN) \
Angus Grattond8213d02016-05-25 20:56:48 +1000347 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200348
Jerry Yu4131ec12022-01-19 10:36:30 +0800349/* Maximum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
350#define MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN 65534
351
Jerry Yu8afd6e42022-01-20 15:54:26 +0800352/* Minimum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
Jerry Yu4131ec12022-01-19 10:36:30 +0800353#define MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN 2
Hanno Beckere131bfe2017-04-12 14:54:42 +0100354
355/* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */
356#define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535
357
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000358#define MBEDTLS_RECEIVED_SIG_ALGS_SIZE 20
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +0000359
Ronald Crone68ab4f2022-10-05 12:46:29 +0200360#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200361
Gabor Mezei24c7c2b2022-05-10 12:51:14 +0200362#define MBEDTLS_TLS_SIG_NONE MBEDTLS_TLS1_3_SIG_NONE
363
Gabor Mezei15b95a62022-05-09 16:37:58 +0200364#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +0100365#define MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG(sig, hash) ((hash << 8) | sig)
Gabor Mezei3631cf62022-05-10 12:59:00 +0200366#define MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg & 0xFF)
367#define MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg >> 8)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200368#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
369
Ronald Crone68ab4f2022-10-05 12:46:29 +0200370#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei15b95a62022-05-09 16:37:58 +0200371
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200372/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100373 * Check that we obey the standard's message size bounds
374 */
375
David Horstmann95d516f2021-05-04 18:36:56 +0100376#if MBEDTLS_SSL_IN_CONTENT_LEN > 16384
377#error "Bad configuration - incoming record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100378#endif
379
David Horstmann95d516f2021-05-04 18:36:56 +0100380#if MBEDTLS_SSL_OUT_CONTENT_LEN > 16384
381#error "Bad configuration - outgoing record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100382#endif
383
David Horstmann95d516f2021-05-04 18:36:56 +0100384#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000385#error "Bad configuration - incoming protected record payload too large."
386#endif
387
David Horstmann95d516f2021-05-04 18:36:56 +0100388#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000389#error "Bad configuration - outgoing protected record payload too large."
390#endif
391
392/* Calculate buffer sizes */
393
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000394/* Note: Even though the TLS record header is only 5 bytes
395 long, we're internally using 8 bytes to store the
396 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100397#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100398
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500399#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000400#define MBEDTLS_SSL_IN_BUFFER_LEN \
Gilles Peskine449bd832023-01-11 14:50:10 +0100401 ((MBEDTLS_SSL_HEADER_LEN) + (MBEDTLS_SSL_IN_PAYLOAD_LEN))
Hanno Becker6cbad552019-05-08 15:40:11 +0100402#else
403#define MBEDTLS_SSL_IN_BUFFER_LEN \
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 ((MBEDTLS_SSL_HEADER_LEN) + (MBEDTLS_SSL_IN_PAYLOAD_LEN) \
405 + (MBEDTLS_SSL_CID_IN_LEN_MAX))
Hanno Becker6cbad552019-05-08 15:40:11 +0100406#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000407
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500408#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000409#define MBEDTLS_SSL_OUT_BUFFER_LEN \
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 ((MBEDTLS_SSL_HEADER_LEN) + (MBEDTLS_SSL_OUT_PAYLOAD_LEN))
Hanno Becker6cbad552019-05-08 15:40:11 +0100411#else
412#define MBEDTLS_SSL_OUT_BUFFER_LEN \
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 ((MBEDTLS_SSL_HEADER_LEN) + (MBEDTLS_SSL_OUT_PAYLOAD_LEN) \
414 + (MBEDTLS_SSL_CID_OUT_LEN_MAX))
Hanno Becker6cbad552019-05-08 15:40:11 +0100415#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000416
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800417#define MBEDTLS_CLIENT_HELLO_RANDOM_LEN 32
418#define MBEDTLS_SERVER_HELLO_RANDOM_LEN 32
419
Hanno Becker9752aad2021-04-21 05:54:33 +0100420#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
421/**
422 * \brief Return the maximum fragment length (payload, in bytes) for
423 * the output buffer. For the client, this is the configured
424 * value. For the server, it is the minimum of two - the
425 * configured value and the negotiated one.
426 *
427 * \sa mbedtls_ssl_conf_max_frag_len()
428 * \sa mbedtls_ssl_get_max_out_record_payload()
429 *
430 * \param ssl SSL context
431 *
432 * \return Current maximum fragment length for the output buffer.
433 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100434size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl);
Hanno Becker9752aad2021-04-21 05:54:33 +0100435
436/**
437 * \brief Return the maximum fragment length (payload, in bytes) for
438 * the input buffer. This is the negotiated maximum fragment
Hanno Beckerdf3b8632021-06-08 05:30:45 +0100439 * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN.
Hanno Becker9752aad2021-04-21 05:54:33 +0100440 * If it is not defined either, the value is 2^14. This function
441 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
442 *
443 * \sa mbedtls_ssl_conf_max_frag_len()
444 * \sa mbedtls_ssl_get_max_in_record_payload()
445 *
446 * \param ssl SSL context
447 *
448 * \return Current maximum fragment length for the output buffer.
449 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100450size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl);
Hanno Becker9752aad2021-04-21 05:54:33 +0100451#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
452
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500453#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Gilles Peskine449bd832023-01-11 14:50:10 +0100454static inline size_t mbedtls_ssl_get_output_buflen(const mbedtls_ssl_context *ctx)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500455{
Gilles Peskine449bd832023-01-11 14:50:10 +0100456#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
457 return mbedtls_ssl_get_output_max_frag_len(ctx)
458 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
459 + MBEDTLS_SSL_CID_OUT_LEN_MAX;
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500460#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100461 return mbedtls_ssl_get_output_max_frag_len(ctx)
462 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500463#endif
464}
465
Gilles Peskine449bd832023-01-11 14:50:10 +0100466static inline size_t mbedtls_ssl_get_input_buflen(const mbedtls_ssl_context *ctx)
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500467{
Gilles Peskine449bd832023-01-11 14:50:10 +0100468#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
469 return mbedtls_ssl_get_input_max_frag_len(ctx)
470 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
471 + MBEDTLS_SSL_CID_IN_LEN_MAX;
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500472#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100473 return mbedtls_ssl_get_input_max_frag_len(ctx)
474 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500475#endif
476}
477#endif
478
Hanno Beckera8434e82017-09-18 10:54:39 +0100479/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200480 * TLS extension flags (for extensions with outgoing ServerHello content
481 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
482 * of state of the renegotiation flag, so no indicator is required)
483 */
484#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200485#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200486
Hanno Becker51018aa2017-04-12 14:54:42 +0100487/**
488 * \brief This function checks if the remaining size in a buffer is
489 * greater or equal than a needed space.
490 *
491 * \param cur Pointer to the current position in the buffer.
492 * \param end Pointer to one past the end of the buffer.
493 * \param need Needed space in bytes.
494 *
Ronald Cronb7b35e12020-06-11 09:50:51 +0200495 * \return Zero if the needed space is available in the buffer, non-zero
Hanno Becker51018aa2017-04-12 14:54:42 +0100496 * otherwise.
497 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100498#if !defined(MBEDTLS_TEST_HOOKS)
499static inline int mbedtls_ssl_chk_buf_ptr(const uint8_t *cur,
500 const uint8_t *end, size_t need)
Hanno Becker51018aa2017-04-12 14:54:42 +0100501{
Gilles Peskine449bd832023-01-11 14:50:10 +0100502 return (cur > end) || (need > (size_t) (end - cur));
Hanno Becker51018aa2017-04-12 14:54:42 +0100503}
Ronald Cronad8c17b2022-06-10 17:18:09 +0200504#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100505typedef struct {
Ronald Cronad8c17b2022-06-10 17:18:09 +0200506 const uint8_t *cur;
507 const uint8_t *end;
508 size_t need;
509} mbedtls_ssl_chk_buf_ptr_args;
510
511void mbedtls_ssl_set_chk_buf_ptr_fail_args(
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 const uint8_t *cur, const uint8_t *end, size_t need);
513void mbedtls_ssl_reset_chk_buf_ptr_fail_args(void);
Ronald Cronce7d76e2022-07-08 18:56:49 +0200514
515MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100516int mbedtls_ssl_cmp_chk_buf_ptr_fail_args(mbedtls_ssl_chk_buf_ptr_args *args);
Ronald Cronad8c17b2022-06-10 17:18:09 +0200517
Gilles Peskine449bd832023-01-11 14:50:10 +0100518static inline int mbedtls_ssl_chk_buf_ptr(const uint8_t *cur,
519 const uint8_t *end, size_t need)
Ronald Cronad8c17b2022-06-10 17:18:09 +0200520{
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 if ((cur > end) || (need > (size_t) (end - cur))) {
522 mbedtls_ssl_set_chk_buf_ptr_fail_args(cur, end, need);
523 return 1;
Ronald Cronad8c17b2022-06-10 17:18:09 +0200524 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 return 0;
Ronald Cronad8c17b2022-06-10 17:18:09 +0200526}
Ronald Croncf600bc2022-06-17 15:54:16 +0200527#endif /* MBEDTLS_TEST_HOOKS */
Hanno Becker51018aa2017-04-12 14:54:42 +0100528
529/**
530 * \brief This macro checks if the remaining size in a buffer is
531 * greater or equal than a needed space. If it is not the case,
532 * it returns an SSL_BUFFER_TOO_SMALL error.
533 *
534 * \param cur Pointer to the current position in the buffer.
535 * \param end Pointer to one past the end of the buffer.
536 * \param need Needed space in bytes.
537 *
538 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100539#define MBEDTLS_SSL_CHK_BUF_PTR(cur, end, need) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100540 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 if (mbedtls_ssl_chk_buf_ptr((cur), (end), (need)) != 0) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100542 { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL; \
Hanno Becker51018aa2017-04-12 14:54:42 +0100544 } \
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 } while (0)
Hanno Becker51018aa2017-04-12 14:54:42 +0100546
Jerry Yu34da3722021-09-19 18:05:08 +0800547/**
Jerry Yue15e6652021-09-28 21:06:07 +0800548 * \brief This macro checks if the remaining length in an input buffer is
549 * greater or equal than a needed length. If it is not the case, it
Jerry Yu205fd822021-10-08 16:16:24 +0800550 * returns #MBEDTLS_ERR_SSL_DECODE_ERROR error and pends a
Jerry Yudca3d5d2021-10-08 14:19:29 +0800551 * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message.
Jerry Yue4eefc72021-10-09 10:40:40 +0800552 *
553 * This is a function-like macro. It is guaranteed to evaluate each
554 * argument exactly once.
Jerry Yu34da3722021-09-19 18:05:08 +0800555 *
556 * \param cur Pointer to the current position in the buffer.
557 * \param end Pointer to one past the end of the buffer.
Jerry Yue15e6652021-09-28 21:06:07 +0800558 * \param need Needed length in bytes.
Jerry Yu34da3722021-09-19 18:05:08 +0800559 *
560 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100561#define MBEDTLS_SSL_CHK_BUF_READ_PTR(cur, end, need) \
Jerry Yu34da3722021-09-19 18:05:08 +0800562 do { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 if (mbedtls_ssl_chk_buf_ptr((cur), (end), (need)) != 0) \
Jerry Yu34da3722021-09-19 18:05:08 +0800564 { \
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 MBEDTLS_SSL_DEBUG_MSG(1, \
566 ("missing input data in %s", __func__)); \
567 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \
568 MBEDTLS_ERR_SSL_DECODE_ERROR); \
569 return MBEDTLS_ERR_SSL_DECODE_ERROR; \
Jerry Yu34da3722021-09-19 18:05:08 +0800570 } \
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 } while (0)
Jerry Yu34da3722021-09-19 18:05:08 +0800572
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200573#ifdef __cplusplus
574extern "C" {
575#endif
576
Gilles Peskine449bd832023-01-11 14:50:10 +0100577typedef int mbedtls_ssl_tls_prf_cb(const unsigned char *secret, size_t slen,
578 const char *label,
579 const unsigned char *random, size_t rlen,
580 unsigned char *dstbuf, size_t dlen);
Hanno Becker3385a4d2020-08-21 13:03:34 +0100581
Hanno Becker61baae72020-09-16 09:24:14 +0100582/* cipher.h exports the maximum IV, key and block length from
Hanno Becker15889832020-09-08 11:29:11 +0100583 * all ciphers enabled in the config, regardless of whether those
584 * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled
585 * in the default configuration and uses 64 Byte keys, but it is
586 * not used for record protection in SSL/TLS.
587 *
588 * In order to prevent unnecessary inflation of key structures,
589 * we introduce SSL-specific variants of the max-{key,block,IV}
590 * macros here which are meant to only take those ciphers into
591 * account which can be negotiated in SSL/TLS.
592 *
593 * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH
594 * in cipher.h are rough overapproximations of the real maxima, here
Hanno Becker9a7a2ac2020-09-09 09:24:54 +0100595 * we content ourselves with replicating those overapproximations
Hanno Becker15889832020-09-08 11:29:11 +0100596 * for the maximum block and IV length, and excluding XTS from the
597 * computation of the maximum key length. */
598#define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16
599#define MBEDTLS_SSL_MAX_IV_LENGTH 16
600#define MBEDTLS_SSL_MAX_KEY_LENGTH 32
601
Hanno Becker3385a4d2020-08-21 13:03:34 +0100602/**
603 * \brief The data structure holding the cryptographic material (key and IV)
604 * used for record protection in TLS 1.3.
605 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100606struct mbedtls_ssl_key_set {
Hanno Becker3385a4d2020-08-21 13:03:34 +0100607 /*! The key for client->server records. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 unsigned char client_write_key[MBEDTLS_SSL_MAX_KEY_LENGTH];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100609 /*! The key for server->client records. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 unsigned char server_write_key[MBEDTLS_SSL_MAX_KEY_LENGTH];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100611 /*! The IV for client->server records. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 unsigned char client_write_iv[MBEDTLS_SSL_MAX_IV_LENGTH];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100613 /*! The IV for server->client records. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 unsigned char server_write_iv[MBEDTLS_SSL_MAX_IV_LENGTH];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100615
Hanno Becker493ea7f2020-09-08 11:01:00 +0100616 size_t key_len; /*!< The length of client_write_key and
617 * server_write_key, in Bytes. */
618 size_t iv_len; /*!< The length of client_write_iv and
619 * server_write_iv, in Bytes. */
Hanno Becker3385a4d2020-08-21 13:03:34 +0100620};
621typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100622
Gilles Peskine449bd832023-01-11 14:50:10 +0100623typedef struct {
624 unsigned char binder_key[MBEDTLS_TLS1_3_MD_MAX_SIZE];
625 unsigned char client_early_traffic_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
626 unsigned char early_exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000627} mbedtls_ssl_tls13_early_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800628
Gilles Peskine449bd832023-01-11 14:50:10 +0100629typedef struct {
630 unsigned char client_handshake_traffic_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
631 unsigned char server_handshake_traffic_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000632} mbedtls_ssl_tls13_handshake_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800633
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200634/*
635 * This structure contains the parameters only needed during handshake.
636 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100637struct mbedtls_ssl_handshake_params {
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100638 /* Frequently-used boolean or byte fields (placed early to take
639 * advantage of smaller code size for indirect access on Arm Thumb) */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100640 uint8_t resume; /*!< session resume indicator*/
641 uint8_t cli_exts; /*!< client extension presence*/
642
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400643#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
644 uint8_t sni_authmode; /*!< authmode from SNI callback */
645#endif
646
XiaokangQian189ded22022-05-10 08:12:17 +0000647#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQianc3017f62022-05-13 05:55:41 +0000648 /* Flag indicating if a CertificateRequest message has been sent
649 * to the client or not. */
XiaokangQian63e713e2022-05-15 04:26:57 +0000650 uint8_t certificate_request_sent;
XiaokangQian189ded22022-05-10 08:12:17 +0000651#endif /* MBEDTLS_SSL_SRV_C */
652
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400653#if defined(MBEDTLS_SSL_SESSION_TICKETS)
654 uint8_t new_session_ticket; /*!< use NewSessionTicket? */
655#endif /* MBEDTLS_SSL_SESSION_TICKETS */
656
Ronald Cron82c785f2022-03-31 15:44:41 +0200657#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron217d6992022-04-04 10:23:22 +0200658 /** Minimum TLS version to be negotiated.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200659 *
Ronald Cron217d6992022-04-04 10:23:22 +0200660 * It is set up in the ClientHello writing preparation stage and used
661 * throughout the ClientHello writing. Not relevant anymore as soon as
662 * the protocol version has been negotiated thus as soon as the
663 * ServerHello is received.
664 * For a fresh handshake not linked to any previous handshake, it is
665 * equal to the configured minimum minor version to be negotiated. When
666 * renegotiating or resuming a session, it is equal to the previously
667 * negotiated minor version.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200668 *
Ronald Cron217d6992022-04-04 10:23:22 +0200669 * There is no maximum TLS version field in this handshake context.
670 * From the start of the handshake, we need to define a current protocol
671 * version for the record layer which we define as the maximum TLS
672 * version to be negotiated. The `tls_version` field of the SSL context is
673 * used to store this maximum value until it contains the actual
674 * negotiated value.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200675 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400676 mbedtls_ssl_protocol_version min_tls_version;
Ronald Cron82c785f2022-03-31 15:44:41 +0200677#endif
Ronald Cron86a477f2022-02-18 17:45:10 +0100678
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100679#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
680 uint8_t extended_ms; /*!< use Extended Master Secret? */
681#endif
682
683#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
684 uint8_t async_in_progress; /*!< an asynchronous operation is in progress */
685#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
686
687#if defined(MBEDTLS_SSL_PROTO_DTLS)
688 unsigned char retransmit_state; /*!< Retransmission state */
689#endif
690
Gilles Peskine41139a22021-12-08 18:25:39 +0100691#if !defined(MBEDTLS_DEPRECATED_REMOVED)
692 unsigned char group_list_heap_allocated;
Jerry Yuf017ee42022-01-12 15:49:48 +0800693 unsigned char sig_algs_heap_allocated;
Gilles Peskine41139a22021-12-08 18:25:39 +0100694#endif
695
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100696#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
697 uint8_t ecrs_enabled; /*!< Handshake supports EC restart? */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100698 enum { /* this complements ssl->state with info on intra-state operations */
699 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
700 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
701 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
702 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
703 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
704 } ecrs_state; /*!< current (or last) operation */
705 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
706 size_t ecrs_n; /*!< place for saving a length */
707#endif
708
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100709 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
710
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100711 MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100712 int (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100713 MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100714 int (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100715 MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +0100716 int (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100717 mbedtls_ssl_tls_prf_cb *tls_prf;
718
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200719 /*
720 * Handshake specific crypto variables
721 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100722#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron85385492022-07-20 16:44:00 +0200723 uint8_t key_exchange_mode; /*!< Selected key exchange mode */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100724
Jerry Yu6a2cd9e2022-05-05 11:14:19 +0800725 /** Number of HelloRetryRequest messages received/sent from/to the server. */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000726 int hello_retry_request_count;
Ronald Cronbc817ba2022-07-21 09:35:20 +0200727
XiaokangQian08037552022-04-20 07:16:41 +0000728#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQian318dc762022-04-20 09:43:51 +0000729 /** selected_group of key_share extension in HelloRetryRequest message. */
XiaokangQian08037552022-04-20 07:16:41 +0000730 uint16_t hrr_selected_group;
Ronald Cron41a443a2022-10-04 16:38:25 +0200731#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cronbc817ba2022-07-21 09:35:20 +0200732 uint8_t tls13_kex_modes; /*!< Key exchange modes supported by the client */
733#endif
Jerry Yud4e75002022-08-09 13:33:50 +0800734#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf3bdf9d2022-09-22 23:30:49 +0800735 uint16_t new_session_tickets_count; /*!< number of session tickets */
Jerry Yud4e75002022-08-09 13:33:50 +0800736#endif
XiaokangQian08037552022-04-20 07:16:41 +0000737#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cronbc817ba2022-07-21 09:35:20 +0200738
Jerry Yu582dd062022-04-22 21:59:01 +0800739#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian08037552022-04-20 07:16:41 +0000740
Ronald Crone68ab4f2022-10-05 12:46:29 +0200741#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000742 uint16_t received_sig_algs[MBEDTLS_RECEIVED_SIG_ALGS_SIZE];
743#endif
744
Gilles Peskine41139a22021-12-08 18:25:39 +0100745#if !defined(MBEDTLS_DEPRECATED_REMOVED)
746 const uint16_t *group_list;
Jerry Yuf017ee42022-01-12 15:49:48 +0800747 const uint16_t *sig_algs;
Gilles Peskine41139a22021-12-08 18:25:39 +0100748#endif
749
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200750#if defined(MBEDTLS_DHM_C)
751 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
752#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100753
Valerio Setti77a904c2023-03-24 07:28:49 +0100754#if defined(MBEDTLS_ECDH_C) && !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200755 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
Valerio Setti77a904c2023-03-24 07:28:49 +0100756#endif /* MBEDTLS_ECDH_C && !MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000757
Valerio Setti226f9b92023-03-23 08:36:00 +0100758#if defined(PSA_WANT_ALG_ECDH) && \
759 (defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3))
Gilles Peskine42459802019-12-19 13:31:53 +0100760 psa_key_type_t ecdh_psa_type;
Neil Armstrong91477a72022-03-25 15:42:20 +0100761 size_t ecdh_bits;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100762 mbedtls_svc_key_id_t ecdh_psa_privkey;
Neil Armstrongf716a702022-04-04 11:23:46 +0200763 uint8_t ecdh_psa_privkey_is_external;
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000764 unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH];
765 size_t ecdh_psa_peerkey_len;
Valerio Setti226f9b92023-03-23 08:36:00 +0100766#endif /* PSA_WANT_ALG_ECDH &&
767 (MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3) */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000768
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200769#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Neil Armstrongca7d5062022-05-31 14:43:23 +0200770#if defined(MBEDTLS_USE_PSA_CRYPTO)
771 psa_pake_operation_t psa_pake_ctx; /*!< EC J-PAKE key exchange */
772 mbedtls_svc_key_id_t psa_pake_password;
773 uint8_t psa_pake_ctx_is_ok;
774#else
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200775 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Neil Armstrongca7d5062022-05-31 14:43:23 +0200776#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200777#if defined(MBEDTLS_SSL_CLI_C)
778 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
779 size_t ecjpake_cache_len; /*!< Length of cached data */
780#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100781#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100782
Valerio Setti1fa5c562023-03-20 13:56:38 +0100783#if defined(MBEDTLS_PK_CAN_ECDH) || defined(MBEDTLS_PK_CAN_ECDSA_SOME) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200784 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Valerio Setti18c9fed2022-12-30 17:44:24 +0100785 uint16_t *curves_tls_id; /*!< List of TLS IDs of supported elliptic curves */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200786#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100787
Ronald Cron73fe8df2022-10-05 14:31:43 +0200788#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100789#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +0100790 mbedtls_svc_key_id_t psk_opaque; /*!< Opaque PSK from the callback */
Neil Armstrong501c9322022-05-03 09:35:09 +0200791 uint8_t psk_opaque_is_internal;
Neil Armstronge952a302022-05-03 10:22:14 +0200792#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200793 unsigned char *psk; /*!< PSK from the callback */
794 size_t psk_len; /*!< Length of PSK from callback */
Neil Armstronge952a302022-05-03 10:22:14 +0200795#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu96a2e362022-07-21 15:11:34 +0800796 uint16_t selected_identity;
Ronald Cron73fe8df2022-10-05 14:31:43 +0200797#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100798
Gilles Peskinecfe74a32021-12-08 18:38:51 +0100799#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
800 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
801#endif
802
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200803#if defined(MBEDTLS_X509_CRT_PARSE_C)
804 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
805#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
806 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
807 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
808 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100809#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200810#endif /* MBEDTLS_X509_CRT_PARSE_C */
Gilles Peskine8716f172021-11-16 15:21:44 +0100811
Gilles Peskine8716f172021-11-16 15:21:44 +0100812#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Hanno Becker75173122019-02-06 16:18:31 +0000813 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
814 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
815#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker2f28c102019-04-25 15:46:59 +0100816
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 struct {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100818 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
819 * buffers used for message buffering. */
820
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100821 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100822 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100823
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 struct mbedtls_ssl_hs_buffer {
Hanno Becker98081a02018-08-22 13:32:50 +0100825 unsigned is_valid : 1;
826 unsigned is_fragmented : 1;
827 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100828 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100829 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100830 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 struct {
Hanno Becker5f066e72018-08-16 14:56:31 +0100833 unsigned char *data;
834 size_t len;
835 unsigned epoch;
836 } future_record;
837
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100838 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100839
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000840#if defined(MBEDTLS_SSL_CLI_C) && \
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 (defined(MBEDTLS_SSL_PROTO_DTLS) || \
842 defined(MBEDTLS_SSL_PROTO_TLS1_3))
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800843 unsigned char *cookie; /*!< HelloVerifyRequest cookie for DTLS
844 * HelloRetryRequest cookie for TLS 1.3 */
845#if !defined(MBEDTLS_SSL_PROTO_TLS1_3)
846 /* RFC 6347 page 15
847 ...
848 opaque cookie<0..2^8-1>;
849 ...
850 */
851 uint8_t cookie_len;
852#else
853 /* RFC 8446 page 39
854 ...
855 opaque cookie<0..2^16-1>;
856 ...
857 If TLS1_3 is enabled, the max length is 2^16 - 1
858 */
859 uint16_t cookie_len; /*!< DTLS: HelloVerifyRequest cookie length
860 * TLS1_3: HelloRetryRequest cookie length */
861#endif
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000862#endif /* MBEDTLS_SSL_CLI_C &&
Jerry Yuac5ca5a2022-03-04 12:50:46 +0800863 ( MBEDTLS_SSL_PROTO_DTLS ||
864 MBEDTLS_SSL_PROTO_TLS1_3 ) */
865#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_DTLS)
866 unsigned char cookie_verify_result; /*!< Srv: flag for sending a cookie */
867#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_DTLS */
XiaokangQian52da5582022-01-26 09:49:29 +0000868
869#if defined(MBEDTLS_SSL_PROTO_DTLS)
870 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
871 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100872
873 uint32_t retransmit_timeout; /*!< Current value of timeout */
874 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
875 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
876 unsigned char *cur_msg_p; /*!< Position in current message */
877 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
878 flight being received */
879 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 resending messages */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100881 unsigned char alt_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Alternative record epoch/counter
882 for resending messages */
883
884#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
885 /* The state of CID configuration in this handshake. */
886
887 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
888 * has been negotiated. Possible values are
889 * #MBEDTLS_SSL_CID_ENABLED and
890 * #MBEDTLS_SSL_CID_DISABLED. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX]; /*! The peer's CID */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100892 uint8_t peer_cid_len; /*!< The length of
893 * \c peer_cid. */
894#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
895
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200896 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100897#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200898
899 /*
900 * Checksum contexts
901 */
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100902#if defined(MBEDTLS_MD_CAN_SHA256)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500903#if defined(MBEDTLS_USE_PSA_CRYPTO)
904 psa_hash_operation_t fin_sha256_psa;
905#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100906 mbedtls_md_context_t fin_sha256;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200907#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500908#endif
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +0100909#if defined(MBEDTLS_MD_CAN_SHA384)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500910#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500911 psa_hash_operation_t fin_sha384_psa;
Andrzej Kurekeb342242019-01-29 09:14:33 -0500912#else
Manuel Pégourié-Gonnardf057ecf2023-02-24 13:19:17 +0100913 mbedtls_md_context_t fin_sha384;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200914#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500915#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200916
Ronald Cron6f135e12021-12-08 16:57:54 +0100917#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800918 uint16_t offered_group_id; /* The NamedGroup value for the group
919 * that is being used for ephemeral
920 * key exchange.
921 *
922 * On the client: Defaults to the first
923 * entry in the client's group list,
924 * but can be overwritten by the HRR. */
Ronald Cron6f135e12021-12-08 16:57:54 +0100925#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800926
Jerry Yufb28b882022-01-28 11:05:58 +0800927#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yu2d9a6942022-02-08 21:07:10 +0800928 uint8_t client_auth; /*!< used to check if CertificateRequest has been
Jerry Yu5c7d1cc2022-02-08 21:08:29 +0800929 received from server side. If CertificateRequest
Jerry Yu0ff8ac82022-02-08 10:10:48 +0800930 has been received, Certificate and CertificateVerify
Jerry Yufb28b882022-01-28 11:05:58 +0800931 should be sent to server */
932#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000933 /*
934 * State-local variables used during the processing
935 * of a specific handshake state.
936 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 union {
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000938 /* Outgoing Finished message */
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 struct {
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000940 uint8_t preparation_done;
941
942 /* Buffer holding digest of the handshake up to
943 * but excluding the outgoing finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000944 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000945 size_t digest_len;
946 } finished_out;
947
948 /* Incoming Finished message */
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 struct {
XiaokangQian57b2aff2021-11-10 03:12:11 +0000950 uint8_t preparation_done;
951
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000952 /* Buffer holding digest of the handshake up to but
953 * excluding the peer's incoming finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000954 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000955 size_t digest_len;
956 } finished_in;
957
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000958 } state_local;
959
960 /* End of state-local variables. */
961
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800962 unsigned char randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN +
963 MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 /*!< random bytes */
Ronald Cron3b056202022-10-05 17:20:21 +0200965#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200966 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
Gilles Peskine449bd832023-01-11 14:50:10 +0100967 /*!< premaster secret */
Ronald Cron3b056202022-10-05 17:20:21 +0200968 size_t pmslen; /*!< premaster length */
969#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200970
Ronald Cron6f135e12021-12-08 16:57:54 +0100971#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu0c354a22022-08-29 15:25:36 +0800972 uint32_t sent_extensions; /*!< extensions sent by endpoint */
973 uint32_t received_extensions; /*!< extensions received by endpoint */
Jerry Yu89ea3212021-09-09 14:31:24 +0800974
Ronald Crone68ab4f2022-10-05 12:46:29 +0200975#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baia0ab7772022-01-16 12:14:45 +0000976 unsigned char certificate_request_context_len;
977 unsigned char *certificate_request_context;
Xiaofei Baie1e34422021-12-23 12:09:05 +0000978#endif
979
Jerry Yu3d9b5902022-11-04 14:07:25 +0800980 /** TLS 1.3 transform for encrypted handshake messages. */
981 mbedtls_ssl_transform *transform_handshake;
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 union {
983 unsigned char early[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Jerry Yud1ab2622021-10-08 15:36:57 +0800984 unsigned char handshake[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 unsigned char app[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Baid25fab62021-12-02 06:36:27 +0000986 } tls13_master_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800987
Xiaofei Bai746f9482021-11-12 08:53:56 +0000988 mbedtls_ssl_tls13_handshake_secrets tls13_hs_secrets;
Jerry Yu3d9b5902022-11-04 14:07:25 +0800989#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu3ce61ff2022-11-21 22:45:58 +0800990 /** TLS 1.3 transform for early data and handshake messages. */
Jerry Yu3d9b5902022-11-04 14:07:25 +0800991 mbedtls_ssl_transform *transform_earlydata;
992#endif
Ronald Cron6f135e12021-12-08 16:57:54 +0100993#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200994
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200995#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
996 /** Asynchronous operation context. This field is meant for use by the
997 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
998 * mbedtls_ssl_config::f_async_decrypt_start,
999 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
1000 * The library does not use it internally. */
1001 void *user_async_ctx;
1002#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Glenn Strauss69894072022-01-24 12:58:00 -05001003
1004#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1005 const unsigned char *sni_name; /*!< raw SNI */
1006 size_t sni_name_len; /*!< raw SNI len */
Glenn Strauss999ef702022-03-11 01:37:23 -05001007#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1008 const mbedtls_x509_crt *dn_hints; /*!< acceptable client cert issuers */
1009#endif
Glenn Strauss69894072022-01-24 12:58:00 -05001010#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001011};
1012
Hanno Becker0271f962018-08-16 13:23:47 +01001013typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
1014
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001015/*
Hanno Beckerd362dc52018-01-03 15:23:11 +00001016 * Representation of decryption/encryption transformations on records
1017 *
1018 * There are the following general types of record transformations:
TRodziewicz2abf03c2021-06-25 14:40:09 +02001019 * - Stream transformations (TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001020 * Transformation adding a MAC and applying a stream-cipher
1021 * to the authenticated message.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001022 * - CBC block cipher transformations ([D]TLS versions == 1.2 only)
1023 * For TLS 1.2, no IV is generated at key extraction time, but every
1024 * encrypted record is explicitly prefixed by the IV with which it was
1025 * encrypted.
1026 * - AEAD transformations ([D]TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001027 * These come in two fundamentally different versions, the first one
1028 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
1029 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
1030 * In the first transformation, the IV to be used for a record is obtained
1031 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
1032 * record sequence number, and explicitly prepending this sequence number
1033 * to the encrypted record. In contrast, in the second transformation
1034 * the IV is obtained by XOR'ing a static IV obtained at key extraction
1035 * time with the 8-byte record sequence number, without prepending the
1036 * latter to the encrypted record.
1037 *
Hanno Becker7d343ec2020-05-04 12:29:05 +01001038 * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext
1039 * which allows to add flexible length padding and to hide a record's true
1040 * content type.
1041 *
Hanno Beckerd362dc52018-01-03 15:23:11 +00001042 * In addition to type and version, the following parameters are relevant:
1043 * - The symmetric cipher algorithm to be used.
1044 * - The (static) encryption/decryption keys for the cipher.
1045 * - For stream/CBC, the type of message digest to be used.
1046 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Becker0db7e0c2018-10-18 15:39:53 +01001047 * - For AEAD transformations, the size (potentially 0) of an explicit,
1048 * random initialization vector placed in encrypted records.
TRodziewicz299510e2021-07-09 16:55:11 +02001049 * - For some transformations (currently AEAD) an implicit IV. It is static
Hanno Beckerd362dc52018-01-03 15:23:11 +00001050 * and (if present) is combined with the explicit IV in a transformation-
TRodziewicz299510e2021-07-09 16:55:11 +02001051 * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
Hanno Beckerd362dc52018-01-03 15:23:11 +00001052 * - For stream/CBC, a flag determining the order of encryption and MAC.
1053 * - The details of the transformation depend on the SSL/TLS version.
1054 * - The length of the authentication tag.
1055 *
1056 * The struct below refines this abstract view as follows:
1057 * - The cipher underlying the transformation is managed in
1058 * cipher contexts cipher_ctx_{enc/dec}, which must have the
1059 * same cipher type. The mode of these cipher contexts determines
1060 * the type of the transformation in the sense above: e.g., if
1061 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
1062 * then the transformation has type CBC resp. AEAD.
1063 * - The cipher keys are never stored explicitly but
1064 * are maintained within cipher_ctx_{enc/dec}.
1065 * - For stream/CBC transformations, the message digest contexts
1066 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
1067 * are unused for AEAD transformations.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001068 * - For stream/CBC transformations, the MAC keys are not stored explicitly
1069 * but maintained within md_ctx_{enc/dec}.
1070 * - The mac_enc and mac_dec fields are unused for EAD transformations.
Hanno Beckerd362dc52018-01-03 15:23:11 +00001071 * - For transformations using an implicit IV maintained within
1072 * the transformation context, its contents are stored within
1073 * iv_{enc/dec}.
1074 * - The value of ivlen indicates the length of the IV.
1075 * This is redundant in case of stream/CBC transformations
1076 * which always use 0 resp. the cipher's block length as the
1077 * IV length, but is needed for AEAD ciphers and may be
1078 * different from the underlying cipher's block length
1079 * in this case.
1080 * - The field fixed_ivlen is nonzero for AEAD transformations only
1081 * and indicates the length of the static part of the IV which is
1082 * constant throughout the communication, and which is stored in
1083 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
Glenn Strauss07c64162022-03-14 12:34:51 -04001084 * - tls_version denotes the 2-byte TLS version
Hanno Beckerd362dc52018-01-03 15:23:11 +00001085 * - For stream/CBC transformations, maclen denotes the length of the
1086 * authentication tag, while taglen is unused and 0.
1087 * - For AEAD transformations, taglen denotes the length of the
1088 * authentication tag, while maclen is unused and 0.
1089 * - For CBC transformations, encrypt_then_mac determines the
1090 * order of encryption and authentication. This field is unused
1091 * in other transformations.
1092 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001093 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001094struct mbedtls_ssl_transform {
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001095 /*
1096 * Session specific crypto layer
1097 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001098 size_t minlen; /*!< min. ciphertext length */
1099 size_t ivlen; /*!< IV length */
1100 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Beckere694c3e2017-12-27 21:34:08 +00001101 size_t maclen; /*!< MAC(CBC) len */
1102 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001103
1104 unsigned char iv_enc[16]; /*!< IV (encryption) */
1105 unsigned char iv_dec[16]; /*!< IV (decryption) */
1106
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001107#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Hanno Beckerd56ed242018-01-03 15:32:51 +00001108
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001109#if defined(MBEDTLS_USE_PSA_CRYPTO)
1110 mbedtls_svc_key_id_t psa_mac_enc; /*!< MAC (encryption) */
1111 mbedtls_svc_key_id_t psa_mac_dec; /*!< MAC (decryption) */
1112 psa_algorithm_t psa_mac_alg; /*!< psa MAC algorithm */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001113#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001114 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
1115 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001116#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001117
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001118#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1119 int encrypt_then_mac; /*!< flag for EtM activation */
1120#endif
1121
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001122#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Beckerd56ed242018-01-03 15:32:51 +00001123
Glenn Strauss07c64162022-03-14 12:34:51 -04001124 mbedtls_ssl_protocol_version tls_version;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001125
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001126#if defined(MBEDTLS_USE_PSA_CRYPTO)
1127 mbedtls_svc_key_id_t psa_key_enc; /*!< psa encryption key */
1128 mbedtls_svc_key_id_t psa_key_dec; /*!< psa decryption key */
1129 psa_algorithm_t psa_alg; /*!< psa algorithm */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001130#else
1131 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
1132 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001133#endif /* MBEDTLS_USE_PSA_CRYPTO */
1134
Hanno Beckera0e20d02019-05-15 14:03:01 +01001135#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker1327fa72019-04-25 15:54:02 +01001136 uint8_t in_cid_len;
1137 uint8_t out_cid_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 unsigned char in_cid[MBEDTLS_SSL_CID_IN_LEN_MAX];
1139 unsigned char out_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX];
Hanno Beckera0e20d02019-05-15 14:03:01 +01001140#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1327fa72019-04-25 15:54:02 +01001141
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001142#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
1143 /* We need the Hello random bytes in order to re-derive keys from the
Hanno Beckerbd257552021-03-22 06:59:27 +00001144 * Master Secret and other session info,
1145 * see ssl_tls12_populate_transform() */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001146 unsigned char randbytes[MBEDTLS_SERVER_HELLO_RANDOM_LEN +
1147 MBEDTLS_CLIENT_HELLO_RANDOM_LEN];
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 /*!< ServerHello.random+ClientHello.random */
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001149#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001150};
1151
Hanno Becker12a3a862018-01-05 15:42:50 +00001152/*
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001153 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
1154 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
1155 */
1156static inline int mbedtls_ssl_transform_uses_aead(
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 const mbedtls_ssl_transform *transform)
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001158{
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001159#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 return transform->maclen == 0 && transform->taglen != 0;
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001161#else
1162 (void) transform;
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 return 1;
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001164#endif
1165}
1166
1167/*
Hanno Becker12a3a862018-01-05 15:42:50 +00001168 * Internal representation of record frames
1169 *
Hanno Becker12a3a862018-01-05 15:42:50 +00001170 * Instances come in two flavors:
1171 * (1) Encrypted
1172 * These always have data_offset = 0
1173 * (2) Unencrypted
Hanno Beckercd430bc2019-04-04 16:29:48 +01001174 * These have data_offset set to the amount of
1175 * pre-expansion during record protection. Concretely,
1176 * this is the length of the fixed part of the explicit IV
1177 * used for encryption, or 0 if no explicit IV is used
TRodziewicz2abf03c2021-06-25 14:40:09 +02001178 * (e.g. for stream ciphers).
Hanno Becker12a3a862018-01-05 15:42:50 +00001179 *
1180 * The reason for the data_offset in the unencrypted case
1181 * is to allow for in-place conversion of an unencrypted to
1182 * an encrypted record. If the offset wasn't included, the
1183 * encrypted content would need to be shifted afterwards to
1184 * make space for the fixed IV.
1185 *
1186 */
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001187#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker75f080f2019-04-30 15:01:51 +01001188#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001189#else
Hanno Becker75f080f2019-04-30 15:01:51 +01001190#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001191#endif
1192
Gilles Peskine449bd832023-01-11 14:50:10 +01001193typedef struct {
Jerry Yuae0b2e22021-10-08 15:21:19 +08001194 uint8_t ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /* In TLS: The implicit record sequence number.
1195 * In DTLS: The 2-byte epoch followed by
1196 * the 6-byte sequence number.
1197 * This is stored as a raw big endian byte array
1198 * as opposed to a uint64_t because we rarely
1199 * need to perform arithmetic on this, but do
1200 * need it as a Byte array for the purpose of
1201 * MAC computations. */
Hanno Beckerd840cea2019-07-11 09:24:36 +01001202 uint8_t type; /* The record content type. */
1203 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
1204 * Convert to internal presentation of versions
1205 * using mbedtls_ssl_read_version() and
1206 * mbedtls_ssl_write_version().
1207 * Keep wire-format for MAC computations. */
Hanno Becker12a3a862018-01-05 15:42:50 +00001208
Hanno Beckerd840cea2019-07-11 09:24:36 +01001209 unsigned char *buf; /* Memory buffer enclosing the record content */
1210 size_t buf_len; /* Buffer length */
1211 size_t data_offset; /* Offset of record content */
1212 size_t data_len; /* Length of record content */
Hanno Becker12a3a862018-01-05 15:42:50 +00001213
Hanno Beckera0e20d02019-05-15 14:03:01 +01001214#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd840cea2019-07-11 09:24:36 +01001215 uint8_t cid_len; /* Length of the CID (0 if not present) */
Gilles Peskine449bd832023-01-11 14:50:10 +01001216 unsigned char cid[MBEDTLS_SSL_CID_LEN_MAX]; /* The CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001217#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker12a3a862018-01-05 15:42:50 +00001218} mbedtls_record;
1219
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001220#if defined(MBEDTLS_X509_CRT_PARSE_C)
1221/*
1222 * List of certificate + private key pairs
1223 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001224struct mbedtls_ssl_key_cert {
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001225 mbedtls_x509_crt *cert; /*!< cert */
1226 mbedtls_pk_context *key; /*!< private key */
1227 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
1228};
1229#endif /* MBEDTLS_X509_CRT_PARSE_C */
1230
1231#if defined(MBEDTLS_SSL_PROTO_DTLS)
1232/*
1233 * List of handshake messages kept around for resending
1234 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001235struct mbedtls_ssl_flight_item {
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001236 unsigned char *p; /*!< message, including handshake headers */
1237 size_t len; /*!< length of p */
1238 unsigned char type; /*!< type of the message: handshake or CCS */
1239 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
1240};
1241#endif /* MBEDTLS_SSL_PROTO_DTLS */
1242
Ronald Cron4079abc2022-02-20 10:35:26 +01001243#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1244/**
1245 * \brief Given an SSL context and its associated configuration, write the TLS
1246 * 1.2 specific extensions of the ClientHello message.
1247 *
1248 * \param[in] ssl SSL context
1249 * \param[in] buf Base address of the buffer where to write the extensions
1250 * \param[in] end End address of the buffer where to write the extensions
1251 * \param uses_ec Whether one proposed ciphersuite uses an elliptic curve
1252 * (<> 0) or not ( 0 ).
1253 * \param[out] out_len Length of the data written into the buffer \p buf
1254 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001255MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001256int mbedtls_ssl_tls12_write_client_hello_exts(mbedtls_ssl_context *ssl,
1257 unsigned char *buf,
1258 const unsigned char *end,
1259 int uses_ec,
1260 size_t *out_len);
Ronald Cron4079abc2022-02-20 10:35:26 +01001261#endif
1262
Hanno Becker7e5437a2017-04-28 17:15:26 +01001263#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01001264 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01001265
Gabor Mezeia3d016c2022-05-10 12:44:09 +02001266/**
1267 * \brief Find the preferred hash for a given signature algorithm.
1268 *
1269 * \param[in] ssl SSL context
1270 * \param[in] sig_alg A signature algorithm identifier as defined in the
1271 * TLS 1.2 SignatureAlgorithm enumeration.
1272 *
1273 * \return The preferred hash algorithm for \p sig_alg. It is a hash algorithm
1274 * identifier as defined in the TLS 1.2 HashAlgorithm enumeration.
1275 */
1276unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01001277 mbedtls_ssl_context *ssl,
1278 unsigned int sig_alg);
Hanno Becker7e5437a2017-04-28 17:15:26 +01001279
Gabor Mezei078e8032022-04-27 21:17:56 +02001280#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01001281 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001282
1283/**
1284 * \brief Free referenced items in an SSL transform context and clear
1285 * memory
1286 *
1287 * \param transform SSL transform context
1288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001289void mbedtls_ssl_transform_free(mbedtls_ssl_transform *transform);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001290
1291/**
1292 * \brief Free referenced items in an SSL handshake context and clear
1293 * memory
1294 *
Gilles Peskine9b562d52018-04-25 20:32:43 +02001295 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001296 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001297void mbedtls_ssl_handshake_free(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001298
Jerry Yuc7875b52021-09-05 21:05:50 +08001299/* set inbound transform of ssl context */
Gilles Peskine449bd832023-01-11 14:50:10 +01001300void mbedtls_ssl_set_inbound_transform(mbedtls_ssl_context *ssl,
1301 mbedtls_ssl_transform *transform);
Jerry Yuc7875b52021-09-05 21:05:50 +08001302
1303/* set outbound transform of ssl context */
Gilles Peskine449bd832023-01-11 14:50:10 +01001304void mbedtls_ssl_set_outbound_transform(mbedtls_ssl_context *ssl,
1305 mbedtls_ssl_transform *transform);
Jerry Yuc7875b52021-09-05 21:05:50 +08001306
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001308int mbedtls_ssl_handshake_client_step(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001309MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001310int mbedtls_ssl_handshake_server_step(mbedtls_ssl_context *ssl);
1311void mbedtls_ssl_handshake_wrapup(mbedtls_ssl_context *ssl);
1312static inline void mbedtls_ssl_handshake_set_state(mbedtls_ssl_context *ssl,
1313 mbedtls_ssl_states state)
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001314{
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 ssl->state = (int) state;
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001316}
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001317
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001319int mbedtls_ssl_send_fatal_handshake_failure(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001320
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001321MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard226aa152023-02-05 09:46:59 +01001322int mbedtls_ssl_reset_checksum(mbedtls_ssl_context *ssl);
Jerry Yubef175d2022-01-28 10:52:05 +08001323
1324#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001325MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001326int mbedtls_ssl_derive_keys(mbedtls_ssl_context *ssl);
Jerry Yubef175d2022-01-28 10:52:05 +08001327#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001328
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001329MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001330int mbedtls_ssl_handle_message_type(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001331MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001332int mbedtls_ssl_prepare_handshake_record(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001333MBEDTLS_CHECK_RETURN_CRITICAL
1334int mbedtls_ssl_update_handshake_status(mbedtls_ssl_context *ssl);
Simon Butcher99000142016-10-13 17:21:01 +01001335
Hanno Becker4a810fb2017-05-24 16:27:30 +01001336/**
1337 * \brief Update record layer
1338 *
1339 * This function roughly separates the implementation
1340 * of the logic of (D)TLS from the implementation
1341 * of the secure transport.
1342 *
Hanno Becker3a0aad12018-08-20 09:44:02 +01001343 * \param ssl The SSL context to use.
1344 * \param update_hs_digest This indicates if the handshake digest
1345 * should be automatically updated in case
1346 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +01001347 *
1348 * \return 0 or non-zero error code.
1349 *
1350 * \note A clarification on what is called 'record layer' here
1351 * is in order, as many sensible definitions are possible:
1352 *
1353 * The record layer takes as input an untrusted underlying
1354 * transport (stream or datagram) and transforms it into
1355 * a serially multiplexed, secure transport, which
1356 * conceptually provides the following:
1357 *
1358 * (1) Three datagram based, content-agnostic transports
1359 * for handshake, alert and CCS messages.
1360 * (2) One stream- or datagram-based transport
1361 * for application data.
1362 * (3) Functionality for changing the underlying transform
1363 * securing the contents.
1364 *
1365 * The interface to this functionality is given as follows:
1366 *
1367 * a Updating
1368 * [Currently implemented by mbedtls_ssl_read_record]
1369 *
1370 * Check if and on which of the four 'ports' data is pending:
1371 * Nothing, a controlling datagram of type (1), or application
1372 * data (2). In any case data is present, internal buffers
1373 * provide access to the data for the user to process it.
1374 * Consumption of type (1) datagrams is done automatically
1375 * on the next update, invalidating that the internal buffers
1376 * for previous datagrams, while consumption of application
1377 * data (2) is user-controlled.
1378 *
1379 * b Reading of application data
1380 * [Currently manual adaption of ssl->in_offt pointer]
1381 *
1382 * As mentioned in the last paragraph, consumption of data
1383 * is different from the automatic consumption of control
1384 * datagrams (1) because application data is treated as a stream.
1385 *
1386 * c Tracking availability of application data
1387 * [Currently manually through decreasing ssl->in_msglen]
1388 *
1389 * For efficiency and to retain datagram semantics for
1390 * application data in case of DTLS, the record layer
1391 * provides functionality for checking how much application
1392 * data is still available in the internal buffer.
1393 *
1394 * d Changing the transformation securing the communication.
1395 *
1396 * Given an opaque implementation of the record layer in the
1397 * above sense, it should be possible to implement the logic
1398 * of (D)TLS on top of it without the need to know anything
1399 * about the record layer's internals. This is done e.g.
1400 * in all the handshake handling functions, and in the
1401 * application data reading function mbedtls_ssl_read.
1402 *
1403 * \note The above tries to give a conceptual picture of the
1404 * record layer, but the current implementation deviates
1405 * from it in some places. For example, our implementation of
1406 * the update functionality through mbedtls_ssl_read_record
1407 * discards datagrams depending on the current state, which
1408 * wouldn't fall under the record layer's responsibility
1409 * following the above definition.
1410 *
1411 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001412MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001413int mbedtls_ssl_read_record(mbedtls_ssl_context *ssl,
1414 unsigned update_hs_digest);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001415MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001416int mbedtls_ssl_fetch_input(mbedtls_ssl_context *ssl, size_t nb_want);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001417
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001418/*
1419 * Write handshake message header
1420 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001421MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001422int mbedtls_ssl_start_handshake_msg(mbedtls_ssl_context *ssl, unsigned hs_type,
1423 unsigned char **buf, size_t *buf_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001424
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001425MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001426int mbedtls_ssl_write_handshake_msg_ext(mbedtls_ssl_context *ssl,
1427 int update_checksum,
1428 int force_flush);
1429static inline int mbedtls_ssl_write_handshake_msg(mbedtls_ssl_context *ssl)
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001430{
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 return mbedtls_ssl_write_handshake_msg_ext(ssl, 1 /* update checksum */, 1 /* force flush */);
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001432}
1433
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001434/*
1435 * Write handshake message tail
1436 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001437MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001438int mbedtls_ssl_finish_handshake_msg(mbedtls_ssl_context *ssl,
1439 size_t buf_len, size_t msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001440
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001441MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001442int mbedtls_ssl_write_record(mbedtls_ssl_context *ssl, int force_flush);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001444int mbedtls_ssl_flush_output(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001445
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001447int mbedtls_ssl_parse_certificate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001448MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001449int mbedtls_ssl_write_certificate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001450
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001452int mbedtls_ssl_parse_change_cipher_spec(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001453MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001454int mbedtls_ssl_write_change_cipher_spec(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001455
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001456MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001457int mbedtls_ssl_parse_finished(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001458MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001459int mbedtls_ssl_write_finished(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001460
Gilles Peskine449bd832023-01-11 14:50:10 +01001461void mbedtls_ssl_optimize_checksum(mbedtls_ssl_context *ssl,
1462 const mbedtls_ssl_ciphersuite_t *ciphersuite_info);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001463
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001464/*
1465 * Update checksum of handshake messages.
1466 */
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001467MBEDTLS_CHECK_RETURN_CRITICAL
1468int mbedtls_ssl_add_hs_msg_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01001469 unsigned hs_type,
1470 unsigned char const *msg,
1471 size_t msg_len);
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001472
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001473MBEDTLS_CHECK_RETURN_CRITICAL
1474int mbedtls_ssl_add_hs_hdr_to_checksum(mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01001475 unsigned hs_type,
1476 size_t total_hs_len);
XiaokangQian86981952022-07-19 09:51:50 +00001477
Gilles Peskineeccd8882020-03-10 12:19:08 +01001478#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong80f6f322022-05-03 17:56:38 +02001479#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001481int mbedtls_ssl_psk_derive_premaster(mbedtls_ssl_context *ssl,
1482 mbedtls_key_exchange_type_t key_ex);
Neil Armstrong80f6f322022-05-03 17:56:38 +02001483#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001484#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Ronald Crond29e13e2022-10-19 10:33:48 +02001485
Ronald Cron73fe8df2022-10-05 14:31:43 +02001486#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Ronald Crond29e13e2022-10-19 10:33:48 +02001487#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001488MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001489int mbedtls_ssl_conf_has_static_psk(mbedtls_ssl_config const *conf);
Ronald Crond491c2d2022-02-19 18:30:46 +01001490#endif
Neil Armstrong044a32c2022-05-03 10:35:56 +02001491#if defined(MBEDTLS_USE_PSA_CRYPTO)
1492/**
1493 * Get the first defined opaque PSK by order of precedence:
1494 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK
1495 * callback
1496 * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque()
1497 * Return an opaque PSK
1498 */
1499static inline mbedtls_svc_key_id_t mbedtls_ssl_get_opaque_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 const mbedtls_ssl_context *ssl)
Neil Armstrong044a32c2022-05-03 10:35:56 +02001501{
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 if (!mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque)) {
1503 return ssl->handshake->psk_opaque;
1504 }
Neil Armstrong044a32c2022-05-03 10:35:56 +02001505
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 if (!mbedtls_svc_key_id_is_null(ssl->conf->psk_opaque)) {
1507 return ssl->conf->psk_opaque;
1508 }
Neil Armstrong044a32c2022-05-03 10:35:56 +02001509
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 return MBEDTLS_SVC_KEY_ID_INIT;
Neil Armstrong044a32c2022-05-03 10:35:56 +02001511}
1512#else
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001513/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001514 * Get the first defined PSK by order of precedence:
1515 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
1516 * 2. static PSK configured by \c mbedtls_ssl_conf_psk()
1517 * Return a code and update the pair (PSK, PSK length) passed to this function
1518 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001519static inline int mbedtls_ssl_get_psk(const mbedtls_ssl_context *ssl,
1520 const unsigned char **psk, size_t *psk_len)
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001521{
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 if (ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0) {
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001523 *psk = ssl->handshake->psk;
1524 *psk_len = ssl->handshake->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 } else if (ssl->conf->psk != NULL && ssl->conf->psk_len > 0) {
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001526 *psk = ssl->conf->psk;
1527 *psk_len = ssl->conf->psk_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 } else {
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001529 *psk = NULL;
1530 *psk_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 return MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001532 }
1533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 return 0;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001535}
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001536#endif /* MBEDTLS_USE_PSA_CRYPTO */
1537
Ronald Cron73fe8df2022-10-05 14:31:43 +02001538#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001539
1540#if defined(MBEDTLS_PK_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001541unsigned char mbedtls_ssl_sig_from_pk(mbedtls_pk_context *pk);
1542unsigned char mbedtls_ssl_sig_from_pk_alg(mbedtls_pk_type_t type);
1543mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig(unsigned char sig);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001544#endif
1545
Gilles Peskine449bd832023-01-11 14:50:10 +01001546mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash(unsigned char hash);
1547unsigned char mbedtls_ssl_hash_from_md_alg(int md);
Ronald Cron4dcbca92022-03-07 10:21:40 +01001548
1549#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001550MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001551int mbedtls_ssl_set_calc_verify_md(mbedtls_ssl_context *ssl, int md);
Ronald Cron4dcbca92022-03-07 10:21:40 +01001552#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001553
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001554MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001555int mbedtls_ssl_check_curve_tls_id(const mbedtls_ssl_context *ssl, uint16_t tls_id);
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001556#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001557MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001558int mbedtls_ssl_check_curve(const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001559#endif
1560
Valerio Setti18c9fed2022-12-30 17:44:24 +01001561/**
1562 * \brief Return PSA EC info for the specified TLS ID.
1563 *
1564 * \param tls_id The TLS ID to look for
1565 * \param family If the TLD ID is supported, then proper \c psa_ecc_family_t
1566 * value is returned here. Can be NULL.
1567 * \param bits If the TLD ID is supported, then proper bit size is returned
1568 * here. Can be NULL.
1569 * \return PSA_SUCCESS if the TLS ID is supported,
1570 * PSA_ERROR_NOT_SUPPORTED otherwise
1571 *
1572 * \note If either \c family or \c bits parameters are NULL, then
1573 * the corresponding value is not returned.
1574 * The function can be called with both parameters as NULL
1575 * simply to check if a specific TLS ID is supported.
1576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001577int mbedtls_ssl_get_psa_curve_info_from_tls_id(uint16_t tls_id,
1578 psa_ecc_family_t *family,
1579 size_t *bits);
Valerio Setti18c9fed2022-12-30 17:44:24 +01001580
1581/**
1582 * \brief Return \c mbedtls_ecp_group_id for the specified TLS ID.
1583 *
1584 * \param tls_id The TLS ID to look for
1585 * \return Proper \c mbedtls_ecp_group_id if the TLS ID is supported,
1586 * or MBEDTLS_ECP_DP_NONE otherwise
1587 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001588mbedtls_ecp_group_id mbedtls_ssl_get_ecp_group_id_from_tls_id(uint16_t tls_id);
Valerio Setti18c9fed2022-12-30 17:44:24 +01001589
1590/**
1591 * \brief Return TLS ID for the specified \c mbedtls_ecp_group_id.
1592 *
1593 * \param grp_id The \c mbedtls_ecp_group_id ID to look for
1594 * \return Proper TLS ID if the \c mbedtls_ecp_group_id is supported,
1595 * or 0 otherwise
1596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001597uint16_t mbedtls_ssl_get_tls_id_from_ecp_group_id(mbedtls_ecp_group_id grp_id);
Valerio Setti18c9fed2022-12-30 17:44:24 +01001598
Valerio Setti67419f02023-01-04 16:12:42 +01001599#if defined(MBEDTLS_DEBUG_C)
Valerio Setti18c9fed2022-12-30 17:44:24 +01001600/**
1601 * \brief Return EC's name for the specified TLS ID.
1602 *
1603 * \param tls_id The TLS ID to look for
1604 * \return A pointer to a const string with the proper name. If TLS
Valerio Setti1e868cc2023-01-09 17:30:01 +01001605 * ID is not supported, a NULL pointer is returned instead.
Valerio Setti18c9fed2022-12-30 17:44:24 +01001606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001607const char *mbedtls_ssl_get_curve_name_from_tls_id(uint16_t tls_id);
Valerio Setti67419f02023-01-04 16:12:42 +01001608#endif
Valerio Setti18c9fed2022-12-30 17:44:24 +01001609
Ron Eldor089c9fe2018-12-06 17:12:49 +02001610#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascal43f94902020-09-22 12:25:52 +02001611static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 (const uint16_t srtp_profile_value)
Ron Eldor089c9fe2018-12-06 17:12:49 +02001613{
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 switch (srtp_profile_value) {
Johan Pascal85269572020-08-25 10:01:54 +02001615 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001616 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascal85269572020-08-25 10:01:54 +02001617 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001618 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascal43f94902020-09-22 12:25:52 +02001619 return srtp_profile_value;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001620 default: break;
1621 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 return MBEDTLS_TLS_SRTP_UNSET;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001623}
1624#endif
1625
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001626#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001627static inline mbedtls_pk_context *mbedtls_ssl_own_key(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001628{
1629 mbedtls_ssl_key_cert *key_cert;
1630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 if (ssl->handshake != NULL && ssl->handshake->key_cert != NULL) {
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001632 key_cert = ssl->handshake->key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 } else {
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001634 key_cert = ssl->conf->key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001635 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001636
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 return key_cert == NULL ? NULL : key_cert->key;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001638}
1639
Gilles Peskine449bd832023-01-11 14:50:10 +01001640static inline mbedtls_x509_crt *mbedtls_ssl_own_cert(mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001641{
1642 mbedtls_ssl_key_cert *key_cert;
1643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 if (ssl->handshake != NULL && ssl->handshake->key_cert != NULL) {
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001645 key_cert = ssl->handshake->key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 } else {
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001647 key_cert = ssl->conf->key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001649
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 return key_cert == NULL ? NULL : key_cert->cert;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001651}
1652
1653/*
1654 * Check usage of a certificate wrt extensions:
1655 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1656 *
1657 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1658 * check a cert we received from them)!
1659 *
1660 * Return 0 if everything is OK, -1 if not.
1661 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001662MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001663int mbedtls_ssl_check_cert_usage(const mbedtls_x509_crt *cert,
1664 const mbedtls_ssl_ciphersuite_t *ciphersuite,
1665 int cert_endpoint,
1666 uint32_t *flags);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001667#endif /* MBEDTLS_X509_CRT_PARSE_C */
1668
Gilles Peskine449bd832023-01-11 14:50:10 +01001669void mbedtls_ssl_write_version(unsigned char version[2], int transport,
1670 mbedtls_ssl_protocol_version tls_version);
1671uint16_t mbedtls_ssl_read_version(const unsigned char version[2],
1672 int transport);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001673
Gilles Peskine449bd832023-01-11 14:50:10 +01001674static inline size_t mbedtls_ssl_in_hdr_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001675{
Hanno Becker47be7682019-07-12 09:55:46 +01001676#if !defined(MBEDTLS_SSL_PROTO_DTLS)
1677 ((void) ssl);
1678#endif
1679
1680#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1682 return 13;
1683 } else
Hanno Becker47be7682019-07-12 09:55:46 +01001684#endif /* MBEDTLS_SSL_PROTO_DTLS */
1685 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 return 5;
Hanno Becker47be7682019-07-12 09:55:46 +01001687 }
Hanno Becker5903de42019-05-03 14:46:38 +01001688}
1689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690static inline size_t mbedtls_ssl_out_hdr_len(const mbedtls_ssl_context *ssl)
Hanno Becker5903de42019-05-03 14:46:38 +01001691{
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 return (size_t) (ssl->out_iv - ssl->out_hdr);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001693}
1694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695static inline size_t mbedtls_ssl_hs_hdr_len(const mbedtls_ssl_context *ssl)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001696{
1697#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1699 return 12;
1700 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001701#else
1702 ((void) ssl);
1703#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 return 4;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001705}
1706
1707#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001708void mbedtls_ssl_send_flight_completed(mbedtls_ssl_context *ssl);
1709void mbedtls_ssl_recv_flight_completed(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001711int mbedtls_ssl_resend(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001713int mbedtls_ssl_flight_transmit(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001714#endif
1715
1716/* Visible for testing purposes only */
1717#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001718MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001719int mbedtls_ssl_dtls_replay_check(mbedtls_ssl_context const *ssl);
1720void mbedtls_ssl_dtls_replay_update(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001721#endif
1722
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001723MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001724int mbedtls_ssl_session_copy(mbedtls_ssl_session *dst,
1725 const mbedtls_ssl_session *src);
Hanno Becker52055ae2019-02-06 14:30:46 +00001726
TRodziewicz0f82ec62021-05-12 17:49:18 +02001727#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek814feff2019-01-14 04:35:19 -05001728/* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001729MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001730int mbedtls_ssl_get_key_exchange_md_tls1_2(mbedtls_ssl_context *ssl,
1731 unsigned char *hash, size_t *hashlen,
1732 unsigned char *data, size_t data_len,
1733 mbedtls_md_type_t md_alg);
TRodziewicz0f82ec62021-05-12 17:49:18 +02001734#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001735
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001736#ifdef __cplusplus
1737}
1738#endif
1739
Gilles Peskine449bd832023-01-11 14:50:10 +01001740void mbedtls_ssl_transform_init(mbedtls_ssl_transform *transform);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001741MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001742int mbedtls_ssl_encrypt_buf(mbedtls_ssl_context *ssl,
1743 mbedtls_ssl_transform *transform,
1744 mbedtls_record *rec,
1745 int (*f_rng)(void *, unsigned char *, size_t),
1746 void *p_rng);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001747MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001748int mbedtls_ssl_decrypt_buf(mbedtls_ssl_context const *ssl,
1749 mbedtls_ssl_transform *transform,
1750 mbedtls_record *rec);
Hanno Beckera18d1322018-01-03 14:27:32 +00001751
Hanno Beckerdd772292020-02-05 10:38:31 +00001752/* Length of the "epoch" field in the record header */
Gilles Peskine449bd832023-01-11 14:50:10 +01001753static inline size_t mbedtls_ssl_ep_len(const mbedtls_ssl_context *ssl)
Hanno Beckerdd772292020-02-05 10:38:31 +00001754{
1755#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 if (ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM) {
1757 return 2;
1758 }
Hanno Beckerdd772292020-02-05 10:38:31 +00001759#else
1760 ((void) ssl);
1761#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 return 0;
Hanno Beckerdd772292020-02-05 10:38:31 +00001763}
1764
Hanno Becker08f09132020-02-11 15:40:07 +00001765#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001766MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001767int mbedtls_ssl_resend_hello_request(mbedtls_ssl_context *ssl);
Hanno Becker08f09132020-02-11 15:40:07 +00001768#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker0f57a652020-02-05 10:37:26 +00001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770void mbedtls_ssl_set_timer(mbedtls_ssl_context *ssl, uint32_t millisecs);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001771MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001772int mbedtls_ssl_check_timer(mbedtls_ssl_context *ssl);
Hanno Becker7876d122020-02-05 10:39:31 +00001773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774void mbedtls_ssl_reset_in_out_pointers(mbedtls_ssl_context *ssl);
1775void mbedtls_ssl_update_out_pointers(mbedtls_ssl_context *ssl,
1776 mbedtls_ssl_transform *transform);
1777void mbedtls_ssl_update_in_pointers(mbedtls_ssl_context *ssl);
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001778
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001779MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001780int mbedtls_ssl_session_reset_int(mbedtls_ssl_context *ssl, int partial);
1781void mbedtls_ssl_session_reset_msg_layer(mbedtls_ssl_context *ssl,
1782 int partial);
Hanno Becker43aefe22020-02-05 10:44:56 +00001783
Jerry Yue7047812021-09-13 19:26:39 +08001784/*
Jerry Yu394ece62021-09-14 22:17:21 +08001785 * Send pending alert
Jerry Yue7047812021-09-13 19:26:39 +08001786 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001787MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001788int mbedtls_ssl_handle_pending_alert(mbedtls_ssl_context *ssl);
Jerry Yue7047812021-09-13 19:26:39 +08001789
Jerry Yu394ece62021-09-14 22:17:21 +08001790/*
1791 * Set pending fatal alert flag.
1792 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001793void mbedtls_ssl_pend_fatal_alert(mbedtls_ssl_context *ssl,
1794 unsigned char alert_type,
1795 int alert_reason);
Jerry Yu394ece62021-09-14 22:17:21 +08001796
1797/* Alias of mbedtls_ssl_pend_fatal_alert */
Gilles Peskine449bd832023-01-11 14:50:10 +01001798#define MBEDTLS_SSL_PEND_FATAL_ALERT(type, user_return_value) \
1799 mbedtls_ssl_pend_fatal_alert(ssl, type, user_return_value)
Jerry Yu394ece62021-09-14 22:17:21 +08001800
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001801#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine449bd832023-01-11 14:50:10 +01001802void mbedtls_ssl_dtls_replay_reset(mbedtls_ssl_context *ssl);
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001803#endif
1804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805void mbedtls_ssl_handshake_wrapup_free_hs_transform(mbedtls_ssl_context *ssl);
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001806
Hanno Becker08f09132020-02-11 15:40:07 +00001807#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001808MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001809int mbedtls_ssl_start_renegotiation(mbedtls_ssl_context *ssl);
Hanno Becker08f09132020-02-11 15:40:07 +00001810#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker89490712020-02-05 10:50:12 +00001811
Hanno Becker533ab5f2020-02-05 10:49:13 +00001812#if defined(MBEDTLS_SSL_PROTO_DTLS)
Gilles Peskine449bd832023-01-11 14:50:10 +01001813size_t mbedtls_ssl_get_current_mtu(const mbedtls_ssl_context *ssl);
1814void mbedtls_ssl_buffering_free(mbedtls_ssl_context *ssl);
1815void mbedtls_ssl_flight_free(mbedtls_ssl_flight_item *flight);
Hanno Becker533ab5f2020-02-05 10:49:13 +00001816#endif /* MBEDTLS_SSL_PROTO_DTLS */
1817
Jerry Yu60835a82021-08-04 10:13:52 +08001818/**
1819 * ssl utils functions for checking configuration.
1820 */
1821
Ronald Cron6f135e12021-12-08 16:57:54 +01001822#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001823static inline int mbedtls_ssl_conf_is_tls13_only(const mbedtls_ssl_config *conf)
Jerry Yu60835a82021-08-04 10:13:52 +08001824{
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 return conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1826 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yu60835a82021-08-04 10:13:52 +08001827}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001828
Ronald Cron6f135e12021-12-08 16:57:54 +01001829#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001830
1831#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001832static inline int mbedtls_ssl_conf_is_tls12_only(const mbedtls_ssl_config *conf)
Jerry Yu60835a82021-08-04 10:13:52 +08001833{
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 return conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1835 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_2;
Jerry Yu60835a82021-08-04 10:13:52 +08001836}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001837
Jerry Yu60835a82021-08-04 10:13:52 +08001838#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1839
Gilles Peskine449bd832023-01-11 14:50:10 +01001840static inline int mbedtls_ssl_conf_is_tls13_enabled(const mbedtls_ssl_config *conf)
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001841{
1842#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_3 &&
1844 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001845#else
1846 ((void) conf);
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 return 0;
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001848#endif
1849}
1850
Gilles Peskine449bd832023-01-11 14:50:10 +01001851static inline int mbedtls_ssl_conf_is_tls12_enabled(const mbedtls_ssl_config *conf)
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001852{
1853#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 return conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 &&
1855 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_2;
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001856#else
1857 ((void) conf);
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 return 0;
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001859#endif
1860}
1861
Ronald Cron6f135e12021-12-08 16:57:54 +01001862#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine449bd832023-01-11 14:50:10 +01001863static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13(const mbedtls_ssl_config *conf)
Jerry Yu60835a82021-08-04 10:13:52 +08001864{
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 return conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1866 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yu60835a82021-08-04 10:13:52 +08001867}
Ronald Cron6f135e12021-12-08 16:57:54 +01001868#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001869
Ronald Cron6f135e12021-12-08 16:57:54 +01001870#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yufbe3e642022-04-25 19:31:51 +08001871extern const uint8_t mbedtls_ssl_tls13_hello_retry_request_magic[
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001873MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001874int mbedtls_ssl_tls13_process_finished_message(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001875MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001876int mbedtls_ssl_tls13_write_finished_message(mbedtls_ssl_context *ssl);
1877void mbedtls_ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl);
Jerry Yua6e6c272021-11-17 17:54:13 +08001878
1879/**
Ronald Cron3d580bf2022-02-18 17:24:56 +01001880 * \brief Given an SSL context and its associated configuration, write the TLS
1881 * 1.3 specific extensions of the ClientHello message.
1882 *
1883 * \param[in] ssl SSL context
1884 * \param[in] buf Base address of the buffer where to write the extensions
1885 * \param[in] end End address of the buffer where to write the extensions
1886 * \param[out] out_len Length of the data written into the buffer \p buf
1887 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001888MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001889int mbedtls_ssl_tls13_write_client_hello_exts(mbedtls_ssl_context *ssl,
1890 unsigned char *buf,
1891 unsigned char *end,
1892 size_t *out_len);
Ronald Cron3d580bf2022-02-18 17:24:56 +01001893
1894/**
Jerry Yua6e6c272021-11-17 17:54:13 +08001895 * \brief TLS 1.3 client side state machine entry
1896 *
1897 * \param ssl SSL context
1898 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001899MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001900int mbedtls_ssl_tls13_handshake_client_step(mbedtls_ssl_context *ssl);
Jerry Yua6e6c272021-11-17 17:54:13 +08001901
1902/**
1903 * \brief TLS 1.3 server side state machine entry
1904 *
1905 * \param ssl SSL context
1906 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001907MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001908int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl);
Jerry Yua6e6c272021-11-17 17:54:13 +08001909
Jerry Yu26f4d152021-08-23 17:42:37 +08001910
1911/*
1912 * Helper functions around key exchange modes.
1913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001914static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes(mbedtls_ssl_context *ssl,
1915 int kex_mode_mask)
Jerry Yu26f4d152021-08-23 17:42:37 +08001916{
Gilles Peskine449bd832023-01-11 14:50:10 +01001917 return (ssl->conf->tls13_kex_modes & kex_mode_mask) != 0;
Jerry Yu26f4d152021-08-23 17:42:37 +08001918}
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920static inline int mbedtls_ssl_conf_tls13_psk_enabled(mbedtls_ssl_context *ssl)
Jerry Yu26f4d152021-08-23 17:42:37 +08001921{
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 return mbedtls_ssl_conf_tls13_check_kex_modes(ssl,
1923 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK);
Jerry Yu26f4d152021-08-23 17:42:37 +08001924}
1925
Gilles Peskine449bd832023-01-11 14:50:10 +01001926static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(mbedtls_ssl_context *ssl)
Jerry Yu26f4d152021-08-23 17:42:37 +08001927{
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 return mbedtls_ssl_conf_tls13_check_kex_modes(ssl,
1929 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL);
Jerry Yu26f4d152021-08-23 17:42:37 +08001930}
1931
Gilles Peskine449bd832023-01-11 14:50:10 +01001932static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled(mbedtls_ssl_context *ssl)
Jerry Yu26f4d152021-08-23 17:42:37 +08001933{
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 return mbedtls_ssl_conf_tls13_check_kex_modes(ssl,
1935 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL);
Jerry Yu26f4d152021-08-23 17:42:37 +08001936}
1937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled(mbedtls_ssl_context *ssl)
Jerry Yu26f4d152021-08-23 17:42:37 +08001939{
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 return mbedtls_ssl_conf_tls13_check_kex_modes(ssl,
1941 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL);
Jerry Yu26f4d152021-08-23 17:42:37 +08001942}
1943
Gilles Peskine449bd832023-01-11 14:50:10 +01001944static inline int mbedtls_ssl_conf_tls13_some_psk_enabled(mbedtls_ssl_context *ssl)
Jerry Yu26f4d152021-08-23 17:42:37 +08001945{
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 return mbedtls_ssl_conf_tls13_check_kex_modes(ssl,
1947 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL);
Jerry Yu26f4d152021-08-23 17:42:37 +08001948}
1949
Ronald Cron41a443a2022-10-04 16:38:25 +02001950#if defined(MBEDTLS_SSL_SRV_C) && \
1951 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuadf861a2021-09-29 21:22:08 +08001952/**
1953 * Given a list of key exchange modes, check if at least one of them is
1954 * supported.
1955 *
1956 * \param[in] ssl SSL context
Jerry Yu0cabad32021-09-30 09:52:35 +08001957 * \param kex_modes_mask Mask of the key exchange modes to check
Jerry Yuadf861a2021-09-29 21:22:08 +08001958 *
1959 * \return 0 if at least one of the key exchange modes is supported,
Jerry Yudca3d5d2021-10-08 14:19:29 +08001960 * !=0 otherwise.
Jerry Yuadf861a2021-09-29 21:22:08 +08001961 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001962static inline unsigned mbedtls_ssl_tls13_check_kex_modes(mbedtls_ssl_context *ssl,
1963 int kex_modes_mask)
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001964{
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 return (ssl->handshake->tls13_kex_modes & kex_modes_mask) == 0;
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001966}
1967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968static inline int mbedtls_ssl_tls13_psk_enabled(mbedtls_ssl_context *ssl)
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001969{
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 return !mbedtls_ssl_tls13_check_kex_modes(ssl,
1971 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK);
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001972}
1973
Xiaofei Bai746f9482021-11-12 08:53:56 +00001974static inline int mbedtls_ssl_tls13_psk_ephemeral_enabled(
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 mbedtls_ssl_context *ssl)
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001976{
Gilles Peskine449bd832023-01-11 14:50:10 +01001977 return !mbedtls_ssl_tls13_check_kex_modes(ssl,
1978 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL);
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001979}
1980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981static inline int mbedtls_ssl_tls13_ephemeral_enabled(mbedtls_ssl_context *ssl)
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001982{
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 return !mbedtls_ssl_tls13_check_kex_modes(ssl,
1984 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL);
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001985}
1986
Gilles Peskine449bd832023-01-11 14:50:10 +01001987static inline int mbedtls_ssl_tls13_some_ephemeral_enabled(mbedtls_ssl_context *ssl)
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001988{
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 return !mbedtls_ssl_tls13_check_kex_modes(ssl,
1990 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL);
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001991}
1992
Gilles Peskine449bd832023-01-11 14:50:10 +01001993static inline int mbedtls_ssl_tls13_some_psk_enabled(mbedtls_ssl_context *ssl)
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001994{
Gilles Peskine449bd832023-01-11 14:50:10 +01001995 return !mbedtls_ssl_tls13_check_kex_modes(ssl,
1996 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL);
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001997}
Ronald Cron41a443a2022-10-04 16:38:25 +02001998#endif /* MBEDTLS_SSL_SRV_C &&
1999 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1b7c4a42021-09-09 17:09:12 +08002000
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002001/*
Jerry Yuea52ed92022-11-08 21:01:17 +08002002 * Helper functions for extensions checking.
Jerry Yue18dc7e2022-08-04 16:29:22 +08002003 */
Jerry Yue18dc7e2022-08-04 16:29:22 +08002004
Jerry Yu0c354a22022-08-29 15:25:36 +08002005MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002006int mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 mbedtls_ssl_context *ssl,
2008 int hs_msg_type,
2009 unsigned int received_extension_type,
2010 uint32_t hs_msg_allowed_extensions_mask);
Jerry Yu0c354a22022-08-29 15:25:36 +08002011
Jerry Yuc4bf5d62022-10-29 09:08:47 +08002012static inline void mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 mbedtls_ssl_context *ssl, unsigned int extension_type)
Jerry Yu0c354a22022-08-29 15:25:36 +08002014{
2015 ssl->handshake->sent_extensions |=
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 mbedtls_ssl_get_extension_mask(extension_type);
Jerry Yu0c354a22022-08-29 15:25:36 +08002017}
Jerry Yue18dc7e2022-08-04 16:29:22 +08002018
2019/*
Ronald Cron85385492022-07-20 16:44:00 +02002020 * Helper functions to check the selected key exchange mode.
2021 */
2022static inline int mbedtls_ssl_tls13_key_exchange_mode_check(
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 mbedtls_ssl_context *ssl, int kex_mask)
Ronald Cron85385492022-07-20 16:44:00 +02002024{
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 return (ssl->handshake->key_exchange_mode & kex_mask) != 0;
Ronald Cron85385492022-07-20 16:44:00 +02002026}
2027
2028static inline int mbedtls_ssl_tls13_key_exchange_mode_with_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 mbedtls_ssl_context *ssl)
Ronald Cron85385492022-07-20 16:44:00 +02002030{
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 return mbedtls_ssl_tls13_key_exchange_mode_check(ssl,
2032 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL);
Ronald Cron85385492022-07-20 16:44:00 +02002033}
2034
2035static inline int mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 mbedtls_ssl_context *ssl)
Ronald Cron85385492022-07-20 16:44:00 +02002037{
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 return mbedtls_ssl_tls13_key_exchange_mode_check(ssl,
2039 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL);
Ronald Cron85385492022-07-20 16:44:00 +02002040}
2041
2042/*
XiaokangQian6b226b02021-09-24 07:51:16 +00002043 * Fetch TLS 1.3 handshake message header
2044 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002045MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002046int mbedtls_ssl_tls13_fetch_handshake_msg(mbedtls_ssl_context *ssl,
2047 unsigned hs_type,
2048 unsigned char **buf,
2049 size_t *buf_len);
XiaokangQian6b226b02021-09-24 07:51:16 +00002050
2051/*
Xiaofei Bai947571e2021-09-29 09:12:03 +00002052 * Handler of TLS 1.3 server certificate message
2053 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002054MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002055int mbedtls_ssl_tls13_process_certificate(mbedtls_ssl_context *ssl);
Xiaofei Bai947571e2021-09-29 09:12:03 +00002056
Ronald Cron928cbd32022-10-04 16:14:26 +02002057#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002058/*
Jerry Yu3e536442022-02-15 11:05:59 +08002059 * Handler of TLS 1.3 write Certificate message
Jerry Yu5cc35062022-01-28 16:16:08 +08002060 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002062int mbedtls_ssl_tls13_write_certificate(mbedtls_ssl_context *ssl);
Jerry Yu5cc35062022-01-28 16:16:08 +08002063
2064/*
Jerry Yu3e536442022-02-15 11:05:59 +08002065 * Handler of TLS 1.3 write Certificate Verify message
Jerry Yu8511f122022-01-29 10:01:04 +08002066 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002067MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002068int mbedtls_ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl);
Jerry Yu90f152d2022-01-29 22:12:42 +08002069
Ronald Cron928cbd32022-10-04 16:14:26 +02002070#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu90f152d2022-01-29 22:12:42 +08002071
Jerry Yu8511f122022-01-29 10:01:04 +08002072/*
Jerry Yu30b071c2021-09-12 20:16:03 +08002073 * Generic handler of Certificate Verify
2074 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002075MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002076int mbedtls_ssl_tls13_process_certificate_verify(mbedtls_ssl_context *ssl);
Jerry Yu30b071c2021-09-12 20:16:03 +08002077
2078/*
Ronald Cron49ad6192021-11-24 16:25:31 +01002079 * Write of dummy-CCS's for middlebox compatibility
2080 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002081MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002082int mbedtls_ssl_tls13_write_change_cipher_spec(mbedtls_ssl_context *ssl);
Ronald Cron49ad6192021-11-24 16:25:31 +01002083
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002084MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002085int mbedtls_ssl_reset_transcript_for_hrr(mbedtls_ssl_context *ssl);
XiaokangQian647719a2021-12-07 09:16:29 +00002086
Valerio Setti080a22b2023-03-20 15:22:47 +01002087#if defined(PSA_WANT_ALG_ECDH)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002088MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu89e103c2022-03-30 22:43:29 +08002089int mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 mbedtls_ssl_context *ssl,
2091 uint16_t named_group,
2092 unsigned char *buf,
2093 unsigned char *end,
2094 size_t *out_len);
Valerio Setti080a22b2023-03-20 15:22:47 +01002095#endif /* PSA_WANT_ALG_ECDH */
Jerry Yu89e103c2022-03-30 22:43:29 +08002096
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00002097#if defined(MBEDTLS_SSL_EARLY_DATA)
Gilles Peskine449bd832023-01-11 14:50:10 +01002098int mbedtls_ssl_tls13_write_early_data_ext(mbedtls_ssl_context *ssl,
2099 unsigned char *buf,
2100 const unsigned char *end,
2101 size_t *out_len);
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00002102#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu89e103c2022-03-30 22:43:29 +08002103
Jerry Yuf017ee42022-01-12 15:49:48 +08002104#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2105
Ronald Crone68ab4f2022-10-05 12:46:29 +02002106#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002107/*
Jerry Yuddda0502022-12-01 19:43:12 +08002108 * Write Signature Algorithm extension
2109 */
2110MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002111int mbedtls_ssl_write_sig_alg_ext(mbedtls_ssl_context *ssl, unsigned char *buf,
2112 const unsigned char *end, size_t *out_len);
Jerry Yuddda0502022-12-01 19:43:12 +08002113/*
Gabor Mezei53a3b142022-05-10 13:20:55 +02002114 * Parse TLS Signature Algorithm extension
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002115 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002116MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002117int mbedtls_ssl_parse_sig_alg_ext(mbedtls_ssl_context *ssl,
2118 const unsigned char *buf,
2119 const unsigned char *end);
Ronald Crone68ab4f2022-10-05 12:46:29 +02002120#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002121
Jerry Yu000f9762021-09-14 11:12:51 +08002122/* Get handshake transcript */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002123MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002124int mbedtls_ssl_get_handshake_transcript(mbedtls_ssl_context *ssl,
2125 const mbedtls_md_type_t md,
2126 unsigned char *dst,
2127 size_t dst_len,
2128 size_t *olen);
Jerry Yu000f9762021-09-14 11:12:51 +08002129
Brett Warrene0edc842021-08-17 09:53:13 +01002130/*
2131 * Return supported groups.
2132 *
2133 * In future, invocations can be changed to ssl->conf->group_list
2134 * when mbedtls_ssl_conf_curves() is deleted.
2135 *
2136 * ssl->handshake->group_list is either a translation of curve_list to IANA TLS group
2137 * identifiers when mbedtls_ssl_conf_curves() has been used, or a pointer to
2138 * ssl->conf->group_list when mbedtls_ssl_conf_groups() has been more recently invoked.
2139 *
2140 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002141static inline const void *mbedtls_ssl_get_groups(const mbedtls_ssl_context *ssl)
Brett Warrene0edc842021-08-17 09:53:13 +01002142{
2143 #if defined(MBEDTLS_DEPRECATED_REMOVED) || !defined(MBEDTLS_ECP_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 return ssl->conf->group_list;
Brett Warrene0edc842021-08-17 09:53:13 +01002145 #else
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 if ((ssl->handshake != NULL) && (ssl->handshake->group_list != NULL)) {
2147 return ssl->handshake->group_list;
2148 } else {
2149 return ssl->conf->group_list;
2150 }
Brett Warrene0edc842021-08-17 09:53:13 +01002151 #endif
2152}
2153
Jerry Yuba073422021-12-20 22:22:15 +08002154/*
2155 * Helper functions for NamedGroup.
2156 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002157static inline int mbedtls_ssl_tls12_named_group_is_ecdhe(uint16_t named_group)
Jerry Yuba073422021-12-20 22:22:15 +08002158{
2159 /*
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002160 * RFC 8422 section 5.1.1
Jerry Yuba073422021-12-20 22:22:15 +08002161 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 return named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2163 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 ||
2164 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 ||
2165 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 ||
2166 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 ||
2167 /* Below deprecated curves should be removed with notice to users */
2168 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 ||
2169 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 ||
2170 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 ||
2171 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 ||
2172 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 ||
2173 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
2174 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
2175 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1;
Jerry Yuba073422021-12-20 22:22:15 +08002176}
2177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178static inline int mbedtls_ssl_tls13_named_group_is_ecdhe(uint16_t named_group)
Jerry Yuba073422021-12-20 22:22:15 +08002179{
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 return named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2181 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
2182 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
2183 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 ||
2184 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448;
Jerry Yuba073422021-12-20 22:22:15 +08002185}
2186
Gilles Peskine449bd832023-01-11 14:50:10 +01002187static inline int mbedtls_ssl_tls13_named_group_is_dhe(uint16_t named_group)
Jerry Yuba073422021-12-20 22:22:15 +08002188{
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 return named_group >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 &&
2190 named_group <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192;
Jerry Yuba073422021-12-20 22:22:15 +08002191}
2192
XiaokangQian08037552022-04-20 07:16:41 +00002193static inline int mbedtls_ssl_named_group_is_offered(
Gilles Peskine449bd832023-01-11 14:50:10 +01002194 const mbedtls_ssl_context *ssl, uint16_t named_group)
XiaokangQian08037552022-04-20 07:16:41 +00002195{
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 const uint16_t *group_list = mbedtls_ssl_get_groups(ssl);
XiaokangQian08037552022-04-20 07:16:41 +00002197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 if (group_list == NULL) {
2199 return 0;
XiaokangQian08037552022-04-20 07:16:41 +00002200 }
2201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 for (; *group_list != 0; group_list++) {
2203 if (*group_list == named_group) {
2204 return 1;
2205 }
2206 }
2207
2208 return 0;
XiaokangQian08037552022-04-20 07:16:41 +00002209}
2210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211static inline int mbedtls_ssl_named_group_is_supported(uint16_t named_group)
XiaokangQian08037552022-04-20 07:16:41 +00002212{
Valerio Setti080a22b2023-03-20 15:22:47 +01002213#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
2215 if (mbedtls_ssl_get_ecp_group_id_from_tls_id(named_group) !=
2216 MBEDTLS_ECP_DP_NONE) {
2217 return 1;
2218 }
XiaokangQian08037552022-04-20 07:16:41 +00002219 }
2220#else
2221 ((void) named_group);
Valerio Setti080a22b2023-03-20 15:22:47 +01002222#endif /* PSA_WANT_ALG_ECDH */
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 return 0;
XiaokangQian08037552022-04-20 07:16:41 +00002224}
2225
Jerry Yuafdfed12021-12-22 10:49:02 +08002226/*
Jerry Yu713013f2022-01-17 18:16:35 +08002227 * Return supported signature algorithms.
2228 *
2229 * In future, invocations can be changed to ssl->conf->sig_algs when
2230 * mbedtls_ssl_conf_sig_hashes() is deleted.
2231 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002232 * ssl->handshake->sig_algs is either a translation of sig_hashes to IANA TLS
2233 * signature algorithm identifiers when mbedtls_ssl_conf_sig_hashes() has been
2234 * used, or a pointer to ssl->conf->sig_algs when mbedtls_ssl_conf_sig_algs() has
2235 * been more recently invoked.
2236 *
Jerry Yuafdfed12021-12-22 10:49:02 +08002237 */
Jerry Yu713013f2022-01-17 18:16:35 +08002238static inline const void *mbedtls_ssl_get_sig_algs(
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 const mbedtls_ssl_context *ssl)
Jerry Yuafdfed12021-12-22 10:49:02 +08002240{
Ronald Crone68ab4f2022-10-05 12:46:29 +02002241#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002242
Jerry Yu6106fdc2022-01-12 16:36:14 +08002243#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002244 if (ssl->handshake != NULL &&
Jerry Yucc539102022-06-27 16:27:35 +08002245 ssl->handshake->sig_algs_heap_allocated == 1 &&
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl->handshake->sig_algs != NULL) {
2247 return ssl->handshake->sig_algs;
Jerry Yuee28e7a2022-06-24 19:35:40 +08002248 }
Jerry Yu6106fdc2022-01-12 16:36:14 +08002249#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 return ssl->conf->sig_algs;
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002251
Ronald Crone68ab4f2022-10-05 12:46:29 +02002252#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002253
Jerry Yu6106fdc2022-01-12 16:36:14 +08002254 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01002255 return NULL;
Ronald Crone68ab4f2022-10-05 12:46:29 +02002256#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002257}
Jerry Yuba073422021-12-20 22:22:15 +08002258
Ronald Cron928cbd32022-10-04 16:14:26 +02002259#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002260static inline int mbedtls_ssl_sig_alg_is_received(const mbedtls_ssl_context *ssl,
2261 uint16_t own_sig_alg)
Jerry Yu8511f122022-01-29 10:01:04 +08002262{
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002263 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
Gilles Peskine449bd832023-01-11 14:50:10 +01002264 if (sig_alg == NULL) {
2265 return 0;
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002266 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002267
2268 for (; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++) {
2269 if (*sig_alg == own_sig_alg) {
2270 return 1;
2271 }
2272 }
2273 return 0;
Jerry Yu8511f122022-01-29 10:01:04 +08002274}
2275
Jerry Yua1255e62022-06-24 10:10:47 +08002276static inline int mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 const uint16_t sig_alg)
Jerry Yu0ebce952022-06-16 13:54:47 +08002278{
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 switch (sig_alg) {
Valerio Setti1ad9ef22023-02-22 12:38:07 +01002280#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002281#if defined(PSA_WANT_ALG_SHA_256) && defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002282 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
2283 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002284#endif /* PSA_WANT_ALG_SHA_256 && MBEDTLS_ECP_DP_SECP256R1_ENABLED */
2285#if defined(PSA_WANT_ALG_SHA_384) && defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002286 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
2287 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002288#endif /* PSA_WANT_ALG_SHA_384 && MBEDTLS_ECP_DP_SECP384R1_ENABLED */
2289#if defined(PSA_WANT_ALG_SHA_512) && defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002290 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
2291 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002292#endif /* PSA_WANT_ALG_SHA_512 && MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Valerio Setti1ad9ef22023-02-22 12:38:07 +01002293#endif /* MBEDTLS_PK_CAN_ECDSA_SOME */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002294
Jerry Yu52b7d922022-07-01 18:03:31 +08002295#if defined(MBEDTLS_PKCS1_V21)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002296#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002297 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2298 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002299#endif /* PSA_WANT_ALG_SHA_256 */
2300#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002301 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2302 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002303#endif /* PSA_WANT_ALG_SHA_384 */
2304#if defined(PSA_WANT_ALG_SHA_512)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002305 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2306 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002307#endif /* PSA_WANT_ALG_SHA_512 */
Jerry Yu52b7d922022-07-01 18:03:31 +08002308#endif /* MBEDTLS_PKCS1_V21 */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002309 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 return 0;
Jerry Yu96ee23e2022-06-21 16:34:57 +08002311 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 return 1;
Jerry Yu80dd5db2022-06-22 19:30:32 +08002313
2314}
2315
2316static inline int mbedtls_ssl_tls13_sig_alg_is_supported(
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 const uint16_t sig_alg)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002318{
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 switch (sig_alg) {
Jerry Yu52b7d922022-07-01 18:03:31 +08002320#if defined(MBEDTLS_PKCS1_V15)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002321#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002322 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
2323 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002324#endif /* MBEDTLS_MD_CAN_SHA256 */
2325#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002326 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
2327 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002328#endif /* MBEDTLS_MD_CAN_SHA384 */
2329#if defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002330 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
2331 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002332#endif /* MBEDTLS_MD_CAN_SHA512 */
Jerry Yu52b7d922022-07-01 18:03:31 +08002333#endif /* MBEDTLS_PKCS1_V15 */
Jerry Yu80dd5db2022-06-22 19:30:32 +08002334 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 return mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
2336 sig_alg);
Jerry Yu80dd5db2022-06-22 19:30:32 +08002337 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 return 1;
Jerry Yu0ebce952022-06-16 13:54:47 +08002339}
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002340
Ronald Cron928cbd32022-10-04 16:14:26 +02002341MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002342int mbedtls_ssl_tls13_check_sig_alg_cert_key_match(uint16_t sig_alg,
2343 mbedtls_pk_context *key);
Ronald Cron928cbd32022-10-04 16:14:26 +02002344#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
2345
Ronald Crone68ab4f2022-10-05 12:46:29 +02002346#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002347static inline int mbedtls_ssl_sig_alg_is_offered(const mbedtls_ssl_context *ssl,
2348 uint16_t proposed_sig_alg)
Ronald Cron928cbd32022-10-04 16:14:26 +02002349{
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs(ssl);
2351 if (sig_alg == NULL) {
2352 return 0;
Ronald Cron928cbd32022-10-04 16:14:26 +02002353 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002354
2355 for (; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++) {
2356 if (*sig_alg == proposed_sig_alg) {
2357 return 1;
2358 }
2359 }
2360 return 0;
Ronald Cron928cbd32022-10-04 16:14:26 +02002361}
2362
2363static inline int mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 uint16_t sig_alg, mbedtls_pk_type_t *pk_type, mbedtls_md_type_t *md_alg)
Ronald Cron928cbd32022-10-04 16:14:26 +02002365{
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 *pk_type = mbedtls_ssl_pk_alg_from_sig(sig_alg & 0xff);
2367 *md_alg = mbedtls_ssl_md_alg_from_hash((sig_alg >> 8) & 0xff);
Ronald Cron928cbd32022-10-04 16:14:26 +02002368
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (*pk_type != MBEDTLS_PK_NONE && *md_alg != MBEDTLS_MD_NONE) {
2370 return 0;
2371 }
Ronald Cron928cbd32022-10-04 16:14:26 +02002372
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 switch (sig_alg) {
Ronald Cron928cbd32022-10-04 16:14:26 +02002374#if defined(MBEDTLS_PKCS1_V21)
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002375#if defined(MBEDTLS_MD_CAN_SHA256)
Ronald Cron928cbd32022-10-04 16:14:26 +02002376 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2377 *md_alg = MBEDTLS_MD_SHA256;
2378 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2379 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002380#endif /* MBEDTLS_MD_CAN_SHA256 */
2381#if defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron928cbd32022-10-04 16:14:26 +02002382 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2383 *md_alg = MBEDTLS_MD_SHA384;
2384 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2385 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002386#endif /* MBEDTLS_MD_CAN_SHA384 */
2387#if defined(MBEDTLS_MD_CAN_SHA512)
Ronald Cron928cbd32022-10-04 16:14:26 +02002388 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2389 *md_alg = MBEDTLS_MD_SHA512;
2390 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2391 break;
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002392#endif /* MBEDTLS_MD_CAN_SHA512 */
Ronald Cron928cbd32022-10-04 16:14:26 +02002393#endif /* MBEDTLS_PKCS1_V21 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 default:
2395 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
2396 }
2397 return 0;
Ronald Cron928cbd32022-10-04 16:14:26 +02002398}
Jerry Yu8c338862022-03-23 13:34:04 +08002399
Jerry Yu0ebce952022-06-16 13:54:47 +08002400#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2401static inline int mbedtls_ssl_tls12_sig_alg_is_supported(
Gilles Peskine449bd832023-01-11 14:50:10 +01002402 const uint16_t sig_alg)
Jerry Yu0ebce952022-06-16 13:54:47 +08002403{
2404 /* High byte is hash */
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 unsigned char hash = MBEDTLS_BYTE_1(sig_alg);
2406 unsigned char sig = MBEDTLS_BYTE_0(sig_alg);
Jerry Yu0ebce952022-06-16 13:54:47 +08002407
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 switch (hash) {
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002409#if defined(MBEDTLS_MD_CAN_MD5)
Jerry Yu0ebce952022-06-16 13:54:47 +08002410 case MBEDTLS_SSL_HASH_MD5:
2411 break;
2412#endif
2413
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002414#if defined(MBEDTLS_MD_CAN_SHA1)
Jerry Yu0ebce952022-06-16 13:54:47 +08002415 case MBEDTLS_SSL_HASH_SHA1:
2416 break;
2417#endif
2418
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002419#if defined(MBEDTLS_MD_CAN_SHA224)
Jerry Yu0ebce952022-06-16 13:54:47 +08002420 case MBEDTLS_SSL_HASH_SHA224:
2421 break;
2422#endif
2423
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002424#if defined(MBEDTLS_MD_CAN_SHA256)
Jerry Yu0ebce952022-06-16 13:54:47 +08002425 case MBEDTLS_SSL_HASH_SHA256:
2426 break;
2427#endif
2428
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002429#if defined(MBEDTLS_MD_CAN_SHA384)
Jerry Yu0ebce952022-06-16 13:54:47 +08002430 case MBEDTLS_SSL_HASH_SHA384:
2431 break;
2432#endif
2433
Manuel Pégourié-Gonnardbef824d2023-03-17 12:50:01 +01002434#if defined(MBEDTLS_MD_CAN_SHA512)
Jerry Yu0ebce952022-06-16 13:54:47 +08002435 case MBEDTLS_SSL_HASH_SHA512:
2436 break;
2437#endif
2438
2439 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return 0;
Jerry Yu0ebce952022-06-16 13:54:47 +08002441 }
2442
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 switch (sig) {
Jerry Yu0ebce952022-06-16 13:54:47 +08002444#if defined(MBEDTLS_RSA_C)
2445 case MBEDTLS_SSL_SIG_RSA:
2446 break;
2447#endif
2448
Valerio Setti1ad9ef22023-02-22 12:38:07 +01002449#if defined(MBEDTLS_PK_CAN_ECDSA_SOME)
Jerry Yu0ebce952022-06-16 13:54:47 +08002450 case MBEDTLS_SSL_SIG_ECDSA:
2451 break;
2452#endif
2453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 default:
2455 return 0;
Jerry Yu0ebce952022-06-16 13:54:47 +08002456 }
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 return 1;
Jerry Yu0ebce952022-06-16 13:54:47 +08002459}
2460#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2461
Jerry Yu1bab3012022-01-19 17:43:22 +08002462static inline int mbedtls_ssl_sig_alg_is_supported(
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 const mbedtls_ssl_context *ssl,
2464 const uint16_t sig_alg)
Jerry Yu1bab3012022-01-19 17:43:22 +08002465{
2466
2467#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2) {
2469 return mbedtls_ssl_tls12_sig_alg_is_supported(sig_alg);
Jerry Yu1bab3012022-01-19 17:43:22 +08002470 }
2471#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2472
Ronald Cron928cbd32022-10-04 16:14:26 +02002473#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 if (ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
2475 return mbedtls_ssl_tls13_sig_alg_is_supported(sig_alg);
Jerry Yu1bab3012022-01-19 17:43:22 +08002476 }
Ronald Cron928cbd32022-10-04 16:14:26 +02002477#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002478 ((void) ssl);
2479 ((void) sig_alg);
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 return 0;
Jerry Yu1bab3012022-01-19 17:43:22 +08002481}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002482#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1bab3012022-01-19 17:43:22 +08002483
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002484#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002485/* Corresponding PSA algorithm for MBEDTLS_CIPHER_NULL.
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002486 * Same value is used for PSA_ALG_CATEGORY_CIPHER, hence it is
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002487 * guaranteed to not be a valid PSA algorithm identifier.
2488 */
2489#define MBEDTLS_SSL_NULL_CIPHER 0x04000000
2490
2491/**
2492 * \brief Translate mbedtls cipher type/taglen pair to psa:
2493 * algorithm, key type and key size.
2494 *
2495 * \param mbedtls_cipher_type [in] given mbedtls cipher type
2496 * \param taglen [in] given tag length
2497 * 0 - default tag length
2498 * \param alg [out] corresponding PSA alg
2499 * There is no corresponding PSA
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01002500 * alg for MBEDTLS_CIPHER_NULL, so
2501 * in this case MBEDTLS_SSL_NULL_CIPHER
2502 * is returned via this parameter
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002503 * \param key_type [out] corresponding PSA key type
2504 * \param key_size [out] corresponding PSA key size
2505 *
2506 * \return PSA_SUCCESS on success or PSA_ERROR_NOT_SUPPORTED if
2507 * conversion is not supported.
2508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509psa_status_t mbedtls_ssl_cipher_to_psa(mbedtls_cipher_type_t mbedtls_cipher_type,
2510 size_t taglen,
2511 psa_algorithm_t *alg,
2512 psa_key_type_t *key_type,
2513 size_t *key_size);
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002514
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05002515#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002516/**
2517 * \brief Convert given PSA status to mbedtls error code.
2518 *
2519 * \param status [in] given PSA status
2520 *
2521 * \return corresponding mbedtls error code
2522 */
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05002523static inline MBEDTLS_DEPRECATED int psa_ssl_status_to_mbedtls(psa_status_t status)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002524{
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 switch (status) {
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002526 case PSA_SUCCESS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 return 0;
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002528 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002530 case PSA_ERROR_NOT_SUPPORTED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
Przemyslaw Stekiel89dad932022-01-31 09:18:07 +01002532 case PSA_ERROR_INVALID_SIGNATURE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 return MBEDTLS_ERR_SSL_INVALID_MAC;
Gabor Mezeiadfeadc2022-03-21 12:17:49 +01002534 case PSA_ERROR_INVALID_ARGUMENT:
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
Gabor Mezeiadfeadc2022-03-21 12:17:49 +01002536 case PSA_ERROR_BAD_STATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Przemek Stekiel85836272022-04-05 10:50:53 +02002538 case PSA_ERROR_BUFFER_TOO_SMALL:
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 return MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL;
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002540 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 return MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED;
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002542 }
2543}
Andrzej Kurek8a045ce2022-12-23 11:00:06 -05002544#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002545#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu1bab3012022-01-19 17:43:22 +08002546
Valerio Setti02c25b52022-11-15 14:08:42 +01002547#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) && \
2548 defined(MBEDTLS_USE_PSA_CRYPTO)
Valerio Settifbbc1f32022-11-15 16:39:55 +01002549
Valerio Setti6b3dab02022-11-17 17:14:54 +01002550typedef enum {
2551 MBEDTLS_ECJPAKE_ROUND_ONE,
2552 MBEDTLS_ECJPAKE_ROUND_TWO
2553} mbedtls_ecjpake_rounds_t;
2554
Valerio Setti02c25b52022-11-15 14:08:42 +01002555/**
2556 * \brief Parse the provided input buffer for getting the first round
2557 * of key exchange. This code is common between server and client
2558 *
2559 * \param pake_ctx [in] the PAKE's operation/context structure
2560 * \param buf [in] input buffer to parse
2561 * \param len [in] length of the input buffer
Valerio Setti6b3dab02022-11-17 17:14:54 +01002562 * \param round [in] either MBEDTLS_ECJPAKE_ROUND_ONE or
2563 * MBEDTLS_ECJPAKE_ROUND_TWO
Valerio Setti02c25b52022-11-15 14:08:42 +01002564 *
2565 * \return 0 on success or a negative error code in case of failure
2566 */
Valerio Setti6b3dab02022-11-17 17:14:54 +01002567int mbedtls_psa_ecjpake_read_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 psa_pake_operation_t *pake_ctx,
2569 const unsigned char *buf,
2570 size_t len, mbedtls_ecjpake_rounds_t round);
Valerio Setti02c25b52022-11-15 14:08:42 +01002571
2572/**
2573 * \brief Write the first round of key exchange into the provided output
2574 * buffer. This code is common between server and client
2575 *
2576 * \param pake_ctx [in] the PAKE's operation/context structure
2577 * \param buf [out] the output buffer in which data will be written to
2578 * \param len [in] length of the output buffer
2579 * \param olen [out] the length of the data really written on the buffer
Valerio Setti6b3dab02022-11-17 17:14:54 +01002580 * \param round [in] either MBEDTLS_ECJPAKE_ROUND_ONE or
2581 * MBEDTLS_ECJPAKE_ROUND_TWO
Valerio Setti02c25b52022-11-15 14:08:42 +01002582 *
2583 * \return 0 on success or a negative error code in case of failure
2584 */
Valerio Setti6b3dab02022-11-17 17:14:54 +01002585int mbedtls_psa_ecjpake_write_round(
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 psa_pake_operation_t *pake_ctx,
2587 unsigned char *buf,
2588 size_t len, size_t *olen,
2589 mbedtls_ecjpake_rounds_t round);
Valerio Setti02c25b52022-11-15 14:08:42 +01002590
Valerio Setti02c25b52022-11-15 14:08:42 +01002591#endif //MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED && MBEDTLS_USE_PSA_CRYPTO
2592
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002593/**
2594 * \brief TLS record protection modes
2595 */
2596typedef enum {
2597 MBEDTLS_SSL_MODE_STREAM = 0,
2598 MBEDTLS_SSL_MODE_CBC,
2599 MBEDTLS_SSL_MODE_CBC_ETM,
2600 MBEDTLS_SSL_MODE_AEAD
2601} mbedtls_ssl_mode_t;
2602
Neil Armstrongab555e02022-04-04 11:07:59 +02002603mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 const mbedtls_ssl_transform *transform);
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002605
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002606#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrongab555e02022-04-04 11:07:59 +02002607mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 int encrypt_then_mac,
2609 const mbedtls_ssl_ciphersuite_t *suite);
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002610#else
Neil Armstrongab555e02022-04-04 11:07:59 +02002611mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 const mbedtls_ssl_ciphersuite_t *suite);
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002613#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002614
Valerio Setti080a22b2023-03-20 15:22:47 +01002615#if defined(PSA_WANT_ALG_ECDH)
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002616
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002617MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002618int mbedtls_ssl_tls13_read_public_ecdhe_share(mbedtls_ssl_context *ssl,
2619 const unsigned char *buf,
2620 size_t buf_len);
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002621
Valerio Setti080a22b2023-03-20 15:22:47 +01002622#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002623
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002624static inline int mbedtls_ssl_tls13_cipher_suite_is_offered(
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 mbedtls_ssl_context *ssl, int cipher_suite)
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002626{
2627 const int *ciphersuite_list = ssl->conf->ciphersuite_list;
2628
2629 /* Check whether we have offered this ciphersuite */
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 for (size_t i = 0; ciphersuite_list[i] != 0; i++) {
2631 if (ciphersuite_list[i] == cipher_suite) {
2632 return 1;
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002633 }
2634 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 return 0;
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002636}
2637
2638/**
2639 * \brief Validate cipher suite against config in SSL context.
2640 *
2641 * \param ssl SSL context
2642 * \param suite_info Cipher suite to validate
2643 * \param min_tls_version Minimal TLS version to accept a cipher suite
2644 * \param max_tls_version Maximal TLS version to accept a cipher suite
2645 *
2646 * \return 0 if valid, negative value otherwise.
2647 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002648MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002649int mbedtls_ssl_validate_ciphersuite(
2650 const mbedtls_ssl_context *ssl,
2651 const mbedtls_ssl_ciphersuite_t *suite_info,
2652 mbedtls_ssl_protocol_version min_tls_version,
Gilles Peskine449bd832023-01-11 14:50:10 +01002653 mbedtls_ssl_protocol_version max_tls_version);
XiaokangQian08037552022-04-20 07:16:41 +00002654
XiaokangQian40a35232022-05-07 09:02:40 +00002655#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002656MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002657int mbedtls_ssl_parse_server_name_ext(mbedtls_ssl_context *ssl,
2658 const unsigned char *buf,
2659 const unsigned char *end);
XiaokangQian40a35232022-05-07 09:02:40 +00002660#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2661
Jan Bruckner151f6422023-02-10 12:45:19 +01002662#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
Jan Brucknera0589e72023-03-15 11:04:45 +01002663#define MBEDTLS_SSL_RECORD_SIZE_LIMIT_EXTENSION_DATA_LENGTH (2)
2664#define MBEDTLS_SSL_RECORD_SIZE_LIMIT_MIN (64)
2665
Jan Bruckner151f6422023-02-10 12:45:19 +01002666MBEDTLS_CHECK_RETURN_CRITICAL
2667int mbedtls_ssl_tls13_parse_record_size_limit_ext(mbedtls_ssl_context *ssl,
2668 const unsigned char *buf,
2669 const unsigned char *end);
2670#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
2671
XiaokangQianacb39922022-06-17 10:18:48 +00002672#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002673MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002674int mbedtls_ssl_parse_alpn_ext(mbedtls_ssl_context *ssl,
2675 const unsigned char *buf,
2676 const unsigned char *end);
XiaokangQianacb39922022-06-17 10:18:48 +00002677
2678
Ronald Cronce7d76e2022-07-08 18:56:49 +02002679MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002680int mbedtls_ssl_write_alpn_ext(mbedtls_ssl_context *ssl,
2681 unsigned char *buf,
2682 unsigned char *end,
2683 size_t *out_len);
XiaokangQianacb39922022-06-17 10:18:48 +00002684#endif /* MBEDTLS_SSL_ALPN */
2685
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002686#if defined(MBEDTLS_TEST_HOOKS)
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04002687int mbedtls_ssl_check_dtls_clihlo_cookie(
Gilles Peskine449bd832023-01-11 14:50:10 +01002688 mbedtls_ssl_context *ssl,
2689 const unsigned char *cli_id, size_t cli_id_len,
2690 const unsigned char *in, size_t in_len,
2691 unsigned char *obuf, size_t buf_len, size_t *olen);
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002692#endif
2693
Ronald Cron41a443a2022-10-04 16:38:25 +02002694#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00002695/**
2696 * \brief Given an SSL context and its associated configuration, write the TLS
2697 * 1.3 specific Pre-Shared key extension.
2698 *
2699 * \param[in] ssl SSL context
2700 * \param[in] buf Base address of the buffer where to write the extension
2701 * \param[in] end End address of the buffer where to write the extension
XiaokangQian008d2bf2022-07-14 07:54:01 +00002702 * \param[out] out_len Length in bytes of the Pre-Shared key extension: data
2703 * written into the buffer \p buf by this function plus
2704 * the length of the binders to be written.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002705 * \param[out] binders_len Length of the binders to be written at the end of
XiaokangQian008d2bf2022-07-14 07:54:01 +00002706 * the extension.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002707 */
XiaokangQian86981952022-07-19 09:51:50 +00002708MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian3ad67bf2022-07-21 02:26:21 +00002709int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002710 mbedtls_ssl_context *ssl,
2711 unsigned char *buf, unsigned char *end,
Gilles Peskine449bd832023-01-11 14:50:10 +01002712 size_t *out_len, size_t *binders_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +00002713
2714/**
2715 * \brief Given an SSL context and its associated configuration, write the TLS
2716 * 1.3 specific Pre-Shared key extension binders at the end of the
2717 * ClientHello.
2718 *
2719 * \param[in] ssl SSL context
XiaokangQian008d2bf2022-07-14 07:54:01 +00002720 * \param[in] buf Base address of the buffer where to write the binders
2721 * \param[in] end End address of the buffer where to write the binders
XiaokangQianeb69aee2022-07-05 08:21:43 +00002722 */
XiaokangQian86981952022-07-19 09:51:50 +00002723MBEDTLS_CHECK_RETURN_CRITICAL
2724int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002725 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 unsigned char *buf, unsigned char *end);
Ronald Cron41a443a2022-10-04 16:38:25 +02002727#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00002728
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002729#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00002730 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002731 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00002732 defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qian03409292022-10-12 02:49:52 +00002733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002734int mbedtls_ssl_session_set_hostname(mbedtls_ssl_session *session,
2735 const char *hostname);
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002736#endif
2737
Pengyu Lvb7d50ac2022-11-17 15:14:12 +08002738#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lv80270b22023-01-12 11:54:04 +08002739static inline unsigned int mbedtls_ssl_session_get_ticket_flags(
Pengyu Lvacecf9c2023-01-16 11:23:24 +08002740 mbedtls_ssl_session *session, unsigned int flags)
Pengyu Lvb7d50ac2022-11-17 15:14:12 +08002741{
2742 return session->ticket_flags &
2743 (flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
2744}
2745
Pengyu Lv80270b22023-01-12 11:54:04 +08002746static inline void mbedtls_ssl_session_set_ticket_flags(
Pengyu Lvacecf9c2023-01-16 11:23:24 +08002747 mbedtls_ssl_session *session, unsigned int flags)
Pengyu Lvb7d50ac2022-11-17 15:14:12 +08002748{
2749 session->ticket_flags |= (flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
2750}
2751
Pengyu Lv80270b22023-01-12 11:54:04 +08002752static inline void mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lvacecf9c2023-01-16 11:23:24 +08002753 mbedtls_ssl_session *session, unsigned int flags)
Pengyu Lvb7d50ac2022-11-17 15:14:12 +08002754{
2755 session->ticket_flags &= ~(flags & MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
2756}
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002757#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Pengyu Lvb7d50ac2022-11-17 15:14:12 +08002758
Xiaokang Qianb46275c2023-01-04 07:38:50 +00002759#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002760int mbedtls_ssl_tls13_finalize_client_hello(mbedtls_ssl_context *ssl);
Xiaokang Qianb46275c2023-01-04 07:38:50 +00002761#endif
Xiaokang Qian126929f2023-01-03 10:29:41 +00002762
Chris Jones84a773f2021-03-05 18:38:47 +00002763#endif /* ssl_misc.h */