blob: 541fcc8e6f453fe6a66823565c410908872dc5d9 [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
Dave Rodgman7ff79652023-11-03 12:04:52 +00008 * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
Paul Bakker5121ce52009-01-03 21:22:43 +00009 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020010#ifndef MBEDTLS_SSL_H
11#define MBEDTLS_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020013#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Amero6609aef2019-07-04 20:01:14 +010014#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020015#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020016#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020017#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010018
Jaeden Amero6609aef2019-07-04 20:01:14 +010019#include "mbedtls/bignum.h"
20#include "mbedtls/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020021
Jaeden Amero6609aef2019-07-04 20:01:14 +010022#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000023
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010025#include "mbedtls/x509_crt.h"
26#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020027#endif
Paul Bakkered27a042013-04-18 22:46:23 +020028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010030#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000031#endif
32
John Durkop07cc04a2020-11-16 22:08:34 -080033/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
34 * to guards also being in ssl_srv.c and ssl_cli.c. There is a gap
35 * in functionality that access to ecdh_ctx structure is needed for
36 * MBEDTLS_ECDSA_C which does not seem correct.
37 */
38#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010039#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010040#endif
41
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#if defined(MBEDTLS_ZLIB_SUPPORT)
Hanno Beckere494e202018-03-08 13:26:12 +000043
44#if defined(MBEDTLS_DEPRECATED_WARNING)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010045#warning \
46 "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and will be removed in the next major revision of the library"
Hanno Beckere494e202018-03-08 13:26:12 +000047#endif
48
49#if defined(MBEDTLS_DEPRECATED_REMOVED)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +010050#error \
51 "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and cannot be used if MBEDTLS_DEPRECATED_REMOVED is set"
Hanno Beckere494e202018-03-08 13:26:12 +000052#endif
53
Paul Bakker2770fbd2012-07-03 13:30:23 +000054#include "zlib.h"
55#endif
56
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020057#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010058#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020059#endif
60
Hanno Becker43633132018-10-22 15:31:03 +010061#if defined(MBEDTLS_USE_PSA_CRYPTO)
62#include "psa/crypto.h"
63#endif /* MBEDTLS_USE_PSA_CRYPTO */
64
Paul Bakker13e2dfe2009-07-28 07:18:38 +000065/*
66 * SSL Error codes
67 */
Gilles Peskinea3974432021-07-26 18:48:10 +020068/** The requested feature is not available. */
69#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
70/** Bad input parameters to function. */
71#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
72/** Verification of the message MAC failed. */
73#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
74/** An invalid SSL record was received. */
75#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
76/** The connection indicated an EOF. */
77#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
78/** An unknown cipher was received. */
79#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300
80/** The server has no ciphersuites in common with the client. */
81#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380
82/** No RNG was provided to the SSL module. */
83#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
84/** No client certification received from the client, but required by the authentication mode. */
85#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
86/** Our own certificate(s) is/are too large to send in an SSL message. */
87#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500
88/** The own certificate is not set, but needed by the server. */
89#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580
90/** The own private key or pre-shared key is not set, but needed. */
91#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
92/** No CA Chain is set, but required to operate. */
93#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
94/** An unexpected message was received from our peer. */
95#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
96/** A fatal alert message was received from our peer. */
97#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
98/** Verification of our peer failed. */
99#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800
100/** The peer notified us that the connection is going to be closed. */
101#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
102/** Processing of the ClientHello handshake message failed. */
103#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900
104/** Processing of the ServerHello handshake message failed. */
105#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980
106/** Processing of the Certificate handshake message failed. */
107#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00
108/** Processing of the CertificateRequest handshake message failed. */
109#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80
110/** Processing of the ServerKeyExchange handshake message failed. */
111#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00
112/** Processing of the ServerHelloDone handshake message failed. */
113#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80
114/** Processing of the ClientKeyExchange handshake message failed. */
115#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00
116/** Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
117#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80
118/** Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
119#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00
120/** Processing of the CertificateVerify handshake message failed. */
121#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80
122/** Processing of the ChangeCipherSpec handshake message failed. */
123#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00
124/** Processing of the Finished handshake message failed. */
125#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80
126/** Memory allocation failed */
127#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
128/** Hardware acceleration function returned with error */
129#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
130/** Hardware acceleration function skipped / left alone data */
131#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
132/** Processing of the compression / decompression failed */
133#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00
134/** Handshake protocol not within min/max boundaries */
135#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80
136/** Processing of the NewSessionTicket handshake message failed. */
137#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00
138/** Session ticket has expired. */
139#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
140/** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
141#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
142/** Unknown identity received (eg, PSK identity) */
143#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
144/** Internal error (eg, unexpected failure in lower-level module) */
145#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
146/** A counter would wrap (eg, too many messages exchanged). */
147#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
148/** Unexpected message at ServerHello in renegotiation. */
149#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
150/** DTLS client must retry for hello verification */
151#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
152/** A buffer is too small to receive or write a message */
153#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
154/** None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
155#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980
156/** No data of requested type currently available on underlying transport. */
157#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
158/** Connection requires a write call. */
159#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
160/** The operation timed out. */
161#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
162/** The client initiated a reconnect from the same port. */
163#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
164/** Record header looks valid but is not expected. */
165#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
166/** The alert message received indicates a non-fatal error. */
167#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
168/** Couldn't set the hash for verifying CertificateVerify */
169#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600
170/** Internal-only message signaling that further message-processing should be done */
171#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
172/** The asynchronous operation is not completed yet. */
173#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
174/** Internal-only message signaling that a message arrived early. */
175#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
176/** An encrypted DTLS-frame with an unexpected CID was received. */
177#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
178/** An operation failed due to an unexpected version or configuration. */
179#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
180/** A cryptographic operation is in progress. Try again later. */
181#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
182/** Invalid value in SSL config */
183#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
Gilles Peskine917dd8b2023-09-29 13:39:49 +0200184/** Cache entry not found */
185#define MBEDTLS_ERR_SSL_CACHE_ENTRY_NOT_FOUND -0x5E00
Gilles Peskine63f958d2025-02-13 13:46:03 +0100186/** Attempt to verify a certificate without an expected hostname.
187 * This is usually insecure.
188 *
189 * In TLS clients, when a client authenticates a server through its
190 * certificate, the client normally checks three things:
191 * - the certificate chain must be valid;
192 * - the chain must start from a trusted CA;
193 * - the certificate must cover the server name that is expected by the client.
194 *
195 * Omitting any of these checks is generally insecure, and can allow a
196 * malicious server to impersonate a legitimate server.
197 *
198 * The third check may be safely skipped in some unusual scenarios,
199 * such as networks where eavesdropping is a risk but not active attacks,
200 * or a private PKI where the client equally trusts all servers that are
201 * accredited by the root CA.
202 *
203 * You should call mbedtls_ssl_set_hostname() with the expected server name
204 * before starting a TLS handshake on a client (unless the client is
205 * set up to only use PSK-based authentication, which does not rely on the
206 * host name). If you have determined that server name verification is not
207 * required for security in your scenario, call mbedtls_ssl_set_hostname()
208 * with \p NULL as the server name.
209 *
210 * This error is raised if all of the following conditions are met:
211 *
212 * - A TLS client is configured with the authentication mode
213 * #MBEDTLS_SSL_VERIFY_REQUIRED (default).
214 * - Certificate authentication is enabled.
215 * - The client does not call mbedtls_ssl_set_hostname().
Gilles Peskineae59c522025-02-13 13:46:58 +0100216 * - The configuration option
217 * #MBEDTLS_SSL_CLI_ALLOW_WEAK_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME
218 * is not enabled.
Gilles Peskine63f958d2025-02-13 13:46:03 +0100219 */
220#define MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME -0x5D80
Paul Bakker5121ce52009-01-03 21:22:43 +0000221
222/*
223 * Various constants
224 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200225#define MBEDTLS_SSL_MAJOR_VERSION_3 3
226#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
227#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
228#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
229#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Hanno Becker2ab47dc2020-05-04 12:19:12 +0100230#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 (experimental) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
233#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100234
Simon Butcher9f812312015-09-28 19:22:33 +0100235#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200236#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
237
238#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 +0100239
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200240/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200241 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
243#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
244#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
245#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
246#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
247#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200249#define MBEDTLS_SSL_IS_CLIENT 0
250#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200251
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200252#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
253#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200254
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200255#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
256#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200257
Hanno Becker019f4b52019-04-09 15:12:56 +0100258#define MBEDTLS_SSL_CID_DISABLED 0
259#define MBEDTLS_SSL_CID_ENABLED 1
260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#define MBEDTLS_SSL_ETM_DISABLED 0
262#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#define MBEDTLS_SSL_COMPRESS_NULL 0
265#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267#define MBEDTLS_SSL_VERIFY_NONE 0
268#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
269#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200270#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000271
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200272#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
273#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
276#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
279#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
282#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
285#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
286#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
289#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
290#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
293#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200294
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100295#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
296#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#define MBEDTLS_SSL_ARC4_ENABLED 0
299#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100300
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200301#define MBEDTLS_SSL_PRESET_DEFAULT 0
302#define MBEDTLS_SSL_PRESET_SUITEB 2
303
Janos Follath088ce432017-04-10 12:42:31 +0100304#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
305#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
306
Ron Eldor591f1622018-01-22 12:30:04 +0200307#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
308#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
309
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200310/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200311 * Default range for DTLS retransmission timer value, in milliseconds.
312 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
315#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200316
Paul Bakker088c5c52014-04-25 11:11:10 +0200317/**
318 * \name SECTION: Module settings
319 *
320 * The configuration options you can set for this module are in this section.
321 * Either change them in config.h or define them on the compiler command line.
322 * \{
323 */
324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
326#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200327#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200328
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200329/*
Angus Grattond8213d02016-05-25 20:56:48 +1000330 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200331 * determines the size of each of the two internal I/O buffers.
332 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200333 * Note: the RFC defines the default size of SSL / TLS messages. If you
334 * change the value here, other clients / servers may not be able to
335 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200336 * both sides of the connection and have it reduced at both sides, or
337 * if you're using the Max Fragment Length extension and you know all your
338 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
341#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200342#endif
343
Angus Grattond8213d02016-05-25 20:56:48 +1000344#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
345#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
346#endif
347
348#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
349#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
350#endif
351
Hanno Becker28007512018-08-28 09:46:44 +0100352/*
353 * Maximum number of heap-allocated bytes for the purpose of
354 * DTLS handshake message reassembly and future message buffering.
355 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100356#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100357#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100358#endif
359
Hanno Becker019f4b52019-04-09 15:12:56 +0100360/*
361 * Maximum length of CIDs for incoming and outgoing messages.
362 */
363#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100364#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100365#endif
366
367#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
368#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
369#endif
370
Hanno Beckerb1aa1b32019-05-08 17:37:58 +0100371#if !defined(MBEDTLS_SSL_CID_PADDING_GRANULARITY)
372#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
373#endif
374
Hanno Beckerceef8482020-06-02 06:16:00 +0100375#if !defined(MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY)
376#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +0100377#endif
378
Andrzej Kurek73afe272022-01-24 10:31:06 -0500379/** \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000380
381/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100382 * Length of the verify data for secure renegotiation
383 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384#if defined(MBEDTLS_SSL_PROTO_SSL3)
385#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100386#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100388#endif
389
390/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200391 * Signaling ciphersuite values (SCSV)
392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200393#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000394#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000395
Paul Bakker5121ce52009-01-03 21:22:43 +0000396/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000397 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200398 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000399 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400#define MBEDTLS_SSL_HASH_NONE 0
401#define MBEDTLS_SSL_HASH_MD5 1
402#define MBEDTLS_SSL_HASH_SHA1 2
403#define MBEDTLS_SSL_HASH_SHA224 3
404#define MBEDTLS_SSL_HASH_SHA256 4
405#define MBEDTLS_SSL_HASH_SHA384 5
406#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408#define MBEDTLS_SSL_SIG_ANON 0
409#define MBEDTLS_SSL_SIG_RSA 1
410#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000411
412/*
Paul Bakker926af752012-11-23 13:38:07 +0100413 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200414 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
417#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100418
419/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000420 * Message, alert and handshake types
421 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
423#define MBEDTLS_SSL_MSG_ALERT 21
424#define MBEDTLS_SSL_MSG_HANDSHAKE 22
425#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100426#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200428#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
429#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
432#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
433#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
434#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
435#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
436#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
437#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
438#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
439#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
440#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
441#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
442#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
443#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
444#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
445#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
446#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
447#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
448#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
449#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
450#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
451#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
452#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
453#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
454#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
455#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
456#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
457#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
458#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
459#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000460
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200461#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
462#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
463#define MBEDTLS_SSL_HS_SERVER_HELLO 2
464#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
465#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
466#define MBEDTLS_SSL_HS_CERTIFICATE 11
467#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
468#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
469#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
470#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
471#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
472#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000473
474/*
475 * TLS extensions
476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477#define MBEDTLS_TLS_EXT_SERVERNAME 0
478#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200480#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
485#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000486
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200487#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100488
Johan Pascalb62bb512015-12-03 21:56:45 +0100489#define MBEDTLS_TLS_EXT_USE_SRTP 14
490
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200491#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200492
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200493#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
494#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200495
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200496#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200497
Hanno Becker0652bc52019-04-25 16:24:57 +0100498/* The value of the CID extension is still TBD as of
Hanno Beckerebcc9132019-05-15 10:26:32 +0100499 * draft-ietf-tls-dtls-connection-id-05
Gilles Peskine065a1c82021-04-24 13:35:41 +0200500 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05).
501 *
502 * A future minor revision of Mbed TLS may change the default value of
503 * this option to match evolving standards and usage.
504 */
505#if !defined(MBEDTLS_TLS_EXT_CID)
Hanno Becker064b7322019-05-03 12:42:13 +0100506#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Gilles Peskine065a1c82021-04-24 13:35:41 +0200507#endif
Hanno Becker0652bc52019-04-25 16:24:57 +0100508
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200509#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
510
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200511#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000512
Johan Pascalb62bb512015-12-03 21:56:45 +0100513/*
Paul Bakkered27a042013-04-18 22:46:23 +0200514 * Size defines
515 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200516#if !defined(MBEDTLS_PSK_MAX_LEN)
517#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200518#endif
519
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200520/* Dummy type used only for its size */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100521union mbedtls_ssl_premaster_secret {
Gilles Peskinee5507d52023-06-25 21:41:58 +0200522 unsigned char dummy; /* Make the union non-empty even with SSL disabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200524 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
525#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200526#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
527 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200528#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
530 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
531 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
532 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
533 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200534#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
536 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200537#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200538#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
539 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100540 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200541#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200542#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
543 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200544#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200545#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
546 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100547 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200548#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200549#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
550 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
551#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200552};
553
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100554#define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200555
Paul Bakker407a0da2013-06-27 14:29:21 +0200556#ifdef __cplusplus
557extern "C" {
558#endif
559
Paul Bakkered27a042013-04-18 22:46:23 +0200560/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000561 * SSL state machine
562 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100563typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564 MBEDTLS_SSL_HELLO_REQUEST,
565 MBEDTLS_SSL_CLIENT_HELLO,
566 MBEDTLS_SSL_SERVER_HELLO,
567 MBEDTLS_SSL_SERVER_CERTIFICATE,
568 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
569 MBEDTLS_SSL_CERTIFICATE_REQUEST,
570 MBEDTLS_SSL_SERVER_HELLO_DONE,
571 MBEDTLS_SSL_CLIENT_CERTIFICATE,
572 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
573 MBEDTLS_SSL_CERTIFICATE_VERIFY,
574 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
575 MBEDTLS_SSL_CLIENT_FINISHED,
576 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
577 MBEDTLS_SSL_SERVER_FINISHED,
578 MBEDTLS_SSL_FLUSH_BUFFERS,
579 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
580 MBEDTLS_SSL_HANDSHAKE_OVER,
581 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
582 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000583}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000585
Ron Eldor51d3ab52019-05-12 14:54:30 +0300586/*
587 * The tls_prf function types.
588 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100589typedef enum {
590 MBEDTLS_SSL_TLS_PRF_NONE,
591 MBEDTLS_SSL_TLS_PRF_SSL3,
592 MBEDTLS_SSL_TLS_PRF_TLS1,
593 MBEDTLS_SSL_TLS_PRF_SHA384,
594 MBEDTLS_SSL_TLS_PRF_SHA256
Ron Eldor51d3ab52019-05-12 14:54:30 +0300595}
596mbedtls_tls_prf_types;
Simon Butchere846b512016-03-01 17:31:49 +0000597/**
598 * \brief Callback type: send data on the network.
599 *
600 * \note That callback may be either blocking or non-blocking.
601 *
602 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000603 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000604 * \param len Length of the data to send
605 *
606 * \return The callback must return the number of bytes sent if any,
607 * or a non-zero error code.
608 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
609 * must be returned when the operation would block.
610 *
Simon Butcherd567a232016-03-09 20:19:21 +0000611 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000612 * It must always return the number of bytes actually sent.
613 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100614typedef int mbedtls_ssl_send_t(void *ctx,
615 const unsigned char *buf,
616 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000617
618/**
619 * \brief Callback type: receive data from the network.
620 *
621 * \note That callback may be either blocking or non-blocking.
622 *
623 * \param ctx Context for the receive callback (typically a file
624 * descriptor)
625 * \param buf Buffer to write the received data to
626 * \param len Length of the receive buffer
627 *
Hanno Beckerc8ac7852021-07-23 07:23:47 +0100628 * \returns If data has been received, the positive number of bytes received.
629 * \returns \c 0 if the connection has been closed.
630 * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
Simon Butchere846b512016-03-01 17:31:49 +0000631 * must be returned when the operation would block.
Hanno Beckerc8ac7852021-07-23 07:23:47 +0100632 * \returns Another negative error code on other kinds of failures.
Simon Butchere846b512016-03-01 17:31:49 +0000633 *
Simon Butcherd567a232016-03-09 20:19:21 +0000634 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000635 * buffer. It must always return the number of bytes actually
636 * received and written to the buffer.
637 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100638typedef int mbedtls_ssl_recv_t(void *ctx,
639 unsigned char *buf,
640 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000641
642/**
643 * \brief Callback type: receive data from the network, with timeout
644 *
645 * \note That callback must block until data is received, or the
646 * timeout delay expires, or the operation is interrupted by a
647 * signal.
648 *
649 * \param ctx Context for the receive callback (typically a file descriptor)
650 * \param buf Buffer to write the received data to
651 * \param len Length of the receive buffer
Tom Cosgrove49f99bc2022-12-04 16:44:21 +0000652 * \param timeout Maximum number of milliseconds to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000653 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000654 *
655 * \return The callback must return the number of bytes received,
656 * or a non-zero error code:
657 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
658 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
659 *
Simon Butcherd567a232016-03-09 20:19:21 +0000660 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000661 * buffer. It must always return the number of bytes actually
662 * received and written to the buffer.
663 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100664typedef int mbedtls_ssl_recv_timeout_t(void *ctx,
665 unsigned char *buf,
666 size_t len,
667 uint32_t timeout);
Simon Butchere846b512016-03-01 17:31:49 +0000668/**
669 * \brief Callback type: set a pair of timers/delays to watch
670 *
671 * \param ctx Context pointer
672 * \param int_ms Intermediate delay in milliseconds
673 * \param fin_ms Final delay in milliseconds
674 * 0 cancels the current timer.
675 *
676 * \note This callback must at least store the necessary information
677 * for the associated \c mbedtls_ssl_get_timer_t callback to
678 * return correct information.
679 *
Tom Cosgrove5205c972022-07-28 06:12:08 +0100680 * \note If using an event-driven style of programming, an event must
Simon Butchere846b512016-03-01 17:31:49 +0000681 * be generated when the final delay is passed. The event must
682 * cause a call to \c mbedtls_ssl_handshake() with the proper
683 * SSL context to be scheduled. Care must be taken to ensure
684 * that at most one such call happens at a time.
685 *
686 * \note Only one timer at a time must be running. Calling this
687 * function while a timer is running must cancel it. Cancelled
688 * timers must not generate any event.
689 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100690typedef void mbedtls_ssl_set_timer_t(void *ctx,
691 uint32_t int_ms,
692 uint32_t fin_ms);
Simon Butchere846b512016-03-01 17:31:49 +0000693
694/**
695 * \brief Callback type: get status of timers/delays
696 *
697 * \param ctx Context pointer
698 *
699 * \return This callback must return:
700 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000701 * 0 if none of the delays have passed,
702 * 1 if only the intermediate delay has passed,
703 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000704 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100705typedef int mbedtls_ssl_get_timer_t(void *ctx);
Simon Butchere846b512016-03-01 17:31:49 +0000706
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200707/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200708typedef struct mbedtls_ssl_session mbedtls_ssl_session;
709typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200710typedef struct mbedtls_ssl_config mbedtls_ssl_config;
711
712/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200713typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
714typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100715typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200716#if defined(MBEDTLS_X509_CRT_PARSE_C)
717typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200718#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200719#if defined(MBEDTLS_SSL_PROTO_DTLS)
720typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200721#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000722
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200723#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100724#if defined(MBEDTLS_X509_CRT_PARSE_C)
725/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200726 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100727 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200728 * This callback is called during an SSL handshake to start
729 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200730 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100731 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200732 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100733 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200734 * This function typically sends or enqueues a request, and
735 * does not wait for the operation to complete. This allows
736 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100737 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200738 * The parameters \p ssl and \p cert are guaranteed to remain
739 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200740 * function must save the contents of \p hash if the value
741 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200742 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100743 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200744 * This function may call mbedtls_ssl_set_async_operation_data()
745 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200746 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200747 *
Gilles Peskined3268832018-04-26 06:23:59 +0200748 * \note For RSA signatures, this function must produce output
749 * that is consistent with PKCS#1 v1.5 in the same way as
750 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
751 * apply the padding steps described in RFC 8017, section 9.2
752 * "EMSA-PKCS1-v1_5" as follows.
753 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
754 * encoding, treating \p hash as the DigestInfo to be
755 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
756 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200757 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200758 * encoding, treating \p hash as the hash to be encoded and
759 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
760 * from step 2, with `digestAlgorithm` obtained by calling
761 * mbedtls_oid_get_oid_by_md() on \p md_alg.
762 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200763 * \note For ECDSA signatures, the output format is the DER encoding
764 * `Ecdsa-Sig-Value` defined in
765 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
766 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200767 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200768 * modified other than via
769 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200770 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200771 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200772 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200773 * connection. However, if other callbacks are used, this
774 * property may not hold. For example, if an SNI callback
775 * is registered with mbedtls_ssl_conf_sni(), then
776 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200777 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100778 * \param hash Buffer containing the hash. This buffer is
779 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200780 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100781 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200782 * \return 0 if the operation was started successfully and the SSL
783 * stack should call the resume callback immediately.
784 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
785 * was started successfully and the SSL stack should return
786 * immediately without calling the resume callback yet.
787 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
788 * processor does not support this key. The SSL stack will
789 * use the private key object instead.
790 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200791 * propagated up the call chain. The callback should
792 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
793 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200794 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100795 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100796typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl,
797 mbedtls_x509_crt *cert,
798 mbedtls_md_type_t md_alg,
799 const unsigned char *hash,
800 size_t hash_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100801
802/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200803 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100804 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200805 * This callback is called during an SSL handshake to start
806 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200807 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100808 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200809 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100810 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200811 * This function typically sends or enqueues a request, and
812 * does not wait for the operation to complete. This allows
813 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100814 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200815 * The parameters \p ssl and \p cert are guaranteed to remain
816 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200817 * function must save the contents of \p input if the value
818 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200819 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100820 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200821 * This function may call mbedtls_ssl_set_async_operation_data()
822 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200823 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200824 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200825 * \warning RSA decryption as used in TLS is subject to a potential
826 * timing side channel attack first discovered by Bleichenbacher
827 * in 1998. This attack can be remotely exploitable
828 * in practice. To avoid this attack, you must ensure that
829 * if the callback performs an RSA decryption, the time it
830 * takes to execute and return the result does not depend
831 * on whether the RSA decryption succeeded or reported
832 * invalid padding.
833 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200834 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200835 * modified other than via
836 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200837 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200838 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200839 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200840 * connection. However, if other callbacks are used, this
841 * property may not hold. For example, if an SNI callback
842 * is registered with mbedtls_ssl_conf_sni(), then
843 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100844 * \param input Buffer containing the input ciphertext. This buffer
845 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200846 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100847 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200848 * \return 0 if the operation was started successfully and the SSL
849 * stack should call the resume callback immediately.
850 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
851 * was started successfully and the SSL stack should return
852 * immediately without calling the resume callback yet.
853 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
854 * processor does not support this key. The SSL stack will
855 * use the private key object instead.
856 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200857 * propagated up the call chain. The callback should
858 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
859 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200860 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100861 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100862typedef int mbedtls_ssl_async_decrypt_t(mbedtls_ssl_context *ssl,
863 mbedtls_x509_crt *cert,
864 const unsigned char *input,
865 size_t input_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100866#endif /* MBEDTLS_X509_CRT_PARSE_C */
867
868/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200869 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100870 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200871 * This callback is called during an SSL handshake to resume
872 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200873 * ::mbedtls_ssl_async_sign_t or
874 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200875 *
876 * This function typically checks the status of a pending
877 * request or causes the request queue to make progress, and
878 * does not wait for the operation to complete. This allows
879 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100880 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200881 * This function may call mbedtls_ssl_get_async_operation_data()
882 * to retrieve an operation context set by the start callback.
883 * It may call mbedtls_ssl_set_async_operation_data() to modify
884 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200885 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200886 * Note that when this function returns a status other than
887 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
888 * resources associated with the operation.
889 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200890 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200891 * modified other than via
892 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200893 * \param output Buffer containing the output (signature or decrypted
894 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200895 * \param output_len On success, number of bytes written to \p output.
896 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100897 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200898 * \return 0 if output of the operation is available in the
899 * \p output buffer.
900 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
901 * is still in progress. Subsequent requests for progress
902 * on the SSL connection will call the resume callback
903 * again.
904 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200905 * The SSL handshake is aborted. The callback should
906 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
907 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200908 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100909 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100910typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl,
911 unsigned char *output,
912 size_t *output_len,
913 size_t output_size);
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100914
915/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200916 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100917 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200918 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200919 * while an asynchronous operation is in progress. Note that
920 * this callback is not called if the
921 * ::mbedtls_ssl_async_resume_t callback has run and has
922 * returned a value other than
923 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
924 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100925 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200926 * This function may call mbedtls_ssl_get_async_operation_data()
927 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200928 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200929 * \param ssl The SSL connection instance. It should not be
930 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100931 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100932typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl);
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200933#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000934
Gilles Peskineeccd8882020-03-10 12:19:08 +0100935#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000936 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000937#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
938#if defined(MBEDTLS_SHA256_C)
939#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
940#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
941#elif defined(MBEDTLS_SHA512_C)
942#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
943#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
944#elif defined(MBEDTLS_SHA1_C)
945#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
946#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
947#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000948/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000949#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
950#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +0100951#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000952 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000953
Johan Pascalb62bb512015-12-03 21:56:45 +0100954#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +0200955
Johan Pascal85269572020-08-25 10:01:54 +0200956#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +0200957#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +0100958/*
Johan Pascal43f94902020-09-22 12:25:52 +0200959 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200960 *
961 * Use_srtp extension protection profiles values as defined in
962 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
963 *
964 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
965 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +0100966 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100967#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001)
968#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002)
969#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005)
970#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006)
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200971/* This one is not iana defined, but for code readability. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100972#define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000)
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200973
Johan Pascal43f94902020-09-22 12:25:52 +0200974typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +0300975
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100976typedef struct mbedtls_dtls_srtp_info_t {
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200977 /*! The SRTP profile that was negotiated. */
Ron Eldora9788042018-12-05 11:04:31 +0200978 mbedtls_ssl_srtp_profile chosen_dtls_srtp_profile;
Johan Pascalf6417ec2020-09-22 15:15:19 +0200979 /*! The length of mki_value. */
980 uint16_t mki_len;
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200981 /*! The mki_value used, with max size of 256 bytes. */
Johan Pascal85269572020-08-25 10:01:54 +0200982 unsigned char mki_value[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +0300983}
984mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +0200985
Johan Pascalb62bb512015-12-03 21:56:45 +0100986#endif /* MBEDTLS_SSL_DTLS_SRTP */
987
Paul Bakker5121ce52009-01-03 21:22:43 +0000988/*
Paul Bakker0a597072012-09-25 21:55:46 +0000989 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200990 *
991 * Note: when changing this definition, we need to check and update:
992 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +0200993 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200994 * - in library/ssl_tls.c:
995 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
996 * mbedtls_ssl_session_save() and ssl_session_load()
997 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000998 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +0100999struct mbedtls_ssl_session {
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001000#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1001 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
1002#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1003
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001004#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +01001005 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +02001006#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +00001007 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +00001008 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +02001009 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +00001010 unsigned char id[32]; /*!< session identifier */
1011 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +02001012
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001013#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +00001014#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +00001015 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +00001016#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001017 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
1018 * changes during renegotiation, mitigating the triple handshake attack. */
1019 unsigned char *peer_cert_digest;
1020 size_t peer_cert_digest_len;
1021 mbedtls_md_type_t peer_cert_digest_type;
Hanno Beckerabe6f662019-02-07 13:29:55 +00001022#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001023#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001024 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +02001025
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001026#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001027 unsigned char *ticket; /*!< RFC 5077 session ticket */
1028 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +02001029 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001030#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001032#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +02001033 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001037 int encrypt_then_mac; /*!< flag for EtM activation */
1038#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001039};
1040
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001041/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001042 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001043 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001044struct mbedtls_ssl_config {
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001045 /* Group items by size and reorder them to maximize usage of immediate offset access. */
1046
1047 /*
1048 * Numerical settings (char)
1049 */
1050
1051 unsigned char max_major_ver; /*!< max. major version used */
1052 unsigned char max_minor_ver; /*!< max. minor version used */
1053 unsigned char min_major_ver; /*!< min. major version used */
1054 unsigned char min_minor_ver; /*!< min. minor version used */
1055
1056 /*
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001057 * Flags (could be bit-fields to save RAM, but separate bytes make
1058 * the code smaller on architectures with an instruction for direct
1059 * byte access).
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001060 */
1061
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001062 uint8_t endpoint /*bool*/; /*!< 0: client, 1: server */
1063 uint8_t transport /*bool*/; /*!< stream (TLS) or datagram (DTLS) */
1064 uint8_t authmode /*2 bits*/; /*!< MBEDTLS_SSL_VERIFY_XXX */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001065 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001066 uint8_t allow_legacy_renegotiation /*2 bits*/; /*!< MBEDTLS_LEGACY_XXX */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001067#if defined(MBEDTLS_ARC4_C)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001068 uint8_t arc4_disabled /*bool*/; /*!< blacklist RC4 ciphersuites? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001069#endif
1070#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001071 uint8_t mfl_code /*3 bits*/; /*!< desired fragment length */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001072#endif
1073#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001074 uint8_t encrypt_then_mac /*bool*/; /*!< negotiate encrypt-then-mac? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001075#endif
1076#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001077 uint8_t extended_ms /*bool*/; /*!< negotiate extended master secret? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001078#endif
1079#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001080 uint8_t anti_replay /*bool*/; /*!< detect and prevent replay? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001081#endif
1082#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001083 uint8_t cbc_record_splitting /*bool*/; /*!< do cbc record splitting */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001084#endif
1085#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001086 uint8_t disable_renegotiation /*bool*/; /*!< disable renegotiation? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001087#endif
1088#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001089 uint8_t trunc_hmac /*bool*/; /*!< negotiate truncated hmac? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001090#endif
1091#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001092 uint8_t session_tickets /*bool*/; /*!< use session tickets? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001093#endif
1094#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001095 uint8_t fallback /*bool*/; /*!< is this a fallback? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001096#endif
1097#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001098 uint8_t cert_req_ca_list /*bool*/; /*!< enable sending CA list in
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001099 Certificate Request messages? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001100#endif
1101#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001102 uint8_t ignore_unexpected_cid /*bool*/; /*!< Determines whether DTLS
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001103 * record with unexpected CID
1104 * should lead to failure. */
1105#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1106#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine7f03d9e2021-11-16 18:31:46 +01001107 uint8_t dtls_srtp_mki_support /*bool*/; /*!< support having mki_value
1108 in the use_srtp extension? */
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001109#endif
1110
1111 /*
Gilles Peskinee8339982021-11-17 20:00:13 +01001112 * Numerical settings (int or larger)
Lukasz Gniadzik9a0e0af2021-08-17 17:34:08 +02001113 */
1114
1115 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
1116
1117#if defined(MBEDTLS_SSL_PROTO_DTLS)
1118 uint32_t hs_timeout_min; /*!< initial value of the handshake
1119 retransmission timeout (ms) */
1120 uint32_t hs_timeout_max; /*!< maximum value of the handshake
1121 retransmission timeout (ms) */
1122#endif
1123
1124#if defined(MBEDTLS_SSL_RENEGOTIATION)
1125 int renego_max_records; /*!< grace period for renegotiation */
1126 unsigned char renego_period[8]; /*!< value of the record counters
1127 that triggers renegotiation */
1128#endif
1129
1130#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1131 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1132#endif
1133
1134#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1135 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1136#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001137
1138 /*
1139 * Pointers
1140 */
1141
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001142 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001143
1144 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001145 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001146 void *p_dbg; /*!< context for the debug function */
1147
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001148 /** Callback for getting (pseudo-)random numbers */
1149 int (*f_rng)(void *, unsigned char *, size_t);
1150 void *p_rng; /*!< context for the RNG function */
1151
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001152 /** Callback to retrieve a session from the cache */
1153 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001154 /** Callback to store a session into the cache */
1155 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001156 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001157
1158#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1159 /** Callback for setting cert according to SNI extension */
1160 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1161 void *p_sni; /*!< context for SNI callback */
1162#endif
1163
1164#if defined(MBEDTLS_X509_CRT_PARSE_C)
1165 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001166 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001167 void *p_vrfy; /*!< context for X.509 verify calllback */
1168#endif
1169
Gilles Peskineeccd8882020-03-10 12:19:08 +01001170#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001171 /** Callback to retrieve PSK key from identity */
1172 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1173 void *p_psk; /*!< context for PSK callback */
1174#endif
1175
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001176#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Tom Cosgrove2b150752022-05-26 11:55:43 +01001177 /** Callback to create & write a cookie for ClientHello verification */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001178 int (*f_cookie_write)(void *, unsigned char **, unsigned char *,
1179 const unsigned char *, size_t);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001180 /** Callback to verify validity of a ClientHello cookie */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001181 int (*f_cookie_check)(void *, const unsigned char *, size_t,
1182 const unsigned char *, size_t);
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001183 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001184#endif
1185
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001186#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001187 /** Callback to create & write a session ticket */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001188 int (*f_ticket_write)(void *, const mbedtls_ssl_session *,
1189 unsigned char *, const unsigned char *, size_t *, uint32_t *);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001190 /** Callback to parse a session ticket into a session structure */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001191 int (*f_ticket_parse)(void *, mbedtls_ssl_session *, unsigned char *, size_t);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001192 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001193#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001194
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001195#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001196 /** Callback to export key block and master secret */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001197 int (*f_export_keys)(void *, const unsigned char *,
1198 const unsigned char *, size_t, size_t, size_t);
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001199 /** Callback to export key block, master secret,
1200 * tls_prf and random bytes. Should replace f_export_keys */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001201 int (*f_export_keys_ext)(void *, const unsigned char *,
1202 const unsigned char *, size_t, size_t, size_t,
1203 const unsigned char[32], const unsigned char[32],
1204 mbedtls_tls_prf_types);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001205 void *p_export_keys; /*!< context for key export callback */
1206#endif
1207
Hanno Beckera0e20d02019-05-15 14:03:01 +01001208#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerad4a1372019-05-03 13:06:44 +01001209 size_t cid_len; /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001210#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001211
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001212#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001213 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001214 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
1215 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
1216 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001217#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1218 mbedtls_x509_crt_ca_cb_t f_ca_cb;
1219 void *p_ca_cb;
1220#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001221#endif /* MBEDTLS_X509_CRT_PARSE_C */
1222
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001223#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001224#if defined(MBEDTLS_X509_CRT_PARSE_C)
1225 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
1226 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
1227#endif /* MBEDTLS_X509_CRT_PARSE_C */
1228 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
1229 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +02001230 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001231#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001232
Gilles Peskineeccd8882020-03-10 12:19:08 +01001233#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001234 const int *sig_hashes; /*!< allowed signature hashes */
1235#endif
1236
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001237#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001238 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001239#endif
1240
1241#if defined(MBEDTLS_DHM_C)
1242 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
1243 mbedtls_mpi dhm_G; /*!< generator for DHM */
1244#endif
1245
Gilles Peskineeccd8882020-03-10 12:19:08 +01001246#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001247
1248#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001249 psa_key_id_t psk_opaque; /*!< PSA key slot holding opaque PSK. This field
1250 * should only be set via
1251 * mbedtls_ssl_conf_psk_opaque().
1252 * If either no PSK or a raw PSK have been
1253 * configured, this has value \c 0.
1254 */
Hanno Becker43633132018-10-22 15:31:03 +01001255#endif /* MBEDTLS_USE_PSA_CRYPTO */
1256
1257 unsigned char *psk; /*!< The raw pre-shared key. This field should
1258 * only be set via mbedtls_ssl_conf_psk().
1259 * If either no PSK or an opaque PSK
1260 * have been configured, this has value NULL. */
1261 size_t psk_len; /*!< The length of the raw pre-shared key.
1262 * This field should only be set via
1263 * mbedtls_ssl_conf_psk().
1264 * Its value is non-zero if and only if
1265 * \c psk is not \c NULL. */
1266
1267 unsigned char *psk_identity; /*!< The PSK identity for PSK negotiation.
1268 * This field should only be set via
1269 * mbedtls_ssl_conf_psk().
1270 * This is set if and only if either
1271 * \c psk or \c psk_opaque are set. */
1272 size_t psk_identity_len;/*!< The length of PSK identity.
1273 * This field should only be set via
1274 * mbedtls_ssl_conf_psk().
1275 * Its value is non-zero if and only if
1276 * \c psk is not \c NULL or \c psk_opaque
1277 * is not \c 0. */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001278#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001279
1280#if defined(MBEDTLS_SSL_ALPN)
1281 const char **alpn_list; /*!< ordered list of protocols */
1282#endif
1283
Johan Pascalbbc057a2016-02-04 22:07:32 +01001284#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001285 /*! ordered list of supported srtp profile */
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001286 const mbedtls_ssl_srtp_profile *dtls_srtp_profile_list;
Ron Eldora9788042018-12-05 11:04:31 +02001287 /*! number of supported profiles */
1288 size_t dtls_srtp_profile_list_len;
Johan Pascalbbc057a2016-02-04 22:07:32 +01001289#endif /* MBEDTLS_SSL_DTLS_SRTP */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001290};
1291
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001292struct mbedtls_ssl_context {
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001293 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001294
Paul Bakker5121ce52009-01-03 21:22:43 +00001295 /*
1296 * Miscellaneous
1297 */
1298 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001299#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001300 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001301 int renego_records_seen; /*!< Records since renego request, or with DTLS,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001302 number of retransmissions of request if
1303 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001304#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001306 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001307 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001310 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001311#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001312
Hanno Becker8927c832019-04-03 12:52:50 +01001313#if defined(MBEDTLS_X509_CRT_PARSE_C)
1314 /** Callback to customize X.509 certificate chain verification */
1315 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Janos Follath924270f2019-04-04 12:49:44 +01001316 void *p_vrfy; /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001317#endif
1318
Simon Butchere846b512016-03-01 17:31:49 +00001319 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1320 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1321 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001322 /*!< Callback for network receive with timeout */
Simon Butchere846b512016-03-01 17:31:49 +00001323
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001324 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001325
Paul Bakker5121ce52009-01-03 21:22:43 +00001326 /*
1327 * Session layer
1328 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001329 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1330 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1331 mbedtls_ssl_session *session; /*!< negotiated session data */
1332 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001335 the handshake process */
Paul Bakker48916f92012-09-16 19:57:18 +00001336
1337 /*
1338 * Record layer transformations
1339 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001340 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1341 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1342 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1343 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001344
Paul Bakker5121ce52009-01-03 21:22:43 +00001345 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001346 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001347 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001348 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001349
1350 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1351 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001352
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001353 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001354 * Record layer (incoming data)
1355 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001356 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001357 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1358 TLS: maintained by us
1359 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001360 unsigned char *in_hdr; /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001361#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001362 unsigned char *in_cid; /*!< The start of the CID;
1363 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001364#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001365 unsigned char *in_len; /*!< two-bytes message length field */
1366 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001367 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001368 unsigned char *in_offt; /*!< read offset in application data */
1369
1370 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001371 size_t in_msglen; /*!< record header: message length */
1372 size_t in_left; /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001373#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1374 size_t in_buf_len; /*!< length of input buffer */
1375#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001376#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001377 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001378 size_t next_record_offset; /*!< offset of the next record in datagram
1379 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001380#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001381#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001382 uint64_t in_window_top; /*!< last validated record seq_num */
1383 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001384#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001385
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001386 size_t in_hslen; /*!< current handshake message length,
1387 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001388 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001389
1390 int keep_current_message; /*!< drop or reuse current message
1391 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001392
Hanno Becker04da1892018-08-14 13:22:10 +01001393#if defined(MBEDTLS_SSL_PROTO_DTLS)
1394 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1395 * within a single datagram. */
1396#endif /* MBEDTLS_SSL_PROTO_DTLS */
1397
Paul Bakker5121ce52009-01-03 21:22:43 +00001398 /*
1399 * Record layer (outgoing data)
1400 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001401 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001402 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001403 unsigned char *out_hdr; /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001404#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001405 unsigned char *out_cid; /*!< The start of the CID;
1406 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001407#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001408 unsigned char *out_len; /*!< two-bytes message length field */
1409 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001410 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001411
1412 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001413 size_t out_msglen; /*!< record header: message length */
1414 size_t out_left; /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001415#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1416 size_t out_buf_len; /*!< length of output buffer */
1417#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001418
Hanno Becker19859472018-08-06 09:40:20 +01001419 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1420
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001421#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001422 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001423#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001424
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001426 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001427#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001428#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
bootstrap-prime7ef96ea2022-05-18 14:08:33 -04001429 signed char split_done; /*!< current record already split? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001430#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001431
Paul Bakker5121ce52009-01-03 21:22:43 +00001432 /*
1433 * PKI layer
1434 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001435 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001436
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001437 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001438 * User settings
1439 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001440#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine520ceb22025-02-12 23:35:54 +01001441 /** Expected peer CN for verification.
1442 *
1443 * Also used on clients for SNI.
1444 *
Gilles Peskine7d193ac2025-02-20 17:39:52 +01001445 * The value of this field can be:
1446 * - \p NULL in a newly initialized or reset context.
1447 * - A heap-allocated copy of the last value passed to
1448 * mbedtls_ssl_set_hostname(), if the last call had a non-null
1449 * \p hostname argument.
1450 * - A special value to indicate that mbedtls_ssl_set_hostname()
1451 * was called with \p NULL (as opposed to never having been called).
1452 * See `mbedtls_ssl_get_hostname_pointer()` in `ssl_tls.c`.
Gilles Peskinef33c45f2025-02-12 23:53:25 +01001453 *
Gilles Peskine7d193ac2025-02-20 17:39:52 +01001454 * If this field contains the value \p NULL and the configuration option
1455 * #MBEDTLS_SSL_CLI_ALLOW_WEAK_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME
1456 * is unset, on a TLS client, attempting to verify a server certificate
1457 * results in the error
1458 * #MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME.
1459 *
1460 * If this field contains the special value described above, or if
1461 * the value is \p NULL and the configuration option
1462 * #MBEDTLS_SSL_CLI_ALLOW_WEAK_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME
1463 * is set, then the peer name verification is skipped, which may be
1464 * insecure, especially on a client. Furthermore, on a client, the
1465 * server_name extension is not sent.
Gilles Peskine520ceb22025-02-12 23:35:54 +01001466 */
1467 char *hostname;
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001468#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001470#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001471 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001472#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001473
Johan Pascalb62bb512015-12-03 21:56:45 +01001474#if defined(MBEDTLS_SSL_DTLS_SRTP)
1475 /*
1476 * use_srtp extension
1477 */
Ron Eldor3adb9922017-12-21 10:15:08 +02001478 mbedtls_dtls_srtp_info dtls_srtp_info;
Johan Pascalb62bb512015-12-03 21:56:45 +01001479#endif /* MBEDTLS_SSL_DTLS_SRTP */
1480
Paul Bakker48916f92012-09-16 19:57:18 +00001481 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001482 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001483 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001484#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001485 unsigned char *cli_id; /*!< transport-level ID of the client */
1486 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001487#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001488
1489 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001490 * Secure renegotiation
1491 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001492 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001493 int secure_renegotiation; /*!< does peer support legacy or
1494 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001496 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001497 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1498 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001499#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001500
Hanno Beckera0e20d02019-05-15 14:03:01 +01001501#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001502 /* CID configuration to use in subsequent handshakes. */
1503
1504 /*! The next incoming CID, chosen by the user and applying to
1505 * all subsequent handshakes. This may be different from the
1506 * CID currently used in case the user has re-configured the CID
1507 * after an initial handshake. */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001508 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX];
Hanno Becker2f28c102019-04-25 15:46:59 +01001509 uint8_t own_cid_len; /*!< The length of \c own_cid. */
1510 uint8_t negotiate_cid; /*!< This indicates whether the CID extension should
1511 * be negotiated in the next handshake or not.
1512 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1513 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001514#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001515};
1516
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001518
Andres Amaya Garcia4156ac12019-01-03 20:48:54 +00001519#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1520
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001521#define MBEDTLS_SSL_CHANNEL_OUTBOUND MBEDTLS_DEPRECATED_NUMERIC_CONSTANT(0)
1522#define MBEDTLS_SSL_CHANNEL_INBOUND MBEDTLS_DEPRECATED_NUMERIC_CONSTANT(1)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001523
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001524#if defined(MBEDTLS_DEPRECATED_WARNING)
1525#define MBEDTLS_DEPRECATED __attribute__((deprecated))
1526#else
1527#define MBEDTLS_DEPRECATED
Andres Amaya Garcia10edb3e2019-01-15 18:44:06 +00001528#endif /* MBEDTLS_DEPRECATED_WARNING */
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001529
1530MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_init)(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001531 mbedtls_ssl_context *ssl,
1532 const unsigned char *key_enc, const unsigned char *key_dec,
1533 size_t keylen,
1534 const unsigned char *iv_enc, const unsigned char *iv_dec,
1535 size_t ivlen,
1536 const unsigned char *mac_enc, const unsigned char *mac_dec,
1537 size_t maclen);
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001538MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_activate)(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001539 mbedtls_ssl_context *ssl,
1540 int direction);
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001541MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_reset)(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001542 mbedtls_ssl_context *ssl);
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001543MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_write)(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001544 mbedtls_ssl_context *ssl);
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001545MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_read)(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001546 mbedtls_ssl_context *ssl);
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001547MBEDTLS_DEPRECATED extern int (*mbedtls_ssl_hw_record_finish)(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001548 mbedtls_ssl_context *ssl);
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001549
1550#undef MBEDTLS_DEPRECATED
Andres Amaya Garcia4156ac12019-01-03 20:48:54 +00001551#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Andres Amaya Garcia3f6cc5f2018-12-05 22:40:09 +00001552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001554
Paul Bakker5121ce52009-01-03 21:22:43 +00001555/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001556 * \brief Return the name of the ciphersuite associated with the
1557 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001558 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001559 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001560 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001561 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001562 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001563const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id);
Paul Bakkere3166ce2011-01-27 17:40:50 +00001564
1565/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001566 * \brief Return the ID of the ciphersuite associated with the
1567 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001568 *
1569 * \param ciphersuite_name SSL ciphersuite name
1570 *
1571 * \return the ID with the ciphersuite or 0 if not found
1572 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001573int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name);
Paul Bakker72f62662011-01-16 21:27:44 +00001574
1575/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001576 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001577 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001578 * mbedtls_ssl_free()
1579 *
1580 * \param ssl SSL context
1581 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001582void mbedtls_ssl_init(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001583
1584/**
1585 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001586 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001587 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001588 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001589 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001590 * \warning The conf structure will be accessed during the session.
1591 * It must not be modified or freed as long as the session
1592 * is active.
1593 *
1594 * \warning This function must be called exactly once per context.
1595 * Calling mbedtls_ssl_setup again is not supported, even
1596 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001597 *
Gilles Peskine1ecf2c72025-02-17 17:41:54 +01001598 * \warning After setting up a client context, if certificate-based
1599 * authentication is enabled, you should call
1600 * mbedtls_ssl_set_hostname() to specifiy the expected
1601 * name of the server. Without this, in most scenarios,
1602 * the TLS connection is insecure. See
1603 * #MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME
1604 * for more information.
1605 *
Gilles Peskine07ae2082023-03-07 20:22:51 +01001606 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
1607 * subsystem must have been initialized by calling
1608 * psa_crypto_init() before calling this function.
1609 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001610 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001611 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001612 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001613 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001614 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001615 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001616int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1617 const mbedtls_ssl_config *conf);
Paul Bakker5121ce52009-01-03 21:22:43 +00001618
1619/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001620 * \brief Reset an already initialized SSL context for re-use
1621 * while retaining application-set variables, function
1622 * pointers and data.
1623 *
1624 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001625 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001626 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1627 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001628 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001629int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl);
Paul Bakker7eb013f2011-10-06 12:37:39 +00001630
1631/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001632 * \brief Set the current endpoint type
1633 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001634 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001635 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001636 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001637void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint);
Paul Bakker5121ce52009-01-03 21:22:43 +00001638
1639/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001640 * \brief Set the transport type (TLS or DTLS).
1641 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001642 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001643 * \note For DTLS, you must either provide a recv callback that
1644 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001645 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1646 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001647 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001648 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001649 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1651 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001652 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001653void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport);
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001654
1655/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001656 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001657 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001658 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001659 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001660 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001661 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001662 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001663 * (default on server)
1664 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001665 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001667 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001669 * handshake is complete.
1670 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001671 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001672 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001673 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001674 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001675 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1676 * 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 +01001677 * the right time(s), which may not be obvious, while REQUIRED always perform
1678 * the verification as soon as possible. For example, REQUIRED was protecting
1679 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001680 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001681void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode);
Paul Bakker5121ce52009-01-03 21:22:43 +00001682
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001683#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001684/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001685 * \brief Set the verification callback (Optional).
1686 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001687 * If set, the provided verify callback is called for each
1688 * certificate in the peer's CRT chain, including the trusted
1689 * root. For more information, please see the documentation of
1690 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001691 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001692 * \note For per context callbacks and contexts, please use
1693 * mbedtls_ssl_set_verify() instead.
1694 *
1695 * \param conf The SSL configuration to use.
1696 * \param f_vrfy The verification callback to use during CRT verification.
1697 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001698 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001699void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
1700 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1701 void *p_vrfy);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001702#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001703
1704/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001705 * \brief Set the random number generator callback
1706 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001707 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001708 * \param f_rng RNG function
1709 * \param p_rng RNG parameter
1710 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001711void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
1712 int (*f_rng)(void *, unsigned char *, size_t),
1713 void *p_rng);
Paul Bakker5121ce52009-01-03 21:22:43 +00001714
1715/**
1716 * \brief Set the debug callback
1717 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001718 * The callback has the following argument:
1719 * void * opaque context for the callback
1720 * int debug level
1721 * const char * file name
1722 * int line number
1723 * const char * message
1724 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001725 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001726 * \param f_dbg debug function
1727 * \param p_dbg debug parameter
1728 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001729void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
1730 void (*f_dbg)(void *, int, const char *, int, const char *),
1731 void *p_dbg);
Paul Bakker5121ce52009-01-03 21:22:43 +00001732
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001733/**
1734 * \brief Set the underlying BIO callbacks for write, read and
1735 * read-with-timeout.
1736 *
1737 * \param ssl SSL context
1738 * \param p_bio parameter (context) shared by BIO callbacks
1739 * \param f_send write callback
1740 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001741 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001742 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001743 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1744 * the other is used. If both are non-NULL, f_recv_timeout is
1745 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001746 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001747 * \note The two most common use cases are:
1748 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
bootstrap-prime7ef96ea2022-05-18 14:08:33 -04001749 * - blocking I/O, f_recv == NULL, f_recv_timeout != NULL
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001750 *
1751 * \note For DTLS, you need to provide either a non-NULL
1752 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001753 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07001754 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001755 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001756 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001757 *
Andres AG3616f6f2016-09-14 14:32:09 +01001758 * \note On some platforms, net_sockets.c provides
1759 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1760 * \c mbedtls_net_recv_timeout() that are suitable to be used
1761 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001762 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001763void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
1764 void *p_bio,
1765 mbedtls_ssl_send_t *f_send,
1766 mbedtls_ssl_recv_t *f_recv,
1767 mbedtls_ssl_recv_timeout_t *f_recv_timeout);
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001768
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001769#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001770
Hanno Beckera0e20d02019-05-15 14:03:01 +01001771#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01001772
1773
1774/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001775 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001776 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001777 *
Hanno Beckerebcc9132019-05-15 10:26:32 +01001778 * Reference: draft-ietf-tls-dtls-connection-id-05
1779 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker019f4b52019-04-09 15:12:56 +01001780 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01001781 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01001782 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01001783 * underlying transport (changed IP and Port metadata) by
1784 * adding explicit connection identifiers (CIDs) to the
1785 * headers of encrypted DTLS records. The desired CIDs are
1786 * configured by the application layer and are exchanged in
1787 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01001788 * handshake, where each side indicates the CID it wants the
1789 * peer to use when writing encrypted messages. The CIDs are
1790 * put to use once records get encrypted: the stack discards
1791 * any incoming records that don't include the configured CID
1792 * in their header, and adds the peer's requested CID to the
1793 * headers of outgoing messages.
1794 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01001795 * This API enables or disables the use of the CID extension
1796 * in the next handshake and sets the value of the CID to
1797 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01001798 *
1799 * \param ssl The SSL context to configure. This must be initialized.
1800 * \param enable This value determines whether the CID extension should
1801 * be used or not. Possible values are:
1802 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001803 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1804 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001805 * \param own_cid The address of the readable buffer holding the CID we want
1806 * the peer to use when sending encrypted messages to us.
1807 * This may be \c NULL if \p own_cid_len is \c 0.
Andrzej Kurek96ce1b02023-07-14 05:22:42 -04001808 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01001809 * MBEDTLS_SSL_CID_DISABLED.
1810 * \param own_cid_len The length of \p own_cid.
Andrzej Kurek96ce1b02023-07-14 05:22:42 -04001811 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01001812 * MBEDTLS_SSL_CID_DISABLED.
1813 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001814 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01001815 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01001816 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001817 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001818 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001819 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001820 * performed on the SSL context \p ssl, but does not trigger
1821 * one. You still have to call `mbedtls_ssl_handshake()`
1822 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1823 * (for a renegotiation handshake) explicitly after a
1824 * successful call to this function to run the handshake.
1825 *
1826 * \note This call cannot guarantee that the use of the CID
1827 * will be successfully negotiated in the next handshake,
1828 * because the peer might not support it. Specifically:
1829 * - On the Client, enabling the use of the CID through
1830 * this call implies that the `ClientHello` in the next
1831 * handshake will include the CID extension, thereby
1832 * offering the use of the CID to the server. Only if
1833 * the `ServerHello` contains the CID extension, too,
1834 * the CID extension will actually be put to use.
1835 * - On the Server, enabling the use of the CID through
1836 * this call implies that that the server will look for
1837 * the CID extension in a `ClientHello` from the client,
1838 * and, if present, reply with a CID extension in its
1839 * `ServerHello`.
1840 *
1841 * \note To check whether the use of the CID was negotiated
1842 * after the subsequent handshake has completed, please
1843 * use the API mbedtls_ssl_get_peer_cid().
1844 *
1845 * \warning If the use of the CID extension is enabled in this call
1846 * and the subsequent handshake negotiates its use, Mbed TLS
1847 * will silently drop every packet whose CID does not match
1848 * the CID configured in \p own_cid. It is the responsibility
1849 * of the user to adapt the underlying transport to take care
1850 * of CID-based demultiplexing before handing datagrams to
1851 * Mbed TLS.
1852 *
1853 * \return \c 0 on success. In this case, the CID configuration
1854 * applies to the next handshake.
1855 * \return A negative error code on failure.
1856 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001857int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
1858 int enable,
1859 unsigned char const *own_cid,
1860 size_t own_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01001861
1862/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01001863 * \brief Get information about the use of the CID extension
1864 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01001865 *
1866 * \param ssl The SSL context to query.
1867 * \param enabled The address at which to store whether the CID extension
1868 * is currently in use or not. If the CID is in use,
1869 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1870 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1871 * \param peer_cid The address of the buffer in which to store the CID
1872 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01001873 * This may be \c NULL in case the value of peer CID
1874 * isn't needed. If it is not \c NULL, \p peer_cid_len
1875 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01001876 * \param peer_cid_len The address at which to store the size of the CID
1877 * chosen by the peer (if the CID extension is used).
1878 * This is also the number of Bytes in \p peer_cid that
1879 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01001880 * This may be \c NULL in case the length of the peer CID
1881 * isn't needed. If it is \c NULL, \p peer_cid must be
1882 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01001883 *
1884 * \note This applies to the state of the CID negotiated in
1885 * the last complete handshake. If a handshake is in
1886 * progress, this function will attempt to complete
1887 * the handshake first.
1888 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001889 * \note If CID extensions have been exchanged but both client
1890 * and server chose to use an empty CID, this function
1891 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1892 * (the rationale for this is that the resulting
1893 * communication is the same as if the CID extensions
1894 * hadn't been used).
1895 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001896 * \return \c 0 on success.
1897 * \return A negative error code on failure.
1898 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001899int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
1900 int *enabled,
1901 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
1902 size_t *peer_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01001903
Hanno Beckera0e20d02019-05-15 14:03:01 +01001904#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01001905
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001906/**
Shaun Case0e7791f2021-12-20 21:14:10 -08001907 * \brief Set the Maximum Transport Unit (MTU).
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001908 * Special value: 0 means unset (no limit).
1909 * This represents the maximum size of a datagram payload
1910 * handled by the transport layer (usually UDP) as determined
1911 * by the network link and stack. In practice, this controls
1912 * the maximum size datagram the DTLS layer will pass to the
1913 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1914 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001915 * \note The limit on datagram size is converted to a limit on
1916 * record payload by subtracting the current overhead of
1917 * encapsulation and encryption/authentication if any.
1918 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001919 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001920 * example when a Path Maximum Transfer Unit (PMTU)
1921 * estimate becomes available from other sources,
1922 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001923 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001924 * \note This setting only controls the size of the packets we send,
1925 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001926 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001927 * server to use smaller records with \c
1928 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001929 *
1930 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001931 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001932 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001933 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001934 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001935 * of datagrams (hence records, see first note) sent. It
1936 * cannot be used to increase the maximum size of records over
1937 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001938 *
1939 * \note Values lower than the current record layer expansion will
1940 * result in an error when trying to send data.
1941 *
1942 * \note Using record compression together with a non-zero MTU value
1943 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001944 *
1945 * \param ssl SSL context
1946 * \param mtu Value of the path MTU in bytes
1947 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001948void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu);
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001949#endif /* MBEDTLS_SSL_PROTO_DTLS */
1950
Hanno Becker726c97a2019-04-03 12:52:35 +01001951#if defined(MBEDTLS_X509_CRT_PARSE_C)
1952/**
1953 * \brief Set a connection-specific verification callback (optional).
1954 *
1955 * If set, the provided verify callback is called for each
1956 * certificate in the peer's CRT chain, including the trusted
1957 * root. For more information, please see the documentation of
1958 * \c mbedtls_x509_crt_verify().
1959 *
1960 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1961 * binds the verification callback and context to an SSL context
1962 * as opposed to an SSL configuration.
1963 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1964 * are both used, mbedtls_ssl_set_verify() takes precedence.
1965 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001966 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001967 * \param f_vrfy The verification callback to use during CRT verification.
1968 * \param p_vrfy The opaque context to be passed to the callback.
1969 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001970void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
1971 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1972 void *p_vrfy);
Hanno Becker726c97a2019-04-03 12:52:35 +01001973#endif /* MBEDTLS_X509_CRT_PARSE_C */
1974
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001975/**
1976 * \brief Set the timeout period for mbedtls_ssl_read()
1977 * (Default: no timeout.)
1978 *
1979 * \param conf SSL configuration context
1980 * \param timeout Timeout value in milliseconds.
1981 * Use 0 for no timeout (default).
1982 *
1983 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001984 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001985 * With non-blocking I/O, this will only work if timer
1986 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1987 *
1988 * \note With non-blocking I/O, you may also skip this function
1989 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001990 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01001991void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout);
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001992
Hanno Beckercfe45792019-07-03 16:13:00 +01001993#if defined(MBEDTLS_SSL_RECORD_CHECKING)
1994/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001995 * \brief Check whether a buffer contains a valid and authentic record
1996 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01001997 *
1998 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01001999 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01002000 * an indication of the legitimacy of an incoming record.
2001 *
2002 * This can be useful e.g. in distributed server environments
2003 * using the DTLS Connection ID feature, in which connections
2004 * might need to be passed between service instances on a change
2005 * of peer address, but where such disruptive operations should
2006 * only happen after the validity of incoming records has been
2007 * confirmed.
2008 *
2009 * \param ssl The SSL context to use.
2010 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002011 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01002012 * \param buflen The length of \p buf in Bytes.
2013 *
2014 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002015 * with a valid and authentic record that has not been seen
2016 * before, but does not check potential data following the
2017 * initial record. In particular, it is possible to pass DTLS
2018 * datagrams containing multiple records, in which case only
2019 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01002020 *
2021 * \note This function modifies the input buffer \p buf. If you need
2022 * to preserve the original record, you have to maintain a copy.
2023 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002024 * \return \c 0 if the record is valid and authentic and has not been
2025 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01002026 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
2027 * successfully but the record was found to be not authentic.
2028 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
2029 * successfully but the record was found to be invalid for
2030 * a reason different from authenticity checking.
2031 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
2032 * successfully but the record was found to be unexpected
2033 * in the state of the SSL context, including replayed records.
2034 * \return Another negative error code on different kinds of failure.
2035 * In this case, the SSL context becomes unusable and needs
2036 * to be freed or reset before reuse.
2037 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002038int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
2039 unsigned char *buf,
2040 size_t buflen);
Hanno Beckercfe45792019-07-03 16:13:00 +01002041#endif /* MBEDTLS_SSL_RECORD_CHECKING */
2042
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002043/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002044 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002045 *
2046 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002047 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002048 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002049 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002050 *
2051 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
2052 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02002053 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002054 *
2055 * \note On some platforms, timing.c provides
2056 * \c mbedtls_timing_set_delay() and
2057 * \c mbedtls_timing_get_delay() that are suitable for using
2058 * here, except if using an event-driven style.
2059 *
2060 * \note See also the "DTLS tutorial" article in our knowledge base.
Dave Rodgman4e7892e2022-10-12 16:47:08 +01002061 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002062 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002063void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
2064 void *p_timer,
2065 mbedtls_ssl_set_timer_t *f_set_timer,
2066 mbedtls_ssl_get_timer_t *f_get_timer);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002067
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002068/**
2069 * \brief Callback type: generate and write session ticket
2070 *
2071 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002072 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002073 * authenticated ticket for the session and write it to the
2074 * output buffer. Here, ticket means the opaque ticket part
2075 * of the NewSessionTicket structure of RFC 5077.
2076 *
2077 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002078 * \param session SSL session to be written in the ticket
2079 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002080 * \param end End of the output buffer
2081 * \param tlen On exit, holds the length written
2082 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2083 *
2084 * \return 0 if successful, or
2085 * a specific MBEDTLS_ERR_XXX code.
2086 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002087typedef int mbedtls_ssl_ticket_write_t(void *p_ticket,
2088 const mbedtls_ssl_session *session,
2089 unsigned char *start,
2090 const unsigned char *end,
2091 size_t *tlen,
2092 uint32_t *lifetime);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002093
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002094#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2095/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002096 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002097 *
2098 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002099 * (RFC 5216) and Thread. The key pointers are ephemeral and
2100 * therefore must not be stored. The master secret and keys
2101 * should not be used directly except as an input to a key
2102 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002103 *
2104 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002105 * \param ms Pointer to master secret (fixed length: 48 bytes)
2106 * \param kb Pointer to key block, see RFC 5246 section 6.3
2107 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002108 * \param maclen MAC length
2109 * \param keylen Key length
2110 * \param ivlen IV length
2111 *
2112 * \return 0 if successful, or
2113 * a specific MBEDTLS_ERR_XXX code.
2114 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002115typedef int mbedtls_ssl_export_keys_t(void *p_expkey,
2116 const unsigned char *ms,
2117 const unsigned char *kb,
2118 size_t maclen,
2119 size_t keylen,
2120 size_t ivlen);
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002121
2122/**
2123 * \brief Callback type: Export key block, master secret,
2124 * handshake randbytes and the tls_prf function
2125 * used to derive keys.
2126 *
2127 * \note This is required for certain uses of TLS, e.g. EAP-TLS
2128 * (RFC 5216) and Thread. The key pointers are ephemeral and
2129 * therefore must not be stored. The master secret and keys
2130 * should not be used directly except as an input to a key
2131 * derivation function.
2132 *
2133 * \param p_expkey Context for the callback.
2134 * \param ms Pointer to master secret (fixed length: 48 bytes).
2135 * \param kb Pointer to key block, see RFC 5246 section 6.3.
2136 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
2137 * \param maclen MAC length.
2138 * \param keylen Key length.
2139 * \param ivlen IV length.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002140 * \param client_random The client random bytes.
2141 * \param server_random The server random bytes.
Ron Eldor51d3ab52019-05-12 14:54:30 +03002142 * \param tls_prf_type The tls_prf enum type.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002143 *
2144 * \return 0 if successful, or
2145 * a specific MBEDTLS_ERR_XXX code.
2146 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002147typedef int mbedtls_ssl_export_keys_ext_t(void *p_expkey,
2148 const unsigned char *ms,
2149 const unsigned char *kb,
2150 size_t maclen,
2151 size_t keylen,
2152 size_t ivlen,
2153 const unsigned char client_random[32],
2154 const unsigned char server_random[32],
2155 mbedtls_tls_prf_types tls_prf_type);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002156#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002157
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002158/**
2159 * \brief Callback type: parse and load session ticket
2160 *
2161 * \note This describes what a callback implementation should do.
2162 * This callback should parse a session ticket as generated
2163 * by the corresponding mbedtls_ssl_ticket_write_t function,
2164 * and, if the ticket is authentic and valid, load the
2165 * session.
2166 *
2167 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002168 * bytes of the input buffer, eg to use it as a temporary
2169 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002170 *
2171 * \param p_ticket Context for the callback
2172 * \param session SSL session to be loaded
2173 * \param buf Start of the buffer containing the ticket
2174 * \param len Length of the ticket.
2175 *
2176 * \return 0 if successful, or
2177 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2178 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2179 * any other non-zero code for other failures.
2180 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002181typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket,
2182 mbedtls_ssl_session *session,
2183 unsigned char *buf,
2184 size_t len);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002185
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002186#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002187/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002188 * \brief Configure SSL session ticket callbacks (server only).
2189 * (Default: none.)
2190 *
2191 * \note On server, session tickets are enabled by providing
2192 * non-NULL callbacks.
2193 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002194 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002195 *
2196 * \param conf SSL configuration context
2197 * \param f_ticket_write Callback for writing a ticket
2198 * \param f_ticket_parse Callback for parsing a ticket
2199 * \param p_ticket Context shared by the two callbacks
2200 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002201void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2202 mbedtls_ssl_ticket_write_t *f_ticket_write,
2203 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2204 void *p_ticket);
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002205#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002206
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002207#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2208/**
2209 * \brief Configure key export callback.
2210 * (Default: none.)
2211 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002212 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002213 *
2214 * \param conf SSL configuration context
2215 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002216 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002217 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002218void mbedtls_ssl_conf_export_keys_cb(mbedtls_ssl_config *conf,
2219 mbedtls_ssl_export_keys_t *f_export_keys,
2220 void *p_export_keys);
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002221
2222/**
2223 * \brief Configure extended key export callback.
2224 * (Default: none.)
2225 *
2226 * \note See \c mbedtls_ssl_export_keys_ext_t.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002227 * \warning Exported key material must not be used for any purpose
2228 * before the (D)TLS handshake is completed
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002229 *
2230 * \param conf SSL configuration context
2231 * \param f_export_keys_ext Callback for exporting keys
2232 * \param p_export_keys Context for the callback
2233 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002234void mbedtls_ssl_conf_export_keys_ext_cb(mbedtls_ssl_config *conf,
2235 mbedtls_ssl_export_keys_ext_t *f_export_keys_ext,
2236 void *p_export_keys);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002237#endif /* MBEDTLS_SSL_EXPORT_KEYS */
2238
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002239#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002240/**
2241 * \brief Configure asynchronous private key operation callbacks.
2242 *
2243 * \param conf SSL configuration context
2244 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002245 * the description of ::mbedtls_ssl_async_sign_t
2246 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002247 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002248 * operation; in this case the private key object
2249 * associated with the certificate will be used.
2250 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002251 * the description of ::mbedtls_ssl_async_decrypt_t
2252 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002253 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002254 * operation; in this case the private key object
2255 * associated with the certificate will be used.
2256 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002257 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002258 * for more information. This may not be \c NULL unless
2259 * \p f_async_sign and \p f_async_decrypt are both
2260 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002261 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002262 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002263 * for more information. This may be \c NULL if
2264 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002265 * \param config_data A pointer to configuration data which can be
2266 * retrieved with
2267 * mbedtls_ssl_conf_get_async_config_data(). The
2268 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002269 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002270void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf,
2271 mbedtls_ssl_async_sign_t *f_async_sign,
2272 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2273 mbedtls_ssl_async_resume_t *f_async_resume,
2274 mbedtls_ssl_async_cancel_t *f_async_cancel,
2275 void *config_data);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002276
2277/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002278 * \brief Retrieve the configuration data set by
2279 * mbedtls_ssl_conf_async_private_cb().
2280 *
2281 * \param conf SSL configuration context
2282 * \return The configuration data set by
2283 * mbedtls_ssl_conf_async_private_cb().
2284 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002285void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf);
Gilles Peskine8f97af72018-04-26 11:46:10 +02002286
2287/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002288 * \brief Retrieve the asynchronous operation user context.
2289 *
2290 * \note This function may only be called while a handshake
2291 * is in progress.
2292 *
2293 * \param ssl The SSL context to access.
2294 *
2295 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002296 * set during the current handshake. If
2297 * mbedtls_ssl_set_async_operation_data() has not yet been
2298 * called during the current handshake, this function returns
2299 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002300 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002301void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002302
2303/**
2304 * \brief Retrieve the asynchronous operation user context.
2305 *
2306 * \note This function may only be called while a handshake
2307 * is in progress.
2308 *
2309 * \param ssl The SSL context to access.
2310 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002311 * Call mbedtls_ssl_get_async_operation_data() later during the
2312 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002313 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002314void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2315 void *ctx);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002316#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002317
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002318/**
2319 * \brief Callback type: generate a cookie
2320 *
2321 * \param ctx Context for the callback
2322 * \param p Buffer to write to,
2323 * must be updated to point right after the cookie
2324 * \param end Pointer to one past the end of the output buffer
2325 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002326 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002327 * \param ilen Length of info in bytes
2328 *
2329 * \return The callback must return 0 on success,
2330 * or a negative error code.
2331 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002332typedef int mbedtls_ssl_cookie_write_t(void *ctx,
2333 unsigned char **p, unsigned char *end,
2334 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002335
2336/**
2337 * \brief Callback type: verify a cookie
2338 *
2339 * \param ctx Context for the callback
2340 * \param cookie Cookie to verify
2341 * \param clen Length of cookie
2342 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002344 * \param ilen Length of info in bytes
2345 *
2346 * \return The callback must return 0 if cookie is valid,
2347 * or a negative error code.
2348 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002349typedef int mbedtls_ssl_cookie_check_t(void *ctx,
2350 const unsigned char *cookie, size_t clen,
2351 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002352
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002353#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002354/**
2355 * \brief Register callbacks for DTLS cookies
2356 * (Server only. DTLS only.)
2357 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002358 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002359 * register working callbacks (and initialize their context).
2360 *
2361 * To disable HelloVerifyRequest, register NULL callbacks.
2362 *
2363 * \warning Disabling hello verification allows your server to be used
2364 * for amplification in DoS attacks against other hosts.
2365 * Only disable if you known this can't happen in your
2366 * particular environment.
2367 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002368 * \note See comments on \c mbedtls_ssl_handshake() about handling
2369 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2370 * on the first handshake attempt when this is enabled.
2371 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002372 * \note This is also necessary to handle client reconnection from
2373 * the same port as described in RFC 6347 section 4.2.8 (only
2374 * the variant with cookies is supported currently). See
2375 * comments on \c mbedtls_ssl_read() for details.
2376 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002377 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002378 * \param f_cookie_write Cookie write callback
2379 * \param f_cookie_check Cookie check callback
2380 * \param p_cookie Context for both callbacks
2381 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002382void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf,
2383 mbedtls_ssl_cookie_write_t *f_cookie_write,
2384 mbedtls_ssl_cookie_check_t *f_cookie_check,
2385 void *p_cookie);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002386
2387/**
2388 * \brief Set client's transport-level identification info.
2389 * (Server only. DTLS only.)
2390 *
2391 * This is usually the IP address (and port), but could be
2392 * anything identify the client depending on the underlying
2393 * network stack. Used for HelloVerifyRequest with DTLS.
2394 * This is *not* used to route the actual packets.
2395 *
2396 * \param ssl SSL context
2397 * \param info Transport-level info identifying the client (eg IP + port)
2398 * \param ilen Length of info in bytes
2399 *
2400 * \note An internal copy is made, so the info buffer can be reused.
2401 *
2402 * \return 0 on success,
2403 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002404 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002405 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002406int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl,
2407 const unsigned char *info,
2408 size_t ilen);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002409
2410#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002411
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002412#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002413/**
2414 * \brief Enable or disable anti-replay protection for DTLS.
2415 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002416 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002417 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002418 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002420 *
2421 * \warning Disabling this is a security risk unless the application
2422 * protocol handles duplicated packets in a safe way. You
2423 * should not disable this without careful consideration.
2424 * However, if your application already detects duplicated
2425 * packets and needs information about them to adjust its
2426 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002427 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002428void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002430
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002431#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002432/**
2433 * \brief Set a limit on the number of records with a bad MAC
2434 * before terminating the connection.
2435 * (DTLS only, no effect on TLS.)
2436 * Default: 0 (disabled).
2437 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002438 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002439 * \param limit Limit, or 0 to disable.
2440 *
2441 * \note If the limit is N, then the connection is terminated when
2442 * the Nth non-authentic record is seen.
2443 *
2444 * \note Records with an invalid header are not counted, only the
2445 * ones going through the authentication-decryption phase.
2446 *
2447 * \note This is a security trade-off related to the fact that it's
Andrzej Kurek293e4522022-04-13 14:28:52 -04002448 * often relatively easy for an active attacker to inject UDP
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002449 * datagrams. On one hand, setting a low limit here makes it
2450 * easier for such an attacker to forcibly terminated a
2451 * connection. On the other hand, a high limit or no limit
2452 * might make us waste resources checking authentication on
2453 * many bogus packets.
2454 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002455void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002456#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002458#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002459
2460/**
2461 * \brief Allow or disallow packing of multiple handshake records
2462 * within a single datagram.
2463 *
2464 * \param ssl The SSL context to configure.
2465 * \param allow_packing This determines whether datagram packing may
2466 * be used or not. A value of \c 0 means that every
2467 * record will be sent in a separate datagram; a
2468 * value of \c 1 means that, if space permits,
2469 * multiple handshake messages (including CCS) belonging to
2470 * a single flight may be packed within a single datagram.
2471 *
2472 * \note This is enabled by default and should only be disabled
2473 * for test purposes, or if datagram packing causes
2474 * interoperability issues with peers that don't support it.
2475 *
2476 * \note Allowing datagram packing reduces the network load since
2477 * there's less overhead if multiple messages share the same
2478 * datagram. Also, it increases the handshake efficiency
2479 * since messages belonging to a single datagram will not
2480 * be reordered in transit, and so future message buffering
2481 * or flight retransmission (if no buffering is used) as
2482 * means to deal with reordering are needed less frequently.
2483 *
Hanno Beckereb570082018-08-24 11:28:35 +01002484 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002485 * are currently always sent in separate datagrams.
2486 *
2487 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002488void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
2489 unsigned allow_packing);
Hanno Becker04da1892018-08-14 13:22:10 +01002490
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002491/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002492 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002493 * (DTLS only, no effect on TLS.)
2494 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002495 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002496 * \param min Initial timeout value in milliseconds.
2497 * Default: 1000 (1 second).
2498 * \param max Maximum timeout value in milliseconds.
2499 * Default: 60000 (60 seconds).
2500 *
2501 * \note Default values are from RFC 6347 section 4.2.4.1.
2502 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002503 * \note The 'min' value should typically be slightly above the
2504 * expected round-trip time to your peer, plus whatever time
2505 * it takes for the peer to process the message. For example,
2506 * if your RTT is about 600ms and you peer needs up to 1s to
2507 * do the cryptographic operations in the handshake, then you
2508 * should set 'min' slightly above 1600. Lower values of 'min'
2509 * might cause spurious resends which waste network resources,
2510 * while larger value of 'min' will increase overall latency
2511 * on unreliable network links.
2512 *
2513 * \note The more unreliable your network connection is, the larger
2514 * your max / min ratio needs to be in order to achieve
2515 * reliable handshakes.
2516 *
2517 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2518 * For example, if min = 1s and max = 5s, the retransmit plan
2519 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2520 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002521 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002522void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002524
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002525#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002526/**
Paul Bakker0a597072012-09-25 21:55:46 +00002527 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002528 * If not set, no session resuming is done (except if session
2529 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002530 *
Paul Bakker0a597072012-09-25 21:55:46 +00002531 * The session cache has the responsibility to check for stale
2532 * entries based on timeout. See RFC 5246 for recommendations.
2533 *
2534 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2535 * connection shutdown, so do not cache the pointer! Either set
2536 * it to NULL or make a full copy of the certificate.
2537 *
2538 * The get callback is called once during the initial handshake
2539 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002540 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002541 * If a valid entry is found, it should fill the master of
2542 * the session object with the cached values and return 0,
2543 * return 1 otherwise. Optionally peer_cert can be set as well
2544 * if it is properly present in cache entry.
2545 *
2546 * The set callback is called once during the initial handshake
2547 * to enable session resuming after the entire handshake has
2548 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002549 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002550 * should create a cache entry for future retrieval based on
2551 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002553 * data) is cleared by the SSL/TLS layer when the connection is
2554 * terminated. It is recommended to add metadata to determine if
2555 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002556 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002557 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002558 * \param conf SSL configuration
Tom Cosgrove2b150752022-05-26 11:55:43 +01002559 * \param p_cache parameter (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002560 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002561 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002562 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002563void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
2564 void *p_cache,
2565 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2566 int (*f_set_cache)(void *, const mbedtls_ssl_session *));
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002568
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002569#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002570/**
Paul Bakker0a597072012-09-25 21:55:46 +00002571 * \brief Request resumption of session (client-side only)
2572 * Session data is copied from presented session structure.
2573 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002574 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002575 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002576 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002577 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002578 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002579 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002580 * arguments are otherwise invalid
2581 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002582 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002583 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002584int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002586
2587/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002588 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002589 * On client, this can be used for loading saved sessions
Tom Cosgrove2b150752022-05-26 11:55:43 +01002590 * before resuming them with mbedtls_ssl_set_session().
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002591 * On server, this can be used for alternative implementations
2592 * of session cache or session tickets.
2593 *
2594 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002595 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002596 * end-entity certificate and the result of the chain
2597 * verification (unless verification was disabled), but not
2598 * the rest of the chain.
2599 *
2600 * \see mbedtls_ssl_session_save()
2601 * \see mbedtls_ssl_set_session()
2602 *
2603 * \param session The session structure to be populated. It must have been
2604 * initialised with mbedtls_ssl_session_init() but not
2605 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002606 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002607 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002608 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002609 *
2610 * \return \c 0 if successful.
2611 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2612 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01002613 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2614 * was generated in a different version or configuration of
2615 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002616 * \return Another negative value for other kinds of errors (for
2617 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002618 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002619int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
2620 const unsigned char *buf,
2621 size_t len);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002622
2623/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002624 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002625 * On client, this can be used for saving session data,
2626 * potentially in non-volatile storage, for resuming later.
2627 * On server, this can be used for alternative implementations
2628 * of session cache or session tickets.
2629 *
2630 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002631 * \see mbedtls_ssl_get_session_pointer()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002632 *
2633 * \param session The session structure to be saved.
2634 * \param buf The buffer to write the serialized data to. It must be a
Andrzej Kurek532ec202023-05-06 09:57:40 -04002635 * writeable buffer of at least \p buf_len bytes, or may be \c
2636 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002637 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002638 * \param olen The size in bytes of the data that has been or would have
2639 * been written. It must point to a valid \c size_t.
2640 *
2641 * \note \p olen is updated to the correct value regardless of
2642 * whether \p buf_len was large enough. This makes it possible
2643 * to determine the necessary size by calling this function
2644 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002645 *
2646 * \return \c 0 if successful.
2647 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2648 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002649int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
2650 unsigned char *buf,
2651 size_t buf_len,
2652 size_t *olen);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002653
2654/**
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002655 * \brief Get a pointer to the current session structure, for example
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002656 * to serialize it.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002657 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002658 * \warning Ownership of the session remains with the SSL context, and
2659 * the returned pointer is only guaranteed to be valid until
2660 * the next API call operating on the same \p ssl context.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002661 *
2662 * \see mbedtls_ssl_session_save()
2663 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002664 * \param ssl The SSL context.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002665 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002666 * \return A pointer to the current session if successful.
2667 * \return \c NULL if no session is active.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002668 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002669const mbedtls_ssl_session *mbedtls_ssl_get_session_pointer(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002670
2671/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002672 * \brief Set the list of allowed ciphersuites and the preference
2673 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002674 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002675 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002676 * The ciphersuites array is not copied, and must remain
2677 * valid for the lifetime of the ssl_config.
2678 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002679 * Note: The server uses its own preferences
2680 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002681 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002682 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002683 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002684 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002685 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002686void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
2687 const int *ciphersuites);
Paul Bakker5121ce52009-01-03 21:22:43 +00002688
Hanno Beckera0e20d02019-05-15 14:03:01 +01002689#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01002690#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2691#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01002692/**
Hanno Becker11259522019-05-23 16:55:50 +01002693 * \brief Specify the length of Connection IDs for incoming
2694 * encrypted DTLS records, as well as the behaviour
2695 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01002696 *
2697 * By default, the CID length is set to \c 0,
2698 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002699 *
2700 * \param conf The SSL configuration to modify.
2701 * \param len The length in Bytes of the CID fields in encrypted
2702 * DTLS records using the CID mechanism. This must
2703 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01002704 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01002705 * receiving a record with an unexpected CID.
2706 * Possible values are:
2707 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2708 * In this case, the record is silently ignored.
2709 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2710 * In this case, the stack fails with the specific
2711 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002712 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002713 * \note The CID specification allows implementations to either
2714 * use a common length for all incoming connection IDs or
2715 * allow variable-length incoming IDs. Mbed TLS currently
2716 * requires a common length for all connections sharing the
2717 * same SSL configuration; this allows simpler parsing of
2718 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002719 *
2720 * \return \c 0 on success.
Andrzej Kurek96ce1b02023-07-14 05:22:42 -04002721 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p len
Hanno Beckerad4a1372019-05-03 13:06:44 +01002722 * is too large.
2723 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002724int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len,
2725 int ignore_other_cids);
Hanno Beckera0e20d02019-05-15 14:03:01 +01002726#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01002727
Paul Bakker5121ce52009-01-03 21:22:43 +00002728/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002729 * \brief Set the list of allowed ciphersuites and the
2730 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002731 * (Only useful on the server side)
2732 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002733 * The ciphersuites array is not copied, and must remain
2734 * valid for the lifetime of the ssl_config.
2735 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002736 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002737 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002739 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002740 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2741 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2742 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002743 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002744 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2745 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002746 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002747void mbedtls_ssl_conf_ciphersuites_for_version(mbedtls_ssl_config *conf,
2748 const int *ciphersuites,
2749 int major, int minor);
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002750
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002752/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002753 * \brief Set the X.509 security profile used for verification
2754 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002755 * \note The restrictions are enforced for all certificates in the
2756 * chain. However, signatures in the handshake are not covered
2757 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2758 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002759 * \param conf SSL configuration
2760 * \param profile Profile to use
2761 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002762void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
2763 const mbedtls_x509_crt_profile *profile);
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002764
2765/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002766 * \brief Set the data required to verify peer certificate
2767 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002768 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002769 * parameters ca_chain (maps to trust_ca for that function)
2770 * and ca_crl.
2771 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002772 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002773 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002774 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002775 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002776void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002777 mbedtls_x509_crt *ca_chain,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002778 mbedtls_x509_crl *ca_crl);
Paul Bakker5121ce52009-01-03 21:22:43 +00002779
Hanno Becker8bf74f32019-03-27 11:01:30 +00002780#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2781/**
2782 * \brief Set the trusted certificate callback.
2783 *
2784 * This API allows to register the set of trusted certificates
2785 * through a callback, instead of a linked list as configured
2786 * by mbedtls_ssl_conf_ca_chain().
2787 *
2788 * This is useful for example in contexts where a large number
2789 * of CAs are used, and the inefficiency of maintaining them
2790 * in a linked list cannot be tolerated. It is also useful when
2791 * the set of trusted CAs needs to be modified frequently.
2792 *
2793 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2794 * more information.
2795 *
2796 * \param conf The SSL configuration to register the callback with.
2797 * \param f_ca_cb The trusted certificate callback to use when verifying
2798 * certificate chains.
2799 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2800 * a reference to a trusted CA database).
2801 *
2802 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2803 * Any call to this function overwrites the values set through
2804 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2805 * mbedtls_ssl_conf_ca_cb().
2806 *
2807 * \note This API is incompatible with CA indication in
2808 * CertificateRequest messages: A server-side SSL context which
2809 * is bound to an SSL configuration that uses a CA callback
2810 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2811 * client authentication, will send an empty CA list in the
2812 * corresponding CertificateRequest message.
2813 *
2814 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2815 * If an SSL context is bound to an SSL configuration which uses
2816 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2817 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2818 *
2819 * \note The use of this API disables the use of restartable ECC
2820 * during X.509 CRT signature verification (but doesn't affect
2821 * other uses).
2822 *
2823 * \warning This API is incompatible with the use of CRLs. Any call to
2824 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2825 * earlier calls to mbedtls_ssl_conf_ca_chain().
2826 *
2827 * \warning In multi-threaded environments, the callback \p f_ca_cb
2828 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002829 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002830 * contained in the callback context pointed to by \p p_ca_cb).
2831 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002832void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
2833 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2834 void *p_ca_cb);
Hanno Becker8bf74f32019-03-27 11:01:30 +00002835#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2836
Paul Bakker5121ce52009-01-03 21:22:43 +00002837/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002838 * \brief Set own certificate chain and private key
2839 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002840 * \note own_cert should contain in order from the bottom up your
2841 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002842 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002843 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002844 * \note On server, this function can be called multiple times to
2845 * provision more than one cert/key pair (eg one ECDSA, one
2846 * RSA with SHA-256, one RSA with SHA-1). An adequate
2847 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002848 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002849 * adequate, preference is given to the one set by the first
2850 * call to this function, then second, etc.
2851 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002852 * \note On client, only the first call has any effect. That is,
2853 * only one client certificate can be provisioned. The
bootstrap-prime7ef96ea2022-05-18 14:08:33 -04002854 * server's preferences in its CertificateRequest message will
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002855 * be ignored and our only cert will be sent regardless of
2856 * whether it matches those preferences - the server can then
2857 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002858 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002859 * \note The provided \p pk_key needs to match the public key in the
2860 * first certificate in \p own_cert, or all handshakes using
2861 * that certificate will fail. It is your responsibility
2862 * to ensure that; this function will not perform any check.
2863 * You may use mbedtls_pk_check_pair() in order to perform
2864 * this check yourself, but be aware that this function can
2865 * be computationally expensive on some key types.
2866 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002867 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002868 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002869 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002870 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002871 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002872 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002873int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002874 mbedtls_x509_crt *own_cert,
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002875 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002876#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002877
Gilles Peskineeccd8882020-03-10 12:19:08 +01002878#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002879/**
Hanno Becker02283042018-10-22 15:28:02 +01002880 * \brief Configure a pre-shared key (PSK) and identity
2881 * to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002882 *
2883 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002884 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002885 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002886 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
2887 * takes precedence over a PSK configured by this function.
2888 *
Hanno Becker02283042018-10-22 15:28:02 +01002889 * \warning Currently, clients can only register a single pre-shared key.
Hanno Beckerf9a32872018-11-15 13:18:25 +00002890 * Calling this function or mbedtls_ssl_conf_psk_opaque() more
Hanno Becker02283042018-10-22 15:28:02 +01002891 * than once will overwrite values configured in previous calls.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002892 * Support for setting multiple PSKs on clients and selecting
Hanno Becker02283042018-10-22 15:28:02 +01002893 * one based on the identity hint is not a planned feature,
2894 * but feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002895 *
Hanno Becker02283042018-10-22 15:28:02 +01002896 * \param conf The SSL configuration to register the PSK with.
2897 * \param psk The pointer to the pre-shared key to use.
2898 * \param psk_len The length of the pre-shared key in bytes.
2899 * \param psk_identity The pointer to the pre-shared key identity.
2900 * \param psk_identity_len The length of the pre-shared key identity
2901 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002902 *
Hanno Becker02283042018-10-22 15:28:02 +01002903 * \note The PSK and its identity are copied internally and
2904 * hence need not be preserved by the caller for the lifetime
2905 * of the SSL configuration.
2906 *
2907 * \return \c 0 if successful.
2908 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002909 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002910int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
2911 const unsigned char *psk, size_t psk_len,
2912 const unsigned char *psk_identity, size_t psk_identity_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002913
Hanno Becker02283042018-10-22 15:28:02 +01002914#if defined(MBEDTLS_USE_PSA_CRYPTO)
2915/**
2916 * \brief Configure an opaque pre-shared key (PSK) and identity
2917 * to be used in PSK-based ciphersuites.
2918 *
2919 * \note This is mainly useful for clients. Servers will usually
2920 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2921 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002922 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
2923 * the PSK callback takes precedence over an opaque PSK
2924 * configured by this function.
2925 *
Hanno Becker02283042018-10-22 15:28:02 +01002926 * \warning Currently, clients can only register a single pre-shared key.
2927 * Calling this function or mbedtls_ssl_conf_psk() more than
2928 * once will overwrite values configured in previous calls.
2929 * Support for setting multiple PSKs on clients and selecting
2930 * one based on the identity hint is not a planned feature,
2931 * but feedback is welcomed.
2932 *
2933 * \param conf The SSL configuration to register the PSK with.
2934 * \param psk The identifier of the key slot holding the PSK.
2935 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002936 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002937 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002938 * allows its use for the key derivation algorithm applied
2939 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002940 * \param psk_identity The pointer to the pre-shared key identity.
2941 * \param psk_identity_len The length of the pre-shared key identity
2942 * in bytes.
2943 *
2944 * \note The PSK identity hint is copied internally and hence need
2945 * not be preserved by the caller for the lifetime of the
2946 * SSL configuration.
2947 *
2948 * \return \c 0 if successful.
2949 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2950 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002951int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
2952 psa_key_id_t psk,
2953 const unsigned char *psk_identity,
2954 size_t psk_identity_len);
Hanno Becker02283042018-10-22 15:28:02 +01002955#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002956
2957/**
Hanno Becker02283042018-10-22 15:28:02 +01002958 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002959 *
2960 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002961 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002962 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002963 * \note A PSK set by this function takes precedence over a PSK
2964 * configured by \c mbedtls_ssl_conf_psk().
2965 *
Hanno Becker02283042018-10-22 15:28:02 +01002966 * \param ssl The SSL context to configure a PSK for.
2967 * \param psk The pointer to the pre-shared key.
2968 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002969 *
Hanno Becker02283042018-10-22 15:28:02 +01002970 * \return \c 0 if successful.
2971 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002972 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002973int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
2974 const unsigned char *psk, size_t psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002975
Hanno Becker02283042018-10-22 15:28:02 +01002976#if defined(MBEDTLS_USE_PSA_CRYPTO)
2977/**
2978 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2979 *
2980 * \note This should only be called inside the PSK callback,
2981 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2982 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002983 * \note An opaque PSK set by this function takes precedence over an
2984 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
2985 *
Hanno Becker02283042018-10-22 15:28:02 +01002986 * \param ssl The SSL context to configure a PSK for.
2987 * \param psk The identifier of the key slot holding the PSK.
2988 * For the duration of the current handshake, the key slot
2989 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002990 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002991 * use for the key derivation algorithm
2992 * applied in the handshake.
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002993 *
Hanno Becker02283042018-10-22 15:28:02 +01002994 * \return \c 0 if successful.
2995 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2996 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01002997int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
2998 psa_key_id_t psk);
Hanno Becker02283042018-10-22 15:28:02 +01002999#endif /* MBEDTLS_USE_PSA_CRYPTO */
3000
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003001/**
3002 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02003003 *
3004 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01003005 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01003006 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02003007 * receive the actual PSK data and length.
3008 *
Hanno Becker02283042018-10-22 15:28:02 +01003009 * The callback has the following parameters:
3010 * - \c void*: The opaque pointer \p p_psk.
3011 * - \c mbedtls_ssl_context*: The SSL context to which
3012 * the operation applies.
3013 * - \c const unsigned char*: The PSK identity
3014 * selected by the client.
3015 * - \c size_t: The length of the PSK identity
3016 * selected by the client.
3017 *
Paul Bakker6db455e2013-09-18 17:29:31 +02003018 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01003019 * \c mbedtls_ssl_set_hs_psk() or
3020 * \c mbedtls_ssl_set_hs_psk_opaque()
3021 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02003022 * Any other return value will result in a denied PSK identity.
3023 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003024 * \note A dynamic PSK (i.e. set by the PSK callback) takes
3025 * precedence over a static PSK (i.e. set by
3026 * \c mbedtls_ssl_conf_psk() or
3027 * \c mbedtls_ssl_conf_psk_opaque()).
3028 * This means that if you set a PSK callback using this
3029 * function, you don't need to set a PSK using
3030 * \c mbedtls_ssl_conf_psk() or
3031 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003032 *
Hanno Becker02283042018-10-22 15:28:02 +01003033 * \param conf The SSL configuration to register the callback with.
3034 * \param f_psk The callback for selecting and setting the PSK based
3035 * in the PSK identity chosen by the client.
3036 * \param p_psk A pointer to an opaque structure to be passed to
3037 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02003038 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003039void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
3040 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3041 size_t),
3042 void *p_psk);
Gilles Peskineeccd8882020-03-10 12:19:08 +01003043#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003044
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01003045#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01003046
3047#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3048
3049#if defined(MBEDTLS_DEPRECATED_WARNING)
3050#define MBEDTLS_DEPRECATED __attribute__((deprecated))
3051#else
3052#define MBEDTLS_DEPRECATED
3053#endif
3054
Paul Bakker5121ce52009-01-03 21:22:43 +00003055/**
3056 * \brief Set the Diffie-Hellman public P and G values,
3057 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01003058 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00003059 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003060 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00003061 * \param dhm_P Diffie-Hellman-Merkle modulus
3062 * \param dhm_G Diffie-Hellman-Merkle generator
3063 *
Hanno Becker470a8c42017-10-04 15:28:46 +01003064 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
3065 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003066 * \return 0 if successful
3067 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003068MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param(mbedtls_ssl_config *conf,
3069 const char *dhm_P,
3070 const char *dhm_G);
Paul Bakker5121ce52009-01-03 21:22:43 +00003071
Hanno Becker470a8c42017-10-04 15:28:46 +01003072#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01003073
3074/**
3075 * \brief Set the Diffie-Hellman public P and G values
3076 * from big-endian binary presentations.
3077 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
3078 *
3079 * \param conf SSL configuration
3080 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
3081 * \param P_len Length of DHM modulus
3082 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
3083 * \param G_len Length of DHM generator
3084 *
3085 * \return 0 if successful
3086 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003087int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
3088 const unsigned char *dhm_P, size_t P_len,
3089 const unsigned char *dhm_G, size_t G_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003090
3091/**
Paul Bakker1b57b062011-01-06 15:48:19 +00003092 * \brief Set the Diffie-Hellman public P and G values,
3093 * read from existing context (server-side only)
3094 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003095 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00003096 * \param dhm_ctx Diffie-Hellman-Merkle context
3097 *
3098 * \return 0 if successful
3099 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003100int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx);
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003101#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00003102
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003103#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3104/**
3105 * \brief Set the minimum length for Diffie-Hellman parameters.
3106 * (Client-side only.)
3107 * (Default: 1024 bits.)
3108 *
3109 * \param conf SSL configuration
3110 * \param bitlen Minimum bit length of the DHM prime
3111 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003112void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
3113 unsigned int bitlen);
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003114#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3115
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003116#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01003117/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003118 * \brief Set the allowed curves in order of preference.
Gilles Peskine5ea63a32021-06-22 10:50:04 +02003119 * (Default: all defined curves in order of decreasing size,
3120 * except that Montgomery curves come last. This order
3121 * is likely to change in a future version.)
Gergely Budai987bfb52014-01-19 21:48:42 +01003122 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003123 * On server: this only affects selection of the ECDHE curve;
3124 * the curves used for ECDH and ECDSA are determined by the
3125 * list of available certificates instead.
3126 *
3127 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01003128 * use. The server can override our preference order.
3129 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003130 * Both sides: limits the set of curves accepted for use in
3131 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003132 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003133 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003134 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003135 * for that. For the end-entity certificate however, the key
3136 * will be accepted only if it is allowed both by this list
3137 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01003138 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003139 * \note This list should be ordered by decreasing preference
3140 * (preferred curve first).
3141 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003142 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003143 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003144 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01003145 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003146void mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3147 const mbedtls_ecp_group_id *curves);
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003148#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01003149
Gilles Peskineeccd8882020-03-10 12:19:08 +01003150#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003151/**
3152 * \brief Set the allowed hashes for signatures during the handshake.
Gilles Peskine138d9f52021-06-21 09:53:25 +02003153 * (Default: all SHA-2 hashes, largest first. Also SHA-1 if
3154 * the compile-time option
3155 * `MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE` is enabled.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003156 *
3157 * \note This only affects which hashes are offered and can be used
3158 * for signatures during the handshake. Hashes for message
3159 * authentication and the TLS PRF are controlled by the
3160 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
3161 * used for certificate signature are controlled by the
3162 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
3163 *
3164 * \note This list should be ordered by decreasing preference
3165 * (preferred hash first).
3166 *
3167 * \param conf SSL configuration
3168 * \param hashes Ordered list of allowed signature hashes,
3169 * terminated by \c MBEDTLS_MD_NONE.
3170 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003171void mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
3172 const int *hashes);
Gilles Peskineeccd8882020-03-10 12:19:08 +01003173#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003174
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003175#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003176/**
Darryl Green11999bb2018-03-13 15:22:58 +00003177 * \brief Set or reset the hostname to check against the received
3178 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003179 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003180 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003181 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003182 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003183
Hanno Becker0446a392017-04-07 12:59:32 +01003184 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003185 *
Darryl Green11999bb2018-03-13 15:22:58 +00003186 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3187 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003188 * too long input hostname.
3189 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003190 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003191 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003192 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003193 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003194int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname);
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003195#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003196
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003197#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003198/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003199 * \brief Set own certificate and key for the current handshake
3200 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003201 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003202 * the SNI callback.
3203 *
3204 * \param ssl SSL context
3205 * \param own_cert own public certificate chain
3206 * \param pk_key own private key
3207 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003208 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003209 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003210int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
3211 mbedtls_x509_crt *own_cert,
3212 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003213
3214/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003215 * \brief Set the data required to verify peer certificate for the
3216 * current handshake
3217 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003218 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003219 * the SNI callback.
3220 *
3221 * \param ssl SSL context
3222 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3223 * \param ca_crl trusted CA CRLs
3224 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003225void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
3226 mbedtls_x509_crt *ca_chain,
3227 mbedtls_x509_crl *ca_crl);
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003228
3229/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003230 * \brief Set authmode for the current handshake.
3231 *
3232 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
3233 * the SNI callback.
3234 *
3235 * \param ssl SSL context
3236 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3237 * MBEDTLS_SSL_VERIFY_REQUIRED
3238 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003239void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
3240 int authmode);
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003241
3242/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003243 * \brief Set server side ServerName TLS extension callback
3244 * (optional, server-side only).
3245 *
3246 * If set, the ServerName callback is called whenever the
3247 * server receives a ServerName TLS extension from the client
3248 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003250 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003251 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003252 * certificate(s) and key(s) to use with \c
3253 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003254 * and may optionally adjust the CA and associated CRL with \c
3255 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3256 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3257 * then must return 0. If no matching name is found, the
3258 * callback must either set a default cert, or
3259 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003260 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003261 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003262 * \param f_sni verification function
3263 * \param p_sni verification parameter
3264 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003265void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3266 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
3267 size_t),
3268 void *p_sni);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003270
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003271#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003272/**
3273 * \brief Set the EC J-PAKE password for current handshake.
3274 *
3275 * \note An internal copy is made, and destroyed as soon as the
3276 * handshake is completed, or when the SSL context is reset or
3277 * freed.
3278 *
3279 * \note The SSL context needs to be already set up. The right place
3280 * to call this function is between \c mbedtls_ssl_setup() or
3281 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
3282 *
3283 * \param ssl SSL context
3284 * \param pw EC J-PAKE password (pre-shared secret)
3285 * \param pw_len length of pw in bytes
3286 *
3287 * \return 0 on success, or a negative error code.
3288 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003289int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
3290 const unsigned char *pw,
3291 size_t pw_len);
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003292#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003293
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003294#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003295/**
3296 * \brief Set the supported Application Layer Protocols.
3297 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003298 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003299 * \param protos Pointer to a NULL-terminated list of supported protocols,
3300 * in decreasing preference order. The pointer to the list is
3301 * recorded by the library for later reference as required, so
Shaun Case0e7791f2021-12-20 21:14:10 -08003302 * the lifetime of the table must be at least as long as the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003303 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003304 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003306 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003307int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos);
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003308
3309/**
3310 * \brief Get the name of the negotiated Application Layer Protocol.
3311 * This function should be called after the handshake is
3312 * completed.
3313 *
3314 * \param ssl SSL context
3315 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003316 * \return Protocol name, or NULL if no protocol was negotiated.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003317 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003318const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003319#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003320
Johan Pascalb62bb512015-12-03 21:56:45 +01003321#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003322#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003323static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile)
Johan Pascala455cd92020-09-22 15:28:11 +02003324{
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003325 switch (profile) {
Johan Pascala455cd92020-09-22 15:28:11 +02003326 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003327 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003328 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003329 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003330 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003331 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003332 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003333 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003334 default: break;
3335 }
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003336 return "";
Johan Pascala455cd92020-09-22 15:28:11 +02003337}
3338#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003339/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003340 * \brief Manage support for mki(master key id) value
3341 * in use_srtp extension.
3342 * MKI is an optional part of SRTP used for key management
3343 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003344 * The default value is
3345 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003346 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003347 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003348 * \param support_mki_value Enable or disable mki usage. Values are
3349 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3350 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003351 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003352void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3353 int support_mki_value);
Ron Eldor591f1622018-01-22 12:30:04 +02003354
3355/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003356 * \brief Set the supported DTLS-SRTP protection profiles.
3357 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003358 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003359 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3360 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003361 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003362 * The pointer to the list is recorded by the library
3363 * for later reference as required, so the lifetime
3364 * of the table must be at least as long as the lifetime
3365 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003366 * The list must not hold more than
3367 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003368 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01003369 *
Johan Pascal85269572020-08-25 10:01:54 +02003370 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003371 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
3372 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01003373 */
Ron Eldora9788042018-12-05 11:04:31 +02003374int mbedtls_ssl_conf_dtls_srtp_protection_profiles
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003375 (mbedtls_ssl_config *conf,
3376 const mbedtls_ssl_srtp_profile *profiles);
Ron Eldor591f1622018-01-22 12:30:04 +02003377
3378/**
Ron Eldora9788042018-12-05 11:04:31 +02003379 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02003380 *
Ron Eldora9788042018-12-05 11:04:31 +02003381 * \param ssl SSL context to use.
3382 * \param mki_value The MKI value to set.
3383 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02003384 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003385 * \note This function is relevant on client side only.
3386 * The server discovers the mki value during handshake.
3387 * A mki value set on server side using this function
3388 * is ignored.
3389 *
Johan Pascal85269572020-08-25 10:01:54 +02003390 * \return 0 on success
3391 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
3392 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02003393 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003394int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
3395 unsigned char *mki_value,
3396 uint16_t mki_len);
Johan Pascalb62bb512015-12-03 21:56:45 +01003397/**
Shaun Case0e7791f2021-12-20 21:14:10 -08003398 * \brief Get the negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01003399 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003400 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003401 * \warning This function must be called after the handshake is
3402 * completed. The value returned by this function must
3403 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01003404 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003405 * \param ssl The SSL context to query.
Shaun Case0e7791f2021-12-20 21:14:10 -08003406 * \param dtls_srtp_info The negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01003407 * - Protection profile in use.
3408 * A direct mapping of the iana defined value for protection
3409 * profile on an uint16_t.
3410 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
3411 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
3412 * or peer's Hello packet was not parsed yet.
3413 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01003414 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003415void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
3416 mbedtls_dtls_srtp_info *dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01003417#endif /* MBEDTLS_SSL_DTLS_SRTP */
3418
Paul Bakker5701cdc2012-09-27 21:49:42 +00003419/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003420 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003421 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003422 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003423 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003424 * \note This ignores ciphersuites from higher versions.
3425 *
3426 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3427 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003428 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003429 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
3431 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
3432 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
3433 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003434 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003435void mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major, int minor);
Paul Bakker490ecc82011-10-06 13:04:09 +00003436
Paul Bakker1d29fb52012-09-28 13:28:45 +00003437/**
3438 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02003439 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003440 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003441 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3442 * SSL_MIN_XXXXX_VERSION range is ignored.
3443 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00003445 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003446 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3447 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
3448 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003449 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003450 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
3451 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
3452 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
3453 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003454 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003455void mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major, int minor);
Paul Bakker1d29fb52012-09-28 13:28:45 +00003456
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003457#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003458/**
3459 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003460 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003461 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003462 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003463 * connection, that is a connection with max_version set to a
3464 * lower value than the value you're willing to use. Such
3465 * fallback connections are not recommended but are sometimes
3466 * necessary to interoperate with buggy (version-intolerant)
3467 * servers.
3468 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003469 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003470 * non-fallback connections! This would appear to work for a
3471 * while, then cause failures when the server is upgraded to
3472 * support a newer TLS version.
3473 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01003474 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003475 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003476 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003477void mbedtls_ssl_conf_fallback(mbedtls_ssl_config *conf, char fallback);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003478#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003481/**
3482 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003483 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003484 *
3485 * \note This should always be enabled, it is a security
3486 * improvement, and should not cause any interoperability
3487 * issue (used only if the peer supports it too).
3488 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003489 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003490 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003491 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003492void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003493#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003494
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003495#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003496/**
3497 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003499 *
3500 * \note This should always be enabled, it is a security fix to the
3501 * protocol, and should not cause any interoperability issue
3502 * (used only if the peer supports it too).
3503 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003504 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003505 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003506 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003507void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003509
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003510#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003511/**
3512 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003513 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003514 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003515 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00003516 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003517 *
Manuel Pégourié-Gonnarda4522e82020-02-25 12:46:10 +01003518 * \note This function is deprecated and will be removed in
Simon Butcher68c0bd72016-02-13 22:44:49 +00003519 * a future version of the library.
3520 * RC4 is disabled by default at compile time and needs to be
3521 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003522 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003523 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003524 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003525 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003526void mbedtls_ssl_conf_arc4_support(mbedtls_ssl_config *conf, char arc4);
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003527#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003528
Janos Follath088ce432017-04-10 12:42:31 +01003529#if defined(MBEDTLS_SSL_SRV_C)
3530/**
3531 * \brief Whether to send a list of acceptable CAs in
3532 * CertificateRequest messages.
3533 * (Default: do send)
3534 *
3535 * \param conf SSL configuration
3536 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3537 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3538 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003539void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
3540 char cert_req_ca_list);
Janos Follath088ce432017-04-10 12:42:31 +01003541#endif /* MBEDTLS_SSL_SRV_C */
3542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003543#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003544/**
k-stachowiak6d722122019-02-08 17:03:33 +01003545 * \brief Set the maximum fragment length to emit and/or negotiate.
3546 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3547 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003548 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003549 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003550 * (Client: set maximum fragment length to emit *and*
3551 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003552 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003553 *
k-stachowiak6d722122019-02-08 17:03:33 +01003554 * \note On the client side, the maximum fragment length extension
3555 * *will not* be used, unless the maximum fragment length has
3556 * been set via this function to a value different than
3557 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003558 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003559 * \note With TLS, this currently only affects ApplicationData (sent
3560 * with \c mbedtls_ssl_read()), not handshake messages.
3561 * With DTLS, this affects both ApplicationData and handshake.
3562 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003563 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003564 * excluding record overhead that will be added to it, see
3565 * \c mbedtls_ssl_get_record_expansion().
3566 *
3567 * \note For DTLS, it is also possible to set a limit for the total
Tom Cosgrove2b150752022-05-26 11:55:43 +01003568 * size of datagrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003569 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003570 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003571 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003572 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003573 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3574 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003575 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003576 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003577 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003578int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003580
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003581#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003582/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01003583 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01003584 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003585 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003586 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003587 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
3588 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003589 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003590void mbedtls_ssl_conf_truncated_hmac(mbedtls_ssl_config *conf, int truncate);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003591#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003592
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003593#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003594/**
3595 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003597 *
3598 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
3599 * Does not affect non-CBC ciphersuites in any version.
3600 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01003601 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003602 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
3603 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003604 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003605void mbedtls_ssl_conf_cbc_record_splitting(mbedtls_ssl_config *conf, char split);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003607
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003608#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003609/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003610 * \brief Enable / Disable session tickets (client only).
3611 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003612 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003613 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003614 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003615 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003616 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3617 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003618 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003619void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets);
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003620#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003621
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003622#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003623/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003624 * \brief Enable / Disable renegotiation support for connection when
3625 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003626 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003627 *
Shaun Case0e7791f2021-12-20 21:14:10 -08003628 * \warning It is recommended to always disable renegotiation unless you
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003629 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003630 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003631 * renegotiation or a poor understanding of its properties.
3632 *
3633 * \note Server-side, enabling renegotiation also makes the server
3634 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003635 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003636 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003637 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3638 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003639 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003640void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003641#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003642
3643/**
3644 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003645 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003646 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003647 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003648 * be established even if the peer does not support
3649 * secure renegotiation, but does not allow renegotiation
3650 * to take place if not secure.
3651 * (Interoperable and secure option)
3652 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003653 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003654 * with non-upgraded peers. Allowing legacy renegotiation
3655 * makes the connection vulnerable to specific man in the
3656 * middle attacks. (See RFC 5746)
3657 * (Most interoperable and least secure option)
3658 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003660 * if peer does not support secure renegotiation. Results
3661 * in interoperability issues with non-upgraded peers
3662 * that do not support renegotiation altogether.
3663 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003664 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003665 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003666 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3667 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003669 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003670void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy);
Paul Bakker48916f92012-09-16 19:57:18 +00003671
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003672#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003673/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003674 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003675 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003676 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003677 * When we request a renegotiation, the peer can comply or
3678 * ignore the request. This function allows us to decide
3679 * whether to enforce our renegotiation requests by closing
3680 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003681 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003682 * However, records could already be in transit from the peer
3683 * when the request is emitted. In order to increase
3684 * reliability, we can accept a number of records before the
3685 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003686 *
3687 * The optimal value is highly dependent on the specific usage
3688 * scenario.
3689 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003690 * \note With DTLS and server-initiated renegotiation, the
Shaun Case0e7791f2021-12-20 21:14:10 -08003691 * HelloRequest is retransmitted every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003692 * out or receives Application Data, until:
3693 * - max_records records have beens seen, if it is >= 0, or
3694 * - the number of retransmits that would happen during an
3695 * actual handshake has been reached.
3696 * Please remember the request might be lost a few times
3697 * if you consider setting max_records to a really low value.
3698 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003699 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003700 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003701 * which always behave as if max_record was 0. The reason is,
3702 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003703 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003704 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003705 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003706 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003707 * enforce renegotiation, or a non-negative value to enforce
3708 * it but allow for a grace period of max_records records.
3709 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003710void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records);
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003711
3712/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003713 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003714 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003715 *
3716 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003717 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003718 * threshold. The default value is meant to prevent the
3719 * connection from being closed when the counter is about to
3720 * reached its maximal value (it is not allowed to wrap).
3721 *
3722 * Lower values can be used to enforce policies such as "keys
3723 * must be refreshed every N packets with cipher X".
3724 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003725 * The renegotiation period can be disabled by setting
3726 * conf->disable_renegotiation to
3727 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3728 *
3729 * \note When the configured transport is
3730 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3731 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3732 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003733 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003734 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003735 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003736 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003737void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
3738 const unsigned char period[8]);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003739#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003740
Paul Bakker43ca69c2011-01-15 17:35:19 +00003741/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003742 * \brief Check if there is data already read from the
3743 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003744 *
3745 * \param ssl SSL context
3746 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003747 * \return 0 if nothing's pending, 1 otherwise.
3748 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003749 * \note This is different in purpose and behaviour from
3750 * \c mbedtls_ssl_get_bytes_avail in that it considers
3751 * any kind of unprocessed data, not only unread
3752 * application data. If \c mbedtls_ssl_get_bytes
3753 * returns a non-zero value, this function will
3754 * also signal pending data, but the converse does
3755 * not hold. For example, in DTLS there might be
3756 * further records waiting to be processed from
3757 * the current underlying transport's datagram.
3758 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003759 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003760 * does not imply that a subsequent call to
3761 * \c mbedtls_ssl_read will provide any data;
3762 * e.g., the unprocessed data might turn out
3763 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003764 *
3765 * \note This function is useful in the following situation:
3766 * If the SSL/TLS module successfully returns from an
3767 * operation - e.g. a handshake or an application record
3768 * read - and you're awaiting incoming data next, you
3769 * must not immediately idle on the underlying transport
3770 * to have data ready, but you need to check the value
3771 * of this function first. The reason is that the desired
3772 * data might already be read but not yet processed.
3773 * If, in contrast, a previous call to the SSL/TLS module
3774 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3775 * to call this function, as the latter error code entails
3776 * that all internal data has been processed.
3777 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003778 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003779int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl);
Hanno Becker8b170a02017-10-10 11:51:19 +01003780
3781/**
3782 * \brief Return the number of application data bytes
3783 * remaining to be read from the current record.
3784 *
3785 * \param ssl SSL context
3786 *
3787 * \return How many bytes are available in the application
3788 * data record read buffer.
3789 *
3790 * \note When working over a datagram transport, this is
3791 * useful to detect the current datagram's boundary
3792 * in case \c mbedtls_ssl_read has written the maximal
3793 * amount of data fitting into the input buffer.
3794 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003795 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003796size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003797
3798/**
3799 * \brief Return the result of the certificate verification
3800 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003801 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003802 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003803 * \return \c 0 if the certificate verification was successful.
3804 * \return \c -1u if the result is not available. This may happen
3805 * e.g. if the handshake aborts early, or a verification
3806 * callback returned a fatal error.
3807 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3808 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003809 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003810uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00003811
3812/**
3813 * \brief Return the name of the current ciphersuite
3814 *
3815 * \param ssl SSL context
3816 *
3817 * \return a string containing the ciphersuite name
3818 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003819const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003820
3821/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00003822 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
3823 *
3824 * \param ssl SSL context
3825 *
3826 * \return a string containing the SSL version
3827 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003828const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00003829
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003830/**
3831 * \brief Return the (maximum) number of bytes added by the record
3832 * layer: header + encryption/MAC overhead (inc. padding)
3833 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003834 * \note This function is not available (always returns an error)
3835 * when record compression is enabled.
3836 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003837 * \param ssl SSL context
3838 *
3839 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003840 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02003841 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003842 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003843int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003844
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003845#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3846/**
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003847 * \brief Return the maximum fragment length (payload, in bytes) for
3848 * the output buffer. For the client, this is the configured
3849 * value. For the server, it is the minimum of two - the
3850 * configured value and the negotiated one.
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003851 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003852 * \sa mbedtls_ssl_conf_max_frag_len()
3853 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003854 *
3855 * \param ssl SSL context
3856 *
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003857 * \return Current maximum fragment length for the output buffer.
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003858 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003859size_t mbedtls_ssl_get_output_max_frag_len(const mbedtls_ssl_context *ssl);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003860
3861/**
3862 * \brief Return the maximum fragment length (payload, in bytes) for
3863 * the input buffer. This is the negotiated maximum fragment
3864 * length, or, if there is none, MBEDTLS_SSL_MAX_CONTENT_LEN.
3865 * If it is not defined either, the value is 2^14. This function
3866 * works as its predecessor, \c mbedtls_ssl_get_max_frag_len().
3867 *
3868 * \sa mbedtls_ssl_conf_max_frag_len()
3869 * \sa mbedtls_ssl_get_max_record_payload()
3870 *
3871 * \param ssl SSL context
3872 *
3873 * \return Current maximum fragment length for the output buffer.
3874 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003875size_t mbedtls_ssl_get_input_max_frag_len(const mbedtls_ssl_context *ssl);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003876
3877#if !defined(MBEDTLS_DEPRECATED_REMOVED)
3878
3879#if defined(MBEDTLS_DEPRECATED_WARNING)
3880#define MBEDTLS_DEPRECATED __attribute__((deprecated))
3881#else
3882#define MBEDTLS_DEPRECATED
3883#endif
3884
3885/**
3886 * \brief This function is a deprecated approach to getting the max
3887 * fragment length. Its an alias for
3888 * \c mbedtls_ssl_get_output_max_frag_len(), as the behaviour
3889 * is the same. See \c mbedtls_ssl_get_output_max_frag_len() for
3890 * more detail.
3891 *
3892 * \sa mbedtls_ssl_get_input_max_frag_len()
3893 * \sa mbedtls_ssl_get_output_max_frag_len()
3894 *
3895 * \param ssl SSL context
3896 *
3897 * \return Current maximum fragment length for the output buffer.
3898 */
3899MBEDTLS_DEPRECATED size_t mbedtls_ssl_get_max_frag_len(
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003900 const mbedtls_ssl_context *ssl);
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003901#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003902#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3903
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003904/**
3905 * \brief Return the current maximum outgoing record payload in bytes.
3906 * This takes into account the config.h setting \c
3907 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3908 * max fragment length extension if used, and for DTLS the
3909 * path MTU as configured and current record expansion.
3910 *
3911 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3912 * called with a larger length value.
3913 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3914 * necessary and return the number of bytes written; it is up
3915 * to the caller to call \c mbedtls_ssl_write() again in
3916 * order to send the remaining bytes if any.
3917 *
3918 * \note This function is not available (always returns an error)
3919 * when record compression is enabled.
3920 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003921 * \sa mbedtls_ssl_set_mtu()
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003922 * \sa mbedtls_ssl_get_output_max_frag_len()
3923 * \sa mbedtls_ssl_get_input_max_frag_len()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003924 * \sa mbedtls_ssl_get_record_expansion()
3925 *
3926 * \param ssl SSL context
3927 *
3928 * \return Current maximum payload for an outgoing record,
3929 * or a negative error code.
3930 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003931int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003932
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003933#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003934/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003935 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003936 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003937 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003938 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003939 * \return The current peer certificate, if available.
3940 * The returned certificate is owned by the SSL context and
3941 * is valid only until the next call to the SSL API.
3942 * \return \c NULL if no peer certificate is available. This might
3943 * be because the chosen ciphersuite doesn't use CRTs
3944 * (PSK-based ciphersuites, for example), or because
3945 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3946 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003947 *
3948 * \note For one-time inspection of the peer's certificate during
3949 * the handshake, consider registering an X.509 CRT verification
3950 * callback through mbedtls_ssl_conf_verify() instead of calling
3951 * this function. Using mbedtls_ssl_conf_verify() also comes at
3952 * the benefit of allowing you to influence the verification
3953 * process, for example by masking expected and tolerated
3954 * verification failures.
3955 *
3956 * \warning You must not use the pointer returned by this function
3957 * after any further call to the SSL API, including
3958 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3959 * because the pointer might change during renegotiation,
3960 * which happens transparently to the user.
3961 * If you want to use the certificate across API calls,
3962 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003963 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003964const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003965#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003966
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003967#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003968/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003969 * \brief Save session in order to resume it later (client-side only)
3970 * Session data is copied to presented session structure.
3971 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003972 *
3973 * \param ssl SSL context
3974 * \param session session context
3975 *
3976 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003977 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003978 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003979 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003980 *
Ron Eldor00115032018-07-17 11:21:50 +03003981 * \note Only the server certificate is copied, and not the full chain,
3982 * so you should not attempt to validate the certificate again
3983 * by calling \c mbedtls_x509_crt_verify() on it.
3984 * Instead, you should use the results from the verification
3985 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3986 * after loading the session again into a new SSL context
3987 * using \c mbedtls_ssl_set_session().
3988 *
3989 * \note Once the session object is not needed anymore, you should
3990 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003991 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003992 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003993 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01003994int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003995#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003996
3997/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003998 * \brief Perform the SSL handshake
3999 *
4000 * \param ssl SSL context
4001 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004002 * \return \c 0 if successful.
4003 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004004 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004005 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004006 * transport - in this case you must call this function again
4007 * when the underlying transport is ready for the operation.
4008 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4009 * operation is in progress (see
4010 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4011 * must call this function again when the operation is ready.
4012 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4013 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4014 * in this case you must call this function again to complete
4015 * the handshake when you're done attending other tasks.
4016 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
4017 * and the client did not demonstrate reachability yet - in
4018 * this case you must stop using the context (see below).
4019 * \return Another SSL error code - in this case you must stop using
4020 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02004021 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004022 * \warning If this function returns something other than
4023 * \c 0,
4024 * #MBEDTLS_ERR_SSL_WANT_READ,
4025 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4026 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4027 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4028 * you must stop using the SSL context for reading or writing,
4029 * and either free it or call \c mbedtls_ssl_session_reset()
4030 * on it before re-using it for a new connection; the current
4031 * connection must be closed.
4032 *
4033 * \note If DTLS is in use, then you may choose to handle
4034 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
4035 * purposes, as it is an expected return value rather than an
4036 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01004037 *
4038 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004039 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004040 * from the underlying transport layer is currently being processed,
4041 * and it is safe to idle until the timer or the underlying transport
4042 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004043 * in which case the datagram of the underlying transport that is
4044 * currently being processed might or might not contain further
4045 * DTLS records.
Gilles Peskine07ae2082023-03-07 20:22:51 +01004046 *
4047 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
4048 * subsystem must have been initialized by calling
4049 * psa_crypto_init() before calling this function.
Paul Bakker5121ce52009-01-03 21:22:43 +00004050 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004051int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004052
4053/**
Paul Bakker1961b702013-01-25 14:49:24 +01004054 * \brief Perform a single step of the SSL handshake
4055 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02004056 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004057 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00004058 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01004059 *
4060 * \param ssl SSL context
4061 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004062 * \return See mbedtls_ssl_handshake().
4063 *
4064 * \warning If this function returns something other than \c 0,
4065 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4066 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4067 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4068 * the SSL context for reading or writing, and either free it
4069 * or call \c mbedtls_ssl_session_reset() on it before
4070 * re-using it for a new connection; the current connection
4071 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01004072 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004073int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004075#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01004076/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004077 * \brief Initiate an SSL renegotiation on the running connection.
4078 * Client: perform the renegotiation right now.
4079 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00004080 * during the next call to mbedtls_ssl_read() if honored by
4081 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00004082 *
4083 * \param ssl SSL context
4084 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00004085 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004086 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
4087 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004088 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004089 * \warning If this function returns something other than \c 0,
4090 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4091 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4092 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4093 * the SSL context for reading or writing, and either free it
4094 * or call \c mbedtls_ssl_session_reset() on it before
4095 * re-using it for a new connection; the current connection
4096 * must be closed.
4097 *
Paul Bakker48916f92012-09-16 19:57:18 +00004098 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004099int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004100#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004101
4102/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004103 * \brief Read at most 'len' application data bytes
4104 *
4105 * \param ssl SSL context
4106 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02004107 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00004108 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004109 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004110 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04004111 * without sending a CloseNotify beforehand, which might happen
4112 * because of various reasons (internal error of an underlying
4113 * stack, non-conformant peer not sending a CloseNotify and
4114 * such) - in this case you must stop using the context
4115 * (see below).
4116 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
4117 * transport is still functional, but the peer has
4118 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004119 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004120 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004121 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004122 * transport - in this case you must call this function again
4123 * when the underlying transport is ready for the operation.
4124 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4125 * operation is in progress (see
4126 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4127 * must call this function again when the operation is ready.
4128 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4129 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4130 * in this case you must call this function again to complete
4131 * the handshake when you're done attending other tasks.
4132 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
4133 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004134 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004135 * \return Another SSL error code - in this case you must stop using
4136 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004137 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004138 * \warning If this function returns something other than
4139 * a positive value,
4140 * #MBEDTLS_ERR_SSL_WANT_READ,
4141 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4142 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4143 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4144 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
4145 * you must stop using the SSL context for reading or writing,
4146 * and either free it or call \c mbedtls_ssl_session_reset()
4147 * on it before re-using it for a new connection; the current
4148 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004149 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004150 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004151 * (which can only happen server-side), it means that a client
4152 * is initiating a new connection using the same source port.
4153 * You can either treat that as a connection close and wait
4154 * for the client to resend a ClientHello, or directly
4155 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004156 * context (as it has been reset internally). Either way, you
4157 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004158 * connection: application state, if any, should be reset, and
4159 * most importantly the identity of the client must be checked
4160 * again. WARNING: not validating the identity of the client
4161 * again, or not transmitting the new identity to the
4162 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01004163 *
Hanno Becker8ec81022017-10-10 10:35:08 +01004164 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004165 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004166 * from the underlying transport layer is currently being processed,
4167 * and it is safe to idle until the timer or the underlying transport
4168 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004169 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
4170 * initially available on the underlying transport, as this data may have
4171 * been only e.g. duplicated messages or a renegotiation request.
4172 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
4173 * when reacting to an incoming-data event from the underlying transport.
4174 * - On success, the datagram of the underlying transport that is currently
4175 * being processed may contain further DTLS records. You should call
4176 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01004177 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004178 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004179int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004180
4181/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004182 * \brief Try to write exactly 'len' application data bytes
4183 *
4184 * \warning This function will do partial writes in some cases. If the
4185 * return value is non-negative but less than length, the
4186 * function must be called again with updated arguments:
4187 * buf + ret, len - ret (if ret is the return value) until
4188 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00004189 *
4190 * \param ssl SSL context
4191 * \param buf buffer holding the data
4192 * \param len how many bytes must be written
4193 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004194 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004195 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004196 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004197 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004198 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004199 * transport - in this case you must call this function again
4200 * when the underlying transport is ready for the operation.
4201 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4202 * operation is in progress (see
4203 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4204 * must call this function again when the operation is ready.
4205 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4206 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4207 * in this case you must call this function again to complete
4208 * the handshake when you're done attending other tasks.
4209 * \return Another SSL error code - in this case you must stop using
4210 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00004211 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004212 * \warning If this function returns something other than
4213 * a non-negative value,
4214 * #MBEDTLS_ERR_SSL_WANT_READ,
4215 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4216 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4217 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4218 * you must stop using the SSL context for reading or writing,
4219 * and either free it or call \c mbedtls_ssl_session_reset()
4220 * on it before re-using it for a new connection; the current
4221 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004222 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004223 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00004224 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004225 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004226 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004227 * some partial data in the output buffer, however this is not
4228 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02004229 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00004230 * \note If the requested length is greater than the maximum
4231 * fragment length (either the built-in limit or the one set
4232 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004233 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004234 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004235 * \c mbedtls_ssl_get_output_max_frag_len() may be used to
4236 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004237 *
4238 * \note Attempting to write 0 bytes will result in an empty TLS
4239 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004240 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004241int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004242
4243/**
Paul Bakker0a925182012-04-16 06:46:41 +00004244 * \brief Send an alert message
4245 *
4246 * \param ssl SSL context
4247 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004248 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004249 * \param message The alert message (SSL_ALERT_MSG_*)
4250 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004251 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004252 *
4253 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004254 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4255 * the SSL context for reading or writing, and either free it or
4256 * call \c mbedtls_ssl_session_reset() on it before re-using it
4257 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004258 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004259int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4260 unsigned char level,
4261 unsigned char message);
Paul Bakker0a925182012-04-16 06:46:41 +00004262/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004263 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004264 *
4265 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004266 *
4267 * \return 0 if successful, or a specific SSL error code.
4268 *
4269 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004270 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4271 * the SSL context for reading or writing, and either free it or
4272 * call \c mbedtls_ssl_session_reset() on it before re-using it
4273 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004274 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004275int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004276
4277/**
Paul Bakker48916f92012-09-16 19:57:18 +00004278 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004279 *
4280 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00004281 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004282void mbedtls_ssl_free(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004283
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004284#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004285/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004286 * \brief Save an active connection as serialized data in a buffer.
4287 * This allows the freeing or re-using of the SSL context
4288 * while still picking up the connection later in a way that
4289 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004290 *
4291 * \see mbedtls_ssl_context_load()
4292 *
4293 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004294 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004295 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
4296 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004297 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004298 * mbedtls_ssl_session_reset() on \p ssl which as a result is
4299 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004300 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004301 * state. You're then free to either re-use the context
4302 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004303 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004304 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004305 *
4306 * \param ssl The SSL context to save. On success, it is no longer
4307 * associated with the connection that has been serialized.
4308 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03004309 * writeable buffer of at least \p buf_len bytes, or may be \c
4310 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004311 * \param buf_len The number of bytes available for writing in \p buf.
4312 * \param olen The size in bytes of the data that has been or would have
4313 * been written. It must point to a valid \c size_t.
4314 *
4315 * \note \p olen is updated to the correct value regardless of
4316 * whether \p buf_len was large enough. This makes it possible
4317 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004318 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
4319 * the value of \p olen is only guaranteed to be correct when
4320 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
4321 * \c 0. If the return value is different, then the value of
4322 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004323 *
4324 * \return \c 0 if successful.
4325 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004326 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
Shaun Case0e7791f2021-12-20 21:14:10 -08004327 * while resetting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004328 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004329 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004330 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004331 * ciphersuite, or renegotiation is enabled.
4332 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004333int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
4334 unsigned char *buf,
4335 size_t buf_len,
4336 size_t *olen);
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004337
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004338/**
4339 * \brief Load serialized connection data to an SSL context.
4340 *
4341 * \see mbedtls_ssl_context_save()
4342 *
4343 * \warning The same serialized data must never be loaded into more
4344 * that one context. In order to ensure that, after
4345 * successfully loading serialized data to an SSL context, you
4346 * should immediately destroy or invalidate all copies of the
4347 * serialized data that was loaded. Loading the same data in
4348 * more than one context would cause severe security failures
4349 * including but not limited to loss of confidentiality.
4350 *
4351 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004352 * prepared in one of the two following ways. The first way is
4353 * to take a context freshly initialised with
4354 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004355 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004356 * the original connection. The second way is to
4357 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004358 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004359 * Either way, you must not use the context to perform a
4360 * handshake between calling mbedtls_ssl_setup() or
4361 * mbedtls_ssl_session_reset() and calling this function. You
4362 * may however call other setter functions in that time frame
4363 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004364 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004365 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004366 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004367 * and settings before you can use the connection again
4368 * (unless they were already set before calling
4369 * mbedtls_ssl_session_reset() and the values are suitable for
4370 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02004371 * at least mbedtls_ssl_set_bio() and
4372 * mbedtls_ssl_set_timer_cb(). All other SSL setter functions
4373 * are not necessary to call, either because they're only used
4374 * in handshakes, or because the setting is already saved. You
4375 * might choose to call them anyway, for example in order to
4376 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004377 * connection and the case of loading an already-established
4378 * connection.
4379 *
4380 * \note If you have new information about the path MTU, you want to
4381 * call mbedtls_ssl_set_mtu() after calling this function, as
4382 * otherwise this function would overwrite your
4383 * newly-configured value with the value that was active when
4384 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004385 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004386 * \note When this function returns an error code, it calls
4387 * mbedtls_ssl_free() on \p ssl. In this case, you need to
4388 * prepare the context with the usual sequence starting with a
4389 * call to mbedtls_ssl_init() if you want to use it again.
4390 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004391 * \param ssl The SSL context structure to be populated. It must have
4392 * been prepared as described in the note above.
4393 * \param buf The buffer holding the serialized connection data. It must
4394 * be a readable buffer of at least \p len bytes.
4395 * \param len The size of the serialized data in bytes.
4396 *
4397 * \return \c 0 if successful.
4398 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004399 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
4400 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004401 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4402 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004403int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl,
4404 const unsigned char *buf,
4405 size_t len);
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004406#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004407
4408/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004409 * \brief Initialize an SSL configuration context
4410 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004411 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004412 *
4413 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01004414 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004415 *
4416 * \param conf SSL configuration context
4417 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004418void mbedtls_ssl_config_init(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004419
4420/**
Adam Wolfef30d902019-09-10 09:53:08 -05004421 * \brief Load reasonable default SSL configuration values.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004422 * (You need to call mbedtls_ssl_config_init() first.)
4423 *
4424 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004425 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4426 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4427 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004428 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004429 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004430 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004431 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004432 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004433 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004434 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004435int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
4436 int endpoint, int transport, int preset);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004437
4438/**
4439 * \brief Free an SSL configuration context
4440 *
4441 * \param conf SSL configuration context
4442 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004443void mbedtls_ssl_config_free(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004444
4445/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004446 * \brief Initialize SSL session structure
4447 *
4448 * \param session SSL session
4449 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004450void mbedtls_ssl_session_init(mbedtls_ssl_session *session);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004451
4452/**
Paul Bakker0a597072012-09-25 21:55:46 +00004453 * \brief Free referenced items in an SSL session including the
4454 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004455 *
Ron Eldor00115032018-07-17 11:21:50 +03004456 * \note A session object can be freed even if the SSL context
4457 * that was used to retrieve the session is still in use.
4458 *
Paul Bakker48916f92012-09-16 19:57:18 +00004459 * \param session SSL session
4460 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004461void mbedtls_ssl_session_free(mbedtls_ssl_session *session);
Paul Bakker48916f92012-09-16 19:57:18 +00004462
Ron Eldor51d3ab52019-05-12 14:54:30 +03004463/**
4464 * \brief TLS-PRF function for key derivation.
4465 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02004466 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004467 * \param secret Secret for the key derivation function.
4468 * \param slen Length of the secret.
4469 * \param label String label for the key derivation function,
4470 * terminated with null character.
4471 * \param random Random bytes.
4472 * \param rlen Length of the random bytes buffer.
4473 * \param dstbuf The buffer holding the derived key.
4474 * \param dlen Length of the output buffer.
4475 *
Tobias Nießen02b6fba2021-05-10 19:53:15 +02004476 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004477 */
Gilles Peskine1b6c09a2023-01-11 14:52:35 +01004478int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
4479 const unsigned char *secret, size_t slen,
4480 const char *label,
4481 const unsigned char *random, size_t rlen,
4482 unsigned char *dstbuf, size_t dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +03004483
Paul Bakker5121ce52009-01-03 21:22:43 +00004484#ifdef __cplusplus
4485}
4486#endif
4487
4488#endif /* ssl.h */