blob: 4af1537126be551d0d2e00ff8c382ce3c24737c5 [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))
63#else
64#define MBEDTLS_ALWAYS_INLINE
65#endif
66
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010067#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
68 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020069#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020070#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020071
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +020072/* The public option is negative for backwards compatibility,
73 * but internally a poisitive option is more convenient. */
74#if !defined(MBEDTLS_SSL_PROTO_NO_TLS)
75#define MBEDTLS_SSL_PROTO_TLS
76#endif
77
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020078/* Determine minimum supported version */
79#define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
80
81#if defined(MBEDTLS_SSL_PROTO_SSL3)
82#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
83#else
84#if defined(MBEDTLS_SSL_PROTO_TLS1)
85#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
86#else
87#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
88#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
89#else
90#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
91#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
92#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
93#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
94#endif /* MBEDTLS_SSL_PROTO_TLS1 */
95#endif /* MBEDTLS_SSL_PROTO_SSL3 */
96
Ron Eldor5e9f14d2017-05-28 10:46:38 +030097#define MBEDTLS_SSL_MIN_VALID_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
98#define MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
99
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200100/* Determine maximum supported version */
101#define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
102
103#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
104#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
105#else
106#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
107#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
108#else
109#if defined(MBEDTLS_SSL_PROTO_TLS1)
110#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
111#else
112#if defined(MBEDTLS_SSL_PROTO_SSL3)
113#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
114#endif /* MBEDTLS_SSL_PROTO_SSL3 */
115#endif /* MBEDTLS_SSL_PROTO_TLS1 */
116#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
117#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
118
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200119/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200120#if defined(MBEDTLS_ECP_RESTARTABLE) && \
121 defined(MBEDTLS_SSL_CLI_C) && \
122 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
123 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
124#define MBEDTLS_SSL__ECP_RESTARTABLE
125#endif
126
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200127#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
128#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
129#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
130#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
131
132/*
133 * DTLS retransmission states, see RFC 6347 4.2.4
134 *
135 * The SENDING state is merged in PREPARING for initial sends,
136 * but is distinct for resends.
137 *
138 * Note: initial state is wrong for server, but is not used anyway.
139 */
140#define MBEDTLS_SSL_RETRANS_PREPARING 0
141#define MBEDTLS_SSL_RETRANS_SENDING 1
142#define MBEDTLS_SSL_RETRANS_WAITING 2
143#define MBEDTLS_SSL_RETRANS_FINISHED 3
144
145/*
146 * Allow extra bytes for record, authentication and encryption overhead:
147 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256)
148 * and allow for a maximum of 1024 of compression expansion if
149 * enabled.
150 */
151#if defined(MBEDTLS_ZLIB_SUPPORT)
152#define MBEDTLS_SSL_COMPRESSION_ADD 1024
153#else
154#define MBEDTLS_SSL_COMPRESSION_ADD 0
155#endif
156
Hanno Becker5cc04d52018-01-03 15:24:20 +0000157#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
158 ( defined(MBEDTLS_CIPHER_MODE_CBC) && \
159 ( defined(MBEDTLS_AES_C) || \
160 defined(MBEDTLS_CAMELLIA_C) || \
Hanno Beckerb628a802018-07-17 10:19:47 +0100161 defined(MBEDTLS_ARIA_C) || \
162 defined(MBEDTLS_DES_C) ) )
Hanno Becker5cc04d52018-01-03 15:24:20 +0000163#define MBEDTLS_SSL_SOME_MODES_USE_MAC
164#endif
165
166#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200167/* Ciphersuites using HMAC */
168#if defined(MBEDTLS_SHA512_C)
169#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
170#elif defined(MBEDTLS_SHA256_C)
171#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
172#else
173#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
174#endif
Hanno Becker5cc04d52018-01-03 15:24:20 +0000175#else /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200176/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
177#define MBEDTLS_SSL_MAC_ADD 16
178#endif
179
180#if defined(MBEDTLS_CIPHER_MODE_CBC)
181#define MBEDTLS_SSL_PADDING_ADD 256
182#else
183#define MBEDTLS_SSL_PADDING_ADD 0
184#endif
185
Hanno Beckera5a2b082019-05-15 14:03:01 +0100186#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker550e1662019-05-08 17:37:58 +0100187#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_PADDING_GRANULARITY
Hanno Beckeradd01902019-05-08 15:40:11 +0100188#else
189#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
190#endif
191
Angus Grattond8213d02016-05-25 20:56:48 +1000192#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_SSL_COMPRESSION_ADD + \
193 MBEDTLS_MAX_IV_LENGTH + \
194 MBEDTLS_SSL_MAC_ADD + \
Hanno Beckeradd01902019-05-08 15:40:11 +0100195 MBEDTLS_SSL_PADDING_ADD + \
196 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000197 )
198
199#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
200 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
201
202#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
203 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
204
Hanno Becker0271f962018-08-16 13:23:47 +0100205/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100206#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100207
Angus Grattond8213d02016-05-25 20:56:48 +1000208/* Maximum length we can advertise as our max content length for
209 RFC 6066 max_fragment_length extension negotiation purposes
210 (the lesser of both sizes, if they are unequal.)
211 */
212#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
213 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
214 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
215 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
216 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200217
218/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100219 * Check that we obey the standard's message size bounds
220 */
221
222#if MBEDTLS_SSL_MAX_CONTENT_LEN > 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000223#error "Bad configuration - record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100224#endif
225
Angus Grattond8213d02016-05-25 20:56:48 +1000226#if MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
227#error "Bad configuration - incoming record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
Hanno Beckera8434e82017-09-18 10:54:39 +0100228#endif
229
Angus Grattond8213d02016-05-25 20:56:48 +1000230#if MBEDTLS_SSL_OUT_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
231#error "Bad configuration - outgoing record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
232#endif
233
234#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
235#error "Bad configuration - incoming protected record payload too large."
236#endif
237
238#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
239#error "Bad configuration - outgoing protected record payload too large."
240#endif
241
242/* Calculate buffer sizes */
243
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000244/* Note: Even though the TLS record header is only 5 bytes
245 long, we're internally using 8 bytes to store the
246 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100247#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100248
Hanno Beckera5a2b082019-05-15 14:03:01 +0100249#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000250#define MBEDTLS_SSL_IN_BUFFER_LEN \
251 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100252#else
253#define MBEDTLS_SSL_IN_BUFFER_LEN \
254 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
255 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
256#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000257
Hanno Beckera5a2b082019-05-15 14:03:01 +0100258#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000259#define MBEDTLS_SSL_OUT_BUFFER_LEN \
260 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100261#else
262#define MBEDTLS_SSL_OUT_BUFFER_LEN \
263 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
264 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
265#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000266
267#ifdef MBEDTLS_ZLIB_SUPPORT
268/* Compression buffer holds both IN and OUT buffers, so should be size of the larger */
269#define MBEDTLS_SSL_COMPRESS_BUFFER_LEN ( \
270 ( MBEDTLS_SSL_IN_BUFFER_LEN > MBEDTLS_SSL_OUT_BUFFER_LEN ) \
271 ? MBEDTLS_SSL_IN_BUFFER_LEN \
272 : MBEDTLS_SSL_OUT_BUFFER_LEN \
273 )
274#endif
Hanno Beckera8434e82017-09-18 10:54:39 +0100275
276/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200277 * TLS extension flags (for extensions with outgoing ServerHello content
278 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
279 * of state of the renegotiation flag, so no indicator is required)
280 */
281#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200282#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200283
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100284/*
285 * Helpers for code specific to TLS or DTLS.
286 *
287 * Goals for these helpers:
288 * - 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 +0200289 * - make the flow clear to the compiler, so that in TLS and DTLS combined
Manuel Pégourié-Gonnardec1c2222019-06-12 10:18:26 +0200290 * builds, when there are two branches, it knows exactly one of them is taken
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100291 * - preserve readability
292 *
293 * There are three macros:
294 * - MBEDTLS_SSL_TRANSPORT_IS_TLS( transport )
295 * - MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport )
296 * - MBEDTLS_SSL_TRANSPORT_ELSE
297 *
298 * The first two are macros rather than static inline functions because some
299 * compilers (eg arm-none-eabi-gcc 5.4.1 20160919) don't propagate constants
300 * well enough for us with static inline functions.
301 *
302 * Usage 1 (can replace DTLS with TLS):
303 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
304 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
305 * // DTLS-specific code
306 * #endif
307 *
308 * Usage 2 (can swap DTLS and TLS);
309 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
310 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
311 * // DTLS-specific code
312 * MBEDTLS_SSL_TRANSPORT_ELSE
313 * #endif
314 * #if defined(MBEDTLS_SSL_PROTO_TLS)
315 * // TLS-specific code
316 * #endif
317 */
318#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_PROTO_TLS) /* both */
Manuel Pégourié-Gonnard8794a422019-06-11 10:04:57 +0200319#define MBEDTLS_SSL_TRANSPORT__BOTH /* shortcut for future tests */
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100320#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) \
321 ( (transport) == MBEDTLS_SSL_TRANSPORT_STREAM )
322#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) \
323 ( (transport) == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
324#define MBEDTLS_SSL_TRANSPORT_ELSE else
325#elif defined(MBEDTLS_SSL_PROTO_DTLS) /* DTLS only */
326#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 0
327#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 1
328#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
329#else /* TLS only */
330#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 1
331#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 0
332#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
333#endif /* TLS and/or DTLS */
334
Hanno Becker3010d552019-06-11 14:46:16 +0100335/* Check if the use of the ExtendedMasterSecret extension
336 * is enforced at compile-time. If so, we don't need to
337 * track its status in the handshake parameters. */
338#if defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET) && \
339 defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET) && \
340 MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET == \
341 MBEDTLS_SSL_EXTENDED_MS_ENABLED && \
342 MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET == \
343 MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED
344#define MBEDTLS_SSL_EXTENDED_MS_ENFORCED
345#endif
346
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200347#ifdef __cplusplus
348extern "C" {
349#endif
350
Hanno Becker7e5437a2017-04-28 17:15:26 +0100351#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
352 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
353/*
354 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
355 */
356struct mbedtls_ssl_sig_hash_set_t
357{
358 /* At the moment, we only need to remember a single suitable
359 * hash algorithm per signature algorithm. As long as that's
360 * the case - and we don't need a general lookup function -
361 * we can implement the sig-hash-set as a map from signatures
362 * to hash algorithms. */
363 mbedtls_md_type_t rsa;
364 mbedtls_md_type_t ecdsa;
365};
366#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
367 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
368
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200369/*
370 * This structure contains the parameters only needed during handshake.
371 */
372struct mbedtls_ssl_handshake_params
373{
374 /*
375 * Handshake specific crypto variables
376 */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100377
378#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
379 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
380 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
381#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200382#if defined(MBEDTLS_DHM_C)
383 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
384#endif
385#if defined(MBEDTLS_ECDH_C)
386 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
387#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200388#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200389 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200390#if defined(MBEDTLS_SSL_CLI_C)
391 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
392 size_t ecjpake_cache_len; /*!< Length of cached data */
393#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100394#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jarno Lamsae12aafb2019-04-04 18:32:56 +0300395#if defined(MBEDTLS_ECDH_C) || \
396 defined(MBEDTLS_ECDSA_C) || \
Hanno Becker3a336792019-08-12 15:25:14 +0100397 defined(MBEDTLS_USE_TINYCRYPT) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200398 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Hanno Becker004619f2019-06-18 16:07:32 +0100399 uint16_t curve_tls_id; /*!< TLS ID of EC for ECDHE. */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200400#endif
401#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
402 unsigned char *psk; /*!< PSK from the callback */
403 size_t psk_len; /*!< Length of PSK from callback */
404#endif
405#if defined(MBEDTLS_X509_CRT_PARSE_C)
406 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
407#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200408 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200409 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
410 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
411 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100412#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200413#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200414#if defined(MBEDTLS_SSL__ECP_RESTARTABLE)
Manuel Pégourié-Gonnardd27d1a52017-08-15 11:49:08 +0200415 int ecrs_enabled; /*!< Handshake supports EC restart? */
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200416 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200417 enum { /* this complements ssl->state with info on intra-state operations */
418 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
419 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
Manuel Pégourié-Gonnardc37423f2018-10-16 10:28:17 +0200420 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200421 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
422 } ecrs_state; /*!< current (or last) operation */
Hanno Beckerdd689312019-02-25 10:08:06 +0000423 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200424#endif
Hanno Becker3bf8cdf2019-02-06 16:18:31 +0000425#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
426 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
427 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
428#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200429#if defined(MBEDTLS_SSL_PROTO_DTLS)
430 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
431 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
432
433 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
434 Srv: unused */
435 unsigned char verify_cookie_len; /*!< Cli: cookie length
436 Srv: flag for sending a cookie */
437
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200438 uint32_t retransmit_timeout; /*!< Current value of timeout */
439 unsigned char retransmit_state; /*!< Retransmission state */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200440 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
441 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
442 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200443 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
444 flight being received */
445 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
446 resending messages */
447 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
448 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100449
Hanno Beckera5a2b082019-05-15 14:03:01 +0100450#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +0100451 /* The state of CID configuration in this handshake. */
452
453 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
Hanno Beckercfa6be72019-05-15 10:17:48 +0100454 * has been negotiated. Possible values are
Hanno Beckere5e7f622019-04-25 15:46:59 +0100455 * #MBEDTLS_SSL_CID_ENABLED and
456 * #MBEDTLS_SSL_CID_DISABLED. */
457 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
458 uint8_t peer_cid_len; /*!< The length of
459 * \c peer_cid. */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100460#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100461
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100462 struct
463 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100464 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
465 * buffers used for message buffering. */
466
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100467 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100468 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100469
Hanno Becker0271f962018-08-16 13:23:47 +0100470 struct mbedtls_ssl_hs_buffer
471 {
Hanno Becker98081a02018-08-22 13:32:50 +0100472 unsigned is_valid : 1;
473 unsigned is_fragmented : 1;
474 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100475 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100476 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100477 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
478
Hanno Becker5f066e72018-08-16 14:56:31 +0100479 struct
480 {
481 unsigned char *data;
482 size_t len;
483 unsigned epoch;
484 } future_record;
485
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100486 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100487
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200488 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100489#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200490
491 /*
492 * Checksum contexts
493 */
494#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
495 defined(MBEDTLS_SSL_PROTO_TLS1_1)
496 mbedtls_md5_context fin_md5;
497 mbedtls_sha1_context fin_sha1;
498#endif
499#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
500#if defined(MBEDTLS_SHA256_C)
501 mbedtls_sha256_context fin_sha256;
502#endif
503#if defined(MBEDTLS_SHA512_C)
504 mbedtls_sha512_context fin_sha512;
505#endif
506#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
507
Hanno Becker73f4cb12019-06-27 13:51:07 +0100508#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker473f98f2019-06-26 10:27:32 +0100509 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info;
Hanno Becker73f4cb12019-06-27 13:51:07 +0100510#endif /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker8759e162017-12-27 21:34:08 +0000511
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200512 size_t pmslen; /*!< premaster length */
513
514 unsigned char randbytes[64]; /*!< random bytes */
515 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
516 /*!< premaster secret */
517
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300518#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200519 int resume; /*!< session resume indicator*/
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300520#endif /* !MBEDTLS_SSL_NO_SESSION_RESUMPTION */
Hanno Becker18729ae2019-06-12 14:47:21 +0100521
522#if defined(MBEDTLS_SSL_SRV_C) && \
523 ( defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
524 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) )
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200525 int max_major_ver; /*!< max. major version client*/
526 int max_minor_ver; /*!< max. minor version client*/
Hanno Becker18729ae2019-06-12 14:47:21 +0100527#endif /* MBEDTLS_SSL_SRV_C && ( MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ||
528 MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200529 int cli_exts; /*!< client extension presence*/
530
531#if defined(MBEDTLS_SSL_SESSION_TICKETS)
532 int new_session_ticket; /*!< use NewSessionTicket? */
533#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Hanno Becker1ab322b2019-06-11 14:50:54 +0100534#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
535 !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200536 int extended_ms; /*!< use Extended Master Secret? */
537#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200538
539#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200540 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200541#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
542
543#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
544 /** Asynchronous operation context. This field is meant for use by the
545 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
546 * mbedtls_ssl_config::f_async_decrypt_start,
547 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
548 * The library does not use it internally. */
549 void *user_async_ctx;
550#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Hanno Becker9175c212019-07-24 11:47:22 +0100551
552#if defined(MBEDTLS_USE_TINYCRYPT)
553 uint8_t ecdh_privkey[NUM_ECC_BYTES];
Hanno Becker9175c212019-07-24 11:47:22 +0100554 uint8_t ecdh_peerkey[2*NUM_ECC_BYTES];
555#endif /* MBEDTLS_USE_TINYCRYPT */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200556};
557
Hanno Beckera49ec562019-06-11 14:47:55 +0100558/*
559 * Getter functions for fields in mbedtls_ssl_handshake_params which
560 * may be statically implied by the configuration and hence be omitted
561 * from the structure.
562 */
563#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
564static inline int mbedtls_ssl_hs_get_extended_ms(
565 mbedtls_ssl_handshake_params const *params )
566{
567#if !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
568 return( params->extended_ms );
569#else
570 ((void) params);
571 return( MBEDTLS_SSL_EXTENDED_MS_ENABLED );
572#endif /* MBEDTLS_SSL_EXTENDED_MS_ENFORCED */
573}
574#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
575
Hanno Becker73f4cb12019-06-27 13:51:07 +0100576#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Beckerdf645962019-06-26 13:02:22 +0100577static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
578 mbedtls_ssl_handshake_params const *handshake )
579{
580 return( handshake->ciphersuite_info );
581}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100582#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100583static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
584 mbedtls_ssl_handshake_params const *handshake )
585{
586 ((void) handshake);
587 return( MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE );
588}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100589#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100590
Hanno Becker0271f962018-08-16 13:23:47 +0100591typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
592
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200593/*
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000594 * Representation of decryption/encryption transformations on records
595 *
596 * There are the following general types of record transformations:
597 * - Stream transformations (TLS versions <= 1.2 only)
598 * Transformation adding a MAC and applying a stream-cipher
599 * to the authenticated message.
600 * - CBC block cipher transformations ([D]TLS versions <= 1.2 only)
601 * In addition to the distinction of the order of encryption and
602 * authentication, there's a fundamental difference between the
603 * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3
604 * and TLS 1.0, the final IV after processing a record is used
605 * as the IV for the next record. No explicit IV is contained
606 * in an encrypted record. The IV for the first record is extracted
607 * at key extraction time. In contrast, for TLS 1.1 and 1.2, no
608 * IV is generated at key extraction time, but every encrypted
609 * record is explicitly prefixed by the IV with which it was encrypted.
610 * - AEAD transformations ([D]TLS versions >= 1.2 only)
611 * These come in two fundamentally different versions, the first one
612 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
613 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
614 * In the first transformation, the IV to be used for a record is obtained
615 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
616 * record sequence number, and explicitly prepending this sequence number
617 * to the encrypted record. In contrast, in the second transformation
618 * the IV is obtained by XOR'ing a static IV obtained at key extraction
619 * time with the 8-byte record sequence number, without prepending the
620 * latter to the encrypted record.
621 *
622 * In addition to type and version, the following parameters are relevant:
623 * - The symmetric cipher algorithm to be used.
624 * - The (static) encryption/decryption keys for the cipher.
625 * - For stream/CBC, the type of message digest to be used.
626 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Beckera198bb72018-10-18 15:39:53 +0100627 * - For AEAD transformations, the size (potentially 0) of an explicit,
628 * random initialization vector placed in encrypted records.
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000629 * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0)
630 * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC)
631 * and (if present) is combined with the explicit IV in a transformation-
632 * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
633 * - For stream/CBC, a flag determining the order of encryption and MAC.
634 * - The details of the transformation depend on the SSL/TLS version.
635 * - The length of the authentication tag.
636 *
Hanno Beckera198bb72018-10-18 15:39:53 +0100637 * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are
638 * constant across multiple encryption/decryption operations.
639 * For CBC, the implicit IV needs to be updated after each
640 * operation.
641 *
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000642 * The struct below refines this abstract view as follows:
643 * - The cipher underlying the transformation is managed in
644 * cipher contexts cipher_ctx_{enc/dec}, which must have the
645 * same cipher type. The mode of these cipher contexts determines
646 * the type of the transformation in the sense above: e.g., if
647 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
648 * then the transformation has type CBC resp. AEAD.
649 * - The cipher keys are never stored explicitly but
650 * are maintained within cipher_ctx_{enc/dec}.
651 * - For stream/CBC transformations, the message digest contexts
652 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
653 * are unused for AEAD transformations.
654 * - For stream/CBC transformations and versions > SSL3, the
655 * MAC keys are not stored explicitly but maintained within
656 * md_ctx_{enc/dec}.
657 * - For stream/CBC transformations and version SSL3, the MAC
658 * keys are stored explicitly in mac_enc, mac_dec and have
659 * a fixed size of 20 bytes. These fields are unused for
660 * AEAD transformations or transformations >= TLS 1.0.
661 * - For transformations using an implicit IV maintained within
662 * the transformation context, its contents are stored within
663 * iv_{enc/dec}.
664 * - The value of ivlen indicates the length of the IV.
665 * This is redundant in case of stream/CBC transformations
666 * which always use 0 resp. the cipher's block length as the
667 * IV length, but is needed for AEAD ciphers and may be
668 * different from the underlying cipher's block length
669 * in this case.
670 * - The field fixed_ivlen is nonzero for AEAD transformations only
671 * and indicates the length of the static part of the IV which is
672 * constant throughout the communication, and which is stored in
673 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
674 * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec}
675 * still store IV's for continued use across multiple transformations,
676 * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are
677 * not being used!
678 * - minor_ver denotes the SSL/TLS version
679 * - For stream/CBC transformations, maclen denotes the length of the
680 * authentication tag, while taglen is unused and 0.
681 * - For AEAD transformations, taglen denotes the length of the
682 * authentication tag, while maclen is unused and 0.
683 * - For CBC transformations, encrypt_then_mac determines the
684 * order of encryption and authentication. This field is unused
685 * in other transformations.
686 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200687 */
688struct mbedtls_ssl_transform
689{
690 /*
691 * Session specific crypto layer
692 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200693 size_t ivlen; /*!< IV length */
694 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Becker8759e162017-12-27 21:34:08 +0000695 size_t maclen; /*!< MAC(CBC) len */
696 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200697
698 unsigned char iv_enc[16]; /*!< IV (encryption) */
699 unsigned char iv_dec[16]; /*!< IV (decryption) */
700
Hanno Becker92231322018-01-03 15:32:51 +0000701#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
702
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200703#if defined(MBEDTLS_SSL_PROTO_SSL3)
704 /* Needed only for SSL v3.0 secret */
705 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
706 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
707#endif /* MBEDTLS_SSL_PROTO_SSL3 */
708
709 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
710 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
711
Hanno Becker3307b532017-12-27 21:37:21 +0000712#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
713 int encrypt_then_mac; /*!< flag for EtM activation */
714#endif
715
Hanno Becker92231322018-01-03 15:32:51 +0000716#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
717
718 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
719 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Hanno Becker0a92b812019-06-24 15:46:40 +0100720
721#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker3307b532017-12-27 21:37:21 +0000722 int minor_ver;
Hanno Becker0a92b812019-06-24 15:46:40 +0100723#endif
Hanno Becker3307b532017-12-27 21:37:21 +0000724
Hanno Beckera5a2b082019-05-15 14:03:01 +0100725#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100726 uint8_t in_cid_len;
727 uint8_t out_cid_len;
728 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
729 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera5a2b082019-05-15 14:03:01 +0100730#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100731
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200732 /*
733 * Session specific compression layer
734 */
735#if defined(MBEDTLS_ZLIB_SUPPORT)
736 z_stream ctx_deflate; /*!< compression context */
737 z_stream ctx_inflate; /*!< decompression context */
738#endif
Manuel Pégourié-Gonnarda3024ee2019-07-09 12:54:17 +0200739
740#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
741 /* We need the Hello random bytes in order to re-derive keys from the
742 * Master Secret and other session info, see ssl_populate_transform() */
743 unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */
744#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200745};
746
Hanno Becker0a92b812019-06-24 15:46:40 +0100747static inline int mbedtls_ssl_transform_get_minor_ver( mbedtls_ssl_transform const *transform )
748{
749#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
750 return( transform->minor_ver );
751#else
752 ((void) transform);
753 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
754#endif
755}
756
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000757/*
Manuel Pégourié-Gonnard569ed6b2019-07-10 14:14:05 +0200758 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
759 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
760 */
761static inline int mbedtls_ssl_transform_uses_aead(
762 const mbedtls_ssl_transform *transform )
763{
764#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
765 return( transform->maclen == 0 && transform->taglen != 0 );
766#else
767 (void) transform;
768 return( 1 );
769#endif
770}
771
772/*
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000773 * Internal representation of record frames
774 *
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000775 * Instances come in two flavors:
776 * (1) Encrypted
777 * These always have data_offset = 0
778 * (2) Unencrypted
Hanno Beckerf8323432019-04-04 16:29:48 +0100779 * These have data_offset set to the amount of
780 * pre-expansion during record protection. Concretely,
781 * this is the length of the fixed part of the explicit IV
782 * used for encryption, or 0 if no explicit IV is used
783 * (e.g. for CBC in TLS 1.0, or stream ciphers).
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000784 *
785 * The reason for the data_offset in the unencrypted case
786 * is to allow for in-place conversion of an unencrypted to
787 * an encrypted record. If the offset wasn't included, the
788 * encrypted content would need to be shifted afterwards to
789 * make space for the fixed IV.
790 *
791 */
Hanno Becker80fe63e2019-04-29 13:45:54 +0100792#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100793#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100794#else
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100795#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100796#endif
797
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000798typedef struct
799{
Hanno Beckere84b28c2019-07-11 09:24:36 +0100800 uint8_t ctr[8]; /* In TLS: The implicit record sequence number.
801 * In DTLS: The 2-byte epoch followed by
802 * the 6-byte sequence number.
803 * This is stored as a raw big endian byte array
804 * as opposed to a uint64_t because we rarely
805 * need to perform arithmetic on this, but do
806 * need it as a Byte array for the purpose of
807 * MAC computations. */
808 uint8_t type; /* The record content type. */
809 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
810 * Convert to internal presentation of versions
811 * using mbedtls_ssl_read_version() and
812 * mbedtls_ssl_write_version().
813 * Keep wire-format for MAC computations. */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000814
Hanno Beckere84b28c2019-07-11 09:24:36 +0100815 unsigned char *buf; /* Memory buffer enclosing the record content */
816 size_t buf_len; /* Buffer length */
817 size_t data_offset; /* Offset of record content */
818 size_t data_len; /* Length of record content */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000819
Hanno Beckera5a2b082019-05-15 14:03:01 +0100820#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere84b28c2019-07-11 09:24:36 +0100821 uint8_t cid_len; /* Length of the CID (0 if not present) */
822 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100823#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000824} mbedtls_record;
825
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200826#if defined(MBEDTLS_X509_CRT_PARSE_C)
827/*
828 * List of certificate + private key pairs
829 */
830struct mbedtls_ssl_key_cert
831{
832 mbedtls_x509_crt *cert; /*!< cert */
833 mbedtls_pk_context *key; /*!< private key */
834 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
835};
836#endif /* MBEDTLS_X509_CRT_PARSE_C */
837
838#if defined(MBEDTLS_SSL_PROTO_DTLS)
839/*
840 * List of handshake messages kept around for resending
841 */
842struct mbedtls_ssl_flight_item
843{
844 unsigned char *p; /*!< message, including handshake headers */
845 size_t len; /*!< length of p */
846 unsigned char type; /*!< type of the message: handshake or CCS */
847 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
848};
849#endif /* MBEDTLS_SSL_PROTO_DTLS */
850
Hanno Becker7e5437a2017-04-28 17:15:26 +0100851#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
852 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
853
854/* Find an entry in a signature-hash set matching a given hash algorithm. */
855mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
856 mbedtls_pk_type_t sig_alg );
857/* Add a signature-hash-pair to a signature-hash set */
858void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
859 mbedtls_pk_type_t sig_alg,
860 mbedtls_md_type_t md_alg );
861/* Allow exactly one hash algorithm for each signature. */
862void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
863 mbedtls_md_type_t md_alg );
864
865/* Setup an empty signature-hash set */
866static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
867{
868 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
869}
870
871#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
872 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200873
874/**
875 * \brief Free referenced items in an SSL transform context and clear
876 * memory
877 *
878 * \param transform SSL transform context
879 */
880void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
881
882/**
883 * \brief Free referenced items in an SSL handshake context and clear
884 * memory
885 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200886 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200887 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200888void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200889
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200890int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
891int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
892void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
893
894int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
895
896void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
897int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
898
Simon Butcher99000142016-10-13 17:21:01 +0100899int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
900int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
901void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
902
Hanno Becker4a810fb2017-05-24 16:27:30 +0100903/**
904 * \brief Update record layer
905 *
906 * This function roughly separates the implementation
907 * of the logic of (D)TLS from the implementation
908 * of the secure transport.
909 *
Hanno Becker3a0aad12018-08-20 09:44:02 +0100910 * \param ssl The SSL context to use.
911 * \param update_hs_digest This indicates if the handshake digest
912 * should be automatically updated in case
913 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +0100914 *
915 * \return 0 or non-zero error code.
916 *
917 * \note A clarification on what is called 'record layer' here
918 * is in order, as many sensible definitions are possible:
919 *
920 * The record layer takes as input an untrusted underlying
921 * transport (stream or datagram) and transforms it into
922 * a serially multiplexed, secure transport, which
923 * conceptually provides the following:
924 *
925 * (1) Three datagram based, content-agnostic transports
926 * for handshake, alert and CCS messages.
927 * (2) One stream- or datagram-based transport
928 * for application data.
929 * (3) Functionality for changing the underlying transform
930 * securing the contents.
931 *
932 * The interface to this functionality is given as follows:
933 *
934 * a Updating
935 * [Currently implemented by mbedtls_ssl_read_record]
936 *
937 * Check if and on which of the four 'ports' data is pending:
938 * Nothing, a controlling datagram of type (1), or application
939 * data (2). In any case data is present, internal buffers
940 * provide access to the data for the user to process it.
941 * Consumption of type (1) datagrams is done automatically
942 * on the next update, invalidating that the internal buffers
943 * for previous datagrams, while consumption of application
944 * data (2) is user-controlled.
945 *
946 * b Reading of application data
947 * [Currently manual adaption of ssl->in_offt pointer]
948 *
949 * As mentioned in the last paragraph, consumption of data
950 * is different from the automatic consumption of control
951 * datagrams (1) because application data is treated as a stream.
952 *
953 * c Tracking availability of application data
954 * [Currently manually through decreasing ssl->in_msglen]
955 *
956 * For efficiency and to retain datagram semantics for
957 * application data in case of DTLS, the record layer
958 * provides functionality for checking how much application
959 * data is still available in the internal buffer.
960 *
961 * d Changing the transformation securing the communication.
962 *
963 * Given an opaque implementation of the record layer in the
964 * above sense, it should be possible to implement the logic
965 * of (D)TLS on top of it without the need to know anything
966 * about the record layer's internals. This is done e.g.
967 * in all the handshake handling functions, and in the
968 * application data reading function mbedtls_ssl_read.
969 *
970 * \note The above tries to give a conceptual picture of the
971 * record layer, but the current implementation deviates
972 * from it in some places. For example, our implementation of
973 * the update functionality through mbedtls_ssl_read_record
974 * discards datagrams depending on the current state, which
975 * wouldn't fall under the record layer's responsibility
976 * following the above definition.
977 *
978 */
Hanno Becker3a0aad12018-08-20 09:44:02 +0100979int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
980 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200981int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
982
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +0200983int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100984int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200985int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
986
987int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
988int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
989
990int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
991int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
992
993int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
994int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
995
996void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
Hanno Becker473f98f2019-06-26 10:27:32 +0100997 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200998
Hanno Becker09d23642019-07-22 17:18:18 +0100999int mbedtls_ssl_build_pms( mbedtls_ssl_context *ssl );
1000
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001001#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1002int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
1003#endif
1004
1005#if defined(MBEDTLS_PK_C)
1006unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001007unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001008mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1009#endif
1010
1011mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001012unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001013
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001014#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001015int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001016#endif
1017
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001018#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001019int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
1020 mbedtls_md_type_t md );
1021#endif
1022
Hanno Becker2881d802019-05-22 14:44:53 +01001023static inline int mbedtls_ssl_get_minor_ver( mbedtls_ssl_context const *ssl )
1024{
Hanno Becker381eaa52019-06-12 14:43:01 +01001025#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001026 return( ssl->minor_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001027#else /* !MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
1028 ((void) ssl);
1029 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
1030#endif /* MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001031}
1032
1033static inline int mbedtls_ssl_get_major_ver( mbedtls_ssl_context const *ssl )
1034{
Hanno Becker381eaa52019-06-12 14:43:01 +01001035#if !defined(MBEDTLS_SSL_CONF_FIXED_MAJOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001036 return( ssl->major_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001037#else /* !MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
1038 ((void) ssl);
1039 return( MBEDTLS_SSL_CONF_FIXED_MAJOR_VER );
1040#endif /* MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001041}
1042
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001043#if defined(MBEDTLS_X509_CRT_PARSE_C)
1044static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1045{
1046 mbedtls_ssl_key_cert *key_cert;
1047
1048 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1049 key_cert = ssl->handshake->key_cert;
1050 else
1051 key_cert = ssl->conf->key_cert;
1052
1053 return( key_cert == NULL ? NULL : key_cert->key );
1054}
1055
1056static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1057{
1058 mbedtls_ssl_key_cert *key_cert;
1059
1060 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1061 key_cert = ssl->handshake->key_cert;
1062 else
1063 key_cert = ssl->conf->key_cert;
1064
1065 return( key_cert == NULL ? NULL : key_cert->cert );
1066}
1067
1068/*
1069 * Check usage of a certificate wrt extensions:
1070 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1071 *
1072 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1073 * check a cert we received from them)!
1074 *
1075 * Return 0 if everything is OK, -1 if not.
1076 */
1077int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
Hanno Becker473f98f2019-06-26 10:27:32 +01001078 mbedtls_ssl_ciphersuite_handle_t ciphersuite,
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001079 int cert_endpoint,
1080 uint32_t *flags );
1081#endif /* MBEDTLS_X509_CRT_PARSE_C */
1082
Hanno Becker43395762019-05-03 14:46:38 +01001083static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001084{
Hanno Beckerf903dc82019-07-12 09:55:46 +01001085#if !defined(MBEDTLS_SSL_PROTO__BOTH)
1086 ((void) ssl);
1087#endif
1088
1089#if defined(MBEDTLS_SSL_PROTO_DTLS)
1090 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1091 {
1092 return( 13 );
1093 }
1094 MBEDTLS_SSL_TRANSPORT_ELSE
1095#endif /* MBEDTLS_SSL_PROTO_DTLS */
1096#if defined(MBEDTLS_SSL_PROTO_TLS)
1097 {
1098 return( 5 );
1099 }
1100#endif /* MBEDTLS_SSL_PROTO_TLS */
Hanno Becker43395762019-05-03 14:46:38 +01001101}
1102
1103static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1104{
Hanno Beckerccc24562019-05-03 15:05:27 +01001105 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001106}
1107
1108static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1109{
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001110#if !defined(MBEDTLS_SSL_PROTO__BOTH)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001111 ((void) ssl);
1112#endif
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001113
1114#if defined(MBEDTLS_SSL_PROTO_DTLS)
1115 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1116 return( 12 );
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001117 MBEDTLS_SSL_TRANSPORT_ELSE
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001118#endif
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001119#if defined(MBEDTLS_SSL_PROTO_TLS)
1120 return( 4 );
1121#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001122}
1123
1124#if defined(MBEDTLS_SSL_PROTO_DTLS)
1125void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1126void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1127int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001128int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001129#endif
1130
1131/* Visible for testing purposes only */
1132#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Beckerfc551722019-07-12 08:50:37 +01001133int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001134void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1135#endif
1136
Hanno Becker58fccf22019-02-06 14:30:46 +00001137int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1138 const mbedtls_ssl_session *src );
1139
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001140/* constant-time buffer comparison */
1141static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
1142{
1143 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +01001144 volatile const unsigned char *A = (volatile const unsigned char *) a;
1145 volatile const unsigned char *B = (volatile const unsigned char *) b;
1146 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001147
1148 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001149 {
1150 /* Read volatile data in order before computing diff.
1151 * This avoids IAR compiler warning:
1152 * 'the order of volatile accesses is undefined ..' */
1153 unsigned char x = A[i], y = B[i];
1154 diff |= x ^ y;
1155 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001156
1157 return( diff );
1158}
1159
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001160#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1161 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1162int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl,
1163 unsigned char *output,
1164 unsigned char *data, size_t data_len );
1165#endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \
1166 MBEDTLS_SSL_PROTO_TLS1_1 */
1167
1168#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1169 defined(MBEDTLS_SSL_PROTO_TLS1_2)
1170int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001171 unsigned char *hash, size_t *hashlen,
1172 unsigned char *data, size_t data_len,
1173 mbedtls_md_type_t md_alg );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001174#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1175 MBEDTLS_SSL_PROTO_TLS1_2 */
1176
Hanno Becker7b628e52019-06-12 14:45:11 +01001177/*
1178 * Convert version numbers to/from wire format
1179 * and, for DTLS, to/from TLS equivalent.
1180 *
1181 * For TLS this is the identity.
1182 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
1183 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
1184 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
1185 */
Hanno Becker8e7f23a2019-08-16 12:12:30 +01001186MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_write_version(
1187 int major, int minor, int transport, unsigned char ver[2] )
Hanno Becker7b628e52019-06-12 14:45:11 +01001188{
1189#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1190 ((void) transport);
1191#endif
1192
1193#if defined(MBEDTLS_SSL_PROTO_DTLS)
1194 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1195 {
1196 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
1197 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1198
1199 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
1200 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
1201 }
1202 MBEDTLS_SSL_TRANSPORT_ELSE
1203#endif
1204#if defined(MBEDTLS_SSL_PROTO_TLS)
1205 {
1206 ver[0] = (unsigned char) major;
1207 ver[1] = (unsigned char) minor;
1208 }
1209#endif
1210}
1211
Hanno Becker8e7f23a2019-08-16 12:12:30 +01001212MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_read_version(
1213 int *major, int *minor, int transport, const unsigned char ver[2] )
Hanno Becker7b628e52019-06-12 14:45:11 +01001214{
1215#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1216 ((void) transport);
1217#endif
1218
1219#if defined(MBEDTLS_SSL_PROTO_DTLS)
1220 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1221 {
1222 *major = 255 - ver[0] + 2;
1223 *minor = 255 - ver[1] + 1;
1224
1225 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
1226 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1227 }
1228 MBEDTLS_SSL_TRANSPORT_ELSE
1229#endif /* MBEDTLS_SSL_PROTO_DTLS */
1230#if defined(MBEDTLS_SSL_PROTO_TLS)
1231 {
1232 *major = ver[0];
1233 *minor = ver[1];
1234 }
1235#endif /* MBEDTLS_SSL_PROTO_TLS */
1236}
1237
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001238#ifdef __cplusplus
1239}
1240#endif
1241
Hanno Becker611a83b2018-01-03 14:27:32 +00001242void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1243int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1244 mbedtls_ssl_transform *transform,
1245 mbedtls_record *rec,
1246 int (*f_rng)(void *, unsigned char *, size_t),
1247 void *p_rng );
Hanno Becker40478be2019-07-12 08:23:59 +01001248int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Becker611a83b2018-01-03 14:27:32 +00001249 mbedtls_ssl_transform *transform,
1250 mbedtls_record *rec );
1251
Hanno Becker57e72c72019-06-12 12:46:31 +01001252
1253/*
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001254 * Accessor functions for optional fields of various structures
1255 */
1256
1257static inline int mbedtls_ssl_handshake_get_resume(
1258 const mbedtls_ssl_handshake_params *handshake )
1259{
1260#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
1261 return( handshake->resume );
1262#else
1263 (void) handshake;
1264 return( 0 );
1265#endif
1266}
1267
1268static inline int mbedtls_ssl_get_renego_status(
1269 const mbedtls_ssl_context *ssl )
1270{
1271#if defined(MBEDTLS_SSL_RENEGOTIATION)
1272 return( ssl->renego_status );
1273#else
1274 (void) ssl;
1275 return( MBEDTLS_SSL_INITIAL_HANDSHAKE );
1276#endif
1277}
1278
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001279static inline int mbedtls_ssl_conf_is_renegotiation_enabled(
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001280 const mbedtls_ssl_config *conf )
1281{
1282#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001283 return( conf->disable_renegotiation ==
1284 MBEDTLS_SSL_RENEGOTIATION_ENABLED );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001285#else
1286 (void) conf;
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001287 return( 0 );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001288#endif
1289}
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001290
1291/*
Hanno Becker57e72c72019-06-12 12:46:31 +01001292 * Getter functions for fields in mbedtls_ssl_config which may
1293 * be fixed at compile time via one of MBEDTLS_SSL_SSL_CONF_XXX.
1294 */
1295
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001296#if defined(MBEDTLS_SSL_SRV_C)
1297#if !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
1298static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1299 mbedtls_ssl_config const *conf )
1300{
1301 return( conf->cert_req_ca_list );
1302}
1303#else /* !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1304static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1305 mbedtls_ssl_config const *conf )
1306{
1307 ((void) conf);
1308 return( MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST );
1309}
1310#endif /* MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1311#endif /* MBEDTLS_SSL_SRV_C */
1312
Hanno Becker2d9623f2019-06-13 12:07:05 +01001313#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
1314static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1315 mbedtls_ssl_config const *conf )
1316{
1317 return( conf->endpoint );
1318}
1319#else /* !MBEDTLS_SSL_CONF_ENDPOINT */
1320static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1321 mbedtls_ssl_config const *conf )
1322{
1323 ((void) conf);
1324 return( MBEDTLS_SSL_CONF_ENDPOINT );
1325}
1326#endif /* MBEDTLS_SSL_CONF_ENDPOINT */
1327
Hanno Becker1f835fa2019-06-13 10:14:59 +01001328#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
1329static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1330 mbedtls_ssl_config const *conf )
1331{
1332 return( conf->read_timeout );
1333}
1334#else /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
1335static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1336 mbedtls_ssl_config const *conf )
1337{
1338 ((void) conf);
1339 return( MBEDTLS_SSL_CONF_READ_TIMEOUT );
1340}
1341#endif /* MBEDTLS_SSL_CONF_READ_TIMEOUT */
1342
1343#if defined(MBEDTLS_SSL_PROTO_DTLS)
1344#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN)
1345static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1346 mbedtls_ssl_config const *conf )
1347{
1348 return( conf->hs_timeout_min );
1349}
1350#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1351static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1352 mbedtls_ssl_config const *conf )
1353{
1354 ((void) conf);
1355 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN );
1356}
1357#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1358
1359#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX)
1360static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1361 mbedtls_ssl_config const *conf )
1362{
1363 return( conf->hs_timeout_max );
1364}
1365#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1366static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1367 mbedtls_ssl_config const *conf )
1368{
1369 ((void) conf);
1370 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX );
1371}
1372#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1373#endif /* MBEDTLS_SSL_PROTO_DTLS */
1374
Hanno Beckere0200da2019-06-13 09:23:43 +01001375#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1376#if !defined(MBEDTLS_SSL_CONF_CID_LEN)
1377static inline size_t mbedtls_ssl_conf_get_cid_len(
1378 mbedtls_ssl_config const *conf )
1379{
1380 return( conf->cid_len );
1381}
1382#else /* !MBEDTLS_SSL_CONF_CID_LEN */
1383static inline size_t mbedtls_ssl_conf_get_cid_len(
1384 mbedtls_ssl_config const *conf )
1385{
1386 ((void) conf);
1387 return( MBEDTLS_SSL_CONF_CID_LEN );
1388}
1389#endif /* MBEDTLS_SSL_CONF_CID_LEN */
1390
1391#if !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
1392static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1393 mbedtls_ssl_config const *conf )
1394{
1395 return( conf->ignore_unexpected_cid );
1396}
1397#else /* !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1398static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1399 mbedtls_ssl_config const *conf )
1400{
1401 ((void) conf);
1402 return( MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID );
1403}
1404#endif /* MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1405#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1406
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001407#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
1408static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1409 mbedtls_ssl_config const *conf )
1410{
1411 return( conf->allow_legacy_renegotiation );
1412}
1413#else /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1414static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1415 mbedtls_ssl_config const *conf )
1416{
1417 ((void) conf);
1418 return( MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION );
1419}
1420#endif /* MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1421
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001422#if !defined(MBEDTLS_SSL_CONF_AUTHMODE)
1423static inline int mbedtls_ssl_conf_get_authmode(
1424 mbedtls_ssl_config const *conf )
1425{
1426 return( conf->authmode );
1427}
1428#else /* !MBEDTLS_SSL_CONF_AUTHMODE */
1429static inline int mbedtls_ssl_conf_get_authmode(
1430 mbedtls_ssl_config const *conf )
1431{
1432 ((void) conf);
1433 return( MBEDTLS_SSL_CONF_AUTHMODE );
1434}
1435#endif /* MBEDTLS_SSL_CONF_AUTHMODE */
1436
Hanno Beckerde671542019-06-12 16:30:46 +01001437#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1438#if !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
1439static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1440 mbedtls_ssl_config const *conf )
1441{
1442 return( conf->badmac_limit );
1443}
1444#else /* !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1445static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1446 mbedtls_ssl_config const *conf )
1447{
1448 ((void) conf);
1449 return( MBEDTLS_SSL_CONF_BADMAC_LIMIT );
1450}
1451#endif /* MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1452#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1453
Hanno Becker7f376f42019-06-12 16:20:48 +01001454#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1455#if !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
1456static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1457 mbedtls_ssl_config const *conf )
1458{
1459 return( conf->anti_replay );
1460}
1461#else /* !MBEDTLS_SSL_CONF_ANTI_REPLAY */
1462static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1463 mbedtls_ssl_config const *conf )
1464{
1465 ((void) conf);
1466 return( MBEDTLS_SSL_CONF_ANTI_REPLAY );
1467}
1468#endif /* MBEDTLS_SSL_CONF_ANTI_REPLAY */
1469#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1470
Hanno Becker0ae6b242019-06-13 16:45:36 +01001471#if !defined(MBEDTLS_SSL_CONF_SET_TIMER)
1472static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1473 mbedtls_ssl_context const *ssl )
1474{
1475 return( ssl->f_set_timer );
1476}
1477#else /* !MBEDTLS_SSL_CONF_SET_TIMER */
1478
1479#define mbedtls_ssl_conf_set_timer_func MBEDTLS_SSL_CONF_SET_TIMER
1480extern void mbedtls_ssl_conf_set_timer_func( void*, uint32_t, uint32_t );
1481
1482static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1483 mbedtls_ssl_context const *ssl )
1484{
1485 ((void) ssl);
1486 return ((mbedtls_ssl_set_timer_t*) mbedtls_ssl_conf_set_timer_func);
1487}
1488#endif /* MBEDTLS_SSL_CONF_SET_TIMER */
1489
1490#if !defined(MBEDTLS_SSL_CONF_GET_TIMER)
1491static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1492 mbedtls_ssl_context const *ssl )
1493{
1494 return( ssl->f_get_timer );
1495}
1496#else /* !MBEDTLS_SSL_CONF_GET_TIMER */
1497
1498#define mbedtls_ssl_conf_get_timer_func MBEDTLS_SSL_CONF_GET_TIMER
1499extern int mbedtls_ssl_conf_get_timer_func( void* );
1500
1501static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1502 mbedtls_ssl_context const *ssl )
1503{
1504 ((void) ssl);
1505 return ((mbedtls_ssl_get_timer_t*) mbedtls_ssl_conf_get_timer_func);
1506}
1507#endif /* MBEDTLS_SSL_CONF_GET_TIMER */
1508
Hanno Beckera58a8962019-06-13 16:11:15 +01001509#if !defined(MBEDTLS_SSL_CONF_RECV)
1510static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1511 mbedtls_ssl_context const *ssl )
1512{
1513 return( ssl->f_recv );
1514}
1515#else /* !MBEDTLS_SSL_CONF_RECV */
1516
1517#define mbedtls_ssl_conf_recv_func MBEDTLS_SSL_CONF_RECV
1518extern int mbedtls_ssl_conf_recv_func( void*, unsigned char*, size_t );
1519
1520static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1521 mbedtls_ssl_context const *ssl )
1522{
1523 ((void) ssl);
1524 return ((mbedtls_ssl_recv_t*) mbedtls_ssl_conf_recv_func);
1525}
1526#endif /* MBEDTLS_SSL_CONF_RECV */
1527
1528#if !defined(MBEDTLS_SSL_CONF_SEND)
1529static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1530 mbedtls_ssl_context const *ssl )
1531{
1532 return( ssl->f_send );
1533}
1534#else /* !MBEDTLS_SSL_CONF_SEND */
1535
1536#define mbedtls_ssl_conf_send_func MBEDTLS_SSL_CONF_SEND
1537extern int mbedtls_ssl_conf_send_func( void*, unsigned char const*, size_t );
1538
1539static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1540 mbedtls_ssl_context const *ssl )
1541{
1542 ((void) ssl);
1543 return ((mbedtls_ssl_send_t*) mbedtls_ssl_conf_send_func);
1544}
1545#endif /* MBEDTLS_SSL_CONF_SEND */
1546
1547#if !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
1548static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1549 mbedtls_ssl_context const *ssl )
1550{
1551 return( ssl->f_recv_timeout );
1552}
1553#else /* !MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1554
1555#define mbedtls_ssl_conf_recv_timeout_func MBEDTLS_SSL_CONF_RECV_TIMEOUT
1556extern int mbedtls_ssl_conf_recv_timeout_func(
1557 void*, unsigned char*, size_t, uint32_t );
1558
1559static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1560 mbedtls_ssl_context const *ssl )
1561{
1562 ((void) ssl);
1563 return ((mbedtls_ssl_recv_timeout_t*) mbedtls_ssl_conf_recv_timeout_func);
1564}
1565#endif /* MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1566
1567typedef int mbedtls_frng_t( void*, unsigned char*, size_t );
1568
Hanno Beckerece325c2019-06-13 15:39:27 +01001569#if !defined(MBEDTLS_SSL_CONF_RNG)
Hanno Beckera58a8962019-06-13 16:11:15 +01001570static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001571 mbedtls_ssl_config const *conf )
1572{
1573 return( conf->f_rng );
1574}
Hanno Beckerece325c2019-06-13 15:39:27 +01001575
Hanno Becker572d4482019-07-23 13:47:53 +01001576static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1577{
1578 return( conf->p_rng );
1579}
1580#else /* !MBEDTLS_SSL_CONF_RNG */
Hanno Beckerece325c2019-06-13 15:39:27 +01001581#define mbedtls_ssl_conf_rng_func MBEDTLS_SSL_CONF_RNG
1582extern int mbedtls_ssl_conf_rng_func( void*, unsigned char*, size_t );
1583
Hanno Beckera58a8962019-06-13 16:11:15 +01001584static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001585 mbedtls_ssl_config const *conf )
1586{
1587 ((void) conf);
1588 return ((mbedtls_frng_t*) mbedtls_ssl_conf_rng_func);
1589}
Hanno Becker572d4482019-07-23 13:47:53 +01001590
1591static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1592{
1593 ((void) conf);
1594 return( NULL );
1595}
Hanno Beckerece325c2019-06-13 15:39:27 +01001596#endif /* MBEDTLS_SSL_CONF_RNG */
1597
Hanno Beckere965bd32019-06-12 14:04:34 +01001598static inline int mbedtls_ssl_conf_get_max_major_ver(
1599 mbedtls_ssl_config const *conf )
1600{
1601#if !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
1602 return( conf->max_major_ver );
1603#else
1604 ((void) conf);
1605 return( MBEDTLS_SSL_CONF_MAX_MAJOR_VER );
1606#endif /* MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
1607}
1608
1609static inline int mbedtls_ssl_conf_get_min_major_ver(
1610 mbedtls_ssl_config const *conf )
1611{
1612#if !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
1613 return( conf->min_major_ver );
1614#else /* !MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1615 ((void) conf);
1616 return( MBEDTLS_SSL_CONF_MIN_MAJOR_VER );
1617#endif /* MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1618}
1619
1620static inline int mbedtls_ssl_conf_get_max_minor_ver(
1621 mbedtls_ssl_config const *conf )
1622{
1623#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER)
1624 return( conf->max_minor_ver );
1625#else /* !MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1626 ((void) conf);
1627 return( MBEDTLS_SSL_CONF_MAX_MINOR_VER );
1628#endif /* MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1629}
1630
1631static inline int mbedtls_ssl_conf_get_min_minor_ver(
1632 mbedtls_ssl_config const *conf )
1633{
1634#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER)
1635 return( conf->min_minor_ver );
1636#else /* !MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1637 ((void) conf);
1638 return( MBEDTLS_SSL_CONF_MIN_MINOR_VER );
1639#endif /* MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1640}
1641
Hanno Becker57e72c72019-06-12 12:46:31 +01001642#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1643static inline unsigned int mbedtls_ssl_conf_get_ems(
1644 mbedtls_ssl_config const *conf )
1645{
1646#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
1647 return( conf->extended_ms );
1648#else
1649 ((void) conf);
1650 return( MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET );
1651#endif /* MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET */
1652}
1653
1654static inline unsigned int mbedtls_ssl_conf_get_ems_enforced(
1655 mbedtls_ssl_config const *conf )
1656{
1657#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
1658 return( conf->enforce_extended_master_secret );
1659#else
1660 ((void) conf);
1661 return( MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET );
1662#endif /* MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
1663}
1664#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1665
Hanno Becker14990272019-06-26 11:47:15 +01001666/*
1667 * Macros for the traversal of the list of all enabled ciphersuites.
1668 * This is implemented as a plain loop in case we have a runtime
1669 * configurable list of ciphersuites, and as a simple variable
1670 * instantiation in case a single ciphersuite is enabled at
1671 * compile-time.
1672 */
Hanno Becker73f4cb12019-06-27 13:51:07 +01001673#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker14990272019-06-26 11:47:15 +01001674
1675#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
1676 { \
1677 int const *__id_ptr; \
1678 for( __id_ptr=(ssl)->conf->ciphersuite_list[ (ver) ]; \
1679 *__id_ptr != 0; __id_ptr++ ) \
1680 { \
1681 const int __id = *__id_ptr; \
1682 mbedtls_ssl_ciphersuite_handle_t info; \
1683 info = mbedtls_ssl_ciphersuite_from_id( __id ); \
1684 if( info == MBEDTLS_SSL_CIPHERSUITE_INVALID_HANDLE ) \
1685 continue;
1686
1687#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
1688 } \
1689 }
1690
Hanno Becker73f4cb12019-06-27 13:51:07 +01001691#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001692
1693#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001694 do { \
Hanno Becker14990272019-06-26 11:47:15 +01001695 const mbedtls_ssl_ciphersuite_handle_t info = \
1696 MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE;
1697
1698#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001699 } while( 0 );
Hanno Becker14990272019-06-26 11:47:15 +01001700
Hanno Becker73f4cb12019-06-27 13:51:07 +01001701#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001702
Hanno Beckerc1096e72019-06-19 12:30:41 +01001703#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
1704
Hanno Becker7ae30262019-07-10 09:40:52 +01001705#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1706 { \
1707 mbedtls_ecp_group_id const *_gid; \
1708 mbedtls_ecp_curve_info const *_info; \
1709 for( _gid = ssl->conf->curve_list; \
1710 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
1711 { \
1712 uint16_t TLS_ID_VAR; \
1713 _info = mbedtls_ecp_curve_info_from_grp_id( *_gid ) ; \
1714 if( _info == NULL ) \
1715 continue; \
1716 TLS_ID_VAR = _info->tls_id;
Hanno Beckera4a9c692019-06-18 16:55:47 +01001717
1718#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1719 } \
1720 }
1721
1722#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1723 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001724 mbedtls_ecp_group_id const *_gid; \
1725 for( _gid = ssl->conf->curve_list; \
1726 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001727 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001728 mbedtls_ecp_group_id EC_ID_VAR = *_gid; \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001729
1730#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1731 } \
1732 }
1733
Hanno Beckerc1096e72019-06-19 12:30:41 +01001734#else /* !MBEDTLS_SSL_CONF_SINGLE_EC */
1735
1736#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1737 { \
1738 uint16_t TLS_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID; \
1739 ((void) ssl);
1740
1741#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1742 }
1743
1744#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1745 { \
1746 mbedtls_ecp_group_id EC_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID; \
1747 ((void) ssl);
1748
1749#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1750 }
1751
1752#endif /* MBEDTLS_SSL_CONF_SINGLE_EC */
1753
Hanno Becker56595f42019-06-19 16:31:38 +01001754#if !defined(MBEDTLS_SSL_CONF_SINGLE_SIG_HASH)
1755
Hanno Beckerf1bc9e12019-06-19 16:23:21 +01001756#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1757 { \
1758 int const *__md; \
1759 for( __md = ssl->conf->sig_hashes; \
1760 *__md != MBEDTLS_MD_NONE; __md++ ) \
1761 { \
1762 mbedtls_md_type_t MD_VAR = (mbedtls_md_type_t) *__md; \
1763
1764 #define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1765 } \
1766 }
1767
1768#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1769 { \
1770 int const *__md; \
1771 for( __md = ssl->conf->sig_hashes; \
1772 *__md != MBEDTLS_MD_NONE; __md++ ) \
1773 { \
1774 unsigned char HASH_VAR; \
1775 HASH_VAR = mbedtls_ssl_hash_from_md_alg( *__md );
1776
1777#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1778 } \
1779 }
1780
Hanno Becker56595f42019-06-19 16:31:38 +01001781#else /* !MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1782
1783#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1784 { \
1785 mbedtls_md_type_t MD_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID; \
1786 ((void) ssl);
1787
1788#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1789 }
1790
1791#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1792 { \
1793 unsigned char HASH_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID; \
1794 ((void) ssl);
1795
1796
1797#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1798 }
1799
1800#endif /* MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1801
Hanno Beckereeabfa42019-07-25 10:28:30 +01001802/* This internal function can be used to pend a fatal alert for
1803 * later delivery.
1804 *
Hanno Beckerb82350b2019-07-26 07:24:05 +01001805 * The check for pending alerts must be done by calling
Hanno Beckerdd691192019-07-26 09:59:18 +01001806 * the function ssl_send_pending_fatal_alert() in ssl_tls.c.
Hanno Beckerfcb721d2019-07-26 12:47:16 +01001807 * Currently, it happens only during the handshake loop and after
1808 * calling ssl_get_next_record() in the record processing stack.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001809 *
Hanno Beckerc8f52992019-07-25 11:15:08 +01001810 * This function must not be called multiple times without
Hanno Beckerb82350b2019-07-26 07:24:05 +01001811 * sending the pending fatal alerts in between.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001812 */
Hanno Beckerd829d0f2019-07-25 10:28:57 +01001813MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_pend_fatal_alert(
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001814 mbedtls_ssl_context *ssl,
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001815 unsigned char message )
1816{
Hanno Beckerc8f52992019-07-25 11:15:08 +01001817 ssl->pending_fatal_alert_msg = message;
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001818}
1819
Hanno Becker88440552019-07-03 14:16:13 +01001820/*
1821 * Getter functions for fields in SSL session.
1822 */
1823
1824static inline int mbedtls_ssl_session_get_compression(
1825 mbedtls_ssl_session const *session )
1826{
1827#if defined(MBEDTLS_ZLIB_SUPPORT)
1828 return( session->compression );
1829#else
1830 ( (void) session );
1831 return( MBEDTLS_SSL_COMPRESS_NULL );
1832#endif
1833}
1834
Hanno Becker84434912019-08-15 17:07:52 +01001835MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_update_checksum(
1836 mbedtls_ssl_context *ssl,
1837 const unsigned char *buf, size_t len )
1838{
1839#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1840 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1841 mbedtls_md5_update_ret( &ssl->handshake->fin_md5 , buf, len );
1842 mbedtls_sha1_update_ret( &ssl->handshake->fin_sha1, buf, len );
1843#endif
1844#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
1845#if defined(MBEDTLS_SHA256_C)
1846 mbedtls_sha256_update_ret( &ssl->handshake->fin_sha256, buf, len );
1847#endif
1848#if defined(MBEDTLS_SHA512_C)
1849 mbedtls_sha512_update_ret( &ssl->handshake->fin_sha512, buf, len );
1850#endif
1851#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
1852}
Hanno Becker8a4b5902019-08-15 17:04:57 +01001853
Hanno Becker2f41b242019-08-15 17:29:43 +01001854int mbedtls_ssl_calc_verify( int minor_ver,
1855 mbedtls_md_type_t hash,
1856 mbedtls_ssl_context const *ssl,
1857 unsigned char *dst,
1858 size_t *hlen );
1859
Hanno Becker868cb582019-07-23 14:29:13 +01001860#define MBEDTLS_SSL_CHK(f) do { if( ( ret = f ) < 0 ) goto cleanup; } while( 0 )
Hanno Becker5d397682018-05-21 12:50:34 +01001861
Hanno Becker75f12d12019-07-23 16:16:15 +01001862#if defined(MBEDTLS_USE_TINYCRYPT)
1863int mbedtls_ssl_ecdh_read_peerkey( mbedtls_ssl_context *ssl,
1864 unsigned char **p, unsigned char *end );
1865#endif /* MBEDTLS_USE_TINYCRYPT */
1866
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001867#endif /* ssl_internal.h */