blob: be7d0e233bce48b06ee59d1635f1322c566bbfb3 [file] [log] [blame]
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001/**
Darryl Greena40a1012018-01-05 15:33:17 +00002 * \file ssl_internal.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/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02007 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
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 *
22 * This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020023 */
24#ifndef MBEDTLS_SSL_INTERNAL_H
25#define MBEDTLS_SSL_INTERNAL_H
26
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020027#if !defined(MBEDTLS_CONFIG_FILE)
28#include "config.h"
29#else
30#include MBEDTLS_CONFIG_FILE
31#endif
32
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020033#include "ssl.h"
Hanno Beckera8434e82017-09-18 10:54:39 +010034#include "cipher.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020035
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020036#if defined(MBEDTLS_MD5_C)
37#include "md5.h"
38#endif
39
40#if defined(MBEDTLS_SHA1_C)
41#include "sha1.h"
42#endif
43
44#if defined(MBEDTLS_SHA256_C)
45#include "sha256.h"
46#endif
47
48#if defined(MBEDTLS_SHA512_C)
49#include "sha512.h"
50#endif
51
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +020052#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +020053#include "ecjpake.h"
54#endif
55
Jarno Lamsae12aafb2019-04-04 18:32:56 +030056#if defined(MBEDTLS_USE_TINYCRYPT)
57#include "tinycrypt/ecc.h"
58#include "tinycrypt/ecc_dh.h"
59#endif
60
Hanno Becker8e7f23a2019-08-16 12:12:30 +010061#if defined(__GNUC__) || defined(__arm__)
62#define MBEDTLS_ALWAYS_INLINE __attribute__((always_inline))
Hanno Becker2793f742019-08-16 14:28:43 +010063#define MBEDTLS_NO_INLINE __attribute__((noinline))
Hanno Becker8e7f23a2019-08-16 12:12:30 +010064#else
65#define MBEDTLS_ALWAYS_INLINE
Hanno Becker2793f742019-08-16 14:28:43 +010066#define MBEDTLS_NO_INLINE
Hanno Becker8e7f23a2019-08-16 12:12:30 +010067#endif
68
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010069#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
70 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020071#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020072#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020073
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +020074/* The public option is negative for backwards compatibility,
75 * but internally a poisitive option is more convenient. */
76#if !defined(MBEDTLS_SSL_PROTO_NO_TLS)
77#define MBEDTLS_SSL_PROTO_TLS
78#endif
79
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020080/* Determine minimum supported version */
81#define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
82
83#if defined(MBEDTLS_SSL_PROTO_SSL3)
84#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
85#else
86#if defined(MBEDTLS_SSL_PROTO_TLS1)
87#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
88#else
89#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
90#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
91#else
92#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
93#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
94#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
95#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
96#endif /* MBEDTLS_SSL_PROTO_TLS1 */
97#endif /* MBEDTLS_SSL_PROTO_SSL3 */
98
Ron Eldor5e9f14d2017-05-28 10:46:38 +030099#define MBEDTLS_SSL_MIN_VALID_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
100#define MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
101
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200102/* Determine maximum supported version */
103#define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
104
105#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
106#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
107#else
108#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
109#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
110#else
111#if defined(MBEDTLS_SSL_PROTO_TLS1)
112#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
113#else
114#if defined(MBEDTLS_SSL_PROTO_SSL3)
115#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
116#endif /* MBEDTLS_SSL_PROTO_SSL3 */
117#endif /* MBEDTLS_SSL_PROTO_TLS1 */
118#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
119#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
120
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200121/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200122#if defined(MBEDTLS_ECP_RESTARTABLE) && \
123 defined(MBEDTLS_SSL_CLI_C) && \
124 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
125 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
126#define MBEDTLS_SSL__ECP_RESTARTABLE
127#endif
128
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200129#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
130#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
131#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
132#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
133
134/*
135 * DTLS retransmission states, see RFC 6347 4.2.4
136 *
137 * The SENDING state is merged in PREPARING for initial sends,
138 * but is distinct for resends.
139 *
140 * Note: initial state is wrong for server, but is not used anyway.
141 */
142#define MBEDTLS_SSL_RETRANS_PREPARING 0
143#define MBEDTLS_SSL_RETRANS_SENDING 1
144#define MBEDTLS_SSL_RETRANS_WAITING 2
145#define MBEDTLS_SSL_RETRANS_FINISHED 3
146
147/*
148 * Allow extra bytes for record, authentication and encryption overhead:
149 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256)
150 * and allow for a maximum of 1024 of compression expansion if
151 * enabled.
152 */
153#if defined(MBEDTLS_ZLIB_SUPPORT)
154#define MBEDTLS_SSL_COMPRESSION_ADD 1024
155#else
156#define MBEDTLS_SSL_COMPRESSION_ADD 0
157#endif
158
Hanno Becker5cc04d52018-01-03 15:24:20 +0000159#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
160 ( defined(MBEDTLS_CIPHER_MODE_CBC) && \
161 ( defined(MBEDTLS_AES_C) || \
162 defined(MBEDTLS_CAMELLIA_C) || \
Hanno Beckerb628a802018-07-17 10:19:47 +0100163 defined(MBEDTLS_ARIA_C) || \
164 defined(MBEDTLS_DES_C) ) )
Hanno Becker5cc04d52018-01-03 15:24:20 +0000165#define MBEDTLS_SSL_SOME_MODES_USE_MAC
166#endif
167
168#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200169/* Ciphersuites using HMAC */
170#if defined(MBEDTLS_SHA512_C)
171#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
172#elif defined(MBEDTLS_SHA256_C)
173#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
174#else
175#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
176#endif
Hanno Becker5cc04d52018-01-03 15:24:20 +0000177#else /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200178/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
179#define MBEDTLS_SSL_MAC_ADD 16
180#endif
181
182#if defined(MBEDTLS_CIPHER_MODE_CBC)
183#define MBEDTLS_SSL_PADDING_ADD 256
184#else
185#define MBEDTLS_SSL_PADDING_ADD 0
186#endif
187
Hanno Beckera5a2b082019-05-15 14:03:01 +0100188#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker550e1662019-05-08 17:37:58 +0100189#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_PADDING_GRANULARITY
Hanno Beckeradd01902019-05-08 15:40:11 +0100190#else
191#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
192#endif
193
Angus Grattond8213d02016-05-25 20:56:48 +1000194#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_SSL_COMPRESSION_ADD + \
195 MBEDTLS_MAX_IV_LENGTH + \
196 MBEDTLS_SSL_MAC_ADD + \
Hanno Beckeradd01902019-05-08 15:40:11 +0100197 MBEDTLS_SSL_PADDING_ADD + \
198 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000199 )
200
201#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
202 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
203
204#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
205 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
206
Hanno Becker0271f962018-08-16 13:23:47 +0100207/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100208#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100209
Angus Grattond8213d02016-05-25 20:56:48 +1000210/* Maximum length we can advertise as our max content length for
211 RFC 6066 max_fragment_length extension negotiation purposes
212 (the lesser of both sizes, if they are unequal.)
213 */
214#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
215 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
216 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
217 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
218 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200219
220/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100221 * Check that we obey the standard's message size bounds
222 */
223
224#if MBEDTLS_SSL_MAX_CONTENT_LEN > 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000225#error "Bad configuration - record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100226#endif
227
Angus Grattond8213d02016-05-25 20:56:48 +1000228#if MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
229#error "Bad configuration - incoming record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
Hanno Beckera8434e82017-09-18 10:54:39 +0100230#endif
231
Angus Grattond8213d02016-05-25 20:56:48 +1000232#if MBEDTLS_SSL_OUT_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
233#error "Bad configuration - outgoing record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
234#endif
235
236#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
237#error "Bad configuration - incoming protected record payload too large."
238#endif
239
240#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
241#error "Bad configuration - outgoing protected record payload too large."
242#endif
243
244/* Calculate buffer sizes */
245
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000246/* Note: Even though the TLS record header is only 5 bytes
247 long, we're internally using 8 bytes to store the
248 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100249#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100250
Hanno Beckera5a2b082019-05-15 14:03:01 +0100251#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000252#define MBEDTLS_SSL_IN_BUFFER_LEN \
253 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100254#else
255#define MBEDTLS_SSL_IN_BUFFER_LEN \
256 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
257 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
258#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000259
Hanno Beckera5a2b082019-05-15 14:03:01 +0100260#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000261#define MBEDTLS_SSL_OUT_BUFFER_LEN \
262 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100263#else
264#define MBEDTLS_SSL_OUT_BUFFER_LEN \
265 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
266 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
267#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000268
269#ifdef MBEDTLS_ZLIB_SUPPORT
270/* Compression buffer holds both IN and OUT buffers, so should be size of the larger */
271#define MBEDTLS_SSL_COMPRESS_BUFFER_LEN ( \
272 ( MBEDTLS_SSL_IN_BUFFER_LEN > MBEDTLS_SSL_OUT_BUFFER_LEN ) \
273 ? MBEDTLS_SSL_IN_BUFFER_LEN \
274 : MBEDTLS_SSL_OUT_BUFFER_LEN \
275 )
276#endif
Hanno Beckera8434e82017-09-18 10:54:39 +0100277
278/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200279 * TLS extension flags (for extensions with outgoing ServerHello content
280 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
281 * of state of the renegotiation flag, so no indicator is required)
282 */
283#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200284#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200285
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100286/*
287 * Helpers for code specific to TLS or DTLS.
288 *
289 * Goals for these helpers:
290 * - generate minimal code, eg don't test if mode is DTLS in a DTLS-only build
Manuel Pégourié-Gonnard8794a422019-06-11 10:04:57 +0200291 * - make the flow clear to the compiler, so that in TLS and DTLS combined
Manuel Pégourié-Gonnardec1c2222019-06-12 10:18:26 +0200292 * builds, when there are two branches, it knows exactly one of them is taken
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100293 * - preserve readability
294 *
295 * There are three macros:
296 * - MBEDTLS_SSL_TRANSPORT_IS_TLS( transport )
297 * - MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport )
298 * - MBEDTLS_SSL_TRANSPORT_ELSE
299 *
300 * The first two are macros rather than static inline functions because some
301 * compilers (eg arm-none-eabi-gcc 5.4.1 20160919) don't propagate constants
302 * well enough for us with static inline functions.
303 *
304 * Usage 1 (can replace DTLS with TLS):
305 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
306 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
307 * // DTLS-specific code
308 * #endif
309 *
310 * Usage 2 (can swap DTLS and TLS);
311 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
312 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
313 * // DTLS-specific code
314 * MBEDTLS_SSL_TRANSPORT_ELSE
315 * #endif
316 * #if defined(MBEDTLS_SSL_PROTO_TLS)
317 * // TLS-specific code
318 * #endif
319 */
320#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_PROTO_TLS) /* both */
Manuel Pégourié-Gonnard8794a422019-06-11 10:04:57 +0200321#define MBEDTLS_SSL_TRANSPORT__BOTH /* shortcut for future tests */
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100322#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) \
323 ( (transport) == MBEDTLS_SSL_TRANSPORT_STREAM )
324#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) \
325 ( (transport) == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
326#define MBEDTLS_SSL_TRANSPORT_ELSE else
327#elif defined(MBEDTLS_SSL_PROTO_DTLS) /* DTLS only */
328#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 0
329#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 1
330#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
331#else /* TLS only */
332#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 1
333#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 0
334#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
335#endif /* TLS and/or DTLS */
336
Hanno Becker3010d552019-06-11 14:46:16 +0100337/* Check if the use of the ExtendedMasterSecret extension
338 * is enforced at compile-time. If so, we don't need to
339 * track its status in the handshake parameters. */
340#if defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET) && \
341 defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET) && \
342 MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET == \
343 MBEDTLS_SSL_EXTENDED_MS_ENABLED && \
344 MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET == \
345 MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED
346#define MBEDTLS_SSL_EXTENDED_MS_ENFORCED
347#endif
348
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200349#ifdef __cplusplus
350extern "C" {
351#endif
352
Hanno Becker7e5437a2017-04-28 17:15:26 +0100353#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
354 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
355/*
356 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
357 */
358struct mbedtls_ssl_sig_hash_set_t
359{
360 /* At the moment, we only need to remember a single suitable
361 * hash algorithm per signature algorithm. As long as that's
362 * the case - and we don't need a general lookup function -
363 * we can implement the sig-hash-set as a map from signatures
364 * to hash algorithms. */
365 mbedtls_md_type_t rsa;
366 mbedtls_md_type_t ecdsa;
367};
368#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
369 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
370
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200371/*
372 * This structure contains the parameters only needed during handshake.
373 */
374struct mbedtls_ssl_handshake_params
375{
376 /*
377 * Handshake specific crypto variables
378 */
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300379#if defined(MBEDTLS_SSL_PROTO_DTLS)
380 unsigned char verify_cookie_len; /*!< Cli: cookie length
381 Srv: flag for sending a cookie */
382 unsigned char retransmit_state; /*!< Retransmission state */
383#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
384 /* The state of CID configuration in this handshake. */
385
386 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
387 * has been negotiated. Possible values are
388 * #MBEDTLS_SSL_CID_ENABLED and
389 * #MBEDTLS_SSL_CID_DISABLED. */
390 uint8_t peer_cid_len; /*!< The length of
391 * \c peer_cid. */
392#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
393 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
394
395#endif /* MBEDTLS_SSL_PROTO_DTLS */
396
397
398
399
400
Hanno Becker7e5437a2017-04-28 17:15:26 +0100401
402#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
403 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
404 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
405#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200406#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200407 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200408#if defined(MBEDTLS_SSL_CLI_C)
409 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
410 size_t ecjpake_cache_len; /*!< Length of cached data */
411#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100412#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jarno Lamsae12aafb2019-04-04 18:32:56 +0300413#if defined(MBEDTLS_ECDH_C) || \
414 defined(MBEDTLS_ECDSA_C) || \
Hanno Becker3a336792019-08-12 15:25:14 +0100415 defined(MBEDTLS_USE_TINYCRYPT) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200416 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Hanno Becker004619f2019-06-18 16:07:32 +0100417 uint16_t curve_tls_id; /*!< TLS ID of EC for ECDHE. */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200418#endif
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300419
420 size_t pmslen; /*!< premaster length */
421
422 int cli_exts; /*!< client extension presence*/
423
424
425
426
427
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200428#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
429 unsigned char *psk; /*!< PSK from the callback */
430 size_t psk_len; /*!< Length of PSK from callback */
431#endif
432#if defined(MBEDTLS_X509_CRT_PARSE_C)
433 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300434#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
435 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
436#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
437
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200438#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200439 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200440 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
441 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
442 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100443#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200444#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200445#if defined(MBEDTLS_SSL__ECP_RESTARTABLE)
Manuel Pégourié-Gonnardd27d1a52017-08-15 11:49:08 +0200446 int ecrs_enabled; /*!< Handshake supports EC restart? */
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200447 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200448 enum { /* this complements ssl->state with info on intra-state operations */
449 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
450 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
Manuel Pégourié-Gonnardc37423f2018-10-16 10:28:17 +0200451 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200452 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
453 } ecrs_state; /*!< current (or last) operation */
Hanno Beckerdd689312019-02-25 10:08:06 +0000454 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200455#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200456#if defined(MBEDTLS_SSL_PROTO_DTLS)
457 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
458 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
459
460 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
461 Srv: unused */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200462 uint32_t retransmit_timeout; /*!< Current value of timeout */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200463 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
464 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
465 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200466 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
467 flight being received */
468 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
469 resending messages */
470 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
471 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100472
Hanno Beckera5a2b082019-05-15 14:03:01 +0100473#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +0100474 /* The state of CID configuration in this handshake. */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100475 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100476#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100477
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300478 unsigned char randbytes[64]; /*!< random bytes */
479 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
480 /*!< premaster secret */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100481 struct
482 {
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300483 uint8_t seen_ccs; /*!< Indicates if a CCS message has
484 * been seen in the current flight. */
485
Hanno Beckere0b150f2018-08-21 15:51:03 +0100486 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
487 * buffers used for message buffering. */
488
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300489 struct
490 {
491 unsigned char *data;
492 size_t len;
493 unsigned epoch;
494 } future_record;
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100495
Hanno Becker0271f962018-08-16 13:23:47 +0100496 struct mbedtls_ssl_hs_buffer
497 {
Hanno Becker98081a02018-08-22 13:32:50 +0100498 unsigned is_valid : 1;
499 unsigned is_fragmented : 1;
500 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100501 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100502 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100503 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100504 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100505
Hanno Becker1aa267c2017-04-28 17:08:27 +0100506#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200507
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200508
Hanno Becker73f4cb12019-06-27 13:51:07 +0100509#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker473f98f2019-06-26 10:27:32 +0100510 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info;
Hanno Becker73f4cb12019-06-27 13:51:07 +0100511#endif /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker8759e162017-12-27 21:34:08 +0000512
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300513#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200514 int resume; /*!< session resume indicator*/
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300515#endif /* !MBEDTLS_SSL_NO_SESSION_RESUMPTION */
Hanno Becker18729ae2019-06-12 14:47:21 +0100516
517#if defined(MBEDTLS_SSL_SRV_C) && \
518 ( defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
519 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) )
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200520 int max_major_ver; /*!< max. major version client*/
521 int max_minor_ver; /*!< max. minor version client*/
Hanno Becker18729ae2019-06-12 14:47:21 +0100522#endif /* MBEDTLS_SSL_SRV_C && ( MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ||
523 MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200524
525#if defined(MBEDTLS_SSL_SESSION_TICKETS)
526 int new_session_ticket; /*!< use NewSessionTicket? */
527#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Hanno Becker1ab322b2019-06-11 14:50:54 +0100528#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
529 !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200530 int extended_ms; /*!< use Extended Master Secret? */
531#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200532
533#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200534 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200535#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
536
537#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
538 /** Asynchronous operation context. This field is meant for use by the
539 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
540 * mbedtls_ssl_config::f_async_decrypt_start,
541 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
542 * The library does not use it internally. */
543 void *user_async_ctx;
544#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Hanno Becker9175c212019-07-24 11:47:22 +0100545
546#if defined(MBEDTLS_USE_TINYCRYPT)
547 uint8_t ecdh_privkey[NUM_ECC_BYTES];
Hanno Becker9175c212019-07-24 11:47:22 +0100548 uint8_t ecdh_peerkey[2*NUM_ECC_BYTES];
549#endif /* MBEDTLS_USE_TINYCRYPT */
Teppo Järvelin1cd48142019-08-29 08:51:25 +0300550
551/*
552 * Checksum contexts
553 */
554#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
555 defined(MBEDTLS_SSL_PROTO_TLS1_1)
556 mbedtls_md5_context fin_md5;
557 mbedtls_sha1_context fin_sha1;
558#endif
559#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
560#if defined(MBEDTLS_SHA256_C)
561 mbedtls_sha256_context fin_sha256;
562#endif
563#if defined(MBEDTLS_SHA512_C)
564 mbedtls_sha512_context fin_sha512;
565#endif
566#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
567
568#if defined(MBEDTLS_DHM_C)
569 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
570#endif
571#if defined(MBEDTLS_ECDH_C)
572 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
573#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200574};
575
Hanno Beckera49ec562019-06-11 14:47:55 +0100576/*
577 * Getter functions for fields in mbedtls_ssl_handshake_params which
578 * may be statically implied by the configuration and hence be omitted
579 * from the structure.
580 */
581#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
582static inline int mbedtls_ssl_hs_get_extended_ms(
583 mbedtls_ssl_handshake_params const *params )
584{
585#if !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
586 return( params->extended_ms );
587#else
588 ((void) params);
589 return( MBEDTLS_SSL_EXTENDED_MS_ENABLED );
590#endif /* MBEDTLS_SSL_EXTENDED_MS_ENFORCED */
591}
592#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
593
Hanno Becker73f4cb12019-06-27 13:51:07 +0100594#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Beckerdf645962019-06-26 13:02:22 +0100595static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
596 mbedtls_ssl_handshake_params const *handshake )
597{
598 return( handshake->ciphersuite_info );
599}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100600#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100601static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
602 mbedtls_ssl_handshake_params const *handshake )
603{
604 ((void) handshake);
605 return( MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE );
606}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100607#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100608
Hanno Becker0271f962018-08-16 13:23:47 +0100609typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
610
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200611/*
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000612 * Representation of decryption/encryption transformations on records
613 *
614 * There are the following general types of record transformations:
615 * - Stream transformations (TLS versions <= 1.2 only)
616 * Transformation adding a MAC and applying a stream-cipher
617 * to the authenticated message.
618 * - CBC block cipher transformations ([D]TLS versions <= 1.2 only)
619 * In addition to the distinction of the order of encryption and
620 * authentication, there's a fundamental difference between the
621 * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3
622 * and TLS 1.0, the final IV after processing a record is used
623 * as the IV for the next record. No explicit IV is contained
624 * in an encrypted record. The IV for the first record is extracted
625 * at key extraction time. In contrast, for TLS 1.1 and 1.2, no
626 * IV is generated at key extraction time, but every encrypted
627 * record is explicitly prefixed by the IV with which it was encrypted.
628 * - AEAD transformations ([D]TLS versions >= 1.2 only)
629 * These come in two fundamentally different versions, the first one
630 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
631 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
632 * In the first transformation, the IV to be used for a record is obtained
633 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
634 * record sequence number, and explicitly prepending this sequence number
635 * to the encrypted record. In contrast, in the second transformation
636 * the IV is obtained by XOR'ing a static IV obtained at key extraction
637 * time with the 8-byte record sequence number, without prepending the
638 * latter to the encrypted record.
639 *
640 * In addition to type and version, the following parameters are relevant:
641 * - The symmetric cipher algorithm to be used.
642 * - The (static) encryption/decryption keys for the cipher.
643 * - For stream/CBC, the type of message digest to be used.
644 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Beckera198bb72018-10-18 15:39:53 +0100645 * - For AEAD transformations, the size (potentially 0) of an explicit,
646 * random initialization vector placed in encrypted records.
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000647 * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0)
648 * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC)
649 * and (if present) is combined with the explicit IV in a transformation-
650 * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
651 * - For stream/CBC, a flag determining the order of encryption and MAC.
652 * - The details of the transformation depend on the SSL/TLS version.
653 * - The length of the authentication tag.
654 *
Hanno Beckera198bb72018-10-18 15:39:53 +0100655 * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are
656 * constant across multiple encryption/decryption operations.
657 * For CBC, the implicit IV needs to be updated after each
658 * operation.
659 *
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000660 * The struct below refines this abstract view as follows:
661 * - The cipher underlying the transformation is managed in
662 * cipher contexts cipher_ctx_{enc/dec}, which must have the
663 * same cipher type. The mode of these cipher contexts determines
664 * the type of the transformation in the sense above: e.g., if
665 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
666 * then the transformation has type CBC resp. AEAD.
667 * - The cipher keys are never stored explicitly but
668 * are maintained within cipher_ctx_{enc/dec}.
669 * - For stream/CBC transformations, the message digest contexts
670 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
671 * are unused for AEAD transformations.
672 * - For stream/CBC transformations and versions > SSL3, the
673 * MAC keys are not stored explicitly but maintained within
674 * md_ctx_{enc/dec}.
675 * - For stream/CBC transformations and version SSL3, the MAC
676 * keys are stored explicitly in mac_enc, mac_dec and have
677 * a fixed size of 20 bytes. These fields are unused for
678 * AEAD transformations or transformations >= TLS 1.0.
679 * - For transformations using an implicit IV maintained within
680 * the transformation context, its contents are stored within
681 * iv_{enc/dec}.
682 * - The value of ivlen indicates the length of the IV.
683 * This is redundant in case of stream/CBC transformations
684 * which always use 0 resp. the cipher's block length as the
685 * IV length, but is needed for AEAD ciphers and may be
686 * different from the underlying cipher's block length
687 * in this case.
688 * - The field fixed_ivlen is nonzero for AEAD transformations only
689 * and indicates the length of the static part of the IV which is
690 * constant throughout the communication, and which is stored in
691 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
692 * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec}
693 * still store IV's for continued use across multiple transformations,
694 * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are
695 * not being used!
696 * - minor_ver denotes the SSL/TLS version
697 * - For stream/CBC transformations, maclen denotes the length of the
698 * authentication tag, while taglen is unused and 0.
699 * - For AEAD transformations, taglen denotes the length of the
700 * authentication tag, while maclen is unused and 0.
701 * - For CBC transformations, encrypt_then_mac determines the
702 * order of encryption and authentication. This field is unused
703 * in other transformations.
704 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200705 */
706struct mbedtls_ssl_transform
707{
Teppo Järvelin22854512019-08-30 08:45:37 +0300708#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
709 uint8_t in_cid_len;
710 uint8_t out_cid_len;
711#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200712 /*
713 * Session specific crypto layer
714 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200715 size_t ivlen; /*!< IV length */
716 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Becker8759e162017-12-27 21:34:08 +0000717 size_t maclen; /*!< MAC(CBC) len */
718 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200719
720 unsigned char iv_enc[16]; /*!< IV (encryption) */
721 unsigned char iv_dec[16]; /*!< IV (decryption) */
722
Hanno Becker92231322018-01-03 15:32:51 +0000723#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
724
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200725#if defined(MBEDTLS_SSL_PROTO_SSL3)
726 /* Needed only for SSL v3.0 secret */
727 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
728 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
729#endif /* MBEDTLS_SSL_PROTO_SSL3 */
730
731 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
732 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
733
Hanno Becker3307b532017-12-27 21:37:21 +0000734#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
735 int encrypt_then_mac; /*!< flag for EtM activation */
736#endif
737
Hanno Becker92231322018-01-03 15:32:51 +0000738#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
739
Hanno Becker0a92b812019-06-24 15:46:40 +0100740#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker3307b532017-12-27 21:37:21 +0000741 int minor_ver;
Hanno Becker0a92b812019-06-24 15:46:40 +0100742#endif
Hanno Becker3307b532017-12-27 21:37:21 +0000743
Hanno Beckera5a2b082019-05-15 14:03:01 +0100744#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100745 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
746 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera5a2b082019-05-15 14:03:01 +0100747#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100748
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200749 /*
750 * Session specific compression layer
751 */
752#if defined(MBEDTLS_ZLIB_SUPPORT)
753 z_stream ctx_deflate; /*!< compression context */
754 z_stream ctx_inflate; /*!< decompression context */
755#endif
Manuel Pégourié-Gonnarda3024ee2019-07-09 12:54:17 +0200756
Teppo Järvelin22854512019-08-30 08:45:37 +0300757 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
758 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
759
Manuel Pégourié-Gonnarda3024ee2019-07-09 12:54:17 +0200760#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
761 /* We need the Hello random bytes in order to re-derive keys from the
762 * Master Secret and other session info, see ssl_populate_transform() */
763 unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */
764#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200765};
766
Hanno Becker0a92b812019-06-24 15:46:40 +0100767static inline int mbedtls_ssl_transform_get_minor_ver( mbedtls_ssl_transform const *transform )
768{
769#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
770 return( transform->minor_ver );
771#else
772 ((void) transform);
773 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
774#endif
775}
776
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000777/*
Manuel Pégourié-Gonnard569ed6b2019-07-10 14:14:05 +0200778 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
779 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
780 */
781static inline int mbedtls_ssl_transform_uses_aead(
782 const mbedtls_ssl_transform *transform )
783{
784#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
785 return( transform->maclen == 0 && transform->taglen != 0 );
786#else
787 (void) transform;
788 return( 1 );
789#endif
790}
791
792/*
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000793 * Internal representation of record frames
794 *
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000795 * Instances come in two flavors:
796 * (1) Encrypted
797 * These always have data_offset = 0
798 * (2) Unencrypted
Hanno Beckerf8323432019-04-04 16:29:48 +0100799 * These have data_offset set to the amount of
800 * pre-expansion during record protection. Concretely,
801 * this is the length of the fixed part of the explicit IV
802 * used for encryption, or 0 if no explicit IV is used
803 * (e.g. for CBC in TLS 1.0, or stream ciphers).
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000804 *
805 * The reason for the data_offset in the unencrypted case
806 * is to allow for in-place conversion of an unencrypted to
807 * an encrypted record. If the offset wasn't included, the
808 * encrypted content would need to be shifted afterwards to
809 * make space for the fixed IV.
810 *
811 */
Hanno Becker80fe63e2019-04-29 13:45:54 +0100812#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100813#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100814#else
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100815#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100816#endif
817
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000818typedef struct
819{
Hanno Beckere84b28c2019-07-11 09:24:36 +0100820 uint8_t ctr[8]; /* In TLS: The implicit record sequence number.
821 * In DTLS: The 2-byte epoch followed by
822 * the 6-byte sequence number.
823 * This is stored as a raw big endian byte array
824 * as opposed to a uint64_t because we rarely
825 * need to perform arithmetic on this, but do
826 * need it as a Byte array for the purpose of
827 * MAC computations. */
828 uint8_t type; /* The record content type. */
829 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
830 * Convert to internal presentation of versions
831 * using mbedtls_ssl_read_version() and
832 * mbedtls_ssl_write_version().
833 * Keep wire-format for MAC computations. */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000834
Hanno Beckere84b28c2019-07-11 09:24:36 +0100835 unsigned char *buf; /* Memory buffer enclosing the record content */
836 size_t buf_len; /* Buffer length */
837 size_t data_offset; /* Offset of record content */
838 size_t data_len; /* Length of record content */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000839
Hanno Beckera5a2b082019-05-15 14:03:01 +0100840#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere84b28c2019-07-11 09:24:36 +0100841 uint8_t cid_len; /* Length of the CID (0 if not present) */
842 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100843#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000844} mbedtls_record;
845
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200846#if defined(MBEDTLS_X509_CRT_PARSE_C)
847/*
848 * List of certificate + private key pairs
849 */
850struct mbedtls_ssl_key_cert
851{
852 mbedtls_x509_crt *cert; /*!< cert */
853 mbedtls_pk_context *key; /*!< private key */
854 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
855};
856#endif /* MBEDTLS_X509_CRT_PARSE_C */
857
858#if defined(MBEDTLS_SSL_PROTO_DTLS)
859/*
860 * List of handshake messages kept around for resending
861 */
862struct mbedtls_ssl_flight_item
863{
864 unsigned char *p; /*!< message, including handshake headers */
865 size_t len; /*!< length of p */
866 unsigned char type; /*!< type of the message: handshake or CCS */
867 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
868};
869#endif /* MBEDTLS_SSL_PROTO_DTLS */
870
Hanno Becker7e5437a2017-04-28 17:15:26 +0100871#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
872 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
873
874/* Find an entry in a signature-hash set matching a given hash algorithm. */
875mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
876 mbedtls_pk_type_t sig_alg );
877/* Add a signature-hash-pair to a signature-hash set */
878void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
879 mbedtls_pk_type_t sig_alg,
880 mbedtls_md_type_t md_alg );
881/* Allow exactly one hash algorithm for each signature. */
882void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
883 mbedtls_md_type_t md_alg );
884
885/* Setup an empty signature-hash set */
886static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
887{
888 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
889}
890
891#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
892 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200893
894/**
895 * \brief Free referenced items in an SSL transform context and clear
896 * memory
897 *
898 * \param transform SSL transform context
899 */
900void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
901
902/**
903 * \brief Free referenced items in an SSL handshake context and clear
904 * memory
905 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200906 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200907 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200908void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200909
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200910int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
911int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
912void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
913
914int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
915
916void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
917int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
918
Simon Butcher99000142016-10-13 17:21:01 +0100919int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
920int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
921void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
922
Hanno Becker4a810fb2017-05-24 16:27:30 +0100923/**
924 * \brief Update record layer
925 *
926 * This function roughly separates the implementation
927 * of the logic of (D)TLS from the implementation
928 * of the secure transport.
929 *
Hanno Becker3a0aad12018-08-20 09:44:02 +0100930 * \param ssl The SSL context to use.
931 * \param update_hs_digest This indicates if the handshake digest
932 * should be automatically updated in case
933 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +0100934 *
935 * \return 0 or non-zero error code.
936 *
937 * \note A clarification on what is called 'record layer' here
938 * is in order, as many sensible definitions are possible:
939 *
940 * The record layer takes as input an untrusted underlying
941 * transport (stream or datagram) and transforms it into
942 * a serially multiplexed, secure transport, which
943 * conceptually provides the following:
944 *
945 * (1) Three datagram based, content-agnostic transports
946 * for handshake, alert and CCS messages.
947 * (2) One stream- or datagram-based transport
948 * for application data.
949 * (3) Functionality for changing the underlying transform
950 * securing the contents.
951 *
952 * The interface to this functionality is given as follows:
953 *
954 * a Updating
955 * [Currently implemented by mbedtls_ssl_read_record]
956 *
957 * Check if and on which of the four 'ports' data is pending:
958 * Nothing, a controlling datagram of type (1), or application
959 * data (2). In any case data is present, internal buffers
960 * provide access to the data for the user to process it.
961 * Consumption of type (1) datagrams is done automatically
962 * on the next update, invalidating that the internal buffers
963 * for previous datagrams, while consumption of application
964 * data (2) is user-controlled.
965 *
966 * b Reading of application data
967 * [Currently manual adaption of ssl->in_offt pointer]
968 *
969 * As mentioned in the last paragraph, consumption of data
970 * is different from the automatic consumption of control
971 * datagrams (1) because application data is treated as a stream.
972 *
973 * c Tracking availability of application data
974 * [Currently manually through decreasing ssl->in_msglen]
975 *
976 * For efficiency and to retain datagram semantics for
977 * application data in case of DTLS, the record layer
978 * provides functionality for checking how much application
979 * data is still available in the internal buffer.
980 *
981 * d Changing the transformation securing the communication.
982 *
983 * Given an opaque implementation of the record layer in the
984 * above sense, it should be possible to implement the logic
985 * of (D)TLS on top of it without the need to know anything
986 * about the record layer's internals. This is done e.g.
987 * in all the handshake handling functions, and in the
988 * application data reading function mbedtls_ssl_read.
989 *
990 * \note The above tries to give a conceptual picture of the
991 * record layer, but the current implementation deviates
992 * from it in some places. For example, our implementation of
993 * the update functionality through mbedtls_ssl_read_record
994 * discards datagrams depending on the current state, which
995 * wouldn't fall under the record layer's responsibility
996 * following the above definition.
997 *
998 */
Hanno Becker3a0aad12018-08-20 09:44:02 +0100999int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
1000 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001001int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
1002
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +02001003int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +01001004int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001005int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
1006
1007int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
1008int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
1009
1010int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
1011int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
1012
1013int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
1014int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1015
1016void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
Hanno Becker473f98f2019-06-26 10:27:32 +01001017 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001018
Hanno Becker09d23642019-07-22 17:18:18 +01001019int mbedtls_ssl_build_pms( mbedtls_ssl_context *ssl );
1020
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001021#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1022int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
1023#endif
1024
1025#if defined(MBEDTLS_PK_C)
1026unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001027unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001028mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1029#endif
1030
1031mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001032unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001033
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001034#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001035int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001036#endif
1037
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001038#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001039int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
1040 mbedtls_md_type_t md );
1041#endif
1042
Hanno Becker2881d802019-05-22 14:44:53 +01001043static inline int mbedtls_ssl_get_minor_ver( mbedtls_ssl_context const *ssl )
1044{
Hanno Becker381eaa52019-06-12 14:43:01 +01001045#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001046 return( ssl->minor_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001047#else /* !MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
1048 ((void) ssl);
1049 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
1050#endif /* MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001051}
1052
1053static inline int mbedtls_ssl_get_major_ver( mbedtls_ssl_context const *ssl )
1054{
Hanno Becker381eaa52019-06-12 14:43:01 +01001055#if !defined(MBEDTLS_SSL_CONF_FIXED_MAJOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001056 return( ssl->major_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001057#else /* !MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
1058 ((void) ssl);
1059 return( MBEDTLS_SSL_CONF_FIXED_MAJOR_VER );
1060#endif /* MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001061}
1062
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001063#if defined(MBEDTLS_X509_CRT_PARSE_C)
1064static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1065{
1066 mbedtls_ssl_key_cert *key_cert;
1067
1068 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1069 key_cert = ssl->handshake->key_cert;
1070 else
1071 key_cert = ssl->conf->key_cert;
1072
1073 return( key_cert == NULL ? NULL : key_cert->key );
1074}
1075
1076static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1077{
1078 mbedtls_ssl_key_cert *key_cert;
1079
1080 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1081 key_cert = ssl->handshake->key_cert;
1082 else
1083 key_cert = ssl->conf->key_cert;
1084
1085 return( key_cert == NULL ? NULL : key_cert->cert );
1086}
1087
1088/*
1089 * Check usage of a certificate wrt extensions:
1090 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1091 *
1092 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1093 * check a cert we received from them)!
1094 *
1095 * Return 0 if everything is OK, -1 if not.
1096 */
1097int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
Hanno Becker473f98f2019-06-26 10:27:32 +01001098 mbedtls_ssl_ciphersuite_handle_t ciphersuite,
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001099 int cert_endpoint,
1100 uint32_t *flags );
1101#endif /* MBEDTLS_X509_CRT_PARSE_C */
1102
Hanno Becker43395762019-05-03 14:46:38 +01001103static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001104{
Hanno Beckerf903dc82019-07-12 09:55:46 +01001105#if !defined(MBEDTLS_SSL_PROTO__BOTH)
1106 ((void) ssl);
1107#endif
1108
1109#if defined(MBEDTLS_SSL_PROTO_DTLS)
1110 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1111 {
1112 return( 13 );
1113 }
1114 MBEDTLS_SSL_TRANSPORT_ELSE
1115#endif /* MBEDTLS_SSL_PROTO_DTLS */
1116#if defined(MBEDTLS_SSL_PROTO_TLS)
1117 {
1118 return( 5 );
1119 }
1120#endif /* MBEDTLS_SSL_PROTO_TLS */
Hanno Becker43395762019-05-03 14:46:38 +01001121}
1122
1123static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1124{
Hanno Beckerccc24562019-05-03 15:05:27 +01001125 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001126}
1127
1128static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1129{
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001130#if !defined(MBEDTLS_SSL_PROTO__BOTH)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001131 ((void) ssl);
1132#endif
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001133
1134#if defined(MBEDTLS_SSL_PROTO_DTLS)
1135 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1136 return( 12 );
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001137 MBEDTLS_SSL_TRANSPORT_ELSE
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001138#endif
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001139#if defined(MBEDTLS_SSL_PROTO_TLS)
1140 return( 4 );
1141#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001142}
1143
1144#if defined(MBEDTLS_SSL_PROTO_DTLS)
1145void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1146void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1147int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001148int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001149#endif
1150
1151/* Visible for testing purposes only */
1152#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Beckerfc551722019-07-12 08:50:37 +01001153int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001154void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1155#endif
1156
Hanno Becker58fccf22019-02-06 14:30:46 +00001157int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1158 const mbedtls_ssl_session *src );
1159
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001160/* constant-time buffer comparison */
1161static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
1162{
1163 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +01001164 volatile const unsigned char *A = (volatile const unsigned char *) a;
1165 volatile const unsigned char *B = (volatile const unsigned char *) b;
1166 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001167
1168 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001169 {
1170 /* Read volatile data in order before computing diff.
1171 * This avoids IAR compiler warning:
1172 * 'the order of volatile accesses is undefined ..' */
1173 unsigned char x = A[i], y = B[i];
1174 diff |= x ^ y;
1175 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001176
1177 return( diff );
1178}
1179
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001180#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1181 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1182int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl,
1183 unsigned char *output,
1184 unsigned char *data, size_t data_len );
1185#endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \
1186 MBEDTLS_SSL_PROTO_TLS1_1 */
1187
1188#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1189 defined(MBEDTLS_SSL_PROTO_TLS1_2)
1190int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001191 unsigned char *hash, size_t *hashlen,
1192 unsigned char *data, size_t data_len,
1193 mbedtls_md_type_t md_alg );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001194#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1195 MBEDTLS_SSL_PROTO_TLS1_2 */
1196
Hanno Becker7b628e52019-06-12 14:45:11 +01001197/*
1198 * Convert version numbers to/from wire format
1199 * and, for DTLS, to/from TLS equivalent.
1200 *
1201 * For TLS this is the identity.
1202 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
1203 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
1204 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
1205 */
Hanno Becker8e7f23a2019-08-16 12:12:30 +01001206MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_write_version(
1207 int major, int minor, int transport, unsigned char ver[2] )
Hanno Becker7b628e52019-06-12 14:45:11 +01001208{
1209#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1210 ((void) transport);
1211#endif
1212
1213#if defined(MBEDTLS_SSL_PROTO_DTLS)
1214 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1215 {
1216 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
1217 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1218
1219 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
1220 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
1221 }
1222 MBEDTLS_SSL_TRANSPORT_ELSE
1223#endif
1224#if defined(MBEDTLS_SSL_PROTO_TLS)
1225 {
1226 ver[0] = (unsigned char) major;
1227 ver[1] = (unsigned char) minor;
1228 }
1229#endif
1230}
1231
Hanno Becker8e7f23a2019-08-16 12:12:30 +01001232MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_read_version(
1233 int *major, int *minor, int transport, const unsigned char ver[2] )
Hanno Becker7b628e52019-06-12 14:45:11 +01001234{
1235#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1236 ((void) transport);
1237#endif
1238
1239#if defined(MBEDTLS_SSL_PROTO_DTLS)
1240 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1241 {
1242 *major = 255 - ver[0] + 2;
1243 *minor = 255 - ver[1] + 1;
1244
1245 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
1246 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1247 }
1248 MBEDTLS_SSL_TRANSPORT_ELSE
1249#endif /* MBEDTLS_SSL_PROTO_DTLS */
1250#if defined(MBEDTLS_SSL_PROTO_TLS)
1251 {
1252 *major = ver[0];
1253 *minor = ver[1];
1254 }
1255#endif /* MBEDTLS_SSL_PROTO_TLS */
1256}
1257
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001258#ifdef __cplusplus
1259}
1260#endif
1261
Hanno Becker611a83b2018-01-03 14:27:32 +00001262void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1263int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1264 mbedtls_ssl_transform *transform,
1265 mbedtls_record *rec,
1266 int (*f_rng)(void *, unsigned char *, size_t),
1267 void *p_rng );
Hanno Becker40478be2019-07-12 08:23:59 +01001268int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Becker611a83b2018-01-03 14:27:32 +00001269 mbedtls_ssl_transform *transform,
1270 mbedtls_record *rec );
1271
Hanno Becker57e72c72019-06-12 12:46:31 +01001272
1273/*
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001274 * Accessor functions for optional fields of various structures
1275 */
1276
1277static inline int mbedtls_ssl_handshake_get_resume(
1278 const mbedtls_ssl_handshake_params *handshake )
1279{
1280#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
1281 return( handshake->resume );
1282#else
1283 (void) handshake;
1284 return( 0 );
1285#endif
1286}
1287
1288static inline int mbedtls_ssl_get_renego_status(
1289 const mbedtls_ssl_context *ssl )
1290{
1291#if defined(MBEDTLS_SSL_RENEGOTIATION)
1292 return( ssl->renego_status );
1293#else
1294 (void) ssl;
1295 return( MBEDTLS_SSL_INITIAL_HANDSHAKE );
1296#endif
1297}
1298
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001299static inline int mbedtls_ssl_conf_is_renegotiation_enabled(
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001300 const mbedtls_ssl_config *conf )
1301{
1302#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001303 return( conf->disable_renegotiation ==
1304 MBEDTLS_SSL_RENEGOTIATION_ENABLED );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001305#else
1306 (void) conf;
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001307 return( 0 );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001308#endif
1309}
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001310
1311/*
Hanno Becker57e72c72019-06-12 12:46:31 +01001312 * Getter functions for fields in mbedtls_ssl_config which may
1313 * be fixed at compile time via one of MBEDTLS_SSL_SSL_CONF_XXX.
1314 */
1315
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001316#if defined(MBEDTLS_SSL_SRV_C)
1317#if !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
1318static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1319 mbedtls_ssl_config const *conf )
1320{
1321 return( conf->cert_req_ca_list );
1322}
1323#else /* !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1324static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1325 mbedtls_ssl_config const *conf )
1326{
1327 ((void) conf);
1328 return( MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST );
1329}
1330#endif /* MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1331#endif /* MBEDTLS_SSL_SRV_C */
1332
Hanno Becker2d9623f2019-06-13 12:07:05 +01001333#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
1334static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1335 mbedtls_ssl_config const *conf )
1336{
1337 return( conf->endpoint );
1338}
1339#else /* !MBEDTLS_SSL_CONF_ENDPOINT */
1340static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1341 mbedtls_ssl_config const *conf )
1342{
1343 ((void) conf);
1344 return( MBEDTLS_SSL_CONF_ENDPOINT );
1345}
1346#endif /* MBEDTLS_SSL_CONF_ENDPOINT */
1347
Hanno Becker1f835fa2019-06-13 10:14:59 +01001348#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
1349static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1350 mbedtls_ssl_config const *conf )
1351{
1352 return( conf->read_timeout );
1353}
1354#else /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
1355static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1356 mbedtls_ssl_config const *conf )
1357{
1358 ((void) conf);
1359 return( MBEDTLS_SSL_CONF_READ_TIMEOUT );
1360}
1361#endif /* MBEDTLS_SSL_CONF_READ_TIMEOUT */
1362
1363#if defined(MBEDTLS_SSL_PROTO_DTLS)
1364#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN)
1365static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1366 mbedtls_ssl_config const *conf )
1367{
1368 return( conf->hs_timeout_min );
1369}
1370#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1371static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1372 mbedtls_ssl_config const *conf )
1373{
1374 ((void) conf);
1375 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN );
1376}
1377#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1378
1379#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX)
1380static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1381 mbedtls_ssl_config const *conf )
1382{
1383 return( conf->hs_timeout_max );
1384}
1385#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1386static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1387 mbedtls_ssl_config const *conf )
1388{
1389 ((void) conf);
1390 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX );
1391}
1392#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1393#endif /* MBEDTLS_SSL_PROTO_DTLS */
1394
Hanno Beckere0200da2019-06-13 09:23:43 +01001395#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1396#if !defined(MBEDTLS_SSL_CONF_CID_LEN)
1397static inline size_t mbedtls_ssl_conf_get_cid_len(
1398 mbedtls_ssl_config const *conf )
1399{
1400 return( conf->cid_len );
1401}
1402#else /* !MBEDTLS_SSL_CONF_CID_LEN */
1403static inline size_t mbedtls_ssl_conf_get_cid_len(
1404 mbedtls_ssl_config const *conf )
1405{
1406 ((void) conf);
1407 return( MBEDTLS_SSL_CONF_CID_LEN );
1408}
1409#endif /* MBEDTLS_SSL_CONF_CID_LEN */
1410
1411#if !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
1412static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1413 mbedtls_ssl_config const *conf )
1414{
1415 return( conf->ignore_unexpected_cid );
1416}
1417#else /* !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1418static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1419 mbedtls_ssl_config const *conf )
1420{
1421 ((void) conf);
1422 return( MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID );
1423}
1424#endif /* MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1425#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1426
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001427#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
1428static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1429 mbedtls_ssl_config const *conf )
1430{
1431 return( conf->allow_legacy_renegotiation );
1432}
1433#else /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1434static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1435 mbedtls_ssl_config const *conf )
1436{
1437 ((void) conf);
1438 return( MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION );
1439}
1440#endif /* MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1441
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001442#if !defined(MBEDTLS_SSL_CONF_AUTHMODE)
1443static inline int mbedtls_ssl_conf_get_authmode(
1444 mbedtls_ssl_config const *conf )
1445{
1446 return( conf->authmode );
1447}
1448#else /* !MBEDTLS_SSL_CONF_AUTHMODE */
1449static inline int mbedtls_ssl_conf_get_authmode(
1450 mbedtls_ssl_config const *conf )
1451{
1452 ((void) conf);
1453 return( MBEDTLS_SSL_CONF_AUTHMODE );
1454}
1455#endif /* MBEDTLS_SSL_CONF_AUTHMODE */
1456
Hanno Beckerde671542019-06-12 16:30:46 +01001457#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1458#if !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
1459static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1460 mbedtls_ssl_config const *conf )
1461{
1462 return( conf->badmac_limit );
1463}
1464#else /* !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1465static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1466 mbedtls_ssl_config const *conf )
1467{
1468 ((void) conf);
1469 return( MBEDTLS_SSL_CONF_BADMAC_LIMIT );
1470}
1471#endif /* MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1472#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1473
Hanno Becker7f376f42019-06-12 16:20:48 +01001474#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1475#if !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
1476static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1477 mbedtls_ssl_config const *conf )
1478{
1479 return( conf->anti_replay );
1480}
1481#else /* !MBEDTLS_SSL_CONF_ANTI_REPLAY */
1482static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1483 mbedtls_ssl_config const *conf )
1484{
1485 ((void) conf);
1486 return( MBEDTLS_SSL_CONF_ANTI_REPLAY );
1487}
1488#endif /* MBEDTLS_SSL_CONF_ANTI_REPLAY */
1489#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1490
Hanno Becker0ae6b242019-06-13 16:45:36 +01001491#if !defined(MBEDTLS_SSL_CONF_SET_TIMER)
1492static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1493 mbedtls_ssl_context const *ssl )
1494{
1495 return( ssl->f_set_timer );
1496}
1497#else /* !MBEDTLS_SSL_CONF_SET_TIMER */
1498
1499#define mbedtls_ssl_conf_set_timer_func MBEDTLS_SSL_CONF_SET_TIMER
1500extern void mbedtls_ssl_conf_set_timer_func( void*, uint32_t, uint32_t );
1501
1502static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1503 mbedtls_ssl_context const *ssl )
1504{
1505 ((void) ssl);
1506 return ((mbedtls_ssl_set_timer_t*) mbedtls_ssl_conf_set_timer_func);
1507}
1508#endif /* MBEDTLS_SSL_CONF_SET_TIMER */
1509
1510#if !defined(MBEDTLS_SSL_CONF_GET_TIMER)
1511static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1512 mbedtls_ssl_context const *ssl )
1513{
1514 return( ssl->f_get_timer );
1515}
1516#else /* !MBEDTLS_SSL_CONF_GET_TIMER */
1517
1518#define mbedtls_ssl_conf_get_timer_func MBEDTLS_SSL_CONF_GET_TIMER
1519extern int mbedtls_ssl_conf_get_timer_func( void* );
1520
1521static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1522 mbedtls_ssl_context const *ssl )
1523{
1524 ((void) ssl);
1525 return ((mbedtls_ssl_get_timer_t*) mbedtls_ssl_conf_get_timer_func);
1526}
1527#endif /* MBEDTLS_SSL_CONF_GET_TIMER */
1528
Hanno Beckera58a8962019-06-13 16:11:15 +01001529#if !defined(MBEDTLS_SSL_CONF_RECV)
1530static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1531 mbedtls_ssl_context const *ssl )
1532{
1533 return( ssl->f_recv );
1534}
1535#else /* !MBEDTLS_SSL_CONF_RECV */
1536
1537#define mbedtls_ssl_conf_recv_func MBEDTLS_SSL_CONF_RECV
1538extern int mbedtls_ssl_conf_recv_func( void*, unsigned char*, size_t );
1539
1540static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1541 mbedtls_ssl_context const *ssl )
1542{
1543 ((void) ssl);
1544 return ((mbedtls_ssl_recv_t*) mbedtls_ssl_conf_recv_func);
1545}
1546#endif /* MBEDTLS_SSL_CONF_RECV */
1547
1548#if !defined(MBEDTLS_SSL_CONF_SEND)
1549static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1550 mbedtls_ssl_context const *ssl )
1551{
1552 return( ssl->f_send );
1553}
1554#else /* !MBEDTLS_SSL_CONF_SEND */
1555
1556#define mbedtls_ssl_conf_send_func MBEDTLS_SSL_CONF_SEND
1557extern int mbedtls_ssl_conf_send_func( void*, unsigned char const*, size_t );
1558
1559static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1560 mbedtls_ssl_context const *ssl )
1561{
1562 ((void) ssl);
1563 return ((mbedtls_ssl_send_t*) mbedtls_ssl_conf_send_func);
1564}
1565#endif /* MBEDTLS_SSL_CONF_SEND */
1566
1567#if !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
1568static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1569 mbedtls_ssl_context const *ssl )
1570{
1571 return( ssl->f_recv_timeout );
1572}
1573#else /* !MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1574
1575#define mbedtls_ssl_conf_recv_timeout_func MBEDTLS_SSL_CONF_RECV_TIMEOUT
1576extern int mbedtls_ssl_conf_recv_timeout_func(
1577 void*, unsigned char*, size_t, uint32_t );
1578
1579static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1580 mbedtls_ssl_context const *ssl )
1581{
1582 ((void) ssl);
1583 return ((mbedtls_ssl_recv_timeout_t*) mbedtls_ssl_conf_recv_timeout_func);
1584}
1585#endif /* MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1586
1587typedef int mbedtls_frng_t( void*, unsigned char*, size_t );
1588
Hanno Beckerece325c2019-06-13 15:39:27 +01001589#if !defined(MBEDTLS_SSL_CONF_RNG)
Hanno Beckera58a8962019-06-13 16:11:15 +01001590static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001591 mbedtls_ssl_config const *conf )
1592{
1593 return( conf->f_rng );
1594}
Hanno Beckerece325c2019-06-13 15:39:27 +01001595
Hanno Becker572d4482019-07-23 13:47:53 +01001596static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1597{
1598 return( conf->p_rng );
1599}
1600#else /* !MBEDTLS_SSL_CONF_RNG */
Hanno Beckerece325c2019-06-13 15:39:27 +01001601#define mbedtls_ssl_conf_rng_func MBEDTLS_SSL_CONF_RNG
1602extern int mbedtls_ssl_conf_rng_func( void*, unsigned char*, size_t );
1603
Hanno Beckera58a8962019-06-13 16:11:15 +01001604static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001605 mbedtls_ssl_config const *conf )
1606{
1607 ((void) conf);
1608 return ((mbedtls_frng_t*) mbedtls_ssl_conf_rng_func);
1609}
Hanno Becker572d4482019-07-23 13:47:53 +01001610
1611static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1612{
1613 ((void) conf);
1614 return( NULL );
1615}
Hanno Beckerece325c2019-06-13 15:39:27 +01001616#endif /* MBEDTLS_SSL_CONF_RNG */
1617
Hanno Beckere965bd32019-06-12 14:04:34 +01001618static inline int mbedtls_ssl_conf_get_max_major_ver(
1619 mbedtls_ssl_config const *conf )
1620{
1621#if !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
1622 return( conf->max_major_ver );
1623#else
1624 ((void) conf);
1625 return( MBEDTLS_SSL_CONF_MAX_MAJOR_VER );
1626#endif /* MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
1627}
1628
1629static inline int mbedtls_ssl_conf_get_min_major_ver(
1630 mbedtls_ssl_config const *conf )
1631{
1632#if !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
1633 return( conf->min_major_ver );
1634#else /* !MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1635 ((void) conf);
1636 return( MBEDTLS_SSL_CONF_MIN_MAJOR_VER );
1637#endif /* MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1638}
1639
1640static inline int mbedtls_ssl_conf_get_max_minor_ver(
1641 mbedtls_ssl_config const *conf )
1642{
1643#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER)
1644 return( conf->max_minor_ver );
1645#else /* !MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1646 ((void) conf);
1647 return( MBEDTLS_SSL_CONF_MAX_MINOR_VER );
1648#endif /* MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1649}
1650
1651static inline int mbedtls_ssl_conf_get_min_minor_ver(
1652 mbedtls_ssl_config const *conf )
1653{
1654#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER)
1655 return( conf->min_minor_ver );
1656#else /* !MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1657 ((void) conf);
1658 return( MBEDTLS_SSL_CONF_MIN_MINOR_VER );
1659#endif /* MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1660}
1661
Hanno Becker57e72c72019-06-12 12:46:31 +01001662#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1663static inline unsigned int mbedtls_ssl_conf_get_ems(
1664 mbedtls_ssl_config const *conf )
1665{
1666#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
1667 return( conf->extended_ms );
1668#else
1669 ((void) conf);
1670 return( MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET );
1671#endif /* MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET */
1672}
1673
1674static inline unsigned int mbedtls_ssl_conf_get_ems_enforced(
1675 mbedtls_ssl_config const *conf )
1676{
1677#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
1678 return( conf->enforce_extended_master_secret );
1679#else
1680 ((void) conf);
1681 return( MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET );
1682#endif /* MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
1683}
1684#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1685
Hanno Becker14990272019-06-26 11:47:15 +01001686/*
1687 * Macros for the traversal of the list of all enabled ciphersuites.
1688 * This is implemented as a plain loop in case we have a runtime
1689 * configurable list of ciphersuites, and as a simple variable
1690 * instantiation in case a single ciphersuite is enabled at
1691 * compile-time.
1692 */
Hanno Becker73f4cb12019-06-27 13:51:07 +01001693#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker14990272019-06-26 11:47:15 +01001694
1695#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
1696 { \
1697 int const *__id_ptr; \
1698 for( __id_ptr=(ssl)->conf->ciphersuite_list[ (ver) ]; \
1699 *__id_ptr != 0; __id_ptr++ ) \
1700 { \
1701 const int __id = *__id_ptr; \
1702 mbedtls_ssl_ciphersuite_handle_t info; \
1703 info = mbedtls_ssl_ciphersuite_from_id( __id ); \
1704 if( info == MBEDTLS_SSL_CIPHERSUITE_INVALID_HANDLE ) \
1705 continue;
1706
1707#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
1708 } \
1709 }
1710
Hanno Becker73f4cb12019-06-27 13:51:07 +01001711#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001712
1713#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001714 do { \
Hanno Becker14990272019-06-26 11:47:15 +01001715 const mbedtls_ssl_ciphersuite_handle_t info = \
1716 MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE;
1717
1718#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001719 } while( 0 );
Hanno Becker14990272019-06-26 11:47:15 +01001720
Hanno Becker73f4cb12019-06-27 13:51:07 +01001721#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001722
Hanno Beckerc1096e72019-06-19 12:30:41 +01001723#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
1724
Hanno Becker7ae30262019-07-10 09:40:52 +01001725#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1726 { \
1727 mbedtls_ecp_group_id const *_gid; \
1728 mbedtls_ecp_curve_info const *_info; \
1729 for( _gid = ssl->conf->curve_list; \
1730 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
1731 { \
1732 uint16_t TLS_ID_VAR; \
1733 _info = mbedtls_ecp_curve_info_from_grp_id( *_gid ) ; \
1734 if( _info == NULL ) \
1735 continue; \
1736 TLS_ID_VAR = _info->tls_id;
Hanno Beckera4a9c692019-06-18 16:55:47 +01001737
1738#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1739 } \
1740 }
1741
1742#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1743 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001744 mbedtls_ecp_group_id const *_gid; \
1745 for( _gid = ssl->conf->curve_list; \
1746 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001747 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001748 mbedtls_ecp_group_id EC_ID_VAR = *_gid; \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001749
1750#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1751 } \
1752 }
1753
Hanno Beckerc1096e72019-06-19 12:30:41 +01001754#else /* !MBEDTLS_SSL_CONF_SINGLE_EC */
1755
1756#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1757 { \
1758 uint16_t TLS_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID; \
1759 ((void) ssl);
1760
1761#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1762 }
1763
1764#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1765 { \
1766 mbedtls_ecp_group_id EC_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID; \
1767 ((void) ssl);
1768
1769#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1770 }
1771
1772#endif /* MBEDTLS_SSL_CONF_SINGLE_EC */
1773
Hanno Becker56595f42019-06-19 16:31:38 +01001774#if !defined(MBEDTLS_SSL_CONF_SINGLE_SIG_HASH)
1775
Hanno Beckerf1bc9e12019-06-19 16:23:21 +01001776#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1777 { \
1778 int const *__md; \
1779 for( __md = ssl->conf->sig_hashes; \
1780 *__md != MBEDTLS_MD_NONE; __md++ ) \
1781 { \
1782 mbedtls_md_type_t MD_VAR = (mbedtls_md_type_t) *__md; \
1783
1784 #define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1785 } \
1786 }
1787
1788#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1789 { \
1790 int const *__md; \
1791 for( __md = ssl->conf->sig_hashes; \
1792 *__md != MBEDTLS_MD_NONE; __md++ ) \
1793 { \
1794 unsigned char HASH_VAR; \
1795 HASH_VAR = mbedtls_ssl_hash_from_md_alg( *__md );
1796
1797#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1798 } \
1799 }
1800
Hanno Becker56595f42019-06-19 16:31:38 +01001801#else /* !MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1802
1803#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1804 { \
1805 mbedtls_md_type_t MD_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID; \
1806 ((void) ssl);
1807
1808#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1809 }
1810
1811#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1812 { \
1813 unsigned char HASH_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID; \
1814 ((void) ssl);
1815
1816
1817#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1818 }
1819
1820#endif /* MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1821
Hanno Beckereeabfa42019-07-25 10:28:30 +01001822/* This internal function can be used to pend a fatal alert for
1823 * later delivery.
1824 *
Hanno Beckerb82350b2019-07-26 07:24:05 +01001825 * The check for pending alerts must be done by calling
Hanno Beckerdd691192019-07-26 09:59:18 +01001826 * the function ssl_send_pending_fatal_alert() in ssl_tls.c.
Hanno Beckerfcb721d2019-07-26 12:47:16 +01001827 * Currently, it happens only during the handshake loop and after
1828 * calling ssl_get_next_record() in the record processing stack.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001829 *
Hanno Beckerc8f52992019-07-25 11:15:08 +01001830 * This function must not be called multiple times without
Hanno Beckerb82350b2019-07-26 07:24:05 +01001831 * sending the pending fatal alerts in between.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001832 */
Hanno Beckerd829d0f2019-07-25 10:28:57 +01001833MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_pend_fatal_alert(
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001834 mbedtls_ssl_context *ssl,
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001835 unsigned char message )
1836{
Hanno Beckerc8f52992019-07-25 11:15:08 +01001837 ssl->pending_fatal_alert_msg = message;
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001838}
1839
Hanno Becker88440552019-07-03 14:16:13 +01001840/*
1841 * Getter functions for fields in SSL session.
1842 */
1843
1844static inline int mbedtls_ssl_session_get_compression(
1845 mbedtls_ssl_session const *session )
1846{
1847#if defined(MBEDTLS_ZLIB_SUPPORT)
1848 return( session->compression );
1849#else
1850 ( (void) session );
1851 return( MBEDTLS_SSL_COMPRESS_NULL );
1852#endif
1853}
1854
Hanno Becker84434912019-08-15 17:07:52 +01001855MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_update_checksum(
1856 mbedtls_ssl_context *ssl,
1857 const unsigned char *buf, size_t len )
1858{
1859#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1860 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1861 mbedtls_md5_update_ret( &ssl->handshake->fin_md5 , buf, len );
1862 mbedtls_sha1_update_ret( &ssl->handshake->fin_sha1, buf, len );
1863#endif
1864#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1865#if defined(MBEDTLS_SHA256_C)
1866 mbedtls_sha256_update_ret( &ssl->handshake->fin_sha256, buf, len );
1867#endif
1868#if defined(MBEDTLS_SHA512_C)
1869 mbedtls_sha512_update_ret( &ssl->handshake->fin_sha512, buf, len );
1870#endif
1871#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1872}
Hanno Becker8a4b5902019-08-15 17:04:57 +01001873
Hanno Becker2f41b242019-08-15 17:29:43 +01001874int mbedtls_ssl_calc_verify( int minor_ver,
1875 mbedtls_md_type_t hash,
1876 mbedtls_ssl_context const *ssl,
1877 unsigned char *dst,
1878 size_t *hlen );
1879
Hanno Becker868cb582019-07-23 14:29:13 +01001880#define MBEDTLS_SSL_CHK(f) do { if( ( ret = f ) < 0 ) goto cleanup; } while( 0 )
Hanno Becker5d397682018-05-21 12:50:34 +01001881
Hanno Becker75f12d12019-07-23 16:16:15 +01001882#if defined(MBEDTLS_USE_TINYCRYPT)
1883int mbedtls_ssl_ecdh_read_peerkey( mbedtls_ssl_context *ssl,
1884 unsigned char **p, unsigned char *end );
1885#endif /* MBEDTLS_USE_TINYCRYPT */
1886
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001887#endif /* ssl_internal.h */