blob: df02800215dfe73817eb34e8a23b8810bcf60aac [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
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010056#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
57 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020058#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020059#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020060
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +020061/* The public option is negative for backwards compatibility,
62 * but internally a poisitive option is more convenient. */
63#if !defined(MBEDTLS_SSL_PROTO_NO_TLS)
64#define MBEDTLS_SSL_PROTO_TLS
65#endif
66
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020067/* Determine minimum supported version */
68#define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
69
70#if defined(MBEDTLS_SSL_PROTO_SSL3)
71#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
72#else
73#if defined(MBEDTLS_SSL_PROTO_TLS1)
74#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
75#else
76#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
77#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
78#else
79#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
80#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
81#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
82#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
83#endif /* MBEDTLS_SSL_PROTO_TLS1 */
84#endif /* MBEDTLS_SSL_PROTO_SSL3 */
85
Ron Eldor5e9f14d2017-05-28 10:46:38 +030086#define MBEDTLS_SSL_MIN_VALID_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
87#define MBEDTLS_SSL_MIN_VALID_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
88
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020089/* Determine maximum supported version */
90#define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
91
92#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
93#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
94#else
95#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
96#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
97#else
98#if defined(MBEDTLS_SSL_PROTO_TLS1)
99#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
100#else
101#if defined(MBEDTLS_SSL_PROTO_SSL3)
102#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
103#endif /* MBEDTLS_SSL_PROTO_SSL3 */
104#endif /* MBEDTLS_SSL_PROTO_TLS1 */
105#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
106#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
107
Manuel Pégourié-Gonnard862cde52017-05-17 11:56:15 +0200108/* Shorthand for restartable ECC */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200109#if defined(MBEDTLS_ECP_RESTARTABLE) && \
110 defined(MBEDTLS_SSL_CLI_C) && \
111 defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
112 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
113#define MBEDTLS_SSL__ECP_RESTARTABLE
114#endif
115
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200116#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
117#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
118#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
119#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
120
121/*
122 * DTLS retransmission states, see RFC 6347 4.2.4
123 *
124 * The SENDING state is merged in PREPARING for initial sends,
125 * but is distinct for resends.
126 *
127 * Note: initial state is wrong for server, but is not used anyway.
128 */
129#define MBEDTLS_SSL_RETRANS_PREPARING 0
130#define MBEDTLS_SSL_RETRANS_SENDING 1
131#define MBEDTLS_SSL_RETRANS_WAITING 2
132#define MBEDTLS_SSL_RETRANS_FINISHED 3
133
134/*
135 * Allow extra bytes for record, authentication and encryption overhead:
136 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256)
137 * and allow for a maximum of 1024 of compression expansion if
138 * enabled.
139 */
140#if defined(MBEDTLS_ZLIB_SUPPORT)
141#define MBEDTLS_SSL_COMPRESSION_ADD 1024
142#else
143#define MBEDTLS_SSL_COMPRESSION_ADD 0
144#endif
145
Hanno Becker5cc04d52018-01-03 15:24:20 +0000146#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_NULL_CIPHER) || \
147 ( defined(MBEDTLS_CIPHER_MODE_CBC) && \
148 ( defined(MBEDTLS_AES_C) || \
149 defined(MBEDTLS_CAMELLIA_C) || \
Hanno Beckerb628a802018-07-17 10:19:47 +0100150 defined(MBEDTLS_ARIA_C) || \
151 defined(MBEDTLS_DES_C) ) )
Hanno Becker5cc04d52018-01-03 15:24:20 +0000152#define MBEDTLS_SSL_SOME_MODES_USE_MAC
153#endif
154
155#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200156/* Ciphersuites using HMAC */
157#if defined(MBEDTLS_SHA512_C)
158#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
159#elif defined(MBEDTLS_SHA256_C)
160#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
161#else
162#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
163#endif
Hanno Becker5cc04d52018-01-03 15:24:20 +0000164#else /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200165/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
166#define MBEDTLS_SSL_MAC_ADD 16
167#endif
168
169#if defined(MBEDTLS_CIPHER_MODE_CBC)
170#define MBEDTLS_SSL_PADDING_ADD 256
171#else
172#define MBEDTLS_SSL_PADDING_ADD 0
173#endif
174
Hanno Beckera5a2b082019-05-15 14:03:01 +0100175#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker550e1662019-05-08 17:37:58 +0100176#define MBEDTLS_SSL_MAX_CID_EXPANSION MBEDTLS_SSL_CID_PADDING_GRANULARITY
Hanno Beckeradd01902019-05-08 15:40:11 +0100177#else
178#define MBEDTLS_SSL_MAX_CID_EXPANSION 0
179#endif
180
Angus Grattond8213d02016-05-25 20:56:48 +1000181#define MBEDTLS_SSL_PAYLOAD_OVERHEAD ( MBEDTLS_SSL_COMPRESSION_ADD + \
182 MBEDTLS_MAX_IV_LENGTH + \
183 MBEDTLS_SSL_MAC_ADD + \
Hanno Beckeradd01902019-05-08 15:40:11 +0100184 MBEDTLS_SSL_PADDING_ADD + \
185 MBEDTLS_SSL_MAX_CID_EXPANSION \
Angus Grattond8213d02016-05-25 20:56:48 +1000186 )
187
188#define MBEDTLS_SSL_IN_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
189 ( MBEDTLS_SSL_IN_CONTENT_LEN ) )
190
191#define MBEDTLS_SSL_OUT_PAYLOAD_LEN ( MBEDTLS_SSL_PAYLOAD_OVERHEAD + \
192 ( MBEDTLS_SSL_OUT_CONTENT_LEN ) )
193
Hanno Becker0271f962018-08-16 13:23:47 +0100194/* The maximum number of buffered handshake messages. */
Hanno Beckerd488b9e2018-08-16 16:35:37 +0100195#define MBEDTLS_SSL_MAX_BUFFERED_HS 4
Hanno Becker0271f962018-08-16 13:23:47 +0100196
Angus Grattond8213d02016-05-25 20:56:48 +1000197/* Maximum length we can advertise as our max content length for
198 RFC 6066 max_fragment_length extension negotiation purposes
199 (the lesser of both sizes, if they are unequal.)
200 */
201#define MBEDTLS_TLS_EXT_ADV_CONTENT_LEN ( \
202 (MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_OUT_CONTENT_LEN) \
203 ? ( MBEDTLS_SSL_OUT_CONTENT_LEN ) \
204 : ( MBEDTLS_SSL_IN_CONTENT_LEN ) \
205 )
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200206
207/*
Hanno Beckera8434e82017-09-18 10:54:39 +0100208 * Check that we obey the standard's message size bounds
209 */
210
211#if MBEDTLS_SSL_MAX_CONTENT_LEN > 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000212#error "Bad configuration - record content too large."
Hanno Beckera8434e82017-09-18 10:54:39 +0100213#endif
214
Angus Grattond8213d02016-05-25 20:56:48 +1000215#if MBEDTLS_SSL_IN_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
216#error "Bad configuration - incoming record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
Hanno Beckera8434e82017-09-18 10:54:39 +0100217#endif
218
Angus Grattond8213d02016-05-25 20:56:48 +1000219#if MBEDTLS_SSL_OUT_CONTENT_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN
220#error "Bad configuration - outgoing record content should not be larger than MBEDTLS_SSL_MAX_CONTENT_LEN."
221#endif
222
223#if MBEDTLS_SSL_IN_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
224#error "Bad configuration - incoming protected record payload too large."
225#endif
226
227#if MBEDTLS_SSL_OUT_PAYLOAD_LEN > MBEDTLS_SSL_MAX_CONTENT_LEN + 2048
228#error "Bad configuration - outgoing protected record payload too large."
229#endif
230
231/* Calculate buffer sizes */
232
Hanno Becker25d6d1a2017-12-07 08:22:51 +0000233/* Note: Even though the TLS record header is only 5 bytes
234 long, we're internally using 8 bytes to store the
235 implicit sequence number. */
Hanno Beckerd25d4442017-10-04 13:56:42 +0100236#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Beckera8434e82017-09-18 10:54:39 +0100237
Hanno Beckera5a2b082019-05-15 14:03:01 +0100238#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000239#define MBEDTLS_SSL_IN_BUFFER_LEN \
240 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100241#else
242#define MBEDTLS_SSL_IN_BUFFER_LEN \
243 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_IN_PAYLOAD_LEN ) \
244 + ( MBEDTLS_SSL_CID_IN_LEN_MAX ) )
245#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000246
Hanno Beckera5a2b082019-05-15 14:03:01 +0100247#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Angus Grattond8213d02016-05-25 20:56:48 +1000248#define MBEDTLS_SSL_OUT_BUFFER_LEN \
249 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) )
Hanno Beckeradd01902019-05-08 15:40:11 +0100250#else
251#define MBEDTLS_SSL_OUT_BUFFER_LEN \
252 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_OUT_PAYLOAD_LEN ) \
253 + ( MBEDTLS_SSL_CID_OUT_LEN_MAX ) )
254#endif
Angus Grattond8213d02016-05-25 20:56:48 +1000255
256#ifdef MBEDTLS_ZLIB_SUPPORT
257/* Compression buffer holds both IN and OUT buffers, so should be size of the larger */
258#define MBEDTLS_SSL_COMPRESS_BUFFER_LEN ( \
259 ( MBEDTLS_SSL_IN_BUFFER_LEN > MBEDTLS_SSL_OUT_BUFFER_LEN ) \
260 ? MBEDTLS_SSL_IN_BUFFER_LEN \
261 : MBEDTLS_SSL_OUT_BUFFER_LEN \
262 )
263#endif
Hanno Beckera8434e82017-09-18 10:54:39 +0100264
265/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200266 * TLS extension flags (for extensions with outgoing ServerHello content
267 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
268 * of state of the renegotiation flag, so no indicator is required)
269 */
270#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
Manuel Pégourié-Gonnardbf57be62015-09-16 15:04:01 +0200271#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP_OK (1 << 1)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200272
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100273/*
274 * Helpers for code specific to TLS or DTLS.
275 *
276 * Goals for these helpers:
277 * - 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 +0200278 * - make the flow clear to the compiler, so that in TLS and DTLS combined
Manuel Pégourié-Gonnardec1c2222019-06-12 10:18:26 +0200279 * builds, when there are two branches, it knows exactly one of them is taken
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100280 * - preserve readability
281 *
282 * There are three macros:
283 * - MBEDTLS_SSL_TRANSPORT_IS_TLS( transport )
284 * - MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport )
285 * - MBEDTLS_SSL_TRANSPORT_ELSE
286 *
287 * The first two are macros rather than static inline functions because some
288 * compilers (eg arm-none-eabi-gcc 5.4.1 20160919) don't propagate constants
289 * well enough for us with static inline functions.
290 *
291 * Usage 1 (can replace DTLS with TLS):
292 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
293 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
294 * // DTLS-specific code
295 * #endif
296 *
297 * Usage 2 (can swap DTLS and TLS);
298 * #if defined(MBEDTLS_SSL_PROTO_DTLS)
299 * if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
300 * // DTLS-specific code
301 * MBEDTLS_SSL_TRANSPORT_ELSE
302 * #endif
303 * #if defined(MBEDTLS_SSL_PROTO_TLS)
304 * // TLS-specific code
305 * #endif
306 */
307#if defined(MBEDTLS_SSL_PROTO_DTLS) && defined(MBEDTLS_SSL_PROTO_TLS) /* both */
Manuel Pégourié-Gonnard8794a422019-06-11 10:04:57 +0200308#define MBEDTLS_SSL_TRANSPORT__BOTH /* shortcut for future tests */
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100309#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) \
310 ( (transport) == MBEDTLS_SSL_TRANSPORT_STREAM )
311#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) \
312 ( (transport) == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
313#define MBEDTLS_SSL_TRANSPORT_ELSE else
314#elif defined(MBEDTLS_SSL_PROTO_DTLS) /* DTLS only */
315#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 0
316#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 1
317#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
318#else /* TLS only */
319#define MBEDTLS_SSL_TRANSPORT_IS_TLS( transport ) 1
320#define MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) 0
321#define MBEDTLS_SSL_TRANSPORT_ELSE /* empty: no other branch */
322#endif /* TLS and/or DTLS */
323
Hanno Becker3010d552019-06-11 14:46:16 +0100324/* Check if the use of the ExtendedMasterSecret extension
325 * is enforced at compile-time. If so, we don't need to
326 * track its status in the handshake parameters. */
327#if defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET) && \
328 defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET) && \
329 MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET == \
330 MBEDTLS_SSL_EXTENDED_MS_ENABLED && \
331 MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET == \
332 MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED
333#define MBEDTLS_SSL_EXTENDED_MS_ENFORCED
334#endif
335
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200336#ifdef __cplusplus
337extern "C" {
338#endif
339
Hanno Becker7e5437a2017-04-28 17:15:26 +0100340#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
341 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
342/*
343 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
344 */
345struct mbedtls_ssl_sig_hash_set_t
346{
347 /* At the moment, we only need to remember a single suitable
348 * hash algorithm per signature algorithm. As long as that's
349 * the case - and we don't need a general lookup function -
350 * we can implement the sig-hash-set as a map from signatures
351 * to hash algorithms. */
352 mbedtls_md_type_t rsa;
353 mbedtls_md_type_t ecdsa;
354};
355#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
356 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
357
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200358/*
359 * This structure contains the parameters only needed during handshake.
360 */
361struct mbedtls_ssl_handshake_params
362{
363 /*
364 * Handshake specific crypto variables
365 */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100366
367#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
368 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
369 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
370#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200371#if defined(MBEDTLS_DHM_C)
372 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
373#endif
374#if defined(MBEDTLS_ECDH_C)
375 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
376#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200377#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200378 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200379#if defined(MBEDTLS_SSL_CLI_C)
380 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
381 size_t ecjpake_cache_len; /*!< Length of cached data */
382#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100383#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnardf4721792015-09-15 10:53:51 +0200384#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200385 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Hanno Becker004619f2019-06-18 16:07:32 +0100386 uint16_t curve_tls_id; /*!< TLS ID of EC for ECDHE. */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200387#endif
388#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
389 unsigned char *psk; /*!< PSK from the callback */
390 size_t psk_len; /*!< Length of PSK from callback */
391#endif
392#if defined(MBEDTLS_X509_CRT_PARSE_C)
393 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
394#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200395 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200396 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
397 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
398 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100399#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200400#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200401#if defined(MBEDTLS_SSL__ECP_RESTARTABLE)
Manuel Pégourié-Gonnardd27d1a52017-08-15 11:49:08 +0200402 int ecrs_enabled; /*!< Handshake supports EC restart? */
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200403 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200404 enum { /* this complements ssl->state with info on intra-state operations */
405 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
406 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
Manuel Pégourié-Gonnardc37423f2018-10-16 10:28:17 +0200407 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200408 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
409 } ecrs_state; /*!< current (or last) operation */
Hanno Beckerdd689312019-02-25 10:08:06 +0000410 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200411#endif
Hanno Becker3bf8cdf2019-02-06 16:18:31 +0000412#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
413 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
414 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
415#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200416#if defined(MBEDTLS_SSL_PROTO_DTLS)
417 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
418 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
419
420 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
421 Srv: unused */
422 unsigned char verify_cookie_len; /*!< Cli: cookie length
423 Srv: flag for sending a cookie */
424
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200425 uint32_t retransmit_timeout; /*!< Current value of timeout */
426 unsigned char retransmit_state; /*!< Retransmission state */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200427 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
428 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
429 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200430 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
431 flight being received */
432 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
433 resending messages */
434 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
435 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100436
Hanno Beckera5a2b082019-05-15 14:03:01 +0100437#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +0100438 /* The state of CID configuration in this handshake. */
439
440 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
Hanno Beckercfa6be72019-05-15 10:17:48 +0100441 * has been negotiated. Possible values are
Hanno Beckere5e7f622019-04-25 15:46:59 +0100442 * #MBEDTLS_SSL_CID_ENABLED and
443 * #MBEDTLS_SSL_CID_DISABLED. */
444 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
445 uint8_t peer_cid_len; /*!< The length of
446 * \c peer_cid. */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100447#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100448
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100449 struct
450 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100451 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
452 * buffers used for message buffering. */
453
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100454 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100455 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100456
Hanno Becker0271f962018-08-16 13:23:47 +0100457 struct mbedtls_ssl_hs_buffer
458 {
Hanno Becker98081a02018-08-22 13:32:50 +0100459 unsigned is_valid : 1;
460 unsigned is_fragmented : 1;
461 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100462 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100463 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100464 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
465
Hanno Becker5f066e72018-08-16 14:56:31 +0100466 struct
467 {
468 unsigned char *data;
469 size_t len;
470 unsigned epoch;
471 } future_record;
472
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100473 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100474
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200475 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100476#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200477
478 /*
479 * Checksum contexts
480 */
481#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
482 defined(MBEDTLS_SSL_PROTO_TLS1_1)
483 mbedtls_md5_context fin_md5;
484 mbedtls_sha1_context fin_sha1;
485#endif
486#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
487#if defined(MBEDTLS_SHA256_C)
488 mbedtls_sha256_context fin_sha256;
489#endif
490#if defined(MBEDTLS_SHA512_C)
491 mbedtls_sha512_context fin_sha512;
492#endif
493#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
494
495 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnarda5759752019-05-03 11:43:28 +0200496 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200497 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
498 int (*tls_prf)(const unsigned char *, size_t, const char *,
499 const unsigned char *, size_t,
500 unsigned char *, size_t);
501
Hanno Becker73f4cb12019-06-27 13:51:07 +0100502#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker473f98f2019-06-26 10:27:32 +0100503 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info;
Hanno Becker73f4cb12019-06-27 13:51:07 +0100504#endif /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker8759e162017-12-27 21:34:08 +0000505
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200506 size_t pmslen; /*!< premaster length */
507
508 unsigned char randbytes[64]; /*!< random bytes */
509 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
510 /*!< premaster secret */
511
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300512#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200513 int resume; /*!< session resume indicator*/
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300514#endif /* !MBEDTLS_SSL_NO_SESSION_RESUMPTION */
Hanno Becker18729ae2019-06-12 14:47:21 +0100515
516#if defined(MBEDTLS_SSL_SRV_C) && \
517 ( defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
518 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) )
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200519 int max_major_ver; /*!< max. major version client*/
520 int max_minor_ver; /*!< max. minor version client*/
Hanno Becker18729ae2019-06-12 14:47:21 +0100521#endif /* MBEDTLS_SSL_SRV_C && ( MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ||
522 MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200523 int cli_exts; /*!< client extension presence*/
524
525#if defined(MBEDTLS_SSL_SESSION_TICKETS)
526 int new_session_ticket; /*!< use NewSessionTicket? */
527#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Hanno Becker1ab322b2019-06-11 14:50:54 +0100528#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
529 !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200530 int extended_ms; /*!< use Extended Master Secret? */
531#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200532
533#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200534 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200535#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
536
537#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
538 /** Asynchronous operation context. This field is meant for use by the
539 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
540 * mbedtls_ssl_config::f_async_decrypt_start,
541 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
542 * The library does not use it internally. */
543 void *user_async_ctx;
544#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200545};
546
Hanno Beckera49ec562019-06-11 14:47:55 +0100547/*
548 * Getter functions for fields in mbedtls_ssl_handshake_params which
549 * may be statically implied by the configuration and hence be omitted
550 * from the structure.
551 */
552#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
553static inline int mbedtls_ssl_hs_get_extended_ms(
554 mbedtls_ssl_handshake_params const *params )
555{
556#if !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
557 return( params->extended_ms );
558#else
559 ((void) params);
560 return( MBEDTLS_SSL_EXTENDED_MS_ENABLED );
561#endif /* MBEDTLS_SSL_EXTENDED_MS_ENFORCED */
562}
563#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
564
Hanno Becker73f4cb12019-06-27 13:51:07 +0100565#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Beckerdf645962019-06-26 13:02:22 +0100566static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
567 mbedtls_ssl_handshake_params const *handshake )
568{
569 return( handshake->ciphersuite_info );
570}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100571#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100572static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
573 mbedtls_ssl_handshake_params const *handshake )
574{
575 ((void) handshake);
576 return( MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE );
577}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100578#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100579
Hanno Becker0271f962018-08-16 13:23:47 +0100580typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
581
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200582/*
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000583 * Representation of decryption/encryption transformations on records
584 *
585 * There are the following general types of record transformations:
586 * - Stream transformations (TLS versions <= 1.2 only)
587 * Transformation adding a MAC and applying a stream-cipher
588 * to the authenticated message.
589 * - CBC block cipher transformations ([D]TLS versions <= 1.2 only)
590 * In addition to the distinction of the order of encryption and
591 * authentication, there's a fundamental difference between the
592 * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3
593 * and TLS 1.0, the final IV after processing a record is used
594 * as the IV for the next record. No explicit IV is contained
595 * in an encrypted record. The IV for the first record is extracted
596 * at key extraction time. In contrast, for TLS 1.1 and 1.2, no
597 * IV is generated at key extraction time, but every encrypted
598 * record is explicitly prefixed by the IV with which it was encrypted.
599 * - AEAD transformations ([D]TLS versions >= 1.2 only)
600 * These come in two fundamentally different versions, the first one
601 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
602 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
603 * In the first transformation, the IV to be used for a record is obtained
604 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
605 * record sequence number, and explicitly prepending this sequence number
606 * to the encrypted record. In contrast, in the second transformation
607 * the IV is obtained by XOR'ing a static IV obtained at key extraction
608 * time with the 8-byte record sequence number, without prepending the
609 * latter to the encrypted record.
610 *
611 * In addition to type and version, the following parameters are relevant:
612 * - The symmetric cipher algorithm to be used.
613 * - The (static) encryption/decryption keys for the cipher.
614 * - For stream/CBC, the type of message digest to be used.
615 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Beckera198bb72018-10-18 15:39:53 +0100616 * - For AEAD transformations, the size (potentially 0) of an explicit,
617 * random initialization vector placed in encrypted records.
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000618 * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0)
619 * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC)
620 * and (if present) is combined with the explicit IV in a transformation-
621 * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
622 * - For stream/CBC, a flag determining the order of encryption and MAC.
623 * - The details of the transformation depend on the SSL/TLS version.
624 * - The length of the authentication tag.
625 *
Hanno Beckera198bb72018-10-18 15:39:53 +0100626 * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are
627 * constant across multiple encryption/decryption operations.
628 * For CBC, the implicit IV needs to be updated after each
629 * operation.
630 *
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000631 * The struct below refines this abstract view as follows:
632 * - The cipher underlying the transformation is managed in
633 * cipher contexts cipher_ctx_{enc/dec}, which must have the
634 * same cipher type. The mode of these cipher contexts determines
635 * the type of the transformation in the sense above: e.g., if
636 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
637 * then the transformation has type CBC resp. AEAD.
638 * - The cipher keys are never stored explicitly but
639 * are maintained within cipher_ctx_{enc/dec}.
640 * - For stream/CBC transformations, the message digest contexts
641 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
642 * are unused for AEAD transformations.
643 * - For stream/CBC transformations and versions > SSL3, the
644 * MAC keys are not stored explicitly but maintained within
645 * md_ctx_{enc/dec}.
646 * - For stream/CBC transformations and version SSL3, the MAC
647 * keys are stored explicitly in mac_enc, mac_dec and have
648 * a fixed size of 20 bytes. These fields are unused for
649 * AEAD transformations or transformations >= TLS 1.0.
650 * - For transformations using an implicit IV maintained within
651 * the transformation context, its contents are stored within
652 * iv_{enc/dec}.
653 * - The value of ivlen indicates the length of the IV.
654 * This is redundant in case of stream/CBC transformations
655 * which always use 0 resp. the cipher's block length as the
656 * IV length, but is needed for AEAD ciphers and may be
657 * different from the underlying cipher's block length
658 * in this case.
659 * - The field fixed_ivlen is nonzero for AEAD transformations only
660 * and indicates the length of the static part of the IV which is
661 * constant throughout the communication, and which is stored in
662 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
663 * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec}
664 * still store IV's for continued use across multiple transformations,
665 * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are
666 * not being used!
667 * - minor_ver denotes the SSL/TLS version
668 * - For stream/CBC transformations, maclen denotes the length of the
669 * authentication tag, while taglen is unused and 0.
670 * - For AEAD transformations, taglen denotes the length of the
671 * authentication tag, while maclen is unused and 0.
672 * - For CBC transformations, encrypt_then_mac determines the
673 * order of encryption and authentication. This field is unused
674 * in other transformations.
675 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200676 */
677struct mbedtls_ssl_transform
678{
679 /*
680 * Session specific crypto layer
681 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200682 size_t minlen; /*!< min. ciphertext length */
683 size_t ivlen; /*!< IV length */
684 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Becker8759e162017-12-27 21:34:08 +0000685 size_t maclen; /*!< MAC(CBC) len */
686 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200687
688 unsigned char iv_enc[16]; /*!< IV (encryption) */
689 unsigned char iv_dec[16]; /*!< IV (decryption) */
690
Hanno Becker92231322018-01-03 15:32:51 +0000691#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
692
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200693#if defined(MBEDTLS_SSL_PROTO_SSL3)
694 /* Needed only for SSL v3.0 secret */
695 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
696 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
697#endif /* MBEDTLS_SSL_PROTO_SSL3 */
698
699 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
700 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
701
Hanno Becker3307b532017-12-27 21:37:21 +0000702#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
703 int encrypt_then_mac; /*!< flag for EtM activation */
704#endif
705
Hanno Becker92231322018-01-03 15:32:51 +0000706#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
707
708 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
709 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Hanno Becker0a92b812019-06-24 15:46:40 +0100710
711#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker3307b532017-12-27 21:37:21 +0000712 int minor_ver;
Hanno Becker0a92b812019-06-24 15:46:40 +0100713#endif
Hanno Becker3307b532017-12-27 21:37:21 +0000714
Hanno Beckera5a2b082019-05-15 14:03:01 +0100715#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100716 uint8_t in_cid_len;
717 uint8_t out_cid_len;
718 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
719 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera5a2b082019-05-15 14:03:01 +0100720#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100721
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200722 /*
723 * Session specific compression layer
724 */
725#if defined(MBEDTLS_ZLIB_SUPPORT)
726 z_stream ctx_deflate; /*!< compression context */
727 z_stream ctx_inflate; /*!< decompression context */
728#endif
Manuel Pégourié-Gonnarda3024ee2019-07-09 12:54:17 +0200729
730#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
731 /* We need the Hello random bytes in order to re-derive keys from the
732 * Master Secret and other session info, see ssl_populate_transform() */
733 unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */
734#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200735};
736
Hanno Becker0a92b812019-06-24 15:46:40 +0100737static inline int mbedtls_ssl_transform_get_minor_ver( mbedtls_ssl_transform const *transform )
738{
739#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
740 return( transform->minor_ver );
741#else
742 ((void) transform);
743 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
744#endif
745}
746
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000747/*
Manuel Pégourié-Gonnard569ed6b2019-07-10 14:14:05 +0200748 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
749 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
750 */
751static inline int mbedtls_ssl_transform_uses_aead(
752 const mbedtls_ssl_transform *transform )
753{
754#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
755 return( transform->maclen == 0 && transform->taglen != 0 );
756#else
757 (void) transform;
758 return( 1 );
759#endif
760}
761
762/*
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000763 * Internal representation of record frames
764 *
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000765 * Instances come in two flavors:
766 * (1) Encrypted
767 * These always have data_offset = 0
768 * (2) Unencrypted
Hanno Beckerf8323432019-04-04 16:29:48 +0100769 * These have data_offset set to the amount of
770 * pre-expansion during record protection. Concretely,
771 * this is the length of the fixed part of the explicit IV
772 * used for encryption, or 0 if no explicit IV is used
773 * (e.g. for CBC in TLS 1.0, or stream ciphers).
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000774 *
775 * The reason for the data_offset in the unencrypted case
776 * is to allow for in-place conversion of an unencrypted to
777 * an encrypted record. If the offset wasn't included, the
778 * encrypted content would need to be shifted afterwards to
779 * make space for the fixed IV.
780 *
781 */
Hanno Becker80fe63e2019-04-29 13:45:54 +0100782#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100783#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100784#else
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100785#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100786#endif
787
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000788typedef struct
789{
Hanno Beckere84b28c2019-07-11 09:24:36 +0100790 uint8_t ctr[8]; /* In TLS: The implicit record sequence number.
791 * In DTLS: The 2-byte epoch followed by
792 * the 6-byte sequence number.
793 * This is stored as a raw big endian byte array
794 * as opposed to a uint64_t because we rarely
795 * need to perform arithmetic on this, but do
796 * need it as a Byte array for the purpose of
797 * MAC computations. */
798 uint8_t type; /* The record content type. */
799 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
800 * Convert to internal presentation of versions
801 * using mbedtls_ssl_read_version() and
802 * mbedtls_ssl_write_version().
803 * Keep wire-format for MAC computations. */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000804
Hanno Beckere84b28c2019-07-11 09:24:36 +0100805 unsigned char *buf; /* Memory buffer enclosing the record content */
806 size_t buf_len; /* Buffer length */
807 size_t data_offset; /* Offset of record content */
808 size_t data_len; /* Length of record content */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000809
Hanno Beckera5a2b082019-05-15 14:03:01 +0100810#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere84b28c2019-07-11 09:24:36 +0100811 uint8_t cid_len; /* Length of the CID (0 if not present) */
812 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100813#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000814} mbedtls_record;
815
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200816#if defined(MBEDTLS_X509_CRT_PARSE_C)
817/*
818 * List of certificate + private key pairs
819 */
820struct mbedtls_ssl_key_cert
821{
822 mbedtls_x509_crt *cert; /*!< cert */
823 mbedtls_pk_context *key; /*!< private key */
824 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
825};
826#endif /* MBEDTLS_X509_CRT_PARSE_C */
827
828#if defined(MBEDTLS_SSL_PROTO_DTLS)
829/*
830 * List of handshake messages kept around for resending
831 */
832struct mbedtls_ssl_flight_item
833{
834 unsigned char *p; /*!< message, including handshake headers */
835 size_t len; /*!< length of p */
836 unsigned char type; /*!< type of the message: handshake or CCS */
837 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
838};
839#endif /* MBEDTLS_SSL_PROTO_DTLS */
840
Hanno Becker7e5437a2017-04-28 17:15:26 +0100841#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
842 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
843
844/* Find an entry in a signature-hash set matching a given hash algorithm. */
845mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
846 mbedtls_pk_type_t sig_alg );
847/* Add a signature-hash-pair to a signature-hash set */
848void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
849 mbedtls_pk_type_t sig_alg,
850 mbedtls_md_type_t md_alg );
851/* Allow exactly one hash algorithm for each signature. */
852void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
853 mbedtls_md_type_t md_alg );
854
855/* Setup an empty signature-hash set */
856static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
857{
858 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
859}
860
861#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
862 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200863
864/**
865 * \brief Free referenced items in an SSL transform context and clear
866 * memory
867 *
868 * \param transform SSL transform context
869 */
870void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
871
872/**
873 * \brief Free referenced items in an SSL handshake context and clear
874 * memory
875 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200876 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200877 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200878void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200879
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200880int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
881int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
882void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
883
884int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
885
886void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
887int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
888
Simon Butcher99000142016-10-13 17:21:01 +0100889int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
890int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
891void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
892
Hanno Becker4a810fb2017-05-24 16:27:30 +0100893/**
894 * \brief Update record layer
895 *
896 * This function roughly separates the implementation
897 * of the logic of (D)TLS from the implementation
898 * of the secure transport.
899 *
Hanno Becker3a0aad12018-08-20 09:44:02 +0100900 * \param ssl The SSL context to use.
901 * \param update_hs_digest This indicates if the handshake digest
902 * should be automatically updated in case
903 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +0100904 *
905 * \return 0 or non-zero error code.
906 *
907 * \note A clarification on what is called 'record layer' here
908 * is in order, as many sensible definitions are possible:
909 *
910 * The record layer takes as input an untrusted underlying
911 * transport (stream or datagram) and transforms it into
912 * a serially multiplexed, secure transport, which
913 * conceptually provides the following:
914 *
915 * (1) Three datagram based, content-agnostic transports
916 * for handshake, alert and CCS messages.
917 * (2) One stream- or datagram-based transport
918 * for application data.
919 * (3) Functionality for changing the underlying transform
920 * securing the contents.
921 *
922 * The interface to this functionality is given as follows:
923 *
924 * a Updating
925 * [Currently implemented by mbedtls_ssl_read_record]
926 *
927 * Check if and on which of the four 'ports' data is pending:
928 * Nothing, a controlling datagram of type (1), or application
929 * data (2). In any case data is present, internal buffers
930 * provide access to the data for the user to process it.
931 * Consumption of type (1) datagrams is done automatically
932 * on the next update, invalidating that the internal buffers
933 * for previous datagrams, while consumption of application
934 * data (2) is user-controlled.
935 *
936 * b Reading of application data
937 * [Currently manual adaption of ssl->in_offt pointer]
938 *
939 * As mentioned in the last paragraph, consumption of data
940 * is different from the automatic consumption of control
941 * datagrams (1) because application data is treated as a stream.
942 *
943 * c Tracking availability of application data
944 * [Currently manually through decreasing ssl->in_msglen]
945 *
946 * For efficiency and to retain datagram semantics for
947 * application data in case of DTLS, the record layer
948 * provides functionality for checking how much application
949 * data is still available in the internal buffer.
950 *
951 * d Changing the transformation securing the communication.
952 *
953 * Given an opaque implementation of the record layer in the
954 * above sense, it should be possible to implement the logic
955 * of (D)TLS on top of it without the need to know anything
956 * about the record layer's internals. This is done e.g.
957 * in all the handshake handling functions, and in the
958 * application data reading function mbedtls_ssl_read.
959 *
960 * \note The above tries to give a conceptual picture of the
961 * record layer, but the current implementation deviates
962 * from it in some places. For example, our implementation of
963 * the update functionality through mbedtls_ssl_read_record
964 * discards datagrams depending on the current state, which
965 * wouldn't fall under the record layer's responsibility
966 * following the above definition.
967 *
968 */
Hanno Becker3a0aad12018-08-20 09:44:02 +0100969int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
970 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200971int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
972
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +0200973int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100974int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200975int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
976
977int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
978int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
979
980int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
981int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
982
983int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
984int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
985
986void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
Hanno Becker473f98f2019-06-26 10:27:32 +0100987 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200988
Hanno Becker09d23642019-07-22 17:18:18 +0100989int mbedtls_ssl_build_pms( mbedtls_ssl_context *ssl );
990
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200991#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
992int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
993#endif
994
995#if defined(MBEDTLS_PK_C)
996unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +0100997unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200998mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
999#endif
1000
1001mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001002unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Simon Butcher99000142016-10-13 17:21:01 +01001003int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001004
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001005#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001006int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001007#endif
1008
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001009#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001010int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
1011 mbedtls_md_type_t md );
1012#endif
1013
Hanno Becker2881d802019-05-22 14:44:53 +01001014static inline int mbedtls_ssl_get_minor_ver( mbedtls_ssl_context const *ssl )
1015{
Hanno Becker381eaa52019-06-12 14:43:01 +01001016#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001017 return( ssl->minor_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001018#else /* !MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
1019 ((void) ssl);
1020 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
1021#endif /* MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001022}
1023
1024static inline int mbedtls_ssl_get_major_ver( mbedtls_ssl_context const *ssl )
1025{
Hanno Becker381eaa52019-06-12 14:43:01 +01001026#if !defined(MBEDTLS_SSL_CONF_FIXED_MAJOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001027 return( ssl->major_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001028#else /* !MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
1029 ((void) ssl);
1030 return( MBEDTLS_SSL_CONF_FIXED_MAJOR_VER );
1031#endif /* MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001032}
1033
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001034#if defined(MBEDTLS_X509_CRT_PARSE_C)
1035static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1036{
1037 mbedtls_ssl_key_cert *key_cert;
1038
1039 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1040 key_cert = ssl->handshake->key_cert;
1041 else
1042 key_cert = ssl->conf->key_cert;
1043
1044 return( key_cert == NULL ? NULL : key_cert->key );
1045}
1046
1047static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1048{
1049 mbedtls_ssl_key_cert *key_cert;
1050
1051 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1052 key_cert = ssl->handshake->key_cert;
1053 else
1054 key_cert = ssl->conf->key_cert;
1055
1056 return( key_cert == NULL ? NULL : key_cert->cert );
1057}
1058
1059/*
1060 * Check usage of a certificate wrt extensions:
1061 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1062 *
1063 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1064 * check a cert we received from them)!
1065 *
1066 * Return 0 if everything is OK, -1 if not.
1067 */
1068int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
Hanno Becker473f98f2019-06-26 10:27:32 +01001069 mbedtls_ssl_ciphersuite_handle_t ciphersuite,
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001070 int cert_endpoint,
1071 uint32_t *flags );
1072#endif /* MBEDTLS_X509_CRT_PARSE_C */
1073
Hanno Becker43395762019-05-03 14:46:38 +01001074static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001075{
Hanno Beckerf903dc82019-07-12 09:55:46 +01001076#if !defined(MBEDTLS_SSL_PROTO__BOTH)
1077 ((void) ssl);
1078#endif
1079
1080#if defined(MBEDTLS_SSL_PROTO_DTLS)
1081 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1082 {
1083 return( 13 );
1084 }
1085 MBEDTLS_SSL_TRANSPORT_ELSE
1086#endif /* MBEDTLS_SSL_PROTO_DTLS */
1087#if defined(MBEDTLS_SSL_PROTO_TLS)
1088 {
1089 return( 5 );
1090 }
1091#endif /* MBEDTLS_SSL_PROTO_TLS */
Hanno Becker43395762019-05-03 14:46:38 +01001092}
1093
1094static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1095{
Hanno Beckerccc24562019-05-03 15:05:27 +01001096 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001097}
1098
1099static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1100{
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001101#if !defined(MBEDTLS_SSL_PROTO__BOTH)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001102 ((void) ssl);
1103#endif
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001104
1105#if defined(MBEDTLS_SSL_PROTO_DTLS)
1106 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1107 return( 12 );
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001108 MBEDTLS_SSL_TRANSPORT_ELSE
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001109#endif
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001110#if defined(MBEDTLS_SSL_PROTO_TLS)
1111 return( 4 );
1112#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001113}
1114
1115#if defined(MBEDTLS_SSL_PROTO_DTLS)
1116void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1117void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1118int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001119int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001120#endif
1121
1122/* Visible for testing purposes only */
1123#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Beckerfc551722019-07-12 08:50:37 +01001124int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001125void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1126#endif
1127
Hanno Becker58fccf22019-02-06 14:30:46 +00001128int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1129 const mbedtls_ssl_session *src );
1130
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001131/* constant-time buffer comparison */
1132static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
1133{
1134 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +01001135 volatile const unsigned char *A = (volatile const unsigned char *) a;
1136 volatile const unsigned char *B = (volatile const unsigned char *) b;
1137 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001138
1139 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001140 {
1141 /* Read volatile data in order before computing diff.
1142 * This avoids IAR compiler warning:
1143 * 'the order of volatile accesses is undefined ..' */
1144 unsigned char x = A[i], y = B[i];
1145 diff |= x ^ y;
1146 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001147
1148 return( diff );
1149}
1150
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001151#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1152 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1153int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl,
1154 unsigned char *output,
1155 unsigned char *data, size_t data_len );
1156#endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \
1157 MBEDTLS_SSL_PROTO_TLS1_1 */
1158
1159#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1160 defined(MBEDTLS_SSL_PROTO_TLS1_2)
1161int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001162 unsigned char *hash, size_t *hashlen,
1163 unsigned char *data, size_t data_len,
1164 mbedtls_md_type_t md_alg );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001165#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1166 MBEDTLS_SSL_PROTO_TLS1_2 */
1167
Hanno Becker7b628e52019-06-12 14:45:11 +01001168/*
1169 * Convert version numbers to/from wire format
1170 * and, for DTLS, to/from TLS equivalent.
1171 *
1172 * For TLS this is the identity.
1173 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
1174 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
1175 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
1176 */
1177static inline void mbedtls_ssl_write_version( int major, int minor,
1178 int transport,
1179 unsigned char ver[2] )
1180{
1181#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1182 ((void) transport);
1183#endif
1184
1185#if defined(MBEDTLS_SSL_PROTO_DTLS)
1186 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1187 {
1188 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
1189 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1190
1191 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
1192 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
1193 }
1194 MBEDTLS_SSL_TRANSPORT_ELSE
1195#endif
1196#if defined(MBEDTLS_SSL_PROTO_TLS)
1197 {
1198 ver[0] = (unsigned char) major;
1199 ver[1] = (unsigned char) minor;
1200 }
1201#endif
1202}
1203
1204static inline void mbedtls_ssl_read_version( int *major, int *minor,
1205 int transport,
1206 const unsigned char ver[2] )
1207{
1208#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1209 ((void) transport);
1210#endif
1211
1212#if defined(MBEDTLS_SSL_PROTO_DTLS)
1213 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1214 {
1215 *major = 255 - ver[0] + 2;
1216 *minor = 255 - ver[1] + 1;
1217
1218 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
1219 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1220 }
1221 MBEDTLS_SSL_TRANSPORT_ELSE
1222#endif /* MBEDTLS_SSL_PROTO_DTLS */
1223#if defined(MBEDTLS_SSL_PROTO_TLS)
1224 {
1225 *major = ver[0];
1226 *minor = ver[1];
1227 }
1228#endif /* MBEDTLS_SSL_PROTO_TLS */
1229}
1230
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001231#ifdef __cplusplus
1232}
1233#endif
1234
Hanno Becker611a83b2018-01-03 14:27:32 +00001235void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1236int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1237 mbedtls_ssl_transform *transform,
1238 mbedtls_record *rec,
1239 int (*f_rng)(void *, unsigned char *, size_t),
1240 void *p_rng );
Hanno Becker40478be2019-07-12 08:23:59 +01001241int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Becker611a83b2018-01-03 14:27:32 +00001242 mbedtls_ssl_transform *transform,
1243 mbedtls_record *rec );
1244
Hanno Becker57e72c72019-06-12 12:46:31 +01001245
1246/*
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001247 * Accessor functions for optional fields of various structures
1248 */
1249
1250static inline int mbedtls_ssl_handshake_get_resume(
1251 const mbedtls_ssl_handshake_params *handshake )
1252{
1253#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
1254 return( handshake->resume );
1255#else
1256 (void) handshake;
1257 return( 0 );
1258#endif
1259}
1260
1261static inline int mbedtls_ssl_get_renego_status(
1262 const mbedtls_ssl_context *ssl )
1263{
1264#if defined(MBEDTLS_SSL_RENEGOTIATION)
1265 return( ssl->renego_status );
1266#else
1267 (void) ssl;
1268 return( MBEDTLS_SSL_INITIAL_HANDSHAKE );
1269#endif
1270}
1271
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001272static inline int mbedtls_ssl_conf_is_renegotiation_enabled(
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001273 const mbedtls_ssl_config *conf )
1274{
1275#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001276 return( conf->disable_renegotiation ==
1277 MBEDTLS_SSL_RENEGOTIATION_ENABLED );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001278#else
1279 (void) conf;
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001280 return( 0 );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001281#endif
1282}
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001283
1284/*
Hanno Becker57e72c72019-06-12 12:46:31 +01001285 * Getter functions for fields in mbedtls_ssl_config which may
1286 * be fixed at compile time via one of MBEDTLS_SSL_SSL_CONF_XXX.
1287 */
1288
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001289#if defined(MBEDTLS_SSL_SRV_C)
1290#if !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
1291static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1292 mbedtls_ssl_config const *conf )
1293{
1294 return( conf->cert_req_ca_list );
1295}
1296#else /* !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1297static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1298 mbedtls_ssl_config const *conf )
1299{
1300 ((void) conf);
1301 return( MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST );
1302}
1303#endif /* MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1304#endif /* MBEDTLS_SSL_SRV_C */
1305
Hanno Becker2d9623f2019-06-13 12:07:05 +01001306#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
1307static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1308 mbedtls_ssl_config const *conf )
1309{
1310 return( conf->endpoint );
1311}
1312#else /* !MBEDTLS_SSL_CONF_ENDPOINT */
1313static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1314 mbedtls_ssl_config const *conf )
1315{
1316 ((void) conf);
1317 return( MBEDTLS_SSL_CONF_ENDPOINT );
1318}
1319#endif /* MBEDTLS_SSL_CONF_ENDPOINT */
1320
Hanno Becker1f835fa2019-06-13 10:14:59 +01001321#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
1322static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1323 mbedtls_ssl_config const *conf )
1324{
1325 return( conf->read_timeout );
1326}
1327#else /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
1328static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1329 mbedtls_ssl_config const *conf )
1330{
1331 ((void) conf);
1332 return( MBEDTLS_SSL_CONF_READ_TIMEOUT );
1333}
1334#endif /* MBEDTLS_SSL_CONF_READ_TIMEOUT */
1335
1336#if defined(MBEDTLS_SSL_PROTO_DTLS)
1337#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN)
1338static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1339 mbedtls_ssl_config const *conf )
1340{
1341 return( conf->hs_timeout_min );
1342}
1343#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1344static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1345 mbedtls_ssl_config const *conf )
1346{
1347 ((void) conf);
1348 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN );
1349}
1350#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1351
1352#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX)
1353static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1354 mbedtls_ssl_config const *conf )
1355{
1356 return( conf->hs_timeout_max );
1357}
1358#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1359static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1360 mbedtls_ssl_config const *conf )
1361{
1362 ((void) conf);
1363 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX );
1364}
1365#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1366#endif /* MBEDTLS_SSL_PROTO_DTLS */
1367
Hanno Beckere0200da2019-06-13 09:23:43 +01001368#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1369#if !defined(MBEDTLS_SSL_CONF_CID_LEN)
1370static inline size_t mbedtls_ssl_conf_get_cid_len(
1371 mbedtls_ssl_config const *conf )
1372{
1373 return( conf->cid_len );
1374}
1375#else /* !MBEDTLS_SSL_CONF_CID_LEN */
1376static inline size_t mbedtls_ssl_conf_get_cid_len(
1377 mbedtls_ssl_config const *conf )
1378{
1379 ((void) conf);
1380 return( MBEDTLS_SSL_CONF_CID_LEN );
1381}
1382#endif /* MBEDTLS_SSL_CONF_CID_LEN */
1383
1384#if !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
1385static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1386 mbedtls_ssl_config const *conf )
1387{
1388 return( conf->ignore_unexpected_cid );
1389}
1390#else /* !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1391static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1392 mbedtls_ssl_config const *conf )
1393{
1394 ((void) conf);
1395 return( MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID );
1396}
1397#endif /* MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1398#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1399
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001400#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
1401static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1402 mbedtls_ssl_config const *conf )
1403{
1404 return( conf->allow_legacy_renegotiation );
1405}
1406#else /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1407static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1408 mbedtls_ssl_config const *conf )
1409{
1410 ((void) conf);
1411 return( MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION );
1412}
1413#endif /* MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1414
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001415#if !defined(MBEDTLS_SSL_CONF_AUTHMODE)
1416static inline int mbedtls_ssl_conf_get_authmode(
1417 mbedtls_ssl_config const *conf )
1418{
1419 return( conf->authmode );
1420}
1421#else /* !MBEDTLS_SSL_CONF_AUTHMODE */
1422static inline int mbedtls_ssl_conf_get_authmode(
1423 mbedtls_ssl_config const *conf )
1424{
1425 ((void) conf);
1426 return( MBEDTLS_SSL_CONF_AUTHMODE );
1427}
1428#endif /* MBEDTLS_SSL_CONF_AUTHMODE */
1429
Hanno Beckerde671542019-06-12 16:30:46 +01001430#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1431#if !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
1432static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1433 mbedtls_ssl_config const *conf )
1434{
1435 return( conf->badmac_limit );
1436}
1437#else /* !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1438static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1439 mbedtls_ssl_config const *conf )
1440{
1441 ((void) conf);
1442 return( MBEDTLS_SSL_CONF_BADMAC_LIMIT );
1443}
1444#endif /* MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1445#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1446
Hanno Becker7f376f42019-06-12 16:20:48 +01001447#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1448#if !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
1449static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1450 mbedtls_ssl_config const *conf )
1451{
1452 return( conf->anti_replay );
1453}
1454#else /* !MBEDTLS_SSL_CONF_ANTI_REPLAY */
1455static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1456 mbedtls_ssl_config const *conf )
1457{
1458 ((void) conf);
1459 return( MBEDTLS_SSL_CONF_ANTI_REPLAY );
1460}
1461#endif /* MBEDTLS_SSL_CONF_ANTI_REPLAY */
1462#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1463
Hanno Becker0ae6b242019-06-13 16:45:36 +01001464#if !defined(MBEDTLS_SSL_CONF_SET_TIMER)
1465static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1466 mbedtls_ssl_context const *ssl )
1467{
1468 return( ssl->f_set_timer );
1469}
1470#else /* !MBEDTLS_SSL_CONF_SET_TIMER */
1471
1472#define mbedtls_ssl_conf_set_timer_func MBEDTLS_SSL_CONF_SET_TIMER
1473extern void mbedtls_ssl_conf_set_timer_func( void*, uint32_t, uint32_t );
1474
1475static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1476 mbedtls_ssl_context const *ssl )
1477{
1478 ((void) ssl);
1479 return ((mbedtls_ssl_set_timer_t*) mbedtls_ssl_conf_set_timer_func);
1480}
1481#endif /* MBEDTLS_SSL_CONF_SET_TIMER */
1482
1483#if !defined(MBEDTLS_SSL_CONF_GET_TIMER)
1484static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1485 mbedtls_ssl_context const *ssl )
1486{
1487 return( ssl->f_get_timer );
1488}
1489#else /* !MBEDTLS_SSL_CONF_GET_TIMER */
1490
1491#define mbedtls_ssl_conf_get_timer_func MBEDTLS_SSL_CONF_GET_TIMER
1492extern int mbedtls_ssl_conf_get_timer_func( void* );
1493
1494static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1495 mbedtls_ssl_context const *ssl )
1496{
1497 ((void) ssl);
1498 return ((mbedtls_ssl_get_timer_t*) mbedtls_ssl_conf_get_timer_func);
1499}
1500#endif /* MBEDTLS_SSL_CONF_GET_TIMER */
1501
Hanno Beckera58a8962019-06-13 16:11:15 +01001502#if !defined(MBEDTLS_SSL_CONF_RECV)
1503static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1504 mbedtls_ssl_context const *ssl )
1505{
1506 return( ssl->f_recv );
1507}
1508#else /* !MBEDTLS_SSL_CONF_RECV */
1509
1510#define mbedtls_ssl_conf_recv_func MBEDTLS_SSL_CONF_RECV
1511extern int mbedtls_ssl_conf_recv_func( void*, unsigned char*, size_t );
1512
1513static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1514 mbedtls_ssl_context const *ssl )
1515{
1516 ((void) ssl);
1517 return ((mbedtls_ssl_recv_t*) mbedtls_ssl_conf_recv_func);
1518}
1519#endif /* MBEDTLS_SSL_CONF_RECV */
1520
1521#if !defined(MBEDTLS_SSL_CONF_SEND)
1522static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1523 mbedtls_ssl_context const *ssl )
1524{
1525 return( ssl->f_send );
1526}
1527#else /* !MBEDTLS_SSL_CONF_SEND */
1528
1529#define mbedtls_ssl_conf_send_func MBEDTLS_SSL_CONF_SEND
1530extern int mbedtls_ssl_conf_send_func( void*, unsigned char const*, size_t );
1531
1532static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1533 mbedtls_ssl_context const *ssl )
1534{
1535 ((void) ssl);
1536 return ((mbedtls_ssl_send_t*) mbedtls_ssl_conf_send_func);
1537}
1538#endif /* MBEDTLS_SSL_CONF_SEND */
1539
1540#if !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
1541static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1542 mbedtls_ssl_context const *ssl )
1543{
1544 return( ssl->f_recv_timeout );
1545}
1546#else /* !MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1547
1548#define mbedtls_ssl_conf_recv_timeout_func MBEDTLS_SSL_CONF_RECV_TIMEOUT
1549extern int mbedtls_ssl_conf_recv_timeout_func(
1550 void*, unsigned char*, size_t, uint32_t );
1551
1552static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1553 mbedtls_ssl_context const *ssl )
1554{
1555 ((void) ssl);
1556 return ((mbedtls_ssl_recv_timeout_t*) mbedtls_ssl_conf_recv_timeout_func);
1557}
1558#endif /* MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1559
1560typedef int mbedtls_frng_t( void*, unsigned char*, size_t );
1561
Hanno Beckerece325c2019-06-13 15:39:27 +01001562#if !defined(MBEDTLS_SSL_CONF_RNG)
Hanno Beckera58a8962019-06-13 16:11:15 +01001563static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001564 mbedtls_ssl_config const *conf )
1565{
1566 return( conf->f_rng );
1567}
Hanno Beckerece325c2019-06-13 15:39:27 +01001568
Hanno Becker572d4482019-07-23 13:47:53 +01001569static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1570{
1571 return( conf->p_rng );
1572}
1573#else /* !MBEDTLS_SSL_CONF_RNG */
Hanno Beckerece325c2019-06-13 15:39:27 +01001574#define mbedtls_ssl_conf_rng_func MBEDTLS_SSL_CONF_RNG
1575extern int mbedtls_ssl_conf_rng_func( void*, unsigned char*, size_t );
1576
Hanno Beckera58a8962019-06-13 16:11:15 +01001577static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001578 mbedtls_ssl_config const *conf )
1579{
1580 ((void) conf);
1581 return ((mbedtls_frng_t*) mbedtls_ssl_conf_rng_func);
1582}
Hanno Becker572d4482019-07-23 13:47:53 +01001583
1584static inline void* mbedtls_ssl_conf_get_prng( mbedtls_ssl_config const *conf )
1585{
1586 ((void) conf);
1587 return( NULL );
1588}
Hanno Beckerece325c2019-06-13 15:39:27 +01001589#endif /* MBEDTLS_SSL_CONF_RNG */
1590
Hanno Beckere965bd32019-06-12 14:04:34 +01001591static inline int mbedtls_ssl_conf_get_max_major_ver(
1592 mbedtls_ssl_config const *conf )
1593{
1594#if !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
1595 return( conf->max_major_ver );
1596#else
1597 ((void) conf);
1598 return( MBEDTLS_SSL_CONF_MAX_MAJOR_VER );
1599#endif /* MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
1600}
1601
1602static inline int mbedtls_ssl_conf_get_min_major_ver(
1603 mbedtls_ssl_config const *conf )
1604{
1605#if !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
1606 return( conf->min_major_ver );
1607#else /* !MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1608 ((void) conf);
1609 return( MBEDTLS_SSL_CONF_MIN_MAJOR_VER );
1610#endif /* MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1611}
1612
1613static inline int mbedtls_ssl_conf_get_max_minor_ver(
1614 mbedtls_ssl_config const *conf )
1615{
1616#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER)
1617 return( conf->max_minor_ver );
1618#else /* !MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1619 ((void) conf);
1620 return( MBEDTLS_SSL_CONF_MAX_MINOR_VER );
1621#endif /* MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1622}
1623
1624static inline int mbedtls_ssl_conf_get_min_minor_ver(
1625 mbedtls_ssl_config const *conf )
1626{
1627#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER)
1628 return( conf->min_minor_ver );
1629#else /* !MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1630 ((void) conf);
1631 return( MBEDTLS_SSL_CONF_MIN_MINOR_VER );
1632#endif /* MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1633}
1634
Hanno Becker57e72c72019-06-12 12:46:31 +01001635#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1636static inline unsigned int mbedtls_ssl_conf_get_ems(
1637 mbedtls_ssl_config const *conf )
1638{
1639#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
1640 return( conf->extended_ms );
1641#else
1642 ((void) conf);
1643 return( MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET );
1644#endif /* MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET */
1645}
1646
1647static inline unsigned int mbedtls_ssl_conf_get_ems_enforced(
1648 mbedtls_ssl_config const *conf )
1649{
1650#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
1651 return( conf->enforce_extended_master_secret );
1652#else
1653 ((void) conf);
1654 return( MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET );
1655#endif /* MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
1656}
1657#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1658
Hanno Becker14990272019-06-26 11:47:15 +01001659/*
1660 * Macros for the traversal of the list of all enabled ciphersuites.
1661 * This is implemented as a plain loop in case we have a runtime
1662 * configurable list of ciphersuites, and as a simple variable
1663 * instantiation in case a single ciphersuite is enabled at
1664 * compile-time.
1665 */
Hanno Becker73f4cb12019-06-27 13:51:07 +01001666#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker14990272019-06-26 11:47:15 +01001667
1668#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
1669 { \
1670 int const *__id_ptr; \
1671 for( __id_ptr=(ssl)->conf->ciphersuite_list[ (ver) ]; \
1672 *__id_ptr != 0; __id_ptr++ ) \
1673 { \
1674 const int __id = *__id_ptr; \
1675 mbedtls_ssl_ciphersuite_handle_t info; \
1676 info = mbedtls_ssl_ciphersuite_from_id( __id ); \
1677 if( info == MBEDTLS_SSL_CIPHERSUITE_INVALID_HANDLE ) \
1678 continue;
1679
1680#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
1681 } \
1682 }
1683
Hanno Becker73f4cb12019-06-27 13:51:07 +01001684#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001685
1686#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001687 do { \
Hanno Becker14990272019-06-26 11:47:15 +01001688 const mbedtls_ssl_ciphersuite_handle_t info = \
1689 MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE;
1690
1691#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001692 } while( 0 );
Hanno Becker14990272019-06-26 11:47:15 +01001693
Hanno Becker73f4cb12019-06-27 13:51:07 +01001694#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001695
Hanno Beckerc1096e72019-06-19 12:30:41 +01001696#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
1697
Hanno Becker7ae30262019-07-10 09:40:52 +01001698#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1699 { \
1700 mbedtls_ecp_group_id const *_gid; \
1701 mbedtls_ecp_curve_info const *_info; \
1702 for( _gid = ssl->conf->curve_list; \
1703 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
1704 { \
1705 uint16_t TLS_ID_VAR; \
1706 _info = mbedtls_ecp_curve_info_from_grp_id( *_gid ) ; \
1707 if( _info == NULL ) \
1708 continue; \
1709 TLS_ID_VAR = _info->tls_id;
Hanno Beckera4a9c692019-06-18 16:55:47 +01001710
1711#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1712 } \
1713 }
1714
1715#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1716 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001717 mbedtls_ecp_group_id const *_gid; \
1718 for( _gid = ssl->conf->curve_list; \
1719 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001720 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001721 mbedtls_ecp_group_id EC_ID_VAR = *_gid; \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001722
1723#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1724 } \
1725 }
1726
Hanno Beckerc1096e72019-06-19 12:30:41 +01001727#else /* !MBEDTLS_SSL_CONF_SINGLE_EC */
1728
1729#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1730 { \
1731 uint16_t TLS_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID; \
1732 ((void) ssl);
1733
1734#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1735 }
1736
1737#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1738 { \
1739 mbedtls_ecp_group_id EC_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID; \
1740 ((void) ssl);
1741
1742#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1743 }
1744
1745#endif /* MBEDTLS_SSL_CONF_SINGLE_EC */
1746
Hanno Becker56595f42019-06-19 16:31:38 +01001747#if !defined(MBEDTLS_SSL_CONF_SINGLE_SIG_HASH)
1748
Hanno Beckerf1bc9e12019-06-19 16:23:21 +01001749#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1750 { \
1751 int const *__md; \
1752 for( __md = ssl->conf->sig_hashes; \
1753 *__md != MBEDTLS_MD_NONE; __md++ ) \
1754 { \
1755 mbedtls_md_type_t MD_VAR = (mbedtls_md_type_t) *__md; \
1756
1757 #define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1758 } \
1759 }
1760
1761#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1762 { \
1763 int const *__md; \
1764 for( __md = ssl->conf->sig_hashes; \
1765 *__md != MBEDTLS_MD_NONE; __md++ ) \
1766 { \
1767 unsigned char HASH_VAR; \
1768 HASH_VAR = mbedtls_ssl_hash_from_md_alg( *__md );
1769
1770#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1771 } \
1772 }
1773
Hanno Becker56595f42019-06-19 16:31:38 +01001774#else /* !MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1775
1776#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1777 { \
1778 mbedtls_md_type_t MD_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID; \
1779 ((void) ssl);
1780
1781#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1782 }
1783
1784#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1785 { \
1786 unsigned char HASH_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID; \
1787 ((void) ssl);
1788
1789
1790#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1791 }
1792
1793#endif /* MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1794
Hanno Becker1f5a7932019-07-03 14:58:59 +01001795#if defined(__GNUC__) || defined(__arm__)
1796#define MBEDTLS_ALWAYS_INLINE __attribute__((always_inline))
1797#else
1798#define MBEDTLS_ALWAYS_INLINE
1799#endif
1800
Hanno Beckereeabfa42019-07-25 10:28:30 +01001801/* This internal function can be used to pend a fatal alert for
1802 * later delivery.
1803 *
Hanno Beckerb82350b2019-07-26 07:24:05 +01001804 * The check for pending alerts must be done by calling
Hanno Beckerdd691192019-07-26 09:59:18 +01001805 * the function ssl_send_pending_fatal_alert() in ssl_tls.c.
Hanno Beckerfcb721d2019-07-26 12:47:16 +01001806 * Currently, it happens only during the handshake loop and after
1807 * calling ssl_get_next_record() in the record processing stack.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001808 *
Hanno Beckerc8f52992019-07-25 11:15:08 +01001809 * This function must not be called multiple times without
Hanno Beckerb82350b2019-07-26 07:24:05 +01001810 * sending the pending fatal alerts in between.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001811 */
Hanno Beckerd829d0f2019-07-25 10:28:57 +01001812MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_pend_fatal_alert(
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001813 mbedtls_ssl_context *ssl,
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001814 unsigned char message )
1815{
Hanno Beckerc8f52992019-07-25 11:15:08 +01001816 ssl->pending_fatal_alert_msg = message;
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001817}
1818
Hanno Becker868cb582019-07-23 14:29:13 +01001819#define MBEDTLS_SSL_CHK(f) do { if( ( ret = f ) < 0 ) goto cleanup; } while( 0 )
Hanno Becker5d397682018-05-21 12:50:34 +01001820
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001821#endif /* ssl_internal.h */