blob: 5df5eb1b58802ad685866d02941a359f21d18c5e [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. */
Hanno Becker7c3cdb62019-05-14 11:02:36 +0100125#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000 /**< An encrypted DTLS-frame with an unexpected CID was received. */
Hanno Becker5dbcc9f2019-06-03 12:58:39 +0100126#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00 /**< An operation failed due to an unexpected version or configuration. */
Manuel Pégourié-Gonnard125af942018-09-11 11:08:12 +0200127#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000128
129/*
130 * Various constants
131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132#define MBEDTLS_SSL_MAJOR_VERSION_3 3
133#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
134#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
135#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
136#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
139#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100140
Simon Butcher9f812312015-09-28 19:22:33 +0100141#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Simon Butcher89f77622015-09-27 22:50:49 +0100142
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200143/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200144 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
146#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
147#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
148#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
149#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
150#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200151
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200152#define MBEDTLS_SSL_IS_CLIENT 0
153#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200154
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200155#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
156#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
159#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200160
Jarno Lamsad9382f82019-06-10 10:27:14 +0300161#define MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED 0
162#define MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED 1
163
Hanno Becker6198af32019-04-09 15:12:56 +0100164#define MBEDTLS_SSL_CID_DISABLED 0
165#define MBEDTLS_SSL_CID_ENABLED 1
166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167#define MBEDTLS_SSL_ETM_DISABLED 0
168#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170#define MBEDTLS_SSL_COMPRESS_NULL 0
171#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173#define MBEDTLS_SSL_VERIFY_NONE 0
174#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
175#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200176#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
179#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
182#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
185#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
188#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
191#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
192#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
195#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
196#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
199#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200200
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100201#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
202#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204#define MBEDTLS_SSL_ARC4_ENABLED 0
205#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100206
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200207#define MBEDTLS_SSL_PRESET_DEFAULT 0
208#define MBEDTLS_SSL_PRESET_SUITEB 2
209
Janos Follath088ce432017-04-10 12:42:31 +0100210#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
211#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
212
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200213/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200214 * Default range for DTLS retransmission timer value, in milliseconds.
215 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
218#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200219
Paul Bakker088c5c52014-04-25 11:11:10 +0200220/**
221 * \name SECTION: Module settings
222 *
223 * The configuration options you can set for this module are in this section.
224 * Either change them in config.h or define them on the compiler command line.
225 * \{
226 */
227
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200228#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
229#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200230#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200231
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200232/*
Angus Grattond8213d02016-05-25 20:56:48 +1000233 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200234 * determines the size of each of the two internal I/O buffers.
235 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200236 * Note: the RFC defines the default size of SSL / TLS messages. If you
237 * change the value here, other clients / servers may not be able to
238 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200239 * both sides of the connection and have it reduced at both sides, or
240 * if you're using the Max Fragment Length extension and you know all your
241 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200242 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200243#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
244#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200245#endif
246
Angus Grattond8213d02016-05-25 20:56:48 +1000247#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
248#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
249#endif
250
251#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
252#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
253#endif
254
Hanno Becker28007512018-08-28 09:46:44 +0100255/*
256 * Maximum number of heap-allocated bytes for the purpose of
257 * DTLS handshake message reassembly and future message buffering.
258 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100259#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100260#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100261#endif
262
Hanno Becker6198af32019-04-09 15:12:56 +0100263/*
264 * Maximum length of CIDs for incoming and outgoing messages.
265 */
266#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Beckerdc19b412019-05-15 10:09:15 +0100267#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker6198af32019-04-09 15:12:56 +0100268#endif
269
270#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
271#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
272#endif
273
Hanno Becker550e1662019-05-08 17:37:58 +0100274#if !defined(MBEDTLS_SSL_CID_PADDING_GRANULARITY)
275#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
276#endif
277
Paul Bakker088c5c52014-04-25 11:11:10 +0200278/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000279
280/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100281 * Length of the verify data for secure renegotiation
282 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200283#if defined(MBEDTLS_SSL_PROTO_SSL3)
284#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100285#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100287#endif
288
289/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200290 * Signaling ciphersuite values (SCSV)
291 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000293#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000294
Paul Bakker5121ce52009-01-03 21:22:43 +0000295/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000296 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200297 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000298 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#define MBEDTLS_SSL_HASH_NONE 0
300#define MBEDTLS_SSL_HASH_MD5 1
301#define MBEDTLS_SSL_HASH_SHA1 2
302#define MBEDTLS_SSL_HASH_SHA224 3
303#define MBEDTLS_SSL_HASH_SHA256 4
304#define MBEDTLS_SSL_HASH_SHA384 5
305#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307#define MBEDTLS_SSL_SIG_ANON 0
308#define MBEDTLS_SSL_SIG_RSA 1
309#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000310
311/*
Paul Bakker926af752012-11-23 13:38:07 +0100312 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200313 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100314 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
316#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100317
318/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000319 * Message, alert and handshake types
320 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
322#define MBEDTLS_SSL_MSG_ALERT 21
323#define MBEDTLS_SSL_MSG_HANDSHAKE 22
324#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker92c930f2019-04-29 17:31:37 +0100325#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
328#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
331#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
332#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
333#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
334#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
335#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
336#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
337#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
338#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
339#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
340#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
341#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
342#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
343#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
344#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
345#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
346#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
347#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
348#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
349#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
350#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
351#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
352#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
353#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
354#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
355#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
356#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
357#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
358#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
361#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
362#define MBEDTLS_SSL_HS_SERVER_HELLO 2
363#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
364#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
365#define MBEDTLS_SSL_HS_CERTIFICATE 11
366#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
367#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
368#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
369#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
370#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
371#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000372
373/*
374 * TLS extensions
375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376#define MBEDTLS_TLS_EXT_SERVERNAME 0
377#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000378
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200382
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200383#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
384#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200386#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100387
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
391#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200394
Hanno Becker4baec2c2019-04-25 16:24:57 +0100395/* The value of the CID extension is still TBD as of
Hanno Becker3cdf8fe2019-05-15 10:26:32 +0100396 * draft-ietf-tls-dtls-connection-id-05
397 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) */
Hanno Beckerfc7ff922019-05-03 12:42:13 +0100398#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker4baec2c2019-04-25 16:24:57 +0100399
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200400#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
401
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000403
Paul Bakkereb2c6582012-09-27 19:15:01 +0000404/*
Paul Bakkered27a042013-04-18 22:46:23 +0200405 * Size defines
406 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200407#if !defined(MBEDTLS_PSK_MAX_LEN)
408#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200409#endif
410
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200411/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200412union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200413{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200414#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200415 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
416#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200417#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
418 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200419#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
421 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
422 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
423 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
424 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200425#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200426#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
427 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200428#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200429#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
430 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
431 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200432#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200433#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
434 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200435#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200436#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
437 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
438 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200439#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200440#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
441 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
442#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200443};
444
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200445#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200446
Paul Bakker407a0da2013-06-27 14:29:21 +0200447#ifdef __cplusplus
448extern "C" {
449#endif
450
Paul Bakkered27a042013-04-18 22:46:23 +0200451/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000452 * SSL state machine
453 */
454typedef enum
455{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456 MBEDTLS_SSL_HELLO_REQUEST,
457 MBEDTLS_SSL_CLIENT_HELLO,
458 MBEDTLS_SSL_SERVER_HELLO,
459 MBEDTLS_SSL_SERVER_CERTIFICATE,
460 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
461 MBEDTLS_SSL_CERTIFICATE_REQUEST,
462 MBEDTLS_SSL_SERVER_HELLO_DONE,
463 MBEDTLS_SSL_CLIENT_CERTIFICATE,
464 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
465 MBEDTLS_SSL_CERTIFICATE_VERIFY,
466 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
467 MBEDTLS_SSL_CLIENT_FINISHED,
468 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
469 MBEDTLS_SSL_SERVER_FINISHED,
470 MBEDTLS_SSL_FLUSH_BUFFERS,
471 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
472 MBEDTLS_SSL_HANDSHAKE_OVER,
473 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
474 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000475}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200476mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000477
Simon Butchere846b512016-03-01 17:31:49 +0000478/**
479 * \brief Callback type: send data on the network.
480 *
481 * \note That callback may be either blocking or non-blocking.
482 *
483 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000484 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000485 * \param len Length of the data to send
486 *
487 * \return The callback must return the number of bytes sent if any,
488 * or a non-zero error code.
489 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
490 * must be returned when the operation would block.
491 *
Simon Butcherd567a232016-03-09 20:19:21 +0000492 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000493 * It must always return the number of bytes actually sent.
494 */
495typedef int mbedtls_ssl_send_t( void *ctx,
496 const unsigned char *buf,
497 size_t len );
498
499/**
500 * \brief Callback type: receive data from the network.
501 *
502 * \note That callback may be either blocking or non-blocking.
503 *
504 * \param ctx Context for the receive callback (typically a file
505 * descriptor)
506 * \param buf Buffer to write the received data to
507 * \param len Length of the receive buffer
508 *
509 * \return The callback must return the number of bytes received,
510 * or a non-zero error code.
511 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
512 * must be returned when the operation would block.
513 *
Simon Butcherd567a232016-03-09 20:19:21 +0000514 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000515 * buffer. It must always return the number of bytes actually
516 * received and written to the buffer.
517 */
518typedef int mbedtls_ssl_recv_t( void *ctx,
519 unsigned char *buf,
520 size_t len );
521
522/**
523 * \brief Callback type: receive data from the network, with timeout
524 *
525 * \note That callback must block until data is received, or the
526 * timeout delay expires, or the operation is interrupted by a
527 * signal.
528 *
529 * \param ctx Context for the receive callback (typically a file descriptor)
530 * \param buf Buffer to write the received data to
531 * \param len Length of the receive buffer
532 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000533 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000534 *
535 * \return The callback must return the number of bytes received,
536 * or a non-zero error code:
537 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
538 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
539 *
Simon Butcherd567a232016-03-09 20:19:21 +0000540 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000541 * buffer. It must always return the number of bytes actually
542 * received and written to the buffer.
543 */
544typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
545 unsigned char *buf,
546 size_t len,
547 uint32_t timeout );
548/**
549 * \brief Callback type: set a pair of timers/delays to watch
550 *
551 * \param ctx Context pointer
552 * \param int_ms Intermediate delay in milliseconds
553 * \param fin_ms Final delay in milliseconds
554 * 0 cancels the current timer.
555 *
556 * \note This callback must at least store the necessary information
557 * for the associated \c mbedtls_ssl_get_timer_t callback to
558 * return correct information.
559 *
560 * \note If using a event-driven style of programming, an event must
561 * be generated when the final delay is passed. The event must
562 * cause a call to \c mbedtls_ssl_handshake() with the proper
563 * SSL context to be scheduled. Care must be taken to ensure
564 * that at most one such call happens at a time.
565 *
566 * \note Only one timer at a time must be running. Calling this
567 * function while a timer is running must cancel it. Cancelled
568 * timers must not generate any event.
569 */
570typedef void mbedtls_ssl_set_timer_t( void * ctx,
571 uint32_t int_ms,
572 uint32_t fin_ms );
573
574/**
575 * \brief Callback type: get status of timers/delays
576 *
577 * \param ctx Context pointer
578 *
579 * \return This callback must return:
580 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000581 * 0 if none of the delays have passed,
582 * 1 if only the intermediate delay has passed,
583 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000584 */
585typedef int mbedtls_ssl_get_timer_t( void * ctx );
586
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200587/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588typedef struct mbedtls_ssl_session mbedtls_ssl_session;
589typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200590typedef struct mbedtls_ssl_config mbedtls_ssl_config;
591
592/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200593typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
594typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100595typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596#if defined(MBEDTLS_X509_CRT_PARSE_C)
597typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200598#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599#if defined(MBEDTLS_SSL_PROTO_DTLS)
600typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200601#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000602
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200603#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100604#if defined(MBEDTLS_X509_CRT_PARSE_C)
605/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200606 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100607 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200608 * This callback is called during an SSL handshake to start
609 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200610 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100611 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200612 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100613 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200614 * This function typically sends or enqueues a request, and
615 * does not wait for the operation to complete. This allows
616 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100617 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200618 * The parameters \p ssl and \p cert are guaranteed to remain
619 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200620 * function must save the contents of \p hash if the value
621 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200622 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100623 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200624 * This function may call mbedtls_ssl_set_async_operation_data()
625 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200626 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200627 *
Gilles Peskined3268832018-04-26 06:23:59 +0200628 * \note For RSA signatures, this function must produce output
629 * that is consistent with PKCS#1 v1.5 in the same way as
630 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
631 * apply the padding steps described in RFC 8017, section 9.2
632 * "EMSA-PKCS1-v1_5" as follows.
633 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
634 * encoding, treating \p hash as the DigestInfo to be
635 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
636 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200637 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200638 * encoding, treating \p hash as the hash to be encoded and
639 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
640 * from step 2, with `digestAlgorithm` obtained by calling
641 * mbedtls_oid_get_oid_by_md() on \p md_alg.
642 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200643 * \note For ECDSA signatures, the output format is the DER encoding
644 * `Ecdsa-Sig-Value` defined in
645 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
646 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200647 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200648 * modified other than via
649 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200650 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200651 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200652 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200653 * connection. However, if other callbacks are used, this
654 * property may not hold. For example, if an SNI callback
655 * is registered with mbedtls_ssl_conf_sni(), then
656 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200657 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100658 * \param hash Buffer containing the hash. This buffer is
659 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200660 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100661 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200662 * \return 0 if the operation was started successfully and the SSL
663 * stack should call the resume callback immediately.
664 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
665 * was started successfully and the SSL stack should return
666 * immediately without calling the resume callback yet.
667 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
668 * processor does not support this key. The SSL stack will
669 * use the private key object instead.
670 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200671 * propagated up the call chain. The callback should
672 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
673 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200674 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100675 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200676typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100677 mbedtls_x509_crt *cert,
678 mbedtls_md_type_t md_alg,
679 const unsigned char *hash,
680 size_t hash_len );
681
682/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200683 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100684 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200685 * This callback is called during an SSL handshake to start
686 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200687 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100688 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200689 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100690 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200691 * This function typically sends or enqueues a request, and
692 * does not wait for the operation to complete. This allows
693 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100694 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200695 * The parameters \p ssl and \p cert are guaranteed to remain
696 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200697 * function must save the contents of \p input if the value
698 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200699 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100700 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200701 * This function may call mbedtls_ssl_set_async_operation_data()
702 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200703 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200704 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200705 * \warning RSA decryption as used in TLS is subject to a potential
706 * timing side channel attack first discovered by Bleichenbacher
707 * in 1998. This attack can be remotely exploitable
708 * in practice. To avoid this attack, you must ensure that
709 * if the callback performs an RSA decryption, the time it
710 * takes to execute and return the result does not depend
711 * on whether the RSA decryption succeeded or reported
712 * invalid padding.
713 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200714 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200715 * modified other than via
716 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200717 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200718 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200719 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200720 * connection. However, if other callbacks are used, this
721 * property may not hold. For example, if an SNI callback
722 * is registered with mbedtls_ssl_conf_sni(), then
723 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100724 * \param input Buffer containing the input ciphertext. This buffer
725 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200726 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100727 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200728 * \return 0 if the operation was started successfully and the SSL
729 * stack should call the resume callback immediately.
730 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
731 * was started successfully and the SSL stack should return
732 * immediately without calling the resume callback yet.
733 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
734 * processor does not support this key. The SSL stack will
735 * use the private key object instead.
736 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200737 * propagated up the call chain. The callback should
738 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
739 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200740 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100741 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200742typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100743 mbedtls_x509_crt *cert,
744 const unsigned char *input,
745 size_t input_len );
746#endif /* MBEDTLS_X509_CRT_PARSE_C */
747
748/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200749 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100750 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200751 * This callback is called during an SSL handshake to resume
752 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200753 * ::mbedtls_ssl_async_sign_t or
754 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200755 *
756 * This function typically checks the status of a pending
757 * request or causes the request queue to make progress, and
758 * does not wait for the operation to complete. This allows
759 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100760 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200761 * This function may call mbedtls_ssl_get_async_operation_data()
762 * to retrieve an operation context set by the start callback.
763 * It may call mbedtls_ssl_set_async_operation_data() to modify
764 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200765 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200766 * Note that when this function returns a status other than
767 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
768 * resources associated with the operation.
769 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200770 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200771 * modified other than via
772 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200773 * \param output Buffer containing the output (signature or decrypted
774 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200775 * \param output_len On success, number of bytes written to \p output.
776 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100777 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200778 * \return 0 if output of the operation is available in the
779 * \p output buffer.
780 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
781 * is still in progress. Subsequent requests for progress
782 * on the SSL connection will call the resume callback
783 * again.
784 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200785 * The SSL handshake is aborted. The callback should
786 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
787 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200788 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100789 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200790typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100791 unsigned char *output,
792 size_t *output_len,
793 size_t output_size );
794
795/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200796 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100797 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200798 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200799 * while an asynchronous operation is in progress. Note that
800 * this callback is not called if the
801 * ::mbedtls_ssl_async_resume_t callback has run and has
802 * returned a value other than
803 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
804 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100805 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200806 * This function may call mbedtls_ssl_get_async_operation_data()
807 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200808 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200809 * \param ssl The SSL connection instance. It should not be
810 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100811 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200812typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200813#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000814
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000815#if defined(MBEDTLS_X509_CRT_PARSE_C)
816#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
817#if defined(MBEDTLS_SHA256_C)
818#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
819#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
820#elif defined(MBEDTLS_SHA512_C)
821#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
822#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
823#elif defined(MBEDTLS_SHA1_C)
824#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
825#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
826#else
827#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
828#endif
829#endif /* MBEDTLS_X509_CRT_PARSE_C */
830
Paul Bakker5121ce52009-01-03 21:22:43 +0000831/*
Paul Bakker0a597072012-09-25 21:55:46 +0000832 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard5363e1f2019-05-24 09:48:05 +0200833 *
834 * Note: when changing this definition, we need to check and update:
835 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +0200836 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard5363e1f2019-05-24 09:48:05 +0200837 * - in library/ssl_tls.c:
838 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
839 * mbedtls_ssl_session_save() and ssl_session_load()
840 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000841 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000843{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100845 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200846#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000847 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000848 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200849 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000850 unsigned char id[32]; /*!< session identifier */
851 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200852
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200853#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Becker9fb6e2e2019-02-05 17:00:50 +0000854 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
855#if !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
856 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
857 * changes during renegotiation, mitigating the triple handshake attack. */
858 unsigned char *peer_cert_digest;
859 size_t peer_cert_digest_len;
860 mbedtls_md_type_t peer_cert_digest_type;
861#endif /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200863 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200864
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200865#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200866 unsigned char *ticket; /*!< RFC 5077 session ticket */
867 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200868 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200869#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200872 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200873#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200874
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200875#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200876 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200877#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100878
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100880 int encrypt_then_mac; /*!< flag for EtM activation */
881#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000882};
883
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200884/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200885 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200886 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200887struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200888{
889 /* Group items by size (largest first) to minimize padding overhead */
890
891 /*
892 * Pointers
893 */
894
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100895 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200896
897 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200898 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200899 void *p_dbg; /*!< context for the debug function */
900
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100901 /** Callback for getting (pseudo-)random numbers */
902 int (*f_rng)(void *, unsigned char *, size_t);
903 void *p_rng; /*!< context for the RNG function */
904
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200905 /** Callback to retrieve a session from the cache */
906 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200907 /** Callback to store a session into the cache */
908 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100909 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200910
911#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
912 /** Callback for setting cert according to SNI extension */
913 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
914 void *p_sni; /*!< context for SNI callback */
915#endif
916
917#if defined(MBEDTLS_X509_CRT_PARSE_C)
918 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200919 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200920 void *p_vrfy; /*!< context for X.509 verify calllback */
921#endif
922
923#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
924 /** Callback to retrieve PSK key from identity */
925 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
926 void *p_psk; /*!< context for PSK callback */
927#endif
928
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200929#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200930 /** Callback to create & write a cookie for ClientHello veirifcation */
931 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
932 const unsigned char *, size_t );
933 /** Callback to verify validity of a ClientHello cookie */
934 int (*f_cookie_check)( void *, const unsigned char *, size_t,
935 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100936 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200937#endif
938
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200939#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200940 /** Callback to create & write a session ticket */
941 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
942 unsigned char *, const unsigned char *, size_t *, uint32_t * );
943 /** Callback to parse a session ticket into a session structure */
944 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
945 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200946#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200947
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100948#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200949 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100950 int (*f_export_keys)( void *, const unsigned char *,
951 const unsigned char *, size_t, size_t, size_t );
952 void *p_export_keys; /*!< context for key export callback */
953#endif
954
Hanno Beckera5a2b082019-05-15 14:03:01 +0100955#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckereec2be92019-05-03 13:06:44 +0100956 size_t cid_len; /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera5a2b082019-05-15 14:03:01 +0100957#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckereec2be92019-05-03 13:06:44 +0100958
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200959#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200960 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200961 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
962 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
963 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
964#endif /* MBEDTLS_X509_CRT_PARSE_C */
965
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200966#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100967#if defined(MBEDTLS_X509_CRT_PARSE_C)
968 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
969 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
970#endif /* MBEDTLS_X509_CRT_PARSE_C */
971 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
972 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200973 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200974#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100975
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200976#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200977 const int *sig_hashes; /*!< allowed signature hashes */
978#endif
979
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200980#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100981 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200982#endif
983
984#if defined(MBEDTLS_DHM_C)
985 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
986 mbedtls_mpi dhm_G; /*!< generator for DHM */
987#endif
988
989#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Azim Khanf4659ef2018-03-26 22:11:24 +0100990 unsigned char *psk; /*!< pre-shared key. This field should
991 only be set via
992 mbedtls_ssl_conf_psk() */
993 size_t psk_len; /*!< length of the pre-shared key. This
994 field should only be set via
995 mbedtls_ssl_conf_psk() */
996 unsigned char *psk_identity; /*!< identity for PSK negotiation. This
997 field should only be set via
998 mbedtls_ssl_conf_psk() */
999 size_t psk_identity_len;/*!< length of identity. This field should
1000 only be set via
1001 mbedtls_ssl_conf_psk() */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001002#endif
1003
1004#if defined(MBEDTLS_SSL_ALPN)
1005 const char **alpn_list; /*!< ordered list of protocols */
1006#endif
1007
1008 /*
1009 * Numerical settings (int then char)
1010 */
1011
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001012 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
1013
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001014#if defined(MBEDTLS_SSL_PROTO_DTLS)
1015 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001016 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001017 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001018 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001019#endif
1020
1021#if defined(MBEDTLS_SSL_RENEGOTIATION)
1022 int renego_max_records; /*!< grace period for renegotiation */
1023 unsigned char renego_period[8]; /*!< value of the record counters
1024 that triggers renegotiation */
1025#endif
1026
1027#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1028 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1029#endif
1030
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001031#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1032 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1033#endif
1034
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001035 unsigned char max_major_ver; /*!< max. major version used */
1036 unsigned char max_minor_ver; /*!< max. minor version used */
1037 unsigned char min_major_ver; /*!< min. major version used */
1038 unsigned char min_minor_ver; /*!< min. minor version used */
1039
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001040 /*
1041 * Flags (bitfields)
1042 */
1043
1044 unsigned int endpoint : 1; /*!< 0: client, 1: server */
1045 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001046 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
1047 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1048 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001049#if defined(MBEDTLS_ARC4_C)
1050 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
1051#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001052#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1053 unsigned int mfl_code : 3; /*!< desired fragment length */
1054#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001055#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1056 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1057#endif
1058#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1059 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03001060 unsigned int enforce_extended_master_secret : 1; /*!< enforce the usage
1061 * of extended master
1062 * secret */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001063#endif
1064#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1065 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
1066#endif
1067#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1068 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1069#endif
1070#if defined(MBEDTLS_SSL_RENEGOTIATION)
1071 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1072#endif
1073#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1074 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1075#endif
1076#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1077 unsigned int session_tickets : 1; /*!< use session tickets? */
1078#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001079#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1080 unsigned int fallback : 1; /*!< is this a fallback? */
1081#endif
Janos Follath088ce432017-04-10 12:42:31 +01001082#if defined(MBEDTLS_SSL_SRV_C)
1083 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1084 Certificate Request messages? */
1085#endif
Hanno Beckera5a2b082019-05-15 14:03:01 +01001086#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere8eff9a2019-05-14 11:30:10 +01001087 unsigned int ignore_unexpected_cid : 1; /*!< Determines whether DTLS
1088 * record with unexpected CID
1089 * should lead to failure. */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001090#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001091};
1092
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001093
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001094struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001095{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001096 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001097
Paul Bakker5121ce52009-01-03 21:22:43 +00001098 /*
1099 * Miscellaneous
1100 */
1101 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001102#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001103 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001104 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1105 number of retransmissions of request if
1106 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001107#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001108
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001110 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1111
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001112#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001113 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001114#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001115
Simon Butchere846b512016-03-01 17:31:49 +00001116 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1117 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1118 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1119 /*!< Callback for network receive with timeout */
1120
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001121 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001122
Paul Bakker5121ce52009-01-03 21:22:43 +00001123 /*
1124 * Session layer
1125 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001126 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1127 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1128 mbedtls_ssl_session *session; /*!< negotiated session data */
1129 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001130
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001131 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001132 the handshake process */
1133
1134 /*
1135 * Record layer transformations
1136 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1138 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1139 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1140 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001141
Paul Bakker5121ce52009-01-03 21:22:43 +00001142 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001143 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001144 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001145 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001146
1147 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1148 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001149
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001150 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001151 * Record layer (incoming data)
1152 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001153 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001154 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1155 TLS: maintained by us
1156 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001157 unsigned char *in_hdr; /*!< start of record header */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001158#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker70e79282019-05-03 14:34:53 +01001159 unsigned char *in_cid; /*!< The start of the CID;
1160 * (the end is marked by in_len). */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001161#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001162 unsigned char *in_len; /*!< two-bytes message length field */
1163 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001164 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001165 unsigned char *in_offt; /*!< read offset in application data */
1166
1167 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001168 size_t in_msglen; /*!< record header: message length */
1169 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001170#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001171 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001172 size_t next_record_offset; /*!< offset of the next record in datagram
1173 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001174#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001175#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001176 uint64_t in_window_top; /*!< last validated record seq_num */
1177 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001178#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001179
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001180 size_t in_hslen; /*!< current handshake message length,
1181 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001182 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001183
1184 int keep_current_message; /*!< drop or reuse current message
1185 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001186
Hanno Becker04da1892018-08-14 13:22:10 +01001187#if defined(MBEDTLS_SSL_PROTO_DTLS)
1188 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1189 * within a single datagram. */
1190#endif /* MBEDTLS_SSL_PROTO_DTLS */
1191
Paul Bakker5121ce52009-01-03 21:22:43 +00001192 /*
1193 * Record layer (outgoing data)
1194 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001195 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001196 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001197 unsigned char *out_hdr; /*!< start of record header */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001198#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker70e79282019-05-03 14:34:53 +01001199 unsigned char *out_cid; /*!< The start of the CID;
1200 * (the end is marked by in_len). */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001201#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001202 unsigned char *out_len; /*!< two-bytes message length field */
1203 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001204 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001205
1206 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001207 size_t out_msglen; /*!< record header: message length */
1208 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +00001209
Hanno Becker19859472018-08-06 09:40:20 +01001210 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1211
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001212#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001213 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001214#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001216#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001217 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001218#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001219#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001220 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001221#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001222
Paul Bakker5121ce52009-01-03 21:22:43 +00001223 /*
1224 * PKI layer
1225 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001226 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001227
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001228 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001229 * User settings
1230 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001231#if defined(MBEDTLS_X509_CRT_PARSE_C)
1232 char *hostname; /*!< expected peer CN for verification
1233 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001234#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001237 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001238#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001239
Paul Bakker48916f92012-09-16 19:57:18 +00001240 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001241 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001242 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001243#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001244 unsigned char *cli_id; /*!< transport-level ID of the client */
1245 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001246#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001247
1248 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001249 * Secure renegotiation
1250 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001251 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001252 int secure_renegotiation; /*!< does peer support legacy or
1253 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001254#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001255 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001256 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1257 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001258#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Beckere5e7f622019-04-25 15:46:59 +01001259
Hanno Beckera5a2b082019-05-15 14:03:01 +01001260#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckere5e7f622019-04-25 15:46:59 +01001261 /* CID configuration to use in subsequent handshakes. */
1262
1263 /*! The next incoming CID, chosen by the user and applying to
1264 * all subsequent handshakes. This may be different from the
1265 * CID currently used in case the user has re-configured the CID
1266 * after an initial handshake. */
1267 unsigned char own_cid[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1268 uint8_t own_cid_len; /*!< The length of \c own_cid. */
1269 uint8_t negotiate_cid; /*!< This indicates whether the CID extension should
1270 * be negotiated in the next handshake or not.
1271 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1272 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera5a2b082019-05-15 14:03:01 +01001273#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001274};
1275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
1279#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +01001280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001281extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +00001282 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001283 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +00001284 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001285 size_t ivlen,
1286 const unsigned char *mac_enc, const unsigned char *mac_dec,
1287 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001288extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
1289extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
1290extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
1291extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
1292extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
1293#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001294
Paul Bakker5121ce52009-01-03 21:22:43 +00001295/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001296 * \brief Return the name of the ciphersuite associated with the
1297 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001298 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001299 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001300 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001301 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001302 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001303const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001304
1305/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001306 * \brief Return the ID of the ciphersuite associated with the
1307 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001308 *
1309 * \param ciphersuite_name SSL ciphersuite name
1310 *
1311 * \return the ID with the ciphersuite or 0 if not found
1312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001313int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001314
1315/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001316 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001317 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001318 * mbedtls_ssl_free()
1319 *
1320 * \param ssl SSL context
1321 */
1322void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1323
1324/**
1325 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001326 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001327 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001328 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001329 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001330 * \warning The conf structure will be accessed during the session.
1331 * It must not be modified or freed as long as the session
1332 * is active.
1333 *
1334 * \warning This function must be called exactly once per context.
1335 * Calling mbedtls_ssl_setup again is not supported, even
1336 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001337 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001338 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001339 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001340 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001341 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001342 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001343 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001344int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001345 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001346
1347/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001348 * \brief Reset an already initialized SSL context for re-use
1349 * while retaining application-set variables, function
1350 * pointers and data.
1351 *
1352 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001353 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1355 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001357int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001358
1359/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001360 * \brief Set the current endpoint type
1361 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001362 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001364 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001365void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001366
1367/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001368 * \brief Set the transport type (TLS or DTLS).
Manuel Pégourié-Gonnardba8b1eb2019-06-17 15:21:07 +02001369 * Default: TLS unless #MBEDTLS_SSL_PROTO_NO_TLS is defined,
1370 * else DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001371 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001372 * \note For DTLS, you must either provide a recv callback that
1373 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001374 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1375 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001376 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001377 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001378 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001379 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1380 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001381 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001382void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001383
1384/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001385 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001386 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001387 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001388 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001389 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001390 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001392 * (default on server)
1393 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001394 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001395 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001396 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001398 * handshake is complete.
1399 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001400 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001401 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001402 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001403 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1405 * 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 +01001406 * the right time(s), which may not be obvious, while REQUIRED always perform
1407 * the verification as soon as possible. For example, REQUIRED was protecting
1408 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001409 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001410void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001412#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001413/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001414 * \brief Set the verification callback (Optional).
1415 *
Paul Bakker915275b2012-09-28 07:10:55 +00001416 * If set, the verify callback is called for each
1417 * certificate in the chain. For implementation
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +02001418 * information, please see \c mbedtls_x509_crt_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001419 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001420 * \param conf SSL configuration
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001421 * \param f_vrfy verification function
1422 * \param p_vrfy verification parameter
1423 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001424void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001425 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001426 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001428
1429/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001430 * \brief Set the random number generator callback
1431 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001432 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001433 * \param f_rng RNG function
1434 * \param p_rng RNG parameter
1435 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001436void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001437 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001438 void *p_rng );
1439
1440/**
1441 * \brief Set the debug callback
1442 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001443 * The callback has the following argument:
1444 * void * opaque context for the callback
1445 * int debug level
1446 * const char * file name
1447 * int line number
1448 * const char * message
1449 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001450 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001451 * \param f_dbg debug function
1452 * \param p_dbg debug parameter
1453 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001454void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001455 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001456 void *p_dbg );
1457
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001458/**
1459 * \brief Set the underlying BIO callbacks for write, read and
1460 * read-with-timeout.
1461 *
1462 * \param ssl SSL context
1463 * \param p_bio parameter (context) shared by BIO callbacks
1464 * \param f_send write callback
1465 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001466 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001467 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001468 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1469 * the other is used. If both are non-NULL, f_recv_timeout is
1470 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001471 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001472 * \note The two most common use cases are:
1473 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1474 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1475 *
1476 * \note For DTLS, you need to provide either a non-NULL
1477 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001478 *
1479 * \note See the documentations of \c mbedtls_ssl_sent_t,
1480 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001481 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001482 *
Andres AG3616f6f2016-09-14 14:32:09 +01001483 * \note On some platforms, net_sockets.c provides
1484 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1485 * \c mbedtls_net_recv_timeout() that are suitable to be used
1486 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001487 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001488void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001489 void *p_bio,
1490 mbedtls_ssl_send_t *f_send,
1491 mbedtls_ssl_recv_t *f_recv,
1492 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001493
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001494#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker6198af32019-04-09 15:12:56 +01001495
Hanno Beckera5a2b082019-05-15 14:03:01 +01001496#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker6198af32019-04-09 15:12:56 +01001497
1498
1499/**
Hanno Becker043a2a42019-05-08 13:24:25 +01001500 * \brief Configure the use of the Connection ID (CID)
Hanno Becker8d0893d2019-04-23 12:01:20 +01001501 * extension in the next handshake.
Hanno Becker6198af32019-04-09 15:12:56 +01001502 *
Hanno Becker3cdf8fe2019-05-15 10:26:32 +01001503 * Reference: draft-ietf-tls-dtls-connection-id-05
1504 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker6198af32019-04-09 15:12:56 +01001505 *
Hanno Beckerf83017c2019-05-15 10:08:35 +01001506 * The DTLS CID extension allows the reliable association of
Hanno Becker6198af32019-04-09 15:12:56 +01001507 * DTLS records to DTLS connections across changes in the
Hanno Becker53f36e92019-05-15 10:10:36 +01001508 * underlying transport (changed IP and Port metadata) by
1509 * adding explicit connection identifiers (CIDs) to the
1510 * headers of encrypted DTLS records. The desired CIDs are
1511 * configured by the application layer and are exchanged in
1512 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker6198af32019-04-09 15:12:56 +01001513 * handshake, where each side indicates the CID it wants the
1514 * peer to use when writing encrypted messages. The CIDs are
1515 * put to use once records get encrypted: the stack discards
1516 * any incoming records that don't include the configured CID
1517 * in their header, and adds the peer's requested CID to the
1518 * headers of outgoing messages.
1519 *
Hanno Becker5fcac0d2019-05-15 10:12:11 +01001520 * This API enables or disables the use of the CID extension
1521 * in the next handshake and sets the value of the CID to
1522 * be used for incoming messages.
Hanno Becker6198af32019-04-09 15:12:56 +01001523 *
1524 * \param ssl The SSL context to configure. This must be initialized.
1525 * \param enable This value determines whether the CID extension should
1526 * be used or not. Possible values are:
1527 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Beckerd928c062019-04-23 11:37:38 +01001528 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1529 * of the CID.
Hanno Becker6198af32019-04-09 15:12:56 +01001530 * \param own_cid The address of the readable buffer holding the CID we want
1531 * the peer to use when sending encrypted messages to us.
1532 * This may be \c NULL if \p own_cid_len is \c 0.
1533 * This parameter is unused if \p enabled is set to
1534 * MBEDTLS_SSL_CID_DISABLED.
1535 * \param own_cid_len The length of \p own_cid.
1536 * This parameter is unused if \p enabled is set to
1537 * MBEDTLS_SSL_CID_DISABLED.
1538 *
Hanno Beckereec2be92019-05-03 13:06:44 +01001539 * \note The value of \p own_cid_len must match the value of the
Hanno Beckere8eff9a2019-05-14 11:30:10 +01001540 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckereec2be92019-05-03 13:06:44 +01001541 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Becker241947d2019-05-13 15:26:11 +01001542 * is bound to.
Hanno Beckereec2be92019-05-03 13:06:44 +01001543 *
Hanno Beckerb9b7e292019-04-23 11:38:47 +01001544 * \note This CID configuration applies to subsequent handshakes
Hanno Becker6198af32019-04-09 15:12:56 +01001545 * performed on the SSL context \p ssl, but does not trigger
1546 * one. You still have to call `mbedtls_ssl_handshake()`
1547 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1548 * (for a renegotiation handshake) explicitly after a
1549 * successful call to this function to run the handshake.
1550 *
1551 * \note This call cannot guarantee that the use of the CID
1552 * will be successfully negotiated in the next handshake,
1553 * because the peer might not support it. Specifically:
1554 * - On the Client, enabling the use of the CID through
1555 * this call implies that the `ClientHello` in the next
1556 * handshake will include the CID extension, thereby
1557 * offering the use of the CID to the server. Only if
1558 * the `ServerHello` contains the CID extension, too,
1559 * the CID extension will actually be put to use.
1560 * - On the Server, enabling the use of the CID through
1561 * this call implies that that the server will look for
1562 * the CID extension in a `ClientHello` from the client,
1563 * and, if present, reply with a CID extension in its
1564 * `ServerHello`.
1565 *
1566 * \note To check whether the use of the CID was negotiated
1567 * after the subsequent handshake has completed, please
1568 * use the API mbedtls_ssl_get_peer_cid().
1569 *
1570 * \warning If the use of the CID extension is enabled in this call
1571 * and the subsequent handshake negotiates its use, Mbed TLS
1572 * will silently drop every packet whose CID does not match
1573 * the CID configured in \p own_cid. It is the responsibility
1574 * of the user to adapt the underlying transport to take care
1575 * of CID-based demultiplexing before handing datagrams to
1576 * Mbed TLS.
1577 *
1578 * \return \c 0 on success. In this case, the CID configuration
1579 * applies to the next handshake.
1580 * \return A negative error code on failure.
1581 */
1582int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1583 int enable,
1584 unsigned char const *own_cid,
1585 size_t own_cid_len );
1586
1587/**
Hanno Becker96f35b42019-05-15 10:14:16 +01001588 * \brief Get information about the use of the CID extension
1589 * in the current connection.
Hanno Becker6198af32019-04-09 15:12:56 +01001590 *
1591 * \param ssl The SSL context to query.
1592 * \param enabled The address at which to store whether the CID extension
1593 * is currently in use or not. If the CID is in use,
1594 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1595 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1596 * \param peer_cid The address of the buffer in which to store the CID
1597 * chosen by the peer (if the CID extension is used).
Hanno Becker633d6042019-05-22 16:50:35 +01001598 * This may be \c NULL in case the value of peer CID
1599 * isn't needed. If it is not \c NULL, \p peer_cid_len
1600 * must not be \c NULL.
Hanno Becker6198af32019-04-09 15:12:56 +01001601 * \param peer_cid_len The address at which to store the size of the CID
1602 * chosen by the peer (if the CID extension is used).
1603 * This is also the number of Bytes in \p peer_cid that
1604 * have been written.
Hanno Becker633d6042019-05-22 16:50:35 +01001605 * This may be \c NULL in case the length of the peer CID
1606 * isn't needed. If it is \c NULL, \p peer_cid must be
1607 * \c NULL, too.
Hanno Becker6198af32019-04-09 15:12:56 +01001608 *
1609 * \note This applies to the state of the CID negotiated in
1610 * the last complete handshake. If a handshake is in
1611 * progress, this function will attempt to complete
1612 * the handshake first.
1613 *
Hanno Beckercb063f52019-05-03 12:54:52 +01001614 * \note If CID extensions have been exchanged but both client
1615 * and server chose to use an empty CID, this function
1616 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1617 * (the rationale for this is that the resulting
1618 * communication is the same as if the CID extensions
1619 * hadn't been used).
1620 *
Hanno Becker6198af32019-04-09 15:12:56 +01001621 * \return \c 0 on success.
1622 * \return A negative error code on failure.
1623 */
1624int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1625 int *enabled,
1626 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1627 size_t *peer_cid_len );
1628
Hanno Beckera5a2b082019-05-15 14:03:01 +01001629#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker6198af32019-04-09 15:12:56 +01001630
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001631/**
1632 * \brief Set the Maximum Tranport Unit (MTU).
1633 * Special value: 0 means unset (no limit).
1634 * This represents the maximum size of a datagram payload
1635 * handled by the transport layer (usually UDP) as determined
1636 * by the network link and stack. In practice, this controls
1637 * the maximum size datagram the DTLS layer will pass to the
1638 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1639 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001640 * \note The limit on datagram size is converted to a limit on
1641 * record payload by subtracting the current overhead of
1642 * encapsulation and encryption/authentication if any.
1643 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001644 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001645 * example when a Path Maximum Transfer Unit (PMTU)
1646 * estimate becomes available from other sources,
1647 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001648 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001649 * \note This setting only controls the size of the packets we send,
1650 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001651 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001652 * server to use smaller records with \c
1653 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001654 *
1655 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001656 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001657 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001658 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001659 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001660 * of datagrams (hence records, see first note) sent. It
1661 * cannot be used to increase the maximum size of records over
1662 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001663 *
1664 * \note Values lower than the current record layer expansion will
1665 * result in an error when trying to send data.
1666 *
1667 * \note Using record compression together with a non-zero MTU value
1668 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001669 *
1670 * \param ssl SSL context
1671 * \param mtu Value of the path MTU in bytes
1672 */
1673void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1674#endif /* MBEDTLS_SSL_PROTO_DTLS */
1675
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001676/**
1677 * \brief Set the timeout period for mbedtls_ssl_read()
1678 * (Default: no timeout.)
1679 *
1680 * \param conf SSL configuration context
1681 * \param timeout Timeout value in milliseconds.
1682 * Use 0 for no timeout (default).
1683 *
1684 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001685 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001686 * With non-blocking I/O, this will only work if timer
1687 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1688 *
1689 * \note With non-blocking I/O, you may also skip this function
1690 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001691 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001692void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001693
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001694/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001695 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001696 *
1697 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001698 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001699 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001700 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001701 *
1702 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1703 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001704 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001705 *
1706 * \note On some platforms, timing.c provides
1707 * \c mbedtls_timing_set_delay() and
1708 * \c mbedtls_timing_get_delay() that are suitable for using
1709 * here, except if using an event-driven style.
1710 *
1711 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001712 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001713 */
1714void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1715 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001716 mbedtls_ssl_set_timer_t *f_set_timer,
1717 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001718
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001719/**
1720 * \brief Callback type: generate and write session ticket
1721 *
1722 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001723 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001724 * authenticated ticket for the session and write it to the
1725 * output buffer. Here, ticket means the opaque ticket part
1726 * of the NewSessionTicket structure of RFC 5077.
1727 *
1728 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001729 * \param session SSL session to be written in the ticket
1730 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001731 * \param end End of the output buffer
1732 * \param tlen On exit, holds the length written
1733 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1734 *
1735 * \return 0 if successful, or
1736 * a specific MBEDTLS_ERR_XXX code.
1737 */
1738typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1739 const mbedtls_ssl_session *session,
1740 unsigned char *start,
1741 const unsigned char *end,
1742 size_t *tlen,
1743 uint32_t *lifetime );
1744
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001745#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1746/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001747 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001748 *
1749 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001750 * (RFC 5216) and Thread. The key pointers are ephemeral and
1751 * therefore must not be stored. The master secret and keys
1752 * should not be used directly except as an input to a key
1753 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001754 *
1755 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001756 * \param ms Pointer to master secret (fixed length: 48 bytes)
1757 * \param kb Pointer to key block, see RFC 5246 section 6.3
1758 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001759 * \param maclen MAC length
1760 * \param keylen Key length
1761 * \param ivlen IV length
1762 *
1763 * \return 0 if successful, or
1764 * a specific MBEDTLS_ERR_XXX code.
1765 */
1766typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001767 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001768 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001769 size_t maclen,
1770 size_t keylen,
1771 size_t ivlen );
1772#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001773
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001774/**
1775 * \brief Callback type: parse and load session ticket
1776 *
1777 * \note This describes what a callback implementation should do.
1778 * This callback should parse a session ticket as generated
1779 * by the corresponding mbedtls_ssl_ticket_write_t function,
1780 * and, if the ticket is authentic and valid, load the
1781 * session.
1782 *
1783 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001784 * bytes of the input buffer, eg to use it as a temporary
1785 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001786 *
1787 * \param p_ticket Context for the callback
1788 * \param session SSL session to be loaded
1789 * \param buf Start of the buffer containing the ticket
1790 * \param len Length of the ticket.
1791 *
1792 * \return 0 if successful, or
1793 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1794 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1795 * any other non-zero code for other failures.
1796 */
1797typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1798 mbedtls_ssl_session *session,
1799 unsigned char *buf,
1800 size_t len );
1801
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001802#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001803/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001804 * \brief Configure SSL session ticket callbacks (server only).
1805 * (Default: none.)
1806 *
1807 * \note On server, session tickets are enabled by providing
1808 * non-NULL callbacks.
1809 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001810 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001811 *
1812 * \param conf SSL configuration context
1813 * \param f_ticket_write Callback for writing a ticket
1814 * \param f_ticket_parse Callback for parsing a ticket
1815 * \param p_ticket Context shared by the two callbacks
1816 */
1817void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1818 mbedtls_ssl_ticket_write_t *f_ticket_write,
1819 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1820 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001821#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001822
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001823#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1824/**
1825 * \brief Configure key export callback.
1826 * (Default: none.)
1827 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001828 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001829 *
1830 * \param conf SSL configuration context
1831 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001832 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001833 */
1834void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1835 mbedtls_ssl_export_keys_t *f_export_keys,
1836 void *p_export_keys );
1837#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1838
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001839#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001840/**
1841 * \brief Configure asynchronous private key operation callbacks.
1842 *
1843 * \param conf SSL configuration context
1844 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001845 * the description of ::mbedtls_ssl_async_sign_t
1846 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001847 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001848 * operation; in this case the private key object
1849 * associated with the certificate will be used.
1850 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001851 * the description of ::mbedtls_ssl_async_decrypt_t
1852 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001853 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001854 * operation; in this case the private key object
1855 * associated with the certificate will be used.
1856 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001857 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001858 * for more information. This may not be \c NULL unless
1859 * \p f_async_sign and \p f_async_decrypt are both
1860 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001861 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001862 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001863 * for more information. This may be \c NULL if
1864 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02001865 * \param config_data A pointer to configuration data which can be
1866 * retrieved with
1867 * mbedtls_ssl_conf_get_async_config_data(). The
1868 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001869 */
1870void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
1871 mbedtls_ssl_async_sign_t *f_async_sign,
1872 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
1873 mbedtls_ssl_async_resume_t *f_async_resume,
1874 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001875 void *config_data );
1876
1877/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02001878 * \brief Retrieve the configuration data set by
1879 * mbedtls_ssl_conf_async_private_cb().
1880 *
1881 * \param conf SSL configuration context
1882 * \return The configuration data set by
1883 * mbedtls_ssl_conf_async_private_cb().
1884 */
1885void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
1886
1887/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001888 * \brief Retrieve the asynchronous operation user context.
1889 *
1890 * \note This function may only be called while a handshake
1891 * is in progress.
1892 *
1893 * \param ssl The SSL context to access.
1894 *
1895 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02001896 * set during the current handshake. If
1897 * mbedtls_ssl_set_async_operation_data() has not yet been
1898 * called during the current handshake, this function returns
1899 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001900 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001901void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001902
1903/**
1904 * \brief Retrieve the asynchronous operation user context.
1905 *
1906 * \note This function may only be called while a handshake
1907 * is in progress.
1908 *
1909 * \param ssl The SSL context to access.
1910 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02001911 * Call mbedtls_ssl_get_async_operation_data() later during the
1912 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001913 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001914void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001915 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001916#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001917
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001918/**
1919 * \brief Callback type: generate a cookie
1920 *
1921 * \param ctx Context for the callback
1922 * \param p Buffer to write to,
1923 * must be updated to point right after the cookie
1924 * \param end Pointer to one past the end of the output buffer
1925 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001926 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001927 * \param ilen Length of info in bytes
1928 *
1929 * \return The callback must return 0 on success,
1930 * or a negative error code.
1931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001933 unsigned char **p, unsigned char *end,
1934 const unsigned char *info, size_t ilen );
1935
1936/**
1937 * \brief Callback type: verify a cookie
1938 *
1939 * \param ctx Context for the callback
1940 * \param cookie Cookie to verify
1941 * \param clen Length of cookie
1942 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001943 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001944 * \param ilen Length of info in bytes
1945 *
1946 * \return The callback must return 0 if cookie is valid,
1947 * or a negative error code.
1948 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001949typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001950 const unsigned char *cookie, size_t clen,
1951 const unsigned char *info, size_t ilen );
1952
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001953#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001954/**
1955 * \brief Register callbacks for DTLS cookies
1956 * (Server only. DTLS only.)
1957 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001958 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001959 * register working callbacks (and initialize their context).
1960 *
1961 * To disable HelloVerifyRequest, register NULL callbacks.
1962 *
1963 * \warning Disabling hello verification allows your server to be used
1964 * for amplification in DoS attacks against other hosts.
1965 * Only disable if you known this can't happen in your
1966 * particular environment.
1967 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001968 * \note See comments on \c mbedtls_ssl_handshake() about handling
1969 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1970 * on the first handshake attempt when this is enabled.
1971 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02001972 * \note This is also necessary to handle client reconnection from
1973 * the same port as described in RFC 6347 section 4.2.8 (only
1974 * the variant with cookies is supported currently). See
1975 * comments on \c mbedtls_ssl_read() for details.
1976 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001977 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001978 * \param f_cookie_write Cookie write callback
1979 * \param f_cookie_check Cookie check callback
1980 * \param p_cookie Context for both callbacks
1981 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001982void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 mbedtls_ssl_cookie_write_t *f_cookie_write,
1984 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001985 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001986
1987/**
1988 * \brief Set client's transport-level identification info.
1989 * (Server only. DTLS only.)
1990 *
1991 * This is usually the IP address (and port), but could be
1992 * anything identify the client depending on the underlying
1993 * network stack. Used for HelloVerifyRequest with DTLS.
1994 * This is *not* used to route the actual packets.
1995 *
1996 * \param ssl SSL context
1997 * \param info Transport-level info identifying the client (eg IP + port)
1998 * \param ilen Length of info in bytes
1999 *
2000 * \note An internal copy is made, so the info buffer can be reused.
2001 *
2002 * \return 0 on success,
2003 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002004 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002005 */
2006int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2007 const unsigned char *info,
2008 size_t ilen );
2009
2010#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002011
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002013/**
2014 * \brief Enable or disable anti-replay protection for DTLS.
2015 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002016 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002017 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002018 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002019 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002020 *
2021 * \warning Disabling this is a security risk unless the application
2022 * protocol handles duplicated packets in a safe way. You
2023 * should not disable this without careful consideration.
2024 * However, if your application already detects duplicated
2025 * packets and needs information about them to adjust its
2026 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002027 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002028void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002030
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002031#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002032/**
2033 * \brief Set a limit on the number of records with a bad MAC
2034 * before terminating the connection.
2035 * (DTLS only, no effect on TLS.)
2036 * Default: 0 (disabled).
2037 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002038 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002039 * \param limit Limit, or 0 to disable.
2040 *
2041 * \note If the limit is N, then the connection is terminated when
2042 * the Nth non-authentic record is seen.
2043 *
2044 * \note Records with an invalid header are not counted, only the
2045 * ones going through the authentication-decryption phase.
2046 *
2047 * \note This is a security trade-off related to the fact that it's
2048 * often relatively easy for an active attacker ot inject UDP
2049 * datagrams. On one hand, setting a low limit here makes it
2050 * easier for such an attacker to forcibly terminated a
2051 * connection. On the other hand, a high limit or no limit
2052 * might make us waste resources checking authentication on
2053 * many bogus packets.
2054 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002055void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002057
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002059
2060/**
2061 * \brief Allow or disallow packing of multiple handshake records
2062 * within a single datagram.
2063 *
2064 * \param ssl The SSL context to configure.
2065 * \param allow_packing This determines whether datagram packing may
2066 * be used or not. A value of \c 0 means that every
2067 * record will be sent in a separate datagram; a
2068 * value of \c 1 means that, if space permits,
2069 * multiple handshake messages (including CCS) belonging to
2070 * a single flight may be packed within a single datagram.
2071 *
2072 * \note This is enabled by default and should only be disabled
2073 * for test purposes, or if datagram packing causes
2074 * interoperability issues with peers that don't support it.
2075 *
2076 * \note Allowing datagram packing reduces the network load since
2077 * there's less overhead if multiple messages share the same
2078 * datagram. Also, it increases the handshake efficiency
2079 * since messages belonging to a single datagram will not
2080 * be reordered in transit, and so future message buffering
2081 * or flight retransmission (if no buffering is used) as
2082 * means to deal with reordering are needed less frequently.
2083 *
Hanno Beckereb570082018-08-24 11:28:35 +01002084 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002085 * are currently always sent in separate datagrams.
2086 *
2087 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002088void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2089 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002090
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002091/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002092 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002093 * (DTLS only, no effect on TLS.)
2094 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002095 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002096 * \param min Initial timeout value in milliseconds.
2097 * Default: 1000 (1 second).
2098 * \param max Maximum timeout value in milliseconds.
2099 * Default: 60000 (60 seconds).
2100 *
2101 * \note Default values are from RFC 6347 section 4.2.4.1.
2102 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002103 * \note The 'min' value should typically be slightly above the
2104 * expected round-trip time to your peer, plus whatever time
2105 * it takes for the peer to process the message. For example,
2106 * if your RTT is about 600ms and you peer needs up to 1s to
2107 * do the cryptographic operations in the handshake, then you
2108 * should set 'min' slightly above 1600. Lower values of 'min'
2109 * might cause spurious resends which waste network resources,
2110 * while larger value of 'min' will increase overall latency
2111 * on unreliable network links.
2112 *
2113 * \note The more unreliable your network connection is, the larger
2114 * your max / min ratio needs to be in order to achieve
2115 * reliable handshakes.
2116 *
2117 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2118 * For example, if min = 1s and max = 5s, the retransmit plan
2119 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2120 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002121 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002122void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002123#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002124
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002125#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002126/**
Paul Bakker0a597072012-09-25 21:55:46 +00002127 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002128 * If not set, no session resuming is done (except if session
2129 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002130 *
Paul Bakker0a597072012-09-25 21:55:46 +00002131 * The session cache has the responsibility to check for stale
2132 * entries based on timeout. See RFC 5246 for recommendations.
2133 *
2134 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2135 * connection shutdown, so do not cache the pointer! Either set
2136 * it to NULL or make a full copy of the certificate.
2137 *
2138 * The get callback is called once during the initial handshake
2139 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002141 * If a valid entry is found, it should fill the master of
2142 * the session object with the cached values and return 0,
2143 * return 1 otherwise. Optionally peer_cert can be set as well
2144 * if it is properly present in cache entry.
2145 *
2146 * The set callback is called once during the initial handshake
2147 * to enable session resuming after the entire handshake has
2148 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002150 * should create a cache entry for future retrieval based on
2151 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002153 * data) is cleared by the SSL/TLS layer when the connection is
2154 * terminated. It is recommended to add metadata to determine if
2155 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002156 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002157 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002158 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002159 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002160 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002161 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002162 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002163void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002164 void *p_cache,
2165 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2166 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002170/**
Paul Bakker0a597072012-09-25 21:55:46 +00002171 * \brief Request resumption of session (client-side only)
2172 * Session data is copied from presented session structure.
2173 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002174 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002175 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002176 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002177 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002178 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002179 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002180 * arguments are otherwise invalid
2181 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002184int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2185#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002186
2187/**
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002188 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002189 * On client, this can be used for loading saved sessions
2190 * before resuming them with mbedstls_ssl_set_session().
2191 * On server, this can be used for alternative implementations
2192 * of session cache or session tickets.
2193 *
2194 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002195 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002196 * end-entity certificate and the result of the chain
2197 * verification (unless verification was disabled), but not
2198 * the rest of the chain.
2199 *
2200 * \see mbedtls_ssl_session_save()
2201 * \see mbedtls_ssl_set_session()
2202 *
2203 * \param session The session structure to be populated. It must have been
2204 * initialised with mbedtls_ssl_session_init() but not
2205 * populated yet.
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002206 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002207 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002208 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002209 *
2210 * \return \c 0 if successful.
2211 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2212 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Becker5dbcc9f2019-06-03 12:58:39 +01002213 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2214 * was generated in a different version or configuration of
2215 * Mbed TLS.
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002216 * \return Another negative value for other kinds of errors (for
2217 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002218 */
2219int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2220 const unsigned char *buf,
2221 size_t len );
2222
2223/**
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002224 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002225 * On client, this can be used for saving session data,
2226 * potentially in non-volatile storage, for resuming later.
2227 * On server, this can be used for alternative implementations
2228 * of session cache or session tickets.
2229 *
2230 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002231 * \see mbedtls_ssl_get_session_pointer()
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002232 *
2233 * \param session The session structure to be saved.
2234 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard32ce5962019-05-21 11:01:32 +02002235 * writeable buffer of at least \p len bytes, or may be \c
2236 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002237 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard32ce5962019-05-21 11:01:32 +02002238 * \param olen The size in bytes of the data that has been or would have
2239 * been written. It must point to a valid \c size_t.
2240 *
2241 * \note \p olen is updated to the correct value regardless of
2242 * whether \p buf_len was large enough. This makes it possible
2243 * to determine the necessary size by calling this function
2244 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard2843fe12019-05-15 16:13:59 +02002245 *
2246 * \return \c 0 if successful.
2247 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2248 */
2249int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2250 unsigned char *buf,
2251 size_t buf_len,
2252 size_t *olen );
2253
2254/**
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002255 * \brief Get a pointer to the current session structure, for example
Manuel Pégourié-Gonnard35ccdbb2019-06-03 09:55:16 +02002256 * to serialize it.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002257 *
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002258 * \warning Ownership of the session remains with the SSL context, and
2259 * the returned pointer is only guaranteed to be valid until
2260 * the next API call operating on the same \p ssl context.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002261 *
2262 * \see mbedtls_ssl_session_save()
2263 *
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002264 * \param ssl The SSL context.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002265 *
Manuel Pégourié-Gonnarde0cd1d02019-05-27 09:58:07 +02002266 * \return A pointer to the current session if successful.
2267 * \return \c NULL if no session is active.
Manuel Pégourié-Gonnard37a53242019-05-20 11:12:28 +02002268 */
2269const mbedtls_ssl_session *mbedtls_ssl_get_session_pointer( const mbedtls_ssl_context *ssl );
2270
2271/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002272 * \brief Set the list of allowed ciphersuites and the preference
2273 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002274 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002276 * The ciphersuites array is not copied, and must remain
2277 * valid for the lifetime of the ssl_config.
2278 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002279 * Note: The server uses its own preferences
2280 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002282 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002283 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002284 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002285 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002286void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002287 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002288
Hanno Beckera5a2b082019-05-15 14:03:01 +01002289#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckera69b4312019-05-14 11:44:35 +01002290#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2291#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckereec2be92019-05-03 13:06:44 +01002292/**
Hanno Becker948d2d52019-05-23 16:55:50 +01002293 * \brief Specify the length of Connection IDs for incoming
2294 * encrypted DTLS records, as well as the behaviour
2295 * on unexpected CIDs.
Hanno Beckere8eff9a2019-05-14 11:30:10 +01002296 *
2297 * By default, the CID length is set to \c 0,
2298 * and unexpected CIDs are silently ignored.
Hanno Beckereec2be92019-05-03 13:06:44 +01002299 *
2300 * \param conf The SSL configuration to modify.
2301 * \param len The length in Bytes of the CID fields in encrypted
2302 * DTLS records using the CID mechanism. This must
2303 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker2f8c8042019-05-20 10:19:56 +01002304 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Beckere8eff9a2019-05-14 11:30:10 +01002305 * receiving a record with an unexpected CID.
2306 * Possible values are:
2307 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2308 * In this case, the record is silently ignored.
2309 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2310 * In this case, the stack fails with the specific
2311 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckereec2be92019-05-03 13:06:44 +01002312 *
Hanno Becker241947d2019-05-13 15:26:11 +01002313 * \note The CID specification allows implementations to either
2314 * use a common length for all incoming connection IDs or
2315 * allow variable-length incoming IDs. Mbed TLS currently
2316 * requires a common length for all connections sharing the
2317 * same SSL configuration; this allows simpler parsing of
2318 * record headers.
Hanno Beckereec2be92019-05-03 13:06:44 +01002319 *
2320 * \return \c 0 on success.
2321 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2322 * is too large.
2323 */
Hanno Beckere8eff9a2019-05-14 11:30:10 +01002324int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2325 int ignore_other_cids );
Hanno Beckera5a2b082019-05-15 14:03:01 +01002326#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckereec2be92019-05-03 13:06:44 +01002327
Paul Bakker5121ce52009-01-03 21:22:43 +00002328/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002329 * \brief Set the list of allowed ciphersuites and the
2330 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002331 * (Only useful on the server side)
2332 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002333 * The ciphersuites array is not copied, and must remain
2334 * valid for the lifetime of the ssl_config.
2335 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002336 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002337 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002338 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002339 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2341 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2342 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002343 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2345 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002346 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002347void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002348 const int *ciphersuites,
2349 int major, int minor );
2350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002351#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002352/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002353 * \brief Set the X.509 security profile used for verification
2354 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002355 * \note The restrictions are enforced for all certificates in the
2356 * chain. However, signatures in the handshake are not covered
2357 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2358 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002359 * \param conf SSL configuration
2360 * \param profile Profile to use
2361 */
2362void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002363 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002364
2365/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002366 * \brief Set the data required to verify peer certificate
2367 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002368 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002369 * parameters ca_chain (maps to trust_ca for that function)
2370 * and ca_crl.
2371 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002372 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002373 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002374 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002375 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002376void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002377 mbedtls_x509_crt *ca_chain,
2378 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002379
2380/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002381 * \brief Set own certificate chain and private key
2382 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002383 * \note own_cert should contain in order from the bottom up your
2384 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002385 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002386 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002387 * \note On server, this function can be called multiple times to
2388 * provision more than one cert/key pair (eg one ECDSA, one
2389 * RSA with SHA-256, one RSA with SHA-1). An adequate
2390 * certificate will be selected according to the client's
2391 * advertised capabilities. In case mutliple certificates are
2392 * adequate, preference is given to the one set by the first
2393 * call to this function, then second, etc.
2394 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002395 * \note On client, only the first call has any effect. That is,
2396 * only one client certificate can be provisioned. The
2397 * server's preferences in its CertficateRequest message will
2398 * be ignored and our only cert will be sent regardless of
2399 * whether it matches those preferences - the server can then
2400 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002401 *
Manuel Pégourié-Gonnardd8e3a1e2018-10-25 13:24:21 +02002402 * \note The provided \p pk_key needs to match the public key in the
2403 * first certificate in \p own_cert, or all handshakes using
2404 * that certificate will fail. It is your responsibility
2405 * to ensure that; this function will not perform any check.
2406 * You may use mbedtls_pk_check_pair() in order to perform
2407 * this check yourself, but be aware that this function can
2408 * be computationally expensive on some key types.
2409 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002410 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002411 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002412 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002413 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002414 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002415 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002416int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002417 mbedtls_x509_crt *own_cert,
2418 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002420
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002422/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002423 * \brief Set the Pre Shared Key (PSK) and the expected identity name
2424 *
2425 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002426 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002427 *
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002428 * \note Currently clients can only register one pre-shared key.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002429 * In other words, the servers' identity hint is ignored.
2430 * Support for setting multiple PSKs on clients and selecting
2431 * one based on the identity hint is not a planned feature but
2432 * feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002433 *
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01002434 * \param conf SSL configuration
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002435 * \param psk pointer to the pre-shared key
2436 * \param psk_len pre-shared key length
2437 * \param psk_identity pointer to the pre-shared key identity
2438 * \param psk_identity_len identity key length
Paul Bakker6db455e2013-09-18 17:29:31 +02002439 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002440 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002441 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002442int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002443 const unsigned char *psk, size_t psk_len,
2444 const unsigned char *psk_identity, size_t psk_identity_len );
2445
Paul Bakker6db455e2013-09-18 17:29:31 +02002446
2447/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002448 * \brief Set the Pre Shared Key (PSK) for the current handshake
2449 *
2450 * \note This should only be called inside the PSK callback,
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002451 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002452 *
2453 * \param ssl SSL context
2454 * \param psk pointer to the pre-shared key
2455 * \param psk_len pre-shared key length
2456 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002457 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002458 */
2459int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2460 const unsigned char *psk, size_t psk_len );
2461
2462/**
2463 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002464 *
2465 * If set, the PSK callback is called for each
2466 * handshake where a PSK ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002467 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002468 * receive the actual PSK data and length.
2469 *
2470 * The callback has the following parameters: (void *parameter,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002471 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
Paul Bakker6db455e2013-09-18 17:29:31 +02002472 * size_t identity_len)
2473 * If a valid PSK identity is found, the callback should use
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002474 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
2475 * correct PSK and return 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002476 * Any other return value will result in a denied PSK identity.
2477 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002478 * \note If you set a PSK callback using this function, then you
2479 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002480 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002481 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002482 * \param conf SSL configuration
Paul Bakker6db455e2013-09-18 17:29:31 +02002483 * \param f_psk PSK identity function
2484 * \param p_psk PSK identity parameter
2485 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002486void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002487 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002488 size_t),
2489 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002490#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002491
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002492#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002493
2494#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2495
2496#if defined(MBEDTLS_DEPRECATED_WARNING)
2497#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2498#else
2499#define MBEDTLS_DEPRECATED
2500#endif
2501
Paul Bakker5121ce52009-01-03 21:22:43 +00002502/**
2503 * \brief Set the Diffie-Hellman public P and G values,
2504 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002505 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002506 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002507 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002508 * \param dhm_P Diffie-Hellman-Merkle modulus
2509 * \param dhm_G Diffie-Hellman-Merkle generator
2510 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002511 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2512 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002513 * \return 0 if successful
2514 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002515MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2516 const char *dhm_P,
2517 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00002518
Hanno Becker470a8c42017-10-04 15:28:46 +01002519#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01002520
2521/**
2522 * \brief Set the Diffie-Hellman public P and G values
2523 * from big-endian binary presentations.
2524 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2525 *
2526 * \param conf SSL configuration
2527 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2528 * \param P_len Length of DHM modulus
2529 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2530 * \param G_len Length of DHM generator
2531 *
2532 * \return 0 if successful
2533 */
2534int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2535 const unsigned char *dhm_P, size_t P_len,
2536 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002537
2538/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002539 * \brief Set the Diffie-Hellman public P and G values,
2540 * read from existing context (server-side only)
2541 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002542 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002543 * \param dhm_ctx Diffie-Hellman-Merkle context
2544 *
2545 * \return 0 if successful
2546 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002547int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002548#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002549
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002550#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2551/**
2552 * \brief Set the minimum length for Diffie-Hellman parameters.
2553 * (Client-side only.)
2554 * (Default: 1024 bits.)
2555 *
2556 * \param conf SSL configuration
2557 * \param bitlen Minimum bit length of the DHM prime
2558 */
2559void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2560 unsigned int bitlen );
2561#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2562
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002563#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002564/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002565 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002566 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002567 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002568 * On server: this only affects selection of the ECDHE curve;
2569 * the curves used for ECDH and ECDSA are determined by the
2570 * list of available certificates instead.
2571 *
2572 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002573 * use. The server can override our preference order.
2574 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002575 * Both sides: limits the set of curves accepted for use in
2576 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002577 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002578 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002579 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002580 * for that. For the end-entity certificate however, the key
2581 * will be accepted only if it is allowed both by this list
2582 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002583 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002584 * \note This list should be ordered by decreasing preference
2585 * (preferred curve first).
2586 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002587 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002588 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002590 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002591void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2592 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002593#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002594
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002595#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002596/**
2597 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002598 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002599 *
2600 * \note This only affects which hashes are offered and can be used
2601 * for signatures during the handshake. Hashes for message
2602 * authentication and the TLS PRF are controlled by the
2603 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2604 * used for certificate signature are controlled by the
2605 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2606 *
2607 * \note This list should be ordered by decreasing preference
2608 * (preferred hash first).
2609 *
2610 * \param conf SSL configuration
2611 * \param hashes Ordered list of allowed signature hashes,
2612 * terminated by \c MBEDTLS_MD_NONE.
2613 */
2614void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2615 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002616#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002617
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002618#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002619/**
Darryl Green11999bb2018-03-13 15:22:58 +00002620 * \brief Set or reset the hostname to check against the received
2621 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002622 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002623 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002624 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002625 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002626
Hanno Becker0446a392017-04-07 12:59:32 +01002627 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002628 *
Darryl Green11999bb2018-03-13 15:22:58 +00002629 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2630 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002631 * too long input hostname.
2632 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002633 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002634 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002635 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002637int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002638#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002639
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002640#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002641/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002642 * \brief Set own certificate and key for the current handshake
2643 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002644 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002645 * the SNI callback.
2646 *
2647 * \param ssl SSL context
2648 * \param own_cert own public certificate chain
2649 * \param pk_key own private key
2650 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002651 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002652 */
2653int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2654 mbedtls_x509_crt *own_cert,
2655 mbedtls_pk_context *pk_key );
2656
2657/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002658 * \brief Set the data required to verify peer certificate for the
2659 * current handshake
2660 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002661 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002662 * the SNI callback.
2663 *
2664 * \param ssl SSL context
2665 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
2666 * \param ca_crl trusted CA CRLs
2667 */
2668void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2669 mbedtls_x509_crt *ca_chain,
2670 mbedtls_x509_crl *ca_crl );
2671
2672/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002673 * \brief Set authmode for the current handshake.
2674 *
2675 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
2676 * the SNI callback.
2677 *
2678 * \param ssl SSL context
2679 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
2680 * MBEDTLS_SSL_VERIFY_REQUIRED
2681 */
2682void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2683 int authmode );
2684
2685/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00002686 * \brief Set server side ServerName TLS extension callback
2687 * (optional, server-side only).
2688 *
2689 * If set, the ServerName callback is called whenever the
2690 * server receives a ServerName TLS extension from the client
2691 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002692 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002693 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002694 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002695 * certificate(s) and key(s) to use with \c
2696 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002697 * and may optionally adjust the CA and associated CRL with \c
2698 * mbedtls_ssl_set_hs_ca_chain() as well as the client
2699 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
2700 * then must return 0. If no matching name is found, the
2701 * callback must either set a default cert, or
2702 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00002703 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002704 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00002705 * \param f_sni verification function
2706 * \param p_sni verification parameter
2707 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002708void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002709 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002710 size_t),
2711 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002712#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002713
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002714#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002715/**
2716 * \brief Set the EC J-PAKE password for current handshake.
2717 *
2718 * \note An internal copy is made, and destroyed as soon as the
2719 * handshake is completed, or when the SSL context is reset or
2720 * freed.
2721 *
2722 * \note The SSL context needs to be already set up. The right place
2723 * to call this function is between \c mbedtls_ssl_setup() or
2724 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
2725 *
2726 * \param ssl SSL context
2727 * \param pw EC J-PAKE password (pre-shared secret)
2728 * \param pw_len length of pw in bytes
2729 *
2730 * \return 0 on success, or a negative error code.
2731 */
2732int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2733 const unsigned char *pw,
2734 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002735#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002736
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002738/**
2739 * \brief Set the supported Application Layer Protocols.
2740 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002741 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00002742 * \param protos Pointer to a NULL-terminated list of supported protocols,
2743 * in decreasing preference order. The pointer to the list is
2744 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00002745 * the lifetime of the table must be atleast as long as the
2746 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002747 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002748 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002749 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002750int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002751
2752/**
2753 * \brief Get the name of the negotiated Application Layer Protocol.
2754 * This function should be called after the handshake is
2755 * completed.
2756 *
2757 * \param ssl SSL context
2758 *
2759 * \return Protcol name, or NULL if no protocol was negotiated.
2760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
2762#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002763
Paul Bakker5701cdc2012-09-27 21:49:42 +00002764/**
Paul Bakker490ecc82011-10-06 13:04:09 +00002765 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02002766 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002767 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02002768 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002769 * \note This ignores ciphersuites from higher versions.
2770 *
2771 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2772 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002773 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002774 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002775 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2776 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2777 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2778 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00002779 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002780void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002781
Paul Bakker1d29fb52012-09-28 13:28:45 +00002782/**
2783 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002784 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002785 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002786 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2787 * SSL_MIN_XXXXX_VERSION range is ignored.
2788 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002789 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002790 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002791 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2792 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2793 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002794 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002795 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2796 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2797 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2798 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002799 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002800void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002803/**
2804 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002806 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002807 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002808 * connection, that is a connection with max_version set to a
2809 * lower value than the value you're willing to use. Such
2810 * fallback connections are not recommended but are sometimes
2811 * necessary to interoperate with buggy (version-intolerant)
2812 * servers.
2813 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002814 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002815 * non-fallback connections! This would appear to work for a
2816 * while, then cause failures when the server is upgraded to
2817 * support a newer TLS version.
2818 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002819 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002820 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002821 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002822void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002823#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002824
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002825#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002826/**
2827 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002828 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002829 *
2830 * \note This should always be enabled, it is a security
2831 * improvement, and should not cause any interoperability
2832 * issue (used only if the peer supports it too).
2833 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002834 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002835 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002836 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002837void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002838#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002839
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002841/**
2842 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002843 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002844 *
2845 * \note This should always be enabled, it is a security fix to the
2846 * protocol, and should not cause any interoperability issue
2847 * (used only if the peer supports it too).
2848 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002849 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002850 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002851 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002852void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03002853
2854/**
2855 * \brief Enable or disable Extended Master Secret enforcing.
Jarno Lamsa18b9a492019-06-10 15:23:29 +03002856 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED)
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03002857 *
Jarno Lamsa20095af2019-06-11 17:16:58 +03002858 * \note If the use of extended master secret is configured (see
2859 * `mbedtls_ssl_conf_extended_master_secret()`) and this
2860 * option is set, handshakes not leading to the use of the
2861 * extended master secret will be aborted: On the server, fail
2862 * the handshake if the client doesn't advertise the
2863 * ExtendedMasterSecret extension. On the client: Fail the
2864 * handshake if the server doesn't consent to the use of the
2865 * ExtendedMasterSecret extension in its ServerHello.
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03002866 *
Jarno Lamsa20095af2019-06-11 17:16:58 +03002867 * \param conf Currently used SSL configuration struct.
Jarno Lamsa95f752e2019-06-10 10:15:49 +03002868 * \param ems_enf MBEDTLS_SSL_EXTENDED_MS_ENFORCE_ENABLED or
Jarno Lamsad9382f82019-06-10 10:27:14 +03002869 * MBEDTLS_SSL_EXTENDED_MS_ENFORCE_DISABLED
Jarno Lamsa7a5e2be2019-06-10 10:13:03 +03002870 */
2871void mbedtls_ssl_conf_extended_master_secret_enforce( mbedtls_ssl_config *conf,
Jarno Lamsa20095af2019-06-11 17:16:58 +03002872 char ems_enf );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002873#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002874
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002875#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002876/**
2877 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002879 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002880 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002881 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002882 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00002883 * \note This function is deprecated and will likely be removed in
2884 * a future version of the library.
2885 * RC4 is disabled by default at compile time and needs to be
2886 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002887 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002888 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002889 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002890 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002891void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002892#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002893
Janos Follath088ce432017-04-10 12:42:31 +01002894#if defined(MBEDTLS_SSL_SRV_C)
2895/**
2896 * \brief Whether to send a list of acceptable CAs in
2897 * CertificateRequest messages.
2898 * (Default: do send)
2899 *
2900 * \param conf SSL configuration
2901 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
2902 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
2903 */
2904void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2905 char cert_req_ca_list );
2906#endif /* MBEDTLS_SSL_SRV_C */
2907
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00002909/**
k-stachowiakd7077832019-04-29 11:15:43 +02002910 * \brief Set the maximum fragment length to emit and/or negotiate.
2911 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
2912 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002913 * (Server: set maximum fragment length to emit,
k-stachowiakd7077832019-04-29 11:15:43 +02002914 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002915 * (Client: set maximum fragment length to emit *and*
2916 * negotiate with the server during handshake)
k-stachowiakd7077832019-04-29 11:15:43 +02002917 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002918 *
k-stachowiakd7077832019-04-29 11:15:43 +02002919 * \note On the client side, the maximum fragment length extension
2920 * *will not* be used, unless the maximum fragment length has
2921 * been set via this function to a value different than
2922 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002923 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02002924 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002925 * excluding record overhead that will be added to it, see
2926 * \c mbedtls_ssl_get_record_expansion().
2927 *
k-stachowiakd7077832019-04-29 11:15:43 +02002928 * \note With TLS, this currently only affects ApplicationData (sent
2929 * with \c mbedtls_ssl_read()), not handshake messages.
2930 * With DTLS, this affects both ApplicationData and handshake.
2931 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002932 * \note For DTLS, it is also possible to set a limit for the total
2933 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002934 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002935 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002936 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002937 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002938 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2939 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002940 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002941 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002942 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002943int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002945
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002946#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002947/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01002948 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01002949 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002950 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002951 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002952 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2953 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002954 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002955void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002956#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002958#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002959/**
2960 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002962 *
2963 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2964 * Does not affect non-CBC ciphersuites in any version.
2965 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01002966 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002967 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2968 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002969 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002970void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002972
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002973#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002974/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002975 * \brief Enable / Disable session tickets (client only).
2976 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002977 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002978 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002979 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002980 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002981 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2982 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002983 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002984void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
2985#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002986
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002988/**
Paul Bakker09f097d2012-10-23 11:54:56 +00002989 * \brief Enable / Disable renegotiation support for connection when
2990 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00002992 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002993 * \warning It is recommended to always disable renegotation unless you
2994 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00002995 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002996 * renegotiation or a poor understanding of its properties.
2997 *
2998 * \note Server-side, enabling renegotiation also makes the server
2999 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003000 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003001 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003002 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3003 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003004 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003005void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003007
3008/**
3009 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003010 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003011 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003013 * be established even if the peer does not support
3014 * secure renegotiation, but does not allow renegotiation
3015 * to take place if not secure.
3016 * (Interoperable and secure option)
3017 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003018 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003019 * with non-upgraded peers. Allowing legacy renegotiation
3020 * makes the connection vulnerable to specific man in the
3021 * middle attacks. (See RFC 5746)
3022 * (Most interoperable and least secure option)
3023 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003024 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003025 * if peer does not support secure renegotiation. Results
3026 * in interoperability issues with non-upgraded peers
3027 * that do not support renegotiation altogether.
3028 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003029 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003030 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003031 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3032 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003033 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003034 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003035void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003037#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003038/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003039 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003040 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003041 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003042 * When we request a renegotiation, the peer can comply or
3043 * ignore the request. This function allows us to decide
3044 * whether to enforce our renegotiation requests by closing
3045 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003046 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003047 * However, records could already be in transit from the peer
3048 * when the request is emitted. In order to increase
3049 * reliability, we can accept a number of records before the
3050 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003051 *
3052 * The optimal value is highly dependent on the specific usage
3053 * scenario.
3054 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003055 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003057 * out or receives Application Data, until:
3058 * - max_records records have beens seen, if it is >= 0, or
3059 * - the number of retransmits that would happen during an
3060 * actual handshake has been reached.
3061 * Please remember the request might be lost a few times
3062 * if you consider setting max_records to a really low value.
3063 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003064 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003066 * which always behave as if max_record was 0. The reason is,
3067 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003069 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003070 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003072 * enforce renegotiation, or a non-negative value to enforce
3073 * it but allow for a grace period of max_records records.
3074 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003075void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003076
3077/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003078 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003079 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003080 *
3081 * Renegotiation is automatically triggered when a record
Hanno Becker8013b272019-05-03 12:55:51 +01003082 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003083 * threshold. The default value is meant to prevent the
3084 * connection from being closed when the counter is about to
3085 * reached its maximal value (it is not allowed to wrap).
3086 *
3087 * Lower values can be used to enforce policies such as "keys
3088 * must be refreshed every N packets with cipher X".
3089 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003090 * The renegotiation period can be disabled by setting
3091 * conf->disable_renegotiation to
3092 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3093 *
3094 * \note When the configured transport is
3095 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3096 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3097 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003098 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003099 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003100 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003101 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003102void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003103 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003105
Paul Bakker43ca69c2011-01-15 17:35:19 +00003106/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003107 * \brief Check if there is data already read from the
3108 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003109 *
3110 * \param ssl SSL context
3111 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003112 * \return 0 if nothing's pending, 1 otherwise.
3113 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003114 * \note This is different in purpose and behaviour from
3115 * \c mbedtls_ssl_get_bytes_avail in that it considers
3116 * any kind of unprocessed data, not only unread
3117 * application data. If \c mbedtls_ssl_get_bytes
3118 * returns a non-zero value, this function will
3119 * also signal pending data, but the converse does
3120 * not hold. For example, in DTLS there might be
3121 * further records waiting to be processed from
3122 * the current underlying transport's datagram.
3123 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003124 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003125 * does not imply that a subsequent call to
3126 * \c mbedtls_ssl_read will provide any data;
3127 * e.g., the unprocessed data might turn out
3128 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003129 *
3130 * \note This function is useful in the following situation:
3131 * If the SSL/TLS module successfully returns from an
3132 * operation - e.g. a handshake or an application record
3133 * read - and you're awaiting incoming data next, you
3134 * must not immediately idle on the underlying transport
3135 * to have data ready, but you need to check the value
3136 * of this function first. The reason is that the desired
3137 * data might already be read but not yet processed.
3138 * If, in contrast, a previous call to the SSL/TLS module
3139 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3140 * to call this function, as the latter error code entails
3141 * that all internal data has been processed.
3142 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003143 */
3144int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3145
3146/**
3147 * \brief Return the number of application data bytes
3148 * remaining to be read from the current record.
3149 *
3150 * \param ssl SSL context
3151 *
3152 * \return How many bytes are available in the application
3153 * data record read buffer.
3154 *
3155 * \note When working over a datagram transport, this is
3156 * useful to detect the current datagram's boundary
3157 * in case \c mbedtls_ssl_read has written the maximal
3158 * amount of data fitting into the input buffer.
3159 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003161size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003162
3163/**
3164 * \brief Return the result of the certificate verification
3165 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003166 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003167 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003168 * \return \c 0 if the certificate verification was successful.
3169 * \return \c -1u if the result is not available. This may happen
3170 * e.g. if the handshake aborts early, or a verification
3171 * callback returned a fatal error.
3172 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3173 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003174 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003175uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003176
3177/**
3178 * \brief Return the name of the current ciphersuite
3179 *
3180 * \param ssl SSL context
3181 *
3182 * \return a string containing the ciphersuite name
3183 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003184const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003185
3186/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00003187 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
3188 *
3189 * \param ssl SSL context
3190 *
3191 * \return a string containing the SSL version
3192 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003193const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003194
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003195/**
3196 * \brief Return the (maximum) number of bytes added by the record
3197 * layer: header + encryption/MAC overhead (inc. padding)
3198 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003199 * \note This function is not available (always returns an error)
3200 * when record compression is enabled.
3201 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003202 * \param ssl SSL context
3203 *
3204 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003205 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02003206 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003208int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003209
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003210#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3211/**
3212 * \brief Return the maximum fragment length (payload, in bytes).
3213 * This is the value negotiated with peer if any,
3214 * or the locally configured value.
3215 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003216 * \sa mbedtls_ssl_conf_max_frag_len()
3217 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003218 *
3219 * \param ssl SSL context
3220 *
3221 * \return Current maximum fragment length.
3222 */
3223size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
3224#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3225
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003226/**
3227 * \brief Return the current maximum outgoing record payload in bytes.
3228 * This takes into account the config.h setting \c
3229 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3230 * max fragment length extension if used, and for DTLS the
3231 * path MTU as configured and current record expansion.
3232 *
3233 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3234 * called with a larger length value.
3235 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3236 * necessary and return the number of bytes written; it is up
3237 * to the caller to call \c mbedtls_ssl_write() again in
3238 * order to send the remaining bytes if any.
3239 *
3240 * \note This function is not available (always returns an error)
3241 * when record compression is enabled.
3242 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003243 * \sa mbedtls_ssl_set_mtu()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003244 * \sa mbedtls_ssl_get_max_frag_len()
3245 * \sa mbedtls_ssl_get_record_expansion()
3246 *
3247 * \param ssl SSL context
3248 *
3249 * \return Current maximum payload for an outgoing record,
3250 * or a negative error code.
3251 */
3252int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003255/**
Hanno Becker869144b2019-02-05 11:33:12 +00003256 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003257 *
Hanno Becker869144b2019-02-05 11:33:12 +00003258 * For ciphersuites not using certificate-based peer
3259 * authentication (such as PSK-based ciphersuites), no
3260 * peer certificate is available, and this function returns
3261 * \c NULL.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003262 *
Hanno Becker869144b2019-02-05 11:33:12 +00003263 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003264 *
Hanno Becker869144b2019-02-05 11:33:12 +00003265 * \return The current peer certificate, or \c NULL if
Hanno Beckerb90f6552019-02-05 17:04:00 +00003266 * none is available, which might be because the chosen
3267 * ciphersuite does not use peer certificates, or because
3268 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled.
3269 * If this functions does not return \c NULL, the returned
3270 * certificate is owned by the SSL context and valid only
3271 * until the next call to the SSL API.
Hanno Becker869144b2019-02-05 11:33:12 +00003272 *
3273 * \note For one-time inspection of the peer's certificate during
3274 * the handshake, consider registering an X.509 CRT verification
3275 * callback through mbedtls_ssl_conf_verify() instead of calling
3276 * this function. Using mbedtls_ssl_conf_verify() also comes at
3277 * the benefit of allowing you to influence the verification
3278 * process, for example by masking expected and tolerated
3279 * verification failures.
3280 *
3281 * \warning You must not use the pointer returned by this function
3282 * after any further call to the SSL API, including
3283 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3284 * because the pointer might change during renegotiation,
3285 * which happens transparently to the user.
3286 * If you want to use the certificate across API calls,
3287 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003288 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3290#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003292#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003293/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003294 * \brief Save session in order to resume it later (client-side only)
3295 * Session data is copied to presented session structure.
3296 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003297 *
3298 * \param ssl SSL context
3299 * \param session session context
3300 *
3301 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003302 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003303 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003304 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003305 *
Ron Eldor00115032018-07-17 11:21:50 +03003306 * \note Only the server certificate is copied, and not the full chain,
3307 * so you should not attempt to validate the certificate again
3308 * by calling \c mbedtls_x509_crt_verify() on it.
3309 * Instead, you should use the results from the verification
3310 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3311 * after loading the session again into a new SSL context
3312 * using \c mbedtls_ssl_set_session().
3313 *
3314 * \note Once the session object is not needed anymore, you should
3315 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003316 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3320#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003321
3322/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003323 * \brief Perform the SSL handshake
3324 *
3325 * \param ssl SSL context
3326 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003327 * \return \c 0 if successful.
3328 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003329 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003330 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003331 * transport - in this case you must call this function again
3332 * when the underlying transport is ready for the operation.
3333 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3334 * operation is in progress (see
3335 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3336 * must call this function again when the operation is ready.
3337 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3338 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3339 * in this case you must call this function again to complete
3340 * the handshake when you're done attending other tasks.
3341 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3342 * and the client did not demonstrate reachability yet - in
3343 * this case you must stop using the context (see below).
3344 * \return Another SSL error code - in this case you must stop using
3345 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003346 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003347 * \warning If this function returns something other than
3348 * \c 0,
3349 * #MBEDTLS_ERR_SSL_WANT_READ,
3350 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3351 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3352 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3353 * you must stop using the SSL context for reading or writing,
3354 * and either free it or call \c mbedtls_ssl_session_reset()
3355 * on it before re-using it for a new connection; the current
3356 * connection must be closed.
3357 *
3358 * \note If DTLS is in use, then you may choose to handle
3359 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3360 * purposes, as it is an expected return value rather than an
3361 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003362 *
3363 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003364 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003365 * from the underlying transport layer is currently being processed,
3366 * and it is safe to idle until the timer or the underlying transport
3367 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003368 * in which case the datagram of the underlying transport that is
3369 * currently being processed might or might not contain further
3370 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003373
3374/**
Paul Bakker1961b702013-01-25 14:49:24 +01003375 * \brief Perform a single step of the SSL handshake
3376 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003377 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003378 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003379 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003380 *
3381 * \param ssl SSL context
3382 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003383 * \return See mbedtls_ssl_handshake().
3384 *
3385 * \warning If this function returns something other than \c 0,
3386 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3387 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3388 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3389 * the SSL context for reading or writing, and either free it
3390 * or call \c mbedtls_ssl_session_reset() on it before
3391 * re-using it for a new connection; the current connection
3392 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003396#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003397/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003398 * \brief Initiate an SSL renegotiation on the running connection.
3399 * Client: perform the renegotiation right now.
3400 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003401 * during the next call to mbedtls_ssl_read() if honored by
3402 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003403 *
3404 * \param ssl SSL context
3405 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003406 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003407 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3408 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003409 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003410 * \warning If this function returns something other than \c 0,
3411 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3412 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3413 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3414 * the SSL context for reading or writing, and either free it
3415 * or call \c mbedtls_ssl_session_reset() on it before
3416 * re-using it for a new connection; the current connection
3417 * must be closed.
3418 *
Paul Bakker48916f92012-09-16 19:57:18 +00003419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3421#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003422
3423/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003424 * \brief Read at most 'len' application data bytes
3425 *
3426 * \param ssl SSL context
3427 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003428 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003429 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003430 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003431 * \return \c 0 if the read end of the underlying transport was closed
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003432 * - in this case you must stop using the context (see below).
3433 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003434 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003435 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003436 * transport - in this case you must call this function again
3437 * when the underlying transport is ready for the operation.
3438 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3439 * operation is in progress (see
3440 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3441 * must call this function again when the operation is ready.
3442 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3443 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3444 * in this case you must call this function again to complete
3445 * the handshake when you're done attending other tasks.
3446 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3447 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003448 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003449 * \return Another SSL error code - in this case you must stop using
3450 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003451 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003452 * \warning If this function returns something other than
3453 * a positive value,
3454 * #MBEDTLS_ERR_SSL_WANT_READ,
3455 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3456 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3457 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3458 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3459 * you must stop using the SSL context for reading or writing,
3460 * and either free it or call \c mbedtls_ssl_session_reset()
3461 * on it before re-using it for a new connection; the current
3462 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003463 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003464 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003465 * (which can only happen server-side), it means that a client
3466 * is initiating a new connection using the same source port.
3467 * You can either treat that as a connection close and wait
3468 * for the client to resend a ClientHello, or directly
3469 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003470 * context (as it has been reset internally). Either way, you
3471 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003472 * connection: application state, if any, should be reset, and
3473 * most importantly the identity of the client must be checked
3474 * again. WARNING: not validating the identity of the client
3475 * again, or not transmitting the new identity to the
3476 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003477 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003478 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003479 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003480 * from the underlying transport layer is currently being processed,
3481 * and it is safe to idle until the timer or the underlying transport
3482 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003483 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3484 * initially available on the underlying transport, as this data may have
3485 * been only e.g. duplicated messages or a renegotiation request.
3486 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3487 * when reacting to an incoming-data event from the underlying transport.
3488 * - On success, the datagram of the underlying transport that is currently
3489 * being processed may contain further DTLS records. You should call
3490 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003491 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003492 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003494
3495/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003496 * \brief Try to write exactly 'len' application data bytes
3497 *
3498 * \warning This function will do partial writes in some cases. If the
3499 * return value is non-negative but less than length, the
3500 * function must be called again with updated arguments:
3501 * buf + ret, len - ret (if ret is the return value) until
3502 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003503 *
3504 * \param ssl SSL context
3505 * \param buf buffer holding the data
3506 * \param len how many bytes must be written
3507 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003508 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003509 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003510 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003511 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003512 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003513 * transport - in this case you must call this function again
3514 * when the underlying transport is ready for the operation.
3515 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3516 * operation is in progress (see
3517 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3518 * must call this function again when the operation is ready.
3519 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3520 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3521 * in this case you must call this function again to complete
3522 * the handshake when you're done attending other tasks.
3523 * \return Another SSL error code - in this case you must stop using
3524 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003525 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003526 * \warning If this function returns something other than
3527 * a non-negative value,
3528 * #MBEDTLS_ERR_SSL_WANT_READ,
3529 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3530 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3531 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3532 * you must stop using the SSL context for reading or writing,
3533 * and either free it or call \c mbedtls_ssl_session_reset()
3534 * on it before re-using it for a new connection; the current
3535 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003536 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003537 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003538 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003539 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003540 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003541 * some partial data in the output buffer, however this is not
3542 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003543 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003544 * \note If the requested length is greater than the maximum
3545 * fragment length (either the built-in limit or the one set
3546 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003547 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003548 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003549 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
3550 * active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003551 *
3552 * \note Attempting to write 0 bytes will result in an empty TLS
3553 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003554 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003555int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003556
3557/**
Paul Bakker0a925182012-04-16 06:46:41 +00003558 * \brief Send an alert message
3559 *
3560 * \param ssl SSL context
3561 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003562 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003563 * \param message The alert message (SSL_ALERT_MSG_*)
3564 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003565 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003566 *
3567 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003568 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3569 * the SSL context for reading or writing, and either free it or
3570 * call \c mbedtls_ssl_session_reset() on it before re-using it
3571 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003572 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003574 unsigned char level,
3575 unsigned char message );
3576/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003577 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003578 *
3579 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003580 *
3581 * \return 0 if successful, or a specific SSL error code.
3582 *
3583 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003584 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3585 * the SSL context for reading or writing, and either free it or
3586 * call \c mbedtls_ssl_session_reset() on it before re-using it
3587 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003590
3591/**
Paul Bakker48916f92012-09-16 19:57:18 +00003592 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003593 *
3594 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003597
Paul Bakker48916f92012-09-16 19:57:18 +00003598/**
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003599 * \brief Save an active connection as serialized data in a buffer.
3600 * This allows the freeing or re-using of the SSL context
3601 * while still picking up the connection later in a way that
3602 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003603 *
3604 * \see mbedtls_ssl_context_load()
3605 *
3606 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003607 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003608 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
3609 *
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003610 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003611 * mbedtls_ssl_session_reset() on \p ssl which as a result is
3612 * no longer associated with the connection that has been
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003613 * serialized. This avoids creating copies of the session
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003614 * state. You're then free to either re-use the context
3615 * structure for a different connection, or call
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003616 * mbedtls_ssl_session_free() on it. See the documentation of
3617 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003618 *
3619 * \param ssl The SSL context to save. On success, it is no longer
3620 * associated with the connection that has been serialized.
3621 * \param buf The buffer to write the serialized data to. It must be a
3622 * writeable buffer of at least \p len bytes, or may be \c
3623 * NULL if \p len is \c 0.
3624 * \param buf_len The number of bytes available for writing in \p buf.
3625 * \param olen The size in bytes of the data that has been or would have
3626 * been written. It must point to a valid \c size_t.
3627 *
3628 * \note \p olen is updated to the correct value regardless of
3629 * whether \p buf_len was large enough. This makes it possible
3630 * to determine the necessary size by calling this function
3631 * with \p buf set to \c NULL and \p buf_len to \c 0.
3632 *
3633 * \return \c 0 if successful.
3634 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003635 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003636 * progress, or there is pending data for reading or sending,
3637 * or the connection does not use DTLS 1.2 with and AEAD
3638 * ciphersuite, or renegotiation is enabled.
3639 */
3640int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
3641 unsigned char *buf,
3642 size_t buf_len,
3643 size_t *olen );
3644/**
3645 * \brief Load serialized connection data to an SSL context.
3646 *
3647 * \see mbedtls_ssl_context_save()
3648 *
3649 * \warning The same serialized data must never be loaded into more
3650 * that one context. In order to ensure that, after
3651 * successfully loading serialized data to an SSL context, you
3652 * should immediately destroy or invalidate all copies of the
3653 * serialized data that was loaded. Loading the same data in
3654 * more than one context would cause severe security failures
3655 * including but not limited to loss of confidentiality.
3656 *
3657 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003658 * prepared in one of the two following ways. The first way is
3659 * to take a context freshly initialised with
3660 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003661 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003662 * the original connection. The second way is to
3663 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003664 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003665 * Either way, you must not use the context to perform a
3666 * handshake between calling mbedtls_ssl_setup() or
3667 * mbedtls_ssl_session_reset() and calling this function. You
3668 * may however call other setter functions in that time frame
3669 * as indicated in the note below.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003670 *
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003671 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003672 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnardcc71c772019-06-05 09:47:18 +02003673 * and settings before you can use the connection again
3674 * (unless they were already set before calling
3675 * mbedtls_ssl_session_reset() and the values are suitable for
3676 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard7667afd2019-06-11 11:25:10 +02003677 * at least mbedtls_ssl_set_bio(). If you're using a read
3678 * timeout (that is, you called
3679 * mbedtls_ssl_conf_read_timeout() with a non-zero timeout)
3680 * and non-blocking I/O, you also need to set timer callbacks
3681 * by calling mbedtls_ssl_set_timer_cb(). All other SSL setter
3682 * functions are not necessary to call, either because they're
3683 * only used in handshakes, or because the setting is already
3684 * saved. You might choose to call them anyway, for example in
3685 * order to share code between the cases of establishing a new
3686 * connection and the case of loading an already-established
3687 * connection.
3688 *
3689 * \note If you have new information about the path MTU, you want to
3690 * call mbedtls_ssl_set_mtu() after calling this function, as
3691 * otherwise this function would overwrite your
3692 * newly-configured value with the value that was active when
3693 * the context was saved.
Manuel Pégourié-Gonnardd87601e2019-05-28 13:02:16 +02003694 *
3695 * \param ssl The SSL context structure to be populated. It must have
3696 * been prepared as described in the note above.
3697 * \param buf The buffer holding the serialized connection data. It must
3698 * be a readable buffer of at least \p len bytes.
3699 * \param len The size of the serialized data in bytes.
3700 *
3701 * \return \c 0 if successful.
3702 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
3703 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
3704 */
3705int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
3706 const unsigned char *buf,
3707 size_t len );
3708
3709/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003710 * \brief Initialize an SSL configuration context
3711 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003712 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003713 *
3714 * \note You need to call mbedtls_ssl_config_defaults() unless you
3715 * manually set all of the relevent fields yourself.
3716 *
3717 * \param conf SSL configuration context
3718 */
3719void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
3720
3721/**
3722 * \brief Load reasonnable default SSL configuration values.
3723 * (You need to call mbedtls_ssl_config_init() first.)
3724 *
3725 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003726 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
3727 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
3728 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003729 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003730 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003731 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01003732 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003733 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003734 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003735 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02003736int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003737 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003738
3739/**
3740 * \brief Free an SSL configuration context
3741 *
3742 * \param conf SSL configuration context
3743 */
3744void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
3745
3746/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003747 * \brief Initialize SSL session structure
3748 *
3749 * \param session SSL session
3750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003751void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003752
3753/**
Paul Bakker0a597072012-09-25 21:55:46 +00003754 * \brief Free referenced items in an SSL session including the
3755 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00003756 *
Ron Eldor00115032018-07-17 11:21:50 +03003757 * \note A session object can be freed even if the SSL context
3758 * that was used to retrieve the session is still in use.
3759 *
Paul Bakker48916f92012-09-16 19:57:18 +00003760 * \param session SSL session
3761 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003762void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00003763
Paul Bakker5121ce52009-01-03 21:22:43 +00003764#ifdef __cplusplus
3765}
3766#endif
3767
3768#endif /* ssl.h */