blob: 7c00180ff5741e2ec75a2041377a7af54f395bd7 [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/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
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 Bakker5121ce52009-01-03 21:22:43 +000021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_SSL_H
23#define MBEDTLS_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Amero6609aef2019-07-04 20:01:14 +010026#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020027#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020028#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010030
Jaeden Amero6609aef2019-07-04 20:01:14 +010031#include "mbedtls/bignum.h"
32#include "mbedtls/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020033
Jaeden Amero6609aef2019-07-04 20:01:14 +010034#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010037#include "mbedtls/x509_crt.h"
38#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020039#endif
Paul Bakkered27a042013-04-18 22:46:23 +020040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010042#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000043#endif
44
John Durkop07cc04a2020-11-16 22:08:34 -080045/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
46 * to guards also being in ssl_srv.c and ssl_cli.c. There is a gap
47 * in functionality that access to ecdh_ctx structure is needed for
48 * MBEDTLS_ECDSA_C which does not seem correct.
49 */
50#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010051#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010052#endif
53
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054#if defined(MBEDTLS_ZLIB_SUPPORT)
Hanno Beckere494e202018-03-08 13:26:12 +000055
56#if defined(MBEDTLS_DEPRECATED_WARNING)
57#warning "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and will be removed in the next major revision of the library"
58#endif
59
60#if defined(MBEDTLS_DEPRECATED_REMOVED)
61#error "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and cannot be used if MBEDTLS_DEPRECATED_REMOVED is set"
62#endif
63
Paul Bakker2770fbd2012-07-03 13:30:23 +000064#include "zlib.h"
65#endif
66
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010068#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020069#endif
70
Hanno Becker43633132018-10-22 15:31:03 +010071#if defined(MBEDTLS_USE_PSA_CRYPTO)
72#include "psa/crypto.h"
73#endif /* MBEDTLS_USE_PSA_CRYPTO */
74
Paul Bakker13e2dfe2009-07-28 07:18:38 +000075/*
76 * SSL Error codes
77 */
Gilles Peskinea3974432021-07-26 18:48:10 +020078/** The requested feature is not available. */
79#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
80/** Bad input parameters to function. */
81#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
82/** Verification of the message MAC failed. */
83#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
84/** An invalid SSL record was received. */
85#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
86/** The connection indicated an EOF. */
87#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
88/** An unknown cipher was received. */
89#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300
90/** The server has no ciphersuites in common with the client. */
91#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380
92/** No RNG was provided to the SSL module. */
93#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
94/** No client certification received from the client, but required by the authentication mode. */
95#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
96/** Our own certificate(s) is/are too large to send in an SSL message. */
97#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500
98/** The own certificate is not set, but needed by the server. */
99#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580
100/** The own private key or pre-shared key is not set, but needed. */
101#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
102/** No CA Chain is set, but required to operate. */
103#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
104/** An unexpected message was received from our peer. */
105#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
106/** A fatal alert message was received from our peer. */
107#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
108/** Verification of our peer failed. */
109#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800
110/** The peer notified us that the connection is going to be closed. */
111#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
112/** Processing of the ClientHello handshake message failed. */
113#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900
114/** Processing of the ServerHello handshake message failed. */
115#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980
116/** Processing of the Certificate handshake message failed. */
117#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00
118/** Processing of the CertificateRequest handshake message failed. */
119#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80
120/** Processing of the ServerKeyExchange handshake message failed. */
121#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00
122/** Processing of the ServerHelloDone handshake message failed. */
123#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80
124/** Processing of the ClientKeyExchange handshake message failed. */
125#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00
126/** Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
127#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80
128/** Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
129#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00
130/** Processing of the CertificateVerify handshake message failed. */
131#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80
132/** Processing of the ChangeCipherSpec handshake message failed. */
133#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00
134/** Processing of the Finished handshake message failed. */
135#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80
136/** Memory allocation failed */
137#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
138/** Hardware acceleration function returned with error */
139#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
140/** Hardware acceleration function skipped / left alone data */
141#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
142/** Processing of the compression / decompression failed */
143#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00
144/** Handshake protocol not within min/max boundaries */
145#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80
146/** Processing of the NewSessionTicket handshake message failed. */
147#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00
148/** Session ticket has expired. */
149#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
150/** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
151#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
152/** Unknown identity received (eg, PSK identity) */
153#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
154/** Internal error (eg, unexpected failure in lower-level module) */
155#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
156/** A counter would wrap (eg, too many messages exchanged). */
157#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
158/** Unexpected message at ServerHello in renegotiation. */
159#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
160/** DTLS client must retry for hello verification */
161#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
162/** A buffer is too small to receive or write a message */
163#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
164/** None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
165#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980
166/** No data of requested type currently available on underlying transport. */
167#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
168/** Connection requires a write call. */
169#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
170/** The operation timed out. */
171#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
172/** The client initiated a reconnect from the same port. */
173#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
174/** Record header looks valid but is not expected. */
175#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
176/** The alert message received indicates a non-fatal error. */
177#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
178/** Couldn't set the hash for verifying CertificateVerify */
179#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600
180/** Internal-only message signaling that further message-processing should be done */
181#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
182/** The asynchronous operation is not completed yet. */
183#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
184/** Internal-only message signaling that a message arrived early. */
185#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
186/** An encrypted DTLS-frame with an unexpected CID was received. */
187#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
188/** An operation failed due to an unexpected version or configuration. */
189#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
190/** A cryptographic operation is in progress. Try again later. */
191#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
192/** Invalid value in SSL config */
193#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
Paul Bakker5121ce52009-01-03 21:22:43 +0000194
195/*
196 * Various constants
197 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#define MBEDTLS_SSL_MAJOR_VERSION_3 3
199#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
200#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
201#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
202#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Hanno Becker2ab47dc2020-05-04 12:19:12 +0100203#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 (experimental) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200205#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
206#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100207
Simon Butcher9f812312015-09-28 19:22:33 +0100208#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200209#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
210
211#define MBEDTLS_SSL_MAX_ALPN_LIST_LEN 65535 /*!< Maximum size in bytes of list in alpn ext., RFC 7301 */
Simon Butcher89f77622015-09-27 22:50:49 +0100212
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200213/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200214 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
216#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
217#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
218#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
219#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
220#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200222#define MBEDTLS_SSL_IS_CLIENT 0
223#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
226#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200227
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200228#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
229#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200230
Hanno Becker019f4b52019-04-09 15:12:56 +0100231#define MBEDTLS_SSL_CID_DISABLED 0
232#define MBEDTLS_SSL_CID_ENABLED 1
233
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200234#define MBEDTLS_SSL_ETM_DISABLED 0
235#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200237#define MBEDTLS_SSL_COMPRESS_NULL 0
238#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#define MBEDTLS_SSL_VERIFY_NONE 0
241#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
242#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200243#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000244
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200245#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
246#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000247
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
249#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000250
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
252#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
255#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200257#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
258#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
259#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
262#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
263#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200264
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
266#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200267
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100268#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
269#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200271#define MBEDTLS_SSL_ARC4_ENABLED 0
272#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100273
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200274#define MBEDTLS_SSL_PRESET_DEFAULT 0
275#define MBEDTLS_SSL_PRESET_SUITEB 2
276
Janos Follath088ce432017-04-10 12:42:31 +0100277#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
278#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
279
Ron Eldor591f1622018-01-22 12:30:04 +0200280#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
281#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
282
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200283/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200284 * Default range for DTLS retransmission timer value, in milliseconds.
285 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
288#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200289
Paul Bakker088c5c52014-04-25 11:11:10 +0200290/**
291 * \name SECTION: Module settings
292 *
293 * The configuration options you can set for this module are in this section.
294 * Either change them in config.h or define them on the compiler command line.
295 * \{
296 */
297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
299#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200300#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200301
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200302/*
Angus Grattond8213d02016-05-25 20:56:48 +1000303 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200304 * determines the size of each of the two internal I/O buffers.
305 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200306 * Note: the RFC defines the default size of SSL / TLS messages. If you
307 * change the value here, other clients / servers may not be able to
308 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200309 * both sides of the connection and have it reduced at both sides, or
310 * if you're using the Max Fragment Length extension and you know all your
311 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
314#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200315#endif
316
Angus Grattond8213d02016-05-25 20:56:48 +1000317#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
318#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
319#endif
320
321#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
322#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
323#endif
324
Hanno Becker28007512018-08-28 09:46:44 +0100325/*
326 * Maximum number of heap-allocated bytes for the purpose of
327 * DTLS handshake message reassembly and future message buffering.
328 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100329#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100330#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100331#endif
332
Hanno Becker019f4b52019-04-09 15:12:56 +0100333/*
334 * Maximum length of CIDs for incoming and outgoing messages.
335 */
336#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100337#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100338#endif
339
340#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
341#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
342#endif
343
Hanno Beckerb1aa1b32019-05-08 17:37:58 +0100344#if !defined(MBEDTLS_SSL_CID_PADDING_GRANULARITY)
345#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
346#endif
347
Hanno Beckerceef8482020-06-02 06:16:00 +0100348#if !defined(MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY)
349#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +0100350#endif
351
Paul Bakker088c5c52014-04-25 11:11:10 +0200352/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000353
354/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100355 * Length of the verify data for secure renegotiation
356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357#if defined(MBEDTLS_SSL_PROTO_SSL3)
358#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100359#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100361#endif
362
363/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200364 * Signaling ciphersuite values (SCSV)
365 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000367#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000368
Paul Bakker5121ce52009-01-03 21:22:43 +0000369/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000370 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200371 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000372 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#define MBEDTLS_SSL_HASH_NONE 0
374#define MBEDTLS_SSL_HASH_MD5 1
375#define MBEDTLS_SSL_HASH_SHA1 2
376#define MBEDTLS_SSL_HASH_SHA224 3
377#define MBEDTLS_SSL_HASH_SHA256 4
378#define MBEDTLS_SSL_HASH_SHA384 5
379#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000380
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200381#define MBEDTLS_SSL_SIG_ANON 0
382#define MBEDTLS_SSL_SIG_RSA 1
383#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000384
385/*
Paul Bakker926af752012-11-23 13:38:07 +0100386 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200387 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100388 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
390#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100391
392/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000393 * Message, alert and handshake types
394 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
396#define MBEDTLS_SSL_MSG_ALERT 21
397#define MBEDTLS_SSL_MSG_HANDSHAKE 22
398#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100399#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
402#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000403
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
405#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
406#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
407#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
408#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
409#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
410#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
411#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
412#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
413#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
414#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
415#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
416#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
417#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
418#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
419#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
420#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
421#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
422#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
423#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
424#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
425#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
426#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
427#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
428#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
429#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
430#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
431#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
432#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000433
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
435#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
436#define MBEDTLS_SSL_HS_SERVER_HELLO 2
437#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
438#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
439#define MBEDTLS_SSL_HS_CERTIFICATE 11
440#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
441#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
442#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
443#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
444#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
445#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000446
447/*
448 * TLS extensions
449 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200450#define MBEDTLS_TLS_EXT_SERVERNAME 0
451#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000452
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200453#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200454
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200455#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200457#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
458#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000459
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200460#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100461
Johan Pascalb62bb512015-12-03 21:56:45 +0100462#define MBEDTLS_TLS_EXT_USE_SRTP 14
463
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200464#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200465
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200466#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
467#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200468
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200469#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200470
Hanno Becker0652bc52019-04-25 16:24:57 +0100471/* The value of the CID extension is still TBD as of
Hanno Beckerebcc9132019-05-15 10:26:32 +0100472 * draft-ietf-tls-dtls-connection-id-05
473 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) */
Hanno Becker064b7322019-05-03 12:42:13 +0100474#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker0652bc52019-04-25 16:24:57 +0100475
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200476#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
477
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200478#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000479
Johan Pascalb62bb512015-12-03 21:56:45 +0100480/*
Paul Bakkered27a042013-04-18 22:46:23 +0200481 * Size defines
482 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200483#if !defined(MBEDTLS_PSK_MAX_LEN)
484#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200485#endif
486
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200487/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200488union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200489{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200490#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200491 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
492#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
494 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200495#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
497 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
498 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
499 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
500 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200501#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200502#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
503 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200504#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
506 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
507 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200508#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200509#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
510 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200511#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200512#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
513 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
514 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200515#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200516#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
517 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
518#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200519};
520
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200521#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200522
Paul Bakker407a0da2013-06-27 14:29:21 +0200523#ifdef __cplusplus
524extern "C" {
525#endif
526
Paul Bakkered27a042013-04-18 22:46:23 +0200527/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000528 * SSL state machine
529 */
530typedef enum
531{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532 MBEDTLS_SSL_HELLO_REQUEST,
533 MBEDTLS_SSL_CLIENT_HELLO,
534 MBEDTLS_SSL_SERVER_HELLO,
535 MBEDTLS_SSL_SERVER_CERTIFICATE,
536 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
537 MBEDTLS_SSL_CERTIFICATE_REQUEST,
538 MBEDTLS_SSL_SERVER_HELLO_DONE,
539 MBEDTLS_SSL_CLIENT_CERTIFICATE,
540 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
541 MBEDTLS_SSL_CERTIFICATE_VERIFY,
542 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
543 MBEDTLS_SSL_CLIENT_FINISHED,
544 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
545 MBEDTLS_SSL_SERVER_FINISHED,
546 MBEDTLS_SSL_FLUSH_BUFFERS,
547 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
548 MBEDTLS_SSL_HANDSHAKE_OVER,
549 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
550 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000551}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000553
Ron Eldor51d3ab52019-05-12 14:54:30 +0300554/*
555 * The tls_prf function types.
556 */
557typedef enum
558{
559 MBEDTLS_SSL_TLS_PRF_NONE,
560 MBEDTLS_SSL_TLS_PRF_SSL3,
561 MBEDTLS_SSL_TLS_PRF_TLS1,
562 MBEDTLS_SSL_TLS_PRF_SHA384,
563 MBEDTLS_SSL_TLS_PRF_SHA256
564}
565mbedtls_tls_prf_types;
Simon Butchere846b512016-03-01 17:31:49 +0000566/**
567 * \brief Callback type: send data on the network.
568 *
569 * \note That callback may be either blocking or non-blocking.
570 *
571 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000572 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000573 * \param len Length of the data to send
574 *
575 * \return The callback must return the number of bytes sent if any,
576 * or a non-zero error code.
577 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
578 * must be returned when the operation would block.
579 *
Simon Butcherd567a232016-03-09 20:19:21 +0000580 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000581 * It must always return the number of bytes actually sent.
582 */
583typedef int mbedtls_ssl_send_t( void *ctx,
584 const unsigned char *buf,
585 size_t len );
586
587/**
588 * \brief Callback type: receive data from the network.
589 *
590 * \note That callback may be either blocking or non-blocking.
591 *
592 * \param ctx Context for the receive callback (typically a file
593 * descriptor)
594 * \param buf Buffer to write the received data to
595 * \param len Length of the receive buffer
596 *
597 * \return The callback must return the number of bytes received,
598 * or a non-zero error code.
599 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
600 * must be returned when the operation would block.
601 *
Simon Butcherd567a232016-03-09 20:19:21 +0000602 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000603 * buffer. It must always return the number of bytes actually
604 * received and written to the buffer.
605 */
606typedef int mbedtls_ssl_recv_t( void *ctx,
607 unsigned char *buf,
608 size_t len );
609
610/**
611 * \brief Callback type: receive data from the network, with timeout
612 *
613 * \note That callback must block until data is received, or the
614 * timeout delay expires, or the operation is interrupted by a
615 * signal.
616 *
617 * \param ctx Context for the receive callback (typically a file descriptor)
618 * \param buf Buffer to write the received data to
619 * \param len Length of the receive buffer
620 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000621 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000622 *
623 * \return The callback must return the number of bytes received,
624 * or a non-zero error code:
625 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
626 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
627 *
Simon Butcherd567a232016-03-09 20:19:21 +0000628 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000629 * buffer. It must always return the number of bytes actually
630 * received and written to the buffer.
631 */
632typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
633 unsigned char *buf,
634 size_t len,
635 uint32_t timeout );
636/**
637 * \brief Callback type: set a pair of timers/delays to watch
638 *
639 * \param ctx Context pointer
640 * \param int_ms Intermediate delay in milliseconds
641 * \param fin_ms Final delay in milliseconds
642 * 0 cancels the current timer.
643 *
644 * \note This callback must at least store the necessary information
645 * for the associated \c mbedtls_ssl_get_timer_t callback to
646 * return correct information.
647 *
648 * \note If using a event-driven style of programming, an event must
649 * be generated when the final delay is passed. The event must
650 * cause a call to \c mbedtls_ssl_handshake() with the proper
651 * SSL context to be scheduled. Care must be taken to ensure
652 * that at most one such call happens at a time.
653 *
654 * \note Only one timer at a time must be running. Calling this
655 * function while a timer is running must cancel it. Cancelled
656 * timers must not generate any event.
657 */
658typedef void mbedtls_ssl_set_timer_t( void * ctx,
659 uint32_t int_ms,
660 uint32_t fin_ms );
661
662/**
663 * \brief Callback type: get status of timers/delays
664 *
665 * \param ctx Context pointer
666 *
667 * \return This callback must return:
668 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000669 * 0 if none of the delays have passed,
670 * 1 if only the intermediate delay has passed,
671 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000672 */
673typedef int mbedtls_ssl_get_timer_t( void * ctx );
674
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200675/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676typedef struct mbedtls_ssl_session mbedtls_ssl_session;
677typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200678typedef struct mbedtls_ssl_config mbedtls_ssl_config;
679
680/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200681typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
682typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100683typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200684#if defined(MBEDTLS_X509_CRT_PARSE_C)
685typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200686#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687#if defined(MBEDTLS_SSL_PROTO_DTLS)
688typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200689#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000690
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200691#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100692#if defined(MBEDTLS_X509_CRT_PARSE_C)
693/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200694 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100695 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200696 * This callback is called during an SSL handshake to start
697 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200698 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100699 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200700 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100701 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200702 * This function typically sends or enqueues a request, and
703 * does not wait for the operation to complete. This allows
704 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100705 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200706 * The parameters \p ssl and \p cert are guaranteed to remain
707 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200708 * function must save the contents of \p hash if the value
709 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200710 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100711 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200712 * This function may call mbedtls_ssl_set_async_operation_data()
713 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200714 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200715 *
Gilles Peskined3268832018-04-26 06:23:59 +0200716 * \note For RSA signatures, this function must produce output
717 * that is consistent with PKCS#1 v1.5 in the same way as
718 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
719 * apply the padding steps described in RFC 8017, section 9.2
720 * "EMSA-PKCS1-v1_5" as follows.
721 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
722 * encoding, treating \p hash as the DigestInfo to be
723 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
724 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200725 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200726 * encoding, treating \p hash as the hash to be encoded and
727 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
728 * from step 2, with `digestAlgorithm` obtained by calling
729 * mbedtls_oid_get_oid_by_md() on \p md_alg.
730 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200731 * \note For ECDSA signatures, the output format is the DER encoding
732 * `Ecdsa-Sig-Value` defined in
733 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
734 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200735 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200736 * modified other than via
737 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200738 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200739 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200740 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200741 * connection. However, if other callbacks are used, this
742 * property may not hold. For example, if an SNI callback
743 * is registered with mbedtls_ssl_conf_sni(), then
744 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200745 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100746 * \param hash Buffer containing the hash. This buffer is
747 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200748 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100749 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200750 * \return 0 if the operation was started successfully and the SSL
751 * stack should call the resume callback immediately.
752 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
753 * was started successfully and the SSL stack should return
754 * immediately without calling the resume callback yet.
755 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
756 * processor does not support this key. The SSL stack will
757 * use the private key object instead.
758 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200759 * propagated up the call chain. The callback should
760 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
761 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200762 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100763 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200764typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100765 mbedtls_x509_crt *cert,
766 mbedtls_md_type_t md_alg,
767 const unsigned char *hash,
768 size_t hash_len );
769
770/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200771 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100772 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200773 * This callback is called during an SSL handshake to start
774 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200775 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100776 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200777 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100778 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200779 * This function typically sends or enqueues a request, and
780 * does not wait for the operation to complete. This allows
781 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100782 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200783 * The parameters \p ssl and \p cert are guaranteed to remain
784 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200785 * function must save the contents of \p input if the value
786 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200787 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100788 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200789 * This function may call mbedtls_ssl_set_async_operation_data()
790 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200791 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200792 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200793 * \warning RSA decryption as used in TLS is subject to a potential
794 * timing side channel attack first discovered by Bleichenbacher
795 * in 1998. This attack can be remotely exploitable
796 * in practice. To avoid this attack, you must ensure that
797 * if the callback performs an RSA decryption, the time it
798 * takes to execute and return the result does not depend
799 * on whether the RSA decryption succeeded or reported
800 * invalid padding.
801 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200802 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200803 * modified other than via
804 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200805 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200806 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200807 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200808 * connection. However, if other callbacks are used, this
809 * property may not hold. For example, if an SNI callback
810 * is registered with mbedtls_ssl_conf_sni(), then
811 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100812 * \param input Buffer containing the input ciphertext. This buffer
813 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200814 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100815 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200816 * \return 0 if the operation was started successfully and the SSL
817 * stack should call the resume callback immediately.
818 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
819 * was started successfully and the SSL stack should return
820 * immediately without calling the resume callback yet.
821 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
822 * processor does not support this key. The SSL stack will
823 * use the private key object instead.
824 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200825 * propagated up the call chain. The callback should
826 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
827 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200828 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100829 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200830typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100831 mbedtls_x509_crt *cert,
832 const unsigned char *input,
833 size_t input_len );
834#endif /* MBEDTLS_X509_CRT_PARSE_C */
835
836/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200837 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100838 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200839 * This callback is called during an SSL handshake to resume
840 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200841 * ::mbedtls_ssl_async_sign_t or
842 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200843 *
844 * This function typically checks the status of a pending
845 * request or causes the request queue to make progress, and
846 * does not wait for the operation to complete. This allows
847 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100848 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200849 * This function may call mbedtls_ssl_get_async_operation_data()
850 * to retrieve an operation context set by the start callback.
851 * It may call mbedtls_ssl_set_async_operation_data() to modify
852 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200853 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200854 * Note that when this function returns a status other than
855 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
856 * resources associated with the operation.
857 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200858 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200859 * modified other than via
860 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200861 * \param output Buffer containing the output (signature or decrypted
862 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200863 * \param output_len On success, number of bytes written to \p output.
864 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100865 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200866 * \return 0 if output of the operation is available in the
867 * \p output buffer.
868 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
869 * is still in progress. Subsequent requests for progress
870 * on the SSL connection will call the resume callback
871 * again.
872 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200873 * The SSL handshake is aborted. The callback should
874 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
875 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200876 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100877 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200878typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100879 unsigned char *output,
880 size_t *output_len,
881 size_t output_size );
882
883/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200884 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100885 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200886 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200887 * while an asynchronous operation is in progress. Note that
888 * this callback is not called if the
889 * ::mbedtls_ssl_async_resume_t callback has run and has
890 * returned a value other than
891 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
892 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100893 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200894 * This function may call mbedtls_ssl_get_async_operation_data()
895 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200896 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200897 * \param ssl The SSL connection instance. It should not be
898 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100899 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200900typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200901#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000902
Gilles Peskineeccd8882020-03-10 12:19:08 +0100903#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000904 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000905#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
906#if defined(MBEDTLS_SHA256_C)
907#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
908#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
909#elif defined(MBEDTLS_SHA512_C)
910#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
911#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
912#elif defined(MBEDTLS_SHA1_C)
913#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
914#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
915#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000916/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000917#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
918#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +0100919#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000920 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000921
Johan Pascalb62bb512015-12-03 21:56:45 +0100922#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +0200923
Johan Pascal85269572020-08-25 10:01:54 +0200924#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +0200925#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +0100926/*
Johan Pascal43f94902020-09-22 12:25:52 +0200927 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200928 *
929 * Use_srtp extension protection profiles values as defined in
930 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
931 *
932 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
933 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +0100934 */
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200935#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ( (uint16_t) 0x0001)
936#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ( (uint16_t) 0x0002)
937#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ( (uint16_t) 0x0005)
938#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ( (uint16_t) 0x0006)
939/* This one is not iana defined, but for code readability. */
940#define MBEDTLS_TLS_SRTP_UNSET ( (uint16_t) 0x0000)
941
Johan Pascal43f94902020-09-22 12:25:52 +0200942typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +0300943
Ron Eldor3adb9922017-12-21 10:15:08 +0200944typedef struct mbedtls_dtls_srtp_info_t
945{
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200946 /*! The SRTP profile that was negotiated. */
Ron Eldora9788042018-12-05 11:04:31 +0200947 mbedtls_ssl_srtp_profile chosen_dtls_srtp_profile;
Johan Pascalf6417ec2020-09-22 15:15:19 +0200948 /*! The length of mki_value. */
949 uint16_t mki_len;
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200950 /*! The mki_value used, with max size of 256 bytes. */
Johan Pascal85269572020-08-25 10:01:54 +0200951 unsigned char mki_value[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +0300952}
953mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +0200954
Johan Pascalb62bb512015-12-03 21:56:45 +0100955#endif /* MBEDTLS_SSL_DTLS_SRTP */
956
Paul Bakker5121ce52009-01-03 21:22:43 +0000957/*
Paul Bakker0a597072012-09-25 21:55:46 +0000958 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200959 *
960 * Note: when changing this definition, we need to check and update:
961 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +0200962 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200963 * - in library/ssl_tls.c:
964 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
965 * mbedtls_ssl_session_save() and ssl_session_load()
966 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000967 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000969{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100971 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200972#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000973 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000974 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200975 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000976 unsigned char id[32]; /*!< session identifier */
977 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200978
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200979#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000980#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000981 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000982#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000983 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
984 * changes during renegotiation, mitigating the triple handshake attack. */
985 unsigned char *peer_cert_digest;
986 size_t peer_cert_digest_len;
987 mbedtls_md_type_t peer_cert_digest_type;
Hanno Beckerabe6f662019-02-07 13:29:55 +0000988#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200989#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200990 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200991
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200992#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200993 unsigned char *ticket; /*!< RFC 5077 session ticket */
994 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200995 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200996#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200997
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200998#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200999 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +02001001
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001002#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +02001003 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001005
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001006#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001007 int encrypt_then_mac; /*!< flag for EtM activation */
1008#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001009};
1010
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001011/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001012 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001013 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001014struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001015{
1016 /* Group items by size (largest first) to minimize padding overhead */
1017
1018 /*
1019 * Pointers
1020 */
1021
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001022 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001023
1024 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001025 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001026 void *p_dbg; /*!< context for the debug function */
1027
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001028 /** Callback for getting (pseudo-)random numbers */
1029 int (*f_rng)(void *, unsigned char *, size_t);
1030 void *p_rng; /*!< context for the RNG function */
1031
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001032 /** Callback to retrieve a session from the cache */
1033 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001034 /** Callback to store a session into the cache */
1035 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001036 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001037
1038#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1039 /** Callback for setting cert according to SNI extension */
1040 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1041 void *p_sni; /*!< context for SNI callback */
1042#endif
1043
1044#if defined(MBEDTLS_X509_CRT_PARSE_C)
1045 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001046 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001047 void *p_vrfy; /*!< context for X.509 verify calllback */
1048#endif
1049
Gilles Peskineeccd8882020-03-10 12:19:08 +01001050#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001051 /** Callback to retrieve PSK key from identity */
1052 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1053 void *p_psk; /*!< context for PSK callback */
1054#endif
1055
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001056#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001057 /** Callback to create & write a cookie for ClientHello veirifcation */
1058 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
1059 const unsigned char *, size_t );
1060 /** Callback to verify validity of a ClientHello cookie */
1061 int (*f_cookie_check)( void *, const unsigned char *, size_t,
1062 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001063 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001064#endif
1065
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001066#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001067 /** Callback to create & write a session ticket */
1068 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
1069 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1070 /** Callback to parse a session ticket into a session structure */
1071 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1072 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001073#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001074
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001075#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001076 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001077 int (*f_export_keys)( void *, const unsigned char *,
1078 const unsigned char *, size_t, size_t, size_t );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001079 /** Callback to export key block, master secret,
1080 * tls_prf and random bytes. Should replace f_export_keys */
1081 int (*f_export_keys_ext)( void *, const unsigned char *,
1082 const unsigned char *, size_t, size_t, size_t,
Jaeden Amero63d813d2019-09-12 10:09:57 +01001083 const unsigned char[32], const unsigned char[32],
1084 mbedtls_tls_prf_types );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001085 void *p_export_keys; /*!< context for key export callback */
1086#endif
1087
Hanno Beckera0e20d02019-05-15 14:03:01 +01001088#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerad4a1372019-05-03 13:06:44 +01001089 size_t cid_len; /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001090#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001091
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001092#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001093 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001094 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
1095 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
1096 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001097#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1098 mbedtls_x509_crt_ca_cb_t f_ca_cb;
1099 void *p_ca_cb;
1100#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001101#endif /* MBEDTLS_X509_CRT_PARSE_C */
1102
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001103#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001104#if defined(MBEDTLS_X509_CRT_PARSE_C)
1105 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
1106 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
1107#endif /* MBEDTLS_X509_CRT_PARSE_C */
1108 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
1109 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +02001110 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001111#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001112
Gilles Peskineeccd8882020-03-10 12:19:08 +01001113#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001114 const int *sig_hashes; /*!< allowed signature hashes */
1115#endif
1116
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001117#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001118 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001119#endif
1120
1121#if defined(MBEDTLS_DHM_C)
1122 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
1123 mbedtls_mpi dhm_G; /*!< generator for DHM */
1124#endif
1125
Gilles Peskineeccd8882020-03-10 12:19:08 +01001126#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001127
1128#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001129 psa_key_id_t psk_opaque; /*!< PSA key slot holding opaque PSK. This field
1130 * should only be set via
1131 * mbedtls_ssl_conf_psk_opaque().
1132 * If either no PSK or a raw PSK have been
1133 * configured, this has value \c 0.
1134 */
Hanno Becker43633132018-10-22 15:31:03 +01001135#endif /* MBEDTLS_USE_PSA_CRYPTO */
1136
1137 unsigned char *psk; /*!< The raw pre-shared key. This field should
1138 * only be set via mbedtls_ssl_conf_psk().
1139 * If either no PSK or an opaque PSK
1140 * have been configured, this has value NULL. */
1141 size_t psk_len; /*!< The length of the raw pre-shared key.
1142 * This field should only be set via
1143 * mbedtls_ssl_conf_psk().
1144 * Its value is non-zero if and only if
1145 * \c psk is not \c NULL. */
1146
1147 unsigned char *psk_identity; /*!< The PSK identity for PSK negotiation.
1148 * This field should only be set via
1149 * mbedtls_ssl_conf_psk().
1150 * This is set if and only if either
1151 * \c psk or \c psk_opaque are set. */
1152 size_t psk_identity_len;/*!< The length of PSK identity.
1153 * This field should only be set via
1154 * mbedtls_ssl_conf_psk().
1155 * Its value is non-zero if and only if
1156 * \c psk is not \c NULL or \c psk_opaque
1157 * is not \c 0. */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001158#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001159
1160#if defined(MBEDTLS_SSL_ALPN)
1161 const char **alpn_list; /*!< ordered list of protocols */
1162#endif
1163
Johan Pascalbbc057a2016-02-04 22:07:32 +01001164#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001165 /*! ordered list of supported srtp profile */
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001166 const mbedtls_ssl_srtp_profile *dtls_srtp_profile_list;
Ron Eldora9788042018-12-05 11:04:31 +02001167 /*! number of supported profiles */
1168 size_t dtls_srtp_profile_list_len;
Johan Pascalbbc057a2016-02-04 22:07:32 +01001169#endif /* MBEDTLS_SSL_DTLS_SRTP */
1170
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001171 /*
1172 * Numerical settings (int then char)
1173 */
1174
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001175 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
1176
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001177#if defined(MBEDTLS_SSL_PROTO_DTLS)
1178 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001179 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001180 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001181 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001182#endif
1183
1184#if defined(MBEDTLS_SSL_RENEGOTIATION)
1185 int renego_max_records; /*!< grace period for renegotiation */
1186 unsigned char renego_period[8]; /*!< value of the record counters
1187 that triggers renegotiation */
1188#endif
1189
1190#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1191 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1192#endif
1193
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001194#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1195 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1196#endif
1197
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001198 unsigned char max_major_ver; /*!< max. major version used */
1199 unsigned char max_minor_ver; /*!< max. minor version used */
1200 unsigned char min_major_ver; /*!< min. major version used */
1201 unsigned char min_minor_ver; /*!< min. minor version used */
1202
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001203 /*
1204 * Flags (bitfields)
1205 */
1206
1207 unsigned int endpoint : 1; /*!< 0: client, 1: server */
1208 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001209 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
1210 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1211 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001212#if defined(MBEDTLS_ARC4_C)
1213 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
1214#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001215#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1216 unsigned int mfl_code : 3; /*!< desired fragment length */
1217#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001218#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1219 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1220#endif
1221#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1222 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
1223#endif
1224#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1225 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
1226#endif
1227#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1228 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1229#endif
1230#if defined(MBEDTLS_SSL_RENEGOTIATION)
1231 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1232#endif
1233#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1234 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1235#endif
1236#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1237 unsigned int session_tickets : 1; /*!< use session tickets? */
1238#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001239#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1240 unsigned int fallback : 1; /*!< is this a fallback? */
1241#endif
Janos Follath088ce432017-04-10 12:42:31 +01001242#if defined(MBEDTLS_SSL_SRV_C)
1243 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1244 Certificate Request messages? */
1245#endif
Hanno Beckera0e20d02019-05-15 14:03:01 +01001246#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01001247 unsigned int ignore_unexpected_cid : 1; /*!< Determines whether DTLS
1248 * record with unexpected CID
1249 * should lead to failure. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001250#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Ron Eldor3adb9922017-12-21 10:15:08 +02001251#if defined(MBEDTLS_SSL_DTLS_SRTP)
1252 unsigned int dtls_srtp_mki_support : 1; /* support having mki_value
Ron Eldor591f1622018-01-22 12:30:04 +02001253 in the use_srtp extension */
Ron Eldor3adb9922017-12-21 10:15:08 +02001254#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001255};
1256
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001257struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001258{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001259 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001260
Paul Bakker5121ce52009-01-03 21:22:43 +00001261 /*
1262 * Miscellaneous
1263 */
1264 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001265#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001266 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001267 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1268 number of retransmissions of request if
1269 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001270#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001271
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001272 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001273 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001276 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001277#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001278
Hanno Becker8927c832019-04-03 12:52:50 +01001279#if defined(MBEDTLS_X509_CRT_PARSE_C)
1280 /** Callback to customize X.509 certificate chain verification */
1281 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Janos Follath924270f2019-04-04 12:49:44 +01001282 void *p_vrfy; /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001283#endif
1284
Simon Butchere846b512016-03-01 17:31:49 +00001285 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1286 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1287 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1288 /*!< Callback for network receive with timeout */
1289
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001290 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001291
Paul Bakker5121ce52009-01-03 21:22:43 +00001292 /*
1293 * Session layer
1294 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1296 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1297 mbedtls_ssl_session *session; /*!< negotiated session data */
1298 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001300 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001301 the handshake process */
1302
1303 /*
1304 * Record layer transformations
1305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1307 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1308 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1309 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001310
Paul Bakker5121ce52009-01-03 21:22:43 +00001311 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001312 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001313 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001314 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001315
1316 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1317 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001318
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001319 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001320 * Record layer (incoming data)
1321 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001322 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001323 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1324 TLS: maintained by us
1325 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001326 unsigned char *in_hdr; /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001327#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001328 unsigned char *in_cid; /*!< The start of the CID;
1329 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001330#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001331 unsigned char *in_len; /*!< two-bytes message length field */
1332 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001333 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001334 unsigned char *in_offt; /*!< read offset in application data */
1335
1336 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001337 size_t in_msglen; /*!< record header: message length */
1338 size_t in_left; /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001339#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1340 size_t in_buf_len; /*!< length of input buffer */
1341#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001342#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001343 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001344 size_t next_record_offset; /*!< offset of the next record in datagram
1345 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001346#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001348 uint64_t in_window_top; /*!< last validated record seq_num */
1349 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001350#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001351
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001352 size_t in_hslen; /*!< current handshake message length,
1353 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001354 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001355
1356 int keep_current_message; /*!< drop or reuse current message
1357 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001358
Hanno Becker04da1892018-08-14 13:22:10 +01001359#if defined(MBEDTLS_SSL_PROTO_DTLS)
1360 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1361 * within a single datagram. */
1362#endif /* MBEDTLS_SSL_PROTO_DTLS */
1363
Paul Bakker5121ce52009-01-03 21:22:43 +00001364 /*
1365 * Record layer (outgoing data)
1366 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001367 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001368 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001369 unsigned char *out_hdr; /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001370#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001371 unsigned char *out_cid; /*!< The start of the CID;
1372 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001373#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001374 unsigned char *out_len; /*!< two-bytes message length field */
1375 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001376 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001377
1378 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001379 size_t out_msglen; /*!< record header: message length */
1380 size_t out_left; /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001381#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1382 size_t out_buf_len; /*!< length of output buffer */
1383#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001384
Hanno Becker19859472018-08-06 09:40:20 +01001385 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1386
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001387#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001388 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001389#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001392 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001393#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001395 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001396#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001397
Paul Bakker5121ce52009-01-03 21:22:43 +00001398 /*
1399 * PKI layer
1400 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001401 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001402
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001403 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001404 * User settings
1405 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001406#if defined(MBEDTLS_X509_CRT_PARSE_C)
1407 char *hostname; /*!< expected peer CN for verification
1408 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001409#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001410
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001411#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001412 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001413#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001414
Johan Pascalb62bb512015-12-03 21:56:45 +01001415#if defined(MBEDTLS_SSL_DTLS_SRTP)
1416 /*
1417 * use_srtp extension
1418 */
Ron Eldor3adb9922017-12-21 10:15:08 +02001419 mbedtls_dtls_srtp_info dtls_srtp_info;
Johan Pascalb62bb512015-12-03 21:56:45 +01001420#endif /* MBEDTLS_SSL_DTLS_SRTP */
1421
Paul Bakker48916f92012-09-16 19:57:18 +00001422 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001423 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001424 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001425#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001426 unsigned char *cli_id; /*!< transport-level ID of the client */
1427 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001428#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001429
1430 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001431 * Secure renegotiation
1432 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001433 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001434 int secure_renegotiation; /*!< does peer support legacy or
1435 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001437 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001438 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1439 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001440#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001441
Hanno Beckera0e20d02019-05-15 14:03:01 +01001442#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001443 /* CID configuration to use in subsequent handshakes. */
1444
1445 /*! The next incoming CID, chosen by the user and applying to
1446 * all subsequent handshakes. This may be different from the
1447 * CID currently used in case the user has re-configured the CID
1448 * after an initial handshake. */
1449 unsigned char own_cid[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1450 uint8_t own_cid_len; /*!< The length of \c own_cid. */
1451 uint8_t negotiate_cid; /*!< This indicates whether the CID extension should
1452 * be negotiated in the next handshake or not.
1453 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1454 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001455#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001456};
1457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001458#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001459
Andres Amaya Garcia4156ac12019-01-03 20:48:54 +00001460#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1461
1462#define MBEDTLS_SSL_CHANNEL_OUTBOUND MBEDTLS_DEPRECATED_NUMERIC_CONSTANT( 0 )
1463#define MBEDTLS_SSL_CHANNEL_INBOUND MBEDTLS_DEPRECATED_NUMERIC_CONSTANT( 1 )
Paul Bakker07eb38b2012-12-19 14:42:06 +01001464
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001465#if defined(MBEDTLS_DEPRECATED_WARNING)
1466#define MBEDTLS_DEPRECATED __attribute__((deprecated))
1467#else
1468#define MBEDTLS_DEPRECATED
Andres Amaya Garcia10edb3e2019-01-15 18:44:06 +00001469#endif /* MBEDTLS_DEPRECATED_WARNING */
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001470
1471MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_init)(
1472 mbedtls_ssl_context *ssl,
1473 const unsigned char *key_enc, const unsigned char *key_dec,
1474 size_t keylen,
1475 const unsigned char *iv_enc, const unsigned char *iv_dec,
1476 size_t ivlen,
1477 const unsigned char *mac_enc, const unsigned char *mac_dec,
1478 size_t maclen);
1479MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_activate)(
1480 mbedtls_ssl_context *ssl,
1481 int direction );
1482MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_reset)(
1483 mbedtls_ssl_context *ssl );
1484MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_write)(
1485 mbedtls_ssl_context *ssl );
1486MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_read)(
1487 mbedtls_ssl_context *ssl );
1488MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_finish)(
1489 mbedtls_ssl_context *ssl );
1490
1491#undef MBEDTLS_DEPRECATED
Andres Amaya Garcia4156ac12019-01-03 20:48:54 +00001492#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001494#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001495
Paul Bakker5121ce52009-01-03 21:22:43 +00001496/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001497 * \brief Return the name of the ciphersuite associated with the
1498 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001499 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001500 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001501 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001502 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001503 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001504const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001505
1506/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001507 * \brief Return the ID of the ciphersuite associated with the
1508 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001509 *
1510 * \param ciphersuite_name SSL ciphersuite name
1511 *
1512 * \return the ID with the ciphersuite or 0 if not found
1513 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001514int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001515
1516/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001517 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001518 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001519 * mbedtls_ssl_free()
1520 *
1521 * \param ssl SSL context
1522 */
1523void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1524
1525/**
1526 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001527 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001528 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001529 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001530 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001531 * \warning The conf structure will be accessed during the session.
1532 * It must not be modified or freed as long as the session
1533 * is active.
1534 *
1535 * \warning This function must be called exactly once per context.
1536 * Calling mbedtls_ssl_setup again is not supported, even
1537 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001538 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001539 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001540 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001541 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001542 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001543 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001544 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001545int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001546 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001547
1548/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001549 * \brief Reset an already initialized SSL context for re-use
1550 * while retaining application-set variables, function
1551 * pointers and data.
1552 *
1553 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001554 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001555 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1556 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001557 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001559
1560/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001561 * \brief Set the current endpoint type
1562 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001563 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001565 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001566void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001567
1568/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001569 * \brief Set the transport type (TLS or DTLS).
1570 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001571 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001572 * \note For DTLS, you must either provide a recv callback that
1573 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001574 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1575 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001576 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001577 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001578 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001579 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1580 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001581 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001582void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001583
1584/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001585 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001586 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001587 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001588 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001589 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001590 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001591 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001592 * (default on server)
1593 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001594 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001595 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001596 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001598 * handshake is complete.
1599 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001600 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001601 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001602 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001604 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1605 * 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 +01001606 * the right time(s), which may not be obvious, while REQUIRED always perform
1607 * the verification as soon as possible. For example, REQUIRED was protecting
1608 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001610void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001612#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001613/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001614 * \brief Set the verification callback (Optional).
1615 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001616 * If set, the provided verify callback is called for each
1617 * certificate in the peer's CRT chain, including the trusted
1618 * root. For more information, please see the documentation of
1619 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001620 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001621 * \note For per context callbacks and contexts, please use
1622 * mbedtls_ssl_set_verify() instead.
1623 *
1624 * \param conf The SSL configuration to use.
1625 * \param f_vrfy The verification callback to use during CRT verification.
1626 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001627 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001628void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001629 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001630 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001632
1633/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001634 * \brief Set the random number generator callback
1635 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001636 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001637 * \param f_rng RNG function
1638 * \param p_rng RNG parameter
1639 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001640void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001641 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001642 void *p_rng );
1643
1644/**
1645 * \brief Set the debug callback
1646 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001647 * The callback has the following argument:
1648 * void * opaque context for the callback
1649 * int debug level
1650 * const char * file name
1651 * int line number
1652 * const char * message
1653 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001654 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001655 * \param f_dbg debug function
1656 * \param p_dbg debug parameter
1657 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001658void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001659 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001660 void *p_dbg );
1661
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001662/**
1663 * \brief Set the underlying BIO callbacks for write, read and
1664 * read-with-timeout.
1665 *
1666 * \param ssl SSL context
1667 * \param p_bio parameter (context) shared by BIO callbacks
1668 * \param f_send write callback
1669 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001670 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001671 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001672 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1673 * the other is used. If both are non-NULL, f_recv_timeout is
1674 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001675 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001676 * \note The two most common use cases are:
1677 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1678 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1679 *
1680 * \note For DTLS, you need to provide either a non-NULL
1681 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001682 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07001683 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001684 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001685 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001686 *
Andres AG3616f6f2016-09-14 14:32:09 +01001687 * \note On some platforms, net_sockets.c provides
1688 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1689 * \c mbedtls_net_recv_timeout() that are suitable to be used
1690 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001691 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001692void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001693 void *p_bio,
1694 mbedtls_ssl_send_t *f_send,
1695 mbedtls_ssl_recv_t *f_recv,
1696 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001697
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001698#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001699
Hanno Beckera0e20d02019-05-15 14:03:01 +01001700#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01001701
1702
1703/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001704 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001705 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001706 *
Hanno Beckerebcc9132019-05-15 10:26:32 +01001707 * Reference: draft-ietf-tls-dtls-connection-id-05
1708 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker019f4b52019-04-09 15:12:56 +01001709 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01001710 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01001711 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01001712 * underlying transport (changed IP and Port metadata) by
1713 * adding explicit connection identifiers (CIDs) to the
1714 * headers of encrypted DTLS records. The desired CIDs are
1715 * configured by the application layer and are exchanged in
1716 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01001717 * handshake, where each side indicates the CID it wants the
1718 * peer to use when writing encrypted messages. The CIDs are
1719 * put to use once records get encrypted: the stack discards
1720 * any incoming records that don't include the configured CID
1721 * in their header, and adds the peer's requested CID to the
1722 * headers of outgoing messages.
1723 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01001724 * This API enables or disables the use of the CID extension
1725 * in the next handshake and sets the value of the CID to
1726 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01001727 *
1728 * \param ssl The SSL context to configure. This must be initialized.
1729 * \param enable This value determines whether the CID extension should
1730 * be used or not. Possible values are:
1731 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001732 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1733 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001734 * \param own_cid The address of the readable buffer holding the CID we want
1735 * the peer to use when sending encrypted messages to us.
1736 * This may be \c NULL if \p own_cid_len is \c 0.
1737 * This parameter is unused if \p enabled is set to
1738 * MBEDTLS_SSL_CID_DISABLED.
1739 * \param own_cid_len The length of \p own_cid.
1740 * This parameter is unused if \p enabled is set to
1741 * MBEDTLS_SSL_CID_DISABLED.
1742 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001743 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01001744 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01001745 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001746 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001747 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001748 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001749 * performed on the SSL context \p ssl, but does not trigger
1750 * one. You still have to call `mbedtls_ssl_handshake()`
1751 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1752 * (for a renegotiation handshake) explicitly after a
1753 * successful call to this function to run the handshake.
1754 *
1755 * \note This call cannot guarantee that the use of the CID
1756 * will be successfully negotiated in the next handshake,
1757 * because the peer might not support it. Specifically:
1758 * - On the Client, enabling the use of the CID through
1759 * this call implies that the `ClientHello` in the next
1760 * handshake will include the CID extension, thereby
1761 * offering the use of the CID to the server. Only if
1762 * the `ServerHello` contains the CID extension, too,
1763 * the CID extension will actually be put to use.
1764 * - On the Server, enabling the use of the CID through
1765 * this call implies that that the server will look for
1766 * the CID extension in a `ClientHello` from the client,
1767 * and, if present, reply with a CID extension in its
1768 * `ServerHello`.
1769 *
1770 * \note To check whether the use of the CID was negotiated
1771 * after the subsequent handshake has completed, please
1772 * use the API mbedtls_ssl_get_peer_cid().
1773 *
1774 * \warning If the use of the CID extension is enabled in this call
1775 * and the subsequent handshake negotiates its use, Mbed TLS
1776 * will silently drop every packet whose CID does not match
1777 * the CID configured in \p own_cid. It is the responsibility
1778 * of the user to adapt the underlying transport to take care
1779 * of CID-based demultiplexing before handing datagrams to
1780 * Mbed TLS.
1781 *
1782 * \return \c 0 on success. In this case, the CID configuration
1783 * applies to the next handshake.
1784 * \return A negative error code on failure.
1785 */
1786int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1787 int enable,
1788 unsigned char const *own_cid,
1789 size_t own_cid_len );
1790
1791/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01001792 * \brief Get information about the use of the CID extension
1793 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01001794 *
1795 * \param ssl The SSL context to query.
1796 * \param enabled The address at which to store whether the CID extension
1797 * is currently in use or not. If the CID is in use,
1798 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1799 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1800 * \param peer_cid The address of the buffer in which to store the CID
1801 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01001802 * This may be \c NULL in case the value of peer CID
1803 * isn't needed. If it is not \c NULL, \p peer_cid_len
1804 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01001805 * \param peer_cid_len The address at which to store the size of the CID
1806 * chosen by the peer (if the CID extension is used).
1807 * This is also the number of Bytes in \p peer_cid that
1808 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01001809 * This may be \c NULL in case the length of the peer CID
1810 * isn't needed. If it is \c NULL, \p peer_cid must be
1811 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01001812 *
1813 * \note This applies to the state of the CID negotiated in
1814 * the last complete handshake. If a handshake is in
1815 * progress, this function will attempt to complete
1816 * the handshake first.
1817 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001818 * \note If CID extensions have been exchanged but both client
1819 * and server chose to use an empty CID, this function
1820 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1821 * (the rationale for this is that the resulting
1822 * communication is the same as if the CID extensions
1823 * hadn't been used).
1824 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001825 * \return \c 0 on success.
1826 * \return A negative error code on failure.
1827 */
1828int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1829 int *enabled,
1830 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1831 size_t *peer_cid_len );
1832
Hanno Beckera0e20d02019-05-15 14:03:01 +01001833#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01001834
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001835/**
1836 * \brief Set the Maximum Tranport Unit (MTU).
1837 * Special value: 0 means unset (no limit).
1838 * This represents the maximum size of a datagram payload
1839 * handled by the transport layer (usually UDP) as determined
1840 * by the network link and stack. In practice, this controls
1841 * the maximum size datagram the DTLS layer will pass to the
1842 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1843 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001844 * \note The limit on datagram size is converted to a limit on
1845 * record payload by subtracting the current overhead of
1846 * encapsulation and encryption/authentication if any.
1847 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001848 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001849 * example when a Path Maximum Transfer Unit (PMTU)
1850 * estimate becomes available from other sources,
1851 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001852 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001853 * \note This setting only controls the size of the packets we send,
1854 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001855 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001856 * server to use smaller records with \c
1857 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001858 *
1859 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001860 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001861 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001862 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001863 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001864 * of datagrams (hence records, see first note) sent. It
1865 * cannot be used to increase the maximum size of records over
1866 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001867 *
1868 * \note Values lower than the current record layer expansion will
1869 * result in an error when trying to send data.
1870 *
1871 * \note Using record compression together with a non-zero MTU value
1872 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001873 *
1874 * \param ssl SSL context
1875 * \param mtu Value of the path MTU in bytes
1876 */
1877void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1878#endif /* MBEDTLS_SSL_PROTO_DTLS */
1879
Hanno Becker726c97a2019-04-03 12:52:35 +01001880#if defined(MBEDTLS_X509_CRT_PARSE_C)
1881/**
1882 * \brief Set a connection-specific verification callback (optional).
1883 *
1884 * If set, the provided verify callback is called for each
1885 * certificate in the peer's CRT chain, including the trusted
1886 * root. For more information, please see the documentation of
1887 * \c mbedtls_x509_crt_verify().
1888 *
1889 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1890 * binds the verification callback and context to an SSL context
1891 * as opposed to an SSL configuration.
1892 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1893 * are both used, mbedtls_ssl_set_verify() takes precedence.
1894 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001895 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001896 * \param f_vrfy The verification callback to use during CRT verification.
1897 * \param p_vrfy The opaque context to be passed to the callback.
1898 */
1899void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1900 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1901 void *p_vrfy );
1902#endif /* MBEDTLS_X509_CRT_PARSE_C */
1903
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001904/**
1905 * \brief Set the timeout period for mbedtls_ssl_read()
1906 * (Default: no timeout.)
1907 *
1908 * \param conf SSL configuration context
1909 * \param timeout Timeout value in milliseconds.
1910 * Use 0 for no timeout (default).
1911 *
1912 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001913 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001914 * With non-blocking I/O, this will only work if timer
1915 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1916 *
1917 * \note With non-blocking I/O, you may also skip this function
1918 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001919 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001920void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001921
Hanno Beckercfe45792019-07-03 16:13:00 +01001922#if defined(MBEDTLS_SSL_RECORD_CHECKING)
1923/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001924 * \brief Check whether a buffer contains a valid and authentic record
1925 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01001926 *
1927 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01001928 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01001929 * an indication of the legitimacy of an incoming record.
1930 *
1931 * This can be useful e.g. in distributed server environments
1932 * using the DTLS Connection ID feature, in which connections
1933 * might need to be passed between service instances on a change
1934 * of peer address, but where such disruptive operations should
1935 * only happen after the validity of incoming records has been
1936 * confirmed.
1937 *
1938 * \param ssl The SSL context to use.
1939 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001940 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01001941 * \param buflen The length of \p buf in Bytes.
1942 *
1943 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001944 * with a valid and authentic record that has not been seen
1945 * before, but does not check potential data following the
1946 * initial record. In particular, it is possible to pass DTLS
1947 * datagrams containing multiple records, in which case only
1948 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01001949 *
1950 * \note This function modifies the input buffer \p buf. If you need
1951 * to preserve the original record, you have to maintain a copy.
1952 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001953 * \return \c 0 if the record is valid and authentic and has not been
1954 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01001955 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
1956 * successfully but the record was found to be not authentic.
1957 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
1958 * successfully but the record was found to be invalid for
1959 * a reason different from authenticity checking.
1960 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
1961 * successfully but the record was found to be unexpected
1962 * in the state of the SSL context, including replayed records.
1963 * \return Another negative error code on different kinds of failure.
1964 * In this case, the SSL context becomes unusable and needs
1965 * to be freed or reset before reuse.
1966 */
1967int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
1968 unsigned char *buf,
1969 size_t buflen );
1970#endif /* MBEDTLS_SSL_RECORD_CHECKING */
1971
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001972/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001973 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001974 *
1975 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001976 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001977 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001978 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001979 *
1980 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1981 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001982 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001983 *
1984 * \note On some platforms, timing.c provides
1985 * \c mbedtls_timing_set_delay() and
1986 * \c mbedtls_timing_get_delay() that are suitable for using
1987 * here, except if using an event-driven style.
1988 *
1989 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001990 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001991 */
1992void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1993 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001994 mbedtls_ssl_set_timer_t *f_set_timer,
1995 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001996
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001997/**
1998 * \brief Callback type: generate and write session ticket
1999 *
2000 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002001 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002002 * authenticated ticket for the session and write it to the
2003 * output buffer. Here, ticket means the opaque ticket part
2004 * of the NewSessionTicket structure of RFC 5077.
2005 *
2006 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002007 * \param session SSL session to be written in the ticket
2008 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002009 * \param end End of the output buffer
2010 * \param tlen On exit, holds the length written
2011 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2012 *
2013 * \return 0 if successful, or
2014 * a specific MBEDTLS_ERR_XXX code.
2015 */
2016typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
2017 const mbedtls_ssl_session *session,
2018 unsigned char *start,
2019 const unsigned char *end,
2020 size_t *tlen,
2021 uint32_t *lifetime );
2022
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002023#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2024/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002025 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002026 *
2027 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002028 * (RFC 5216) and Thread. The key pointers are ephemeral and
2029 * therefore must not be stored. The master secret and keys
2030 * should not be used directly except as an input to a key
2031 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002032 *
2033 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002034 * \param ms Pointer to master secret (fixed length: 48 bytes)
2035 * \param kb Pointer to key block, see RFC 5246 section 6.3
2036 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002037 * \param maclen MAC length
2038 * \param keylen Key length
2039 * \param ivlen IV length
2040 *
2041 * \return 0 if successful, or
2042 * a specific MBEDTLS_ERR_XXX code.
2043 */
2044typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002045 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002046 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002047 size_t maclen,
2048 size_t keylen,
2049 size_t ivlen );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002050
2051/**
2052 * \brief Callback type: Export key block, master secret,
2053 * handshake randbytes and the tls_prf function
2054 * used to derive keys.
2055 *
2056 * \note This is required for certain uses of TLS, e.g. EAP-TLS
2057 * (RFC 5216) and Thread. The key pointers are ephemeral and
2058 * therefore must not be stored. The master secret and keys
2059 * should not be used directly except as an input to a key
2060 * derivation function.
2061 *
2062 * \param p_expkey Context for the callback.
2063 * \param ms Pointer to master secret (fixed length: 48 bytes).
2064 * \param kb Pointer to key block, see RFC 5246 section 6.3.
2065 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
2066 * \param maclen MAC length.
2067 * \param keylen Key length.
2068 * \param ivlen IV length.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002069 * \param client_random The client random bytes.
2070 * \param server_random The server random bytes.
Ron Eldor51d3ab52019-05-12 14:54:30 +03002071 * \param tls_prf_type The tls_prf enum type.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002072 *
2073 * \return 0 if successful, or
2074 * a specific MBEDTLS_ERR_XXX code.
2075 */
2076typedef int mbedtls_ssl_export_keys_ext_t( void *p_expkey,
2077 const unsigned char *ms,
2078 const unsigned char *kb,
2079 size_t maclen,
2080 size_t keylen,
2081 size_t ivlen,
Jaeden Amero63d813d2019-09-12 10:09:57 +01002082 const unsigned char client_random[32],
2083 const unsigned char server_random[32],
Ron Eldor51d3ab52019-05-12 14:54:30 +03002084 mbedtls_tls_prf_types tls_prf_type );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002085#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002086
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002087/**
2088 * \brief Callback type: parse and load session ticket
2089 *
2090 * \note This describes what a callback implementation should do.
2091 * This callback should parse a session ticket as generated
2092 * by the corresponding mbedtls_ssl_ticket_write_t function,
2093 * and, if the ticket is authentic and valid, load the
2094 * session.
2095 *
2096 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002097 * bytes of the input buffer, eg to use it as a temporary
2098 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002099 *
2100 * \param p_ticket Context for the callback
2101 * \param session SSL session to be loaded
2102 * \param buf Start of the buffer containing the ticket
2103 * \param len Length of the ticket.
2104 *
2105 * \return 0 if successful, or
2106 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2107 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2108 * any other non-zero code for other failures.
2109 */
2110typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
2111 mbedtls_ssl_session *session,
2112 unsigned char *buf,
2113 size_t len );
2114
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002115#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002116/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002117 * \brief Configure SSL session ticket callbacks (server only).
2118 * (Default: none.)
2119 *
2120 * \note On server, session tickets are enabled by providing
2121 * non-NULL callbacks.
2122 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002123 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002124 *
2125 * \param conf SSL configuration context
2126 * \param f_ticket_write Callback for writing a ticket
2127 * \param f_ticket_parse Callback for parsing a ticket
2128 * \param p_ticket Context shared by the two callbacks
2129 */
2130void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2131 mbedtls_ssl_ticket_write_t *f_ticket_write,
2132 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2133 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002134#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002135
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002136#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2137/**
2138 * \brief Configure key export callback.
2139 * (Default: none.)
2140 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002141 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002142 *
2143 * \param conf SSL configuration context
2144 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002145 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002146 */
2147void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
2148 mbedtls_ssl_export_keys_t *f_export_keys,
2149 void *p_export_keys );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002150
2151/**
2152 * \brief Configure extended key export callback.
2153 * (Default: none.)
2154 *
2155 * \note See \c mbedtls_ssl_export_keys_ext_t.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002156 * \warning Exported key material must not be used for any purpose
2157 * before the (D)TLS handshake is completed
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002158 *
2159 * \param conf SSL configuration context
2160 * \param f_export_keys_ext Callback for exporting keys
2161 * \param p_export_keys Context for the callback
2162 */
2163void mbedtls_ssl_conf_export_keys_ext_cb( mbedtls_ssl_config *conf,
2164 mbedtls_ssl_export_keys_ext_t *f_export_keys_ext,
2165 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002166#endif /* MBEDTLS_SSL_EXPORT_KEYS */
2167
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002168#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002169/**
2170 * \brief Configure asynchronous private key operation callbacks.
2171 *
2172 * \param conf SSL configuration context
2173 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002174 * the description of ::mbedtls_ssl_async_sign_t
2175 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002176 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002177 * operation; in this case the private key object
2178 * associated with the certificate will be used.
2179 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002180 * the description of ::mbedtls_ssl_async_decrypt_t
2181 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002182 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002183 * operation; in this case the private key object
2184 * associated with the certificate will be used.
2185 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002186 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002187 * for more information. This may not be \c NULL unless
2188 * \p f_async_sign and \p f_async_decrypt are both
2189 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002190 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002191 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002192 * for more information. This may be \c NULL if
2193 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002194 * \param config_data A pointer to configuration data which can be
2195 * retrieved with
2196 * mbedtls_ssl_conf_get_async_config_data(). The
2197 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002198 */
2199void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2200 mbedtls_ssl_async_sign_t *f_async_sign,
2201 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2202 mbedtls_ssl_async_resume_t *f_async_resume,
2203 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002204 void *config_data );
2205
2206/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002207 * \brief Retrieve the configuration data set by
2208 * mbedtls_ssl_conf_async_private_cb().
2209 *
2210 * \param conf SSL configuration context
2211 * \return The configuration data set by
2212 * mbedtls_ssl_conf_async_private_cb().
2213 */
2214void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2215
2216/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002217 * \brief Retrieve the asynchronous operation user context.
2218 *
2219 * \note This function may only be called while a handshake
2220 * is in progress.
2221 *
2222 * \param ssl The SSL context to access.
2223 *
2224 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002225 * set during the current handshake. If
2226 * mbedtls_ssl_set_async_operation_data() has not yet been
2227 * called during the current handshake, this function returns
2228 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002229 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002230void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002231
2232/**
2233 * \brief Retrieve the asynchronous operation user context.
2234 *
2235 * \note This function may only be called while a handshake
2236 * is in progress.
2237 *
2238 * \param ssl The SSL context to access.
2239 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002240 * Call mbedtls_ssl_get_async_operation_data() later during the
2241 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002242 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002243void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002244 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002245#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002246
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002247/**
2248 * \brief Callback type: generate a cookie
2249 *
2250 * \param ctx Context for the callback
2251 * \param p Buffer to write to,
2252 * must be updated to point right after the cookie
2253 * \param end Pointer to one past the end of the output buffer
2254 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002256 * \param ilen Length of info in bytes
2257 *
2258 * \return The callback must return 0 on success,
2259 * or a negative error code.
2260 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002262 unsigned char **p, unsigned char *end,
2263 const unsigned char *info, size_t ilen );
2264
2265/**
2266 * \brief Callback type: verify a cookie
2267 *
2268 * \param ctx Context for the callback
2269 * \param cookie Cookie to verify
2270 * \param clen Length of cookie
2271 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002272 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002273 * \param ilen Length of info in bytes
2274 *
2275 * \return The callback must return 0 if cookie is valid,
2276 * or a negative error code.
2277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002278typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002279 const unsigned char *cookie, size_t clen,
2280 const unsigned char *info, size_t ilen );
2281
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002282#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002283/**
2284 * \brief Register callbacks for DTLS cookies
2285 * (Server only. DTLS only.)
2286 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002287 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002288 * register working callbacks (and initialize their context).
2289 *
2290 * To disable HelloVerifyRequest, register NULL callbacks.
2291 *
2292 * \warning Disabling hello verification allows your server to be used
2293 * for amplification in DoS attacks against other hosts.
2294 * Only disable if you known this can't happen in your
2295 * particular environment.
2296 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002297 * \note See comments on \c mbedtls_ssl_handshake() about handling
2298 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2299 * on the first handshake attempt when this is enabled.
2300 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002301 * \note This is also necessary to handle client reconnection from
2302 * the same port as described in RFC 6347 section 4.2.8 (only
2303 * the variant with cookies is supported currently). See
2304 * comments on \c mbedtls_ssl_read() for details.
2305 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002306 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002307 * \param f_cookie_write Cookie write callback
2308 * \param f_cookie_check Cookie check callback
2309 * \param p_cookie Context for both callbacks
2310 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002311void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312 mbedtls_ssl_cookie_write_t *f_cookie_write,
2313 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002314 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002315
2316/**
2317 * \brief Set client's transport-level identification info.
2318 * (Server only. DTLS only.)
2319 *
2320 * This is usually the IP address (and port), but could be
2321 * anything identify the client depending on the underlying
2322 * network stack. Used for HelloVerifyRequest with DTLS.
2323 * This is *not* used to route the actual packets.
2324 *
2325 * \param ssl SSL context
2326 * \param info Transport-level info identifying the client (eg IP + port)
2327 * \param ilen Length of info in bytes
2328 *
2329 * \note An internal copy is made, so the info buffer can be reused.
2330 *
2331 * \return 0 on success,
2332 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002333 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002334 */
2335int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2336 const unsigned char *info,
2337 size_t ilen );
2338
2339#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002342/**
2343 * \brief Enable or disable anti-replay protection for DTLS.
2344 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002345 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002346 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002347 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002348 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002349 *
2350 * \warning Disabling this is a security risk unless the application
2351 * protocol handles duplicated packets in a safe way. You
2352 * should not disable this without careful consideration.
2353 * However, if your application already detects duplicated
2354 * packets and needs information about them to adjust its
2355 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002356 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002357void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002361/**
2362 * \brief Set a limit on the number of records with a bad MAC
2363 * before terminating the connection.
2364 * (DTLS only, no effect on TLS.)
2365 * Default: 0 (disabled).
2366 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002367 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002368 * \param limit Limit, or 0 to disable.
2369 *
2370 * \note If the limit is N, then the connection is terminated when
2371 * the Nth non-authentic record is seen.
2372 *
2373 * \note Records with an invalid header are not counted, only the
2374 * ones going through the authentication-decryption phase.
2375 *
2376 * \note This is a security trade-off related to the fact that it's
2377 * often relatively easy for an active attacker ot inject UDP
2378 * datagrams. On one hand, setting a low limit here makes it
2379 * easier for such an attacker to forcibly terminated a
2380 * connection. On the other hand, a high limit or no limit
2381 * might make us waste resources checking authentication on
2382 * many bogus packets.
2383 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002384void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002388
2389/**
2390 * \brief Allow or disallow packing of multiple handshake records
2391 * within a single datagram.
2392 *
2393 * \param ssl The SSL context to configure.
2394 * \param allow_packing This determines whether datagram packing may
2395 * be used or not. A value of \c 0 means that every
2396 * record will be sent in a separate datagram; a
2397 * value of \c 1 means that, if space permits,
2398 * multiple handshake messages (including CCS) belonging to
2399 * a single flight may be packed within a single datagram.
2400 *
2401 * \note This is enabled by default and should only be disabled
2402 * for test purposes, or if datagram packing causes
2403 * interoperability issues with peers that don't support it.
2404 *
2405 * \note Allowing datagram packing reduces the network load since
2406 * there's less overhead if multiple messages share the same
2407 * datagram. Also, it increases the handshake efficiency
2408 * since messages belonging to a single datagram will not
2409 * be reordered in transit, and so future message buffering
2410 * or flight retransmission (if no buffering is used) as
2411 * means to deal with reordering are needed less frequently.
2412 *
Hanno Beckereb570082018-08-24 11:28:35 +01002413 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002414 * are currently always sent in separate datagrams.
2415 *
2416 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002417void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2418 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002419
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002420/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002421 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002422 * (DTLS only, no effect on TLS.)
2423 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002424 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002425 * \param min Initial timeout value in milliseconds.
2426 * Default: 1000 (1 second).
2427 * \param max Maximum timeout value in milliseconds.
2428 * Default: 60000 (60 seconds).
2429 *
2430 * \note Default values are from RFC 6347 section 4.2.4.1.
2431 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002432 * \note The 'min' value should typically be slightly above the
2433 * expected round-trip time to your peer, plus whatever time
2434 * it takes for the peer to process the message. For example,
2435 * if your RTT is about 600ms and you peer needs up to 1s to
2436 * do the cryptographic operations in the handshake, then you
2437 * should set 'min' slightly above 1600. Lower values of 'min'
2438 * might cause spurious resends which waste network resources,
2439 * while larger value of 'min' will increase overall latency
2440 * on unreliable network links.
2441 *
2442 * \note The more unreliable your network connection is, the larger
2443 * your max / min ratio needs to be in order to achieve
2444 * reliable handshakes.
2445 *
2446 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2447 * For example, if min = 1s and max = 5s, the retransmit plan
2448 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2449 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002450 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002451void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002452#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002453
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002454#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002455/**
Paul Bakker0a597072012-09-25 21:55:46 +00002456 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002457 * If not set, no session resuming is done (except if session
2458 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002459 *
Paul Bakker0a597072012-09-25 21:55:46 +00002460 * The session cache has the responsibility to check for stale
2461 * entries based on timeout. See RFC 5246 for recommendations.
2462 *
2463 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2464 * connection shutdown, so do not cache the pointer! Either set
2465 * it to NULL or make a full copy of the certificate.
2466 *
2467 * The get callback is called once during the initial handshake
2468 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002469 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002470 * If a valid entry is found, it should fill the master of
2471 * the session object with the cached values and return 0,
2472 * return 1 otherwise. Optionally peer_cert can be set as well
2473 * if it is properly present in cache entry.
2474 *
2475 * The set callback is called once during the initial handshake
2476 * to enable session resuming after the entire handshake has
2477 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002479 * should create a cache entry for future retrieval based on
2480 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002481 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002482 * data) is cleared by the SSL/TLS layer when the connection is
2483 * terminated. It is recommended to add metadata to determine if
2484 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002485 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002486 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002487 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002488 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002489 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002490 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002491 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002492void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002493 void *p_cache,
2494 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2495 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002496#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002497
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002499/**
Paul Bakker0a597072012-09-25 21:55:46 +00002500 * \brief Request resumption of session (client-side only)
2501 * Session data is copied from presented session structure.
2502 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002503 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002504 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002505 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002506 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002507 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002508 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002509 * arguments are otherwise invalid
2510 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002511 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002513int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2514#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002515
2516/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002517 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002518 * On client, this can be used for loading saved sessions
2519 * before resuming them with mbedstls_ssl_set_session().
2520 * On server, this can be used for alternative implementations
2521 * of session cache or session tickets.
2522 *
2523 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002524 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002525 * end-entity certificate and the result of the chain
2526 * verification (unless verification was disabled), but not
2527 * the rest of the chain.
2528 *
2529 * \see mbedtls_ssl_session_save()
2530 * \see mbedtls_ssl_set_session()
2531 *
2532 * \param session The session structure to be populated. It must have been
2533 * initialised with mbedtls_ssl_session_init() but not
2534 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002535 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002536 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002537 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002538 *
2539 * \return \c 0 if successful.
2540 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2541 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01002542 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2543 * was generated in a different version or configuration of
2544 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002545 * \return Another negative value for other kinds of errors (for
2546 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002547 */
2548int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2549 const unsigned char *buf,
2550 size_t len );
2551
2552/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002553 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002554 * On client, this can be used for saving session data,
2555 * potentially in non-volatile storage, for resuming later.
2556 * On server, this can be used for alternative implementations
2557 * of session cache or session tickets.
2558 *
2559 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002560 * \see mbedtls_ssl_get_session_pointer()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002561 *
2562 * \param session The session structure to be saved.
2563 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002564 * writeable buffer of at least \p len bytes, or may be \c
2565 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002566 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002567 * \param olen The size in bytes of the data that has been or would have
2568 * been written. It must point to a valid \c size_t.
2569 *
2570 * \note \p olen is updated to the correct value regardless of
2571 * whether \p buf_len was large enough. This makes it possible
2572 * to determine the necessary size by calling this function
2573 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002574 *
2575 * \return \c 0 if successful.
2576 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2577 */
2578int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2579 unsigned char *buf,
2580 size_t buf_len,
2581 size_t *olen );
2582
2583/**
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002584 * \brief Get a pointer to the current session structure, for example
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002585 * to serialize it.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002586 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002587 * \warning Ownership of the session remains with the SSL context, and
2588 * the returned pointer is only guaranteed to be valid until
2589 * the next API call operating on the same \p ssl context.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002590 *
2591 * \see mbedtls_ssl_session_save()
2592 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002593 * \param ssl The SSL context.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002594 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002595 * \return A pointer to the current session if successful.
2596 * \return \c NULL if no session is active.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002597 */
2598const mbedtls_ssl_session *mbedtls_ssl_get_session_pointer( const mbedtls_ssl_context *ssl );
2599
2600/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002601 * \brief Set the list of allowed ciphersuites and the preference
2602 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002603 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002604 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002605 * The ciphersuites array is not copied, and must remain
2606 * valid for the lifetime of the ssl_config.
2607 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002608 * Note: The server uses its own preferences
2609 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002610 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002611 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002612 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002613 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002614 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002615void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002616 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002617
Hanno Beckera0e20d02019-05-15 14:03:01 +01002618#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01002619#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2620#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01002621/**
Hanno Becker11259522019-05-23 16:55:50 +01002622 * \brief Specify the length of Connection IDs for incoming
2623 * encrypted DTLS records, as well as the behaviour
2624 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01002625 *
2626 * By default, the CID length is set to \c 0,
2627 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002628 *
2629 * \param conf The SSL configuration to modify.
2630 * \param len The length in Bytes of the CID fields in encrypted
2631 * DTLS records using the CID mechanism. This must
2632 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01002633 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01002634 * receiving a record with an unexpected CID.
2635 * Possible values are:
2636 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2637 * In this case, the record is silently ignored.
2638 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2639 * In this case, the stack fails with the specific
2640 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002641 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002642 * \note The CID specification allows implementations to either
2643 * use a common length for all incoming connection IDs or
2644 * allow variable-length incoming IDs. Mbed TLS currently
2645 * requires a common length for all connections sharing the
2646 * same SSL configuration; this allows simpler parsing of
2647 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002648 *
2649 * \return \c 0 on success.
2650 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2651 * is too large.
2652 */
Hanno Becker8367ccc2019-05-14 11:30:10 +01002653int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2654 int ignore_other_cids );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002655#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01002656
Paul Bakker5121ce52009-01-03 21:22:43 +00002657/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002658 * \brief Set the list of allowed ciphersuites and the
2659 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002660 * (Only useful on the server side)
2661 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002662 * The ciphersuites array is not copied, and must remain
2663 * valid for the lifetime of the ssl_config.
2664 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002665 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002666 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002667 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002668 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002669 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2670 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2671 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002672 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002673 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2674 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002675 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002676void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002677 const int *ciphersuites,
2678 int major, int minor );
2679
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002680#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002681/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002682 * \brief Set the X.509 security profile used for verification
2683 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002684 * \note The restrictions are enforced for all certificates in the
2685 * chain. However, signatures in the handshake are not covered
2686 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2687 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002688 * \param conf SSL configuration
2689 * \param profile Profile to use
2690 */
2691void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002692 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002693
2694/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002695 * \brief Set the data required to verify peer certificate
2696 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002697 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002698 * parameters ca_chain (maps to trust_ca for that function)
2699 * and ca_crl.
2700 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002701 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002702 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002703 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002704 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002705void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002706 mbedtls_x509_crt *ca_chain,
2707 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002708
Hanno Becker8bf74f32019-03-27 11:01:30 +00002709#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2710/**
2711 * \brief Set the trusted certificate callback.
2712 *
2713 * This API allows to register the set of trusted certificates
2714 * through a callback, instead of a linked list as configured
2715 * by mbedtls_ssl_conf_ca_chain().
2716 *
2717 * This is useful for example in contexts where a large number
2718 * of CAs are used, and the inefficiency of maintaining them
2719 * in a linked list cannot be tolerated. It is also useful when
2720 * the set of trusted CAs needs to be modified frequently.
2721 *
2722 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2723 * more information.
2724 *
2725 * \param conf The SSL configuration to register the callback with.
2726 * \param f_ca_cb The trusted certificate callback to use when verifying
2727 * certificate chains.
2728 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2729 * a reference to a trusted CA database).
2730 *
2731 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2732 * Any call to this function overwrites the values set through
2733 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2734 * mbedtls_ssl_conf_ca_cb().
2735 *
2736 * \note This API is incompatible with CA indication in
2737 * CertificateRequest messages: A server-side SSL context which
2738 * is bound to an SSL configuration that uses a CA callback
2739 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2740 * client authentication, will send an empty CA list in the
2741 * corresponding CertificateRequest message.
2742 *
2743 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2744 * If an SSL context is bound to an SSL configuration which uses
2745 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2746 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2747 *
2748 * \note The use of this API disables the use of restartable ECC
2749 * during X.509 CRT signature verification (but doesn't affect
2750 * other uses).
2751 *
2752 * \warning This API is incompatible with the use of CRLs. Any call to
2753 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2754 * earlier calls to mbedtls_ssl_conf_ca_chain().
2755 *
2756 * \warning In multi-threaded environments, the callback \p f_ca_cb
2757 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002758 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002759 * contained in the callback context pointed to by \p p_ca_cb).
2760 */
2761void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2762 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2763 void *p_ca_cb );
2764#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2765
Paul Bakker5121ce52009-01-03 21:22:43 +00002766/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002767 * \brief Set own certificate chain and private key
2768 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002769 * \note own_cert should contain in order from the bottom up your
2770 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002771 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002772 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002773 * \note On server, this function can be called multiple times to
2774 * provision more than one cert/key pair (eg one ECDSA, one
2775 * RSA with SHA-256, one RSA with SHA-1). An adequate
2776 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002777 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002778 * adequate, preference is given to the one set by the first
2779 * call to this function, then second, etc.
2780 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002781 * \note On client, only the first call has any effect. That is,
2782 * only one client certificate can be provisioned. The
2783 * server's preferences in its CertficateRequest message will
2784 * be ignored and our only cert will be sent regardless of
2785 * whether it matches those preferences - the server can then
2786 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002787 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002788 * \note The provided \p pk_key needs to match the public key in the
2789 * first certificate in \p own_cert, or all handshakes using
2790 * that certificate will fail. It is your responsibility
2791 * to ensure that; this function will not perform any check.
2792 * You may use mbedtls_pk_check_pair() in order to perform
2793 * this check yourself, but be aware that this function can
2794 * be computationally expensive on some key types.
2795 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002796 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002797 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002798 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002799 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002800 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002801 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002802int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002803 mbedtls_x509_crt *own_cert,
2804 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002805#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002806
Gilles Peskineeccd8882020-03-10 12:19:08 +01002807#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002808/**
Hanno Becker02283042018-10-22 15:28:02 +01002809 * \brief Configure a pre-shared key (PSK) and identity
2810 * to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002811 *
2812 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002813 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002814 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002815 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
2816 * takes precedence over a PSK configured by this function.
2817 *
Hanno Becker02283042018-10-22 15:28:02 +01002818 * \warning Currently, clients can only register a single pre-shared key.
Hanno Beckerf9a32872018-11-15 13:18:25 +00002819 * Calling this function or mbedtls_ssl_conf_psk_opaque() more
Hanno Becker02283042018-10-22 15:28:02 +01002820 * than once will overwrite values configured in previous calls.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002821 * Support for setting multiple PSKs on clients and selecting
Hanno Becker02283042018-10-22 15:28:02 +01002822 * one based on the identity hint is not a planned feature,
2823 * but feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002824 *
Hanno Becker02283042018-10-22 15:28:02 +01002825 * \param conf The SSL configuration to register the PSK with.
2826 * \param psk The pointer to the pre-shared key to use.
2827 * \param psk_len The length of the pre-shared key in bytes.
2828 * \param psk_identity The pointer to the pre-shared key identity.
2829 * \param psk_identity_len The length of the pre-shared key identity
2830 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002831 *
Hanno Becker02283042018-10-22 15:28:02 +01002832 * \note The PSK and its identity are copied internally and
2833 * hence need not be preserved by the caller for the lifetime
2834 * of the SSL configuration.
2835 *
2836 * \return \c 0 if successful.
2837 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002838 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002839int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002840 const unsigned char *psk, size_t psk_len,
2841 const unsigned char *psk_identity, size_t psk_identity_len );
2842
Hanno Becker02283042018-10-22 15:28:02 +01002843#if defined(MBEDTLS_USE_PSA_CRYPTO)
2844/**
2845 * \brief Configure an opaque pre-shared key (PSK) and identity
2846 * to be used in PSK-based ciphersuites.
2847 *
2848 * \note This is mainly useful for clients. Servers will usually
2849 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2850 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002851 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
2852 * the PSK callback takes precedence over an opaque PSK
2853 * configured by this function.
2854 *
Hanno Becker02283042018-10-22 15:28:02 +01002855 * \warning Currently, clients can only register a single pre-shared key.
2856 * Calling this function or mbedtls_ssl_conf_psk() more than
2857 * once will overwrite values configured in previous calls.
2858 * Support for setting multiple PSKs on clients and selecting
2859 * one based on the identity hint is not a planned feature,
2860 * but feedback is welcomed.
2861 *
2862 * \param conf The SSL configuration to register the PSK with.
2863 * \param psk The identifier of the key slot holding the PSK.
2864 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002865 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002866 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002867 * allows its use for the key derivation algorithm applied
2868 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002869 * \param psk_identity The pointer to the pre-shared key identity.
2870 * \param psk_identity_len The length of the pre-shared key identity
2871 * in bytes.
2872 *
2873 * \note The PSK identity hint is copied internally and hence need
2874 * not be preserved by the caller for the lifetime of the
2875 * SSL configuration.
2876 *
2877 * \return \c 0 if successful.
2878 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2879 */
2880int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002881 psa_key_id_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002882 const unsigned char *psk_identity,
2883 size_t psk_identity_len );
2884#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002885
2886/**
Hanno Becker02283042018-10-22 15:28:02 +01002887 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002888 *
2889 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002890 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002891 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002892 * \note A PSK set by this function takes precedence over a PSK
2893 * configured by \c mbedtls_ssl_conf_psk().
2894 *
Hanno Becker02283042018-10-22 15:28:02 +01002895 * \param ssl The SSL context to configure a PSK for.
2896 * \param psk The pointer to the pre-shared key.
2897 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002898 *
Hanno Becker02283042018-10-22 15:28:02 +01002899 * \return \c 0 if successful.
2900 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002901 */
2902int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2903 const unsigned char *psk, size_t psk_len );
2904
Hanno Becker02283042018-10-22 15:28:02 +01002905#if defined(MBEDTLS_USE_PSA_CRYPTO)
2906/**
2907 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2908 *
2909 * \note This should only be called inside the PSK callback,
2910 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2911 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002912 * \note An opaque PSK set by this function takes precedence over an
2913 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
2914 *
Hanno Becker02283042018-10-22 15:28:02 +01002915 * \param ssl The SSL context to configure a PSK for.
2916 * \param psk The identifier of the key slot holding the PSK.
2917 * For the duration of the current handshake, the key slot
2918 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002919 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002920 * use for the key derivation algorithm
2921 * applied in the handshake.
2922 *
2923 * \return \c 0 if successful.
2924 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2925 */
2926int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002927 psa_key_id_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002928#endif /* MBEDTLS_USE_PSA_CRYPTO */
2929
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002930/**
2931 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002932 *
2933 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002934 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002935 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002936 * receive the actual PSK data and length.
2937 *
Hanno Becker02283042018-10-22 15:28:02 +01002938 * The callback has the following parameters:
2939 * - \c void*: The opaque pointer \p p_psk.
2940 * - \c mbedtls_ssl_context*: The SSL context to which
2941 * the operation applies.
2942 * - \c const unsigned char*: The PSK identity
2943 * selected by the client.
2944 * - \c size_t: The length of the PSK identity
2945 * selected by the client.
2946 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002947 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002948 * \c mbedtls_ssl_set_hs_psk() or
2949 * \c mbedtls_ssl_set_hs_psk_opaque()
2950 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002951 * Any other return value will result in a denied PSK identity.
2952 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002953 * \note A dynamic PSK (i.e. set by the PSK callback) takes
2954 * precedence over a static PSK (i.e. set by
2955 * \c mbedtls_ssl_conf_psk() or
2956 * \c mbedtls_ssl_conf_psk_opaque()).
2957 * This means that if you set a PSK callback using this
2958 * function, you don't need to set a PSK using
2959 * \c mbedtls_ssl_conf_psk() or
2960 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002961 *
Hanno Becker02283042018-10-22 15:28:02 +01002962 * \param conf The SSL configuration to register the callback with.
2963 * \param f_psk The callback for selecting and setting the PSK based
2964 * in the PSK identity chosen by the client.
2965 * \param p_psk A pointer to an opaque structure to be passed to
2966 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002967 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002968void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002970 size_t),
2971 void *p_psk );
Gilles Peskineeccd8882020-03-10 12:19:08 +01002972#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002973
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002974#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002975
2976#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2977
2978#if defined(MBEDTLS_DEPRECATED_WARNING)
2979#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2980#else
2981#define MBEDTLS_DEPRECATED
2982#endif
2983
Paul Bakker5121ce52009-01-03 21:22:43 +00002984/**
2985 * \brief Set the Diffie-Hellman public P and G values,
2986 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002987 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002988 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002989 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002990 * \param dhm_P Diffie-Hellman-Merkle modulus
2991 * \param dhm_G Diffie-Hellman-Merkle generator
2992 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002993 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2994 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002995 * \return 0 if successful
2996 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002997MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2998 const char *dhm_P,
2999 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00003000
Hanno Becker470a8c42017-10-04 15:28:46 +01003001#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01003002
3003/**
3004 * \brief Set the Diffie-Hellman public P and G values
3005 * from big-endian binary presentations.
3006 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
3007 *
3008 * \param conf SSL configuration
3009 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
3010 * \param P_len Length of DHM modulus
3011 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
3012 * \param G_len Length of DHM generator
3013 *
3014 * \return 0 if successful
3015 */
3016int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
3017 const unsigned char *dhm_P, size_t P_len,
3018 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003019
3020/**
Paul Bakker1b57b062011-01-06 15:48:19 +00003021 * \brief Set the Diffie-Hellman public P and G values,
3022 * read from existing context (server-side only)
3023 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003024 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00003025 * \param dhm_ctx Diffie-Hellman-Merkle context
3026 *
3027 * \return 0 if successful
3028 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003029int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003030#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00003031
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003032#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3033/**
3034 * \brief Set the minimum length for Diffie-Hellman parameters.
3035 * (Client-side only.)
3036 * (Default: 1024 bits.)
3037 *
3038 * \param conf SSL configuration
3039 * \param bitlen Minimum bit length of the DHM prime
3040 */
3041void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
3042 unsigned int bitlen );
3043#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3044
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003045#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01003046/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003047 * \brief Set the allowed curves in order of preference.
Gilles Peskine5ea63a32021-06-22 10:50:04 +02003048 * (Default: all defined curves in order of decreasing size,
3049 * except that Montgomery curves come last. This order
3050 * is likely to change in a future version.)
Gergely Budai987bfb52014-01-19 21:48:42 +01003051 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003052 * On server: this only affects selection of the ECDHE curve;
3053 * the curves used for ECDH and ECDSA are determined by the
3054 * list of available certificates instead.
3055 *
3056 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01003057 * use. The server can override our preference order.
3058 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003059 * Both sides: limits the set of curves accepted for use in
3060 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003061 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003062 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003063 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003064 * for that. For the end-entity certificate however, the key
3065 * will be accepted only if it is allowed both by this list
3066 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01003067 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003068 * \note This list should be ordered by decreasing preference
3069 * (preferred curve first).
3070 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003071 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003072 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01003074 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003075void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
3076 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003077#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01003078
Gilles Peskineeccd8882020-03-10 12:19:08 +01003079#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003080/**
3081 * \brief Set the allowed hashes for signatures during the handshake.
Gilles Peskine138d9f52021-06-21 09:53:25 +02003082 * (Default: all SHA-2 hashes, largest first. Also SHA-1 if
3083 * the compile-time option
3084 * `MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE` is enabled.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003085 *
3086 * \note This only affects which hashes are offered and can be used
3087 * for signatures during the handshake. Hashes for message
3088 * authentication and the TLS PRF are controlled by the
3089 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
3090 * used for certificate signature are controlled by the
3091 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
3092 *
3093 * \note This list should be ordered by decreasing preference
3094 * (preferred hash first).
3095 *
3096 * \param conf SSL configuration
3097 * \param hashes Ordered list of allowed signature hashes,
3098 * terminated by \c MBEDTLS_MD_NONE.
3099 */
3100void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
3101 const int *hashes );
Gilles Peskineeccd8882020-03-10 12:19:08 +01003102#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003103
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003104#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003105/**
Darryl Green11999bb2018-03-13 15:22:58 +00003106 * \brief Set or reset the hostname to check against the received
3107 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003108 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003109 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003110 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003111 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003112
Hanno Becker0446a392017-04-07 12:59:32 +01003113 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003114 *
Darryl Green11999bb2018-03-13 15:22:58 +00003115 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3116 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003117 * too long input hostname.
3118 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003119 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003120 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003121 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003124#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003125
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003126#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003127/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003128 * \brief Set own certificate and key for the current handshake
3129 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003130 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003131 * the SNI callback.
3132 *
3133 * \param ssl SSL context
3134 * \param own_cert own public certificate chain
3135 * \param pk_key own private key
3136 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003137 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003138 */
3139int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
3140 mbedtls_x509_crt *own_cert,
3141 mbedtls_pk_context *pk_key );
3142
3143/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003144 * \brief Set the data required to verify peer certificate for the
3145 * current handshake
3146 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003147 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003148 * the SNI callback.
3149 *
3150 * \param ssl SSL context
3151 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3152 * \param ca_crl trusted CA CRLs
3153 */
3154void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
3155 mbedtls_x509_crt *ca_chain,
3156 mbedtls_x509_crl *ca_crl );
3157
3158/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003159 * \brief Set authmode for the current handshake.
3160 *
3161 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
3162 * the SNI callback.
3163 *
3164 * \param ssl SSL context
3165 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3166 * MBEDTLS_SSL_VERIFY_REQUIRED
3167 */
3168void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
3169 int authmode );
3170
3171/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003172 * \brief Set server side ServerName TLS extension callback
3173 * (optional, server-side only).
3174 *
3175 * If set, the ServerName callback is called whenever the
3176 * server receives a ServerName TLS extension from the client
3177 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003178 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003179 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003180 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003181 * certificate(s) and key(s) to use with \c
3182 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003183 * and may optionally adjust the CA and associated CRL with \c
3184 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3185 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3186 * then must return 0. If no matching name is found, the
3187 * callback must either set a default cert, or
3188 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003189 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003190 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003191 * \param f_sni verification function
3192 * \param p_sni verification parameter
3193 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003194void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003195 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003196 size_t),
3197 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003198#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003199
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003200#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003201/**
3202 * \brief Set the EC J-PAKE password for current handshake.
3203 *
3204 * \note An internal copy is made, and destroyed as soon as the
3205 * handshake is completed, or when the SSL context is reset or
3206 * freed.
3207 *
3208 * \note The SSL context needs to be already set up. The right place
3209 * to call this function is between \c mbedtls_ssl_setup() or
3210 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
3211 *
3212 * \param ssl SSL context
3213 * \param pw EC J-PAKE password (pre-shared secret)
3214 * \param pw_len length of pw in bytes
3215 *
3216 * \return 0 on success, or a negative error code.
3217 */
3218int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3219 const unsigned char *pw,
3220 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003221#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003222
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003223#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003224/**
3225 * \brief Set the supported Application Layer Protocols.
3226 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003227 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003228 * \param protos Pointer to a NULL-terminated list of supported protocols,
3229 * in decreasing preference order. The pointer to the list is
3230 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00003231 * the lifetime of the table must be atleast as long as the
3232 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003233 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003235 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003236int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003237
3238/**
3239 * \brief Get the name of the negotiated Application Layer Protocol.
3240 * This function should be called after the handshake is
3241 * completed.
3242 *
3243 * \param ssl SSL context
3244 *
3245 * \return Protcol name, or NULL if no protocol was negotiated.
3246 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003247const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
3248#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003249
Johan Pascalb62bb512015-12-03 21:56:45 +01003250#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003251#if defined(MBEDTLS_DEBUG_C)
Johan Pascalaae4d222020-09-22 21:21:39 +02003252static inline const char *mbedtls_ssl_get_srtp_profile_as_string( mbedtls_ssl_srtp_profile profile )
Johan Pascala455cd92020-09-22 15:28:11 +02003253{
3254 switch( profile )
3255 {
3256 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003257 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003258 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003259 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003260 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003261 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003262 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003263 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003264 default: break;
3265 }
3266 return( "" );
3267}
3268#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003269/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003270 * \brief Manage support for mki(master key id) value
3271 * in use_srtp extension.
3272 * MKI is an optional part of SRTP used for key management
3273 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003274 * The default value is
3275 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003276 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003277 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003278 * \param support_mki_value Enable or disable mki usage. Values are
3279 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3280 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003281 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003282void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3283 int support_mki_value );
Ron Eldor591f1622018-01-22 12:30:04 +02003284
3285/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003286 * \brief Set the supported DTLS-SRTP protection profiles.
3287 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003288 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003289 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3290 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003291 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003292 * The pointer to the list is recorded by the library
3293 * for later reference as required, so the lifetime
3294 * of the table must be at least as long as the lifetime
3295 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003296 * The list must not hold more than
3297 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003298 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01003299 *
Johan Pascal85269572020-08-25 10:01:54 +02003300 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003301 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
3302 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01003303 */
Ron Eldora9788042018-12-05 11:04:31 +02003304int mbedtls_ssl_conf_dtls_srtp_protection_profiles
3305 ( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02003306 const mbedtls_ssl_srtp_profile *profiles );
Ron Eldor591f1622018-01-22 12:30:04 +02003307
3308/**
Ron Eldora9788042018-12-05 11:04:31 +02003309 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02003310 *
Ron Eldora9788042018-12-05 11:04:31 +02003311 * \param ssl SSL context to use.
3312 * \param mki_value The MKI value to set.
3313 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02003314 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003315 * \note This function is relevant on client side only.
3316 * The server discovers the mki value during handshake.
3317 * A mki value set on server side using this function
3318 * is ignored.
3319 *
Johan Pascal85269572020-08-25 10:01:54 +02003320 * \return 0 on success
3321 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
3322 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02003323 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003324int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
3325 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02003326 uint16_t mki_len );
Johan Pascalb62bb512015-12-03 21:56:45 +01003327/**
Johan Pascal2258a4f2020-10-28 13:53:09 +01003328 * \brief Get the negotiated DTLS-SRTP informations:
3329 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003330 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003331 * \warning This function must be called after the handshake is
3332 * completed. The value returned by this function must
3333 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01003334 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003335 * \param ssl The SSL context to query.
3336 * \param dtls_srtp_info The negotiated DTLS-SRTP informations:
3337 * - Protection profile in use.
3338 * A direct mapping of the iana defined value for protection
3339 * profile on an uint16_t.
3340 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
3341 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
3342 * or peer's Hello packet was not parsed yet.
3343 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01003344 */
Johan Pascal2258a4f2020-10-28 13:53:09 +01003345void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
3346 mbedtls_dtls_srtp_info *dtls_srtp_info );
Johan Pascalb62bb512015-12-03 21:56:45 +01003347#endif /* MBEDTLS_SSL_DTLS_SRTP */
3348
Paul Bakker5701cdc2012-09-27 21:49:42 +00003349/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003350 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003351 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003352 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003353 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003354 * \note This ignores ciphersuites from higher versions.
3355 *
3356 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3357 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003358 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003359 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
3361 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
3362 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
3363 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003364 */
Ron Eldora9788042018-12-05 11:04:31 +02003365void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00003366
Paul Bakker1d29fb52012-09-28 13:28:45 +00003367/**
3368 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02003369 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003370 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003371 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3372 * SSL_MIN_XXXXX_VERSION range is ignored.
3373 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003374 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00003375 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003376 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3377 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
3378 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003379 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003380 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
3381 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
3382 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
3383 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003384 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003385void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00003386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003388/**
3389 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003390 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003391 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003392 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003393 * connection, that is a connection with max_version set to a
3394 * lower value than the value you're willing to use. Such
3395 * fallback connections are not recommended but are sometimes
3396 * necessary to interoperate with buggy (version-intolerant)
3397 * servers.
3398 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003400 * non-fallback connections! This would appear to work for a
3401 * while, then cause failures when the server is upgraded to
3402 * support a newer TLS version.
3403 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01003404 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003406 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003407void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003408#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003411/**
3412 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003414 *
3415 * \note This should always be enabled, it is a security
3416 * improvement, and should not cause any interoperability
3417 * issue (used only if the peer supports it too).
3418 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003419 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003421 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003422void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003423#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003425#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003426/**
3427 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003428 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003429 *
3430 * \note This should always be enabled, it is a security fix to the
3431 * protocol, and should not cause any interoperability issue
3432 * (used only if the peer supports it too).
3433 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003434 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003436 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003437void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003438#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003439
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003440#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003441/**
3442 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003443 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003444 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003445 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00003446 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003447 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01003448 * \note This function is deprecated and will be removed in
Simon Butcher68c0bd72016-02-13 22:44:49 +00003449 * a future version of the library.
3450 * RC4 is disabled by default at compile time and needs to be
3451 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003452 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003453 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003454 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003455 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003456void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003457#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003458
Janos Follath088ce432017-04-10 12:42:31 +01003459#if defined(MBEDTLS_SSL_SRV_C)
3460/**
3461 * \brief Whether to send a list of acceptable CAs in
3462 * CertificateRequest messages.
3463 * (Default: do send)
3464 *
3465 * \param conf SSL configuration
3466 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3467 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3468 */
3469void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3470 char cert_req_ca_list );
3471#endif /* MBEDTLS_SSL_SRV_C */
3472
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003473#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003474/**
k-stachowiak6d722122019-02-08 17:03:33 +01003475 * \brief Set the maximum fragment length to emit and/or negotiate.
3476 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3477 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003478 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003479 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003480 * (Client: set maximum fragment length to emit *and*
3481 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003482 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003483 *
k-stachowiak6d722122019-02-08 17:03:33 +01003484 * \note On the client side, the maximum fragment length extension
3485 * *will not* be used, unless the maximum fragment length has
3486 * been set via this function to a value different than
3487 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003488 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003489 * \note With TLS, this currently only affects ApplicationData (sent
3490 * with \c mbedtls_ssl_read()), not handshake messages.
3491 * With DTLS, this affects both ApplicationData and handshake.
3492 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003493 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003494 * excluding record overhead that will be added to it, see
3495 * \c mbedtls_ssl_get_record_expansion().
3496 *
3497 * \note For DTLS, it is also possible to set a limit for the total
3498 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003499 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003500 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003501 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003502 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003503 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3504 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003505 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003506 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003507 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003508int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003512/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01003513 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01003514 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003515 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003516 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003517 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
3518 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003519 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003520void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003521#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003522
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003523#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003524/**
3525 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003526 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003527 *
3528 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
3529 * Does not affect non-CBC ciphersuites in any version.
3530 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01003531 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003532 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
3533 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003534 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003535void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003536#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003537
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003538#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003539/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003540 * \brief Enable / Disable session tickets (client only).
3541 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003542 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003543 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003544 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003545 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003546 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3547 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003548 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003549void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3550#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003551
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003553/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003554 * \brief Enable / Disable renegotiation support for connection when
3555 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003556 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003557 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003558 * \warning It is recommended to always disable renegotation unless you
3559 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003560 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003561 * renegotiation or a poor understanding of its properties.
3562 *
3563 * \note Server-side, enabling renegotiation also makes the server
3564 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003565 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003566 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003567 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3568 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003569 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003570void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003571#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003572
3573/**
3574 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003575 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003576 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003577 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003578 * be established even if the peer does not support
3579 * secure renegotiation, but does not allow renegotiation
3580 * to take place if not secure.
3581 * (Interoperable and secure option)
3582 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003583 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003584 * with non-upgraded peers. Allowing legacy renegotiation
3585 * makes the connection vulnerable to specific man in the
3586 * middle attacks. (See RFC 5746)
3587 * (Most interoperable and least secure option)
3588 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003590 * if peer does not support secure renegotiation. Results
3591 * in interoperability issues with non-upgraded peers
3592 * that do not support renegotiation altogether.
3593 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003594 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003595 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003596 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3597 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003598 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003599 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003600void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003603/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003604 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003605 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003606 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003607 * When we request a renegotiation, the peer can comply or
3608 * ignore the request. This function allows us to decide
3609 * whether to enforce our renegotiation requests by closing
3610 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003611 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003612 * However, records could already be in transit from the peer
3613 * when the request is emitted. In order to increase
3614 * reliability, we can accept a number of records before the
3615 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003616 *
3617 * The optimal value is highly dependent on the specific usage
3618 * scenario.
3619 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003620 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003621 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003622 * out or receives Application Data, until:
3623 * - max_records records have beens seen, if it is >= 0, or
3624 * - the number of retransmits that would happen during an
3625 * actual handshake has been reached.
3626 * Please remember the request might be lost a few times
3627 * if you consider setting max_records to a really low value.
3628 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003629 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003631 * which always behave as if max_record was 0. The reason is,
3632 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003633 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003634 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003635 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003637 * enforce renegotiation, or a non-negative value to enforce
3638 * it but allow for a grace period of max_records records.
3639 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003640void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003641
3642/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003643 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003644 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003645 *
3646 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003647 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003648 * threshold. The default value is meant to prevent the
3649 * connection from being closed when the counter is about to
3650 * reached its maximal value (it is not allowed to wrap).
3651 *
3652 * Lower values can be used to enforce policies such as "keys
3653 * must be refreshed every N packets with cipher X".
3654 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003655 * The renegotiation period can be disabled by setting
3656 * conf->disable_renegotiation to
3657 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3658 *
3659 * \note When the configured transport is
3660 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3661 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3662 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003663 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003664 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003665 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003666 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003667void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003668 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003669#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003670
Paul Bakker43ca69c2011-01-15 17:35:19 +00003671/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003672 * \brief Check if there is data already read from the
3673 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003674 *
3675 * \param ssl SSL context
3676 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003677 * \return 0 if nothing's pending, 1 otherwise.
3678 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003679 * \note This is different in purpose and behaviour from
3680 * \c mbedtls_ssl_get_bytes_avail in that it considers
3681 * any kind of unprocessed data, not only unread
3682 * application data. If \c mbedtls_ssl_get_bytes
3683 * returns a non-zero value, this function will
3684 * also signal pending data, but the converse does
3685 * not hold. For example, in DTLS there might be
3686 * further records waiting to be processed from
3687 * the current underlying transport's datagram.
3688 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003689 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003690 * does not imply that a subsequent call to
3691 * \c mbedtls_ssl_read will provide any data;
3692 * e.g., the unprocessed data might turn out
3693 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003694 *
3695 * \note This function is useful in the following situation:
3696 * If the SSL/TLS module successfully returns from an
3697 * operation - e.g. a handshake or an application record
3698 * read - and you're awaiting incoming data next, you
3699 * must not immediately idle on the underlying transport
3700 * to have data ready, but you need to check the value
3701 * of this function first. The reason is that the desired
3702 * data might already be read but not yet processed.
3703 * If, in contrast, a previous call to the SSL/TLS module
3704 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3705 * to call this function, as the latter error code entails
3706 * that all internal data has been processed.
3707 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003708 */
3709int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3710
3711/**
3712 * \brief Return the number of application data bytes
3713 * remaining to be read from the current record.
3714 *
3715 * \param ssl SSL context
3716 *
3717 * \return How many bytes are available in the application
3718 * data record read buffer.
3719 *
3720 * \note When working over a datagram transport, this is
3721 * useful to detect the current datagram's boundary
3722 * in case \c mbedtls_ssl_read has written the maximal
3723 * amount of data fitting into the input buffer.
3724 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003725 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003726size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003727
3728/**
3729 * \brief Return the result of the certificate verification
3730 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003731 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003732 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003733 * \return \c 0 if the certificate verification was successful.
3734 * \return \c -1u if the result is not available. This may happen
3735 * e.g. if the handshake aborts early, or a verification
3736 * callback returned a fatal error.
3737 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3738 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003739 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003740uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003741
3742/**
3743 * \brief Return the name of the current ciphersuite
3744 *
3745 * \param ssl SSL context
3746 *
3747 * \return a string containing the ciphersuite name
3748 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003749const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003750
3751/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00003752 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
3753 *
3754 * \param ssl SSL context
3755 *
3756 * \return a string containing the SSL version
3757 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003758const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003759
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003760/**
3761 * \brief Return the (maximum) number of bytes added by the record
3762 * layer: header + encryption/MAC overhead (inc. padding)
3763 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003764 * \note This function is not available (always returns an error)
3765 * when record compression is enabled.
3766 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003767 * \param ssl SSL context
3768 *
3769 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003770 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02003771 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003772 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003774
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003775#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3776/**
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003777 * \brief Return the maximum fragment length (payload, in bytes) for
3778 * the output buffer. For the client, this is the configured
3779 * value. For the server, it is the minimum of two - the
3780 * configured value and the negotiated one.
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003781 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003782 * \sa mbedtls_ssl_conf_max_frag_len()
3783 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003784 *
3785 * \param ssl SSL context
3786 *
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003787 * \return Current maximum fragment length for the output buffer.
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003788 */
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003789size_t mbedtls_ssl_get_output_max_frag_len( const mbedtls_ssl_context *ssl );
3790
3791/**
3792 * \brief Return the maximum fragment length (payload, in bytes) for
3793 * the input buffer. This is the negotiated maximum fragment
3794 * length, or, if there is none, MBEDTLS_SSL_MAX_CONTENT_LEN.
3795 * If it is not defined either, the value is 2^14. This function
3796 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
3797 *
3798 * \sa mbedtls_ssl_conf_max_frag_len()
3799 * \sa mbedtls_ssl_get_max_record_payload()
3800 *
3801 * \param ssl SSL context
3802 *
3803 * \return Current maximum fragment length for the output buffer.
3804 */
3805size_t mbedtls_ssl_get_input_max_frag_len( const mbedtls_ssl_context *ssl );
3806
3807#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3808
3809#if defined(MBEDTLS_DEPRECATED_WARNING)
3810#define MBEDTLS_DEPRECATED __attribute__((deprecated))
3811#else
3812#define MBEDTLS_DEPRECATED
3813#endif
3814
3815/**
3816 * \brief This function is a deprecated approach to getting the max
3817 * fragment length. Its an alias for
3818 * \c mbedtls_ssl_get_output_max_frag_len(), as the behaviour
3819 * is the same. See \c mbedtls_ssl_get_output_max_frag_len() for
3820 * more detail.
3821 *
3822 * \sa mbedtls_ssl_get_input_max_frag_len()
3823 * \sa mbedtls_ssl_get_output_max_frag_len()
3824 *
3825 * \param ssl SSL context
3826 *
3827 * \return Current maximum fragment length for the output buffer.
3828 */
3829MBEDTLS_DEPRECATED size_t mbedtls_ssl_get_max_frag_len(
3830 const mbedtls_ssl_context *ssl );
3831#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003832#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3833
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003834/**
3835 * \brief Return the current maximum outgoing record payload in bytes.
3836 * This takes into account the config.h setting \c
3837 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3838 * max fragment length extension if used, and for DTLS the
3839 * path MTU as configured and current record expansion.
3840 *
3841 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3842 * called with a larger length value.
3843 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3844 * necessary and return the number of bytes written; it is up
3845 * to the caller to call \c mbedtls_ssl_write() again in
3846 * order to send the remaining bytes if any.
3847 *
3848 * \note This function is not available (always returns an error)
3849 * when record compression is enabled.
3850 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003851 * \sa mbedtls_ssl_set_mtu()
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003852 * \sa mbedtls_ssl_get_output_max_frag_len()
3853 * \sa mbedtls_ssl_get_input_max_frag_len()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003854 * \sa mbedtls_ssl_get_record_expansion()
3855 *
3856 * \param ssl SSL context
3857 *
3858 * \return Current maximum payload for an outgoing record,
3859 * or a negative error code.
3860 */
3861int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003863#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003864/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003865 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003866 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003867 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003868 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003869 * \return The current peer certificate, if available.
3870 * The returned certificate is owned by the SSL context and
3871 * is valid only until the next call to the SSL API.
3872 * \return \c NULL if no peer certificate is available. This might
3873 * be because the chosen ciphersuite doesn't use CRTs
3874 * (PSK-based ciphersuites, for example), or because
3875 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3876 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003877 *
3878 * \note For one-time inspection of the peer's certificate during
3879 * the handshake, consider registering an X.509 CRT verification
3880 * callback through mbedtls_ssl_conf_verify() instead of calling
3881 * this function. Using mbedtls_ssl_conf_verify() also comes at
3882 * the benefit of allowing you to influence the verification
3883 * process, for example by masking expected and tolerated
3884 * verification failures.
3885 *
3886 * \warning You must not use the pointer returned by this function
3887 * after any further call to the SSL API, including
3888 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3889 * because the pointer might change during renegotiation,
3890 * which happens transparently to the user.
3891 * If you want to use the certificate across API calls,
3892 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003893 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003894const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3895#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003896
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003897#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003898/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003899 * \brief Save session in order to resume it later (client-side only)
3900 * Session data is copied to presented session structure.
3901 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003902 *
3903 * \param ssl SSL context
3904 * \param session session context
3905 *
3906 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003907 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003908 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003909 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003910 *
Ron Eldor00115032018-07-17 11:21:50 +03003911 * \note Only the server certificate is copied, and not the full chain,
3912 * so you should not attempt to validate the certificate again
3913 * by calling \c mbedtls_x509_crt_verify() on it.
3914 * Instead, you should use the results from the verification
3915 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3916 * after loading the session again into a new SSL context
3917 * using \c mbedtls_ssl_set_session().
3918 *
3919 * \note Once the session object is not needed anymore, you should
3920 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003921 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003922 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003923 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003924int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3925#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003926
3927/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003928 * \brief Perform the SSL handshake
3929 *
3930 * \param ssl SSL context
3931 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003932 * \return \c 0 if successful.
3933 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003934 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003935 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003936 * transport - in this case you must call this function again
3937 * when the underlying transport is ready for the operation.
3938 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3939 * operation is in progress (see
3940 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3941 * must call this function again when the operation is ready.
3942 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3943 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3944 * in this case you must call this function again to complete
3945 * the handshake when you're done attending other tasks.
3946 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3947 * and the client did not demonstrate reachability yet - in
3948 * this case you must stop using the context (see below).
3949 * \return Another SSL error code - in this case you must stop using
3950 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003951 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003952 * \warning If this function returns something other than
3953 * \c 0,
3954 * #MBEDTLS_ERR_SSL_WANT_READ,
3955 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3956 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3957 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3958 * you must stop using the SSL context for reading or writing,
3959 * and either free it or call \c mbedtls_ssl_session_reset()
3960 * on it before re-using it for a new connection; the current
3961 * connection must be closed.
3962 *
3963 * \note If DTLS is in use, then you may choose to handle
3964 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3965 * purposes, as it is an expected return value rather than an
3966 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003967 *
3968 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003969 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003970 * from the underlying transport layer is currently being processed,
3971 * and it is safe to idle until the timer or the underlying transport
3972 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003973 * in which case the datagram of the underlying transport that is
3974 * currently being processed might or might not contain further
3975 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003976 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003977int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003978
3979/**
Paul Bakker1961b702013-01-25 14:49:24 +01003980 * \brief Perform a single step of the SSL handshake
3981 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003982 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003983 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003984 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003985 *
3986 * \param ssl SSL context
3987 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003988 * \return See mbedtls_ssl_handshake().
3989 *
3990 * \warning If this function returns something other than \c 0,
3991 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3992 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3993 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3994 * the SSL context for reading or writing, and either free it
3995 * or call \c mbedtls_ssl_session_reset() on it before
3996 * re-using it for a new connection; the current connection
3997 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003998 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003999int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01004000
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004001#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01004002/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004003 * \brief Initiate an SSL renegotiation on the running connection.
4004 * Client: perform the renegotiation right now.
4005 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00004006 * during the next call to mbedtls_ssl_read() if honored by
4007 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00004008 *
4009 * \param ssl SSL context
4010 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00004011 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004012 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
4013 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004014 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004015 * \warning If this function returns something other than \c 0,
4016 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4017 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4018 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4019 * the SSL context for reading or writing, and either free it
4020 * or call \c mbedtls_ssl_session_reset() on it before
4021 * re-using it for a new connection; the current connection
4022 * must be closed.
4023 *
Paul Bakker48916f92012-09-16 19:57:18 +00004024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004025int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
4026#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004027
4028/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004029 * \brief Read at most 'len' application data bytes
4030 *
4031 * \param ssl SSL context
4032 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02004033 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00004034 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004035 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004036 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04004037 * without sending a CloseNotify beforehand, which might happen
4038 * because of various reasons (internal error of an underlying
4039 * stack, non-conformant peer not sending a CloseNotify and
4040 * such) - in this case you must stop using the context
4041 * (see below).
4042 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
4043 * transport is still functional, but the peer has
4044 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004045 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004046 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004047 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004048 * transport - in this case you must call this function again
4049 * when the underlying transport is ready for the operation.
4050 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4051 * operation is in progress (see
4052 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4053 * must call this function again when the operation is ready.
4054 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4055 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4056 * in this case you must call this function again to complete
4057 * the handshake when you're done attending other tasks.
4058 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
4059 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004060 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004061 * \return Another SSL error code - in this case you must stop using
4062 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004063 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004064 * \warning If this function returns something other than
4065 * a positive value,
4066 * #MBEDTLS_ERR_SSL_WANT_READ,
4067 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4068 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4069 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4070 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
4071 * you must stop using the SSL context for reading or writing,
4072 * and either free it or call \c mbedtls_ssl_session_reset()
4073 * on it before re-using it for a new connection; the current
4074 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004075 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004076 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004077 * (which can only happen server-side), it means that a client
4078 * is initiating a new connection using the same source port.
4079 * You can either treat that as a connection close and wait
4080 * for the client to resend a ClientHello, or directly
4081 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004082 * context (as it has been reset internally). Either way, you
4083 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004084 * connection: application state, if any, should be reset, and
4085 * most importantly the identity of the client must be checked
4086 * again. WARNING: not validating the identity of the client
4087 * again, or not transmitting the new identity to the
4088 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01004089 *
Hanno Becker8ec81022017-10-10 10:35:08 +01004090 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004091 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004092 * from the underlying transport layer is currently being processed,
4093 * and it is safe to idle until the timer or the underlying transport
4094 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004095 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
4096 * initially available on the underlying transport, as this data may have
4097 * been only e.g. duplicated messages or a renegotiation request.
4098 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
4099 * when reacting to an incoming-data event from the underlying transport.
4100 * - On success, the datagram of the underlying transport that is currently
4101 * being processed may contain further DTLS records. You should call
4102 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01004103 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004104 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004105int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00004106
4107/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004108 * \brief Try to write exactly 'len' application data bytes
4109 *
4110 * \warning This function will do partial writes in some cases. If the
4111 * return value is non-negative but less than length, the
4112 * function must be called again with updated arguments:
4113 * buf + ret, len - ret (if ret is the return value) until
4114 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00004115 *
4116 * \param ssl SSL context
4117 * \param buf buffer holding the data
4118 * \param len how many bytes must be written
4119 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004120 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004121 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004122 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004123 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004124 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004125 * transport - in this case you must call this function again
4126 * when the underlying transport is ready for the operation.
4127 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4128 * operation is in progress (see
4129 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4130 * must call this function again when the operation is ready.
4131 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4132 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4133 * in this case you must call this function again to complete
4134 * the handshake when you're done attending other tasks.
4135 * \return Another SSL error code - in this case you must stop using
4136 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00004137 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004138 * \warning If this function returns something other than
4139 * a non-negative value,
4140 * #MBEDTLS_ERR_SSL_WANT_READ,
4141 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4142 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4143 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4144 * you must stop using the SSL context for reading or writing,
4145 * and either free it or call \c mbedtls_ssl_session_reset()
4146 * on it before re-using it for a new connection; the current
4147 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004148 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004149 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00004150 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004151 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004152 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004153 * some partial data in the output buffer, however this is not
4154 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02004155 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00004156 * \note If the requested length is greater than the maximum
4157 * fragment length (either the built-in limit or the one set
4158 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004159 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004160 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004161 * \c mbedtls_ssl_get_output_max_frag_len() may be used to
4162 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004163 *
4164 * \note Attempting to write 0 bytes will result in an empty TLS
4165 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004166 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004167int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00004168
4169/**
Paul Bakker0a925182012-04-16 06:46:41 +00004170 * \brief Send an alert message
4171 *
4172 * \param ssl SSL context
4173 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004174 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004175 * \param message The alert message (SSL_ALERT_MSG_*)
4176 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004177 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004178 *
4179 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004180 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4181 * the SSL context for reading or writing, and either free it or
4182 * call \c mbedtls_ssl_session_reset() on it before re-using it
4183 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004184 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004185int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004186 unsigned char level,
4187 unsigned char message );
4188/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004189 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004190 *
4191 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004192 *
4193 * \return 0 if successful, or a specific SSL error code.
4194 *
4195 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004196 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4197 * the SSL context for reading or writing, and either free it or
4198 * call \c mbedtls_ssl_session_reset() on it before re-using it
4199 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004200 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004201int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00004202
4203/**
Paul Bakker48916f92012-09-16 19:57:18 +00004204 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004205 *
4206 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00004207 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004208void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00004209
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004210#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004211/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004212 * \brief Save an active connection as serialized data in a buffer.
4213 * This allows the freeing or re-using of the SSL context
4214 * while still picking up the connection later in a way that
4215 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004216 *
4217 * \see mbedtls_ssl_context_load()
4218 *
4219 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004220 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004221 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
4222 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004223 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004224 * mbedtls_ssl_session_reset() on \p ssl which as a result is
4225 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004226 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004227 * state. You're then free to either re-use the context
4228 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004229 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004230 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004231 *
4232 * \param ssl The SSL context to save. On success, it is no longer
4233 * associated with the connection that has been serialized.
4234 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03004235 * writeable buffer of at least \p buf_len bytes, or may be \c
4236 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004237 * \param buf_len The number of bytes available for writing in \p buf.
4238 * \param olen The size in bytes of the data that has been or would have
4239 * been written. It must point to a valid \c size_t.
4240 *
4241 * \note \p olen is updated to the correct value regardless of
4242 * whether \p buf_len was large enough. This makes it possible
4243 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004244 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
4245 * the value of \p olen is only guaranteed to be correct when
4246 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
4247 * \c 0. If the return value is different, then the value of
4248 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004249 *
4250 * \return \c 0 if successful.
4251 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004252 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
4253 * while reseting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004254 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004255 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004256 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004257 * ciphersuite, or renegotiation is enabled.
4258 */
4259int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4260 unsigned char *buf,
4261 size_t buf_len,
4262 size_t *olen );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004263
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004264/**
4265 * \brief Load serialized connection data to an SSL context.
4266 *
4267 * \see mbedtls_ssl_context_save()
4268 *
4269 * \warning The same serialized data must never be loaded into more
4270 * that one context. In order to ensure that, after
4271 * successfully loading serialized data to an SSL context, you
4272 * should immediately destroy or invalidate all copies of the
4273 * serialized data that was loaded. Loading the same data in
4274 * more than one context would cause severe security failures
4275 * including but not limited to loss of confidentiality.
4276 *
4277 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004278 * prepared in one of the two following ways. The first way is
4279 * to take a context freshly initialised with
4280 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004281 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004282 * the original connection. The second way is to
4283 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004284 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004285 * Either way, you must not use the context to perform a
4286 * handshake between calling mbedtls_ssl_setup() or
4287 * mbedtls_ssl_session_reset() and calling this function. You
4288 * may however call other setter functions in that time frame
4289 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004290 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004291 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004292 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004293 * and settings before you can use the connection again
4294 * (unless they were already set before calling
4295 * mbedtls_ssl_session_reset() and the values are suitable for
4296 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02004297 * at least mbedtls_ssl_set_bio() and
4298 * mbedtls_ssl_set_timer_cb(). All other SSL setter functions
4299 * are not necessary to call, either because they're only used
4300 * in handshakes, or because the setting is already saved. You
4301 * might choose to call them anyway, for example in order to
4302 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004303 * connection and the case of loading an already-established
4304 * connection.
4305 *
4306 * \note If you have new information about the path MTU, you want to
4307 * call mbedtls_ssl_set_mtu() after calling this function, as
4308 * otherwise this function would overwrite your
4309 * newly-configured value with the value that was active when
4310 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004311 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004312 * \note When this function returns an error code, it calls
4313 * mbedtls_ssl_free() on \p ssl. In this case, you need to
4314 * prepare the context with the usual sequence starting with a
4315 * call to mbedtls_ssl_init() if you want to use it again.
4316 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004317 * \param ssl The SSL context structure to be populated. It must have
4318 * been prepared as described in the note above.
4319 * \param buf The buffer holding the serialized connection data. It must
4320 * be a readable buffer of at least \p len bytes.
4321 * \param len The size of the serialized data in bytes.
4322 *
4323 * \return \c 0 if successful.
4324 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004325 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
4326 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004327 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4328 */
4329int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
4330 const unsigned char *buf,
4331 size_t len );
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004332#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004333
4334/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004335 * \brief Initialize an SSL configuration context
4336 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004337 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004338 *
4339 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01004340 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004341 *
4342 * \param conf SSL configuration context
4343 */
4344void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
4345
4346/**
4347 * \brief Load reasonnable default SSL configuration values.
4348 * (You need to call mbedtls_ssl_config_init() first.)
4349 *
4350 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004351 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4352 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4353 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004354 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004355 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004356 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004357 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004358 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004359 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004360 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004361int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004362 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004363
4364/**
4365 * \brief Free an SSL configuration context
4366 *
4367 * \param conf SSL configuration context
4368 */
4369void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
4370
4371/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004372 * \brief Initialize SSL session structure
4373 *
4374 * \param session SSL session
4375 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004376void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004377
4378/**
Paul Bakker0a597072012-09-25 21:55:46 +00004379 * \brief Free referenced items in an SSL session including the
4380 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004381 *
Ron Eldor00115032018-07-17 11:21:50 +03004382 * \note A session object can be freed even if the SSL context
4383 * that was used to retrieve the session is still in use.
4384 *
Paul Bakker48916f92012-09-16 19:57:18 +00004385 * \param session SSL session
4386 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00004388
Ron Eldor51d3ab52019-05-12 14:54:30 +03004389/**
4390 * \brief TLS-PRF function for key derivation.
4391 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02004392 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004393 * \param secret Secret for the key derivation function.
4394 * \param slen Length of the secret.
4395 * \param label String label for the key derivation function,
4396 * terminated with null character.
4397 * \param random Random bytes.
4398 * \param rlen Length of the random bytes buffer.
4399 * \param dstbuf The buffer holding the derived key.
4400 * \param dlen Length of the output buffer.
4401 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02004402 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004403 */
4404int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
4405 const unsigned char *secret, size_t slen,
4406 const char *label,
4407 const unsigned char *random, size_t rlen,
4408 unsigned char *dstbuf, size_t dlen );
4409
Paul Bakker5121ce52009-01-03 21:22:43 +00004410#ifdef __cplusplus
4411}
4412#endif
4413
4414#endif /* ssl.h */