blob: 8089441c4575c2ce52274403f35fadd679f91d7d [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
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200324#ifdef __cplusplus
325extern "C" {
326#endif
327
Hanno Becker7e5437a2017-04-28 17:15:26 +0100328#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
329 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
330/*
331 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
332 */
333struct mbedtls_ssl_sig_hash_set_t
334{
335 /* At the moment, we only need to remember a single suitable
336 * hash algorithm per signature algorithm. As long as that's
337 * the case - and we don't need a general lookup function -
338 * we can implement the sig-hash-set as a map from signatures
339 * to hash algorithms. */
340 mbedtls_md_type_t rsa;
341 mbedtls_md_type_t ecdsa;
342};
343#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
344 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
345
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200346/*
347 * This structure contains the parameters only needed during handshake.
348 */
349struct mbedtls_ssl_handshake_params
350{
351 /*
352 * Handshake specific crypto variables
353 */
Hanno Becker7e5437a2017-04-28 17:15:26 +0100354
355#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
356 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
357 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
358#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200359#if defined(MBEDTLS_DHM_C)
360 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
361#endif
362#if defined(MBEDTLS_ECDH_C)
363 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
364#endif
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200365#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard76cfd3f2015-09-15 12:10:54 +0200366 mbedtls_ecjpake_context ecjpake_ctx; /*!< EC J-PAKE key exchange */
Manuel Pégourié-Gonnard77c06462015-09-17 13:59:49 +0200367#if defined(MBEDTLS_SSL_CLI_C)
368 unsigned char *ecjpake_cache; /*!< Cache for ClientHello ext */
369 size_t ecjpake_cache_len; /*!< Length of cached data */
370#endif
Hanno Becker1aa267c2017-04-28 17:08:27 +0100371#endif /* MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnardf4721792015-09-15 10:53:51 +0200372#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C) || \
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +0200373 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200374 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
375#endif
376#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
377 unsigned char *psk; /*!< PSK from the callback */
378 size_t psk_len; /*!< Length of PSK from callback */
379#endif
380#if defined(MBEDTLS_X509_CRT_PARSE_C)
381 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
382#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200383 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200384 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
385 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
386 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100387#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200388#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200389#if defined(MBEDTLS_SSL__ECP_RESTARTABLE)
Manuel Pégourié-Gonnardd27d1a52017-08-15 11:49:08 +0200390 int ecrs_enabled; /*!< Handshake supports EC restart? */
Manuel Pégourié-Gonnard6b7301c2017-08-15 12:08:45 +0200391 mbedtls_x509_crt_restart_ctx ecrs_ctx; /*!< restart context */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200392 enum { /* this complements ssl->state with info on intra-state operations */
393 ssl_ecrs_none = 0, /*!< nothing going on (yet) */
394 ssl_ecrs_crt_verify, /*!< Certificate: crt_verify() */
Manuel Pégourié-Gonnardc37423f2018-10-16 10:28:17 +0200395 ssl_ecrs_ske_start_processing, /*!< ServerKeyExchange: pk_verify() */
396 ssl_ecrs_cke_ecdh_calc_secret, /*!< ClientKeyExchange: ECDH step 2 */
Manuel Pégourié-Gonnard0b23f162017-08-24 12:08:33 +0200397 ssl_ecrs_crt_vrfy_sign, /*!< CertificateVerify: pk_sign() */
398 } ecrs_state; /*!< current (or last) operation */
399 size_t ecrs_n; /*!< place for saving a length */
Manuel Pégourié-Gonnard2350b4e2017-05-16 09:26:48 +0200400#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200401#if defined(MBEDTLS_SSL_PROTO_DTLS)
402 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
403 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
404
405 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
406 Srv: unused */
407 unsigned char verify_cookie_len; /*!< Cli: cookie length
408 Srv: flag for sending a cookie */
409
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200410 uint32_t retransmit_timeout; /*!< Current value of timeout */
411 unsigned char retransmit_state; /*!< Retransmission state */
Manuel Pégourié-Gonnard28f4bea2017-09-13 14:00:05 +0200412 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
413 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
414 unsigned char *cur_msg_p; /*!< Position in current message */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200415 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
416 flight being received */
417 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
418 resending messages */
419 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
420 for resending messages */
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100421
Hanno Beckera5a2b082019-05-15 14:03:01 +0100422#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +0100423 /* The state of CID configuration in this handshake. */
424
425 uint8_t cid_in_use; /*!< This indicates whether the use of the CID extension
Hanno Beckercfa6be72019-05-15 10:17:48 +0100426 * has been negotiated. Possible values are
Hanno Beckere5e7f622019-04-25 15:46:59 +0100427 * #MBEDTLS_SSL_CID_ENABLED and
428 * #MBEDTLS_SSL_CID_DISABLED. */
429 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ]; /*! The peer's CID */
430 uint8_t peer_cid_len; /*!< The length of
431 * \c peer_cid. */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100432#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckere5e7f622019-04-25 15:46:59 +0100433
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100434 struct
435 {
Hanno Beckere0b150f2018-08-21 15:51:03 +0100436 size_t total_bytes_buffered; /*!< Cumulative size of heap allocated
437 * buffers used for message buffering. */
438
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100439 uint8_t seen_ccs; /*!< Indicates if a CCS message has
Hanno Becker2ed6bcc2018-08-15 15:11:57 +0100440 * been seen in the current flight. */
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100441
Hanno Becker0271f962018-08-16 13:23:47 +0100442 struct mbedtls_ssl_hs_buffer
443 {
Hanno Becker98081a02018-08-22 13:32:50 +0100444 unsigned is_valid : 1;
445 unsigned is_fragmented : 1;
446 unsigned is_complete : 1;
Hanno Becker0271f962018-08-16 13:23:47 +0100447 unsigned char *data;
Hanno Beckere0b150f2018-08-21 15:51:03 +0100448 size_t data_len;
Hanno Becker0271f962018-08-16 13:23:47 +0100449 } hs[MBEDTLS_SSL_MAX_BUFFERED_HS];
450
Hanno Becker5f066e72018-08-16 14:56:31 +0100451 struct
452 {
453 unsigned char *data;
454 size_t len;
455 unsigned epoch;
456 } future_record;
457
Hanno Beckerd7f8ae22018-08-16 09:45:56 +0100458 } buffering;
Hanno Becker35462012018-08-22 10:25:40 +0100459
Manuel Pégourié-Gonnardf47a4af2018-08-22 10:38:52 +0200460 uint16_t mtu; /*!< Handshake mtu, used to fragment outgoing messages */
Hanno Becker1aa267c2017-04-28 17:08:27 +0100461#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200462
463 /*
464 * Checksum contexts
465 */
466#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
467 defined(MBEDTLS_SSL_PROTO_TLS1_1)
468 mbedtls_md5_context fin_md5;
469 mbedtls_sha1_context fin_sha1;
470#endif
471#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
472#if defined(MBEDTLS_SHA256_C)
473 mbedtls_sha256_context fin_sha256;
474#endif
475#if defined(MBEDTLS_SHA512_C)
476 mbedtls_sha512_context fin_sha512;
477#endif
478#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
479
480 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
Manuel Pégourié-Gonnarda5759752019-05-03 11:43:28 +0200481 void (*calc_verify)(const mbedtls_ssl_context *, unsigned char *, size_t *);
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200482 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
483 int (*tls_prf)(const unsigned char *, size_t, const char *,
484 const unsigned char *, size_t,
485 unsigned char *, size_t);
486
Hanno Becker8759e162017-12-27 21:34:08 +0000487 mbedtls_ssl_ciphersuite_t const *ciphersuite_info;
488
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200489 size_t pmslen; /*!< premaster length */
490
491 unsigned char randbytes[64]; /*!< random bytes */
492 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
493 /*!< premaster secret */
494
495 int resume; /*!< session resume indicator*/
496 int max_major_ver; /*!< max. major version client*/
497 int max_minor_ver; /*!< max. minor version client*/
498 int cli_exts; /*!< client extension presence*/
499
500#if defined(MBEDTLS_SSL_SESSION_TICKETS)
501 int new_session_ticket; /*!< use NewSessionTicket? */
502#endif /* MBEDTLS_SSL_SESSION_TICKETS */
503#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
504 int extended_ms; /*!< use Extended Master Secret? */
505#endif
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200506
507#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine78300732018-04-26 13:03:29 +0200508 unsigned int async_in_progress : 1; /*!< an asynchronous operation is in progress */
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200509#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
510
511#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
512 /** Asynchronous operation context. This field is meant for use by the
513 * asynchronous operation callbacks (mbedtls_ssl_config::f_async_sign_start,
514 * mbedtls_ssl_config::f_async_decrypt_start,
515 * mbedtls_ssl_config::f_async_resume, mbedtls_ssl_config::f_async_cancel).
516 * The library does not use it internally. */
517 void *user_async_ctx;
518#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200519};
520
Hanno Becker0271f962018-08-16 13:23:47 +0100521typedef struct mbedtls_ssl_hs_buffer mbedtls_ssl_hs_buffer;
522
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200523/*
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000524 * Representation of decryption/encryption transformations on records
525 *
526 * There are the following general types of record transformations:
527 * - Stream transformations (TLS versions <= 1.2 only)
528 * Transformation adding a MAC and applying a stream-cipher
529 * to the authenticated message.
530 * - CBC block cipher transformations ([D]TLS versions <= 1.2 only)
531 * In addition to the distinction of the order of encryption and
532 * authentication, there's a fundamental difference between the
533 * handling in SSL3 & TLS 1.0 and TLS 1.1 and TLS 1.2: For SSL3
534 * and TLS 1.0, the final IV after processing a record is used
535 * as the IV for the next record. No explicit IV is contained
536 * in an encrypted record. The IV for the first record is extracted
537 * at key extraction time. In contrast, for TLS 1.1 and 1.2, no
538 * IV is generated at key extraction time, but every encrypted
539 * record is explicitly prefixed by the IV with which it was encrypted.
540 * - AEAD transformations ([D]TLS versions >= 1.2 only)
541 * These come in two fundamentally different versions, the first one
542 * used in TLS 1.2, excluding ChaChaPoly ciphersuites, and the second
543 * one used for ChaChaPoly ciphersuites in TLS 1.2 as well as for TLS 1.3.
544 * In the first transformation, the IV to be used for a record is obtained
545 * as the concatenation of an explicit, static 4-byte IV and the 8-byte
546 * record sequence number, and explicitly prepending this sequence number
547 * to the encrypted record. In contrast, in the second transformation
548 * the IV is obtained by XOR'ing a static IV obtained at key extraction
549 * time with the 8-byte record sequence number, without prepending the
550 * latter to the encrypted record.
551 *
552 * In addition to type and version, the following parameters are relevant:
553 * - The symmetric cipher algorithm to be used.
554 * - The (static) encryption/decryption keys for the cipher.
555 * - For stream/CBC, the type of message digest to be used.
556 * - For stream/CBC, (static) encryption/decryption keys for the digest.
Hanno Beckera198bb72018-10-18 15:39:53 +0100557 * - For AEAD transformations, the size (potentially 0) of an explicit,
558 * random initialization vector placed in encrypted records.
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000559 * - For some transformations (currently AEAD and CBC in SSL3 and TLS 1.0)
560 * an implicit IV. It may be static (e.g. AEAD) or dynamic (e.g. CBC)
561 * and (if present) is combined with the explicit IV in a transformation-
562 * dependent way (e.g. appending in TLS 1.2 and XOR'ing in TLS 1.3).
563 * - For stream/CBC, a flag determining the order of encryption and MAC.
564 * - The details of the transformation depend on the SSL/TLS version.
565 * - The length of the authentication tag.
566 *
Hanno Beckera198bb72018-10-18 15:39:53 +0100567 * Note: Except for CBC in SSL3 and TLS 1.0, these parameters are
568 * constant across multiple encryption/decryption operations.
569 * For CBC, the implicit IV needs to be updated after each
570 * operation.
571 *
Hanno Becker4a5eeae2018-01-03 15:23:11 +0000572 * The struct below refines this abstract view as follows:
573 * - The cipher underlying the transformation is managed in
574 * cipher contexts cipher_ctx_{enc/dec}, which must have the
575 * same cipher type. The mode of these cipher contexts determines
576 * the type of the transformation in the sense above: e.g., if
577 * the type is MBEDTLS_CIPHER_AES_256_CBC resp. MBEDTLS_CIPHER_AES_192_GCM
578 * then the transformation has type CBC resp. AEAD.
579 * - The cipher keys are never stored explicitly but
580 * are maintained within cipher_ctx_{enc/dec}.
581 * - For stream/CBC transformations, the message digest contexts
582 * used for the MAC's are stored in md_ctx_{enc/dec}. These contexts
583 * are unused for AEAD transformations.
584 * - For stream/CBC transformations and versions > SSL3, the
585 * MAC keys are not stored explicitly but maintained within
586 * md_ctx_{enc/dec}.
587 * - For stream/CBC transformations and version SSL3, the MAC
588 * keys are stored explicitly in mac_enc, mac_dec and have
589 * a fixed size of 20 bytes. These fields are unused for
590 * AEAD transformations or transformations >= TLS 1.0.
591 * - For transformations using an implicit IV maintained within
592 * the transformation context, its contents are stored within
593 * iv_{enc/dec}.
594 * - The value of ivlen indicates the length of the IV.
595 * This is redundant in case of stream/CBC transformations
596 * which always use 0 resp. the cipher's block length as the
597 * IV length, but is needed for AEAD ciphers and may be
598 * different from the underlying cipher's block length
599 * in this case.
600 * - The field fixed_ivlen is nonzero for AEAD transformations only
601 * and indicates the length of the static part of the IV which is
602 * constant throughout the communication, and which is stored in
603 * the first fixed_ivlen bytes of the iv_{enc/dec} arrays.
604 * Note: For CBC in SSL3 and TLS 1.0, the fields iv_{enc/dec}
605 * still store IV's for continued use across multiple transformations,
606 * so it is not true that fixed_ivlen == 0 means that iv_{enc/dec} are
607 * not being used!
608 * - minor_ver denotes the SSL/TLS version
609 * - For stream/CBC transformations, maclen denotes the length of the
610 * authentication tag, while taglen is unused and 0.
611 * - For AEAD transformations, taglen denotes the length of the
612 * authentication tag, while maclen is unused and 0.
613 * - For CBC transformations, encrypt_then_mac determines the
614 * order of encryption and authentication. This field is unused
615 * in other transformations.
616 *
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200617 */
618struct mbedtls_ssl_transform
619{
620 /*
621 * Session specific crypto layer
622 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200623 size_t minlen; /*!< min. ciphertext length */
624 size_t ivlen; /*!< IV length */
625 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
Hanno Becker8759e162017-12-27 21:34:08 +0000626 size_t maclen; /*!< MAC(CBC) len */
627 size_t taglen; /*!< TAG(AEAD) len */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200628
629 unsigned char iv_enc[16]; /*!< IV (encryption) */
630 unsigned char iv_dec[16]; /*!< IV (decryption) */
631
Hanno Becker92231322018-01-03 15:32:51 +0000632#if defined(MBEDTLS_SSL_SOME_MODES_USE_MAC)
633
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200634#if defined(MBEDTLS_SSL_PROTO_SSL3)
635 /* Needed only for SSL v3.0 secret */
636 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
637 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
638#endif /* MBEDTLS_SSL_PROTO_SSL3 */
639
640 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
641 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
642
Hanno Becker3307b532017-12-27 21:37:21 +0000643#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
644 int encrypt_then_mac; /*!< flag for EtM activation */
645#endif
646
Hanno Becker92231322018-01-03 15:32:51 +0000647#endif /* MBEDTLS_SSL_SOME_MODES_USE_MAC */
648
649 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
650 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
Hanno Becker3307b532017-12-27 21:37:21 +0000651 int minor_ver;
652
Hanno Beckera5a2b082019-05-15 14:03:01 +0100653#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100654 uint8_t in_cid_len;
655 uint8_t out_cid_len;
656 unsigned char in_cid [ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
657 unsigned char out_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ];
Hanno Beckera5a2b082019-05-15 14:03:01 +0100658#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker4f0b15f2019-04-25 15:54:02 +0100659
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200660 /*
661 * Session specific compression layer
662 */
663#if defined(MBEDTLS_ZLIB_SUPPORT)
664 z_stream ctx_deflate; /*!< compression context */
665 z_stream ctx_inflate; /*!< decompression context */
666#endif
667};
668
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000669/*
670 * Internal representation of record frames
671 *
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000672 * Instances come in two flavors:
673 * (1) Encrypted
674 * These always have data_offset = 0
675 * (2) Unencrypted
Hanno Beckerf8323432019-04-04 16:29:48 +0100676 * These have data_offset set to the amount of
677 * pre-expansion during record protection. Concretely,
678 * this is the length of the fixed part of the explicit IV
679 * used for encryption, or 0 if no explicit IV is used
680 * (e.g. for CBC in TLS 1.0, or stream ciphers).
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000681 *
682 * The reason for the data_offset in the unencrypted case
683 * is to allow for in-place conversion of an unencrypted to
684 * an encrypted record. If the offset wasn't included, the
685 * encrypted content would need to be shifted afterwards to
686 * make space for the fixed IV.
687 *
688 */
Hanno Becker80fe63e2019-04-29 13:45:54 +0100689#if MBEDTLS_SSL_CID_OUT_LEN_MAX > MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100690#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_OUT_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100691#else
Hanno Becker2e7cd5a2019-04-30 15:01:51 +0100692#define MBEDTLS_SSL_CID_LEN_MAX MBEDTLS_SSL_CID_IN_LEN_MAX
Hanno Becker80fe63e2019-04-29 13:45:54 +0100693#endif
694
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000695typedef struct
696{
Hanno Becker346a5902019-05-20 14:49:02 +0100697 uint8_t ctr[8]; /* Record sequence number */
698 uint8_t type; /* Record type */
699 uint8_t ver[2]; /* SSL/TLS version */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000700
Hanno Becker346a5902019-05-20 14:49:02 +0100701 unsigned char *buf; /* Memory buffer enclosing the record content */
702 size_t buf_len; /* Buffer length */
703 size_t data_offset; /* Offset of record content */
704 size_t data_len; /* Length of record content */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000705
Hanno Beckera5a2b082019-05-15 14:03:01 +0100706#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker346a5902019-05-20 14:49:02 +0100707 uint8_t cid_len; /* Length of the CID (0 if not present) */
708 unsigned char cid[ MBEDTLS_SSL_CID_LEN_MAX ]; /* The CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100709#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker9d2e4b42018-01-05 15:42:50 +0000710} mbedtls_record;
711
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200712#if defined(MBEDTLS_X509_CRT_PARSE_C)
713/*
714 * List of certificate + private key pairs
715 */
716struct mbedtls_ssl_key_cert
717{
718 mbedtls_x509_crt *cert; /*!< cert */
719 mbedtls_pk_context *key; /*!< private key */
720 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
721};
722#endif /* MBEDTLS_X509_CRT_PARSE_C */
723
724#if defined(MBEDTLS_SSL_PROTO_DTLS)
725/*
726 * List of handshake messages kept around for resending
727 */
728struct mbedtls_ssl_flight_item
729{
730 unsigned char *p; /*!< message, including handshake headers */
731 size_t len; /*!< length of p */
732 unsigned char type; /*!< type of the message: handshake or CCS */
733 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
734};
735#endif /* MBEDTLS_SSL_PROTO_DTLS */
736
Hanno Becker7e5437a2017-04-28 17:15:26 +0100737#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
738 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
739
740/* Find an entry in a signature-hash set matching a given hash algorithm. */
741mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
742 mbedtls_pk_type_t sig_alg );
743/* Add a signature-hash-pair to a signature-hash set */
744void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
745 mbedtls_pk_type_t sig_alg,
746 mbedtls_md_type_t md_alg );
747/* Allow exactly one hash algorithm for each signature. */
748void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
749 mbedtls_md_type_t md_alg );
750
751/* Setup an empty signature-hash set */
752static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
753{
754 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
755}
756
757#endif /* MBEDTLS_SSL_PROTO_TLS1_2) &&
758 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200759
760/**
761 * \brief Free referenced items in an SSL transform context and clear
762 * memory
763 *
764 * \param transform SSL transform context
765 */
766void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
767
768/**
769 * \brief Free referenced items in an SSL handshake context and clear
770 * memory
771 *
Gilles Peskine9b562d52018-04-25 20:32:43 +0200772 * \param ssl SSL context
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200773 */
Gilles Peskine9b562d52018-04-25 20:32:43 +0200774void mbedtls_ssl_handshake_free( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200775
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200776int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
777int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
778void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
779
780int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
781
782void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
783int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
784
Simon Butcher99000142016-10-13 17:21:01 +0100785int mbedtls_ssl_handle_message_type( mbedtls_ssl_context *ssl );
786int mbedtls_ssl_prepare_handshake_record( mbedtls_ssl_context *ssl );
787void mbedtls_ssl_update_handshake_status( mbedtls_ssl_context *ssl );
788
Hanno Becker4a810fb2017-05-24 16:27:30 +0100789/**
790 * \brief Update record layer
791 *
792 * This function roughly separates the implementation
793 * of the logic of (D)TLS from the implementation
794 * of the secure transport.
795 *
Hanno Becker3a0aad12018-08-20 09:44:02 +0100796 * \param ssl The SSL context to use.
797 * \param update_hs_digest This indicates if the handshake digest
798 * should be automatically updated in case
799 * a handshake message is found.
Hanno Becker4a810fb2017-05-24 16:27:30 +0100800 *
801 * \return 0 or non-zero error code.
802 *
803 * \note A clarification on what is called 'record layer' here
804 * is in order, as many sensible definitions are possible:
805 *
806 * The record layer takes as input an untrusted underlying
807 * transport (stream or datagram) and transforms it into
808 * a serially multiplexed, secure transport, which
809 * conceptually provides the following:
810 *
811 * (1) Three datagram based, content-agnostic transports
812 * for handshake, alert and CCS messages.
813 * (2) One stream- or datagram-based transport
814 * for application data.
815 * (3) Functionality for changing the underlying transform
816 * securing the contents.
817 *
818 * The interface to this functionality is given as follows:
819 *
820 * a Updating
821 * [Currently implemented by mbedtls_ssl_read_record]
822 *
823 * Check if and on which of the four 'ports' data is pending:
824 * Nothing, a controlling datagram of type (1), or application
825 * data (2). In any case data is present, internal buffers
826 * provide access to the data for the user to process it.
827 * Consumption of type (1) datagrams is done automatically
828 * on the next update, invalidating that the internal buffers
829 * for previous datagrams, while consumption of application
830 * data (2) is user-controlled.
831 *
832 * b Reading of application data
833 * [Currently manual adaption of ssl->in_offt pointer]
834 *
835 * As mentioned in the last paragraph, consumption of data
836 * is different from the automatic consumption of control
837 * datagrams (1) because application data is treated as a stream.
838 *
839 * c Tracking availability of application data
840 * [Currently manually through decreasing ssl->in_msglen]
841 *
842 * For efficiency and to retain datagram semantics for
843 * application data in case of DTLS, the record layer
844 * provides functionality for checking how much application
845 * data is still available in the internal buffer.
846 *
847 * d Changing the transformation securing the communication.
848 *
849 * Given an opaque implementation of the record layer in the
850 * above sense, it should be possible to implement the logic
851 * of (D)TLS on top of it without the need to know anything
852 * about the record layer's internals. This is done e.g.
853 * in all the handshake handling functions, and in the
854 * application data reading function mbedtls_ssl_read.
855 *
856 * \note The above tries to give a conceptual picture of the
857 * record layer, but the current implementation deviates
858 * from it in some places. For example, our implementation of
859 * the update functionality through mbedtls_ssl_read_record
860 * discards datagrams depending on the current state, which
861 * wouldn't fall under the record layer's responsibility
862 * following the above definition.
863 *
864 */
Hanno Becker3a0aad12018-08-20 09:44:02 +0100865int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl,
866 unsigned update_hs_digest );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200867int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
868
Manuel Pégourié-Gonnard31c15862017-09-13 09:38:11 +0200869int mbedtls_ssl_write_handshake_msg( mbedtls_ssl_context *ssl );
Hanno Becker67bc7c32018-08-06 11:33:50 +0100870int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl, uint8_t force_flush );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200871int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
872
873int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
874int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
875
876int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
877int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
878
879int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
880int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
881
882void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
883 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
884
885#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
886int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
887#endif
888
889#if defined(MBEDTLS_PK_C)
890unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
Hanno Becker7e5437a2017-04-28 17:15:26 +0100891unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200892mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
893#endif
894
895mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +0200896unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Simon Butcher99000142016-10-13 17:21:01 +0100897int mbedtls_ssl_set_calc_verify_md( mbedtls_ssl_context *ssl, int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200898
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200899#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +0200900int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200901#endif
902
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200903#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +0200904int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
905 mbedtls_md_type_t md );
906#endif
907
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200908#if defined(MBEDTLS_X509_CRT_PARSE_C)
909static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
910{
911 mbedtls_ssl_key_cert *key_cert;
912
913 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
914 key_cert = ssl->handshake->key_cert;
915 else
916 key_cert = ssl->conf->key_cert;
917
918 return( key_cert == NULL ? NULL : key_cert->key );
919}
920
921static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
922{
923 mbedtls_ssl_key_cert *key_cert;
924
925 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
926 key_cert = ssl->handshake->key_cert;
927 else
928 key_cert = ssl->conf->key_cert;
929
930 return( key_cert == NULL ? NULL : key_cert->cert );
931}
932
933/*
934 * Check usage of a certificate wrt extensions:
935 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
936 *
937 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
938 * check a cert we received from them)!
939 *
940 * Return 0 if everything is OK, -1 if not.
941 */
942int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
943 const mbedtls_ssl_ciphersuite_t *ciphersuite,
944 int cert_endpoint,
945 uint32_t *flags );
946#endif /* MBEDTLS_X509_CRT_PARSE_C */
947
948void mbedtls_ssl_write_version( int major, int minor, int transport,
949 unsigned char ver[2] );
950void mbedtls_ssl_read_version( int *major, int *minor, int transport,
951 const unsigned char ver[2] );
952
Hanno Becker43395762019-05-03 14:46:38 +0100953static inline size_t mbedtls_ssl_in_hdr_len( const mbedtls_ssl_context *ssl )
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200954{
Hanno Beckerccc24562019-05-03 15:05:27 +0100955 return( (size_t) ( ssl->in_iv - ssl->in_hdr ) );
Hanno Becker43395762019-05-03 14:46:38 +0100956}
957
958static inline size_t mbedtls_ssl_out_hdr_len( const mbedtls_ssl_context *ssl )
959{
Hanno Beckerccc24562019-05-03 15:05:27 +0100960 return( (size_t) ( ssl->out_iv - ssl->out_hdr ) );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200961}
962
963static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
964{
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100965#if !defined(MBEDTLS_SSL_PROTO__BOTH)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200966 ((void) ssl);
967#endif
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100968
969#if defined(MBEDTLS_SSL_PROTO_DTLS)
970 if( MBEDTLS_SSL_TRANSPORT_IS_DTLS( ssl->conf->transport ) )
971 return( 12 );
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +0200972 MBEDTLS_SSL_TRANSPORT_ELSE
Manuel Pégourié-Gonnard25838b72019-03-19 10:23:56 +0100973#endif
Manuel Pégourié-Gonnard889bbc72019-06-18 10:56:09 +0200974#if defined(MBEDTLS_SSL_PROTO_TLS)
975 return( 4 );
976#endif
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200977}
978
979#if defined(MBEDTLS_SSL_PROTO_DTLS)
980void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
981void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
982int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard87a346f2017-09-13 12:45:21 +0200983int mbedtls_ssl_flight_transmit( mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200984#endif
985
986/* Visible for testing purposes only */
987#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
988int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context *ssl );
989void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
990#endif
991
992/* constant-time buffer comparison */
993static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
994{
995 size_t i;
Hanno Becker59e69632017-06-26 13:26:58 +0100996 volatile const unsigned char *A = (volatile const unsigned char *) a;
997 volatile const unsigned char *B = (volatile const unsigned char *) b;
998 volatile unsigned char diff = 0;
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200999
1000 for( i = 0; i < n; i++ )
Azim Khan45b79cf2018-05-23 16:55:16 +01001001 {
1002 /* Read volatile data in order before computing diff.
1003 * This avoids IAR compiler warning:
1004 * 'the order of volatile accesses is undefined ..' */
1005 unsigned char x = A[i], y = B[i];
1006 diff |= x ^ y;
1007 }
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001008
1009 return( diff );
1010}
1011
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001012#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
1013 defined(MBEDTLS_SSL_PROTO_TLS1_1)
1014int mbedtls_ssl_get_key_exchange_md_ssl_tls( mbedtls_ssl_context *ssl,
1015 unsigned char *output,
1016 unsigned char *data, size_t data_len );
1017#endif /* MBEDTLS_SSL_PROTO_SSL3 || MBEDTLS_SSL_PROTO_TLS1 || \
1018 MBEDTLS_SSL_PROTO_TLS1_1 */
1019
1020#if defined(MBEDTLS_SSL_PROTO_TLS1) || defined(MBEDTLS_SSL_PROTO_TLS1_1) || \
1021 defined(MBEDTLS_SSL_PROTO_TLS1_2)
1022int mbedtls_ssl_get_key_exchange_md_tls1_2( mbedtls_ssl_context *ssl,
Gilles Peskineca1d7422018-04-24 11:53:22 +02001023 unsigned char *hash, size_t *hashlen,
1024 unsigned char *data, size_t data_len,
1025 mbedtls_md_type_t md_alg );
Andres Amaya Garcia46f5a3e2017-07-20 16:17:51 +01001026#endif /* MBEDTLS_SSL_PROTO_TLS1 || MBEDTLS_SSL_PROTO_TLS1_1 || \
1027 MBEDTLS_SSL_PROTO_TLS1_2 */
1028
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001029#ifdef __cplusplus
1030}
1031#endif
1032
Hanno Becker611a83b2018-01-03 14:27:32 +00001033void mbedtls_ssl_transform_init( mbedtls_ssl_transform *transform );
1034int mbedtls_ssl_encrypt_buf( mbedtls_ssl_context *ssl,
1035 mbedtls_ssl_transform *transform,
1036 mbedtls_record *rec,
1037 int (*f_rng)(void *, unsigned char *, size_t),
1038 void *p_rng );
1039int mbedtls_ssl_decrypt_buf( mbedtls_ssl_context *ssl,
1040 mbedtls_ssl_transform *transform,
1041 mbedtls_record *rec );
1042
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001043#endif /* ssl_internal.h */