blob: 25ded986b7c8ca1e0df9c0f71c8a818188a47f14 [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_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
408 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200409 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
410 } ecrs_state; /*!< current (or last) operation */
Hanno Beckerdd689312019-02-25 10:08:06 +0000411 mbedtls_x509_crt *ecrs_peer_cert; /*!< The peer's CRT chain. */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200412#endif
Hanno Becker3bf8cdf2019-02-06 16:18:31 +0000413#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
414 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
415 mbedtls_pk_context peer_pubkey; /*!< The public key from the peer. */
416#endif /* MBEDTLS_X509_CRT_PARSE_C && !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200417#if defined(MBEDTLS_SSL_PROTO_DTLS)
418 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
419 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
420
421 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
422 Srv: unused */
423 unsigned char verify_cookie_len; /*!< Cli: cookie length
424 Srv: flag for sending a cookie */
425
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200426 uint32_t retransmit_timeout; /*!< Current value of timeout */
427 unsigned char retransmit_state; /*!< Retransmission state */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200428 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
429 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
430 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200431 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
432 flight being received */
433 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
434 resending messages */
435 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
436 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100437
Hanno Beckera5a2b082019-05-15 14:03:01 +0100438#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +0100439 /* The state of CID configuration in this handshake. */
440
441 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
Hanno Beckercfa6be72019-05-15 10:17:48 +0100442 * has been negotiated. Possible values are
Hanno Beckere5e7f622019-04-25 15:46:59 +0100443 * #MBEDTLS_SSL_CID_ENABLED and
444 * #MBEDTLS_SSL_CID_DISABLED. */
445 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
446 uint8_t peer_cid_len; /*!< The length of
447 * \c peer_cid. */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100448#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100449
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100450 struct
451 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100452 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
453 * buffers used for message buffering. */
454
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100455 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100456 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100457
Hanno Becker0271f962018-08-16 13:23:47 +0100458 struct mbedtls_ssl_hs_buffer
459 {
Hanno Becker98081a02018-08-22 13:32:50 +0100460 unsigned is_valid : 1;
461 unsigned is_fragmented : 1;
462 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100463 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100464 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100465 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
466
Hanno Becker5f066e72018-08-16 14:56:31 +0100467 struct
468 {
469 unsigned char *data;
470 size_t len;
471 unsigned epoch;
472 } future_record;
473
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100474 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100475
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200476 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100477#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200478
479 /*
480 * Checksum contexts
481 */
482#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
483 defined(MBEDTLS_SSL_PROTO_TLS1_1)
484 mbedtls_md5_context fin_md5;
485 mbedtls_sha1_context fin_sha1;
486#endif
487#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
488#if defined(MBEDTLS_SHA256_C)
489 mbedtls_sha256_context fin_sha256;
490#endif
491#if defined(MBEDTLS_SHA512_C)
492 mbedtls_sha512_context fin_sha512;
493#endif
494#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
495
496 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnarda5759752019-05-03 11:43:28 +0200497 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200498 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
499 int (*tls_prf)(const unsigned char *, size_t, const char *,
500 const unsigned char *, size_t,
501 unsigned char *, size_t);
502
Hanno Becker73f4cb12019-06-27 13:51:07 +0100503#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker473f98f2019-06-26 10:27:32 +0100504 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info;
Hanno Becker73f4cb12019-06-27 13:51:07 +0100505#endif /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker8759e162017-12-27 21:34:08 +0000506
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200507 size_t pmslen; /*!< premaster length */
508
509 unsigned char randbytes[64]; /*!< random bytes */
510 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
511 /*!< premaster secret */
512
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300513#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200514 int resume; /*!< session resume indicator*/
Jarno Lamsa29f2dd02019-06-20 15:31:52 +0300515#endif /* !MBEDTLS_SSL_NO_SESSION_RESUMPTION */
Hanno Becker18729ae2019-06-12 14:47:21 +0100516
517#if defined(MBEDTLS_SSL_SRV_C) && \
518 ( defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
519 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) )
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200520 int max_major_ver; /*!< max. major version client*/
521 int max_minor_ver; /*!< max. minor version client*/
Hanno Becker18729ae2019-06-12 14:47:21 +0100522#endif /* MBEDTLS_SSL_SRV_C && ( MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ||
523 MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED ) */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200524 int cli_exts; /*!< client extension presence*/
525
526#if defined(MBEDTLS_SSL_SESSION_TICKETS)
527 int new_session_ticket; /*!< use NewSessionTicket? */
528#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Hanno Becker1ab322b2019-06-11 14:50:54 +0100529#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) && \
530 !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200531 int extended_ms; /*!< use Extended Master Secret? */
532#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200533
534#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200535 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200536#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
537
538#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
539 /** Asynchronous operation context. This field is meant for use by the
540 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
541 * mbedtls_ssl_config::f_async_decrypt_start,
542 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
543 * The library does not use it internally. */
544 void *user_async_ctx;
545#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200546};
547
Hanno Beckera49ec562019-06-11 14:47:55 +0100548/*
549 * Getter functions for fields in mbedtls_ssl_handshake_params which
550 * may be statically implied by the configuration and hence be omitted
551 * from the structure.
552 */
553#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
554static inline int mbedtls_ssl_hs_get_extended_ms(
555 mbedtls_ssl_handshake_params const *params )
556{
557#if !defined(MBEDTLS_SSL_EXTENDED_MS_ENFORCED)
558 return( params->extended_ms );
559#else
560 ((void) params);
561 return( MBEDTLS_SSL_EXTENDED_MS_ENABLED );
562#endif /* MBEDTLS_SSL_EXTENDED_MS_ENFORCED */
563}
564#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
565
Hanno Becker73f4cb12019-06-27 13:51:07 +0100566#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Beckerdf645962019-06-26 13:02:22 +0100567static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
568 mbedtls_ssl_handshake_params const *handshake )
569{
570 return( handshake->ciphersuite_info );
571}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100572#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100573static inline mbedtls_ssl_ciphersuite_handle_t mbedtls_ssl_handshake_get_ciphersuite(
574 mbedtls_ssl_handshake_params const *handshake )
575{
576 ((void) handshake);
577 return( MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE );
578}
Hanno Becker73f4cb12019-06-27 13:51:07 +0100579#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Beckerdf645962019-06-26 13:02:22 +0100580
Hanno Becker0271f962018-08-16 13:23:47 +0100581typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
582
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200583/*
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000584 * Representation of decryption/encryption transformations on records
585 *
586 * There are the following general types of record transformations:
587 * - Stream transformations (TLS versions <= 1.2 only)
588 * Transformation adding a MAC and applying a stream-cipher
589 * to the authenticated message.
590 * - CBC block cipher transformations ([D]TLS versions <= 1.2 only)
591 * In addition to the distinction of the order of encryption and
592 * authentication, there's a fundamental difference between the
593 * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3
594 * and TLS 1.0, the final IV after processing a record is used
595 * as the IV for the next record. No explicit IV is contained
596 * in an encrypted record. The IV for the first record is extracted
597 * at key extraction time. In contrast, for TLS 1.1 and 1.2, no
598 * IV is generated at key extraction time, but every encrypted
599 * record is explicitly prefixed by the IV with which it was encrypted.
600 * - AEAD transformations ([D]TLS versions >= 1.2 only)
601 * These come in two fundamentally different versions, the first one
602 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
603 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
604 * In the first transformation, the IV to be used for a record is obtained
605 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
606 * record sequence number, and explicitly prepending this sequence number
607 * to the encrypted record. In contrast, in the second transformation
608 * the IV is obtained by XOR'ing a static IV obtained at key extraction
609 * time with the 8-byte record sequence number, without prepending the
610 * latter to the encrypted record.
611 *
612 * In addition to type and version, the following parameters are relevant:
613 * - The symmetric cipher algorithm to be used.
614 * - The (static) encryption/decryption keys for the cipher.
615 * - For stream/CBC, the type of message digest to be used.
616 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Beckera198bb72018-10-18 15:39:53 +0100617 * - For AEAD transformations, the size (potentially 0) of an explicit,
618 * random initialization vector placed in encrypted records.
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000619 * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0)
620 * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC)
621 * and (if present) is combined with the explicit IV in a transformation-
622 * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
623 * - For stream/CBC, a flag determining the order of encryption and MAC.
624 * - The details of the transformation depend on the SSL/TLS version.
625 * - The length of the authentication tag.
626 *
Hanno Beckera198bb72018-10-18 15:39:53 +0100627 * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are
628 * constant across multiple encryption/decryption operations.
629 * For CBC, the implicit IV needs to be updated after each
630 * operation.
631 *
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000632 * The struct below refines this abstract view as follows:
633 * - The cipher underlying the transformation is managed in
634 * cipher contexts cipher_ctx_{enc/dec}, which must have the
635 * same cipher type. The mode of these cipher contexts determines
636 * the type of the transformation in the sense above: e.g., if
637 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
638 * then the transformation has type CBC resp. AEAD.
639 * - The cipher keys are never stored explicitly but
640 * are maintained within cipher_ctx_{enc/dec}.
641 * - For stream/CBC transformations, the message digest contexts
642 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
643 * are unused for AEAD transformations.
644 * - For stream/CBC transformations and versions > SSL3, the
645 * MAC keys are not stored explicitly but maintained within
646 * md_ctx_{enc/dec}.
647 * - For stream/CBC transformations and version SSL3, the MAC
648 * keys are stored explicitly in mac_enc, mac_dec and have
649 * a fixed size of 20 bytes. These fields are unused for
650 * AEAD transformations or transformations >= TLS 1.0.
651 * - For transformations using an implicit IV maintained within
652 * the transformation context, its contents are stored within
653 * iv_{enc/dec}.
654 * - The value of ivlen indicates the length of the IV.
655 * This is redundant in case of stream/CBC transformations
656 * which always use 0 resp. the cipher's block length as the
657 * IV length, but is needed for AEAD ciphers and may be
658 * different from the underlying cipher's block length
659 * in this case.
660 * - The field fixed_ivlen is nonzero for AEAD transformations only
661 * and indicates the length of the static part of the IV which is
662 * constant throughout the communication, and which is stored in
663 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
664 * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec}
665 * still store IV's for continued use across multiple transformations,
666 * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are
667 * not being used!
668 * - minor_ver denotes the SSL/TLS version
669 * - For stream/CBC transformations, maclen denotes the length of the
670 * authentication tag, while taglen is unused and 0.
671 * - For AEAD transformations, taglen denotes the length of the
672 * authentication tag, while maclen is unused and 0.
673 * - For CBC transformations, encrypt_then_mac determines the
674 * order of encryption and authentication. This field is unused
675 * in other transformations.
676 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200677 */
678struct mbedtls_ssl_transform
679{
680 /*
681 * Session specific crypto layer
682 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200683 size_t minlen; /*!< min. ciphertext length */
684 size_t ivlen; /*!< IV length */
685 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Becker8759e162017-12-27 21:34:08 +0000686 size_t maclen; /*!< MAC(CBC) len */
687 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200688
689 unsigned char iv_enc[16]; /*!< IV (encryption) */
690 unsigned char iv_dec[16]; /*!< IV (decryption) */
691
Hanno Becker92231322018-01-03 15:32:51 +0000692#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
693
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200694#if defined(MBEDTLS_SSL_PROTO_SSL3)
695 /* Needed only for SSL v3.0 secret */
696 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
697 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
698#endif /* MBEDTLS_SSL_PROTO_SSL3 */
699
700 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
701 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
702
Hanno Becker3307b532017-12-27 21:37:21 +0000703#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
704 int encrypt_then_mac; /*!< flag for EtM activation */
705#endif
706
Hanno Becker92231322018-01-03 15:32:51 +0000707#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
708
709 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
710 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Hanno Becker0a92b812019-06-24 15:46:40 +0100711
712#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker3307b532017-12-27 21:37:21 +0000713 int minor_ver;
Hanno Becker0a92b812019-06-24 15:46:40 +0100714#endif
Hanno Becker3307b532017-12-27 21:37:21 +0000715
Hanno Beckera5a2b082019-05-15 14:03:01 +0100716#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100717 uint8_t in_cid_len;
718 uint8_t out_cid_len;
719 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
720 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera5a2b082019-05-15 14:03:01 +0100721#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100722
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200723 /*
724 * Session specific compression layer
725 */
726#if defined(MBEDTLS_ZLIB_SUPPORT)
727 z_stream ctx_deflate; /*!< compression context */
728 z_stream ctx_inflate; /*!< decompression context */
729#endif
Manuel Pégourié-Gonnarda3024ee2019-07-09 12:54:17 +0200730
731#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
732 /* We need the Hello random bytes in order to re-derive keys from the
733 * Master Secret and other session info, see ssl_populate_transform() */
734 unsigned char randbytes[64]; /*!< ServerHello.random+ClientHello.random */
735#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200736};
737
Hanno Becker0a92b812019-06-24 15:46:40 +0100738static inline int mbedtls_ssl_transform_get_minor_ver( mbedtls_ssl_transform const *transform )
739{
740#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
741 return( transform->minor_ver );
742#else
743 ((void) transform);
744 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
745#endif
746}
747
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000748/*
Manuel Pégourié-Gonnard569ed6b2019-07-10 14:14:05 +0200749 * Return 1 if the transform uses an AEAD cipher, 0 otherwise.
750 * Equivalently, return 0 if a separate MAC is used, 1 otherwise.
751 */
752static inline int mbedtls_ssl_transform_uses_aead(
753 const mbedtls_ssl_transform *transform )
754{
755#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
756 return( transform->maclen == 0 && transform->taglen != 0 );
757#else
758 (void) transform;
759 return( 1 );
760#endif
761}
762
763/*
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000764 * Internal representation of record frames
765 *
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000766 * Instances come in two flavors:
767 * (1) Encrypted
768 * These always have data_offset = 0
769 * (2) Unencrypted
Hanno Beckerf8323432019-04-04 16:29:48 +0100770 * These have data_offset set to the amount of
771 * pre-expansion during record protection. Concretely,
772 * this is the length of the fixed part of the explicit IV
773 * used for encryption, or 0 if no explicit IV is used
774 * (e.g. for CBC in TLS 1.0, or stream ciphers).
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000775 *
776 * The reason for the data_offset in the unencrypted case
777 * is to allow for in-place conversion of an unencrypted to
778 * an encrypted record. If the offset wasn't included, the
779 * encrypted content would need to be shifted afterwards to
780 * make space for the fixed IV.
781 *
782 */
Hanno Becker80fe63e2019-04-29 13:45:54 +0100783#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100784#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100785#else
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100786#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100787#endif
788
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000789typedef struct
790{
Hanno Beckere84b28c2019-07-11 09:24:36 +0100791 uint8_t ctr[8]; /* In TLS: The implicit record sequence number.
792 * In DTLS: The 2-byte epoch followed by
793 * the 6-byte sequence number.
794 * This is stored as a raw big endian byte array
795 * as opposed to a uint64_t because we rarely
796 * need to perform arithmetic on this, but do
797 * need it as a Byte array for the purpose of
798 * MAC computations. */
799 uint8_t type; /* The record content type. */
800 uint8_t ver[2]; /* SSL/TLS version as present on the wire.
801 * Convert to internal presentation of versions
802 * using mbedtls_ssl_read_version() and
803 * mbedtls_ssl_write_version().
804 * Keep wire-format for MAC computations. */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000805
Hanno Beckere84b28c2019-07-11 09:24:36 +0100806 unsigned char *buf; /* Memory buffer enclosing the record content */
807 size_t buf_len; /* Buffer length */
808 size_t data_offset; /* Offset of record content */
809 size_t data_len; /* Length of record content */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000810
Hanno Beckera5a2b082019-05-15 14:03:01 +0100811#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere84b28c2019-07-11 09:24:36 +0100812 uint8_t cid_len; /* Length of the CID (0 if not present) */
813 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100814#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000815} mbedtls_record;
816
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200817#if defined(MBEDTLS_X509_CRT_PARSE_C)
818/*
819 * List of certificate + private key pairs
820 */
821struct mbedtls_ssl_key_cert
822{
823 mbedtls_x509_crt *cert; /*!< cert */
824 mbedtls_pk_context *key; /*!< private key */
825 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
826};
827#endif /* MBEDTLS_X509_CRT_PARSE_C */
828
829#if defined(MBEDTLS_SSL_PROTO_DTLS)
830/*
831 * List of handshake messages kept around for resending
832 */
833struct mbedtls_ssl_flight_item
834{
835 unsigned char *p; /*!< message, including handshake headers */
836 size_t len; /*!< length of p */
837 unsigned char type; /*!< type of the message: handshake or CCS */
838 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
839};
840#endif /* MBEDTLS_SSL_PROTO_DTLS */
841
Hanno Becker7e5437a2017-04-28 17:15:26 +0100842#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
843 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
844
845/* Find an entry in a signature-hash set matching a given hash algorithm. */
846mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
847 mbedtls_pk_type_t sig_alg );
848/* Add a signature-hash-pair to a signature-hash set */
849void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
850 mbedtls_pk_type_t sig_alg,
851 mbedtls_md_type_t md_alg );
852/* Allow exactly one hash algorithm for each signature. */
853void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
854 mbedtls_md_type_t md_alg );
855
856/* Setup an empty signature-hash set */
857static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
858{
859 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
860}
861
862#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
863 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200864
865/**
866 * \brief Free referenced items in an SSL transform context and clear
867 * memory
868 *
869 * \param transform SSL transform context
870 */
871void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
872
873/**
874 * \brief Free referenced items in an SSL handshake context and clear
875 * memory
876 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200877 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200878 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200879void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200880
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200881int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
882int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
883void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
884
885int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
886
887void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
888int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
889
Simon Butcher99000142016-10-13 17:21:01 +0100890int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
891int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
892void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
893
Hanno Becker4a810fb2017-05-24 16:27:30 +0100894/**
895 * \brief Update record layer
896 *
897 * This function roughly separates the implementation
898 * of the logic of (D)TLS from the implementation
899 * of the secure transport.
900 *
Hanno Becker3a0aad12018-08-20 09:44:02 +0100901 * \param ssl The SSL context to use.
902 * \param update_hs_digest This indicates if the handshake digest
903 * should be automatically updated in case
904 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +0100905 *
906 * \return 0 or non-zero error code.
907 *
908 * \note A clarification on what is called 'record layer' here
909 * is in order, as many sensible definitions are possible:
910 *
911 * The record layer takes as input an untrusted underlying
912 * transport (stream or datagram) and transforms it into
913 * a serially multiplexed, secure transport, which
914 * conceptually provides the following:
915 *
916 * (1) Three datagram based, content-agnostic transports
917 * for handshake, alert and CCS messages.
918 * (2) One stream- or datagram-based transport
919 * for application data.
920 * (3) Functionality for changing the underlying transform
921 * securing the contents.
922 *
923 * The interface to this functionality is given as follows:
924 *
925 * a Updating
926 * [Currently implemented by mbedtls_ssl_read_record]
927 *
928 * Check if and on which of the four 'ports' data is pending:
929 * Nothing, a controlling datagram of type (1), or application
930 * data (2). In any case data is present, internal buffers
931 * provide access to the data for the user to process it.
932 * Consumption of type (1) datagrams is done automatically
933 * on the next update, invalidating that the internal buffers
934 * for previous datagrams, while consumption of application
935 * data (2) is user-controlled.
936 *
937 * b Reading of application data
938 * [Currently manual adaption of ssl->in_offt pointer]
939 *
940 * As mentioned in the last paragraph, consumption of data
941 * is different from the automatic consumption of control
942 * datagrams (1) because application data is treated as a stream.
943 *
944 * c Tracking availability of application data
945 * [Currently manually through decreasing ssl->in_msglen]
946 *
947 * For efficiency and to retain datagram semantics for
948 * application data in case of DTLS, the record layer
949 * provides functionality for checking how much application
950 * data is still available in the internal buffer.
951 *
952 * d Changing the transformation securing the communication.
953 *
954 * Given an opaque implementation of the record layer in the
955 * above sense, it should be possible to implement the logic
956 * of (D)TLS on top of it without the need to know anything
957 * about the record layer's internals. This is done e.g.
958 * in all the handshake handling functions, and in the
959 * application data reading function mbedtls_ssl_read.
960 *
961 * \note The above tries to give a conceptual picture of the
962 * record layer, but the current implementation deviates
963 * from it in some places. For example, our implementation of
964 * the update functionality through mbedtls_ssl_read_record
965 * discards datagrams depending on the current state, which
966 * wouldn't fall under the record layer's responsibility
967 * following the above definition.
968 *
969 */
Hanno Becker3a0aad12018-08-20 09:44:02 +0100970int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
971 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200972int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
973
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +0200974int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100975int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200976int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
977
978int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
979int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
980
981int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
982int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
983
984int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
985int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
986
987void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
Hanno Becker473f98f2019-06-26 10:27:32 +0100988 mbedtls_ssl_ciphersuite_handle_t ciphersuite_info );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200989
Hanno Becker09d23642019-07-22 17:18:18 +0100990int mbedtls_ssl_build_pms( mbedtls_ssl_context *ssl );
991
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200992#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
993int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
994#endif
995
996#if defined(MBEDTLS_PK_C)
997unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +0100998unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200999mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
1000#endif
1001
1002mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001003unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Simon Butcher99000142016-10-13 17:21:01 +01001004int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001005
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001006#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +02001007int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001008#endif
1009
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001010#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +02001011int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
1012 mbedtls_md_type_t md );
1013#endif
1014
Hanno Becker2881d802019-05-22 14:44:53 +01001015static inline int mbedtls_ssl_get_minor_ver( mbedtls_ssl_context const *ssl )
1016{
Hanno Becker381eaa52019-06-12 14:43:01 +01001017#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001018 return( ssl->minor_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001019#else /* !MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
1020 ((void) ssl);
1021 return( MBEDTLS_SSL_CONF_FIXED_MINOR_VER );
1022#endif /* MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001023}
1024
1025static inline int mbedtls_ssl_get_major_ver( mbedtls_ssl_context const *ssl )
1026{
Hanno Becker381eaa52019-06-12 14:43:01 +01001027#if !defined(MBEDTLS_SSL_CONF_FIXED_MAJOR_VER)
Hanno Becker2881d802019-05-22 14:44:53 +01001028 return( ssl->major_ver );
Hanno Becker381eaa52019-06-12 14:43:01 +01001029#else /* !MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
1030 ((void) ssl);
1031 return( MBEDTLS_SSL_CONF_FIXED_MAJOR_VER );
1032#endif /* MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
Hanno Becker2881d802019-05-22 14:44:53 +01001033}
1034
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001035#if defined(MBEDTLS_X509_CRT_PARSE_C)
1036static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
1037{
1038 mbedtls_ssl_key_cert *key_cert;
1039
1040 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1041 key_cert = ssl->handshake->key_cert;
1042 else
1043 key_cert = ssl->conf->key_cert;
1044
1045 return( key_cert == NULL ? NULL : key_cert->key );
1046}
1047
1048static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
1049{
1050 mbedtls_ssl_key_cert *key_cert;
1051
1052 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
1053 key_cert = ssl->handshake->key_cert;
1054 else
1055 key_cert = ssl->conf->key_cert;
1056
1057 return( key_cert == NULL ? NULL : key_cert->cert );
1058}
1059
1060/*
1061 * Check usage of a certificate wrt extensions:
1062 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
1063 *
1064 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
1065 * check a cert we received from them)!
1066 *
1067 * Return 0 if everything is OK, -1 if not.
1068 */
1069int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
Hanno Becker473f98f2019-06-26 10:27:32 +01001070 mbedtls_ssl_ciphersuite_handle_t ciphersuite,
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001071 int cert_endpoint,
1072 uint32_t *flags );
1073#endif /* MBEDTLS_X509_CRT_PARSE_C */
1074
Hanno Becker43395762019-05-03 14:46:38 +01001075static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001076{
Hanno Beckerf903dc82019-07-12 09:55:46 +01001077#if !defined(MBEDTLS_SSL_PROTO__BOTH)
1078 ((void) ssl);
1079#endif
1080
1081#if defined(MBEDTLS_SSL_PROTO_DTLS)
1082 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1083 {
1084 return( 13 );
1085 }
1086 MBEDTLS_SSL_TRANSPORT_ELSE
1087#endif /* MBEDTLS_SSL_PROTO_DTLS */
1088#if defined(MBEDTLS_SSL_PROTO_TLS)
1089 {
1090 return( 5 );
1091 }
1092#endif /* MBEDTLS_SSL_PROTO_TLS */
Hanno Becker43395762019-05-03 14:46:38 +01001093}
1094
1095static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
1096{
Hanno Beckerccc24562019-05-03 15:05:27 +01001097 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001098}
1099
1100static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
1101{
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001102#if !defined(MBEDTLS_SSL_PROTO__BOTH)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001103 ((void) ssl);
1104#endif
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001105
1106#if defined(MBEDTLS_SSL_PROTO_DTLS)
1107 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
1108 return( 12 );
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001109 MBEDTLS_SSL_TRANSPORT_ELSE
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +01001110#endif
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +02001111#if defined(MBEDTLS_SSL_PROTO_TLS)
1112 return( 4 );
1113#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001114}
1115
1116#if defined(MBEDTLS_SSL_PROTO_DTLS)
1117void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
1118void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
1119int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +02001120int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001121#endif
1122
1123/* Visible for testing purposes only */
1124#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Beckerfc551722019-07-12 08:50:37 +01001125int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context const *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001126void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
1127#endif
1128
Hanno Becker58fccf22019-02-06 14:30:46 +00001129int mbedtls_ssl_session_copy( mbedtls_ssl_session *dst,
1130 const mbedtls_ssl_session *src );
1131
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001132/* constant-time buffer comparison */
1133static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
1134{
1135 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +01001136 volatile const unsigned char *A = (volatile const unsigned char *) a;
1137 volatile const unsigned char *B = (volatile const unsigned char *) b;
1138 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001139
1140 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001141 {
1142 /* Read volatile data in order before computing diff.
1143 * This avoids IAR compiler warning:
1144 * 'the order of volatile accesses is undefined ..' */
1145 unsigned char x = A[i], y = B[i];
1146 diff |= x ^ y;
1147 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001148
1149 return( diff );
1150}
1151
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001152#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1153 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1154int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl,
1155 unsigned char *output,
1156 unsigned char *data, size_t data_len );
1157#endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \
1158 MBEDTLS_SSL_PROTO_TLS1_1 */
1159
1160#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1161 defined(MBEDTLS_SSL_PROTO_TLS1_2)
1162int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001163 unsigned char *hash, size_t *hashlen,
1164 unsigned char *data, size_t data_len,
1165 mbedtls_md_type_t md_alg );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001166#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1167 MBEDTLS_SSL_PROTO_TLS1_2 */
1168
Hanno Becker7b628e52019-06-12 14:45:11 +01001169/*
1170 * Convert version numbers to/from wire format
1171 * and, for DTLS, to/from TLS equivalent.
1172 *
1173 * For TLS this is the identity.
1174 * For DTLS, use 1's complement (v -> 255 - v, and then map as follows:
1175 * 1.0 <-> 3.2 (DTLS 1.0 is based on TLS 1.1)
1176 * 1.x <-> 3.x+1 for x != 0 (DTLS 1.2 based on TLS 1.2)
1177 */
1178static inline void mbedtls_ssl_write_version( int major, int minor,
1179 int transport,
1180 unsigned char ver[2] )
1181{
1182#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1183 ((void) transport);
1184#endif
1185
1186#if defined(MBEDTLS_SSL_PROTO_DTLS)
1187 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1188 {
1189 if( minor == MBEDTLS_SSL_MINOR_VERSION_2 )
1190 --minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1191
1192 ver[0] = (unsigned char)( 255 - ( major - 2 ) );
1193 ver[1] = (unsigned char)( 255 - ( minor - 1 ) );
1194 }
1195 MBEDTLS_SSL_TRANSPORT_ELSE
1196#endif
1197#if defined(MBEDTLS_SSL_PROTO_TLS)
1198 {
1199 ver[0] = (unsigned char) major;
1200 ver[1] = (unsigned char) minor;
1201 }
1202#endif
1203}
1204
1205static inline void mbedtls_ssl_read_version( int *major, int *minor,
1206 int transport,
1207 const unsigned char ver[2] )
1208{
1209#if !defined(MBEDTLS_SSL_TRANSPORT__BOTH)
1210 ((void) transport);
1211#endif
1212
1213#if defined(MBEDTLS_SSL_PROTO_DTLS)
1214 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( transport ) )
1215 {
1216 *major = 255 - ver[0] + 2;
1217 *minor = 255 - ver[1] + 1;
1218
1219 if( *minor == MBEDTLS_SSL_MINOR_VERSION_1 )
1220 ++*minor; /* DTLS 1.0 stored as TLS 1.1 internally */
1221 }
1222 MBEDTLS_SSL_TRANSPORT_ELSE
1223#endif /* MBEDTLS_SSL_PROTO_DTLS */
1224#if defined(MBEDTLS_SSL_PROTO_TLS)
1225 {
1226 *major = ver[0];
1227 *minor = ver[1];
1228 }
1229#endif /* MBEDTLS_SSL_PROTO_TLS */
1230}
1231
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001232#ifdef __cplusplus
1233}
1234#endif
1235
Hanno Becker611a83b2018-01-03 14:27:32 +00001236void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1237int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1238 mbedtls_ssl_transform *transform,
1239 mbedtls_record *rec,
1240 int (*f_rng)(void *, unsigned char *, size_t),
1241 void *p_rng );
Hanno Becker40478be2019-07-12 08:23:59 +01001242int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context const *ssl,
Hanno Becker611a83b2018-01-03 14:27:32 +00001243 mbedtls_ssl_transform *transform,
1244 mbedtls_record *rec );
1245
Hanno Becker57e72c72019-06-12 12:46:31 +01001246
1247/*
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001248 * Accessor functions for optional fields of various structures
1249 */
1250
1251static inline int mbedtls_ssl_handshake_get_resume(
1252 const mbedtls_ssl_handshake_params *handshake )
1253{
1254#if !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
1255 return( handshake->resume );
1256#else
1257 (void) handshake;
1258 return( 0 );
1259#endif
1260}
1261
1262static inline int mbedtls_ssl_get_renego_status(
1263 const mbedtls_ssl_context *ssl )
1264{
1265#if defined(MBEDTLS_SSL_RENEGOTIATION)
1266 return( ssl->renego_status );
1267#else
1268 (void) ssl;
1269 return( MBEDTLS_SSL_INITIAL_HANDSHAKE );
1270#endif
1271}
1272
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001273static inline int mbedtls_ssl_conf_is_renegotiation_enabled(
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001274 const mbedtls_ssl_config *conf )
1275{
1276#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001277 return( conf->disable_renegotiation ==
1278 MBEDTLS_SSL_RENEGOTIATION_ENABLED );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001279#else
1280 (void) conf;
Manuel Pégourié-Gonnard18332c52019-07-29 12:17:52 +02001281 return( 0 );
Manuel Pégourié-Gonnardb3bb31b2019-07-26 16:37:45 +02001282#endif
1283}
Manuel Pégourié-Gonnard1772c9f2019-07-02 15:18:36 +02001284
1285/*
Hanno Becker57e72c72019-06-12 12:46:31 +01001286 * Getter functions for fields in mbedtls_ssl_config which may
1287 * be fixed at compile time via one of MBEDTLS_SSL_SSL_CONF_XXX.
1288 */
1289
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001290#if defined(MBEDTLS_SSL_SRV_C)
1291#if !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
1292static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1293 mbedtls_ssl_config const *conf )
1294{
1295 return( conf->cert_req_ca_list );
1296}
1297#else /* !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1298static inline unsigned int mbedtls_ssl_conf_get_cert_req_ca_list(
1299 mbedtls_ssl_config const *conf )
1300{
1301 ((void) conf);
1302 return( MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST );
1303}
1304#endif /* MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
1305#endif /* MBEDTLS_SSL_SRV_C */
1306
Hanno Becker2d9623f2019-06-13 12:07:05 +01001307#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
1308static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1309 mbedtls_ssl_config const *conf )
1310{
1311 return( conf->endpoint );
1312}
1313#else /* !MBEDTLS_SSL_CONF_ENDPOINT */
1314static inline unsigned int mbedtls_ssl_conf_get_endpoint(
1315 mbedtls_ssl_config const *conf )
1316{
1317 ((void) conf);
1318 return( MBEDTLS_SSL_CONF_ENDPOINT );
1319}
1320#endif /* MBEDTLS_SSL_CONF_ENDPOINT */
1321
Hanno Becker1f835fa2019-06-13 10:14:59 +01001322#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
1323static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1324 mbedtls_ssl_config const *conf )
1325{
1326 return( conf->read_timeout );
1327}
1328#else /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
1329static inline uint32_t mbedtls_ssl_conf_get_read_timeout(
1330 mbedtls_ssl_config const *conf )
1331{
1332 ((void) conf);
1333 return( MBEDTLS_SSL_CONF_READ_TIMEOUT );
1334}
1335#endif /* MBEDTLS_SSL_CONF_READ_TIMEOUT */
1336
1337#if defined(MBEDTLS_SSL_PROTO_DTLS)
1338#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN)
1339static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1340 mbedtls_ssl_config const *conf )
1341{
1342 return( conf->hs_timeout_min );
1343}
1344#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1345static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_min(
1346 mbedtls_ssl_config const *conf )
1347{
1348 ((void) conf);
1349 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN );
1350}
1351#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1352
1353#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX)
1354static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1355 mbedtls_ssl_config const *conf )
1356{
1357 return( conf->hs_timeout_max );
1358}
1359#else /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1360static inline uint32_t mbedtls_ssl_conf_get_hs_timeout_max(
1361 mbedtls_ssl_config const *conf )
1362{
1363 ((void) conf);
1364 return( MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX );
1365}
1366#endif /* MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1367#endif /* MBEDTLS_SSL_PROTO_DTLS */
1368
Hanno Beckere0200da2019-06-13 09:23:43 +01001369#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
1370#if !defined(MBEDTLS_SSL_CONF_CID_LEN)
1371static inline size_t mbedtls_ssl_conf_get_cid_len(
1372 mbedtls_ssl_config const *conf )
1373{
1374 return( conf->cid_len );
1375}
1376#else /* !MBEDTLS_SSL_CONF_CID_LEN */
1377static inline size_t mbedtls_ssl_conf_get_cid_len(
1378 mbedtls_ssl_config const *conf )
1379{
1380 ((void) conf);
1381 return( MBEDTLS_SSL_CONF_CID_LEN );
1382}
1383#endif /* MBEDTLS_SSL_CONF_CID_LEN */
1384
1385#if !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
1386static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1387 mbedtls_ssl_config const *conf )
1388{
1389 return( conf->ignore_unexpected_cid );
1390}
1391#else /* !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1392static inline unsigned int mbedtls_ssl_conf_get_ignore_unexpected_cid(
1393 mbedtls_ssl_config const *conf )
1394{
1395 ((void) conf);
1396 return( MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID );
1397}
1398#endif /* MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
1399#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1400
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001401#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
1402static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1403 mbedtls_ssl_config const *conf )
1404{
1405 return( conf->allow_legacy_renegotiation );
1406}
1407#else /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1408static inline unsigned int mbedtls_ssl_conf_get_allow_legacy_renegotiation(
1409 mbedtls_ssl_config const *conf )
1410{
1411 ((void) conf);
1412 return( MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION );
1413}
1414#endif /* MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
1415
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001416#if !defined(MBEDTLS_SSL_CONF_AUTHMODE)
1417static inline int mbedtls_ssl_conf_get_authmode(
1418 mbedtls_ssl_config const *conf )
1419{
1420 return( conf->authmode );
1421}
1422#else /* !MBEDTLS_SSL_CONF_AUTHMODE */
1423static inline int mbedtls_ssl_conf_get_authmode(
1424 mbedtls_ssl_config const *conf )
1425{
1426 ((void) conf);
1427 return( MBEDTLS_SSL_CONF_AUTHMODE );
1428}
1429#endif /* MBEDTLS_SSL_CONF_AUTHMODE */
1430
Hanno Beckerde671542019-06-12 16:30:46 +01001431#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1432#if !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
1433static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1434 mbedtls_ssl_config const *conf )
1435{
1436 return( conf->badmac_limit );
1437}
1438#else /* !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1439static inline unsigned int mbedtls_ssl_conf_get_badmac_limit(
1440 mbedtls_ssl_config const *conf )
1441{
1442 ((void) conf);
1443 return( MBEDTLS_SSL_CONF_BADMAC_LIMIT );
1444}
1445#endif /* MBEDTLS_SSL_CONF_BADMAC_LIMIT */
1446#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1447
Hanno Becker7f376f42019-06-12 16:20:48 +01001448#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1449#if !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
1450static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1451 mbedtls_ssl_config const *conf )
1452{
1453 return( conf->anti_replay );
1454}
1455#else /* !MBEDTLS_SSL_CONF_ANTI_REPLAY */
1456static inline unsigned int mbedtls_ssl_conf_get_anti_replay(
1457 mbedtls_ssl_config const *conf )
1458{
1459 ((void) conf);
1460 return( MBEDTLS_SSL_CONF_ANTI_REPLAY );
1461}
1462#endif /* MBEDTLS_SSL_CONF_ANTI_REPLAY */
1463#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1464
Hanno Becker0ae6b242019-06-13 16:45:36 +01001465#if !defined(MBEDTLS_SSL_CONF_SET_TIMER)
1466static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1467 mbedtls_ssl_context const *ssl )
1468{
1469 return( ssl->f_set_timer );
1470}
1471#else /* !MBEDTLS_SSL_CONF_SET_TIMER */
1472
1473#define mbedtls_ssl_conf_set_timer_func MBEDTLS_SSL_CONF_SET_TIMER
1474extern void mbedtls_ssl_conf_set_timer_func( void*, uint32_t, uint32_t );
1475
1476static inline mbedtls_ssl_set_timer_t* mbedtls_ssl_get_set_timer(
1477 mbedtls_ssl_context const *ssl )
1478{
1479 ((void) ssl);
1480 return ((mbedtls_ssl_set_timer_t*) mbedtls_ssl_conf_set_timer_func);
1481}
1482#endif /* MBEDTLS_SSL_CONF_SET_TIMER */
1483
1484#if !defined(MBEDTLS_SSL_CONF_GET_TIMER)
1485static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1486 mbedtls_ssl_context const *ssl )
1487{
1488 return( ssl->f_get_timer );
1489}
1490#else /* !MBEDTLS_SSL_CONF_GET_TIMER */
1491
1492#define mbedtls_ssl_conf_get_timer_func MBEDTLS_SSL_CONF_GET_TIMER
1493extern int mbedtls_ssl_conf_get_timer_func( void* );
1494
1495static inline mbedtls_ssl_get_timer_t* mbedtls_ssl_get_get_timer(
1496 mbedtls_ssl_context const *ssl )
1497{
1498 ((void) ssl);
1499 return ((mbedtls_ssl_get_timer_t*) mbedtls_ssl_conf_get_timer_func);
1500}
1501#endif /* MBEDTLS_SSL_CONF_GET_TIMER */
1502
Hanno Beckera58a8962019-06-13 16:11:15 +01001503#if !defined(MBEDTLS_SSL_CONF_RECV)
1504static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1505 mbedtls_ssl_context const *ssl )
1506{
1507 return( ssl->f_recv );
1508}
1509#else /* !MBEDTLS_SSL_CONF_RECV */
1510
1511#define mbedtls_ssl_conf_recv_func MBEDTLS_SSL_CONF_RECV
1512extern int mbedtls_ssl_conf_recv_func( void*, unsigned char*, size_t );
1513
1514static inline mbedtls_ssl_recv_t* mbedtls_ssl_get_recv(
1515 mbedtls_ssl_context const *ssl )
1516{
1517 ((void) ssl);
1518 return ((mbedtls_ssl_recv_t*) mbedtls_ssl_conf_recv_func);
1519}
1520#endif /* MBEDTLS_SSL_CONF_RECV */
1521
1522#if !defined(MBEDTLS_SSL_CONF_SEND)
1523static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1524 mbedtls_ssl_context const *ssl )
1525{
1526 return( ssl->f_send );
1527}
1528#else /* !MBEDTLS_SSL_CONF_SEND */
1529
1530#define mbedtls_ssl_conf_send_func MBEDTLS_SSL_CONF_SEND
1531extern int mbedtls_ssl_conf_send_func( void*, unsigned char const*, size_t );
1532
1533static inline mbedtls_ssl_send_t* mbedtls_ssl_get_send(
1534 mbedtls_ssl_context const *ssl )
1535{
1536 ((void) ssl);
1537 return ((mbedtls_ssl_send_t*) mbedtls_ssl_conf_send_func);
1538}
1539#endif /* MBEDTLS_SSL_CONF_SEND */
1540
1541#if !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
1542static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1543 mbedtls_ssl_context const *ssl )
1544{
1545 return( ssl->f_recv_timeout );
1546}
1547#else /* !MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1548
1549#define mbedtls_ssl_conf_recv_timeout_func MBEDTLS_SSL_CONF_RECV_TIMEOUT
1550extern int mbedtls_ssl_conf_recv_timeout_func(
1551 void*, unsigned char*, size_t, uint32_t );
1552
1553static inline mbedtls_ssl_recv_timeout_t* mbedtls_ssl_get_recv_timeout(
1554 mbedtls_ssl_context const *ssl )
1555{
1556 ((void) ssl);
1557 return ((mbedtls_ssl_recv_timeout_t*) mbedtls_ssl_conf_recv_timeout_func);
1558}
1559#endif /* MBEDTLS_SSL_CONF_RECV_TIMEOUT */
1560
1561typedef int mbedtls_frng_t( void*, unsigned char*, size_t );
1562
Hanno Beckerece325c2019-06-13 15:39:27 +01001563#if !defined(MBEDTLS_SSL_CONF_RNG)
Hanno Beckera58a8962019-06-13 16:11:15 +01001564static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001565 mbedtls_ssl_config const *conf )
1566{
1567 return( conf->f_rng );
1568}
1569#else /* !MBEDTLS_SSL_CONF_RNG */
1570
1571#define mbedtls_ssl_conf_rng_func MBEDTLS_SSL_CONF_RNG
1572extern int mbedtls_ssl_conf_rng_func( void*, unsigned char*, size_t );
1573
Hanno Beckera58a8962019-06-13 16:11:15 +01001574static inline mbedtls_frng_t* mbedtls_ssl_conf_get_frng(
Hanno Beckerece325c2019-06-13 15:39:27 +01001575 mbedtls_ssl_config const *conf )
1576{
1577 ((void) conf);
1578 return ((mbedtls_frng_t*) mbedtls_ssl_conf_rng_func);
1579}
1580#endif /* MBEDTLS_SSL_CONF_RNG */
1581
Hanno Beckere965bd32019-06-12 14:04:34 +01001582static inline int mbedtls_ssl_conf_get_max_major_ver(
1583 mbedtls_ssl_config const *conf )
1584{
1585#if !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
1586 return( conf->max_major_ver );
1587#else
1588 ((void) conf);
1589 return( MBEDTLS_SSL_CONF_MAX_MAJOR_VER );
1590#endif /* MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
1591}
1592
1593static inline int mbedtls_ssl_conf_get_min_major_ver(
1594 mbedtls_ssl_config const *conf )
1595{
1596#if !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
1597 return( conf->min_major_ver );
1598#else /* !MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1599 ((void) conf);
1600 return( MBEDTLS_SSL_CONF_MIN_MAJOR_VER );
1601#endif /* MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1602}
1603
1604static inline int mbedtls_ssl_conf_get_max_minor_ver(
1605 mbedtls_ssl_config const *conf )
1606{
1607#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER)
1608 return( conf->max_minor_ver );
1609#else /* !MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1610 ((void) conf);
1611 return( MBEDTLS_SSL_CONF_MAX_MINOR_VER );
1612#endif /* MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1613}
1614
1615static inline int mbedtls_ssl_conf_get_min_minor_ver(
1616 mbedtls_ssl_config const *conf )
1617{
1618#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER)
1619 return( conf->min_minor_ver );
1620#else /* !MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1621 ((void) conf);
1622 return( MBEDTLS_SSL_CONF_MIN_MINOR_VER );
1623#endif /* MBEDTLS_SSL_CONF_MIN_MINOR_VER */
1624}
1625
Hanno Becker57e72c72019-06-12 12:46:31 +01001626#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1627static inline unsigned int mbedtls_ssl_conf_get_ems(
1628 mbedtls_ssl_config const *conf )
1629{
1630#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
1631 return( conf->extended_ms );
1632#else
1633 ((void) conf);
1634 return( MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET );
1635#endif /* MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET */
1636}
1637
1638static inline unsigned int mbedtls_ssl_conf_get_ems_enforced(
1639 mbedtls_ssl_config const *conf )
1640{
1641#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
1642 return( conf->enforce_extended_master_secret );
1643#else
1644 ((void) conf);
1645 return( MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET );
1646#endif /* MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
1647}
1648#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1649
Hanno Becker14990272019-06-26 11:47:15 +01001650/*
1651 * Macros for the traversal of the list of all enabled ciphersuites.
1652 * This is implemented as a plain loop in case we have a runtime
1653 * configurable list of ciphersuites, and as a simple variable
1654 * instantiation in case a single ciphersuite is enabled at
1655 * compile-time.
1656 */
Hanno Becker73f4cb12019-06-27 13:51:07 +01001657#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Hanno Becker14990272019-06-26 11:47:15 +01001658
1659#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
1660 { \
1661 int const *__id_ptr; \
1662 for( __id_ptr=(ssl)->conf->ciphersuite_list[ (ver) ]; \
1663 *__id_ptr != 0; __id_ptr++ ) \
1664 { \
1665 const int __id = *__id_ptr; \
1666 mbedtls_ssl_ciphersuite_handle_t info; \
1667 info = mbedtls_ssl_ciphersuite_from_id( __id ); \
1668 if( info == MBEDTLS_SSL_CIPHERSUITE_INVALID_HANDLE ) \
1669 continue;
1670
1671#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
1672 } \
1673 }
1674
Hanno Becker73f4cb12019-06-27 13:51:07 +01001675#else /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001676
1677#define MBEDTLS_SSL_BEGIN_FOR_EACH_CIPHERSUITE( ssl, ver, info ) \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001678 do { \
Hanno Becker14990272019-06-26 11:47:15 +01001679 const mbedtls_ssl_ciphersuite_handle_t info = \
1680 MBEDTLS_SSL_CIPHERSUITE_UNIQUE_VALID_HANDLE;
1681
1682#define MBEDTLS_SSL_END_FOR_EACH_CIPHERSUITE \
Hanno Beckerf4d6b492019-07-02 17:13:14 +01001683 } while( 0 );
Hanno Becker14990272019-06-26 11:47:15 +01001684
Hanno Becker73f4cb12019-06-27 13:51:07 +01001685#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Hanno Becker14990272019-06-26 11:47:15 +01001686
Hanno Beckerc1096e72019-06-19 12:30:41 +01001687#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
1688
Hanno Becker7ae30262019-07-10 09:40:52 +01001689#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1690 { \
1691 mbedtls_ecp_group_id const *_gid; \
1692 mbedtls_ecp_curve_info const *_info; \
1693 for( _gid = ssl->conf->curve_list; \
1694 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
1695 { \
1696 uint16_t TLS_ID_VAR; \
1697 _info = mbedtls_ecp_curve_info_from_grp_id( *_gid ) ; \
1698 if( _info == NULL ) \
1699 continue; \
1700 TLS_ID_VAR = _info->tls_id;
Hanno Beckera4a9c692019-06-18 16:55:47 +01001701
1702#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1703 } \
1704 }
1705
1706#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1707 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001708 mbedtls_ecp_group_id const *_gid; \
1709 for( _gid = ssl->conf->curve_list; \
1710 *_gid != MBEDTLS_ECP_DP_NONE; _gid++ ) \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001711 { \
Hanno Becker7ae30262019-07-10 09:40:52 +01001712 mbedtls_ecp_group_id EC_ID_VAR = *_gid; \
Hanno Beckera4a9c692019-06-18 16:55:47 +01001713
1714#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1715 } \
1716 }
1717
Hanno Beckerc1096e72019-06-19 12:30:41 +01001718#else /* !MBEDTLS_SSL_CONF_SINGLE_EC */
1719
1720#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_TLS_ID( TLS_ID_VAR ) \
1721 { \
1722 uint16_t TLS_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_TLS_ID; \
1723 ((void) ssl);
1724
1725#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_TLS_ID \
1726 }
1727
1728#define MBEDTLS_SSL_BEGIN_FOR_EACH_SUPPORTED_EC_GRP_ID( EC_ID_VAR ) \
1729 { \
1730 mbedtls_ecp_group_id EC_ID_VAR = MBEDTLS_SSL_CONF_SINGLE_EC_GRP_ID; \
1731 ((void) ssl);
1732
1733#define MBEDTLS_SSL_END_FOR_EACH_SUPPORTED_EC_GRP_ID \
1734 }
1735
1736#endif /* MBEDTLS_SSL_CONF_SINGLE_EC */
1737
Hanno Becker56595f42019-06-19 16:31:38 +01001738#if !defined(MBEDTLS_SSL_CONF_SINGLE_SIG_HASH)
1739
Hanno Beckerf1bc9e12019-06-19 16:23:21 +01001740#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1741 { \
1742 int const *__md; \
1743 for( __md = ssl->conf->sig_hashes; \
1744 *__md != MBEDTLS_MD_NONE; __md++ ) \
1745 { \
1746 mbedtls_md_type_t MD_VAR = (mbedtls_md_type_t) *__md; \
1747
1748 #define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1749 } \
1750 }
1751
1752#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1753 { \
1754 int const *__md; \
1755 for( __md = ssl->conf->sig_hashes; \
1756 *__md != MBEDTLS_MD_NONE; __md++ ) \
1757 { \
1758 unsigned char HASH_VAR; \
1759 HASH_VAR = mbedtls_ssl_hash_from_md_alg( *__md );
1760
1761#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1762 } \
1763 }
1764
Hanno Becker56595f42019-06-19 16:31:38 +01001765#else /* !MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1766
1767#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH( MD_VAR ) \
1768 { \
1769 mbedtls_md_type_t MD_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_MD_ID; \
1770 ((void) ssl);
1771
1772#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH \
1773 }
1774
1775#define MBEDTLS_SSL_BEGIN_FOR_EACH_SIG_HASH_TLS( HASH_VAR ) \
1776 { \
1777 unsigned char HASH_VAR = MBEDTLS_SSL_CONF_SINGLE_SIG_HASH_TLS_ID; \
1778 ((void) ssl);
1779
1780
1781#define MBEDTLS_SSL_END_FOR_EACH_SIG_HASH_TLS \
1782 }
1783
1784#endif /* MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
1785
Hanno Becker1f5a7932019-07-03 14:58:59 +01001786#if defined(__GNUC__) || defined(__arm__)
1787#define MBEDTLS_ALWAYS_INLINE __attribute__((always_inline))
1788#else
1789#define MBEDTLS_ALWAYS_INLINE
1790#endif
1791
Hanno Beckereeabfa42019-07-25 10:28:30 +01001792/* This internal function can be used to pend a fatal alert for
1793 * later delivery.
1794 *
Hanno Beckerb82350b2019-07-26 07:24:05 +01001795 * The check for pending alerts must be done by calling
Hanno Beckerdd691192019-07-26 09:59:18 +01001796 * the function ssl_send_pending_fatal_alert() in ssl_tls.c.
Hanno Beckerfcb721d2019-07-26 12:47:16 +01001797 * Currently, it happens only during the handshake loop and after
1798 * calling ssl_get_next_record() in the record processing stack.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001799 *
Hanno Beckerc8f52992019-07-25 11:15:08 +01001800 * This function must not be called multiple times without
Hanno Beckerb82350b2019-07-26 07:24:05 +01001801 * sending the pending fatal alerts in between.
Hanno Beckereeabfa42019-07-25 10:28:30 +01001802 */
Hanno Beckerd829d0f2019-07-25 10:28:57 +01001803MBEDTLS_ALWAYS_INLINE static inline void mbedtls_ssl_pend_fatal_alert(
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001804 mbedtls_ssl_context *ssl,
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001805 unsigned char message )
1806{
Hanno Beckerc8f52992019-07-25 11:15:08 +01001807 ssl->pending_fatal_alert_msg = message;
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001808}
1809
Hanno Becker5d397682018-05-21 12:50:34 +01001810#define SSL_PROC_CHK(f) do { if( ( ret = f ) < 0 ) goto cleanup; } while( 0 )
1811
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001812#endif /* ssl_internal.h */