blob: c1534420ab2ce43e99417777c805bf208cbc18cf [file] [log] [blame]
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +02001/**
2 * \file ssl_ticket.h
3 *
4 * \brief Internal functions shared by the SSL modules
5 *
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02006 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02007 * SPDX-License-Identifier: Apache-2.0
8 *
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
12 *
13 * http://www.apache.org/licenses/LICENSE-2.0
14 *
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020020 *
21 * This file is part of mbed TLS (https://tls.mbed.org)
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020022 */
23#ifndef MBEDTLS_SSL_INTERNAL_H
24#define MBEDTLS_SSL_INTERNAL_H
25
26#include "ssl.h"
Hanno Becker6499bed2017-09-18 10:54:39 +010027#include "cipher.h"
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +020028
Manuel Pégourié-Gonnard56273da2015-05-26 12:19:45 +020029#if defined(MBEDTLS_MD5_C)
30#include "md5.h"
31#endif
32
33#if defined(MBEDTLS_SHA1_C)
34#include "sha1.h"
35#endif
36
37#if defined(MBEDTLS_SHA256_C)
38#include "sha256.h"
39#endif
40
41#if defined(MBEDTLS_SHA512_C)
42#include "sha512.h"
43#endif
44
Manuel Pégourié-Gonnard0223ab92015-10-05 11:40:01 +010045#if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
46 !defined(inline) && !defined(__cplusplus)
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020047#define inline __inline
Manuel Pégourié-Gonnard20af64d2015-07-07 18:33:39 +020048#endif
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +020049
50/* Determine minimum supported version */
51#define MBEDTLS_SSL_MIN_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
52
53#if defined(MBEDTLS_SSL_PROTO_SSL3)
54#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
55#else
56#if defined(MBEDTLS_SSL_PROTO_TLS1)
57#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
58#else
59#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
60#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
61#else
62#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
63#define MBEDTLS_SSL_MIN_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
64#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
65#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
66#endif /* MBEDTLS_SSL_PROTO_TLS1 */
67#endif /* MBEDTLS_SSL_PROTO_SSL3 */
68
69/* Determine maximum supported version */
70#define MBEDTLS_SSL_MAX_MAJOR_VERSION MBEDTLS_SSL_MAJOR_VERSION_3
71
72#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
73#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_3
74#else
75#if defined(MBEDTLS_SSL_PROTO_TLS1_1)
76#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_2
77#else
78#if defined(MBEDTLS_SSL_PROTO_TLS1)
79#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_1
80#else
81#if defined(MBEDTLS_SSL_PROTO_SSL3)
82#define MBEDTLS_SSL_MAX_MINOR_VERSION MBEDTLS_SSL_MINOR_VERSION_0
83#endif /* MBEDTLS_SSL_PROTO_SSL3 */
84#endif /* MBEDTLS_SSL_PROTO_TLS1 */
85#endif /* MBEDTLS_SSL_PROTO_TLS1_1 */
86#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
87
88#define MBEDTLS_SSL_INITIAL_HANDSHAKE 0
89#define MBEDTLS_SSL_RENEGOTIATION_IN_PROGRESS 1 /* In progress */
90#define MBEDTLS_SSL_RENEGOTIATION_DONE 2 /* Done or aborted */
91#define MBEDTLS_SSL_RENEGOTIATION_PENDING 3 /* Requested (server only) */
92
93/*
94 * DTLS retransmission states, see RFC 6347 4.2.4
95 *
96 * The SENDING state is merged in PREPARING for initial sends,
97 * but is distinct for resends.
98 *
99 * Note: initial state is wrong for server, but is not used anyway.
100 */
101#define MBEDTLS_SSL_RETRANS_PREPARING 0
102#define MBEDTLS_SSL_RETRANS_SENDING 1
103#define MBEDTLS_SSL_RETRANS_WAITING 2
104#define MBEDTLS_SSL_RETRANS_FINISHED 3
105
106/*
107 * Allow extra bytes for record, authentication and encryption overhead:
108 * counter (8) + header (5) + IV(16) + MAC (16-48) + padding (0-256)
109 * and allow for a maximum of 1024 of compression expansion if
110 * enabled.
111 */
112#if defined(MBEDTLS_ZLIB_SUPPORT)
113#define MBEDTLS_SSL_COMPRESSION_ADD 1024
114#else
115#define MBEDTLS_SSL_COMPRESSION_ADD 0
116#endif
117
118#if defined(MBEDTLS_ARC4_C) || defined(MBEDTLS_CIPHER_MODE_CBC)
119/* Ciphersuites using HMAC */
120#if defined(MBEDTLS_SHA512_C)
121#define MBEDTLS_SSL_MAC_ADD 48 /* SHA-384 used for HMAC */
122#elif defined(MBEDTLS_SHA256_C)
123#define MBEDTLS_SSL_MAC_ADD 32 /* SHA-256 used for HMAC */
124#else
125#define MBEDTLS_SSL_MAC_ADD 20 /* SHA-1 used for HMAC */
126#endif
127#else
128/* AEAD ciphersuites: GCM and CCM use a 128 bits tag */
129#define MBEDTLS_SSL_MAC_ADD 16
130#endif
131
132#if defined(MBEDTLS_CIPHER_MODE_CBC)
133#define MBEDTLS_SSL_PADDING_ADD 256
134#else
135#define MBEDTLS_SSL_PADDING_ADD 0
136#endif
137
Hanno Becker6499bed2017-09-18 10:54:39 +0100138#define MBEDTLS_SSL_PAYLOAD_LEN ( MBEDTLS_SSL_MAX_CONTENT_LEN \
139 + MBEDTLS_SSL_COMPRESSION_ADD \
140 + MBEDTLS_MAX_IV_LENGTH \
141 + MBEDTLS_SSL_MAC_ADD \
142 + MBEDTLS_SSL_PADDING_ADD \
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200143 )
144
145/*
Hanno Becker6499bed2017-09-18 10:54:39 +0100146 * Check that we obey the standard's message size bounds
147 */
148
149#if MBEDTLS_SSL_MAX_CONTENT_LEN > 16384
150#error Bad configuration - record content too large.
151#endif
152
153#if MBEDTLS_SSL_PAYLOAD_LEN > 16384 + 2048
154#error Bad configuration - protected record payload too large.
155#endif
156
Hanno Beckere40802a2017-12-07 08:22:51 +0000157/* Note: Even though the TLS record header is only 5 bytes
158 long, we're internally using 8 bytes to store the
159 implicit sequence number. */
Hanno Becker0ca15962017-10-04 13:56:42 +0100160#define MBEDTLS_SSL_HEADER_LEN 13
Hanno Becker6499bed2017-09-18 10:54:39 +0100161
Hanno Becker0ca15962017-10-04 13:56:42 +0100162#define MBEDTLS_SSL_BUFFER_LEN \
163 ( ( MBEDTLS_SSL_HEADER_LEN ) + ( MBEDTLS_SSL_PAYLOAD_LEN ) )
Hanno Becker6499bed2017-09-18 10:54:39 +0100164
165/*
Manuel Pégourié-Gonnard065122c2015-05-26 12:31:46 +0200166 * TLS extension flags (for extensions with outgoing ServerHello content
167 * that need it (e.g. for RENEGOTIATION_INFO the server already knows because
168 * of state of the renegotiation flag, so no indicator is required)
169 */
170#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS_PRESENT (1 << 0)
171
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200172#ifdef __cplusplus
173extern "C" {
174#endif
175
Hanno Beckeraa8a2bd2017-04-28 17:15:26 +0100176#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
177 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
178/*
179 * Abstraction for a grid of allowed signature-hash-algorithm pairs.
180 */
181struct mbedtls_ssl_sig_hash_set_t
182{
183 /* At the moment, we only need to remember a single suitable
184 * hash algorithm per signature algorithm. As long as that's
185 * the case - and we don't need a general lookup function -
186 * we can implement the sig-hash-set as a map from signatures
187 * to hash algorithms. */
188 mbedtls_md_type_t rsa;
189 mbedtls_md_type_t ecdsa;
190};
191#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
192 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
193
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200194/*
195 * This structure contains the parameters only needed during handshake.
196 */
197struct mbedtls_ssl_handshake_params
198{
199 /*
200 * Handshake specific crypto variables
201 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200202 int cert_type; /*!< Requested cert type */
203 int verify_sig_alg; /*!< Signature algorithm for verify */
Hanno Beckeraa8a2bd2017-04-28 17:15:26 +0100204
205#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
206 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
207 mbedtls_ssl_sig_hash_set_t hash_algs; /*!< Set of suitable sig-hash pairs */
208#endif
209
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200210#if defined(MBEDTLS_DHM_C)
211 mbedtls_dhm_context dhm_ctx; /*!< DHM key exchange */
212#endif
213#if defined(MBEDTLS_ECDH_C)
214 mbedtls_ecdh_context ecdh_ctx; /*!< ECDH key exchange */
215#endif
216#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
217 const mbedtls_ecp_curve_info **curves; /*!< Supported elliptic curves */
218#endif
219#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
220 unsigned char *psk; /*!< PSK from the callback */
221 size_t psk_len; /*!< Length of PSK from callback */
222#endif
223#if defined(MBEDTLS_X509_CRT_PARSE_C)
224 mbedtls_ssl_key_cert *key_cert; /*!< chosen key/cert pair (server) */
225#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200226 int sni_authmode; /*!< authmode from SNI callback */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200227 mbedtls_ssl_key_cert *sni_key_cert; /*!< key/cert list from SNI */
228 mbedtls_x509_crt *sni_ca_chain; /*!< trusted CAs from SNI callback */
229 mbedtls_x509_crl *sni_ca_crl; /*!< trusted CAs CRLs from SNI */
Hanno Beckerb3e68722017-04-28 17:08:27 +0100230#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200231#endif /* MBEDTLS_X509_CRT_PARSE_C */
232#if defined(MBEDTLS_SSL_PROTO_DTLS)
233 unsigned int out_msg_seq; /*!< Outgoing handshake sequence number */
234 unsigned int in_msg_seq; /*!< Incoming handshake sequence number */
235
236 unsigned char *verify_cookie; /*!< Cli: HelloVerifyRequest cookie
237 Srv: unused */
238 unsigned char verify_cookie_len; /*!< Cli: cookie length
239 Srv: flag for sending a cookie */
240
241 unsigned char *hs_msg; /*!< Reassembled handshake message */
242
243 uint32_t retransmit_timeout; /*!< Current value of timeout */
244 unsigned char retransmit_state; /*!< Retransmission state */
245 mbedtls_ssl_flight_item *flight; /*!< Current outgoing flight */
246 mbedtls_ssl_flight_item *cur_msg; /*!< Current message in flight */
247 unsigned int in_flight_start_seq; /*!< Minimum message sequence in the
248 flight being received */
249 mbedtls_ssl_transform *alt_transform_out; /*!< Alternative transform for
250 resending messages */
251 unsigned char alt_out_ctr[8]; /*!< Alternative record epoch/counter
252 for resending messages */
Hanno Beckerb3e68722017-04-28 17:08:27 +0100253#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200254
255 /*
256 * Checksum contexts
257 */
258#if defined(MBEDTLS_SSL_PROTO_SSL3) || defined(MBEDTLS_SSL_PROTO_TLS1) || \
259 defined(MBEDTLS_SSL_PROTO_TLS1_1)
260 mbedtls_md5_context fin_md5;
261 mbedtls_sha1_context fin_sha1;
262#endif
263#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
264#if defined(MBEDTLS_SHA256_C)
265 mbedtls_sha256_context fin_sha256;
266#endif
267#if defined(MBEDTLS_SHA512_C)
268 mbedtls_sha512_context fin_sha512;
269#endif
270#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
271
272 void (*update_checksum)(mbedtls_ssl_context *, const unsigned char *, size_t);
273 void (*calc_verify)(mbedtls_ssl_context *, unsigned char *);
274 void (*calc_finished)(mbedtls_ssl_context *, unsigned char *, int);
275 int (*tls_prf)(const unsigned char *, size_t, const char *,
276 const unsigned char *, size_t,
277 unsigned char *, size_t);
278
279 size_t pmslen; /*!< premaster length */
280
281 unsigned char randbytes[64]; /*!< random bytes */
282 unsigned char premaster[MBEDTLS_PREMASTER_SIZE];
283 /*!< premaster secret */
284
285 int resume; /*!< session resume indicator*/
286 int max_major_ver; /*!< max. major version client*/
287 int max_minor_ver; /*!< max. minor version client*/
288 int cli_exts; /*!< client extension presence*/
289
290#if defined(MBEDTLS_SSL_SESSION_TICKETS)
291 int new_session_ticket; /*!< use NewSessionTicket? */
292#endif /* MBEDTLS_SSL_SESSION_TICKETS */
293#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
294 int extended_ms; /*!< use Extended Master Secret? */
295#endif
296};
297
298/*
299 * This structure contains a full set of runtime transform parameters
300 * either in negotiation or active.
301 */
302struct mbedtls_ssl_transform
303{
304 /*
305 * Session specific crypto layer
306 */
307 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
308 /*!< Chosen cipersuite_info */
Manuel Pégourié-Gonnard39a48f42015-06-18 16:06:55 +0200309 unsigned int keylen; /*!< symmetric key length (bytes) */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200310 size_t minlen; /*!< min. ciphertext length */
311 size_t ivlen; /*!< IV length */
312 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
313 size_t maclen; /*!< MAC length */
314
315 unsigned char iv_enc[16]; /*!< IV (encryption) */
316 unsigned char iv_dec[16]; /*!< IV (decryption) */
317
318#if defined(MBEDTLS_SSL_PROTO_SSL3)
319 /* Needed only for SSL v3.0 secret */
320 unsigned char mac_enc[20]; /*!< SSL v3.0 secret (enc) */
321 unsigned char mac_dec[20]; /*!< SSL v3.0 secret (dec) */
322#endif /* MBEDTLS_SSL_PROTO_SSL3 */
323
324 mbedtls_md_context_t md_ctx_enc; /*!< MAC (encryption) */
325 mbedtls_md_context_t md_ctx_dec; /*!< MAC (decryption) */
326
327 mbedtls_cipher_context_t cipher_ctx_enc; /*!< encryption context */
328 mbedtls_cipher_context_t cipher_ctx_dec; /*!< decryption context */
329
330 /*
331 * Session specific compression layer
332 */
333#if defined(MBEDTLS_ZLIB_SUPPORT)
334 z_stream ctx_deflate; /*!< compression context */
335 z_stream ctx_inflate; /*!< decompression context */
336#endif
337};
338
339#if defined(MBEDTLS_X509_CRT_PARSE_C)
340/*
341 * List of certificate + private key pairs
342 */
343struct mbedtls_ssl_key_cert
344{
345 mbedtls_x509_crt *cert; /*!< cert */
346 mbedtls_pk_context *key; /*!< private key */
347 mbedtls_ssl_key_cert *next; /*!< next key/cert pair */
348};
349#endif /* MBEDTLS_X509_CRT_PARSE_C */
350
351#if defined(MBEDTLS_SSL_PROTO_DTLS)
352/*
353 * List of handshake messages kept around for resending
354 */
355struct mbedtls_ssl_flight_item
356{
357 unsigned char *p; /*!< message, including handshake headers */
358 size_t len; /*!< length of p */
359 unsigned char type; /*!< type of the message: handshake or CCS */
360 mbedtls_ssl_flight_item *next; /*!< next handshake message(s) */
361};
362#endif /* MBEDTLS_SSL_PROTO_DTLS */
363
Hanno Beckeraa8a2bd2017-04-28 17:15:26 +0100364#if defined(MBEDTLS_SSL_PROTO_TLS1_2) && \
365 defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
366
367/* Find an entry in a signature-hash set matching a given hash algorithm. */
368mbedtls_md_type_t mbedtls_ssl_sig_hash_set_find( mbedtls_ssl_sig_hash_set_t *set,
369 mbedtls_pk_type_t sig_alg );
370/* Add a signature-hash-pair to a signature-hash set */
371void mbedtls_ssl_sig_hash_set_add( mbedtls_ssl_sig_hash_set_t *set,
372 mbedtls_pk_type_t sig_alg,
373 mbedtls_md_type_t md_alg );
374/* Allow exactly one hash algorithm for each signature. */
375void mbedtls_ssl_sig_hash_set_const_hash( mbedtls_ssl_sig_hash_set_t *set,
376 mbedtls_md_type_t md_alg );
377/* Setup an empty signature-hash set */
378static inline void mbedtls_ssl_sig_hash_set_init( mbedtls_ssl_sig_hash_set_t *set )
379{
380 mbedtls_ssl_sig_hash_set_const_hash( set, MBEDTLS_MD_NONE );
381}
382
383#endif /* MBEDTLS_SSL_PROTO_TLS1_2 &&
384 MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200385
386/**
387 * \brief Free referenced items in an SSL transform context and clear
388 * memory
389 *
390 * \param transform SSL transform context
391 */
392void mbedtls_ssl_transform_free( mbedtls_ssl_transform *transform );
393
394/**
395 * \brief Free referenced items in an SSL handshake context and clear
396 * memory
397 *
398 * \param handshake SSL handshake context
399 */
400void mbedtls_ssl_handshake_free( mbedtls_ssl_handshake_params *handshake );
401
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200402int mbedtls_ssl_handshake_client_step( mbedtls_ssl_context *ssl );
403int mbedtls_ssl_handshake_server_step( mbedtls_ssl_context *ssl );
404void mbedtls_ssl_handshake_wrapup( mbedtls_ssl_context *ssl );
405
406int mbedtls_ssl_send_fatal_handshake_failure( mbedtls_ssl_context *ssl );
407
408void mbedtls_ssl_reset_checksum( mbedtls_ssl_context *ssl );
409int mbedtls_ssl_derive_keys( mbedtls_ssl_context *ssl );
410
Hanno Becker6a582e82017-06-08 13:38:05 +0100411/**
412 * \brief Update record layer
413 *
414 * This function roughly separates the implementation
415 * of the logic of (D)TLS from the implementation
416 * of the secure transport.
417 *
418 * \param ssl SSL context to use
419 *
420 * \return 0 or non-zero error code.
421 *
422 * \note A clarification on what is called 'record layer' here
423 * is in order, as many sensible definitions are possible:
424 *
425 * The record layer takes as input an untrusted underlying
426 * transport (stream or datagram) and transforms it into
427 * a serially multiplexed, secure transport, which
428 * conceptually provides the following:
429 *
430 * (1) Three datagram based, content-agnostic transports
431 * for handshake, alert and CCS messages.
432 * (2) One stream- or datagram-based transport
433 * for application data.
434 * (3) Functionality for changing the underlying transform
435 * securing the contents.
436 *
437 * The interface to this functionality is given as follows:
438 *
439 * a Updating
440 * [Currently implemented by mbedtls_ssl_read_record]
441 *
442 * Check if and on which of the four 'ports' data is pending:
443 * Nothing, a controlling datagram of type (1), or application
444 * data (2). In any case data is present, internal buffers
445 * provide access to the data for the user to process it.
446 * Consumption of type (1) datagrams is done automatically
447 * on the next update, invalidating that the internal buffers
448 * for previous datagrams, while consumption of application
449 * data (2) is user-controlled.
450 *
451 * b Reading of application data
452 * [Currently manual adaption of ssl->in_offt pointer]
453 *
454 * As mentioned in the last paragraph, consumption of data
455 * is different from the automatic consumption of control
456 * datagrams (1) because application data is treated as a stream.
457 *
458 * c Tracking availability of application data
459 * [Currently manually through decreasing ssl->in_msglen]
460 *
461 * For efficiency and to retain datagram semantics for
462 * application data in case of DTLS, the record layer
463 * provides functionality for checking how much application
464 * data is still available in the internal buffer.
465 *
466 * d Changing the transformation securing the communication.
467 *
468 * Given an opaque implementation of the record layer in the
469 * above sense, it should be possible to implement the logic
470 * of (D)TLS on top of it without the need to know anything
471 * about the record layer's internals. This is done e.g.
472 * in all the handshake handling functions, and in the
473 * application data reading function mbedtls_ssl_read.
474 *
475 * \note The above tries to give a conceptual picture of the
476 * record layer, but the current implementation deviates
477 * from it in some places. For example, our implementation of
478 * the update functionality through mbedtls_ssl_read_record
479 * discards datagrams depending on the current state, which
480 * wouldn't fall under the record layer's responsibility
481 * following the above definition.
482 *
483 */
484
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200485int mbedtls_ssl_read_record( mbedtls_ssl_context *ssl );
486int mbedtls_ssl_fetch_input( mbedtls_ssl_context *ssl, size_t nb_want );
487
488int mbedtls_ssl_write_record( mbedtls_ssl_context *ssl );
489int mbedtls_ssl_flush_output( mbedtls_ssl_context *ssl );
490
491int mbedtls_ssl_parse_certificate( mbedtls_ssl_context *ssl );
492int mbedtls_ssl_write_certificate( mbedtls_ssl_context *ssl );
493
494int mbedtls_ssl_parse_change_cipher_spec( mbedtls_ssl_context *ssl );
495int mbedtls_ssl_write_change_cipher_spec( mbedtls_ssl_context *ssl );
496
497int mbedtls_ssl_parse_finished( mbedtls_ssl_context *ssl );
498int mbedtls_ssl_write_finished( mbedtls_ssl_context *ssl );
499
500void mbedtls_ssl_optimize_checksum( mbedtls_ssl_context *ssl,
501 const mbedtls_ssl_ciphersuite_t *ciphersuite_info );
502
503#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
504int mbedtls_ssl_psk_derive_premaster( mbedtls_ssl_context *ssl, mbedtls_key_exchange_type_t key_ex );
505#endif
506
507#if defined(MBEDTLS_PK_C)
508unsigned char mbedtls_ssl_sig_from_pk( mbedtls_pk_context *pk );
509mbedtls_pk_type_t mbedtls_ssl_pk_alg_from_sig( unsigned char sig );
Hanno Beckeraa8a2bd2017-04-28 17:15:26 +0100510unsigned char mbedtls_ssl_sig_from_pk_alg( mbedtls_pk_type_t type );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200511#endif
512
513mbedtls_md_type_t mbedtls_ssl_md_alg_from_hash( unsigned char hash );
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +0200514unsigned char mbedtls_ssl_hash_from_md_alg( int md );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200515
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200516#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard9d412d82015-06-17 12:10:46 +0200517int mbedtls_ssl_check_curve( const mbedtls_ssl_context *ssl, mbedtls_ecp_group_id grp_id );
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200518#endif
519
Manuel Pégourié-Gonnardf9945bc2015-10-22 17:01:15 +0200520#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard7bfc1222015-06-17 14:34:48 +0200521int mbedtls_ssl_check_sig_hash( const mbedtls_ssl_context *ssl,
522 mbedtls_md_type_t md );
523#endif
524
Manuel Pégourié-Gonnard5e94dde2015-05-26 11:57:05 +0200525#if defined(MBEDTLS_X509_CRT_PARSE_C)
526static inline mbedtls_pk_context *mbedtls_ssl_own_key( mbedtls_ssl_context *ssl )
527{
528 mbedtls_ssl_key_cert *key_cert;
529
530 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
531 key_cert = ssl->handshake->key_cert;
532 else
533 key_cert = ssl->conf->key_cert;
534
535 return( key_cert == NULL ? NULL : key_cert->key );
536}
537
538static inline mbedtls_x509_crt *mbedtls_ssl_own_cert( mbedtls_ssl_context *ssl )
539{
540 mbedtls_ssl_key_cert *key_cert;
541
542 if( ssl->handshake != NULL && ssl->handshake->key_cert != NULL )
543 key_cert = ssl->handshake->key_cert;
544 else
545 key_cert = ssl->conf->key_cert;
546
547 return( key_cert == NULL ? NULL : key_cert->cert );
548}
549
550/*
551 * Check usage of a certificate wrt extensions:
552 * keyUsage, extendedKeyUsage (later), and nSCertType (later).
553 *
554 * Warning: cert_endpoint is the endpoint of the cert (ie, of our peer when we
555 * check a cert we received from them)!
556 *
557 * Return 0 if everything is OK, -1 if not.
558 */
559int mbedtls_ssl_check_cert_usage( const mbedtls_x509_crt *cert,
560 const mbedtls_ssl_ciphersuite_t *ciphersuite,
561 int cert_endpoint,
562 uint32_t *flags );
563#endif /* MBEDTLS_X509_CRT_PARSE_C */
564
565void mbedtls_ssl_write_version( int major, int minor, int transport,
566 unsigned char ver[2] );
567void mbedtls_ssl_read_version( int *major, int *minor, int transport,
568 const unsigned char ver[2] );
569
570static inline size_t mbedtls_ssl_hdr_len( const mbedtls_ssl_context *ssl )
571{
572#if defined(MBEDTLS_SSL_PROTO_DTLS)
573 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
574 return( 13 );
575#else
576 ((void) ssl);
577#endif
578 return( 5 );
579}
580
581static inline size_t mbedtls_ssl_hs_hdr_len( const mbedtls_ssl_context *ssl )
582{
583#if defined(MBEDTLS_SSL_PROTO_DTLS)
584 if( ssl->conf->transport == MBEDTLS_SSL_TRANSPORT_DATAGRAM )
585 return( 12 );
586#else
587 ((void) ssl);
588#endif
589 return( 4 );
590}
591
592#if defined(MBEDTLS_SSL_PROTO_DTLS)
593void mbedtls_ssl_send_flight_completed( mbedtls_ssl_context *ssl );
594void mbedtls_ssl_recv_flight_completed( mbedtls_ssl_context *ssl );
595int mbedtls_ssl_resend( mbedtls_ssl_context *ssl );
596#endif
597
598/* Visible for testing purposes only */
599#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
600int mbedtls_ssl_dtls_replay_check( mbedtls_ssl_context *ssl );
601void mbedtls_ssl_dtls_replay_update( mbedtls_ssl_context *ssl );
602#endif
603
604/* constant-time buffer comparison */
605static inline int mbedtls_ssl_safer_memcmp( const void *a, const void *b, size_t n )
606{
607 size_t i;
608 const unsigned char *A = (const unsigned char *) a;
609 const unsigned char *B = (const unsigned char *) b;
610 unsigned char diff = 0;
611
612 for( i = 0; i < n; i++ )
613 diff |= A[i] ^ B[i];
614
615 return( diff );
616}
617
618#ifdef __cplusplus
619}
620#endif
621
622#endif /* ssl_internal.h */