blob: aaa910fc81065edeb0488f16d0cf6f7bd2232833 [file] [log] [blame]
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001/**
Chris Jones84a773f2021-03-05 18:38:47 +00002 * \file ssl_misc.h
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02003 *
4 * \brief Internal functions shared by the SSL modules
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020021 */
Chris Jones84a773f2021-03-05 18:38:47 +000022#ifndef MBEDTLS_SSL_MISC_H
23#define MBEDTLS_SSL_MISC_H
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020024
Bence Szépkútic662b362021-05-27 11:25:03 +020025#include "mbedtls/build_info.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050026
Jaeden Amero6609aef2019-07-04 20:01:14 +010027#include "mbedtls/ssl.h"
28#include "mbedtls/cipher.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020029
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +010030#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Andrzej Kurekeb342242019-01-29 09:14:33 -050031#include "psa/crypto.h"
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +010032#include "mbedtls/psa_util.h"
Manuel Pégourié-Gonnardabac0372022-07-18 13:41:11 +020033#include "hash_info.h"
Andrzej Kurekeb342242019-01-29 09:14:33 -050034#endif
Manuel Pégourié-Gonnard07018f92022-09-15 11:29:35 +020035#include "mbedtls/legacy_or_psa.h"
Andrzej Kurekeb342242019-01-29 09:14:33 -050036
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020037#if defined(MBEDTLS_MD5_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010038#include "mbedtls/md5.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020039#endif
40
41#if defined(MBEDTLS_SHA1_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010042#include "mbedtls/sha1.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020043#endif
44
45#if defined(MBEDTLS_SHA256_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010046#include "mbedtls/sha256.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020047#endif
48
49#if defined(MBEDTLS_SHA512_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010050#include "mbedtls/sha512.h"
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020051#endif
52
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +020053#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Jaeden Amero6609aef2019-07-04 20:01:14 +010054#include "mbedtls/ecjpake.h"
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +020055#endif
56
Jerry Yu1bab3012022-01-19 17:43:22 +080057#include "common.h"
58
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010059#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
60 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020061#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020062#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020063
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +020064/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020065#if defined(MBEDTLS_ECP_RESTARTABLE) && \
66 defined(MBEDTLS_SSL_CLI_C) && \
67 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
68 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Gilles Peskineeccd8882020-03-10 12:19:08 +010069#define MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +020070#endif
71
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020072#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
73#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
74#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
75#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
76
77/*
Jerry Yu8e7ca042021-08-26 15:31:37 +080078 * Mask of TLS 1.3 handshake extensions used in extensions_present
79 * of mbedtls_ssl_handshake_params.
80 */
81#define MBEDTLS_SSL_EXT_NONE 0
82
83#define MBEDTLS_SSL_EXT_SERVERNAME ( 1 << 0 )
84#define MBEDTLS_SSL_EXT_MAX_FRAGMENT_LENGTH ( 1 << 1 )
85#define MBEDTLS_SSL_EXT_STATUS_REQUEST ( 1 << 2 )
86#define MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ( 1 << 3 )
87#define MBEDTLS_SSL_EXT_SIG_ALG ( 1 << 4 )
88#define MBEDTLS_SSL_EXT_USE_SRTP ( 1 << 5 )
89#define MBEDTLS_SSL_EXT_HEARTBEAT ( 1 << 6 )
90#define MBEDTLS_SSL_EXT_ALPN ( 1 << 7 )
91#define MBEDTLS_SSL_EXT_SCT ( 1 << 8 )
Jerry Yu995ecd32021-08-30 17:53:49 +080092#define MBEDTLS_SSL_EXT_CLI_CERT_TYPE ( 1 << 9 )
93#define MBEDTLS_SSL_EXT_SERV_CERT_TYPE ( 1 << 10 )
Jerry Yu8e7ca042021-08-26 15:31:37 +080094#define MBEDTLS_SSL_EXT_PADDING ( 1 << 11 )
95#define MBEDTLS_SSL_EXT_PRE_SHARED_KEY ( 1 << 12 )
96#define MBEDTLS_SSL_EXT_EARLY_DATA ( 1 << 13 )
97#define MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ( 1 << 14 )
98#define MBEDTLS_SSL_EXT_COOKIE ( 1 << 15 )
99#define MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ( 1 << 16 )
100#define MBEDTLS_SSL_EXT_CERT_AUTH ( 1 << 17 )
101#define MBEDTLS_SSL_EXT_OID_FILTERS ( 1 << 18 )
102#define MBEDTLS_SSL_EXT_POST_HANDSHAKE_AUTH ( 1 << 19 )
103#define MBEDTLS_SSL_EXT_SIG_ALG_CERT ( 1 << 20 )
104#define MBEDTLS_SSL_EXT_KEY_SHARE ( 1 << 21 )
Jerry Yu93bcd612021-08-18 12:47:24 +0800105
Jerry Yud15992d2022-08-29 10:58:31 +0800106/* For request messages, we should just ignore unrecognized extension when
107 * parsing messages. For response messages, we should not ignore unrecognized
108 * extension when parsing messages. Request messages include ClientHello,
109 * Certificate and NewSessionTicket. Response messages include ServerHello,
110 * EncryptExtensions, Certificate and HelloRetryRequest.
Jerry Yue18dc7e2022-08-04 16:29:22 +0800111 *
Jerry Yud15992d2022-08-29 10:58:31 +0800112 * RFC 8446 section 4.1.3
Jerry Yue18dc7e2022-08-04 16:29:22 +0800113 *
114 * The ServerHello MUST only include extensions which are required to establish
115 * the cryptographic context and negotiate the protocol version.
116 *
Jerry Yud15992d2022-08-29 10:58:31 +0800117 * RFC 8446 section 4.2
Jerry Yue18dc7e2022-08-04 16:29:22 +0800118 *
119 * If an implementation receives an extension which it recognizes and which is
120 * not specified for the message in which it appears, it MUST abort the handshake
121 * with an "illegal_parameter" alert.
122 */
123#define MBEDTLS_SSL_EXT_UNRECOGNIZED ( 1U << 31 )
124
Jerry Yud15992d2022-08-29 10:58:31 +0800125/* RFC 8446 section 4.2. Allowed extensions for ClienHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800126#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH \
127 ( MBEDTLS_SSL_EXT_SERVERNAME | \
128 MBEDTLS_SSL_EXT_MAX_FRAGMENT_LENGTH | \
129 MBEDTLS_SSL_EXT_STATUS_REQUEST | \
130 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS | \
131 MBEDTLS_SSL_EXT_SIG_ALG | \
132 MBEDTLS_SSL_EXT_USE_SRTP | \
133 MBEDTLS_SSL_EXT_HEARTBEAT | \
134 MBEDTLS_SSL_EXT_ALPN | \
135 MBEDTLS_SSL_EXT_SCT | \
136 MBEDTLS_SSL_EXT_CLI_CERT_TYPE | \
137 MBEDTLS_SSL_EXT_SERV_CERT_TYPE | \
138 MBEDTLS_SSL_EXT_PADDING | \
139 MBEDTLS_SSL_EXT_KEY_SHARE | \
140 MBEDTLS_SSL_EXT_PRE_SHARED_KEY | \
141 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES | \
142 MBEDTLS_SSL_EXT_EARLY_DATA | \
143 MBEDTLS_SSL_EXT_COOKIE | \
144 MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS | \
145 MBEDTLS_SSL_EXT_CERT_AUTH | \
146 MBEDTLS_SSL_EXT_POST_HANDSHAKE_AUTH | \
147 MBEDTLS_SSL_EXT_SIG_ALG_CERT | \
148 MBEDTLS_SSL_EXT_UNRECOGNIZED )
149
Jerry Yud15992d2022-08-29 10:58:31 +0800150/* RFC 8446 section 4.2. Allowed extensions for EncryptedExtensions */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800151#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_EE \
152 ( MBEDTLS_SSL_EXT_SERVERNAME | \
153 MBEDTLS_SSL_EXT_MAX_FRAGMENT_LENGTH | \
154 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS | \
155 MBEDTLS_SSL_EXT_USE_SRTP | \
156 MBEDTLS_SSL_EXT_HEARTBEAT | \
157 MBEDTLS_SSL_EXT_ALPN | \
158 MBEDTLS_SSL_EXT_CLI_CERT_TYPE | \
159 MBEDTLS_SSL_EXT_SERV_CERT_TYPE | \
Jerry Yud15992d2022-08-29 10:58:31 +0800160 MBEDTLS_SSL_EXT_EARLY_DATA )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800161
Jerry Yud15992d2022-08-29 10:58:31 +0800162/* RFC 8446 section 4.2. Allowed extensions for CertificateRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800163#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CR \
164 ( MBEDTLS_SSL_EXT_STATUS_REQUEST | \
165 MBEDTLS_SSL_EXT_SIG_ALG | \
166 MBEDTLS_SSL_EXT_SCT | \
167 MBEDTLS_SSL_EXT_CERT_AUTH | \
168 MBEDTLS_SSL_EXT_OID_FILTERS | \
169 MBEDTLS_SSL_EXT_SIG_ALG_CERT | \
170 MBEDTLS_SSL_EXT_UNRECOGNIZED )
171
Jerry Yud15992d2022-08-29 10:58:31 +0800172/* RFC 8446 section 4.2. Allowed extensions for Certificate */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800173#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CT \
174 ( MBEDTLS_SSL_EXT_STATUS_REQUEST | \
Jerry Yud15992d2022-08-29 10:58:31 +0800175 MBEDTLS_SSL_EXT_SCT )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800176
Jerry Yud15992d2022-08-29 10:58:31 +0800177/* RFC 8446 section 4.2. Allowed extensions for ServerHello */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800178#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_SH \
179 ( MBEDTLS_SSL_EXT_KEY_SHARE | \
180 MBEDTLS_SSL_EXT_PRE_SHARED_KEY | \
181 MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS )
182
Jerry Yud15992d2022-08-29 10:58:31 +0800183/* RFC 8446 section 4.2. Allowed extensions for HelloRetryRequest */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800184#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_HRR \
185 ( MBEDTLS_SSL_EXT_KEY_SHARE | \
186 MBEDTLS_SSL_EXT_COOKIE | \
Jerry Yud15992d2022-08-29 10:58:31 +0800187 MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS )
Jerry Yue18dc7e2022-08-04 16:29:22 +0800188
Jerry Yud15992d2022-08-29 10:58:31 +0800189/* RFC 8446 section 4.2. Allowed extensions for NewSessionTicket */
Jerry Yue18dc7e2022-08-04 16:29:22 +0800190#define MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_NST \
191 ( MBEDTLS_SSL_EXT_EARLY_DATA | \
192 MBEDTLS_SSL_EXT_UNRECOGNIZED )
193
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800194/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800195 * Helper macros for function call with return check.
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800196 */
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800197/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800198 * Exit when return non-zero value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800199 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800200#define MBEDTLS_SSL_PROC_CHK( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800201 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800202 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800203 if( ret != 0 ) \
204 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800205 goto cleanup; \
206 } \
207 } while( 0 )
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800208/*
Jerry Yu8c02bb42021-09-03 21:09:22 +0800209 * Exit when return negative value
Jerry Yu5cc8f0a2021-08-27 17:21:44 +0800210 */
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800211#define MBEDTLS_SSL_PROC_CHK_NEG( f ) \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800212 do { \
Jerry Yu2c0fbf32021-09-02 13:53:46 +0800213 ret = ( f ); \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800214 if( ret < 0 ) \
215 { \
Jerry Yu65dd2cc2021-08-18 16:38:40 +0800216 goto cleanup; \
217 } \
218 } while( 0 )
219
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200220/*
221 * DTLS retransmission states, see RFC 6347 4.2.4
222 *
223 * The SENDING state is merged in PREPARING for initial sends,
224 * but is distinct for resends.
225 *
226 * Note: initial state is wrong for server, but is not used anyway.
227 */
228#define MBEDTLS_SSL_RETRANS_PREPARING 0
229#define MBEDTLS_SSL_RETRANS_SENDING 1
230#define MBEDTLS_SSL_RETRANS_WAITING 2
231#define MBEDTLS_SSL_RETRANS_FINISHED 3
232
233/*
234 * Allow extra bytes for record, authentication and encryption overhead:
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100235 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256).
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200236 */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200237
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200238#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0cc46612020-11-30 08:56:52 +0000239
Manuel Pégourié-Gonnard05579c42020-07-31 12:53:39 +0200240/* This macro determines whether CBC is supported. */
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200241#if defined(MBEDTLS_CIPHER_MODE_CBC) && \
242 ( defined(MBEDTLS_AES_C) || \
243 defined(MBEDTLS_CAMELLIA_C) || \
244 defined(MBEDTLS_ARIA_C) || \
245 defined(MBEDTLS_DES_C) )
246#define MBEDTLS_SSL_SOME_SUITES_USE_CBC
247#endif
248
Hanno Becker0cc46612020-11-30 08:56:52 +0000249/* This macro determines whether a ciphersuite using a
250 * stream cipher can be used. */
251#if defined(MBEDTLS_CIPHER_NULL_CIPHER)
252#define MBEDTLS_SSL_SOME_SUITES_USE_STREAM
253#endif
254
TRodziewicz0f82ec62021-05-12 17:49:18 +0200255/* This macro determines whether the CBC construct used in TLS 1.2 is supported. */
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200256#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
TRodziewicz0f82ec62021-05-12 17:49:18 +0200257 defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarded0e8642020-07-21 11:20:30 +0200258#define MBEDTLS_SSL_SOME_SUITES_USE_TLS_CBC
259#endif
260
Hanno Becker31351ce2021-03-22 11:05:58 +0000261#if defined(MBEDTLS_SSL_SOME_SUITES_USE_STREAM) || \
Manuel Pégourié-Gonnard2df1f1f2020-07-09 12:11:39 +0200262 defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC)
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000263#define MBEDTLS_SSL_SOME_SUITES_USE_MAC
Hanno Becker52344c22018-01-03 15:24:20 +0000264#endif
265
Neil Armstrongf2c82f02022-04-05 11:16:53 +0200266/* This macro determines whether a ciphersuite uses Encrypt-then-MAC with CBC */
267#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC) && \
268 defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
269#define MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM
270#endif
271
TRodziewicz4ca18aa2021-05-20 14:46:20 +0200272#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker0cc46612020-11-30 08:56:52 +0000273
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000274#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200275/* Ciphersuites using HMAC */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400276#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200277#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400278#elif defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200279#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
280#else
281#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
282#endif
Hanno Beckerfd86ca82020-11-30 08:54:23 +0000283#else /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200284/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
285#define MBEDTLS_SSL_MAC_ADD 16
286#endif
287
288#if defined(MBEDTLS_CIPHER_MODE_CBC)
289#define MBEDTLS_SSL_PADDING_ADD 256
290#else
291#define MBEDTLS_SSL_PADDING_ADD 0
292#endif
293
Hanno Beckera0e20d02019-05-15 14:03:01 +0100294#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
TRodziewicze8dd7092021-05-12 14:19:11 +0200295#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY
Hanno Becker6cbad552019-05-08 15:40:11 +0100296#else
297#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
298#endif
299
Mateusz Starzyka3a99842021-02-19 14:27:22 +0100300#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_MAX_IV_LENGTH + \
Angus Grattond8213d02016-05-25 20:56:48 +1000301 MBEDTLS_SSL_MAC_ADD + \
Hanno Becker6cbad552019-05-08 15:40:11 +0100302 MBEDTLS_SSL_PADDING_ADD + \
303 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000304 )
305
306#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
307 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
308
309#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
310 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
311
Hanno Becker0271f962018-08-16 13:23:47 +0100312/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100313#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100314
Angus Grattond8213d02016-05-25 20:56:48 +1000315/* Maximum length we can advertise as our max content length for
316 RFC 6066 max_fragment_length extension negotiation purposes
317 (the lesser of both sizes, if they are unequal.)
318 */
319#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
320 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
321 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
322 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
323 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200324
Jerry Yu4131ec12022-01-19 10:36:30 +0800325/* Maximum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
326#define MBEDTLS_SSL_MAX_SIG_ALG_LIST_LEN 65534
327
Jerry Yu8afd6e42022-01-20 15:54:26 +0800328/* Minimum size in bytes of list in signature algorithms ext., RFC 5246/8446 */
Jerry Yu4131ec12022-01-19 10:36:30 +0800329#define MBEDTLS_SSL_MIN_SIG_ALG_LIST_LEN 2
Hanno Beckere131bfe2017-04-12 14:54:42 +0100330
331/* Maximum size in bytes of list in supported elliptic curve ext., RFC 4492 */
332#define MBEDTLS_SSL_MAX_CURVE_LIST_LEN 65535
333
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000334#define MBEDTLS_RECEIVED_SIG_ALGS_SIZE 20
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +0000335
Ronald Crone68ab4f2022-10-05 12:46:29 +0200336#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200337
Gabor Mezei24c7c2b2022-05-10 12:51:14 +0200338#define MBEDTLS_TLS_SIG_NONE MBEDTLS_TLS1_3_SIG_NONE
339
Gabor Mezei15b95a62022-05-09 16:37:58 +0200340#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Gabor Mezei3631cf62022-05-10 12:59:00 +0200341#define MBEDTLS_SSL_TLS12_SIG_AND_HASH_ALG( sig, hash ) (( hash << 8 ) | sig)
342#define MBEDTLS_SSL_TLS12_SIG_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg & 0xFF)
343#define MBEDTLS_SSL_TLS12_HASH_ALG_FROM_SIG_AND_HASH_ALG(alg) (alg >> 8)
Gabor Mezei15b95a62022-05-09 16:37:58 +0200344#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
345
Ronald Crone68ab4f2022-10-05 12:46:29 +0200346#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Gabor Mezei15b95a62022-05-09 16:37:58 +0200347
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200348/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100349 * Check that we obey the standard's message size bounds
350 */
351
David Horstmann95d516f2021-05-04 18:36:56 +0100352#if MBEDTLS_SSL_IN_CONTENT_LEN > 16384
353#error "Bad configuration - incoming record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100354#endif
355
David Horstmann95d516f2021-05-04 18:36:56 +0100356#if MBEDTLS_SSL_OUT_CONTENT_LEN > 16384
357#error "Bad configuration - outgoing record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100358#endif
359
David Horstmann95d516f2021-05-04 18:36:56 +0100360#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_IN_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000361#error "Bad configuration - incoming protected record payload too large."
362#endif
363
David Horstmann95d516f2021-05-04 18:36:56 +0100364#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN + 2048
Angus Grattond8213d02016-05-25 20:56:48 +1000365#error "Bad configuration - outgoing protected record payload too large."
366#endif
367
368/* Calculate buffer sizes */
369
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000370/* Note: Even though the TLS record header is only 5 bytes
371 long, we're internally using 8 bytes to store the
372 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100373#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100374
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500375#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000376#define MBEDTLS_SSL_IN_BUFFER_LEN \
377 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100378#else
379#define MBEDTLS_SSL_IN_BUFFER_LEN \
380 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
381 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
382#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000383
Andrzej Kurek033c42a2020-03-03 05:57:59 -0500384#if !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000385#define MBEDTLS_SSL_OUT_BUFFER_LEN \
386 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Becker6cbad552019-05-08 15:40:11 +0100387#else
388#define MBEDTLS_SSL_OUT_BUFFER_LEN \
389 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
390 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
391#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000392
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800393#define MBEDTLS_CLIENT_HELLO_RANDOM_LEN 32
394#define MBEDTLS_SERVER_HELLO_RANDOM_LEN 32
395
Hanno Becker9752aad2021-04-21 05:54:33 +0100396#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
397/**
398 * \brief Return the maximum fragment length (payload, in bytes) for
399 * the output buffer. For the client, this is the configured
400 * value. For the server, it is the minimum of two - the
401 * configured value and the negotiated one.
402 *
403 * \sa mbedtls_ssl_conf_max_frag_len()
404 * \sa mbedtls_ssl_get_max_out_record_payload()
405 *
406 * \param ssl SSL context
407 *
408 * \return Current maximum fragment length for the output buffer.
409 */
410size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl );
411
412/**
413 * \brief Return the maximum fragment length (payload, in bytes) for
414 * the input buffer. This is the negotiated maximum fragment
Hanno Beckerdf3b8632021-06-08 05:30:45 +0100415 * length, or, if there is none, MBEDTLS_SSL_IN_CONTENT_LEN.
Hanno Becker9752aad2021-04-21 05:54:33 +0100416 * If it is not defined either, the value is 2^14. This function
417 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
418 *
419 * \sa mbedtls_ssl_conf_max_frag_len()
420 * \sa mbedtls_ssl_get_max_in_record_payload()
421 *
422 * \param ssl SSL context
423 *
424 * \return Current maximum fragment length for the output buffer.
425 */
426size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl );
427#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
428
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500429#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500430static inline size_t mbedtls_ssl_get_output_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500431{
432#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500433 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500434 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
435 + MBEDTLS_SSL_CID_OUT_LEN_MAX;
436#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500437 return mbedtls_ssl_get_output_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500438 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
439#endif
440}
441
Andrzej Kurek069fa962021-01-07 08:02:15 -0500442static inline size_t mbedtls_ssl_get_input_buflen( const mbedtls_ssl_context *ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500443{
444#if defined (MBEDTLS_SSL_DTLS_CONNECTION_ID)
Andrzej Kurek069fa962021-01-07 08:02:15 -0500445 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500446 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD
447 + MBEDTLS_SSL_CID_IN_LEN_MAX;
448#else
Andrzej Kurek069fa962021-01-07 08:02:15 -0500449 return mbedtls_ssl_get_input_max_frag_len( ctx )
Andrzej Kurek0afa2a12020-03-03 10:39:58 -0500450 + MBEDTLS_SSL_HEADER_LEN + MBEDTLS_SSL_PAYLOAD_OVERHEAD;
451#endif
452}
453#endif
454
Hanno Beckera8434e82017-09-18 10:54:39 +0100455/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200456 * TLS extension flags (for extensions with outgoing ServerHello content
457 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
458 * of state of the renegotiation flag, so no indicator is required)
459 */
460#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200461#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200462
Hanno Becker51018aa2017-04-12 14:54:42 +0100463/**
464 * \brief This function checks if the remaining size in a buffer is
465 * greater or equal than a needed space.
466 *
467 * \param cur Pointer to the current position in the buffer.
468 * \param end Pointer to one past the end of the buffer.
469 * \param need Needed space in bytes.
470 *
Ronald Cronb7b35e12020-06-11 09:50:51 +0200471 * \return Zero if the needed space is available in the buffer, non-zero
Hanno Becker51018aa2017-04-12 14:54:42 +0100472 * otherwise.
473 */
Ronald Cronad8c17b2022-06-10 17:18:09 +0200474#if ! defined(MBEDTLS_TEST_HOOKS)
Hanno Becker51018aa2017-04-12 14:54:42 +0100475static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
476 const uint8_t *end, size_t need )
477{
Ronald Cronb7b35e12020-06-11 09:50:51 +0200478 return( ( cur > end ) || ( need > (size_t)( end - cur ) ) );
Hanno Becker51018aa2017-04-12 14:54:42 +0100479}
Ronald Cronad8c17b2022-06-10 17:18:09 +0200480#else
481typedef struct
482{
483 const uint8_t *cur;
484 const uint8_t *end;
485 size_t need;
486} mbedtls_ssl_chk_buf_ptr_args;
487
488void mbedtls_ssl_set_chk_buf_ptr_fail_args(
489 const uint8_t *cur, const uint8_t *end, size_t need );
490void mbedtls_ssl_reset_chk_buf_ptr_fail_args( void );
Ronald Cronce7d76e2022-07-08 18:56:49 +0200491
492MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronad8c17b2022-06-10 17:18:09 +0200493int mbedtls_ssl_cmp_chk_buf_ptr_fail_args( mbedtls_ssl_chk_buf_ptr_args *args );
494
495static inline int mbedtls_ssl_chk_buf_ptr( const uint8_t *cur,
496 const uint8_t *end, size_t need )
497{
498 if( ( cur > end ) || ( need > (size_t)( end - cur ) ) )
499 {
500 mbedtls_ssl_set_chk_buf_ptr_fail_args( cur, end, need );
501 return( 1 );
502 }
503 return( 0 );
504}
Ronald Croncf600bc2022-06-17 15:54:16 +0200505#endif /* MBEDTLS_TEST_HOOKS */
Hanno Becker51018aa2017-04-12 14:54:42 +0100506
507/**
508 * \brief This macro checks if the remaining size in a buffer is
509 * greater or equal than a needed space. If it is not the case,
510 * it returns an SSL_BUFFER_TOO_SMALL error.
511 *
512 * \param cur Pointer to the current position in the buffer.
513 * \param end Pointer to one past the end of the buffer.
514 * \param need Needed space in bytes.
515 *
516 */
517#define MBEDTLS_SSL_CHK_BUF_PTR( cur, end, need ) \
518 do { \
Ronald Cronb7b35e12020-06-11 09:50:51 +0200519 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
Hanno Becker51018aa2017-04-12 14:54:42 +0100520 { \
521 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL ); \
522 } \
523 } while( 0 )
524
Jerry Yu34da3722021-09-19 18:05:08 +0800525/**
Jerry Yue15e6652021-09-28 21:06:07 +0800526 * \brief This macro checks if the remaining length in an input buffer is
527 * greater or equal than a needed length. If it is not the case, it
Jerry Yu205fd822021-10-08 16:16:24 +0800528 * returns #MBEDTLS_ERR_SSL_DECODE_ERROR error and pends a
Jerry Yudca3d5d2021-10-08 14:19:29 +0800529 * #MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR alert message.
Jerry Yue4eefc72021-10-09 10:40:40 +0800530 *
531 * This is a function-like macro. It is guaranteed to evaluate each
532 * argument exactly once.
Jerry Yu34da3722021-09-19 18:05:08 +0800533 *
534 * \param cur Pointer to the current position in the buffer.
535 * \param end Pointer to one past the end of the buffer.
Jerry Yue15e6652021-09-28 21:06:07 +0800536 * \param need Needed length in bytes.
Jerry Yu34da3722021-09-19 18:05:08 +0800537 *
538 */
539#define MBEDTLS_SSL_CHK_BUF_READ_PTR( cur, end, need ) \
540 do { \
541 if( mbedtls_ssl_chk_buf_ptr( ( cur ), ( end ), ( need ) ) != 0 ) \
542 { \
543 MBEDTLS_SSL_DEBUG_MSG( 1, \
544 ( "missing input data in %s", __func__ ) ); \
545 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR, \
546 MBEDTLS_ERR_SSL_DECODE_ERROR ); \
547 return( MBEDTLS_ERR_SSL_DECODE_ERROR ); \
548 } \
549 } while( 0 )
550
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200551#ifdef __cplusplus
552extern "C" {
553#endif
554
Ron Eldor51d3ab52019-05-12 14:54:30 +0300555typedef int mbedtls_ssl_tls_prf_cb( const unsigned char *secret, size_t slen,
556 const char *label,
557 const unsigned char *random, size_t rlen,
558 unsigned char *dstbuf, size_t dlen );
Hanno Becker3385a4d2020-08-21 13:03:34 +0100559
Hanno Becker61baae72020-09-16 09:24:14 +0100560/* cipher.h exports the maximum IV, key and block length from
Hanno Becker15889832020-09-08 11:29:11 +0100561 * all ciphers enabled in the config, regardless of whether those
562 * ciphers are actually usable in SSL/TLS. Notably, XTS is enabled
563 * in the default configuration and uses 64 Byte keys, but it is
564 * not used for record protection in SSL/TLS.
565 *
566 * In order to prevent unnecessary inflation of key structures,
567 * we introduce SSL-specific variants of the max-{key,block,IV}
568 * macros here which are meant to only take those ciphers into
569 * account which can be negotiated in SSL/TLS.
570 *
571 * Since the current definitions of MBEDTLS_MAX_{KEY|BLOCK|IV}_LENGTH
572 * in cipher.h are rough overapproximations of the real maxima, here
Hanno Becker9a7a2ac2020-09-09 09:24:54 +0100573 * we content ourselves with replicating those overapproximations
Hanno Becker15889832020-09-08 11:29:11 +0100574 * for the maximum block and IV length, and excluding XTS from the
575 * computation of the maximum key length. */
576#define MBEDTLS_SSL_MAX_BLOCK_LENGTH 16
577#define MBEDTLS_SSL_MAX_IV_LENGTH 16
578#define MBEDTLS_SSL_MAX_KEY_LENGTH 32
579
Hanno Becker3385a4d2020-08-21 13:03:34 +0100580/**
581 * \brief The data structure holding the cryptographic material (key and IV)
582 * used for record protection in TLS 1.3.
583 */
584struct mbedtls_ssl_key_set
585{
586 /*! The key for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100587 unsigned char client_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100588 /*! The key for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100589 unsigned char server_write_key[ MBEDTLS_SSL_MAX_KEY_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100590 /*! The IV for client->server records. */
Hanno Becker15889832020-09-08 11:29:11 +0100591 unsigned char client_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100592 /*! The IV for server->client records. */
Hanno Becker15889832020-09-08 11:29:11 +0100593 unsigned char server_write_iv[ MBEDTLS_SSL_MAX_IV_LENGTH ];
Hanno Becker3385a4d2020-08-21 13:03:34 +0100594
Hanno Becker493ea7f2020-09-08 11:01:00 +0100595 size_t key_len; /*!< The length of client_write_key and
596 * server_write_key, in Bytes. */
597 size_t iv_len; /*!< The length of client_write_iv and
598 * server_write_iv, in Bytes. */
Hanno Becker3385a4d2020-08-21 13:03:34 +0100599};
600typedef struct mbedtls_ssl_key_set mbedtls_ssl_key_set;
Hanno Becker3385a4d2020-08-21 13:03:34 +0100601
Jerry Yu61e35e02021-09-16 18:59:08 +0800602typedef struct
603{
Jerry Yuf532bb22021-10-13 10:34:03 +0800604 unsigned char binder_key [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
605 unsigned char client_early_traffic_secret [ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
606 unsigned char early_exporter_master_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000607} mbedtls_ssl_tls13_early_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800608
609typedef struct
610{
Jerry Yuf532bb22021-10-13 10:34:03 +0800611 unsigned char client_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
612 unsigned char server_handshake_traffic_secret[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Xiaofei Bai746f9482021-11-12 08:53:56 +0000613} mbedtls_ssl_tls13_handshake_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800614
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200615/*
616 * This structure contains the parameters only needed during handshake.
617 */
618struct mbedtls_ssl_handshake_params
619{
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100620 /* Frequently-used boolean or byte fields (placed early to take
621 * advantage of smaller code size for indirect access on Arm Thumb) */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100622 uint8_t resume; /*!< session resume indicator*/
623 uint8_t cli_exts; /*!< client extension presence*/
624
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400625#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
626 uint8_t sni_authmode; /*!< authmode from SNI callback */
627#endif
628
XiaokangQian189ded22022-05-10 08:12:17 +0000629#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQianc3017f62022-05-13 05:55:41 +0000630 /* Flag indicating if a CertificateRequest message has been sent
631 * to the client or not. */
XiaokangQian63e713e2022-05-15 04:26:57 +0000632 uint8_t certificate_request_sent;
XiaokangQian189ded22022-05-10 08:12:17 +0000633#endif /* MBEDTLS_SSL_SRV_C */
634
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400635#if defined(MBEDTLS_SSL_SESSION_TICKETS)
636 uint8_t new_session_ticket; /*!< use NewSessionTicket? */
637#endif /* MBEDTLS_SSL_SESSION_TICKETS */
638
Ronald Cron82c785f2022-03-31 15:44:41 +0200639#if defined(MBEDTLS_SSL_CLI_C)
Ronald Cron217d6992022-04-04 10:23:22 +0200640 /** Minimum TLS version to be negotiated.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200641 *
Ronald Cron217d6992022-04-04 10:23:22 +0200642 * It is set up in the ClientHello writing preparation stage and used
643 * throughout the ClientHello writing. Not relevant anymore as soon as
644 * the protocol version has been negotiated thus as soon as the
645 * ServerHello is received.
646 * For a fresh handshake not linked to any previous handshake, it is
647 * equal to the configured minimum minor version to be negotiated. When
648 * renegotiating or resuming a session, it is equal to the previously
649 * negotiated minor version.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200650 *
Ronald Cron217d6992022-04-04 10:23:22 +0200651 * There is no maximum TLS version field in this handshake context.
652 * From the start of the handshake, we need to define a current protocol
653 * version for the record layer which we define as the maximum TLS
654 * version to be negotiated. The `tls_version` field of the SSL context is
655 * used to store this maximum value until it contains the actual
656 * negotiated value.
Ronald Cronbdb4f582022-03-31 15:37:44 +0200657 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -0400658 mbedtls_ssl_protocol_version min_tls_version;
Ronald Cron82c785f2022-03-31 15:44:41 +0200659#endif
Ronald Cron86a477f2022-02-18 17:45:10 +0100660
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100661#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
662 uint8_t extended_ms; /*!< use Extended Master Secret? */
663#endif
664
665#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
666 uint8_t async_in_progress; /*!< an asynchronous operation is in progress */
667#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
668
669#if defined(MBEDTLS_SSL_PROTO_DTLS)
670 unsigned char retransmit_state; /*!< Retransmission state */
671#endif
672
Gilles Peskine41139a22021-12-08 18:25:39 +0100673#if !defined(MBEDTLS_DEPRECATED_REMOVED)
674 unsigned char group_list_heap_allocated;
Jerry Yuf017ee42022-01-12 15:49:48 +0800675 unsigned char sig_algs_heap_allocated;
Gilles Peskine41139a22021-12-08 18:25:39 +0100676#endif
677
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100678#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
679 uint8_t ecrs_enabled; /*!< Handshake supports EC restart? */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100680 enum { /* this complements ssl->state with info on intra-state operations */
681 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
682 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
683 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
684 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
685 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
686 } ecrs_state; /*!< current (or last) operation */
687 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
688 size_t ecrs_n; /*!< place for saving a length */
689#endif
690
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100691 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
692
693 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
694 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
695 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
696 mbedtls_ssl_tls_prf_cb *tls_prf;
697
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200698 /*
699 * Handshake specific crypto variables
700 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100701#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Ronald Cron85385492022-07-20 16:44:00 +0200702 uint8_t key_exchange_mode; /*!< Selected key exchange mode */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100703
Jerry Yu6a2cd9e2022-05-05 11:14:19 +0800704 /** Number of HelloRetryRequest messages received/sent from/to the server. */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000705 int hello_retry_request_count;
Ronald Cronbc817ba2022-07-21 09:35:20 +0200706
XiaokangQian08037552022-04-20 07:16:41 +0000707#if defined(MBEDTLS_SSL_SRV_C)
XiaokangQian318dc762022-04-20 09:43:51 +0000708 /** selected_group of key_share extension in HelloRetryRequest message. */
XiaokangQian08037552022-04-20 07:16:41 +0000709 uint16_t hrr_selected_group;
Ronald Cron41a443a2022-10-04 16:38:25 +0200710#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Ronald Cronbc817ba2022-07-21 09:35:20 +0200711 uint8_t tls13_kex_modes; /*!< Key exchange modes supported by the client */
712#endif
Jerry Yud4e75002022-08-09 13:33:50 +0800713#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf3bdf9d2022-09-22 23:30:49 +0800714 uint16_t new_session_tickets_count; /*!< number of session tickets */
Jerry Yud4e75002022-08-09 13:33:50 +0800715#endif
XiaokangQian08037552022-04-20 07:16:41 +0000716#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cronbc817ba2022-07-21 09:35:20 +0200717
Jerry Yu582dd062022-04-22 21:59:01 +0800718#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian08037552022-04-20 07:16:41 +0000719
Ronald Crone68ab4f2022-10-05 12:46:29 +0200720#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baif5b4d252022-01-28 06:37:15 +0000721 uint16_t received_sig_algs[MBEDTLS_RECEIVED_SIG_ALGS_SIZE];
722#endif
723
Gilles Peskine41139a22021-12-08 18:25:39 +0100724#if !defined(MBEDTLS_DEPRECATED_REMOVED)
725 const uint16_t *group_list;
Jerry Yuf017ee42022-01-12 15:49:48 +0800726 const uint16_t *sig_algs;
Gilles Peskine41139a22021-12-08 18:25:39 +0100727#endif
728
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200729#if defined(MBEDTLS_DHM_C)
730 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
731#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100732
John Durkop07cc04a2020-11-16 22:08:34 -0800733/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
Ronald Cronde1adee2022-03-07 16:20:30 +0100734 * to guards in client and server code. There is a gap in functionality that
735 * access to ecdh_ctx structure is needed for MBEDTLS_ECDSA_C which does not
736 * seem correct.
John Durkop07cc04a2020-11-16 22:08:34 -0800737 */
738#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Neil Armstrong769dc052022-04-13 15:12:43 +0200739#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200740 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
Neil Armstrong769dc052022-04-13 15:12:43 +0200741#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000742
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100743#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Gilles Peskine42459802019-12-19 13:31:53 +0100744 psa_key_type_t ecdh_psa_type;
Neil Armstrong91477a72022-03-25 15:42:20 +0100745 size_t ecdh_bits;
Andrzej Kurek03e01462022-01-03 12:53:24 +0100746 mbedtls_svc_key_id_t ecdh_psa_privkey;
Neil Armstrongf716a702022-04-04 11:23:46 +0200747 uint8_t ecdh_psa_privkey_is_external;
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000748 unsigned char ecdh_psa_peerkey[MBEDTLS_PSA_MAX_EC_PUBKEY_LENGTH];
749 size_t ecdh_psa_peerkey_len;
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +0100750#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
John Durkop07cc04a2020-11-16 22:08:34 -0800751#endif /* MBEDTLS_ECDH_C || MBEDTLS_ECDSA_C */
Hanno Beckerdf51dbe2019-02-18 16:41:55 +0000752
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200753#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200754 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200755#if defined(MBEDTLS_SSL_CLI_C)
756 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
757 size_t ecjpake_cache_len; /*!< Length of cached data */
758#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100759#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100760
761#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200762 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200763 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
764#endif
Gilles Peskine8716f172021-11-16 15:21:44 +0100765
Ronald Cron73fe8df2022-10-05 14:31:43 +0200766#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Beckerd9f7d432018-10-22 15:29:46 +0100767#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +0100768 mbedtls_svc_key_id_t psk_opaque; /*!< Opaque PSK from the callback */
Neil Armstrong501c9322022-05-03 09:35:09 +0200769 uint8_t psk_opaque_is_internal;
Neil Armstronge952a302022-05-03 10:22:14 +0200770#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200771 unsigned char *psk; /*!< PSK from the callback */
772 size_t psk_len; /*!< Length of PSK from callback */
Neil Armstronge952a302022-05-03 10:22:14 +0200773#endif /* MBEDTLS_USE_PSA_CRYPTO */
Jerry Yu96a2e362022-07-21 15:11:34 +0800774 uint16_t selected_identity;
Ronald Cron73fe8df2022-10-05 14:31:43 +0200775#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Gilles Peskine8716f172021-11-16 15:21:44 +0100776
Gilles Peskinecfe74a32021-12-08 18:38:51 +0100777#if defined(MBEDTLS_SSL_ECP_RESTARTABLE_ENABLED)
778 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
779#endif
780
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200781#if defined(MBEDTLS_X509_CRT_PARSE_C)
782 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
783#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
784 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
785 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
786 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100787#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200788#endif /* MBEDTLS_X509_CRT_PARSE_C */
Gilles Peskine8716f172021-11-16 15:21:44 +0100789
Gilles Peskine8716f172021-11-16 15:21:44 +0100790#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Hanno Becker75173122019-02-06 16:18:31 +0000791 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
792 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
793#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker2f28c102019-04-25 15:46:59 +0100794
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100795 struct
796 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100797 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
798 * buffers used for message buffering. */
799
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100800 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100801 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100802
Hanno Becker0271f962018-08-16 13:23:47 +0100803 struct mbedtls_ssl_hs_buffer
804 {
Hanno Becker98081a02018-08-22 13:32:50 +0100805 unsigned is_valid : 1;
806 unsigned is_fragmented : 1;
807 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100808 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100809 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100810 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
811
Hanno Becker5f066e72018-08-16 14:56:31 +0100812 struct
813 {
814 unsigned char *data;
815 size_t len;
816 unsigned epoch;
817 } future_record;
818
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100819 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100820
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000821#if defined(MBEDTLS_SSL_CLI_C) && \
822 ( defined(MBEDTLS_SSL_PROTO_DTLS) || defined(MBEDTLS_SSL_PROTO_TLS1_3) )
823 unsigned char *cookie; /*!< HelloVerifyRequest cookie for DTLS
824 * HelloRetryRequest cookie for TLS 1.3 */
825#endif /* MBEDTLS_SSL_CLI_C &&
826 ( MBEDTLS_SSL_PROTO_DTLS || MBEDTLS_SSL_PROTO_TLS1_3 ) */
827#if defined(MBEDTLS_SSL_PROTO_DTLS)
828 unsigned char verify_cookie_len; /*!< Cli: HelloVerifyRequest cookie
829 * length
XiaokangQian34909742022-01-27 02:25:04 +0000830 * Srv: flag for sending a cookie */
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000831#endif /* MBEDTLS_SSL_PROTO_DTLS */
832#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
833 uint16_t hrr_cookie_len; /*!< HelloRetryRequest cookie length */
XiaokangQian20438972022-03-04 08:52:07 +0000834#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
XiaokangQian52da5582022-01-26 09:49:29 +0000835
836#if defined(MBEDTLS_SSL_PROTO_DTLS)
837 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
838 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
Gilles Peskineec45c1e2021-11-29 12:18:09 +0100839
840 uint32_t retransmit_timeout; /*!< Current value of timeout */
841 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
842 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
843 unsigned char *cur_msg_p; /*!< Position in current message */
844 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
845 flight being received */
846 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
847 resending messages */
848 unsigned char alt_out_ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Alternative record epoch/counter
849 for resending messages */
850
851#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
852 /* The state of CID configuration in this handshake. */
853
854 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
855 * has been negotiated. Possible values are
856 * #MBEDTLS_SSL_CID_ENABLED and
857 * #MBEDTLS_SSL_CID_DISABLED. */
858 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
859 uint8_t peer_cid_len; /*!< The length of
860 * \c peer_cid. */
861#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
862
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200863 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100864#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200865
Ronald Cron6f135e12021-12-08 16:57:54 +0100866#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +0100867 /*! TLS 1.3 transforms for 0-RTT and encrypted handshake messages.
868 * Those pointers own the transforms they reference. */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100869 mbedtls_ssl_transform *transform_handshake;
870 mbedtls_ssl_transform *transform_earlydata;
Ronald Cron6f135e12021-12-08 16:57:54 +0100871#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +0100872
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200873 /*
874 * Checksum contexts
875 */
Andrzej Kurek25f27152022-08-17 16:09:31 -0400876#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500877#if defined(MBEDTLS_USE_PSA_CRYPTO)
878 psa_hash_operation_t fin_sha256_psa;
879#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200880 mbedtls_sha256_context fin_sha256;
881#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500882#endif
Andrzej Kurek25f27152022-08-17 16:09:31 -0400883#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Andrzej Kurekeb342242019-01-29 09:14:33 -0500884#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek972fba52019-01-30 03:29:12 -0500885 psa_hash_operation_t fin_sha384_psa;
Andrzej Kurekeb342242019-01-29 09:14:33 -0500886#else
Andrzej Kureka242e832022-08-11 10:03:14 -0400887 mbedtls_sha512_context fin_sha384;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200888#endif
Andrzej Kurekeb342242019-01-29 09:14:33 -0500889#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200890
Ronald Cron6f135e12021-12-08 16:57:54 +0100891#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu56fc07f2021-09-01 17:48:49 +0800892 uint16_t offered_group_id; /* The NamedGroup value for the group
893 * that is being used for ephemeral
894 * key exchange.
895 *
896 * On the client: Defaults to the first
897 * entry in the client's group list,
898 * but can be overwritten by the HRR. */
Ronald Cron6f135e12021-12-08 16:57:54 +0100899#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800900
Jerry Yufb28b882022-01-28 11:05:58 +0800901#if defined(MBEDTLS_SSL_CLI_C)
Jerry Yu2d9a6942022-02-08 21:07:10 +0800902 uint8_t client_auth; /*!< used to check if CertificateRequest has been
Jerry Yu5c7d1cc2022-02-08 21:08:29 +0800903 received from server side. If CertificateRequest
Jerry Yu0ff8ac82022-02-08 10:10:48 +0800904 has been received, Certificate and CertificateVerify
Jerry Yufb28b882022-01-28 11:05:58 +0800905 should be sent to server */
906#endif /* MBEDTLS_SSL_CLI_C */
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000907 /*
908 * State-local variables used during the processing
909 * of a specific handshake state.
910 */
911 union
912 {
913 /* Outgoing Finished message */
914 struct
915 {
916 uint8_t preparation_done;
917
918 /* Buffer holding digest of the handshake up to
919 * but excluding the outgoing finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000920 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000921 size_t digest_len;
922 } finished_out;
923
924 /* Incoming Finished message */
925 struct
926 {
XiaokangQian57b2aff2021-11-10 03:12:11 +0000927 uint8_t preparation_done;
928
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000929 /* Buffer holding digest of the handshake up to but
930 * excluding the peer's incoming finished message. */
XiaokangQianc5c39d52021-11-09 11:55:10 +0000931 unsigned char digest[MBEDTLS_TLS1_3_MD_MAX_SIZE];
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000932 size_t digest_len;
933 } finished_in;
934
XiaokangQianaa5f5c12021-09-18 06:20:25 +0000935 } state_local;
936
937 /* End of state-local variables. */
938
Jerry Yue6d7e5c2021-10-26 10:44:32 +0800939 unsigned char randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN +
940 MBEDTLS_SERVER_HELLO_RANDOM_LEN];
941 /*!< random bytes */
Ronald Cron3b056202022-10-05 17:20:21 +0200942#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200943 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
944 /*!< premaster secret */
Ronald Cron3b056202022-10-05 17:20:21 +0200945 size_t pmslen; /*!< premaster length */
946#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200947
Ronald Cron6f135e12021-12-08 16:57:54 +0100948#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yue18dc7e2022-08-04 16:29:22 +0800949 uint32_t extensions_present; /*!< extension presence; Each bitfield
Jerry Yu8e7ca042021-08-26 15:31:37 +0800950 represents an extension and defined
951 as \c MBEDTLS_SSL_EXT_XXX */
Jerry Yu89ea3212021-09-09 14:31:24 +0800952
Ronald Crone68ab4f2022-10-05 12:46:29 +0200953#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Xiaofei Baia0ab7772022-01-16 12:14:45 +0000954 unsigned char certificate_request_context_len;
955 unsigned char *certificate_request_context;
Xiaofei Baie1e34422021-12-23 12:09:05 +0000956#endif
957
Jerry Yu89ea3212021-09-09 14:31:24 +0800958 union
959 {
Jerry Yud1ab2622021-10-08 15:36:57 +0800960 unsigned char early [MBEDTLS_TLS1_3_MD_MAX_SIZE];
961 unsigned char handshake[MBEDTLS_TLS1_3_MD_MAX_SIZE];
962 unsigned char app [MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Baid25fab62021-12-02 06:36:27 +0000963 } tls13_master_secrets;
Jerry Yu61e35e02021-09-16 18:59:08 +0800964
Xiaofei Bai746f9482021-11-12 08:53:56 +0000965 mbedtls_ssl_tls13_handshake_secrets tls13_hs_secrets;
Ronald Cron6f135e12021-12-08 16:57:54 +0100966#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200967
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200968#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
969 /** Asynchronous operation context. This field is meant for use by the
970 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
971 * mbedtls_ssl_config::f_async_decrypt_start,
972 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
973 * The library does not use it internally. */
974 void *user_async_ctx;
975#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Glenn Strauss69894072022-01-24 12:58:00 -0500976
977#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
978 const unsigned char *sni_name; /*!< raw SNI */
979 size_t sni_name_len; /*!< raw SNI len */
Glenn Strauss999ef702022-03-11 01:37:23 -0500980#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
981 const mbedtls_x509_crt *dn_hints; /*!< acceptable client cert issuers */
982#endif
Glenn Strauss69894072022-01-24 12:58:00 -0500983#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200984};
985
Hanno Becker0271f962018-08-16 13:23:47 +0100986typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
987
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200988/*
Hanno Beckerd362dc52018-01-03 15:23:11 +0000989 * Representation of decryption/encryption transformations on records
990 *
991 * There are the following general types of record transformations:
TRodziewicz2abf03c2021-06-25 14:40:09 +0200992 * - Stream transformations (TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +0000993 * Transformation adding a MAC and applying a stream-cipher
994 * to the authenticated message.
TRodziewicz2abf03c2021-06-25 14:40:09 +0200995 * - CBC block cipher transformations ([D]TLS versions == 1.2 only)
996 * For TLS 1.2, no IV is generated at key extraction time, but every
997 * encrypted record is explicitly prefixed by the IV with which it was
998 * encrypted.
999 * - AEAD transformations ([D]TLS versions == 1.2 only)
Hanno Beckerd362dc52018-01-03 15:23:11 +00001000 * These come in two fundamentally different versions, the first one
1001 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
1002 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
1003 * In the first transformation, the IV to be used for a record is obtained
1004 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
1005 * record sequence number, and explicitly prepending this sequence number
1006 * to the encrypted record. In contrast, in the second transformation
1007 * the IV is obtained by XOR'ing a static IV obtained at key extraction
1008 * time with the 8-byte record sequence number, without prepending the
1009 * latter to the encrypted record.
1010 *
Hanno Becker7d343ec2020-05-04 12:29:05 +01001011 * Additionally, DTLS 1.2 + CID as well as TLS 1.3 use an inner plaintext
1012 * which allows to add flexible length padding and to hide a record's true
1013 * content type.
1014 *
Hanno Beckerd362dc52018-01-03 15:23:11 +00001015 * In addition to type and version, the following parameters are relevant:
1016 * - The symmetric cipher algorithm to be used.
1017 * - The (static) encryption/decryption keys for the cipher.
1018 * - For stream/CBC, the type of message digest to be used.
1019 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Becker0db7e0c2018-10-18 15:39:53 +01001020 * - For AEAD transformations, the size (potentially 0) of an explicit,
1021 * random initialization vector placed in encrypted records.
TRodziewicz299510e2021-07-09 16:55:11 +02001022 * - For some transformations (currently AEAD) an implicit IV. It is static
Hanno Beckerd362dc52018-01-03 15:23:11 +00001023 * and (if present) is combined with the explicit IV in a transformation-
TRodziewicz299510e2021-07-09 16:55:11 +02001024 * -dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
Hanno Beckerd362dc52018-01-03 15:23:11 +00001025 * - For stream/CBC, a flag determining the order of encryption and MAC.
1026 * - The details of the transformation depend on the SSL/TLS version.
1027 * - The length of the authentication tag.
1028 *
1029 * The struct below refines this abstract view as follows:
1030 * - The cipher underlying the transformation is managed in
1031 * cipher contexts cipher_ctx_{enc/dec}, which must have the
1032 * same cipher type. The mode of these cipher contexts determines
1033 * the type of the transformation in the sense above: e.g., if
1034 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
1035 * then the transformation has type CBC resp. AEAD.
1036 * - The cipher keys are never stored explicitly but
1037 * are maintained within cipher_ctx_{enc/dec}.
1038 * - For stream/CBC transformations, the message digest contexts
1039 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
1040 * are unused for AEAD transformations.
TRodziewicz2abf03c2021-06-25 14:40:09 +02001041 * - For stream/CBC transformations, the MAC keys are not stored explicitly
1042 * but maintained within md_ctx_{enc/dec}.
1043 * - The mac_enc and mac_dec fields are unused for EAD transformations.
Hanno Beckerd362dc52018-01-03 15:23:11 +00001044 * - For transformations using an implicit IV maintained within
1045 * the transformation context, its contents are stored within
1046 * iv_{enc/dec}.
1047 * - The value of ivlen indicates the length of the IV.
1048 * This is redundant in case of stream/CBC transformations
1049 * which always use 0 resp. the cipher's block length as the
1050 * IV length, but is needed for AEAD ciphers and may be
1051 * different from the underlying cipher's block length
1052 * in this case.
1053 * - The field fixed_ivlen is nonzero for AEAD transformations only
1054 * and indicates the length of the static part of the IV which is
1055 * constant throughout the communication, and which is stored in
1056 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
Glenn Strauss07c64162022-03-14 12:34:51 -04001057 * - tls_version denotes the 2-byte TLS version
Hanno Beckerd362dc52018-01-03 15:23:11 +00001058 * - For stream/CBC transformations, maclen denotes the length of the
1059 * authentication tag, while taglen is unused and 0.
1060 * - For AEAD transformations, taglen denotes the length of the
1061 * authentication tag, while maclen is unused and 0.
1062 * - For CBC transformations, encrypt_then_mac determines the
1063 * order of encryption and authentication. This field is unused
1064 * in other transformations.
1065 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001066 */
1067struct mbedtls_ssl_transform
1068{
1069 /*
1070 * Session specific crypto layer
1071 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001072 size_t minlen; /*!< min. ciphertext length */
1073 size_t ivlen; /*!< IV length */
1074 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Beckere694c3e2017-12-27 21:34:08 +00001075 size_t maclen; /*!< MAC(CBC) len */
1076 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001077
1078 unsigned char iv_enc[16]; /*!< IV (encryption) */
1079 unsigned char iv_dec[16]; /*!< IV (decryption) */
1080
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001081#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Hanno Beckerd56ed242018-01-03 15:32:51 +00001082
Neil Armstrong39b8e7d2022-02-23 09:24:45 +01001083#if defined(MBEDTLS_USE_PSA_CRYPTO)
1084 mbedtls_svc_key_id_t psa_mac_enc; /*!< MAC (encryption) */
1085 mbedtls_svc_key_id_t psa_mac_dec; /*!< MAC (decryption) */
1086 psa_algorithm_t psa_mac_alg; /*!< psa MAC algorithm */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001087#else
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001088 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
1089 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
Neil Armstrongcf8841a2022-02-24 11:17:45 +01001090#endif /* MBEDTLS_USE_PSA_CRYPTO */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001091
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001092#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1093 int encrypt_then_mac; /*!< flag for EtM activation */
1094#endif
1095
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001096#endif /* MBEDTLS_SSL_SOME_SUITES_USE_MAC */
Hanno Beckerd56ed242018-01-03 15:32:51 +00001097
Glenn Strauss07c64162022-03-14 12:34:51 -04001098 mbedtls_ssl_protocol_version tls_version;
Hanno Becker9eddaeb2017-12-27 21:37:21 +00001099
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001100#if defined(MBEDTLS_USE_PSA_CRYPTO)
1101 mbedtls_svc_key_id_t psa_key_enc; /*!< psa encryption key */
1102 mbedtls_svc_key_id_t psa_key_dec; /*!< psa decryption key */
1103 psa_algorithm_t psa_alg; /*!< psa algorithm */
Przemyslaw Stekiel6be9cf52022-01-19 16:00:22 +01001104#else
1105 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
1106 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Przemyslaw Stekiel44187d72022-01-11 08:25:29 +01001107#endif /* MBEDTLS_USE_PSA_CRYPTO */
1108
Hanno Beckera0e20d02019-05-15 14:03:01 +01001109#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker1327fa72019-04-25 15:54:02 +01001110 uint8_t in_cid_len;
1111 uint8_t out_cid_len;
1112 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
1113 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera0e20d02019-05-15 14:03:01 +01001114#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker1327fa72019-04-25 15:54:02 +01001115
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001116#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
1117 /* We need the Hello random bytes in order to re-derive keys from the
Hanno Beckerbd257552021-03-22 06:59:27 +00001118 * Master Secret and other session info,
1119 * see ssl_tls12_populate_transform() */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001120 unsigned char randbytes[MBEDTLS_SERVER_HELLO_RANDOM_LEN +
1121 MBEDTLS_CLIENT_HELLO_RANDOM_LEN];
1122 /*!< ServerHello.random+ClientHello.random */
Manuel Pégourié-Gonnard96fb0ee2019-07-09 12:54:17 +02001123#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001124};
1125
Hanno Becker12a3a862018-01-05 15:42:50 +00001126/*
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001127 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
1128 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
1129 */
1130static inline int mbedtls_ssl_transform_uses_aead(
1131 const mbedtls_ssl_transform *transform )
1132{
Hanno Beckerfd86ca82020-11-30 08:54:23 +00001133#if defined(MBEDTLS_SSL_SOME_SUITES_USE_MAC)
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02001134 return( transform->maclen == 0 && transform->taglen != 0 );
1135#else
1136 (void) transform;
1137 return( 1 );
1138#endif
1139}
1140
1141/*
Hanno Becker12a3a862018-01-05 15:42:50 +00001142 * Internal representation of record frames
1143 *
Hanno Becker12a3a862018-01-05 15:42:50 +00001144 * Instances come in two flavors:
1145 * (1) Encrypted
1146 * These always have data_offset = 0
1147 * (2) Unencrypted
Hanno Beckercd430bc2019-04-04 16:29:48 +01001148 * These have data_offset set to the amount of
1149 * pre-expansion during record protection. Concretely,
1150 * this is the length of the fixed part of the explicit IV
1151 * used for encryption, or 0 if no explicit IV is used
TRodziewicz2abf03c2021-06-25 14:40:09 +02001152 * (e.g. for stream ciphers).
Hanno Becker12a3a862018-01-05 15:42:50 +00001153 *
1154 * The reason for the data_offset in the unencrypted case
1155 * is to allow for in-place conversion of an unencrypted to
1156 * an encrypted record. If the offset wasn't included, the
1157 * encrypted content would need to be shifted afterwards to
1158 * make space for the fixed IV.
1159 *
1160 */
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001161#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker75f080f2019-04-30 15:01:51 +01001162#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001163#else
Hanno Becker75f080f2019-04-30 15:01:51 +01001164#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Beckerf2ed4482019-04-29 13:45:54 +01001165#endif
1166
Hanno Becker12a3a862018-01-05 15:42:50 +00001167typedef struct
1168{
Jerry Yuae0b2e22021-10-08 15:21:19 +08001169 uint8_t ctr[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /* In TLS: The implicit record sequence number.
1170 * In DTLS: The 2-byte epoch followed by
1171 * the 6-byte sequence number.
1172 * This is stored as a raw big endian byte array
1173 * as opposed to a uint64_t because we rarely
1174 * need to perform arithmetic on this, but do
1175 * need it as a Byte array for the purpose of
1176 * MAC computations. */
Hanno Beckerd840cea2019-07-11 09:24:36 +01001177 uint8_t type; /* The record content type. */
1178 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
1179 * Convert to internal presentation of versions
1180 * using mbedtls_ssl_read_version() and
1181 * mbedtls_ssl_write_version().
1182 * Keep wire-format for MAC computations. */
Hanno Becker12a3a862018-01-05 15:42:50 +00001183
Hanno Beckerd840cea2019-07-11 09:24:36 +01001184 unsigned char *buf; /* Memory buffer enclosing the record content */
1185 size_t buf_len; /* Buffer length */
1186 size_t data_offset; /* Offset of record content */
1187 size_t data_len; /* Length of record content */
Hanno Becker12a3a862018-01-05 15:42:50 +00001188
Hanno Beckera0e20d02019-05-15 14:03:01 +01001189#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerd840cea2019-07-11 09:24:36 +01001190 uint8_t cid_len; /* Length of the CID (0 if not present) */
1191 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001192#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker12a3a862018-01-05 15:42:50 +00001193} mbedtls_record;
1194
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001195#if defined(MBEDTLS_X509_CRT_PARSE_C)
1196/*
1197 * List of certificate + private key pairs
1198 */
1199struct mbedtls_ssl_key_cert
1200{
1201 mbedtls_x509_crt *cert; /*!< cert */
1202 mbedtls_pk_context *key; /*!< private key */
1203 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
1204};
1205#endif /* MBEDTLS_X509_CRT_PARSE_C */
1206
1207#if defined(MBEDTLS_SSL_PROTO_DTLS)
1208/*
1209 * List of handshake messages kept around for resending
1210 */
1211struct mbedtls_ssl_flight_item
1212{
1213 unsigned char *p; /*!< message, including handshake headers */
1214 size_t len; /*!< length of p */
1215 unsigned char type; /*!< type of the message: handshake or CCS */
1216 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
1217};
1218#endif /* MBEDTLS_SSL_PROTO_DTLS */
1219
Ronald Cron4079abc2022-02-20 10:35:26 +01001220#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1221/**
1222 * \brief Given an SSL context and its associated configuration, write the TLS
1223 * 1.2 specific extensions of the ClientHello message.
1224 *
1225 * \param[in] ssl SSL context
1226 * \param[in] buf Base address of the buffer where to write the extensions
1227 * \param[in] end End address of the buffer where to write the extensions
1228 * \param uses_ec Whether one proposed ciphersuite uses an elliptic curve
1229 * (<> 0) or not ( 0 ).
1230 * \param[out] out_len Length of the data written into the buffer \p buf
1231 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001232MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron4079abc2022-02-20 10:35:26 +01001233int mbedtls_ssl_tls12_write_client_hello_exts( mbedtls_ssl_context *ssl,
1234 unsigned char *buf,
1235 const unsigned char *end,
1236 int uses_ec,
1237 size_t *out_len );
1238#endif
1239
Hanno Becker7e5437a2017-04-28 17:15:26 +01001240#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
Gilles Peskineeccd8882020-03-10 12:19:08 +01001241 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Hanno Becker7e5437a2017-04-28 17:15:26 +01001242
Gabor Mezeia3d016c2022-05-10 12:44:09 +02001243/**
1244 * \brief Find the preferred hash for a given signature algorithm.
1245 *
1246 * \param[in] ssl SSL context
1247 * \param[in] sig_alg A signature algorithm identifier as defined in the
1248 * TLS 1.2 SignatureAlgorithm enumeration.
1249 *
1250 * \return The preferred hash algorithm for \p sig_alg. It is a hash algorithm
1251 * identifier as defined in the TLS 1.2 HashAlgorithm enumeration.
1252 */
1253unsigned int mbedtls_ssl_tls12_get_preferred_hash_for_sig_alg(
1254 mbedtls_ssl_context *ssl,
1255 unsigned int sig_alg );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001256
Gabor Mezei078e8032022-04-27 21:17:56 +02001257#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
Gilles Peskineeccd8882020-03-10 12:19:08 +01001258 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001259
1260/**
1261 * \brief Free referenced items in an SSL transform context and clear
1262 * memory
1263 *
1264 * \param transform SSL transform context
1265 */
1266void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
1267
1268/**
1269 * \brief Free referenced items in an SSL handshake context and clear
1270 * memory
1271 *
Gilles Peskine9b562d52018-04-25 20:32:43 +02001272 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001273 */
Gilles Peskine9b562d52018-04-25 20:32:43 +02001274void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001275
Jerry Yuc7875b52021-09-05 21:05:50 +08001276/* set inbound transform of ssl context */
1277void mbedtls_ssl_set_inbound_transform( mbedtls_ssl_context *ssl,
1278 mbedtls_ssl_transform *transform );
1279
1280/* set outbound transform of ssl context */
1281void mbedtls_ssl_set_outbound_transform( mbedtls_ssl_context *ssl,
1282 mbedtls_ssl_transform *transform );
1283
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001284MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001285int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001287int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
1288void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001289static inline void mbedtls_ssl_handshake_set_state( mbedtls_ssl_context *ssl,
1290 mbedtls_ssl_states state )
1291{
1292 ssl->state = ( int ) state;
1293}
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001294
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001295MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001296int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
1297
1298void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001299
1300#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001301MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001302int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
Jerry Yubef175d2022-01-28 10:52:05 +08001303#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001304
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001305MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001306int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001307MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001308int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
1309void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
1310
Hanno Becker4a810fb2017-05-24 16:27:30 +01001311/**
1312 * \brief Update record layer
1313 *
1314 * This function roughly separates the implementation
1315 * of the logic of (D)TLS from the implementation
1316 * of the secure transport.
1317 *
Hanno Becker3a0aad12018-08-20 09:44:02 +01001318 * \param ssl The SSL context to use.
1319 * \param update_hs_digest This indicates if the handshake digest
1320 * should be automatically updated in case
1321 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +01001322 *
1323 * \return 0 or non-zero error code.
1324 *
1325 * \note A clarification on what is called 'record layer' here
1326 * is in order, as many sensible definitions are possible:
1327 *
1328 * The record layer takes as input an untrusted underlying
1329 * transport (stream or datagram) and transforms it into
1330 * a serially multiplexed, secure transport, which
1331 * conceptually provides the following:
1332 *
1333 * (1) Three datagram based, content-agnostic transports
1334 * for handshake, alert and CCS messages.
1335 * (2) One stream- or datagram-based transport
1336 * for application data.
1337 * (3) Functionality for changing the underlying transform
1338 * securing the contents.
1339 *
1340 * The interface to this functionality is given as follows:
1341 *
1342 * a Updating
1343 * [Currently implemented by mbedtls_ssl_read_record]
1344 *
1345 * Check if and on which of the four 'ports' data is pending:
1346 * Nothing, a controlling datagram of type (1), or application
1347 * data (2). In any case data is present, internal buffers
1348 * provide access to the data for the user to process it.
1349 * Consumption of type (1) datagrams is done automatically
1350 * on the next update, invalidating that the internal buffers
1351 * for previous datagrams, while consumption of application
1352 * data (2) is user-controlled.
1353 *
1354 * b Reading of application data
1355 * [Currently manual adaption of ssl->in_offt pointer]
1356 *
1357 * As mentioned in the last paragraph, consumption of data
1358 * is different from the automatic consumption of control
1359 * datagrams (1) because application data is treated as a stream.
1360 *
1361 * c Tracking availability of application data
1362 * [Currently manually through decreasing ssl->in_msglen]
1363 *
1364 * For efficiency and to retain datagram semantics for
1365 * application data in case of DTLS, the record layer
1366 * provides functionality for checking how much application
1367 * data is still available in the internal buffer.
1368 *
1369 * d Changing the transformation securing the communication.
1370 *
1371 * Given an opaque implementation of the record layer in the
1372 * above sense, it should be possible to implement the logic
1373 * of (D)TLS on top of it without the need to know anything
1374 * about the record layer's internals. This is done e.g.
1375 * in all the handshake handling functions, and in the
1376 * application data reading function mbedtls_ssl_read.
1377 *
1378 * \note The above tries to give a conceptual picture of the
1379 * record layer, but the current implementation deviates
1380 * from it in some places. For example, our implementation of
1381 * the update functionality through mbedtls_ssl_read_record
1382 * discards datagrams depending on the current state, which
1383 * wouldn't fall under the record layer's responsibility
1384 * following the above definition.
1385 *
1386 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001387MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker3a0aad12018-08-20 09:44:02 +01001388int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
1389 unsigned update_hs_digest );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001390MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001391int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
1392
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001393/*
1394 * Write handshake message header
1395 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001396MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001397int mbedtls_ssl_start_handshake_msg( mbedtls_ssl_context *ssl, unsigned hs_type,
1398 unsigned char **buf, size_t *buf_len );
1399
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001400MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001401int mbedtls_ssl_write_handshake_msg_ext( mbedtls_ssl_context *ssl,
Ronald Cron66dbf912022-02-02 15:33:46 +01001402 int update_checksum,
Ronald Cron00d012f22022-03-08 15:57:12 +01001403 int force_flush );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001404static inline int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl )
1405{
Ronald Cron66dbf912022-02-02 15:33:46 +01001406 return( mbedtls_ssl_write_handshake_msg_ext( ssl, 1 /* update checksum */, 1 /* force flush */ ) );
Hanno Beckerf3cce8b2021-08-07 14:29:49 +01001407}
1408
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001409/*
1410 * Write handshake message tail
1411 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001412MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001413int mbedtls_ssl_finish_handshake_msg( mbedtls_ssl_context *ssl,
1414 size_t buf_len, size_t msg_len );
1415
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001416MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron00d012f22022-03-08 15:57:12 +01001417int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, int force_flush );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001418MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001419int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
1420
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001421MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001422int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001423MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001424int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
1425
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001426MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001427int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001428MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001429int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1430
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001431MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001432int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001433MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001434int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1435
1436void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
1437 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
1438
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001439/*
1440 * Update checksum of handshake messages.
1441 */
1442void mbedtls_ssl_add_hs_msg_to_checksum( mbedtls_ssl_context *ssl,
1443 unsigned hs_type,
1444 unsigned char const *msg,
1445 size_t msg_len );
1446
XiaokangQian86981952022-07-19 09:51:50 +00001447void mbedtls_ssl_add_hs_hdr_to_checksum( mbedtls_ssl_context *ssl,
1448 unsigned hs_type,
1449 size_t total_hs_len );
1450
Gilles Peskineeccd8882020-03-10 12:19:08 +01001451#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Neil Armstrong80f6f322022-05-03 17:56:38 +02001452#if !defined(MBEDTLS_USE_PSA_CRYPTO)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001453MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001454int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl,
1455 mbedtls_key_exchange_type_t key_ex );
Neil Armstrong80f6f322022-05-03 17:56:38 +02001456#endif /* !MBEDTLS_USE_PSA_CRYPTO */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001457#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Ronald Crond29e13e2022-10-19 10:33:48 +02001458
Ronald Cron73fe8df2022-10-05 14:31:43 +02001459#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Ronald Crond29e13e2022-10-19 10:33:48 +02001460#if defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001461MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Crond491c2d2022-02-19 18:30:46 +01001462int mbedtls_ssl_conf_has_static_psk( mbedtls_ssl_config const *conf );
1463#endif
Neil Armstrong044a32c2022-05-03 10:35:56 +02001464#if defined(MBEDTLS_USE_PSA_CRYPTO)
1465/**
1466 * Get the first defined opaque PSK by order of precedence:
1467 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in the PSK
1468 * callback
1469 * 2. static PSK configured by \c mbedtls_ssl_conf_psk_opaque()
1470 * Return an opaque PSK
1471 */
1472static inline mbedtls_svc_key_id_t mbedtls_ssl_get_opaque_psk(
1473 const mbedtls_ssl_context *ssl )
1474{
1475 if( ! mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
1476 return( ssl->handshake->psk_opaque );
1477
1478 if( ! mbedtls_svc_key_id_is_null( ssl->conf->psk_opaque ) )
1479 return( ssl->conf->psk_opaque );
1480
1481 return( MBEDTLS_SVC_KEY_ID_INIT );
1482}
1483#else
Guilhem Bryant8a69ddd2020-03-27 11:13:39 +00001484/**
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001485 * Get the first defined PSK by order of precedence:
1486 * 1. handshake PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
1487 * 2. static PSK configured by \c mbedtls_ssl_conf_psk()
1488 * Return a code and update the pair (PSK, PSK length) passed to this function
1489 */
1490static inline int mbedtls_ssl_get_psk( const mbedtls_ssl_context *ssl,
1491 const unsigned char **psk, size_t *psk_len )
1492{
1493 if( ssl->handshake->psk != NULL && ssl->handshake->psk_len > 0 )
1494 {
1495 *psk = ssl->handshake->psk;
1496 *psk_len = ssl->handshake->psk_len;
1497 }
1498
1499 else if( ssl->conf->psk != NULL && ssl->conf->psk_len > 0 )
1500 {
1501 *psk = ssl->conf->psk;
1502 *psk_len = ssl->conf->psk_len;
1503 }
1504
1505 else
1506 {
Guilhem Bryantb5f04e42020-04-01 11:23:58 +01001507 *psk = NULL;
1508 *psk_len = 0;
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001509 return( MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED );
1510 }
1511
1512 return( 0 );
1513}
Guilhem Bryantd511ac32020-03-25 17:06:37 +00001514#endif /* MBEDTLS_USE_PSA_CRYPTO */
1515
Ronald Cron73fe8df2022-10-05 14:31:43 +02001516#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001517
1518#if defined(MBEDTLS_PK_C)
1519unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001520unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001521mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1522#endif
1523
1524mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001525unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001526
1527#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001528MBEDTLS_CHECK_RETURN_CRITICAL
Simon Butcher99000142016-10-13 17:21:01 +01001529int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Ronald Cron4dcbca92022-03-07 10:21:40 +01001530#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001531
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001532MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard0d63b842022-01-18 13:10:56 +01001533int mbedtls_ssl_check_curve_tls_id( const mbedtls_ssl_context *ssl, uint16_t tls_id );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001534#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001535MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001536int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001537#endif
1538
Ron Eldor089c9fe2018-12-06 17:12:49 +02001539#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascal43f94902020-09-22 12:25:52 +02001540static inline mbedtls_ssl_srtp_profile mbedtls_ssl_check_srtp_profile_value
1541 ( const uint16_t srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001542{
Johan Pascal43f94902020-09-22 12:25:52 +02001543 switch( srtp_profile_value )
Ron Eldor089c9fe2018-12-06 17:12:49 +02001544 {
Johan Pascal85269572020-08-25 10:01:54 +02001545 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001546 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascal85269572020-08-25 10:01:54 +02001547 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascal85269572020-08-25 10:01:54 +02001548 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascal43f94902020-09-22 12:25:52 +02001549 return srtp_profile_value;
Ron Eldor089c9fe2018-12-06 17:12:49 +02001550 default: break;
1551 }
Johan Pascal43f94902020-09-22 12:25:52 +02001552 return( MBEDTLS_TLS_SRTP_UNSET );
Ron Eldor089c9fe2018-12-06 17:12:49 +02001553}
1554#endif
1555
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001556#if defined(MBEDTLS_X509_CRT_PARSE_C)
1557static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1558{
1559 mbedtls_ssl_key_cert *key_cert;
1560
1561 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1562 key_cert = ssl->handshake->key_cert;
1563 else
1564 key_cert = ssl->conf->key_cert;
1565
1566 return( key_cert == NULL ? NULL : key_cert->key );
1567}
1568
1569static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1570{
1571 mbedtls_ssl_key_cert *key_cert;
1572
1573 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1574 key_cert = ssl->handshake->key_cert;
1575 else
1576 key_cert = ssl->conf->key_cert;
1577
1578 return( key_cert == NULL ? NULL : key_cert->cert );
1579}
1580
1581/*
1582 * Check usage of a certificate wrt extensions:
1583 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1584 *
1585 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1586 * check a cert we received from them)!
1587 *
1588 * Return 0 if everything is OK, -1 if not.
1589 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001590MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001591int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
1592 const mbedtls_ssl_ciphersuite_t *ciphersuite,
1593 int cert_endpoint,
1594 uint32_t *flags );
1595#endif /* MBEDTLS_X509_CRT_PARSE_C */
1596
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001597void mbedtls_ssl_write_version( unsigned char version[2], int transport,
1598 mbedtls_ssl_protocol_version tls_version );
1599uint16_t mbedtls_ssl_read_version( const unsigned char version[2],
1600 int transport );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001601
Hanno Becker5903de42019-05-03 14:46:38 +01001602static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001603{
Hanno Becker47be7682019-07-12 09:55:46 +01001604#if !defined(MBEDTLS_SSL_PROTO_DTLS)
1605 ((void) ssl);
1606#endif
1607
1608#if defined(MBEDTLS_SSL_PROTO_DTLS)
1609 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1610 {
1611 return( 13 );
1612 }
1613 else
1614#endif /* MBEDTLS_SSL_PROTO_DTLS */
1615 {
1616 return( 5 );
1617 }
Hanno Becker5903de42019-05-03 14:46:38 +01001618}
1619
1620static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1621{
Hanno Becker3b154c12019-05-03 15:05:27 +01001622 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001623}
1624
1625static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1626{
1627#if defined(MBEDTLS_SSL_PROTO_DTLS)
1628 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1629 return( 12 );
1630#else
1631 ((void) ssl);
1632#endif
1633 return( 4 );
1634}
1635
1636#if defined(MBEDTLS_SSL_PROTO_DTLS)
1637void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1638void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001639MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001640int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001641MBEDTLS_CHECK_RETURN_CRITICAL
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001642int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001643#endif
1644
1645/* Visible for testing purposes only */
1646#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001647MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker0183d692019-07-12 08:50:37 +01001648int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001649void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1650#endif
1651
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001652MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker52055ae2019-02-06 14:30:46 +00001653int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1654 const mbedtls_ssl_session *src );
1655
TRodziewicz0f82ec62021-05-12 17:49:18 +02001656#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Andrzej Kurek814feff2019-01-14 04:35:19 -05001657/* The hash buffer must have at least MBEDTLS_MD_MAX_SIZE bytes of length. */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001658MBEDTLS_CHECK_RETURN_CRITICAL
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001659int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001660 unsigned char *hash, size_t *hashlen,
1661 unsigned char *data, size_t data_len,
1662 mbedtls_md_type_t md_alg );
TRodziewicz0f82ec62021-05-12 17:49:18 +02001663#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001664
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001665#ifdef __cplusplus
1666}
1667#endif
1668
Hanno Beckera18d1322018-01-03 14:27:32 +00001669void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001670MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Beckera18d1322018-01-03 14:27:32 +00001671int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1672 mbedtls_ssl_transform *transform,
1673 mbedtls_record *rec,
1674 int (*f_rng)(void *, unsigned char *, size_t),
1675 void *p_rng );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001676MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker605949f2019-07-12 08:23:59 +01001677int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Beckera18d1322018-01-03 14:27:32 +00001678 mbedtls_ssl_transform *transform,
1679 mbedtls_record *rec );
1680
Hanno Beckerdd772292020-02-05 10:38:31 +00001681/* Length of the "epoch" field in the record header */
1682static inline size_t mbedtls_ssl_ep_len( const mbedtls_ssl_context *ssl )
1683{
1684#if defined(MBEDTLS_SSL_PROTO_DTLS)
1685 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
1686 return( 2 );
1687#else
1688 ((void) ssl);
1689#endif
1690 return( 0 );
1691}
1692
Hanno Becker08f09132020-02-11 15:40:07 +00001693#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001694MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker786300f2020-02-05 10:46:40 +00001695int mbedtls_ssl_resend_hello_request( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001696#endif /* MBEDTLS_SSL_PROTO_DTLS */
Hanno Becker0f57a652020-02-05 10:37:26 +00001697
1698void mbedtls_ssl_set_timer( mbedtls_ssl_context *ssl, uint32_t millisecs );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001699MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker7876d122020-02-05 10:39:31 +00001700int mbedtls_ssl_check_timer( mbedtls_ssl_context *ssl );
1701
Hanno Becker3e6f8ab2020-02-05 10:40:57 +00001702void mbedtls_ssl_reset_in_out_pointers( mbedtls_ssl_context *ssl );
1703void mbedtls_ssl_update_out_pointers( mbedtls_ssl_context *ssl,
1704 mbedtls_ssl_transform *transform );
1705void mbedtls_ssl_update_in_pointers( mbedtls_ssl_context *ssl );
1706
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001707MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker43aefe22020-02-05 10:44:56 +00001708int mbedtls_ssl_session_reset_int( mbedtls_ssl_context *ssl, int partial );
XiaokangQian78b1fa72022-01-19 06:56:30 +00001709void mbedtls_ssl_session_reset_msg_layer( mbedtls_ssl_context *ssl,
1710 int partial );
Hanno Becker43aefe22020-02-05 10:44:56 +00001711
Jerry Yue7047812021-09-13 19:26:39 +08001712/*
Jerry Yu394ece62021-09-14 22:17:21 +08001713 * Send pending alert
Jerry Yue7047812021-09-13 19:26:39 +08001714 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001715MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue7047812021-09-13 19:26:39 +08001716int mbedtls_ssl_handle_pending_alert( mbedtls_ssl_context *ssl );
1717
Jerry Yu394ece62021-09-14 22:17:21 +08001718/*
1719 * Set pending fatal alert flag.
1720 */
1721void mbedtls_ssl_pend_fatal_alert( mbedtls_ssl_context *ssl,
1722 unsigned char alert_type,
1723 int alert_reason );
1724
1725/* Alias of mbedtls_ssl_pend_fatal_alert */
1726#define MBEDTLS_SSL_PEND_FATAL_ALERT( type, user_return_value ) \
1727 mbedtls_ssl_pend_fatal_alert( ssl, type, user_return_value )
1728
Hanno Becker7e8e6a62020-02-05 10:45:48 +00001729#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1730void mbedtls_ssl_dtls_replay_reset( mbedtls_ssl_context *ssl );
1731#endif
1732
Hanno Beckerce5f5fd2020-02-05 10:47:44 +00001733void mbedtls_ssl_handshake_wrapup_free_hs_transform( mbedtls_ssl_context *ssl );
1734
Hanno Becker08f09132020-02-11 15:40:07 +00001735#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001736MBEDTLS_CHECK_RETURN_CRITICAL
Hanno Becker40cdaa12020-02-05 10:48:27 +00001737int mbedtls_ssl_start_renegotiation( mbedtls_ssl_context *ssl );
Hanno Becker08f09132020-02-11 15:40:07 +00001738#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker89490712020-02-05 10:50:12 +00001739
Hanno Becker533ab5f2020-02-05 10:49:13 +00001740#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker08f09132020-02-11 15:40:07 +00001741size_t mbedtls_ssl_get_current_mtu( const mbedtls_ssl_context *ssl );
Hanno Becker533ab5f2020-02-05 10:49:13 +00001742void mbedtls_ssl_buffering_free( mbedtls_ssl_context *ssl );
1743void mbedtls_ssl_flight_free( mbedtls_ssl_flight_item *flight );
1744#endif /* MBEDTLS_SSL_PROTO_DTLS */
1745
Jerry Yu60835a82021-08-04 10:13:52 +08001746/**
1747 * ssl utils functions for checking configuration.
1748 */
1749
Ronald Cron6f135e12021-12-08 16:57:54 +01001750#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001751static inline int mbedtls_ssl_conf_is_tls13_only( const mbedtls_ssl_config *conf )
1752{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001753 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 &&
1754 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001755}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001756
Ronald Cron6f135e12021-12-08 16:57:54 +01001757#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001758
1759#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1760static inline int mbedtls_ssl_conf_is_tls12_only( const mbedtls_ssl_config *conf )
1761{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001762 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1763 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu60835a82021-08-04 10:13:52 +08001764}
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001765
Jerry Yu60835a82021-08-04 10:13:52 +08001766#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1767
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001768static inline int mbedtls_ssl_conf_is_tls13_enabled( const mbedtls_ssl_config *conf )
1769{
1770#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001771 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_3 &&
1772 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001773#else
1774 ((void) conf);
1775 return( 0 );
1776#endif
1777}
1778
1779static inline int mbedtls_ssl_conf_is_tls12_enabled( const mbedtls_ssl_config *conf )
1780{
1781#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001782 return( conf->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 &&
1783 conf->max_tls_version >= MBEDTLS_SSL_VERSION_TLS1_2 );
Jerry Yu3ad14ac2022-01-11 17:13:16 +08001784#else
1785 ((void) conf);
1786 return( 0 );
1787#endif
1788}
1789
Ronald Cron6f135e12021-12-08 16:57:54 +01001790#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu60835a82021-08-04 10:13:52 +08001791static inline int mbedtls_ssl_conf_is_hybrid_tls12_tls13( const mbedtls_ssl_config *conf )
1792{
Glenn Strauss2dfcea22022-03-14 17:26:42 -04001793 return( conf->min_tls_version == MBEDTLS_SSL_VERSION_TLS1_2 &&
1794 conf->max_tls_version == MBEDTLS_SSL_VERSION_TLS1_3 );
Jerry Yu60835a82021-08-04 10:13:52 +08001795}
Ronald Cron6f135e12021-12-08 16:57:54 +01001796#endif /* MBEDTLS_SSL_PROTO_TLS1_2 && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu60835a82021-08-04 10:13:52 +08001797
Ronald Cron6f135e12021-12-08 16:57:54 +01001798#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yufbe3e642022-04-25 19:31:51 +08001799extern const uint8_t mbedtls_ssl_tls13_hello_retry_request_magic[
1800 MBEDTLS_SERVER_HELLO_RANDOM_LEN ];
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001801MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001802int mbedtls_ssl_tls13_process_finished_message( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001803MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001804int mbedtls_ssl_tls13_write_finished_message( mbedtls_ssl_context *ssl );
1805void mbedtls_ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl );
1806
1807/**
Ronald Cron3d580bf2022-02-18 17:24:56 +01001808 * \brief Given an SSL context and its associated configuration, write the TLS
1809 * 1.3 specific extensions of the ClientHello message.
1810 *
1811 * \param[in] ssl SSL context
1812 * \param[in] buf Base address of the buffer where to write the extensions
1813 * \param[in] end End address of the buffer where to write the extensions
1814 * \param[out] out_len Length of the data written into the buffer \p buf
1815 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001816MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron3d580bf2022-02-18 17:24:56 +01001817int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1818 unsigned char *buf,
1819 unsigned char *end,
1820 size_t *out_len );
1821
1822/**
Jerry Yua6e6c272021-11-17 17:54:13 +08001823 * \brief TLS 1.3 client side state machine entry
1824 *
1825 * \param ssl SSL context
1826 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001827MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001828int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl );
1829
1830/**
1831 * \brief TLS 1.3 server side state machine entry
1832 *
1833 * \param ssl SSL context
1834 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02001835MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yua6e6c272021-11-17 17:54:13 +08001836int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl );
1837
Jerry Yu26f4d152021-08-23 17:42:37 +08001838
1839/*
1840 * Helper functions around key exchange modes.
1841 */
Jerry Yub60e3cf2021-09-08 16:41:02 +08001842static inline unsigned mbedtls_ssl_conf_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
Jerry Yu26f4d152021-08-23 17:42:37 +08001843 int kex_mode_mask )
1844{
1845 return( ( ssl->conf->tls13_kex_modes & kex_mode_mask ) != 0 );
1846}
1847
Jerry Yub60e3cf2021-09-08 16:41:02 +08001848static inline int mbedtls_ssl_conf_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001849{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001850 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001851 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001852}
1853
1854static inline int mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( mbedtls_ssl_context *ssl )
1855{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001856 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001857 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001858}
1859
Jerry Yub60e3cf2021-09-08 16:41:02 +08001860static inline int mbedtls_ssl_conf_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu26f4d152021-08-23 17:42:37 +08001861{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001862 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001863 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001864}
1865
1866static inline int mbedtls_ssl_conf_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
1867{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001868 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001869 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001870}
1871
1872static inline int mbedtls_ssl_conf_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
1873{
Jerry Yub60e3cf2021-09-08 16:41:02 +08001874 return( mbedtls_ssl_conf_tls13_check_kex_modes( ssl,
Xiaofei Bai746f9482021-11-12 08:53:56 +00001875 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu26f4d152021-08-23 17:42:37 +08001876}
1877
Ronald Cron41a443a2022-10-04 16:38:25 +02001878#if defined(MBEDTLS_SSL_SRV_C) && \
1879 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuadf861a2021-09-29 21:22:08 +08001880/**
1881 * Given a list of key exchange modes, check if at least one of them is
1882 * supported.
1883 *
1884 * \param[in] ssl SSL context
Jerry Yu0cabad32021-09-30 09:52:35 +08001885 * \param kex_modes_mask Mask of the key exchange modes to check
Jerry Yuadf861a2021-09-29 21:22:08 +08001886 *
1887 * \return 0 if at least one of the key exchange modes is supported,
Jerry Yudca3d5d2021-10-08 14:19:29 +08001888 * !=0 otherwise.
Jerry Yuadf861a2021-09-29 21:22:08 +08001889 */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001890static inline unsigned mbedtls_ssl_tls13_check_kex_modes( mbedtls_ssl_context *ssl,
1891 int kex_modes_mask )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001892{
Xiaofei Baid25fab62021-12-02 06:36:27 +00001893 return( ( ssl->handshake->tls13_kex_modes & kex_modes_mask ) == 0 );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001894}
1895
Xiaofei Bai746f9482021-11-12 08:53:56 +00001896static inline int mbedtls_ssl_tls13_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001897{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001898 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1899 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001900}
1901
Xiaofei Bai746f9482021-11-12 08:53:56 +00001902static inline int mbedtls_ssl_tls13_psk_ephemeral_enabled(
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001903 mbedtls_ssl_context *ssl )
1904{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001905 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1906 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001907}
1908
Xiaofei Bai746f9482021-11-12 08:53:56 +00001909static inline int mbedtls_ssl_tls13_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001910{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001911 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1912 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001913}
1914
Xiaofei Bai746f9482021-11-12 08:53:56 +00001915static inline int mbedtls_ssl_tls13_some_ephemeral_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001916{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001917 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1918 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001919}
1920
Xiaofei Bai746f9482021-11-12 08:53:56 +00001921static inline int mbedtls_ssl_tls13_some_psk_enabled( mbedtls_ssl_context *ssl )
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001922{
Xiaofei Bai746f9482021-11-12 08:53:56 +00001923 return( ! mbedtls_ssl_tls13_check_kex_modes( ssl,
1924 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001925}
Ronald Cron41a443a2022-10-04 16:38:25 +02001926#endif /* MBEDTLS_SSL_SRV_C &&
1927 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1b7c4a42021-09-09 17:09:12 +08001928
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08001929/*
Jerry Yue18dc7e2022-08-04 16:29:22 +08001930 * Helper functions to check if the extension is allowed or forbiden
1931 */
1932static inline int mbedtls_ssl_tls13_has_extensions( mbedtls_ssl_context *ssl,
1933 int extensions_mask )
1934{
1935 int masked = ssl->handshake->extensions_present & extensions_mask;
1936 return( masked != 0 );
1937}
1938
1939static inline int mbedtls_tls13_get_extension_mask( uint16_t extension_type )
1940{
1941 switch( extension_type )
1942 {
1943 case MBEDTLS_TLS_EXT_SERVERNAME:
1944 return( MBEDTLS_SSL_EXT_SERVERNAME );
1945
1946 case MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH:
1947 return( MBEDTLS_SSL_EXT_MAX_FRAGMENT_LENGTH );
1948
1949 case MBEDTLS_TLS_EXT_STATUS_REQUEST:
1950 return( MBEDTLS_SSL_EXT_STATUS_REQUEST );
1951
1952 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1953 return( MBEDTLS_SSL_EXT_SUPPORTED_GROUPS );
1954
1955 case MBEDTLS_TLS_EXT_SIG_ALG:
1956 return( MBEDTLS_SSL_EXT_SIG_ALG );
1957
1958 case MBEDTLS_TLS_EXT_USE_SRTP:
1959 return( MBEDTLS_SSL_EXT_USE_SRTP );
1960
1961 case MBEDTLS_TLS_EXT_HEARTBEAT:
1962 return( MBEDTLS_SSL_EXT_HEARTBEAT );
1963
1964 case MBEDTLS_TLS_EXT_ALPN:
1965 return( MBEDTLS_SSL_EXT_ALPN );
1966
1967 case MBEDTLS_TLS_EXT_SCT:
1968 return( MBEDTLS_SSL_EXT_SCT );
1969
1970 case MBEDTLS_TLS_EXT_CLI_CERT_TYPE:
1971 return( MBEDTLS_SSL_EXT_CLI_CERT_TYPE );
1972
1973 case MBEDTLS_TLS_EXT_SERV_CERT_TYPE:
1974 return( MBEDTLS_SSL_EXT_SERV_CERT_TYPE );
1975
1976 case MBEDTLS_TLS_EXT_PADDING:
1977 return( MBEDTLS_SSL_EXT_PADDING );
1978
1979 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1980 return( MBEDTLS_SSL_EXT_PRE_SHARED_KEY );
1981
1982 case MBEDTLS_TLS_EXT_EARLY_DATA:
1983 return( MBEDTLS_SSL_EXT_EARLY_DATA );
1984
1985 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1986 return( MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS );
1987
1988 case MBEDTLS_TLS_EXT_COOKIE:
1989 return( MBEDTLS_SSL_EXT_COOKIE );
1990
1991 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1992 return( MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES );
1993
1994 case MBEDTLS_TLS_EXT_CERT_AUTH:
1995 return( MBEDTLS_SSL_EXT_CERT_AUTH );
1996
1997 case MBEDTLS_TLS_EXT_OID_FILTERS:
1998 return( MBEDTLS_SSL_EXT_OID_FILTERS );
1999
2000 case MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH:
2001 return( MBEDTLS_SSL_EXT_POST_HANDSHAKE_AUTH );
2002
2003 case MBEDTLS_TLS_EXT_SIG_ALG_CERT:
2004 return( MBEDTLS_SSL_EXT_SIG_ALG_CERT );
2005
2006 case MBEDTLS_TLS_EXT_KEY_SHARE:
2007 return( MBEDTLS_SSL_EXT_KEY_SHARE );
2008 };
2009
2010 return( MBEDTLS_SSL_EXT_UNRECOGNIZED );
2011}
2012
2013/*
Ronald Cron85385492022-07-20 16:44:00 +02002014 * Helper functions to check the selected key exchange mode.
2015 */
2016static inline int mbedtls_ssl_tls13_key_exchange_mode_check(
2017 mbedtls_ssl_context *ssl, int kex_mask )
2018{
2019 return( ( ssl->handshake->key_exchange_mode & kex_mask ) != 0 );
2020}
2021
2022static inline int mbedtls_ssl_tls13_key_exchange_mode_with_psk(
2023 mbedtls_ssl_context *ssl )
2024{
2025 return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl,
2026 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL ) );
2027}
2028
2029static inline int mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(
2030 mbedtls_ssl_context *ssl )
2031{
2032 return( mbedtls_ssl_tls13_key_exchange_mode_check( ssl,
2033 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL ) );
2034}
2035
2036/*
XiaokangQian6b226b02021-09-24 07:51:16 +00002037 * Fetch TLS 1.3 handshake message header
2038 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002039MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002040int mbedtls_ssl_tls13_fetch_handshake_msg( mbedtls_ssl_context *ssl,
2041 unsigned hs_type,
2042 unsigned char **buf,
2043 size_t *buf_len );
XiaokangQian6b226b02021-09-24 07:51:16 +00002044
2045/*
Xiaofei Bai947571e2021-09-29 09:12:03 +00002046 * Handler of TLS 1.3 server certificate message
2047 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002048MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai947571e2021-09-29 09:12:03 +00002049int mbedtls_ssl_tls13_process_certificate( mbedtls_ssl_context *ssl );
2050
Ronald Cron928cbd32022-10-04 16:14:26 +02002051#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002052/*
Jerry Yu3e536442022-02-15 11:05:59 +08002053 * Handler of TLS 1.3 write Certificate message
Jerry Yu5cc35062022-01-28 16:16:08 +08002054 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002055MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5cc35062022-01-28 16:16:08 +08002056int mbedtls_ssl_tls13_write_certificate( mbedtls_ssl_context *ssl );
2057
2058/*
Jerry Yu3e536442022-02-15 11:05:59 +08002059 * Handler of TLS 1.3 write Certificate Verify message
Jerry Yu8511f122022-01-29 10:01:04 +08002060 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002061MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8511f122022-01-29 10:01:04 +08002062int mbedtls_ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl );
Jerry Yu90f152d2022-01-29 22:12:42 +08002063
Ronald Cron928cbd32022-10-04 16:14:26 +02002064#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu90f152d2022-01-29 22:12:42 +08002065
Jerry Yu8511f122022-01-29 10:01:04 +08002066/*
Jerry Yu30b071c2021-09-12 20:16:03 +08002067 * Generic handler of Certificate Verify
2068 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002069MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu30b071c2021-09-12 20:16:03 +08002070int mbedtls_ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl );
2071
2072/*
Ronald Cron49ad6192021-11-24 16:25:31 +01002073 * Write of dummy-CCS's for middlebox compatibility
2074 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002075MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron49ad6192021-11-24 16:25:31 +01002076int mbedtls_ssl_tls13_write_change_cipher_spec( mbedtls_ssl_context *ssl );
2077
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002078MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian647719a2021-12-07 09:16:29 +00002079int mbedtls_ssl_reset_transcript_for_hrr( mbedtls_ssl_context *ssl );
2080
Jerry Yu89e103c2022-03-30 22:43:29 +08002081#if defined(MBEDTLS_ECDH_C)
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002082MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu89e103c2022-03-30 22:43:29 +08002083int mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
2084 mbedtls_ssl_context *ssl,
2085 uint16_t named_group,
2086 unsigned char *buf,
2087 unsigned char *end,
2088 size_t *out_len );
2089#endif /* MBEDTLS_ECDH_C */
2090
2091
Jerry Yuf017ee42022-01-12 15:49:48 +08002092#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
2093
Ronald Crone68ab4f2022-10-05 12:46:29 +02002094#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu5cc8f0a2021-08-27 17:21:44 +08002095/*
Gabor Mezei53a3b142022-05-10 13:20:55 +02002096 * Parse TLS Signature Algorithm extension
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002097 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002098MBEDTLS_CHECK_RETURN_CRITICAL
Gabor Mezei078e8032022-04-27 21:17:56 +02002099int mbedtls_ssl_parse_sig_alg_ext( mbedtls_ssl_context *ssl,
2100 const unsigned char *buf,
2101 const unsigned char *end );
Ronald Crone68ab4f2022-10-05 12:46:29 +02002102#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002103
Jerry Yu000f9762021-09-14 11:12:51 +08002104/* Get handshake transcript */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002105MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu000f9762021-09-14 11:12:51 +08002106int mbedtls_ssl_get_handshake_transcript( mbedtls_ssl_context *ssl,
2107 const mbedtls_md_type_t md,
2108 unsigned char *dst,
2109 size_t dst_len,
2110 size_t *olen );
2111
Brett Warrene0edc842021-08-17 09:53:13 +01002112/*
2113 * Return supported groups.
2114 *
2115 * In future, invocations can be changed to ssl->conf->group_list
2116 * when mbedtls_ssl_conf_curves() is deleted.
2117 *
2118 * ssl->handshake->group_list is either a translation of curve_list to IANA TLS group
2119 * identifiers when mbedtls_ssl_conf_curves() has been used, or a pointer to
2120 * ssl->conf->group_list when mbedtls_ssl_conf_groups() has been more recently invoked.
2121 *
2122 */
2123static inline const void *mbedtls_ssl_get_groups( const mbedtls_ssl_context *ssl )
2124{
2125 #if defined(MBEDTLS_DEPRECATED_REMOVED) || !defined(MBEDTLS_ECP_C)
2126 return( ssl->conf->group_list );
2127 #else
2128 if( ( ssl->handshake != NULL ) && ( ssl->handshake->group_list != NULL ) )
2129 return( ssl->handshake->group_list );
2130 else
2131 return( ssl->conf->group_list );
2132 #endif
2133}
2134
Jerry Yuba073422021-12-20 22:22:15 +08002135/*
2136 * Helper functions for NamedGroup.
2137 */
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002138static inline int mbedtls_ssl_tls12_named_group_is_ecdhe( uint16_t named_group )
Jerry Yuba073422021-12-20 22:22:15 +08002139{
2140 /*
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002141 * RFC 8422 section 5.1.1
Jerry Yuba073422021-12-20 22:22:15 +08002142 */
Jerry Yuf0fede52022-01-12 10:57:47 +08002143 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2144 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 ||
2145 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 ||
2146 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 ||
2147 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 ||
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002148 /* Below deprecated curves should be removed with notice to users */
Jerry Yuf0fede52022-01-12 10:57:47 +08002149 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 ||
Jerry Yu3ad14ac2022-01-11 17:13:16 +08002150 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 ||
2151 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 ||
2152 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 ||
2153 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 ||
2154 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
2155 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
Jerry Yuf0fede52022-01-12 10:57:47 +08002156 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 );
Jerry Yuba073422021-12-20 22:22:15 +08002157}
2158
2159static inline int mbedtls_ssl_tls13_named_group_is_ecdhe( uint16_t named_group )
2160{
Jerry Yuf0fede52022-01-12 10:57:47 +08002161 return( named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X25519 ||
2162 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08002163 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 ||
2164 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 ||
Jerry Yuba073422021-12-20 22:22:15 +08002165 named_group == MBEDTLS_SSL_IANA_TLS_GROUP_X448 );
2166}
2167
2168static inline int mbedtls_ssl_tls13_named_group_is_dhe( uint16_t named_group )
2169{
2170 return( named_group >= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 &&
2171 named_group <= MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 );
2172}
2173
XiaokangQian08037552022-04-20 07:16:41 +00002174static inline int mbedtls_ssl_named_group_is_offered(
2175 const mbedtls_ssl_context *ssl, uint16_t named_group )
2176{
2177 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
2178
2179 if( group_list == NULL )
2180 return( 0 );
2181
2182 for( ; *group_list != 0; group_list++ )
2183 {
2184 if( *group_list == named_group )
2185 return( 1 );
2186 }
2187
2188 return( 0 );
2189}
2190
2191static inline int mbedtls_ssl_named_group_is_supported( uint16_t named_group )
2192{
2193#if defined(MBEDTLS_ECDH_C)
2194 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
2195 {
2196 const mbedtls_ecp_curve_info *curve_info =
2197 mbedtls_ecp_curve_info_from_tls_id( named_group );
2198 if( curve_info != NULL )
2199 return( 1 );
2200 }
2201#else
2202 ((void) named_group);
2203#endif /* MBEDTLS_ECDH_C */
2204 return( 0 );
2205}
2206
Jerry Yuafdfed12021-12-22 10:49:02 +08002207/*
Jerry Yu713013f2022-01-17 18:16:35 +08002208 * Return supported signature algorithms.
2209 *
2210 * In future, invocations can be changed to ssl->conf->sig_algs when
2211 * mbedtls_ssl_conf_sig_hashes() is deleted.
2212 *
Jerry Yu7ddc38c2022-01-19 11:08:05 +08002213 * ssl->handshake->sig_algs is either a translation of sig_hashes to IANA TLS
2214 * signature algorithm identifiers when mbedtls_ssl_conf_sig_hashes() has been
2215 * used, or a pointer to ssl->conf->sig_algs when mbedtls_ssl_conf_sig_algs() has
2216 * been more recently invoked.
2217 *
Jerry Yuafdfed12021-12-22 10:49:02 +08002218 */
Jerry Yu713013f2022-01-17 18:16:35 +08002219static inline const void *mbedtls_ssl_get_sig_algs(
2220 const mbedtls_ssl_context *ssl )
Jerry Yuafdfed12021-12-22 10:49:02 +08002221{
Ronald Crone68ab4f2022-10-05 12:46:29 +02002222#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002223
Jerry Yu6106fdc2022-01-12 16:36:14 +08002224#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jerry Yucc539102022-06-27 16:27:35 +08002225 if( ssl->handshake != NULL &&
2226 ssl->handshake->sig_algs_heap_allocated == 1 &&
Jerry Yuee28e7a2022-06-24 19:35:40 +08002227 ssl->handshake->sig_algs != NULL )
2228 {
Jerry Yu6106fdc2022-01-12 16:36:14 +08002229 return( ssl->handshake->sig_algs );
Jerry Yuee28e7a2022-06-24 19:35:40 +08002230 }
Jerry Yu6106fdc2022-01-12 16:36:14 +08002231#endif
2232 return( ssl->conf->sig_algs );
Manuel Pégourié-Gonnardf7d704d2022-01-28 10:05:56 +01002233
Ronald Crone68ab4f2022-10-05 12:46:29 +02002234#else /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002235
Jerry Yu6106fdc2022-01-12 16:36:14 +08002236 ((void) ssl);
Jerry Yu713013f2022-01-17 18:16:35 +08002237 return( NULL );
Ronald Crone68ab4f2022-10-05 12:46:29 +02002238#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yuafdfed12021-12-22 10:49:02 +08002239}
Jerry Yuba073422021-12-20 22:22:15 +08002240
Ronald Cron928cbd32022-10-04 16:14:26 +02002241#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu8511f122022-01-29 10:01:04 +08002242static inline int mbedtls_ssl_sig_alg_is_received( const mbedtls_ssl_context *ssl,
2243 uint16_t own_sig_alg )
2244{
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002245 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
2246 if( sig_alg == NULL )
2247 return( 0 );
2248
Gabor Mezei15b95a62022-05-09 16:37:58 +02002249 for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ )
Jerry Yu1bb5a1f2022-01-30 10:52:11 +08002250 {
2251 if( *sig_alg == own_sig_alg )
2252 return( 1 );
2253 }
2254 return( 0 );
Jerry Yu8511f122022-01-29 10:01:04 +08002255}
2256
Jerry Yua1255e62022-06-24 10:10:47 +08002257static inline int mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Jerry Yu0ebce952022-06-16 13:54:47 +08002258 const uint16_t sig_alg )
2259{
Jerry Yu96ee23e2022-06-21 16:34:57 +08002260 switch( sig_alg )
2261 {
2262#if defined(MBEDTLS_ECDSA_C)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002263#if defined(PSA_WANT_ALG_SHA_256) && defined(MBEDTLS_ECP_DP_SECP256R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002264 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
2265 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002266#endif /* PSA_WANT_ALG_SHA_256 && MBEDTLS_ECP_DP_SECP256R1_ENABLED */
2267#if defined(PSA_WANT_ALG_SHA_384) && defined(MBEDTLS_ECP_DP_SECP384R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002268 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
2269 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002270#endif /* PSA_WANT_ALG_SHA_384 && MBEDTLS_ECP_DP_SECP384R1_ENABLED */
2271#if defined(PSA_WANT_ALG_SHA_512) && defined(MBEDTLS_ECP_DP_SECP521R1_ENABLED)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002272 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
2273 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002274#endif /* PSA_WANT_ALG_SHA_512 && MBEDTLS_ECP_DP_SECP521R1_ENABLED */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002275#endif /* MBEDTLS_ECDSA_C */
2276
Jerry Yu52b7d922022-07-01 18:03:31 +08002277#if defined(MBEDTLS_PKCS1_V21)
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002278#if defined(PSA_WANT_ALG_SHA_256)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002279 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2280 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002281#endif /* PSA_WANT_ALG_SHA_256 */
2282#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002283 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2284 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002285#endif /* PSA_WANT_ALG_SHA_384 */
2286#if defined(PSA_WANT_ALG_SHA_512)
Jerry Yu96ee23e2022-06-21 16:34:57 +08002287 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2288 break;
Przemyslaw Stekiel004c2182022-09-14 09:09:16 +02002289#endif /* PSA_WANT_ALG_SHA_512 */
Jerry Yu52b7d922022-07-01 18:03:31 +08002290#endif /* MBEDTLS_PKCS1_V21 */
Jerry Yu96ee23e2022-06-21 16:34:57 +08002291 default:
2292 return( 0 );
2293 }
2294 return( 1 );
Jerry Yu80dd5db2022-06-22 19:30:32 +08002295
2296}
2297
2298static inline int mbedtls_ssl_tls13_sig_alg_is_supported(
2299 const uint16_t sig_alg )
2300{
2301 switch( sig_alg )
2302 {
Jerry Yu52b7d922022-07-01 18:03:31 +08002303#if defined(MBEDTLS_PKCS1_V15)
Przemek Stekiel153b4422022-09-05 12:36:25 +02002304#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002305 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
2306 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002307#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2308#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002309 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
2310 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002311#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2312#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu80dd5db2022-06-22 19:30:32 +08002313 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
2314 break;
Przemek Stekiel153b4422022-09-05 12:36:25 +02002315#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
Jerry Yu52b7d922022-07-01 18:03:31 +08002316#endif /* MBEDTLS_PKCS1_V15 */
Jerry Yu80dd5db2022-06-22 19:30:32 +08002317 default:
Jerry Yua1255e62022-06-24 10:10:47 +08002318 return( mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(
Jerry Yu80dd5db2022-06-22 19:30:32 +08002319 sig_alg ) );
2320 }
2321 return( 1 );
Jerry Yu0ebce952022-06-16 13:54:47 +08002322}
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002323
Ronald Cron928cbd32022-10-04 16:14:26 +02002324MBEDTLS_CHECK_RETURN_CRITICAL
2325int mbedtls_ssl_tls13_check_sig_alg_cert_key_match( uint16_t sig_alg,
2326 mbedtls_pk_context *key );
2327#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
2328
Ronald Crone68ab4f2022-10-05 12:46:29 +02002329#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Ronald Cron928cbd32022-10-04 16:14:26 +02002330static inline int mbedtls_ssl_sig_alg_is_offered( const mbedtls_ssl_context *ssl,
2331 uint16_t proposed_sig_alg )
2332{
2333 const uint16_t *sig_alg = mbedtls_ssl_get_sig_algs( ssl );
2334 if( sig_alg == NULL )
2335 return( 0 );
2336
2337 for( ; *sig_alg != MBEDTLS_TLS_SIG_NONE; sig_alg++ )
2338 {
2339 if( *sig_alg == proposed_sig_alg )
2340 return( 1 );
2341 }
2342 return( 0 );
2343}
2344
2345static inline int mbedtls_ssl_get_pk_type_and_md_alg_from_sig_alg(
2346 uint16_t sig_alg, mbedtls_pk_type_t *pk_type, mbedtls_md_type_t *md_alg )
2347{
2348 *pk_type = mbedtls_ssl_pk_alg_from_sig( sig_alg & 0xff );
2349 *md_alg = mbedtls_ssl_md_alg_from_hash( ( sig_alg >> 8 ) & 0xff );
2350
2351 if( *pk_type != MBEDTLS_PK_NONE && *md_alg != MBEDTLS_MD_NONE )
2352 return( 0 );
2353
2354 switch( sig_alg )
2355 {
2356#if defined(MBEDTLS_PKCS1_V21)
2357#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2358 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
2359 *md_alg = MBEDTLS_MD_SHA256;
2360 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2361 break;
2362#endif /* MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2363#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2364 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
2365 *md_alg = MBEDTLS_MD_SHA384;
2366 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2367 break;
2368#endif /* MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2369#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
2370 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
2371 *md_alg = MBEDTLS_MD_SHA512;
2372 *pk_type = MBEDTLS_PK_RSASSA_PSS;
2373 break;
2374#endif /* MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA */
2375#endif /* MBEDTLS_PKCS1_V21 */
2376 default:
2377 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
2378 }
2379 return( 0 );
2380}
Jerry Yu8c338862022-03-23 13:34:04 +08002381
Jerry Yu0ebce952022-06-16 13:54:47 +08002382#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
2383static inline int mbedtls_ssl_tls12_sig_alg_is_supported(
2384 const uint16_t sig_alg )
2385{
2386 /* High byte is hash */
2387 unsigned char hash = MBEDTLS_BYTE_1( sig_alg );
2388 unsigned char sig = MBEDTLS_BYTE_0( sig_alg );
2389
2390 switch( hash )
2391 {
Andrzej Kurek25f27152022-08-17 16:09:31 -04002392#if defined(MBEDTLS_HAS_ALG_MD5_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002393 case MBEDTLS_SSL_HASH_MD5:
2394 break;
2395#endif
2396
Andrzej Kurek25f27152022-08-17 16:09:31 -04002397#if defined(MBEDTLS_HAS_ALG_SHA_1_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002398 case MBEDTLS_SSL_HASH_SHA1:
2399 break;
2400#endif
2401
Andrzej Kurek25f27152022-08-17 16:09:31 -04002402#if defined(MBEDTLS_HAS_ALG_SHA_224_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002403 case MBEDTLS_SSL_HASH_SHA224:
2404 break;
2405#endif
2406
Andrzej Kurek25f27152022-08-17 16:09:31 -04002407#if defined(MBEDTLS_HAS_ALG_SHA_256_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002408 case MBEDTLS_SSL_HASH_SHA256:
2409 break;
2410#endif
2411
Andrzej Kurek25f27152022-08-17 16:09:31 -04002412#if defined(MBEDTLS_HAS_ALG_SHA_384_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002413 case MBEDTLS_SSL_HASH_SHA384:
2414 break;
2415#endif
2416
Andrzej Kurek25f27152022-08-17 16:09:31 -04002417#if defined(MBEDTLS_HAS_ALG_SHA_512_VIA_MD_OR_PSA_BASED_ON_USE_PSA)
Jerry Yu0ebce952022-06-16 13:54:47 +08002418 case MBEDTLS_SSL_HASH_SHA512:
2419 break;
2420#endif
2421
2422 default:
2423 return( 0 );
2424 }
2425
2426 switch( sig )
2427 {
2428#if defined(MBEDTLS_RSA_C)
2429 case MBEDTLS_SSL_SIG_RSA:
2430 break;
2431#endif
2432
2433#if defined(MBEDTLS_ECDSA_C)
2434 case MBEDTLS_SSL_SIG_ECDSA:
2435 break;
2436#endif
2437
2438 default:
2439 return( 0 );
2440 }
2441
2442 return( 1 );
2443}
2444#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2445
Jerry Yu1bab3012022-01-19 17:43:22 +08002446static inline int mbedtls_ssl_sig_alg_is_supported(
2447 const mbedtls_ssl_context *ssl,
2448 const uint16_t sig_alg )
2449{
2450
2451#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002452 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002453 {
Jerry Yu0ebce952022-06-16 13:54:47 +08002454 return( mbedtls_ssl_tls12_sig_alg_is_supported( sig_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002455 }
2456#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
2457
Ronald Cron928cbd32022-10-04 16:14:26 +02002458#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Glenn Strauss60bfe602022-03-14 19:04:24 -04002459 if( ssl->tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yu1bab3012022-01-19 17:43:22 +08002460 {
Jerry Yu7ab7f2b2022-06-16 19:07:10 +08002461 return( mbedtls_ssl_tls13_sig_alg_is_supported( sig_alg ) );
Jerry Yu1bab3012022-01-19 17:43:22 +08002462 }
Ronald Cron928cbd32022-10-04 16:14:26 +02002463#endif
Jerry Yu1bab3012022-01-19 17:43:22 +08002464 ((void) ssl);
2465 ((void) sig_alg);
2466 return( 0 );
2467}
Ronald Crone68ab4f2022-10-05 12:46:29 +02002468#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Jerry Yu1bab3012022-01-19 17:43:22 +08002469
Neil Armstrong8395d7a2022-05-18 11:44:56 +02002470#if defined(MBEDTLS_USE_PSA_CRYPTO) || defined(MBEDTLS_SSL_PROTO_TLS1_3)
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002471/* Corresponding PSA algorithm for MBEDTLS_CIPHER_NULL.
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002472 * Same value is used for PSA_ALG_CATEGORY_CIPHER, hence it is
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002473 * guaranteed to not be a valid PSA algorithm identifier.
2474 */
2475#define MBEDTLS_SSL_NULL_CIPHER 0x04000000
2476
2477/**
2478 * \brief Translate mbedtls cipher type/taglen pair to psa:
2479 * algorithm, key type and key size.
2480 *
2481 * \param mbedtls_cipher_type [in] given mbedtls cipher type
2482 * \param taglen [in] given tag length
2483 * 0 - default tag length
2484 * \param alg [out] corresponding PSA alg
2485 * There is no corresponding PSA
Przemyslaw Stekiel8c010eb2022-02-03 10:44:02 +01002486 * alg for MBEDTLS_CIPHER_NULL, so
2487 * in this case MBEDTLS_SSL_NULL_CIPHER
2488 * is returned via this parameter
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002489 * \param key_type [out] corresponding PSA key type
2490 * \param key_size [out] corresponding PSA key size
2491 *
2492 * \return PSA_SUCCESS on success or PSA_ERROR_NOT_SUPPORTED if
2493 * conversion is not supported.
2494 */
2495psa_status_t mbedtls_ssl_cipher_to_psa( mbedtls_cipher_type_t mbedtls_cipher_type,
2496 size_t taglen,
2497 psa_algorithm_t *alg,
2498 psa_key_type_t *key_type,
2499 size_t *key_size );
2500
2501/**
2502 * \brief Convert given PSA status to mbedtls error code.
2503 *
2504 * \param status [in] given PSA status
2505 *
2506 * \return corresponding mbedtls error code
2507 */
Przemyslaw Stekiel77aec8d2022-01-31 20:22:53 +01002508static inline int psa_ssl_status_to_mbedtls( psa_status_t status )
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002509{
2510 switch( status )
2511 {
2512 case PSA_SUCCESS:
2513 return( 0 );
2514 case PSA_ERROR_INSUFFICIENT_MEMORY:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002515 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002516 case PSA_ERROR_NOT_SUPPORTED:
Gabor Mezei1bf075f2022-03-21 12:19:52 +01002517 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Przemyslaw Stekiel89dad932022-01-31 09:18:07 +01002518 case PSA_ERROR_INVALID_SIGNATURE:
2519 return( MBEDTLS_ERR_SSL_INVALID_MAC );
Gabor Mezeiadfeadc2022-03-21 12:17:49 +01002520 case PSA_ERROR_INVALID_ARGUMENT:
2521 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2522 case PSA_ERROR_BAD_STATE:
2523 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Przemek Stekiel85836272022-04-05 10:50:53 +02002524 case PSA_ERROR_BUFFER_TOO_SMALL:
2525 return( MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL );
Przemyslaw Stekiele5c22382022-01-25 00:56:34 +01002526 default:
2527 return( MBEDTLS_ERR_PLATFORM_HW_ACCEL_FAILED );
2528 }
2529}
Przemyslaw Stekielb15f33d2022-02-10 10:12:12 +01002530#endif /* MBEDTLS_USE_PSA_CRYPTO || MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu1bab3012022-01-19 17:43:22 +08002531
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002532/**
2533 * \brief TLS record protection modes
2534 */
2535typedef enum {
2536 MBEDTLS_SSL_MODE_STREAM = 0,
2537 MBEDTLS_SSL_MODE_CBC,
2538 MBEDTLS_SSL_MODE_CBC_ETM,
2539 MBEDTLS_SSL_MODE_AEAD
2540} mbedtls_ssl_mode_t;
2541
Neil Armstrongab555e02022-04-04 11:07:59 +02002542mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_transform(
Neil Armstrong8a0f3e82022-03-30 10:57:37 +02002543 const mbedtls_ssl_transform *transform );
2544
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002545#if defined(MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM)
Neil Armstrongab555e02022-04-04 11:07:59 +02002546mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002547 int encrypt_then_mac,
2548 const mbedtls_ssl_ciphersuite_t *suite );
2549#else
Neil Armstrongab555e02022-04-04 11:07:59 +02002550mbedtls_ssl_mode_t mbedtls_ssl_get_mode_from_ciphersuite(
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002551 const mbedtls_ssl_ciphersuite_t *suite );
Neil Armstrongf2c82f02022-04-05 11:16:53 +02002552#endif /* MBEDTLS_SSL_SOME_SUITES_USE_CBC_ETM */
Neil Armstrong4bf4c862022-04-01 10:35:48 +02002553
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002554#if defined(MBEDTLS_ECDH_C)
2555
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002556MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b5d04b2022-04-10 10:20:43 +00002557int mbedtls_ssl_tls13_read_public_ecdhe_share( mbedtls_ssl_context *ssl,
2558 const unsigned char *buf,
2559 size_t buf_len );
2560
2561#endif /* MBEDTLS_ECDH_C */
2562
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002563static inline int mbedtls_ssl_tls13_cipher_suite_is_offered(
2564 mbedtls_ssl_context *ssl, int cipher_suite )
2565{
2566 const int *ciphersuite_list = ssl->conf->ciphersuite_list;
2567
2568 /* Check whether we have offered this ciphersuite */
2569 for ( size_t i = 0; ciphersuite_list[i] != 0; i++ )
2570 {
2571 if( ciphersuite_list[i] == cipher_suite )
2572 {
2573 return( 1 );
2574 }
2575 }
2576 return( 0 );
2577}
2578
2579/**
2580 * \brief Validate cipher suite against config in SSL context.
2581 *
2582 * \param ssl SSL context
2583 * \param suite_info Cipher suite to validate
2584 * \param min_tls_version Minimal TLS version to accept a cipher suite
2585 * \param max_tls_version Maximal TLS version to accept a cipher suite
2586 *
2587 * \return 0 if valid, negative value otherwise.
2588 */
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002589MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0a1b54e2022-04-21 03:01:38 +00002590int mbedtls_ssl_validate_ciphersuite(
2591 const mbedtls_ssl_context *ssl,
2592 const mbedtls_ssl_ciphersuite_t *suite_info,
2593 mbedtls_ssl_protocol_version min_tls_version,
2594 mbedtls_ssl_protocol_version max_tls_version );
XiaokangQian08037552022-04-20 07:16:41 +00002595
Manuel Pégourié-Gonnarda82a8b92022-06-17 10:53:58 +02002596MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeaf36512022-04-24 09:07:44 +00002597int mbedtls_ssl_write_sig_alg_ext( mbedtls_ssl_context *ssl, unsigned char *buf,
2598 const unsigned char *end, size_t *out_len );
2599
XiaokangQian40a35232022-05-07 09:02:40 +00002600#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002601MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian9b2b7712022-05-17 02:57:00 +00002602int mbedtls_ssl_parse_server_name_ext( mbedtls_ssl_context *ssl,
2603 const unsigned char *buf,
2604 const unsigned char *end );
XiaokangQian40a35232022-05-07 09:02:40 +00002605#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
2606
XiaokangQianacb39922022-06-17 10:18:48 +00002607#if defined(MBEDTLS_SSL_ALPN)
Ronald Cronce7d76e2022-07-08 18:56:49 +02002608MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00002609int mbedtls_ssl_parse_alpn_ext( mbedtls_ssl_context *ssl,
2610 const unsigned char *buf,
2611 const unsigned char *end );
2612
2613
Ronald Cronce7d76e2022-07-08 18:56:49 +02002614MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianacb39922022-06-17 10:18:48 +00002615int mbedtls_ssl_write_alpn_ext( mbedtls_ssl_context *ssl,
2616 unsigned char *buf,
2617 unsigned char *end,
XiaokangQianc7403452022-06-23 03:24:12 +00002618 size_t *out_len );
XiaokangQianacb39922022-06-17 10:18:48 +00002619#endif /* MBEDTLS_SSL_ALPN */
2620
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002621#if defined(MBEDTLS_TEST_HOOKS)
Andrzej Kurek078e9bc2022-06-08 11:47:33 -04002622int mbedtls_ssl_check_dtls_clihlo_cookie(
Andrzej Kurekcfb01942022-06-06 13:08:23 -04002623 mbedtls_ssl_context *ssl,
2624 const unsigned char *cli_id, size_t cli_id_len,
2625 const unsigned char *in, size_t in_len,
2626 unsigned char *obuf, size_t buf_len, size_t *olen );
2627#endif
2628
Ronald Cron41a443a2022-10-04 16:38:25 +02002629#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQianeb69aee2022-07-05 08:21:43 +00002630/**
2631 * \brief Given an SSL context and its associated configuration, write the TLS
2632 * 1.3 specific Pre-Shared key extension.
2633 *
2634 * \param[in] ssl SSL context
2635 * \param[in] buf Base address of the buffer where to write the extension
2636 * \param[in] end End address of the buffer where to write the extension
XiaokangQian008d2bf2022-07-14 07:54:01 +00002637 * \param[out] out_len Length in bytes of the Pre-Shared key extension: data
2638 * written into the buffer \p buf by this function plus
2639 * the length of the binders to be written.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002640 * \param[out] binders_len Length of the binders to be written at the end of
XiaokangQian008d2bf2022-07-14 07:54:01 +00002641 * the extension.
XiaokangQianeb69aee2022-07-05 08:21:43 +00002642 */
XiaokangQian86981952022-07-19 09:51:50 +00002643MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian3ad67bf2022-07-21 02:26:21 +00002644int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002645 mbedtls_ssl_context *ssl,
2646 unsigned char *buf, unsigned char *end,
2647 size_t *out_len, size_t *binders_len );
2648
2649/**
2650 * \brief Given an SSL context and its associated configuration, write the TLS
2651 * 1.3 specific Pre-Shared key extension binders at the end of the
2652 * ClientHello.
2653 *
2654 * \param[in] ssl SSL context
XiaokangQian008d2bf2022-07-14 07:54:01 +00002655 * \param[in] buf Base address of the buffer where to write the binders
2656 * \param[in] end End address of the buffer where to write the binders
XiaokangQianeb69aee2022-07-05 08:21:43 +00002657 */
XiaokangQian86981952022-07-19 09:51:50 +00002658MBEDTLS_CHECK_RETURN_CRITICAL
2659int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +00002660 mbedtls_ssl_context *ssl,
2661 unsigned char *buf, unsigned char *end );
Ronald Cron41a443a2022-10-04 16:38:25 +02002662#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
XiaokangQianeb69aee2022-07-05 08:21:43 +00002663
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002664#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
Xiaokang Qian03409292022-10-12 02:49:52 +00002665 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Xiaokang Qianed0620c2022-10-12 06:58:13 +00002666 defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && \
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00002667 defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qian03409292022-10-12 02:49:52 +00002668MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qiana3b451f2022-10-11 06:20:56 +00002669int mbedtls_ssl_session_set_hostname( mbedtls_ssl_session *session,
2670 const char *hostname );
2671#endif
2672
Chris Jones84a773f2021-03-05 18:38:47 +00002673#endif /* ssl_misc.h */