blob: 02e527cdf5c7fc2a878437bcb9d2d080e35b6a50 [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 Rodgman16799db2023-11-02 19:47:20 +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
Brett Warrene0edc842021-08-17 09:53:13 +010012#include "mbedtls/platform_util.h"
Mateusz Starzyk846f0212021-05-19 19:44:07 +020013#include "mbedtls/private_access.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000014
Bence Szépkútic662b362021-05-27 11:25:03 +020015#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010016
Anton Matkinbc487252025-06-16 13:37:03 +020017#include "mbedtls/private/bignum.h"
18#include "mbedtls/private/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020019
Jaeden Amero6609aef2019-07-04 20:01:14 +010020#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010023#include "mbedtls/x509_crt.h"
24#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020025#endif
Paul Bakkered27a042013-04-18 22:46:23 +020026
Andrzej Kurek1b75e5f2023-04-04 09:55:06 -040027#include "mbedtls/md.h"
28
Valerio Setti7aeec542023-07-05 18:57:21 +020029#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED)
Anton Matkinbc487252025-06-16 13:37:03 +020030#include "mbedtls/private/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010031#endif
32
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010034#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020035#endif
36
Hanno Becker43633132018-10-22 15:31:03 +010037#include "psa/crypto.h"
Hanno Becker43633132018-10-22 15:31:03 +010038
Paul Bakker13e2dfe2009-07-28 07:18:38 +000039/*
40 * SSL Error codes
41 */
Gilles Peskined2971572021-07-26 18:48:10 +020042/** A cryptographic operation is in progress. Try again later. */
43#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
44/** The requested feature is not available. */
45#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
46/** Bad input parameters to function. */
Felix Conway37ede2c2025-08-18 14:46:39 +010047#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA PSA_ERROR_INVALID_ARGUMENT
Gilles Peskined2971572021-07-26 18:48:10 +020048/** Verification of the message MAC failed. */
49#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
50/** An invalid SSL record was received. */
51#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
52/** The connection indicated an EOF. */
53#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
54/** A message could not be parsed due to a syntactic error. */
55#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300
Dave Rodgmanbb05cd02021-06-29 10:37:43 +010056/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020057/** No RNG was provided to the SSL module. */
58#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
59/** No client certification received from the client, but required by the authentication mode. */
60#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
61/** Client received an extended server hello containing an unsupported extension */
62#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500
63/** No ALPN protocols supported that the client advertises */
64#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580
65/** The own private key or pre-shared key is not set, but needed. */
66#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
67/** No CA Chain is set, but required to operate. */
68#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
69/** An unexpected message was received from our peer. */
70#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
71/** A fatal alert message was received from our peer. */
72#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
73/** No server could be identified matching the client's SNI. */
74#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800
75/** The peer notified us that the connection is going to be closed. */
76#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
Hanno Becker90d59dd2021-06-24 11:17:13 +010077/* Error space gap */
Hanno Beckerc3411d42021-06-24 11:09:00 +010078/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020079/** Processing of the Certificate handshake message failed. */
80#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00
Pengyu Lv18946532023-01-12 12:28:09 +080081/* Error space gap */
Ronald Cronda130722022-11-22 09:08:57 +010082/**
83 * Received NewSessionTicket Post Handshake Message.
84 * This error code is experimental and may be changed or removed without notice.
85 */
Jerry Yuf8a49942022-07-07 11:32:32 +000086#define MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET -0x7B00
Ronald Cron4a8c9e22022-10-26 18:49:09 +020087/** Not possible to read early data */
88#define MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA -0x7B80
Jerry Yu032985c2023-12-06 17:59:33 +080089/**
90 * Early data has been received as part of an on-going handshake.
Ronald Cron44d70a52024-01-30 18:16:47 +010091 * This error code can be returned only on server side if and only if early
92 * data has been enabled by means of the mbedtls_ssl_conf_early_data() API.
93 * This error code can then be returned by mbedtls_ssl_handshake(),
94 * mbedtls_ssl_handshake_step(), mbedtls_ssl_read() or mbedtls_ssl_write() if
95 * early data has been received as part of the handshake sequence they
96 * triggered. To read the early data, call mbedtls_ssl_read_early_data().
Jerry Yu032985c2023-12-06 17:59:33 +080097 */
98#define MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA -0x7C00
Ronald Cron4a8c9e22022-10-26 18:49:09 +020099/** Not possible to write early data */
Jerry Yu032985c2023-12-06 17:59:33 +0800100#define MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA -0x7C80
Hanno Beckerb24e74b2021-06-24 09:52:01 +0100101/* Error space gap */
Hanno Beckerd3eec782021-06-24 10:21:46 +0100102/* Error space gap */
Hanno Beckerd934a2a2021-06-24 10:23:45 +0100103/* Error space gap */
Hanno Beckerd2002962021-06-24 10:25:40 +0100104/* Error space gap */
Pengyu Lv5038a382023-03-23 15:49:52 +0800105/** Cache entry not found */
Pengyu Lve3746d72023-04-10 14:40:03 +0800106#define MBEDTLS_ERR_SSL_CACHE_ENTRY_NOT_FOUND -0x7E80
Gilles Peskined2971572021-07-26 18:48:10 +0200107/** Memory allocation failed */
Felix Conway37ede2c2025-08-18 14:46:39 +0100108#define MBEDTLS_ERR_SSL_ALLOC_FAILED PSA_ERROR_INSUFFICIENT_MEMORY
Gilles Peskined2971572021-07-26 18:48:10 +0200109/** Hardware acceleration function returned with error */
110#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
111/** Hardware acceleration function skipped / left alone data */
112#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
113/** Handshake protocol not within min/max boundaries */
114#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80
115/** The handshake negotiation failed. */
116#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00
117/** Session ticket has expired. */
118#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
119/** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
120#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
121/** Unknown identity received (eg, PSK identity) */
122#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
123/** Internal error (eg, unexpected failure in lower-level module) */
124#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
125/** A counter would wrap (eg, too many messages exchanged). */
126#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
127/** Unexpected message at ServerHello in renegotiation. */
128#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
129/** DTLS client must retry for hello verification */
130#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
131/** A buffer is too small to receive or write a message */
Felix Conway37ede2c2025-08-18 14:46:39 +0100132#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL PSA_ERROR_BUFFER_TOO_SMALL
Dave Rodgman096c4112021-06-29 09:52:06 +0100133/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200134/** No data of requested type currently available on underlying transport. */
135#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
136/** Connection requires a write call. */
137#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
138/** The operation timed out. */
139#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
140/** The client initiated a reconnect from the same port. */
141#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
142/** Record header looks valid but is not expected. */
143#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
144/** The alert message received indicates a non-fatal error. */
145#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
146/** A field in a message was incorrect or inconsistent with other fields. */
147#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600
148/** Internal-only message signaling that further message-processing should be done */
149#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
150/** The asynchronous operation is not completed yet. */
151#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
152/** Internal-only message signaling that a message arrived early. */
153#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
Dave Rodgmanc628fc92021-06-29 14:32:46 +0100154/* Error space gap */
155/* Error space gap */
156/* Error space gap */
157/* Error space gap */
158/* Error space gap */
159/* Error space gap */
160/* Error space gap */
161/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200162/** An encrypted DTLS-frame with an unexpected CID was received. */
163#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
164/** An operation failed due to an unexpected version or configuration. */
165#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
166/** Invalid value in SSL config */
167#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
Gilles Peskine59a51172025-02-13 13:46:03 +0100168/* Error space gap */
169/** Attempt to verify a certificate without an expected hostname.
170 * This is usually insecure.
171 *
172 * In TLS clients, when a client authenticates a server through its
173 * certificate, the client normally checks three things:
174 * - the certificate chain must be valid;
175 * - the chain must start from a trusted CA;
176 * - the certificate must cover the server name that is expected by the client.
177 *
178 * Omitting any of these checks is generally insecure, and can allow a
179 * malicious server to impersonate a legitimate server.
180 *
181 * The third check may be safely skipped in some unusual scenarios,
182 * such as networks where eavesdropping is a risk but not active attacks,
183 * or a private PKI where the client equally trusts all servers that are
184 * accredited by the root CA.
185 *
186 * You should call mbedtls_ssl_set_hostname() with the expected server name
187 * before starting a TLS handshake on a client (unless the client is
188 * set up to only use PSK-based authentication, which does not rely on the
189 * host name). If you have determined that server name verification is not
190 * required for security in your scenario, call mbedtls_ssl_set_hostname()
191 * with \p NULL as the server name.
192 *
193 * This error is raised if all of the following conditions are met:
194 *
195 * - A TLS client is configured with the authentication mode
196 * #MBEDTLS_SSL_VERIFY_REQUIRED (default).
197 * - Certificate authentication is enabled.
198 * - The client does not call mbedtls_ssl_set_hostname().
199 */
200#define MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME -0x5D80
Paul Bakker5121ce52009-01-03 21:22:43 +0000201
202/*
Jerry Yue19e3b92022-07-08 12:04:51 +0000203 * Constants from RFC 8446 for TLS 1.3 PSK modes
204 *
205 * Those are used in the Pre-Shared Key Exchange Modes extension.
206 * See Section 4.2.9 in RFC 8446.
207 */
208#define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */
209#define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */
210
211/*
Jerry Yue226cef2021-08-27 22:06:20 +0800212 * TLS 1.3 NamedGroup values
213 *
214 * From RF 8446
215 * enum {
216 * // Elliptic Curve Groups (ECDHE)
217 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
218 * x25519(0x001D), x448(0x001E),
219 * // Finite Field Groups (DHE)
220 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
221 * ffdhe6144(0x0103), ffdhe8192(0x0104),
222 * // Reserved Code Points
223 * ffdhe_private_use(0x01FC..0x01FF),
224 * ecdhe_private_use(0xFE00..0xFEFF),
225 * (0xFFFF)
226 * } NamedGroup;
227 *
228 */
Brett Warrene0edc842021-08-17 09:53:13 +0100229
Jerry Yue226cef2021-08-27 22:06:20 +0800230/* Elliptic Curve Groups (ECDHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100231#define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0
Brett Warrene0edc842021-08-17 09:53:13 +0100232#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016
233#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017
234#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018
235#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019
236#define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A
237#define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B
238#define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C
239#define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D
240#define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E
Jerry Yue226cef2021-08-27 22:06:20 +0800241/* Finite Field Groups (DHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100242#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100
243#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101
244#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102
245#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103
246#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104
Jerry Yue226cef2021-08-27 22:06:20 +0800247
248/*
Hanno Becker71f1ed62021-07-24 06:01:47 +0100249 * TLS 1.3 Key Exchange Modes
250 *
251 * Mbed TLS internal identifiers for use with the SSL configuration API
252 * mbedtls_ssl_conf_tls13_key_exchange_modes().
253 */
254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK (1u << 0) /*!< Pure-PSK TLS 1.3 key exchange,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000256 * encompassing both externally agreed PSKs
257 * as well as resumption PSKs. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100258#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL (1u << 1) /*!< Pure-Ephemeral TLS 1.3 key exchanges,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000259 * including for example ECDHE and DHE
260 * key exchanges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100261#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL (1u << 2) /*!< PSK-Ephemeral TLS 1.3 key exchanges,
Xiaofei Bai746f9482021-11-12 08:53:56 +0000262 * using both a PSK and an ephemeral
263 * key exchange. */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100264
265/* Convenience macros for sets of key exchanges. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000266#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100267 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
268 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
269 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL) /*!< All TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000270#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
272 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All PSK-based TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000273#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \
275 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All ephemeral TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100276
Gilles Peskine449bd832023-01-11 14:50:10 +0100277#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE (0)
Jerry Yu77f01482022-07-11 07:03:24 +0000278
Hanno Becker71f1ed62021-07-24 06:01:47 +0100279/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000280 * Various constants
281 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100282
Paul Bakker5121ce52009-01-03 21:22:43 +0000283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
285#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100286
Simon Butcher9f812312015-09-28 19:22:33 +0100287#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200288#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
289
290#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 +0100291
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200292/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200293 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
295#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
296#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
297#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
298#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
299#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200300
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200301#define MBEDTLS_SSL_IS_CLIENT 0
302#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200303
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200304#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
305#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200306
Hanno Becker019f4b52019-04-09 15:12:56 +0100307#define MBEDTLS_SSL_CID_DISABLED 0
308#define MBEDTLS_SSL_CID_ENABLED 1
309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310#define MBEDTLS_SSL_ETM_DISABLED 0
311#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100312
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315#define MBEDTLS_SSL_VERIFY_NONE 0
316#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
317#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200318#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
321#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000322
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200323#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
324#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
327#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
330#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
333#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
334#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200336#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
337#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
338#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
341#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200342
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200343#define MBEDTLS_SSL_PRESET_DEFAULT 0
344#define MBEDTLS_SSL_PRESET_SUITEB 2
345
Janos Follath088ce432017-04-10 12:42:31 +0100346#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
347#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
348
Xiaokang Qian54413b12022-10-20 05:57:03 +0000349#define MBEDTLS_SSL_EARLY_DATA_DISABLED 0
350#define MBEDTLS_SSL_EARLY_DATA_ENABLED 1
351
Ron Eldor591f1622018-01-22 12:30:04 +0200352#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
353#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
354
TRodziewicz3946f792021-06-14 12:11:18 +0200355#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
356#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200357
Jerry Yu0a430c82022-07-20 11:02:48 +0800358#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200359#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu0a430c82022-07-20 11:02:48 +0800360#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200361#elif defined(PSA_WANT_ALG_SHA_256)
Jerry Yu0a430c82022-07-20 11:02:48 +0800362#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32
Przemek Stekiela9a88162022-09-02 13:18:55 +0200363#endif
Jerry Yu0a430c82022-07-20 11:02:48 +0800364#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200365/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200366 * Default range for DTLS retransmission timer value, in milliseconds.
367 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
368 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200369#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
370#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200371
Jerry Yu4caf3ca2023-11-15 16:13:47 +0800372/*
373 * Whether early data record should be discarded or not and how.
374 *
375 * The client has indicated early data and the server has rejected them.
376 * The server has then to skip past early data by either:
377 * - attempting to deprotect received records using the handshake traffic
378 * key, discarding records which fail deprotection (up to the configured
379 * max_early_data_size). Once a record is deprotected successfully,
380 * it is treated as the start of the client's second flight and the
381 * server proceeds as with an ordinary 1-RTT handshake.
382 * - skipping all records with an external content type of
383 * "application_data" (indicating that they are encrypted), up to the
384 * configured max_early_data_size. This is the expected behavior if the
385 * server has sent an HelloRetryRequest message. The server ignores
386 * application data message before 2nd ClientHello.
387 */
388#define MBEDTLS_SSL_EARLY_DATA_NO_DISCARD 0
389#define MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD 1
390#define MBEDTLS_SSL_EARLY_DATA_DISCARD 2
391
Paul Bakker088c5c52014-04-25 11:11:10 +0200392/**
393 * \name SECTION: Module settings
394 *
395 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200396 * Either change them in mbedtls_config.h or define them on the compiler command line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200397 * \{
398 */
399
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200400/*
Angus Grattond8213d02016-05-25 20:56:48 +1000401 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200402 * determines the size of each of the two internal I/O buffers.
403 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200404 * Note: the RFC defines the default size of SSL / TLS messages. If you
405 * change the value here, other clients / servers may not be able to
406 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200407 * both sides of the connection and have it reduced at both sides, or
408 * if you're using the Max Fragment Length extension and you know all your
409 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200410 */
Angus Grattond8213d02016-05-25 20:56:48 +1000411#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100412#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000413#endif
414
415#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100416#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000417#endif
418
Hanno Becker28007512018-08-28 09:46:44 +0100419/*
420 * Maximum number of heap-allocated bytes for the purpose of
421 * DTLS handshake message reassembly and future message buffering.
422 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100423#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100424#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100425#endif
426
Hanno Becker019f4b52019-04-09 15:12:56 +0100427/*
428 * Maximum length of CIDs for incoming and outgoing messages.
429 */
430#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100431#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100432#endif
433
434#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
435#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
436#endif
437
TRodziewicze8dd7092021-05-12 14:19:11 +0200438#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
439#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100440#endif
441
Tom Cosgrove3b4471e2023-09-14 12:59:50 +0100442#if !defined(MBEDTLS_SSL_MAX_EARLY_DATA_SIZE)
443#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
444#endif
445
Gilles Peskined65ea422023-09-05 21:07:32 +0200446#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE)
447#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
448#endif
449
450#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH)
451#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
452#endif
453
454#if !defined(MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS)
455#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
456#endif
457
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100458/** \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000459
460/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100461 * Length of the verify data for secure renegotiation
462 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200463#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100464
465/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200466 * Signaling ciphersuite values (SCSV)
467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200468#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000469
Paul Bakker5121ce52009-01-03 21:22:43 +0000470/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000471 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200472 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000473 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200474#define MBEDTLS_SSL_HASH_NONE 0
475#define MBEDTLS_SSL_HASH_MD5 1
476#define MBEDTLS_SSL_HASH_SHA1 2
477#define MBEDTLS_SSL_HASH_SHA224 3
478#define MBEDTLS_SSL_HASH_SHA256 4
479#define MBEDTLS_SSL_HASH_SHA384 5
480#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000481
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_SSL_SIG_ANON 0
483#define MBEDTLS_SSL_SIG_RSA 1
484#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000485
486/*
Hanno Becker551265f2021-08-10 13:03:48 +0100487 * TLS 1.3 signature algorithms
Yanray Wang55933a32023-11-22 16:34:15 +0800488 * RFC 8446, Section 4.2.3
Hanno Becker551265f2021-08-10 13:03:48 +0100489 */
490
491/* RSASSA-PKCS1-v1_5 algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000492#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401
493#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501
494#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601
Hanno Becker551265f2021-08-10 13:03:48 +0100495
496/* ECDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000497#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403
498#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503
499#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603
Hanno Becker551265f2021-08-10 13:03:48 +0100500
501/* RSASSA-PSS algorithms with public key OID rsaEncryption */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000502#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804
503#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805
504#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806
Hanno Becker551265f2021-08-10 13:03:48 +0100505
506/* EdDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000507#define MBEDTLS_TLS1_3_SIG_ED25519 0x0807
508#define MBEDTLS_TLS1_3_SIG_ED448 0x0808
Hanno Becker551265f2021-08-10 13:03:48 +0100509
510/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000511#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809
512#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A
513#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B
Hanno Becker551265f2021-08-10 13:03:48 +0100514
515/* LEGACY ALGORITHMS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000516#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201
517#define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203
Hanno Becker551265f2021-08-10 13:03:48 +0100518
Xiaofei Bai746f9482021-11-12 08:53:56 +0000519#define MBEDTLS_TLS1_3_SIG_NONE 0x0
Hanno Becker551265f2021-08-10 13:03:48 +0100520
521/*
Paul Bakker926af752012-11-23 13:38:07 +0100522 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200523 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100524 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
526#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100527
528/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000529 * Message, alert and handshake types
530 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200531#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
532#define MBEDTLS_SSL_MSG_ALERT 21
533#define MBEDTLS_SSL_MSG_HANDSHAKE 22
534#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100535#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000536
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
538#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
541#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
542#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
543#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
544#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
545#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
546#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
547#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
548#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
549#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
550#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
551#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
552#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
553#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
554#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
555#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
556#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
557#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
558#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
559#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
560#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
561#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
562#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
563#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
564#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000565#define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
567#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
568#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
XiaokangQian6b916b12022-04-25 07:29:34 +0000569#define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200570#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
573#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
574#define MBEDTLS_SSL_HS_SERVER_HELLO 2
575#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
576#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
Xiaokang Qian5b410072023-01-03 10:31:15 +0000577#define MBEDTLS_SSL_HS_END_OF_EARLY_DATA 5
578#define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579#define MBEDTLS_SSL_HS_CERTIFICATE 11
580#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
581#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
582#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
583#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
584#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
585#define MBEDTLS_SSL_HS_FINISHED 20
XiaokangQian647719a2021-12-07 09:16:29 +0000586#define MBEDTLS_SSL_HS_MESSAGE_HASH 254
Paul Bakker5121ce52009-01-03 21:22:43 +0000587
588/*
589 * TLS extensions
590 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591#define MBEDTLS_TLS_EXT_SERVERNAME 0
592#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000593
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800597#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800600#define MBEDTLS_TLS_EXT_SUPPORTED_GROUPS 10 /* RFC 8422,7919 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000602
Jerry Yub3317e12021-08-26 14:30:22 +0800603#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
Johan Pascalb62bb512015-12-03 21:56:45 +0100604#define MBEDTLS_TLS_EXT_USE_SRTP 14
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800605#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200607
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800608#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
Jerry Yu1bc2c1f2021-09-01 12:57:29 +0800609#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
610#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
611#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200612#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
613#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200614
Jan Bruckner151f6422023-02-10 12:45:19 +0100615#define MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT 28 /* RFC 8449 (implemented for TLS 1.3 only) */
616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200617#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200618
Jerry Yub3317e12021-08-26 14:30:22 +0800619#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
620#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
621#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
622#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
623#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800624
Jerry Yub3317e12021-08-26 14:30:22 +0800625#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
626#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
627#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
628#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
629#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800630
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200631#define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */
Hanno Becker0652bc52019-04-25 16:24:57 +0100632
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200633#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200635#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000636
Johan Pascalb62bb512015-12-03 21:56:45 +0100637/*
Paul Bakkered27a042013-04-18 22:46:23 +0200638 * Size defines
639 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200640#if !defined(MBEDTLS_PSK_MAX_LEN)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100641/*
642 * If the library supports TLS 1.3 tickets and the cipher suite
643 * TLS1-3-AES-256-GCM-SHA384, set the PSK maximum length to 48 instead of 32.
644 * That way, the TLS 1.3 client and server are able to resume sessions where
Ronald Cronee54de02023-02-24 12:06:30 +0100645 * the cipher suite is TLS1-3-AES-256-GCM-SHA384 (pre-shared keys are 48
646 * bytes long in that case).
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100647 */
648#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
649 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +0100650 defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM) && \
Elena Uziunaitecf5e3dd2024-06-26 10:49:49 +0100651 defined(PSA_WANT_ALG_SHA_384)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100652#define MBEDTLS_PSK_MAX_LEN 48 /* 384 bits */
653#else
654#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200655#endif
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100656#endif /* !MBEDTLS_PSK_MAX_LEN */
Paul Bakkered27a042013-04-18 22:46:23 +0200657
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200658/* Dummy type used only for its size */
Gilles Peskine449bd832023-01-11 14:50:10 +0100659union mbedtls_ssl_premaster_secret {
Gilles Peskinee8e1e152023-06-25 21:41:58 +0200660 unsigned char dummy; /* Make the union non-empty even with SSL disabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200661#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
Ben Taylor15f1d7f2025-07-10 09:41:09 +0100662 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200663 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200664#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
666 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200667#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
669 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200671#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200672#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
673 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
674#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200675};
676
Gilles Peskine449bd832023-01-11 14:50:10 +0100677#define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200678
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200679#define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200680
XiaokangQianc5c39d52021-11-09 11:55:10 +0000681
Jerry Yud96a5c22021-09-29 17:46:51 +0800682/* Length in number of bytes of the TLS sequence number */
Jerry Yuae0b2e22021-10-08 15:21:19 +0800683#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8
Jerry Yu957f0fa2021-09-24 10:27:07 +0800684
Max Fillinger2fe35f62024-10-25 00:52:24 +0200685/* Helper to state that client_random and server_random need to be stored
686 * after the handshake is complete. This is required for context serialization
687 * and for the keying material exporter in TLS 1.2. */
688#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION) || \
689 (defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT) && defined(MBEDTLS_SSL_PROTO_TLS1_2))
690#define MBEDTLS_SSL_KEEP_RANDBYTES
691#endif
692
Paul Bakker407a0da2013-06-27 14:29:21 +0200693#ifdef __cplusplus
694extern "C" {
695#endif
696
Paul Bakkered27a042013-04-18 22:46:23 +0200697/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000698 * SSL state machine
699 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100700typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200701 MBEDTLS_SSL_HELLO_REQUEST,
702 MBEDTLS_SSL_CLIENT_HELLO,
703 MBEDTLS_SSL_SERVER_HELLO,
704 MBEDTLS_SSL_SERVER_CERTIFICATE,
705 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
706 MBEDTLS_SSL_CERTIFICATE_REQUEST,
707 MBEDTLS_SSL_SERVER_HELLO_DONE,
708 MBEDTLS_SSL_CLIENT_CERTIFICATE,
709 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
710 MBEDTLS_SSL_CERTIFICATE_VERIFY,
711 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
712 MBEDTLS_SSL_CLIENT_FINISHED,
713 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
714 MBEDTLS_SSL_SERVER_FINISHED,
715 MBEDTLS_SSL_FLUSH_BUFFERS,
716 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
Jerry Yua357cf42022-07-12 05:36:45 +0000717 MBEDTLS_SSL_NEW_SESSION_TICKET,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000719 MBEDTLS_SSL_HELLO_RETRY_REQUEST,
Jerry Yua13c7e72021-08-17 10:44:40 +0800720 MBEDTLS_SSL_ENCRYPTED_EXTENSIONS,
Xiaokang Qian125afcb2022-10-28 06:04:06 +0000721 MBEDTLS_SSL_END_OF_EARLY_DATA,
Jerry Yu687101b2021-09-14 16:03:56 +0800722 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY,
Ronald Cron49ad6192021-11-24 16:25:31 +0100723 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED,
XiaokangQian647719a2021-12-07 09:16:29 +0000724 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO,
Gabor Mezei7b39bf12022-05-24 16:04:14 +0200725 MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO,
Xiaokang Qian592021a2023-01-04 10:47:05 +0000726 MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO,
Gabor Mezeif7044ea2022-06-28 16:01:49 +0200727 MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST,
Jerry Yu5ed73ff2022-10-27 13:08:42 +0800728 MBEDTLS_SSL_HANDSHAKE_OVER,
Jerry Yua8d3c502022-10-30 14:51:23 +0800729 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET,
730 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH,
Paul Bakker5121ce52009-01-03 21:22:43 +0000731}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200732mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000733
Ronald Crond6d32b92024-02-14 12:01:50 +0100734/*
735 * Early data status, client side only.
736 */
737
738#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
739typedef enum {
740/*
Ronald Crond6d32b92024-02-14 12:01:50 +0100741 * See documentation of mbedtls_ssl_get_early_data_status().
742 */
Ronald Cron840de7f2024-03-11 17:49:35 +0100743 MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_INDICATED,
Ronald Crond6d32b92024-02-14 12:01:50 +0100744 MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED,
745 MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED,
Ronald Crond6d32b92024-02-14 12:01:50 +0100746} mbedtls_ssl_early_data_status;
Ronald Crond6d32b92024-02-14 12:01:50 +0100747#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
748
Simon Butchere846b512016-03-01 17:31:49 +0000749/**
750 * \brief Callback type: send data on the network.
751 *
752 * \note That callback may be either blocking or non-blocking.
753 *
754 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000755 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000756 * \param len Length of the data to send
757 *
758 * \return The callback must return the number of bytes sent if any,
759 * or a non-zero error code.
760 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
761 * must be returned when the operation would block.
762 *
Simon Butcherd567a232016-03-09 20:19:21 +0000763 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000764 * It must always return the number of bytes actually sent.
765 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100766typedef int mbedtls_ssl_send_t(void *ctx,
767 const unsigned char *buf,
768 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000769
770/**
771 * \brief Callback type: receive data from the network.
772 *
773 * \note That callback may be either blocking or non-blocking.
774 *
775 * \param ctx Context for the receive callback (typically a file
776 * descriptor)
777 * \param buf Buffer to write the received data to
778 * \param len Length of the receive buffer
779 *
Hanno Becker218dec82021-07-23 07:23:47 +0100780 * \returns If data has been received, the positive number of bytes received.
781 * \returns \c 0 if the connection has been closed.
782 * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
Simon Butchere846b512016-03-01 17:31:49 +0000783 * must be returned when the operation would block.
Hanno Becker218dec82021-07-23 07:23:47 +0100784 * \returns Another negative error code on other kinds of failures.
Simon Butchere846b512016-03-01 17:31:49 +0000785 *
Simon Butcherd567a232016-03-09 20:19:21 +0000786 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000787 * buffer. It must always return the number of bytes actually
788 * received and written to the buffer.
789 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100790typedef int mbedtls_ssl_recv_t(void *ctx,
791 unsigned char *buf,
792 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000793
794/**
795 * \brief Callback type: receive data from the network, with timeout
796 *
797 * \note That callback must block until data is received, or the
798 * timeout delay expires, or the operation is interrupted by a
799 * signal.
800 *
801 * \param ctx Context for the receive callback (typically a file descriptor)
802 * \param buf Buffer to write the received data to
803 * \param len Length of the receive buffer
Andrey Starodubtsev90cc33a2021-08-23 12:14:56 +0300804 * \param timeout Maximum number of milliseconds to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000805 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000806 *
807 * \return The callback must return the number of bytes received,
808 * or a non-zero error code:
809 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
810 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
811 *
Simon Butcherd567a232016-03-09 20:19:21 +0000812 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000813 * buffer. It must always return the number of bytes actually
814 * received and written to the buffer.
815 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100816typedef int mbedtls_ssl_recv_timeout_t(void *ctx,
817 unsigned char *buf,
818 size_t len,
819 uint32_t timeout);
Simon Butchere846b512016-03-01 17:31:49 +0000820/**
821 * \brief Callback type: set a pair of timers/delays to watch
822 *
823 * \param ctx Context pointer
824 * \param int_ms Intermediate delay in milliseconds
825 * \param fin_ms Final delay in milliseconds
826 * 0 cancels the current timer.
827 *
828 * \note This callback must at least store the necessary information
829 * for the associated \c mbedtls_ssl_get_timer_t callback to
830 * return correct information.
831 *
Tom Cosgrovece7f18c2022-07-28 05:50:56 +0100832 * \note If using an event-driven style of programming, an event must
Simon Butchere846b512016-03-01 17:31:49 +0000833 * be generated when the final delay is passed. The event must
834 * cause a call to \c mbedtls_ssl_handshake() with the proper
835 * SSL context to be scheduled. Care must be taken to ensure
836 * that at most one such call happens at a time.
837 *
838 * \note Only one timer at a time must be running. Calling this
839 * function while a timer is running must cancel it. Cancelled
840 * timers must not generate any event.
841 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100842typedef void mbedtls_ssl_set_timer_t(void *ctx,
843 uint32_t int_ms,
844 uint32_t fin_ms);
Simon Butchere846b512016-03-01 17:31:49 +0000845
846/**
847 * \brief Callback type: get status of timers/delays
848 *
849 * \param ctx Context pointer
850 *
851 * \return This callback must return:
852 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000853 * 0 if none of the delays have passed,
854 * 1 if only the intermediate delay has passed,
855 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000856 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100857typedef int mbedtls_ssl_get_timer_t(void *ctx);
Simon Butchere846b512016-03-01 17:31:49 +0000858
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200859/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200860typedef struct mbedtls_ssl_session mbedtls_ssl_session;
861typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200862typedef struct mbedtls_ssl_config mbedtls_ssl_config;
863
Chris Jones3848e312021-03-11 16:17:59 +0000864/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200865typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
866typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200867#if defined(MBEDTLS_X509_CRT_PARSE_C)
868typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200869#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870#if defined(MBEDTLS_SSL_PROTO_DTLS)
871typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200872#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000873
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000874#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000875#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100876 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000877#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100878 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */
879#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA (1U << 3)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000880
881#define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 (MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \
883 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \
884 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000885#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000886
Hanno Becker02487852021-05-13 06:26:57 +0100887/**
888 * \brief Callback type: server-side session cache getter
889 *
890 * The session cache is logically a key value store, with
891 * keys being session IDs and values being instances of
892 * mbedtls_ssl_session.
893 *
894 * This callback retrieves an entry in this key-value store.
895 *
896 * \param data The address of the session cache structure to query.
897 * \param session_id The buffer holding the session ID to query.
898 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100899 * \param session The address of the session structure to populate.
900 * It is initialized with mbdtls_ssl_session_init(),
901 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100902 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100903 * mbedtls_ssl_session_free() independent of the
904 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100905 *
906 * \return \c 0 on success
907 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100908 *
Hanno Becker02487852021-05-13 06:26:57 +0100909 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100910typedef int mbedtls_ssl_cache_get_t(void *data,
911 unsigned char const *session_id,
912 size_t session_id_len,
913 mbedtls_ssl_session *session);
Hanno Becker02487852021-05-13 06:26:57 +0100914/**
915 * \brief Callback type: server-side session cache setter
916 *
917 * The session cache is logically a key value store, with
918 * keys being session IDs and values being instances of
919 * mbedtls_ssl_session.
920 *
921 * This callback sets an entry in this key-value store.
922 *
923 * \param data The address of the session cache structure to modify.
924 * \param session_id The buffer holding the session ID to query.
925 * \param session_id_len The length of \p session_id in Bytes.
926 * \param session The address of the session to be stored in the
927 * session cache.
928 *
929 * \return \c 0 on success
930 * \return A non-zero return value on failure.
931 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100932typedef int mbedtls_ssl_cache_set_t(void *data,
933 unsigned char const *session_id,
934 size_t session_id_len,
935 const mbedtls_ssl_session *session);
Hanno Beckera637ff62021-04-15 08:42:48 +0100936
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200937#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100938#if defined(MBEDTLS_X509_CRT_PARSE_C)
939/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200940 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100941 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200942 * This callback is called during an SSL handshake to start
943 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200944 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100945 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200946 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100947 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200948 * This function typically sends or enqueues a request, and
949 * does not wait for the operation to complete. This allows
950 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100951 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200952 * The parameters \p ssl and \p cert are guaranteed to remain
953 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200954 * function must save the contents of \p hash if the value
955 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200956 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100957 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200958 * This function may call mbedtls_ssl_set_async_operation_data()
959 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200960 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200961 *
Gilles Peskine86b9d3f2025-04-10 14:00:40 +0200962 * \note For an RSA key, this function must produce a PKCS#1v1.5
963 * signature in the standard format (like
964 * #PSA_ALG_RSA_PKCS1V15_SIGN). \c md_alg is guaranteed to be
965 * a hash that is supported by the library.
Gilles Peskined3268832018-04-26 06:23:59 +0200966 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200967 * \note For ECDSA signatures, the output format is the DER encoding
968 * `Ecdsa-Sig-Value` defined in
969 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
970 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200971 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200972 * modified other than via
973 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200974 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200975 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200976 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200977 * connection. However, if other callbacks are used, this
978 * property may not hold. For example, if an SNI callback
979 * is registered with mbedtls_ssl_conf_sni(), then
980 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200981 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100982 * \param hash Buffer containing the hash. This buffer is
983 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200984 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100985 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200986 * \return 0 if the operation was started successfully and the SSL
987 * stack should call the resume callback immediately.
988 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
989 * was started successfully and the SSL stack should return
990 * immediately without calling the resume callback yet.
991 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
992 * processor does not support this key. The SSL stack will
993 * use the private key object instead.
994 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200995 * propagated up the call chain. The callback should
996 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
997 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200998 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100999 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001000typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl,
1001 mbedtls_x509_crt *cert,
1002 mbedtls_md_type_t md_alg,
1003 const unsigned char *hash,
1004 size_t hash_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001005#endif /* MBEDTLS_X509_CRT_PARSE_C */
1006
1007/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001008 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001009 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001010 * This callback is called during an SSL handshake to resume
1011 * an external operation started by the
Gabor Mezeie99e5912025-02-27 13:41:24 +01001012 * ::mbedtls_ssl_async_sign_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +02001013 *
1014 * This function typically checks the status of a pending
1015 * request or causes the request queue to make progress, and
1016 * does not wait for the operation to complete. This allows
1017 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001018 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001019 * This function may call mbedtls_ssl_get_async_operation_data()
1020 * to retrieve an operation context set by the start callback.
1021 * It may call mbedtls_ssl_set_async_operation_data() to modify
1022 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001023 *
Gilles Peskineea5fab82018-04-30 13:57:45 +02001024 * Note that when this function returns a status other than
1025 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
1026 * resources associated with the operation.
1027 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001028 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +02001029 * modified other than via
1030 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +02001031 * \param output Buffer containing the output (signature or decrypted
1032 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +02001033 * \param output_len On success, number of bytes written to \p output.
1034 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001035 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001036 * \return 0 if output of the operation is available in the
1037 * \p output buffer.
1038 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1039 * is still in progress. Subsequent requests for progress
1040 * on the SSL connection will call the resume callback
1041 * again.
1042 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001043 * The SSL handshake is aborted. The callback should
1044 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1045 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001046 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001047 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001048typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl,
1049 unsigned char *output,
1050 size_t *output_len,
1051 size_t output_size);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001052
1053/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001054 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001055 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001056 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +02001057 * while an asynchronous operation is in progress. Note that
1058 * this callback is not called if the
1059 * ::mbedtls_ssl_async_resume_t callback has run and has
1060 * returned a value other than
1061 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
1062 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001063 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001064 * This function may call mbedtls_ssl_get_async_operation_data()
1065 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001066 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001067 * \param ssl The SSL connection instance. It should not be
1068 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001070typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001071#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +00001072
Gilles Peskineeccd8882020-03-10 12:19:08 +01001073#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001074 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +00001075#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
Elena Uziunaite4e6a3682024-06-26 13:28:50 +01001076#if defined(PSA_WANT_ALG_SHA_256)
Hanno Becker9198ad12019-02-05 17:00:50 +00001077#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1078#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Elena Uziunaitecf5e3dd2024-06-26 10:49:49 +01001079#elif defined(PSA_WANT_ALG_SHA_384)
Hanno Becker9198ad12019-02-05 17:00:50 +00001080#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1081#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01001082#elif defined(PSA_WANT_ALG_SHA_1)
Hanno Becker9198ad12019-02-05 17:00:50 +00001083#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1084#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1085#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001086/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +00001087#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1088#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +01001089#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001090 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001091
Gilles Peskine449bd832023-01-11 14:50:10 +01001092typedef struct {
1093 unsigned char client_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1094 unsigned char server_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1095 unsigned char exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1096 unsigned char resumption_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Bai746f9482021-11-12 08:53:56 +00001097} mbedtls_ssl_tls13_application_secrets;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001098
Johan Pascalb62bb512015-12-03 21:56:45 +01001099#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001100
Johan Pascal85269572020-08-25 10:01:54 +02001101#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +02001102#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +01001103/*
Johan Pascal43f94902020-09-22 12:25:52 +02001104 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001105 *
1106 * Use_srtp extension protection profiles values as defined in
1107 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1108 *
1109 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1110 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +01001111 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001112#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001)
1113#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002)
1114#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005)
1115#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001116/* This one is not iana defined, but for code readability. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001117#define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001118
Johan Pascal43f94902020-09-22 12:25:52 +02001119typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +03001120
Gilles Peskine449bd832023-01-11 14:50:10 +01001121typedef struct mbedtls_dtls_srtp_info_t {
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001122 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001123 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +02001124 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001125 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001126 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001127 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +03001128}
1129mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +02001130
Johan Pascalb62bb512015-12-03 21:56:45 +01001131#endif /* MBEDTLS_SSL_DTLS_SRTP */
1132
Glenn Straussdff84622022-03-14 11:12:57 -04001133/** Human-friendly representation of the (D)TLS protocol version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001134typedef enum {
Glenn Straussdff84622022-03-14 11:12:57 -04001135 MBEDTLS_SSL_VERSION_UNKNOWN, /*!< Context not in use or version not yet negotiated. */
1136 MBEDTLS_SSL_VERSION_TLS1_2 = 0x0303, /*!< (D)TLS 1.2 */
1137 MBEDTLS_SSL_VERSION_TLS1_3 = 0x0304, /*!< (D)TLS 1.3 */
1138} mbedtls_ssl_protocol_version;
1139
Paul Bakker5121ce52009-01-03 21:22:43 +00001140/*
Paul Bakker0a597072012-09-25 21:55:46 +00001141 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001142 *
1143 * Note: when changing this definition, we need to check and update:
1144 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02001145 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001146 * - in library/ssl_tls.c:
1147 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1148 * mbedtls_ssl_session_save() and ssl_session_load()
1149 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +00001150 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151struct mbedtls_ssl_session {
Gilles Peskine8834d872021-11-29 12:36:50 +01001152#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1153 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
1154#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1155
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001156/*!< RecordSizeLimit received from the peer */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001157#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1158 uint16_t MBEDTLS_PRIVATE(record_size_limit);
1159#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1160
Gilles Peskine8834d872021-11-29 12:36:50 +01001161 unsigned char MBEDTLS_PRIVATE(exported);
Ronald Cron7fdee8b2024-02-09 09:26:12 +01001162 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskine8834d872021-11-29 12:36:50 +01001163
Ronald Cron217d6992022-04-04 10:23:22 +02001164 /** TLS version negotiated in the session. Used if and when renegotiating
1165 * or resuming a session instead of the configured minor TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001166 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001167 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Gilles Peskine8834d872021-11-29 12:36:50 +01001168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001169#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu702fc592023-10-31 14:22:04 +08001170 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< start time of current session */
Paul Bakkerfa9b1002013-07-03 15:31:03 +02001171#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001172 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001173 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
1174 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
1175 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +02001176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001177#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +00001178#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001179 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +00001180#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001181 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
1182 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +02001183 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1184 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1185 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +00001186#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001187#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001188 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +02001189
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001190#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001191 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
1192 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
1193 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001194#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001195
Ronald Crond1c106c2023-11-22 09:14:02 +01001196#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C) && \
1197 defined(MBEDTLS_HAVE_TIME)
Ronald Cron3c0072b2023-11-22 10:00:14 +01001198 /*! When a ticket is created by a TLS server as part of an established TLS
1199 * session, the ticket creation time may need to be saved for the ticket
1200 * module to be able to check the ticket age when the ticket is used.
1201 * That's the purpose of this field.
1202 * Before creating a new ticket, an Mbed TLS server set this field with
1203 * its current time in milliseconds. This time may then be saved in the
1204 * session ticket data by the session ticket writing function and
1205 * recovered by the ticket parsing function later when the ticket is used.
1206 * The ticket module may then use this time to compute the ticket age and
1207 * determine if it has expired or not.
1208 * The Mbed TLS implementations of the session ticket writing and parsing
1209 * functions save and retrieve the ticket creation time as part of the
1210 * session ticket data. The session ticket parsing function relies on
1211 * the mbedtls_ssl_session_get_ticket_creation_time() API to get the
1212 * ticket creation time from the session ticket data.
1213 */
Ronald Crond1c106c2023-11-22 09:14:02 +01001214 mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_creation_time);
1215#endif
1216
Jerry Yua270f672022-07-07 06:51:06 +00001217#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron7fdee8b2024-02-09 09:26:12 +01001218 uint32_t MBEDTLS_PRIVATE(ticket_age_add); /*!< Randomly generated value used to obscure the age of the ticket */
1219 uint8_t MBEDTLS_PRIVATE(ticket_flags); /*!< Ticket flags */
1220 uint8_t MBEDTLS_PRIVATE(resumption_key_len); /*!< resumption_key length */
Jerry Yu0a430c82022-07-20 11:02:48 +08001221 unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN];
Jerry Yua270f672022-07-07 06:51:06 +00001222
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00001223#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C)
1224 char *MBEDTLS_PRIVATE(hostname); /*!< host name binded with tickets */
1225#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */
1226
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00001227#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C)
Gilles Peskineaa2594a2025-02-20 18:42:13 +01001228 char *MBEDTLS_PRIVATE(ticket_alpn); /*!< ALPN negotiated in the session
1229 during which the ticket was generated. */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00001230#endif
1231
Ronald Crond1c106c2023-11-22 09:14:02 +01001232#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_CLI_C)
1233 /*! Time in milliseconds when the last ticket was received. */
1234 mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_reception_time);
Jerry Yu25ba4d42023-11-10 14:12:20 +08001235#endif
Jerry Yua270f672022-07-07 06:51:06 +00001236#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
1237
Jerry Yu02e3a072022-12-12 15:13:20 +08001238#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu6c485da2023-11-15 10:18:47 +08001239 uint32_t MBEDTLS_PRIVATE(max_early_data_size); /*!< maximum amount of early data in tickets */
Jerry Yu02e3a072022-12-12 15:13:20 +08001240#endif
1241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001242#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001243 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001244#endif
XiaokangQian33062842021-11-11 03:37:45 +00001245
Ronald Cron6f135e12021-12-08 16:57:54 +01001246#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001247 mbedtls_ssl_tls13_application_secrets MBEDTLS_PRIVATE(app_secrets);
Xiaokang Qianbaa47642022-10-12 10:21:27 +00001248#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001249};
1250
Hanno Becker457d6162021-05-24 10:27:39 +01001251/*
1252 * Identifiers for PRFs used in various versions of TLS.
1253 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001254typedef enum {
1255 MBEDTLS_SSL_TLS_PRF_NONE,
1256 MBEDTLS_SSL_TLS_PRF_SHA384,
1257 MBEDTLS_SSL_TLS_PRF_SHA256,
1258 MBEDTLS_SSL_HKDF_EXPAND_SHA384,
1259 MBEDTLS_SSL_HKDF_EXPAND_SHA256
Hanno Becker457d6162021-05-24 10:27:39 +01001260}
1261mbedtls_tls_prf_types;
1262
Gilles Peskine449bd832023-01-11 14:50:10 +01001263typedef enum {
Hanno Becker457d6162021-05-24 10:27:39 +01001264 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0,
Ronald Cron6f135e12021-12-08 16:57:54 +01001265#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001266 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1267 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET,
1268 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1269 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1270 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
1271 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
Ronald Cron6f135e12021-12-08 16:57:54 +01001272#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker457d6162021-05-24 10:27:39 +01001273} mbedtls_ssl_key_export_type;
1274
1275/**
1276 * \brief Callback type: Export key alongside random values for
1277 * session identification, and PRF for
1278 * implementation of TLS key exporters.
1279 *
Hanno Beckerddc739c2021-05-28 05:10:38 +01001280 * \param p_expkey Context for the callback.
1281 * \param type The type of the key that is being exported.
1282 * \param secret The address of the buffer holding the secret
1283 * that's being exporterd.
1284 * \param secret_len The length of \p secret in bytes.
Hanno Becker457d6162021-05-24 10:27:39 +01001285 * \param client_random The client random bytes.
1286 * \param server_random The server random bytes.
1287 * \param tls_prf_type The identifier for the PRF used in the handshake
1288 * to which the key belongs.
Hanno Becker457d6162021-05-24 10:27:39 +01001289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001290typedef void mbedtls_ssl_export_keys_t(void *p_expkey,
1291 mbedtls_ssl_key_export_type type,
1292 const unsigned char *secret,
1293 size_t secret_len,
1294 const unsigned char client_random[32],
1295 const unsigned char server_random[32],
1296 mbedtls_tls_prf_types tls_prf_type);
Hanno Becker457d6162021-05-24 10:27:39 +01001297
Glenn Strauss236e17e2022-03-13 23:39:40 -04001298#if defined(MBEDTLS_SSL_SRV_C)
1299/**
1300 * \brief Callback type: generic handshake callback
1301 *
1302 * \note Callbacks may use user_data funcs to set/get app user data.
1303 * See \c mbedtls_ssl_get_user_data_p()
1304 * \c mbedtls_ssl_get_user_data_n()
1305 * \c mbedtls_ssl_conf_get_user_data_p()
1306 * \c mbedtls_ssl_conf_get_user_data_n()
1307 *
1308 * \param ssl \c mbedtls_ssl_context on which the callback is run
1309 *
1310 * \return The return value of the callback is 0 if successful,
1311 * or a specific MBEDTLS_ERR_XXX code, which will cause
1312 * the handshake to be aborted.
1313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001314typedef int (*mbedtls_ssl_hs_cb_t)(mbedtls_ssl_context *ssl);
Glenn Strauss236e17e2022-03-13 23:39:40 -04001315#endif
1316
Gilles Peskineded2a422022-02-12 00:20:08 +01001317/* A type for storing user data in a library structure.
1318 *
1319 * The representation of type may change in future versions of the library.
1320 * Only the behaviors guaranteed by documented accessor functions are
1321 * guaranteed to remain stable.
1322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001323typedef union {
Gilles Peskineded2a422022-02-12 00:20:08 +01001324 uintptr_t n; /* typically a handle to an associated object */
1325 void *p; /* typically a pointer to extra data */
1326} mbedtls_ssl_user_data_t;
1327
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001328/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001329 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001331struct mbedtls_ssl_config {
Gilles Peskine8834d872021-11-29 12:36:50 +01001332 /* Group items mostly by size. This helps to reduce memory wasted to
1333 * padding. It also helps to keep smaller fields early in the structure,
1334 * so that elements tend to be in the 128-element direct access window
1335 * on Arm Thumb, which reduces the code size. */
1336
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001337 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(max_tls_version); /*!< max. TLS version used */
1338 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(min_tls_version); /*!< min. TLS version used */
Gilles Peskine8834d872021-11-29 12:36:50 +01001339
1340 /*
Gilles Peskine533a7282021-11-16 18:31:46 +01001341 * Flags (could be bit-fields to save RAM, but separate bytes make
1342 * the code smaller on architectures with an instruction for direct
1343 * byte access).
Gilles Peskine8834d872021-11-29 12:36:50 +01001344 */
1345
Gilles Peskine533a7282021-11-16 18:31:46 +01001346 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001347 uint8_t MBEDTLS_PRIVATE(transport); /*!< 0: stream (TLS), 1: datagram (DTLS) */
Gilles Peskine533a7282021-11-16 18:31:46 +01001348 uint8_t MBEDTLS_PRIVATE(authmode); /*!< MBEDTLS_SSL_VERIFY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001349 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Gilles Peskine533a7282021-11-16 18:31:46 +01001350 uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation); /*!< MBEDTLS_LEGACY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001351#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001352 uint8_t MBEDTLS_PRIVATE(mfl_code); /*!< desired fragment length indicator
1353 (MBEDTLS_SSL_MAX_FRAG_LEN_XXX) */
Gilles Peskine8834d872021-11-29 12:36:50 +01001354#endif
1355#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine533a7282021-11-16 18:31:46 +01001356 uint8_t MBEDTLS_PRIVATE(encrypt_then_mac); /*!< negotiate encrypt-then-mac? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001357#endif
1358#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine533a7282021-11-16 18:31:46 +01001359 uint8_t MBEDTLS_PRIVATE(extended_ms); /*!< negotiate extended master secret? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001360#endif
1361#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine533a7282021-11-16 18:31:46 +01001362 uint8_t MBEDTLS_PRIVATE(anti_replay); /*!< detect and prevent replay? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001363#endif
1364#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine533a7282021-11-16 18:31:46 +01001365 uint8_t MBEDTLS_PRIVATE(disable_renegotiation); /*!< disable renegotiation? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001366#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001367#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1368 defined(MBEDTLS_SSL_CLI_C)
1369 uint8_t MBEDTLS_PRIVATE(session_tickets); /*!< use session tickets? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001370#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001371
1372#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1373 defined(MBEDTLS_SSL_SRV_C) && \
1374 defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yud0766ec2022-09-22 10:46:57 +08001375 uint16_t MBEDTLS_PRIVATE(new_session_tickets_count); /*!< number of NewSessionTicket */
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001376#endif
1377
Gilles Peskine8834d872021-11-29 12:36:50 +01001378#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine533a7282021-11-16 18:31:46 +01001379 uint8_t MBEDTLS_PRIVATE(cert_req_ca_list); /*!< enable sending CA list in
1380 Certificate Request messages? */
1381 uint8_t MBEDTLS_PRIVATE(respect_cli_pref); /*!< pick the ciphersuite according to
1382 the client's preferences rather
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001383 than ours? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001384#endif
1385#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001386 uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid); /*!< Should DTLS record with
1387 * unexpected CID
1388 * lead to failure? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001389#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1390#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine533a7282021-11-16 18:31:46 +01001391 uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001392 in the use_srtp extension? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001393#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001394
1395 /*
1396 * Pointers
1397 */
1398
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001399 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +02001400 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001401
Ronald Cron6f135e12021-12-08 16:57:54 +01001402#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001403 /** Allowed TLS 1.3 key exchange modes. */
1404 int MBEDTLS_PRIVATE(tls13_kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01001405#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001406
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001407 /** Callback for printing debug output */
Gilles Peskine449bd832023-01-11 14:50:10 +01001408 void(*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001409 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001410
1411 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001412 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001413 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001414 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
1415 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001416
1417#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1418 /** Callback for setting cert according to SNI extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 int(*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001420 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001421#endif
1422
1423#if defined(MBEDTLS_X509_CRT_PARSE_C)
1424 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001426 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001427#endif
1428
Ronald Cron73fe8df2022-10-05 14:31:43 +02001429#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Jerry Yu8897c072022-08-12 13:56:53 +08001430#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001431 /** Callback to retrieve PSK key from identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 int(*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001433 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001434#endif
Jerry Yu8897c072022-08-12 13:56:53 +08001435#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001436
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001437#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Tom Cosgrove1e211442022-05-26 11:51:00 +01001438 /** Callback to create & write a cookie for ClientHello verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001439 int(*MBEDTLS_PRIVATE(f_cookie_write))(void *, unsigned char **, unsigned char *,
1440 const unsigned char *, size_t);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001441 /** Callback to verify validity of a ClientHello cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 int(*MBEDTLS_PRIVATE(f_cookie_check))(void *, const unsigned char *, size_t,
1443 const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001444 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001445#endif
1446
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001447#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001448 /** Callback to create & write a session ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 int(*MBEDTLS_PRIVATE(f_ticket_write))(void *, const mbedtls_ssl_session *,
1450 unsigned char *, const unsigned char *, size_t *,
1451 uint32_t *);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001452 /** Callback to parse a session ticket into a session structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 int(*MBEDTLS_PRIVATE(f_ticket_parse))(void *, mbedtls_ssl_session *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001454 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001455#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001456#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001457 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001458#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001459
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001460#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001461 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1462 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1463 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1464 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001465#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001466 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1467 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001468#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001469#endif /* MBEDTLS_X509_CRT_PARSE_C */
1470
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001471#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001472#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001473 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001474#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001475 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1476 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1477 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001478#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001479
Ronald Crone68ab4f2022-10-05 12:46:29 +02001480#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yuf017ee42022-01-12 15:49:48 +08001481 const uint16_t *MBEDTLS_PRIVATE(sig_algs); /*!< allowed signature algorithms */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001482#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001483
Brett Warrene0edc842021-08-17 09:53:13 +01001484 const uint16_t *MBEDTLS_PRIVATE(group_list); /*!< allowed IANA NamedGroups */
1485
Ronald Cron73fe8df2022-10-05 14:31:43 +02001486#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001487
Andrzej Kurek03e01462022-01-03 12:53:24 +01001488 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 * should only be set via
1490 * mbedtls_ssl_conf_psk_opaque().
1491 * If either no PSK or a raw PSK have been
1492 * configured, this has value \c 0.
1493 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001494 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 * only be set via mbedtls_ssl_conf_psk().
1496 * If either no PSK or an opaque PSK
1497 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001498 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Gilles Peskine449bd832023-01-11 14:50:10 +01001499 * This field should only be set via
1500 * mbedtls_ssl_conf_psk().
1501 * Its value is non-zero if and only if
1502 * \c psk is not \c NULL. */
Hanno Becker43633132018-10-22 15:31:03 +01001503
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001504 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 * This field should only be set via
1506 * mbedtls_ssl_conf_psk().
1507 * This is set if and only if either
1508 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001509 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 * This field should only be set via
1511 * mbedtls_ssl_conf_psk().
1512 * Its value is non-zero if and only if
1513 * \c psk is not \c NULL or \c psk_opaque
1514 * is not \c 0. */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001515#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001516
Xiaokang Qian54413b12022-10-20 05:57:03 +00001517#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001518 int MBEDTLS_PRIVATE(early_data_enabled); /*!< Early data enablement:
Xiaokang Qiand69d06f2022-10-25 06:51:25 +00001519 * - MBEDTLS_SSL_EARLY_DATA_DISABLED,
1520 * - MBEDTLS_SSL_EARLY_DATA_ENABLED */
Jerry Yucc4e0072022-11-22 17:22:22 +08001521
1522#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu12c46bd2022-12-06 11:02:51 +08001523 /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */
Jerry Yucc4e0072022-11-22 17:22:22 +08001524 uint32_t MBEDTLS_PRIVATE(max_early_data_size);
1525#endif /* MBEDTLS_SSL_SRV_C */
1526
Xiaokang Qian54413b12022-10-20 05:57:03 +00001527#endif /* MBEDTLS_SSL_EARLY_DATA */
1528
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001529#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskinec4949d12025-05-27 19:45:29 +02001530 const char *const *MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001531#endif
1532
Johan Pascalbbc057a2016-02-04 22:07:32 +01001533#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001534 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001535 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001536 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001537 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001538#endif /* MBEDTLS_SSL_DTLS_SRTP */
1539
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001540 /*
Gilles Peskine8834d872021-11-29 12:36:50 +01001541 * Numerical settings (int)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001542 */
1543
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001544 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001545
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001546#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001547 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001549 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001551#endif
1552
1553#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001554 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1555 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 that triggers renegotiation */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001557#endif
1558
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001559 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001560
Gilles Peskine69477b52022-01-13 01:01:45 +01001561 /** User data pointer or handle.
1562 *
1563 * The library sets this to \p 0 when creating a context and does not
1564 * access it afterwards.
1565 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001566 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Glenn Strauss2ed95272022-01-21 18:02:17 -05001567
1568#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss236e17e2022-03-13 23:39:40 -04001569 mbedtls_ssl_hs_cb_t MBEDTLS_PRIVATE(f_cert_cb); /*!< certificate selection callback */
Glenn Strauss2ed95272022-01-21 18:02:17 -05001570#endif /* MBEDTLS_SSL_SRV_C */
Glenn Strauss999ef702022-03-11 01:37:23 -05001571
1572#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1573 const mbedtls_x509_crt *MBEDTLS_PRIVATE(dn_hints);/*!< acceptable client cert issuers */
1574#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001575};
1576
Gilles Peskine449bd832023-01-11 14:50:10 +01001577struct mbedtls_ssl_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001578 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001579
Paul Bakker5121ce52009-01-03 21:22:43 +00001580 /*
1581 * Miscellaneous
1582 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001583 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Gilles Peskine95fe2a62025-02-20 18:12:29 +01001584
1585 /** Mask of `MBEDTLS_SSL_CONTEXT_FLAG_XXX`.
Gilles Peskine434016e2025-02-20 18:49:59 +01001586 * See `mbedtls_ssl_context_flags_t` in ssl_misc.h.
1587 *
Gilles Peskine95fe2a62025-02-20 18:12:29 +01001588 * This field is not saved by mbedtls_ssl_session_save().
1589 */
1590 uint32_t MBEDTLS_PRIVATE(flags);
1591
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001592#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001593 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1594 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 number of retransmissions of request if
1596 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001597#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001598
Ronald Cron8a12aee2023-03-08 15:30:43 +01001599 /**
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001600 * Maximum TLS version to be negotiated, then negotiated TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001601 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001602 * It is initialized as the configured maximum TLS version to be
1603 * negotiated by mbedtls_ssl_setup().
Ronald Cronbdb4f582022-03-31 15:37:44 +02001604 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001605 * When renegotiating or resuming a session, it is overwritten in the
1606 * ClientHello writing preparation stage with the previously negotiated
1607 * TLS version.
Ronald Cron8a12aee2023-03-08 15:30:43 +01001608 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001609 * On client side, it is updated to the TLS version selected by the server
1610 * for the handshake when the ServerHello is received.
Ronald Cron8a12aee2023-03-08 15:30:43 +01001611 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001612 * On server side, it is updated to the TLS version the server selects for
1613 * the handshake when the ClientHello is received.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001614 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001615 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Ronald Cronbdb4f582022-03-31 15:37:44 +02001616
Ronald Cron78a38f62024-02-01 18:30:31 +01001617#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
Ronald Cron5d0ae902024-01-05 14:20:35 +01001618 /**
Ronald Crond2884662024-03-03 15:03:22 +01001619 * State of the negotiation and transfer of early data. Reset to
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001620 * MBEDTLS_SSL_EARLY_DATA_STATE_IDLE when the context is reset.
Ronald Cron5d0ae902024-01-05 14:20:35 +01001621 */
Ronald Cronaa359312024-03-11 17:24:39 +01001622 int MBEDTLS_PRIVATE(early_data_state);
Ronald Cron5d0ae902024-01-05 14:20:35 +01001623#endif
1624
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001625 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001626
Hanno Becker8927c832019-04-03 12:52:50 +01001627#if defined(MBEDTLS_X509_CRT_PARSE_C)
1628 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001630 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001631#endif
1632
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001633 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1634 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1635 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 /*!< Callback for network receive with timeout */
Simon Butchere846b512016-03-01 17:31:49 +00001637
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001638 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001639
Paul Bakker5121ce52009-01-03 21:22:43 +00001640 /*
1641 * Session layer
1642 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001643 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1644 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1645 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1646 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001647
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001648 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Gilles Peskine449bd832023-01-11 14:50:10 +01001649 the handshake process */
Paul Bakker48916f92012-09-16 19:57:18 +00001650
1651 /*
1652 * Record layer transformations
1653 */
Hanno Becker0e719ff2021-08-10 09:24:08 +01001654 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in)
1655 * This is always a reference,
1656 * never an owning pointer. */
1657 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (out)
1658 * This is always a reference,
1659 * never an owning pointer. */
1660 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params
1661 * This pointer owns the transform
1662 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001663#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0e719ff2021-08-10 09:24:08 +01001664 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation
1665 * This pointer owns the transform
1666 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001667#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001668
Ronald Cron6f135e12021-12-08 16:57:54 +01001669#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +01001670 /*! The application data transform in TLS 1.3.
1671 * This pointer owns the transform it references. */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001672 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01001673#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001674
Paul Bakker5121ce52009-01-03 21:22:43 +00001675 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001676 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001677 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001678 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001679
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001680 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1681 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001682
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001683 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001684 * Record layer (incoming data)
1685 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001686 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1687 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 TLS: maintained by us
1689 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001690 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001691#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001692 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001694#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001695 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1696 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1697 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1698 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001699
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001700 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1701 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1702 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001703#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001704 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001705#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001706#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001707 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1708 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001710#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001712 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1713 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001714#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001715
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001716 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Gilles Peskine449bd832023-01-11 14:50:10 +01001717 including the handshake header */
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001718 size_t MBEDTLS_PRIVATE(in_hsfraglen); /*!< accumulated length of hs fragments
1719 (up to in_hslen) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001720 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001721
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001722 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Gilles Peskine449bd832023-01-11 14:50:10 +01001723 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001724
Jerry Yue7047812021-09-13 19:26:39 +08001725 /* The following three variables indicate if and, if yes,
Jerry Yu394ece62021-09-14 22:17:21 +08001726 * what kind of alert is pending to be sent.
Jerry Yue7047812021-09-13 19:26:39 +08001727 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001728 unsigned char MBEDTLS_PRIVATE(send_alert); /*!< Determines if a fatal alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 should be sent. Values:
1730 - \c 0 , no alert is to be sent.
1731 - \c 1 , alert is to be sent. */
Jerry Yu33cedca2021-09-14 19:55:49 +08001732 unsigned char MBEDTLS_PRIVATE(alert_type); /*!< Type of alert if send_alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 != 0 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001734 int MBEDTLS_PRIVATE(alert_reason); /*!< The error code to be returned
Gilles Peskine449bd832023-01-11 14:50:10 +01001735 to the user once the fatal alert
1736 has been sent. */
Jerry Yue7047812021-09-13 19:26:39 +08001737
Hanno Becker04da1892018-08-14 13:22:10 +01001738#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001739 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 * within a single datagram. */
Hanno Becker04da1892018-08-14 13:22:10 +01001741#endif /* MBEDTLS_SSL_PROTO_DTLS */
1742
Ronald Cron26a98112024-02-23 08:23:40 +01001743#if defined(MBEDTLS_SSL_EARLY_DATA)
1744#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001745 /*
1746 * One of:
1747 * MBEDTLS_SSL_EARLY_DATA_NO_DISCARD
1748 * MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD
1749 * MBEDTLS_SSL_EARLY_DATA_DISCARD
1750 */
1751 uint8_t MBEDTLS_PRIVATE(discard_early_data_record);
1752#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001753 uint32_t MBEDTLS_PRIVATE(total_early_data_size); /*!< Number of received/written early data bytes */
Ronald Cron26a98112024-02-23 08:23:40 +01001754#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001755
Paul Bakker5121ce52009-01-03 21:22:43 +00001756 /*
1757 * Record layer (outgoing data)
1758 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001759 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1760 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1761 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001762#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001763 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001765#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001766 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1767 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1768 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001769
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001770 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1771 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1772 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001773#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001774 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001775#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001776
Jerry Yuae0b2e22021-10-08 15:21:19 +08001777 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001778
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001779#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001780 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001781#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001782
Paul Bakker5121ce52009-01-03 21:22:43 +00001783 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001784 * User settings
1785 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001786#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001787 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001789#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001790
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001791#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001792 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001793#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001794
Johan Pascalb62bb512015-12-03 21:56:45 +01001795#if defined(MBEDTLS_SSL_DTLS_SRTP)
1796 /*
1797 * use_srtp extension
1798 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001799 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001800#endif /* MBEDTLS_SSL_DTLS_SRTP */
1801
Paul Bakker48916f92012-09-16 19:57:18 +00001802 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001803 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001804 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001805#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001806 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1807 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001808#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001809
1810 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001811 * Secure renegotiation
1812 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001813 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001814 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001817 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1818 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1819 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001820#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001821
Hanno Beckera0e20d02019-05-15 14:03:01 +01001822#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001823 /* CID configuration to use in subsequent handshakes. */
1824
1825 /*! The next incoming CID, chosen by the user and applying to
1826 * all subsequent handshakes. This may be different from the
1827 * CID currently used in case the user has re-configured the CID
1828 * after an initial handshake. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 unsigned char MBEDTLS_PRIVATE(own_cid)[MBEDTLS_SSL_CID_IN_LEN_MAX];
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001830 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1831 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 * be negotiated in the next handshake or not.
1833 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1834 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001835#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001836
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001837 /** Callback to export key block and master secret */
1838 mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys);
1839 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
Gilles Peskine69477b52022-01-13 01:01:45 +01001840
1841 /** User data pointer or handle.
1842 *
1843 * The library sets this to \p 0 when creating a context and does not
1844 * access it afterwards.
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01001845 *
1846 * \warning Serializing and restoring an SSL context with
1847 * mbedtls_ssl_context_save() and mbedtls_ssl_context_load()
1848 * does not currently restore the user data.
Gilles Peskine69477b52022-01-13 01:01:45 +01001849 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001850 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Paul Bakker5121ce52009-01-03 21:22:43 +00001851};
1852
Paul Bakker5121ce52009-01-03 21:22:43 +00001853/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001854 * \brief Return the name of the ciphersuite associated with the
1855 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001856 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001857 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001858 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001859 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001860 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001861const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id);
Paul Bakkere3166ce2011-01-27 17:40:50 +00001862
1863/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001864 * \brief Return the ID of the ciphersuite associated with the
1865 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001866 *
1867 * \param ciphersuite_name SSL ciphersuite name
1868 *
1869 * \return the ID with the ciphersuite or 0 if not found
1870 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001871int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name);
Paul Bakker72f62662011-01-16 21:27:44 +00001872
1873/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001874 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001875 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001876 * mbedtls_ssl_free()
1877 *
1878 * \param ssl SSL context
1879 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001880void mbedtls_ssl_init(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001881
1882/**
1883 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001884 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001885 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001886 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001887 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001888 * \warning The conf structure will be accessed during the session.
1889 * It must not be modified or freed as long as the session
1890 * is active.
1891 *
1892 * \warning This function must be called exactly once per context.
1893 * Calling mbedtls_ssl_setup again is not supported, even
1894 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001895 *
Janos Follath130ece02024-11-19 16:16:36 +00001896 * \note The PSA crypto subsystem must have been initialized by
1897 * calling psa_crypto_init() before calling this function.
Gilles Peskine5b7e1642022-08-04 23:44:59 +02001898 *
Gilles Peskine825c3d02025-02-17 17:41:54 +01001899 * \note After setting up a client context, if certificate-based
1900 * authentication is enabled, you should call
1901 * mbedtls_ssl_set_hostname() to specifiy the expected
1902 * name of the server. Otherwise, if server authentication
1903 * is required (which is the case by default) and the
1904 * selected key exchange involves a certificate (i.e. is not
1905 * based on a pre-shared key), the certificate authentication
1906 * will fail. See
1907 * #MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME
1908 * for more information.
1909 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001910 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001911 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001912 *
Felix Conway37ede2c2025-08-18 14:46:39 +01001913 * \return 0 if successful, or #PSA_ERROR_INSUFFICIENT_MEMORY if
Paul Bakker69e095c2011-12-10 21:55:01 +00001914 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001916int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1917 const mbedtls_ssl_config *conf);
Paul Bakker5121ce52009-01-03 21:22:43 +00001918
1919/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001920 * \brief Reset an already initialized SSL context for re-use
1921 * while retaining application-set variables, function
1922 * pointers and data.
1923 *
1924 * \param ssl SSL context
Felix Conway37ede2c2025-08-18 14:46:39 +01001925 * \return 0 if successful, or #PSA_ERROR_INSUFFICIENT_MEMORY or
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001926 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001927 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001928int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl);
Paul Bakker7eb013f2011-10-06 12:37:39 +00001929
1930/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001931 * \brief Set the current endpoint type
1932 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001933 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001934 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001935 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001936void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint);
Paul Bakker5121ce52009-01-03 21:22:43 +00001937
1938/**
Pengyu Lvaccd53f2023-03-07 10:31:08 +08001939 * \brief Get the current endpoint type
1940 *
1941 * \param conf SSL configuration
1942 *
1943 * \return Endpoint type, either MBEDTLS_SSL_IS_CLIENT
1944 * or MBEDTLS_SSL_IS_SERVER
1945 */
Pengyu Lv08daebb2023-07-10 10:36:48 +08001946static inline int mbedtls_ssl_conf_get_endpoint(const mbedtls_ssl_config *conf)
Pengyu Lvaccd53f2023-03-07 10:31:08 +08001947{
1948 return conf->MBEDTLS_PRIVATE(endpoint);
1949}
1950
1951/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001952 * \brief Set the transport type (TLS or DTLS).
1953 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001954 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001955 * \note For DTLS, you must either provide a recv callback that
1956 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001957 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1958 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001959 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001960 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001961 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001962 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1963 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001964 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001965void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport);
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001966
1967/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001968 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001969 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001970 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001971 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001972 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001973 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001975 * (default on server)
1976 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001977 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001978 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001979 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001980 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001981 * handshake is complete.
1982 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001983 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001984 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001985 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001986 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1988 * 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 +01001989 * the right time(s), which may not be obvious, while REQUIRED always perform
1990 * the verification as soon as possible. For example, REQUIRED was protecting
1991 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001992 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001993void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode);
Paul Bakker5121ce52009-01-03 21:22:43 +00001994
Ronald Cron7d21cde2024-01-30 14:37:55 +01001995#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian54413b12022-10-20 05:57:03 +00001996/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 * \brief Set the early data mode
1998 * Default: disabled on server and client
1999 *
2000 * \param conf The SSL configuration to use.
2001 * \param early_data_enabled can be:
2002 *
Ronald Cron44d70a52024-01-30 18:16:47 +01002003 * MBEDTLS_SSL_EARLY_DATA_DISABLED:
2004 * Early data functionality is disabled. This is the default on client and
2005 * server.
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 *
Ronald Cron44d70a52024-01-30 18:16:47 +01002007 * MBEDTLS_SSL_EARLY_DATA_ENABLED:
2008 * Early data functionality is enabled and may be negotiated in the handshake.
2009 * Application using early data functionality needs to be aware that the
2010 * security properties for early data (also refered to as 0-RTT data) are
2011 * weaker than those for other kinds of TLS data. See the documentation of
2012 * mbedtls_ssl_write_early_data() and mbedtls_ssl_read_early_data() for more
2013 * information.
2014 * When early data functionality is enabled on server and only in that case,
2015 * the call to one of the APIs that trigger or resume an handshake sequence,
2016 * namely mbedtls_ssl_handshake(), mbedtls_ssl_handshake_step(),
2017 * mbedtls_ssl_read() or mbedtls_ssl_write() may return with the error code
2018 * MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA indicating that some early data have
Ronald Cron164537c2024-02-01 18:05:47 +01002019 * been received. To read the early data, call mbedtls_ssl_read_early_data()
2020 * before calling the original function again.
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 */
Yanray Wangd5ed36f2023-11-07 11:40:43 +08002022void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
2023 int early_data_enabled);
Jerry Yucc4e0072022-11-22 17:22:22 +08002024
2025#if defined(MBEDTLS_SSL_SRV_C)
2026/**
Jerry Yu12c46bd2022-12-06 11:02:51 +08002027 * \brief Set the maximum amount of 0-RTT data in bytes
2028 * Default: #MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
2029 *
2030 * This function sets the value of the max_early_data_size
2031 * field of the early data indication extension included in
2032 * the NewSessionTicket messages that the server may send.
2033 *
2034 * The value defines the maximum amount of 0-RTT data
2035 * in bytes that a client will be allowed to send when using
2036 * one of the tickets defined by the NewSessionTicket messages.
2037 *
2038 * \note When resuming a session using a ticket, if the server receives more
2039 * early data than allowed for the ticket, it terminates the connection.
2040 * The maximum amount of 0-RTT data should thus be large enough
2041 * to allow a minimum of early data to be exchanged.
Jerry Yucc4e0072022-11-22 17:22:22 +08002042 *
2043 * \param[in] conf The SSL configuration to use.
2044 * \param[in] max_early_data_size The maximum amount of 0-RTT data.
Jerry Yucc4e0072022-11-22 17:22:22 +08002045 *
Jerry Yu6c485da2023-11-15 10:18:47 +08002046 * \warning This interface DOES NOT influence/limit the amount of early data
Jerry Yufedaeb22023-11-15 13:59:07 +08002047 * that can be received through previously created and issued tickets,
2048 * which clients may have stored.
Jerry Yucc4e0072022-11-22 17:22:22 +08002049 */
Yanray Wang07517612023-11-07 11:47:36 +08002050void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 mbedtls_ssl_config *conf, uint32_t max_early_data_size);
Jerry Yucc4e0072022-11-22 17:22:22 +08002052#endif /* MBEDTLS_SSL_SRV_C */
2053
Ronald Cron7d21cde2024-01-30 14:37:55 +01002054#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qian54413b12022-10-20 05:57:03 +00002055
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002056#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002057/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002058 * \brief Set the verification callback (Optional).
2059 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002060 * If set, the provided verify callback is called for each
2061 * certificate in the peer's CRT chain, including the trusted
2062 * root. For more information, please see the documentation of
2063 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002064 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002065 * \note For per context callbacks and contexts, please use
2066 * mbedtls_ssl_set_verify() instead.
2067 *
2068 * \param conf The SSL configuration to use.
2069 * \param f_vrfy The verification callback to use during CRT verification.
2070 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002072void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
2073 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2074 void *p_vrfy);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002076
2077/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002078 * \brief Set the debug callback
2079 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02002080 * The callback has the following argument:
2081 * void * opaque context for the callback
2082 * int debug level
2083 * const char * file name
2084 * int line number
2085 * const char * message
2086 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002087 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002088 * \param f_dbg debug function
2089 * \param p_dbg debug parameter
2090 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002091void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
2092 void (*f_dbg)(void *, int, const char *, int, const char *),
2093 void *p_dbg);
Paul Bakker5121ce52009-01-03 21:22:43 +00002094
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002095/**
Gilles Peskine915896f2022-01-13 01:05:10 +01002096 * \brief Return the SSL configuration structure associated
2097 * with the given SSL context.
2098 *
2099 * \note The pointer returned by this function is guaranteed to
2100 * remain valid until the context is freed.
2101 *
2102 * \param ssl The SSL context to query.
2103 * \return Pointer to the SSL configuration associated with \p ssl.
2104 */
2105static inline const mbedtls_ssl_config *mbedtls_ssl_context_get_config(
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 const mbedtls_ssl_context *ssl)
Gilles Peskine915896f2022-01-13 01:05:10 +01002107{
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 return ssl->MBEDTLS_PRIVATE(conf);
Gilles Peskine915896f2022-01-13 01:05:10 +01002109}
2110
2111/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002112 * \brief Set the underlying BIO callbacks for write, read and
2113 * read-with-timeout.
2114 *
2115 * \param ssl SSL context
2116 * \param p_bio parameter (context) shared by BIO callbacks
2117 * \param f_send write callback
2118 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002119 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002120 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002121 * \note One of f_recv or f_recv_timeout can be NULL, in which case
2122 * the other is used. If both are non-NULL, f_recv_timeout is
2123 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002124 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002125 * \note The two most common use cases are:
2126 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
bootstrap-prime6dbbf442022-05-17 19:30:44 -04002127 * - blocking I/O, f_recv == NULL, f_recv_timeout != NULL
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002128 *
2129 * \note For DTLS, you need to provide either a non-NULL
2130 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002131 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07002132 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002133 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00002134 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002135 *
Andres AG3616f6f2016-09-14 14:32:09 +01002136 * \note On some platforms, net_sockets.c provides
2137 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
2138 * \c mbedtls_net_recv_timeout() that are suitable to be used
2139 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002140 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002141void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
2142 void *p_bio,
2143 mbedtls_ssl_send_t *f_send,
2144 mbedtls_ssl_recv_t *f_recv,
2145 mbedtls_ssl_recv_timeout_t *f_recv_timeout);
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002146
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002147#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01002148
Hanno Beckera0e20d02019-05-15 14:03:01 +01002149#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01002150
2151
2152/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01002153 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01002154 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01002155 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002156 * Reference: RFC 9146 (or draft-ietf-tls-dtls-connection-id-05
Hanno Beckerebcc9132019-05-15 10:26:32 +01002157 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002158 * for legacy version)
Hanno Becker019f4b52019-04-09 15:12:56 +01002159 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01002160 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01002161 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01002162 * underlying transport (changed IP and Port metadata) by
2163 * adding explicit connection identifiers (CIDs) to the
2164 * headers of encrypted DTLS records. The desired CIDs are
2165 * configured by the application layer and are exchanged in
2166 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01002167 * handshake, where each side indicates the CID it wants the
2168 * peer to use when writing encrypted messages. The CIDs are
2169 * put to use once records get encrypted: the stack discards
2170 * any incoming records that don't include the configured CID
2171 * in their header, and adds the peer's requested CID to the
2172 * headers of outgoing messages.
2173 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01002174 * This API enables or disables the use of the CID extension
2175 * in the next handshake and sets the value of the CID to
2176 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01002177 *
2178 * \param ssl The SSL context to configure. This must be initialized.
2179 * \param enable This value determines whether the CID extension should
2180 * be used or not. Possible values are:
2181 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01002182 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
2183 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01002184 * \param own_cid The address of the readable buffer holding the CID we want
2185 * the peer to use when sending encrypted messages to us.
2186 * This may be \c NULL if \p own_cid_len is \c 0.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05002187 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01002188 * MBEDTLS_SSL_CID_DISABLED.
2189 * \param own_cid_len The length of \p own_cid.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05002190 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01002191 * MBEDTLS_SSL_CID_DISABLED.
2192 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01002193 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01002194 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01002195 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01002196 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002197 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01002198 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01002199 * performed on the SSL context \p ssl, but does not trigger
2200 * one. You still have to call `mbedtls_ssl_handshake()`
2201 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
2202 * (for a renegotiation handshake) explicitly after a
2203 * successful call to this function to run the handshake.
2204 *
2205 * \note This call cannot guarantee that the use of the CID
2206 * will be successfully negotiated in the next handshake,
2207 * because the peer might not support it. Specifically:
2208 * - On the Client, enabling the use of the CID through
2209 * this call implies that the `ClientHello` in the next
2210 * handshake will include the CID extension, thereby
2211 * offering the use of the CID to the server. Only if
2212 * the `ServerHello` contains the CID extension, too,
2213 * the CID extension will actually be put to use.
2214 * - On the Server, enabling the use of the CID through
Tom Cosgrove1797b052022-12-04 17:19:59 +00002215 * this call implies that the server will look for
Hanno Becker019f4b52019-04-09 15:12:56 +01002216 * the CID extension in a `ClientHello` from the client,
2217 * and, if present, reply with a CID extension in its
2218 * `ServerHello`.
2219 *
2220 * \note To check whether the use of the CID was negotiated
2221 * after the subsequent handshake has completed, please
2222 * use the API mbedtls_ssl_get_peer_cid().
2223 *
2224 * \warning If the use of the CID extension is enabled in this call
2225 * and the subsequent handshake negotiates its use, Mbed TLS
2226 * will silently drop every packet whose CID does not match
2227 * the CID configured in \p own_cid. It is the responsibility
2228 * of the user to adapt the underlying transport to take care
2229 * of CID-based demultiplexing before handing datagrams to
2230 * Mbed TLS.
2231 *
2232 * \return \c 0 on success. In this case, the CID configuration
2233 * applies to the next handshake.
2234 * \return A negative error code on failure.
2235 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002236int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
2237 int enable,
2238 unsigned char const *own_cid,
2239 size_t own_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002240
2241/**
Paul Elliott0113cf12022-03-11 20:26:47 +00002242 * \brief Get information about our request for usage of the CID
2243 * extension in the current connection.
2244 *
2245 * \param ssl The SSL context to query.
2246 * \param enabled The address at which to store whether the CID extension
2247 * is requested to be used or not. If the CID is
2248 * requested, `*enabled` is set to
2249 * MBEDTLS_SSL_CID_ENABLED; otherwise, it is set to
2250 * MBEDTLS_SSL_CID_DISABLED.
2251 * \param own_cid The address of the buffer in which to store our own
2252 * CID (if the CID extension is requested). This may be
2253 * \c NULL in case the value of our CID isn't needed. If
2254 * it is not \c NULL, \p own_cid_len must not be \c NULL.
2255 * \param own_cid_len The address at which to store the size of our own CID
2256 * (if the CID extension is requested). This is also the
2257 * number of Bytes in \p own_cid that have been written.
2258 * This may be \c NULL in case the length of our own CID
2259 * isn't needed. If it is \c NULL, \p own_cid must be
2260 * \c NULL, too.
2261 *
2262 *\note If we are requesting an empty CID this function sets
2263 * `*enabled` to #MBEDTLS_SSL_CID_DISABLED (the rationale
2264 * for this is that the resulting outcome is the
2265 * same as if the CID extensions wasn't requested).
2266 *
2267 * \return \c 0 on success.
2268 * \return A negative error code on failure.
2269 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002270int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
Paul Elliott0113cf12022-03-11 20:26:47 +00002271 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +01002272 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 size_t *own_cid_len);
Paul Elliott0113cf12022-03-11 20:26:47 +00002274
2275/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01002276 * \brief Get information about the use of the CID extension
2277 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01002278 *
2279 * \param ssl The SSL context to query.
2280 * \param enabled The address at which to store whether the CID extension
2281 * is currently in use or not. If the CID is in use,
2282 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
2283 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
2284 * \param peer_cid The address of the buffer in which to store the CID
2285 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01002286 * This may be \c NULL in case the value of peer CID
2287 * isn't needed. If it is not \c NULL, \p peer_cid_len
2288 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01002289 * \param peer_cid_len The address at which to store the size of the CID
2290 * chosen by the peer (if the CID extension is used).
2291 * This is also the number of Bytes in \p peer_cid that
2292 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01002293 * This may be \c NULL in case the length of the peer CID
2294 * isn't needed. If it is \c NULL, \p peer_cid must be
2295 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01002296 *
2297 * \note This applies to the state of the CID negotiated in
2298 * the last complete handshake. If a handshake is in
2299 * progress, this function will attempt to complete
2300 * the handshake first.
2301 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01002302 * \note If CID extensions have been exchanged but both client
2303 * and server chose to use an empty CID, this function
2304 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
2305 * (the rationale for this is that the resulting
2306 * communication is the same as if the CID extensions
2307 * hadn't been used).
2308 *
Hanno Becker019f4b52019-04-09 15:12:56 +01002309 * \return \c 0 on success.
2310 * \return A negative error code on failure.
2311 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002312int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
2313 int *enabled,
2314 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2315 size_t *peer_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002316
Hanno Beckera0e20d02019-05-15 14:03:01 +01002317#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01002318
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002319/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002320 * \brief Set the Maximum Transport Unit (MTU).
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002321 * Special value: 0 means unset (no limit).
2322 * This represents the maximum size of a datagram payload
2323 * handled by the transport layer (usually UDP) as determined
2324 * by the network link and stack. In practice, this controls
2325 * the maximum size datagram the DTLS layer will pass to the
2326 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
2327 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002328 * \note The limit on datagram size is converted to a limit on
2329 * record payload by subtracting the current overhead of
2330 * encapsulation and encryption/authentication if any.
2331 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002332 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01002333 * example when a Path Maximum Transfer Unit (PMTU)
2334 * estimate becomes available from other sources,
2335 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002336 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002337 * \note This setting only controls the size of the packets we send,
2338 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02002339 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002340 * server to use smaller records with \c
2341 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002342 *
2343 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002344 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002345 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002346 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002347 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002348 * of datagrams (hence records, see first note) sent. It
2349 * cannot be used to increase the maximum size of records over
2350 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002351 *
2352 * \note Values lower than the current record layer expansion will
2353 * result in an error when trying to send data.
2354 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002355 * \param ssl SSL context
2356 * \param mtu Value of the path MTU in bytes
2357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002358void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu);
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002359#endif /* MBEDTLS_SSL_PROTO_DTLS */
2360
Hanno Becker726c97a2019-04-03 12:52:35 +01002361#if defined(MBEDTLS_X509_CRT_PARSE_C)
2362/**
2363 * \brief Set a connection-specific verification callback (optional).
2364 *
2365 * If set, the provided verify callback is called for each
2366 * certificate in the peer's CRT chain, including the trusted
2367 * root. For more information, please see the documentation of
2368 * \c mbedtls_x509_crt_verify().
2369 *
2370 * \note This call is analogous to mbedtls_ssl_conf_verify() but
2371 * binds the verification callback and context to an SSL context
2372 * as opposed to an SSL configuration.
2373 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
2374 * are both used, mbedtls_ssl_set_verify() takes precedence.
2375 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01002376 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01002377 * \param f_vrfy The verification callback to use during CRT verification.
2378 * \param p_vrfy The opaque context to be passed to the callback.
2379 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002380void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
2381 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2382 void *p_vrfy);
Hanno Becker726c97a2019-04-03 12:52:35 +01002383#endif /* MBEDTLS_X509_CRT_PARSE_C */
2384
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002385/**
2386 * \brief Set the timeout period for mbedtls_ssl_read()
2387 * (Default: no timeout.)
2388 *
2389 * \param conf SSL configuration context
2390 * \param timeout Timeout value in milliseconds.
2391 * Use 0 for no timeout (default).
2392 *
2393 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002394 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002395 * With non-blocking I/O, this will only work if timer
2396 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
2397 *
2398 * \note With non-blocking I/O, you may also skip this function
2399 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002401void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout);
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002402
Hanno Beckercfe45792019-07-03 16:13:00 +01002403/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002404 * \brief Check whether a buffer contains a valid and authentic record
2405 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01002406 *
2407 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01002408 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01002409 * an indication of the legitimacy of an incoming record.
2410 *
2411 * This can be useful e.g. in distributed server environments
2412 * using the DTLS Connection ID feature, in which connections
2413 * might need to be passed between service instances on a change
2414 * of peer address, but where such disruptive operations should
2415 * only happen after the validity of incoming records has been
2416 * confirmed.
2417 *
2418 * \param ssl The SSL context to use.
2419 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002420 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01002421 * \param buflen The length of \p buf in Bytes.
2422 *
2423 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002424 * with a valid and authentic record that has not been seen
2425 * before, but does not check potential data following the
2426 * initial record. In particular, it is possible to pass DTLS
2427 * datagrams containing multiple records, in which case only
2428 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01002429 *
2430 * \note This function modifies the input buffer \p buf. If you need
2431 * to preserve the original record, you have to maintain a copy.
2432 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002433 * \return \c 0 if the record is valid and authentic and has not been
2434 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01002435 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
2436 * successfully but the record was found to be not authentic.
2437 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
2438 * successfully but the record was found to be invalid for
2439 * a reason different from authenticity checking.
2440 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
2441 * successfully but the record was found to be unexpected
2442 * in the state of the SSL context, including replayed records.
2443 * \return Another negative error code on different kinds of failure.
2444 * In this case, the SSL context becomes unusable and needs
2445 * to be freed or reset before reuse.
2446 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002447int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
2448 unsigned char *buf,
2449 size_t buflen);
Hanno Beckercfe45792019-07-03 16:13:00 +01002450
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002451/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002452 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002453 *
2454 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002455 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002456 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002457 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002458 *
2459 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
2460 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02002461 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002462 *
2463 * \note On some platforms, timing.c provides
2464 * \c mbedtls_timing_set_delay() and
2465 * \c mbedtls_timing_get_delay() that are suitable for using
2466 * here, except if using an event-driven style.
2467 *
2468 * \note See also the "DTLS tutorial" article in our knowledge base.
Dave Rodgmanb3196842022-10-12 16:47:08 +01002469 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002470 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002471void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
2472 void *p_timer,
2473 mbedtls_ssl_set_timer_t *f_set_timer,
2474 mbedtls_ssl_get_timer_t *f_get_timer);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002475
Glenn Strauss2ed95272022-01-21 18:02:17 -05002476#if defined(MBEDTLS_SSL_SRV_C)
2477/**
2478 * \brief Set the certificate selection callback (server-side only).
2479 *
2480 * If set, the callback is always called for each handshake,
2481 * after `ClientHello` processing has finished.
2482 *
Glenn Strauss2ed95272022-01-21 18:02:17 -05002483 * \param conf The SSL configuration to register the callback with.
2484 * \param f_cert_cb The callback for selecting server certificate after
2485 * `ClientHello` processing has finished.
2486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002487static inline void mbedtls_ssl_conf_cert_cb(mbedtls_ssl_config *conf,
2488 mbedtls_ssl_hs_cb_t f_cert_cb)
Glenn Strauss236e17e2022-03-13 23:39:40 -04002489{
2490 conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb;
2491}
Glenn Strauss2ed95272022-01-21 18:02:17 -05002492#endif /* MBEDTLS_SSL_SRV_C */
2493
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002494/**
2495 * \brief Callback type: generate and write session ticket
2496 *
2497 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002498 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002499 * authenticated ticket for the session and write it to the
2500 * output buffer. Here, ticket means the opaque ticket part
2501 * of the NewSessionTicket structure of RFC 5077.
2502 *
2503 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002504 * \param session SSL session to be written in the ticket
2505 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002506 * \param end End of the output buffer
2507 * \param tlen On exit, holds the length written
2508 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2509 *
2510 * \return 0 if successful, or
2511 * a specific MBEDTLS_ERR_XXX code.
2512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513typedef int mbedtls_ssl_ticket_write_t(void *p_ticket,
2514 const mbedtls_ssl_session *session,
2515 unsigned char *start,
2516 const unsigned char *end,
2517 size_t *tlen,
2518 uint32_t *lifetime);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002519
2520/**
2521 * \brief Callback type: parse and load session ticket
2522 *
2523 * \note This describes what a callback implementation should do.
2524 * This callback should parse a session ticket as generated
2525 * by the corresponding mbedtls_ssl_ticket_write_t function,
2526 * and, if the ticket is authentic and valid, load the
2527 * session.
2528 *
2529 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002530 * bytes of the input buffer, eg to use it as a temporary
2531 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002532 *
2533 * \param p_ticket Context for the callback
2534 * \param session SSL session to be loaded
2535 * \param buf Start of the buffer containing the ticket
2536 * \param len Length of the ticket.
2537 *
2538 * \return 0 if successful, or
2539 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2540 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2541 * any other non-zero code for other failures.
2542 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002543typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket,
2544 mbedtls_ssl_session *session,
2545 unsigned char *buf,
2546 size_t len);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002547
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002548#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002549/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002550 * \brief Configure SSL session ticket callbacks (server only).
2551 * (Default: none.)
2552 *
2553 * \note On server, session tickets are enabled by providing
2554 * non-NULL callbacks.
2555 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002556 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002557 *
2558 * \param conf SSL configuration context
2559 * \param f_ticket_write Callback for writing a ticket
2560 * \param f_ticket_parse Callback for parsing a ticket
2561 * \param p_ticket Context shared by the two callbacks
2562 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002563void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2564 mbedtls_ssl_ticket_write_t *f_ticket_write,
2565 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2566 void *p_ticket);
Ronald Cron3c0072b2023-11-22 10:00:14 +01002567
2568#if defined(MBEDTLS_HAVE_TIME)
2569/**
2570 * \brief Get the creation time of a session ticket.
2571 *
2572 * \note See the documentation of \c ticket_creation_time for information about
2573 * the intended usage of this function.
2574 *
2575 * \param session SSL session
2576 * \param ticket_creation_time On exit, holds the ticket creation time in
2577 * milliseconds.
2578 *
2579 * \return 0 on success,
Felix Conway37ede2c2025-08-18 14:46:39 +01002580 * #PSA_ERROR_INVALID_ARGUMENT if an input is not valid.
Ronald Cron3c0072b2023-11-22 10:00:14 +01002581 */
2582static inline int mbedtls_ssl_session_get_ticket_creation_time(
2583 mbedtls_ssl_session *session, mbedtls_ms_time_t *ticket_creation_time)
2584{
2585 if (session == NULL || ticket_creation_time == NULL ||
2586 session->MBEDTLS_PRIVATE(endpoint) != MBEDTLS_SSL_IS_SERVER) {
Felix Conway37ede2c2025-08-18 14:46:39 +01002587 return PSA_ERROR_INVALID_ARGUMENT;
Ronald Cron3c0072b2023-11-22 10:00:14 +01002588 }
2589
2590 *ticket_creation_time = session->MBEDTLS_PRIVATE(ticket_creation_time);
2591
2592 return 0;
2593}
2594#endif /* MBEDTLS_HAVE_TIME */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002595#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002596
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002597/**
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002598 * \brief Get the session-id buffer.
2599 *
2600 * \param session SSL session.
2601 *
2602 * \return The address of the session-id buffer.
2603 */
Minos Galanakis358b4482024-03-04 02:19:31 +00002604static inline unsigned const char (*mbedtls_ssl_session_get_id(const mbedtls_ssl_session *
2605 session))[32]
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002606{
2607 return &session->MBEDTLS_PRIVATE(id);
2608}
2609
2610/**
2611 * \brief Get the size of the session-id.
2612 *
2613 * \param session SSL session.
2614 *
2615 * \return size_t size of session-id buffer.
2616 */
Minos Galanakis358b4482024-03-04 02:19:31 +00002617static inline size_t mbedtls_ssl_session_get_id_len(const mbedtls_ssl_session *session)
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002618{
2619 return session->MBEDTLS_PRIVATE(id_len);
2620}
2621
2622/**
Minos Galanakis40d47082024-03-04 15:24:51 +00002623 * \brief Get the ciphersuite-id.
2624 *
2625 * \param session SSL session.
2626 *
2627 * \return int represetation for ciphersuite.
2628 */
2629static inline int mbedtls_ssl_session_get_ciphersuite_id(const mbedtls_ssl_session *session)
2630{
2631 return session->MBEDTLS_PRIVATE(ciphersuite);
2632}
2633
2634/**
Hanno Becker457d6162021-05-24 10:27:39 +01002635 * \brief Configure a key export callback.
2636 * (Default: none.)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002637 *
Hanno Becker457d6162021-05-24 10:27:39 +01002638 * This API can be used for two purposes:
2639 * - Debugging: Use this API to e.g. generate an NSSKeylog
2640 * file and use it to inspect encrypted traffic in tools
2641 * such as Wireshark.
2642 * - Application-specific export: Use this API to implement
2643 * key exporters, e.g. for EAP-TLS or DTLS-SRTP.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002644 *
Hanno Becker457d6162021-05-24 10:27:39 +01002645 *
Hanno Becker7e6c1782021-06-08 09:24:55 +01002646 * \param ssl The SSL context to which the export
2647 * callback should be attached.
Hanno Becker457d6162021-05-24 10:27:39 +01002648 * \param f_export_keys The callback for the key export.
2649 * \param p_export_keys The opaque context pointer to be passed to the
2650 * callback \p f_export_keys.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002651 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002652void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2653 mbedtls_ssl_export_keys_t *f_export_keys,
2654 void *p_export_keys);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002655
Gilles Peskine80dae042022-01-21 23:50:39 +01002656/** \brief Set the user data in an SSL configuration to a pointer.
2657 *
2658 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_p().
2659 *
2660 * \note The library stores \c p without accessing it. It is the responsibility
2661 * of the caller to ensure that the pointer remains valid.
2662 *
2663 * \param conf The SSL configuration context to modify.
2664 * \param p The new value of the user data.
2665 */
2666static inline void mbedtls_ssl_conf_set_user_data_p(
2667 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002669{
Gilles Peskineded2a422022-02-12 00:20:08 +01002670 conf->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002671}
2672
2673/** \brief Set the user data in an SSL configuration to an integer.
2674 *
2675 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_n().
2676 *
2677 * \param conf The SSL configuration context to modify.
2678 * \param n The new value of the user data.
2679 */
2680static inline void mbedtls_ssl_conf_set_user_data_n(
2681 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002683{
Gilles Peskineded2a422022-02-12 00:20:08 +01002684 conf->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002685}
2686
2687/** \brief Retrieve the user data in an SSL configuration as a pointer.
2688 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002689 * This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or
2690 * \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been
2691 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has
2692 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002693 *
2694 * \param conf The SSL configuration context to modify.
2695 * \return The current value of the user data.
2696 */
2697static inline void *mbedtls_ssl_conf_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002699{
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return conf->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002701}
2702
2703/** \brief Retrieve the user data in an SSL configuration as an integer.
2704 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002705 * This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or
2706 * \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been
2707 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has
2708 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002709 *
2710 * \param conf The SSL configuration context to modify.
2711 * \return The current value of the user data.
2712 */
2713static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002714 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002715{
Gilles Peskine449bd832023-01-11 14:50:10 +01002716 return conf->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002717}
2718
2719/** \brief Set the user data in an SSL context to a pointer.
2720 *
2721 * You can retrieve this value later with mbedtls_ssl_get_user_data_p().
2722 *
2723 * \note The library stores \c p without accessing it. It is the responsibility
2724 * of the caller to ensure that the pointer remains valid.
2725 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002726 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002727 * \param p The new value of the user data.
2728 */
2729static inline void mbedtls_ssl_set_user_data_p(
2730 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002732{
Gilles Peskineded2a422022-02-12 00:20:08 +01002733 ssl->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002734}
2735
2736/** \brief Set the user data in an SSL context to an integer.
2737 *
2738 * You can retrieve this value later with mbedtls_ssl_get_user_data_n().
2739 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002740 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002741 * \param n The new value of the user data.
2742 */
2743static inline void mbedtls_ssl_set_user_data_n(
2744 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002746{
Gilles Peskineded2a422022-02-12 00:20:08 +01002747 ssl->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002748}
2749
2750/** \brief Retrieve the user data in an SSL context as a pointer.
2751 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002752 * This is the value last set with mbedtls_ssl_set_user_data_p(), or
2753 * \c NULL if mbedtls_ssl_set_user_data_p() has not previously been
2754 * called. The value is undefined if mbedtls_ssl_set_user_data_n() has
2755 * been called without a subsequent call to mbedtls_ssl_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002756 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002757 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002758 * \return The current value of the user data.
2759 */
2760static inline void *mbedtls_ssl_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002761 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002762{
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 return ssl->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002764}
2765
2766/** \brief Retrieve the user data in an SSL context as an integer.
2767 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002768 * This is the value last set with mbedtls_ssl_set_user_data_n(), or
2769 * \c 0 if mbedtls_ssl_set_user_data_n() has not previously been
2770 * called. The value is undefined if mbedtls_ssl_set_user_data_p() has
2771 * been called without a subsequent call to mbedtls_ssl_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002772 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002773 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002774 * \return The current value of the user data.
2775 */
2776static inline uintptr_t mbedtls_ssl_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002778{
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 return ssl->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002780}
2781
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002782#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002783/**
2784 * \brief Configure asynchronous private key operation callbacks.
2785 *
2786 * \param conf SSL configuration context
2787 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002788 * the description of ::mbedtls_ssl_async_sign_t
2789 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002790 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002791 * operation; in this case the private key object
2792 * associated with the certificate will be used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002793 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002794 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002795 * for more information. This may not be \c NULL unless
Gabor Mezeie99e5912025-02-27 13:41:24 +01002796 * \p f_async_sign is \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002797 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002798 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002799 * for more information. This may be \c NULL if
2800 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002801 * \param config_data A pointer to configuration data which can be
2802 * retrieved with
2803 * mbedtls_ssl_conf_get_async_config_data(). The
2804 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002805 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002806void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf,
2807 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 mbedtls_ssl_async_resume_t *f_async_resume,
2809 mbedtls_ssl_async_cancel_t *f_async_cancel,
2810 void *config_data);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002811
2812/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002813 * \brief Retrieve the configuration data set by
2814 * mbedtls_ssl_conf_async_private_cb().
2815 *
2816 * \param conf SSL configuration context
2817 * \return The configuration data set by
2818 * mbedtls_ssl_conf_async_private_cb().
2819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002820void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf);
Gilles Peskine8f97af72018-04-26 11:46:10 +02002821
2822/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002823 * \brief Retrieve the asynchronous operation user context.
2824 *
2825 * \note This function may only be called while a handshake
2826 * is in progress.
2827 *
2828 * \param ssl The SSL context to access.
2829 *
2830 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002831 * set during the current handshake. If
2832 * mbedtls_ssl_set_async_operation_data() has not yet been
2833 * called during the current handshake, this function returns
2834 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002835 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002836void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002837
2838/**
2839 * \brief Retrieve the asynchronous operation user context.
2840 *
2841 * \note This function may only be called while a handshake
2842 * is in progress.
2843 *
2844 * \param ssl The SSL context to access.
2845 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002846 * Call mbedtls_ssl_get_async_operation_data() later during the
2847 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002849void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2850 void *ctx);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002851#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002852
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002853/**
2854 * \brief Callback type: generate a cookie
2855 *
2856 * \param ctx Context for the callback
2857 * \param p Buffer to write to,
2858 * must be updated to point right after the cookie
2859 * \param end Pointer to one past the end of the output buffer
2860 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002861 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002862 * \param ilen Length of info in bytes
2863 *
2864 * \return The callback must return 0 on success,
2865 * or a negative error code.
2866 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002867typedef int mbedtls_ssl_cookie_write_t(void *ctx,
2868 unsigned char **p, unsigned char *end,
2869 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002870
2871/**
2872 * \brief Callback type: verify a cookie
2873 *
2874 * \param ctx Context for the callback
2875 * \param cookie Cookie to verify
2876 * \param clen Length of cookie
2877 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002878 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002879 * \param ilen Length of info in bytes
2880 *
2881 * \return The callback must return 0 if cookie is valid,
2882 * or a negative error code.
2883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002884typedef int mbedtls_ssl_cookie_check_t(void *ctx,
2885 const unsigned char *cookie, size_t clen,
2886 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002887
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002888#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002889/**
2890 * \brief Register callbacks for DTLS cookies
2891 * (Server only. DTLS only.)
2892 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002893 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002894 * register working callbacks (and initialize their context).
2895 *
2896 * To disable HelloVerifyRequest, register NULL callbacks.
2897 *
2898 * \warning Disabling hello verification allows your server to be used
2899 * for amplification in DoS attacks against other hosts.
2900 * Only disable if you known this can't happen in your
2901 * particular environment.
2902 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002903 * \note See comments on \c mbedtls_ssl_handshake() about handling
2904 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2905 * on the first handshake attempt when this is enabled.
2906 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002907 * \note This is also necessary to handle client reconnection from
2908 * the same port as described in RFC 6347 section 4.2.8 (only
2909 * the variant with cookies is supported currently). See
2910 * comments on \c mbedtls_ssl_read() for details.
2911 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002912 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002913 * \param f_cookie_write Cookie write callback
2914 * \param f_cookie_check Cookie check callback
2915 * \param p_cookie Context for both callbacks
2916 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002917void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf,
2918 mbedtls_ssl_cookie_write_t *f_cookie_write,
2919 mbedtls_ssl_cookie_check_t *f_cookie_check,
2920 void *p_cookie);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002921
2922/**
2923 * \brief Set client's transport-level identification info.
2924 * (Server only. DTLS only.)
2925 *
2926 * This is usually the IP address (and port), but could be
2927 * anything identify the client depending on the underlying
2928 * network stack. Used for HelloVerifyRequest with DTLS.
2929 * This is *not* used to route the actual packets.
2930 *
2931 * \param ssl SSL context
2932 * \param info Transport-level info identifying the client (eg IP + port)
2933 * \param ilen Length of info in bytes
2934 *
2935 * \note An internal copy is made, so the info buffer can be reused.
2936 *
2937 * \return 0 on success,
Felix Conway37ede2c2025-08-18 14:46:39 +01002938 * #PSA_ERROR_INVALID_ARGUMENT if used on client,
2939 * #PSA_ERROR_INSUFFICIENT_MEMORY if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002940 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002941int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl,
2942 const unsigned char *info,
2943 size_t ilen);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002944
2945#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002947#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002948/**
2949 * \brief Enable or disable anti-replay protection for DTLS.
2950 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002951 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002952 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002953 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002954 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002955 *
2956 * \warning Disabling this is a security risk unless the application
2957 * protocol handles duplicated packets in a safe way. You
2958 * should not disable this without careful consideration.
2959 * However, if your application already detects duplicated
2960 * packets and needs information about them to adjust its
2961 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002962 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002963void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002965
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002966/**
2967 * \brief Set a limit on the number of records with a bad MAC
2968 * before terminating the connection.
2969 * (DTLS only, no effect on TLS.)
2970 * Default: 0 (disabled).
2971 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002972 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002973 * \param limit Limit, or 0 to disable.
2974 *
2975 * \note If the limit is N, then the connection is terminated when
2976 * the Nth non-authentic record is seen.
2977 *
2978 * \note Records with an invalid header are not counted, only the
2979 * ones going through the authentication-decryption phase.
2980 *
2981 * \note This is a security trade-off related to the fact that it's
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002982 * often relatively easy for an active attacker to inject UDP
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002983 * datagrams. On one hand, setting a low limit here makes it
2984 * easier for such an attacker to forcibly terminated a
2985 * connection. On the other hand, a high limit or no limit
2986 * might make us waste resources checking authentication on
2987 * many bogus packets.
2988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002989void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit);
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002992
2993/**
2994 * \brief Allow or disallow packing of multiple handshake records
2995 * within a single datagram.
2996 *
2997 * \param ssl The SSL context to configure.
2998 * \param allow_packing This determines whether datagram packing may
2999 * be used or not. A value of \c 0 means that every
3000 * record will be sent in a separate datagram; a
3001 * value of \c 1 means that, if space permits,
3002 * multiple handshake messages (including CCS) belonging to
3003 * a single flight may be packed within a single datagram.
3004 *
3005 * \note This is enabled by default and should only be disabled
3006 * for test purposes, or if datagram packing causes
3007 * interoperability issues with peers that don't support it.
3008 *
3009 * \note Allowing datagram packing reduces the network load since
3010 * there's less overhead if multiple messages share the same
3011 * datagram. Also, it increases the handshake efficiency
3012 * since messages belonging to a single datagram will not
3013 * be reordered in transit, and so future message buffering
3014 * or flight retransmission (if no buffering is used) as
3015 * means to deal with reordering are needed less frequently.
3016 *
Hanno Beckereb570082018-08-24 11:28:35 +01003017 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01003018 * are currently always sent in separate datagrams.
3019 *
3020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
3022 unsigned allow_packing);
Hanno Becker04da1892018-08-14 13:22:10 +01003023
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003024/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00003025 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003026 * (DTLS only, no effect on TLS.)
3027 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003028 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003029 * \param min Initial timeout value in milliseconds.
3030 * Default: 1000 (1 second).
3031 * \param max Maximum timeout value in milliseconds.
3032 * Default: 60000 (60 seconds).
3033 *
3034 * \note Default values are from RFC 6347 section 4.2.4.1.
3035 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01003036 * \note The 'min' value should typically be slightly above the
3037 * expected round-trip time to your peer, plus whatever time
3038 * it takes for the peer to process the message. For example,
3039 * if your RTT is about 600ms and you peer needs up to 1s to
3040 * do the cryptographic operations in the handshake, then you
3041 * should set 'min' slightly above 1600. Lower values of 'min'
3042 * might cause spurious resends which waste network resources,
3043 * while larger value of 'min' will increase overall latency
3044 * on unreliable network links.
3045 *
3046 * \note The more unreliable your network connection is, the larger
3047 * your max / min ratio needs to be in order to achieve
3048 * reliable handshakes.
3049 *
3050 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
3051 * For example, if min = 1s and max = 5s, the retransmit plan
3052 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
3053 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003055void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003056#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003057
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01003058#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003059/**
Paul Bakker0a597072012-09-25 21:55:46 +00003060 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01003061 * If not set, no session resuming is done (except if session
3062 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00003063 *
Paul Bakker0a597072012-09-25 21:55:46 +00003064 * The session cache has the responsibility to check for stale
3065 * entries based on timeout. See RFC 5246 for recommendations.
3066 *
3067 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
3068 * connection shutdown, so do not cache the pointer! Either set
3069 * it to NULL or make a full copy of the certificate.
3070 *
3071 * The get callback is called once during the initial handshake
3072 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00003074 * If a valid entry is found, it should fill the master of
3075 * the session object with the cached values and return 0,
3076 * return 1 otherwise. Optionally peer_cert can be set as well
3077 * if it is properly present in cache entry.
3078 *
3079 * The set callback is called once during the initial handshake
3080 * to enable session resuming after the entire handshake has
3081 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00003083 * should create a cache entry for future retrieval based on
3084 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003085 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00003086 * data) is cleared by the SSL/TLS layer when the connection is
3087 * terminated. It is recommended to add metadata to determine if
3088 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00003089 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00003090 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003091 * \param conf SSL configuration
Tom Cosgrove1e211442022-05-26 11:51:00 +01003092 * \param p_cache parameter (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00003093 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00003094 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00003095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003096void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
3097 void *p_cache,
3098 mbedtls_ssl_cache_get_t *f_get_cache,
3099 mbedtls_ssl_cache_set_t *f_set_cache);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003100#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003101
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003102#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003103/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003104 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00003105 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003106 * Sessions loaded through this call will be considered
3107 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003108 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003109 * \note Even if this call succeeds, it is not guaranteed that
3110 * the next handshake will indeed be shortened through the
3111 * use of session resumption: The server is always free
3112 * to reject any attempt for resumption and fall back to
3113 * a full handshake.
3114 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003115 * \note This function can handle a variety of mechanisms for session
Ronald Crond85eeae2024-04-04 10:34:21 +02003116 * resumption: For TLS 1.2, both session ID-based resumption
3117 * and ticket-based resumption will be considered. For TLS 1.3,
3118 * sessions equate to tickets, and loading one session by
3119 * calling this function will lead to its corresponding ticket
Ronald Cronfe15d902024-04-04 13:40:11 +02003120 * being advertised as resumption PSK by the client. This
3121 * depends on session tickets being enabled (see
3122 * #MBEDTLS_SSL_SESSION_TICKETS configuration option) though.
3123 * If session tickets are disabled, a call to this function
3124 * with a TLS 1.3 session, will not have any effect on the next
3125 * handshake for the SSL context \p ssl.
Hanno Beckere810bbc2021-05-14 16:01:05 +01003126 *
3127 * \param ssl The SSL context representing the connection which should
3128 * be attempted to be setup using session resumption. This
3129 * must be initialized via mbedtls_ssl_init() and bound to
3130 * an SSL configuration via mbedtls_ssl_setup(), but
3131 * the handshake must not yet have been started.
3132 * \param session The session to be considered for session resumption.
3133 * This must be a session previously exported via
3134 * mbedtls_ssl_get_session(), and potentially serialized and
3135 * deserialized through mbedtls_ssl_session_save() and
3136 * mbedtls_ssl_session_load() in the meantime.
3137 *
3138 * \return \c 0 if successful.
3139 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
Ronald Crond85eeae2024-04-04 10:34:21 +02003140 * could not be loaded because one session has already been
3141 * loaded. This error is non-fatal, and has no observable
3142 * effect on the SSL context or the session that was attempted
3143 * to be loaded.
Hanno Beckere810bbc2021-05-14 16:01:05 +01003144 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003145 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003146 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003147 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00003148 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003149int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003151
3152/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003153 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003154 * On client, this can be used for loading saved sessions
Tom Cosgrove1e211442022-05-26 11:51:00 +01003155 * before resuming them with mbedtls_ssl_set_session().
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003156 * On server, this can be used for alternative implementations
3157 * of session cache or session tickets.
3158 *
3159 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003160 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003161 * end-entity certificate and the result of the chain
3162 * verification (unless verification was disabled), but not
3163 * the rest of the chain.
3164 *
3165 * \see mbedtls_ssl_session_save()
3166 * \see mbedtls_ssl_set_session()
3167 *
3168 * \param session The session structure to be populated. It must have been
3169 * initialised with mbedtls_ssl_session_init() but not
3170 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003171 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003172 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003173 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003174 *
3175 * \return \c 0 if successful.
Felix Conway37ede2c2025-08-18 14:46:39 +01003176 * \return #PSA_ERROR_INSUFFICIENT_MEMORY if memory allocation failed.
3177 * \return #PSA_ERROR_INVALID_ARGUMENT if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01003178 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
3179 * was generated in a different version or configuration of
3180 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02003181 * \return Another negative value for other kinds of errors (for
3182 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003183 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003184int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3185 const unsigned char *buf,
3186 size_t len);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003187
3188/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003189 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003190 * On client, this can be used for saving session data,
3191 * potentially in non-volatile storage, for resuming later.
3192 * On server, this can be used for alternative implementations
3193 * of session cache or session tickets.
3194 *
3195 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003196 *
3197 * \param session The session structure to be saved.
3198 * \param buf The buffer to write the serialized data to. It must be a
Andrzej Kurek377eb5f2023-05-06 09:57:40 -04003199 * writeable buffer of at least \p buf_len bytes, or may be \c
3200 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003201 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003202 * \param olen The size in bytes of the data that has been or would have
3203 * been written. It must point to a valid \c size_t.
3204 *
3205 * \note \p olen is updated to the correct value regardless of
3206 * whether \p buf_len was large enough. This makes it possible
3207 * to determine the necessary size by calling this function
3208 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003209 *
Ronald Cron9314df62024-04-04 09:53:07 +02003210 * \note For TLS 1.3 sessions, this feature is supported only if the
3211 * MBEDTLS_SSL_SESSION_TICKETS configuration option is enabled,
3212 * as in TLS 1.3 session resumption is possible only with
3213 * tickets.
3214 *
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003215 * \return \c 0 if successful.
Felix Conway37ede2c2025-08-18 14:46:39 +01003216 * \return #PSA_ERROR_BUFFER_TOO_SMALL if \p buf is too small.
Ronald Cron9314df62024-04-04 09:53:07 +02003217 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the
3218 * MBEDTLS_SSL_SESSION_TICKETS configuration option is disabled
3219 * and the session is a TLS 1.3 session.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003220 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003221int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3222 unsigned char *buf,
3223 size_t buf_len,
3224 size_t *olen);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003225
3226/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003227 * \brief Set the list of allowed ciphersuites and the preference
3228 * order. First in the list has the highest preference.
Paul Bakker5121ce52009-01-03 21:22:43 +00003229 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003230 * For TLS 1.2, the notion of ciphersuite determines both
3231 * the key exchange mechanism and the suite of symmetric
3232 * algorithms to be used during and after the handshake.
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003233 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003234 * For TLS 1.3 (in development), the notion of ciphersuite
Hanno Becker674f9482021-08-02 21:21:19 +01003235 * only determines the suite of symmetric algorithms to be
Hanno Beckere486b2d2021-07-23 19:24:30 +01003236 * used during and after the handshake, while key exchange
3237 * mechanisms are configured separately.
3238 *
3239 * In Mbed TLS, ciphersuites for both TLS 1.2 and TLS 1.3
3240 * are configured via this function. For users of TLS 1.3,
3241 * there will be separate API for the configuration of key
3242 * exchange mechanisms.
3243 *
3244 * The list of ciphersuites passed to this function may
3245 * contain a mixture of TLS 1.2 and TLS 1.3 ciphersuite
3246 * identifiers. This is useful if negotiation of TLS 1.3
3247 * should be attempted, but a fallback to TLS 1.2 would
3248 * be tolerated.
3249 *
3250 * \note By default, the server chooses its preferred
TRodziewicz3946f792021-06-14 12:11:18 +02003251 * ciphersuite among those that the client supports. If
3252 * mbedtls_ssl_conf_preference_order() is called to prefer
3253 * the client's preferences, the server instead chooses
3254 * the client's preferred ciphersuite among those that
3255 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003256 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003257 * \warning The ciphersuites array \p ciphersuites is not copied.
Jerry Yucadebe52021-08-24 10:36:45 +08003258 * It must remain valid for the lifetime of the SSL
Hanno Beckere486b2d2021-07-23 19:24:30 +01003259 * configuration \p conf.
3260 *
3261 * \param conf The SSL configuration to modify.
3262 * \param ciphersuites A 0-terminated list of IANA identifiers of supported
3263 * ciphersuites, accessible through \c MBEDTLS_TLS_XXX
3264 * and \c MBEDTLS_TLS1_3_XXX macros defined in
3265 * ssl_ciphersuites.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003267void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
3268 const int *ciphersuites);
Paul Bakker5121ce52009-01-03 21:22:43 +00003269
Ronald Cron6f135e12021-12-08 16:57:54 +01003270#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01003271/**
3272 * \brief Set the supported key exchange modes for TLS 1.3 connections.
3273 *
3274 * In contrast to TLS 1.2, the ciphersuite concept in TLS 1.3 does not
3275 * include the choice of key exchange mechanism. It is therefore not
3276 * covered by the API mbedtls_ssl_conf_ciphersuites(). See the
3277 * documentation of mbedtls_ssl_conf_ciphersuites() for more
3278 * information on the ciphersuite concept in TLS 1.2 and TLS 1.3.
3279 *
3280 * The present function is specific to TLS 1.3 and allows users to
3281 * configure the set of supported key exchange mechanisms in TLS 1.3.
3282 *
3283 * \param conf The SSL configuration the change should apply to.
3284 * \param kex_modes A bitwise combination of one or more of the following:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003285 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK
Hanno Becker71f1ed62021-07-24 06:01:47 +01003286 * This flag enables pure-PSK key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003287 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003288 * This flag enables combined PSK-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003289 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003290 * This flag enables pure-ephemeral key exchanges.
3291 * For convenience, the following pre-defined macros are
3292 * available for combinations of the above:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003293 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003294 * Includes all of pure-PSK, PSK-ephemeral and pure-ephemeral.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003295 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003296 * Includes both pure-PSK and combined PSK-ephemeral
3297 * key exchanges, but excludes pure-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003298 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003299 * Includes both pure-ephemeral and combined PSK-ephemeral
3300 * key exchanges.
3301 *
3302 * \note If a PSK-based key exchange mode shall be supported, applications
3303 * must also use the APIs mbedtls_ssl_conf_psk() or
3304 * mbedtls_ssl_conf_psk_cb() or mbedtls_ssl_conf_psk_opaque()
3305 * to configure the PSKs to be used.
3306 *
Hanno Becker5d045a82021-08-02 21:21:30 +01003307 * \note If a pure-ephemeral key exchange mode shall be supported,
Hanno Becker71f1ed62021-07-24 06:01:47 +01003308 * server-side applications must also provide a certificate via
3309 * mbedtls_ssl_conf_own_cert().
3310 *
3311 */
3312
Gilles Peskine449bd832023-01-11 14:50:10 +01003313void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
3314 const int kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01003315#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00003316
Hanno Beckera0e20d02019-05-15 14:03:01 +01003317#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01003318#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
3319#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01003320/**
Hanno Becker11259522019-05-23 16:55:50 +01003321 * \brief Specify the length of Connection IDs for incoming
3322 * encrypted DTLS records, as well as the behaviour
3323 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01003324 *
3325 * By default, the CID length is set to \c 0,
3326 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003327 *
3328 * \param conf The SSL configuration to modify.
3329 * \param len The length in Bytes of the CID fields in encrypted
3330 * DTLS records using the CID mechanism. This must
3331 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01003332 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01003333 * receiving a record with an unexpected CID.
3334 * Possible values are:
3335 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
3336 * In this case, the record is silently ignored.
3337 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
3338 * In this case, the stack fails with the specific
3339 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003340 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01003341 * \note The CID specification allows implementations to either
3342 * use a common length for all incoming connection IDs or
3343 * allow variable-length incoming IDs. Mbed TLS currently
3344 * requires a common length for all connections sharing the
3345 * same SSL configuration; this allows simpler parsing of
3346 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003347 *
3348 * \return \c 0 on success.
Felix Conway37ede2c2025-08-18 14:46:39 +01003349 * \return #PSA_ERROR_INVALID_ARGUMENT if \p len
Hanno Beckerad4a1372019-05-03 13:06:44 +01003350 * is too large.
3351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003352int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len,
3353 int ignore_other_cids);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003354#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01003355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003356#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02003357/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003358 * \brief Set the X.509 security profile used for verification
3359 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003360 * \note The restrictions are enforced for all certificates in the
3361 * chain. However, signatures in the handshake are not covered
Ben Taylor9ff2b732025-08-05 08:17:13 +01003362 * by this setting but by \b mbedtls_ssl_conf_sig_algs().
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003363 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003364 * \param conf SSL configuration
3365 * \param profile Profile to use
3366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003367void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
3368 const mbedtls_x509_crt_profile *profile);
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003369
3370/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003371 * \brief Set the data required to verify peer certificate
3372 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02003373 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02003374 * parameters ca_chain (maps to trust_ca for that function)
3375 * and ca_crl.
3376 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003377 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003378 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00003379 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00003380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003381void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003382 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01003383 mbedtls_x509_crl *ca_crl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003384
Glenn Strauss999ef702022-03-11 01:37:23 -05003385#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3386/**
3387 * \brief Set DN hints sent to client in CertificateRequest message
3388 *
3389 * \note If not set, subject distinguished names (DNs) are taken
3390 * from \c mbedtls_ssl_conf_ca_chain()
3391 * or \c mbedtls_ssl_set_hs_ca_chain())
3392 *
3393 * \param conf SSL configuration
3394 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3395 * from which the client should select client peer certificate.
3396 */
3397static inline
Gilles Peskine449bd832023-01-11 14:50:10 +01003398void mbedtls_ssl_conf_dn_hints(mbedtls_ssl_config *conf,
3399 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05003400{
3401 conf->MBEDTLS_PRIVATE(dn_hints) = crt;
3402}
3403#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3404
Hanno Becker8bf74f32019-03-27 11:01:30 +00003405#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3406/**
3407 * \brief Set the trusted certificate callback.
3408 *
3409 * This API allows to register the set of trusted certificates
3410 * through a callback, instead of a linked list as configured
3411 * by mbedtls_ssl_conf_ca_chain().
3412 *
3413 * This is useful for example in contexts where a large number
3414 * of CAs are used, and the inefficiency of maintaining them
3415 * in a linked list cannot be tolerated. It is also useful when
3416 * the set of trusted CAs needs to be modified frequently.
3417 *
3418 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
3419 * more information.
3420 *
3421 * \param conf The SSL configuration to register the callback with.
3422 * \param f_ca_cb The trusted certificate callback to use when verifying
3423 * certificate chains.
3424 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
3425 * a reference to a trusted CA database).
3426 *
3427 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
3428 * Any call to this function overwrites the values set through
3429 * earlier calls to mbedtls_ssl_conf_ca_chain() or
3430 * mbedtls_ssl_conf_ca_cb().
3431 *
3432 * \note This API is incompatible with CA indication in
3433 * CertificateRequest messages: A server-side SSL context which
3434 * is bound to an SSL configuration that uses a CA callback
3435 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
3436 * client authentication, will send an empty CA list in the
3437 * corresponding CertificateRequest message.
3438 *
3439 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
3440 * If an SSL context is bound to an SSL configuration which uses
3441 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
3442 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
3443 *
3444 * \note The use of this API disables the use of restartable ECC
3445 * during X.509 CRT signature verification (but doesn't affect
3446 * other uses).
3447 *
3448 * \warning This API is incompatible with the use of CRLs. Any call to
3449 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
3450 * earlier calls to mbedtls_ssl_conf_ca_chain().
3451 *
3452 * \warning In multi-threaded environments, the callback \p f_ca_cb
3453 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01003454 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00003455 * contained in the callback context pointed to by \p p_ca_cb).
3456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003457void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
3458 mbedtls_x509_crt_ca_cb_t f_ca_cb,
3459 void *p_ca_cb);
Hanno Becker8bf74f32019-03-27 11:01:30 +00003460#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
3461
Paul Bakker5121ce52009-01-03 21:22:43 +00003462/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003463 * \brief Set own certificate chain and private key
3464 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003465 * \note own_cert should contain in order from the bottom up your
3466 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003467 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00003468 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003469 * \note On server, this function can be called multiple times to
3470 * provision more than one cert/key pair (eg one ECDSA, one
3471 * RSA with SHA-256, one RSA with SHA-1). An adequate
3472 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01003473 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003474 * adequate, preference is given to the one set by the first
3475 * call to this function, then second, etc.
3476 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003477 * \note On client, only the first call has any effect. That is,
3478 * only one client certificate can be provisioned. The
bootstrap-prime6dbbf442022-05-17 19:30:44 -04003479 * server's preferences in its CertificateRequest message will
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003480 * be ignored and our only cert will be sent regardless of
3481 * whether it matches those preferences - the server can then
3482 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003483 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003484 * \note The provided \p pk_key needs to match the public key in the
3485 * first certificate in \p own_cert, or all handshakes using
3486 * that certificate will fail. It is your responsibility
3487 * to ensure that; this function will not perform any check.
3488 * You may use mbedtls_pk_check_pair() in order to perform
3489 * this check yourself, but be aware that this function can
3490 * be computationally expensive on some key types.
3491 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02003492 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003493 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02003494 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003495 *
Felix Conway37ede2c2025-08-18 14:46:39 +01003496 * \return 0 on success or #PSA_ERROR_INSUFFICIENT_MEMORY
Paul Bakker5121ce52009-01-03 21:22:43 +00003497 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003498int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003499 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01003500 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003501#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00003502
Ronald Cron73fe8df2022-10-05 14:31:43 +02003503#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003504/**
Hanno Becker196739b2021-05-28 05:25:46 +01003505 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01003506 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003507 *
Hanno Becker196739b2021-05-28 05:25:46 +01003508 * Only one PSK can be registered, through either
3509 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3510 * If you attempt to register more than one PSK, this function
3511 * fails, though this may change in future versions, which
3512 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003513 *
3514 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003515 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003516 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003517 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
3518 * takes precedence over a PSK configured by this function.
3519 *
Hanno Becker02283042018-10-22 15:28:02 +01003520 * \param conf The SSL configuration to register the PSK with.
3521 * \param psk The pointer to the pre-shared key to use.
3522 * \param psk_len The length of the pre-shared key in bytes.
3523 * \param psk_identity The pointer to the pre-shared key identity.
3524 * \param psk_identity_len The length of the pre-shared key identity
3525 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02003526 *
Hanno Becker02283042018-10-22 15:28:02 +01003527 * \note The PSK and its identity are copied internally and
3528 * hence need not be preserved by the caller for the lifetime
3529 * of the SSL configuration.
3530 *
3531 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003532 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003533 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003534 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003535 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003536int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
3537 const unsigned char *psk, size_t psk_len,
3538 const unsigned char *psk_identity, size_t psk_identity_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003539
Hanno Becker02283042018-10-22 15:28:02 +01003540/**
Hanno Becker946c9252021-04-19 21:41:47 +01003541 * \brief Configure one or more opaque pre-shared keys (PSKs) and
3542 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01003543 *
Hanno Becker196739b2021-05-28 05:25:46 +01003544 * Only one PSK can be registered, through either
3545 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3546 * If you attempt to register more than one PSK, this function
3547 * fails, though this may change in future versions, which
3548 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01003549 *
3550 * \note This is mainly useful for clients. Servers will usually
3551 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
3552 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003553 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
3554 * the PSK callback takes precedence over an opaque PSK
3555 * configured by this function.
3556 *
Hanno Becker02283042018-10-22 15:28:02 +01003557 * \param conf The SSL configuration to register the PSK with.
3558 * \param psk The identifier of the key slot holding the PSK.
3559 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00003560 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05003561 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00003562 * allows its use for the key derivation algorithm applied
3563 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01003564 * \param psk_identity The pointer to the pre-shared key identity.
3565 * \param psk_identity_len The length of the pre-shared key identity
3566 * in bytes.
3567 *
3568 * \note The PSK identity hint is copied internally and hence need
3569 * not be preserved by the caller for the lifetime of the
3570 * SSL configuration.
3571 *
3572 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003573 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003574 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003575 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01003576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003577int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
3578 mbedtls_svc_key_id_t psk,
3579 const unsigned char *psk_identity,
3580 size_t psk_identity_len);
Paul Bakker6db455e2013-09-18 17:29:31 +02003581
3582/**
Hanno Becker02283042018-10-22 15:28:02 +01003583 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003584 *
3585 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01003586 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003587 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003588 * \note A PSK set by this function takes precedence over a PSK
3589 * configured by \c mbedtls_ssl_conf_psk().
3590 *
Hanno Becker02283042018-10-22 15:28:02 +01003591 * \param ssl The SSL context to configure a PSK for.
3592 * \param psk The pointer to the pre-shared key.
3593 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003594 *
Hanno Becker02283042018-10-22 15:28:02 +01003595 * \return \c 0 if successful.
3596 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003597 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003598int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
3599 const unsigned char *psk, size_t psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003600
Hanno Becker02283042018-10-22 15:28:02 +01003601/**
3602 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
3603 *
3604 * \note This should only be called inside the PSK callback,
3605 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
3606 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003607 * \note An opaque PSK set by this function takes precedence over an
3608 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
3609 *
Hanno Becker02283042018-10-22 15:28:02 +01003610 * \param ssl The SSL context to configure a PSK for.
3611 * \param psk The identifier of the key slot holding the PSK.
3612 * For the duration of the current handshake, the key slot
3613 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05003614 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01003615 * use for the key derivation algorithm
3616 * applied in the handshake.
Gilles Peskine449bd832023-01-11 14:50:10 +01003617 *
Hanno Becker02283042018-10-22 15:28:02 +01003618 * \return \c 0 if successful.
3619 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
3620 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003621int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
3622 mbedtls_svc_key_id_t psk);
Hanno Becker02283042018-10-22 15:28:02 +01003623
Jerry Yu8897c072022-08-12 13:56:53 +08003624#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003625/**
3626 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02003627 *
3628 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01003629 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01003630 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02003631 * receive the actual PSK data and length.
3632 *
Hanno Becker02283042018-10-22 15:28:02 +01003633 * The callback has the following parameters:
3634 * - \c void*: The opaque pointer \p p_psk.
3635 * - \c mbedtls_ssl_context*: The SSL context to which
3636 * the operation applies.
3637 * - \c const unsigned char*: The PSK identity
3638 * selected by the client.
3639 * - \c size_t: The length of the PSK identity
3640 * selected by the client.
3641 *
Paul Bakker6db455e2013-09-18 17:29:31 +02003642 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01003643 * \c mbedtls_ssl_set_hs_psk() or
3644 * \c mbedtls_ssl_set_hs_psk_opaque()
3645 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02003646 * Any other return value will result in a denied PSK identity.
3647 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003648 * \note A dynamic PSK (i.e. set by the PSK callback) takes
3649 * precedence over a static PSK (i.e. set by
3650 * \c mbedtls_ssl_conf_psk() or
3651 * \c mbedtls_ssl_conf_psk_opaque()).
3652 * This means that if you set a PSK callback using this
3653 * function, you don't need to set a PSK using
3654 * \c mbedtls_ssl_conf_psk() or
3655 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003656 *
Hanno Becker02283042018-10-22 15:28:02 +01003657 * \param conf The SSL configuration to register the callback with.
3658 * \param f_psk The callback for selecting and setting the PSK based
3659 * in the PSK identity chosen by the client.
3660 * \param p_psk A pointer to an opaque structure to be passed to
3661 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02003662 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003663void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
3664 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3665 size_t),
3666 void *p_psk);
Jerry Yu8897c072022-08-12 13:56:53 +08003667#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cron73fe8df2022-10-05 14:31:43 +02003668#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003669
Brett Warrene0edc842021-08-17 09:53:13 +01003670/**
3671 * \brief Set the allowed groups in order of preference.
3672 *
3673 * On server: This only affects the choice of key agreement mechanism
3674 *
3675 * On client: this affects the list of groups offered for any
3676 * use. The server can override our preference order.
3677 *
3678 * Both sides: limits the set of groups accepted for use in
3679 * key sharing.
3680 *
Brett Warrene0edc842021-08-17 09:53:13 +01003681 * \note This list should be ordered by decreasing preference
3682 * (preferred group first).
3683 *
3684 * \note When this function is not called, a default list is used,
3685 * consisting of all supported curves at 255 bits and above,
3686 * and all supported finite fields at 2048 bits and above.
3687 * The order favors groups with the lowest resource usage.
3688 *
3689 * \note New minor versions of Mbed TLS will not remove items
3690 * from the default list unless serious security concerns require it.
3691 * New minor versions of Mbed TLS may change the order in
3692 * keeping with the general principle of favoring the lowest
3693 * resource usage.
3694 *
3695 * \param conf SSL configuration
3696 * \param groups List of allowed groups ordered by preference, terminated by 0.
3697 * Must contain valid IANA NamedGroup IDs (provided via either an integer
Xiaofei Bai746f9482021-11-12 08:53:56 +00003698 * or using MBEDTLS_TLS1_3_NAMED_GROUP_XXX macros).
Brett Warrene0edc842021-08-17 09:53:13 +01003699 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003700void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3701 const uint16_t *groups);
Brett Warrene0edc842021-08-17 09:53:13 +01003702
Ronald Crone68ab4f2022-10-05 12:46:29 +02003703#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01003704
Hanno Becker1cd6e002021-08-10 13:27:10 +01003705/**
Jerry Yu1b23bce2023-11-13 13:45:14 +08003706 * \brief Configure allowed signature algorithms for use in TLS
Hanno Becker1cd6e002021-08-10 13:27:10 +01003707 *
3708 * \param conf The SSL configuration to use.
Jerry Yu7899de82021-08-17 13:09:23 +08003709 * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms,
Jerry Yu53c4a0d2023-11-09 10:38:17 +08003710 * terminated by #MBEDTLS_TLS1_3_SIG_NONE. The list must remain
3711 * available throughout the lifetime of the conf object.
3712 * - For TLS 1.3, values of \c MBEDTLS_TLS1_3_SIG_XXXX should be
3713 * used.
3714 * - For TLS 1.2, values should be given as
3715 * "(HashAlgorithm << 8) | SignatureAlgorithm".
Hanno Becker1cd6e002021-08-10 13:27:10 +01003716 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003717void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
3718 const uint16_t *sig_algs);
Ronald Crone68ab4f2022-10-05 12:46:29 +02003719#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003720
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003721#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003722/**
Darryl Green11999bb2018-03-13 15:22:58 +00003723 * \brief Set or reset the hostname to check against the received
Gilles Peskine96073fb2025-02-20 19:12:04 +01003724 * peer certificate. On a client, this also sets the
3725 * ServerName TLS extension, if that extension is enabled.
3726 * On a TLS 1.3 client, this also sets the server name in
3727 * the session resumption ticket, if that feature is enabled.
Paul Bakker6db455e2013-09-18 17:29:31 +02003728 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003729 * \param ssl SSL context
Gilles Peskine96073fb2025-02-20 19:12:04 +01003730 * \param hostname The server hostname. This may be \c NULL to clear
3731 * the hostname.
Paul Bakker5121ce52009-01-03 21:22:43 +00003732 *
Gilles Peskine96073fb2025-02-20 19:12:04 +01003733 * \note Maximum hostname length #MBEDTLS_SSL_MAX_HOST_NAME_LEN.
3734 *
Gilles Peskineeb2d29e2025-02-20 19:12:16 +01003735 * \note If the hostname is \c NULL on a client, then the server
3736 * is not authenticated: it only needs to have a valid
3737 * certificate, not a certificate matching its name.
3738 * Therefore you should always call this function on a client,
3739 * unless the connection is set up to only allow
3740 * pre-shared keys, or in scenarios where server
3741 * impersonation is not a concern. See the documentation of
3742 * #MBEDTLS_ERR_SSL_CERTIFICATE_VERIFICATION_WITHOUT_HOSTNAME
3743 * for more details.
3744 *
Felix Conway37ede2c2025-08-18 14:46:39 +01003745 * \return 0 if successful, #PSA_ERROR_INSUFFICIENT_MEMORY on
3746 * allocation failure, #PSA_ERROR_INVALID_ARGUMENT on
Hanno Becker0446a392017-04-07 12:59:32 +01003747 * too long input hostname.
3748 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003749 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003750 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003751 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003753int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname);
Pengyu Lv918ebf32023-03-07 10:17:31 +08003754
3755/**
3756 * \brief Get the hostname that checked against the received
3757 * server certificate. It is used to set the ServerName
3758 * TLS extension, too, if that extension is enabled.
3759 * (client-side only)
3760 *
3761 * \param ssl SSL context
3762 *
3763 * \return const pointer to the hostname value
3764 */
3765static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
3766{
3767 return ssl->MBEDTLS_PRIVATE(hostname);
3768}
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003769#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003770
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003771#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003772/**
Glenn Strauss69894072022-01-24 12:58:00 -05003773 * \brief Retrieve SNI extension value for the current handshake.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04003774 * Available in \c f_cert_cb of \c mbedtls_ssl_conf_cert_cb(),
3775 * this is the same value passed to \c f_sni callback of
Glenn Strauss69894072022-01-24 12:58:00 -05003776 * \c mbedtls_ssl_conf_sni() and may be used instead of
3777 * \c mbedtls_ssl_conf_sni().
3778 *
3779 * \param ssl SSL context
3780 * \param name_len pointer into which to store length of returned value.
3781 * 0 if SNI extension is not present or not yet processed.
3782 *
3783 * \return const pointer to SNI extension value.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04003784 * - value is valid only when called in \c f_cert_cb
Glenn Strauss69894072022-01-24 12:58:00 -05003785 * registered with \c mbedtls_ssl_conf_cert_cb().
3786 * - value is NULL if SNI extension is not present.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04003787 * - value is not '\0'-terminated. Use \c name_len for len.
Glenn Strauss69894072022-01-24 12:58:00 -05003788 * - value must not be freed.
3789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003790const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
3791 size_t *name_len);
Glenn Strauss69894072022-01-24 12:58:00 -05003792
3793/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003794 * \brief Set own certificate and key for the current handshake
3795 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003796 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003797 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003798 *
Glenn Strauss36872db2022-01-22 05:06:31 -05003799 * \note Passing null \c own_cert clears the certificate list for
3800 * the current handshake.
3801 *
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003802 * \param ssl SSL context
3803 * \param own_cert own public certificate chain
3804 * \param pk_key own private key
3805 *
Felix Conway37ede2c2025-08-18 14:46:39 +01003806 * \return 0 on success or #PSA_ERROR_INSUFFICIENT_MEMORY
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003807 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003808int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
3809 mbedtls_x509_crt *own_cert,
3810 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003811
3812/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003813 * \brief Set the data required to verify peer certificate for the
3814 * current handshake
3815 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003816 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003817 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003818 *
3819 * \param ssl SSL context
3820 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3821 * \param ca_crl trusted CA CRLs
3822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003823void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
3824 mbedtls_x509_crt *ca_chain,
3825 mbedtls_x509_crl *ca_crl);
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003826
Glenn Strauss999ef702022-03-11 01:37:23 -05003827#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3828/**
3829 * \brief Set DN hints sent to client in CertificateRequest message
3830 *
3831 * \note Same as \c mbedtls_ssl_conf_dn_hints() but for use within
3832 * the SNI callback or the certificate selection callback.
3833 *
3834 * \param ssl SSL context
3835 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3836 * from which the client should select client peer certificate.
3837 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003838void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
3839 const mbedtls_x509_crt *crt);
Glenn Strauss999ef702022-03-11 01:37:23 -05003840#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3841
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003842/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003843 * \brief Set authmode for the current handshake.
3844 *
3845 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003846 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003847 *
3848 * \param ssl SSL context
3849 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3850 * MBEDTLS_SSL_VERIFY_REQUIRED
3851 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003852void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
3853 int authmode);
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003854
3855/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003856 * \brief Set server side ServerName TLS extension callback
3857 * (optional, server-side only).
3858 *
3859 * If set, the ServerName callback is called whenever the
3860 * server receives a ServerName TLS extension from the client
3861 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003862 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003863 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003864 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003865 * certificate(s) and key(s) to use with \c
3866 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003867 * and may optionally adjust the CA and associated CRL with \c
3868 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3869 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3870 * then must return 0. If no matching name is found, the
Glenn Strauss0ebf24a2022-01-24 18:30:13 -05003871 * callback may return non-zero to abort the handshake.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003872 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003873 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003874 * \param f_sni verification function
3875 * \param p_sni verification parameter
3876 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003877void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3878 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
3879 size_t),
3880 void *p_sni);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003881#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003882
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003883#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003884/**
3885 * \brief Set the EC J-PAKE password for current handshake.
3886 *
3887 * \note An internal copy is made, and destroyed as soon as the
3888 * handshake is completed, or when the SSL context is reset or
3889 * freed.
3890 *
3891 * \note The SSL context needs to be already set up. The right place
3892 * to call this function is between \c mbedtls_ssl_setup() or
3893 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settiaca21b72022-11-17 18:17:01 +01003894 * Password cannot be empty (see RFC 8236).
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003895 *
3896 * \param ssl SSL context
Valerio Settiaca21b72022-11-17 18:17:01 +01003897 * \param pw EC J-PAKE password (pre-shared secret). It cannot be empty
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003898 * \param pw_len length of pw in bytes
3899 *
3900 * \return 0 on success, or a negative error code.
3901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003902int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
3903 const unsigned char *pw,
3904 size_t pw_len);
Valerio Settia9a97dc2022-11-28 18:26:16 +01003905
3906/**
3907 * \brief Set the EC J-PAKE opaque password for current handshake.
3908 *
Valerio Settic689ed82022-12-07 14:40:38 +01003909 * \note The key must remain valid until the handshake is over.
Valerio Settia9a97dc2022-11-28 18:26:16 +01003910 *
3911 * \note The SSL context needs to be already set up. The right place
3912 * to call this function is between \c mbedtls_ssl_setup() or
3913 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settia9a97dc2022-11-28 18:26:16 +01003914 *
3915 * \param ssl SSL context
3916 * \param pwd EC J-PAKE opaque password
3917 *
3918 * \return 0 on success, or a negative error code.
3919 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003920int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
3921 mbedtls_svc_key_id_t pwd);
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003922#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003923
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003924#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003925/**
3926 * \brief Set the supported Application Layer Protocols.
3927 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003928 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003929 * \param protos Pointer to a NULL-terminated list of supported protocols,
3930 * in decreasing preference order. The pointer to the list is
3931 * recorded by the library for later reference as required, so
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003932 * the lifetime of the table must be at least as long as the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003933 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003934 *
Felix Conway37ede2c2025-08-18 14:46:39 +01003935 * \return 0 on success, or #PSA_ERROR_INVALID_ARGUMENT.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003936 */
Gilles Peskinec4949d12025-05-27 19:45:29 +02003937int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf,
3938 const char *const *protos);
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003939
3940/**
3941 * \brief Get the name of the negotiated Application Layer Protocol.
3942 * This function should be called after the handshake is
3943 * completed.
3944 *
3945 * \param ssl SSL context
3946 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003947 * \return Protocol name, or NULL if no protocol was negotiated.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003948 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003949const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003950#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003951
Johan Pascalb62bb512015-12-03 21:56:45 +01003952#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003953#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003954static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile)
Johan Pascala455cd92020-09-22 15:28:11 +02003955{
Gilles Peskine449bd832023-01-11 14:50:10 +01003956 switch (profile) {
Johan Pascala455cd92020-09-22 15:28:11 +02003957 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01003958 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003959 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01003960 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003961 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01003962 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003963 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01003964 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003965 default: break;
3966 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 return "";
Johan Pascala455cd92020-09-22 15:28:11 +02003968}
3969#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003970/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003971 * \brief Manage support for mki(master key id) value
3972 * in use_srtp extension.
3973 * MKI is an optional part of SRTP used for key management
3974 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003975 * The default value is
3976 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003977 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003978 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003979 * \param support_mki_value Enable or disable mki usage. Values are
3980 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3981 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003982 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003983void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3984 int support_mki_value);
Ron Eldor591f1622018-01-22 12:30:04 +02003985
3986/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003987 * \brief Set the supported DTLS-SRTP protection profiles.
3988 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003989 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003990 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3991 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003992 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003993 * The pointer to the list is recorded by the library
3994 * for later reference as required, so the lifetime
3995 * of the table must be at least as long as the lifetime
3996 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003997 * The list must not hold more than
3998 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003999 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01004000 *
Johan Pascal85269572020-08-25 10:01:54 +02004001 * \return 0 on success
Felix Conway37ede2c2025-08-18 14:46:39 +01004002 * \return #PSA_ERROR_INVALID_ARGUMENT when the list of
Johan Pascal9bc97ca2020-09-21 23:44:45 +02004003 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01004004 */
Ron Eldora9788042018-12-05 11:04:31 +02004005int mbedtls_ssl_conf_dtls_srtp_protection_profiles
Gilles Peskine449bd832023-01-11 14:50:10 +01004006 (mbedtls_ssl_config *conf,
4007 const mbedtls_ssl_srtp_profile *profiles);
Ron Eldor591f1622018-01-22 12:30:04 +02004008
4009/**
Ron Eldora9788042018-12-05 11:04:31 +02004010 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02004011 *
Ron Eldora9788042018-12-05 11:04:31 +02004012 * \param ssl SSL context to use.
4013 * \param mki_value The MKI value to set.
4014 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02004015 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004016 * \note This function is relevant on client side only.
4017 * The server discovers the mki value during handshake.
4018 * A mki value set on server side using this function
4019 * is ignored.
4020 *
Johan Pascal85269572020-08-25 10:01:54 +02004021 * \return 0 on success
Felix Conway37ede2c2025-08-18 14:46:39 +01004022 * \return #PSA_ERROR_INVALID_ARGUMENT
Johan Pascal85269572020-08-25 10:01:54 +02004023 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02004024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004025int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
4026 unsigned char *mki_value,
4027 uint16_t mki_len);
Johan Pascalb62bb512015-12-03 21:56:45 +01004028/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004029 * \brief Get the negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004030 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004031 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004032 * \warning This function must be called after the handshake is
4033 * completed. The value returned by this function must
4034 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01004035 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004036 * \param ssl The SSL context to query.
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004037 * \param dtls_srtp_info The negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004038 * - Protection profile in use.
4039 * A direct mapping of the iana defined value for protection
4040 * profile on an uint16_t.
4041 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
4042 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
4043 * or peer's Hello packet was not parsed yet.
4044 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01004045 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004046void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
4047 mbedtls_dtls_srtp_info *dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01004048#endif /* MBEDTLS_SSL_DTLS_SRTP */
4049
Paul Bakker1d29fb52012-09-28 13:28:45 +00004050/**
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004051 * \brief Set the maximum supported version sent from the client side
4052 * and/or accepted at the server side.
4053 *
4054 * \note After the handshake, you can call
4055 * mbedtls_ssl_get_version_number() to see what version was
4056 * negotiated.
4057 *
4058 * \param conf SSL configuration
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004059 * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004060 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4061 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004062static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf,
4063 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004064{
4065 conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version;
4066}
4067
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004068/**
4069 * \brief Set the minimum supported version sent from the client side
4070 * and/or accepted at the server side.
4071 *
4072 * \note After the handshake, you can call
4073 * mbedtls_ssl_get_version_number() to see what version was
4074 * negotiated.
4075 *
4076 * \param conf SSL configuration
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004077 * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004078 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4079 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004080static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf,
4081 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004082{
4083 conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version;
4084}
Paul Bakker1d29fb52012-09-28 13:28:45 +00004085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004086#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004087/**
4088 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004089 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004090 *
4091 * \note This should always be enabled, it is a security
4092 * improvement, and should not cause any interoperability
4093 * issue (used only if the peer supports it too).
4094 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004095 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004096 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004098void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004099#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004101#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004102/**
4103 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004104 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004105 *
4106 * \note This should always be enabled, it is a security fix to the
4107 * protocol, and should not cause any interoperability issue
4108 * (used only if the peer supports it too).
4109 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004110 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004111 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004112 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004113void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004114#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004115
Janos Follath088ce432017-04-10 12:42:31 +01004116#if defined(MBEDTLS_SSL_SRV_C)
4117/**
4118 * \brief Whether to send a list of acceptable CAs in
4119 * CertificateRequest messages.
4120 * (Default: do send)
4121 *
4122 * \param conf SSL configuration
4123 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
4124 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
4125 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004126void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
4127 char cert_req_ca_list);
Janos Follath088ce432017-04-10 12:42:31 +01004128#endif /* MBEDTLS_SSL_SRV_C */
4129
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004130#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00004131/**
k-stachowiak6d722122019-02-08 17:03:33 +01004132 * \brief Set the maximum fragment length to emit and/or negotiate.
4133 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
4134 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004135 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01004136 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004137 * (Client: set maximum fragment length to emit *and*
4138 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02004139 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004140 *
k-stachowiak6d722122019-02-08 17:03:33 +01004141 * \note On the client side, the maximum fragment length extension
4142 * *will not* be used, unless the maximum fragment length has
4143 * been set via this function to a value different than
4144 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004145 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004146 * \note With TLS, this currently only affects ApplicationData (sent
4147 * with \c mbedtls_ssl_read()), not handshake messages.
4148 * With DTLS, this affects both ApplicationData and handshake.
4149 *
Gilles Peskined8f9e222025-03-11 13:45:27 +01004150 * \note Defragmentation of TLS handshake messages is supported
4151 * with some limitations. See the documentation of
4152 * mbedtls_ssl_handshake() for details.
Gilles Peskine36edd482025-03-05 17:41:59 +01004153 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02004154 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004155 * excluding record overhead that will be added to it, see
4156 * \c mbedtls_ssl_get_record_expansion().
4157 *
4158 * \note For DTLS, it is also possible to set a limit for the total
Tom Cosgrove1e211442022-05-26 11:51:00 +01004159 * size of datagrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02004160 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004161 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01004162 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02004163 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004164 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
4165 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004166 *
Felix Conway37ede2c2025-08-18 14:46:39 +01004167 * \return 0 if successful or #PSA_ERROR_INVALID_ARGUMENT
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004168 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004169int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004170#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004171
TRodziewicz8476f2f2021-06-02 14:34:47 +02004172#if defined(MBEDTLS_SSL_SRV_C)
4173/**
TRodziewicz3946f792021-06-14 12:11:18 +02004174 * \brief Pick the ciphersuites order according to the second parameter
4175 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
4176 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004177 *
4178 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02004179 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
4180 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004181 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004182void mbedtls_ssl_conf_preference_order(mbedtls_ssl_config *conf, int order);
TRodziewicz8476f2f2021-06-02 14:34:47 +02004183#endif /* MBEDTLS_SSL_SRV_C */
4184
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004185#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4186 defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02004187/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004188 * \brief Enable / Disable session tickets (client only).
4189 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004190 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004191 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004192 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01004193 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004194 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
4195 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004196 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004197void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004198#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4199 MBEDTLS_SSL_CLI_C */
4200
4201#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4202 defined(MBEDTLS_SSL_SRV_C) && \
4203 defined(MBEDTLS_SSL_PROTO_TLS1_3)
4204/**
Jerry Yuba627bf2022-09-23 09:58:22 +08004205 * \brief Number of NewSessionTicket messages for the server to send
4206 * after handshake completion.
4207 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004208 * \note The default value is
Jerry Yuba627bf2022-09-23 09:58:22 +08004209 * \c MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS.
4210 *
4211 * \note In case of a session resumption, this setting only partially apply.
4212 * At most one ticket is sent in that case to just renew the pool of
4213 * tickets of the client. The rationale is to avoid the number of
4214 * tickets on the server to become rapidly out of control when the
4215 * server has the same configuration for all its connection instances.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004216 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004217 * \param conf SSL configuration
4218 * \param num_tickets Number of NewSessionTicket.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004219 *
4220 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004221void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
4222 uint16_t num_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004223#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4224 MBEDTLS_SSL_SRV_C &&
4225 MBEDTLS_SSL_PROTO_TLS1_3*/
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004227#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004228/**
Paul Bakker09f097d2012-10-23 11:54:56 +00004229 * \brief Enable / Disable renegotiation support for connection when
4230 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004231 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00004232 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004233 * \warning It is recommended to always disable renegotiation unless you
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004234 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00004235 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004236 * renegotiation or a poor understanding of its properties.
4237 *
4238 * \note Server-side, enabling renegotiation also makes the server
4239 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00004240 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004241 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004242 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
4243 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00004244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004245void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004246#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004247
4248/**
4249 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004250 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02004251 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004252 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004253 * be established even if the peer does not support
4254 * secure renegotiation, but does not allow renegotiation
4255 * to take place if not secure.
4256 * (Interoperable and secure option)
4257 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004258 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004259 * with non-upgraded peers. Allowing legacy renegotiation
4260 * makes the connection vulnerable to specific man in the
4261 * middle attacks. (See RFC 5746)
4262 * (Most interoperable and least secure option)
4263 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004264 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004265 * if peer does not support secure renegotiation. Results
4266 * in interoperability issues with non-upgraded peers
4267 * that do not support renegotiation altogether.
4268 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00004269 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004270 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00004271 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
4272 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004273 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00004274 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004275void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy);
Paul Bakker48916f92012-09-16 19:57:18 +00004276
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004277#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004278/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004279 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004280 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004281 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004282 * When we request a renegotiation, the peer can comply or
4283 * ignore the request. This function allows us to decide
4284 * whether to enforce our renegotiation requests by closing
4285 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004286 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004287 * However, records could already be in transit from the peer
4288 * when the request is emitted. In order to increase
4289 * reliability, we can accept a number of records before the
4290 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004291 *
4292 * The optimal value is highly dependent on the specific usage
4293 * scenario.
4294 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004295 * \note With DTLS and server-initiated renegotiation, the
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004296 * HelloRequest is retransmitted every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004297 * out or receives Application Data, until:
4298 * - max_records records have beens seen, if it is >= 0, or
4299 * - the number of retransmits that would happen during an
4300 * actual handshake has been reached.
4301 * Please remember the request might be lost a few times
4302 * if you consider setting max_records to a really low value.
4303 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004304 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004305 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004306 * which always behave as if max_record was 0. The reason is,
4307 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004308 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004309 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004310 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004311 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004312 * enforce renegotiation, or a non-negative value to enforce
4313 * it but allow for a grace period of max_records records.
4314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004315void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records);
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004316
4317/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004318 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00004319 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004320 *
4321 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01004322 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004323 * threshold. The default value is meant to prevent the
4324 * connection from being closed when the counter is about to
4325 * reached its maximal value (it is not allowed to wrap).
4326 *
4327 * Lower values can be used to enforce policies such as "keys
4328 * must be refreshed every N packets with cipher X".
4329 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00004330 * The renegotiation period can be disabled by setting
4331 * conf->disable_renegotiation to
4332 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
4333 *
4334 * \note When the configured transport is
4335 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
4336 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
4337 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00004338 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004339 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004340 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004341 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004342void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
4343 const unsigned char period[8]);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004344#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00004345
Paul Bakker43ca69c2011-01-15 17:35:19 +00004346/**
Hanno Becker8b170a02017-10-10 11:51:19 +01004347 * \brief Check if there is data already read from the
4348 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004349 *
4350 * \param ssl SSL context
4351 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004352 * \return 0 if nothing's pending, 1 otherwise.
4353 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004354 * \note This is different in purpose and behaviour from
4355 * \c mbedtls_ssl_get_bytes_avail in that it considers
4356 * any kind of unprocessed data, not only unread
4357 * application data. If \c mbedtls_ssl_get_bytes
4358 * returns a non-zero value, this function will
4359 * also signal pending data, but the converse does
4360 * not hold. For example, in DTLS there might be
4361 * further records waiting to be processed from
4362 * the current underlying transport's datagram.
4363 *
Hanno Becker9b19a122017-10-31 13:00:14 +00004364 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01004365 * does not imply that a subsequent call to
4366 * \c mbedtls_ssl_read will provide any data;
4367 * e.g., the unprocessed data might turn out
4368 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00004369 *
4370 * \note This function is useful in the following situation:
4371 * If the SSL/TLS module successfully returns from an
4372 * operation - e.g. a handshake or an application record
4373 * read - and you're awaiting incoming data next, you
4374 * must not immediately idle on the underlying transport
4375 * to have data ready, but you need to check the value
4376 * of this function first. The reason is that the desired
4377 * data might already be read but not yet processed.
4378 * If, in contrast, a previous call to the SSL/TLS module
4379 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
4380 * to call this function, as the latter error code entails
4381 * that all internal data has been processed.
4382 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004383 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004384int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl);
Hanno Becker8b170a02017-10-10 11:51:19 +01004385
4386/**
4387 * \brief Return the number of application data bytes
4388 * remaining to be read from the current record.
4389 *
4390 * \param ssl SSL context
4391 *
4392 * \return How many bytes are available in the application
4393 * data record read buffer.
4394 *
4395 * \note When working over a datagram transport, this is
4396 * useful to detect the current datagram's boundary
4397 * in case \c mbedtls_ssl_read has written the maximal
4398 * amount of data fitting into the input buffer.
4399 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004400 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004401size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004402
4403/**
4404 * \brief Return the result of the certificate verification
4405 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004406 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00004407 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004408 * \return \c 0 if the certificate verification was successful.
4409 * \return \c -1u if the result is not available. This may happen
4410 * e.g. if the handshake aborts early, or a verification
4411 * callback returned a fatal error.
4412 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
4413 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00004414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004415uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004416
4417/**
Glenn Strauss8f526902022-01-13 00:04:49 -05004418 * \brief Return the id of the current ciphersuite
4419 *
4420 * \param ssl SSL context
4421 *
4422 * \return a ciphersuite id
4423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004424int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl);
Glenn Strauss8f526902022-01-13 00:04:49 -05004425
4426/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00004427 * \brief Return the name of the current ciphersuite
4428 *
4429 * \param ssl SSL context
4430 *
4431 * \return a string containing the ciphersuite name
4432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004433const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004434
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004435
4436/**
4437 * \brief Return the (D)TLS protocol version negotiated in the
4438 * given connection.
4439 *
Gilles Peskined44e0502022-02-12 00:45:21 +01004440 * \note If you call this function too early during the initial
4441 * handshake, before the two sides have agreed on a version,
4442 * this function returns #MBEDTLS_SSL_VERSION_UNKNOWN.
4443 *
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004444 * \param ssl The SSL context to query.
4445 * \return The negotiated protocol version.
4446 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04004447static inline mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(
Gilles Peskine449bd832023-01-11 14:50:10 +01004448 const mbedtls_ssl_context *ssl)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004449{
4450 return ssl->MBEDTLS_PRIVATE(tls_version);
4451}
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004452
Paul Bakker5121ce52009-01-03 21:22:43 +00004453/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004454 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004455 *
4456 * \param ssl SSL context
4457 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004458 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004459 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004460const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004461
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004462/**
4463 * \brief Return the (maximum) number of bytes added by the record
4464 * layer: header + encryption/MAC overhead (inc. padding)
4465 *
4466 * \param ssl SSL context
4467 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01004468 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004469 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004470int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004471
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004472/**
4473 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004474 *
4475 * \note The logic to determine the maximum outgoing record payload is
4476 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004477 * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004478 * such as the max fragment length or record size limit extension if
4479 * used, and for DTLS the path MTU as configured and current
4480 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004481 *
4482 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
4483 * called with a larger length value.
4484 * With TLS, \c mbedtls_ssl_write() will fragment the input if
4485 * necessary and return the number of bytes written; it is up
4486 * to the caller to call \c mbedtls_ssl_write() again in
4487 * order to send the remaining bytes if any.
4488 *
Hanno Becker80d163d2021-04-21 06:28:18 +01004489 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004490 * \sa mbedtls_ssl_get_record_expansion()
4491 *
4492 * \param ssl SSL context
4493 *
4494 * \return Current maximum payload for an outgoing record,
4495 * or a negative error code.
4496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004497int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004498
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004499/**
4500 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004501 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004502 * \note The logic to determine the maximum incoming record payload is
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004503 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004504 * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004505 * such as the max fragment length extension or record size limit
4506 * extension if used, and the current record expansion.
4507 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004508 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01004509 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004510 * \sa mbedtls_ssl_get_record_expansion()
4511 *
4512 * \param ssl SSL context
4513 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004514 * \return Current maximum payload for an incoming record,
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004515 * or a negative error code.
4516 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004517int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004518
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004519#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00004520/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004521 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004522 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004523 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004524 *
Hanno Becker958efeb2019-02-25 10:13:43 +00004525 * \return The current peer certificate, if available.
4526 * The returned certificate is owned by the SSL context and
4527 * is valid only until the next call to the SSL API.
4528 * \return \c NULL if no peer certificate is available. This might
4529 * be because the chosen ciphersuite doesn't use CRTs
4530 * (PSK-based ciphersuites, for example), or because
4531 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
4532 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004533 *
4534 * \note For one-time inspection of the peer's certificate during
4535 * the handshake, consider registering an X.509 CRT verification
4536 * callback through mbedtls_ssl_conf_verify() instead of calling
4537 * this function. Using mbedtls_ssl_conf_verify() also comes at
4538 * the benefit of allowing you to influence the verification
4539 * process, for example by masking expected and tolerated
4540 * verification failures.
4541 *
4542 * \warning You must not use the pointer returned by this function
4543 * after any further call to the SSL API, including
4544 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
4545 * because the pointer might change during renegotiation,
4546 * which happens transparently to the user.
4547 * If you want to use the certificate across API calls,
4548 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004549 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004550const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004551#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00004552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004553#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00004554/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01004555 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004556 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004557 * \param ssl The SSL context representing the connection for which to
4558 * to export a session structure for later resumption.
4559 * \param session The target structure in which to store the exported session.
Benson Liou6d0a0932023-12-27 22:03:24 +08004560 * This must have been initialized with mbedtls_ssl_session_init()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004561 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004562 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01004563 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01004564 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01004565 * ticket-based resumption will be considered. For TLS 1.3,
Ronald Cron66a206c2024-04-04 15:34:22 +02004566 * sessions equate to tickets, and if session tickets are
4567 * enabled (see #MBEDTLS_SSL_SESSION_TICKETS configuration
4568 * option), this function exports the last received ticket and
4569 * the exported session may be used to resume the TLS 1.3
4570 * session. If session tickets are disabled, exported sessions
4571 * cannot be used to resume a TLS 1.3 session.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004572 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004573 * \return \c 0 if successful. In this case, \p session can be used for
4574 * session resumption by passing it to mbedtls_ssl_set_session(),
4575 * and serialized for storage via mbedtls_ssl_session_save().
Hanno Beckere810bbc2021-05-14 16:01:05 +01004576 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004577 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004578 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004579 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004581int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
4582 mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004583#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004584
4585/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004586 * \brief Perform the SSL handshake
4587 *
4588 * \param ssl SSL context
4589 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004590 * \return \c 0 if successful.
4591 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004592 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004593 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004594 * transport - in this case you must call this function again
4595 * when the underlying transport is ready for the operation.
4596 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4597 * operation is in progress (see
4598 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4599 * must call this function again when the operation is ready.
4600 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4601 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4602 * in this case you must call this function again to complete
4603 * the handshake when you're done attending other tasks.
4604 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
4605 * and the client did not demonstrate reachability yet - in
4606 * this case you must stop using the context (see below).
Jerry Yu032985c2023-12-06 17:59:33 +08004607 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4608 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004609 * received as part of the handshake. This is server specific
4610 * and may occur only if the early data feature has been
4611 * enabled on server (see mbedtls_ssl_conf_early_data()
4612 * documentation). You must call mbedtls_ssl_read_early_data()
4613 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004614 * \return Another SSL error code - in this case you must stop using
4615 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02004616 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004617 * \warning If this function returns something other than
4618 * \c 0,
4619 * #MBEDTLS_ERR_SSL_WANT_READ,
4620 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4621 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
Jerry Yu032985c2023-12-06 17:59:33 +08004622 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4623 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004624 * you must stop using the SSL context for reading or writing,
4625 * and either free it or call \c mbedtls_ssl_session_reset()
4626 * on it before re-using it for a new connection; the current
4627 * connection must be closed.
4628 *
4629 * \note If DTLS is in use, then you may choose to handle
4630 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
4631 * purposes, as it is an expected return value rather than an
4632 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01004633 *
4634 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004635 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004636 * from the underlying transport layer is currently being processed,
4637 * and it is safe to idle until the timer or the underlying transport
4638 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004639 * in which case the datagram of the underlying transport that is
4640 * currently being processed might or might not contain further
4641 * DTLS records.
Gilles Peskine8c2830a2022-08-04 23:37:51 +02004642 *
Gilles Peskine2b78a5a2025-03-12 10:07:33 +01004643 * \note In TLS, reception of fragmented handshake messages is
4644 * supported with some limitations (those limitations do
4645 * not apply to DTLS, where defragmentation is fully
4646 * supported):
Gilles Peskined8f9e222025-03-11 13:45:27 +01004647 * - On an Mbed TLS server that only accepts TLS 1.2,
4648 * the initial ClientHello message must not be fragmented.
4649 * A TLS 1.2 ClientHello may be fragmented if the server
4650 * also accepts TLS 1.3 connections (meaning
4651 * that #MBEDTLS_SSL_PROTO_TLS1_3 enabled, and the
4652 * accepted versions have not been restricted with
4653 * mbedtls_ssl_conf_max_tls_version() or the like).
Gilles Peskined8f9e222025-03-11 13:45:27 +01004654 * - The first fragment of a handshake message must be
4655 * at least 4 bytes long.
4656 * - Non-handshake records must not be interleaved between
4657 * the fragments of a handshake message. (This is permitted
4658 * in TLS 1.2 but not in TLS 1.3, but Mbed TLS rejects it
4659 * even in TLS 1.2.)
4660 *
Janos Follath130ece02024-11-19 16:16:36 +00004661 * \note The PSA crypto subsystem must have been initialized by
4662 * calling psa_crypto_init() before calling this function.
Paul Bakker5121ce52009-01-03 21:22:43 +00004663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004664int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004665
4666/**
Paul Elliott93ba3e32022-03-18 21:51:13 +00004667 * \brief After calling mbedtls_ssl_handshake() to start the SSL
4668 * handshake you can call this function to check whether the
4669 * handshake is over for a given SSL context. This function
4670 * should be also used to determine when to stop calling
4671 * mbedtls_handshake_step() for that context.
4672 *
4673 * \param ssl SSL context
4674 *
4675 * \return \c 1 if handshake is over, \c 0 if it is still ongoing.
4676 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004677static inline int mbedtls_ssl_is_handshake_over(mbedtls_ssl_context *ssl)
Paul Elliott93ba3e32022-03-18 21:51:13 +00004678{
Gilles Peskine449bd832023-01-11 14:50:10 +01004679 return ssl->MBEDTLS_PRIVATE(state) >= MBEDTLS_SSL_HANDSHAKE_OVER;
Paul Elliott93ba3e32022-03-18 21:51:13 +00004680}
4681
4682/**
Paul Bakker1961b702013-01-25 14:49:24 +01004683 * \brief Perform a single step of the SSL handshake
4684 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02004685 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004686 * the next state after this function returns \c 0. Do not
Paul Elliott93ba3e32022-03-18 21:51:13 +00004687 * call this function if mbedtls_ssl_is_handshake_over()
4688 * returns \c 1.
4689 *
4690 * \warning Whilst in the past you may have used direct access to the
4691 * context state (ssl->state) in order to ascertain when to
4692 * stop calling this function and although you can still do
4693 * so with something like ssl->MBEDTLS_PRIVATE(state) or by
4694 * defining MBEDTLS_ALLOW_PRIVATE_ACCESS, this is now
4695 * considered deprecated and could be broken in any future
4696 * release. If you still find you have good reason for such
4697 * direct access, then please do contact the team to explain
4698 * this (raise an issue or post to the mailing list), so that
4699 * we can add a solution to your problem that will be
4700 * guaranteed to work in the future.
Paul Bakker1961b702013-01-25 14:49:24 +01004701 *
4702 * \param ssl SSL context
4703 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004704 * \return See mbedtls_ssl_handshake().
4705 *
4706 * \warning If this function returns something other than \c 0,
4707 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
Jerry Yu032985c2023-12-06 17:59:33 +08004708 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4709 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4710 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA, you must stop using
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004711 * the SSL context for reading or writing, and either free it
4712 * or call \c mbedtls_ssl_session_reset() on it before
4713 * re-using it for a new connection; the current connection
4714 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01004715 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004716int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004717
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004718#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01004719/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004720 * \brief Initiate an SSL renegotiation on the running connection.
4721 * Client: perform the renegotiation right now.
4722 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00004723 * during the next call to mbedtls_ssl_read() if honored by
4724 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00004725 *
4726 * \param ssl SSL context
4727 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00004728 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004729 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
4730 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004731 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004732 * \warning If this function returns something other than \c 0,
4733 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4734 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4735 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4736 * the SSL context for reading or writing, and either free it
4737 * or call \c mbedtls_ssl_session_reset() on it before
4738 * re-using it for a new connection; the current connection
4739 * must be closed.
4740 *
Paul Bakker48916f92012-09-16 19:57:18 +00004741 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004742int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004743#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004744
4745/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004746 * \brief Read at most 'len' application data bytes
4747 *
4748 * \param ssl SSL context
4749 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02004750 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00004751 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004752 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004753 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04004754 * without sending a CloseNotify beforehand, which might happen
4755 * because of various reasons (internal error of an underlying
4756 * stack, non-conformant peer not sending a CloseNotify and
4757 * such) - in this case you must stop using the context
4758 * (see below).
4759 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
4760 * transport is still functional, but the peer has
4761 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004762 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004763 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004764 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004765 * transport - in this case you must call this function again
4766 * when the underlying transport is ready for the operation.
4767 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4768 * operation is in progress (see
4769 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4770 * must call this function again when the operation is ready.
4771 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4772 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4773 * in this case you must call this function again to complete
4774 * the handshake when you're done attending other tasks.
4775 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
4776 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004777 * new connection using the same source port. See below.
Jerry Yu032985c2023-12-06 17:59:33 +08004778 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4779 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004780 * received as part of the handshake. This is server specific
4781 * and may occur only if the early data feature has been
4782 * enabled on server (see mbedtls_ssl_conf_early_data()
4783 * documentation). You must call mbedtls_ssl_read_early_data()
4784 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004785 * \return Another SSL error code - in this case you must stop using
4786 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004787 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004788 * \warning If this function returns something other than
4789 * a positive value,
4790 * #MBEDTLS_ERR_SSL_WANT_READ,
4791 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4792 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
Jerry Yu032985c2023-12-06 17:59:33 +08004793 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4794 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT or
4795 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004796 * you must stop using the SSL context for reading or writing,
4797 * and either free it or call \c mbedtls_ssl_session_reset()
4798 * on it before re-using it for a new connection; the current
4799 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004800 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004801 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004802 * (which can only happen server-side), it means that a client
4803 * is initiating a new connection using the same source port.
4804 * You can either treat that as a connection close and wait
4805 * for the client to resend a ClientHello, or directly
4806 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004807 * context (as it has been reset internally). Either way, you
4808 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004809 * connection: application state, if any, should be reset, and
4810 * most importantly the identity of the client must be checked
4811 * again. WARNING: not validating the identity of the client
4812 * again, or not transmitting the new identity to the
4813 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01004814 *
Hanno Becker8ec81022017-10-10 10:35:08 +01004815 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004816 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004817 * from the underlying transport layer is currently being processed,
4818 * and it is safe to idle until the timer or the underlying transport
4819 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004820 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
4821 * initially available on the underlying transport, as this data may have
4822 * been only e.g. duplicated messages or a renegotiation request.
4823 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
4824 * when reacting to an incoming-data event from the underlying transport.
4825 * - On success, the datagram of the underlying transport that is currently
4826 * being processed may contain further DTLS records. You should call
4827 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01004828 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004829 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004830int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004831
4832/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004833 * \brief Try to write exactly 'len' application data bytes
4834 *
4835 * \warning This function will do partial writes in some cases. If the
4836 * return value is non-negative but less than length, the
4837 * function must be called again with updated arguments:
4838 * buf + ret, len - ret (if ret is the return value) until
4839 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00004840 *
4841 * \param ssl SSL context
4842 * \param buf buffer holding the data
4843 * \param len how many bytes must be written
4844 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004845 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004846 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004847 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004848 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004849 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004850 * transport - in this case you must call this function again
4851 * when the underlying transport is ready for the operation.
4852 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4853 * operation is in progress (see
4854 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4855 * must call this function again when the operation is ready.
4856 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4857 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4858 * in this case you must call this function again to complete
4859 * the handshake when you're done attending other tasks.
Jerry Yu032985c2023-12-06 17:59:33 +08004860 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4861 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004862 * received as part of the handshake. This is server specific
4863 * and may occur only if the early data feature has been
4864 * enabled on server (see mbedtls_ssl_conf_early_data()
4865 * documentation). You must call mbedtls_ssl_read_early_data()
4866 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004867 * \return Another SSL error code - in this case you must stop using
4868 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00004869 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004870 * \warning If this function returns something other than
4871 * a non-negative value,
4872 * #MBEDTLS_ERR_SSL_WANT_READ,
4873 * #MBEDTLS_ERR_SSL_WANT_WRITE,
Jerry Yu032985c2023-12-06 17:59:33 +08004874 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4875 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4876 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004877 * you must stop using the SSL context for reading or writing,
4878 * and either free it or call \c mbedtls_ssl_session_reset()
4879 * on it before re-using it for a new connection; the current
4880 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004881 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004882 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00004883 * it must be called later with the *same* arguments,
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02004884 * until it returns a value greater than or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004885 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004886 * some partial data in the output buffer, however this is not
4887 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02004888 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00004889 * \note If the requested length is greater than the maximum
4890 * fragment length (either the built-in limit or the one set
4891 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004892 * - with TLS, less bytes than requested are written.
Felix Conway37ede2c2025-08-18 14:46:39 +01004893 * - with DTLS, #PSA_ERROR_INVALID_ARGUMENT is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01004894 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004895 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004896 *
4897 * \note Attempting to write 0 bytes will result in an empty TLS
4898 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004900int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004901
4902/**
Paul Bakker0a925182012-04-16 06:46:41 +00004903 * \brief Send an alert message
4904 *
4905 * \param ssl SSL context
4906 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004907 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004908 * \param message The alert message (SSL_ALERT_MSG_*)
4909 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004910 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004911 *
4912 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004913 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4914 * the SSL context for reading or writing, and either free it or
4915 * call \c mbedtls_ssl_session_reset() on it before re-using it
4916 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004917 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004918int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4919 unsigned char level,
4920 unsigned char message);
Paul Bakker0a925182012-04-16 06:46:41 +00004921/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004922 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004923 *
4924 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004925 *
4926 * \return 0 if successful, or a specific SSL error code.
4927 *
4928 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004929 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4930 * the SSL context for reading or writing, and either free it or
4931 * call \c mbedtls_ssl_session_reset() on it before re-using it
4932 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004934int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004935
Ronald Cron4a8c9e22022-10-26 18:49:09 +02004936#if defined(MBEDTLS_SSL_EARLY_DATA)
4937
4938#if defined(MBEDTLS_SSL_SRV_C)
4939/**
Ronald Cron3a045622024-01-08 18:44:59 +01004940 * \brief Read at most 'len' bytes of early data
4941 *
4942 * \note This API is server specific.
4943 *
Ronald Cron164537c2024-02-01 18:05:47 +01004944 * \warning Early data is defined in the TLS 1.3 specification, RFC 8446.
Ronald Cron44d70a52024-01-30 18:16:47 +01004945 * IMPORTANT NOTE from section 2.3 of the specification:
4946 *
4947 * The security properties for 0-RTT data are weaker than
4948 * those for other kinds of TLS data. Specifically:
4949 * - This data is not forward secret, as it is encrypted
4950 * solely under keys derived using the offered PSK.
4951 * - There are no guarantees of non-replay between connections.
4952 * Protection against replay for ordinary TLS 1.3 1-RTT data
4953 * is provided via the server's Random value, but 0-RTT data
4954 * does not depend on the ServerHello and therefore has
4955 * weaker guarantees. This is especially relevant if the
4956 * data is authenticated either with TLS client
4957 * authentication or inside the application protocol. The
4958 * same warnings apply to any use of the
4959 * early_exporter_master_secret.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02004960 *
Ronald Cron3996ebc2024-03-15 14:57:05 +01004961 * \warning Mbed TLS does not implement any of the anti-replay defenses
Ronald Cron1987a7c2024-03-14 19:05:26 +01004962 * defined in section 8 of the TLS 1.3 specification:
Ronald Cron3996ebc2024-03-15 14:57:05 +01004963 * single-use of tickets or ClientHello recording within a
4964 * given time window.
Ronald Cron1987a7c2024-03-14 19:05:26 +01004965 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01004966 * \note This function is used in conjunction with
Ronald Cron3a045622024-01-08 18:44:59 +01004967 * mbedtls_ssl_handshake(), mbedtls_ssl_handshake_step(),
4968 * mbedtls_ssl_read() and mbedtls_ssl_write() to read early
4969 * data when these functions return
4970 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA.
4971 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01004972 * \param ssl SSL context, it must have been initialized and set up.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02004973 * \param buf buffer that will hold the data
4974 * \param len maximum number of bytes to read
4975 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01004976 * \return The (positive) number of bytes read if successful.
Felix Conway37ede2c2025-08-18 14:46:39 +01004977 * \return #PSA_ERROR_INVALID_ARGUMENT if input data is invalid.
Ronald Croned7d4bf2024-01-31 07:55:19 +01004978 * \return #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA if it is not
4979 * possible to read early data for the SSL context \p ssl. Note
4980 * that this function is intended to be called for an SSL
4981 * context \p ssl only after a call to mbedtls_ssl_handshake(),
4982 * mbedtls_ssl_handshake_step(), mbedtls_ssl_read() or
4983 * mbedtls_ssl_write() for \p ssl that has returned
Ronald Cron3a045622024-01-08 18:44:59 +01004984 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02004985 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004986int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
4987 unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02004988#endif /* MBEDTLS_SSL_SRV_C */
4989
4990#if defined(MBEDTLS_SSL_CLI_C)
4991/**
4992 * \brief Try to write exactly 'len' application data bytes while
4993 * performing the handshake (early data).
4994 *
Ronald Crond4069242024-02-21 13:45:52 +01004995 * \warning Early data is defined in the TLS 1.3 specification, RFC 8446.
4996 * IMPORTANT NOTE from section 2.3 of the specification:
4997 *
4998 * The security properties for 0-RTT data are weaker than
4999 * those for other kinds of TLS data. Specifically:
5000 * - This data is not forward secret, as it is encrypted
5001 * solely under keys derived using the offered PSK.
5002 * - There are no guarantees of non-replay between connections.
5003 * Protection against replay for ordinary TLS 1.3 1-RTT data
5004 * is provided via the server's Random value, but 0-RTT data
5005 * does not depend on the ServerHello and therefore has
5006 * weaker guarantees. This is especially relevant if the
5007 * data is authenticated either with TLS client
5008 * authentication or inside the application protocol. The
5009 * same warnings apply to any use of the
5010 * early_exporter_master_secret.
5011 *
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005012 * \note This function behaves mainly as mbedtls_ssl_write(). The
5013 * specification of mbedtls_ssl_write() relevant to TLS 1.3
5014 * (thus not the parts specific to (D)TLS1.2) applies to this
Ronald Crond4069242024-02-21 13:45:52 +01005015 * function and the present documentation is mainly restricted
5016 * to the differences with mbedtls_ssl_write(). One noticeable
5017 * difference though is that mbedtls_ssl_write() aims to
5018 * complete the handshake before to write application data
5019 * while mbedtls_ssl_write_early() aims to drive the handshake
5020 * just past the point where it is not possible to send early
5021 * data anymore.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005022 *
5023 * \param ssl SSL context
5024 * \param buf buffer holding the data
5025 * \param len how many bytes must be written
5026 *
Ronald Crond4069242024-02-21 13:45:52 +01005027 * \return The (non-negative) number of bytes actually written if
5028 * successful (may be less than \p len).
5029 *
5030 * \return One additional specific error code compared to
5031 * mbedtls_ssl_write():
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005032 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA.
5033 *
5034 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA is returned when it
5035 * is not possible to write early data for the SSL context
5036 * \p ssl.
5037 *
5038 * It may have been possible and it is not possible
5039 * anymore because the client received the server Finished
5040 * message, the server rejected early data or the maximum
5041 * number of allowed early data for the PSK in use has been
5042 * reached.
5043 *
5044 * It may never have been possible and will never be possible
5045 * for the SSL context \p ssl because the use of early data
5046 * is disabled for that context or more generally the context
5047 * is not suitably configured to enable early data or the first
5048 * call to the function was done while the handshake was
5049 * already completed.
5050 *
5051 * It is not possible to write early data for the SSL context
Ronald Cron8f1de7e2024-02-22 12:02:39 +01005052 * \p ssl and any subsequent call to this API will return this
5053 * error code. But this does not preclude for using it with
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005054 * mbedtls_ssl_write(), mbedtls_ssl_read() or
Ronald Cron8f1de7e2024-02-22 12:02:39 +01005055 * mbedtls_ssl_handshake() and the handshake can be
5056 * completed by calling one of these APIs.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005057 *
5058 * \note This function may write early data only if the SSL context
5059 * has been configured for the handshake with a PSK for which
5060 * early data is allowed.
5061 *
5062 * \note To maximize the number of early data that can be written in
5063 * the course of the handshake, it is expected that this
5064 * function starts the handshake for the SSL context \p ssl.
5065 * But this is not mandatory.
5066 *
5067 * \note This function does not provide any information on whether
5068 * the server has accepted or will accept early data or not.
5069 * When it returns a positive value, it just means that it
5070 * has written early data to the server. To know whether the
5071 * server has accepted early data or not, you should call
5072 * mbedtls_ssl_get_early_data_status() with the handshake
5073 * completed.
5074 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005075int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5076 const unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005077
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005078/**
5079 * \brief Get the status of the negotiation of the use of early data.
5080 *
5081 * \param ssl The SSL context to query
5082 *
Felix Conway37ede2c2025-08-18 14:46:39 +01005083 * \return #PSA_ERROR_INVALID_ARGUMENT if this function is called
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005084 * from the server-side.
5085 *
Felix Conway37ede2c2025-08-18 14:46:39 +01005086 * \return #PSA_ERROR_INVALID_ARGUMENT if this function is called
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005087 * prior to completion of the handshake.
5088 *
Ronald Cron840de7f2024-03-11 17:49:35 +01005089 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_INDICATED if the client
5090 * has not indicated the use of early data to the server.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005091 *
5092 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED if the client has
5093 * indicated the use of early data and the server has accepted
5094 * it.
5095 *
5096 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED if the client has
5097 * indicated the use of early data but the server has rejected
5098 * it. In this situation, the client may want to re-send the
5099 * early data it may have tried to send by calling
5100 * mbedtls_ssl_write_early_data() as ordinary post-handshake
5101 * application data by calling mbedtls_ssl_write().
5102 *
5103 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005104int mbedtls_ssl_get_early_data_status(mbedtls_ssl_context *ssl);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005105#endif /* MBEDTLS_SSL_CLI_C */
5106
5107#endif /* MBEDTLS_SSL_EARLY_DATA */
5108
Paul Bakker5121ce52009-01-03 21:22:43 +00005109/**
Paul Bakker48916f92012-09-16 19:57:18 +00005110 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00005111 *
5112 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00005113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005114void mbedtls_ssl_free(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005115
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005116#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00005117/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005118 * \brief Save an active connection as serialized data in a buffer.
5119 * This allows the freeing or re-using of the SSL context
5120 * while still picking up the connection later in a way that
5121 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005122 *
5123 * \see mbedtls_ssl_context_load()
5124 *
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005125 * \note The serialized data only contains the data that is
5126 * necessary to resume the connection: negotiated protocol
5127 * options, session identifier, keys, etc.
5128 * Loading a saved SSL context does not restore settings and
5129 * state related to how the application accesses the context,
5130 * such as configured callback functions, user data, pending
5131 * incoming or outgoing data, etc.
5132 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005133 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005134 * conditions, see the documentation of the return value
Felix Conway37ede2c2025-08-18 14:46:39 +01005135 * #PSA_ERROR_INVALID_ARGUMENT for details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005136 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005137 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005138 * mbedtls_ssl_session_reset() on \p ssl which as a result is
5139 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005140 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005141 * state. You're then free to either re-use the context
5142 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005143 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005144 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005145 *
5146 * \param ssl The SSL context to save. On success, it is no longer
5147 * associated with the connection that has been serialized.
5148 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03005149 * writeable buffer of at least \p buf_len bytes, or may be \c
5150 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005151 * \param buf_len The number of bytes available for writing in \p buf.
5152 * \param olen The size in bytes of the data that has been or would have
5153 * been written. It must point to a valid \c size_t.
5154 *
5155 * \note \p olen is updated to the correct value regardless of
5156 * whether \p buf_len was large enough. This makes it possible
5157 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005158 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
5159 * the value of \p olen is only guaranteed to be correct when
Felix Conway37ede2c2025-08-18 14:46:39 +01005160 * the function returns #PSA_ERROR_BUFFER_TOO_SMALL or
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005161 * \c 0. If the return value is different, then the value of
5162 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005163 *
5164 * \return \c 0 if successful.
Felix Conway37ede2c2025-08-18 14:46:39 +01005165 * \return #PSA_ERROR_BUFFER_TOO_SMALL if \p buf is too small.
5166 * \return #PSA_ERROR_INSUFFICIENT_MEMORY if memory allocation failed
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005167 * while resetting the context.
Felix Conway37ede2c2025-08-18 14:46:39 +01005168 * \return #PSA_ERROR_INVALID_ARGUMENT if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005169 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005170 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005171 * ciphersuite, or renegotiation is enabled.
5172 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005173int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5174 unsigned char *buf,
5175 size_t buf_len,
5176 size_t *olen);
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005177
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005178/**
5179 * \brief Load serialized connection data to an SSL context.
5180 *
5181 * \see mbedtls_ssl_context_save()
5182 *
5183 * \warning The same serialized data must never be loaded into more
5184 * that one context. In order to ensure that, after
5185 * successfully loading serialized data to an SSL context, you
5186 * should immediately destroy or invalidate all copies of the
5187 * serialized data that was loaded. Loading the same data in
5188 * more than one context would cause severe security failures
5189 * including but not limited to loss of confidentiality.
5190 *
5191 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005192 * prepared in one of the two following ways. The first way is
5193 * to take a context freshly initialised with
5194 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005195 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005196 * the original connection. The second way is to
5197 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005198 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005199 * Either way, you must not use the context to perform a
5200 * handshake between calling mbedtls_ssl_setup() or
5201 * mbedtls_ssl_session_reset() and calling this function. You
5202 * may however call other setter functions in that time frame
5203 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005204 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005205 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005206 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005207 * and settings before you can use the connection again
5208 * (unless they were already set before calling
5209 * mbedtls_ssl_session_reset() and the values are suitable for
5210 * the present connection). Specifically, you want to call
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005211 * at least mbedtls_ssl_set_bio(),
5212 * mbedtls_ssl_set_timer_cb(), and
5213 * mbedtls_ssl_set_user_data_n() or
5214 * mbedtls_ssl_set_user_data_p() if they were set originally.
5215 * All other SSL setter functions
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02005216 * are not necessary to call, either because they're only used
5217 * in handshakes, or because the setting is already saved. You
5218 * might choose to call them anyway, for example in order to
5219 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005220 * connection and the case of loading an already-established
5221 * connection.
5222 *
5223 * \note If you have new information about the path MTU, you want to
5224 * call mbedtls_ssl_set_mtu() after calling this function, as
5225 * otherwise this function would overwrite your
5226 * newly-configured value with the value that was active when
5227 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005228 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005229 * \note When this function returns an error code, it calls
5230 * mbedtls_ssl_free() on \p ssl. In this case, you need to
5231 * prepare the context with the usual sequence starting with a
5232 * call to mbedtls_ssl_init() if you want to use it again.
5233 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005234 * \param ssl The SSL context structure to be populated. It must have
5235 * been prepared as described in the note above.
5236 * \param buf The buffer holding the serialized connection data. It must
5237 * be a readable buffer of at least \p len bytes.
5238 * \param len The size of the serialized data in bytes.
5239 *
5240 * \return \c 0 if successful.
Felix Conway37ede2c2025-08-18 14:46:39 +01005241 * \return #PSA_ERROR_INSUFFICIENT_MEMORY if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005242 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
5243 * comes from a different Mbed TLS version or build.
Felix Conway37ede2c2025-08-18 14:46:39 +01005244 * \return #PSA_ERROR_INVALID_ARGUMENT if input data is invalid.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005245 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005246int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl,
5247 const unsigned char *buf,
5248 size_t len);
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005249#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005250
5251/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005252 * \brief Initialize an SSL configuration context
5253 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005254 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005255 *
5256 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01005257 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005258 *
5259 * \param conf SSL configuration context
5260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005261void mbedtls_ssl_config_init(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005262
5263/**
Adam Wolf039080f2019-09-10 09:53:08 -05005264 * \brief Load reasonable default SSL configuration values.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005265 * (You need to call mbedtls_ssl_config_init() first.)
5266 *
5267 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005268 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
5269 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
5270 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005271 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005272 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02005273 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01005274 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005275 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005276 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005277 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005278int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5279 int endpoint, int transport, int preset);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005280
5281/**
5282 * \brief Free an SSL configuration context
5283 *
5284 * \param conf SSL configuration context
5285 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005286void mbedtls_ssl_config_free(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005287
5288/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005289 * \brief Initialize SSL session structure
5290 *
5291 * \param session SSL session
5292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005293void mbedtls_ssl_session_init(mbedtls_ssl_session *session);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005294
5295/**
Paul Bakker0a597072012-09-25 21:55:46 +00005296 * \brief Free referenced items in an SSL session including the
5297 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00005298 *
Ron Eldor00115032018-07-17 11:21:50 +03005299 * \note A session object can be freed even if the SSL context
5300 * that was used to retrieve the session is still in use.
5301 *
Paul Bakker48916f92012-09-16 19:57:18 +00005302 * \param session SSL session
5303 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005304void mbedtls_ssl_session_free(mbedtls_ssl_session *session);
Paul Bakker48916f92012-09-16 19:57:18 +00005305
Ron Eldor51d3ab52019-05-12 14:54:30 +03005306/**
5307 * \brief TLS-PRF function for key derivation.
5308 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005309 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005310 * \param secret Secret for the key derivation function.
5311 * \param slen Length of the secret.
5312 * \param label String label for the key derivation function,
5313 * terminated with null character.
5314 * \param random Random bytes.
5315 * \param rlen Length of the random bytes buffer.
5316 * \param dstbuf The buffer holding the derived key.
5317 * \param dlen Length of the output buffer.
5318 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005319 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005321int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
5322 const unsigned char *secret, size_t slen,
5323 const char *label,
5324 const unsigned char *random, size_t rlen,
5325 unsigned char *dstbuf, size_t dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +03005326
Max Fillingerc6fd1a22024-11-01 16:05:34 +01005327#if defined(MBEDTLS_SSL_KEYING_MATERIAL_EXPORT)
5328/* Maximum value for key_len in mbedtls_ssl_export_keying material. Depending on the TLS
5329 * version and the negotiated ciphersuite, larger keys could in principle be exported,
5330 * but for simplicity, we define one limit that works in all cases. TLS 1.3 with SHA256
5331 * has the strictest limit: 255 blocks of SHA256 output, or 8160 bytes. */
5332#define MBEDTLS_SSL_EXPORT_MAX_KEY_LEN 8160
5333
Max Fillinger7b722202024-09-21 10:48:57 +02005334/**
5335 * \brief TLS-Exporter to derive shared symmetric keys between server and client.
5336 *
5337 * \param ssl SSL context from which to export keys. Must have finished the handshake.
5338 * \param out Output buffer of length at least key_len bytes.
Max Fillingerc6fd1a22024-11-01 16:05:34 +01005339 * \param key_len Length of the key to generate in bytes, must be at most
5340 * MBEDTLS_SSL_EXPORT_MAX_KEY_LEN (8160).
Max Fillinger7b722202024-09-21 10:48:57 +02005341 * \param label Label for which to generate the key of length label_len.
Max Fillinger9c5bae52024-11-21 12:33:46 +01005342 * \param label_len Length of label in bytes. Must be at most 249 in TLS 1.3.
Max Fillinger7b722202024-09-21 10:48:57 +02005343 * \param context Context of the key. Can be NULL if context_len or use_context is 0.
5344 * \param context_len Length of context. Must be < 2^16 in TLS 1.2.
5345 * \param use_context Indicates if a context should be used in deriving the key.
5346 *
5347 * \note TLS 1.2 makes a distinction between a 0-length context and no context.
5348 * This is why the use_context argument exists. TLS 1.3 does not make
5349 * this distinction. If use_context is 0 and TLS 1.3 is used, context and
5350 * context_len are ignored and a 0-length context is used.
5351 *
Max Fillinger53d91682024-11-18 18:22:51 +01005352 * \return 0 on success.
Felix Conway37ede2c2025-08-18 14:46:39 +01005353 * \return #PSA_ERROR_INVALID_ARGUMENT if the handshake is not yet completed.
Max Fillinger53d91682024-11-18 18:22:51 +01005354 * \return An SSL-specific error on failure.
Max Fillinger7b722202024-09-21 10:48:57 +02005355 */
5356int mbedtls_ssl_export_keying_material(mbedtls_ssl_context *ssl,
Max Fillingere10c9842024-09-22 01:28:12 +02005357 uint8_t *out, const size_t key_len,
5358 const char *label, const size_t label_len,
5359 const unsigned char *context, const size_t context_len,
5360 const int use_context);
Max Fillinger281fb792024-10-23 18:35:09 +02005361#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00005362#ifdef __cplusplus
5363}
5364#endif
5365
5366#endif /* ssl.h */