blob: 29c139ed16b004a75f5b9ca6dc75806ccf04401c [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
Paul Bakker68884e32013-01-07 18:20:04 +010036#include "ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020039#include "x509_crt.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020040#include "x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020041#endif
Paul Bakkered27a042013-04-18 22:46:23 +020042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_DHM_C)
Paul Bakker48916f92012-09-16 19:57:18 +000044#include "dhm.h"
45#endif
46
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#if defined(MBEDTLS_ECDH_C)
Paul Bakker41c83d32013-03-20 14:39:14 +010048#include "ecdh.h"
49#endif
50
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_ZLIB_SUPPORT)
Hanno Beckere494e202018-03-08 13:26:12 +000052
53#if defined(MBEDTLS_DEPRECATED_WARNING)
54#warning "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and will be removed in the next major revision of the library"
55#endif
56
57#if defined(MBEDTLS_DEPRECATED_REMOVED)
58#error "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and cannot be used if MBEDTLS_DEPRECATED_REMOVED is set"
59#endif
60
Paul Bakker2770fbd2012-07-03 13:30:23 +000061#include "zlib.h"
62#endif
63
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#if defined(MBEDTLS_HAVE_TIME)
Ron Eldor6fd941f2017-05-14 16:17:33 +030065#include "platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020066#endif
67
Paul Bakker13e2dfe2009-07-28 07:18:38 +000068/*
69 * SSL Error codes
70 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
72#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
73#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
74#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
75#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
76#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
77#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
78#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
79#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
80#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
81#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
82#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
83#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
84#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
85#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
86#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
87#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
88#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
89#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
90#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
91#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
92#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
93#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
94#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
95#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
96#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
97#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
98#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
99#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200100#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200101#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
102#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
103#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
104#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
105#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
106#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
107#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
108#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
109#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
110#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
111#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
112#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
113#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
114#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 +0100115#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 +0100116#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
117#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200118#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 +0100119#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100120#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
121#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */
Hanno Becker8ec81022017-10-10 10:35:08 +0100122#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 +0200123#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100124#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000125
126/*
127 * Various constants
128 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200129#define MBEDTLS_SSL_MAJOR_VERSION_3 3
130#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
131#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
132#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
133#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000134
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200135#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
136#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100137
Simon Butcher9f812312015-09-28 19:22:33 +0100138#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Simon Butcher89f77622015-09-27 22:50:49 +0100139
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200140/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200141 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200142#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
143#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
144#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
145#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
146#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
147#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200149#define MBEDTLS_SSL_IS_CLIENT 0
150#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200152#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
153#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
156#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158#define MBEDTLS_SSL_ETM_DISABLED 0
159#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200161#define MBEDTLS_SSL_COMPRESS_NULL 0
162#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#define MBEDTLS_SSL_VERIFY_NONE 0
165#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
166#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200167#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
170#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
173#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000174
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
176#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
179#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
182#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
183#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200185#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
186#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
187#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
190#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200191
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100192#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
193#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100194
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200195#define MBEDTLS_SSL_ARC4_ENABLED 0
196#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100197
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200198#define MBEDTLS_SSL_PRESET_DEFAULT 0
199#define MBEDTLS_SSL_PRESET_SUITEB 2
200
Janos Follath088ce432017-04-10 12:42:31 +0100201#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
202#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
203
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200204/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200205 * Default range for DTLS retransmission timer value, in milliseconds.
206 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
209#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200210
Paul Bakker088c5c52014-04-25 11:11:10 +0200211/**
212 * \name SECTION: Module settings
213 *
214 * The configuration options you can set for this module are in this section.
215 * Either change them in config.h or define them on the compiler command line.
216 * \{
217 */
218
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200219#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
220#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200221#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200222
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200223/*
Angus Grattond8213d02016-05-25 20:56:48 +1000224 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200225 * determines the size of each of the two internal I/O buffers.
226 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200227 * Note: the RFC defines the default size of SSL / TLS messages. If you
228 * change the value here, other clients / servers may not be able to
229 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200230 * both sides of the connection and have it reduced at both sides, or
231 * if you're using the Max Fragment Length extension and you know all your
232 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200233 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
235#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200236#endif
237
Angus Grattond8213d02016-05-25 20:56:48 +1000238#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
239#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
240#endif
241
242#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
243#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
244#endif
245
Hanno Beckere0b150f2018-08-21 15:51:03 +0100246#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
247#define MBEDTLS_SSL_DTLS_MAX_BUFFERING ( 2 * MBEDTLS_SSL_IN_CONTENT_LEN )
248#endif
249
Paul Bakker088c5c52014-04-25 11:11:10 +0200250/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000251
252/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100253 * Length of the verify data for secure renegotiation
254 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200255#if defined(MBEDTLS_SSL_PROTO_SSL3)
256#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100257#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200258#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100259#endif
260
261/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200262 * Signaling ciphersuite values (SCSV)
263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000265#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000266
Paul Bakker5121ce52009-01-03 21:22:43 +0000267/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000268 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200269 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200271#define MBEDTLS_SSL_HASH_NONE 0
272#define MBEDTLS_SSL_HASH_MD5 1
273#define MBEDTLS_SSL_HASH_SHA1 2
274#define MBEDTLS_SSL_HASH_SHA224 3
275#define MBEDTLS_SSL_HASH_SHA256 4
276#define MBEDTLS_SSL_HASH_SHA384 5
277#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000278
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200279#define MBEDTLS_SSL_SIG_ANON 0
280#define MBEDTLS_SSL_SIG_RSA 1
281#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000282
283/*
Paul Bakker926af752012-11-23 13:38:07 +0100284 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200285 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
288#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100289
290/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000291 * Message, alert and handshake types
292 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
294#define MBEDTLS_SSL_MSG_ALERT 21
295#define MBEDTLS_SSL_MSG_HANDSHAKE 22
296#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Paul Bakker5121ce52009-01-03 21:22:43 +0000297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
299#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
302#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
303#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
304#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
305#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
306#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
307#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
308#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
309#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
310#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
311#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
312#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
313#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
314#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
315#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
316#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
317#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
318#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
319#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
320#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
321#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
322#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
323#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
324#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
325#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
326#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
327#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
328#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
329#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200331#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
332#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
333#define MBEDTLS_SSL_HS_SERVER_HELLO 2
334#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
335#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
336#define MBEDTLS_SSL_HS_CERTIFICATE 11
337#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
338#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
339#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
340#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
341#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
342#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000343
344/*
345 * TLS extensions
346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200347#define MBEDTLS_TLS_EXT_SERVERNAME 0
348#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000349
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
355#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000356
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
362#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200365
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200366#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000369
Paul Bakkereb2c6582012-09-27 19:15:01 +0000370/*
Paul Bakkered27a042013-04-18 22:46:23 +0200371 * Size defines
372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#if !defined(MBEDTLS_PSK_MAX_LEN)
374#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200375#endif
376
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200377/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200378union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200379{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200381 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
382#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
384 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200385#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
387 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
388 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
389 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
390 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200391#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
393 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200394#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
396 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
397 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200398#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
400 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200401#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
403 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
404 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200405#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200406#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
407 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
408#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200409};
410
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200411#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200412
Paul Bakker407a0da2013-06-27 14:29:21 +0200413#ifdef __cplusplus
414extern "C" {
415#endif
416
Paul Bakkered27a042013-04-18 22:46:23 +0200417/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000418 * SSL state machine
419 */
420typedef enum
421{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422 MBEDTLS_SSL_HELLO_REQUEST,
423 MBEDTLS_SSL_CLIENT_HELLO,
424 MBEDTLS_SSL_SERVER_HELLO,
425 MBEDTLS_SSL_SERVER_CERTIFICATE,
426 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
427 MBEDTLS_SSL_CERTIFICATE_REQUEST,
428 MBEDTLS_SSL_SERVER_HELLO_DONE,
429 MBEDTLS_SSL_CLIENT_CERTIFICATE,
430 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
431 MBEDTLS_SSL_CERTIFICATE_VERIFY,
432 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
433 MBEDTLS_SSL_CLIENT_FINISHED,
434 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
435 MBEDTLS_SSL_SERVER_FINISHED,
436 MBEDTLS_SSL_FLUSH_BUFFERS,
437 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
438 MBEDTLS_SSL_HANDSHAKE_OVER,
439 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
440 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000441}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200442mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000443
Simon Butchere846b512016-03-01 17:31:49 +0000444/**
445 * \brief Callback type: send data on the network.
446 *
447 * \note That callback may be either blocking or non-blocking.
448 *
449 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000450 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000451 * \param len Length of the data to send
452 *
453 * \return The callback must return the number of bytes sent if any,
454 * or a non-zero error code.
455 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
456 * must be returned when the operation would block.
457 *
Simon Butcherd567a232016-03-09 20:19:21 +0000458 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000459 * It must always return the number of bytes actually sent.
460 */
461typedef int mbedtls_ssl_send_t( void *ctx,
462 const unsigned char *buf,
463 size_t len );
464
465/**
466 * \brief Callback type: receive data from the network.
467 *
468 * \note That callback may be either blocking or non-blocking.
469 *
470 * \param ctx Context for the receive callback (typically a file
471 * descriptor)
472 * \param buf Buffer to write the received data to
473 * \param len Length of the receive buffer
474 *
475 * \return The callback must return the number of bytes received,
476 * or a non-zero error code.
477 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
478 * must be returned when the operation would block.
479 *
Simon Butcherd567a232016-03-09 20:19:21 +0000480 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000481 * buffer. It must always return the number of bytes actually
482 * received and written to the buffer.
483 */
484typedef int mbedtls_ssl_recv_t( void *ctx,
485 unsigned char *buf,
486 size_t len );
487
488/**
489 * \brief Callback type: receive data from the network, with timeout
490 *
491 * \note That callback must block until data is received, or the
492 * timeout delay expires, or the operation is interrupted by a
493 * signal.
494 *
495 * \param ctx Context for the receive callback (typically a file descriptor)
496 * \param buf Buffer to write the received data to
497 * \param len Length of the receive buffer
498 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000499 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000500 *
501 * \return The callback must return the number of bytes received,
502 * or a non-zero error code:
503 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
504 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
505 *
Simon Butcherd567a232016-03-09 20:19:21 +0000506 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000507 * buffer. It must always return the number of bytes actually
508 * received and written to the buffer.
509 */
510typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
511 unsigned char *buf,
512 size_t len,
513 uint32_t timeout );
514/**
515 * \brief Callback type: set a pair of timers/delays to watch
516 *
517 * \param ctx Context pointer
518 * \param int_ms Intermediate delay in milliseconds
519 * \param fin_ms Final delay in milliseconds
520 * 0 cancels the current timer.
521 *
522 * \note This callback must at least store the necessary information
523 * for the associated \c mbedtls_ssl_get_timer_t callback to
524 * return correct information.
525 *
526 * \note If using a event-driven style of programming, an event must
527 * be generated when the final delay is passed. The event must
528 * cause a call to \c mbedtls_ssl_handshake() with the proper
529 * SSL context to be scheduled. Care must be taken to ensure
530 * that at most one such call happens at a time.
531 *
532 * \note Only one timer at a time must be running. Calling this
533 * function while a timer is running must cancel it. Cancelled
534 * timers must not generate any event.
535 */
536typedef void mbedtls_ssl_set_timer_t( void * ctx,
537 uint32_t int_ms,
538 uint32_t fin_ms );
539
540/**
541 * \brief Callback type: get status of timers/delays
542 *
543 * \param ctx Context pointer
544 *
545 * \return This callback must return:
546 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000547 * 0 if none of the delays have passed,
548 * 1 if only the intermediate delay has passed,
549 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000550 */
551typedef int mbedtls_ssl_get_timer_t( void * ctx );
552
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200553/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554typedef struct mbedtls_ssl_session mbedtls_ssl_session;
555typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200556typedef struct mbedtls_ssl_config mbedtls_ssl_config;
557
558/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200559typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
560typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100561typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200562#if defined(MBEDTLS_X509_CRT_PARSE_C)
563typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200564#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200565#if defined(MBEDTLS_SSL_PROTO_DTLS)
566typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200567#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000568
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200569#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100570#if defined(MBEDTLS_X509_CRT_PARSE_C)
571/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200572 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100573 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200574 * This callback is called during an SSL handshake to start
575 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200576 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100577 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200578 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100579 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200580 * This function typically sends or enqueues a request, and
581 * does not wait for the operation to complete. This allows
582 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100583 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200584 * The parameters \p ssl and \p cert are guaranteed to remain
585 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200586 * function must save the contents of \p hash if the value
587 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200588 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100589 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200590 * This function may call mbedtls_ssl_set_async_operation_data()
591 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200592 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200593 *
Gilles Peskined3268832018-04-26 06:23:59 +0200594 * \note For RSA signatures, this function must produce output
595 * that is consistent with PKCS#1 v1.5 in the same way as
596 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
597 * apply the padding steps described in RFC 8017, section 9.2
598 * "EMSA-PKCS1-v1_5" as follows.
599 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
600 * encoding, treating \p hash as the DigestInfo to be
601 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
602 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200603 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200604 * encoding, treating \p hash as the hash to be encoded and
605 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
606 * from step 2, with `digestAlgorithm` obtained by calling
607 * mbedtls_oid_get_oid_by_md() on \p md_alg.
608 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200609 * \note For ECDSA signatures, the output format is the DER encoding
610 * `Ecdsa-Sig-Value` defined in
611 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
612 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200613 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200614 * modified other than via
615 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200616 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200617 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200618 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200619 * connection. However, if other callbacks are used, this
620 * property may not hold. For example, if an SNI callback
621 * is registered with mbedtls_ssl_conf_sni(), then
622 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200623 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100624 * \param hash Buffer containing the hash. This buffer is
625 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200626 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100627 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200628 * \return 0 if the operation was started successfully and the SSL
629 * stack should call the resume callback immediately.
630 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
631 * was started successfully and the SSL stack should return
632 * immediately without calling the resume callback yet.
633 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
634 * processor does not support this key. The SSL stack will
635 * use the private key object instead.
636 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200637 * propagated up the call chain. The callback should
638 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
639 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200640 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100641 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200642typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100643 mbedtls_x509_crt *cert,
644 mbedtls_md_type_t md_alg,
645 const unsigned char *hash,
646 size_t hash_len );
647
648/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200649 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100650 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200651 * This callback is called during an SSL handshake to start
652 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200653 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100654 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200655 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100656 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200657 * This function typically sends or enqueues a request, and
658 * does not wait for the operation to complete. This allows
659 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100660 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200661 * The parameters \p ssl and \p cert are guaranteed to remain
662 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200663 * function must save the contents of \p input if the value
664 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200665 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100666 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200667 * This function may call mbedtls_ssl_set_async_operation_data()
668 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200669 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200670 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200671 * \warning RSA decryption as used in TLS is subject to a potential
672 * timing side channel attack first discovered by Bleichenbacher
673 * in 1998. This attack can be remotely exploitable
674 * in practice. To avoid this attack, you must ensure that
675 * if the callback performs an RSA decryption, the time it
676 * takes to execute and return the result does not depend
677 * on whether the RSA decryption succeeded or reported
678 * invalid padding.
679 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200680 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200681 * modified other than via
682 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200683 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200684 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200685 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200686 * connection. However, if other callbacks are used, this
687 * property may not hold. For example, if an SNI callback
688 * is registered with mbedtls_ssl_conf_sni(), then
689 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100690 * \param input Buffer containing the input ciphertext. This buffer
691 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200692 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100693 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200694 * \return 0 if the operation was started successfully and the SSL
695 * stack should call the resume callback immediately.
696 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
697 * was started successfully and the SSL stack should return
698 * immediately without calling the resume callback yet.
699 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
700 * processor does not support this key. The SSL stack will
701 * use the private key object instead.
702 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200703 * propagated up the call chain. The callback should
704 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
705 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200706 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100707 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200708typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100709 mbedtls_x509_crt *cert,
710 const unsigned char *input,
711 size_t input_len );
712#endif /* MBEDTLS_X509_CRT_PARSE_C */
713
714/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200715 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100716 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200717 * This callback is called during an SSL handshake to resume
718 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200719 * ::mbedtls_ssl_async_sign_t or
720 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200721 *
722 * This function typically checks the status of a pending
723 * request or causes the request queue to make progress, and
724 * does not wait for the operation to complete. This allows
725 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100726 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200727 * This function may call mbedtls_ssl_get_async_operation_data()
728 * to retrieve an operation context set by the start callback.
729 * It may call mbedtls_ssl_set_async_operation_data() to modify
730 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200731 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200732 * Note that when this function returns a status other than
733 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
734 * resources associated with the operation.
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 output Buffer containing the output (signature or decrypted
740 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200741 * \param output_len On success, number of bytes written to \p output.
742 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100743 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200744 * \return 0 if output of the operation is available in the
745 * \p output buffer.
746 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
747 * is still in progress. Subsequent requests for progress
748 * on the SSL connection will call the resume callback
749 * again.
750 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200751 * The SSL handshake is aborted. The callback should
752 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
753 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200754 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100755 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200756typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100757 unsigned char *output,
758 size_t *output_len,
759 size_t output_size );
760
761/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200762 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100763 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200764 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200765 * while an asynchronous operation is in progress. Note that
766 * this callback is not called if the
767 * ::mbedtls_ssl_async_resume_t callback has run and has
768 * returned a value other than
769 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
770 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100771 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200772 * This function may call mbedtls_ssl_get_async_operation_data()
773 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200774 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200775 * \param ssl The SSL connection instance. It should not be
776 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100777 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200778typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200779#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000780
Paul Bakker5121ce52009-01-03 21:22:43 +0000781/*
Paul Bakker0a597072012-09-25 21:55:46 +0000782 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000783 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200784struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000785{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100787 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200788#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000789 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000790 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200791 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000792 unsigned char id[32]; /*!< session identifier */
793 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200794
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200795#if defined(MBEDTLS_X509_CRT_PARSE_C)
796 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
797#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200798 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200799
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200800#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200801 unsigned char *ticket; /*!< RFC 5077 session ticket */
802 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200803 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200804#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200805
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200806#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200807 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200809
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200810#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200811 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100813
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100815 int encrypt_then_mac; /*!< flag for EtM activation */
816#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000817};
818
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200819/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200820 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200821 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200822struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200823{
824 /* Group items by size (largest first) to minimize padding overhead */
825
826 /*
827 * Pointers
828 */
829
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100830 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200831
832 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200833 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200834 void *p_dbg; /*!< context for the debug function */
835
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100836 /** Callback for getting (pseudo-)random numbers */
837 int (*f_rng)(void *, unsigned char *, size_t);
838 void *p_rng; /*!< context for the RNG function */
839
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200840 /** Callback to retrieve a session from the cache */
841 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200842 /** Callback to store a session into the cache */
843 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100844 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200845
846#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
847 /** Callback for setting cert according to SNI extension */
848 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
849 void *p_sni; /*!< context for SNI callback */
850#endif
851
852#if defined(MBEDTLS_X509_CRT_PARSE_C)
853 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200854 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200855 void *p_vrfy; /*!< context for X.509 verify calllback */
856#endif
857
858#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
859 /** Callback to retrieve PSK key from identity */
860 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
861 void *p_psk; /*!< context for PSK callback */
862#endif
863
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200864#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200865 /** Callback to create & write a cookie for ClientHello veirifcation */
866 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
867 const unsigned char *, size_t );
868 /** Callback to verify validity of a ClientHello cookie */
869 int (*f_cookie_check)( void *, const unsigned char *, size_t,
870 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100871 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200872#endif
873
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200874#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200875 /** Callback to create & write a session ticket */
876 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
877 unsigned char *, const unsigned char *, size_t *, uint32_t * );
878 /** Callback to parse a session ticket into a session structure */
879 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
880 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200881#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200882
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100883#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200884 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100885 int (*f_export_keys)( void *, const unsigned char *,
886 const unsigned char *, size_t, size_t, size_t );
887 void *p_export_keys; /*!< context for key export callback */
888#endif
889
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200890#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200891 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200892 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
893 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
894 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
895#endif /* MBEDTLS_X509_CRT_PARSE_C */
896
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200897#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100898#if defined(MBEDTLS_X509_CRT_PARSE_C)
899 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
900 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
901#endif /* MBEDTLS_X509_CRT_PARSE_C */
902 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
903 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200904 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200905#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100906
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200907#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200908 const int *sig_hashes; /*!< allowed signature hashes */
909#endif
910
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200911#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100912 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200913#endif
914
915#if defined(MBEDTLS_DHM_C)
916 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
917 mbedtls_mpi dhm_G; /*!< generator for DHM */
918#endif
919
920#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Azim Khanf4659ef2018-03-26 22:11:24 +0100921 unsigned char *psk; /*!< pre-shared key. This field should
922 only be set via
923 mbedtls_ssl_conf_psk() */
924 size_t psk_len; /*!< length of the pre-shared key. This
925 field should only be set via
926 mbedtls_ssl_conf_psk() */
927 unsigned char *psk_identity; /*!< identity for PSK negotiation. This
928 field should only be set via
929 mbedtls_ssl_conf_psk() */
930 size_t psk_identity_len;/*!< length of identity. This field should
931 only be set via
932 mbedtls_ssl_conf_psk() */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200933#endif
934
935#if defined(MBEDTLS_SSL_ALPN)
936 const char **alpn_list; /*!< ordered list of protocols */
937#endif
938
939 /*
940 * Numerical settings (int then char)
941 */
942
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200943 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
944
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200945#if defined(MBEDTLS_SSL_PROTO_DTLS)
946 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200947 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200948 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200949 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200950#endif
951
952#if defined(MBEDTLS_SSL_RENEGOTIATION)
953 int renego_max_records; /*!< grace period for renegotiation */
954 unsigned char renego_period[8]; /*!< value of the record counters
955 that triggers renegotiation */
956#endif
957
958#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
959 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
960#endif
961
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +0200962#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
963 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
964#endif
965
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +0200966#if defined(MBEDTLS_SSL_PROTO_DTLS)
967 uint16_t mtu; /*!< path mtu, used to fragment outoing messages */
968#endif
969
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200970 unsigned char max_major_ver; /*!< max. major version used */
971 unsigned char max_minor_ver; /*!< max. minor version used */
972 unsigned char min_major_ver; /*!< min. major version used */
973 unsigned char min_minor_ver; /*!< min. minor version used */
974
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200975 /*
976 * Flags (bitfields)
977 */
978
979 unsigned int endpoint : 1; /*!< 0: client, 1: server */
980 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200981 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
982 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
983 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +0200984#if defined(MBEDTLS_ARC4_C)
985 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
986#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +0100987#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
988 unsigned int mfl_code : 3; /*!< desired fragment length */
989#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200990#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
991 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
992#endif
993#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
994 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
995#endif
996#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
997 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
998#endif
999#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1000 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1001#endif
1002#if defined(MBEDTLS_SSL_RENEGOTIATION)
1003 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1004#endif
1005#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1006 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1007#endif
1008#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1009 unsigned int session_tickets : 1; /*!< use session tickets? */
1010#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001011#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1012 unsigned int fallback : 1; /*!< is this a fallback? */
1013#endif
Janos Follath088ce432017-04-10 12:42:31 +01001014#if defined(MBEDTLS_SSL_SRV_C)
1015 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1016 Certificate Request messages? */
1017#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001018};
1019
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001020
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001021struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001022{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001023 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001024
Paul Bakker5121ce52009-01-03 21:22:43 +00001025 /*
1026 * Miscellaneous
1027 */
1028 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001029#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001030 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001031 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1032 number of retransmissions of request if
1033 renego_max_records is < 0 */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001034#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001037 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001040 unsigned badmac_seen; /*!< records with a bad MAC received */
1041#endif
1042
Simon Butchere846b512016-03-01 17:31:49 +00001043 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1044 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1045 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1046 /*!< Callback for network receive with timeout */
1047
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001048 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001049
Paul Bakker5121ce52009-01-03 21:22:43 +00001050 /*
1051 * Session layer
1052 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001053 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1054 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1055 mbedtls_ssl_session *session; /*!< negotiated session data */
1056 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001058 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001059 the handshake process */
1060
1061 /*
1062 * Record layer transformations
1063 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001064 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1065 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1066 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1067 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001068
Paul Bakker5121ce52009-01-03 21:22:43 +00001069 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001070 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001071 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001072 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001073
1074 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1075 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001076
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001077 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001078 * Record layer (incoming data)
1079 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001080 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001081 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1082 TLS: maintained by us
1083 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001084 unsigned char *in_hdr; /*!< start of record header */
1085 unsigned char *in_len; /*!< two-bytes message length field */
1086 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001087 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001088 unsigned char *in_offt; /*!< read offset in application data */
1089
1090 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001091 size_t in_msglen; /*!< record header: message length */
1092 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001093#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001094 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001095 size_t next_record_offset; /*!< offset of the next record in datagram
1096 (equal to in_left if none) */
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +02001097#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001098#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001099 uint64_t in_window_top; /*!< last validated record seq_num */
1100 uint64_t in_window; /*!< bitmask for replay detection */
1101#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001102
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001103 size_t in_hslen; /*!< current handshake message length,
1104 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001105 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001106
1107 int keep_current_message; /*!< drop or reuse current message
1108 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001109
Hanno Becker04da1892018-08-14 13:22:10 +01001110#if defined(MBEDTLS_SSL_PROTO_DTLS)
1111 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1112 * within a single datagram. */
1113#endif /* MBEDTLS_SSL_PROTO_DTLS */
1114
Paul Bakker5121ce52009-01-03 21:22:43 +00001115 /*
1116 * Record layer (outgoing data)
1117 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001118 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001119 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001120 unsigned char *out_hdr; /*!< start of record header */
1121 unsigned char *out_len; /*!< two-bytes message length field */
1122 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001123 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001124
1125 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001126 size_t out_msglen; /*!< record header: message length */
1127 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +00001128
Hanno Becker19859472018-08-06 09:40:20 +01001129 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001132 unsigned char *compress_buf; /*!< zlib data buffer */
1133#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001135 signed char split_done; /*!< current record already splitted? */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +01001136#endif
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001137
Paul Bakker5121ce52009-01-03 21:22:43 +00001138 /*
1139 * PKI layer
1140 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001141 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001142
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001143 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001144 * User settings
1145 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001146#if defined(MBEDTLS_X509_CRT_PARSE_C)
1147 char *hostname; /*!< expected peer CN for verification
1148 (and SNI if available) */
Paul Bakker0be444a2013-08-27 21:55:01 +02001149#endif
Paul Bakker48916f92012-09-16 19:57:18 +00001150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001151#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001152 const char *alpn_chosen; /*!< negotiated protocol */
1153#endif
1154
Paul Bakker48916f92012-09-16 19:57:18 +00001155 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001156 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001157 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001158#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001159 unsigned char *cli_id; /*!< transport-level ID of the client */
1160 size_t cli_id_len; /*!< length of cli_id */
1161#endif
1162
1163 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001164 * Secure renegotiation
1165 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001166 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001167 int secure_renegotiation; /*!< does peer support legacy or
1168 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001170 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001171 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1172 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +01001173#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001174};
1175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001176#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001178#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
1179#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +01001180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001181extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +00001182 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001183 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +00001184 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001185 size_t ivlen,
1186 const unsigned char *mac_enc, const unsigned char *mac_dec,
1187 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001188extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
1189extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
1190extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
1191extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
1192extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
1193#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001194
Paul Bakker5121ce52009-01-03 21:22:43 +00001195/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001196 * \brief Return the name of the ciphersuite associated with the
1197 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001198 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001199 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001200 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001201 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001202 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001203const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001204
1205/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001206 * \brief Return the ID of the ciphersuite associated with the
1207 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001208 *
1209 * \param ciphersuite_name SSL ciphersuite name
1210 *
1211 * \return the ID with the ciphersuite or 0 if not found
1212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001213int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001214
1215/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001216 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001217 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001218 * mbedtls_ssl_free()
1219 *
1220 * \param ssl SSL context
1221 */
1222void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1223
1224/**
1225 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001226 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001227 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001228 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001229 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001230 * \warning The conf structure will be accessed during the session.
1231 * It must not be modified or freed as long as the session
1232 * is active.
1233 *
1234 * \warning This function must be called exactly once per context.
1235 * Calling mbedtls_ssl_setup again is not supported, even
1236 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001237 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001238 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001239 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001240 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001241 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001242 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001243 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001244int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001245 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001246
1247/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001248 * \brief Reset an already initialized SSL context for re-use
1249 * while retaining application-set variables, function
1250 * pointers and data.
1251 *
1252 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001253 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1255 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001256 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001258
1259/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001260 * \brief Set the current endpoint type
1261 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001262 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001264 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001265void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001266
1267/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001268 * \brief Set the transport type (TLS or DTLS).
1269 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001270 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001271 * \note For DTLS, you must either provide a recv callback that
1272 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001273 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1274 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001275 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001276 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001277 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1279 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001280 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001281void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001282
1283/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001284 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001285 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001286 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001287 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001288 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001289 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001290 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001291 * (default on server)
1292 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001293 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001294 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001296 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001297 * handshake is complete.
1298 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001300 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001301 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001302 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1304 * 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 +01001305 * the right time(s), which may not be obvious, while REQUIRED always perform
1306 * the verification as soon as possible. For example, REQUIRED was protecting
1307 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001308 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001309void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001311#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001312/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001313 * \brief Set the verification callback (Optional).
1314 *
Paul Bakker915275b2012-09-28 07:10:55 +00001315 * If set, the verify callback is called for each
1316 * certificate in the chain. For implementation
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +02001317 * information, please see \c mbedtls_x509_crt_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001318 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001319 * \param conf SSL configuration
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001320 * \param f_vrfy verification function
1321 * \param p_vrfy verification parameter
1322 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001323void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001324 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001325 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001326#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001327
1328/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001329 * \brief Set the random number generator callback
1330 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001331 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001332 * \param f_rng RNG function
1333 * \param p_rng RNG parameter
1334 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001335void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001336 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001337 void *p_rng );
1338
1339/**
1340 * \brief Set the debug callback
1341 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001342 * The callback has the following argument:
1343 * void * opaque context for the callback
1344 * int debug level
1345 * const char * file name
1346 * int line number
1347 * const char * message
1348 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001349 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001350 * \param f_dbg debug function
1351 * \param p_dbg debug parameter
1352 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001353void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001354 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001355 void *p_dbg );
1356
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001357/**
1358 * \brief Set the underlying BIO callbacks for write, read and
1359 * read-with-timeout.
1360 *
1361 * \param ssl SSL context
1362 * \param p_bio parameter (context) shared by BIO callbacks
1363 * \param f_send write callback
1364 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001365 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001366 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001367 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1368 * the other is used. If both are non-NULL, f_recv_timeout is
1369 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001370 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001371 * \note The two most common use cases are:
1372 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1373 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1374 *
1375 * \note For DTLS, you need to provide either a non-NULL
1376 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001377 *
1378 * \note See the documentations of \c mbedtls_ssl_sent_t,
1379 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001380 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001381 *
Andres AG3616f6f2016-09-14 14:32:09 +01001382 * \note On some platforms, net_sockets.c provides
1383 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1384 * \c mbedtls_net_recv_timeout() that are suitable to be used
1385 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001386 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001387void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001388 void *p_bio,
1389 mbedtls_ssl_send_t *f_send,
1390 mbedtls_ssl_recv_t *f_recv,
1391 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001392
1393/**
1394 * \brief Set the timeout period for mbedtls_ssl_read()
1395 * (Default: no timeout.)
1396 *
1397 * \param conf SSL configuration context
1398 * \param timeout Timeout value in milliseconds.
1399 * Use 0 for no timeout (default).
1400 *
1401 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001402 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001403 * With non-blocking I/O, this will only work if timer
1404 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1405 *
1406 * \note With non-blocking I/O, you may also skip this function
1407 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001408 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001409void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001410
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001411/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001412 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001413 *
1414 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001415 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001416 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001417 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001418 *
1419 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1420 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001421 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001422 *
1423 * \note On some platforms, timing.c provides
1424 * \c mbedtls_timing_set_delay() and
1425 * \c mbedtls_timing_get_delay() that are suitable for using
1426 * here, except if using an event-driven style.
1427 *
1428 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001429 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001430 */
1431void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1432 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001433 mbedtls_ssl_set_timer_t *f_set_timer,
1434 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001435
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001436/**
1437 * \brief Callback type: generate and write session ticket
1438 *
1439 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001440 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001441 * authenticated ticket for the session and write it to the
1442 * output buffer. Here, ticket means the opaque ticket part
1443 * of the NewSessionTicket structure of RFC 5077.
1444 *
1445 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001446 * \param session SSL session to be written in the ticket
1447 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001448 * \param end End of the output buffer
1449 * \param tlen On exit, holds the length written
1450 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1451 *
1452 * \return 0 if successful, or
1453 * a specific MBEDTLS_ERR_XXX code.
1454 */
1455typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1456 const mbedtls_ssl_session *session,
1457 unsigned char *start,
1458 const unsigned char *end,
1459 size_t *tlen,
1460 uint32_t *lifetime );
1461
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001462#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1463/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001464 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001465 *
1466 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001467 * (RFC 5216) and Thread. The key pointers are ephemeral and
1468 * therefore must not be stored. The master secret and keys
1469 * should not be used directly except as an input to a key
1470 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001471 *
1472 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001473 * \param ms Pointer to master secret (fixed length: 48 bytes)
1474 * \param kb Pointer to key block, see RFC 5246 section 6.3
1475 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001476 * \param maclen MAC length
1477 * \param keylen Key length
1478 * \param ivlen IV length
1479 *
1480 * \return 0 if successful, or
1481 * a specific MBEDTLS_ERR_XXX code.
1482 */
1483typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001484 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001485 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001486 size_t maclen,
1487 size_t keylen,
1488 size_t ivlen );
1489#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001490
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001491/**
1492 * \brief Callback type: parse and load session ticket
1493 *
1494 * \note This describes what a callback implementation should do.
1495 * This callback should parse a session ticket as generated
1496 * by the corresponding mbedtls_ssl_ticket_write_t function,
1497 * and, if the ticket is authentic and valid, load the
1498 * session.
1499 *
1500 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001501 * bytes of the input buffer, eg to use it as a temporary
1502 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001503 *
1504 * \param p_ticket Context for the callback
1505 * \param session SSL session to be loaded
1506 * \param buf Start of the buffer containing the ticket
1507 * \param len Length of the ticket.
1508 *
1509 * \return 0 if successful, or
1510 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1511 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1512 * any other non-zero code for other failures.
1513 */
1514typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1515 mbedtls_ssl_session *session,
1516 unsigned char *buf,
1517 size_t len );
1518
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001519#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001520/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001521 * \brief Configure SSL session ticket callbacks (server only).
1522 * (Default: none.)
1523 *
1524 * \note On server, session tickets are enabled by providing
1525 * non-NULL callbacks.
1526 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001527 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001528 *
1529 * \param conf SSL configuration context
1530 * \param f_ticket_write Callback for writing a ticket
1531 * \param f_ticket_parse Callback for parsing a ticket
1532 * \param p_ticket Context shared by the two callbacks
1533 */
1534void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1535 mbedtls_ssl_ticket_write_t *f_ticket_write,
1536 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1537 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001538#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001539
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001540#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1541/**
1542 * \brief Configure key export callback.
1543 * (Default: none.)
1544 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001545 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001546 *
1547 * \param conf SSL configuration context
1548 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001549 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001550 */
1551void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1552 mbedtls_ssl_export_keys_t *f_export_keys,
1553 void *p_export_keys );
1554#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1555
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001556#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001557/**
1558 * \brief Configure asynchronous private key operation callbacks.
1559 *
1560 * \param conf SSL configuration context
1561 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001562 * the description of ::mbedtls_ssl_async_sign_t
1563 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001564 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001565 * operation; in this case the private key object
1566 * associated with the certificate will be used.
1567 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001568 * the description of ::mbedtls_ssl_async_decrypt_t
1569 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001570 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001571 * operation; in this case the private key object
1572 * associated with the certificate will be used.
1573 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001574 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001575 * for more information. This may not be \c NULL unless
1576 * \p f_async_sign and \p f_async_decrypt are both
1577 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001578 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001579 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001580 * for more information. This may be \c NULL if
1581 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02001582 * \param config_data A pointer to configuration data which can be
1583 * retrieved with
1584 * mbedtls_ssl_conf_get_async_config_data(). The
1585 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001586 */
1587void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
1588 mbedtls_ssl_async_sign_t *f_async_sign,
1589 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
1590 mbedtls_ssl_async_resume_t *f_async_resume,
1591 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001592 void *config_data );
1593
1594/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02001595 * \brief Retrieve the configuration data set by
1596 * mbedtls_ssl_conf_async_private_cb().
1597 *
1598 * \param conf SSL configuration context
1599 * \return The configuration data set by
1600 * mbedtls_ssl_conf_async_private_cb().
1601 */
1602void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
1603
1604/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001605 * \brief Retrieve the asynchronous operation user context.
1606 *
1607 * \note This function may only be called while a handshake
1608 * is in progress.
1609 *
1610 * \param ssl The SSL context to access.
1611 *
1612 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02001613 * set during the current handshake. If
1614 * mbedtls_ssl_set_async_operation_data() has not yet been
1615 * called during the current handshake, this function returns
1616 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001617 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001618void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001619
1620/**
1621 * \brief Retrieve the asynchronous operation user context.
1622 *
1623 * \note This function may only be called while a handshake
1624 * is in progress.
1625 *
1626 * \param ssl The SSL context to access.
1627 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02001628 * Call mbedtls_ssl_get_async_operation_data() later during the
1629 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001630 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001631void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001632 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001633#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001634
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001635/**
1636 * \brief Callback type: generate a cookie
1637 *
1638 * \param ctx Context for the callback
1639 * \param p Buffer to write to,
1640 * must be updated to point right after the cookie
1641 * \param end Pointer to one past the end of the output buffer
1642 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001643 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001644 * \param ilen Length of info in bytes
1645 *
1646 * \return The callback must return 0 on success,
1647 * or a negative error code.
1648 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001649typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001650 unsigned char **p, unsigned char *end,
1651 const unsigned char *info, size_t ilen );
1652
1653/**
1654 * \brief Callback type: verify a cookie
1655 *
1656 * \param ctx Context for the callback
1657 * \param cookie Cookie to verify
1658 * \param clen Length of cookie
1659 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001660 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001661 * \param ilen Length of info in bytes
1662 *
1663 * \return The callback must return 0 if cookie is valid,
1664 * or a negative error code.
1665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001667 const unsigned char *cookie, size_t clen,
1668 const unsigned char *info, size_t ilen );
1669
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001670#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001671/**
1672 * \brief Register callbacks for DTLS cookies
1673 * (Server only. DTLS only.)
1674 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001675 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001676 * register working callbacks (and initialize their context).
1677 *
1678 * To disable HelloVerifyRequest, register NULL callbacks.
1679 *
1680 * \warning Disabling hello verification allows your server to be used
1681 * for amplification in DoS attacks against other hosts.
1682 * Only disable if you known this can't happen in your
1683 * particular environment.
1684 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001685 * \note See comments on \c mbedtls_ssl_handshake() about handling
1686 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1687 * on the first handshake attempt when this is enabled.
1688 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02001689 * \note This is also necessary to handle client reconnection from
1690 * the same port as described in RFC 6347 section 4.2.8 (only
1691 * the variant with cookies is supported currently). See
1692 * comments on \c mbedtls_ssl_read() for details.
1693 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001694 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001695 * \param f_cookie_write Cookie write callback
1696 * \param f_cookie_check Cookie check callback
1697 * \param p_cookie Context for both callbacks
1698 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001699void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001700 mbedtls_ssl_cookie_write_t *f_cookie_write,
1701 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001702 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001703
1704/**
1705 * \brief Set client's transport-level identification info.
1706 * (Server only. DTLS only.)
1707 *
1708 * This is usually the IP address (and port), but could be
1709 * anything identify the client depending on the underlying
1710 * network stack. Used for HelloVerifyRequest with DTLS.
1711 * This is *not* used to route the actual packets.
1712 *
1713 * \param ssl SSL context
1714 * \param info Transport-level info identifying the client (eg IP + port)
1715 * \param ilen Length of info in bytes
1716 *
1717 * \note An internal copy is made, so the info buffer can be reused.
1718 *
1719 * \return 0 on success,
1720 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001721 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001722 */
1723int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
1724 const unsigned char *info,
1725 size_t ilen );
1726
1727#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001728
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001729#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001730/**
1731 * \brief Enable or disable anti-replay protection for DTLS.
1732 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001733 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001734 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001735 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001737 *
1738 * \warning Disabling this is a security risk unless the application
1739 * protocol handles duplicated packets in a safe way. You
1740 * should not disable this without careful consideration.
1741 * However, if your application already detects duplicated
1742 * packets and needs information about them to adjust its
1743 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001744 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001745void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001746#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001748#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001749/**
1750 * \brief Set a limit on the number of records with a bad MAC
1751 * before terminating the connection.
1752 * (DTLS only, no effect on TLS.)
1753 * Default: 0 (disabled).
1754 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001755 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001756 * \param limit Limit, or 0 to disable.
1757 *
1758 * \note If the limit is N, then the connection is terminated when
1759 * the Nth non-authentic record is seen.
1760 *
1761 * \note Records with an invalid header are not counted, only the
1762 * ones going through the authentication-decryption phase.
1763 *
1764 * \note This is a security trade-off related to the fact that it's
1765 * often relatively easy for an active attacker ot inject UDP
1766 * datagrams. On one hand, setting a low limit here makes it
1767 * easier for such an attacker to forcibly terminated a
1768 * connection. On the other hand, a high limit or no limit
1769 * might make us waste resources checking authentication on
1770 * many bogus packets.
1771 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001772void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001775#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001776
1777/**
1778 * \brief Allow or disallow packing of multiple handshake records
1779 * within a single datagram.
1780 *
1781 * \param ssl The SSL context to configure.
1782 * \param allow_packing This determines whether datagram packing may
1783 * be used or not. A value of \c 0 means that every
1784 * record will be sent in a separate datagram; a
1785 * value of \c 1 means that, if space permits,
1786 * multiple handshake messages (including CCS) belonging to
1787 * a single flight may be packed within a single datagram.
1788 *
1789 * \note This is enabled by default and should only be disabled
1790 * for test purposes, or if datagram packing causes
1791 * interoperability issues with peers that don't support it.
1792 *
1793 * \note Allowing datagram packing reduces the network load since
1794 * there's less overhead if multiple messages share the same
1795 * datagram. Also, it increases the handshake efficiency
1796 * since messages belonging to a single datagram will not
1797 * be reordered in transit, and so future message buffering
1798 * or flight retransmission (if no buffering is used) as
1799 * means to deal with reordering are needed less frequently.
1800 *
1801 * \note Application datagrams are not affected by this option and
1802 * are currently always sent in separate datagrams.
1803 *
1804 */
1805void mbedtls_ssl_conf_datagram_packing( mbedtls_ssl_context *ssl,
1806 unsigned allow_packing );
1807
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001808/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00001809 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001810 * (DTLS only, no effect on TLS.)
1811 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001812 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001813 * \param min Initial timeout value in milliseconds.
1814 * Default: 1000 (1 second).
1815 * \param max Maximum timeout value in milliseconds.
1816 * Default: 60000 (60 seconds).
1817 *
1818 * \note Default values are from RFC 6347 section 4.2.4.1.
1819 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01001820 * \note The 'min' value should typically be slightly above the
1821 * expected round-trip time to your peer, plus whatever time
1822 * it takes for the peer to process the message. For example,
1823 * if your RTT is about 600ms and you peer needs up to 1s to
1824 * do the cryptographic operations in the handshake, then you
1825 * should set 'min' slightly above 1600. Lower values of 'min'
1826 * might cause spurious resends which waste network resources,
1827 * while larger value of 'min' will increase overall latency
1828 * on unreliable network links.
1829 *
1830 * \note The more unreliable your network connection is, the larger
1831 * your max / min ratio needs to be in order to achieve
1832 * reliable handshakes.
1833 *
1834 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
1835 * For example, if min = 1s and max = 5s, the retransmit plan
1836 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
1837 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001838 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001839void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001840#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001841
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01001842#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001843/**
Paul Bakker0a597072012-09-25 21:55:46 +00001844 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01001845 * If not set, no session resuming is done (except if session
1846 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00001847 *
Paul Bakker0a597072012-09-25 21:55:46 +00001848 * The session cache has the responsibility to check for stale
1849 * entries based on timeout. See RFC 5246 for recommendations.
1850 *
1851 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1852 * connection shutdown, so do not cache the pointer! Either set
1853 * it to NULL or make a full copy of the certificate.
1854 *
1855 * The get callback is called once during the initial handshake
1856 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00001858 * If a valid entry is found, it should fill the master of
1859 * the session object with the cached values and return 0,
1860 * return 1 otherwise. Optionally peer_cert can be set as well
1861 * if it is properly present in cache entry.
1862 *
1863 * The set callback is called once during the initial handshake
1864 * to enable session resuming after the entire handshake has
1865 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001866 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00001867 * should create a cache entry for future retrieval based on
1868 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001869 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00001870 * data) is cleared by the SSL/TLS layer when the connection is
1871 * terminated. It is recommended to add metadata to determine if
1872 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00001873 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00001874 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001875 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001876 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00001877 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00001878 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00001879 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001880void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001881 void *p_cache,
1882 int (*f_get_cache)(void *, mbedtls_ssl_session *),
1883 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001884#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001885
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001886#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001887/**
Paul Bakker0a597072012-09-25 21:55:46 +00001888 * \brief Request resumption of session (client-side only)
1889 * Session data is copied from presented session structure.
1890 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001891 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001892 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001893 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001894 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001895 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001897 * arguments are otherwise invalid
1898 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001899 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00001900 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001901int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
1902#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001903
1904/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001905 * \brief Set the list of allowed ciphersuites and the preference
1906 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001907 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00001908 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001909 * The ciphersuites array is not copied, and must remain
1910 * valid for the lifetime of the ssl_config.
1911 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001912 * Note: The server uses its own preferences
1913 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001915 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001916 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00001917 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00001918 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001919void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001920 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00001921
1922/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001923 * \brief Set the list of allowed ciphersuites and the
1924 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001925 * (Only useful on the server side)
1926 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001927 * The ciphersuites array is not copied, and must remain
1928 * valid for the lifetime of the ssl_config.
1929 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001930 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001931 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001933 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1935 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1936 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01001937 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001938 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
1939 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001940 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001941void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001942 const int *ciphersuites,
1943 int major, int minor );
1944
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001946/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001947 * \brief Set the X.509 security profile used for verification
1948 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001949 * \note The restrictions are enforced for all certificates in the
1950 * chain. However, signatures in the handshake are not covered
1951 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
1952 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001953 * \param conf SSL configuration
1954 * \param profile Profile to use
1955 */
1956void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001957 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001958
1959/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001960 * \brief Set the data required to verify peer certificate
1961 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02001962 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02001963 * parameters ca_chain (maps to trust_ca for that function)
1964 * and ca_crl.
1965 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001966 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001967 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00001968 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00001969 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001970void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001971 mbedtls_x509_crt *ca_chain,
1972 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001973
1974/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001975 * \brief Set own certificate chain and private key
1976 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001977 * \note own_cert should contain in order from the bottom up your
1978 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001979 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00001980 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001981 * \note On server, this function can be called multiple times to
1982 * provision more than one cert/key pair (eg one ECDSA, one
1983 * RSA with SHA-256, one RSA with SHA-1). An adequate
1984 * certificate will be selected according to the client's
1985 * advertised capabilities. In case mutliple certificates are
1986 * adequate, preference is given to the one set by the first
1987 * call to this function, then second, etc.
1988 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00001989 * \note On client, only the first call has any effect. That is,
1990 * only one client certificate can be provisioned. The
1991 * server's preferences in its CertficateRequest message will
1992 * be ignored and our only cert will be sent regardless of
1993 * whether it matches those preferences - the server can then
1994 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001995 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001996 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001997 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02001998 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001999 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002000 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002001 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002002int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002003 mbedtls_x509_crt *own_cert,
2004 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002005#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002006
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002007#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002008/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002009 * \brief Set the Pre Shared Key (PSK) and the expected identity name
2010 *
2011 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002012 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002013 *
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002014 * \note Currently clients can only register one pre-shared key.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002015 * In other words, the servers' identity hint is ignored.
2016 * Support for setting multiple PSKs on clients and selecting
2017 * one based on the identity hint is not a planned feature but
2018 * feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002019 *
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002020 * \param conf SSL configuration
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002021 * \param psk pointer to the pre-shared key
2022 * \param psk_len pre-shared key length
2023 * \param psk_identity pointer to the pre-shared key identity
2024 * \param psk_identity_len identity key length
Paul Bakker6db455e2013-09-18 17:29:31 +02002025 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002026 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002027 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002028int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002029 const unsigned char *psk, size_t psk_len,
2030 const unsigned char *psk_identity, size_t psk_identity_len );
2031
Paul Bakker6db455e2013-09-18 17:29:31 +02002032
2033/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002034 * \brief Set the Pre Shared Key (PSK) for the current handshake
2035 *
2036 * \note This should only be called inside the PSK callback,
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002037 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002038 *
2039 * \param ssl SSL context
2040 * \param psk pointer to the pre-shared key
2041 * \param psk_len pre-shared key length
2042 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002043 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002044 */
2045int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2046 const unsigned char *psk, size_t psk_len );
2047
2048/**
2049 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002050 *
2051 * If set, the PSK callback is called for each
2052 * handshake where a PSK ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002053 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002054 * receive the actual PSK data and length.
2055 *
2056 * The callback has the following parameters: (void *parameter,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
Paul Bakker6db455e2013-09-18 17:29:31 +02002058 * size_t identity_len)
2059 * If a valid PSK identity is found, the callback should use
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002060 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
2061 * correct PSK and return 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002062 * Any other return value will result in a denied PSK identity.
2063 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002064 * \note If you set a PSK callback using this function, then you
2065 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002066 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002067 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002068 * \param conf SSL configuration
Paul Bakker6db455e2013-09-18 17:29:31 +02002069 * \param f_psk PSK identity function
2070 * \param p_psk PSK identity parameter
2071 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002072void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002074 size_t),
2075 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002077
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002078#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002079
2080#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2081
2082#if defined(MBEDTLS_DEPRECATED_WARNING)
2083#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2084#else
2085#define MBEDTLS_DEPRECATED
2086#endif
2087
Paul Bakker5121ce52009-01-03 21:22:43 +00002088/**
2089 * \brief Set the Diffie-Hellman public P and G values,
2090 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002091 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002092 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002093 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002094 * \param dhm_P Diffie-Hellman-Merkle modulus
2095 * \param dhm_G Diffie-Hellman-Merkle generator
2096 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002097 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2098 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002099 * \return 0 if successful
2100 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002101MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2102 const char *dhm_P,
2103 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00002104
Hanno Becker470a8c42017-10-04 15:28:46 +01002105#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01002106
2107/**
2108 * \brief Set the Diffie-Hellman public P and G values
2109 * from big-endian binary presentations.
2110 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2111 *
2112 * \param conf SSL configuration
2113 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2114 * \param P_len Length of DHM modulus
2115 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2116 * \param G_len Length of DHM generator
2117 *
2118 * \return 0 if successful
2119 */
2120int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2121 const unsigned char *dhm_P, size_t P_len,
2122 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002123
2124/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002125 * \brief Set the Diffie-Hellman public P and G values,
2126 * read from existing context (server-side only)
2127 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002128 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002129 * \param dhm_ctx Diffie-Hellman-Merkle context
2130 *
2131 * \return 0 if successful
2132 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002133int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002134#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002135
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002136#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2137/**
2138 * \brief Set the minimum length for Diffie-Hellman parameters.
2139 * (Client-side only.)
2140 * (Default: 1024 bits.)
2141 *
2142 * \param conf SSL configuration
2143 * \param bitlen Minimum bit length of the DHM prime
2144 */
2145void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2146 unsigned int bitlen );
2147#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2148
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002149#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002150/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002151 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002152 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002153 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002154 * On server: this only affects selection of the ECDHE curve;
2155 * the curves used for ECDH and ECDSA are determined by the
2156 * list of available certificates instead.
2157 *
2158 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002159 * use. The server can override our preference order.
2160 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002161 * Both sides: limits the set of curves accepted for use in
2162 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002163 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002164 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002165 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002166 * for that. For the end-entity certificate however, the key
2167 * will be accepted only if it is allowed both by this list
2168 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002169 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002170 * \note This list should be ordered by decreasing preference
2171 * (preferred curve first).
2172 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002173 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002174 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002175 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002176 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002177void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2178 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002179#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002180
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002181#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002182/**
2183 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002184 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002185 *
2186 * \note This only affects which hashes are offered and can be used
2187 * for signatures during the handshake. Hashes for message
2188 * authentication and the TLS PRF are controlled by the
2189 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2190 * used for certificate signature are controlled by the
2191 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2192 *
2193 * \note This list should be ordered by decreasing preference
2194 * (preferred hash first).
2195 *
2196 * \param conf SSL configuration
2197 * \param hashes Ordered list of allowed signature hashes,
2198 * terminated by \c MBEDTLS_MD_NONE.
2199 */
2200void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2201 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002202#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002203
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002204#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002205/**
Darryl Green11999bb2018-03-13 15:22:58 +00002206 * \brief Set or reset the hostname to check against the received
2207 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002208 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002209 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002210 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002211 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002212
Hanno Becker0446a392017-04-07 12:59:32 +01002213 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002214 *
Darryl Green11999bb2018-03-13 15:22:58 +00002215 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2216 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002217 * too long input hostname.
2218 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002219 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002220 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002221 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002224#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002225
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002226#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002227/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002228 * \brief Set own certificate and key for the current handshake
2229 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002230 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002231 * the SNI callback.
2232 *
2233 * \param ssl SSL context
2234 * \param own_cert own public certificate chain
2235 * \param pk_key own private key
2236 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002237 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002238 */
2239int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2240 mbedtls_x509_crt *own_cert,
2241 mbedtls_pk_context *pk_key );
2242
2243/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002244 * \brief Set the data required to verify peer certificate for the
2245 * current handshake
2246 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002247 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002248 * the SNI callback.
2249 *
2250 * \param ssl SSL context
2251 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
2252 * \param ca_crl trusted CA CRLs
2253 */
2254void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2255 mbedtls_x509_crt *ca_chain,
2256 mbedtls_x509_crl *ca_crl );
2257
2258/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002259 * \brief Set authmode for the current handshake.
2260 *
2261 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
2262 * the SNI callback.
2263 *
2264 * \param ssl SSL context
2265 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
2266 * MBEDTLS_SSL_VERIFY_REQUIRED
2267 */
2268void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2269 int authmode );
2270
2271/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00002272 * \brief Set server side ServerName TLS extension callback
2273 * (optional, server-side only).
2274 *
2275 * If set, the ServerName callback is called whenever the
2276 * server receives a ServerName TLS extension from the client
2277 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002279 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002280 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002281 * certificate(s) and key(s) to use with \c
2282 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002283 * and may optionally adjust the CA and associated CRL with \c
2284 * mbedtls_ssl_set_hs_ca_chain() as well as the client
2285 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
2286 * then must return 0. If no matching name is found, the
2287 * callback must either set a default cert, or
2288 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00002289 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002290 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00002291 * \param f_sni verification function
2292 * \param p_sni verification parameter
2293 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002294void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002295 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002296 size_t),
2297 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002299
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002300#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002301/**
2302 * \brief Set the EC J-PAKE password for current handshake.
2303 *
2304 * \note An internal copy is made, and destroyed as soon as the
2305 * handshake is completed, or when the SSL context is reset or
2306 * freed.
2307 *
2308 * \note The SSL context needs to be already set up. The right place
2309 * to call this function is between \c mbedtls_ssl_setup() or
2310 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
2311 *
2312 * \param ssl SSL context
2313 * \param pw EC J-PAKE password (pre-shared secret)
2314 * \param pw_len length of pw in bytes
2315 *
2316 * \return 0 on success, or a negative error code.
2317 */
2318int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2319 const unsigned char *pw,
2320 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002321#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002323#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002324/**
2325 * \brief Set the supported Application Layer Protocols.
2326 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002327 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00002328 * \param protos Pointer to a NULL-terminated list of supported protocols,
2329 * in decreasing preference order. The pointer to the list is
2330 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00002331 * the lifetime of the table must be atleast as long as the
2332 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002333 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002334 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002335 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002336int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002337
2338/**
2339 * \brief Get the name of the negotiated Application Layer Protocol.
2340 * This function should be called after the handshake is
2341 * completed.
2342 *
2343 * \param ssl SSL context
2344 *
2345 * \return Protcol name, or NULL if no protocol was negotiated.
2346 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002347const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
2348#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002349
Paul Bakker5701cdc2012-09-27 21:49:42 +00002350/**
Paul Bakker490ecc82011-10-06 13:04:09 +00002351 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02002352 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02002354 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002355 * \note This ignores ciphersuites from higher versions.
2356 *
2357 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2358 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002359 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002360 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002361 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2362 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2363 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2364 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00002365 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002366void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002367
Paul Bakker1d29fb52012-09-28 13:28:45 +00002368/**
2369 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002370 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002371 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002372 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2373 * SSL_MIN_XXXXX_VERSION range is ignored.
2374 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002376 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002377 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2378 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2379 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002380 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002381 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2382 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2383 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2384 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002385 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002386void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002387
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002389/**
2390 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002391 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002392 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002394 * connection, that is a connection with max_version set to a
2395 * lower value than the value you're willing to use. Such
2396 * fallback connections are not recommended but are sometimes
2397 * necessary to interoperate with buggy (version-intolerant)
2398 * servers.
2399 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002400 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002401 * non-fallback connections! This would appear to work for a
2402 * while, then cause failures when the server is upgraded to
2403 * support a newer TLS version.
2404 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002405 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002407 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002408void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002409#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002411#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002412/**
2413 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002414 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002415 *
2416 * \note This should always be enabled, it is a security
2417 * improvement, and should not cause any interoperability
2418 * issue (used only if the peer supports it too).
2419 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002420 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002422 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002423void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002424#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002425
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002426#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002427/**
2428 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002430 *
2431 * \note This should always be enabled, it is a security fix to the
2432 * protocol, and should not cause any interoperability issue
2433 * (used only if the peer supports it too).
2434 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002435 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002436 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002437 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002438void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002439#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002440
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002441#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002442/**
2443 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002445 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002446 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002447 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002448 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00002449 * \note This function is deprecated and will likely be removed in
2450 * a future version of the library.
2451 * RC4 is disabled by default at compile time and needs to be
2452 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002453 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002454 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002455 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002456 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002457void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002458#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002459
Janos Follath088ce432017-04-10 12:42:31 +01002460#if defined(MBEDTLS_SSL_SRV_C)
2461/**
2462 * \brief Whether to send a list of acceptable CAs in
2463 * CertificateRequest messages.
2464 * (Default: do send)
2465 *
2466 * \param conf SSL configuration
2467 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
2468 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
2469 */
2470void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2471 char cert_req_ca_list );
2472#endif /* MBEDTLS_SSL_SRV_C */
2473
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002474#if defined(MBEDTLS_SSL_PROTO_DTLS)
2475/**
2476 * \brief Set the Maximum Tranport Unit (MTU).
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002477 * Special value: 0 means unset (no limit).
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002478 * This represents the maximum size of a datagram payload
2479 * handled by the transport layer (usually UDP) as determined
2480 * by the network link and stack. In practice, this controls
2481 * the maximum size datagram the DTLS layer will pass to the
2482 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
2483 *
2484 * \note This only controls the size of the packet we send.
2485 * Client-side, you can request the server to use smaller
2486 * records with \c mbedtls_conf_max_frag_len().
2487 *
2488 * \note If both a MTU and a maximum fragment length have been
2489 * configured (or negotiated with the peer), the lower limit
2490 * is used.
2491 *
2492 * \note Values larger than \c MBEDTLS_SSL_OUT_CONTENT_LEN have no
2493 * effect. This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002494 * of datagrams sent. Values lower than record layer expansion
2495 * are ignored.
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002496 *
2497 * \param conf SSL configuration
2498 * \param mtu Value of the path MTU in bytes
2499 */
2500void mbedtls_ssl_conf_mtu( mbedtls_ssl_config *conf, uint16_t mtu );
2501#endif /* MBEDTLS_SSL_PROTO_DTLS */
2502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002503#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00002504/**
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002505 * \brief Set the maximum fragment length to emit and/or negotiate
Angus Grattond8213d02016-05-25 20:56:48 +10002506 * (Default: the smaller of MBEDTLS_SSL_IN_CONTENT_LEN and
2507 * MBEDTLS_SSL_OUT_CONTENT_LEN, usually 2^14 bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002508 * (Server: set maximum fragment length to emit,
2509 * usually negotiated by the client during handshake
2510 * (Client: set maximum fragment length to emit *and*
2511 * negotiate with the server during handshake)
2512 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002513 * \note With TLS, this currently only affects ApplicationData (sent
2514 * with \c mbedtls_ssl_read()), not handshake messages.
2515 * With DTLS, this affects both ApplicationData and handshake.
2516 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02002517 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002518 * excluding record overhead that will be added to it, see
2519 * \c mbedtls_ssl_get_record_expansion().
2520 *
2521 * \note For DTLS, it is also possible to set a limit for the total
2522 * size of daragrams passed to the transport layer, including
2523 * record overhead, see \c mbedtls_ssl_conf_mtu().
2524 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002525 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002526 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002527 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2528 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002529 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002530 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002531 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002532int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002533#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002536/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01002537 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01002538 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002539 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002540 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2542 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002543 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002544void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002545#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002546
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002547#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002548/**
2549 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002550 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002551 *
2552 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2553 * Does not affect non-CBC ciphersuites in any version.
2554 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01002555 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002556 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2557 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002558 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002559void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002561
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002562#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002563/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002564 * \brief Enable / Disable session tickets (client only).
2565 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002566 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002567 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002568 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002569 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2571 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002572 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002573void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
2574#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002576#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002577/**
Paul Bakker09f097d2012-10-23 11:54:56 +00002578 * \brief Enable / Disable renegotiation support for connection when
2579 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002580 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00002581 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002582 * \warning It is recommended to always disable renegotation unless you
2583 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00002584 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002585 * renegotiation or a poor understanding of its properties.
2586 *
2587 * \note Server-side, enabling renegotiation also makes the server
2588 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00002589 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002590 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002591 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
2592 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00002593 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002594void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002596
2597/**
2598 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02002600 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002602 * be established even if the peer does not support
2603 * secure renegotiation, but does not allow renegotiation
2604 * to take place if not secure.
2605 * (Interoperable and secure option)
2606 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002607 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002608 * with non-upgraded peers. Allowing legacy renegotiation
2609 * makes the connection vulnerable to specific man in the
2610 * middle attacks. (See RFC 5746)
2611 * (Most interoperable and least secure option)
2612 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002614 * if peer does not support secure renegotiation. Results
2615 * in interoperability issues with non-upgraded peers
2616 * that do not support renegotiation altogether.
2617 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00002618 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002619 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00002620 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
2621 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002622 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00002623 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002624void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00002625
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00002627/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002628 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002629 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002630 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002631 * When we request a renegotiation, the peer can comply or
2632 * ignore the request. This function allows us to decide
2633 * whether to enforce our renegotiation requests by closing
2634 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002635 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002636 * However, records could already be in transit from the peer
2637 * when the request is emitted. In order to increase
2638 * reliability, we can accept a number of records before the
2639 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002640 *
2641 * The optimal value is highly dependent on the specific usage
2642 * scenario.
2643 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002644 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002645 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002646 * out or receives Application Data, until:
2647 * - max_records records have beens seen, if it is >= 0, or
2648 * - the number of retransmits that would happen during an
2649 * actual handshake has been reached.
2650 * Please remember the request might be lost a few times
2651 * if you consider setting max_records to a really low value.
2652 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002653 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002655 * which always behave as if max_record was 0. The reason is,
2656 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002657 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002658 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002659 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002661 * enforce renegotiation, or a non-negative value to enforce
2662 * it but allow for a grace period of max_records records.
2663 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002664void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002665
2666/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002667 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00002668 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002669 *
2670 * Renegotiation is automatically triggered when a record
2671 * counter (outgoing or ingoing) crosses the defined
2672 * threshold. The default value is meant to prevent the
2673 * connection from being closed when the counter is about to
2674 * reached its maximal value (it is not allowed to wrap).
2675 *
2676 * Lower values can be used to enforce policies such as "keys
2677 * must be refreshed every N packets with cipher X".
2678 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00002679 * The renegotiation period can be disabled by setting
2680 * conf->disable_renegotiation to
2681 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
2682 *
2683 * \note When the configured transport is
2684 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
2685 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
2686 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00002687 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002688 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002689 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002690 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002691void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002692 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002693#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002694
Paul Bakker43ca69c2011-01-15 17:35:19 +00002695/**
Hanno Becker8b170a02017-10-10 11:51:19 +01002696 * \brief Check if there is data already read from the
2697 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00002698 *
2699 * \param ssl SSL context
2700 *
Hanno Becker8b170a02017-10-10 11:51:19 +01002701 * \return 0 if nothing's pending, 1 otherwise.
2702 *
Hanno Becker8b170a02017-10-10 11:51:19 +01002703 * \note This is different in purpose and behaviour from
2704 * \c mbedtls_ssl_get_bytes_avail in that it considers
2705 * any kind of unprocessed data, not only unread
2706 * application data. If \c mbedtls_ssl_get_bytes
2707 * returns a non-zero value, this function will
2708 * also signal pending data, but the converse does
2709 * not hold. For example, in DTLS there might be
2710 * further records waiting to be processed from
2711 * the current underlying transport's datagram.
2712 *
Hanno Becker9b19a122017-10-31 13:00:14 +00002713 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01002714 * does not imply that a subsequent call to
2715 * \c mbedtls_ssl_read will provide any data;
2716 * e.g., the unprocessed data might turn out
2717 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00002718 *
2719 * \note This function is useful in the following situation:
2720 * If the SSL/TLS module successfully returns from an
2721 * operation - e.g. a handshake or an application record
2722 * read - and you're awaiting incoming data next, you
2723 * must not immediately idle on the underlying transport
2724 * to have data ready, but you need to check the value
2725 * of this function first. The reason is that the desired
2726 * data might already be read but not yet processed.
2727 * If, in contrast, a previous call to the SSL/TLS module
2728 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
2729 * to call this function, as the latter error code entails
2730 * that all internal data has been processed.
2731 *
Hanno Becker8b170a02017-10-10 11:51:19 +01002732 */
2733int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
2734
2735/**
2736 * \brief Return the number of application data bytes
2737 * remaining to be read from the current record.
2738 *
2739 * \param ssl SSL context
2740 *
2741 * \return How many bytes are available in the application
2742 * data record read buffer.
2743 *
2744 * \note When working over a datagram transport, this is
2745 * useful to detect the current datagram's boundary
2746 * in case \c mbedtls_ssl_read has written the maximal
2747 * amount of data fitting into the input buffer.
2748 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002749 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002750size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002751
2752/**
2753 * \brief Return the result of the certificate verification
2754 *
2755 * \param ssl SSL context
2756 *
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00002757 * \return 0 if successful,
2758 * -1 if result is not available (eg because the handshake was
2759 * aborted too early), or
2760 * a combination of BADCERT_xxx and BADCRL_xxx flags, see
2761 * x509.h
Paul Bakker5121ce52009-01-03 21:22:43 +00002762 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002763uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002764
2765/**
2766 * \brief Return the name of the current ciphersuite
2767 *
2768 * \param ssl SSL context
2769 *
2770 * \return a string containing the ciphersuite name
2771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002772const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002773
2774/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00002775 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
2776 *
2777 * \param ssl SSL context
2778 *
2779 * \return a string containing the SSL version
2780 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002781const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002782
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002783/**
2784 * \brief Return the (maximum) number of bytes added by the record
2785 * layer: header + encryption/MAC overhead (inc. padding)
2786 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002787 * \note This function is not available (always returns an error)
2788 * when record compression is enabled.
2789 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002790 * \param ssl SSL context
2791 *
2792 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002793 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02002794 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002795 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002796int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002797
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002798#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2799/**
2800 * \brief Return the maximum fragment length (payload, in bytes).
2801 * This is the value negotiated with peer if any,
2802 * or the locally configured value.
2803 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002804 * \sa mbedtls_ssl_conf_max_frag_len()
2805 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002806 *
2807 * \param ssl SSL context
2808 *
2809 * \return Current maximum fragment length.
2810 */
2811size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
2812#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2813
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002814/**
2815 * \brief Return the current maximum outgoing record payload in bytes.
2816 * This takes into account the config.h setting \c
2817 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
2818 * max fragment length extension if used, and for DTLS the
2819 * path MTU as configured and current record expansion.
2820 *
2821 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
2822 * called with a larger length value.
2823 * With TLS, \c mbedtls_ssl_write() will fragment the input if
2824 * necessary and return the number of bytes written; it is up
2825 * to the caller to call \c mbedtls_ssl_write() again in
2826 * order to send the remaining bytes if any.
2827 *
2828 * \note This function is not available (always returns an error)
2829 * when record compression is enabled.
2830 *
2831 * \sa mbedtls_ssl_conf_mtu()
2832 * \sa mbedtls_ssl_get_max_frag_len()
2833 * \sa mbedtls_ssl_get_record_expansion()
2834 *
2835 * \param ssl SSL context
2836 *
2837 * \return Current maximum payload for an outgoing record,
2838 * or a negative error code.
2839 */
2840int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
2841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002842#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002843/**
Paul Bakkerb0550d92012-10-30 07:51:03 +00002844 * \brief Return the peer certificate from the current connection
2845 *
2846 * Note: Can be NULL in case no certificate was sent during
2847 * the handshake. Different calls for the same connection can
2848 * return the same or different pointers for the same
2849 * certificate and even a different certificate altogether.
2850 * The peer cert CAN change in a single connection if
2851 * renegotiation is performed.
2852 *
2853 * \param ssl SSL context
2854 *
2855 * \return the current peer certificate
2856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002857const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
2858#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00002861/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002862 * \brief Save session in order to resume it later (client-side only)
2863 * Session data is copied to presented session structure.
2864 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002865 *
2866 * \param ssl SSL context
2867 * \param session session context
2868 *
2869 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002870 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002871 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03002872 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002873 *
Ron Eldor00115032018-07-17 11:21:50 +03002874 * \note Only the server certificate is copied, and not the full chain,
2875 * so you should not attempt to validate the certificate again
2876 * by calling \c mbedtls_x509_crt_verify() on it.
2877 * Instead, you should use the results from the verification
2878 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
2879 * after loading the session again into a new SSL context
2880 * using \c mbedtls_ssl_set_session().
2881 *
2882 * \note Once the session object is not needed anymore, you should
2883 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002884 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002886 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002887int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
2888#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002889
2890/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002891 * \brief Perform the SSL handshake
2892 *
2893 * \param ssl SSL context
2894 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002895 * \return 0 if successful, or
2896 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
Simon Butcher1a57af12015-09-11 17:14:16 +01002897 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED (see below), or
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002898 * a specific SSL error code.
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002899 *
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01002900 * If this function returns MBEDTLS_ERR_SSL_WANT_READ, the
2901 * handshake is unfinished and no further data is available
2902 * from the underlying transport. In this case, you must call
2903 * the function again at some later stage.
Hanno Becker8ec81022017-10-10 10:35:08 +01002904 *
2905 * \note Remarks regarding event-driven DTLS:
2906 * If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram
2907 * from the underlying transport layer is currently being processed,
2908 * and it is safe to idle until the timer or the underlying transport
2909 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01002910 * in which case the datagram of the underlying transport that is
2911 * currently being processed might or might not contain further
2912 * DTLS records.
Hanno Becker8ec81022017-10-10 10:35:08 +01002913 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002914 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00002915 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
2916 * the SSL context for reading or writing, and either free it or
2917 * call \c mbedtls_ssl_session_reset() on it before re-using it
2918 * for a new connection; the current connection must be closed.
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002919 *
2920 * \note If DTLS is in use, then you may choose to handle
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002921 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002922 * purposes, as it is an expected return value rather than an
2923 * actual error, but you still need to reset/free the context.
Paul Bakker5121ce52009-01-03 21:22:43 +00002924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002925int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002926
2927/**
Paul Bakker1961b702013-01-25 14:49:24 +01002928 * \brief Perform a single step of the SSL handshake
2929 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002930 * \note The state of the context (ssl->state) will be at
Aaron Jonesd96e5262016-06-17 14:40:41 +00002931 * the next state after execution of this function. Do not
2932 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01002933 *
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002934 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00002935 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
2936 * the SSL context for reading or writing, and either free it or
2937 * call \c mbedtls_ssl_session_reset() on it before re-using it
2938 * for a new connection; the current connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002939 *
Paul Bakker1961b702013-01-25 14:49:24 +01002940 * \param ssl SSL context
2941 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002942 * \return 0 if successful, or
2943 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2944 * a specific SSL error code.
Paul Bakker1961b702013-01-25 14:49:24 +01002945 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002947
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002948#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01002949/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002950 * \brief Initiate an SSL renegotiation on the running connection.
2951 * Client: perform the renegotiation right now.
2952 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00002953 * during the next call to mbedtls_ssl_read() if honored by
2954 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00002955 *
2956 * \param ssl SSL context
2957 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002958 * \return 0 if successful, or any mbedtls_ssl_handshake() return
2959 * value.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002960 *
2961 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00002962 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
2963 * the SSL context for reading or writing, and either free it or
2964 * call \c mbedtls_ssl_session_reset() on it before re-using it
2965 * for a new connection; the current connection must be closed.
Paul Bakker48916f92012-09-16 19:57:18 +00002966 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
2968#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002969
2970/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002971 * \brief Read at most 'len' application data bytes
2972 *
2973 * \param ssl SSL context
2974 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02002975 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 *
Hanno Becker8ec81022017-10-10 10:35:08 +01002977 * \return One of the following:
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01002978 * - 0 if the read end of the underlying transport was closed,
Hanno Becker8ec81022017-10-10 10:35:08 +01002979 * - the (positive) number of bytes read, or
2980 * - a negative error code on failure.
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002981 *
Hanno Becker8ec81022017-10-10 10:35:08 +01002982 * If MBEDTLS_ERR_SSL_WANT_READ is returned, no application data
2983 * is available from the underlying transport. In this case,
2984 * the function needs to be called again at some later stage.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002985 *
Hanno Becker8ec81022017-10-10 10:35:08 +01002986 * If MBEDTLS_ERR_SSL_WANT_WRITE is returned, a write is pending
2987 * but the underlying transport isn't available for writing. In this
2988 * case, the function needs to be called again at some later stage.
2989 *
2990 * When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002991 * (which can only happen server-side), it means that a client
2992 * is initiating a new connection using the same source port.
2993 * You can either treat that as a connection close and wait
2994 * for the client to resend a ClientHello, or directly
2995 * continue with \c mbedtls_ssl_handshake() with the same
2996 * context (as it has beeen reset internally). Either way, you
2997 * should make sure this is seen by the application as a new
2998 * connection: application state, if any, should be reset, and
2999 * most importantly the identity of the client must be checked
3000 * again. WARNING: not validating the identity of the client
3001 * again, or not transmitting the new identity to the
3002 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003003 *
Hanno Becker298a7b22017-11-06 10:45:26 +00003004 * \note If this function returns something other than a positive value
3005 * or MBEDTLS_ERR_SSL_WANT_READ/WRITE or MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3006 * you must stop using the SSL context for reading or writing,
3007 * and either free it or call \c mbedtls_ssl_session_reset() on it
3008 * before re-using it for a new connection; the current connection
3009 * must be closed.
Hanno Becker8ec81022017-10-10 10:35:08 +01003010 *
3011 * \note Remarks regarding event-driven DTLS:
3012 * - If the function returns MBEDTLS_ERR_SSL_WANT_READ, no datagram
3013 * from the underlying transport layer is currently being processed,
3014 * and it is safe to idle until the timer or the underlying transport
3015 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003016 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3017 * initially available on the underlying transport, as this data may have
3018 * been only e.g. duplicated messages or a renegotiation request.
3019 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3020 * when reacting to an incoming-data event from the underlying transport.
3021 * - On success, the datagram of the underlying transport that is currently
3022 * being processed may contain further DTLS records. You should call
3023 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003024 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003027
3028/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003029 * \brief Try to write exactly 'len' application data bytes
3030 *
3031 * \warning This function will do partial writes in some cases. If the
3032 * return value is non-negative but less than length, the
3033 * function must be called again with updated arguments:
3034 * buf + ret, len - ret (if ret is the return value) until
3035 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003036 *
3037 * \param ssl SSL context
3038 * \param buf buffer holding the data
3039 * \param len how many bytes must be written
3040 *
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003041 * \return the number of bytes actually written (may be less than len),
Jaakko Korhonenaca11a02017-02-07 14:44:40 +02003042 * or MBEDTLS_ERR_SSL_WANT_WRITE or MBEDTLS_ERR_SSL_WANT_READ,
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003043 * or another negative error code.
Paul Bakker5121ce52009-01-03 21:22:43 +00003044 *
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003045 * \note If this function returns something other than 0, a positive
3046 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop
3047 * using the SSL context for reading or writing, and either
3048 * free it or call \c mbedtls_ssl_session_reset() on it before
3049 * re-using it for a new connection; the current connection
3050 * must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003051 *
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003052 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003053 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003054 * until it returns a value greater that or equal to 0. When
3055 * the function returns MBEDTLS_ERR_SSL_WANT_WRITE there may be
3056 * some partial data in the output buffer, however this is not
3057 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003058 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003059 * \note If the requested length is greater than the maximum
3060 * fragment length (either the built-in limit or the one set
3061 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003062 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003064 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
3065 * active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003066 *
3067 * \note Attempting to write 0 bytes will result in an empty TLS
3068 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003071
3072/**
Paul Bakker0a925182012-04-16 06:46:41 +00003073 * \brief Send an alert message
3074 *
3075 * \param ssl SSL context
3076 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003077 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003078 * \param message The alert message (SSL_ALERT_MSG_*)
3079 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003080 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003081 *
3082 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003083 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3084 * the SSL context for reading or writing, and either free it or
3085 * call \c mbedtls_ssl_session_reset() on it before re-using it
3086 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003087 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003089 unsigned char level,
3090 unsigned char message );
3091/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003092 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003093 *
3094 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003095 *
3096 * \return 0 if successful, or a specific SSL error code.
3097 *
3098 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003099 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3100 * the SSL context for reading or writing, and either free it or
3101 * call \c mbedtls_ssl_session_reset() on it before re-using it
3102 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003103 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003105
3106/**
Paul Bakker48916f92012-09-16 19:57:18 +00003107 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003108 *
3109 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003110 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003111void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003112
Paul Bakker48916f92012-09-16 19:57:18 +00003113/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003114 * \brief Initialize an SSL configuration context
3115 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003116 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003117 *
3118 * \note You need to call mbedtls_ssl_config_defaults() unless you
3119 * manually set all of the relevent fields yourself.
3120 *
3121 * \param conf SSL configuration context
3122 */
3123void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
3124
3125/**
3126 * \brief Load reasonnable default SSL configuration values.
3127 * (You need to call mbedtls_ssl_config_init() first.)
3128 *
3129 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003130 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
3131 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
3132 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003133 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003134 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003135 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01003136 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003137 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003138 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003139 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02003140int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003141 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003142
3143/**
3144 * \brief Free an SSL configuration context
3145 *
3146 * \param conf SSL configuration context
3147 */
3148void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
3149
3150/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003151 * \brief Initialize SSL session structure
3152 *
3153 * \param session SSL session
3154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003155void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003156
3157/**
Paul Bakker0a597072012-09-25 21:55:46 +00003158 * \brief Free referenced items in an SSL session including the
3159 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00003160 *
Ron Eldor00115032018-07-17 11:21:50 +03003161 * \note A session object can be freed even if the SSL context
3162 * that was used to retrieve the session is still in use.
3163 *
Paul Bakker48916f92012-09-16 19:57:18 +00003164 * \param session SSL session
3165 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003166void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00003167
Paul Bakker5121ce52009-01-03 21:22:43 +00003168#ifdef __cplusplus
3169}
3170#endif
3171
3172#endif /* ssl.h */