blob: 0e95756260e2712967b03911c99ac19b49aa27a3 [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
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010061#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
62 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020063#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020064#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020065
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +020066/* The public option is negative for backwards compatibility,
67 * but internally a poisitive option is more convenient. */
68#if !defined(MBEDTLS_SSL_PROTO_NO_TLS)
69#define MBEDTLS_SSL_PROTO_TLS
70#endif
71
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020072/* Determine minimum supported version */
73#define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
74
75#if defined(MBEDTLS_SSL_PROTO_SSL3)
76#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
77#else
78#if defined(MBEDTLS_SSL_PROTO_TLS1)
79#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
80#else
81#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
82#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
83#else
84#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
85#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
86#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
87#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
88#endif /* MBEDTLS_SSL_PROTO_TLS1 */
89#endif /* MBEDTLS_SSL_PROTO_SSL3 */
90
Ron Eldor5e9f14d2017-05-28 10:46:38 +030091#define MBEDTLS_SSL_MIN_VALID_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
92#define MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
93
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020094/* Determine maximum supported version */
95#define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
96
97#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
98#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
99#else
100#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
101#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
102#else
103#if defined(MBEDTLS_SSL_PROTO_TLS1)
104#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
105#else
106#if defined(MBEDTLS_SSL_PROTO_SSL3)
107#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
108#endif /* MBEDTLS_SSL_PROTO_SSL3 */
109#endif /* MBEDTLS_SSL_PROTO_TLS1 */
110#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
111#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
112
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200113/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200114#if defined(MBEDTLS_ECP_RESTARTABLE) && \
115 defined(MBEDTLS_SSL_CLI_C) && \
116 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
117 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
118#define MBEDTLS_SSL__ECP_RESTARTABLE
119#endif
120
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200121#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
122#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
123#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
124#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
125
126/*
127 * DTLS retransmission states, see RFC 6347 4.2.4
128 *
129 * The SENDING state is merged in PREPARING for initial sends,
130 * but is distinct for resends.
131 *
132 * Note: initial state is wrong for server, but is not used anyway.
133 */
134#define MBEDTLS_SSL_RETRANS_PREPARING 0
135#define MBEDTLS_SSL_RETRANS_SENDING 1
136#define MBEDTLS_SSL_RETRANS_WAITING 2
137#define MBEDTLS_SSL_RETRANS_FINISHED 3
138
139/*
140 * Allow extra bytes for record, authentication and encryption overhead:
141 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256)
142 * and allow for a maximum of 1024 of compression expansion if
143 * enabled.
144 */
145#if defined(MBEDTLS_ZLIB_SUPPORT)
146#define MBEDTLS_SSL_COMPRESSION_ADD 1024
147#else
148#define MBEDTLS_SSL_COMPRESSION_ADD 0
149#endif
150
Hanno Becker5cc04d52018-01-03 15:24:20 +0000151#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
152 ( defined(MBEDTLS_CIPHER_MODE_CBC) && \
153 ( defined(MBEDTLS_AES_C) || \
154 defined(MBEDTLS_CAMELLIA_C) || \
Hanno Beckerb628a802018-07-17 10:19:47 +0100155 defined(MBEDTLS_ARIA_C) || \
156 defined(MBEDTLS_DES_C) ) )
Hanno Becker5cc04d52018-01-03 15:24:20 +0000157#define MBEDTLS_SSL_SOME_MODES_USE_MAC
158#endif
159
160#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200161/* Ciphersuites using HMAC */
162#if defined(MBEDTLS_SHA512_C)
163#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
164#elif defined(MBEDTLS_SHA256_C)
165#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
166#else
167#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
168#endif
Hanno Becker5cc04d52018-01-03 15:24:20 +0000169#else /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200170/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
171#define MBEDTLS_SSL_MAC_ADD 16
172#endif
173
174#if defined(MBEDTLS_CIPHER_MODE_CBC)
175#define MBEDTLS_SSL_PADDING_ADD 256
176#else
177#define MBEDTLS_SSL_PADDING_ADD 0
178#endif
179
Hanno Beckera5a2b082019-05-15 14:03:01 +0100180#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker550e1662019-05-08 17:37:58 +0100181#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_PADDING_GRANULARITY
Hanno Beckeradd01902019-05-08 15:40:11 +0100182#else
183#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
184#endif
185
Angus Grattond8213d02016-05-25 20:56:48 +1000186#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_SSL_COMPRESSION_ADD + \
187 MBEDTLS_MAX_IV_LENGTH + \
188 MBEDTLS_SSL_MAC_ADD + \
Hanno Beckeradd01902019-05-08 15:40:11 +0100189 MBEDTLS_SSL_PADDING_ADD + \
190 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000191 )
192
193#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
194 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
195
196#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
197 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
198
Hanno Becker0271f962018-08-16 13:23:47 +0100199/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100200#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100201
Angus Grattond8213d02016-05-25 20:56:48 +1000202/* Maximum length we can advertise as our max content length for
203 RFC 6066 max_fragment_length extension negotiation purposes
204 (the lesser of both sizes, if they are unequal.)
205 */
206#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
207 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
208 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
209 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
210 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200211
212/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100213 * Check that we obey the standard's message size bounds
214 */
215
216#if MBEDTLS_SSL_MAX_CONTENT_LEN > 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000217#error "Bad configuration - record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100218#endif
219
Angus Grattond8213d02016-05-25 20:56:48 +1000220#if MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
221#error "Bad configuration - incoming record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
Hanno Beckera8434e82017-09-18 10:54:39 +0100222#endif
223
Angus Grattond8213d02016-05-25 20:56:48 +1000224#if MBEDTLS_SSL_OUT_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
225#error "Bad configuration - outgoing record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
226#endif
227
228#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
229#error "Bad configuration - incoming protected record payload too large."
230#endif
231
232#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
233#error "Bad configuration - outgoing protected record payload too large."
234#endif
235
236/* Calculate buffer sizes */
237
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000238/* Note: Even though the TLS record header is only 5 bytes
239 long, we're internally using 8 bytes to store the
240 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100241#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100242
Hanno Beckera5a2b082019-05-15 14:03:01 +0100243#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000244#define MBEDTLS_SSL_IN_BUFFER_LEN \
245 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100246#else
247#define MBEDTLS_SSL_IN_BUFFER_LEN \
248 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
249 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
250#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000251
Hanno Beckera5a2b082019-05-15 14:03:01 +0100252#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000253#define MBEDTLS_SSL_OUT_BUFFER_LEN \
254 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100255#else
256#define MBEDTLS_SSL_OUT_BUFFER_LEN \
257 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
258 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
259#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000260
261#ifdef MBEDTLS_ZLIB_SUPPORT
262/* Compression buffer holds both IN and OUT buffers, so should be size of the larger */
263#define MBEDTLS_SSL_COMPRESS_BUFFER_LEN ( \
264 ( MBEDTLS_SSL_IN_BUFFER_LEN > MBEDTLS_SSL_OUT_BUFFER_LEN ) \
265 ? MBEDTLS_SSL_IN_BUFFER_LEN \
266 : MBEDTLS_SSL_OUT_BUFFER_LEN \
267 )
268#endif
Hanno Beckera8434e82017-09-18 10:54:39 +0100269
270/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200271 * TLS extension flags (for extensions with outgoing ServerHello content
272 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
273 * of state of the renegotiation flag, so no indicator is required)
274 */
275#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200276#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200277
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100278/*
279 * Helpers for code specific to TLS or DTLS.
280 *
281 * Goals for these helpers:
282 * - 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 +0200283 * - make the flow clear to the compiler, so that in TLS and DTLS combined
Manuel Pégourié-Gonnardec1c2222019-06-12 10:18:26 +0200284 * builds, when there are two branches, it knows exactly one of them is taken
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100285 * - preserve readability
286 *
287 * There are three macros:
288 * - MBEDTLS_SSL_TRANSPORT_IS_TLS( transport )
289 * - MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport )
290 * - MBEDTLS_SSL_TRANSPORT_ELSE
291 *
292 * The first two are macros rather than static inline functions because some
293 * compilers (eg arm-none-eabi-gcc 5.4.1 20160919) don't propagate constants
294 * well enough for us with static inline functions.
295 *
296 * Usage 1 (can replace DTLS with TLS):
297 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
298 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
299 * // DTLS-specific code
300 * #endif
301 *
302 * Usage 2 (can swap DTLS and TLS);
303 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
304 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
305 * // DTLS-specific code
306 * MBEDTLS_SSL_TRANSPORT_ELSE
307 * #endif
308 * #if defined(MBEDTLS_SSL_PROTO_TLS)
309 * // TLS-specific code
310 * #endif
311 */
312#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_PROTO_TLS) /* both */
Manuel Pégourié-Gonnard8794a422019-06-11 10:04:57 +0200313#define MBEDTLS_SSL_TRANSPORT__BOTH /* shortcut for future tests */
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100314#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) \
315 ( (transport) == MBEDTLS_SSL_TRANSPORT_STREAM )
316#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) \
317 ( (transport) == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
318#define MBEDTLS_SSL_TRANSPORT_ELSE else
319#elif defined(MBEDTLS_SSL_PROTO_DTLS) /* DTLS only */
320#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 0
321#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 1
322#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
323#else /* TLS only */
324#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 1
325#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 0
326#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
327#endif /* TLS and/or DTLS */
328
Hanno Becker3010d552019-06-11 14:46:16 +0100329/* Check if the use of the ExtendedMasterSecret extension
330 * is enforced at compile-time. If so, we don't need to
331 * track its status in the handshake parameters. */
332#if defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET) && \
333 defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET) && \
334 MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET == \
335 MBEDTLS_SSL_EXTENDED_MS_ENABLED && \
336 MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET == \
337 MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED
338#define MBEDTLS_SSL_EXTENDED_MS_ENFORCED
339#endif
340
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200341#ifdef __cplusplus
342extern "C" {
343#endif
344
Hanno Becker7e5437a2017-04-28 17:15:26 +0100345#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
346 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
347/*
348 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
349 */
350struct mbedtls_ssl_sig_hash_set_t
351{
352 /* At the moment, we only need to remember a single suitable
353 * hash algorithm per signature algorithm. As long as that's
354 * the case - and we don't need a general lookup function -
355 * we can implement the sig-hash-set as a map from signatures
356 * to hash algorithms. */
357 mbedtls_md_type_t rsa;
358 mbedtls_md_type_t ecdsa;
359};
360#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
361 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
362
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200363/*
364 * This structure contains the parameters only needed during handshake.
365 */
366struct mbedtls_ssl_handshake_params
367{
368 /*
369 * Handshake specific crypto variables
370 */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100371
372#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
373 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
374 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
375#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200376#if defined(MBEDTLS_DHM_C)
377 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
378#endif
379#if defined(MBEDTLS_ECDH_C)
380 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
381#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200382#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200383 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200384#if defined(MBEDTLS_SSL_CLI_C)
385 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
386 size_t ecjpake_cache_len; /*!< Length of cached data */
387#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100388#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Jarno Lamsae12aafb2019-04-04 18:32:56 +0300389#if defined(MBEDTLS_ECDH_C) || \
390 defined(MBEDTLS_ECDSA_C) || \
391 defined(MBEDTLS_USE_TINYCRYPT) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200392 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Hanno Becker004619f2019-06-18 16:07:32 +0100393 uint16_t curve_tls_id; /*!< TLS ID of EC for ECDHE. */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200394#endif
Jarno Lamsae12aafb2019-04-04 18:32:56 +0300395#if defined(MBEDTLS_USE_TINYCRYPT)
396 uint8_t ecdh_privkey[NUM_ECC_BYTES];
397 uint8_t ecdh_ownpubkey[2*NUM_ECC_BYTES];
398 uint8_t ecdh_peerkey[2*NUM_ECC_BYTES];
399#endif /* MBEDTLS_USE_TINYCRYPT */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200400#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
401 unsigned char *psk; /*!< PSK from the callback */
402 size_t psk_len; /*!< Length of PSK from callback */
403#endif
404#if defined(MBEDTLS_X509_CRT_PARSE_C)
405 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
406#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200407 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200408 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
409 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
410 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100411#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200412#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200413#if defined(MBEDTLS_SSL__ECP_RESTARTABLE)
Manuel Pégourié-Gonnardd27d1a52017-08-15 11:49:08 +0200414 int ecrs_enabled; /*!< Handshake supports EC restart? */
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200415 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200416 enum { /* this complements ssl->state with info on intra-state operations */
417 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
418 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
Manuel Pégourié-Gonnardc37423f2018-10-16 10:28:17 +0200419 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200420 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
421 } ecrs_state; /*!< current (or last) operation */
Hanno Beckerdd689312019-02-25 10:08:06 +0000422 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200423#endif
Hanno Becker3bf8cdf2019-02-06 16:18:31 +0000424#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
425 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
426 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
427#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200428#if defined(MBEDTLS_SSL_PROTO_DTLS)
429 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
430 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
431
432 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
433 Srv: unused */
434 unsigned char verify_cookie_len; /*!< Cli: cookie length
435 Srv: flag for sending a cookie */
436
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200437 uint32_t retransmit_timeout; /*!< Current value of timeout */
438 unsigned char retransmit_state; /*!< Retransmission state */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200439 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
440 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
441 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200442 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
443 flight being received */
444 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
445 resending messages */
446 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
447 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100448
Hanno Beckera5a2b082019-05-15 14:03:01 +0100449#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +0100450 /* The state of CID configuration in this handshake. */
451
452 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
Hanno Beckercfa6be72019-05-15 10:17:48 +0100453 * has been negotiated. Possible values are
Hanno Beckere5e7f622019-04-25 15:46:59 +0100454 * #MBEDTLS_SSL_CID_ENABLED and
455 * #MBEDTLS_SSL_CID_DISABLED. */
456 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
457 uint8_t peer_cid_len; /*!< The length of
458 * \c peer_cid. */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100460
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100461 struct
462 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100463 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
464 * buffers used for message buffering. */
465
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100466 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100467 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100468
Hanno Becker0271f962018-08-16 13:23:47 +0100469 struct mbedtls_ssl_hs_buffer
470 {
Hanno Becker98081a02018-08-22 13:32:50 +0100471 unsigned is_valid : 1;
472 unsigned is_fragmented : 1;
473 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100474 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100475 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100476 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
477
Hanno Becker5f066e72018-08-16 14:56:31 +0100478 struct
479 {
480 unsigned char *data;
481 size_t len;
482 unsigned epoch;
483 } future_record;
484
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100485 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100486
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200487 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100488#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200489
490 /*
491 * Checksum contexts
492 */
493#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
494 defined(MBEDTLS_SSL_PROTO_TLS1_1)
495 mbedtls_md5_context fin_md5;
496 mbedtls_sha1_context fin_sha1;
497#endif
498#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
499#if defined(MBEDTLS_SHA256_C)
500 mbedtls_sha256_context fin_sha256;
501#endif
502#if defined(MBEDTLS_SHA512_C)
503 mbedtls_sha512_context fin_sha512;
504#endif
505#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
506
507 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnarda5759752019-05-03 11:43:28 +0200508 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200509 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
510 int (*tls_prf)(const unsigned char *, size_t, const char *,
511 const unsigned char *, size_t,
512 unsigned char *, size_t);
513
Hanno Becker73f4cb12019-06-27 13:51:07 +0100514#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker473f98f2019-06-26 10:27:32 +0100515 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info;
Hanno Becker73f4cb12019-06-27 13:51:07 +0100516#endif /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker8759e162017-12-27 21:34:08 +0000517
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200518 size_t pmslen; /*!< premaster length */
519
520 unsigned char randbytes[64]; /*!< random bytes */
521 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
522 /*!< premaster secret */
523
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300524#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200525 int resume; /*!< session resume indicator*/
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300526#endif /* !MBEDTLS_SSL_NO_SESSION_RESUMPTION */
Hanno Becker18729ae2019-06-12 14:47:21 +0100527
528#if defined(MBEDTLS_SSL_SRV_C) && \
529 ( defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
530 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) )
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200531 int max_major_ver; /*!< max. major version client*/
532 int max_minor_ver; /*!< max. minor version client*/
Hanno Becker18729ae2019-06-12 14:47:21 +0100533#endif /* MBEDTLS_SSL_SRV_C && ( MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ||
534 MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200535 int cli_exts; /*!< client extension presence*/
536
537#if defined(MBEDTLS_SSL_SESSION_TICKETS)
538 int new_session_ticket; /*!< use NewSessionTicket? */
539#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Hanno Becker1ab322b2019-06-11 14:50:54 +0100540#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
541 !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200542 int extended_ms; /*!< use Extended Master Secret? */
543#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200544
545#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200546 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200547#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
548
549#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
550 /** Asynchronous operation context. This field is meant for use by the
551 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
552 * mbedtls_ssl_config::f_async_decrypt_start,
553 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
554 * The library does not use it internally. */
555 void *user_async_ctx;
556#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200557};
558
Hanno Beckera49ec562019-06-11 14:47:55 +0100559/*
560 * Getter functions for fields in mbedtls_ssl_handshake_params which
561 * may be statically implied by the configuration and hence be omitted
562 * from the structure.
563 */
564#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
565static inline int mbedtls_ssl_hs_get_extended_ms(
566 mbedtls_ssl_handshake_params const *params )
567{
568#if !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
569 return( params->extended_ms );
570#else
571 ((void) params);
572 return( MBEDTLS_SSL_EXTENDED_MS_ENABLED );
573#endif /* MBEDTLS_SSL_EXTENDED_MS_ENFORCED */
574}
575#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
576
Hanno Becker73f4cb12019-06-27 13:51:07 +0100577#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Beckerdf645962019-06-26 13:02:22 +0100578static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
579 mbedtls_ssl_handshake_params const *handshake )
580{
581 return( handshake->ciphersuite_info );
582}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100583#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100584static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
585 mbedtls_ssl_handshake_params const *handshake )
586{
587 ((void) handshake);
588 return( MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE );
589}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100590#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100591
Hanno Becker0271f962018-08-16 13:23:47 +0100592typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
593
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200594/*
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000595 * Representation of decryption/encryption transformations on records
596 *
597 * There are the following general types of record transformations:
598 * - Stream transformations (TLS versions <= 1.2 only)
599 * Transformation adding a MAC and applying a stream-cipher
600 * to the authenticated message.
601 * - CBC block cipher transformations ([D]TLS versions <= 1.2 only)
602 * In addition to the distinction of the order of encryption and
603 * authentication, there's a fundamental difference between the
604 * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3
605 * and TLS 1.0, the final IV after processing a record is used
606 * as the IV for the next record. No explicit IV is contained
607 * in an encrypted record. The IV for the first record is extracted
608 * at key extraction time. In contrast, for TLS 1.1 and 1.2, no
609 * IV is generated at key extraction time, but every encrypted
610 * record is explicitly prefixed by the IV with which it was encrypted.
611 * - AEAD transformations ([D]TLS versions >= 1.2 only)
612 * These come in two fundamentally different versions, the first one
613 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
614 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
615 * In the first transformation, the IV to be used for a record is obtained
616 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
617 * record sequence number, and explicitly prepending this sequence number
618 * to the encrypted record. In contrast, in the second transformation
619 * the IV is obtained by XOR'ing a static IV obtained at key extraction
620 * time with the 8-byte record sequence number, without prepending the
621 * latter to the encrypted record.
622 *
623 * In addition to type and version, the following parameters are relevant:
624 * - The symmetric cipher algorithm to be used.
625 * - The (static) encryption/decryption keys for the cipher.
626 * - For stream/CBC, the type of message digest to be used.
627 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Beckera198bb72018-10-18 15:39:53 +0100628 * - For AEAD transformations, the size (potentially 0) of an explicit,
629 * random initialization vector placed in encrypted records.
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000630 * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0)
631 * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC)
632 * and (if present) is combined with the explicit IV in a transformation-
633 * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
634 * - For stream/CBC, a flag determining the order of encryption and MAC.
635 * - The details of the transformation depend on the SSL/TLS version.
636 * - The length of the authentication tag.
637 *
Hanno Beckera198bb72018-10-18 15:39:53 +0100638 * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are
639 * constant across multiple encryption/decryption operations.
640 * For CBC, the implicit IV needs to be updated after each
641 * operation.
642 *
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000643 * The struct below refines this abstract view as follows:
644 * - The cipher underlying the transformation is managed in
645 * cipher contexts cipher_ctx_{enc/dec}, which must have the
646 * same cipher type. The mode of these cipher contexts determines
647 * the type of the transformation in the sense above: e.g., if
648 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
649 * then the transformation has type CBC resp. AEAD.
650 * - The cipher keys are never stored explicitly but
651 * are maintained within cipher_ctx_{enc/dec}.
652 * - For stream/CBC transformations, the message digest contexts
653 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
654 * are unused for AEAD transformations.
655 * - For stream/CBC transformations and versions > SSL3, the
656 * MAC keys are not stored explicitly but maintained within
657 * md_ctx_{enc/dec}.
658 * - For stream/CBC transformations and version SSL3, the MAC
659 * keys are stored explicitly in mac_enc, mac_dec and have
660 * a fixed size of 20 bytes. These fields are unused for
661 * AEAD transformations or transformations >= TLS 1.0.
662 * - For transformations using an implicit IV maintained within
663 * the transformation context, its contents are stored within
664 * iv_{enc/dec}.
665 * - The value of ivlen indicates the length of the IV.
666 * This is redundant in case of stream/CBC transformations
667 * which always use 0 resp. the cipher's block length as the
668 * IV length, but is needed for AEAD ciphers and may be
669 * different from the underlying cipher's block length
670 * in this case.
671 * - The field fixed_ivlen is nonzero for AEAD transformations only
672 * and indicates the length of the static part of the IV which is
673 * constant throughout the communication, and which is stored in
674 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
675 * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec}
676 * still store IV's for continued use across multiple transformations,
677 * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are
678 * not being used!
679 * - minor_ver denotes the SSL/TLS version
680 * - For stream/CBC transformations, maclen denotes the length of the
681 * authentication tag, while taglen is unused and 0.
682 * - For AEAD transformations, taglen denotes the length of the
683 * authentication tag, while maclen is unused and 0.
684 * - For CBC transformations, encrypt_then_mac determines the
685 * order of encryption and authentication. This field is unused
686 * in other transformations.
687 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200688 */
689struct mbedtls_ssl_transform
690{
691 /*
692 * Session specific crypto layer
693 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200694 size_t minlen; /*!< min. ciphertext length */
695 size_t ivlen; /*!< IV length */
696 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Becker8759e162017-12-27 21:34:08 +0000697 size_t maclen; /*!< MAC(CBC) len */
698 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200699
700 unsigned char iv_enc[16]; /*!< IV (encryption) */
701 unsigned char iv_dec[16]; /*!< IV (decryption) */
702
Hanno Becker92231322018-01-03 15:32:51 +0000703#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
704
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200705#if defined(MBEDTLS_SSL_PROTO_SSL3)
706 /* Needed only for SSL v3.0 secret */
707 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
708 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
709#endif /* MBEDTLS_SSL_PROTO_SSL3 */
710
711 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
712 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
713
Hanno Becker3307b532017-12-27 21:37:21 +0000714#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
715 int encrypt_then_mac; /*!< flag for EtM activation */
716#endif
717
Hanno Becker92231322018-01-03 15:32:51 +0000718#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
719
720 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
721 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Hanno Becker0a92b812019-06-24 15:46:40 +0100722
723#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker3307b532017-12-27 21:37:21 +0000724 int minor_ver;
Hanno Becker0a92b812019-06-24 15:46:40 +0100725#endif
Hanno Becker3307b532017-12-27 21:37:21 +0000726
Hanno Beckera5a2b082019-05-15 14:03:01 +0100727#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100728 uint8_t in_cid_len;
729 uint8_t out_cid_len;
730 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
731 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera5a2b082019-05-15 14:03:01 +0100732#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100733
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200734 /*
735 * Session specific compression layer
736 */
737#if defined(MBEDTLS_ZLIB_SUPPORT)
738 z_stream ctx_deflate; /*!< compression context */
739 z_stream ctx_inflate; /*!< decompression context */
740#endif
Manuel Pégourié-Gonnarda3024ee2019-07-09 12:54:17 +0200741
742#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
743 /* We need the Hello random bytes in order to re-derive keys from the
744 * Master Secret and other session info, see ssl_populate_transform() */
745 unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */
746#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200747};
748
Hanno Becker0a92b812019-06-24 15:46:40 +0100749static inline int mbedtls_ssl_transform_get_minor_ver( mbedtls_ssl_transform const *transform )
750{
751#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
752 return( transform->minor_ver );
753#else
754 ((void) transform);
755 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
756#endif
757}
758
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000759/*
Manuel Pégourié-Gonnard569ed6b2019-07-10 14:14:05 +0200760 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
761 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
762 */
763static inline int mbedtls_ssl_transform_uses_aead(
764 const mbedtls_ssl_transform *transform )
765{
766#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
767 return( transform->maclen == 0 && transform->taglen != 0 );
768#else
769 (void) transform;
770 return( 1 );
771#endif
772}
773
774/*
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000775 * Internal representation of record frames
776 *
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000777 * Instances come in two flavors:
778 * (1) Encrypted
779 * These always have data_offset = 0
780 * (2) Unencrypted
Hanno Beckerf8323432019-04-04 16:29:48 +0100781 * These have data_offset set to the amount of
782 * pre-expansion during record protection. Concretely,
783 * this is the length of the fixed part of the explicit IV
784 * used for encryption, or 0 if no explicit IV is used
785 * (e.g. for CBC in TLS 1.0, or stream ciphers).
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000786 *
787 * The reason for the data_offset in the unencrypted case
788 * is to allow for in-place conversion of an unencrypted to
789 * an encrypted record. If the offset wasn't included, the
790 * encrypted content would need to be shifted afterwards to
791 * make space for the fixed IV.
792 *
793 */
Hanno Becker80fe63e2019-04-29 13:45:54 +0100794#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100795#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100796#else
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100797#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100798#endif
799
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000800typedef struct
801{
Hanno Beckere84b28c2019-07-11 09:24:36 +0100802 uint8_t ctr[8]; /* In TLS: The implicit record sequence number.
803 * In DTLS: The 2-byte epoch followed by
804 * the 6-byte sequence number.
805 * This is stored as a raw big endian byte array
806 * as opposed to a uint64_t because we rarely
807 * need to perform arithmetic on this, but do
808 * need it as a Byte array for the purpose of
809 * MAC computations. */
810 uint8_t type; /* The record content type. */
811 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
812 * Convert to internal presentation of versions
813 * using mbedtls_ssl_read_version() and
814 * mbedtls_ssl_write_version().
815 * Keep wire-format for MAC computations. */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000816
Hanno Beckere84b28c2019-07-11 09:24:36 +0100817 unsigned char *buf; /* Memory buffer enclosing the record content */
818 size_t buf_len; /* Buffer length */
819 size_t data_offset; /* Offset of record content */
820 size_t data_len; /* Length of record content */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000821
Hanno Beckera5a2b082019-05-15 14:03:01 +0100822#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere84b28c2019-07-11 09:24:36 +0100823 uint8_t cid_len; /* Length of the CID (0 if not present) */
824 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100825#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000826} mbedtls_record;
827
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200828#if defined(MBEDTLS_X509_CRT_PARSE_C)
829/*
830 * List of certificate + private key pairs
831 */
832struct mbedtls_ssl_key_cert
833{
834 mbedtls_x509_crt *cert; /*!< cert */
835 mbedtls_pk_context *key; /*!< private key */
836 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
837};
838#endif /* MBEDTLS_X509_CRT_PARSE_C */
839
840#if defined(MBEDTLS_SSL_PROTO_DTLS)
841/*
842 * List of handshake messages kept around for resending
843 */
844struct mbedtls_ssl_flight_item
845{
846 unsigned char *p; /*!< message, including handshake headers */
847 size_t len; /*!< length of p */
848 unsigned char type; /*!< type of the message: handshake or CCS */
849 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
850};
851#endif /* MBEDTLS_SSL_PROTO_DTLS */
852
Hanno Becker7e5437a2017-04-28 17:15:26 +0100853#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
854 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
855
856/* Find an entry in a signature-hash set matching a given hash algorithm. */
857mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
858 mbedtls_pk_type_t sig_alg );
859/* Add a signature-hash-pair to a signature-hash set */
860void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
861 mbedtls_pk_type_t sig_alg,
862 mbedtls_md_type_t md_alg );
863/* Allow exactly one hash algorithm for each signature. */
864void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
865 mbedtls_md_type_t md_alg );
866
867/* Setup an empty signature-hash set */
868static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
869{
870 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
871}
872
873#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
874 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200875
876/**
877 * \brief Free referenced items in an SSL transform context and clear
878 * memory
879 *
880 * \param transform SSL transform context
881 */
882void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
883
884/**
885 * \brief Free referenced items in an SSL handshake context and clear
886 * memory
887 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200888 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200889 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200890void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200891
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200892int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
893int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
894void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
895
896int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
897
898void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
899int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
900
Simon Butcher99000142016-10-13 17:21:01 +0100901int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
902int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
903void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
904
Jarno Lamsae12aafb2019-04-04 18:32:56 +0300905#if defined(MBEDTLS_USE_TINYCRYPT)
906int mbetls_uecc_rng_wrapper( uint8_t *dest, unsigned int size );
907#endif
908
Hanno Becker4a810fb2017-05-24 16:27:30 +0100909/**
910 * \brief Update record layer
911 *
912 * This function roughly separates the implementation
913 * of the logic of (D)TLS from the implementation
914 * of the secure transport.
915 *
Hanno Becker3a0aad12018-08-20 09:44:02 +0100916 * \param ssl The SSL context to use.
917 * \param update_hs_digest This indicates if the handshake digest
918 * should be automatically updated in case
919 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +0100920 *
921 * \return 0 or non-zero error code.
922 *
923 * \note A clarification on what is called 'record layer' here
924 * is in order, as many sensible definitions are possible:
925 *
926 * The record layer takes as input an untrusted underlying
927 * transport (stream or datagram) and transforms it into
928 * a serially multiplexed, secure transport, which
929 * conceptually provides the following:
930 *
931 * (1) Three datagram based, content-agnostic transports
932 * for handshake, alert and CCS messages.
933 * (2) One stream- or datagram-based transport
934 * for application data.
935 * (3) Functionality for changing the underlying transform
936 * securing the contents.
937 *
938 * The interface to this functionality is given as follows:
939 *
940 * a Updating
941 * [Currently implemented by mbedtls_ssl_read_record]
942 *
943 * Check if and on which of the four 'ports' data is pending:
944 * Nothing, a controlling datagram of type (1), or application
945 * data (2). In any case data is present, internal buffers
946 * provide access to the data for the user to process it.
947 * Consumption of type (1) datagrams is done automatically
948 * on the next update, invalidating that the internal buffers
949 * for previous datagrams, while consumption of application
950 * data (2) is user-controlled.
951 *
952 * b Reading of application data
953 * [Currently manual adaption of ssl->in_offt pointer]
954 *
955 * As mentioned in the last paragraph, consumption of data
956 * is different from the automatic consumption of control
957 * datagrams (1) because application data is treated as a stream.
958 *
959 * c Tracking availability of application data
960 * [Currently manually through decreasing ssl->in_msglen]
961 *
962 * For efficiency and to retain datagram semantics for
963 * application data in case of DTLS, the record layer
964 * provides functionality for checking how much application
965 * data is still available in the internal buffer.
966 *
967 * d Changing the transformation securing the communication.
968 *
969 * Given an opaque implementation of the record layer in the
970 * above sense, it should be possible to implement the logic
971 * of (D)TLS on top of it without the need to know anything
972 * about the record layer's internals. This is done e.g.
973 * in all the handshake handling functions, and in the
974 * application data reading function mbedtls_ssl_read.
975 *
976 * \note The above tries to give a conceptual picture of the
977 * record layer, but the current implementation deviates
978 * from it in some places. For example, our implementation of
979 * the update functionality through mbedtls_ssl_read_record
980 * discards datagrams depending on the current state, which
981 * wouldn't fall under the record layer's responsibility
982 * following the above definition.
983 *
984 */
Hanno Becker3a0aad12018-08-20 09:44:02 +0100985int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
986 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200987int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
988
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +0200989int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100990int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200991int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
992
993int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
994int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
995
996int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
997int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
998
999int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
1000int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
1001
1002void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
Hanno Becker473f98f2019-06-26 10:27:32 +01001003 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001004
Hanno Becker09d23642019-07-22 17:18:18 +01001005int mbedtls_ssl_build_pms( mbedtls_ssl_context *ssl );
1006
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001007#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1008int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
1009#endif
1010
1011#if defined(MBEDTLS_PK_C)
1012unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +01001013unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001014mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1015#endif
1016
1017mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001018unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Simon Butcher99000142016-10-13 17:21:01 +01001019int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001020
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001021#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001022int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001023#endif
1024
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001025#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001026int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
1027 mbedtls_md_type_t md );
1028#endif
1029
Hanno Becker2881d802019-05-22 14:44:53 +01001030static inline int mbedtls_ssl_get_minor_ver( mbedtls_ssl_context const *ssl )
1031{
Hanno Becker381eaa52019-06-12 14:43:01 +01001032#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001033 return( ssl->minor_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001034#else /* !MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
1035 ((void) ssl);
1036 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
1037#endif /* MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001038}
1039
1040static inline int mbedtls_ssl_get_major_ver( mbedtls_ssl_context const *ssl )
1041{
Hanno Becker381eaa52019-06-12 14:43:01 +01001042#if !defined(MBEDTLS_SSL_CONF_FIXED_MAJOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001043 return( ssl->major_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001044#else /* !MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
1045 ((void) ssl);
1046 return( MBEDTLS_SSL_CONF_FIXED_MAJOR_VER );
1047#endif /* MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001048}
1049
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001050#if defined(MBEDTLS_X509_CRT_PARSE_C)
1051static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1052{
1053 mbedtls_ssl_key_cert *key_cert;
1054
1055 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1056 key_cert = ssl->handshake->key_cert;
1057 else
1058 key_cert = ssl->conf->key_cert;
1059
1060 return( key_cert == NULL ? NULL : key_cert->key );
1061}
1062
1063static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1064{
1065 mbedtls_ssl_key_cert *key_cert;
1066
1067 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1068 key_cert = ssl->handshake->key_cert;
1069 else
1070 key_cert = ssl->conf->key_cert;
1071
1072 return( key_cert == NULL ? NULL : key_cert->cert );
1073}
1074
1075/*
1076 * Check usage of a certificate wrt extensions:
1077 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1078 *
1079 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1080 * check a cert we received from them)!
1081 *
1082 * Return 0 if everything is OK, -1 if not.
1083 */
1084int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
Hanno Becker473f98f2019-06-26 10:27:32 +01001085 mbedtls_ssl_ciphersuite_handle_t ciphersuite,
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001086 int cert_endpoint,
1087 uint32_t *flags );
1088#endif /* MBEDTLS_X509_CRT_PARSE_C */
1089
Hanno Becker43395762019-05-03 14:46:38 +01001090static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001091{
Hanno Beckerf903dc82019-07-12 09:55:46 +01001092#if !defined(MBEDTLS_SSL_PROTO__BOTH)
1093 ((void) ssl);
1094#endif
1095
1096#if defined(MBEDTLS_SSL_PROTO_DTLS)
1097 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1098 {
1099 return( 13 );
1100 }
1101 MBEDTLS_SSL_TRANSPORT_ELSE
1102#endif /* MBEDTLS_SSL_PROTO_DTLS */
1103#if defined(MBEDTLS_SSL_PROTO_TLS)
1104 {
1105 return( 5 );
1106 }
1107#endif /* MBEDTLS_SSL_PROTO_TLS */
Hanno Becker43395762019-05-03 14:46:38 +01001108}
1109
1110static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1111{
Hanno Beckerccc24562019-05-03 15:05:27 +01001112 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001113}
1114
1115static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1116{
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001117#if !defined(MBEDTLS_SSL_PROTO__BOTH)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001118 ((void) ssl);
1119#endif
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001120
1121#if defined(MBEDTLS_SSL_PROTO_DTLS)
1122 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1123 return( 12 );
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001124 MBEDTLS_SSL_TRANSPORT_ELSE
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001125#endif
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001126#if defined(MBEDTLS_SSL_PROTO_TLS)
1127 return( 4 );
1128#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001129}
1130
1131#if defined(MBEDTLS_SSL_PROTO_DTLS)
1132void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1133void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1134int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001135int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001136#endif
1137
1138/* Visible for testing purposes only */
1139#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Beckerfc551722019-07-12 08:50:37 +01001140int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001141void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1142#endif
1143
Hanno Becker58fccf22019-02-06 14:30:46 +00001144int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1145 const mbedtls_ssl_session *src );
1146
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001147/* constant-time buffer comparison */
1148static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
1149{
1150 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +01001151 volatile const unsigned char *A = (volatile const unsigned char *) a;
1152 volatile const unsigned char *B = (volatile const unsigned char *) b;
1153 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001154
1155 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001156 {
1157 /* Read volatile data in order before computing diff.
1158 * This avoids IAR compiler warning:
1159 * 'the order of volatile accesses is undefined ..' */
1160 unsigned char x = A[i], y = B[i];
1161 diff |= x ^ y;
1162 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001163
1164 return( diff );
1165}
1166
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001167#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1168 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1169int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl,
1170 unsigned char *output,
1171 unsigned char *data, size_t data_len );
1172#endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \
1173 MBEDTLS_SSL_PROTO_TLS1_1 */
1174
1175#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1176 defined(MBEDTLS_SSL_PROTO_TLS1_2)
1177int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001178 unsigned char *hash, size_t *hashlen,
1179 unsigned char *data, size_t data_len,
1180 mbedtls_md_type_t md_alg );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001181#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1182 MBEDTLS_SSL_PROTO_TLS1_2 */
1183
Hanno Becker7b628e52019-06-12 14:45:11 +01001184/*
1185 * Convert version numbers to/from wire format
1186 * and, for DTLS, to/from TLS equivalent.
1187 *
1188 * For TLS this is the identity.
1189 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
1190 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
1191 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
1192 */
1193static inline void mbedtls_ssl_write_version( int major, int minor,
1194 int transport,
1195 unsigned char ver[2] )
1196{
1197#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1198 ((void) transport);
1199#endif
1200
1201#if defined(MBEDTLS_SSL_PROTO_DTLS)
1202 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1203 {
1204 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
1205 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1206
1207 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
1208 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
1209 }
1210 MBEDTLS_SSL_TRANSPORT_ELSE
1211#endif
1212#if defined(MBEDTLS_SSL_PROTO_TLS)
1213 {
1214 ver[0] = (unsigned char) major;
1215 ver[1] = (unsigned char) minor;
1216 }
1217#endif
1218}
1219
1220static inline void mbedtls_ssl_read_version( int *major, int *minor,
1221 int transport,
1222 const unsigned char ver[2] )
1223{
1224#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1225 ((void) transport);
1226#endif
1227
1228#if defined(MBEDTLS_SSL_PROTO_DTLS)
1229 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1230 {
1231 *major = 255 - ver[0] + 2;
1232 *minor = 255 - ver[1] + 1;
1233
1234 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
1235 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1236 }
1237 MBEDTLS_SSL_TRANSPORT_ELSE
1238#endif /* MBEDTLS_SSL_PROTO_DTLS */
1239#if defined(MBEDTLS_SSL_PROTO_TLS)
1240 {
1241 *major = ver[0];
1242 *minor = ver[1];
1243 }
1244#endif /* MBEDTLS_SSL_PROTO_TLS */
1245}
1246
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001247#ifdef __cplusplus
1248}
1249#endif
1250
Hanno Becker611a83b2018-01-03 14:27:32 +00001251void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1252int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1253 mbedtls_ssl_transform *transform,
1254 mbedtls_record *rec,
1255 int (*f_rng)(void *, unsigned char *, size_t),
1256 void *p_rng );
Hanno Becker40478be2019-07-12 08:23:59 +01001257int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Becker611a83b2018-01-03 14:27:32 +00001258 mbedtls_ssl_transform *transform,
1259 mbedtls_record *rec );
1260
Hanno Becker57e72c72019-06-12 12:46:31 +01001261
1262/*
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001263 * Accessor functions for optional fields of various structures
1264 */
1265
1266static inline int mbedtls_ssl_handshake_get_resume(
1267 const mbedtls_ssl_handshake_params *handshake )
1268{
1269#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
1270 return( handshake->resume );
1271#else
1272 (void) handshake;
1273 return( 0 );
1274#endif
1275}
1276
1277static inline int mbedtls_ssl_get_renego_status(
1278 const mbedtls_ssl_context *ssl )
1279{
1280#if defined(MBEDTLS_SSL_RENEGOTIATION)
1281 return( ssl->renego_status );
1282#else
1283 (void) ssl;
1284 return( MBEDTLS_SSL_INITIAL_HANDSHAKE );
1285#endif
1286}
1287
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001288static inline int mbedtls_ssl_conf_is_renegotiation_enabled(
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001289 const mbedtls_ssl_config *conf )
1290{
1291#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001292 return( conf->disable_renegotiation ==
1293 MBEDTLS_SSL_RENEGOTIATION_ENABLED );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001294#else
1295 (void) conf;
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001296 return( 0 );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001297#endif
1298}
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001299
1300/*
Hanno Becker57e72c72019-06-12 12:46:31 +01001301 * Getter functions for fields in mbedtls_ssl_config which may
1302 * be fixed at compile time via one of MBEDTLS_SSL_SSL_CONF_XXX.
1303 */
1304
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001305#if defined(MBEDTLS_SSL_SRV_C)
1306#if !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
1307static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1308 mbedtls_ssl_config const *conf )
1309{
1310 return( conf->cert_req_ca_list );
1311}
1312#else /* !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1313static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1314 mbedtls_ssl_config const *conf )
1315{
1316 ((void) conf);
1317 return( MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST );
1318}
1319#endif /* MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1320#endif /* MBEDTLS_SSL_SRV_C */
1321
Hanno Becker2d9623f2019-06-13 12:07:05 +01001322#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
1323static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1324 mbedtls_ssl_config const *conf )
1325{
1326 return( conf->endpoint );
1327}
1328#else /* !MBEDTLS_SSL_CONF_ENDPOINT */
1329static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1330 mbedtls_ssl_config const *conf )
1331{
1332 ((void) conf);
1333 return( MBEDTLS_SSL_CONF_ENDPOINT );
1334}
1335#endif /* MBEDTLS_SSL_CONF_ENDPOINT */
1336
Hanno Becker1f835fa2019-06-13 10:14:59 +01001337#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
1338static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1339 mbedtls_ssl_config const *conf )
1340{
1341 return( conf->read_timeout );
1342}
1343#else /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
1344static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1345 mbedtls_ssl_config const *conf )
1346{
1347 ((void) conf);
1348 return( MBEDTLS_SSL_CONF_READ_TIMEOUT );
1349}
1350#endif /* MBEDTLS_SSL_CONF_READ_TIMEOUT */
1351
1352#if defined(MBEDTLS_SSL_PROTO_DTLS)
1353#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN)
1354static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1355 mbedtls_ssl_config const *conf )
1356{
1357 return( conf->hs_timeout_min );
1358}
1359#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1360static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1361 mbedtls_ssl_config const *conf )
1362{
1363 ((void) conf);
1364 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN );
1365}
1366#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1367
1368#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX)
1369static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1370 mbedtls_ssl_config const *conf )
1371{
1372 return( conf->hs_timeout_max );
1373}
1374#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1375static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1376 mbedtls_ssl_config const *conf )
1377{
1378 ((void) conf);
1379 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX );
1380}
1381#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1382#endif /* MBEDTLS_SSL_PROTO_DTLS */
1383
Hanno Beckere0200da2019-06-13 09:23:43 +01001384#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1385#if !defined(MBEDTLS_SSL_CONF_CID_LEN)
1386static inline size_t mbedtls_ssl_conf_get_cid_len(
1387 mbedtls_ssl_config const *conf )
1388{
1389 return( conf->cid_len );
1390}
1391#else /* !MBEDTLS_SSL_CONF_CID_LEN */
1392static inline size_t mbedtls_ssl_conf_get_cid_len(
1393 mbedtls_ssl_config const *conf )
1394{
1395 ((void) conf);
1396 return( MBEDTLS_SSL_CONF_CID_LEN );
1397}
1398#endif /* MBEDTLS_SSL_CONF_CID_LEN */
1399
1400#if !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
1401static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1402 mbedtls_ssl_config const *conf )
1403{
1404 return( conf->ignore_unexpected_cid );
1405}
1406#else /* !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1407static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1408 mbedtls_ssl_config const *conf )
1409{
1410 ((void) conf);
1411 return( MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID );
1412}
1413#endif /* MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1414#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1415
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001416#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
1417static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1418 mbedtls_ssl_config const *conf )
1419{
1420 return( conf->allow_legacy_renegotiation );
1421}
1422#else /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1423static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1424 mbedtls_ssl_config const *conf )
1425{
1426 ((void) conf);
1427 return( MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION );
1428}
1429#endif /* MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1430
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001431#if !defined(MBEDTLS_SSL_CONF_AUTHMODE)
1432static inline int mbedtls_ssl_conf_get_authmode(
1433 mbedtls_ssl_config const *conf )
1434{
1435 return( conf->authmode );
1436}
1437#else /* !MBEDTLS_SSL_CONF_AUTHMODE */
1438static inline int mbedtls_ssl_conf_get_authmode(
1439 mbedtls_ssl_config const *conf )
1440{
1441 ((void) conf);
1442 return( MBEDTLS_SSL_CONF_AUTHMODE );
1443}
1444#endif /* MBEDTLS_SSL_CONF_AUTHMODE */
1445
Hanno Beckerde671542019-06-12 16:30:46 +01001446#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1447#if !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
1448static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1449 mbedtls_ssl_config const *conf )
1450{
1451 return( conf->badmac_limit );
1452}
1453#else /* !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1454static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1455 mbedtls_ssl_config const *conf )
1456{
1457 ((void) conf);
1458 return( MBEDTLS_SSL_CONF_BADMAC_LIMIT );
1459}
1460#endif /* MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1461#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1462
Hanno Becker7f376f42019-06-12 16:20:48 +01001463#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1464#if !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
1465static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1466 mbedtls_ssl_config const *conf )
1467{
1468 return( conf->anti_replay );
1469}
1470#else /* !MBEDTLS_SSL_CONF_ANTI_REPLAY */
1471static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1472 mbedtls_ssl_config const *conf )
1473{
1474 ((void) conf);
1475 return( MBEDTLS_SSL_CONF_ANTI_REPLAY );
1476}
1477#endif /* MBEDTLS_SSL_CONF_ANTI_REPLAY */
1478#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1479
Hanno Becker0ae6b242019-06-13 16:45:36 +01001480#if !defined(MBEDTLS_SSL_CONF_SET_TIMER)
1481static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1482 mbedtls_ssl_context const *ssl )
1483{
1484 return( ssl->f_set_timer );
1485}
1486#else /* !MBEDTLS_SSL_CONF_SET_TIMER */
1487
1488#define mbedtls_ssl_conf_set_timer_func MBEDTLS_SSL_CONF_SET_TIMER
1489extern void mbedtls_ssl_conf_set_timer_func( void*, uint32_t, uint32_t );
1490
1491static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1492 mbedtls_ssl_context const *ssl )
1493{
1494 ((void) ssl);
1495 return ((mbedtls_ssl_set_timer_t*) mbedtls_ssl_conf_set_timer_func);
1496}
1497#endif /* MBEDTLS_SSL_CONF_SET_TIMER */
1498
1499#if !defined(MBEDTLS_SSL_CONF_GET_TIMER)
1500static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1501 mbedtls_ssl_context const *ssl )
1502{
1503 return( ssl->f_get_timer );
1504}
1505#else /* !MBEDTLS_SSL_CONF_GET_TIMER */
1506
1507#define mbedtls_ssl_conf_get_timer_func MBEDTLS_SSL_CONF_GET_TIMER
1508extern int mbedtls_ssl_conf_get_timer_func( void* );
1509
1510static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1511 mbedtls_ssl_context const *ssl )
1512{
1513 ((void) ssl);
1514 return ((mbedtls_ssl_get_timer_t*) mbedtls_ssl_conf_get_timer_func);
1515}
1516#endif /* MBEDTLS_SSL_CONF_GET_TIMER */
1517
Hanno Beckera58a8962019-06-13 16:11:15 +01001518#if !defined(MBEDTLS_SSL_CONF_RECV)
1519static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1520 mbedtls_ssl_context const *ssl )
1521{
1522 return( ssl->f_recv );
1523}
1524#else /* !MBEDTLS_SSL_CONF_RECV */
1525
1526#define mbedtls_ssl_conf_recv_func MBEDTLS_SSL_CONF_RECV
1527extern int mbedtls_ssl_conf_recv_func( void*, unsigned char*, size_t );
1528
1529static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1530 mbedtls_ssl_context const *ssl )
1531{
1532 ((void) ssl);
1533 return ((mbedtls_ssl_recv_t*) mbedtls_ssl_conf_recv_func);
1534}
1535#endif /* MBEDTLS_SSL_CONF_RECV */
1536
1537#if !defined(MBEDTLS_SSL_CONF_SEND)
1538static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1539 mbedtls_ssl_context const *ssl )
1540{
1541 return( ssl->f_send );
1542}
1543#else /* !MBEDTLS_SSL_CONF_SEND */
1544
1545#define mbedtls_ssl_conf_send_func MBEDTLS_SSL_CONF_SEND
1546extern int mbedtls_ssl_conf_send_func( void*, unsigned char const*, size_t );
1547
1548static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1549 mbedtls_ssl_context const *ssl )
1550{
1551 ((void) ssl);
1552 return ((mbedtls_ssl_send_t*) mbedtls_ssl_conf_send_func);
1553}
1554#endif /* MBEDTLS_SSL_CONF_SEND */
1555
1556#if !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
1557static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1558 mbedtls_ssl_context const *ssl )
1559{
1560 return( ssl->f_recv_timeout );
1561}
1562#else /* !MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1563
1564#define mbedtls_ssl_conf_recv_timeout_func MBEDTLS_SSL_CONF_RECV_TIMEOUT
1565extern int mbedtls_ssl_conf_recv_timeout_func(
1566 void*, unsigned char*, size_t, uint32_t );
1567
1568static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1569 mbedtls_ssl_context const *ssl )
1570{
1571 ((void) ssl);
1572 return ((mbedtls_ssl_recv_timeout_t*) mbedtls_ssl_conf_recv_timeout_func);
1573}
1574#endif /* MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1575
1576typedef int mbedtls_frng_t( void*, unsigned char*, size_t );
1577
Hanno Beckerece325c2019-06-13 15:39:27 +01001578#if !defined(MBEDTLS_SSL_CONF_RNG)
Hanno Beckera58a8962019-06-13 16:11:15 +01001579static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001580 mbedtls_ssl_config const *conf )
1581{
1582 return( conf->f_rng );
1583}
Hanno Beckerece325c2019-06-13 15:39:27 +01001584
Hanno Becker572d4482019-07-23 13:47:53 +01001585static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1586{
1587 return( conf->p_rng );
1588}
1589#else /* !MBEDTLS_SSL_CONF_RNG */
Hanno Beckerece325c2019-06-13 15:39:27 +01001590#define mbedtls_ssl_conf_rng_func MBEDTLS_SSL_CONF_RNG
1591extern int mbedtls_ssl_conf_rng_func( void*, unsigned char*, size_t );
1592
Hanno Beckera58a8962019-06-13 16:11:15 +01001593static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001594 mbedtls_ssl_config const *conf )
1595{
1596 ((void) conf);
1597 return ((mbedtls_frng_t*) mbedtls_ssl_conf_rng_func);
1598}
Hanno Becker572d4482019-07-23 13:47:53 +01001599
1600static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1601{
1602 ((void) conf);
1603 return( NULL );
1604}
Hanno Beckerece325c2019-06-13 15:39:27 +01001605#endif /* MBEDTLS_SSL_CONF_RNG */
1606
Hanno Beckere965bd32019-06-12 14:04:34 +01001607static inline int mbedtls_ssl_conf_get_max_major_ver(
1608 mbedtls_ssl_config const *conf )
1609{
1610#if !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
1611 return( conf->max_major_ver );
1612#else
1613 ((void) conf);
1614 return( MBEDTLS_SSL_CONF_MAX_MAJOR_VER );
1615#endif /* MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
1616}
1617
1618static inline int mbedtls_ssl_conf_get_min_major_ver(
1619 mbedtls_ssl_config const *conf )
1620{
1621#if !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
1622 return( conf->min_major_ver );
1623#else /* !MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1624 ((void) conf);
1625 return( MBEDTLS_SSL_CONF_MIN_MAJOR_VER );
1626#endif /* MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1627}
1628
1629static inline int mbedtls_ssl_conf_get_max_minor_ver(
1630 mbedtls_ssl_config const *conf )
1631{
1632#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER)
1633 return( conf->max_minor_ver );
1634#else /* !MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1635 ((void) conf);
1636 return( MBEDTLS_SSL_CONF_MAX_MINOR_VER );
1637#endif /* MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1638}
1639
1640static inline int mbedtls_ssl_conf_get_min_minor_ver(
1641 mbedtls_ssl_config const *conf )
1642{
1643#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER)
1644 return( conf->min_minor_ver );
1645#else /* !MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1646 ((void) conf);
1647 return( MBEDTLS_SSL_CONF_MIN_MINOR_VER );
1648#endif /* MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1649}
1650
Hanno Becker57e72c72019-06-12 12:46:31 +01001651#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1652static inline unsigned int mbedtls_ssl_conf_get_ems(
1653 mbedtls_ssl_config const *conf )
1654{
1655#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
1656 return( conf->extended_ms );
1657#else
1658 ((void) conf);
1659 return( MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET );
1660#endif /* MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET */
1661}
1662
1663static inline unsigned int mbedtls_ssl_conf_get_ems_enforced(
1664 mbedtls_ssl_config const *conf )
1665{
1666#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
1667 return( conf->enforce_extended_master_secret );
1668#else
1669 ((void) conf);
1670 return( MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET );
1671#endif /* MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
1672}
1673#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1674
Hanno Becker14990272019-06-26 11:47:15 +01001675/*
1676 * Macros for the traversal of the list of all enabled ciphersuites.
1677 * This is implemented as a plain loop in case we have a runtime
1678 * configurable list of ciphersuites, and as a simple variable
1679 * instantiation in case a single ciphersuite is enabled at
1680 * compile-time.
1681 */
Hanno Becker73f4cb12019-06-27 13:51:07 +01001682#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker14990272019-06-26 11:47:15 +01001683
1684#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
1685 { \
1686 int const *__id_ptr; \
1687 for( __id_ptr=(ssl)->conf->ciphersuite_list[ (ver) ]; \
1688 *__id_ptr != 0; __id_ptr++ ) \
1689 { \
1690 const int __id = *__id_ptr; \
1691 mbedtls_ssl_ciphersuite_handle_t info; \
1692 info = mbedtls_ssl_ciphersuite_from_id( __id ); \
1693 if( info == MBEDTLS_SSL_CIPHERSUITE_INVALID_HANDLE ) \
1694 continue;
1695
1696#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
1697 } \
1698 }
1699
Hanno Becker73f4cb12019-06-27 13:51:07 +01001700#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001701
1702#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001703 do { \
Hanno Becker14990272019-06-26 11:47:15 +01001704 const mbedtls_ssl_ciphersuite_handle_t info = \
1705 MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE;
1706
1707#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001708 } while( 0 );
Hanno Becker14990272019-06-26 11:47:15 +01001709
Hanno Becker73f4cb12019-06-27 13:51:07 +01001710#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001711
Hanno Beckerc1096e72019-06-19 12:30:41 +01001712#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
1713
Hanno Becker7ae30262019-07-10 09:40:52 +01001714#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1715 { \
1716 mbedtls_ecp_group_id const *_gid; \
1717 mbedtls_ecp_curve_info const *_info; \
1718 for( _gid = ssl->conf->curve_list; \
1719 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
1720 { \
1721 uint16_t TLS_ID_VAR; \
1722 _info = mbedtls_ecp_curve_info_from_grp_id( *_gid ) ; \
1723 if( _info == NULL ) \
1724 continue; \
1725 TLS_ID_VAR = _info->tls_id;
Hanno Beckera4a9c692019-06-18 16:55:47 +01001726
1727#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1728 } \
1729 }
1730
1731#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1732 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001733 mbedtls_ecp_group_id const *_gid; \
1734 for( _gid = ssl->conf->curve_list; \
1735 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001736 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001737 mbedtls_ecp_group_id EC_ID_VAR = *_gid; \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001738
1739#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1740 } \
1741 }
1742
Hanno Beckerc1096e72019-06-19 12:30:41 +01001743#else /* !MBEDTLS_SSL_CONF_SINGLE_EC */
1744
1745#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1746 { \
1747 uint16_t TLS_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID; \
1748 ((void) ssl);
1749
1750#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1751 }
1752
1753#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1754 { \
1755 mbedtls_ecp_group_id EC_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID; \
1756 ((void) ssl);
1757
1758#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1759 }
1760
1761#endif /* MBEDTLS_SSL_CONF_SINGLE_EC */
1762
Hanno Becker56595f42019-06-19 16:31:38 +01001763#if !defined(MBEDTLS_SSL_CONF_SINGLE_SIG_HASH)
1764
Hanno Beckerf1bc9e12019-06-19 16:23:21 +01001765#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1766 { \
1767 int const *__md; \
1768 for( __md = ssl->conf->sig_hashes; \
1769 *__md != MBEDTLS_MD_NONE; __md++ ) \
1770 { \
1771 mbedtls_md_type_t MD_VAR = (mbedtls_md_type_t) *__md; \
1772
1773 #define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1774 } \
1775 }
1776
1777#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1778 { \
1779 int const *__md; \
1780 for( __md = ssl->conf->sig_hashes; \
1781 *__md != MBEDTLS_MD_NONE; __md++ ) \
1782 { \
1783 unsigned char HASH_VAR; \
1784 HASH_VAR = mbedtls_ssl_hash_from_md_alg( *__md );
1785
1786#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1787 } \
1788 }
1789
Hanno Becker56595f42019-06-19 16:31:38 +01001790#else /* !MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1791
1792#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1793 { \
1794 mbedtls_md_type_t MD_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID; \
1795 ((void) ssl);
1796
1797#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1798 }
1799
1800#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1801 { \
1802 unsigned char HASH_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID; \
1803 ((void) ssl);
1804
1805
1806#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1807 }
1808
1809#endif /* MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1810
Hanno Becker1f5a7932019-07-03 14:58:59 +01001811#if defined(__GNUC__) || defined(__arm__)
1812#define MBEDTLS_ALWAYS_INLINE __attribute__((always_inline))
1813#else
1814#define MBEDTLS_ALWAYS_INLINE
1815#endif
1816
Hanno Beckereeabfa42019-07-25 10:28:30 +01001817/* This internal function can be used to pend a fatal alert for
1818 * later delivery.
1819 *
Hanno Beckerb82350b2019-07-26 07:24:05 +01001820 * The check for pending alerts must be done by calling
Hanno Beckerdd691192019-07-26 09:59:18 +01001821 * the function ssl_send_pending_fatal_alert() in ssl_tls.c.
Hanno Beckerfcb721d2019-07-26 12:47:16 +01001822 * Currently, it happens only during the handshake loop and after
1823 * calling ssl_get_next_record() in the record processing stack.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001824 *
Hanno Beckerc8f52992019-07-25 11:15:08 +01001825 * This function must not be called multiple times without
Hanno Beckerb82350b2019-07-26 07:24:05 +01001826 * sending the pending fatal alerts in between.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001827 */
Hanno Beckerd829d0f2019-07-25 10:28:57 +01001828MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_pend_fatal_alert(
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001829 mbedtls_ssl_context *ssl,
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001830 unsigned char message )
1831{
Hanno Beckerc8f52992019-07-25 11:15:08 +01001832 ssl->pending_fatal_alert_msg = message;
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001833}
1834
Hanno Becker868cb582019-07-23 14:29:13 +01001835#define MBEDTLS_SSL_CHK(f) do { if( ( ret = f ) < 0 ) goto cleanup; } while( 0 )
Hanno Becker5d397682018-05-21 12:50:34 +01001836
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001837#endif /* ssl_internal.h */