blob: 5a774aafbe90b20a944700dba23bfa33b9ee271b [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file ssl.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief SSL/TLS functions.
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.
Paul Bakkerb96f1542010-07-18 20:36:00 +000021 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000022 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_SSL_H
25#define MBEDTLS_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakkered27a042013-04-18 22:46:23 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010032
Paul Bakkered27a042013-04-18 22:46:23 +020033#include "bignum.h"
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +020034#include "ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020037#include "x509_crt.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020038#include "x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020039#endif
Paul Bakkered27a042013-04-18 22:46:23 +020040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if defined(MBEDTLS_DHM_C)
Paul Bakker48916f92012-09-16 19:57:18 +000042#include "dhm.h"
43#endif
44
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020045#if defined(MBEDTLS_ECDH_C)
Paul Bakker41c83d32013-03-20 14:39:14 +010046#include "ecdh.h"
47#endif
48
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#if defined(MBEDTLS_ZLIB_SUPPORT)
Hanno Beckere494e202018-03-08 13:26:12 +000050
51#if defined(MBEDTLS_DEPRECATED_WARNING)
52#warning "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and will be removed in the next major revision of the library"
53#endif
54
55#if defined(MBEDTLS_DEPRECATED_REMOVED)
56#error "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and cannot be used if MBEDTLS_DEPRECATED_REMOVED is set"
57#endif
58
Paul Bakker2770fbd2012-07-03 13:30:23 +000059#include "zlib.h"
60#endif
61
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#if defined(MBEDTLS_HAVE_TIME)
Ron Eldor6fd941f2017-05-14 16:17:33 +030063#include "platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020064#endif
65
Hanno Becker381eaa52019-06-12 14:43:01 +010066#if defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER) && \
67 defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER) && \
68 ( MBEDTLS_SSL_CONF_MAX_MAJOR_VER == MBEDTLS_SSL_CONF_MIN_MAJOR_VER )
69#define MBEDTLS_SSL_CONF_FIXED_MAJOR_VER MBEDTLS_SSL_CONF_MIN_MAJOR_VER
70#endif
71
72#if defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER) && \
73 defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER) && \
74 ( MBEDTLS_SSL_CONF_MAX_MINOR_VER == MBEDTLS_SSL_CONF_MIN_MINOR_VER )
75#define MBEDTLS_SSL_CONF_FIXED_MINOR_VER MBEDTLS_SSL_CONF_MIN_MINOR_VER
76#endif
77
Paul Bakker13e2dfe2009-07-28 07:18:38 +000078/*
79 * SSL Error codes
80 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
82#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
83#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
84#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
85#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
86#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
87#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
88#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
89#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
90#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
91#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
92#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
93#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
94#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
95#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
96#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
97#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
98#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
99#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
100#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
101#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
102#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
103#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
104#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
105#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
106#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
107#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
108#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
109#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200110#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200111#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
112#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
113#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
114#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
115#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
116#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
117#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
118#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
119#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
120#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
121#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
122#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
123#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
124#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
Hanno Becker8ec81022017-10-10 10:35:08 +0100125#define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< No data of requested type currently available on underlying transport. */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100126#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
127#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200128#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +0100129#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100130#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
131#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */
Hanno Becker8ec81022017-10-10 10:35:08 +0100132#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580 /**< Internal-only message signaling that further message-processing should be done */
Gilles Peskineb44692f2018-04-24 12:18:19 +0200133#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100134#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Hanno Becker7c3cdb62019-05-14 11:02:36 +0100135#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000 /**< An encrypted DTLS-frame with an unexpected CID was received. */
Hanno Becker5dbcc9f2019-06-03 12:58:39 +0100136#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00 /**< An operation failed due to an unexpected version or configuration. */
Manuel Pégourié-Gonnard125af942018-09-11 11:08:12 +0200137#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000138
139/*
140 * Various constants
141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142#define MBEDTLS_SSL_MAJOR_VERSION_3 3
143#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
144#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
145#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
146#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200148#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
149#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100150
Simon Butcher9f812312015-09-28 19:22:33 +0100151#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Simon Butcher89f77622015-09-27 22:50:49 +0100152
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200153/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200154 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
156#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
157#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
158#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
159#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
160#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162#define MBEDTLS_SSL_IS_CLIENT 0
163#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
166#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
169#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200170
Jarno Lamsad9382f82019-06-10 10:27:14 +0300171#define MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED 0
172#define MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED 1
173
Hanno Becker6198af32019-04-09 15:12:56 +0100174#define MBEDTLS_SSL_CID_DISABLED 0
175#define MBEDTLS_SSL_CID_ENABLED 1
176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#define MBEDTLS_SSL_ETM_DISABLED 0
178#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#define MBEDTLS_SSL_COMPRESS_NULL 0
181#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183#define MBEDTLS_SSL_VERIFY_NONE 0
184#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
185#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200186#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
189#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200191#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
192#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
195#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
198#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
201#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
202#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
205#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
206#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
209#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200210
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100211#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
212#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100213
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200214#define MBEDTLS_SSL_ARC4_ENABLED 0
215#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100216
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200217#define MBEDTLS_SSL_PRESET_DEFAULT 0
218#define MBEDTLS_SSL_PRESET_SUITEB 2
219
Janos Follath088ce432017-04-10 12:42:31 +0100220#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
221#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
222
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200223/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200224 * Default range for DTLS retransmission timer value, in milliseconds.
225 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
226 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
228#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200229
Paul Bakker088c5c52014-04-25 11:11:10 +0200230/**
231 * \name SECTION: Module settings
232 *
233 * The configuration options you can set for this module are in this section.
234 * Either change them in config.h or define them on the compiler command line.
235 * \{
236 */
237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
239#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200240#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200241
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200242/*
Angus Grattond8213d02016-05-25 20:56:48 +1000243 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200244 * determines the size of each of the two internal I/O buffers.
245 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200246 * Note: the RFC defines the default size of SSL / TLS messages. If you
247 * change the value here, other clients / servers may not be able to
248 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200249 * both sides of the connection and have it reduced at both sides, or
250 * if you're using the Max Fragment Length extension and you know all your
251 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200253#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
254#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200255#endif
256
Angus Grattond8213d02016-05-25 20:56:48 +1000257#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
258#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
259#endif
260
261#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
262#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
263#endif
264
Hanno Becker28007512018-08-28 09:46:44 +0100265/*
266 * Maximum number of heap-allocated bytes for the purpose of
267 * DTLS handshake message reassembly and future message buffering.
268 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100269#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100270#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100271#endif
272
Hanno Becker6198af32019-04-09 15:12:56 +0100273/*
274 * Maximum length of CIDs for incoming and outgoing messages.
275 */
276#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Beckerdc19b412019-05-15 10:09:15 +0100277#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker6198af32019-04-09 15:12:56 +0100278#endif
279
280#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
281#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
282#endif
283
Hanno Becker550e1662019-05-08 17:37:58 +0100284#if !defined(MBEDTLS_SSL_CID_PADDING_GRANULARITY)
285#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
286#endif
287
Paul Bakker088c5c52014-04-25 11:11:10 +0200288/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000289
290/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100291 * Length of the verify data for secure renegotiation
292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293#if defined(MBEDTLS_SSL_PROTO_SSL3)
294#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100295#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100297#endif
298
299/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200300 * Signaling ciphersuite values (SCSV)
301 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000303#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000304
Paul Bakker5121ce52009-01-03 21:22:43 +0000305/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000306 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200307 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309#define MBEDTLS_SSL_HASH_NONE 0
310#define MBEDTLS_SSL_HASH_MD5 1
311#define MBEDTLS_SSL_HASH_SHA1 2
312#define MBEDTLS_SSL_HASH_SHA224 3
313#define MBEDTLS_SSL_HASH_SHA256 4
314#define MBEDTLS_SSL_HASH_SHA384 5
315#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200317#define MBEDTLS_SSL_SIG_ANON 0
318#define MBEDTLS_SSL_SIG_RSA 1
319#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000320
321/*
Paul Bakker926af752012-11-23 13:38:07 +0100322 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200323 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
326#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100327
328/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000329 * Message, alert and handshake types
330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200331#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
332#define MBEDTLS_SSL_MSG_ALERT 21
333#define MBEDTLS_SSL_MSG_HANDSHAKE 22
334#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker92c930f2019-04-29 17:31:37 +0100335#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
338#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
341#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
342#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
343#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
344#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
345#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
346#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
347#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
348#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
349#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
350#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
351#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
352#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
353#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
354#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
355#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
356#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
357#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
358#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
359#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
360#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
361#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
362#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
363#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
364#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
365#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
366#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
367#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
368#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Hanno Beckerf46e1ce2019-07-03 13:56:59 +0100369#define MBEDTLS_SSL_ALERT_MSG_NONE 255 /* internal */
Paul Bakker5121ce52009-01-03 21:22:43 +0000370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
372#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
373#define MBEDTLS_SSL_HS_SERVER_HELLO 2
374#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
375#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
376#define MBEDTLS_SSL_HS_CERTIFICATE 11
377#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
378#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
379#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
380#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
381#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
382#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000383
384/*
385 * TLS extensions
386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387#define MBEDTLS_TLS_EXT_SERVERNAME 0
388#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200393
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
395#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000396
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200397#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
402#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200405
Hanno Becker4baec2c2019-04-25 16:24:57 +0100406/* The value of the CID extension is still TBD as of
Hanno Becker3cdf8fe2019-05-15 10:26:32 +0100407 * draft-ietf-tls-dtls-connection-id-05
408 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) */
Hanno Beckerfc7ff922019-05-03 12:42:13 +0100409#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker4baec2c2019-04-25 16:24:57 +0100410
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200411#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
412
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200413#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000414
Paul Bakkereb2c6582012-09-27 19:15:01 +0000415/*
Hanno Becker65382f22019-07-02 13:51:57 +0100416 * Helper macros indicating whether certain classes
417 * of key exchanges are enabled in the configuration.
418 */
419
420/* Key exchanges using a certificate */
421#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
422 defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
423 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
424 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
425 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
426 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
427 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
428#define MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED
429#endif
430
431/* Key exchanges allowing client certificate requests */
432#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
433 defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
434 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
435 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
436 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED) || \
437 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
438#define MBEDTLS_KEY_EXCHANGE__CERT_REQ_ALLOWED__ENABLED
439#endif
440
441/* Key exchanges involving server signature in ServerKeyExchange */
442#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
443 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
444 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
445#define MBEDTLS_KEY_EXCHANGE__WITH_SERVER_SIGNATURE__ENABLED
446#endif
447
448/* Key exchanges using ECDH */
449#if defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
450 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
451#define MBEDTLS_KEY_EXCHANGE__SOME__ECDH_ENABLED
452#endif
453
454/* Key exchanges that don't involve ephemeral keys */
455#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) || \
456 defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
457 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
458 defined(MBEDTLS_KEY_EXCHANGE__SOME__ECDH_ENABLED)
459#define MBEDTLS_KEY_EXCHANGE__SOME_NON_PFS__ENABLED
460#endif
461
462/* Key exchanges that involve ephemeral keys */
463#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
464 defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
465 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
466 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED) || \
467 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
468 defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
469#define MBEDTLS_KEY_EXCHANGE__SOME_PFS__ENABLED
470#endif
471
472/* Key exchanges using a PSK */
473#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
474 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
475 defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
476 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
477#define MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED
478#endif
479
480/* Key exchanges using DHE */
481#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) || \
482 defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
483#define MBEDTLS_KEY_EXCHANGE__SOME__DHE_ENABLED
484#endif
485
486/* Key exchanges using ECDHE */
487#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
488 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
489 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
490#define MBEDTLS_KEY_EXCHANGE__SOME__ECDHE_ENABLED
491#endif
492
493/*
Paul Bakkered27a042013-04-18 22:46:23 +0200494 * Size defines
495 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496#if !defined(MBEDTLS_PSK_MAX_LEN)
497#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200498#endif
499
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200500/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200501union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200502{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200504 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
505#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200506#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
507 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200508#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
510 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
511 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
512 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
513 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200514#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200515#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
516 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200517#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200518#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
519 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
520 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200521#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200522#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
523 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200524#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
526 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
527 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200528#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200529#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
530 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
531#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200532};
533
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200534#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200535
Paul Bakker407a0da2013-06-27 14:29:21 +0200536#ifdef __cplusplus
537extern "C" {
538#endif
539
Paul Bakkered27a042013-04-18 22:46:23 +0200540/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000541 * SSL state machine
542 */
543typedef enum
544{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545 MBEDTLS_SSL_HELLO_REQUEST,
546 MBEDTLS_SSL_CLIENT_HELLO,
547 MBEDTLS_SSL_SERVER_HELLO,
548 MBEDTLS_SSL_SERVER_CERTIFICATE,
549 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
550 MBEDTLS_SSL_CERTIFICATE_REQUEST,
551 MBEDTLS_SSL_SERVER_HELLO_DONE,
552 MBEDTLS_SSL_CLIENT_CERTIFICATE,
553 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
554 MBEDTLS_SSL_CERTIFICATE_VERIFY,
555 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
556 MBEDTLS_SSL_CLIENT_FINISHED,
557 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
558 MBEDTLS_SSL_SERVER_FINISHED,
559 MBEDTLS_SSL_FLUSH_BUFFERS,
560 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
561 MBEDTLS_SSL_HANDSHAKE_OVER,
562 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
563 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000564}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000566
Simon Butchere846b512016-03-01 17:31:49 +0000567/**
568 * \brief Callback type: send data on the network.
569 *
570 * \note That callback may be either blocking or non-blocking.
571 *
572 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000573 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000574 * \param len Length of the data to send
575 *
576 * \return The callback must return the number of bytes sent if any,
577 * or a non-zero error code.
578 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
579 * must be returned when the operation would block.
580 *
Simon Butcherd567a232016-03-09 20:19:21 +0000581 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000582 * It must always return the number of bytes actually sent.
583 */
584typedef int mbedtls_ssl_send_t( void *ctx,
585 const unsigned char *buf,
586 size_t len );
587
588/**
589 * \brief Callback type: receive data from the network.
590 *
591 * \note That callback may be either blocking or non-blocking.
592 *
593 * \param ctx Context for the receive callback (typically a file
594 * descriptor)
595 * \param buf Buffer to write the received data to
596 * \param len Length of the receive buffer
597 *
598 * \return The callback must return the number of bytes received,
599 * or a non-zero error code.
600 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
601 * must be returned when the operation would block.
602 *
Simon Butcherd567a232016-03-09 20:19:21 +0000603 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000604 * buffer. It must always return the number of bytes actually
605 * received and written to the buffer.
606 */
607typedef int mbedtls_ssl_recv_t( void *ctx,
608 unsigned char *buf,
609 size_t len );
610
611/**
612 * \brief Callback type: receive data from the network, with timeout
613 *
614 * \note That callback must block until data is received, or the
615 * timeout delay expires, or the operation is interrupted by a
616 * signal.
617 *
618 * \param ctx Context for the receive callback (typically a file descriptor)
619 * \param buf Buffer to write the received data to
620 * \param len Length of the receive buffer
621 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000622 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000623 *
624 * \return The callback must return the number of bytes received,
625 * or a non-zero error code:
626 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
627 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
628 *
Simon Butcherd567a232016-03-09 20:19:21 +0000629 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000630 * buffer. It must always return the number of bytes actually
631 * received and written to the buffer.
632 */
633typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
634 unsigned char *buf,
635 size_t len,
636 uint32_t timeout );
637/**
638 * \brief Callback type: set a pair of timers/delays to watch
639 *
640 * \param ctx Context pointer
641 * \param int_ms Intermediate delay in milliseconds
642 * \param fin_ms Final delay in milliseconds
643 * 0 cancels the current timer.
644 *
645 * \note This callback must at least store the necessary information
646 * for the associated \c mbedtls_ssl_get_timer_t callback to
647 * return correct information.
648 *
649 * \note If using a event-driven style of programming, an event must
650 * be generated when the final delay is passed. The event must
651 * cause a call to \c mbedtls_ssl_handshake() with the proper
652 * SSL context to be scheduled. Care must be taken to ensure
653 * that at most one such call happens at a time.
654 *
655 * \note Only one timer at a time must be running. Calling this
656 * function while a timer is running must cancel it. Cancelled
657 * timers must not generate any event.
658 */
659typedef void mbedtls_ssl_set_timer_t( void * ctx,
660 uint32_t int_ms,
661 uint32_t fin_ms );
662
663/**
664 * \brief Callback type: get status of timers/delays
665 *
666 * \param ctx Context pointer
667 *
668 * \return This callback must return:
669 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000670 * 0 if none of the delays have passed,
671 * 1 if only the intermediate delay has passed,
672 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000673 */
674typedef int mbedtls_ssl_get_timer_t( void * ctx );
675
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200676/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200677typedef struct mbedtls_ssl_session mbedtls_ssl_session;
678typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200679typedef struct mbedtls_ssl_config mbedtls_ssl_config;
680
681/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200682typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
683typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100684typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200685#if defined(MBEDTLS_X509_CRT_PARSE_C)
686typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200687#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200688#if defined(MBEDTLS_SSL_PROTO_DTLS)
689typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200690#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000691
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200692#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100693#if defined(MBEDTLS_X509_CRT_PARSE_C)
694/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200695 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100696 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200697 * This callback is called during an SSL handshake to start
698 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200699 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100700 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200701 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100702 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200703 * This function typically sends or enqueues a request, and
704 * does not wait for the operation to complete. This allows
705 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100706 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200707 * The parameters \p ssl and \p cert are guaranteed to remain
708 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200709 * function must save the contents of \p hash if the value
710 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200711 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100712 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200713 * This function may call mbedtls_ssl_set_async_operation_data()
714 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200715 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200716 *
Gilles Peskined3268832018-04-26 06:23:59 +0200717 * \note For RSA signatures, this function must produce output
718 * that is consistent with PKCS#1 v1.5 in the same way as
719 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
720 * apply the padding steps described in RFC 8017, section 9.2
721 * "EMSA-PKCS1-v1_5" as follows.
722 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
723 * encoding, treating \p hash as the DigestInfo to be
724 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
725 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200726 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200727 * encoding, treating \p hash as the hash to be encoded and
728 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
729 * from step 2, with `digestAlgorithm` obtained by calling
730 * mbedtls_oid_get_oid_by_md() on \p md_alg.
731 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200732 * \note For ECDSA signatures, the output format is the DER encoding
733 * `Ecdsa-Sig-Value` defined in
734 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
735 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200736 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200737 * modified other than via
738 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200739 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200740 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200741 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200742 * connection. However, if other callbacks are used, this
743 * property may not hold. For example, if an SNI callback
744 * is registered with mbedtls_ssl_conf_sni(), then
745 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200746 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100747 * \param hash Buffer containing the hash. This buffer is
748 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200749 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100750 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200751 * \return 0 if the operation was started successfully and the SSL
752 * stack should call the resume callback immediately.
753 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
754 * was started successfully and the SSL stack should return
755 * immediately without calling the resume callback yet.
756 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
757 * processor does not support this key. The SSL stack will
758 * use the private key object instead.
759 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200760 * propagated up the call chain. The callback should
761 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
762 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200763 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100764 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200765typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100766 mbedtls_x509_crt *cert,
767 mbedtls_md_type_t md_alg,
768 const unsigned char *hash,
769 size_t hash_len );
770
771/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200772 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100773 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200774 * This callback is called during an SSL handshake to start
775 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200776 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100777 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200778 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100779 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200780 * This function typically sends or enqueues a request, and
781 * does not wait for the operation to complete. This allows
782 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100783 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200784 * The parameters \p ssl and \p cert are guaranteed to remain
785 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200786 * function must save the contents of \p input if the value
787 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200788 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100789 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200790 * This function may call mbedtls_ssl_set_async_operation_data()
791 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200792 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200793 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200794 * \warning RSA decryption as used in TLS is subject to a potential
795 * timing side channel attack first discovered by Bleichenbacher
796 * in 1998. This attack can be remotely exploitable
797 * in practice. To avoid this attack, you must ensure that
798 * if the callback performs an RSA decryption, the time it
799 * takes to execute and return the result does not depend
800 * on whether the RSA decryption succeeded or reported
801 * invalid padding.
802 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200803 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200804 * modified other than via
805 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200806 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200807 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200808 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200809 * connection. However, if other callbacks are used, this
810 * property may not hold. For example, if an SNI callback
811 * is registered with mbedtls_ssl_conf_sni(), then
812 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100813 * \param input Buffer containing the input ciphertext. This buffer
814 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200815 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100816 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200817 * \return 0 if the operation was started successfully and the SSL
818 * stack should call the resume callback immediately.
819 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
820 * was started successfully and the SSL stack should return
821 * immediately without calling the resume callback yet.
822 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
823 * processor does not support this key. The SSL stack will
824 * use the private key object instead.
825 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200826 * propagated up the call chain. The callback should
827 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
828 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200829 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100830 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200831typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100832 mbedtls_x509_crt *cert,
833 const unsigned char *input,
834 size_t input_len );
835#endif /* MBEDTLS_X509_CRT_PARSE_C */
836
837/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200838 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100839 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200840 * This callback is called during an SSL handshake to resume
841 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200842 * ::mbedtls_ssl_async_sign_t or
843 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200844 *
845 * This function typically checks the status of a pending
846 * request or causes the request queue to make progress, and
847 * does not wait for the operation to complete. This allows
848 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100849 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200850 * This function may call mbedtls_ssl_get_async_operation_data()
851 * to retrieve an operation context set by the start callback.
852 * It may call mbedtls_ssl_set_async_operation_data() to modify
853 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200854 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200855 * Note that when this function returns a status other than
856 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
857 * resources associated with the operation.
858 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200859 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200860 * modified other than via
861 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200862 * \param output Buffer containing the output (signature or decrypted
863 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200864 * \param output_len On success, number of bytes written to \p output.
865 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100866 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200867 * \return 0 if output of the operation is available in the
868 * \p output buffer.
869 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
870 * is still in progress. Subsequent requests for progress
871 * on the SSL connection will call the resume callback
872 * again.
873 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200874 * The SSL handshake is aborted. The callback should
875 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
876 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200877 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100878 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200879typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100880 unsigned char *output,
881 size_t *output_len,
882 size_t output_size );
883
884/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200885 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100886 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200887 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200888 * while an asynchronous operation is in progress. Note that
889 * this callback is not called if the
890 * ::mbedtls_ssl_async_resume_t callback has run and has
891 * returned a value other than
892 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
893 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100894 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200895 * This function may call mbedtls_ssl_get_async_operation_data()
896 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200897 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200898 * \param ssl The SSL connection instance. It should not be
899 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100900 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200901typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200902#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000903
Hanno Becker2984bd22019-02-26 11:43:09 +0000904#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) && \
905 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000906#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
907#if defined(MBEDTLS_SHA256_C)
908#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
909#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
910#elif defined(MBEDTLS_SHA512_C)
911#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
912#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
913#elif defined(MBEDTLS_SHA1_C)
914#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
915#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
916#else
Hanno Becker2984bd22019-02-26 11:43:09 +0000917/* This is already checked in check_config.h, but be sure. */
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000918#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
919#endif
Hanno Becker2984bd22019-02-26 11:43:09 +0000920#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED &&
921 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000922
Paul Bakker5121ce52009-01-03 21:22:43 +0000923/*
Paul Bakker0a597072012-09-25 21:55:46 +0000924 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard5363e1f2019-05-24 09:48:05 +0200925 *
926 * Note: when changing this definition, we need to check and update:
927 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +0200928 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard5363e1f2019-05-24 09:48:05 +0200929 * - in library/ssl_tls.c:
930 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
931 * mbedtls_ssl_session_save() and ssl_session_load()
932 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000933 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200934struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000935{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100937 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200938#endif
Hanno Becker73f4cb12019-06-27 13:51:07 +0100939#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Paul Bakkere3166ce2011-01-27 17:40:50 +0000940 int ciphersuite; /*!< chosen ciphersuite */
Hanno Becker73f4cb12019-06-27 13:51:07 +0100941#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000942 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200943 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000944 unsigned char id[32]; /*!< session identifier */
945 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker2e6d3472019-02-06 15:40:27 +0000948#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000949 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Becker5882dd02019-06-06 16:25:57 +0100950#elif defined(MBEDTLS_SSL_RENEGOTIATION)
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000951 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
952 * changes during renegotiation, mitigating the triple handshake attack. */
953 unsigned char *peer_cert_digest;
954 size_t peer_cert_digest_len;
955 mbedtls_md_type_t peer_cert_digest_type;
Hanno Becker5882dd02019-06-06 16:25:57 +0100956#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE && MBEDTLS_SSL_RENEGOTIATION */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200958 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200959
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200960#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200961 unsigned char *ticket; /*!< RFC 5077 session ticket */
962 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200963 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200964#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200967 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200971 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100975 int encrypt_then_mac; /*!< flag for EtM activation */
976#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000977};
978
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200979/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200980 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200981 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200982struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200983{
984 /* Group items by size (largest first) to minimize padding overhead */
985
986 /*
987 * Pointers
988 */
989
Hanno Becker73f4cb12019-06-27 13:51:07 +0100990#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100991 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Hanno Becker73f4cb12019-06-27 13:51:07 +0100992#endif /* MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200993
Hanno Becker272063a2019-06-19 15:06:40 +0100994#if defined(MBEDTLS_DEBUG_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200995 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200996 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200997 void *p_dbg; /*!< context for the debug function */
Hanno Becker272063a2019-06-19 15:06:40 +0100998#endif /* MBEDTLS_DEBUG_C */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200999
Hanno Beckerece325c2019-06-13 15:39:27 +01001000#if !defined(MBEDTLS_SSL_CONF_RNG)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001001 /** Callback for getting (pseudo-)random numbers */
1002 int (*f_rng)(void *, unsigned char *, size_t);
Hanno Beckerece325c2019-06-13 15:39:27 +01001003#endif /* !MBEDTLS_SSL_CONF_RNG */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001004 void *p_rng; /*!< context for the RNG function */
1005
Manuel Pégourié-Gonnard33cb3e12019-07-01 11:14:18 +02001006#if defined(MBEDTLS_SSL_SRV_C) && !defined(MBEDTLS_SSL_NO_SESSION_CACHE)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001007 /** Callback to retrieve a session from the cache */
1008 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001009 /** Callback to store a session into the cache */
1010 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001011 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnard33cb3e12019-07-01 11:14:18 +02001012#endif /* MBEDTLS_SSL_SRV_C && !MBEDTLS_SSL_NO_SESSION_CACHE */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001013
1014#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1015 /** Callback for setting cert according to SNI extension */
1016 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1017 void *p_sni; /*!< context for SNI callback */
1018#endif
1019
1020#if defined(MBEDTLS_X509_CRT_PARSE_C)
1021 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001022 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001023 void *p_vrfy; /*!< context for X.509 verify calllback */
1024#endif
1025
1026#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1027 /** Callback to retrieve PSK key from identity */
1028 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1029 void *p_psk; /*!< context for PSK callback */
1030#endif
1031
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001032#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001033 /** Callback to create & write a cookie for ClientHello veirifcation */
1034 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
1035 const unsigned char *, size_t );
1036 /** Callback to verify validity of a ClientHello cookie */
1037 int (*f_cookie_check)( void *, const unsigned char *, size_t,
1038 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001039 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001040#endif
1041
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001042#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001043 /** Callback to create & write a session ticket */
1044 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
1045 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1046 /** Callback to parse a session ticket into a session structure */
1047 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1048 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001049#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001050
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001051#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001052 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001053 int (*f_export_keys)( void *, const unsigned char *,
1054 const unsigned char *, size_t, size_t, size_t );
1055 void *p_export_keys; /*!< context for key export callback */
1056#endif
1057
Hanno Beckera5a2b082019-05-15 14:03:01 +01001058#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere0200da2019-06-13 09:23:43 +01001059#if !defined(MBEDTLS_SSL_CONF_CID_LEN)
Hanno Beckereec2be92019-05-03 13:06:44 +01001060 size_t cid_len; /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckere0200da2019-06-13 09:23:43 +01001061#endif /* !MBEDTLS_SSL_CONF_CID_LEN */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001062#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckereec2be92019-05-03 13:06:44 +01001063
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001064#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001065 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001066 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
1067 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
1068 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
1069#endif /* MBEDTLS_X509_CRT_PARSE_C */
1070
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001071#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001072#if defined(MBEDTLS_X509_CRT_PARSE_C)
1073 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
1074 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
1075#endif /* MBEDTLS_X509_CRT_PARSE_C */
1076 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
1077 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +02001078 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001079#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001080
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001081#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Hanno Becker56595f42019-06-19 16:31:38 +01001082#if !defined(MBEDTLS_SSL_CONF_SINGLE_SIG_HASH)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001083 const int *sig_hashes; /*!< allowed signature hashes */
Hanno Becker56595f42019-06-19 16:31:38 +01001084#endif /* !MBEDTLS_SSL_CONF_SINGLE_SIG_HASH */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001085#endif
1086
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001087#if defined(MBEDTLS_ECP_C)
Hanno Beckerc1096e72019-06-19 12:30:41 +01001088#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001089 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Hanno Beckerc1096e72019-06-19 12:30:41 +01001090#endif /* MBEDTLS_SSL_CONF_SINGLE_EC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001091#endif
1092
1093#if defined(MBEDTLS_DHM_C)
1094 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
1095 mbedtls_mpi dhm_G; /*!< generator for DHM */
1096#endif
1097
1098#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Azim Khanf4659ef2018-03-26 22:11:24 +01001099 unsigned char *psk; /*!< pre-shared key. This field should
1100 only be set via
1101 mbedtls_ssl_conf_psk() */
1102 size_t psk_len; /*!< length of the pre-shared key. This
1103 field should only be set via
1104 mbedtls_ssl_conf_psk() */
1105 unsigned char *psk_identity; /*!< identity for PSK negotiation. This
1106 field should only be set via
1107 mbedtls_ssl_conf_psk() */
1108 size_t psk_identity_len;/*!< length of identity. This field should
1109 only be set via
1110 mbedtls_ssl_conf_psk() */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001111#endif
1112
1113#if defined(MBEDTLS_SSL_ALPN)
1114 const char **alpn_list; /*!< ordered list of protocols */
1115#endif
1116
1117 /*
1118 * Numerical settings (int then char)
1119 */
1120
Hanno Becker1f835fa2019-06-13 10:14:59 +01001121#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001122 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
Hanno Becker1f835fa2019-06-13 10:14:59 +01001123#endif /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001124
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001125#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker1f835fa2019-06-13 10:14:59 +01001126#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001127 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001128 retransmission timeout (ms) */
Hanno Becker1f835fa2019-06-13 10:14:59 +01001129#endif /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MIN */
1130#if !defined(MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001131 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001132 retransmission timeout (ms) */
Hanno Becker1f835fa2019-06-13 10:14:59 +01001133#endif /* !MBEDTLS_SSL_CONF_HS_TIMEOUT_MAX */
1134#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001135
1136#if defined(MBEDTLS_SSL_RENEGOTIATION)
1137 int renego_max_records; /*!< grace period for renegotiation */
1138 unsigned char renego_period[8]; /*!< value of the record counters
1139 that triggers renegotiation */
1140#endif
1141
1142#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Hanno Beckerde671542019-06-12 16:30:46 +01001143#if !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001144 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
Hanno Beckerde671542019-06-12 16:30:46 +01001145#endif /* !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001146#endif
1147
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001148#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1149 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1150#endif
1151
Hanno Beckere965bd32019-06-12 14:04:34 +01001152#if !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001153 unsigned char max_major_ver; /*!< max. major version used */
Hanno Beckere965bd32019-06-12 14:04:34 +01001154#endif /* !MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
1155#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001156 unsigned char max_minor_ver; /*!< max. minor version used */
Hanno Beckere965bd32019-06-12 14:04:34 +01001157#endif /* !MBEDTLS_SSL_CONF_MAX_MINOR_VER */
1158#if !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001159 unsigned char min_major_ver; /*!< min. major version used */
Hanno Beckere965bd32019-06-12 14:04:34 +01001160#endif /* !MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
1161#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001162 unsigned char min_minor_ver; /*!< min. minor version used */
Hanno Beckere965bd32019-06-12 14:04:34 +01001163#endif /* !MBEDTLS_SSL_CONF_MIN_MINOR_VER */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001164
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001165 /*
1166 * Flags (bitfields)
1167 */
1168
Hanno Becker2d9623f2019-06-13 12:07:05 +01001169#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001170 unsigned int endpoint : 1; /*!< 0: client, 1: server */
Hanno Becker2d9623f2019-06-13 12:07:05 +01001171#endif /* !MBEDTLS_SSL_CONF_ENDPOINT */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001172 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001173#if !defined(MBEDTLS_SSL_CONF_AUTHMODE)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001174 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
Hanno Beckeracd4fc02019-06-12 16:40:50 +01001175#endif /* !MBEDTLS_SSL_CONF_AUTHMODE */
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001176#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001177 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1178 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Hanno Beckerb0b2b672019-06-12 16:58:10 +01001179#endif /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001180#if defined(MBEDTLS_ARC4_C)
1181 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
1182#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001183#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1184 unsigned int mfl_code : 3; /*!< desired fragment length */
1185#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001186#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1187 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1188#endif
1189#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Hanno Beckeraabbb582019-06-11 13:43:27 +01001190#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001191 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
Hanno Beckeraabbb582019-06-11 13:43:27 +01001192#endif /* !MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
1193#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03001194 unsigned int enforce_extended_master_secret : 1; /*!< enforce the usage
1195 * of extended master
1196 * secret */
Hanno Beckeraabbb582019-06-11 13:43:27 +01001197#endif /* !MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001198#endif
1199#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Hanno Becker7f376f42019-06-12 16:20:48 +01001200#if !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001201 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
Hanno Becker7f376f42019-06-12 16:20:48 +01001202#endif /* !MBEDTLS_SSL_CONF_ANTI_REPLAY */
1203#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001204#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1205 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1206#endif
1207#if defined(MBEDTLS_SSL_RENEGOTIATION)
1208 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1209#endif
1210#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1211 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1212#endif
1213#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1214 unsigned int session_tickets : 1; /*!< use session tickets? */
1215#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001216#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1217 unsigned int fallback : 1; /*!< is this a fallback? */
1218#endif
Janos Follath088ce432017-04-10 12:42:31 +01001219#if defined(MBEDTLS_SSL_SRV_C)
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001220#if !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
Janos Follath088ce432017-04-10 12:42:31 +01001221 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1222 Certificate Request messages? */
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01001223#endif /* !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
Janos Follath088ce432017-04-10 12:42:31 +01001224#endif
Hanno Beckera5a2b082019-05-15 14:03:01 +01001225#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere0200da2019-06-13 09:23:43 +01001226#if !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
Hanno Beckere8eff9a2019-05-14 11:30:10 +01001227 unsigned int ignore_unexpected_cid : 1; /*!< Determines whether DTLS
1228 * record with unexpected CID
1229 * should lead to failure. */
Hanno Beckere0200da2019-06-13 09:23:43 +01001230#endif /* !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001231#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001232};
1233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001234struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001235{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001236 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001237
Hanno Beckerc8f52992019-07-25 11:15:08 +01001238 unsigned char pending_fatal_alert_msg;
Hanno Beckerf46e1ce2019-07-03 13:56:59 +01001239
Paul Bakker5121ce52009-01-03 21:22:43 +00001240 /*
1241 * Miscellaneous
1242 */
1243 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001244#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001245 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001246 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1247 number of retransmissions of request if
1248 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001249#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001250
Hanno Becker381eaa52019-06-12 14:43:01 +01001251#if !defined(MBEDTLS_SSL_CONF_FIXED_MAJOR_VER)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001252 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Hanno Becker381eaa52019-06-12 14:43:01 +01001253#endif /* !MBEDTLS_SSL_CONF_FIXED_MAJOR_VER */
1254#if !defined(MBEDTLS_SSL_CONF_FIXED_MINOR_VER)
Paul Bakker5121ce52009-01-03 21:22:43 +00001255 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
Hanno Becker381eaa52019-06-12 14:43:01 +01001256#endif /* !MBEDTLS_SSL_CONF_FIXED_MINOR_VER */
Paul Bakker5121ce52009-01-03 21:22:43 +00001257
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001258#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001259 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001260#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001261
Hanno Beckera58a8962019-06-13 16:11:15 +01001262#if !defined(MBEDTLS_SSL_CONF_SEND)
Simon Butchere846b512016-03-01 17:31:49 +00001263 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
Hanno Beckera58a8962019-06-13 16:11:15 +01001264#endif /* !MBEDTLS_SSL_CONF_SEND */
1265#if !defined(MBEDTLS_SSL_CONF_RECV)
Simon Butchere846b512016-03-01 17:31:49 +00001266 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
Hanno Beckera58a8962019-06-13 16:11:15 +01001267#endif /* !MBEDTLS_SSL_CONF_RECV */
1268#if !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
Simon Butchere846b512016-03-01 17:31:49 +00001269 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
Hanno Beckera58a8962019-06-13 16:11:15 +01001270#endif /* !MBEDTLS_SSL_CONF_RECV_TIMEOUT */
Simon Butchere846b512016-03-01 17:31:49 +00001271 /*!< Callback for network receive with timeout */
1272
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001273 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001274
Paul Bakker5121ce52009-01-03 21:22:43 +00001275 /*
1276 * Session layer
1277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1279 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1280 mbedtls_ssl_session *session; /*!< negotiated session data */
1281 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001284 the handshake process */
1285
1286 /*
1287 * Record layer transformations
1288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1290 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1291 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1292 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001293
Paul Bakker5121ce52009-01-03 21:22:43 +00001294 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001295 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001296 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001297 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001298
Hanno Becker0ae6b242019-06-13 16:45:36 +01001299#if !defined(MBEDTLS_SSL_CONF_SET_TIMER)
Simon Butchere846b512016-03-01 17:31:49 +00001300 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
Hanno Becker0ae6b242019-06-13 16:45:36 +01001301#endif /* !MBEDTLS_SSL_CONF_SET_TIMER */
1302#if !defined(MBEDTLS_SSL_CONF_GET_TIMER)
Simon Butchere846b512016-03-01 17:31:49 +00001303 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Hanno Becker0ae6b242019-06-13 16:45:36 +01001304#endif /* !MBEDTLS_SSL_CONF_GET_TIMER */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001305
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001306 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 * Record layer (incoming data)
1308 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001309 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001310 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1311 TLS: maintained by us
1312 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001313 unsigned char *in_hdr; /*!< start of record header */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001314#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker70e79282019-05-03 14:34:53 +01001315 unsigned char *in_cid; /*!< The start of the CID;
1316 * (the end is marked by in_len). */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001317#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001318 unsigned char *in_len; /*!< two-bytes message length field */
1319 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001320 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001321 unsigned char *in_offt; /*!< read offset in application data */
1322
1323 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001324 size_t in_msglen; /*!< record header: message length */
1325 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001327 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001328 size_t next_record_offset; /*!< offset of the next record in datagram
1329 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001330#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001331#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001332 uint64_t in_window_top; /*!< last validated record seq_num */
1333 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001334#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001335
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001336 size_t in_hslen; /*!< current handshake message length,
1337 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001338 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001339
1340 int keep_current_message; /*!< drop or reuse current message
1341 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001342
Hanno Becker04da1892018-08-14 13:22:10 +01001343#if defined(MBEDTLS_SSL_PROTO_DTLS)
1344 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1345 * within a single datagram. */
1346#endif /* MBEDTLS_SSL_PROTO_DTLS */
1347
Paul Bakker5121ce52009-01-03 21:22:43 +00001348 /*
1349 * Record layer (outgoing data)
1350 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001351 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001352 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001353 unsigned char *out_hdr; /*!< start of record header */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001354#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker70e79282019-05-03 14:34:53 +01001355 unsigned char *out_cid; /*!< The start of the CID;
1356 * (the end is marked by in_len). */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001357#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001358 unsigned char *out_len; /*!< two-bytes message length field */
1359 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001360 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001361
1362 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001363 size_t out_msglen; /*!< record header: message length */
1364 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +00001365
Hanno Becker19859472018-08-06 09:40:20 +01001366 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1367
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001368#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001369 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001370#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001371
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001372#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001373 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001374#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001375#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001376 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001377#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001378
Paul Bakker5121ce52009-01-03 21:22:43 +00001379 /*
1380 * PKI layer
1381 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001382 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001383
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001384 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001385 * User settings
1386 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001387#if defined(MBEDTLS_X509_CRT_PARSE_C)
1388 char *hostname; /*!< expected peer CN for verification
1389 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001390#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001392#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001393 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001394#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001395
Paul Bakker48916f92012-09-16 19:57:18 +00001396 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001397 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001398 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001399#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001400 unsigned char *cli_id; /*!< transport-level ID of the client */
1401 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001402#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001403
1404 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001405 * Secure renegotiation
1406 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001407 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001408 int secure_renegotiation; /*!< does peer support legacy or
1409 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001411 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1413 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001414#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Beckere5e7f622019-04-25 15:46:59 +01001415
Hanno Beckera5a2b082019-05-15 14:03:01 +01001416#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +01001417 /* CID configuration to use in subsequent handshakes. */
1418
1419 /*! The next incoming CID, chosen by the user and applying to
1420 * all subsequent handshakes. This may be different from the
1421 * CID currently used in case the user has re-configured the CID
1422 * after an initial handshake. */
1423 unsigned char own_cid[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1424 uint8_t own_cid_len; /*!< The length of \c own_cid. */
1425 uint8_t negotiate_cid; /*!< This indicates whether the CID extension should
1426 * be negotiated in the next handshake or not.
1427 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1428 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001429#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001430};
1431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001432#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
1435#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +01001436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001437extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +00001438 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001439 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +00001440 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001441 size_t ivlen,
1442 const unsigned char *mac_enc, const unsigned char *mac_dec,
1443 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001444extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
1445extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
1446extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
1447extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
1448extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
1449#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001450
Paul Bakker5121ce52009-01-03 21:22:43 +00001451/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001452 * \brief Return the name of the ciphersuite associated with the
1453 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001454 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001455 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001456 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001457 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001458 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001459const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001460
1461/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001462 * \brief Return the ID of the ciphersuite associated with the
1463 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001464 *
1465 * \param ciphersuite_name SSL ciphersuite name
1466 *
1467 * \return the ID with the ciphersuite or 0 if not found
1468 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001470
1471/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001472 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001473 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001474 * mbedtls_ssl_free()
1475 *
1476 * \param ssl SSL context
1477 */
1478void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1479
1480/**
1481 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001482 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001483 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001484 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001485 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001486 * \warning The conf structure will be accessed during the session.
1487 * It must not be modified or freed as long as the session
1488 * is active.
1489 *
1490 * \warning This function must be called exactly once per context.
1491 * Calling mbedtls_ssl_setup again is not supported, even
1492 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001493 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001494 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001495 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001496 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001497 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001498 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001499 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001500int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001501 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001502
1503/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001504 * \brief Reset an already initialized SSL context for re-use
1505 * while retaining application-set variables, function
1506 * pointers and data.
1507 *
1508 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001509 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1511 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001514
Hanno Becker2d9623f2019-06-13 12:07:05 +01001515#if !defined(MBEDTLS_SSL_CONF_ENDPOINT)
Paul Bakker7eb013f2011-10-06 12:37:39 +00001516/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001517 * \brief Set the current endpoint type
1518 *
Hanno Becker2d9623f2019-06-13 12:07:05 +01001519 * \note On constrained systems, this can also be configured
1520 * at compile-time via MBEDTLS_SSL_CONF_ENDPOINT.
1521 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001522 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001524 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001525void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Hanno Becker2d9623f2019-06-13 12:07:05 +01001526#endif /* !MBEDTLS_SSL_CONF_ENDPOINT */
Paul Bakker5121ce52009-01-03 21:22:43 +00001527
1528/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001529 * \brief Set the transport type (TLS or DTLS).
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001530 * Default: TLS unless #MBEDTLS_SSL_PROTO_NO_TLS is defined,
1531 * else DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001532 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001533 * \note For DTLS, you must either provide a recv callback that
1534 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001535 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1536 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001537 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001538 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001539 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1541 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001542 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001543void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001544
1545/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001546 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001547 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001548 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001549 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001550 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001551 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001552 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001553 * (default on server)
1554 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001555 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001556 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001557 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001559 * handshake is complete.
1560 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001562 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001563 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001564 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001565 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1566 * With MBEDTLS_SSL_VERIFY_OPTIONAL, the user needs to call mbedtls_ssl_get_verify_result() at
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001567 * the right time(s), which may not be obvious, while REQUIRED always perform
1568 * the verification as soon as possible. For example, REQUIRED was protecting
1569 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001570 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001571void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001572
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001573#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001574/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001575 * \brief Set the verification callback (Optional).
1576 *
Paul Bakker915275b2012-09-28 07:10:55 +00001577 * If set, the verify callback is called for each
1578 * certificate in the chain. For implementation
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +02001579 * information, please see \c mbedtls_x509_crt_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001580 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001581 * \param conf SSL configuration
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001582 * \param f_vrfy verification function
1583 * \param p_vrfy verification parameter
1584 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001585void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001586 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001587 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001588#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001589
Hanno Beckerece325c2019-06-13 15:39:27 +01001590#if !defined(MBEDTLS_SSL_CONF_RNG)
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001591/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001592 * \brief Set the random number generator callback
1593 *
Hanno Becker65f6f382019-07-04 11:28:34 +01001594 * \note On constrained systems, the RNG can also be configured at
1595 * compile-time via the option MBEDTLS_SSL_CONF_RNG.
Hanno Beckerece325c2019-06-13 15:39:27 +01001596 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001597 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001598 * \param f_rng RNG function
1599 * \param p_rng RNG parameter
1600 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001601void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001602 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001603 void *p_rng );
Hanno Becker65f6f382019-07-04 11:28:34 +01001604#else /* !MBEDTLS_SSL_CONF_RNG */
Hanno Beckerece325c2019-06-13 15:39:27 +01001605/**
1606 * \brief Set the random number generator callback context.
1607 *
1608 * \param conf SSL configuration
1609 * \param p_rng RNG parameter
1610 */
1611void mbedtls_ssl_conf_rng_ctx( mbedtls_ssl_config *conf,
1612 void *p_rng );
Hanno Becker65f6f382019-07-04 11:28:34 +01001613#endif /* MBEDTLS_SSL_CONF_RNG */
Paul Bakker5121ce52009-01-03 21:22:43 +00001614
Hanno Becker14a4a442019-07-02 17:00:34 +01001615#if defined(MBEDTLS_DEBUG_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001616/**
1617 * \brief Set the debug callback
1618 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001619 * The callback has the following argument:
1620 * void * opaque context for the callback
1621 * int debug level
1622 * const char * file name
1623 * int line number
1624 * const char * message
1625 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001626 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001627 * \param f_dbg debug function
1628 * \param p_dbg debug parameter
1629 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001630void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001631 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001632 void *p_dbg );
Hanno Becker14a4a442019-07-02 17:00:34 +01001633#endif /* MBEDTLS_DEBUG_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001634
Hanno Beckera58a8962019-06-13 16:11:15 +01001635#if !defined(MBEDTLS_SSL_CONF_RECV) && \
1636 !defined(MBEDTLS_SSL_CONF_SEND) && \
1637 !defined(MBEDTLS_SSL_CONF_RECV_TIMEOUT)
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001638/**
1639 * \brief Set the underlying BIO callbacks for write, read and
1640 * read-with-timeout.
1641 *
1642 * \param ssl SSL context
1643 * \param p_bio parameter (context) shared by BIO callbacks
1644 * \param f_send write callback
1645 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001646 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001647 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001648 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1649 * the other is used. If both are non-NULL, f_recv_timeout is
1650 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001651 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001652 * \note The two most common use cases are:
1653 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1654 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1655 *
1656 * \note For DTLS, you need to provide either a non-NULL
1657 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001658 *
1659 * \note See the documentations of \c mbedtls_ssl_sent_t,
1660 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001661 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001662 *
Hanno Beckera58a8962019-06-13 16:11:15 +01001663 * \note On constrained systems, the pointers \p f_send, \p f_recv,
1664 * and \p f_recv_timeout can also be configured at compile-time
1665 * via the macros MBEDTLS_SSL_CONF_RECV, MBEDTLS_SSL_CONF_SEND
Hanno Becker1f1e9ef2019-07-04 11:33:09 +01001666 * and MBEDTLS_SSL_CONF_RECV_TIMEOUT.
Hanno Beckera58a8962019-06-13 16:11:15 +01001667 *
Andres AG3616f6f2016-09-14 14:32:09 +01001668 * \note On some platforms, net_sockets.c provides
1669 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1670 * \c mbedtls_net_recv_timeout() that are suitable to be used
1671 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001672 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001673void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001674 void *p_bio,
1675 mbedtls_ssl_send_t *f_send,
1676 mbedtls_ssl_recv_t *f_recv,
1677 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Hanno Becker1f1e9ef2019-07-04 11:33:09 +01001678#else /* !( MBEDTLS_SSL_CONF_RECV &&
1679 MBEDTLS_SSL_CONF_SEND &&
1680 MBEDTLS_SSL_CONF_RECV_TIMEOUT ) */
Hanno Beckera58a8962019-06-13 16:11:15 +01001681/**
1682 * \brief Set the context to be passed to the underlying BIO callbacks
1683 * for write, read and read-with-timeout.
1684 *
1685 * \param ssl The SSL context to configure.
1686 * \param p_bio The parameter (context) to be used for the BIO callbacks.
1687 *
1688 */
1689void mbedtls_ssl_set_bio_ctx( mbedtls_ssl_context *ssl,
1690 void *p_bio );
Hanno Becker1f1e9ef2019-07-04 11:33:09 +01001691#endif /* MBEDTLS_SSL_CONF_RECV &&
1692 MBEDTLS_SSL_CONF_SEND &&
1693 MBEDTLS_SSL_CONF_RECV_TIMEOUT */
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001694
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001695#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker6198af32019-04-09 15:12:56 +01001696
Hanno Beckera5a2b082019-05-15 14:03:01 +01001697#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6198af32019-04-09 15:12:56 +01001698
1699
1700/**
Hanno Becker043a2a42019-05-08 13:24:25 +01001701 * \brief Configure the use of the Connection ID (CID)
Hanno Becker8d0893d2019-04-23 12:01:20 +01001702 * extension in the next handshake.
Hanno Becker6198af32019-04-09 15:12:56 +01001703 *
Hanno Becker3cdf8fe2019-05-15 10:26:32 +01001704 * Reference: draft-ietf-tls-dtls-connection-id-05
1705 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker6198af32019-04-09 15:12:56 +01001706 *
Hanno Beckerf83017c2019-05-15 10:08:35 +01001707 * The DTLS CID extension allows the reliable association of
Hanno Becker6198af32019-04-09 15:12:56 +01001708 * DTLS records to DTLS connections across changes in the
Hanno Becker53f36e92019-05-15 10:10:36 +01001709 * underlying transport (changed IP and Port metadata) by
1710 * adding explicit connection identifiers (CIDs) to the
1711 * headers of encrypted DTLS records. The desired CIDs are
1712 * configured by the application layer and are exchanged in
1713 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker6198af32019-04-09 15:12:56 +01001714 * handshake, where each side indicates the CID it wants the
1715 * peer to use when writing encrypted messages. The CIDs are
1716 * put to use once records get encrypted: the stack discards
1717 * any incoming records that don't include the configured CID
1718 * in their header, and adds the peer's requested CID to the
1719 * headers of outgoing messages.
1720 *
Hanno Becker5fcac0d2019-05-15 10:12:11 +01001721 * This API enables or disables the use of the CID extension
1722 * in the next handshake and sets the value of the CID to
1723 * be used for incoming messages.
Hanno Becker6198af32019-04-09 15:12:56 +01001724 *
1725 * \param ssl The SSL context to configure. This must be initialized.
1726 * \param enable This value determines whether the CID extension should
1727 * be used or not. Possible values are:
1728 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Beckerd928c062019-04-23 11:37:38 +01001729 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1730 * of the CID.
Hanno Becker6198af32019-04-09 15:12:56 +01001731 * \param own_cid The address of the readable buffer holding the CID we want
1732 * the peer to use when sending encrypted messages to us.
1733 * This may be \c NULL if \p own_cid_len is \c 0.
1734 * This parameter is unused if \p enabled is set to
1735 * MBEDTLS_SSL_CID_DISABLED.
1736 * \param own_cid_len The length of \p own_cid.
1737 * This parameter is unused if \p enabled is set to
1738 * MBEDTLS_SSL_CID_DISABLED.
1739 *
Hanno Beckereec2be92019-05-03 13:06:44 +01001740 * \note The value of \p own_cid_len must match the value of the
Hanno Beckere8eff9a2019-05-14 11:30:10 +01001741 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckereec2be92019-05-03 13:06:44 +01001742 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Becker241947d2019-05-13 15:26:11 +01001743 * is bound to.
Hanno Beckereec2be92019-05-03 13:06:44 +01001744 *
Hanno Beckerb9b7e292019-04-23 11:38:47 +01001745 * \note This CID configuration applies to subsequent handshakes
Hanno Becker6198af32019-04-09 15:12:56 +01001746 * performed on the SSL context \p ssl, but does not trigger
1747 * one. You still have to call `mbedtls_ssl_handshake()`
1748 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1749 * (for a renegotiation handshake) explicitly after a
1750 * successful call to this function to run the handshake.
1751 *
1752 * \note This call cannot guarantee that the use of the CID
1753 * will be successfully negotiated in the next handshake,
1754 * because the peer might not support it. Specifically:
1755 * - On the Client, enabling the use of the CID through
1756 * this call implies that the `ClientHello` in the next
1757 * handshake will include the CID extension, thereby
1758 * offering the use of the CID to the server. Only if
1759 * the `ServerHello` contains the CID extension, too,
1760 * the CID extension will actually be put to use.
1761 * - On the Server, enabling the use of the CID through
1762 * this call implies that that the server will look for
1763 * the CID extension in a `ClientHello` from the client,
1764 * and, if present, reply with a CID extension in its
1765 * `ServerHello`.
1766 *
1767 * \note To check whether the use of the CID was negotiated
1768 * after the subsequent handshake has completed, please
1769 * use the API mbedtls_ssl_get_peer_cid().
1770 *
1771 * \warning If the use of the CID extension is enabled in this call
1772 * and the subsequent handshake negotiates its use, Mbed TLS
1773 * will silently drop every packet whose CID does not match
1774 * the CID configured in \p own_cid. It is the responsibility
1775 * of the user to adapt the underlying transport to take care
1776 * of CID-based demultiplexing before handing datagrams to
1777 * Mbed TLS.
1778 *
1779 * \return \c 0 on success. In this case, the CID configuration
1780 * applies to the next handshake.
1781 * \return A negative error code on failure.
1782 */
1783int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1784 int enable,
1785 unsigned char const *own_cid,
1786 size_t own_cid_len );
1787
1788/**
Hanno Becker96f35b42019-05-15 10:14:16 +01001789 * \brief Get information about the use of the CID extension
1790 * in the current connection.
Hanno Becker6198af32019-04-09 15:12:56 +01001791 *
1792 * \param ssl The SSL context to query.
1793 * \param enabled The address at which to store whether the CID extension
1794 * is currently in use or not. If the CID is in use,
1795 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1796 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1797 * \param peer_cid The address of the buffer in which to store the CID
1798 * chosen by the peer (if the CID extension is used).
Hanno Becker633d6042019-05-22 16:50:35 +01001799 * This may be \c NULL in case the value of peer CID
1800 * isn't needed. If it is not \c NULL, \p peer_cid_len
1801 * must not be \c NULL.
Hanno Becker6198af32019-04-09 15:12:56 +01001802 * \param peer_cid_len The address at which to store the size of the CID
1803 * chosen by the peer (if the CID extension is used).
1804 * This is also the number of Bytes in \p peer_cid that
1805 * have been written.
Hanno Becker633d6042019-05-22 16:50:35 +01001806 * This may be \c NULL in case the length of the peer CID
1807 * isn't needed. If it is \c NULL, \p peer_cid must be
1808 * \c NULL, too.
Hanno Becker6198af32019-04-09 15:12:56 +01001809 *
1810 * \note This applies to the state of the CID negotiated in
1811 * the last complete handshake. If a handshake is in
1812 * progress, this function will attempt to complete
1813 * the handshake first.
1814 *
Hanno Beckercb063f52019-05-03 12:54:52 +01001815 * \note If CID extensions have been exchanged but both client
1816 * and server chose to use an empty CID, this function
1817 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1818 * (the rationale for this is that the resulting
1819 * communication is the same as if the CID extensions
1820 * hadn't been used).
1821 *
Hanno Becker6198af32019-04-09 15:12:56 +01001822 * \return \c 0 on success.
1823 * \return A negative error code on failure.
1824 */
1825int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1826 int *enabled,
1827 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1828 size_t *peer_cid_len );
1829
Hanno Beckera5a2b082019-05-15 14:03:01 +01001830#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6198af32019-04-09 15:12:56 +01001831
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001832/**
1833 * \brief Set the Maximum Tranport Unit (MTU).
1834 * Special value: 0 means unset (no limit).
1835 * This represents the maximum size of a datagram payload
1836 * handled by the transport layer (usually UDP) as determined
1837 * by the network link and stack. In practice, this controls
1838 * the maximum size datagram the DTLS layer will pass to the
1839 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1840 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001841 * \note The limit on datagram size is converted to a limit on
1842 * record payload by subtracting the current overhead of
1843 * encapsulation and encryption/authentication if any.
1844 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001845 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001846 * example when a Path Maximum Transfer Unit (PMTU)
1847 * estimate becomes available from other sources,
1848 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001849 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001850 * \note This setting only controls the size of the packets we send,
1851 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001852 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001853 * server to use smaller records with \c
1854 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001855 *
1856 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001857 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001858 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001859 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001860 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001861 * of datagrams (hence records, see first note) sent. It
1862 * cannot be used to increase the maximum size of records over
1863 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001864 *
1865 * \note Values lower than the current record layer expansion will
1866 * result in an error when trying to send data.
1867 *
1868 * \note Using record compression together with a non-zero MTU value
1869 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001870 *
1871 * \param ssl SSL context
1872 * \param mtu Value of the path MTU in bytes
1873 */
1874void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1875#endif /* MBEDTLS_SSL_PROTO_DTLS */
1876
Hanno Becker1f835fa2019-06-13 10:14:59 +01001877#if !defined(MBEDTLS_SSL_CONF_READ_TIMEOUT)
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001878/**
1879 * \brief Set the timeout period for mbedtls_ssl_read()
1880 * (Default: no timeout.)
1881 *
1882 * \param conf SSL configuration context
1883 * \param timeout Timeout value in milliseconds.
1884 * Use 0 for no timeout (default).
1885 *
1886 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001887 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001888 * With non-blocking I/O, this will only work if timer
1889 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1890 *
Hanno Becker1f835fa2019-06-13 10:14:59 +01001891 * \note On constrained systems, this option can also be configured
1892 * at compile-time via MBEDTLS_SSL_CONF_READ_TIMEOUT.
1893 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001894 * \note With non-blocking I/O, you may also skip this function
1895 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001896 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001897void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Hanno Becker1f835fa2019-06-13 10:14:59 +01001898#endif /* !MBEDTLS_SSL_CONF_READ_TIMEOUT */
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001899
Hanno Becker0ae6b242019-06-13 16:45:36 +01001900#if !defined(MBEDTLS_SSL_CONF_SET_TIMER) && \
1901 !defined(MBEDTLS_SSL_CONF_GET_TIMER)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001902/**
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001903 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001904 *
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001905 * \param ssl SSL context
1906 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001907 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001908 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001909 *
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001910 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1911 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
1912 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001913 *
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001914 * \note On some platforms, timing.c provides
1915 * \c mbedtls_timing_set_delay() and
1916 * \c mbedtls_timing_get_delay() that are suitable for using
1917 * here, except if using an event-driven style.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001918 *
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001919 * \note On constrained systems, the timer callbacks \p f_set_timer
1920 * and \p f_get_timer may also be configured at compile-time
1921 * via MBEDTLS_SSL_CONF_GET_TIMER and MBEDTLS_SSL_CONF_SET_TIMER.
Hanno Becker0ae6b242019-06-13 16:45:36 +01001922 *
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001923 * \note See also the "DTLS tutorial" article in our knowledge base.
1924 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001925 */
1926void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1927 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001928 mbedtls_ssl_set_timer_t *f_set_timer,
1929 mbedtls_ssl_get_timer_t *f_get_timer );
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001930#else /* !( MBEDTLS_SSL_CONF_SET_TIMER &&
1931 MBEDTLS_SSL_CONF_GET_TIMER ) */
Hanno Becker0ae6b242019-06-13 16:45:36 +01001932/**
1933 * \brief Set the context to be passed to the timer callbacks
1934 * (Mandatory for DTLS.)
1935 *
1936 * \param ssl The SSL context to configure.
1937 * \param p_timer The context to be passed to the timer callbacks.
1938 *
1939 */
1940void mbedtls_ssl_set_timer_cb_ctx( mbedtls_ssl_context *ssl,
1941 void *p_timer );
Hanno Becker99b6b6b2019-07-04 11:34:40 +01001942#endif /* MBEDTLS_SSL_CONF_SET_TIMER &&
1943 MBEDTLS_SSL_CONF_GET_TIMER */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001944
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001945/**
1946 * \brief Callback type: generate and write session ticket
1947 *
1948 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001949 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001950 * authenticated ticket for the session and write it to the
1951 * output buffer. Here, ticket means the opaque ticket part
1952 * of the NewSessionTicket structure of RFC 5077.
1953 *
1954 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001955 * \param session SSL session to be written in the ticket
1956 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001957 * \param end End of the output buffer
1958 * \param tlen On exit, holds the length written
1959 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1960 *
1961 * \return 0 if successful, or
1962 * a specific MBEDTLS_ERR_XXX code.
1963 */
1964typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1965 const mbedtls_ssl_session *session,
1966 unsigned char *start,
1967 const unsigned char *end,
1968 size_t *tlen,
1969 uint32_t *lifetime );
1970
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001971#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1972/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001973 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001974 *
1975 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001976 * (RFC 5216) and Thread. The key pointers are ephemeral and
1977 * therefore must not be stored. The master secret and keys
1978 * should not be used directly except as an input to a key
1979 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001980 *
1981 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001982 * \param ms Pointer to master secret (fixed length: 48 bytes)
1983 * \param kb Pointer to key block, see RFC 5246 section 6.3
1984 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001985 * \param maclen MAC length
1986 * \param keylen Key length
1987 * \param ivlen IV length
1988 *
1989 * \return 0 if successful, or
1990 * a specific MBEDTLS_ERR_XXX code.
1991 */
1992typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001993 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001994 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001995 size_t maclen,
1996 size_t keylen,
1997 size_t ivlen );
1998#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001999
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002000/**
2001 * \brief Callback type: parse and load session ticket
2002 *
2003 * \note This describes what a callback implementation should do.
2004 * This callback should parse a session ticket as generated
2005 * by the corresponding mbedtls_ssl_ticket_write_t function,
2006 * and, if the ticket is authentic and valid, load the
2007 * session.
2008 *
2009 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002010 * bytes of the input buffer, eg to use it as a temporary
2011 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002012 *
2013 * \param p_ticket Context for the callback
2014 * \param session SSL session to be loaded
2015 * \param buf Start of the buffer containing the ticket
2016 * \param len Length of the ticket.
2017 *
2018 * \return 0 if successful, or
2019 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2020 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2021 * any other non-zero code for other failures.
2022 */
2023typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
2024 mbedtls_ssl_session *session,
2025 unsigned char *buf,
2026 size_t len );
2027
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002028#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002029/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002030 * \brief Configure SSL session ticket callbacks (server only).
2031 * (Default: none.)
2032 *
2033 * \note On server, session tickets are enabled by providing
2034 * non-NULL callbacks.
2035 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002036 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002037 *
2038 * \param conf SSL configuration context
2039 * \param f_ticket_write Callback for writing a ticket
2040 * \param f_ticket_parse Callback for parsing a ticket
2041 * \param p_ticket Context shared by the two callbacks
2042 */
2043void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2044 mbedtls_ssl_ticket_write_t *f_ticket_write,
2045 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2046 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002047#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002048
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002049#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2050/**
2051 * \brief Configure key export callback.
2052 * (Default: none.)
2053 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002054 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002055 *
2056 * \param conf SSL configuration context
2057 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002058 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002059 */
2060void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
2061 mbedtls_ssl_export_keys_t *f_export_keys,
2062 void *p_export_keys );
2063#endif /* MBEDTLS_SSL_EXPORT_KEYS */
2064
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002065#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002066/**
2067 * \brief Configure asynchronous private key operation callbacks.
2068 *
2069 * \param conf SSL configuration context
2070 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002071 * the description of ::mbedtls_ssl_async_sign_t
2072 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002073 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002074 * operation; in this case the private key object
2075 * associated with the certificate will be used.
2076 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002077 * the description of ::mbedtls_ssl_async_decrypt_t
2078 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002079 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002080 * operation; in this case the private key object
2081 * associated with the certificate will be used.
2082 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002083 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002084 * for more information. This may not be \c NULL unless
2085 * \p f_async_sign and \p f_async_decrypt are both
2086 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002087 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002088 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002089 * for more information. This may be \c NULL if
2090 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002091 * \param config_data A pointer to configuration data which can be
2092 * retrieved with
2093 * mbedtls_ssl_conf_get_async_config_data(). The
2094 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002095 */
2096void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2097 mbedtls_ssl_async_sign_t *f_async_sign,
2098 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2099 mbedtls_ssl_async_resume_t *f_async_resume,
2100 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002101 void *config_data );
2102
2103/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002104 * \brief Retrieve the configuration data set by
2105 * mbedtls_ssl_conf_async_private_cb().
2106 *
2107 * \param conf SSL configuration context
2108 * \return The configuration data set by
2109 * mbedtls_ssl_conf_async_private_cb().
2110 */
2111void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2112
2113/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002114 * \brief Retrieve the asynchronous operation user context.
2115 *
2116 * \note This function may only be called while a handshake
2117 * is in progress.
2118 *
2119 * \param ssl The SSL context to access.
2120 *
2121 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002122 * set during the current handshake. If
2123 * mbedtls_ssl_set_async_operation_data() has not yet been
2124 * called during the current handshake, this function returns
2125 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002126 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002127void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002128
2129/**
2130 * \brief Retrieve the asynchronous operation user context.
2131 *
2132 * \note This function may only be called while a handshake
2133 * is in progress.
2134 *
2135 * \param ssl The SSL context to access.
2136 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002137 * Call mbedtls_ssl_get_async_operation_data() later during the
2138 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002139 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002140void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002141 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002142#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002143
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002144/**
2145 * \brief Callback type: generate a cookie
2146 *
2147 * \param ctx Context for the callback
2148 * \param p Buffer to write to,
2149 * must be updated to point right after the cookie
2150 * \param end Pointer to one past the end of the output buffer
2151 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002153 * \param ilen Length of info in bytes
2154 *
2155 * \return The callback must return 0 on success,
2156 * or a negative error code.
2157 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002158typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002159 unsigned char **p, unsigned char *end,
2160 const unsigned char *info, size_t ilen );
2161
2162/**
2163 * \brief Callback type: verify a cookie
2164 *
2165 * \param ctx Context for the callback
2166 * \param cookie Cookie to verify
2167 * \param clen Length of cookie
2168 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002170 * \param ilen Length of info in bytes
2171 *
2172 * \return The callback must return 0 if cookie is valid,
2173 * or a negative error code.
2174 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002176 const unsigned char *cookie, size_t clen,
2177 const unsigned char *info, size_t ilen );
2178
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002179#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002180/**
2181 * \brief Register callbacks for DTLS cookies
2182 * (Server only. DTLS only.)
2183 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002184 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002185 * register working callbacks (and initialize their context).
2186 *
2187 * To disable HelloVerifyRequest, register NULL callbacks.
2188 *
2189 * \warning Disabling hello verification allows your server to be used
2190 * for amplification in DoS attacks against other hosts.
2191 * Only disable if you known this can't happen in your
2192 * particular environment.
2193 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002194 * \note See comments on \c mbedtls_ssl_handshake() about handling
2195 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2196 * on the first handshake attempt when this is enabled.
2197 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002198 * \note This is also necessary to handle client reconnection from
2199 * the same port as described in RFC 6347 section 4.2.8 (only
2200 * the variant with cookies is supported currently). See
2201 * comments on \c mbedtls_ssl_read() for details.
2202 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002203 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002204 * \param f_cookie_write Cookie write callback
2205 * \param f_cookie_check Cookie check callback
2206 * \param p_cookie Context for both callbacks
2207 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002208void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002209 mbedtls_ssl_cookie_write_t *f_cookie_write,
2210 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002211 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002212
2213/**
2214 * \brief Set client's transport-level identification info.
2215 * (Server only. DTLS only.)
2216 *
2217 * This is usually the IP address (and port), but could be
2218 * anything identify the client depending on the underlying
2219 * network stack. Used for HelloVerifyRequest with DTLS.
2220 * This is *not* used to route the actual packets.
2221 *
2222 * \param ssl SSL context
2223 * \param info Transport-level info identifying the client (eg IP + port)
2224 * \param ilen Length of info in bytes
2225 *
2226 * \note An internal copy is made, so the info buffer can be reused.
2227 *
2228 * \return 0 on success,
2229 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002230 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002231 */
2232int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2233 const unsigned char *info,
2234 size_t ilen );
2235
2236#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002237
Hanno Becker7f376f42019-06-12 16:20:48 +01002238#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) && \
2239 !defined(MBEDTLS_SSL_CONF_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002240/**
2241 * \brief Enable or disable anti-replay protection for DTLS.
2242 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002243 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002244 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002245 * \param conf SSL configuration
Hanno Becker7f376f42019-06-12 16:20:48 +01002246 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or
2247 * MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002248 *
2249 * \warning Disabling this is a security risk unless the application
2250 * protocol handles duplicated packets in a safe way. You
2251 * should not disable this without careful consideration.
2252 * However, if your application already detects duplicated
2253 * packets and needs information about them to adjust its
2254 * transmission strategy, then you'll want to disable this.
Hanno Becker7f376f42019-06-12 16:20:48 +01002255 *
2256 * \note On constrained systems, this option can also be
2257 * fixed at compile-time by defining the constant
2258 * MBEDTLS_SSL_CONF_ANTI_REPLAY.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002259 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002260void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Hanno Becker7f376f42019-06-12 16:20:48 +01002261#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY && !MBEDTLS_SSL_CONF_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002262
Hanno Beckerde671542019-06-12 16:30:46 +01002263#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT) && \
2264 !defined(MBEDTLS_SSL_CONF_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002265/**
2266 * \brief Set a limit on the number of records with a bad MAC
2267 * before terminating the connection.
2268 * (DTLS only, no effect on TLS.)
2269 * Default: 0 (disabled).
2270 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002271 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002272 * \param limit Limit, or 0 to disable.
2273 *
2274 * \note If the limit is N, then the connection is terminated when
2275 * the Nth non-authentic record is seen.
2276 *
2277 * \note Records with an invalid header are not counted, only the
2278 * ones going through the authentication-decryption phase.
2279 *
2280 * \note This is a security trade-off related to the fact that it's
2281 * often relatively easy for an active attacker ot inject UDP
2282 * datagrams. On one hand, setting a low limit here makes it
2283 * easier for such an attacker to forcibly terminated a
2284 * connection. On the other hand, a high limit or no limit
2285 * might make us waste resources checking authentication on
2286 * many bogus packets.
Hanno Beckerde671542019-06-12 16:30:46 +01002287 *
2288 * \note On constrained systems, this option can also be
2289 * fixed at compile-time by defining the constant
2290 * MBEDTLS_SSL_CONF_BADMAC_LIMIT.
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002291 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002292void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Hanno Beckerde671542019-06-12 16:30:46 +01002293#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT && !MBEDTLS_SSL_CONF_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002296
2297/**
2298 * \brief Allow or disallow packing of multiple handshake records
2299 * within a single datagram.
2300 *
2301 * \param ssl The SSL context to configure.
2302 * \param allow_packing This determines whether datagram packing may
2303 * be used or not. A value of \c 0 means that every
2304 * record will be sent in a separate datagram; a
2305 * value of \c 1 means that, if space permits,
2306 * multiple handshake messages (including CCS) belonging to
2307 * a single flight may be packed within a single datagram.
2308 *
2309 * \note This is enabled by default and should only be disabled
2310 * for test purposes, or if datagram packing causes
2311 * interoperability issues with peers that don't support it.
2312 *
2313 * \note Allowing datagram packing reduces the network load since
2314 * there's less overhead if multiple messages share the same
2315 * datagram. Also, it increases the handshake efficiency
2316 * since messages belonging to a single datagram will not
2317 * be reordered in transit, and so future message buffering
2318 * or flight retransmission (if no buffering is used) as
2319 * means to deal with reordering are needed less frequently.
2320 *
Hanno Beckereb570082018-08-24 11:28:35 +01002321 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002322 * are currently always sent in separate datagrams.
2323 *
2324 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002325void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2326 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002327
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002328/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002329 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002330 * (DTLS only, no effect on TLS.)
2331 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002332 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002333 * \param min Initial timeout value in milliseconds.
2334 * Default: 1000 (1 second).
2335 * \param max Maximum timeout value in milliseconds.
2336 * Default: 60000 (60 seconds).
2337 *
2338 * \note Default values are from RFC 6347 section 4.2.4.1.
2339 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002340 * \note The 'min' value should typically be slightly above the
2341 * expected round-trip time to your peer, plus whatever time
2342 * it takes for the peer to process the message. For example,
2343 * if your RTT is about 600ms and you peer needs up to 1s to
2344 * do the cryptographic operations in the handshake, then you
2345 * should set 'min' slightly above 1600. Lower values of 'min'
2346 * might cause spurious resends which waste network resources,
2347 * while larger value of 'min' will increase overall latency
2348 * on unreliable network links.
2349 *
2350 * \note The more unreliable your network connection is, the larger
2351 * your max / min ratio needs to be in order to achieve
2352 * reliable handshakes.
2353 *
2354 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2355 * For example, if min = 1s and max = 5s, the retransmit plan
2356 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2357 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002358 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002359void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002361
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03002362#if defined(MBEDTLS_SSL_SRV_C) && !defined(MBEDTLS_SSL_NO_SESSION_CACHE)
Paul Bakker5121ce52009-01-03 21:22:43 +00002363/**
Paul Bakker0a597072012-09-25 21:55:46 +00002364 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002365 * If not set, no session resuming is done (except if session
2366 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002367 *
Paul Bakker0a597072012-09-25 21:55:46 +00002368 * The session cache has the responsibility to check for stale
2369 * entries based on timeout. See RFC 5246 for recommendations.
2370 *
2371 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2372 * connection shutdown, so do not cache the pointer! Either set
2373 * it to NULL or make a full copy of the certificate.
2374 *
2375 * The get callback is called once during the initial handshake
2376 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002377 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002378 * If a valid entry is found, it should fill the master of
2379 * the session object with the cached values and return 0,
2380 * return 1 otherwise. Optionally peer_cert can be set as well
2381 * if it is properly present in cache entry.
2382 *
2383 * The set callback is called once during the initial handshake
2384 * to enable session resuming after the entire handshake has
2385 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002386 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002387 * should create a cache entry for future retrieval based on
2388 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002389 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002390 * data) is cleared by the SSL/TLS layer when the connection is
2391 * terminated. It is recommended to add metadata to determine if
2392 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002393 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002394 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002395 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002396 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002397 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002398 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002399 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002400void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002401 void *p_cache,
2402 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2403 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03002404#endif /* MBEDTLS_SSL_SRV_C && !MBEDTLS_SSL_NO_SESSION_CACHE */
Paul Bakker5121ce52009-01-03 21:22:43 +00002405
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03002406#if defined(MBEDTLS_SSL_CLI_C) && !defined(MBEDTLS_SSL_NO_SESSION_RESUMPTION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002407/**
Paul Bakker0a597072012-09-25 21:55:46 +00002408 * \brief Request resumption of session (client-side only)
2409 * Session data is copied from presented session structure.
2410 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002411 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002412 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002413 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002414 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002415 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002416 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002417 * arguments are otherwise invalid
2418 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002420 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
Jarno Lamsa29f2dd02019-06-20 15:31:52 +03002422#endif /* MBEDTLS_SSL_CLI_C && !MBEDTLS_SSL_NO_SESSION_RESUMPTION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002423
2424/**
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002425 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002426 * On client, this can be used for loading saved sessions
2427 * before resuming them with mbedstls_ssl_set_session().
2428 * On server, this can be used for alternative implementations
2429 * of session cache or session tickets.
2430 *
2431 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002432 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002433 * end-entity certificate and the result of the chain
2434 * verification (unless verification was disabled), but not
2435 * the rest of the chain.
2436 *
2437 * \see mbedtls_ssl_session_save()
2438 * \see mbedtls_ssl_set_session()
2439 *
2440 * \param session The session structure to be populated. It must have been
2441 * initialised with mbedtls_ssl_session_init() but not
2442 * populated yet.
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002443 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002444 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002445 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002446 *
2447 * \return \c 0 if successful.
2448 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2449 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Becker5dbcc9f2019-06-03 12:58:39 +01002450 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2451 * was generated in a different version or configuration of
2452 * Mbed TLS.
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002453 * \return Another negative value for other kinds of errors (for
2454 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002455 */
2456int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2457 const unsigned char *buf,
2458 size_t len );
2459
2460/**
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002461 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002462 * On client, this can be used for saving session data,
2463 * potentially in non-volatile storage, for resuming later.
2464 * On server, this can be used for alternative implementations
2465 * of session cache or session tickets.
2466 *
2467 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002468 * \see mbedtls_ssl_get_session_pointer()
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002469 *
2470 * \param session The session structure to be saved.
2471 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard32ce5962019-05-21 11:01:32 +02002472 * writeable buffer of at least \p len bytes, or may be \c
2473 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002474 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard32ce5962019-05-21 11:01:32 +02002475 * \param olen The size in bytes of the data that has been or would have
2476 * been written. It must point to a valid \c size_t.
2477 *
2478 * \note \p olen is updated to the correct value regardless of
2479 * whether \p buf_len was large enough. This makes it possible
2480 * to determine the necessary size by calling this function
2481 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002482 *
2483 * \return \c 0 if successful.
2484 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2485 */
2486int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2487 unsigned char *buf,
2488 size_t buf_len,
2489 size_t *olen );
2490
2491/**
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002492 * \brief Get a pointer to the current session structure, for example
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002493 * to serialize it.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002494 *
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002495 * \warning Ownership of the session remains with the SSL context, and
2496 * the returned pointer is only guaranteed to be valid until
2497 * the next API call operating on the same \p ssl context.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002498 *
2499 * \see mbedtls_ssl_session_save()
2500 *
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002501 * \param ssl The SSL context.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002502 *
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002503 * \return A pointer to the current session if successful.
2504 * \return \c NULL if no session is active.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002505 */
2506const mbedtls_ssl_session *mbedtls_ssl_get_session_pointer( const mbedtls_ssl_context *ssl );
2507
Hanno Becker73f4cb12019-06-27 13:51:07 +01002508#if !defined(MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE)
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002509/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002510 * \brief Set the list of allowed ciphersuites and the preference
2511 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002512 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002514 * The ciphersuites array is not copied, and must remain
2515 * valid for the lifetime of the ssl_config.
2516 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002517 * Note: The server uses its own preferences
2518 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002519 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002520 *
Hanno Becker6ace4652019-06-26 15:14:50 +01002521 * \note On constrained systems, support for a single ciphersuite
2522 * (in all versions) can be fixed at compile-time through
Hanno Becker73f4cb12019-06-27 13:51:07 +01002523 * the configuration option MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE.
Hanno Becker6ace4652019-06-26 15:14:50 +01002524 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002525 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002526 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002527 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002528void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Hanno Becker6ace4652019-06-26 15:14:50 +01002529 const int *ciphersuites );
2530
2531/**
2532 * \brief Set the list of allowed ciphersuites and the
2533 * preference order for a specific version of the protocol.
2534 * (Only useful on the server side)
2535 *
2536 * The ciphersuites array is not copied, and must remain
2537 * valid for the lifetime of the ssl_config.
2538 *
2539 * \param conf SSL configuration
2540 * \param ciphersuites 0-terminated list of allowed ciphersuites
2541 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
2542 * supported)
2543 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2544 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2545 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
2546 *
2547 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2548 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2549 *
2550 * \note On constrained systems, support for a single ciphersuite
2551 * (in all versions) can be fixed at compile-time through
Hanno Becker73f4cb12019-06-27 13:51:07 +01002552 * the configuration option MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE.
Hanno Becker6ace4652019-06-26 15:14:50 +01002553 */
2554void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
2555 const int *ciphersuites,
2556 int major, int minor );
Hanno Becker73f4cb12019-06-27 13:51:07 +01002557#endif /* !MBEDTLS_SSL_CONF_SINGLE_CIPHERSUITE */
Paul Bakker5121ce52009-01-03 21:22:43 +00002558
Hanno Beckera69b4312019-05-14 11:44:35 +01002559#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2560#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckere0200da2019-06-13 09:23:43 +01002561#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
2562 !defined(MBEDTLS_SSL_CONF_CID_LEN) && \
2563 !defined(MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID)
Hanno Beckereec2be92019-05-03 13:06:44 +01002564/**
Hanno Becker948d2d52019-05-23 16:55:50 +01002565 * \brief Specify the length of Connection IDs for incoming
2566 * encrypted DTLS records, as well as the behaviour
2567 * on unexpected CIDs.
Hanno Beckere8eff9a2019-05-14 11:30:10 +01002568 *
2569 * By default, the CID length is set to \c 0,
2570 * and unexpected CIDs are silently ignored.
Hanno Beckereec2be92019-05-03 13:06:44 +01002571 *
2572 * \param conf The SSL configuration to modify.
2573 * \param len The length in Bytes of the CID fields in encrypted
2574 * DTLS records using the CID mechanism. This must
2575 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker2f8c8042019-05-20 10:19:56 +01002576 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Beckere8eff9a2019-05-14 11:30:10 +01002577 * receiving a record with an unexpected CID.
2578 * Possible values are:
2579 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2580 * In this case, the record is silently ignored.
2581 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2582 * In this case, the stack fails with the specific
2583 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckereec2be92019-05-03 13:06:44 +01002584 *
Hanno Becker241947d2019-05-13 15:26:11 +01002585 * \note The CID specification allows implementations to either
2586 * use a common length for all incoming connection IDs or
2587 * allow variable-length incoming IDs. Mbed TLS currently
2588 * requires a common length for all connections sharing the
2589 * same SSL configuration; this allows simpler parsing of
2590 * record headers.
Hanno Beckereec2be92019-05-03 13:06:44 +01002591 *
Hanno Beckere0200da2019-06-13 09:23:43 +01002592 * \note On constrained systems, this configuration can also be
2593 * fixed at compile-time via MBEDTLS_SSL_CONF_CID_LEN and
2594 * MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID.
2595 *
Hanno Beckereec2be92019-05-03 13:06:44 +01002596 * \return \c 0 on success.
2597 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2598 * is too large.
2599 */
Hanno Beckere8eff9a2019-05-14 11:30:10 +01002600int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2601 int ignore_other_cids );
Hanno Beckere0200da2019-06-13 09:23:43 +01002602#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID &&
2603 !MBEDTLS_SSL_CONF_CID_LEN &&
2604 !MBEDTLS_SSL_CONF_IGNORE_UNEXPECTED_CID */
Hanno Beckereec2be92019-05-03 13:06:44 +01002605
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002606#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002607/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002608 * \brief Set the X.509 security profile used for verification
2609 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002610 * \note The restrictions are enforced for all certificates in the
2611 * chain. However, signatures in the handshake are not covered
2612 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2613 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002614 * \param conf SSL configuration
2615 * \param profile Profile to use
2616 */
2617void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002618 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002619
2620/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002621 * \brief Set the data required to verify peer certificate
2622 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002623 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002624 * parameters ca_chain (maps to trust_ca for that function)
2625 * and ca_crl.
2626 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002627 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002628 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002629 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002630 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002631void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002632 mbedtls_x509_crt *ca_chain,
2633 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002634
2635/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002636 * \brief Set own certificate chain and private key
2637 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002638 * \note own_cert should contain in order from the bottom up your
2639 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002640 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002641 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002642 * \note On server, this function can be called multiple times to
2643 * provision more than one cert/key pair (eg one ECDSA, one
2644 * RSA with SHA-256, one RSA with SHA-1). An adequate
2645 * certificate will be selected according to the client's
Antonin Décimod5f47592019-01-23 15:24:37 +01002646 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002647 * adequate, preference is given to the one set by the first
2648 * call to this function, then second, etc.
2649 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002650 * \note On client, only the first call has any effect. That is,
2651 * only one client certificate can be provisioned. The
2652 * server's preferences in its CertficateRequest message will
2653 * be ignored and our only cert will be sent regardless of
2654 * whether it matches those preferences - the server can then
2655 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002656 *
Manuel Pégourié-Gonnardd8e3a1e2018-10-25 13:24:21 +02002657 * \note The provided \p pk_key needs to match the public key in the
2658 * first certificate in \p own_cert, or all handshakes using
2659 * that certificate will fail. It is your responsibility
2660 * to ensure that; this function will not perform any check.
2661 * You may use mbedtls_pk_check_pair() in order to perform
2662 * this check yourself, but be aware that this function can
2663 * be computationally expensive on some key types.
2664 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002665 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002666 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002667 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002668 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002669 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002670 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002671int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002672 mbedtls_x509_crt *own_cert,
2673 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002674#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002675
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002676#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002677/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002678 * \brief Set the Pre Shared Key (PSK) and the expected identity name
2679 *
2680 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002681 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002682 *
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002683 * \note Currently clients can only register one pre-shared key.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002684 * In other words, the servers' identity hint is ignored.
2685 * Support for setting multiple PSKs on clients and selecting
2686 * one based on the identity hint is not a planned feature but
2687 * feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002688 *
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002689 * \param conf SSL configuration
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002690 * \param psk pointer to the pre-shared key
2691 * \param psk_len pre-shared key length
2692 * \param psk_identity pointer to the pre-shared key identity
2693 * \param psk_identity_len identity key length
Paul Bakker6db455e2013-09-18 17:29:31 +02002694 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002695 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002696 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002697int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002698 const unsigned char *psk, size_t psk_len,
2699 const unsigned char *psk_identity, size_t psk_identity_len );
2700
Paul Bakker6db455e2013-09-18 17:29:31 +02002701
2702/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002703 * \brief Set the Pre Shared Key (PSK) for the current handshake
2704 *
2705 * \note This should only be called inside the PSK callback,
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002706 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002707 *
2708 * \param ssl SSL context
2709 * \param psk pointer to the pre-shared key
2710 * \param psk_len pre-shared key length
2711 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002712 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002713 */
2714int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2715 const unsigned char *psk, size_t psk_len );
2716
2717/**
2718 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002719 *
2720 * If set, the PSK callback is called for each
2721 * handshake where a PSK ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002722 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002723 * receive the actual PSK data and length.
2724 *
2725 * The callback has the following parameters: (void *parameter,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
Paul Bakker6db455e2013-09-18 17:29:31 +02002727 * size_t identity_len)
2728 * If a valid PSK identity is found, the callback should use
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002729 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
2730 * correct PSK and return 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002731 * Any other return value will result in a denied PSK identity.
2732 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002733 * \note If you set a PSK callback using this function, then you
2734 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002735 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002736 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002737 * \param conf SSL configuration
Paul Bakker6db455e2013-09-18 17:29:31 +02002738 * \param f_psk PSK identity function
2739 * \param p_psk PSK identity parameter
2740 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002741void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002742 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002743 size_t),
2744 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002745#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002746
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002747#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002748
2749#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2750
2751#if defined(MBEDTLS_DEPRECATED_WARNING)
2752#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2753#else
2754#define MBEDTLS_DEPRECATED
2755#endif
2756
Paul Bakker5121ce52009-01-03 21:22:43 +00002757/**
2758 * \brief Set the Diffie-Hellman public P and G values,
2759 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002760 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002761 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002762 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002763 * \param dhm_P Diffie-Hellman-Merkle modulus
2764 * \param dhm_G Diffie-Hellman-Merkle generator
2765 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002766 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2767 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002768 * \return 0 if successful
2769 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002770MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2771 const char *dhm_P,
2772 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00002773
Hanno Becker470a8c42017-10-04 15:28:46 +01002774#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01002775
2776/**
2777 * \brief Set the Diffie-Hellman public P and G values
2778 * from big-endian binary presentations.
2779 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2780 *
2781 * \param conf SSL configuration
2782 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2783 * \param P_len Length of DHM modulus
2784 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2785 * \param G_len Length of DHM generator
2786 *
2787 * \return 0 if successful
2788 */
2789int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2790 const unsigned char *dhm_P, size_t P_len,
2791 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002792
2793/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002794 * \brief Set the Diffie-Hellman public P and G values,
2795 * read from existing context (server-side only)
2796 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002797 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002798 * \param dhm_ctx Diffie-Hellman-Merkle context
2799 *
2800 * \return 0 if successful
2801 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002802int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002803#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002804
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002805#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2806/**
2807 * \brief Set the minimum length for Diffie-Hellman parameters.
2808 * (Client-side only.)
2809 * (Default: 1024 bits.)
2810 *
2811 * \param conf SSL configuration
2812 * \param bitlen Minimum bit length of the DHM prime
2813 */
2814void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2815 unsigned int bitlen );
2816#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2817
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002818#if defined(MBEDTLS_ECP_C)
Hanno Beckerc1096e72019-06-19 12:30:41 +01002819#if !defined(MBEDTLS_SSL_CONF_SINGLE_EC)
Gergely Budai987bfb52014-01-19 21:48:42 +01002820/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002821 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002822 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002823 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002824 * On server: this only affects selection of the ECDHE curve;
2825 * the curves used for ECDH and ECDSA are determined by the
2826 * list of available certificates instead.
2827 *
2828 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002829 * use. The server can override our preference order.
2830 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002831 * Both sides: limits the set of curves accepted for use in
2832 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002833 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002834 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002835 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002836 * for that. For the end-entity certificate however, the key
2837 * will be accepted only if it is allowed both by this list
2838 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002839 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002840 * \note This list should be ordered by decreasing preference
2841 * (preferred curve first).
2842 *
Hanno Beckerc1096e72019-06-19 12:30:41 +01002843 * \note On highly constrained systems, the support for a single
2844 * fixed elliptic curve can be configured at compile time
2845 * through the option MBEDTLS_SSL_CONF_SINGLE_EC.
2846 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002847 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002848 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002850 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002851void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2852 const mbedtls_ecp_group_id *curves );
Hanno Beckerc1096e72019-06-19 12:30:41 +01002853#endif /* !MBEDTLS_SSL_CONF_SINGLE_EC */
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002854#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002855
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002856#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002857/**
2858 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002859 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002860 *
2861 * \note This only affects which hashes are offered and can be used
2862 * for signatures during the handshake. Hashes for message
2863 * authentication and the TLS PRF are controlled by the
2864 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2865 * used for certificate signature are controlled by the
2866 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2867 *
2868 * \note This list should be ordered by decreasing preference
2869 * (preferred hash first).
2870 *
Hanno Becker56595f42019-06-19 16:31:38 +01002871 * \note On highly constrained systems, the support for a single
2872 * fixed signature hash algorithm can be configured at compile
2873 * time through the option MBEDTLS_SSL_CONF_SINGLE_SIG_HASH.
2874 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002875 * \param conf SSL configuration
2876 * \param hashes Ordered list of allowed signature hashes,
2877 * terminated by \c MBEDTLS_MD_NONE.
2878 */
2879void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2880 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002881#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002882
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002883#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002884/**
Darryl Green11999bb2018-03-13 15:22:58 +00002885 * \brief Set or reset the hostname to check against the received
2886 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002887 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002888 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002889 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002890 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002891
Hanno Becker0446a392017-04-07 12:59:32 +01002892 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002893 *
Darryl Green11999bb2018-03-13 15:22:58 +00002894 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2895 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002896 * too long input hostname.
2897 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002898 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002899 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002900 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002901 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002902int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002903#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002904
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002905#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002906/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002907 * \brief Set own certificate and key for the current handshake
2908 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002909 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002910 * the SNI callback.
2911 *
2912 * \param ssl SSL context
2913 * \param own_cert own public certificate chain
2914 * \param pk_key own private key
2915 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002916 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002917 */
2918int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2919 mbedtls_x509_crt *own_cert,
2920 mbedtls_pk_context *pk_key );
2921
2922/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002923 * \brief Set the data required to verify peer certificate for the
2924 * current handshake
2925 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002926 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002927 * the SNI callback.
2928 *
2929 * \param ssl SSL context
2930 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
2931 * \param ca_crl trusted CA CRLs
2932 */
2933void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2934 mbedtls_x509_crt *ca_chain,
2935 mbedtls_x509_crl *ca_crl );
2936
2937/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002938 * \brief Set authmode for the current handshake.
2939 *
2940 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
2941 * the SNI callback.
2942 *
2943 * \param ssl SSL context
2944 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
2945 * MBEDTLS_SSL_VERIFY_REQUIRED
2946 */
2947void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2948 int authmode );
2949
2950/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00002951 * \brief Set server side ServerName TLS extension callback
2952 * (optional, server-side only).
2953 *
2954 * If set, the ServerName callback is called whenever the
2955 * server receives a ServerName TLS extension from the client
2956 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002958 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002959 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002960 * certificate(s) and key(s) to use with \c
2961 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002962 * and may optionally adjust the CA and associated CRL with \c
2963 * mbedtls_ssl_set_hs_ca_chain() as well as the client
2964 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
2965 * then must return 0. If no matching name is found, the
2966 * callback must either set a default cert, or
2967 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00002968 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00002970 * \param f_sni verification function
2971 * \param p_sni verification parameter
2972 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002973void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002974 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002975 size_t),
2976 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002978
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002979#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002980/**
2981 * \brief Set the EC J-PAKE password for current handshake.
2982 *
2983 * \note An internal copy is made, and destroyed as soon as the
2984 * handshake is completed, or when the SSL context is reset or
2985 * freed.
2986 *
2987 * \note The SSL context needs to be already set up. The right place
2988 * to call this function is between \c mbedtls_ssl_setup() or
2989 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
2990 *
2991 * \param ssl SSL context
2992 * \param pw EC J-PAKE password (pre-shared secret)
2993 * \param pw_len length of pw in bytes
2994 *
2995 * \return 0 on success, or a negative error code.
2996 */
2997int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2998 const unsigned char *pw,
2999 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003000#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003003/**
3004 * \brief Set the supported Application Layer Protocols.
3005 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003006 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003007 * \param protos Pointer to a NULL-terminated list of supported protocols,
3008 * in decreasing preference order. The pointer to the list is
3009 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00003010 * the lifetime of the table must be atleast as long as the
3011 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003012 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003014 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003015int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003016
3017/**
3018 * \brief Get the name of the negotiated Application Layer Protocol.
3019 * This function should be called after the handshake is
3020 * completed.
3021 *
3022 * \param ssl SSL context
3023 *
3024 * \return Protcol name, or NULL if no protocol was negotiated.
3025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
3027#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003028
Hanno Becker33b9b252019-07-05 11:23:25 +01003029#if !defined(MBEDTLS_SSL_CONF_MAX_MINOR_VER) || \
3030 !defined(MBEDTLS_SSL_CONF_MAX_MAJOR_VER)
Paul Bakker5701cdc2012-09-27 21:49:42 +00003031/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003032 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003033 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003035 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003036 * \note This ignores ciphersuites from higher versions.
3037 *
3038 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3039 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003040 *
Hanno Becker94c40d12019-07-05 11:15:37 +01003041 * \note On constrained systems, the maximum major/minor version can
Hanno Beckerf1c2a332019-06-12 15:27:23 +01003042 * also be configured at compile-time by setting
Hanno Becker94c40d12019-07-05 11:15:37 +01003043 * MBEDTLS_SSL_CONF_MAX_MAJOR_VER and
3044 * MBEDTLS_SSL_CONF_MAX_MINOR_VER.
Hanno Beckerf1c2a332019-06-12 15:27:23 +01003045 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003046 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
3048 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
3049 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
3050 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003051 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003052void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Hanno Becker33b9b252019-07-05 11:23:25 +01003053#endif /* MBEDTLS_SSL_CONF_MAX_MINOR_VER ||
3054 MBEDTLS_SSL_CONF_MAX_MAJOR_VER */
Paul Bakker490ecc82011-10-06 13:04:09 +00003055
Hanno Becker33b9b252019-07-05 11:23:25 +01003056#if !defined(MBEDTLS_SSL_CONF_MIN_MINOR_VER) || \
3057 !defined(MBEDTLS_SSL_CONF_MIN_MAJOR_VER)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003058/**
3059 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02003060 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003061 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003062 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3063 * SSL_MIN_XXXXX_VERSION range is ignored.
3064 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00003066 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003067 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3068 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
3069 *
Hanno Beckerf1c2a332019-06-12 15:27:23 +01003070 * \note On constrained systems, the minimum major/minor version can
3071 * also be configured at compile-time by setting
Hanno Becker94c40d12019-07-05 11:15:37 +01003072 * MBEDTLS_SSL_CONF_MIN_MAJOR_VER and
3073 * MBEDTLS_SSL_CONF_MIN_MINOR_VER.
Hanno Beckerf1c2a332019-06-12 15:27:23 +01003074 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003075 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003076 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
3077 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
3078 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
3079 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003080 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003081void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Hanno Becker33b9b252019-07-05 11:23:25 +01003082#endif /* MBEDTLS_SSL_CONF_MIN_MINOR_VER ||
3083 MBEDTLS_SSL_CONF_MIN_MAJOR_VER */
Paul Bakker1d29fb52012-09-28 13:28:45 +00003084
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003086/**
3087 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003089 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003090 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003091 * connection, that is a connection with max_version set to a
3092 * lower value than the value you're willing to use. Such
3093 * fallback connections are not recommended but are sometimes
3094 * necessary to interoperate with buggy (version-intolerant)
3095 * servers.
3096 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003098 * non-fallback connections! This would appear to work for a
3099 * while, then cause failures when the server is upgraded to
3100 * support a newer TLS version.
3101 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01003102 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003103 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003104 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003105void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003106#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003107
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003109/**
3110 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003112 *
3113 * \note This should always be enabled, it is a security
3114 * improvement, and should not cause any interoperability
3115 * issue (used only if the peer supports it too).
3116 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003117 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003118 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003119 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003120void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003121#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Hanno Beckerab1ce762019-06-12 13:35:03 +01003124#if !defined(MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003125/**
3126 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003128 *
3129 * \note This should always be enabled, it is a security fix to the
3130 * protocol, and should not cause any interoperability issue
3131 * (used only if the peer supports it too).
3132 *
Hanno Beckerab1ce762019-06-12 13:35:03 +01003133 * \note On constrained systems, this option can also be
3134 * fixed at compile-time by defining the constant
3135 * MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET
3136 * as MBEDTLS_SSL_EXTENDED_MS_ENABLED or
3137 * MBEDTLS_SSL_EXTENDED_MS_DISABLED.
3138 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003139 * \param conf SSL configuration
Hanno Beckerab1ce762019-06-12 13:35:03 +01003140 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or
3141 * MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003142 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003143void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Hanno Beckerab1ce762019-06-12 13:35:03 +01003144#endif /* !MBEDTLS_SSL_CONF_EXTENDED_MASTER_SECRET */
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03003145
Hanno Beckerab1ce762019-06-12 13:35:03 +01003146#if !defined(MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET)
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03003147/**
3148 * \brief Enable or disable Extended Master Secret enforcing.
Jarno Lamsa18b9a492019-06-10 15:23:29 +03003149 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED)
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03003150 *
Jarno Lamsa20095af2019-06-11 17:16:58 +03003151 * \note If the use of extended master secret is configured (see
3152 * `mbedtls_ssl_conf_extended_master_secret()`) and this
3153 * option is set, handshakes not leading to the use of the
3154 * extended master secret will be aborted: On the server, fail
3155 * the handshake if the client doesn't advertise the
3156 * ExtendedMasterSecret extension. On the client: Fail the
3157 * handshake if the server doesn't consent to the use of the
3158 * ExtendedMasterSecret extension in its ServerHello.
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03003159 *
Jarno Lamsa20095af2019-06-11 17:16:58 +03003160 * \param conf Currently used SSL configuration struct.
Jarno Lamsa95f752e2019-06-10 10:15:49 +03003161 * \param ems_enf MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED or
Jarno Lamsad9382f82019-06-10 10:27:14 +03003162 * MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED
Hanno Beckerab1ce762019-06-12 13:35:03 +01003163
3164 * \note On constrained systems, this option can also be
3165 * fixed at compile-time by defining the constant
3166 * MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET
3167 * as MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED or
3168 * MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED.
3169 *
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03003170 */
3171void mbedtls_ssl_conf_extended_master_secret_enforce( mbedtls_ssl_config *conf,
Jarno Lamsa20095af2019-06-11 17:16:58 +03003172 char ems_enf );
Hanno Beckerab1ce762019-06-12 13:35:03 +01003173#endif /* !MBEDTLS_SSL_CONF_ENFORCE_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003174#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003175
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003176#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003177/**
3178 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003179 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003180 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003181 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00003182 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003183 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00003184 * \note This function is deprecated and will likely be removed in
3185 * a future version of the library.
3186 * RC4 is disabled by default at compile time and needs to be
3187 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003188 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003189 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003190 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003191 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003192void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003193#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003194
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01003195#if defined(MBEDTLS_SSL_SRV_C) && !defined(MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST)
Janos Follath088ce432017-04-10 12:42:31 +01003196/**
3197 * \brief Whether to send a list of acceptable CAs in
3198 * CertificateRequest messages.
3199 * (Default: do send)
3200 *
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01003201 * \note On constrained systems, this options can also be configured
3202 * at compile-time via MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST.
3203 *
Janos Follath088ce432017-04-10 12:42:31 +01003204 * \param conf SSL configuration
3205 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3206 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3207 */
3208void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3209 char cert_req_ca_list );
Hanno Beckerc2cfdaa2019-06-13 12:33:03 +01003210#endif /* MBEDTLS_SSL_SRV_C && !MBEDTLS_SSL_CONF_CERT_REQ_CA_LIST */
Janos Follath088ce432017-04-10 12:42:31 +01003211
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003212#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003213/**
k-stachowiakd7077832019-04-29 11:15:43 +02003214 * \brief Set the maximum fragment length to emit and/or negotiate.
3215 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3216 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003217 * (Server: set maximum fragment length to emit,
k-stachowiakd7077832019-04-29 11:15:43 +02003218 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003219 * (Client: set maximum fragment length to emit *and*
3220 * negotiate with the server during handshake)
k-stachowiakd7077832019-04-29 11:15:43 +02003221 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003222 *
k-stachowiakd7077832019-04-29 11:15:43 +02003223 * \note On the client side, the maximum fragment length extension
3224 * *will not* be used, unless the maximum fragment length has
3225 * been set via this function to a value different than
3226 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003227 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003228 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003229 * excluding record overhead that will be added to it, see
3230 * \c mbedtls_ssl_get_record_expansion().
3231 *
k-stachowiakd7077832019-04-29 11:15:43 +02003232 * \note With TLS, this currently only affects ApplicationData (sent
3233 * with \c mbedtls_ssl_read()), not handshake messages.
3234 * With DTLS, this affects both ApplicationData and handshake.
3235 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003236 * \note For DTLS, it is also possible to set a limit for the total
3237 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003238 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003239 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003240 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003241 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3243 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003244 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003245 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003246 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003247int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003248#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003249
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003251/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01003252 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01003253 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003254 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003255 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003256 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
3257 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003258 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003259void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003263/**
3264 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003265 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003266 *
3267 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
3268 * Does not affect non-CBC ciphersuites in any version.
3269 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01003270 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
3272 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003273 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003274void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003275#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003276
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003277#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003278/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003279 * \brief Enable / Disable session tickets (client only).
3280 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003281 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003282 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003283 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003284 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003285 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3286 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003287 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003288void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3289#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003291#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003292/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003293 * \brief Enable / Disable renegotiation support for connection when
3294 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003295 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003296 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003297 * \warning It is recommended to always disable renegotation unless you
3298 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003299 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003300 * renegotiation or a poor understanding of its properties.
3301 *
3302 * \note Server-side, enabling renegotiation also makes the server
3303 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003304 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003305 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003306 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3307 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003308 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003309void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003311
Hanno Beckerb0b2b672019-06-12 16:58:10 +01003312#if !defined(MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003313/**
3314 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003315 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003316 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003318 * be established even if the peer does not support
3319 * secure renegotiation, but does not allow renegotiation
3320 * to take place if not secure.
3321 * (Interoperable and secure option)
3322 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003323 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003324 * with non-upgraded peers. Allowing legacy renegotiation
3325 * makes the connection vulnerable to specific man in the
3326 * middle attacks. (See RFC 5746)
3327 * (Most interoperable and least secure option)
3328 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003329 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003330 * if peer does not support secure renegotiation. Results
3331 * in interoperability issues with non-upgraded peers
3332 * that do not support renegotiation altogether.
3333 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003334 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003335 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003336 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3337 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Hanno Beckerb0b2b672019-06-12 16:58:10 +01003339 *
3340 *
3341 * \note On constrained systems, this option can also be
3342 * fixed at compile-time by defining the constant
3343 * MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION.
Paul Bakker48916f92012-09-16 19:57:18 +00003344 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003345void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Hanno Beckerb0b2b672019-06-12 16:58:10 +01003346#endif /* !MBEDTLS_SSL_CONF_ALLOW_LEGACY_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003348#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003349/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003350 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003351 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003352 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003353 * When we request a renegotiation, the peer can comply or
3354 * ignore the request. This function allows us to decide
3355 * whether to enforce our renegotiation requests by closing
3356 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003357 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003358 * However, records could already be in transit from the peer
3359 * when the request is emitted. In order to increase
3360 * reliability, we can accept a number of records before the
3361 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003362 *
3363 * The optimal value is highly dependent on the specific usage
3364 * scenario.
3365 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003366 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003368 * out or receives Application Data, until:
3369 * - max_records records have beens seen, if it is >= 0, or
3370 * - the number of retransmits that would happen during an
3371 * actual handshake has been reached.
3372 * Please remember the request might be lost a few times
3373 * if you consider setting max_records to a really low value.
3374 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003375 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003376 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003377 * which always behave as if max_record was 0. The reason is,
3378 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003379 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003380 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003381 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003383 * enforce renegotiation, or a non-negative value to enforce
3384 * it but allow for a grace period of max_records records.
3385 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003386void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003387
3388/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003389 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003390 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003391 *
3392 * Renegotiation is automatically triggered when a record
Hanno Becker8013b272019-05-03 12:55:51 +01003393 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003394 * threshold. The default value is meant to prevent the
3395 * connection from being closed when the counter is about to
3396 * reached its maximal value (it is not allowed to wrap).
3397 *
3398 * Lower values can be used to enforce policies such as "keys
3399 * must be refreshed every N packets with cipher X".
3400 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003401 * The renegotiation period can be disabled by setting
3402 * conf->disable_renegotiation to
3403 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3404 *
3405 * \note When the configured transport is
3406 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3407 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3408 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003409 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003410 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003411 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003412 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003413void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003414 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003415#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003416
Paul Bakker43ca69c2011-01-15 17:35:19 +00003417/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003418 * \brief Check if there is data already read from the
3419 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003420 *
3421 * \param ssl SSL context
3422 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003423 * \return 0 if nothing's pending, 1 otherwise.
3424 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003425 * \note This is different in purpose and behaviour from
3426 * \c mbedtls_ssl_get_bytes_avail in that it considers
3427 * any kind of unprocessed data, not only unread
3428 * application data. If \c mbedtls_ssl_get_bytes
3429 * returns a non-zero value, this function will
3430 * also signal pending data, but the converse does
3431 * not hold. For example, in DTLS there might be
3432 * further records waiting to be processed from
3433 * the current underlying transport's datagram.
3434 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003435 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003436 * does not imply that a subsequent call to
3437 * \c mbedtls_ssl_read will provide any data;
3438 * e.g., the unprocessed data might turn out
3439 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003440 *
3441 * \note This function is useful in the following situation:
3442 * If the SSL/TLS module successfully returns from an
3443 * operation - e.g. a handshake or an application record
3444 * read - and you're awaiting incoming data next, you
3445 * must not immediately idle on the underlying transport
3446 * to have data ready, but you need to check the value
3447 * of this function first. The reason is that the desired
3448 * data might already be read but not yet processed.
3449 * If, in contrast, a previous call to the SSL/TLS module
3450 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3451 * to call this function, as the latter error code entails
3452 * that all internal data has been processed.
3453 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003454 */
3455int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3456
3457/**
3458 * \brief Return the number of application data bytes
3459 * remaining to be read from the current record.
3460 *
3461 * \param ssl SSL context
3462 *
3463 * \return How many bytes are available in the application
3464 * data record read buffer.
3465 *
3466 * \note When working over a datagram transport, this is
3467 * useful to detect the current datagram's boundary
3468 * in case \c mbedtls_ssl_read has written the maximal
3469 * amount of data fitting into the input buffer.
3470 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003471 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003472size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003473
3474/**
3475 * \brief Return the result of the certificate verification
3476 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003477 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003478 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003479 * \return \c 0 if the certificate verification was successful.
3480 * \return \c -1u if the result is not available. This may happen
3481 * e.g. if the handshake aborts early, or a verification
3482 * callback returned a fatal error.
3483 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3484 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003485 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003486uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003487
3488/**
3489 * \brief Return the name of the current ciphersuite
3490 *
3491 * \param ssl SSL context
3492 *
3493 * \return a string containing the ciphersuite name
3494 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003496
3497/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00003498 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
3499 *
3500 * \param ssl SSL context
3501 *
3502 * \return a string containing the SSL version
3503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003505
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003506/**
3507 * \brief Return the (maximum) number of bytes added by the record
3508 * layer: header + encryption/MAC overhead (inc. padding)
3509 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003510 * \note This function is not available (always returns an error)
3511 * when record compression is enabled.
3512 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003513 * \param ssl SSL context
3514 *
3515 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003516 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02003517 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003520
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003521#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3522/**
3523 * \brief Return the maximum fragment length (payload, in bytes).
3524 * This is the value negotiated with peer if any,
3525 * or the locally configured value.
3526 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003527 * \sa mbedtls_ssl_conf_max_frag_len()
3528 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003529 *
3530 * \param ssl SSL context
3531 *
3532 * \return Current maximum fragment length.
3533 */
3534size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
3535#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3536
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003537/**
3538 * \brief Return the current maximum outgoing record payload in bytes.
3539 * This takes into account the config.h setting \c
3540 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3541 * max fragment length extension if used, and for DTLS the
3542 * path MTU as configured and current record expansion.
3543 *
3544 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3545 * called with a larger length value.
3546 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3547 * necessary and return the number of bytes written; it is up
3548 * to the caller to call \c mbedtls_ssl_write() again in
3549 * order to send the remaining bytes if any.
3550 *
3551 * \note This function is not available (always returns an error)
3552 * when record compression is enabled.
3553 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003554 * \sa mbedtls_ssl_set_mtu()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003555 * \sa mbedtls_ssl_get_max_frag_len()
3556 * \sa mbedtls_ssl_get_record_expansion()
3557 *
3558 * \param ssl SSL context
3559 *
3560 * \return Current maximum payload for an outgoing record,
3561 * or a negative error code.
3562 */
3563int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3564
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003565#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003566/**
Hanno Becker869144b2019-02-05 11:33:12 +00003567 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003568 *
Hanno Becker869144b2019-02-05 11:33:12 +00003569 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003570 *
Hanno Becker24bc5702019-02-25 10:13:43 +00003571 * \return The current peer certificate, if available.
3572 * The returned certificate is owned by the SSL context and
3573 * is valid only until the next call to the SSL API.
3574 * \return \c NULL if no peer certificate is available. This might
3575 * be because the chosen ciphersuite doesn't use CRTs
3576 * (PSK-based ciphersuites, for example), or because
3577 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3578 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker869144b2019-02-05 11:33:12 +00003579 *
3580 * \note For one-time inspection of the peer's certificate during
3581 * the handshake, consider registering an X.509 CRT verification
3582 * callback through mbedtls_ssl_conf_verify() instead of calling
3583 * this function. Using mbedtls_ssl_conf_verify() also comes at
3584 * the benefit of allowing you to influence the verification
3585 * process, for example by masking expected and tolerated
3586 * verification failures.
3587 *
3588 * \warning You must not use the pointer returned by this function
3589 * after any further call to the SSL API, including
3590 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3591 * because the pointer might change during renegotiation,
3592 * which happens transparently to the user.
3593 * If you want to use the certificate across API calls,
3594 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3597#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003599#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003600/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003601 * \brief Save session in order to resume it later (client-side only)
3602 * Session data is copied to presented session structure.
3603 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003604 *
3605 * \param ssl SSL context
3606 * \param session session context
3607 *
3608 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003609 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003610 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003611 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003612 *
Ron Eldor00115032018-07-17 11:21:50 +03003613 * \note Only the server certificate is copied, and not the full chain,
3614 * so you should not attempt to validate the certificate again
3615 * by calling \c mbedtls_x509_crt_verify() on it.
3616 * Instead, you should use the results from the verification
3617 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3618 * after loading the session again into a new SSL context
3619 * using \c mbedtls_ssl_set_session().
3620 *
3621 * \note Once the session object is not needed anymore, you should
3622 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003623 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003624 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003625 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003626int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3627#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003628
3629/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003630 * \brief Perform the SSL handshake
3631 *
3632 * \param ssl SSL context
3633 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003634 * \return \c 0 if successful.
3635 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003636 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003637 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003638 * transport - in this case you must call this function again
3639 * when the underlying transport is ready for the operation.
3640 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3641 * operation is in progress (see
3642 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3643 * must call this function again when the operation is ready.
3644 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3645 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3646 * in this case you must call this function again to complete
3647 * the handshake when you're done attending other tasks.
3648 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3649 * and the client did not demonstrate reachability yet - in
3650 * this case you must stop using the context (see below).
3651 * \return Another SSL error code - in this case you must stop using
3652 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003653 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003654 * \warning If this function returns something other than
3655 * \c 0,
3656 * #MBEDTLS_ERR_SSL_WANT_READ,
3657 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3658 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3659 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3660 * you must stop using the SSL context for reading or writing,
3661 * and either free it or call \c mbedtls_ssl_session_reset()
3662 * on it before re-using it for a new connection; the current
3663 * connection must be closed.
3664 *
3665 * \note If DTLS is in use, then you may choose to handle
3666 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3667 * purposes, as it is an expected return value rather than an
3668 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003669 *
3670 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003671 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003672 * from the underlying transport layer is currently being processed,
3673 * and it is safe to idle until the timer or the underlying transport
3674 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003675 * in which case the datagram of the underlying transport that is
3676 * currently being processed might or might not contain further
3677 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003678 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003679int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003680
3681/**
Paul Bakker1961b702013-01-25 14:49:24 +01003682 * \brief Perform a single step of the SSL handshake
3683 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003684 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003685 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003686 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003687 *
3688 * \param ssl SSL context
3689 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003690 * \return See mbedtls_ssl_handshake().
3691 *
3692 * \warning If this function returns something other than \c 0,
3693 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3694 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3695 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3696 * the SSL context for reading or writing, and either free it
3697 * or call \c mbedtls_ssl_session_reset() on it before
3698 * re-using it for a new connection; the current connection
3699 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003700 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003701int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003702
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003703#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003704/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003705 * \brief Initiate an SSL renegotiation on the running connection.
3706 * Client: perform the renegotiation right now.
3707 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003708 * during the next call to mbedtls_ssl_read() if honored by
3709 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003710 *
3711 * \param ssl SSL context
3712 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003713 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003714 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3715 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003716 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003717 * \warning If this function returns something other than \c 0,
3718 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3719 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3720 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3721 * the SSL context for reading or writing, and either free it
3722 * or call \c mbedtls_ssl_session_reset() on it before
3723 * re-using it for a new connection; the current connection
3724 * must be closed.
3725 *
Paul Bakker48916f92012-09-16 19:57:18 +00003726 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003727int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3728#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003729
3730/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003731 * \brief Read at most 'len' application data bytes
3732 *
3733 * \param ssl SSL context
3734 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003735 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003736 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003737 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003738 * \return \c 0 if the read end of the underlying transport was closed
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003739 * - in this case you must stop using the context (see below).
3740 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003741 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003742 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003743 * transport - in this case you must call this function again
3744 * when the underlying transport is ready for the operation.
3745 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3746 * operation is in progress (see
3747 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3748 * must call this function again when the operation is ready.
3749 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3750 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3751 * in this case you must call this function again to complete
3752 * the handshake when you're done attending other tasks.
3753 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3754 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003755 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003756 * \return Another SSL error code - in this case you must stop using
3757 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003758 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003759 * \warning If this function returns something other than
3760 * a positive value,
3761 * #MBEDTLS_ERR_SSL_WANT_READ,
3762 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3763 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3764 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3765 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3766 * you must stop using the SSL context for reading or writing,
3767 * and either free it or call \c mbedtls_ssl_session_reset()
3768 * on it before re-using it for a new connection; the current
3769 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003770 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003771 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003772 * (which can only happen server-side), it means that a client
3773 * is initiating a new connection using the same source port.
3774 * You can either treat that as a connection close and wait
3775 * for the client to resend a ClientHello, or directly
3776 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003777 * context (as it has been reset internally). Either way, you
3778 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003779 * connection: application state, if any, should be reset, and
3780 * most importantly the identity of the client must be checked
3781 * again. WARNING: not validating the identity of the client
3782 * again, or not transmitting the new identity to the
3783 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003784 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003785 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003786 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003787 * from the underlying transport layer is currently being processed,
3788 * and it is safe to idle until the timer or the underlying transport
3789 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003790 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3791 * initially available on the underlying transport, as this data may have
3792 * been only e.g. duplicated messages or a renegotiation request.
3793 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3794 * when reacting to an incoming-data event from the underlying transport.
3795 * - On success, the datagram of the underlying transport that is currently
3796 * being processed may contain further DTLS records. You should call
3797 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003798 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003801
3802/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003803 * \brief Try to write exactly 'len' application data bytes
3804 *
3805 * \warning This function will do partial writes in some cases. If the
3806 * return value is non-negative but less than length, the
3807 * function must be called again with updated arguments:
3808 * buf + ret, len - ret (if ret is the return value) until
3809 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003810 *
3811 * \param ssl SSL context
3812 * \param buf buffer holding the data
3813 * \param len how many bytes must be written
3814 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003815 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003816 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003817 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003818 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003819 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003820 * transport - in this case you must call this function again
3821 * when the underlying transport is ready for the operation.
3822 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3823 * operation is in progress (see
3824 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3825 * must call this function again when the operation is ready.
3826 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3827 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3828 * in this case you must call this function again to complete
3829 * the handshake when you're done attending other tasks.
3830 * \return Another SSL error code - in this case you must stop using
3831 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003832 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003833 * \warning If this function returns something other than
3834 * a non-negative value,
3835 * #MBEDTLS_ERR_SSL_WANT_READ,
3836 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3837 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3838 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3839 * you must stop using the SSL context for reading or writing,
3840 * and either free it or call \c mbedtls_ssl_session_reset()
3841 * on it before re-using it for a new connection; the current
3842 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003843 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003844 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003845 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003846 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003847 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003848 * some partial data in the output buffer, however this is not
3849 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003850 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003851 * \note If the requested length is greater than the maximum
3852 * fragment length (either the built-in limit or the one set
3853 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003854 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003855 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003856 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
3857 * active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003858 *
3859 * \note Attempting to write 0 bytes will result in an empty TLS
3860 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003862int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003863
3864/**
Paul Bakker0a925182012-04-16 06:46:41 +00003865 * \brief Send an alert message
3866 *
3867 * \param ssl SSL context
3868 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003869 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003870 * \param message The alert message (SSL_ALERT_MSG_*)
3871 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003872 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003873 *
3874 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003875 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3876 * the SSL context for reading or writing, and either free it or
3877 * call \c mbedtls_ssl_session_reset() on it before re-using it
3878 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003879 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003880int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003881 unsigned char level,
3882 unsigned char message );
3883/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003884 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003885 *
3886 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003887 *
3888 * \return 0 if successful, or a specific SSL error code.
3889 *
3890 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003891 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3892 * the SSL context for reading or writing, and either free it or
3893 * call \c mbedtls_ssl_session_reset() on it before re-using it
3894 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003895 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003896int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003897
3898/**
Paul Bakker48916f92012-09-16 19:57:18 +00003899 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003900 *
3901 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003902 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003903void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003904
Paul Bakker48916f92012-09-16 19:57:18 +00003905/**
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003906 * \brief Save an active connection as serialized data in a buffer.
3907 * This allows the freeing or re-using of the SSL context
3908 * while still picking up the connection later in a way that
3909 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003910 *
3911 * \see mbedtls_ssl_context_load()
3912 *
3913 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003914 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003915 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
3916 *
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003917 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003918 * mbedtls_ssl_session_reset() on \p ssl which as a result is
3919 * no longer associated with the connection that has been
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003920 * serialized. This avoids creating copies of the session
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003921 * state. You're then free to either re-use the context
3922 * structure for a different connection, or call
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003923 * mbedtls_ssl_session_free() on it. See the documentation of
3924 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003925 *
3926 * \param ssl The SSL context to save. On success, it is no longer
3927 * associated with the connection that has been serialized.
3928 * \param buf The buffer to write the serialized data to. It must be a
3929 * writeable buffer of at least \p len bytes, or may be \c
3930 * NULL if \p len is \c 0.
3931 * \param buf_len The number of bytes available for writing in \p buf.
3932 * \param olen The size in bytes of the data that has been or would have
3933 * been written. It must point to a valid \c size_t.
3934 *
3935 * \note \p olen is updated to the correct value regardless of
3936 * whether \p buf_len was large enough. This makes it possible
3937 * to determine the necessary size by calling this function
3938 * with \p buf set to \c NULL and \p buf_len to \c 0.
3939 *
3940 * \return \c 0 if successful.
3941 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003942 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003943 * progress, or there is pending data for reading or sending,
3944 * or the connection does not use DTLS 1.2 with and AEAD
3945 * ciphersuite, or renegotiation is enabled.
3946 */
3947int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3948 unsigned char *buf,
3949 size_t buf_len,
3950 size_t *olen );
3951/**
3952 * \brief Load serialized connection data to an SSL context.
3953 *
3954 * \see mbedtls_ssl_context_save()
3955 *
3956 * \warning The same serialized data must never be loaded into more
3957 * that one context. In order to ensure that, after
3958 * successfully loading serialized data to an SSL context, you
3959 * should immediately destroy or invalidate all copies of the
3960 * serialized data that was loaded. Loading the same data in
3961 * more than one context would cause severe security failures
3962 * including but not limited to loss of confidentiality.
3963 *
3964 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003965 * prepared in one of the two following ways. The first way is
3966 * to take a context freshly initialised with
3967 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003968 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003969 * the original connection. The second way is to
3970 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003971 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003972 * Either way, you must not use the context to perform a
3973 * handshake between calling mbedtls_ssl_setup() or
3974 * mbedtls_ssl_session_reset() and calling this function. You
3975 * may however call other setter functions in that time frame
3976 * as indicated in the note below.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003977 *
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003978 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003979 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003980 * and settings before you can use the connection again
3981 * (unless they were already set before calling
3982 * mbedtls_ssl_session_reset() and the values are suitable for
3983 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003984 * at least mbedtls_ssl_set_bio(). If you're using a read
3985 * timeout (that is, you called
3986 * mbedtls_ssl_conf_read_timeout() with a non-zero timeout)
3987 * and non-blocking I/O, you also need to set timer callbacks
3988 * by calling mbedtls_ssl_set_timer_cb(). All other SSL setter
3989 * functions are not necessary to call, either because they're
3990 * only used in handshakes, or because the setting is already
3991 * saved. You might choose to call them anyway, for example in
3992 * order to share code between the cases of establishing a new
3993 * connection and the case of loading an already-established
3994 * connection.
3995 *
3996 * \note If you have new information about the path MTU, you want to
3997 * call mbedtls_ssl_set_mtu() after calling this function, as
3998 * otherwise this function would overwrite your
3999 * newly-configured value with the value that was active when
4000 * the context was saved.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02004001 *
4002 * \param ssl The SSL context structure to be populated. It must have
4003 * been prepared as described in the note above.
4004 * \param buf The buffer holding the serialized connection data. It must
4005 * be a readable buffer of at least \p len bytes.
4006 * \param len The size of the serialized data in bytes.
4007 *
4008 * \return \c 0 if successful.
4009 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
4010 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4011 */
4012int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
4013 const unsigned char *buf,
4014 size_t len );
4015
4016/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004017 * \brief Initialize an SSL configuration context
4018 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004019 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004020 *
4021 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimod5f47592019-01-23 15:24:37 +01004022 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004023 *
4024 * \param conf SSL configuration context
4025 */
4026void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
4027
4028/**
4029 * \brief Load reasonnable default SSL configuration values.
4030 * (You need to call mbedtls_ssl_config_init() first.)
4031 *
4032 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004033 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4034 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4035 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004036 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004037 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004038 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004039 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004040 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004041 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004042 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004043int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004044 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004045
4046/**
4047 * \brief Free an SSL configuration context
4048 *
4049 * \param conf SSL configuration context
4050 */
4051void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
4052
4053/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004054 * \brief Initialize SSL session structure
4055 *
4056 * \param session SSL session
4057 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004058void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004059
4060/**
Paul Bakker0a597072012-09-25 21:55:46 +00004061 * \brief Free referenced items in an SSL session including the
4062 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004063 *
Ron Eldor00115032018-07-17 11:21:50 +03004064 * \note A session object can be freed even if the SSL context
4065 * that was used to retrieve the session is still in use.
4066 *
Paul Bakker48916f92012-09-16 19:57:18 +00004067 * \param session SSL session
4068 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004069void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00004070
Hanno Becker65382f22019-07-02 13:51:57 +01004071#include "ssl_ciphersuites.h"
4072
Paul Bakker5121ce52009-01-03 21:22:43 +00004073#ifdef __cplusplus
4074}
4075#endif
4076
4077#endif /* ssl.h */