blob: 6c37fc370322e39cc953947b4b54375c6c0ce39e [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
Jaeden Amero6609aef2019-07-04 20:01:14 +010017#include "mbedtls/bignum.h"
18#include "mbedtls/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)
Jaeden Amero6609aef2019-07-04 20:01:14 +010030#include "mbedtls/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. */
47#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
48/** 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 */
108#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
109/** 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 */
132#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
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
Paul Bakker5121ce52009-01-03 21:22:43 +0000168
169/*
Jerry Yue19e3b92022-07-08 12:04:51 +0000170 * Constants from RFC 8446 for TLS 1.3 PSK modes
171 *
172 * Those are used in the Pre-Shared Key Exchange Modes extension.
173 * See Section 4.2.9 in RFC 8446.
174 */
175#define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */
176#define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */
177
178/*
Jerry Yue226cef2021-08-27 22:06:20 +0800179 * TLS 1.3 NamedGroup values
180 *
181 * From RF 8446
182 * enum {
183 * // Elliptic Curve Groups (ECDHE)
184 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
185 * x25519(0x001D), x448(0x001E),
186 * // Finite Field Groups (DHE)
187 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
188 * ffdhe6144(0x0103), ffdhe8192(0x0104),
189 * // Reserved Code Points
190 * ffdhe_private_use(0x01FC..0x01FF),
191 * ecdhe_private_use(0xFE00..0xFEFF),
192 * (0xFFFF)
193 * } NamedGroup;
194 *
195 */
Brett Warrene0edc842021-08-17 09:53:13 +0100196
Jerry Yue226cef2021-08-27 22:06:20 +0800197/* Elliptic Curve Groups (ECDHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100198#define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0
199#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 0x0012
200#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 0x0013
201#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 0x0014
202#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 0x0015
203#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016
204#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017
205#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018
206#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019
207#define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A
208#define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B
209#define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C
210#define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D
211#define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E
Jerry Yue226cef2021-08-27 22:06:20 +0800212/* Finite Field Groups (DHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100213#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100
214#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101
215#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102
216#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103
217#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104
Jerry Yue226cef2021-08-27 22:06:20 +0800218
219/*
Hanno Becker71f1ed62021-07-24 06:01:47 +0100220 * TLS 1.3 Key Exchange Modes
221 *
222 * Mbed TLS internal identifiers for use with the SSL configuration API
223 * mbedtls_ssl_conf_tls13_key_exchange_modes().
224 */
225
Gilles Peskine449bd832023-01-11 14:50:10 +0100226#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 +0000227 * encompassing both externally agreed PSKs
228 * as well as resumption PSKs. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100229#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 +0000230 * including for example ECDHE and DHE
231 * key exchanges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100232#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 +0000233 * using both a PSK and an ephemeral
234 * key exchange. */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100235
236/* Convenience macros for sets of key exchanges. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000237#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100238 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
239 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
240 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL) /*!< All TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000241#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
243 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All PSK-based TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000244#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \
246 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All ephemeral TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE (0)
Jerry Yu77f01482022-07-11 07:03:24 +0000249
Hanno Becker71f1ed62021-07-24 06:01:47 +0100250/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000251 * Various constants
252 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100253
Glenn Straussd09b3432022-04-11 13:58:11 -0400254#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jan Bruckner25fdc2a2022-07-26 10:45:07 +0200255/* These are the high and low bytes of ProtocolVersion as defined by:
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100256 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
257 * - RFC 8446: see section 4.2.1
258 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200260#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100261#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 */
Glenn Straussd09b3432022-04-11 13:58:11 -0400262#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker5121ce52009-01-03 21:22:43 +0000263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
265#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100266
Simon Butcher9f812312015-09-28 19:22:33 +0100267#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200268#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
269
270#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 +0100271
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200272/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200273 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200274#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
275#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
276#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
277#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
278#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
279#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#define MBEDTLS_SSL_IS_CLIENT 0
282#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
285#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200286
Hanno Becker019f4b52019-04-09 15:12:56 +0100287#define MBEDTLS_SSL_CID_DISABLED 0
288#define MBEDTLS_SSL_CID_ENABLED 1
289
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200290#define MBEDTLS_SSL_ETM_DISABLED 0
291#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295#define MBEDTLS_SSL_VERIFY_NONE 0
296#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
297#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200298#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
301#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000302
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200303#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
304#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
307#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200309#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
310#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
313#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
314#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000315
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
317#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
318#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200319
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
321#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200322
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200323#define MBEDTLS_SSL_PRESET_DEFAULT 0
324#define MBEDTLS_SSL_PRESET_SUITEB 2
325
Janos Follath088ce432017-04-10 12:42:31 +0100326#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
327#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
328
Xiaokang Qian54413b12022-10-20 05:57:03 +0000329#define MBEDTLS_SSL_EARLY_DATA_DISABLED 0
330#define MBEDTLS_SSL_EARLY_DATA_ENABLED 1
331
Ron Eldor591f1622018-01-22 12:30:04 +0200332#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
333#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
334
TRodziewicz3946f792021-06-14 12:11:18 +0200335#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
336#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200337
Jerry Yu0a430c82022-07-20 11:02:48 +0800338#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200339#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu0a430c82022-07-20 11:02:48 +0800340#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200341#elif defined(PSA_WANT_ALG_SHA_256)
Jerry Yu0a430c82022-07-20 11:02:48 +0800342#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32
Przemek Stekiela9a88162022-09-02 13:18:55 +0200343#endif
Jerry Yu0a430c82022-07-20 11:02:48 +0800344#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200345/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200346 * Default range for DTLS retransmission timer value, in milliseconds.
347 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200349#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
350#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200351
Jerry Yu4caf3ca2023-11-15 16:13:47 +0800352/*
353 * Whether early data record should be discarded or not and how.
354 *
355 * The client has indicated early data and the server has rejected them.
356 * The server has then to skip past early data by either:
357 * - attempting to deprotect received records using the handshake traffic
358 * key, discarding records which fail deprotection (up to the configured
359 * max_early_data_size). Once a record is deprotected successfully,
360 * it is treated as the start of the client's second flight and the
361 * server proceeds as with an ordinary 1-RTT handshake.
362 * - skipping all records with an external content type of
363 * "application_data" (indicating that they are encrypted), up to the
364 * configured max_early_data_size. This is the expected behavior if the
365 * server has sent an HelloRetryRequest message. The server ignores
366 * application data message before 2nd ClientHello.
367 */
368#define MBEDTLS_SSL_EARLY_DATA_NO_DISCARD 0
369#define MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD 1
370#define MBEDTLS_SSL_EARLY_DATA_DISCARD 2
371
Paul Bakker088c5c52014-04-25 11:11:10 +0200372/**
373 * \name SECTION: Module settings
374 *
375 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200376 * Either change them in mbedtls_config.h or define them on the compiler command line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200377 * \{
378 */
379
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200380/*
Angus Grattond8213d02016-05-25 20:56:48 +1000381 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200382 * determines the size of each of the two internal I/O buffers.
383 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200384 * Note: the RFC defines the default size of SSL / TLS messages. If you
385 * change the value here, other clients / servers may not be able to
386 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200387 * both sides of the connection and have it reduced at both sides, or
388 * if you're using the Max Fragment Length extension and you know all your
389 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200390 */
Angus Grattond8213d02016-05-25 20:56:48 +1000391#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100392#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000393#endif
394
395#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100396#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000397#endif
398
Hanno Becker28007512018-08-28 09:46:44 +0100399/*
400 * Maximum number of heap-allocated bytes for the purpose of
401 * DTLS handshake message reassembly and future message buffering.
402 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100403#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100404#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100405#endif
406
Hanno Becker019f4b52019-04-09 15:12:56 +0100407/*
408 * Maximum length of CIDs for incoming and outgoing messages.
409 */
410#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100411#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100412#endif
413
414#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
415#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
416#endif
417
TRodziewicze8dd7092021-05-12 14:19:11 +0200418#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
419#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100420#endif
421
Tom Cosgrove3b4471e2023-09-14 12:59:50 +0100422#if !defined(MBEDTLS_SSL_MAX_EARLY_DATA_SIZE)
423#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
424#endif
425
Gilles Peskined65ea422023-09-05 21:07:32 +0200426#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE)
427#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
428#endif
429
430#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH)
431#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
432#endif
433
434#if !defined(MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS)
435#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
436#endif
437
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100438/** \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000439
440/*
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200441 * Default to standard CID mode
442 */
443#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
444 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT)
445#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
446#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000447
448/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100449 * Length of the verify data for secure renegotiation
450 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100452
453/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200454 * Signaling ciphersuite values (SCSV)
455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000457
Paul Bakker5121ce52009-01-03 21:22:43 +0000458/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000459 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200460 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000461 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462#define MBEDTLS_SSL_HASH_NONE 0
463#define MBEDTLS_SSL_HASH_MD5 1
464#define MBEDTLS_SSL_HASH_SHA1 2
465#define MBEDTLS_SSL_HASH_SHA224 3
466#define MBEDTLS_SSL_HASH_SHA256 4
467#define MBEDTLS_SSL_HASH_SHA384 5
468#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470#define MBEDTLS_SSL_SIG_ANON 0
471#define MBEDTLS_SSL_SIG_RSA 1
472#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000473
474/*
Hanno Becker551265f2021-08-10 13:03:48 +0100475 * TLS 1.3 signature algorithms
Yanray Wang55933a32023-11-22 16:34:15 +0800476 * RFC 8446, Section 4.2.3
Hanno Becker551265f2021-08-10 13:03:48 +0100477 */
478
479/* RSASSA-PKCS1-v1_5 algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000480#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401
481#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501
482#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601
Hanno Becker551265f2021-08-10 13:03:48 +0100483
484/* ECDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000485#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403
486#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503
487#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603
Hanno Becker551265f2021-08-10 13:03:48 +0100488
489/* RSASSA-PSS algorithms with public key OID rsaEncryption */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000490#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804
491#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805
492#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806
Hanno Becker551265f2021-08-10 13:03:48 +0100493
494/* EdDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000495#define MBEDTLS_TLS1_3_SIG_ED25519 0x0807
496#define MBEDTLS_TLS1_3_SIG_ED448 0x0808
Hanno Becker551265f2021-08-10 13:03:48 +0100497
498/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000499#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809
500#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A
501#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B
Hanno Becker551265f2021-08-10 13:03:48 +0100502
503/* LEGACY ALGORITHMS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000504#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201
505#define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203
Hanno Becker551265f2021-08-10 13:03:48 +0100506
Xiaofei Bai746f9482021-11-12 08:53:56 +0000507#define MBEDTLS_TLS1_3_SIG_NONE 0x0
Hanno Becker551265f2021-08-10 13:03:48 +0100508
509/*
Paul Bakker926af752012-11-23 13:38:07 +0100510 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200511 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100512 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200513#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
514#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100515
516/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000517 * Message, alert and handshake types
518 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200519#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
520#define MBEDTLS_SSL_MSG_ALERT 21
521#define MBEDTLS_SSL_MSG_HANDSHAKE 22
522#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100523#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000524
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200525#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
526#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000527
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
529#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
530#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
531#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
532#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
533#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
534#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
535#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
536#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
537#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
538#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
539#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
540#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
541#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
542#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
543#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
544#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
545#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
546#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
547#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
548#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
549#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
550#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
551#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
552#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000553#define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200554#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
555#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
556#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
XiaokangQian6b916b12022-04-25 07:29:34 +0000557#define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200558#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000559
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200560#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
561#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
562#define MBEDTLS_SSL_HS_SERVER_HELLO 2
563#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
564#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
Xiaokang Qian5b410072023-01-03 10:31:15 +0000565#define MBEDTLS_SSL_HS_END_OF_EARLY_DATA 5
566#define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200567#define MBEDTLS_SSL_HS_CERTIFICATE 11
568#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
569#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
570#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
571#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
572#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
573#define MBEDTLS_SSL_HS_FINISHED 20
XiaokangQian647719a2021-12-07 09:16:29 +0000574#define MBEDTLS_SSL_HS_MESSAGE_HASH 254
Paul Bakker5121ce52009-01-03 21:22:43 +0000575
576/*
577 * TLS extensions
578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579#define MBEDTLS_TLS_EXT_SERVERNAME 0
580#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000581
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200583
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200584#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800585#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200586
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200587#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800588#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 +0200589#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000590
Jerry Yub3317e12021-08-26 14:30:22 +0800591#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
Johan Pascalb62bb512015-12-03 21:56:45 +0100592#define MBEDTLS_TLS_EXT_USE_SRTP 14
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800593#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200595
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800596#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
Jerry Yu1bc2c1f2021-09-01 12:57:29 +0800597#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
598#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
599#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
601#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200602
Jan Bruckner151f6422023-02-10 12:45:19 +0100603#define MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT 28 /* RFC 8449 (implemented for TLS 1.3 only) */
604
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200606
Jerry Yub3317e12021-08-26 14:30:22 +0800607#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
608#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
609#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
610#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
611#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800612
Jerry Yub3317e12021-08-26 14:30:22 +0800613#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
614#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
615#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
616#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
617#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800618
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200619#if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
620#define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */
621#else
622#define MBEDTLS_TLS_EXT_CID 254 /* Pre-RFC 9146 DTLS 1.2 CID */
Gilles Peskine7dd2f502021-04-24 13:35:41 +0200623#endif
Hanno Becker0652bc52019-04-25 16:24:57 +0100624
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200625#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
626
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000628
Johan Pascalb62bb512015-12-03 21:56:45 +0100629/*
Paul Bakkered27a042013-04-18 22:46:23 +0200630 * Size defines
631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632#if !defined(MBEDTLS_PSK_MAX_LEN)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100633/*
634 * If the library supports TLS 1.3 tickets and the cipher suite
635 * TLS1-3-AES-256-GCM-SHA384, set the PSK maximum length to 48 instead of 32.
636 * That way, the TLS 1.3 client and server are able to resume sessions where
Ronald Cronee54de02023-02-24 12:06:30 +0100637 * the cipher suite is TLS1-3-AES-256-GCM-SHA384 (pre-shared keys are 48
638 * bytes long in that case).
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100639 */
640#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
641 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Elena Uziunaite83a0d9d2024-07-05 11:41:22 +0100642 defined(PSA_WANT_KEY_TYPE_AES) && defined(PSA_WANT_ALG_GCM) && \
Elena Uziunaitecf5e3dd2024-06-26 10:49:49 +0100643 defined(PSA_WANT_ALG_SHA_384)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100644#define MBEDTLS_PSK_MAX_LEN 48 /* 384 bits */
645#else
646#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200647#endif
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100648#endif /* !MBEDTLS_PSK_MAX_LEN */
Paul Bakkered27a042013-04-18 22:46:23 +0200649
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200650/* Dummy type used only for its size */
Gilles Peskine449bd832023-01-11 14:50:10 +0100651union mbedtls_ssl_premaster_secret {
Gilles Peskinee8e1e152023-06-25 21:41:58 +0200652 unsigned char dummy; /* Make the union non-empty even with SSL disabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200653#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
654 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
655 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
656 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
657 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200658#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200659#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
660 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200661#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200662#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
663 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
Gilles Peskine449bd832023-01-11 14:50:10 +0100664 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200665#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200666#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
667 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
668#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200669};
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671#define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200672
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200673#define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200674
XiaokangQianc5c39d52021-11-09 11:55:10 +0000675
Jerry Yud96a5c22021-09-29 17:46:51 +0800676/* Length in number of bytes of the TLS sequence number */
Jerry Yuae0b2e22021-10-08 15:21:19 +0800677#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8
Jerry Yu957f0fa2021-09-24 10:27:07 +0800678
Paul Bakker407a0da2013-06-27 14:29:21 +0200679#ifdef __cplusplus
680extern "C" {
681#endif
682
Paul Bakkered27a042013-04-18 22:46:23 +0200683/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000684 * SSL state machine
685 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687 MBEDTLS_SSL_HELLO_REQUEST,
688 MBEDTLS_SSL_CLIENT_HELLO,
689 MBEDTLS_SSL_SERVER_HELLO,
690 MBEDTLS_SSL_SERVER_CERTIFICATE,
691 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
692 MBEDTLS_SSL_CERTIFICATE_REQUEST,
693 MBEDTLS_SSL_SERVER_HELLO_DONE,
694 MBEDTLS_SSL_CLIENT_CERTIFICATE,
695 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
696 MBEDTLS_SSL_CERTIFICATE_VERIFY,
697 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
698 MBEDTLS_SSL_CLIENT_FINISHED,
699 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
700 MBEDTLS_SSL_SERVER_FINISHED,
701 MBEDTLS_SSL_FLUSH_BUFFERS,
702 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
Jerry Yua357cf42022-07-12 05:36:45 +0000703 MBEDTLS_SSL_NEW_SESSION_TICKET,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200704 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000705 MBEDTLS_SSL_HELLO_RETRY_REQUEST,
Jerry Yua13c7e72021-08-17 10:44:40 +0800706 MBEDTLS_SSL_ENCRYPTED_EXTENSIONS,
Xiaokang Qian125afcb2022-10-28 06:04:06 +0000707 MBEDTLS_SSL_END_OF_EARLY_DATA,
Jerry Yu687101b2021-09-14 16:03:56 +0800708 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY,
Ronald Cron49ad6192021-11-24 16:25:31 +0100709 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED,
XiaokangQian647719a2021-12-07 09:16:29 +0000710 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO,
Gabor Mezei7b39bf12022-05-24 16:04:14 +0200711 MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO,
Xiaokang Qian592021a2023-01-04 10:47:05 +0000712 MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO,
Gabor Mezeif7044ea2022-06-28 16:01:49 +0200713 MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST,
Jerry Yu5ed73ff2022-10-27 13:08:42 +0800714 MBEDTLS_SSL_HANDSHAKE_OVER,
Jerry Yua8d3c502022-10-30 14:51:23 +0800715 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET,
716 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH,
Paul Bakker5121ce52009-01-03 21:22:43 +0000717}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200718mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000719
Ronald Crond6d32b92024-02-14 12:01:50 +0100720/*
721 * Early data status, client side only.
722 */
723
724#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
725typedef enum {
726/*
Ronald Crond6d32b92024-02-14 12:01:50 +0100727 * See documentation of mbedtls_ssl_get_early_data_status().
728 */
Ronald Cron840de7f2024-03-11 17:49:35 +0100729 MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_INDICATED,
Ronald Crond6d32b92024-02-14 12:01:50 +0100730 MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED,
731 MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED,
Ronald Crond6d32b92024-02-14 12:01:50 +0100732} mbedtls_ssl_early_data_status;
Ronald Crond6d32b92024-02-14 12:01:50 +0100733#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
734
Simon Butchere846b512016-03-01 17:31:49 +0000735/**
736 * \brief Callback type: send data on the network.
737 *
738 * \note That callback may be either blocking or non-blocking.
739 *
740 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000741 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000742 * \param len Length of the data to send
743 *
744 * \return The callback must return the number of bytes sent if any,
745 * or a non-zero error code.
746 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
747 * must be returned when the operation would block.
748 *
Simon Butcherd567a232016-03-09 20:19:21 +0000749 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000750 * It must always return the number of bytes actually sent.
751 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100752typedef int mbedtls_ssl_send_t(void *ctx,
753 const unsigned char *buf,
754 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000755
756/**
757 * \brief Callback type: receive data from the network.
758 *
759 * \note That callback may be either blocking or non-blocking.
760 *
761 * \param ctx Context for the receive callback (typically a file
762 * descriptor)
763 * \param buf Buffer to write the received data to
764 * \param len Length of the receive buffer
765 *
Hanno Becker218dec82021-07-23 07:23:47 +0100766 * \returns If data has been received, the positive number of bytes received.
767 * \returns \c 0 if the connection has been closed.
768 * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
Simon Butchere846b512016-03-01 17:31:49 +0000769 * must be returned when the operation would block.
Hanno Becker218dec82021-07-23 07:23:47 +0100770 * \returns Another negative error code on other kinds of failures.
Simon Butchere846b512016-03-01 17:31:49 +0000771 *
Simon Butcherd567a232016-03-09 20:19:21 +0000772 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000773 * buffer. It must always return the number of bytes actually
774 * received and written to the buffer.
775 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100776typedef int mbedtls_ssl_recv_t(void *ctx,
777 unsigned char *buf,
778 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000779
780/**
781 * \brief Callback type: receive data from the network, with timeout
782 *
783 * \note That callback must block until data is received, or the
784 * timeout delay expires, or the operation is interrupted by a
785 * signal.
786 *
787 * \param ctx Context for the receive callback (typically a file descriptor)
788 * \param buf Buffer to write the received data to
789 * \param len Length of the receive buffer
Andrey Starodubtsev90cc33a2021-08-23 12:14:56 +0300790 * \param timeout Maximum number of milliseconds to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000791 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000792 *
793 * \return The callback must return the number of bytes received,
794 * or a non-zero error code:
795 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
796 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
797 *
Simon Butcherd567a232016-03-09 20:19:21 +0000798 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000799 * buffer. It must always return the number of bytes actually
800 * received and written to the buffer.
801 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100802typedef int mbedtls_ssl_recv_timeout_t(void *ctx,
803 unsigned char *buf,
804 size_t len,
805 uint32_t timeout);
Simon Butchere846b512016-03-01 17:31:49 +0000806/**
807 * \brief Callback type: set a pair of timers/delays to watch
808 *
809 * \param ctx Context pointer
810 * \param int_ms Intermediate delay in milliseconds
811 * \param fin_ms Final delay in milliseconds
812 * 0 cancels the current timer.
813 *
814 * \note This callback must at least store the necessary information
815 * for the associated \c mbedtls_ssl_get_timer_t callback to
816 * return correct information.
817 *
Tom Cosgrovece7f18c2022-07-28 05:50:56 +0100818 * \note If using an event-driven style of programming, an event must
Simon Butchere846b512016-03-01 17:31:49 +0000819 * be generated when the final delay is passed. The event must
820 * cause a call to \c mbedtls_ssl_handshake() with the proper
821 * SSL context to be scheduled. Care must be taken to ensure
822 * that at most one such call happens at a time.
823 *
824 * \note Only one timer at a time must be running. Calling this
825 * function while a timer is running must cancel it. Cancelled
826 * timers must not generate any event.
827 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100828typedef void mbedtls_ssl_set_timer_t(void *ctx,
829 uint32_t int_ms,
830 uint32_t fin_ms);
Simon Butchere846b512016-03-01 17:31:49 +0000831
832/**
833 * \brief Callback type: get status of timers/delays
834 *
835 * \param ctx Context pointer
836 *
837 * \return This callback must return:
838 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000839 * 0 if none of the delays have passed,
840 * 1 if only the intermediate delay has passed,
841 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000842 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100843typedef int mbedtls_ssl_get_timer_t(void *ctx);
Simon Butchere846b512016-03-01 17:31:49 +0000844
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200845/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846typedef struct mbedtls_ssl_session mbedtls_ssl_session;
847typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200848typedef struct mbedtls_ssl_config mbedtls_ssl_config;
849
Chris Jones3848e312021-03-11 16:17:59 +0000850/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200851typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
852typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100853typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200854#if defined(MBEDTLS_X509_CRT_PARSE_C)
855typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200856#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200857#if defined(MBEDTLS_SSL_PROTO_DTLS)
858typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200859#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000860
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000861#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000862#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100863 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000864#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100865 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */
866#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA (1U << 3)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000867
868#define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 (MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \
870 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \
871 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000872#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000873
Hanno Becker02487852021-05-13 06:26:57 +0100874/**
875 * \brief Callback type: server-side session cache getter
876 *
877 * The session cache is logically a key value store, with
878 * keys being session IDs and values being instances of
879 * mbedtls_ssl_session.
880 *
881 * This callback retrieves an entry in this key-value store.
882 *
883 * \param data The address of the session cache structure to query.
884 * \param session_id The buffer holding the session ID to query.
885 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100886 * \param session The address of the session structure to populate.
887 * It is initialized with mbdtls_ssl_session_init(),
888 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100889 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100890 * mbedtls_ssl_session_free() independent of the
891 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100892 *
893 * \return \c 0 on success
894 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100895 *
Hanno Becker02487852021-05-13 06:26:57 +0100896 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100897typedef int mbedtls_ssl_cache_get_t(void *data,
898 unsigned char const *session_id,
899 size_t session_id_len,
900 mbedtls_ssl_session *session);
Hanno Becker02487852021-05-13 06:26:57 +0100901/**
902 * \brief Callback type: server-side session cache setter
903 *
904 * The session cache is logically a key value store, with
905 * keys being session IDs and values being instances of
906 * mbedtls_ssl_session.
907 *
908 * This callback sets an entry in this key-value store.
909 *
910 * \param data The address of the session cache structure to modify.
911 * \param session_id The buffer holding the session ID to query.
912 * \param session_id_len The length of \p session_id in Bytes.
913 * \param session The address of the session to be stored in the
914 * session cache.
915 *
916 * \return \c 0 on success
917 * \return A non-zero return value on failure.
918 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100919typedef int mbedtls_ssl_cache_set_t(void *data,
920 unsigned char const *session_id,
921 size_t session_id_len,
922 const mbedtls_ssl_session *session);
Hanno Beckera637ff62021-04-15 08:42:48 +0100923
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200924#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100925#if defined(MBEDTLS_X509_CRT_PARSE_C)
926/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200927 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100928 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200929 * This callback is called during an SSL handshake to start
930 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200931 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100932 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200933 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100934 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200935 * This function typically sends or enqueues a request, and
936 * does not wait for the operation to complete. This allows
937 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100938 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200939 * The parameters \p ssl and \p cert are guaranteed to remain
940 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200941 * function must save the contents of \p hash if the value
942 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200943 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100944 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200945 * This function may call mbedtls_ssl_set_async_operation_data()
946 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200947 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200948 *
Gilles Peskined3268832018-04-26 06:23:59 +0200949 * \note For RSA signatures, this function must produce output
950 * that is consistent with PKCS#1 v1.5 in the same way as
951 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
952 * apply the padding steps described in RFC 8017, section 9.2
953 * "EMSA-PKCS1-v1_5" as follows.
954 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
955 * encoding, treating \p hash as the DigestInfo to be
956 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
957 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200958 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200959 * encoding, treating \p hash as the hash to be encoded and
960 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
961 * from step 2, with `digestAlgorithm` obtained by calling
962 * mbedtls_oid_get_oid_by_md() on \p md_alg.
963 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200964 * \note For ECDSA signatures, the output format is the DER encoding
965 * `Ecdsa-Sig-Value` defined in
966 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
967 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200968 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200969 * modified other than via
970 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200971 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200972 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200973 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200974 * connection. However, if other callbacks are used, this
975 * property may not hold. For example, if an SNI callback
976 * is registered with mbedtls_ssl_conf_sni(), then
977 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200978 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100979 * \param hash Buffer containing the hash. This buffer is
980 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200981 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100982 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200983 * \return 0 if the operation was started successfully and the SSL
984 * stack should call the resume callback immediately.
985 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
986 * was started successfully and the SSL stack should return
987 * immediately without calling the resume callback yet.
988 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
989 * processor does not support this key. The SSL stack will
990 * use the private key object instead.
991 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200992 * propagated up the call chain. The callback should
993 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
994 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200995 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100996 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100997typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl,
998 mbedtls_x509_crt *cert,
999 mbedtls_md_type_t md_alg,
1000 const unsigned char *hash,
1001 size_t hash_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001002#endif /* MBEDTLS_X509_CRT_PARSE_C */
1003
1004/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001005 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001006 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001007 * This callback is called during an SSL handshake to resume
1008 * an external operation started by the
Gabor Mezeie99e5912025-02-27 13:41:24 +01001009 * ::mbedtls_ssl_async_sign_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +02001010 *
1011 * This function typically checks the status of a pending
1012 * request or causes the request queue to make progress, and
1013 * does not wait for the operation to complete. This allows
1014 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001015 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001016 * This function may call mbedtls_ssl_get_async_operation_data()
1017 * to retrieve an operation context set by the start callback.
1018 * It may call mbedtls_ssl_set_async_operation_data() to modify
1019 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001020 *
Gilles Peskineea5fab82018-04-30 13:57:45 +02001021 * Note that when this function returns a status other than
1022 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
1023 * resources associated with the operation.
1024 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001025 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +02001026 * modified other than via
1027 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +02001028 * \param output Buffer containing the output (signature or decrypted
1029 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +02001030 * \param output_len On success, number of bytes written to \p output.
1031 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001032 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001033 * \return 0 if output of the operation is available in the
1034 * \p output buffer.
1035 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1036 * is still in progress. Subsequent requests for progress
1037 * on the SSL connection will call the resume callback
1038 * again.
1039 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001040 * The SSL handshake is aborted. The callback should
1041 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1042 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001043 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001044 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001045typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl,
1046 unsigned char *output,
1047 size_t *output_len,
1048 size_t output_size);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001049
1050/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001051 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001052 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001053 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +02001054 * while an asynchronous operation is in progress. Note that
1055 * this callback is not called if the
1056 * ::mbedtls_ssl_async_resume_t callback has run and has
1057 * returned a value other than
1058 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
1059 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001060 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001061 * This function may call mbedtls_ssl_get_async_operation_data()
1062 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001063 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001064 * \param ssl The SSL connection instance. It should not be
1065 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001066 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001067typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001068#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +00001069
Gilles Peskineeccd8882020-03-10 12:19:08 +01001070#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001071 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +00001072#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
Elena Uziunaite4e6a3682024-06-26 13:28:50 +01001073#if defined(PSA_WANT_ALG_SHA_256)
Hanno Becker9198ad12019-02-05 17:00:50 +00001074#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1075#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Elena Uziunaitecf5e3dd2024-06-26 10:49:49 +01001076#elif defined(PSA_WANT_ALG_SHA_384)
Hanno Becker9198ad12019-02-05 17:00:50 +00001077#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1078#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
Elena Uziunaite9fc5be02024-09-04 18:12:59 +01001079#elif defined(PSA_WANT_ALG_SHA_1)
Hanno Becker9198ad12019-02-05 17:00:50 +00001080#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1081#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1082#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001083/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +00001084#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1085#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +01001086#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001087 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001088
Gilles Peskine449bd832023-01-11 14:50:10 +01001089typedef struct {
1090 unsigned char client_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1091 unsigned char server_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1092 unsigned char exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1093 unsigned char resumption_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Bai746f9482021-11-12 08:53:56 +00001094} mbedtls_ssl_tls13_application_secrets;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001095
Johan Pascalb62bb512015-12-03 21:56:45 +01001096#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001097
Johan Pascal85269572020-08-25 10:01:54 +02001098#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +02001099#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +01001100/*
Johan Pascal43f94902020-09-22 12:25:52 +02001101 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001102 *
1103 * Use_srtp extension protection profiles values as defined in
1104 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1105 *
1106 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1107 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +01001108 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001109#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001)
1110#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002)
1111#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005)
1112#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001113/* This one is not iana defined, but for code readability. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001114#define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001115
Johan Pascal43f94902020-09-22 12:25:52 +02001116typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +03001117
Gilles Peskine449bd832023-01-11 14:50:10 +01001118typedef struct mbedtls_dtls_srtp_info_t {
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001119 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001120 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +02001121 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001122 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001123 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001124 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +03001125}
1126mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +02001127
Johan Pascalb62bb512015-12-03 21:56:45 +01001128#endif /* MBEDTLS_SSL_DTLS_SRTP */
1129
Glenn Straussdff84622022-03-14 11:12:57 -04001130/** Human-friendly representation of the (D)TLS protocol version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001131typedef enum {
Glenn Straussdff84622022-03-14 11:12:57 -04001132 MBEDTLS_SSL_VERSION_UNKNOWN, /*!< Context not in use or version not yet negotiated. */
1133 MBEDTLS_SSL_VERSION_TLS1_2 = 0x0303, /*!< (D)TLS 1.2 */
1134 MBEDTLS_SSL_VERSION_TLS1_3 = 0x0304, /*!< (D)TLS 1.3 */
1135} mbedtls_ssl_protocol_version;
1136
Paul Bakker5121ce52009-01-03 21:22:43 +00001137/*
Paul Bakker0a597072012-09-25 21:55:46 +00001138 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001139 *
1140 * Note: when changing this definition, we need to check and update:
1141 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02001142 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001143 * - in library/ssl_tls.c:
1144 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1145 * mbedtls_ssl_session_save() and ssl_session_load()
1146 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +00001147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001148struct mbedtls_ssl_session {
Gilles Peskine8834d872021-11-29 12:36:50 +01001149#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1150 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
1151#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1152
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001153/*!< RecordSizeLimit received from the peer */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001154#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1155 uint16_t MBEDTLS_PRIVATE(record_size_limit);
1156#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1157
Gilles Peskine8834d872021-11-29 12:36:50 +01001158 unsigned char MBEDTLS_PRIVATE(exported);
Ronald Cron7fdee8b2024-02-09 09:26:12 +01001159 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskine8834d872021-11-29 12:36:50 +01001160
Ronald Cron217d6992022-04-04 10:23:22 +02001161 /** TLS version negotiated in the session. Used if and when renegotiating
1162 * or resuming a session instead of the configured minor TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001163 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001164 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Gilles Peskine8834d872021-11-29 12:36:50 +01001165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001166#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu702fc592023-10-31 14:22:04 +08001167 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< start time of current session */
Paul Bakkerfa9b1002013-07-03 15:31:03 +02001168#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001169 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001170 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
1171 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
1172 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +02001173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001174#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +00001175#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001176 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +00001177#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001178 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
1179 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +02001180 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1181 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1182 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +00001183#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001185 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +02001186
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001187#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001188 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
1189 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
1190 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001191#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001192
Ronald Crond1c106c2023-11-22 09:14:02 +01001193#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C) && \
1194 defined(MBEDTLS_HAVE_TIME)
Ronald Cron3c0072b2023-11-22 10:00:14 +01001195 /*! When a ticket is created by a TLS server as part of an established TLS
1196 * session, the ticket creation time may need to be saved for the ticket
1197 * module to be able to check the ticket age when the ticket is used.
1198 * That's the purpose of this field.
1199 * Before creating a new ticket, an Mbed TLS server set this field with
1200 * its current time in milliseconds. This time may then be saved in the
1201 * session ticket data by the session ticket writing function and
1202 * recovered by the ticket parsing function later when the ticket is used.
1203 * The ticket module may then use this time to compute the ticket age and
1204 * determine if it has expired or not.
1205 * The Mbed TLS implementations of the session ticket writing and parsing
1206 * functions save and retrieve the ticket creation time as part of the
1207 * session ticket data. The session ticket parsing function relies on
1208 * the mbedtls_ssl_session_get_ticket_creation_time() API to get the
1209 * ticket creation time from the session ticket data.
1210 */
Ronald Crond1c106c2023-11-22 09:14:02 +01001211 mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_creation_time);
1212#endif
1213
Jerry Yua270f672022-07-07 06:51:06 +00001214#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron7fdee8b2024-02-09 09:26:12 +01001215 uint32_t MBEDTLS_PRIVATE(ticket_age_add); /*!< Randomly generated value used to obscure the age of the ticket */
1216 uint8_t MBEDTLS_PRIVATE(ticket_flags); /*!< Ticket flags */
1217 uint8_t MBEDTLS_PRIVATE(resumption_key_len); /*!< resumption_key length */
Jerry Yu0a430c82022-07-20 11:02:48 +08001218 unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN];
Jerry Yua270f672022-07-07 06:51:06 +00001219
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00001220#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C)
1221 char *MBEDTLS_PRIVATE(hostname); /*!< host name binded with tickets */
1222#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */
1223
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00001224#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy5bc52632024-03-12 16:25:08 +00001225 char *ticket_alpn; /*!< ALPN negotiated in the session
1226 during which the ticket was generated. */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00001227#endif
1228
Ronald Crond1c106c2023-11-22 09:14:02 +01001229#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_CLI_C)
1230 /*! Time in milliseconds when the last ticket was received. */
1231 mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_reception_time);
Jerry Yu25ba4d42023-11-10 14:12:20 +08001232#endif
Jerry Yua270f672022-07-07 06:51:06 +00001233#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
1234
Jerry Yu02e3a072022-12-12 15:13:20 +08001235#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu6c485da2023-11-15 10:18:47 +08001236 uint32_t MBEDTLS_PRIVATE(max_early_data_size); /*!< maximum amount of early data in tickets */
Jerry Yu02e3a072022-12-12 15:13:20 +08001237#endif
1238
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001239#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001240 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001241#endif
XiaokangQian33062842021-11-11 03:37:45 +00001242
Ronald Cron6f135e12021-12-08 16:57:54 +01001243#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001244 mbedtls_ssl_tls13_application_secrets MBEDTLS_PRIVATE(app_secrets);
Xiaokang Qianbaa47642022-10-12 10:21:27 +00001245#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001246};
1247
Hanno Becker457d6162021-05-24 10:27:39 +01001248/*
1249 * Identifiers for PRFs used in various versions of TLS.
1250 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001251typedef enum {
1252 MBEDTLS_SSL_TLS_PRF_NONE,
1253 MBEDTLS_SSL_TLS_PRF_SHA384,
1254 MBEDTLS_SSL_TLS_PRF_SHA256,
1255 MBEDTLS_SSL_HKDF_EXPAND_SHA384,
1256 MBEDTLS_SSL_HKDF_EXPAND_SHA256
Hanno Becker457d6162021-05-24 10:27:39 +01001257}
1258mbedtls_tls_prf_types;
1259
Gilles Peskine449bd832023-01-11 14:50:10 +01001260typedef enum {
Hanno Becker457d6162021-05-24 10:27:39 +01001261 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0,
Ronald Cron6f135e12021-12-08 16:57:54 +01001262#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001263 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1264 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET,
1265 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1266 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1267 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
1268 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
Ronald Cron6f135e12021-12-08 16:57:54 +01001269#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker457d6162021-05-24 10:27:39 +01001270} mbedtls_ssl_key_export_type;
1271
1272/**
1273 * \brief Callback type: Export key alongside random values for
1274 * session identification, and PRF for
1275 * implementation of TLS key exporters.
1276 *
Hanno Beckerddc739c2021-05-28 05:10:38 +01001277 * \param p_expkey Context for the callback.
1278 * \param type The type of the key that is being exported.
1279 * \param secret The address of the buffer holding the secret
1280 * that's being exporterd.
1281 * \param secret_len The length of \p secret in bytes.
Hanno Becker457d6162021-05-24 10:27:39 +01001282 * \param client_random The client random bytes.
1283 * \param server_random The server random bytes.
1284 * \param tls_prf_type The identifier for the PRF used in the handshake
1285 * to which the key belongs.
Hanno Becker457d6162021-05-24 10:27:39 +01001286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287typedef void mbedtls_ssl_export_keys_t(void *p_expkey,
1288 mbedtls_ssl_key_export_type type,
1289 const unsigned char *secret,
1290 size_t secret_len,
1291 const unsigned char client_random[32],
1292 const unsigned char server_random[32],
1293 mbedtls_tls_prf_types tls_prf_type);
Hanno Becker457d6162021-05-24 10:27:39 +01001294
Glenn Strauss236e17e2022-03-13 23:39:40 -04001295#if defined(MBEDTLS_SSL_SRV_C)
1296/**
1297 * \brief Callback type: generic handshake callback
1298 *
1299 * \note Callbacks may use user_data funcs to set/get app user data.
1300 * See \c mbedtls_ssl_get_user_data_p()
1301 * \c mbedtls_ssl_get_user_data_n()
1302 * \c mbedtls_ssl_conf_get_user_data_p()
1303 * \c mbedtls_ssl_conf_get_user_data_n()
1304 *
1305 * \param ssl \c mbedtls_ssl_context on which the callback is run
1306 *
1307 * \return The return value of the callback is 0 if successful,
1308 * or a specific MBEDTLS_ERR_XXX code, which will cause
1309 * the handshake to be aborted.
1310 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001311typedef int (*mbedtls_ssl_hs_cb_t)(mbedtls_ssl_context *ssl);
Glenn Strauss236e17e2022-03-13 23:39:40 -04001312#endif
1313
Gilles Peskineded2a422022-02-12 00:20:08 +01001314/* A type for storing user data in a library structure.
1315 *
1316 * The representation of type may change in future versions of the library.
1317 * Only the behaviors guaranteed by documented accessor functions are
1318 * guaranteed to remain stable.
1319 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001320typedef union {
Gilles Peskineded2a422022-02-12 00:20:08 +01001321 uintptr_t n; /* typically a handle to an associated object */
1322 void *p; /* typically a pointer to extra data */
1323} mbedtls_ssl_user_data_t;
1324
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001325/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001326 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001328struct mbedtls_ssl_config {
Gilles Peskine8834d872021-11-29 12:36:50 +01001329 /* Group items mostly by size. This helps to reduce memory wasted to
1330 * padding. It also helps to keep smaller fields early in the structure,
1331 * so that elements tend to be in the 128-element direct access window
1332 * on Arm Thumb, which reduces the code size. */
1333
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001334 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(max_tls_version); /*!< max. TLS version used */
1335 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(min_tls_version); /*!< min. TLS version used */
Gilles Peskine8834d872021-11-29 12:36:50 +01001336
1337 /*
Gilles Peskine533a7282021-11-16 18:31:46 +01001338 * Flags (could be bit-fields to save RAM, but separate bytes make
1339 * the code smaller on architectures with an instruction for direct
1340 * byte access).
Gilles Peskine8834d872021-11-29 12:36:50 +01001341 */
1342
Gilles Peskine533a7282021-11-16 18:31:46 +01001343 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001344 uint8_t MBEDTLS_PRIVATE(transport); /*!< 0: stream (TLS), 1: datagram (DTLS) */
Gilles Peskine533a7282021-11-16 18:31:46 +01001345 uint8_t MBEDTLS_PRIVATE(authmode); /*!< MBEDTLS_SSL_VERIFY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001346 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Gilles Peskine533a7282021-11-16 18:31:46 +01001347 uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation); /*!< MBEDTLS_LEGACY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001348#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001349 uint8_t MBEDTLS_PRIVATE(mfl_code); /*!< desired fragment length indicator
1350 (MBEDTLS_SSL_MAX_FRAG_LEN_XXX) */
Gilles Peskine8834d872021-11-29 12:36:50 +01001351#endif
1352#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine533a7282021-11-16 18:31:46 +01001353 uint8_t MBEDTLS_PRIVATE(encrypt_then_mac); /*!< negotiate encrypt-then-mac? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001354#endif
1355#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine533a7282021-11-16 18:31:46 +01001356 uint8_t MBEDTLS_PRIVATE(extended_ms); /*!< negotiate extended master secret? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001357#endif
1358#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine533a7282021-11-16 18:31:46 +01001359 uint8_t MBEDTLS_PRIVATE(anti_replay); /*!< detect and prevent replay? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001360#endif
1361#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine533a7282021-11-16 18:31:46 +01001362 uint8_t MBEDTLS_PRIVATE(disable_renegotiation); /*!< disable renegotiation? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001363#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001364#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1365 defined(MBEDTLS_SSL_CLI_C)
1366 uint8_t MBEDTLS_PRIVATE(session_tickets); /*!< use session tickets? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001367#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001368
1369#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1370 defined(MBEDTLS_SSL_SRV_C) && \
1371 defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yud0766ec2022-09-22 10:46:57 +08001372 uint16_t MBEDTLS_PRIVATE(new_session_tickets_count); /*!< number of NewSessionTicket */
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001373#endif
1374
Gilles Peskine8834d872021-11-29 12:36:50 +01001375#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine533a7282021-11-16 18:31:46 +01001376 uint8_t MBEDTLS_PRIVATE(cert_req_ca_list); /*!< enable sending CA list in
1377 Certificate Request messages? */
1378 uint8_t MBEDTLS_PRIVATE(respect_cli_pref); /*!< pick the ciphersuite according to
1379 the client's preferences rather
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001380 than ours? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001381#endif
1382#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001383 uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid); /*!< Should DTLS record with
1384 * unexpected CID
1385 * lead to failure? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001386#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1387#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine533a7282021-11-16 18:31:46 +01001388 uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001389 in the use_srtp extension? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001390#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001391
1392 /*
1393 * Pointers
1394 */
1395
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001396 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +02001397 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001398
Ronald Cron6f135e12021-12-08 16:57:54 +01001399#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001400 /** Allowed TLS 1.3 key exchange modes. */
1401 int MBEDTLS_PRIVATE(tls13_kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01001402#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001403
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001404 /** Callback for printing debug output */
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 void(*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001406 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001407
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001408 /** Callback for getting (pseudo-)random numbers */
Gilles Peskine449bd832023-01-11 14:50:10 +01001409 int(*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001410 void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001411
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001412 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001413 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001414 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001415 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
1416 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001417
1418#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1419 /** Callback for setting cert according to SNI extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 int(*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001421 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001422#endif
1423
1424#if defined(MBEDTLS_X509_CRT_PARSE_C)
1425 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001427 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001428#endif
1429
Ronald Cron73fe8df2022-10-05 14:31:43 +02001430#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Jerry Yu8897c072022-08-12 13:56:53 +08001431#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001432 /** Callback to retrieve PSK key from identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 int(*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001434 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001435#endif
Jerry Yu8897c072022-08-12 13:56:53 +08001436#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001437
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001438#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Tom Cosgrove1e211442022-05-26 11:51:00 +01001439 /** Callback to create & write a cookie for ClientHello verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 int(*MBEDTLS_PRIVATE(f_cookie_write))(void *, unsigned char **, unsigned char *,
1441 const unsigned char *, size_t);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001442 /** Callback to verify validity of a ClientHello cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 int(*MBEDTLS_PRIVATE(f_cookie_check))(void *, const unsigned char *, size_t,
1444 const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001445 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001446#endif
1447
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001448#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001449 /** Callback to create & write a session ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 int(*MBEDTLS_PRIVATE(f_ticket_write))(void *, const mbedtls_ssl_session *,
1451 unsigned char *, const unsigned char *, size_t *,
1452 uint32_t *);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001453 /** Callback to parse a session ticket into a session structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 int(*MBEDTLS_PRIVATE(f_ticket_parse))(void *, mbedtls_ssl_session *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001455 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001456#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001457#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001458 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001459#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001460
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001461#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001462 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1463 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1464 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1465 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001466#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001467 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1468 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001469#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001470#endif /* MBEDTLS_X509_CRT_PARSE_C */
1471
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001472#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001473#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001474 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001475#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001476 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1477 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1478 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001479#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001480
Ronald Crone68ab4f2022-10-05 12:46:29 +02001481#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01001482
Jerry Yuf017ee42022-01-12 15:49:48 +08001483#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1484 const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */
1485#endif
1486 const uint16_t *MBEDTLS_PRIVATE(sig_algs); /*!< allowed signature algorithms */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001487#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001488
Brett Warrene0edc842021-08-17 09:53:13 +01001489 const uint16_t *MBEDTLS_PRIVATE(group_list); /*!< allowed IANA NamedGroups */
1490
Ronald Cron73fe8df2022-10-05 14:31:43 +02001491#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001492
Andrzej Kurek03e01462022-01-03 12:53:24 +01001493 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 * should only be set via
1495 * mbedtls_ssl_conf_psk_opaque().
1496 * If either no PSK or a raw PSK have been
1497 * configured, this has value \c 0.
1498 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001499 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 * only be set via mbedtls_ssl_conf_psk().
1501 * If either no PSK or an opaque PSK
1502 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001503 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 * This field should only be set via
1505 * mbedtls_ssl_conf_psk().
1506 * Its value is non-zero if and only if
1507 * \c psk is not \c NULL. */
Hanno Becker43633132018-10-22 15:31:03 +01001508
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001509 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 * This field should only be set via
1511 * mbedtls_ssl_conf_psk().
1512 * This is set if and only if either
1513 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001514 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 * This field should only be set via
1516 * mbedtls_ssl_conf_psk().
1517 * Its value is non-zero if and only if
1518 * \c psk is not \c NULL or \c psk_opaque
1519 * is not \c 0. */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001520#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001521
Xiaokang Qian54413b12022-10-20 05:57:03 +00001522#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001523 int MBEDTLS_PRIVATE(early_data_enabled); /*!< Early data enablement:
Xiaokang Qiand69d06f2022-10-25 06:51:25 +00001524 * - MBEDTLS_SSL_EARLY_DATA_DISABLED,
1525 * - MBEDTLS_SSL_EARLY_DATA_ENABLED */
Jerry Yucc4e0072022-11-22 17:22:22 +08001526
1527#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu12c46bd2022-12-06 11:02:51 +08001528 /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */
Jerry Yucc4e0072022-11-22 17:22:22 +08001529 uint32_t MBEDTLS_PRIVATE(max_early_data_size);
1530#endif /* MBEDTLS_SSL_SRV_C */
1531
Xiaokang Qian54413b12022-10-20 05:57:03 +00001532#endif /* MBEDTLS_SSL_EARLY_DATA */
1533
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001534#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001535 const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001536#endif
1537
Johan Pascalbbc057a2016-02-04 22:07:32 +01001538#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001539 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001540 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001541 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001542 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001543#endif /* MBEDTLS_SSL_DTLS_SRTP */
1544
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001545 /*
Gilles Peskine8834d872021-11-29 12:36:50 +01001546 * Numerical settings (int)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001547 */
1548
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001549 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001550
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001551#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001552 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001554 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001556#endif
1557
1558#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001559 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1560 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Gilles Peskine449bd832023-01-11 14:50:10 +01001561 that triggers renegotiation */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001562#endif
1563
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001564 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001565
Gilles Peskine69477b52022-01-13 01:01:45 +01001566 /** User data pointer or handle.
1567 *
1568 * The library sets this to \p 0 when creating a context and does not
1569 * access it afterwards.
1570 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001571 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Glenn Strauss2ed95272022-01-21 18:02:17 -05001572
1573#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss236e17e2022-03-13 23:39:40 -04001574 mbedtls_ssl_hs_cb_t MBEDTLS_PRIVATE(f_cert_cb); /*!< certificate selection callback */
Glenn Strauss2ed95272022-01-21 18:02:17 -05001575#endif /* MBEDTLS_SSL_SRV_C */
Glenn Strauss999ef702022-03-11 01:37:23 -05001576
1577#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1578 const mbedtls_x509_crt *MBEDTLS_PRIVATE(dn_hints);/*!< acceptable client cert issuers */
1579#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001580};
1581
Gilles Peskine449bd832023-01-11 14:50:10 +01001582struct mbedtls_ssl_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001583 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001584
Paul Bakker5121ce52009-01-03 21:22:43 +00001585 /*
1586 * Miscellaneous
1587 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001588 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001589#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001590 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1591 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 number of retransmissions of request if
1593 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001594#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001595
Ronald Cron8a12aee2023-03-08 15:30:43 +01001596 /**
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001597 * Maximum TLS version to be negotiated, then negotiated TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001598 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001599 * It is initialized as the configured maximum TLS version to be
1600 * negotiated by mbedtls_ssl_setup().
Ronald Cronbdb4f582022-03-31 15:37:44 +02001601 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001602 * When renegotiating or resuming a session, it is overwritten in the
1603 * ClientHello writing preparation stage with the previously negotiated
1604 * TLS version.
Ronald Cron8a12aee2023-03-08 15:30:43 +01001605 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001606 * On client side, it is updated to the TLS version selected by the server
1607 * for the handshake when the ServerHello is received.
Ronald Cron8a12aee2023-03-08 15:30:43 +01001608 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001609 * On server side, it is updated to the TLS version the server selects for
1610 * the handshake when the ClientHello is received.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001611 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001612 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Ronald Cronbdb4f582022-03-31 15:37:44 +02001613
Ronald Cron78a38f62024-02-01 18:30:31 +01001614#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
Ronald Cron5d0ae902024-01-05 14:20:35 +01001615 /**
Ronald Crond2884662024-03-03 15:03:22 +01001616 * State of the negotiation and transfer of early data. Reset to
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001617 * MBEDTLS_SSL_EARLY_DATA_STATE_IDLE when the context is reset.
Ronald Cron5d0ae902024-01-05 14:20:35 +01001618 */
Ronald Cronaa359312024-03-11 17:24:39 +01001619 int MBEDTLS_PRIVATE(early_data_state);
Ronald Cron5d0ae902024-01-05 14:20:35 +01001620#endif
1621
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001622 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001623
Hanno Becker8927c832019-04-03 12:52:50 +01001624#if defined(MBEDTLS_X509_CRT_PARSE_C)
1625 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001627 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001628#endif
1629
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001630 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1631 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1632 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 /*!< Callback for network receive with timeout */
Simon Butchere846b512016-03-01 17:31:49 +00001634
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001635 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001636
Paul Bakker5121ce52009-01-03 21:22:43 +00001637 /*
1638 * Session layer
1639 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001640 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1641 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1642 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1643 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001644
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001645 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 the handshake process */
Paul Bakker48916f92012-09-16 19:57:18 +00001647
1648 /*
1649 * Record layer transformations
1650 */
Hanno Becker0e719ff2021-08-10 09:24:08 +01001651 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in)
1652 * This is always a reference,
1653 * never an owning pointer. */
1654 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (out)
1655 * This is always a reference,
1656 * never an owning pointer. */
1657 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params
1658 * This pointer owns the transform
1659 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001660#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0e719ff2021-08-10 09:24:08 +01001661 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation
1662 * This pointer owns the transform
1663 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001664#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001665
Ronald Cron6f135e12021-12-08 16:57:54 +01001666#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +01001667 /*! The application data transform in TLS 1.3.
1668 * This pointer owns the transform it references. */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001669 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01001670#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001671
Paul Bakker5121ce52009-01-03 21:22:43 +00001672 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001673 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001674 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001675 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001676
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001677 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1678 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001679
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001680 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001681 * Record layer (incoming data)
1682 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001683 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1684 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 TLS: maintained by us
1686 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001687 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001688#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001689 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001691#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001692 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1693 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1694 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1695 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001696
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001697 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1698 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1699 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001700#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001701 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001702#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001703#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001704 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1705 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001707#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001708#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001709 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1710 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001711#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001712
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001713 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 including the handshake header */
Deomid rojer Ryabkovdd14c0a2025-02-13 13:41:51 +03001715 size_t MBEDTLS_PRIVATE(in_hsfraglen); /*!< accumulated length of hs fragments
1716 (up to in_hslen) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001717 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001718
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001719 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001721
Jerry Yue7047812021-09-13 19:26:39 +08001722 /* The following three variables indicate if and, if yes,
Jerry Yu394ece62021-09-14 22:17:21 +08001723 * what kind of alert is pending to be sent.
Jerry Yue7047812021-09-13 19:26:39 +08001724 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001725 unsigned char MBEDTLS_PRIVATE(send_alert); /*!< Determines if a fatal alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 should be sent. Values:
1727 - \c 0 , no alert is to be sent.
1728 - \c 1 , alert is to be sent. */
Jerry Yu33cedca2021-09-14 19:55:49 +08001729 unsigned char MBEDTLS_PRIVATE(alert_type); /*!< Type of alert if send_alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 != 0 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001731 int MBEDTLS_PRIVATE(alert_reason); /*!< The error code to be returned
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 to the user once the fatal alert
1733 has been sent. */
Jerry Yue7047812021-09-13 19:26:39 +08001734
Hanno Becker04da1892018-08-14 13:22:10 +01001735#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001736 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 * within a single datagram. */
Hanno Becker04da1892018-08-14 13:22:10 +01001738#endif /* MBEDTLS_SSL_PROTO_DTLS */
1739
Ronald Cron26a98112024-02-23 08:23:40 +01001740#if defined(MBEDTLS_SSL_EARLY_DATA)
1741#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001742 /*
1743 * One of:
1744 * MBEDTLS_SSL_EARLY_DATA_NO_DISCARD
1745 * MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD
1746 * MBEDTLS_SSL_EARLY_DATA_DISCARD
1747 */
1748 uint8_t MBEDTLS_PRIVATE(discard_early_data_record);
1749#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001750 uint32_t MBEDTLS_PRIVATE(total_early_data_size); /*!< Number of received/written early data bytes */
Ronald Cron26a98112024-02-23 08:23:40 +01001751#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001752
Paul Bakker5121ce52009-01-03 21:22:43 +00001753 /*
1754 * Record layer (outgoing data)
1755 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001756 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1757 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1758 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001759#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001760 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001762#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001763 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1764 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1765 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001766
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001767 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1768 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1769 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001770#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001771 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001772#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001773
Jerry Yuae0b2e22021-10-08 15:21:19 +08001774 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001775
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001776#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001777 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001778#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001779
Paul Bakker5121ce52009-01-03 21:22:43 +00001780 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001781 * User settings
1782 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001783#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001784 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001786#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001788#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001789 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001790#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001791
Johan Pascalb62bb512015-12-03 21:56:45 +01001792#if defined(MBEDTLS_SSL_DTLS_SRTP)
1793 /*
1794 * use_srtp extension
1795 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001796 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001797#endif /* MBEDTLS_SSL_DTLS_SRTP */
1798
Paul Bakker48916f92012-09-16 19:57:18 +00001799 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001800 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001801 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001802#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001803 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1804 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001805#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001806
1807 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001808 * Secure renegotiation
1809 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001810 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001811 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001814 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1815 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1816 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001817#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001818
Hanno Beckera0e20d02019-05-15 14:03:01 +01001819#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001820 /* CID configuration to use in subsequent handshakes. */
1821
1822 /*! The next incoming CID, chosen by the user and applying to
1823 * all subsequent handshakes. This may be different from the
1824 * CID currently used in case the user has re-configured the CID
1825 * after an initial handshake. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001826 unsigned char MBEDTLS_PRIVATE(own_cid)[MBEDTLS_SSL_CID_IN_LEN_MAX];
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001827 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1828 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 * be negotiated in the next handshake or not.
1830 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1831 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001832#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001833
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001834 /** Callback to export key block and master secret */
1835 mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys);
1836 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
Gilles Peskine69477b52022-01-13 01:01:45 +01001837
1838 /** User data pointer or handle.
1839 *
1840 * The library sets this to \p 0 when creating a context and does not
1841 * access it afterwards.
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01001842 *
1843 * \warning Serializing and restoring an SSL context with
1844 * mbedtls_ssl_context_save() and mbedtls_ssl_context_load()
1845 * does not currently restore the user data.
Gilles Peskine69477b52022-01-13 01:01:45 +01001846 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001847 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Paul Bakker5121ce52009-01-03 21:22:43 +00001848};
1849
Paul Bakker5121ce52009-01-03 21:22:43 +00001850/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001851 * \brief Return the name of the ciphersuite associated with the
1852 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001853 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001854 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001855 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001856 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001858const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id);
Paul Bakkere3166ce2011-01-27 17:40:50 +00001859
1860/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001861 * \brief Return the ID of the ciphersuite associated with the
1862 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001863 *
1864 * \param ciphersuite_name SSL ciphersuite name
1865 *
1866 * \return the ID with the ciphersuite or 0 if not found
1867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001868int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name);
Paul Bakker72f62662011-01-16 21:27:44 +00001869
1870/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001871 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001872 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001873 * mbedtls_ssl_free()
1874 *
1875 * \param ssl SSL context
1876 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001877void mbedtls_ssl_init(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001878
1879/**
1880 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001881 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001882 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001883 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001884 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001885 * \warning The conf structure will be accessed during the session.
1886 * It must not be modified or freed as long as the session
1887 * is active.
1888 *
1889 * \warning This function must be called exactly once per context.
1890 * Calling mbedtls_ssl_setup again is not supported, even
1891 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001892 *
Janos Follath130ece02024-11-19 16:16:36 +00001893 * \note The PSA crypto subsystem must have been initialized by
1894 * calling psa_crypto_init() before calling this function.
Gilles Peskine5b7e1642022-08-04 23:44:59 +02001895 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001896 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001897 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001898 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001899 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001900 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001902int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1903 const mbedtls_ssl_config *conf);
Paul Bakker5121ce52009-01-03 21:22:43 +00001904
1905/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001906 * \brief Reset an already initialized SSL context for re-use
1907 * while retaining application-set variables, function
1908 * pointers and data.
1909 *
1910 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001911 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
1912 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001914int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl);
Paul Bakker7eb013f2011-10-06 12:37:39 +00001915
1916/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001917 * \brief Set the current endpoint type
1918 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001919 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001920 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001921 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001922void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint);
Paul Bakker5121ce52009-01-03 21:22:43 +00001923
1924/**
Pengyu Lvaccd53f2023-03-07 10:31:08 +08001925 * \brief Get the current endpoint type
1926 *
1927 * \param conf SSL configuration
1928 *
1929 * \return Endpoint type, either MBEDTLS_SSL_IS_CLIENT
1930 * or MBEDTLS_SSL_IS_SERVER
1931 */
Pengyu Lv08daebb2023-07-10 10:36:48 +08001932static inline int mbedtls_ssl_conf_get_endpoint(const mbedtls_ssl_config *conf)
Pengyu Lvaccd53f2023-03-07 10:31:08 +08001933{
1934 return conf->MBEDTLS_PRIVATE(endpoint);
1935}
1936
1937/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001938 * \brief Set the transport type (TLS or DTLS).
1939 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001940 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001941 * \note For DTLS, you must either provide a recv callback that
1942 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001943 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1944 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001945 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001946 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001947 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001948 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1949 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001950 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001951void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport);
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001952
1953/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001954 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001955 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001956 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001957 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001958 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001959 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001961 * (default on server)
1962 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001963 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001964 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001965 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001966 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001967 * handshake is complete.
1968 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001969 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001970 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001971 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001972 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001973 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1974 * 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 +01001975 * the right time(s), which may not be obvious, while REQUIRED always perform
1976 * the verification as soon as possible. For example, REQUIRED was protecting
1977 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001979void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode);
Paul Bakker5121ce52009-01-03 21:22:43 +00001980
Ronald Cron7d21cde2024-01-30 14:37:55 +01001981#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian54413b12022-10-20 05:57:03 +00001982/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001983 * \brief Set the early data mode
1984 * Default: disabled on server and client
1985 *
1986 * \param conf The SSL configuration to use.
1987 * \param early_data_enabled can be:
1988 *
Ronald Cron44d70a52024-01-30 18:16:47 +01001989 * MBEDTLS_SSL_EARLY_DATA_DISABLED:
1990 * Early data functionality is disabled. This is the default on client and
1991 * server.
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 *
Ronald Cron44d70a52024-01-30 18:16:47 +01001993 * MBEDTLS_SSL_EARLY_DATA_ENABLED:
1994 * Early data functionality is enabled and may be negotiated in the handshake.
1995 * Application using early data functionality needs to be aware that the
1996 * security properties for early data (also refered to as 0-RTT data) are
1997 * weaker than those for other kinds of TLS data. See the documentation of
1998 * mbedtls_ssl_write_early_data() and mbedtls_ssl_read_early_data() for more
1999 * information.
2000 * When early data functionality is enabled on server and only in that case,
2001 * the call to one of the APIs that trigger or resume an handshake sequence,
2002 * namely mbedtls_ssl_handshake(), mbedtls_ssl_handshake_step(),
2003 * mbedtls_ssl_read() or mbedtls_ssl_write() may return with the error code
2004 * MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA indicating that some early data have
Ronald Cron164537c2024-02-01 18:05:47 +01002005 * been received. To read the early data, call mbedtls_ssl_read_early_data()
2006 * before calling the original function again.
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 */
Yanray Wangd5ed36f2023-11-07 11:40:43 +08002008void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
2009 int early_data_enabled);
Jerry Yucc4e0072022-11-22 17:22:22 +08002010
2011#if defined(MBEDTLS_SSL_SRV_C)
2012/**
Jerry Yu12c46bd2022-12-06 11:02:51 +08002013 * \brief Set the maximum amount of 0-RTT data in bytes
2014 * Default: #MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
2015 *
2016 * This function sets the value of the max_early_data_size
2017 * field of the early data indication extension included in
2018 * the NewSessionTicket messages that the server may send.
2019 *
2020 * The value defines the maximum amount of 0-RTT data
2021 * in bytes that a client will be allowed to send when using
2022 * one of the tickets defined by the NewSessionTicket messages.
2023 *
2024 * \note When resuming a session using a ticket, if the server receives more
2025 * early data than allowed for the ticket, it terminates the connection.
2026 * The maximum amount of 0-RTT data should thus be large enough
2027 * to allow a minimum of early data to be exchanged.
Jerry Yucc4e0072022-11-22 17:22:22 +08002028 *
2029 * \param[in] conf The SSL configuration to use.
2030 * \param[in] max_early_data_size The maximum amount of 0-RTT data.
Jerry Yucc4e0072022-11-22 17:22:22 +08002031 *
Jerry Yu6c485da2023-11-15 10:18:47 +08002032 * \warning This interface DOES NOT influence/limit the amount of early data
Jerry Yufedaeb22023-11-15 13:59:07 +08002033 * that can be received through previously created and issued tickets,
2034 * which clients may have stored.
Jerry Yucc4e0072022-11-22 17:22:22 +08002035 */
Yanray Wang07517612023-11-07 11:47:36 +08002036void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 mbedtls_ssl_config *conf, uint32_t max_early_data_size);
Jerry Yucc4e0072022-11-22 17:22:22 +08002038#endif /* MBEDTLS_SSL_SRV_C */
2039
Ronald Cron7d21cde2024-01-30 14:37:55 +01002040#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qian54413b12022-10-20 05:57:03 +00002041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002042#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002043/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002044 * \brief Set the verification callback (Optional).
2045 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002046 * If set, the provided verify callback is called for each
2047 * certificate in the peer's CRT chain, including the trusted
2048 * root. For more information, please see the documentation of
2049 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002050 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002051 * \note For per context callbacks and contexts, please use
2052 * mbedtls_ssl_set_verify() instead.
2053 *
2054 * \param conf The SSL configuration to use.
2055 * \param f_vrfy The verification callback to use during CRT verification.
2056 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002057 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002058void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
2059 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2060 void *p_vrfy);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002062
2063/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002064 * \brief Set the random number generator callback
2065 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01002066 * \param conf SSL configuration
Manuel Pégourié-Gonnardad5390f2021-06-15 11:29:26 +02002067 * \param f_rng RNG function (mandatory)
Paul Bakker5121ce52009-01-03 21:22:43 +00002068 * \param p_rng RNG parameter
2069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002070void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
2071 int (*f_rng)(void *, unsigned char *, size_t),
2072 void *p_rng);
Paul Bakker5121ce52009-01-03 21:22:43 +00002073
2074/**
2075 * \brief Set the debug callback
2076 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02002077 * The callback has the following argument:
2078 * void * opaque context for the callback
2079 * int debug level
2080 * const char * file name
2081 * int line number
2082 * const char * message
2083 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002084 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002085 * \param f_dbg debug function
2086 * \param p_dbg debug parameter
2087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002088void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
2089 void (*f_dbg)(void *, int, const char *, int, const char *),
2090 void *p_dbg);
Paul Bakker5121ce52009-01-03 21:22:43 +00002091
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002092/**
Gilles Peskine915896f2022-01-13 01:05:10 +01002093 * \brief Return the SSL configuration structure associated
2094 * with the given SSL context.
2095 *
2096 * \note The pointer returned by this function is guaranteed to
2097 * remain valid until the context is freed.
2098 *
2099 * \param ssl The SSL context to query.
2100 * \return Pointer to the SSL configuration associated with \p ssl.
2101 */
2102static inline const mbedtls_ssl_config *mbedtls_ssl_context_get_config(
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 const mbedtls_ssl_context *ssl)
Gilles Peskine915896f2022-01-13 01:05:10 +01002104{
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 return ssl->MBEDTLS_PRIVATE(conf);
Gilles Peskine915896f2022-01-13 01:05:10 +01002106}
2107
2108/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002109 * \brief Set the underlying BIO callbacks for write, read and
2110 * read-with-timeout.
2111 *
2112 * \param ssl SSL context
2113 * \param p_bio parameter (context) shared by BIO callbacks
2114 * \param f_send write callback
2115 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002116 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002117 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002118 * \note One of f_recv or f_recv_timeout can be NULL, in which case
2119 * the other is used. If both are non-NULL, f_recv_timeout is
2120 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002121 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002122 * \note The two most common use cases are:
2123 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
bootstrap-prime6dbbf442022-05-17 19:30:44 -04002124 * - blocking I/O, f_recv == NULL, f_recv_timeout != NULL
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002125 *
2126 * \note For DTLS, you need to provide either a non-NULL
2127 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002128 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07002129 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002130 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00002131 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002132 *
Andres AG3616f6f2016-09-14 14:32:09 +01002133 * \note On some platforms, net_sockets.c provides
2134 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
2135 * \c mbedtls_net_recv_timeout() that are suitable to be used
2136 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002138void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
2139 void *p_bio,
2140 mbedtls_ssl_send_t *f_send,
2141 mbedtls_ssl_recv_t *f_recv,
2142 mbedtls_ssl_recv_timeout_t *f_recv_timeout);
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002143
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002144#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01002145
Hanno Beckera0e20d02019-05-15 14:03:01 +01002146#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01002147
2148
2149/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01002150 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01002151 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01002152 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002153 * Reference: RFC 9146 (or draft-ietf-tls-dtls-connection-id-05
Hanno Beckerebcc9132019-05-15 10:26:32 +01002154 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002155 * for legacy version)
Hanno Becker019f4b52019-04-09 15:12:56 +01002156 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01002157 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01002158 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01002159 * underlying transport (changed IP and Port metadata) by
2160 * adding explicit connection identifiers (CIDs) to the
2161 * headers of encrypted DTLS records. The desired CIDs are
2162 * configured by the application layer and are exchanged in
2163 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01002164 * handshake, where each side indicates the CID it wants the
2165 * peer to use when writing encrypted messages. The CIDs are
2166 * put to use once records get encrypted: the stack discards
2167 * any incoming records that don't include the configured CID
2168 * in their header, and adds the peer's requested CID to the
2169 * headers of outgoing messages.
2170 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01002171 * This API enables or disables the use of the CID extension
2172 * in the next handshake and sets the value of the CID to
2173 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01002174 *
2175 * \param ssl The SSL context to configure. This must be initialized.
2176 * \param enable This value determines whether the CID extension should
2177 * be used or not. Possible values are:
2178 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01002179 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
2180 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01002181 * \param own_cid The address of the readable buffer holding the CID we want
2182 * the peer to use when sending encrypted messages to us.
2183 * This may be \c NULL if \p own_cid_len is \c 0.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05002184 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01002185 * MBEDTLS_SSL_CID_DISABLED.
2186 * \param own_cid_len The length of \p own_cid.
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 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01002190 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01002191 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01002192 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01002193 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002194 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01002195 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01002196 * performed on the SSL context \p ssl, but does not trigger
2197 * one. You still have to call `mbedtls_ssl_handshake()`
2198 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
2199 * (for a renegotiation handshake) explicitly after a
2200 * successful call to this function to run the handshake.
2201 *
2202 * \note This call cannot guarantee that the use of the CID
2203 * will be successfully negotiated in the next handshake,
2204 * because the peer might not support it. Specifically:
2205 * - On the Client, enabling the use of the CID through
2206 * this call implies that the `ClientHello` in the next
2207 * handshake will include the CID extension, thereby
2208 * offering the use of the CID to the server. Only if
2209 * the `ServerHello` contains the CID extension, too,
2210 * the CID extension will actually be put to use.
2211 * - On the Server, enabling the use of the CID through
Tom Cosgrove1797b052022-12-04 17:19:59 +00002212 * this call implies that the server will look for
Hanno Becker019f4b52019-04-09 15:12:56 +01002213 * the CID extension in a `ClientHello` from the client,
2214 * and, if present, reply with a CID extension in its
2215 * `ServerHello`.
2216 *
2217 * \note To check whether the use of the CID was negotiated
2218 * after the subsequent handshake has completed, please
2219 * use the API mbedtls_ssl_get_peer_cid().
2220 *
2221 * \warning If the use of the CID extension is enabled in this call
2222 * and the subsequent handshake negotiates its use, Mbed TLS
2223 * will silently drop every packet whose CID does not match
2224 * the CID configured in \p own_cid. It is the responsibility
2225 * of the user to adapt the underlying transport to take care
2226 * of CID-based demultiplexing before handing datagrams to
2227 * Mbed TLS.
2228 *
2229 * \return \c 0 on success. In this case, the CID configuration
2230 * applies to the next handshake.
2231 * \return A negative error code on failure.
2232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002233int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
2234 int enable,
2235 unsigned char const *own_cid,
2236 size_t own_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002237
2238/**
Paul Elliott0113cf12022-03-11 20:26:47 +00002239 * \brief Get information about our request for usage of the CID
2240 * extension in the current connection.
2241 *
2242 * \param ssl The SSL context to query.
2243 * \param enabled The address at which to store whether the CID extension
2244 * is requested to be used or not. If the CID is
2245 * requested, `*enabled` is set to
2246 * MBEDTLS_SSL_CID_ENABLED; otherwise, it is set to
2247 * MBEDTLS_SSL_CID_DISABLED.
2248 * \param own_cid The address of the buffer in which to store our own
2249 * CID (if the CID extension is requested). This may be
2250 * \c NULL in case the value of our CID isn't needed. If
2251 * it is not \c NULL, \p own_cid_len must not be \c NULL.
2252 * \param own_cid_len The address at which to store the size of our own CID
2253 * (if the CID extension is requested). This is also the
2254 * number of Bytes in \p own_cid that have been written.
2255 * This may be \c NULL in case the length of our own CID
2256 * isn't needed. If it is \c NULL, \p own_cid must be
2257 * \c NULL, too.
2258 *
2259 *\note If we are requesting an empty CID this function sets
2260 * `*enabled` to #MBEDTLS_SSL_CID_DISABLED (the rationale
2261 * for this is that the resulting outcome is the
2262 * same as if the CID extensions wasn't requested).
2263 *
2264 * \return \c 0 on success.
2265 * \return A negative error code on failure.
2266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002267int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
Paul Elliott0113cf12022-03-11 20:26:47 +00002268 int *enabled,
Sam Berry3504c882024-06-11 14:34:17 +01002269 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 size_t *own_cid_len);
Paul Elliott0113cf12022-03-11 20:26:47 +00002271
2272/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01002273 * \brief Get information about the use of the CID extension
2274 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01002275 *
2276 * \param ssl The SSL context to query.
2277 * \param enabled The address at which to store whether the CID extension
2278 * is currently in use or not. If the CID is in use,
2279 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
2280 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
2281 * \param peer_cid The address of the buffer in which to store the CID
2282 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01002283 * This may be \c NULL in case the value of peer CID
2284 * isn't needed. If it is not \c NULL, \p peer_cid_len
2285 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01002286 * \param peer_cid_len The address at which to store the size of the CID
2287 * chosen by the peer (if the CID extension is used).
2288 * This is also the number of Bytes in \p peer_cid that
2289 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01002290 * This may be \c NULL in case the length of the peer CID
2291 * isn't needed. If it is \c NULL, \p peer_cid must be
2292 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01002293 *
2294 * \note This applies to the state of the CID negotiated in
2295 * the last complete handshake. If a handshake is in
2296 * progress, this function will attempt to complete
2297 * the handshake first.
2298 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01002299 * \note If CID extensions have been exchanged but both client
2300 * and server chose to use an empty CID, this function
2301 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
2302 * (the rationale for this is that the resulting
2303 * communication is the same as if the CID extensions
2304 * hadn't been used).
2305 *
Hanno Becker019f4b52019-04-09 15:12:56 +01002306 * \return \c 0 on success.
2307 * \return A negative error code on failure.
2308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002309int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
2310 int *enabled,
2311 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2312 size_t *peer_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002313
Hanno Beckera0e20d02019-05-15 14:03:01 +01002314#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01002315
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002316/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002317 * \brief Set the Maximum Transport Unit (MTU).
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002318 * Special value: 0 means unset (no limit).
2319 * This represents the maximum size of a datagram payload
2320 * handled by the transport layer (usually UDP) as determined
2321 * by the network link and stack. In practice, this controls
2322 * the maximum size datagram the DTLS layer will pass to the
2323 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
2324 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002325 * \note The limit on datagram size is converted to a limit on
2326 * record payload by subtracting the current overhead of
2327 * encapsulation and encryption/authentication if any.
2328 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002329 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01002330 * example when a Path Maximum Transfer Unit (PMTU)
2331 * estimate becomes available from other sources,
2332 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002333 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002334 * \note This setting only controls the size of the packets we send,
2335 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02002336 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002337 * server to use smaller records with \c
2338 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002339 *
2340 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002341 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002342 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002343 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002344 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002345 * of datagrams (hence records, see first note) sent. It
2346 * cannot be used to increase the maximum size of records over
2347 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002348 *
2349 * \note Values lower than the current record layer expansion will
2350 * result in an error when trying to send data.
2351 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002352 * \param ssl SSL context
2353 * \param mtu Value of the path MTU in bytes
2354 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002355void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu);
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002356#endif /* MBEDTLS_SSL_PROTO_DTLS */
2357
Hanno Becker726c97a2019-04-03 12:52:35 +01002358#if defined(MBEDTLS_X509_CRT_PARSE_C)
2359/**
2360 * \brief Set a connection-specific verification callback (optional).
2361 *
2362 * If set, the provided verify callback is called for each
2363 * certificate in the peer's CRT chain, including the trusted
2364 * root. For more information, please see the documentation of
2365 * \c mbedtls_x509_crt_verify().
2366 *
2367 * \note This call is analogous to mbedtls_ssl_conf_verify() but
2368 * binds the verification callback and context to an SSL context
2369 * as opposed to an SSL configuration.
2370 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
2371 * are both used, mbedtls_ssl_set_verify() takes precedence.
2372 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01002373 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01002374 * \param f_vrfy The verification callback to use during CRT verification.
2375 * \param p_vrfy The opaque context to be passed to the callback.
2376 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002377void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
2378 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2379 void *p_vrfy);
Hanno Becker726c97a2019-04-03 12:52:35 +01002380#endif /* MBEDTLS_X509_CRT_PARSE_C */
2381
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002382/**
2383 * \brief Set the timeout period for mbedtls_ssl_read()
2384 * (Default: no timeout.)
2385 *
2386 * \param conf SSL configuration context
2387 * \param timeout Timeout value in milliseconds.
2388 * Use 0 for no timeout (default).
2389 *
2390 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002391 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002392 * With non-blocking I/O, this will only work if timer
2393 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
2394 *
2395 * \note With non-blocking I/O, you may also skip this function
2396 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002398void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout);
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002399
Hanno Beckercfe45792019-07-03 16:13:00 +01002400/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002401 * \brief Check whether a buffer contains a valid and authentic record
2402 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01002403 *
2404 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01002405 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01002406 * an indication of the legitimacy of an incoming record.
2407 *
2408 * This can be useful e.g. in distributed server environments
2409 * using the DTLS Connection ID feature, in which connections
2410 * might need to be passed between service instances on a change
2411 * of peer address, but where such disruptive operations should
2412 * only happen after the validity of incoming records has been
2413 * confirmed.
2414 *
2415 * \param ssl The SSL context to use.
2416 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002417 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01002418 * \param buflen The length of \p buf in Bytes.
2419 *
2420 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002421 * with a valid and authentic record that has not been seen
2422 * before, but does not check potential data following the
2423 * initial record. In particular, it is possible to pass DTLS
2424 * datagrams containing multiple records, in which case only
2425 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01002426 *
2427 * \note This function modifies the input buffer \p buf. If you need
2428 * to preserve the original record, you have to maintain a copy.
2429 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002430 * \return \c 0 if the record is valid and authentic and has not been
2431 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01002432 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
2433 * successfully but the record was found to be not authentic.
2434 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
2435 * successfully but the record was found to be invalid for
2436 * a reason different from authenticity checking.
2437 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
2438 * successfully but the record was found to be unexpected
2439 * in the state of the SSL context, including replayed records.
2440 * \return Another negative error code on different kinds of failure.
2441 * In this case, the SSL context becomes unusable and needs
2442 * to be freed or reset before reuse.
2443 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002444int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
2445 unsigned char *buf,
2446 size_t buflen);
Hanno Beckercfe45792019-07-03 16:13:00 +01002447
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002448/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002449 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002450 *
2451 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002452 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002453 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002454 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002455 *
2456 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
2457 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02002458 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002459 *
2460 * \note On some platforms, timing.c provides
2461 * \c mbedtls_timing_set_delay() and
2462 * \c mbedtls_timing_get_delay() that are suitable for using
2463 * here, except if using an event-driven style.
2464 *
2465 * \note See also the "DTLS tutorial" article in our knowledge base.
Dave Rodgmanb3196842022-10-12 16:47:08 +01002466 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002467 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002468void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
2469 void *p_timer,
2470 mbedtls_ssl_set_timer_t *f_set_timer,
2471 mbedtls_ssl_get_timer_t *f_get_timer);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002472
Glenn Strauss2ed95272022-01-21 18:02:17 -05002473#if defined(MBEDTLS_SSL_SRV_C)
2474/**
2475 * \brief Set the certificate selection callback (server-side only).
2476 *
2477 * If set, the callback is always called for each handshake,
2478 * after `ClientHello` processing has finished.
2479 *
Glenn Strauss2ed95272022-01-21 18:02:17 -05002480 * \param conf The SSL configuration to register the callback with.
2481 * \param f_cert_cb The callback for selecting server certificate after
2482 * `ClientHello` processing has finished.
2483 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002484static inline void mbedtls_ssl_conf_cert_cb(mbedtls_ssl_config *conf,
2485 mbedtls_ssl_hs_cb_t f_cert_cb)
Glenn Strauss236e17e2022-03-13 23:39:40 -04002486{
2487 conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb;
2488}
Glenn Strauss2ed95272022-01-21 18:02:17 -05002489#endif /* MBEDTLS_SSL_SRV_C */
2490
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002491/**
2492 * \brief Callback type: generate and write session ticket
2493 *
2494 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002495 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002496 * authenticated ticket for the session and write it to the
2497 * output buffer. Here, ticket means the opaque ticket part
2498 * of the NewSessionTicket structure of RFC 5077.
2499 *
2500 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002501 * \param session SSL session to be written in the ticket
2502 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002503 * \param end End of the output buffer
2504 * \param tlen On exit, holds the length written
2505 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2506 *
2507 * \return 0 if successful, or
2508 * a specific MBEDTLS_ERR_XXX code.
2509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002510typedef int mbedtls_ssl_ticket_write_t(void *p_ticket,
2511 const mbedtls_ssl_session *session,
2512 unsigned char *start,
2513 const unsigned char *end,
2514 size_t *tlen,
2515 uint32_t *lifetime);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002516
2517/**
2518 * \brief Callback type: parse and load session ticket
2519 *
2520 * \note This describes what a callback implementation should do.
2521 * This callback should parse a session ticket as generated
2522 * by the corresponding mbedtls_ssl_ticket_write_t function,
2523 * and, if the ticket is authentic and valid, load the
2524 * session.
2525 *
2526 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002527 * bytes of the input buffer, eg to use it as a temporary
2528 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002529 *
2530 * \param p_ticket Context for the callback
2531 * \param session SSL session to be loaded
2532 * \param buf Start of the buffer containing the ticket
2533 * \param len Length of the ticket.
2534 *
2535 * \return 0 if successful, or
2536 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2537 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2538 * any other non-zero code for other failures.
2539 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002540typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket,
2541 mbedtls_ssl_session *session,
2542 unsigned char *buf,
2543 size_t len);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002544
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002545#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002546/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002547 * \brief Configure SSL session ticket callbacks (server only).
2548 * (Default: none.)
2549 *
2550 * \note On server, session tickets are enabled by providing
2551 * non-NULL callbacks.
2552 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002553 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002554 *
2555 * \param conf SSL configuration context
2556 * \param f_ticket_write Callback for writing a ticket
2557 * \param f_ticket_parse Callback for parsing a ticket
2558 * \param p_ticket Context shared by the two callbacks
2559 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002560void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2561 mbedtls_ssl_ticket_write_t *f_ticket_write,
2562 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2563 void *p_ticket);
Ronald Cron3c0072b2023-11-22 10:00:14 +01002564
2565#if defined(MBEDTLS_HAVE_TIME)
2566/**
2567 * \brief Get the creation time of a session ticket.
2568 *
2569 * \note See the documentation of \c ticket_creation_time for information about
2570 * the intended usage of this function.
2571 *
2572 * \param session SSL session
2573 * \param ticket_creation_time On exit, holds the ticket creation time in
2574 * milliseconds.
2575 *
2576 * \return 0 on success,
2577 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if an input is not valid.
2578 */
2579static inline int mbedtls_ssl_session_get_ticket_creation_time(
2580 mbedtls_ssl_session *session, mbedtls_ms_time_t *ticket_creation_time)
2581{
2582 if (session == NULL || ticket_creation_time == NULL ||
2583 session->MBEDTLS_PRIVATE(endpoint) != MBEDTLS_SSL_IS_SERVER) {
2584 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2585 }
2586
2587 *ticket_creation_time = session->MBEDTLS_PRIVATE(ticket_creation_time);
2588
2589 return 0;
2590}
2591#endif /* MBEDTLS_HAVE_TIME */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002592#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002593
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002594/**
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002595 * \brief Get the session-id buffer.
2596 *
2597 * \param session SSL session.
2598 *
2599 * \return The address of the session-id buffer.
2600 */
Minos Galanakis358b4482024-03-04 02:19:31 +00002601static inline unsigned const char (*mbedtls_ssl_session_get_id(const mbedtls_ssl_session *
2602 session))[32]
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002603{
2604 return &session->MBEDTLS_PRIVATE(id);
2605}
2606
2607/**
2608 * \brief Get the size of the session-id.
2609 *
2610 * \param session SSL session.
2611 *
2612 * \return size_t size of session-id buffer.
2613 */
Minos Galanakis358b4482024-03-04 02:19:31 +00002614static inline size_t mbedtls_ssl_session_get_id_len(const mbedtls_ssl_session *session)
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002615{
2616 return session->MBEDTLS_PRIVATE(id_len);
2617}
2618
2619/**
Minos Galanakis40d47082024-03-04 15:24:51 +00002620 * \brief Get the ciphersuite-id.
2621 *
2622 * \param session SSL session.
2623 *
2624 * \return int represetation for ciphersuite.
2625 */
2626static inline int mbedtls_ssl_session_get_ciphersuite_id(const mbedtls_ssl_session *session)
2627{
2628 return session->MBEDTLS_PRIVATE(ciphersuite);
2629}
2630
2631/**
Hanno Becker457d6162021-05-24 10:27:39 +01002632 * \brief Configure a key export callback.
2633 * (Default: none.)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002634 *
Hanno Becker457d6162021-05-24 10:27:39 +01002635 * This API can be used for two purposes:
2636 * - Debugging: Use this API to e.g. generate an NSSKeylog
2637 * file and use it to inspect encrypted traffic in tools
2638 * such as Wireshark.
2639 * - Application-specific export: Use this API to implement
2640 * key exporters, e.g. for EAP-TLS or DTLS-SRTP.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002641 *
Hanno Becker457d6162021-05-24 10:27:39 +01002642 *
Hanno Becker7e6c1782021-06-08 09:24:55 +01002643 * \param ssl The SSL context to which the export
2644 * callback should be attached.
Hanno Becker457d6162021-05-24 10:27:39 +01002645 * \param f_export_keys The callback for the key export.
2646 * \param p_export_keys The opaque context pointer to be passed to the
2647 * callback \p f_export_keys.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002648 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002649void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2650 mbedtls_ssl_export_keys_t *f_export_keys,
2651 void *p_export_keys);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002652
Gilles Peskine80dae042022-01-21 23:50:39 +01002653/** \brief Set the user data in an SSL configuration to a pointer.
2654 *
2655 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_p().
2656 *
2657 * \note The library stores \c p without accessing it. It is the responsibility
2658 * of the caller to ensure that the pointer remains valid.
2659 *
2660 * \param conf The SSL configuration context to modify.
2661 * \param p The new value of the user data.
2662 */
2663static inline void mbedtls_ssl_conf_set_user_data_p(
2664 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002666{
Gilles Peskineded2a422022-02-12 00:20:08 +01002667 conf->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002668}
2669
2670/** \brief Set the user data in an SSL configuration to an integer.
2671 *
2672 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_n().
2673 *
2674 * \param conf The SSL configuration context to modify.
2675 * \param n The new value of the user data.
2676 */
2677static inline void mbedtls_ssl_conf_set_user_data_n(
2678 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002680{
Gilles Peskineded2a422022-02-12 00:20:08 +01002681 conf->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002682}
2683
2684/** \brief Retrieve the user data in an SSL configuration as a pointer.
2685 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002686 * This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or
2687 * \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been
2688 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has
2689 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002690 *
2691 * \param conf The SSL configuration context to modify.
2692 * \return The current value of the user data.
2693 */
2694static inline void *mbedtls_ssl_conf_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002696{
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return conf->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002698}
2699
2700/** \brief Retrieve the user data in an SSL configuration as an integer.
2701 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002702 * This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or
2703 * \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been
2704 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has
2705 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002706 *
2707 * \param conf The SSL configuration context to modify.
2708 * \return The current value of the user data.
2709 */
2710static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002712{
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 return conf->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002714}
2715
2716/** \brief Set the user data in an SSL context to a pointer.
2717 *
2718 * You can retrieve this value later with mbedtls_ssl_get_user_data_p().
2719 *
2720 * \note The library stores \c p without accessing it. It is the responsibility
2721 * of the caller to ensure that the pointer remains valid.
2722 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002723 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002724 * \param p The new value of the user data.
2725 */
2726static inline void mbedtls_ssl_set_user_data_p(
2727 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002728 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002729{
Gilles Peskineded2a422022-02-12 00:20:08 +01002730 ssl->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002731}
2732
2733/** \brief Set the user data in an SSL context to an integer.
2734 *
2735 * You can retrieve this value later with mbedtls_ssl_get_user_data_n().
2736 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002737 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002738 * \param n The new value of the user data.
2739 */
2740static inline void mbedtls_ssl_set_user_data_n(
2741 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002743{
Gilles Peskineded2a422022-02-12 00:20:08 +01002744 ssl->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002745}
2746
2747/** \brief Retrieve the user data in an SSL context as a pointer.
2748 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002749 * This is the value last set with mbedtls_ssl_set_user_data_p(), or
2750 * \c NULL if mbedtls_ssl_set_user_data_p() has not previously been
2751 * called. The value is undefined if mbedtls_ssl_set_user_data_n() has
2752 * been called without a subsequent call to mbedtls_ssl_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002753 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002754 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002755 * \return The current value of the user data.
2756 */
2757static inline void *mbedtls_ssl_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002759{
Gilles Peskine449bd832023-01-11 14:50:10 +01002760 return ssl->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002761}
2762
2763/** \brief Retrieve the user data in an SSL context as an integer.
2764 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002765 * This is the value last set with mbedtls_ssl_set_user_data_n(), or
2766 * \c 0 if mbedtls_ssl_set_user_data_n() has not previously been
2767 * called. The value is undefined if mbedtls_ssl_set_user_data_p() has
2768 * been called without a subsequent call to mbedtls_ssl_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002769 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002770 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002771 * \return The current value of the user data.
2772 */
2773static inline uintptr_t mbedtls_ssl_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002775{
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 return ssl->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002777}
2778
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002779#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002780/**
2781 * \brief Configure asynchronous private key operation callbacks.
2782 *
2783 * \param conf SSL configuration context
2784 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002785 * the description of ::mbedtls_ssl_async_sign_t
2786 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002787 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002788 * operation; in this case the private key object
2789 * associated with the certificate will be used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002790 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002791 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002792 * for more information. This may not be \c NULL unless
Gabor Mezeie99e5912025-02-27 13:41:24 +01002793 * \p f_async_sign is \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002794 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002795 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002796 * for more information. This may be \c NULL if
2797 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002798 * \param config_data A pointer to configuration data which can be
2799 * retrieved with
2800 * mbedtls_ssl_conf_get_async_config_data(). The
2801 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002802 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002803void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf,
2804 mbedtls_ssl_async_sign_t *f_async_sign,
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 mbedtls_ssl_async_resume_t *f_async_resume,
2806 mbedtls_ssl_async_cancel_t *f_async_cancel,
2807 void *config_data);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002808
2809/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002810 * \brief Retrieve the configuration data set by
2811 * mbedtls_ssl_conf_async_private_cb().
2812 *
2813 * \param conf SSL configuration context
2814 * \return The configuration data set by
2815 * mbedtls_ssl_conf_async_private_cb().
2816 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002817void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf);
Gilles Peskine8f97af72018-04-26 11:46:10 +02002818
2819/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002820 * \brief Retrieve the asynchronous operation user context.
2821 *
2822 * \note This function may only be called while a handshake
2823 * is in progress.
2824 *
2825 * \param ssl The SSL context to access.
2826 *
2827 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002828 * set during the current handshake. If
2829 * mbedtls_ssl_set_async_operation_data() has not yet been
2830 * called during the current handshake, this function returns
2831 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002832 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002833void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002834
2835/**
2836 * \brief Retrieve the asynchronous operation user context.
2837 *
2838 * \note This function may only be called while a handshake
2839 * is in progress.
2840 *
2841 * \param ssl The SSL context to access.
2842 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002843 * Call mbedtls_ssl_get_async_operation_data() later during the
2844 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002846void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2847 void *ctx);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002848#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002849
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002850/**
2851 * \brief Callback type: generate a cookie
2852 *
2853 * \param ctx Context for the callback
2854 * \param p Buffer to write to,
2855 * must be updated to point right after the cookie
2856 * \param end Pointer to one past the end of the output buffer
2857 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002858 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002859 * \param ilen Length of info in bytes
2860 *
2861 * \return The callback must return 0 on success,
2862 * or a negative error code.
2863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002864typedef int mbedtls_ssl_cookie_write_t(void *ctx,
2865 unsigned char **p, unsigned char *end,
2866 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002867
2868/**
2869 * \brief Callback type: verify a cookie
2870 *
2871 * \param ctx Context for the callback
2872 * \param cookie Cookie to verify
2873 * \param clen Length of cookie
2874 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002875 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002876 * \param ilen Length of info in bytes
2877 *
2878 * \return The callback must return 0 if cookie is valid,
2879 * or a negative error code.
2880 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002881typedef int mbedtls_ssl_cookie_check_t(void *ctx,
2882 const unsigned char *cookie, size_t clen,
2883 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002884
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002885#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002886/**
2887 * \brief Register callbacks for DTLS cookies
2888 * (Server only. DTLS only.)
2889 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002890 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002891 * register working callbacks (and initialize their context).
2892 *
2893 * To disable HelloVerifyRequest, register NULL callbacks.
2894 *
2895 * \warning Disabling hello verification allows your server to be used
2896 * for amplification in DoS attacks against other hosts.
2897 * Only disable if you known this can't happen in your
2898 * particular environment.
2899 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002900 * \note See comments on \c mbedtls_ssl_handshake() about handling
2901 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2902 * on the first handshake attempt when this is enabled.
2903 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002904 * \note This is also necessary to handle client reconnection from
2905 * the same port as described in RFC 6347 section 4.2.8 (only
2906 * the variant with cookies is supported currently). See
2907 * comments on \c mbedtls_ssl_read() for details.
2908 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002909 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002910 * \param f_cookie_write Cookie write callback
2911 * \param f_cookie_check Cookie check callback
2912 * \param p_cookie Context for both callbacks
2913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002914void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf,
2915 mbedtls_ssl_cookie_write_t *f_cookie_write,
2916 mbedtls_ssl_cookie_check_t *f_cookie_check,
2917 void *p_cookie);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002918
2919/**
2920 * \brief Set client's transport-level identification info.
2921 * (Server only. DTLS only.)
2922 *
2923 * This is usually the IP address (and port), but could be
2924 * anything identify the client depending on the underlying
2925 * network stack. Used for HelloVerifyRequest with DTLS.
2926 * This is *not* used to route the actual packets.
2927 *
2928 * \param ssl SSL context
2929 * \param info Transport-level info identifying the client (eg IP + port)
2930 * \param ilen Length of info in bytes
2931 *
2932 * \note An internal copy is made, so the info buffer can be reused.
2933 *
2934 * \return 0 on success,
2935 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002936 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002937 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002938int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl,
2939 const unsigned char *info,
2940 size_t ilen);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002941
2942#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002943
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002945/**
2946 * \brief Enable or disable anti-replay protection for DTLS.
2947 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002948 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002949 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002950 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002952 *
2953 * \warning Disabling this is a security risk unless the application
2954 * protocol handles duplicated packets in a safe way. You
2955 * should not disable this without careful consideration.
2956 * However, if your application already detects duplicated
2957 * packets and needs information about them to adjust its
2958 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002960void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002961#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002962
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002963/**
2964 * \brief Set a limit on the number of records with a bad MAC
2965 * before terminating the connection.
2966 * (DTLS only, no effect on TLS.)
2967 * Default: 0 (disabled).
2968 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002969 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002970 * \param limit Limit, or 0 to disable.
2971 *
2972 * \note If the limit is N, then the connection is terminated when
2973 * the Nth non-authentic record is seen.
2974 *
2975 * \note Records with an invalid header are not counted, only the
2976 * ones going through the authentication-decryption phase.
2977 *
2978 * \note This is a security trade-off related to the fact that it's
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002979 * often relatively easy for an active attacker to inject UDP
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002980 * datagrams. On one hand, setting a low limit here makes it
2981 * easier for such an attacker to forcibly terminated a
2982 * connection. On the other hand, a high limit or no limit
2983 * might make us waste resources checking authentication on
2984 * many bogus packets.
2985 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002986void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit);
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002987
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002989
2990/**
2991 * \brief Allow or disallow packing of multiple handshake records
2992 * within a single datagram.
2993 *
2994 * \param ssl The SSL context to configure.
2995 * \param allow_packing This determines whether datagram packing may
2996 * be used or not. A value of \c 0 means that every
2997 * record will be sent in a separate datagram; a
2998 * value of \c 1 means that, if space permits,
2999 * multiple handshake messages (including CCS) belonging to
3000 * a single flight may be packed within a single datagram.
3001 *
3002 * \note This is enabled by default and should only be disabled
3003 * for test purposes, or if datagram packing causes
3004 * interoperability issues with peers that don't support it.
3005 *
3006 * \note Allowing datagram packing reduces the network load since
3007 * there's less overhead if multiple messages share the same
3008 * datagram. Also, it increases the handshake efficiency
3009 * since messages belonging to a single datagram will not
3010 * be reordered in transit, and so future message buffering
3011 * or flight retransmission (if no buffering is used) as
3012 * means to deal with reordering are needed less frequently.
3013 *
Hanno Beckereb570082018-08-24 11:28:35 +01003014 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01003015 * are currently always sent in separate datagrams.
3016 *
3017 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003018void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
3019 unsigned allow_packing);
Hanno Becker04da1892018-08-14 13:22:10 +01003020
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003021/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00003022 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003023 * (DTLS only, no effect on TLS.)
3024 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003025 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003026 * \param min Initial timeout value in milliseconds.
3027 * Default: 1000 (1 second).
3028 * \param max Maximum timeout value in milliseconds.
3029 * Default: 60000 (60 seconds).
3030 *
3031 * \note Default values are from RFC 6347 section 4.2.4.1.
3032 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01003033 * \note The 'min' value should typically be slightly above the
3034 * expected round-trip time to your peer, plus whatever time
3035 * it takes for the peer to process the message. For example,
3036 * if your RTT is about 600ms and you peer needs up to 1s to
3037 * do the cryptographic operations in the handshake, then you
3038 * should set 'min' slightly above 1600. Lower values of 'min'
3039 * might cause spurious resends which waste network resources,
3040 * while larger value of 'min' will increase overall latency
3041 * on unreliable network links.
3042 *
3043 * \note The more unreliable your network connection is, the larger
3044 * your max / min ratio needs to be in order to achieve
3045 * reliable handshakes.
3046 *
3047 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
3048 * For example, if min = 1s and max = 5s, the retransmit plan
3049 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
3050 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003051 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003052void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003054
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01003055#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003056/**
Paul Bakker0a597072012-09-25 21:55:46 +00003057 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01003058 * If not set, no session resuming is done (except if session
3059 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00003060 *
Paul Bakker0a597072012-09-25 21:55:46 +00003061 * The session cache has the responsibility to check for stale
3062 * entries based on timeout. See RFC 5246 for recommendations.
3063 *
3064 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
3065 * connection shutdown, so do not cache the pointer! Either set
3066 * it to NULL or make a full copy of the certificate.
3067 *
3068 * The get callback is called once during the initial handshake
3069 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00003071 * If a valid entry is found, it should fill the master of
3072 * the session object with the cached values and return 0,
3073 * return 1 otherwise. Optionally peer_cert can be set as well
3074 * if it is properly present in cache entry.
3075 *
3076 * The set callback is called once during the initial handshake
3077 * to enable session resuming after the entire handshake has
3078 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00003080 * should create a cache entry for future retrieval based on
3081 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00003083 * data) is cleared by the SSL/TLS layer when the connection is
3084 * terminated. It is recommended to add metadata to determine if
3085 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00003086 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00003087 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003088 * \param conf SSL configuration
Tom Cosgrove1e211442022-05-26 11:51:00 +01003089 * \param p_cache parameter (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00003090 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00003091 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00003092 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003093void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
3094 void *p_cache,
3095 mbedtls_ssl_cache_get_t *f_get_cache,
3096 mbedtls_ssl_cache_set_t *f_set_cache);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003097#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003098
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003099#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003100/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003101 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00003102 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003103 * Sessions loaded through this call will be considered
3104 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003105 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003106 * \note Even if this call succeeds, it is not guaranteed that
3107 * the next handshake will indeed be shortened through the
3108 * use of session resumption: The server is always free
3109 * to reject any attempt for resumption and fall back to
3110 * a full handshake.
3111 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003112 * \note This function can handle a variety of mechanisms for session
Ronald Crond85eeae2024-04-04 10:34:21 +02003113 * resumption: For TLS 1.2, both session ID-based resumption
3114 * and ticket-based resumption will be considered. For TLS 1.3,
3115 * sessions equate to tickets, and loading one session by
3116 * calling this function will lead to its corresponding ticket
Ronald Cronfe15d902024-04-04 13:40:11 +02003117 * being advertised as resumption PSK by the client. This
3118 * depends on session tickets being enabled (see
3119 * #MBEDTLS_SSL_SESSION_TICKETS configuration option) though.
3120 * If session tickets are disabled, a call to this function
3121 * with a TLS 1.3 session, will not have any effect on the next
3122 * handshake for the SSL context \p ssl.
Hanno Beckere810bbc2021-05-14 16:01:05 +01003123 *
3124 * \param ssl The SSL context representing the connection which should
3125 * be attempted to be setup using session resumption. This
3126 * must be initialized via mbedtls_ssl_init() and bound to
3127 * an SSL configuration via mbedtls_ssl_setup(), but
3128 * the handshake must not yet have been started.
3129 * \param session The session to be considered for session resumption.
3130 * This must be a session previously exported via
3131 * mbedtls_ssl_get_session(), and potentially serialized and
3132 * deserialized through mbedtls_ssl_session_save() and
3133 * mbedtls_ssl_session_load() in the meantime.
3134 *
3135 * \return \c 0 if successful.
3136 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
Ronald Crond85eeae2024-04-04 10:34:21 +02003137 * could not be loaded because one session has already been
3138 * loaded. This error is non-fatal, and has no observable
3139 * effect on the SSL context or the session that was attempted
3140 * to be loaded.
Hanno Beckere810bbc2021-05-14 16:01:05 +01003141 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003142 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003143 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003144 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00003145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003146int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003148
3149/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003150 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003151 * On client, this can be used for loading saved sessions
Tom Cosgrove1e211442022-05-26 11:51:00 +01003152 * before resuming them with mbedtls_ssl_set_session().
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003153 * On server, this can be used for alternative implementations
3154 * of session cache or session tickets.
3155 *
3156 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003157 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003158 * end-entity certificate and the result of the chain
3159 * verification (unless verification was disabled), but not
3160 * the rest of the chain.
3161 *
3162 * \see mbedtls_ssl_session_save()
3163 * \see mbedtls_ssl_set_session()
3164 *
3165 * \param session The session structure to be populated. It must have been
3166 * initialised with mbedtls_ssl_session_init() but not
3167 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003168 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003169 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003170 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003171 *
3172 * \return \c 0 if successful.
3173 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
3174 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01003175 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
3176 * was generated in a different version or configuration of
3177 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02003178 * \return Another negative value for other kinds of errors (for
3179 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003181int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3182 const unsigned char *buf,
3183 size_t len);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003184
3185/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003186 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003187 * On client, this can be used for saving session data,
3188 * potentially in non-volatile storage, for resuming later.
3189 * On server, this can be used for alternative implementations
3190 * of session cache or session tickets.
3191 *
3192 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003193 *
3194 * \param session The session structure to be saved.
3195 * \param buf The buffer to write the serialized data to. It must be a
Andrzej Kurek377eb5f2023-05-06 09:57:40 -04003196 * writeable buffer of at least \p buf_len bytes, or may be \c
3197 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003198 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003199 * \param olen The size in bytes of the data that has been or would have
3200 * been written. It must point to a valid \c size_t.
3201 *
3202 * \note \p olen is updated to the correct value regardless of
3203 * whether \p buf_len was large enough. This makes it possible
3204 * to determine the necessary size by calling this function
3205 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003206 *
Ronald Cron9314df62024-04-04 09:53:07 +02003207 * \note For TLS 1.3 sessions, this feature is supported only if the
3208 * MBEDTLS_SSL_SESSION_TICKETS configuration option is enabled,
3209 * as in TLS 1.3 session resumption is possible only with
3210 * tickets.
3211 *
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003212 * \return \c 0 if successful.
3213 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Ronald Cron9314df62024-04-04 09:53:07 +02003214 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the
3215 * MBEDTLS_SSL_SESSION_TICKETS configuration option is disabled
3216 * and the session is a TLS 1.3 session.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003217 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003218int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3219 unsigned char *buf,
3220 size_t buf_len,
3221 size_t *olen);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003222
3223/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003224 * \brief Set the list of allowed ciphersuites and the preference
3225 * order. First in the list has the highest preference.
Paul Bakker5121ce52009-01-03 21:22:43 +00003226 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003227 * For TLS 1.2, the notion of ciphersuite determines both
3228 * the key exchange mechanism and the suite of symmetric
3229 * algorithms to be used during and after the handshake.
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003230 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003231 * For TLS 1.3 (in development), the notion of ciphersuite
Hanno Becker674f9482021-08-02 21:21:19 +01003232 * only determines the suite of symmetric algorithms to be
Hanno Beckere486b2d2021-07-23 19:24:30 +01003233 * used during and after the handshake, while key exchange
3234 * mechanisms are configured separately.
3235 *
3236 * In Mbed TLS, ciphersuites for both TLS 1.2 and TLS 1.3
3237 * are configured via this function. For users of TLS 1.3,
3238 * there will be separate API for the configuration of key
3239 * exchange mechanisms.
3240 *
3241 * The list of ciphersuites passed to this function may
3242 * contain a mixture of TLS 1.2 and TLS 1.3 ciphersuite
3243 * identifiers. This is useful if negotiation of TLS 1.3
3244 * should be attempted, but a fallback to TLS 1.2 would
3245 * be tolerated.
3246 *
3247 * \note By default, the server chooses its preferred
TRodziewicz3946f792021-06-14 12:11:18 +02003248 * ciphersuite among those that the client supports. If
3249 * mbedtls_ssl_conf_preference_order() is called to prefer
3250 * the client's preferences, the server instead chooses
3251 * the client's preferred ciphersuite among those that
3252 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003253 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003254 * \warning The ciphersuites array \p ciphersuites is not copied.
Jerry Yucadebe52021-08-24 10:36:45 +08003255 * It must remain valid for the lifetime of the SSL
Hanno Beckere486b2d2021-07-23 19:24:30 +01003256 * configuration \p conf.
3257 *
3258 * \param conf The SSL configuration to modify.
3259 * \param ciphersuites A 0-terminated list of IANA identifiers of supported
3260 * ciphersuites, accessible through \c MBEDTLS_TLS_XXX
3261 * and \c MBEDTLS_TLS1_3_XXX macros defined in
3262 * ssl_ciphersuites.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003264void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
3265 const int *ciphersuites);
Paul Bakker5121ce52009-01-03 21:22:43 +00003266
Ronald Cron6f135e12021-12-08 16:57:54 +01003267#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01003268/**
3269 * \brief Set the supported key exchange modes for TLS 1.3 connections.
3270 *
3271 * In contrast to TLS 1.2, the ciphersuite concept in TLS 1.3 does not
3272 * include the choice of key exchange mechanism. It is therefore not
3273 * covered by the API mbedtls_ssl_conf_ciphersuites(). See the
3274 * documentation of mbedtls_ssl_conf_ciphersuites() for more
3275 * information on the ciphersuite concept in TLS 1.2 and TLS 1.3.
3276 *
3277 * The present function is specific to TLS 1.3 and allows users to
3278 * configure the set of supported key exchange mechanisms in TLS 1.3.
3279 *
3280 * \param conf The SSL configuration the change should apply to.
3281 * \param kex_modes A bitwise combination of one or more of the following:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003282 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK
Hanno Becker71f1ed62021-07-24 06:01:47 +01003283 * This flag enables pure-PSK key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003284 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003285 * This flag enables combined PSK-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003286 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003287 * This flag enables pure-ephemeral key exchanges.
3288 * For convenience, the following pre-defined macros are
3289 * available for combinations of the above:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003290 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003291 * Includes all of pure-PSK, PSK-ephemeral and pure-ephemeral.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003292 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003293 * Includes both pure-PSK and combined PSK-ephemeral
3294 * key exchanges, but excludes pure-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003295 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003296 * Includes both pure-ephemeral and combined PSK-ephemeral
3297 * key exchanges.
3298 *
3299 * \note If a PSK-based key exchange mode shall be supported, applications
3300 * must also use the APIs mbedtls_ssl_conf_psk() or
3301 * mbedtls_ssl_conf_psk_cb() or mbedtls_ssl_conf_psk_opaque()
3302 * to configure the PSKs to be used.
3303 *
Hanno Becker5d045a82021-08-02 21:21:30 +01003304 * \note If a pure-ephemeral key exchange mode shall be supported,
Hanno Becker71f1ed62021-07-24 06:01:47 +01003305 * server-side applications must also provide a certificate via
3306 * mbedtls_ssl_conf_own_cert().
3307 *
3308 */
3309
Gilles Peskine449bd832023-01-11 14:50:10 +01003310void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
3311 const int kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01003312#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00003313
Hanno Beckera0e20d02019-05-15 14:03:01 +01003314#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01003315#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
3316#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01003317/**
Hanno Becker11259522019-05-23 16:55:50 +01003318 * \brief Specify the length of Connection IDs for incoming
3319 * encrypted DTLS records, as well as the behaviour
3320 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01003321 *
3322 * By default, the CID length is set to \c 0,
3323 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003324 *
3325 * \param conf The SSL configuration to modify.
3326 * \param len The length in Bytes of the CID fields in encrypted
3327 * DTLS records using the CID mechanism. This must
3328 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01003329 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01003330 * receiving a record with an unexpected CID.
3331 * Possible values are:
3332 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
3333 * In this case, the record is silently ignored.
3334 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
3335 * In this case, the stack fails with the specific
3336 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003337 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01003338 * \note The CID specification allows implementations to either
3339 * use a common length for all incoming connection IDs or
3340 * allow variable-length incoming IDs. Mbed TLS currently
3341 * requires a common length for all connections sharing the
3342 * same SSL configuration; this allows simpler parsing of
3343 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003344 *
3345 * \return \c 0 on success.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05003346 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p len
Hanno Beckerad4a1372019-05-03 13:06:44 +01003347 * is too large.
3348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003349int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len,
3350 int ignore_other_cids);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003351#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01003352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003353#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02003354/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003355 * \brief Set the X.509 security profile used for verification
3356 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003357 * \note The restrictions are enforced for all certificates in the
3358 * chain. However, signatures in the handshake are not covered
3359 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
3360 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003361 * \param conf SSL configuration
3362 * \param profile Profile to use
3363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003364void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
3365 const mbedtls_x509_crt_profile *profile);
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003366
3367/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003368 * \brief Set the data required to verify peer certificate
3369 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02003370 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02003371 * parameters ca_chain (maps to trust_ca for that function)
3372 * and ca_crl.
3373 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003374 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003375 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00003376 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00003377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003378void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003379 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01003380 mbedtls_x509_crl *ca_crl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003381
Glenn Strauss999ef702022-03-11 01:37:23 -05003382#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3383/**
3384 * \brief Set DN hints sent to client in CertificateRequest message
3385 *
3386 * \note If not set, subject distinguished names (DNs) are taken
3387 * from \c mbedtls_ssl_conf_ca_chain()
3388 * or \c mbedtls_ssl_set_hs_ca_chain())
3389 *
3390 * \param conf SSL configuration
3391 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3392 * from which the client should select client peer certificate.
3393 */
3394static inline
Gilles Peskine449bd832023-01-11 14:50:10 +01003395void mbedtls_ssl_conf_dn_hints(mbedtls_ssl_config *conf,
3396 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05003397{
3398 conf->MBEDTLS_PRIVATE(dn_hints) = crt;
3399}
3400#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3401
Hanno Becker8bf74f32019-03-27 11:01:30 +00003402#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3403/**
3404 * \brief Set the trusted certificate callback.
3405 *
3406 * This API allows to register the set of trusted certificates
3407 * through a callback, instead of a linked list as configured
3408 * by mbedtls_ssl_conf_ca_chain().
3409 *
3410 * This is useful for example in contexts where a large number
3411 * of CAs are used, and the inefficiency of maintaining them
3412 * in a linked list cannot be tolerated. It is also useful when
3413 * the set of trusted CAs needs to be modified frequently.
3414 *
3415 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
3416 * more information.
3417 *
3418 * \param conf The SSL configuration to register the callback with.
3419 * \param f_ca_cb The trusted certificate callback to use when verifying
3420 * certificate chains.
3421 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
3422 * a reference to a trusted CA database).
3423 *
3424 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
3425 * Any call to this function overwrites the values set through
3426 * earlier calls to mbedtls_ssl_conf_ca_chain() or
3427 * mbedtls_ssl_conf_ca_cb().
3428 *
3429 * \note This API is incompatible with CA indication in
3430 * CertificateRequest messages: A server-side SSL context which
3431 * is bound to an SSL configuration that uses a CA callback
3432 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
3433 * client authentication, will send an empty CA list in the
3434 * corresponding CertificateRequest message.
3435 *
3436 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
3437 * If an SSL context is bound to an SSL configuration which uses
3438 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
3439 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
3440 *
3441 * \note The use of this API disables the use of restartable ECC
3442 * during X.509 CRT signature verification (but doesn't affect
3443 * other uses).
3444 *
3445 * \warning This API is incompatible with the use of CRLs. Any call to
3446 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
3447 * earlier calls to mbedtls_ssl_conf_ca_chain().
3448 *
3449 * \warning In multi-threaded environments, the callback \p f_ca_cb
3450 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01003451 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00003452 * contained in the callback context pointed to by \p p_ca_cb).
3453 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003454void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
3455 mbedtls_x509_crt_ca_cb_t f_ca_cb,
3456 void *p_ca_cb);
Hanno Becker8bf74f32019-03-27 11:01:30 +00003457#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
3458
Paul Bakker5121ce52009-01-03 21:22:43 +00003459/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003460 * \brief Set own certificate chain and private key
3461 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003462 * \note own_cert should contain in order from the bottom up your
3463 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003464 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00003465 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003466 * \note On server, this function can be called multiple times to
3467 * provision more than one cert/key pair (eg one ECDSA, one
3468 * RSA with SHA-256, one RSA with SHA-1). An adequate
3469 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01003470 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003471 * adequate, preference is given to the one set by the first
3472 * call to this function, then second, etc.
3473 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003474 * \note On client, only the first call has any effect. That is,
3475 * only one client certificate can be provisioned. The
bootstrap-prime6dbbf442022-05-17 19:30:44 -04003476 * server's preferences in its CertificateRequest message will
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003477 * be ignored and our only cert will be sent regardless of
3478 * whether it matches those preferences - the server can then
3479 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003480 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003481 * \note The provided \p pk_key needs to match the public key in the
3482 * first certificate in \p own_cert, or all handshakes using
3483 * that certificate will fail. It is your responsibility
3484 * to ensure that; this function will not perform any check.
3485 * You may use mbedtls_pk_check_pair() in order to perform
3486 * this check yourself, but be aware that this function can
3487 * be computationally expensive on some key types.
3488 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02003489 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003490 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02003491 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003492 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003493 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00003494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003495int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003496 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003498#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00003499
Ronald Cron73fe8df2022-10-05 14:31:43 +02003500#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003501/**
Hanno Becker196739b2021-05-28 05:25:46 +01003502 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01003503 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003504 *
Hanno Becker196739b2021-05-28 05:25:46 +01003505 * Only one PSK can be registered, through either
3506 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3507 * If you attempt to register more than one PSK, this function
3508 * fails, though this may change in future versions, which
3509 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003510 *
3511 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003512 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003513 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003514 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
3515 * takes precedence over a PSK configured by this function.
3516 *
Hanno Becker02283042018-10-22 15:28:02 +01003517 * \param conf The SSL configuration to register the PSK with.
3518 * \param psk The pointer to the pre-shared key to use.
3519 * \param psk_len The length of the pre-shared key in bytes.
3520 * \param psk_identity The pointer to the pre-shared key identity.
3521 * \param psk_identity_len The length of the pre-shared key identity
3522 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02003523 *
Hanno Becker02283042018-10-22 15:28:02 +01003524 * \note The PSK and its identity are copied internally and
3525 * hence need not be preserved by the caller for the lifetime
3526 * of the SSL configuration.
3527 *
3528 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003529 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003530 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003531 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003532 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003533int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
3534 const unsigned char *psk, size_t psk_len,
3535 const unsigned char *psk_identity, size_t psk_identity_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003536
Hanno Becker02283042018-10-22 15:28:02 +01003537/**
Hanno Becker946c9252021-04-19 21:41:47 +01003538 * \brief Configure one or more opaque pre-shared keys (PSKs) and
3539 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01003540 *
Hanno Becker196739b2021-05-28 05:25:46 +01003541 * Only one PSK can be registered, through either
3542 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3543 * If you attempt to register more than one PSK, this function
3544 * fails, though this may change in future versions, which
3545 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01003546 *
3547 * \note This is mainly useful for clients. Servers will usually
3548 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
3549 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003550 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
3551 * the PSK callback takes precedence over an opaque PSK
3552 * configured by this function.
3553 *
Hanno Becker02283042018-10-22 15:28:02 +01003554 * \param conf The SSL configuration to register the PSK with.
3555 * \param psk The identifier of the key slot holding the PSK.
3556 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00003557 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05003558 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00003559 * allows its use for the key derivation algorithm applied
3560 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01003561 * \param psk_identity The pointer to the pre-shared key identity.
3562 * \param psk_identity_len The length of the pre-shared key identity
3563 * in bytes.
3564 *
3565 * \note The PSK identity hint is copied internally and hence need
3566 * not be preserved by the caller for the lifetime of the
3567 * SSL configuration.
3568 *
3569 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003570 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003571 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003572 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01003573 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003574int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
3575 mbedtls_svc_key_id_t psk,
3576 const unsigned char *psk_identity,
3577 size_t psk_identity_len);
Paul Bakker6db455e2013-09-18 17:29:31 +02003578
3579/**
Hanno Becker02283042018-10-22 15:28:02 +01003580 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003581 *
3582 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01003583 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003584 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003585 * \note A PSK set by this function takes precedence over a PSK
3586 * configured by \c mbedtls_ssl_conf_psk().
3587 *
Hanno Becker02283042018-10-22 15:28:02 +01003588 * \param ssl The SSL context to configure a PSK for.
3589 * \param psk The pointer to the pre-shared key.
3590 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003591 *
Hanno Becker02283042018-10-22 15:28:02 +01003592 * \return \c 0 if successful.
3593 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003594 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003595int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
3596 const unsigned char *psk, size_t psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003597
Hanno Becker02283042018-10-22 15:28:02 +01003598/**
3599 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
3600 *
3601 * \note This should only be called inside the PSK callback,
3602 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
3603 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003604 * \note An opaque PSK set by this function takes precedence over an
3605 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
3606 *
Hanno Becker02283042018-10-22 15:28:02 +01003607 * \param ssl The SSL context to configure a PSK for.
3608 * \param psk The identifier of the key slot holding the PSK.
3609 * For the duration of the current handshake, the key slot
3610 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05003611 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01003612 * use for the key derivation algorithm
3613 * applied in the handshake.
Gilles Peskine449bd832023-01-11 14:50:10 +01003614 *
Hanno Becker02283042018-10-22 15:28:02 +01003615 * \return \c 0 if successful.
3616 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
3617 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003618int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
3619 mbedtls_svc_key_id_t psk);
Hanno Becker02283042018-10-22 15:28:02 +01003620
Jerry Yu8897c072022-08-12 13:56:53 +08003621#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003622/**
3623 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02003624 *
3625 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01003626 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01003627 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02003628 * receive the actual PSK data and length.
3629 *
Hanno Becker02283042018-10-22 15:28:02 +01003630 * The callback has the following parameters:
3631 * - \c void*: The opaque pointer \p p_psk.
3632 * - \c mbedtls_ssl_context*: The SSL context to which
3633 * the operation applies.
3634 * - \c const unsigned char*: The PSK identity
3635 * selected by the client.
3636 * - \c size_t: The length of the PSK identity
3637 * selected by the client.
3638 *
Paul Bakker6db455e2013-09-18 17:29:31 +02003639 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01003640 * \c mbedtls_ssl_set_hs_psk() or
3641 * \c mbedtls_ssl_set_hs_psk_opaque()
3642 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02003643 * Any other return value will result in a denied PSK identity.
3644 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003645 * \note A dynamic PSK (i.e. set by the PSK callback) takes
3646 * precedence over a static PSK (i.e. set by
3647 * \c mbedtls_ssl_conf_psk() or
3648 * \c mbedtls_ssl_conf_psk_opaque()).
3649 * This means that if you set a PSK callback using this
3650 * function, you don't need to set a PSK using
3651 * \c mbedtls_ssl_conf_psk() or
3652 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003653 *
Hanno Becker02283042018-10-22 15:28:02 +01003654 * \param conf The SSL configuration to register the callback with.
3655 * \param f_psk The callback for selecting and setting the PSK based
3656 * in the PSK identity chosen by the client.
3657 * \param p_psk A pointer to an opaque structure to be passed to
3658 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02003659 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003660void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
3661 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3662 size_t),
3663 void *p_psk);
Jerry Yu8897c072022-08-12 13:56:53 +08003664#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cron73fe8df2022-10-05 14:31:43 +02003665#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003666
Brett Warrene0edc842021-08-17 09:53:13 +01003667/**
3668 * \brief Set the allowed groups in order of preference.
3669 *
3670 * On server: This only affects the choice of key agreement mechanism
3671 *
3672 * On client: this affects the list of groups offered for any
3673 * use. The server can override our preference order.
3674 *
3675 * Both sides: limits the set of groups accepted for use in
3676 * key sharing.
3677 *
Brett Warrene0edc842021-08-17 09:53:13 +01003678 * \note This list should be ordered by decreasing preference
3679 * (preferred group first).
3680 *
3681 * \note When this function is not called, a default list is used,
3682 * consisting of all supported curves at 255 bits and above,
3683 * and all supported finite fields at 2048 bits and above.
3684 * The order favors groups with the lowest resource usage.
3685 *
3686 * \note New minor versions of Mbed TLS will not remove items
3687 * from the default list unless serious security concerns require it.
3688 * New minor versions of Mbed TLS may change the order in
3689 * keeping with the general principle of favoring the lowest
3690 * resource usage.
3691 *
3692 * \param conf SSL configuration
3693 * \param groups List of allowed groups ordered by preference, terminated by 0.
3694 * Must contain valid IANA NamedGroup IDs (provided via either an integer
Xiaofei Bai746f9482021-11-12 08:53:56 +00003695 * or using MBEDTLS_TLS1_3_NAMED_GROUP_XXX macros).
Brett Warrene0edc842021-08-17 09:53:13 +01003696 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003697void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3698 const uint16_t *groups);
Brett Warrene0edc842021-08-17 09:53:13 +01003699
Ronald Crone68ab4f2022-10-05 12:46:29 +02003700#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003701#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003702/**
3703 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003704 *
3705 * \note This only affects which hashes are offered and can be used
3706 * for signatures during the handshake. Hashes for message
3707 * authentication and the TLS PRF are controlled by the
3708 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
3709 * used for certificate signature are controlled by the
3710 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
3711 *
Jerry Yu2c46ca32023-10-30 17:32:20 +08003712 * \deprecated Superseded by mbedtls_ssl_conf_sig_algs().
Jerry Yu01c73562023-10-27 17:03:20 +08003713 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003714 * \note This list should be ordered by decreasing preference
3715 * (preferred hash first).
3716 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003717 * \note By default, all supported hashes whose length is at least
3718 * 256 bits are allowed. This is the same set as the default
3719 * for certificate verification
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003720 * (#mbedtls_x509_crt_profile_default).
3721 * The preference order is currently unspecified and may
3722 * change in future versions.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003723 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003724 * \note New minor versions of Mbed TLS may extend this list,
3725 * for example if new curves are added to the library.
3726 * New minor versions of Mbed TLS will not remove items
3727 * from this list unless serious security concerns require it.
3728 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003729 * \param conf SSL configuration
3730 * \param hashes Ordered list of allowed signature hashes,
3731 * terminated by \c MBEDTLS_MD_NONE.
3732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003733void MBEDTLS_DEPRECATED mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
3734 const int *hashes);
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003735#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01003736
Hanno Becker1cd6e002021-08-10 13:27:10 +01003737/**
Jerry Yu1b23bce2023-11-13 13:45:14 +08003738 * \brief Configure allowed signature algorithms for use in TLS
Hanno Becker1cd6e002021-08-10 13:27:10 +01003739 *
3740 * \param conf The SSL configuration to use.
Jerry Yu7899de82021-08-17 13:09:23 +08003741 * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms,
Jerry Yu53c4a0d2023-11-09 10:38:17 +08003742 * terminated by #MBEDTLS_TLS1_3_SIG_NONE. The list must remain
3743 * available throughout the lifetime of the conf object.
3744 * - For TLS 1.3, values of \c MBEDTLS_TLS1_3_SIG_XXXX should be
3745 * used.
3746 * - For TLS 1.2, values should be given as
3747 * "(HashAlgorithm << 8) | SignatureAlgorithm".
Hanno Becker1cd6e002021-08-10 13:27:10 +01003748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003749void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
3750 const uint16_t *sig_algs);
Ronald Crone68ab4f2022-10-05 12:46:29 +02003751#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003752
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003753#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003754/**
Darryl Green11999bb2018-03-13 15:22:58 +00003755 * \brief Set or reset the hostname to check against the received
3756 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003757 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003758 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003759 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003760 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003761
Hanno Becker0446a392017-04-07 12:59:32 +01003762 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003763 *
Darryl Green11999bb2018-03-13 15:22:58 +00003764 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3765 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003766 * too long input hostname.
3767 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003768 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003769 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003770 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003771 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003772int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname);
Pengyu Lv918ebf32023-03-07 10:17:31 +08003773
3774/**
3775 * \brief Get the hostname that checked against the received
3776 * server certificate. It is used to set the ServerName
3777 * TLS extension, too, if that extension is enabled.
3778 * (client-side only)
3779 *
3780 * \param ssl SSL context
3781 *
3782 * \return const pointer to the hostname value
3783 */
3784static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
3785{
3786 return ssl->MBEDTLS_PRIVATE(hostname);
3787}
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003788#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003789
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003790#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003791/**
Glenn Strauss69894072022-01-24 12:58:00 -05003792 * \brief Retrieve SNI extension value for the current handshake.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04003793 * Available in \c f_cert_cb of \c mbedtls_ssl_conf_cert_cb(),
3794 * this is the same value passed to \c f_sni callback of
Glenn Strauss69894072022-01-24 12:58:00 -05003795 * \c mbedtls_ssl_conf_sni() and may be used instead of
3796 * \c mbedtls_ssl_conf_sni().
3797 *
3798 * \param ssl SSL context
3799 * \param name_len pointer into which to store length of returned value.
3800 * 0 if SNI extension is not present or not yet processed.
3801 *
3802 * \return const pointer to SNI extension value.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04003803 * - value is valid only when called in \c f_cert_cb
Glenn Strauss69894072022-01-24 12:58:00 -05003804 * registered with \c mbedtls_ssl_conf_cert_cb().
3805 * - value is NULL if SNI extension is not present.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04003806 * - value is not '\0'-terminated. Use \c name_len for len.
Glenn Strauss69894072022-01-24 12:58:00 -05003807 * - value must not be freed.
3808 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003809const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
3810 size_t *name_len);
Glenn Strauss69894072022-01-24 12:58:00 -05003811
3812/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003813 * \brief Set own certificate and key for the current handshake
3814 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003815 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003816 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003817 *
Glenn Strauss36872db2022-01-22 05:06:31 -05003818 * \note Passing null \c own_cert clears the certificate list for
3819 * the current handshake.
3820 *
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003821 * \param ssl SSL context
3822 * \param own_cert own public certificate chain
3823 * \param pk_key own private key
3824 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003825 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003827int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
3828 mbedtls_x509_crt *own_cert,
3829 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003830
3831/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003832 * \brief Set the data required to verify peer certificate for the
3833 * current handshake
3834 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003835 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003836 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003837 *
3838 * \param ssl SSL context
3839 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3840 * \param ca_crl trusted CA CRLs
3841 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003842void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
3843 mbedtls_x509_crt *ca_chain,
3844 mbedtls_x509_crl *ca_crl);
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003845
Glenn Strauss999ef702022-03-11 01:37:23 -05003846#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3847/**
3848 * \brief Set DN hints sent to client in CertificateRequest message
3849 *
3850 * \note Same as \c mbedtls_ssl_conf_dn_hints() but for use within
3851 * the SNI callback or the certificate selection callback.
3852 *
3853 * \param ssl SSL context
3854 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3855 * from which the client should select client peer certificate.
3856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003857void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
3858 const mbedtls_x509_crt *crt);
Glenn Strauss999ef702022-03-11 01:37:23 -05003859#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3860
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003861/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003862 * \brief Set authmode for the current handshake.
3863 *
3864 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003865 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003866 *
3867 * \param ssl SSL context
3868 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3869 * MBEDTLS_SSL_VERIFY_REQUIRED
3870 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003871void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
3872 int authmode);
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003873
3874/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003875 * \brief Set server side ServerName TLS extension callback
3876 * (optional, server-side only).
3877 *
3878 * If set, the ServerName callback is called whenever the
3879 * server receives a ServerName TLS extension from the client
3880 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003881 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003882 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003883 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003884 * certificate(s) and key(s) to use with \c
3885 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003886 * and may optionally adjust the CA and associated CRL with \c
3887 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3888 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3889 * then must return 0. If no matching name is found, the
Glenn Strauss0ebf24a2022-01-24 18:30:13 -05003890 * callback may return non-zero to abort the handshake.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003891 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003892 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003893 * \param f_sni verification function
3894 * \param p_sni verification parameter
3895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003896void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3897 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
3898 size_t),
3899 void *p_sni);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003900#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003901
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003902#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003903/**
3904 * \brief Set the EC J-PAKE password for current handshake.
3905 *
3906 * \note An internal copy is made, and destroyed as soon as the
3907 * handshake is completed, or when the SSL context is reset or
3908 * freed.
3909 *
3910 * \note The SSL context needs to be already set up. The right place
3911 * to call this function is between \c mbedtls_ssl_setup() or
3912 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settiaca21b72022-11-17 18:17:01 +01003913 * Password cannot be empty (see RFC 8236).
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003914 *
3915 * \param ssl SSL context
Valerio Settiaca21b72022-11-17 18:17:01 +01003916 * \param pw EC J-PAKE password (pre-shared secret). It cannot be empty
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003917 * \param pw_len length of pw in bytes
3918 *
3919 * \return 0 on success, or a negative error code.
3920 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003921int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
3922 const unsigned char *pw,
3923 size_t pw_len);
Valerio Settia9a97dc2022-11-28 18:26:16 +01003924
3925/**
3926 * \brief Set the EC J-PAKE opaque password for current handshake.
3927 *
Valerio Settic689ed82022-12-07 14:40:38 +01003928 * \note The key must remain valid until the handshake is over.
Valerio Settia9a97dc2022-11-28 18:26:16 +01003929 *
3930 * \note The SSL context needs to be already set up. The right place
3931 * to call this function is between \c mbedtls_ssl_setup() or
3932 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settia9a97dc2022-11-28 18:26:16 +01003933 *
3934 * \param ssl SSL context
3935 * \param pwd EC J-PAKE opaque password
3936 *
3937 * \return 0 on success, or a negative error code.
3938 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003939int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
3940 mbedtls_svc_key_id_t pwd);
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003941#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003942
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003944/**
3945 * \brief Set the supported Application Layer Protocols.
3946 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003947 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003948 * \param protos Pointer to a NULL-terminated list of supported protocols,
3949 * in decreasing preference order. The pointer to the list is
3950 * recorded by the library for later reference as required, so
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003951 * the lifetime of the table must be at least as long as the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003952 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003954 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003955 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003956int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos);
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003957
3958/**
3959 * \brief Get the name of the negotiated Application Layer Protocol.
3960 * This function should be called after the handshake is
3961 * completed.
3962 *
3963 * \param ssl SSL context
3964 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003965 * \return Protocol name, or NULL if no protocol was negotiated.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003966 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003967const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003968#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003969
Johan Pascalb62bb512015-12-03 21:56:45 +01003970#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003971#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003972static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile)
Johan Pascala455cd92020-09-22 15:28:11 +02003973{
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 switch (profile) {
Johan Pascala455cd92020-09-22 15:28:11 +02003975 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01003976 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003977 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01003978 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003979 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01003980 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003981 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01003982 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003983 default: break;
3984 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003985 return "";
Johan Pascala455cd92020-09-22 15:28:11 +02003986}
3987#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003988/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003989 * \brief Manage support for mki(master key id) value
3990 * in use_srtp extension.
3991 * MKI is an optional part of SRTP used for key management
3992 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003993 * The default value is
3994 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003995 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003996 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003997 * \param support_mki_value Enable or disable mki usage. Values are
3998 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3999 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02004000 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004001void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
4002 int support_mki_value);
Ron Eldor591f1622018-01-22 12:30:04 +02004003
4004/**
Johan Pascalb62bb512015-12-03 21:56:45 +01004005 * \brief Set the supported DTLS-SRTP protection profiles.
4006 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07004007 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02004008 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
4009 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01004010 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02004011 * The pointer to the list is recorded by the library
4012 * for later reference as required, so the lifetime
4013 * of the table must be at least as long as the lifetime
4014 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02004015 * The list must not hold more than
4016 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02004017 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01004018 *
Johan Pascal85269572020-08-25 10:01:54 +02004019 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02004020 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
4021 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01004022 */
Ron Eldora9788042018-12-05 11:04:31 +02004023int mbedtls_ssl_conf_dtls_srtp_protection_profiles
Gilles Peskine449bd832023-01-11 14:50:10 +01004024 (mbedtls_ssl_config *conf,
4025 const mbedtls_ssl_srtp_profile *profiles);
Ron Eldor591f1622018-01-22 12:30:04 +02004026
4027/**
Ron Eldora9788042018-12-05 11:04:31 +02004028 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02004029 *
Ron Eldora9788042018-12-05 11:04:31 +02004030 * \param ssl SSL context to use.
4031 * \param mki_value The MKI value to set.
4032 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02004033 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004034 * \note This function is relevant on client side only.
4035 * The server discovers the mki value during handshake.
4036 * A mki value set on server side using this function
4037 * is ignored.
4038 *
Johan Pascal85269572020-08-25 10:01:54 +02004039 * \return 0 on success
4040 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
4041 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02004042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004043int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
4044 unsigned char *mki_value,
4045 uint16_t mki_len);
Johan Pascalb62bb512015-12-03 21:56:45 +01004046/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004047 * \brief Get the negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004048 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004049 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004050 * \warning This function must be called after the handshake is
4051 * completed. The value returned by this function must
4052 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01004053 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004054 * \param ssl The SSL context to query.
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004055 * \param dtls_srtp_info The negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004056 * - Protection profile in use.
4057 * A direct mapping of the iana defined value for protection
4058 * profile on an uint16_t.
4059 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
4060 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
4061 * or peer's Hello packet was not parsed yet.
4062 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01004063 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004064void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
4065 mbedtls_dtls_srtp_info *dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01004066#endif /* MBEDTLS_SSL_DTLS_SRTP */
4067
Glenn Straussd09b3432022-04-11 13:58:11 -04004068#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Paul Bakker5701cdc2012-09-27 21:49:42 +00004069/**
Paul Bakker490ecc82011-10-06 13:04:09 +00004070 * \brief Set the maximum supported version sent from the client side
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004071 * and/or accepted at the server side.
4072 *
4073 * See also the documentation of mbedtls_ssl_conf_min_version().
Paul Bakker2fbefde2013-06-29 16:01:15 +02004074 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02004075 * \note This ignores ciphersuites from higher versions.
4076 *
Glenn Straussd09b3432022-04-11 13:58:11 -04004077 * \note This function is deprecated and has been replaced by
4078 * \c mbedtls_ssl_conf_max_tls_version().
4079 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004080 * \param conf SSL configuration
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004081 * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3)
4082 * \param minor Minor version number
4083 * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2,
4084 * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3)
Paul Bakker490ecc82011-10-06 13:04:09 +00004085 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004086void MBEDTLS_DEPRECATED mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major,
4087 int minor);
Glenn Straussd09b3432022-04-11 13:58:11 -04004088#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker490ecc82011-10-06 13:04:09 +00004089
Paul Bakker1d29fb52012-09-28 13:28:45 +00004090/**
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004091 * \brief Set the maximum supported version sent from the client side
4092 * and/or accepted at the server side.
4093 *
4094 * \note After the handshake, you can call
4095 * mbedtls_ssl_get_version_number() to see what version was
4096 * negotiated.
4097 *
4098 * \param conf SSL configuration
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004099 * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004100 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4101 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004102static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf,
4103 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004104{
4105 conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version;
4106}
4107
Glenn Straussd09b3432022-04-11 13:58:11 -04004108#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004109/**
Paul Bakker1d29fb52012-09-28 13:28:45 +00004110 * \brief Set the minimum accepted SSL/TLS protocol version
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004111 *
4112 * \note By default, all supported versions are accepted.
4113 * Future versions of the library may disable older
4114 * protocol versions by default if they become deprecated.
4115 *
4116 * \note The following versions are supported (if enabled at
4117 * compile time):
4118 * - (D)TLS 1.2: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3,
4119 * \p minor = #MBEDTLS_SSL_MINOR_VERSION_3
4120 * - TLS 1.3: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3,
4121 * \p minor = #MBEDTLS_SSL_MINOR_VERSION_4
4122 *
4123 * Note that the numbers in the constant names are the
4124 * TLS internal protocol numbers, and the minor versions
4125 * differ by one from the human-readable versions!
Paul Bakkerd2f068e2013-08-27 21:19:20 +02004126 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01004127 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
4128 * SSL_MIN_XXXXX_VERSION range is ignored.
4129 *
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004130 * \note After the handshake, you can call
Gilles Peskinece4f00d2022-02-12 00:47:23 +01004131 * mbedtls_ssl_get_version_number() to see what version was
4132 * negotiated.
4133 *
Glenn Straussd09b3432022-04-11 13:58:11 -04004134 * \note This function is deprecated and has been replaced by
4135 * \c mbedtls_ssl_conf_min_tls_version().
4136 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004137 * \param conf SSL configuration
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004138 * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3)
4139 * \param minor Minor version number
4140 * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2,
4141 * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3)
Paul Bakker1d29fb52012-09-28 13:28:45 +00004142 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004143void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major,
4144 int minor);
Glenn Straussd09b3432022-04-11 13:58:11 -04004145#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00004146
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004147/**
4148 * \brief Set the minimum supported version sent from the client side
4149 * and/or accepted at the server side.
4150 *
4151 * \note After the handshake, you can call
4152 * mbedtls_ssl_get_version_number() to see what version was
4153 * negotiated.
4154 *
4155 * \param conf SSL configuration
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004156 * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004157 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004159static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf,
4160 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004161{
4162 conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version;
4163}
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004165#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004166/**
4167 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004168 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004169 *
4170 * \note This should always be enabled, it is a security
4171 * improvement, and should not cause any interoperability
4172 * issue (used only if the peer supports it too).
4173 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004174 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004175 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004177void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004178#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004180#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004181/**
4182 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004183 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004184 *
4185 * \note This should always be enabled, it is a security fix to the
4186 * protocol, and should not cause any interoperability issue
4187 * (used only if the peer supports it too).
4188 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004189 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004190 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004191 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004192void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004193#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004194
Janos Follath088ce432017-04-10 12:42:31 +01004195#if defined(MBEDTLS_SSL_SRV_C)
4196/**
4197 * \brief Whether to send a list of acceptable CAs in
4198 * CertificateRequest messages.
4199 * (Default: do send)
4200 *
4201 * \param conf SSL configuration
4202 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
4203 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
4204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004205void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
4206 char cert_req_ca_list);
Janos Follath088ce432017-04-10 12:42:31 +01004207#endif /* MBEDTLS_SSL_SRV_C */
4208
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004209#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00004210/**
k-stachowiak6d722122019-02-08 17:03:33 +01004211 * \brief Set the maximum fragment length to emit and/or negotiate.
4212 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
4213 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004214 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01004215 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004216 * (Client: set maximum fragment length to emit *and*
4217 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02004218 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004219 *
k-stachowiak6d722122019-02-08 17:03:33 +01004220 * \note On the client side, the maximum fragment length extension
4221 * *will not* be used, unless the maximum fragment length has
4222 * been set via this function to a value different than
4223 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004224 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004225 * \note With TLS, this currently only affects ApplicationData (sent
4226 * with \c mbedtls_ssl_read()), not handshake messages.
4227 * With DTLS, this affects both ApplicationData and handshake.
4228 *
Gilles Peskined8f9e222025-03-11 13:45:27 +01004229 * \note Defragmentation of TLS handshake messages is supported
4230 * with some limitations. See the documentation of
4231 * mbedtls_ssl_handshake() for details.
Gilles Peskine36edd482025-03-05 17:41:59 +01004232 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02004233 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004234 * excluding record overhead that will be added to it, see
4235 * \c mbedtls_ssl_get_record_expansion().
4236 *
4237 * \note For DTLS, it is also possible to set a limit for the total
Tom Cosgrove1e211442022-05-26 11:51:00 +01004238 * size of datagrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02004239 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004240 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01004241 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02004242 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004243 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
4244 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004245 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02004246 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004248int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004249#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004250
TRodziewicz8476f2f2021-06-02 14:34:47 +02004251#if defined(MBEDTLS_SSL_SRV_C)
4252/**
TRodziewicz3946f792021-06-14 12:11:18 +02004253 * \brief Pick the ciphersuites order according to the second parameter
4254 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
4255 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004256 *
4257 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02004258 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
4259 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004261void mbedtls_ssl_conf_preference_order(mbedtls_ssl_config *conf, int order);
TRodziewicz8476f2f2021-06-02 14:34:47 +02004262#endif /* MBEDTLS_SSL_SRV_C */
4263
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004264#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4265 defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02004266/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004267 * \brief Enable / Disable session tickets (client only).
4268 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004269 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004270 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004271 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01004272 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004273 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
4274 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004275 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004276void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004277#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4278 MBEDTLS_SSL_CLI_C */
4279
4280#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4281 defined(MBEDTLS_SSL_SRV_C) && \
4282 defined(MBEDTLS_SSL_PROTO_TLS1_3)
4283/**
Jerry Yuba627bf2022-09-23 09:58:22 +08004284 * \brief Number of NewSessionTicket messages for the server to send
4285 * after handshake completion.
4286 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004287 * \note The default value is
Jerry Yuba627bf2022-09-23 09:58:22 +08004288 * \c MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS.
4289 *
4290 * \note In case of a session resumption, this setting only partially apply.
4291 * At most one ticket is sent in that case to just renew the pool of
4292 * tickets of the client. The rationale is to avoid the number of
4293 * tickets on the server to become rapidly out of control when the
4294 * server has the same configuration for all its connection instances.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004295 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004296 * \param conf SSL configuration
4297 * \param num_tickets Number of NewSessionTicket.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004298 *
4299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004300void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
4301 uint16_t num_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004302#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4303 MBEDTLS_SSL_SRV_C &&
4304 MBEDTLS_SSL_PROTO_TLS1_3*/
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004306#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004307/**
Paul Bakker09f097d2012-10-23 11:54:56 +00004308 * \brief Enable / Disable renegotiation support for connection when
4309 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004310 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00004311 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004312 * \warning It is recommended to always disable renegotiation unless you
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004313 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00004314 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004315 * renegotiation or a poor understanding of its properties.
4316 *
4317 * \note Server-side, enabling renegotiation also makes the server
4318 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00004319 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004320 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004321 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
4322 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00004323 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004324void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004325#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004326
4327/**
4328 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004329 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02004330 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004331 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004332 * be established even if the peer does not support
4333 * secure renegotiation, but does not allow renegotiation
4334 * to take place if not secure.
4335 * (Interoperable and secure option)
4336 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004337 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004338 * with non-upgraded peers. Allowing legacy renegotiation
4339 * makes the connection vulnerable to specific man in the
4340 * middle attacks. (See RFC 5746)
4341 * (Most interoperable and least secure option)
4342 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004343 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004344 * if peer does not support secure renegotiation. Results
4345 * in interoperability issues with non-upgraded peers
4346 * that do not support renegotiation altogether.
4347 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00004348 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004349 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00004350 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
4351 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004352 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00004353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004354void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy);
Paul Bakker48916f92012-09-16 19:57:18 +00004355
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004356#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004357/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004358 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004359 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004360 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004361 * When we request a renegotiation, the peer can comply or
4362 * ignore the request. This function allows us to decide
4363 * whether to enforce our renegotiation requests by closing
4364 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004365 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004366 * However, records could already be in transit from the peer
4367 * when the request is emitted. In order to increase
4368 * reliability, we can accept a number of records before the
4369 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004370 *
4371 * The optimal value is highly dependent on the specific usage
4372 * scenario.
4373 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004374 * \note With DTLS and server-initiated renegotiation, the
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004375 * HelloRequest is retransmitted every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004376 * out or receives Application Data, until:
4377 * - max_records records have beens seen, if it is >= 0, or
4378 * - the number of retransmits that would happen during an
4379 * actual handshake has been reached.
4380 * Please remember the request might be lost a few times
4381 * if you consider setting max_records to a really low value.
4382 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004383 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004384 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004385 * which always behave as if max_record was 0. The reason is,
4386 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004388 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004389 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004390 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004391 * enforce renegotiation, or a non-negative value to enforce
4392 * it but allow for a grace period of max_records records.
4393 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004394void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records);
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004395
4396/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004397 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00004398 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004399 *
4400 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01004401 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004402 * threshold. The default value is meant to prevent the
4403 * connection from being closed when the counter is about to
4404 * reached its maximal value (it is not allowed to wrap).
4405 *
4406 * Lower values can be used to enforce policies such as "keys
4407 * must be refreshed every N packets with cipher X".
4408 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00004409 * The renegotiation period can be disabled by setting
4410 * conf->disable_renegotiation to
4411 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
4412 *
4413 * \note When the configured transport is
4414 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
4415 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
4416 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00004417 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004418 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004419 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004421void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
4422 const unsigned char period[8]);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004423#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00004424
Paul Bakker43ca69c2011-01-15 17:35:19 +00004425/**
Hanno Becker8b170a02017-10-10 11:51:19 +01004426 * \brief Check if there is data already read from the
4427 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004428 *
4429 * \param ssl SSL context
4430 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004431 * \return 0 if nothing's pending, 1 otherwise.
4432 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004433 * \note This is different in purpose and behaviour from
4434 * \c mbedtls_ssl_get_bytes_avail in that it considers
4435 * any kind of unprocessed data, not only unread
4436 * application data. If \c mbedtls_ssl_get_bytes
4437 * returns a non-zero value, this function will
4438 * also signal pending data, but the converse does
4439 * not hold. For example, in DTLS there might be
4440 * further records waiting to be processed from
4441 * the current underlying transport's datagram.
4442 *
Hanno Becker9b19a122017-10-31 13:00:14 +00004443 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01004444 * does not imply that a subsequent call to
4445 * \c mbedtls_ssl_read will provide any data;
4446 * e.g., the unprocessed data might turn out
4447 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00004448 *
4449 * \note This function is useful in the following situation:
4450 * If the SSL/TLS module successfully returns from an
4451 * operation - e.g. a handshake or an application record
4452 * read - and you're awaiting incoming data next, you
4453 * must not immediately idle on the underlying transport
4454 * to have data ready, but you need to check the value
4455 * of this function first. The reason is that the desired
4456 * data might already be read but not yet processed.
4457 * If, in contrast, a previous call to the SSL/TLS module
4458 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
4459 * to call this function, as the latter error code entails
4460 * that all internal data has been processed.
4461 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004463int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl);
Hanno Becker8b170a02017-10-10 11:51:19 +01004464
4465/**
4466 * \brief Return the number of application data bytes
4467 * remaining to be read from the current record.
4468 *
4469 * \param ssl SSL context
4470 *
4471 * \return How many bytes are available in the application
4472 * data record read buffer.
4473 *
4474 * \note When working over a datagram transport, this is
4475 * useful to detect the current datagram's boundary
4476 * in case \c mbedtls_ssl_read has written the maximal
4477 * amount of data fitting into the input buffer.
4478 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004479 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004480size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004481
4482/**
4483 * \brief Return the result of the certificate verification
4484 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004485 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00004486 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004487 * \return \c 0 if the certificate verification was successful.
4488 * \return \c -1u if the result is not available. This may happen
4489 * e.g. if the handshake aborts early, or a verification
4490 * callback returned a fatal error.
4491 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
4492 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00004493 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004494uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004495
4496/**
Glenn Strauss8f526902022-01-13 00:04:49 -05004497 * \brief Return the id of the current ciphersuite
4498 *
4499 * \param ssl SSL context
4500 *
4501 * \return a ciphersuite id
4502 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004503int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl);
Glenn Strauss8f526902022-01-13 00:04:49 -05004504
4505/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00004506 * \brief Return the name of the current ciphersuite
4507 *
4508 * \param ssl SSL context
4509 *
4510 * \return a string containing the ciphersuite name
4511 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004512const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004513
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004514
4515/**
4516 * \brief Return the (D)TLS protocol version negotiated in the
4517 * given connection.
4518 *
Gilles Peskined44e0502022-02-12 00:45:21 +01004519 * \note If you call this function too early during the initial
4520 * handshake, before the two sides have agreed on a version,
4521 * this function returns #MBEDTLS_SSL_VERSION_UNKNOWN.
4522 *
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004523 * \param ssl The SSL context to query.
4524 * \return The negotiated protocol version.
4525 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04004526static inline mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(
Gilles Peskine449bd832023-01-11 14:50:10 +01004527 const mbedtls_ssl_context *ssl)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004528{
4529 return ssl->MBEDTLS_PRIVATE(tls_version);
4530}
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004531
Paul Bakker5121ce52009-01-03 21:22:43 +00004532/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004533 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004534 *
4535 * \param ssl SSL context
4536 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004537 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004538 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004539const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004540
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004541/**
4542 * \brief Return the (maximum) number of bytes added by the record
4543 * layer: header + encryption/MAC overhead (inc. padding)
4544 *
4545 * \param ssl SSL context
4546 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01004547 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004548 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004549int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004550
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004551/**
4552 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004553 *
4554 * \note The logic to determine the maximum outgoing record payload is
4555 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004556 * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004557 * such as the max fragment length or record size limit extension if
4558 * used, and for DTLS the path MTU as configured and current
4559 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004560 *
4561 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
4562 * called with a larger length value.
4563 * With TLS, \c mbedtls_ssl_write() will fragment the input if
4564 * necessary and return the number of bytes written; it is up
4565 * to the caller to call \c mbedtls_ssl_write() again in
4566 * order to send the remaining bytes if any.
4567 *
Hanno Becker80d163d2021-04-21 06:28:18 +01004568 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004569 * \sa mbedtls_ssl_get_record_expansion()
4570 *
4571 * \param ssl SSL context
4572 *
4573 * \return Current maximum payload for an outgoing record,
4574 * or a negative error code.
4575 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004576int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004577
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004578/**
4579 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004580 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004581 * \note The logic to determine the maximum incoming record payload is
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004582 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004583 * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004584 * such as the max fragment length extension or record size limit
4585 * extension if used, and the current record expansion.
4586 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004587 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01004588 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004589 * \sa mbedtls_ssl_get_record_expansion()
4590 *
4591 * \param ssl SSL context
4592 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004593 * \return Current maximum payload for an incoming record,
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004594 * or a negative error code.
4595 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004596int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004597
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00004599/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004600 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004601 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004602 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004603 *
Hanno Becker958efeb2019-02-25 10:13:43 +00004604 * \return The current peer certificate, if available.
4605 * The returned certificate is owned by the SSL context and
4606 * is valid only until the next call to the SSL API.
4607 * \return \c NULL if no peer certificate is available. This might
4608 * be because the chosen ciphersuite doesn't use CRTs
4609 * (PSK-based ciphersuites, for example), or because
4610 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
4611 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004612 *
4613 * \note For one-time inspection of the peer's certificate during
4614 * the handshake, consider registering an X.509 CRT verification
4615 * callback through mbedtls_ssl_conf_verify() instead of calling
4616 * this function. Using mbedtls_ssl_conf_verify() also comes at
4617 * the benefit of allowing you to influence the verification
4618 * process, for example by masking expected and tolerated
4619 * verification failures.
4620 *
4621 * \warning You must not use the pointer returned by this function
4622 * after any further call to the SSL API, including
4623 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
4624 * because the pointer might change during renegotiation,
4625 * which happens transparently to the user.
4626 * If you want to use the certificate across API calls,
4627 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004628 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004629const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004630#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00004631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004632#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00004633/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01004634 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004635 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004636 * \param ssl The SSL context representing the connection for which to
4637 * to export a session structure for later resumption.
4638 * \param session The target structure in which to store the exported session.
Benson Liou6d0a0932023-12-27 22:03:24 +08004639 * This must have been initialized with mbedtls_ssl_session_init()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004640 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004641 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01004642 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01004643 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01004644 * ticket-based resumption will be considered. For TLS 1.3,
Ronald Cron66a206c2024-04-04 15:34:22 +02004645 * sessions equate to tickets, and if session tickets are
4646 * enabled (see #MBEDTLS_SSL_SESSION_TICKETS configuration
4647 * option), this function exports the last received ticket and
4648 * the exported session may be used to resume the TLS 1.3
4649 * session. If session tickets are disabled, exported sessions
4650 * cannot be used to resume a TLS 1.3 session.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004651 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004652 * \return \c 0 if successful. In this case, \p session can be used for
4653 * session resumption by passing it to mbedtls_ssl_set_session(),
4654 * and serialized for storage via mbedtls_ssl_session_save().
Hanno Beckere810bbc2021-05-14 16:01:05 +01004655 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004656 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004658 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004659 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004660int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
4661 mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004662#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004663
4664/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004665 * \brief Perform the SSL handshake
4666 *
4667 * \param ssl SSL context
4668 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004669 * \return \c 0 if successful.
4670 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004671 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004672 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004673 * transport - in this case you must call this function again
4674 * when the underlying transport is ready for the operation.
4675 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4676 * operation is in progress (see
4677 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4678 * must call this function again when the operation is ready.
4679 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4680 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4681 * in this case you must call this function again to complete
4682 * the handshake when you're done attending other tasks.
4683 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
4684 * and the client did not demonstrate reachability yet - in
4685 * this case you must stop using the context (see below).
Jerry Yu032985c2023-12-06 17:59:33 +08004686 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4687 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004688 * received as part of the handshake. This is server specific
4689 * and may occur only if the early data feature has been
4690 * enabled on server (see mbedtls_ssl_conf_early_data()
4691 * documentation). You must call mbedtls_ssl_read_early_data()
4692 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004693 * \return Another SSL error code - in this case you must stop using
4694 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02004695 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004696 * \warning If this function returns something other than
4697 * \c 0,
4698 * #MBEDTLS_ERR_SSL_WANT_READ,
4699 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4700 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
Jerry Yu032985c2023-12-06 17:59:33 +08004701 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4702 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004703 * you must stop using the SSL context for reading or writing,
4704 * and either free it or call \c mbedtls_ssl_session_reset()
4705 * on it before re-using it for a new connection; the current
4706 * connection must be closed.
4707 *
4708 * \note If DTLS is in use, then you may choose to handle
4709 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
4710 * purposes, as it is an expected return value rather than an
4711 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01004712 *
4713 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004714 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004715 * from the underlying transport layer is currently being processed,
4716 * and it is safe to idle until the timer or the underlying transport
4717 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004718 * in which case the datagram of the underlying transport that is
4719 * currently being processed might or might not contain further
4720 * DTLS records.
Gilles Peskine8c2830a2022-08-04 23:37:51 +02004721 *
Gilles Peskine2b78a5a2025-03-12 10:07:33 +01004722 * \note In TLS, reception of fragmented handshake messages is
4723 * supported with some limitations (those limitations do
4724 * not apply to DTLS, where defragmentation is fully
4725 * supported):
Gilles Peskined8f9e222025-03-11 13:45:27 +01004726 * - On an Mbed TLS server that only accepts TLS 1.2,
4727 * the initial ClientHello message must not be fragmented.
4728 * A TLS 1.2 ClientHello may be fragmented if the server
4729 * also accepts TLS 1.3 connections (meaning
4730 * that #MBEDTLS_SSL_PROTO_TLS1_3 enabled, and the
4731 * accepted versions have not been restricted with
4732 * mbedtls_ssl_conf_max_tls_version() or the like).
Gilles Peskined8f9e222025-03-11 13:45:27 +01004733 * - The first fragment of a handshake message must be
4734 * at least 4 bytes long.
4735 * - Non-handshake records must not be interleaved between
4736 * the fragments of a handshake message. (This is permitted
4737 * in TLS 1.2 but not in TLS 1.3, but Mbed TLS rejects it
4738 * even in TLS 1.2.)
4739 *
Janos Follath130ece02024-11-19 16:16:36 +00004740 * \note The PSA crypto subsystem must have been initialized by
4741 * calling psa_crypto_init() before calling this function.
Paul Bakker5121ce52009-01-03 21:22:43 +00004742 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004743int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004744
4745/**
Paul Elliott93ba3e32022-03-18 21:51:13 +00004746 * \brief After calling mbedtls_ssl_handshake() to start the SSL
4747 * handshake you can call this function to check whether the
4748 * handshake is over for a given SSL context. This function
4749 * should be also used to determine when to stop calling
4750 * mbedtls_handshake_step() for that context.
4751 *
4752 * \param ssl SSL context
4753 *
4754 * \return \c 1 if handshake is over, \c 0 if it is still ongoing.
4755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004756static inline int mbedtls_ssl_is_handshake_over(mbedtls_ssl_context *ssl)
Paul Elliott93ba3e32022-03-18 21:51:13 +00004757{
Gilles Peskine449bd832023-01-11 14:50:10 +01004758 return ssl->MBEDTLS_PRIVATE(state) >= MBEDTLS_SSL_HANDSHAKE_OVER;
Paul Elliott93ba3e32022-03-18 21:51:13 +00004759}
4760
4761/**
Paul Bakker1961b702013-01-25 14:49:24 +01004762 * \brief Perform a single step of the SSL handshake
4763 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02004764 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004765 * the next state after this function returns \c 0. Do not
Paul Elliott93ba3e32022-03-18 21:51:13 +00004766 * call this function if mbedtls_ssl_is_handshake_over()
4767 * returns \c 1.
4768 *
4769 * \warning Whilst in the past you may have used direct access to the
4770 * context state (ssl->state) in order to ascertain when to
4771 * stop calling this function and although you can still do
4772 * so with something like ssl->MBEDTLS_PRIVATE(state) or by
4773 * defining MBEDTLS_ALLOW_PRIVATE_ACCESS, this is now
4774 * considered deprecated and could be broken in any future
4775 * release. If you still find you have good reason for such
4776 * direct access, then please do contact the team to explain
4777 * this (raise an issue or post to the mailing list), so that
4778 * we can add a solution to your problem that will be
4779 * guaranteed to work in the future.
Paul Bakker1961b702013-01-25 14:49:24 +01004780 *
4781 * \param ssl SSL context
4782 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004783 * \return See mbedtls_ssl_handshake().
4784 *
4785 * \warning If this function returns something other than \c 0,
4786 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
Jerry Yu032985c2023-12-06 17:59:33 +08004787 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4788 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4789 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA, you must stop using
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004790 * the SSL context for reading or writing, and either free it
4791 * or call \c mbedtls_ssl_session_reset() on it before
4792 * re-using it for a new connection; the current connection
4793 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01004794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004795int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004796
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004797#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01004798/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004799 * \brief Initiate an SSL renegotiation on the running connection.
4800 * Client: perform the renegotiation right now.
4801 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00004802 * during the next call to mbedtls_ssl_read() if honored by
4803 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00004804 *
4805 * \param ssl SSL context
4806 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00004807 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004808 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
4809 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004810 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004811 * \warning If this function returns something other than \c 0,
4812 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4813 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4814 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4815 * the SSL context for reading or writing, and either free it
4816 * or call \c mbedtls_ssl_session_reset() on it before
4817 * re-using it for a new connection; the current connection
4818 * must be closed.
4819 *
Paul Bakker48916f92012-09-16 19:57:18 +00004820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004821int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004822#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004823
4824/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004825 * \brief Read at most 'len' application data bytes
4826 *
4827 * \param ssl SSL context
4828 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02004829 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00004830 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004831 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004832 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04004833 * without sending a CloseNotify beforehand, which might happen
4834 * because of various reasons (internal error of an underlying
4835 * stack, non-conformant peer not sending a CloseNotify and
4836 * such) - in this case you must stop using the context
4837 * (see below).
4838 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
4839 * transport is still functional, but the peer has
4840 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004841 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004842 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004843 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004844 * transport - in this case you must call this function again
4845 * when the underlying transport is ready for the operation.
4846 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4847 * operation is in progress (see
4848 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4849 * must call this function again when the operation is ready.
4850 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4851 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4852 * in this case you must call this function again to complete
4853 * the handshake when you're done attending other tasks.
4854 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
4855 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004856 * new connection using the same source port. See below.
Jerry Yu032985c2023-12-06 17:59:33 +08004857 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4858 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004859 * received as part of the handshake. This is server specific
4860 * and may occur only if the early data feature has been
4861 * enabled on server (see mbedtls_ssl_conf_early_data()
4862 * documentation). You must call mbedtls_ssl_read_early_data()
4863 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004864 * \return Another SSL error code - in this case you must stop using
4865 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004866 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004867 * \warning If this function returns something other than
4868 * a positive value,
4869 * #MBEDTLS_ERR_SSL_WANT_READ,
4870 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4871 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
Jerry Yu032985c2023-12-06 17:59:33 +08004872 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4873 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT or
4874 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004875 * you must stop using the SSL context for reading or writing,
4876 * and either free it or call \c mbedtls_ssl_session_reset()
4877 * on it before re-using it for a new connection; the current
4878 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004879 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004880 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004881 * (which can only happen server-side), it means that a client
4882 * is initiating a new connection using the same source port.
4883 * You can either treat that as a connection close and wait
4884 * for the client to resend a ClientHello, or directly
4885 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004886 * context (as it has been reset internally). Either way, you
4887 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004888 * connection: application state, if any, should be reset, and
4889 * most importantly the identity of the client must be checked
4890 * again. WARNING: not validating the identity of the client
4891 * again, or not transmitting the new identity to the
4892 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01004893 *
Hanno Becker8ec81022017-10-10 10:35:08 +01004894 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004895 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004896 * from the underlying transport layer is currently being processed,
4897 * and it is safe to idle until the timer or the underlying transport
4898 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004899 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
4900 * initially available on the underlying transport, as this data may have
4901 * been only e.g. duplicated messages or a renegotiation request.
4902 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
4903 * when reacting to an incoming-data event from the underlying transport.
4904 * - On success, the datagram of the underlying transport that is currently
4905 * being processed may contain further DTLS records. You should call
4906 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01004907 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004909int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004910
4911/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004912 * \brief Try to write exactly 'len' application data bytes
4913 *
4914 * \warning This function will do partial writes in some cases. If the
4915 * return value is non-negative but less than length, the
4916 * function must be called again with updated arguments:
4917 * buf + ret, len - ret (if ret is the return value) until
4918 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00004919 *
4920 * \param ssl SSL context
4921 * \param buf buffer holding the data
4922 * \param len how many bytes must be written
4923 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004924 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004925 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004926 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004927 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004928 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004929 * transport - in this case you must call this function again
4930 * when the underlying transport is ready for the operation.
4931 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4932 * operation is in progress (see
4933 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4934 * must call this function again when the operation is ready.
4935 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4936 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4937 * in this case you must call this function again to complete
4938 * the handshake when you're done attending other tasks.
Jerry Yu032985c2023-12-06 17:59:33 +08004939 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4940 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004941 * received as part of the handshake. This is server specific
4942 * and may occur only if the early data feature has been
4943 * enabled on server (see mbedtls_ssl_conf_early_data()
4944 * documentation). You must call mbedtls_ssl_read_early_data()
4945 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004946 * \return Another SSL error code - in this case you must stop using
4947 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00004948 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004949 * \warning If this function returns something other than
4950 * a non-negative value,
4951 * #MBEDTLS_ERR_SSL_WANT_READ,
4952 * #MBEDTLS_ERR_SSL_WANT_WRITE,
Jerry Yu032985c2023-12-06 17:59:33 +08004953 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4954 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4955 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004956 * you must stop using the SSL context for reading or writing,
4957 * and either free it or call \c mbedtls_ssl_session_reset()
4958 * on it before re-using it for a new connection; the current
4959 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004960 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004961 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00004962 * it must be called later with the *same* arguments,
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02004963 * until it returns a value greater than or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004964 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004965 * some partial data in the output buffer, however this is not
4966 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02004967 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00004968 * \note If the requested length is greater than the maximum
4969 * fragment length (either the built-in limit or the one set
4970 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004971 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004972 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01004973 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004974 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004975 *
4976 * \note Attempting to write 0 bytes will result in an empty TLS
4977 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004979int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004980
4981/**
Paul Bakker0a925182012-04-16 06:46:41 +00004982 * \brief Send an alert message
4983 *
4984 * \param ssl SSL context
4985 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004986 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004987 * \param message The alert message (SSL_ALERT_MSG_*)
4988 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004989 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004990 *
4991 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004992 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4993 * the SSL context for reading or writing, and either free it or
4994 * call \c mbedtls_ssl_session_reset() on it before re-using it
4995 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004996 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004997int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4998 unsigned char level,
4999 unsigned char message);
Paul Bakker0a925182012-04-16 06:46:41 +00005000/**
Paul Bakker5121ce52009-01-03 21:22:43 +00005001 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00005002 *
5003 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01005004 *
5005 * \return 0 if successful, or a specific SSL error code.
5006 *
5007 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00005008 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
5009 * the SSL context for reading or writing, and either free it or
5010 * call \c mbedtls_ssl_session_reset() on it before re-using it
5011 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00005012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005013int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005014
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005015#if defined(MBEDTLS_SSL_EARLY_DATA)
5016
5017#if defined(MBEDTLS_SSL_SRV_C)
5018/**
Ronald Cron3a045622024-01-08 18:44:59 +01005019 * \brief Read at most 'len' bytes of early data
5020 *
5021 * \note This API is server specific.
5022 *
Ronald Cron164537c2024-02-01 18:05:47 +01005023 * \warning Early data is defined in the TLS 1.3 specification, RFC 8446.
Ronald Cron44d70a52024-01-30 18:16:47 +01005024 * IMPORTANT NOTE from section 2.3 of the specification:
5025 *
5026 * The security properties for 0-RTT data are weaker than
5027 * those for other kinds of TLS data. Specifically:
5028 * - This data is not forward secret, as it is encrypted
5029 * solely under keys derived using the offered PSK.
5030 * - There are no guarantees of non-replay between connections.
5031 * Protection against replay for ordinary TLS 1.3 1-RTT data
5032 * is provided via the server's Random value, but 0-RTT data
5033 * does not depend on the ServerHello and therefore has
5034 * weaker guarantees. This is especially relevant if the
5035 * data is authenticated either with TLS client
5036 * authentication or inside the application protocol. The
5037 * same warnings apply to any use of the
5038 * early_exporter_master_secret.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005039 *
Ronald Cron3996ebc2024-03-15 14:57:05 +01005040 * \warning Mbed TLS does not implement any of the anti-replay defenses
Ronald Cron1987a7c2024-03-14 19:05:26 +01005041 * defined in section 8 of the TLS 1.3 specification:
Ronald Cron3996ebc2024-03-15 14:57:05 +01005042 * single-use of tickets or ClientHello recording within a
5043 * given time window.
Ronald Cron1987a7c2024-03-14 19:05:26 +01005044 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01005045 * \note This function is used in conjunction with
Ronald Cron3a045622024-01-08 18:44:59 +01005046 * mbedtls_ssl_handshake(), mbedtls_ssl_handshake_step(),
5047 * mbedtls_ssl_read() and mbedtls_ssl_write() to read early
5048 * data when these functions return
5049 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA.
5050 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01005051 * \param ssl SSL context, it must have been initialized and set up.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005052 * \param buf buffer that will hold the data
5053 * \param len maximum number of bytes to read
5054 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01005055 * \return The (positive) number of bytes read if successful.
5056 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
5057 * \return #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA if it is not
5058 * possible to read early data for the SSL context \p ssl. Note
5059 * that this function is intended to be called for an SSL
5060 * context \p ssl only after a call to mbedtls_ssl_handshake(),
5061 * mbedtls_ssl_handshake_step(), mbedtls_ssl_read() or
5062 * mbedtls_ssl_write() for \p ssl that has returned
Ronald Cron3a045622024-01-08 18:44:59 +01005063 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005064 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005065int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5066 unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005067#endif /* MBEDTLS_SSL_SRV_C */
5068
5069#if defined(MBEDTLS_SSL_CLI_C)
5070/**
5071 * \brief Try to write exactly 'len' application data bytes while
5072 * performing the handshake (early data).
5073 *
Ronald Crond4069242024-02-21 13:45:52 +01005074 * \warning Early data is defined in the TLS 1.3 specification, RFC 8446.
5075 * IMPORTANT NOTE from section 2.3 of the specification:
5076 *
5077 * The security properties for 0-RTT data are weaker than
5078 * those for other kinds of TLS data. Specifically:
5079 * - This data is not forward secret, as it is encrypted
5080 * solely under keys derived using the offered PSK.
5081 * - There are no guarantees of non-replay between connections.
5082 * Protection against replay for ordinary TLS 1.3 1-RTT data
5083 * is provided via the server's Random value, but 0-RTT data
5084 * does not depend on the ServerHello and therefore has
5085 * weaker guarantees. This is especially relevant if the
5086 * data is authenticated either with TLS client
5087 * authentication or inside the application protocol. The
5088 * same warnings apply to any use of the
5089 * early_exporter_master_secret.
5090 *
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005091 * \note This function behaves mainly as mbedtls_ssl_write(). The
5092 * specification of mbedtls_ssl_write() relevant to TLS 1.3
5093 * (thus not the parts specific to (D)TLS1.2) applies to this
Ronald Crond4069242024-02-21 13:45:52 +01005094 * function and the present documentation is mainly restricted
5095 * to the differences with mbedtls_ssl_write(). One noticeable
5096 * difference though is that mbedtls_ssl_write() aims to
5097 * complete the handshake before to write application data
5098 * while mbedtls_ssl_write_early() aims to drive the handshake
5099 * just past the point where it is not possible to send early
5100 * data anymore.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005101 *
5102 * \param ssl SSL context
5103 * \param buf buffer holding the data
5104 * \param len how many bytes must be written
5105 *
Ronald Crond4069242024-02-21 13:45:52 +01005106 * \return The (non-negative) number of bytes actually written if
5107 * successful (may be less than \p len).
5108 *
5109 * \return One additional specific error code compared to
5110 * mbedtls_ssl_write():
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005111 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA.
5112 *
5113 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA is returned when it
5114 * is not possible to write early data for the SSL context
5115 * \p ssl.
5116 *
5117 * It may have been possible and it is not possible
5118 * anymore because the client received the server Finished
5119 * message, the server rejected early data or the maximum
5120 * number of allowed early data for the PSK in use has been
5121 * reached.
5122 *
5123 * It may never have been possible and will never be possible
5124 * for the SSL context \p ssl because the use of early data
5125 * is disabled for that context or more generally the context
5126 * is not suitably configured to enable early data or the first
5127 * call to the function was done while the handshake was
5128 * already completed.
5129 *
5130 * It is not possible to write early data for the SSL context
Ronald Cron8f1de7e2024-02-22 12:02:39 +01005131 * \p ssl and any subsequent call to this API will return this
5132 * error code. But this does not preclude for using it with
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005133 * mbedtls_ssl_write(), mbedtls_ssl_read() or
Ronald Cron8f1de7e2024-02-22 12:02:39 +01005134 * mbedtls_ssl_handshake() and the handshake can be
5135 * completed by calling one of these APIs.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005136 *
5137 * \note This function may write early data only if the SSL context
5138 * has been configured for the handshake with a PSK for which
5139 * early data is allowed.
5140 *
5141 * \note To maximize the number of early data that can be written in
5142 * the course of the handshake, it is expected that this
5143 * function starts the handshake for the SSL context \p ssl.
5144 * But this is not mandatory.
5145 *
5146 * \note This function does not provide any information on whether
5147 * the server has accepted or will accept early data or not.
5148 * When it returns a positive value, it just means that it
5149 * has written early data to the server. To know whether the
5150 * server has accepted early data or not, you should call
5151 * mbedtls_ssl_get_early_data_status() with the handshake
5152 * completed.
5153 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005154int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5155 const unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005156
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005157/**
5158 * \brief Get the status of the negotiation of the use of early data.
5159 *
5160 * \param ssl The SSL context to query
5161 *
5162 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called
5163 * from the server-side.
5164 *
5165 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called
5166 * prior to completion of the handshake.
5167 *
Ronald Cron840de7f2024-03-11 17:49:35 +01005168 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_INDICATED if the client
5169 * has not indicated the use of early data to the server.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005170 *
5171 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED if the client has
5172 * indicated the use of early data and the server has accepted
5173 * it.
5174 *
5175 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED if the client has
5176 * indicated the use of early data but the server has rejected
5177 * it. In this situation, the client may want to re-send the
5178 * early data it may have tried to send by calling
5179 * mbedtls_ssl_write_early_data() as ordinary post-handshake
5180 * application data by calling mbedtls_ssl_write().
5181 *
5182 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005183int mbedtls_ssl_get_early_data_status(mbedtls_ssl_context *ssl);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005184#endif /* MBEDTLS_SSL_CLI_C */
5185
5186#endif /* MBEDTLS_SSL_EARLY_DATA */
5187
Paul Bakker5121ce52009-01-03 21:22:43 +00005188/**
Paul Bakker48916f92012-09-16 19:57:18 +00005189 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00005190 *
5191 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00005192 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005193void mbedtls_ssl_free(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005194
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005195#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00005196/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005197 * \brief Save an active connection as serialized data in a buffer.
5198 * This allows the freeing or re-using of the SSL context
5199 * while still picking up the connection later in a way that
5200 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005201 *
5202 * \see mbedtls_ssl_context_load()
5203 *
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005204 * \note The serialized data only contains the data that is
5205 * necessary to resume the connection: negotiated protocol
5206 * options, session identifier, keys, etc.
5207 * Loading a saved SSL context does not restore settings and
5208 * state related to how the application accesses the context,
5209 * such as configured callback functions, user data, pending
5210 * incoming or outgoing data, etc.
5211 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005212 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005213 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005214 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
5215 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005216 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005217 * mbedtls_ssl_session_reset() on \p ssl which as a result is
5218 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005219 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005220 * state. You're then free to either re-use the context
5221 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005222 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005223 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005224 *
5225 * \param ssl The SSL context to save. On success, it is no longer
5226 * associated with the connection that has been serialized.
5227 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03005228 * writeable buffer of at least \p buf_len bytes, or may be \c
5229 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005230 * \param buf_len The number of bytes available for writing in \p buf.
5231 * \param olen The size in bytes of the data that has been or would have
5232 * been written. It must point to a valid \c size_t.
5233 *
5234 * \note \p olen is updated to the correct value regardless of
5235 * whether \p buf_len was large enough. This makes it possible
5236 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005237 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
5238 * the value of \p olen is only guaranteed to be correct when
5239 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
5240 * \c 0. If the return value is different, then the value of
5241 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005242 *
5243 * \return \c 0 if successful.
5244 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005245 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005246 * while resetting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005247 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005248 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005249 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005250 * ciphersuite, or renegotiation is enabled.
5251 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005252int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5253 unsigned char *buf,
5254 size_t buf_len,
5255 size_t *olen);
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005256
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005257/**
5258 * \brief Load serialized connection data to an SSL context.
5259 *
5260 * \see mbedtls_ssl_context_save()
5261 *
5262 * \warning The same serialized data must never be loaded into more
5263 * that one context. In order to ensure that, after
5264 * successfully loading serialized data to an SSL context, you
5265 * should immediately destroy or invalidate all copies of the
5266 * serialized data that was loaded. Loading the same data in
5267 * more than one context would cause severe security failures
5268 * including but not limited to loss of confidentiality.
5269 *
5270 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005271 * prepared in one of the two following ways. The first way is
5272 * to take a context freshly initialised with
5273 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005274 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005275 * the original connection. The second way is to
5276 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005277 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005278 * Either way, you must not use the context to perform a
5279 * handshake between calling mbedtls_ssl_setup() or
5280 * mbedtls_ssl_session_reset() and calling this function. You
5281 * may however call other setter functions in that time frame
5282 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005283 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005284 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005285 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005286 * and settings before you can use the connection again
5287 * (unless they were already set before calling
5288 * mbedtls_ssl_session_reset() and the values are suitable for
5289 * the present connection). Specifically, you want to call
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005290 * at least mbedtls_ssl_set_bio(),
5291 * mbedtls_ssl_set_timer_cb(), and
5292 * mbedtls_ssl_set_user_data_n() or
5293 * mbedtls_ssl_set_user_data_p() if they were set originally.
5294 * All other SSL setter functions
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02005295 * are not necessary to call, either because they're only used
5296 * in handshakes, or because the setting is already saved. You
5297 * might choose to call them anyway, for example in order to
5298 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005299 * connection and the case of loading an already-established
5300 * connection.
5301 *
5302 * \note If you have new information about the path MTU, you want to
5303 * call mbedtls_ssl_set_mtu() after calling this function, as
5304 * otherwise this function would overwrite your
5305 * newly-configured value with the value that was active when
5306 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005307 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005308 * \note When this function returns an error code, it calls
5309 * mbedtls_ssl_free() on \p ssl. In this case, you need to
5310 * prepare the context with the usual sequence starting with a
5311 * call to mbedtls_ssl_init() if you want to use it again.
5312 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005313 * \param ssl The SSL context structure to be populated. It must have
5314 * been prepared as described in the note above.
5315 * \param buf The buffer holding the serialized connection data. It must
5316 * be a readable buffer of at least \p len bytes.
5317 * \param len The size of the serialized data in bytes.
5318 *
5319 * \return \c 0 if successful.
5320 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005321 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
5322 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005323 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
5324 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005325int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl,
5326 const unsigned char *buf,
5327 size_t len);
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005328#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005329
5330/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005331 * \brief Initialize an SSL configuration context
5332 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005333 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005334 *
5335 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01005336 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005337 *
5338 * \param conf SSL configuration context
5339 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005340void mbedtls_ssl_config_init(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005341
5342/**
Adam Wolf039080f2019-09-10 09:53:08 -05005343 * \brief Load reasonable default SSL configuration values.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005344 * (You need to call mbedtls_ssl_config_init() first.)
5345 *
5346 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005347 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
5348 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
5349 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005350 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005351 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02005352 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01005353 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005354 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005355 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005356 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005357int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5358 int endpoint, int transport, int preset);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005359
5360/**
5361 * \brief Free an SSL configuration context
5362 *
5363 * \param conf SSL configuration context
5364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005365void mbedtls_ssl_config_free(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005366
5367/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005368 * \brief Initialize SSL session structure
5369 *
5370 * \param session SSL session
5371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005372void mbedtls_ssl_session_init(mbedtls_ssl_session *session);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005373
5374/**
Paul Bakker0a597072012-09-25 21:55:46 +00005375 * \brief Free referenced items in an SSL session including the
5376 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00005377 *
Ron Eldor00115032018-07-17 11:21:50 +03005378 * \note A session object can be freed even if the SSL context
5379 * that was used to retrieve the session is still in use.
5380 *
Paul Bakker48916f92012-09-16 19:57:18 +00005381 * \param session SSL session
5382 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005383void mbedtls_ssl_session_free(mbedtls_ssl_session *session);
Paul Bakker48916f92012-09-16 19:57:18 +00005384
Ron Eldor51d3ab52019-05-12 14:54:30 +03005385/**
5386 * \brief TLS-PRF function for key derivation.
5387 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005388 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005389 * \param secret Secret for the key derivation function.
5390 * \param slen Length of the secret.
5391 * \param label String label for the key derivation function,
5392 * terminated with null character.
5393 * \param random Random bytes.
5394 * \param rlen Length of the random bytes buffer.
5395 * \param dstbuf The buffer holding the derived key.
5396 * \param dlen Length of the output buffer.
5397 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005398 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005399 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005400int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
5401 const unsigned char *secret, size_t slen,
5402 const char *label,
5403 const unsigned char *random, size_t rlen,
5404 unsigned char *dstbuf, size_t dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +03005405
Paul Bakker5121ce52009-01-03 21:22:43 +00005406#ifdef __cplusplus
5407}
5408#endif
5409
5410#endif /* ssl.h */