blob: 2eb4f9cd5380fc69696578f7ba24f23070254816 [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010028#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000029#endif
XiaokangQiana7634982021-10-22 06:32:32 +000030
Andrzej Kurek1b75e5f2023-04-04 09:55:06 -040031#include "mbedtls/md.h"
32
Valerio Setti7aeec542023-07-05 18:57:21 +020033#if defined(MBEDTLS_KEY_EXCHANGE_SOME_ECDH_OR_ECDHE_ANY_ENABLED)
Jaeden Amero6609aef2019-07-04 20:01:14 +010034#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010035#endif
36
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010038#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020039#endif
40
Hanno Becker43633132018-10-22 15:31:03 +010041#include "psa/crypto.h"
Hanno Becker43633132018-10-22 15:31:03 +010042
Paul Bakker13e2dfe2009-07-28 07:18:38 +000043/*
44 * SSL Error codes
45 */
Gilles Peskined2971572021-07-26 18:48:10 +020046/** A cryptographic operation is in progress. Try again later. */
47#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
48/** The requested feature is not available. */
49#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
50/** Bad input parameters to function. */
51#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
52/** Verification of the message MAC failed. */
53#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
54/** An invalid SSL record was received. */
55#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
56/** The connection indicated an EOF. */
57#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
58/** A message could not be parsed due to a syntactic error. */
59#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300
Dave Rodgmanbb05cd02021-06-29 10:37:43 +010060/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020061/** No RNG was provided to the SSL module. */
62#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
63/** No client certification received from the client, but required by the authentication mode. */
64#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
65/** Client received an extended server hello containing an unsupported extension */
66#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500
67/** No ALPN protocols supported that the client advertises */
68#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580
69/** The own private key or pre-shared key is not set, but needed. */
70#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
71/** No CA Chain is set, but required to operate. */
72#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
73/** An unexpected message was received from our peer. */
74#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
75/** A fatal alert message was received from our peer. */
76#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
77/** No server could be identified matching the client's SNI. */
78#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800
79/** The peer notified us that the connection is going to be closed. */
80#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
Hanno Becker90d59dd2021-06-24 11:17:13 +010081/* Error space gap */
Hanno Beckerc3411d42021-06-24 11:09:00 +010082/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020083/** Processing of the Certificate handshake message failed. */
84#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00
Pengyu Lv18946532023-01-12 12:28:09 +080085/* Error space gap */
Ronald Cronda130722022-11-22 09:08:57 +010086/**
Ronald Cron0e5d4fd2024-08-27 14:29:55 +020087 * A TLS 1.3 NewSessionTicket message has been received.
88 * This error code can be returned only on client side if and only if handling
89 * of TLS 1.3 NewSessionTicket messages has been enabled through the
90 * mbedtls_ssl_conf_enable_new_session_tickets() API. This error
91 * code can then be returned by mbedtls_ssl_handshake(),
92 * mbedtls_ssl_handshake_step(), mbedtls_ssl_read(), mbedtls_ssl_write() and
Ronald Cron9df05632024-08-27 18:04:44 +020093 * mbedtls_ssl_write_early_data(). A TLS 1.3 NewSessionTicket message has been
94 * received and parsed successfully by the client. Ticket data is available
95 * in the SSL context and may be retrieved through the
96 * mbedtls_ssl_get_session() API.
Ronald Cronda130722022-11-22 09:08:57 +010097 */
Jerry Yuf8a49942022-07-07 11:32:32 +000098#define MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET -0x7B00
Ronald Cron4a8c9e22022-10-26 18:49:09 +020099/** Not possible to read early data */
100#define MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA -0x7B80
Jerry Yu032985c2023-12-06 17:59:33 +0800101/**
102 * Early data has been received as part of an on-going handshake.
Ronald Cron44d70a52024-01-30 18:16:47 +0100103 * This error code can be returned only on server side if and only if early
104 * data has been enabled by means of the mbedtls_ssl_conf_early_data() API.
105 * This error code can then be returned by mbedtls_ssl_handshake(),
106 * mbedtls_ssl_handshake_step(), mbedtls_ssl_read() or mbedtls_ssl_write() if
107 * early data has been received as part of the handshake sequence they
108 * triggered. To read the early data, call mbedtls_ssl_read_early_data().
Jerry Yu032985c2023-12-06 17:59:33 +0800109 */
110#define MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA -0x7C00
Ronald Cron4a8c9e22022-10-26 18:49:09 +0200111/** Not possible to write early data */
Jerry Yu032985c2023-12-06 17:59:33 +0800112#define MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA -0x7C80
Hanno Beckerb24e74b2021-06-24 09:52:01 +0100113/* Error space gap */
Hanno Beckerd3eec782021-06-24 10:21:46 +0100114/* Error space gap */
Hanno Beckerd934a2a2021-06-24 10:23:45 +0100115/* Error space gap */
Hanno Beckerd2002962021-06-24 10:25:40 +0100116/* Error space gap */
Pengyu Lv5038a382023-03-23 15:49:52 +0800117/** Cache entry not found */
Pengyu Lve3746d72023-04-10 14:40:03 +0800118#define MBEDTLS_ERR_SSL_CACHE_ENTRY_NOT_FOUND -0x7E80
Gilles Peskined2971572021-07-26 18:48:10 +0200119/** Memory allocation failed */
120#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
121/** Hardware acceleration function returned with error */
122#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
123/** Hardware acceleration function skipped / left alone data */
124#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
125/** Handshake protocol not within min/max boundaries */
126#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80
127/** The handshake negotiation failed. */
128#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00
129/** Session ticket has expired. */
130#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
131/** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
132#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
133/** Unknown identity received (eg, PSK identity) */
134#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
135/** Internal error (eg, unexpected failure in lower-level module) */
136#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
137/** A counter would wrap (eg, too many messages exchanged). */
138#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
139/** Unexpected message at ServerHello in renegotiation. */
140#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
141/** DTLS client must retry for hello verification */
142#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
143/** A buffer is too small to receive or write a message */
144#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
Dave Rodgman096c4112021-06-29 09:52:06 +0100145/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200146/** No data of requested type currently available on underlying transport. */
147#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
148/** Connection requires a write call. */
149#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
150/** The operation timed out. */
151#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
152/** The client initiated a reconnect from the same port. */
153#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
154/** Record header looks valid but is not expected. */
155#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
156/** The alert message received indicates a non-fatal error. */
157#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
158/** A field in a message was incorrect or inconsistent with other fields. */
159#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600
160/** Internal-only message signaling that further message-processing should be done */
161#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
162/** The asynchronous operation is not completed yet. */
163#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
164/** Internal-only message signaling that a message arrived early. */
165#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
Dave Rodgmanc628fc92021-06-29 14:32:46 +0100166/* Error space gap */
167/* Error space gap */
168/* Error space gap */
169/* Error space gap */
170/* Error space gap */
171/* Error space gap */
172/* Error space gap */
173/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200174/** An encrypted DTLS-frame with an unexpected CID was received. */
175#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
176/** An operation failed due to an unexpected version or configuration. */
177#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
178/** Invalid value in SSL config */
179#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
Paul Bakker5121ce52009-01-03 21:22:43 +0000180
181/*
Jerry Yue19e3b92022-07-08 12:04:51 +0000182 * Constants from RFC 8446 for TLS 1.3 PSK modes
183 *
184 * Those are used in the Pre-Shared Key Exchange Modes extension.
185 * See Section 4.2.9 in RFC 8446.
186 */
187#define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */
188#define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */
189
190/*
Jerry Yue226cef2021-08-27 22:06:20 +0800191 * TLS 1.3 NamedGroup values
192 *
193 * From RF 8446
194 * enum {
195 * // Elliptic Curve Groups (ECDHE)
196 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
197 * x25519(0x001D), x448(0x001E),
198 * // Finite Field Groups (DHE)
199 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
200 * ffdhe6144(0x0103), ffdhe8192(0x0104),
201 * // Reserved Code Points
202 * ffdhe_private_use(0x01FC..0x01FF),
203 * ecdhe_private_use(0xFE00..0xFEFF),
204 * (0xFFFF)
205 * } NamedGroup;
206 *
207 */
Brett Warrene0edc842021-08-17 09:53:13 +0100208
Jerry Yue226cef2021-08-27 22:06:20 +0800209/* Elliptic Curve Groups (ECDHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100210#define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0
211#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 0x0012
212#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 0x0013
213#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 0x0014
214#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 0x0015
215#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016
216#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017
217#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018
218#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019
219#define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A
220#define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B
221#define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C
222#define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D
223#define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E
Jerry Yue226cef2021-08-27 22:06:20 +0800224/* Finite Field Groups (DHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100225#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100
226#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101
227#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102
228#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103
229#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104
Jerry Yue226cef2021-08-27 22:06:20 +0800230
231/*
Hanno Becker71f1ed62021-07-24 06:01:47 +0100232 * TLS 1.3 Key Exchange Modes
233 *
234 * Mbed TLS internal identifiers for use with the SSL configuration API
235 * mbedtls_ssl_conf_tls13_key_exchange_modes().
236 */
237
Gilles Peskine449bd832023-01-11 14:50:10 +0100238#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 +0000239 * encompassing both externally agreed PSKs
240 * as well as resumption PSKs. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100241#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 +0000242 * including for example ECDHE and DHE
243 * key exchanges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100244#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 +0000245 * using both a PSK and an ephemeral
246 * key exchange. */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100247
248/* Convenience macros for sets of key exchanges. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000249#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
251 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
252 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL) /*!< All TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000253#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
255 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All PSK-based TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000256#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \
258 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All ephemeral TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100259
Gilles Peskine449bd832023-01-11 14:50:10 +0100260#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE (0)
Jerry Yu77f01482022-07-11 07:03:24 +0000261
Hanno Becker71f1ed62021-07-24 06:01:47 +0100262/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000263 * Various constants
264 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100265
Glenn Straussd09b3432022-04-11 13:58:11 -0400266#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jan Bruckner25fdc2a2022-07-26 10:45:07 +0200267/* These are the high and low bytes of ProtocolVersion as defined by:
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100268 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
269 * - RFC 8446: see section 4.2.1
270 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200271#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200272#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100273#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 */
Glenn Straussd09b3432022-04-11 13:58:11 -0400274#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker5121ce52009-01-03 21:22:43 +0000275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
277#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100278
Simon Butcher9f812312015-09-28 19:22:33 +0100279#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200280#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
281
282#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 +0100283
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200284/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200285 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
287#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
288#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
289#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
290#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
291#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200292
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200293#define MBEDTLS_SSL_IS_CLIENT 0
294#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
297#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200298
Hanno Becker019f4b52019-04-09 15:12:56 +0100299#define MBEDTLS_SSL_CID_DISABLED 0
300#define MBEDTLS_SSL_CID_ENABLED 1
301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#define MBEDTLS_SSL_ETM_DISABLED 0
303#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307#define MBEDTLS_SSL_VERIFY_NONE 0
308#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
309#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200310#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
313#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
316#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000317
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200318#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
319#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
322#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
325#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
326#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000327
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200328#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
329#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
330#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
333#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200334
Ronald Crond67f8012024-08-28 07:45:57 +0200335#define MBEDTLS_SSL_NEW_SESSION_TICKETS_DISABLED 0
336#define MBEDTLS_SSL_NEW_SESSION_TICKETS_ENABLED 1
Ronald Cronbedddd72024-08-27 14:18:50 +0200337
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200338#define MBEDTLS_SSL_PRESET_DEFAULT 0
339#define MBEDTLS_SSL_PRESET_SUITEB 2
340
Janos Follath088ce432017-04-10 12:42:31 +0100341#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
342#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
343
Xiaokang Qian54413b12022-10-20 05:57:03 +0000344#define MBEDTLS_SSL_EARLY_DATA_DISABLED 0
345#define MBEDTLS_SSL_EARLY_DATA_ENABLED 1
346
Ron Eldor591f1622018-01-22 12:30:04 +0200347#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
348#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
349
TRodziewicz3946f792021-06-14 12:11:18 +0200350#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
351#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200352
Jerry Yu0a430c82022-07-20 11:02:48 +0800353#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200354#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu0a430c82022-07-20 11:02:48 +0800355#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200356#elif defined(PSA_WANT_ALG_SHA_256)
Jerry Yu0a430c82022-07-20 11:02:48 +0800357#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32
Przemek Stekiela9a88162022-09-02 13:18:55 +0200358#endif
Jerry Yu0a430c82022-07-20 11:02:48 +0800359#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200360/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200361 * Default range for DTLS retransmission timer value, in milliseconds.
362 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
363 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
365#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200366
Jerry Yu4caf3ca2023-11-15 16:13:47 +0800367/*
368 * Whether early data record should be discarded or not and how.
369 *
370 * The client has indicated early data and the server has rejected them.
371 * The server has then to skip past early data by either:
372 * - attempting to deprotect received records using the handshake traffic
373 * key, discarding records which fail deprotection (up to the configured
374 * max_early_data_size). Once a record is deprotected successfully,
375 * it is treated as the start of the client's second flight and the
376 * server proceeds as with an ordinary 1-RTT handshake.
377 * - skipping all records with an external content type of
378 * "application_data" (indicating that they are encrypted), up to the
379 * configured max_early_data_size. This is the expected behavior if the
380 * server has sent an HelloRetryRequest message. The server ignores
381 * application data message before 2nd ClientHello.
382 */
383#define MBEDTLS_SSL_EARLY_DATA_NO_DISCARD 0
384#define MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD 1
385#define MBEDTLS_SSL_EARLY_DATA_DISCARD 2
386
Paul Bakker088c5c52014-04-25 11:11:10 +0200387/**
388 * \name SECTION: Module settings
389 *
390 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200391 * Either change them in mbedtls_config.h or define them on the compiler command line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200392 * \{
393 */
394
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200395/*
Angus Grattond8213d02016-05-25 20:56:48 +1000396 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200397 * determines the size of each of the two internal I/O buffers.
398 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200399 * Note: the RFC defines the default size of SSL / TLS messages. If you
400 * change the value here, other clients / servers may not be able to
401 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200402 * both sides of the connection and have it reduced at both sides, or
403 * if you're using the Max Fragment Length extension and you know all your
404 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200405 */
Angus Grattond8213d02016-05-25 20:56:48 +1000406#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100407#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000408#endif
409
410#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100411#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000412#endif
413
Hanno Becker28007512018-08-28 09:46:44 +0100414/*
415 * Maximum number of heap-allocated bytes for the purpose of
416 * DTLS handshake message reassembly and future message buffering.
417 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100418#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100419#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100420#endif
421
Hanno Becker019f4b52019-04-09 15:12:56 +0100422/*
423 * Maximum length of CIDs for incoming and outgoing messages.
424 */
425#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100426#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100427#endif
428
429#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
430#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
431#endif
432
TRodziewicze8dd7092021-05-12 14:19:11 +0200433#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
434#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100435#endif
436
Tom Cosgrove3b4471e2023-09-14 12:59:50 +0100437#if !defined(MBEDTLS_SSL_MAX_EARLY_DATA_SIZE)
438#define MBEDTLS_SSL_MAX_EARLY_DATA_SIZE 1024
439#endif
440
Gilles Peskined65ea422023-09-05 21:07:32 +0200441#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE)
442#define MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE 6000
443#endif
444
445#if !defined(MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH)
446#define MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH 32
447#endif
448
449#if !defined(MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS)
450#define MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS 1
451#endif
452
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100453/** \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000454
455/*
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200456 * Default to standard CID mode
457 */
458#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
459 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT)
460#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
461#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000462
463/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100464 * Length of the verify data for secure renegotiation
465 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200466#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100467
468/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200469 * Signaling ciphersuite values (SCSV)
470 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200471#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000472
Paul Bakker5121ce52009-01-03 21:22:43 +0000473/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000474 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200475 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000476 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200477#define MBEDTLS_SSL_HASH_NONE 0
478#define MBEDTLS_SSL_HASH_MD5 1
479#define MBEDTLS_SSL_HASH_SHA1 2
480#define MBEDTLS_SSL_HASH_SHA224 3
481#define MBEDTLS_SSL_HASH_SHA256 4
482#define MBEDTLS_SSL_HASH_SHA384 5
483#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000484
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200485#define MBEDTLS_SSL_SIG_ANON 0
486#define MBEDTLS_SSL_SIG_RSA 1
487#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000488
489/*
Hanno Becker551265f2021-08-10 13:03:48 +0100490 * TLS 1.3 signature algorithms
Yanray Wang55933a32023-11-22 16:34:15 +0800491 * RFC 8446, Section 4.2.3
Hanno Becker551265f2021-08-10 13:03:48 +0100492 */
493
494/* RSASSA-PKCS1-v1_5 algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000495#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401
496#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501
497#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601
Hanno Becker551265f2021-08-10 13:03:48 +0100498
499/* ECDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000500#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403
501#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503
502#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603
Hanno Becker551265f2021-08-10 13:03:48 +0100503
504/* RSASSA-PSS algorithms with public key OID rsaEncryption */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000505#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804
506#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805
507#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806
Hanno Becker551265f2021-08-10 13:03:48 +0100508
509/* EdDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000510#define MBEDTLS_TLS1_3_SIG_ED25519 0x0807
511#define MBEDTLS_TLS1_3_SIG_ED448 0x0808
Hanno Becker551265f2021-08-10 13:03:48 +0100512
513/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000514#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809
515#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A
516#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B
Hanno Becker551265f2021-08-10 13:03:48 +0100517
518/* LEGACY ALGORITHMS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000519#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201
520#define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203
Hanno Becker551265f2021-08-10 13:03:48 +0100521
Xiaofei Bai746f9482021-11-12 08:53:56 +0000522#define MBEDTLS_TLS1_3_SIG_NONE 0x0
Hanno Becker551265f2021-08-10 13:03:48 +0100523
524/*
Paul Bakker926af752012-11-23 13:38:07 +0100525 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200526 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100527 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200528#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
529#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100530
531/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000532 * Message, alert and handshake types
533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200534#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
535#define MBEDTLS_SSL_MSG_ALERT 21
536#define MBEDTLS_SSL_MSG_HANDSHAKE 22
537#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100538#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000539
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
541#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
544#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
545#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
546#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
547#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
548#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
549#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
550#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
551#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
552#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
553#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
554#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
555#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
556#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
557#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
558#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
559#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
560#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
561#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
562#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
563#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
564#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
565#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
566#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
567#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000568#define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
570#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
571#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
XiaokangQian6b916b12022-04-25 07:29:34 +0000572#define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200573#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
576#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
577#define MBEDTLS_SSL_HS_SERVER_HELLO 2
578#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
579#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
Xiaokang Qian5b410072023-01-03 10:31:15 +0000580#define MBEDTLS_SSL_HS_END_OF_EARLY_DATA 5
581#define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582#define MBEDTLS_SSL_HS_CERTIFICATE 11
583#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
584#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
585#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
586#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
587#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
588#define MBEDTLS_SSL_HS_FINISHED 20
XiaokangQian647719a2021-12-07 09:16:29 +0000589#define MBEDTLS_SSL_HS_MESSAGE_HASH 254
Paul Bakker5121ce52009-01-03 21:22:43 +0000590
591/*
592 * TLS extensions
593 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#define MBEDTLS_TLS_EXT_SERVERNAME 0
595#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000596
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200598
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800600#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200601
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800603#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 +0200604#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000605
Jerry Yub3317e12021-08-26 14:30:22 +0800606#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
Johan Pascalb62bb512015-12-03 21:56:45 +0100607#define MBEDTLS_TLS_EXT_USE_SRTP 14
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800608#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200610
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800611#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
Jerry Yu1bc2c1f2021-09-01 12:57:29 +0800612#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
613#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
614#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200615#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
616#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200617
Jan Bruckner151f6422023-02-10 12:45:19 +0100618#define MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT 28 /* RFC 8449 (implemented for TLS 1.3 only) */
619
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200620#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200621
Jerry Yub3317e12021-08-26 14:30:22 +0800622#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
623#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
624#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
625#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
626#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800627
Jerry Yub3317e12021-08-26 14:30:22 +0800628#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
629#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
630#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
631#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
632#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800633
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200634#if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
635#define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */
636#else
637#define MBEDTLS_TLS_EXT_CID 254 /* Pre-RFC 9146 DTLS 1.2 CID */
Gilles Peskine7dd2f502021-04-24 13:35:41 +0200638#endif
Hanno Becker0652bc52019-04-25 16:24:57 +0100639
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200640#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
641
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200642#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000643
Johan Pascalb62bb512015-12-03 21:56:45 +0100644/*
Paul Bakkered27a042013-04-18 22:46:23 +0200645 * Size defines
646 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647#if !defined(MBEDTLS_PSK_MAX_LEN)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100648/*
649 * If the library supports TLS 1.3 tickets and the cipher suite
650 * TLS1-3-AES-256-GCM-SHA384, set the PSK maximum length to 48 instead of 32.
651 * That way, the TLS 1.3 client and server are able to resume sessions where
Ronald Cronee54de02023-02-24 12:06:30 +0100652 * the cipher suite is TLS1-3-AES-256-GCM-SHA384 (pre-shared keys are 48
653 * bytes long in that case).
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100654 */
655#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
656 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
Valerio Setti01c4fa32023-11-09 10:46:36 +0100657 defined(MBEDTLS_SSL_HAVE_AES) && defined(MBEDTLS_SSL_HAVE_GCM) && \
Paul Elliott69034382023-03-27 21:24:45 +0100658 defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100659#define MBEDTLS_PSK_MAX_LEN 48 /* 384 bits */
660#else
661#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200662#endif
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100663#endif /* !MBEDTLS_PSK_MAX_LEN */
Paul Bakkered27a042013-04-18 22:46:23 +0200664
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200665/* Dummy type used only for its size */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666union mbedtls_ssl_premaster_secret {
Gilles Peskinee8e1e152023-06-25 21:41:58 +0200667 unsigned char dummy; /* Make the union non-empty even with SSL disabled */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200669 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
670#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200671#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
672 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200673#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200674#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
675 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
676 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
677 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
678 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200679#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200680#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
681 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200682#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200683#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
684 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200686#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200687#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
688 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200689#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200690#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
691 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200693#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200694#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
695 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
696#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200697};
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699#define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200700
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200701#define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200702
XiaokangQianc5c39d52021-11-09 11:55:10 +0000703
Jerry Yud96a5c22021-09-29 17:46:51 +0800704/* Length in number of bytes of the TLS sequence number */
Jerry Yuae0b2e22021-10-08 15:21:19 +0800705#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8
Jerry Yu957f0fa2021-09-24 10:27:07 +0800706
Paul Bakker407a0da2013-06-27 14:29:21 +0200707#ifdef __cplusplus
708extern "C" {
709#endif
710
Paul Bakkered27a042013-04-18 22:46:23 +0200711/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000712 * SSL state machine
713 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100714typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200715 MBEDTLS_SSL_HELLO_REQUEST,
716 MBEDTLS_SSL_CLIENT_HELLO,
717 MBEDTLS_SSL_SERVER_HELLO,
718 MBEDTLS_SSL_SERVER_CERTIFICATE,
719 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
720 MBEDTLS_SSL_CERTIFICATE_REQUEST,
721 MBEDTLS_SSL_SERVER_HELLO_DONE,
722 MBEDTLS_SSL_CLIENT_CERTIFICATE,
723 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
724 MBEDTLS_SSL_CERTIFICATE_VERIFY,
725 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
726 MBEDTLS_SSL_CLIENT_FINISHED,
727 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
728 MBEDTLS_SSL_SERVER_FINISHED,
729 MBEDTLS_SSL_FLUSH_BUFFERS,
730 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
Jerry Yua357cf42022-07-12 05:36:45 +0000731 MBEDTLS_SSL_NEW_SESSION_TICKET,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200732 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000733 MBEDTLS_SSL_HELLO_RETRY_REQUEST,
Jerry Yua13c7e72021-08-17 10:44:40 +0800734 MBEDTLS_SSL_ENCRYPTED_EXTENSIONS,
Xiaokang Qian125afcb2022-10-28 06:04:06 +0000735 MBEDTLS_SSL_END_OF_EARLY_DATA,
Jerry Yu687101b2021-09-14 16:03:56 +0800736 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY,
Ronald Cron49ad6192021-11-24 16:25:31 +0100737 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED,
XiaokangQian647719a2021-12-07 09:16:29 +0000738 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO,
Gabor Mezei7b39bf12022-05-24 16:04:14 +0200739 MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO,
Xiaokang Qian592021a2023-01-04 10:47:05 +0000740 MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO,
Gabor Mezeif7044ea2022-06-28 16:01:49 +0200741 MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST,
Jerry Yu5ed73ff2022-10-27 13:08:42 +0800742 MBEDTLS_SSL_HANDSHAKE_OVER,
Jerry Yua8d3c502022-10-30 14:51:23 +0800743 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET,
744 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH,
Paul Bakker5121ce52009-01-03 21:22:43 +0000745}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000747
Ronald Crond6d32b92024-02-14 12:01:50 +0100748/*
749 * Early data status, client side only.
750 */
751
752#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
753typedef enum {
754/*
Ronald Crond6d32b92024-02-14 12:01:50 +0100755 * See documentation of mbedtls_ssl_get_early_data_status().
756 */
Ronald Cron840de7f2024-03-11 17:49:35 +0100757 MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_INDICATED,
Ronald Crond6d32b92024-02-14 12:01:50 +0100758 MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED,
759 MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED,
Ronald Crond6d32b92024-02-14 12:01:50 +0100760} mbedtls_ssl_early_data_status;
Ronald Crond6d32b92024-02-14 12:01:50 +0100761#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
762
Simon Butchere846b512016-03-01 17:31:49 +0000763/**
764 * \brief Callback type: send data on the network.
765 *
766 * \note That callback may be either blocking or non-blocking.
767 *
768 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000769 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000770 * \param len Length of the data to send
771 *
772 * \return The callback must return the number of bytes sent if any,
773 * or a non-zero error code.
774 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
775 * must be returned when the operation would block.
776 *
Simon Butcherd567a232016-03-09 20:19:21 +0000777 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000778 * It must always return the number of bytes actually sent.
779 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100780typedef int mbedtls_ssl_send_t(void *ctx,
781 const unsigned char *buf,
782 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000783
784/**
785 * \brief Callback type: receive data from the network.
786 *
787 * \note That callback may be either blocking or non-blocking.
788 *
789 * \param ctx Context for the receive callback (typically a file
790 * descriptor)
791 * \param buf Buffer to write the received data to
792 * \param len Length of the receive buffer
793 *
Hanno Becker218dec82021-07-23 07:23:47 +0100794 * \returns If data has been received, the positive number of bytes received.
795 * \returns \c 0 if the connection has been closed.
796 * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
Simon Butchere846b512016-03-01 17:31:49 +0000797 * must be returned when the operation would block.
Hanno Becker218dec82021-07-23 07:23:47 +0100798 * \returns Another negative error code on other kinds of failures.
Simon Butchere846b512016-03-01 17:31:49 +0000799 *
Simon Butcherd567a232016-03-09 20:19:21 +0000800 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000801 * buffer. It must always return the number of bytes actually
802 * received and written to the buffer.
803 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100804typedef int mbedtls_ssl_recv_t(void *ctx,
805 unsigned char *buf,
806 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000807
808/**
809 * \brief Callback type: receive data from the network, with timeout
810 *
811 * \note That callback must block until data is received, or the
812 * timeout delay expires, or the operation is interrupted by a
813 * signal.
814 *
815 * \param ctx Context for the receive callback (typically a file descriptor)
816 * \param buf Buffer to write the received data to
817 * \param len Length of the receive buffer
Andrey Starodubtsev90cc33a2021-08-23 12:14:56 +0300818 * \param timeout Maximum number of milliseconds to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000819 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000820 *
821 * \return The callback must return the number of bytes received,
822 * or a non-zero error code:
823 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
824 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
825 *
Simon Butcherd567a232016-03-09 20:19:21 +0000826 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000827 * buffer. It must always return the number of bytes actually
828 * received and written to the buffer.
829 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100830typedef int mbedtls_ssl_recv_timeout_t(void *ctx,
831 unsigned char *buf,
832 size_t len,
833 uint32_t timeout);
Simon Butchere846b512016-03-01 17:31:49 +0000834/**
835 * \brief Callback type: set a pair of timers/delays to watch
836 *
837 * \param ctx Context pointer
838 * \param int_ms Intermediate delay in milliseconds
839 * \param fin_ms Final delay in milliseconds
840 * 0 cancels the current timer.
841 *
842 * \note This callback must at least store the necessary information
843 * for the associated \c mbedtls_ssl_get_timer_t callback to
844 * return correct information.
845 *
Tom Cosgrovece7f18c2022-07-28 05:50:56 +0100846 * \note If using an event-driven style of programming, an event must
Simon Butchere846b512016-03-01 17:31:49 +0000847 * be generated when the final delay is passed. The event must
848 * cause a call to \c mbedtls_ssl_handshake() with the proper
849 * SSL context to be scheduled. Care must be taken to ensure
850 * that at most one such call happens at a time.
851 *
852 * \note Only one timer at a time must be running. Calling this
853 * function while a timer is running must cancel it. Cancelled
854 * timers must not generate any event.
855 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100856typedef void mbedtls_ssl_set_timer_t(void *ctx,
857 uint32_t int_ms,
858 uint32_t fin_ms);
Simon Butchere846b512016-03-01 17:31:49 +0000859
860/**
861 * \brief Callback type: get status of timers/delays
862 *
863 * \param ctx Context pointer
864 *
865 * \return This callback must return:
866 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000867 * 0 if none of the delays have passed,
868 * 1 if only the intermediate delay has passed,
869 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000870 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100871typedef int mbedtls_ssl_get_timer_t(void *ctx);
Simon Butchere846b512016-03-01 17:31:49 +0000872
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200873/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874typedef struct mbedtls_ssl_session mbedtls_ssl_session;
875typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200876typedef struct mbedtls_ssl_config mbedtls_ssl_config;
877
Chris Jones3848e312021-03-11 16:17:59 +0000878/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
880typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100881typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200882#if defined(MBEDTLS_X509_CRT_PARSE_C)
883typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200884#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885#if defined(MBEDTLS_SSL_PROTO_DTLS)
886typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200887#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000888
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000889#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000890#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000892#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100893 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */
894#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA (1U << 3)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000895
896#define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 (MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \
898 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \
899 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000900#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000901
Hanno Becker02487852021-05-13 06:26:57 +0100902/**
903 * \brief Callback type: server-side session cache getter
904 *
905 * The session cache is logically a key value store, with
906 * keys being session IDs and values being instances of
907 * mbedtls_ssl_session.
908 *
909 * This callback retrieves an entry in this key-value store.
910 *
911 * \param data The address of the session cache structure to query.
912 * \param session_id The buffer holding the session ID to query.
913 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100914 * \param session The address of the session structure to populate.
915 * It is initialized with mbdtls_ssl_session_init(),
916 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100917 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100918 * mbedtls_ssl_session_free() independent of the
919 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100920 *
921 * \return \c 0 on success
922 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100923 *
Hanno Becker02487852021-05-13 06:26:57 +0100924 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100925typedef int mbedtls_ssl_cache_get_t(void *data,
926 unsigned char const *session_id,
927 size_t session_id_len,
928 mbedtls_ssl_session *session);
Hanno Becker02487852021-05-13 06:26:57 +0100929/**
930 * \brief Callback type: server-side session cache setter
931 *
932 * The session cache is logically a key value store, with
933 * keys being session IDs and values being instances of
934 * mbedtls_ssl_session.
935 *
936 * This callback sets an entry in this key-value store.
937 *
938 * \param data The address of the session cache structure to modify.
939 * \param session_id The buffer holding the session ID to query.
940 * \param session_id_len The length of \p session_id in Bytes.
941 * \param session The address of the session to be stored in the
942 * session cache.
943 *
944 * \return \c 0 on success
945 * \return A non-zero return value on failure.
946 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100947typedef int mbedtls_ssl_cache_set_t(void *data,
948 unsigned char const *session_id,
949 size_t session_id_len,
950 const mbedtls_ssl_session *session);
Hanno Beckera637ff62021-04-15 08:42:48 +0100951
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200952#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100953#if defined(MBEDTLS_X509_CRT_PARSE_C)
954/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200955 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100956 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200957 * This callback is called during an SSL handshake to start
958 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200959 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100960 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200961 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100962 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200963 * This function typically sends or enqueues a request, and
964 * does not wait for the operation to complete. This allows
965 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100966 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200967 * The parameters \p ssl and \p cert are guaranteed to remain
968 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200969 * function must save the contents of \p hash if the value
970 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200971 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100972 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200973 * This function may call mbedtls_ssl_set_async_operation_data()
974 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200975 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200976 *
Gilles Peskined3268832018-04-26 06:23:59 +0200977 * \note For RSA signatures, this function must produce output
978 * that is consistent with PKCS#1 v1.5 in the same way as
979 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
980 * apply the padding steps described in RFC 8017, section 9.2
981 * "EMSA-PKCS1-v1_5" as follows.
982 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
983 * encoding, treating \p hash as the DigestInfo to be
984 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
985 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200986 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200987 * encoding, treating \p hash as the hash to be encoded and
988 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
989 * from step 2, with `digestAlgorithm` obtained by calling
990 * mbedtls_oid_get_oid_by_md() on \p md_alg.
991 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200992 * \note For ECDSA signatures, the output format is the DER encoding
993 * `Ecdsa-Sig-Value` defined in
994 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
995 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200996 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200997 * modified other than via
998 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200999 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +02001000 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +02001001 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +02001002 * connection. However, if other callbacks are used, this
1003 * property may not hold. For example, if an SNI callback
1004 * is registered with mbedtls_ssl_conf_sni(), then
1005 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +02001006 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001007 * \param hash Buffer containing the hash. This buffer is
1008 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +02001009 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001010 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001011 * \return 0 if the operation was started successfully and the SSL
1012 * stack should call the resume callback immediately.
1013 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1014 * was started successfully and the SSL stack should return
1015 * immediately without calling the resume callback yet.
1016 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
1017 * processor does not support this key. The SSL stack will
1018 * use the private key object instead.
1019 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001020 * propagated up the call chain. The callback should
1021 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1022 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001023 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001025typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl,
1026 mbedtls_x509_crt *cert,
1027 mbedtls_md_type_t md_alg,
1028 const unsigned char *hash,
1029 size_t hash_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001030
1031/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001032 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001033 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001034 * This callback is called during an SSL handshake to start
1035 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +02001036 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001037 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +02001038 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001039 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001040 * This function typically sends or enqueues a request, and
1041 * does not wait for the operation to complete. This allows
1042 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001043 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +02001044 * The parameters \p ssl and \p cert are guaranteed to remain
1045 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +02001046 * function must save the contents of \p input if the value
1047 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +02001048 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001049 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001050 * This function may call mbedtls_ssl_set_async_operation_data()
1051 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +02001052 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001053 *
Gilles Peskine20deb012018-04-26 17:57:37 +02001054 * \warning RSA decryption as used in TLS is subject to a potential
1055 * timing side channel attack first discovered by Bleichenbacher
1056 * in 1998. This attack can be remotely exploitable
1057 * in practice. To avoid this attack, you must ensure that
1058 * if the callback performs an RSA decryption, the time it
1059 * takes to execute and return the result does not depend
1060 * on whether the RSA decryption succeeded or reported
1061 * invalid padding.
1062 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001063 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +02001064 * modified other than via
1065 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +02001066 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +02001067 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +02001068 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +02001069 * connection. However, if other callbacks are used, this
1070 * property may not hold. For example, if an SNI callback
1071 * is registered with mbedtls_ssl_conf_sni(), then
1072 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001073 * \param input Buffer containing the input ciphertext. This buffer
1074 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +02001075 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001076 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001077 * \return 0 if the operation was started successfully and the SSL
1078 * stack should call the resume callback immediately.
1079 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1080 * was started successfully and the SSL stack should return
1081 * immediately without calling the resume callback yet.
1082 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
1083 * processor does not support this key. The SSL stack will
1084 * use the private key object instead.
1085 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001086 * propagated up the call chain. The callback should
1087 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1088 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001089 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001090 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001091typedef int mbedtls_ssl_async_decrypt_t(mbedtls_ssl_context *ssl,
1092 mbedtls_x509_crt *cert,
1093 const unsigned char *input,
1094 size_t input_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001095#endif /* MBEDTLS_X509_CRT_PARSE_C */
1096
1097/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001098 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001099 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001100 * This callback is called during an SSL handshake to resume
1101 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +02001102 * ::mbedtls_ssl_async_sign_t or
1103 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +02001104 *
1105 * This function typically checks the status of a pending
1106 * request or causes the request queue to make progress, and
1107 * does not wait for the operation to complete. This allows
1108 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001109 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001110 * This function may call mbedtls_ssl_get_async_operation_data()
1111 * to retrieve an operation context set by the start callback.
1112 * It may call mbedtls_ssl_set_async_operation_data() to modify
1113 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001114 *
Gilles Peskineea5fab82018-04-30 13:57:45 +02001115 * Note that when this function returns a status other than
1116 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
1117 * resources associated with the operation.
1118 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001119 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +02001120 * modified other than via
1121 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +02001122 * \param output Buffer containing the output (signature or decrypted
1123 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +02001124 * \param output_len On success, number of bytes written to \p output.
1125 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001126 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001127 * \return 0 if output of the operation is available in the
1128 * \p output buffer.
1129 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1130 * is still in progress. Subsequent requests for progress
1131 * on the SSL connection will call the resume callback
1132 * again.
1133 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001134 * The SSL handshake is aborted. The callback should
1135 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1136 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001137 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001138 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001139typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl,
1140 unsigned char *output,
1141 size_t *output_len,
1142 size_t output_size);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001143
1144/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001145 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001146 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001147 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +02001148 * while an asynchronous operation is in progress. Note that
1149 * this callback is not called if the
1150 * ::mbedtls_ssl_async_resume_t callback has run and has
1151 * returned a value other than
1152 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
1153 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001154 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001155 * This function may call mbedtls_ssl_get_async_operation_data()
1156 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001157 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001158 * \param ssl The SSL connection instance. It should not be
1159 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001161typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001162#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +00001163
Gilles Peskineeccd8882020-03-10 12:19:08 +01001164#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001165 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +00001166#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
Manuel Pégourié-Gonnard93302422023-03-21 17:23:08 +01001167#if defined(MBEDTLS_MD_CAN_SHA256)
Hanno Becker9198ad12019-02-05 17:00:50 +00001168#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1169#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Manuel Pégourié-Gonnard93302422023-03-21 17:23:08 +01001170#elif defined(MBEDTLS_MD_CAN_SHA384)
Hanno Becker9198ad12019-02-05 17:00:50 +00001171#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1172#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
Manuel Pégourié-Gonnard93302422023-03-21 17:23:08 +01001173#elif defined(MBEDTLS_MD_CAN_SHA1)
Hanno Becker9198ad12019-02-05 17:00:50 +00001174#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1175#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1176#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001177/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +00001178#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1179#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +01001180#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001181 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001182
Gilles Peskine449bd832023-01-11 14:50:10 +01001183typedef struct {
1184 unsigned char client_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1185 unsigned char server_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1186 unsigned char exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1187 unsigned char resumption_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Bai746f9482021-11-12 08:53:56 +00001188} mbedtls_ssl_tls13_application_secrets;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001189
Johan Pascalb62bb512015-12-03 21:56:45 +01001190#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001191
Johan Pascal85269572020-08-25 10:01:54 +02001192#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +02001193#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +01001194/*
Johan Pascal43f94902020-09-22 12:25:52 +02001195 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001196 *
1197 * Use_srtp extension protection profiles values as defined in
1198 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1199 *
1200 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1201 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +01001202 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001203#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001)
1204#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002)
1205#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005)
1206#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001207/* This one is not iana defined, but for code readability. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001208#define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001209
Johan Pascal43f94902020-09-22 12:25:52 +02001210typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +03001211
Gilles Peskine449bd832023-01-11 14:50:10 +01001212typedef struct mbedtls_dtls_srtp_info_t {
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001213 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001214 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +02001215 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001216 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001217 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001218 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +03001219}
1220mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +02001221
Johan Pascalb62bb512015-12-03 21:56:45 +01001222#endif /* MBEDTLS_SSL_DTLS_SRTP */
1223
Glenn Straussdff84622022-03-14 11:12:57 -04001224/** Human-friendly representation of the (D)TLS protocol version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001225typedef enum {
Glenn Straussdff84622022-03-14 11:12:57 -04001226 MBEDTLS_SSL_VERSION_UNKNOWN, /*!< Context not in use or version not yet negotiated. */
1227 MBEDTLS_SSL_VERSION_TLS1_2 = 0x0303, /*!< (D)TLS 1.2 */
1228 MBEDTLS_SSL_VERSION_TLS1_3 = 0x0304, /*!< (D)TLS 1.3 */
1229} mbedtls_ssl_protocol_version;
1230
Paul Bakker5121ce52009-01-03 21:22:43 +00001231/*
Paul Bakker0a597072012-09-25 21:55:46 +00001232 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001233 *
1234 * Note: when changing this definition, we need to check and update:
1235 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02001236 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001237 * - in library/ssl_tls.c:
1238 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1239 * mbedtls_ssl_session_save() and ssl_session_load()
1240 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +00001241 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001242struct mbedtls_ssl_session {
Gilles Peskine8834d872021-11-29 12:36:50 +01001243#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1244 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
1245#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1246
Waleed Elmelegy049cd302023-12-20 17:28:31 +00001247/*!< RecordSizeLimit received from the peer */
Jan Brucknerf482dcc2023-03-15 09:09:06 +01001248#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1249 uint16_t MBEDTLS_PRIVATE(record_size_limit);
1250#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1251
Gilles Peskine8834d872021-11-29 12:36:50 +01001252 unsigned char MBEDTLS_PRIVATE(exported);
Ronald Cron7fdee8b2024-02-09 09:26:12 +01001253 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskine8834d872021-11-29 12:36:50 +01001254
Ronald Cron217d6992022-04-04 10:23:22 +02001255 /** TLS version negotiated in the session. Used if and when renegotiating
1256 * or resuming a session instead of the configured minor TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001257 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001258 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Gilles Peskine8834d872021-11-29 12:36:50 +01001259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001260#if defined(MBEDTLS_HAVE_TIME)
Jerry Yu702fc592023-10-31 14:22:04 +08001261 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< start time of current session */
Paul Bakkerfa9b1002013-07-03 15:31:03 +02001262#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001263 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001264 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
1265 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
1266 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +02001267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +00001269#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001270 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +00001271#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001272 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
1273 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +02001274 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1275 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1276 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +00001277#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001279 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +02001280
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001281#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001282 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
1283 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
1284 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001285#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001286
Ronald Crond1c106c2023-11-22 09:14:02 +01001287#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C) && \
1288 defined(MBEDTLS_HAVE_TIME)
Ronald Cron3c0072b2023-11-22 10:00:14 +01001289 /*! When a ticket is created by a TLS server as part of an established TLS
1290 * session, the ticket creation time may need to be saved for the ticket
1291 * module to be able to check the ticket age when the ticket is used.
1292 * That's the purpose of this field.
1293 * Before creating a new ticket, an Mbed TLS server set this field with
1294 * its current time in milliseconds. This time may then be saved in the
1295 * session ticket data by the session ticket writing function and
1296 * recovered by the ticket parsing function later when the ticket is used.
1297 * The ticket module may then use this time to compute the ticket age and
1298 * determine if it has expired or not.
1299 * The Mbed TLS implementations of the session ticket writing and parsing
1300 * functions save and retrieve the ticket creation time as part of the
1301 * session ticket data. The session ticket parsing function relies on
1302 * the mbedtls_ssl_session_get_ticket_creation_time() API to get the
1303 * ticket creation time from the session ticket data.
1304 */
Ronald Crond1c106c2023-11-22 09:14:02 +01001305 mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_creation_time);
1306#endif
1307
Jerry Yua270f672022-07-07 06:51:06 +00001308#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Ronald Cron7fdee8b2024-02-09 09:26:12 +01001309 uint32_t MBEDTLS_PRIVATE(ticket_age_add); /*!< Randomly generated value used to obscure the age of the ticket */
1310 uint8_t MBEDTLS_PRIVATE(ticket_flags); /*!< Ticket flags */
1311 uint8_t MBEDTLS_PRIVATE(resumption_key_len); /*!< resumption_key length */
Jerry Yu0a430c82022-07-20 11:02:48 +08001312 unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN];
Jerry Yua270f672022-07-07 06:51:06 +00001313
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00001314#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C)
1315 char *MBEDTLS_PRIVATE(hostname); /*!< host name binded with tickets */
1316#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */
1317
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00001318#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_ALPN) && defined(MBEDTLS_SSL_SRV_C)
Waleed Elmelegy5bc52632024-03-12 16:25:08 +00001319 char *ticket_alpn; /*!< ALPN negotiated in the session
1320 during which the ticket was generated. */
Waleed Elmelegy883f77c2024-03-06 19:09:41 +00001321#endif
1322
Ronald Crond1c106c2023-11-22 09:14:02 +01001323#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_CLI_C)
1324 /*! Time in milliseconds when the last ticket was received. */
1325 mbedtls_ms_time_t MBEDTLS_PRIVATE(ticket_reception_time);
Jerry Yu25ba4d42023-11-10 14:12:20 +08001326#endif
Jerry Yua270f672022-07-07 06:51:06 +00001327#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
1328
Jerry Yu02e3a072022-12-12 15:13:20 +08001329#if defined(MBEDTLS_SSL_EARLY_DATA)
Jerry Yu6c485da2023-11-15 10:18:47 +08001330 uint32_t MBEDTLS_PRIVATE(max_early_data_size); /*!< maximum amount of early data in tickets */
Jerry Yu02e3a072022-12-12 15:13:20 +08001331#endif
1332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001333#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001334 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001335#endif
XiaokangQian33062842021-11-11 03:37:45 +00001336
Ronald Cron6f135e12021-12-08 16:57:54 +01001337#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001338 mbedtls_ssl_tls13_application_secrets MBEDTLS_PRIVATE(app_secrets);
Xiaokang Qianbaa47642022-10-12 10:21:27 +00001339#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001340};
1341
Hanno Becker457d6162021-05-24 10:27:39 +01001342/*
1343 * Identifiers for PRFs used in various versions of TLS.
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345typedef enum {
1346 MBEDTLS_SSL_TLS_PRF_NONE,
1347 MBEDTLS_SSL_TLS_PRF_SHA384,
1348 MBEDTLS_SSL_TLS_PRF_SHA256,
1349 MBEDTLS_SSL_HKDF_EXPAND_SHA384,
1350 MBEDTLS_SSL_HKDF_EXPAND_SHA256
Hanno Becker457d6162021-05-24 10:27:39 +01001351}
1352mbedtls_tls_prf_types;
1353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354typedef enum {
Hanno Becker457d6162021-05-24 10:27:39 +01001355 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0,
Ronald Cron6f135e12021-12-08 16:57:54 +01001356#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001357 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1358 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET,
1359 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1360 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1361 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
1362 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
Ronald Cron6f135e12021-12-08 16:57:54 +01001363#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker457d6162021-05-24 10:27:39 +01001364} mbedtls_ssl_key_export_type;
1365
1366/**
1367 * \brief Callback type: Export key alongside random values for
1368 * session identification, and PRF for
1369 * implementation of TLS key exporters.
1370 *
Hanno Beckerddc739c2021-05-28 05:10:38 +01001371 * \param p_expkey Context for the callback.
1372 * \param type The type of the key that is being exported.
1373 * \param secret The address of the buffer holding the secret
1374 * that's being exporterd.
1375 * \param secret_len The length of \p secret in bytes.
Hanno Becker457d6162021-05-24 10:27:39 +01001376 * \param client_random The client random bytes.
1377 * \param server_random The server random bytes.
1378 * \param tls_prf_type The identifier for the PRF used in the handshake
1379 * to which the key belongs.
Hanno Becker457d6162021-05-24 10:27:39 +01001380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001381typedef void mbedtls_ssl_export_keys_t(void *p_expkey,
1382 mbedtls_ssl_key_export_type type,
1383 const unsigned char *secret,
1384 size_t secret_len,
1385 const unsigned char client_random[32],
1386 const unsigned char server_random[32],
1387 mbedtls_tls_prf_types tls_prf_type);
Hanno Becker457d6162021-05-24 10:27:39 +01001388
Glenn Strauss236e17e2022-03-13 23:39:40 -04001389#if defined(MBEDTLS_SSL_SRV_C)
1390/**
1391 * \brief Callback type: generic handshake callback
1392 *
1393 * \note Callbacks may use user_data funcs to set/get app user data.
1394 * See \c mbedtls_ssl_get_user_data_p()
1395 * \c mbedtls_ssl_get_user_data_n()
1396 * \c mbedtls_ssl_conf_get_user_data_p()
1397 * \c mbedtls_ssl_conf_get_user_data_n()
1398 *
1399 * \param ssl \c mbedtls_ssl_context on which the callback is run
1400 *
1401 * \return The return value of the callback is 0 if successful,
1402 * or a specific MBEDTLS_ERR_XXX code, which will cause
1403 * the handshake to be aborted.
1404 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001405typedef int (*mbedtls_ssl_hs_cb_t)(mbedtls_ssl_context *ssl);
Glenn Strauss236e17e2022-03-13 23:39:40 -04001406#endif
1407
Gilles Peskineded2a422022-02-12 00:20:08 +01001408/* A type for storing user data in a library structure.
1409 *
1410 * The representation of type may change in future versions of the library.
1411 * Only the behaviors guaranteed by documented accessor functions are
1412 * guaranteed to remain stable.
1413 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001414typedef union {
Gilles Peskineded2a422022-02-12 00:20:08 +01001415 uintptr_t n; /* typically a handle to an associated object */
1416 void *p; /* typically a pointer to extra data */
1417} mbedtls_ssl_user_data_t;
1418
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001419/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001420 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001422struct mbedtls_ssl_config {
Gilles Peskine8834d872021-11-29 12:36:50 +01001423 /* Group items mostly by size. This helps to reduce memory wasted to
1424 * padding. It also helps to keep smaller fields early in the structure,
1425 * so that elements tend to be in the 128-element direct access window
1426 * on Arm Thumb, which reduces the code size. */
1427
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001428 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(max_tls_version); /*!< max. TLS version used */
1429 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(min_tls_version); /*!< min. TLS version used */
Gilles Peskine8834d872021-11-29 12:36:50 +01001430
1431 /*
Gilles Peskine533a7282021-11-16 18:31:46 +01001432 * Flags (could be bit-fields to save RAM, but separate bytes make
1433 * the code smaller on architectures with an instruction for direct
1434 * byte access).
Gilles Peskine8834d872021-11-29 12:36:50 +01001435 */
1436
Gilles Peskine533a7282021-11-16 18:31:46 +01001437 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001438 uint8_t MBEDTLS_PRIVATE(transport); /*!< 0: stream (TLS), 1: datagram (DTLS) */
Gilles Peskine533a7282021-11-16 18:31:46 +01001439 uint8_t MBEDTLS_PRIVATE(authmode); /*!< MBEDTLS_SSL_VERIFY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001440 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Gilles Peskine533a7282021-11-16 18:31:46 +01001441 uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation); /*!< MBEDTLS_LEGACY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001442#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001443 uint8_t MBEDTLS_PRIVATE(mfl_code); /*!< desired fragment length indicator
1444 (MBEDTLS_SSL_MAX_FRAG_LEN_XXX) */
Gilles Peskine8834d872021-11-29 12:36:50 +01001445#endif
1446#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine533a7282021-11-16 18:31:46 +01001447 uint8_t MBEDTLS_PRIVATE(encrypt_then_mac); /*!< negotiate encrypt-then-mac? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001448#endif
1449#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine533a7282021-11-16 18:31:46 +01001450 uint8_t MBEDTLS_PRIVATE(extended_ms); /*!< negotiate extended master secret? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001451#endif
1452#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine533a7282021-11-16 18:31:46 +01001453 uint8_t MBEDTLS_PRIVATE(anti_replay); /*!< detect and prevent replay? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001454#endif
1455#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine533a7282021-11-16 18:31:46 +01001456 uint8_t MBEDTLS_PRIVATE(disable_renegotiation); /*!< disable renegotiation? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001457#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001458#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1459 defined(MBEDTLS_SSL_CLI_C)
1460 uint8_t MBEDTLS_PRIVATE(session_tickets); /*!< use session tickets? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001461#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001462
1463#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1464 defined(MBEDTLS_SSL_SRV_C) && \
1465 defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yud0766ec2022-09-22 10:46:57 +08001466 uint16_t MBEDTLS_PRIVATE(new_session_tickets_count); /*!< number of NewSessionTicket */
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001467#endif
1468
Gilles Peskine8834d872021-11-29 12:36:50 +01001469#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine533a7282021-11-16 18:31:46 +01001470 uint8_t MBEDTLS_PRIVATE(cert_req_ca_list); /*!< enable sending CA list in
1471 Certificate Request messages? */
1472 uint8_t MBEDTLS_PRIVATE(respect_cli_pref); /*!< pick the ciphersuite according to
1473 the client's preferences rather
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001474 than ours? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001475#endif
1476#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001477 uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid); /*!< Should DTLS record with
1478 * unexpected CID
1479 * lead to failure? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001480#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1481#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine533a7282021-11-16 18:31:46 +01001482 uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001483 in the use_srtp extension? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001484#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001485
1486 /*
1487 * Pointers
1488 */
1489
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001490 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +02001491 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001492
Ronald Cron6f135e12021-12-08 16:57:54 +01001493#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001494 /** Allowed TLS 1.3 key exchange modes. */
1495 int MBEDTLS_PRIVATE(tls13_kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01001496#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001497
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001498 /** Callback for printing debug output */
Gilles Peskine449bd832023-01-11 14:50:10 +01001499 void(*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001500 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001501
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001502 /** Callback for getting (pseudo-)random numbers */
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 int(*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001504 void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001505
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001506 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001507 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001508 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001509 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
1510 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001511
1512#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1513 /** Callback for setting cert according to SNI extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 int(*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001515 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001516#endif
1517
1518#if defined(MBEDTLS_X509_CRT_PARSE_C)
1519 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001521 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001522#endif
1523
Ronald Cron73fe8df2022-10-05 14:31:43 +02001524#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Jerry Yu8897c072022-08-12 13:56:53 +08001525#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001526 /** Callback to retrieve PSK key from identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 int(*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001528 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001529#endif
Jerry Yu8897c072022-08-12 13:56:53 +08001530#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001531
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001532#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Tom Cosgrove1e211442022-05-26 11:51:00 +01001533 /** Callback to create & write a cookie for ClientHello verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 int(*MBEDTLS_PRIVATE(f_cookie_write))(void *, unsigned char **, unsigned char *,
1535 const unsigned char *, size_t);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001536 /** Callback to verify validity of a ClientHello cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 int(*MBEDTLS_PRIVATE(f_cookie_check))(void *, const unsigned char *, size_t,
1538 const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001539 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001540#endif
1541
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001542#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001543 /** Callback to create & write a session ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 int(*MBEDTLS_PRIVATE(f_ticket_write))(void *, const mbedtls_ssl_session *,
1545 unsigned char *, const unsigned char *, size_t *,
1546 uint32_t *);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001547 /** Callback to parse a session ticket into a session structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 int(*MBEDTLS_PRIVATE(f_ticket_parse))(void *, mbedtls_ssl_session *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001549 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001550#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001551#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001552 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001553#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001554
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001555#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001556 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1557 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1558 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1559 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001560#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001561 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1562 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001563#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001564#endif /* MBEDTLS_X509_CRT_PARSE_C */
1565
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001566#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001567#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001568 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
1569 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start); /*!< start asynchronous decryption operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001570#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001571 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1572 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1573 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001574#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001575
Ronald Crone68ab4f2022-10-05 12:46:29 +02001576#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01001577
Jerry Yuf017ee42022-01-12 15:49:48 +08001578#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1579 const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */
1580#endif
1581 const uint16_t *MBEDTLS_PRIVATE(sig_algs); /*!< allowed signature algorithms */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001582#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001583
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02001584#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001585 const mbedtls_ecp_group_id *MBEDTLS_PRIVATE(curve_list); /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001586#endif
1587
Brett Warrene0edc842021-08-17 09:53:13 +01001588 const uint16_t *MBEDTLS_PRIVATE(group_list); /*!< allowed IANA NamedGroups */
1589
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001590#if defined(MBEDTLS_DHM_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001591 mbedtls_mpi MBEDTLS_PRIVATE(dhm_P); /*!< prime modulus for DHM */
1592 mbedtls_mpi MBEDTLS_PRIVATE(dhm_G); /*!< generator for DHM */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001593#endif
1594
Ronald Cron73fe8df2022-10-05 14:31:43 +02001595#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001596
1597#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +01001598 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Gilles Peskine449bd832023-01-11 14:50:10 +01001599 * should only be set via
1600 * mbedtls_ssl_conf_psk_opaque().
1601 * If either no PSK or a raw PSK have been
1602 * configured, this has value \c 0.
1603 */
Neil Armstrong8ecd6682022-05-05 11:40:35 +02001604#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001605 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 * only be set via mbedtls_ssl_conf_psk().
1607 * If either no PSK or an opaque PSK
1608 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001609 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Gilles Peskine449bd832023-01-11 14:50:10 +01001610 * This field should only be set via
1611 * mbedtls_ssl_conf_psk().
1612 * Its value is non-zero if and only if
1613 * \c psk is not \c NULL. */
Hanno Becker43633132018-10-22 15:31:03 +01001614
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001615 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 * This field should only be set via
1617 * mbedtls_ssl_conf_psk().
1618 * This is set if and only if either
1619 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001620 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 * This field should only be set via
1622 * mbedtls_ssl_conf_psk().
1623 * Its value is non-zero if and only if
1624 * \c psk is not \c NULL or \c psk_opaque
1625 * is not \c 0. */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001626#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001627
Xiaokang Qian54413b12022-10-20 05:57:03 +00001628#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001629 int MBEDTLS_PRIVATE(early_data_enabled); /*!< Early data enablement:
Xiaokang Qiand69d06f2022-10-25 06:51:25 +00001630 * - MBEDTLS_SSL_EARLY_DATA_DISABLED,
1631 * - MBEDTLS_SSL_EARLY_DATA_ENABLED */
Jerry Yucc4e0072022-11-22 17:22:22 +08001632
1633#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu12c46bd2022-12-06 11:02:51 +08001634 /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */
Jerry Yucc4e0072022-11-22 17:22:22 +08001635 uint32_t MBEDTLS_PRIVATE(max_early_data_size);
1636#endif /* MBEDTLS_SSL_SRV_C */
1637
Xiaokang Qian54413b12022-10-20 05:57:03 +00001638#endif /* MBEDTLS_SSL_EARLY_DATA */
1639
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001640#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001641 const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001642#endif
1643
Johan Pascalbbc057a2016-02-04 22:07:32 +01001644#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001645 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001646 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001647 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001648 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001649#endif /* MBEDTLS_SSL_DTLS_SRTP */
1650
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001651 /*
Gilles Peskine8834d872021-11-29 12:36:50 +01001652 * Numerical settings (int)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001653 */
1654
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001655 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001656
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001657#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001658 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001660 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001662#endif
1663
1664#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001665 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1666 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 that triggers renegotiation */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001668#endif
1669
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001670 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001671
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001672#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001673 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen); /*!< min. bit length of the DHM prime */
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001674#endif
Gilles Peskine69477b52022-01-13 01:01:45 +01001675
1676 /** User data pointer or handle.
1677 *
1678 * The library sets this to \p 0 when creating a context and does not
1679 * access it afterwards.
1680 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001681 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Glenn Strauss2ed95272022-01-21 18:02:17 -05001682
1683#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss236e17e2022-03-13 23:39:40 -04001684 mbedtls_ssl_hs_cb_t MBEDTLS_PRIVATE(f_cert_cb); /*!< certificate selection callback */
Glenn Strauss2ed95272022-01-21 18:02:17 -05001685#endif /* MBEDTLS_SSL_SRV_C */
Glenn Strauss999ef702022-03-11 01:37:23 -05001686
1687#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1688 const mbedtls_x509_crt *MBEDTLS_PRIVATE(dn_hints);/*!< acceptable client cert issuers */
1689#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001690};
1691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692struct mbedtls_ssl_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001693 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001694
Paul Bakker5121ce52009-01-03 21:22:43 +00001695 /*
1696 * Miscellaneous
1697 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001698 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001700 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1701 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 number of retransmissions of request if
1703 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001704#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001705
Ronald Cron8a12aee2023-03-08 15:30:43 +01001706 /**
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001707 * Maximum TLS version to be negotiated, then negotiated TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001708 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001709 * It is initialized as the configured maximum TLS version to be
1710 * negotiated by mbedtls_ssl_setup().
Ronald Cronbdb4f582022-03-31 15:37:44 +02001711 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001712 * When renegotiating or resuming a session, it is overwritten in the
1713 * ClientHello writing preparation stage with the previously negotiated
1714 * TLS version.
Ronald Cron8a12aee2023-03-08 15:30:43 +01001715 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001716 * On client side, it is updated to the TLS version selected by the server
1717 * for the handshake when the ServerHello is received.
Ronald Cron8a12aee2023-03-08 15:30:43 +01001718 *
Ronald Cronb9a9b1f2024-02-14 11:28:05 +01001719 * On server side, it is updated to the TLS version the server selects for
1720 * the handshake when the ClientHello is received.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001721 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001722 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Ronald Cronbdb4f582022-03-31 15:37:44 +02001723
Ronald Cron78a38f62024-02-01 18:30:31 +01001724#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
Ronald Cron5d0ae902024-01-05 14:20:35 +01001725 /**
Ronald Crond2884662024-03-03 15:03:22 +01001726 * State of the negotiation and transfer of early data. Reset to
Ronald Cron05d7cfb2024-03-03 15:39:30 +01001727 * MBEDTLS_SSL_EARLY_DATA_STATE_IDLE when the context is reset.
Ronald Cron5d0ae902024-01-05 14:20:35 +01001728 */
Ronald Cronaa359312024-03-11 17:24:39 +01001729 int MBEDTLS_PRIVATE(early_data_state);
Ronald Cron5d0ae902024-01-05 14:20:35 +01001730#endif
1731
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001732 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001733
Hanno Becker8927c832019-04-03 12:52:50 +01001734#if defined(MBEDTLS_X509_CRT_PARSE_C)
1735 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001737 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001738#endif
1739
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001740 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1741 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1742 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 /*!< Callback for network receive with timeout */
Simon Butchere846b512016-03-01 17:31:49 +00001744
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001745 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001746
Paul Bakker5121ce52009-01-03 21:22:43 +00001747 /*
1748 * Session layer
1749 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001750 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1751 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1752 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1753 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001754
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001755 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 the handshake process */
Paul Bakker48916f92012-09-16 19:57:18 +00001757
1758 /*
1759 * Record layer transformations
1760 */
Hanno Becker0e719ff2021-08-10 09:24:08 +01001761 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in)
1762 * This is always a reference,
1763 * never an owning pointer. */
1764 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (out)
1765 * This is always a reference,
1766 * never an owning pointer. */
1767 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params
1768 * This pointer owns the transform
1769 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001770#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0e719ff2021-08-10 09:24:08 +01001771 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation
1772 * This pointer owns the transform
1773 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001774#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001775
Ronald Cron6f135e12021-12-08 16:57:54 +01001776#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +01001777 /*! The application data transform in TLS 1.3.
1778 * This pointer owns the transform it references. */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001779 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01001780#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001781
Paul Bakker5121ce52009-01-03 21:22:43 +00001782 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001783 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001784 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001785 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001786
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001787 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1788 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001789
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001790 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001791 * Record layer (incoming data)
1792 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001793 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1794 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 TLS: maintained by us
1796 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001797 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001798#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001799 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001801#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001802 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1803 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1804 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1805 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001806
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001807 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1808 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1809 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001810#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001811 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001812#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001813#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001814 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1815 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001817#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001819 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1820 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001821#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001822
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001823 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 including the handshake header */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001825 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001826
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001827 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001829
Jerry Yue7047812021-09-13 19:26:39 +08001830 /* The following three variables indicate if and, if yes,
Jerry Yu394ece62021-09-14 22:17:21 +08001831 * what kind of alert is pending to be sent.
Jerry Yue7047812021-09-13 19:26:39 +08001832 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001833 unsigned char MBEDTLS_PRIVATE(send_alert); /*!< Determines if a fatal alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 should be sent. Values:
1835 - \c 0 , no alert is to be sent.
1836 - \c 1 , alert is to be sent. */
Jerry Yu33cedca2021-09-14 19:55:49 +08001837 unsigned char MBEDTLS_PRIVATE(alert_type); /*!< Type of alert if send_alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 != 0 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001839 int MBEDTLS_PRIVATE(alert_reason); /*!< The error code to be returned
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 to the user once the fatal alert
1841 has been sent. */
Jerry Yue7047812021-09-13 19:26:39 +08001842
Hanno Becker04da1892018-08-14 13:22:10 +01001843#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001844 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 * within a single datagram. */
Hanno Becker04da1892018-08-14 13:22:10 +01001846#endif /* MBEDTLS_SSL_PROTO_DTLS */
1847
Ronald Cron26a98112024-02-23 08:23:40 +01001848#if defined(MBEDTLS_SSL_EARLY_DATA)
1849#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001850 /*
1851 * One of:
1852 * MBEDTLS_SSL_EARLY_DATA_NO_DISCARD
1853 * MBEDTLS_SSL_EARLY_DATA_TRY_TO_DEPROTECT_AND_DISCARD
1854 * MBEDTLS_SSL_EARLY_DATA_DISCARD
1855 */
1856 uint8_t MBEDTLS_PRIVATE(discard_early_data_record);
1857#endif
Ronald Cron19bfe0a2024-02-26 16:43:01 +01001858 uint32_t MBEDTLS_PRIVATE(total_early_data_size); /*!< Number of received/written early data bytes */
Ronald Cron26a98112024-02-23 08:23:40 +01001859#endif /* MBEDTLS_SSL_EARLY_DATA */
Jerry Yu4caf3ca2023-11-15 16:13:47 +08001860
Paul Bakker5121ce52009-01-03 21:22:43 +00001861 /*
1862 * Record layer (outgoing data)
1863 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001864 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1865 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1866 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001867#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001868 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001870#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001871 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1872 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1873 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001874
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001875 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1876 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1877 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001878#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001879 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001880#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001881
Jerry Yuae0b2e22021-10-08 15:21:19 +08001882 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001883
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001884#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001885 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001886#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001887
Paul Bakker5121ce52009-01-03 21:22:43 +00001888 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001889 * User settings
1890 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001891#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001892 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001894#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001895
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001896#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001897 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001898#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001899
Johan Pascalb62bb512015-12-03 21:56:45 +01001900#if defined(MBEDTLS_SSL_DTLS_SRTP)
1901 /*
1902 * use_srtp extension
1903 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001904 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001905#endif /* MBEDTLS_SSL_DTLS_SRTP */
1906
Paul Bakker48916f92012-09-16 19:57:18 +00001907 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001908 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001909 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001910#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001911 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1912 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001913#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001914
1915 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001916 * Secure renegotiation
1917 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001918 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001919 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001921#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001922 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1923 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1924 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001925#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001926
Hanno Beckera0e20d02019-05-15 14:03:01 +01001927#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001928 /* CID configuration to use in subsequent handshakes. */
1929
1930 /*! The next incoming CID, chosen by the user and applying to
1931 * all subsequent handshakes. This may be different from the
1932 * CID currently used in case the user has re-configured the CID
1933 * after an initial handshake. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 unsigned char MBEDTLS_PRIVATE(own_cid)[MBEDTLS_SSL_CID_IN_LEN_MAX];
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001935 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1936 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 * be negotiated in the next handshake or not.
1938 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1939 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001940#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001941
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001942 /** Callback to export key block and master secret */
1943 mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys);
1944 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
Gilles Peskine69477b52022-01-13 01:01:45 +01001945
1946 /** User data pointer or handle.
1947 *
1948 * The library sets this to \p 0 when creating a context and does not
1949 * access it afterwards.
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01001950 *
1951 * \warning Serializing and restoring an SSL context with
1952 * mbedtls_ssl_context_save() and mbedtls_ssl_context_load()
1953 * does not currently restore the user data.
Gilles Peskine69477b52022-01-13 01:01:45 +01001954 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001955 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Paul Bakker5121ce52009-01-03 21:22:43 +00001956};
1957
Paul Bakker5121ce52009-01-03 21:22:43 +00001958/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001959 * \brief Return the name of the ciphersuite associated with the
1960 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001961 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001962 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001963 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001964 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001965 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001966const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id);
Paul Bakkere3166ce2011-01-27 17:40:50 +00001967
1968/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001969 * \brief Return the ID of the ciphersuite associated with the
1970 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001971 *
1972 * \param ciphersuite_name SSL ciphersuite name
1973 *
1974 * \return the ID with the ciphersuite or 0 if not found
1975 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001976int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name);
Paul Bakker72f62662011-01-16 21:27:44 +00001977
1978/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001979 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001980 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001981 * mbedtls_ssl_free()
1982 *
1983 * \param ssl SSL context
1984 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001985void mbedtls_ssl_init(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001986
1987/**
1988 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001989 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001990 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001991 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001992 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001993 * \warning The conf structure will be accessed during the session.
1994 * It must not be modified or freed as long as the session
1995 * is active.
1996 *
1997 * \warning This function must be called exactly once per context.
1998 * Calling mbedtls_ssl_setup again is not supported, even
1999 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02002000 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +02002001 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
2002 * subsystem must have been initialized by calling
2003 * psa_crypto_init() before calling this function.
2004 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002005 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02002006 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00002007 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002008 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00002009 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00002010 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002011int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
2012 const mbedtls_ssl_config *conf);
Paul Bakker5121ce52009-01-03 21:22:43 +00002013
2014/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00002015 * \brief Reset an already initialized SSL context for re-use
2016 * while retaining application-set variables, function
2017 * pointers and data.
2018 *
2019 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01002020 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
2021 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00002022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002023int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl);
Paul Bakker7eb013f2011-10-06 12:37:39 +00002024
2025/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002026 * \brief Set the current endpoint type
2027 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002028 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002029 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00002030 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002031void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint);
Paul Bakker5121ce52009-01-03 21:22:43 +00002032
2033/**
Pengyu Lvaccd53f2023-03-07 10:31:08 +08002034 * \brief Get the current endpoint type
2035 *
2036 * \param conf SSL configuration
2037 *
2038 * \return Endpoint type, either MBEDTLS_SSL_IS_CLIENT
2039 * or MBEDTLS_SSL_IS_SERVER
2040 */
Pengyu Lv08daebb2023-07-10 10:36:48 +08002041static inline int mbedtls_ssl_conf_get_endpoint(const mbedtls_ssl_config *conf)
Pengyu Lvaccd53f2023-03-07 10:31:08 +08002042{
2043 return conf->MBEDTLS_PRIVATE(endpoint);
2044}
2045
2046/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002047 * \brief Set the transport type (TLS or DTLS).
2048 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002049 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002050 * \note For DTLS, you must either provide a recv callback that
2051 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002052 * \c mbedtls_ssl_set_bio(). You also need to provide timer
2053 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002054 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002055 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002056 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002057 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
2058 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002059 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002060void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport);
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01002061
2062/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002063 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002064 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00002065 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002066 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00002067 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00002068 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002069 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01002070 * (default on server)
2071 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00002072 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00002074 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002075 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00002076 * handshake is complete.
2077 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00002079 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002080 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01002081 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
2083 * 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 +01002084 * the right time(s), which may not be obvious, while REQUIRED always perform
2085 * the verification as soon as possible. For example, REQUIRED was protecting
2086 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00002087 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002088void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode);
Paul Bakker5121ce52009-01-03 21:22:43 +00002089
Ronald Cron7d21cde2024-01-30 14:37:55 +01002090#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian54413b12022-10-20 05:57:03 +00002091/**
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 * \brief Set the early data mode
2093 * Default: disabled on server and client
2094 *
2095 * \param conf The SSL configuration to use.
2096 * \param early_data_enabled can be:
2097 *
Ronald Cron44d70a52024-01-30 18:16:47 +01002098 * MBEDTLS_SSL_EARLY_DATA_DISABLED:
2099 * Early data functionality is disabled. This is the default on client and
2100 * server.
Gilles Peskine449bd832023-01-11 14:50:10 +01002101 *
Ronald Cron44d70a52024-01-30 18:16:47 +01002102 * MBEDTLS_SSL_EARLY_DATA_ENABLED:
2103 * Early data functionality is enabled and may be negotiated in the handshake.
2104 * Application using early data functionality needs to be aware that the
2105 * security properties for early data (also refered to as 0-RTT data) are
2106 * weaker than those for other kinds of TLS data. See the documentation of
2107 * mbedtls_ssl_write_early_data() and mbedtls_ssl_read_early_data() for more
2108 * information.
2109 * When early data functionality is enabled on server and only in that case,
2110 * the call to one of the APIs that trigger or resume an handshake sequence,
2111 * namely mbedtls_ssl_handshake(), mbedtls_ssl_handshake_step(),
2112 * mbedtls_ssl_read() or mbedtls_ssl_write() may return with the error code
2113 * MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA indicating that some early data have
Ronald Cron164537c2024-02-01 18:05:47 +01002114 * been received. To read the early data, call mbedtls_ssl_read_early_data()
2115 * before calling the original function again.
Gilles Peskine449bd832023-01-11 14:50:10 +01002116 */
Yanray Wangd5ed36f2023-11-07 11:40:43 +08002117void mbedtls_ssl_conf_early_data(mbedtls_ssl_config *conf,
2118 int early_data_enabled);
Jerry Yucc4e0072022-11-22 17:22:22 +08002119
2120#if defined(MBEDTLS_SSL_SRV_C)
2121/**
Jerry Yu12c46bd2022-12-06 11:02:51 +08002122 * \brief Set the maximum amount of 0-RTT data in bytes
2123 * Default: #MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
2124 *
2125 * This function sets the value of the max_early_data_size
2126 * field of the early data indication extension included in
2127 * the NewSessionTicket messages that the server may send.
2128 *
2129 * The value defines the maximum amount of 0-RTT data
2130 * in bytes that a client will be allowed to send when using
2131 * one of the tickets defined by the NewSessionTicket messages.
2132 *
2133 * \note When resuming a session using a ticket, if the server receives more
2134 * early data than allowed for the ticket, it terminates the connection.
2135 * The maximum amount of 0-RTT data should thus be large enough
2136 * to allow a minimum of early data to be exchanged.
Jerry Yucc4e0072022-11-22 17:22:22 +08002137 *
2138 * \param[in] conf The SSL configuration to use.
2139 * \param[in] max_early_data_size The maximum amount of 0-RTT data.
Jerry Yucc4e0072022-11-22 17:22:22 +08002140 *
Jerry Yu6c485da2023-11-15 10:18:47 +08002141 * \warning This interface DOES NOT influence/limit the amount of early data
Jerry Yufedaeb22023-11-15 13:59:07 +08002142 * that can be received through previously created and issued tickets,
2143 * which clients may have stored.
Jerry Yucc4e0072022-11-22 17:22:22 +08002144 */
Yanray Wang07517612023-11-07 11:47:36 +08002145void mbedtls_ssl_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 mbedtls_ssl_config *conf, uint32_t max_early_data_size);
Jerry Yucc4e0072022-11-22 17:22:22 +08002147#endif /* MBEDTLS_SSL_SRV_C */
2148
Ronald Cron7d21cde2024-01-30 14:37:55 +01002149#endif /* MBEDTLS_SSL_EARLY_DATA */
Xiaokang Qian54413b12022-10-20 05:57:03 +00002150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002152/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002153 * \brief Set the verification callback (Optional).
2154 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002155 * If set, the provided verify callback is called for each
2156 * certificate in the peer's CRT chain, including the trusted
2157 * root. For more information, please see the documentation of
2158 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002159 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002160 * \note For per context callbacks and contexts, please use
2161 * mbedtls_ssl_set_verify() instead.
2162 *
2163 * \param conf The SSL configuration to use.
2164 * \param f_vrfy The verification callback to use during CRT verification.
2165 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002166 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002167void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
2168 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2169 void *p_vrfy);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002171
2172/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002173 * \brief Set the random number generator callback
2174 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01002175 * \param conf SSL configuration
Manuel Pégourié-Gonnardad5390f2021-06-15 11:29:26 +02002176 * \param f_rng RNG function (mandatory)
Paul Bakker5121ce52009-01-03 21:22:43 +00002177 * \param p_rng RNG parameter
2178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
2180 int (*f_rng)(void *, unsigned char *, size_t),
2181 void *p_rng);
Paul Bakker5121ce52009-01-03 21:22:43 +00002182
2183/**
2184 * \brief Set the debug callback
2185 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02002186 * The callback has the following argument:
2187 * void * opaque context for the callback
2188 * int debug level
2189 * const char * file name
2190 * int line number
2191 * const char * message
2192 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002193 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002194 * \param f_dbg debug function
2195 * \param p_dbg debug parameter
2196 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002197void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
2198 void (*f_dbg)(void *, int, const char *, int, const char *),
2199 void *p_dbg);
Paul Bakker5121ce52009-01-03 21:22:43 +00002200
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002201/**
Gilles Peskine915896f2022-01-13 01:05:10 +01002202 * \brief Return the SSL configuration structure associated
2203 * with the given SSL context.
2204 *
2205 * \note The pointer returned by this function is guaranteed to
2206 * remain valid until the context is freed.
2207 *
2208 * \param ssl The SSL context to query.
2209 * \return Pointer to the SSL configuration associated with \p ssl.
2210 */
2211static inline const mbedtls_ssl_config *mbedtls_ssl_context_get_config(
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 const mbedtls_ssl_context *ssl)
Gilles Peskine915896f2022-01-13 01:05:10 +01002213{
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 return ssl->MBEDTLS_PRIVATE(conf);
Gilles Peskine915896f2022-01-13 01:05:10 +01002215}
2216
2217/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002218 * \brief Set the underlying BIO callbacks for write, read and
2219 * read-with-timeout.
2220 *
2221 * \param ssl SSL context
2222 * \param p_bio parameter (context) shared by BIO callbacks
2223 * \param f_send write callback
2224 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002225 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002226 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002227 * \note One of f_recv or f_recv_timeout can be NULL, in which case
2228 * the other is used. If both are non-NULL, f_recv_timeout is
2229 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002230 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002231 * \note The two most common use cases are:
2232 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
bootstrap-prime6dbbf442022-05-17 19:30:44 -04002233 * - blocking I/O, f_recv == NULL, f_recv_timeout != NULL
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002234 *
2235 * \note For DTLS, you need to provide either a non-NULL
2236 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002237 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07002238 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002239 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00002240 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002241 *
Andres AG3616f6f2016-09-14 14:32:09 +01002242 * \note On some platforms, net_sockets.c provides
2243 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
2244 * \c mbedtls_net_recv_timeout() that are suitable to be used
2245 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002247void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
2248 void *p_bio,
2249 mbedtls_ssl_send_t *f_send,
2250 mbedtls_ssl_recv_t *f_recv,
2251 mbedtls_ssl_recv_timeout_t *f_recv_timeout);
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002252
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002253#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01002254
Hanno Beckera0e20d02019-05-15 14:03:01 +01002255#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01002256
2257
2258/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01002259 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01002260 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01002261 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002262 * Reference: RFC 9146 (or draft-ietf-tls-dtls-connection-id-05
Hanno Beckerebcc9132019-05-15 10:26:32 +01002263 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002264 * for legacy version)
Hanno Becker019f4b52019-04-09 15:12:56 +01002265 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01002266 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01002267 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01002268 * underlying transport (changed IP and Port metadata) by
2269 * adding explicit connection identifiers (CIDs) to the
2270 * headers of encrypted DTLS records. The desired CIDs are
2271 * configured by the application layer and are exchanged in
2272 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01002273 * handshake, where each side indicates the CID it wants the
2274 * peer to use when writing encrypted messages. The CIDs are
2275 * put to use once records get encrypted: the stack discards
2276 * any incoming records that don't include the configured CID
2277 * in their header, and adds the peer's requested CID to the
2278 * headers of outgoing messages.
2279 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01002280 * This API enables or disables the use of the CID extension
2281 * in the next handshake and sets the value of the CID to
2282 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01002283 *
2284 * \param ssl The SSL context to configure. This must be initialized.
2285 * \param enable This value determines whether the CID extension should
2286 * be used or not. Possible values are:
2287 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01002288 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
2289 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01002290 * \param own_cid The address of the readable buffer holding the CID we want
2291 * the peer to use when sending encrypted messages to us.
2292 * This may be \c NULL if \p own_cid_len is \c 0.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05002293 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01002294 * MBEDTLS_SSL_CID_DISABLED.
2295 * \param own_cid_len The length of \p own_cid.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05002296 * This parameter is unused if \p enable is set to
Hanno Becker019f4b52019-04-09 15:12:56 +01002297 * MBEDTLS_SSL_CID_DISABLED.
2298 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01002299 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01002300 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01002301 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01002302 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002303 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01002304 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01002305 * performed on the SSL context \p ssl, but does not trigger
2306 * one. You still have to call `mbedtls_ssl_handshake()`
2307 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
2308 * (for a renegotiation handshake) explicitly after a
2309 * successful call to this function to run the handshake.
2310 *
2311 * \note This call cannot guarantee that the use of the CID
2312 * will be successfully negotiated in the next handshake,
2313 * because the peer might not support it. Specifically:
2314 * - On the Client, enabling the use of the CID through
2315 * this call implies that the `ClientHello` in the next
2316 * handshake will include the CID extension, thereby
2317 * offering the use of the CID to the server. Only if
2318 * the `ServerHello` contains the CID extension, too,
2319 * the CID extension will actually be put to use.
2320 * - On the Server, enabling the use of the CID through
Tom Cosgrove1797b052022-12-04 17:19:59 +00002321 * this call implies that the server will look for
Hanno Becker019f4b52019-04-09 15:12:56 +01002322 * the CID extension in a `ClientHello` from the client,
2323 * and, if present, reply with a CID extension in its
2324 * `ServerHello`.
2325 *
2326 * \note To check whether the use of the CID was negotiated
2327 * after the subsequent handshake has completed, please
2328 * use the API mbedtls_ssl_get_peer_cid().
2329 *
2330 * \warning If the use of the CID extension is enabled in this call
2331 * and the subsequent handshake negotiates its use, Mbed TLS
2332 * will silently drop every packet whose CID does not match
2333 * the CID configured in \p own_cid. It is the responsibility
2334 * of the user to adapt the underlying transport to take care
2335 * of CID-based demultiplexing before handing datagrams to
2336 * Mbed TLS.
2337 *
2338 * \return \c 0 on success. In this case, the CID configuration
2339 * applies to the next handshake.
2340 * \return A negative error code on failure.
2341 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002342int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
2343 int enable,
2344 unsigned char const *own_cid,
2345 size_t own_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002346
2347/**
Paul Elliott0113cf12022-03-11 20:26:47 +00002348 * \brief Get information about our request for usage of the CID
2349 * extension in the current connection.
2350 *
2351 * \param ssl The SSL context to query.
2352 * \param enabled The address at which to store whether the CID extension
2353 * is requested to be used or not. If the CID is
2354 * requested, `*enabled` is set to
2355 * MBEDTLS_SSL_CID_ENABLED; otherwise, it is set to
2356 * MBEDTLS_SSL_CID_DISABLED.
2357 * \param own_cid The address of the buffer in which to store our own
2358 * CID (if the CID extension is requested). This may be
2359 * \c NULL in case the value of our CID isn't needed. If
2360 * it is not \c NULL, \p own_cid_len must not be \c NULL.
2361 * \param own_cid_len The address at which to store the size of our own CID
2362 * (if the CID extension is requested). This is also the
2363 * number of Bytes in \p own_cid that have been written.
2364 * This may be \c NULL in case the length of our own CID
2365 * isn't needed. If it is \c NULL, \p own_cid must be
2366 * \c NULL, too.
2367 *
2368 *\note If we are requesting an empty CID this function sets
2369 * `*enabled` to #MBEDTLS_SSL_CID_DISABLED (the rationale
2370 * for this is that the resulting outcome is the
2371 * same as if the CID extensions wasn't requested).
2372 *
2373 * \return \c 0 on success.
2374 * \return A negative error code on failure.
2375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002376int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
Paul Elliott0113cf12022-03-11 20:26:47 +00002377 int *enabled,
Sam Berry9722fd12024-06-11 14:34:17 +01002378 unsigned char own_cid[MBEDTLS_SSL_CID_IN_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 size_t *own_cid_len);
Paul Elliott0113cf12022-03-11 20:26:47 +00002380
2381/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01002382 * \brief Get information about the use of the CID extension
2383 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01002384 *
2385 * \param ssl The SSL context to query.
2386 * \param enabled The address at which to store whether the CID extension
2387 * is currently in use or not. If the CID is in use,
2388 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
2389 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
2390 * \param peer_cid The address of the buffer in which to store the CID
2391 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01002392 * This may be \c NULL in case the value of peer CID
2393 * isn't needed. If it is not \c NULL, \p peer_cid_len
2394 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01002395 * \param peer_cid_len The address at which to store the size of the CID
2396 * chosen by the peer (if the CID extension is used).
2397 * This is also the number of Bytes in \p peer_cid that
2398 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01002399 * This may be \c NULL in case the length of the peer CID
2400 * isn't needed. If it is \c NULL, \p peer_cid must be
2401 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01002402 *
2403 * \note This applies to the state of the CID negotiated in
2404 * the last complete handshake. If a handshake is in
2405 * progress, this function will attempt to complete
2406 * the handshake first.
2407 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01002408 * \note If CID extensions have been exchanged but both client
2409 * and server chose to use an empty CID, this function
2410 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
2411 * (the rationale for this is that the resulting
2412 * communication is the same as if the CID extensions
2413 * hadn't been used).
2414 *
Hanno Becker019f4b52019-04-09 15:12:56 +01002415 * \return \c 0 on success.
2416 * \return A negative error code on failure.
2417 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002418int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
2419 int *enabled,
2420 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2421 size_t *peer_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002422
Hanno Beckera0e20d02019-05-15 14:03:01 +01002423#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01002424
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002425/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002426 * \brief Set the Maximum Transport Unit (MTU).
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002427 * Special value: 0 means unset (no limit).
2428 * This represents the maximum size of a datagram payload
2429 * handled by the transport layer (usually UDP) as determined
2430 * by the network link and stack. In practice, this controls
2431 * the maximum size datagram the DTLS layer will pass to the
2432 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
2433 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002434 * \note The limit on datagram size is converted to a limit on
2435 * record payload by subtracting the current overhead of
2436 * encapsulation and encryption/authentication if any.
2437 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002438 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01002439 * example when a Path Maximum Transfer Unit (PMTU)
2440 * estimate becomes available from other sources,
2441 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002442 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002443 * \note This setting only controls the size of the packets we send,
2444 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02002445 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002446 * server to use smaller records with \c
2447 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002448 *
2449 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002450 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002451 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002452 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002453 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002454 * of datagrams (hence records, see first note) sent. It
2455 * cannot be used to increase the maximum size of records over
2456 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002457 *
2458 * \note Values lower than the current record layer expansion will
2459 * result in an error when trying to send data.
2460 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002461 * \param ssl SSL context
2462 * \param mtu Value of the path MTU in bytes
2463 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002464void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu);
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002465#endif /* MBEDTLS_SSL_PROTO_DTLS */
2466
Hanno Becker726c97a2019-04-03 12:52:35 +01002467#if defined(MBEDTLS_X509_CRT_PARSE_C)
2468/**
2469 * \brief Set a connection-specific verification callback (optional).
2470 *
2471 * If set, the provided verify callback is called for each
2472 * certificate in the peer's CRT chain, including the trusted
2473 * root. For more information, please see the documentation of
2474 * \c mbedtls_x509_crt_verify().
2475 *
2476 * \note This call is analogous to mbedtls_ssl_conf_verify() but
2477 * binds the verification callback and context to an SSL context
2478 * as opposed to an SSL configuration.
2479 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
2480 * are both used, mbedtls_ssl_set_verify() takes precedence.
2481 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01002482 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01002483 * \param f_vrfy The verification callback to use during CRT verification.
2484 * \param p_vrfy The opaque context to be passed to the callback.
2485 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002486void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
2487 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2488 void *p_vrfy);
Hanno Becker726c97a2019-04-03 12:52:35 +01002489#endif /* MBEDTLS_X509_CRT_PARSE_C */
2490
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002491/**
2492 * \brief Set the timeout period for mbedtls_ssl_read()
2493 * (Default: no timeout.)
2494 *
2495 * \param conf SSL configuration context
2496 * \param timeout Timeout value in milliseconds.
2497 * Use 0 for no timeout (default).
2498 *
2499 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002500 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002501 * With non-blocking I/O, this will only work if timer
2502 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
2503 *
2504 * \note With non-blocking I/O, you may also skip this function
2505 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002507void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout);
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002508
Hanno Beckercfe45792019-07-03 16:13:00 +01002509/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002510 * \brief Check whether a buffer contains a valid and authentic record
2511 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01002512 *
2513 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01002514 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01002515 * an indication of the legitimacy of an incoming record.
2516 *
2517 * This can be useful e.g. in distributed server environments
2518 * using the DTLS Connection ID feature, in which connections
2519 * might need to be passed between service instances on a change
2520 * of peer address, but where such disruptive operations should
2521 * only happen after the validity of incoming records has been
2522 * confirmed.
2523 *
2524 * \param ssl The SSL context to use.
2525 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002526 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01002527 * \param buflen The length of \p buf in Bytes.
2528 *
2529 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002530 * with a valid and authentic record that has not been seen
2531 * before, but does not check potential data following the
2532 * initial record. In particular, it is possible to pass DTLS
2533 * datagrams containing multiple records, in which case only
2534 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01002535 *
2536 * \note This function modifies the input buffer \p buf. If you need
2537 * to preserve the original record, you have to maintain a copy.
2538 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002539 * \return \c 0 if the record is valid and authentic and has not been
2540 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01002541 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
2542 * successfully but the record was found to be not authentic.
2543 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
2544 * successfully but the record was found to be invalid for
2545 * a reason different from authenticity checking.
2546 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
2547 * successfully but the record was found to be unexpected
2548 * in the state of the SSL context, including replayed records.
2549 * \return Another negative error code on different kinds of failure.
2550 * In this case, the SSL context becomes unusable and needs
2551 * to be freed or reset before reuse.
2552 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002553int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
2554 unsigned char *buf,
2555 size_t buflen);
Hanno Beckercfe45792019-07-03 16:13:00 +01002556
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002557/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002558 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002559 *
2560 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002561 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002562 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002563 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002564 *
2565 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
2566 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02002567 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002568 *
2569 * \note On some platforms, timing.c provides
2570 * \c mbedtls_timing_set_delay() and
2571 * \c mbedtls_timing_get_delay() that are suitable for using
2572 * here, except if using an event-driven style.
2573 *
2574 * \note See also the "DTLS tutorial" article in our knowledge base.
Dave Rodgmanb3196842022-10-12 16:47:08 +01002575 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002576 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002577void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
2578 void *p_timer,
2579 mbedtls_ssl_set_timer_t *f_set_timer,
2580 mbedtls_ssl_get_timer_t *f_get_timer);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002581
Glenn Strauss2ed95272022-01-21 18:02:17 -05002582#if defined(MBEDTLS_SSL_SRV_C)
2583/**
2584 * \brief Set the certificate selection callback (server-side only).
2585 *
2586 * If set, the callback is always called for each handshake,
2587 * after `ClientHello` processing has finished.
2588 *
Glenn Strauss2ed95272022-01-21 18:02:17 -05002589 * \param conf The SSL configuration to register the callback with.
2590 * \param f_cert_cb The callback for selecting server certificate after
2591 * `ClientHello` processing has finished.
2592 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002593static inline void mbedtls_ssl_conf_cert_cb(mbedtls_ssl_config *conf,
2594 mbedtls_ssl_hs_cb_t f_cert_cb)
Glenn Strauss236e17e2022-03-13 23:39:40 -04002595{
2596 conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb;
2597}
Glenn Strauss2ed95272022-01-21 18:02:17 -05002598#endif /* MBEDTLS_SSL_SRV_C */
2599
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002600/**
2601 * \brief Callback type: generate and write session ticket
2602 *
2603 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002604 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002605 * authenticated ticket for the session and write it to the
2606 * output buffer. Here, ticket means the opaque ticket part
2607 * of the NewSessionTicket structure of RFC 5077.
2608 *
2609 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002610 * \param session SSL session to be written in the ticket
2611 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002612 * \param end End of the output buffer
2613 * \param tlen On exit, holds the length written
2614 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2615 *
2616 * \return 0 if successful, or
2617 * a specific MBEDTLS_ERR_XXX code.
2618 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002619typedef int mbedtls_ssl_ticket_write_t(void *p_ticket,
2620 const mbedtls_ssl_session *session,
2621 unsigned char *start,
2622 const unsigned char *end,
2623 size_t *tlen,
2624 uint32_t *lifetime);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002625
2626/**
2627 * \brief Callback type: parse and load session ticket
2628 *
2629 * \note This describes what a callback implementation should do.
2630 * This callback should parse a session ticket as generated
2631 * by the corresponding mbedtls_ssl_ticket_write_t function,
2632 * and, if the ticket is authentic and valid, load the
2633 * session.
2634 *
2635 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002636 * bytes of the input buffer, eg to use it as a temporary
2637 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002638 *
2639 * \param p_ticket Context for the callback
2640 * \param session SSL session to be loaded
2641 * \param buf Start of the buffer containing the ticket
2642 * \param len Length of the ticket.
2643 *
2644 * \return 0 if successful, or
2645 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2646 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2647 * any other non-zero code for other failures.
2648 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002649typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket,
2650 mbedtls_ssl_session *session,
2651 unsigned char *buf,
2652 size_t len);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002653
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002654#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002655/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002656 * \brief Configure SSL session ticket callbacks (server only).
2657 * (Default: none.)
2658 *
2659 * \note On server, session tickets are enabled by providing
2660 * non-NULL callbacks.
2661 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002662 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002663 *
2664 * \param conf SSL configuration context
2665 * \param f_ticket_write Callback for writing a ticket
2666 * \param f_ticket_parse Callback for parsing a ticket
2667 * \param p_ticket Context shared by the two callbacks
2668 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002669void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2670 mbedtls_ssl_ticket_write_t *f_ticket_write,
2671 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2672 void *p_ticket);
Ronald Cron3c0072b2023-11-22 10:00:14 +01002673
2674#if defined(MBEDTLS_HAVE_TIME)
2675/**
2676 * \brief Get the creation time of a session ticket.
2677 *
2678 * \note See the documentation of \c ticket_creation_time for information about
2679 * the intended usage of this function.
2680 *
2681 * \param session SSL session
2682 * \param ticket_creation_time On exit, holds the ticket creation time in
2683 * milliseconds.
2684 *
2685 * \return 0 on success,
2686 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if an input is not valid.
2687 */
2688static inline int mbedtls_ssl_session_get_ticket_creation_time(
2689 mbedtls_ssl_session *session, mbedtls_ms_time_t *ticket_creation_time)
2690{
2691 if (session == NULL || ticket_creation_time == NULL ||
2692 session->MBEDTLS_PRIVATE(endpoint) != MBEDTLS_SSL_IS_SERVER) {
2693 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2694 }
2695
2696 *ticket_creation_time = session->MBEDTLS_PRIVATE(ticket_creation_time);
2697
2698 return 0;
2699}
2700#endif /* MBEDTLS_HAVE_TIME */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002701#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002702
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002703/**
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002704 * \brief Get the session-id buffer.
2705 *
2706 * \param session SSL session.
2707 *
2708 * \return The address of the session-id buffer.
2709 */
Minos Galanakis358b4482024-03-04 02:19:31 +00002710static inline unsigned const char (*mbedtls_ssl_session_get_id(const mbedtls_ssl_session *
2711 session))[32]
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002712{
2713 return &session->MBEDTLS_PRIVATE(id);
2714}
2715
2716/**
2717 * \brief Get the size of the session-id.
2718 *
2719 * \param session SSL session.
2720 *
2721 * \return size_t size of session-id buffer.
2722 */
Minos Galanakis358b4482024-03-04 02:19:31 +00002723static inline size_t mbedtls_ssl_session_get_id_len(const mbedtls_ssl_session *session)
Minos Galanakis2c8c3642024-03-04 15:15:06 +00002724{
2725 return session->MBEDTLS_PRIVATE(id_len);
2726}
2727
2728/**
Minos Galanakis40d47082024-03-04 15:24:51 +00002729 * \brief Get the ciphersuite-id.
2730 *
2731 * \param session SSL session.
2732 *
2733 * \return int represetation for ciphersuite.
2734 */
2735static inline int mbedtls_ssl_session_get_ciphersuite_id(const mbedtls_ssl_session *session)
2736{
2737 return session->MBEDTLS_PRIVATE(ciphersuite);
2738}
2739
2740/**
Hanno Becker457d6162021-05-24 10:27:39 +01002741 * \brief Configure a key export callback.
2742 * (Default: none.)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002743 *
Hanno Becker457d6162021-05-24 10:27:39 +01002744 * This API can be used for two purposes:
2745 * - Debugging: Use this API to e.g. generate an NSSKeylog
2746 * file and use it to inspect encrypted traffic in tools
2747 * such as Wireshark.
2748 * - Application-specific export: Use this API to implement
2749 * key exporters, e.g. for EAP-TLS or DTLS-SRTP.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002750 *
Hanno Becker457d6162021-05-24 10:27:39 +01002751 *
Hanno Becker7e6c1782021-06-08 09:24:55 +01002752 * \param ssl The SSL context to which the export
2753 * callback should be attached.
Hanno Becker457d6162021-05-24 10:27:39 +01002754 * \param f_export_keys The callback for the key export.
2755 * \param p_export_keys The opaque context pointer to be passed to the
2756 * callback \p f_export_keys.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002758void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2759 mbedtls_ssl_export_keys_t *f_export_keys,
2760 void *p_export_keys);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002761
Gilles Peskine80dae042022-01-21 23:50:39 +01002762/** \brief Set the user data in an SSL configuration to a pointer.
2763 *
2764 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_p().
2765 *
2766 * \note The library stores \c p without accessing it. It is the responsibility
2767 * of the caller to ensure that the pointer remains valid.
2768 *
2769 * \param conf The SSL configuration context to modify.
2770 * \param p The new value of the user data.
2771 */
2772static inline void mbedtls_ssl_conf_set_user_data_p(
2773 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002775{
Gilles Peskineded2a422022-02-12 00:20:08 +01002776 conf->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002777}
2778
2779/** \brief Set the user data in an SSL configuration to an integer.
2780 *
2781 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_n().
2782 *
2783 * \param conf The SSL configuration context to modify.
2784 * \param n The new value of the user data.
2785 */
2786static inline void mbedtls_ssl_conf_set_user_data_n(
2787 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002789{
Gilles Peskineded2a422022-02-12 00:20:08 +01002790 conf->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002791}
2792
2793/** \brief Retrieve the user data in an SSL configuration as a pointer.
2794 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002795 * This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or
2796 * \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been
2797 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has
2798 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002799 *
2800 * \param conf The SSL configuration context to modify.
2801 * \return The current value of the user data.
2802 */
2803static inline void *mbedtls_ssl_conf_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002804 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002805{
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 return conf->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002807}
2808
2809/** \brief Retrieve the user data in an SSL configuration as an integer.
2810 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002811 * This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or
2812 * \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been
2813 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has
2814 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002815 *
2816 * \param conf The SSL configuration context to modify.
2817 * \return The current value of the user data.
2818 */
2819static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002821{
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 return conf->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002823}
2824
2825/** \brief Set the user data in an SSL context to a pointer.
2826 *
2827 * You can retrieve this value later with mbedtls_ssl_get_user_data_p().
2828 *
2829 * \note The library stores \c p without accessing it. It is the responsibility
2830 * of the caller to ensure that the pointer remains valid.
2831 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002832 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002833 * \param p The new value of the user data.
2834 */
2835static inline void mbedtls_ssl_set_user_data_p(
2836 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002838{
Gilles Peskineded2a422022-02-12 00:20:08 +01002839 ssl->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002840}
2841
2842/** \brief Set the user data in an SSL context to an integer.
2843 *
2844 * You can retrieve this value later with mbedtls_ssl_get_user_data_n().
2845 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002846 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002847 * \param n The new value of the user data.
2848 */
2849static inline void mbedtls_ssl_set_user_data_n(
2850 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002852{
Gilles Peskineded2a422022-02-12 00:20:08 +01002853 ssl->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002854}
2855
2856/** \brief Retrieve the user data in an SSL context as a pointer.
2857 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002858 * This is the value last set with mbedtls_ssl_set_user_data_p(), or
2859 * \c NULL if mbedtls_ssl_set_user_data_p() has not previously been
2860 * called. The value is undefined if mbedtls_ssl_set_user_data_n() has
2861 * been called without a subsequent call to mbedtls_ssl_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002862 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002863 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002864 * \return The current value of the user data.
2865 */
2866static inline void *mbedtls_ssl_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002868{
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 return ssl->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002870}
2871
2872/** \brief Retrieve the user data in an SSL context as an integer.
2873 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002874 * This is the value last set with mbedtls_ssl_set_user_data_n(), or
2875 * \c 0 if mbedtls_ssl_set_user_data_n() has not previously been
2876 * called. The value is undefined if mbedtls_ssl_set_user_data_p() has
2877 * been called without a subsequent call to mbedtls_ssl_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002878 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002879 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002880 * \return The current value of the user data.
2881 */
2882static inline uintptr_t mbedtls_ssl_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002884{
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 return ssl->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002886}
2887
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002888#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002889/**
2890 * \brief Configure asynchronous private key operation callbacks.
2891 *
2892 * \param conf SSL configuration context
2893 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002894 * the description of ::mbedtls_ssl_async_sign_t
2895 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002896 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002897 * operation; in this case the private key object
2898 * associated with the certificate will be used.
2899 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002900 * the description of ::mbedtls_ssl_async_decrypt_t
2901 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002902 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002903 * operation; in this case the private key object
2904 * associated with the certificate will be used.
2905 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002906 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002907 * for more information. This may not be \c NULL unless
2908 * \p f_async_sign and \p f_async_decrypt are both
2909 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002910 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002911 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002912 * for more information. This may be \c NULL if
2913 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002914 * \param config_data A pointer to configuration data which can be
2915 * retrieved with
2916 * mbedtls_ssl_conf_get_async_config_data(). The
2917 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002918 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002919void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf,
2920 mbedtls_ssl_async_sign_t *f_async_sign,
2921 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2922 mbedtls_ssl_async_resume_t *f_async_resume,
2923 mbedtls_ssl_async_cancel_t *f_async_cancel,
2924 void *config_data);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002925
2926/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002927 * \brief Retrieve the configuration data set by
2928 * mbedtls_ssl_conf_async_private_cb().
2929 *
2930 * \param conf SSL configuration context
2931 * \return The configuration data set by
2932 * mbedtls_ssl_conf_async_private_cb().
2933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002934void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf);
Gilles Peskine8f97af72018-04-26 11:46:10 +02002935
2936/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002937 * \brief Retrieve the asynchronous operation user context.
2938 *
2939 * \note This function may only be called while a handshake
2940 * is in progress.
2941 *
2942 * \param ssl The SSL context to access.
2943 *
2944 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002945 * set during the current handshake. If
2946 * mbedtls_ssl_set_async_operation_data() has not yet been
2947 * called during the current handshake, this function returns
2948 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002949 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002950void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002951
2952/**
2953 * \brief Retrieve the asynchronous operation user context.
2954 *
2955 * \note This function may only be called while a handshake
2956 * is in progress.
2957 *
2958 * \param ssl The SSL context to access.
2959 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002960 * Call mbedtls_ssl_get_async_operation_data() later during the
2961 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002962 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002963void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2964 void *ctx);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002965#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002966
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002967/**
2968 * \brief Callback type: generate a cookie
2969 *
2970 * \param ctx Context for the callback
2971 * \param p Buffer to write to,
2972 * must be updated to point right after the cookie
2973 * \param end Pointer to one past the end of the output buffer
2974 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002976 * \param ilen Length of info in bytes
2977 *
2978 * \return The callback must return 0 on success,
2979 * or a negative error code.
2980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002981typedef int mbedtls_ssl_cookie_write_t(void *ctx,
2982 unsigned char **p, unsigned char *end,
2983 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002984
2985/**
2986 * \brief Callback type: verify a cookie
2987 *
2988 * \param ctx Context for the callback
2989 * \param cookie Cookie to verify
2990 * \param clen Length of cookie
2991 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002992 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002993 * \param ilen Length of info in bytes
2994 *
2995 * \return The callback must return 0 if cookie is valid,
2996 * or a negative error code.
2997 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002998typedef int mbedtls_ssl_cookie_check_t(void *ctx,
2999 const unsigned char *cookie, size_t clen,
3000 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02003001
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003002#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02003003/**
3004 * \brief Register callbacks for DTLS cookies
3005 * (Server only. DTLS only.)
3006 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003007 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02003008 * register working callbacks (and initialize their context).
3009 *
3010 * To disable HelloVerifyRequest, register NULL callbacks.
3011 *
3012 * \warning Disabling hello verification allows your server to be used
3013 * for amplification in DoS attacks against other hosts.
3014 * Only disable if you known this can't happen in your
3015 * particular environment.
3016 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003017 * \note See comments on \c mbedtls_ssl_handshake() about handling
3018 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
3019 * on the first handshake attempt when this is enabled.
3020 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003021 * \note This is also necessary to handle client reconnection from
3022 * the same port as described in RFC 6347 section 4.2.8 (only
3023 * the variant with cookies is supported currently). See
3024 * comments on \c mbedtls_ssl_read() for details.
3025 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003026 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02003027 * \param f_cookie_write Cookie write callback
3028 * \param f_cookie_check Cookie check callback
3029 * \param p_cookie Context for both callbacks
3030 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003031void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf,
3032 mbedtls_ssl_cookie_write_t *f_cookie_write,
3033 mbedtls_ssl_cookie_check_t *f_cookie_check,
3034 void *p_cookie);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003035
3036/**
3037 * \brief Set client's transport-level identification info.
3038 * (Server only. DTLS only.)
3039 *
3040 * This is usually the IP address (and port), but could be
3041 * anything identify the client depending on the underlying
3042 * network stack. Used for HelloVerifyRequest with DTLS.
3043 * This is *not* used to route the actual packets.
3044 *
3045 * \param ssl SSL context
3046 * \param info Transport-level info identifying the client (eg IP + port)
3047 * \param ilen Length of info in bytes
3048 *
3049 * \note An internal copy is made, so the info buffer can be reused.
3050 *
3051 * \return 0 on success,
3052 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003053 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003054 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003055int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl,
3056 const unsigned char *info,
3057 size_t ilen);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02003058
3059#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02003060
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003062/**
3063 * \brief Enable or disable anti-replay protection for DTLS.
3064 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02003065 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003066 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003067 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02003069 *
3070 * \warning Disabling this is a security risk unless the application
3071 * protocol handles duplicated packets in a safe way. You
3072 * should not disable this without careful consideration.
3073 * However, if your application already detects duplicated
3074 * packets and needs information about them to adjust its
3075 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003077void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003079
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003080/**
3081 * \brief Set a limit on the number of records with a bad MAC
3082 * before terminating the connection.
3083 * (DTLS only, no effect on TLS.)
3084 * Default: 0 (disabled).
3085 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003086 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003087 * \param limit Limit, or 0 to disable.
3088 *
3089 * \note If the limit is N, then the connection is terminated when
3090 * the Nth non-authentic record is seen.
3091 *
3092 * \note Records with an invalid header are not counted, only the
3093 * ones going through the authentication-decryption phase.
3094 *
3095 * \note This is a security trade-off related to the fact that it's
Andrzej Kurek5c65c572022-04-13 14:28:52 -04003096 * often relatively easy for an active attacker to inject UDP
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003097 * datagrams. On one hand, setting a low limit here makes it
3098 * easier for such an attacker to forcibly terminated a
3099 * connection. On the other hand, a high limit or no limit
3100 * might make us waste resources checking authentication on
3101 * many bogus packets.
3102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003103void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit);
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02003104
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003105#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01003106
3107/**
3108 * \brief Allow or disallow packing of multiple handshake records
3109 * within a single datagram.
3110 *
3111 * \param ssl The SSL context to configure.
3112 * \param allow_packing This determines whether datagram packing may
3113 * be used or not. A value of \c 0 means that every
3114 * record will be sent in a separate datagram; a
3115 * value of \c 1 means that, if space permits,
3116 * multiple handshake messages (including CCS) belonging to
3117 * a single flight may be packed within a single datagram.
3118 *
3119 * \note This is enabled by default and should only be disabled
3120 * for test purposes, or if datagram packing causes
3121 * interoperability issues with peers that don't support it.
3122 *
3123 * \note Allowing datagram packing reduces the network load since
3124 * there's less overhead if multiple messages share the same
3125 * datagram. Also, it increases the handshake efficiency
3126 * since messages belonging to a single datagram will not
3127 * be reordered in transit, and so future message buffering
3128 * or flight retransmission (if no buffering is used) as
3129 * means to deal with reordering are needed less frequently.
3130 *
Hanno Beckereb570082018-08-24 11:28:35 +01003131 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01003132 * are currently always sent in separate datagrams.
3133 *
3134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003135void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
3136 unsigned allow_packing);
Hanno Becker04da1892018-08-14 13:22:10 +01003137
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003138/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00003139 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003140 * (DTLS only, no effect on TLS.)
3141 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003142 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003143 * \param min Initial timeout value in milliseconds.
3144 * Default: 1000 (1 second).
3145 * \param max Maximum timeout value in milliseconds.
3146 * Default: 60000 (60 seconds).
3147 *
3148 * \note Default values are from RFC 6347 section 4.2.4.1.
3149 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01003150 * \note The 'min' value should typically be slightly above the
3151 * expected round-trip time to your peer, plus whatever time
3152 * it takes for the peer to process the message. For example,
3153 * if your RTT is about 600ms and you peer needs up to 1s to
3154 * do the cryptographic operations in the handshake, then you
3155 * should set 'min' slightly above 1600. Lower values of 'min'
3156 * might cause spurious resends which waste network resources,
3157 * while larger value of 'min' will increase overall latency
3158 * on unreliable network links.
3159 *
3160 * \note The more unreliable your network connection is, the larger
3161 * your max / min ratio needs to be in order to achieve
3162 * reliable handshakes.
3163 *
3164 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
3165 * For example, if min = 1s and max = 5s, the retransmit plan
3166 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
3167 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02003168 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003169void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02003171
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01003172#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003173/**
Paul Bakker0a597072012-09-25 21:55:46 +00003174 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01003175 * If not set, no session resuming is done (except if session
3176 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00003177 *
Paul Bakker0a597072012-09-25 21:55:46 +00003178 * The session cache has the responsibility to check for stale
3179 * entries based on timeout. See RFC 5246 for recommendations.
3180 *
3181 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
3182 * connection shutdown, so do not cache the pointer! Either set
3183 * it to NULL or make a full copy of the certificate.
3184 *
3185 * The get callback is called once during the initial handshake
3186 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003187 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00003188 * If a valid entry is found, it should fill the master of
3189 * the session object with the cached values and return 0,
3190 * return 1 otherwise. Optionally peer_cert can be set as well
3191 * if it is properly present in cache entry.
3192 *
3193 * The set callback is called once during the initial handshake
3194 * to enable session resuming after the entire handshake has
3195 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00003197 * should create a cache entry for future retrieval based on
3198 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003199 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00003200 * data) is cleared by the SSL/TLS layer when the connection is
3201 * terminated. It is recommended to add metadata to determine if
3202 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00003203 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00003204 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003205 * \param conf SSL configuration
Tom Cosgrove1e211442022-05-26 11:51:00 +01003206 * \param p_cache parameter (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00003207 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00003208 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00003209 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003210void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
3211 void *p_cache,
3212 mbedtls_ssl_cache_get_t *f_get_cache,
3213 mbedtls_ssl_cache_set_t *f_set_cache);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003214#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003215
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003216#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003217/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003218 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00003219 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003220 * Sessions loaded through this call will be considered
3221 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003222 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003223 * \note Even if this call succeeds, it is not guaranteed that
3224 * the next handshake will indeed be shortened through the
3225 * use of session resumption: The server is always free
3226 * to reject any attempt for resumption and fall back to
3227 * a full handshake.
3228 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003229 * \note This function can handle a variety of mechanisms for session
Ronald Cron7fb43432024-04-04 10:34:21 +02003230 * resumption: For TLS 1.2, both session ID-based resumption
3231 * and ticket-based resumption will be considered. For TLS 1.3,
3232 * sessions equate to tickets, and loading one session by
3233 * calling this function will lead to its corresponding ticket
Ronald Cronfccfa692024-04-04 13:40:11 +02003234 * being advertised as resumption PSK by the client. This
3235 * depends on session tickets being enabled (see
3236 * #MBEDTLS_SSL_SESSION_TICKETS configuration option) though.
3237 * If session tickets are disabled, a call to this function
3238 * with a TLS 1.3 session, will not have any effect on the next
3239 * handshake for the SSL context \p ssl.
Hanno Beckere810bbc2021-05-14 16:01:05 +01003240 *
3241 * \param ssl The SSL context representing the connection which should
3242 * be attempted to be setup using session resumption. This
3243 * must be initialized via mbedtls_ssl_init() and bound to
3244 * an SSL configuration via mbedtls_ssl_setup(), but
3245 * the handshake must not yet have been started.
3246 * \param session The session to be considered for session resumption.
3247 * This must be a session previously exported via
3248 * mbedtls_ssl_get_session(), and potentially serialized and
3249 * deserialized through mbedtls_ssl_session_save() and
3250 * mbedtls_ssl_session_load() in the meantime.
3251 *
3252 * \return \c 0 if successful.
3253 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
Ronald Cron7fb43432024-04-04 10:34:21 +02003254 * could not be loaded because one session has already been
3255 * loaded. This error is non-fatal, and has no observable
3256 * effect on the SSL context or the session that was attempted
3257 * to be loaded.
Hanno Beckere810bbc2021-05-14 16:01:05 +01003258 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003259 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003261 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00003262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003263int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003265
3266/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003267 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003268 * On client, this can be used for loading saved sessions
Tom Cosgrove1e211442022-05-26 11:51:00 +01003269 * before resuming them with mbedtls_ssl_set_session().
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003270 * On server, this can be used for alternative implementations
3271 * of session cache or session tickets.
3272 *
3273 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003274 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003275 * end-entity certificate and the result of the chain
3276 * verification (unless verification was disabled), but not
3277 * the rest of the chain.
3278 *
3279 * \see mbedtls_ssl_session_save()
3280 * \see mbedtls_ssl_set_session()
3281 *
3282 * \param session The session structure to be populated. It must have been
3283 * initialised with mbedtls_ssl_session_init() but not
3284 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003285 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003286 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003287 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003288 *
3289 * \return \c 0 if successful.
3290 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
3291 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01003292 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
3293 * was generated in a different version or configuration of
3294 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02003295 * \return Another negative value for other kinds of errors (for
3296 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003298int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3299 const unsigned char *buf,
3300 size_t len);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003301
3302/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003303 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003304 * On client, this can be used for saving session data,
3305 * potentially in non-volatile storage, for resuming later.
3306 * On server, this can be used for alternative implementations
3307 * of session cache or session tickets.
3308 *
3309 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003310 *
3311 * \param session The session structure to be saved.
3312 * \param buf The buffer to write the serialized data to. It must be a
Andrzej Kurek377eb5f2023-05-06 09:57:40 -04003313 * writeable buffer of at least \p buf_len bytes, or may be \c
3314 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003315 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003316 * \param olen The size in bytes of the data that has been or would have
3317 * been written. It must point to a valid \c size_t.
3318 *
3319 * \note \p olen is updated to the correct value regardless of
3320 * whether \p buf_len was large enough. This makes it possible
3321 * to determine the necessary size by calling this function
3322 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003323 *
Ronald Cron48e29a12024-04-04 09:53:07 +02003324 * \note For TLS 1.3 sessions, this feature is supported only if the
3325 * MBEDTLS_SSL_SESSION_TICKETS configuration option is enabled,
3326 * as in TLS 1.3 session resumption is possible only with
3327 * tickets.
3328 *
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003329 * \return \c 0 if successful.
3330 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Ronald Cron48e29a12024-04-04 09:53:07 +02003331 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the
3332 * MBEDTLS_SSL_SESSION_TICKETS configuration option is disabled
3333 * and the session is a TLS 1.3 session.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003335int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3336 unsigned char *buf,
3337 size_t buf_len,
3338 size_t *olen);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003339
3340/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003341 * \brief Set the list of allowed ciphersuites and the preference
3342 * order. First in the list has the highest preference.
Paul Bakker5121ce52009-01-03 21:22:43 +00003343 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003344 * For TLS 1.2, the notion of ciphersuite determines both
3345 * the key exchange mechanism and the suite of symmetric
3346 * algorithms to be used during and after the handshake.
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003347 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003348 * For TLS 1.3 (in development), the notion of ciphersuite
Hanno Becker674f9482021-08-02 21:21:19 +01003349 * only determines the suite of symmetric algorithms to be
Hanno Beckere486b2d2021-07-23 19:24:30 +01003350 * used during and after the handshake, while key exchange
3351 * mechanisms are configured separately.
3352 *
3353 * In Mbed TLS, ciphersuites for both TLS 1.2 and TLS 1.3
3354 * are configured via this function. For users of TLS 1.3,
3355 * there will be separate API for the configuration of key
3356 * exchange mechanisms.
3357 *
3358 * The list of ciphersuites passed to this function may
3359 * contain a mixture of TLS 1.2 and TLS 1.3 ciphersuite
3360 * identifiers. This is useful if negotiation of TLS 1.3
3361 * should be attempted, but a fallback to TLS 1.2 would
3362 * be tolerated.
3363 *
3364 * \note By default, the server chooses its preferred
TRodziewicz3946f792021-06-14 12:11:18 +02003365 * ciphersuite among those that the client supports. If
3366 * mbedtls_ssl_conf_preference_order() is called to prefer
3367 * the client's preferences, the server instead chooses
3368 * the client's preferred ciphersuite among those that
3369 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003370 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003371 * \warning The ciphersuites array \p ciphersuites is not copied.
Jerry Yucadebe52021-08-24 10:36:45 +08003372 * It must remain valid for the lifetime of the SSL
Hanno Beckere486b2d2021-07-23 19:24:30 +01003373 * configuration \p conf.
3374 *
3375 * \param conf The SSL configuration to modify.
3376 * \param ciphersuites A 0-terminated list of IANA identifiers of supported
3377 * ciphersuites, accessible through \c MBEDTLS_TLS_XXX
3378 * and \c MBEDTLS_TLS1_3_XXX macros defined in
3379 * ssl_ciphersuites.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003381void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
3382 const int *ciphersuites);
Paul Bakker5121ce52009-01-03 21:22:43 +00003383
Ronald Cron6f135e12021-12-08 16:57:54 +01003384#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01003385/**
3386 * \brief Set the supported key exchange modes for TLS 1.3 connections.
3387 *
3388 * In contrast to TLS 1.2, the ciphersuite concept in TLS 1.3 does not
3389 * include the choice of key exchange mechanism. It is therefore not
3390 * covered by the API mbedtls_ssl_conf_ciphersuites(). See the
3391 * documentation of mbedtls_ssl_conf_ciphersuites() for more
3392 * information on the ciphersuite concept in TLS 1.2 and TLS 1.3.
3393 *
3394 * The present function is specific to TLS 1.3 and allows users to
3395 * configure the set of supported key exchange mechanisms in TLS 1.3.
3396 *
3397 * \param conf The SSL configuration the change should apply to.
3398 * \param kex_modes A bitwise combination of one or more of the following:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003399 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK
Hanno Becker71f1ed62021-07-24 06:01:47 +01003400 * This flag enables pure-PSK key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003401 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003402 * This flag enables combined PSK-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003403 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003404 * This flag enables pure-ephemeral key exchanges.
3405 * For convenience, the following pre-defined macros are
3406 * available for combinations of the above:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003407 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003408 * Includes all of pure-PSK, PSK-ephemeral and pure-ephemeral.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003409 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003410 * Includes both pure-PSK and combined PSK-ephemeral
3411 * key exchanges, but excludes pure-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003412 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003413 * Includes both pure-ephemeral and combined PSK-ephemeral
3414 * key exchanges.
3415 *
3416 * \note If a PSK-based key exchange mode shall be supported, applications
3417 * must also use the APIs mbedtls_ssl_conf_psk() or
3418 * mbedtls_ssl_conf_psk_cb() or mbedtls_ssl_conf_psk_opaque()
3419 * to configure the PSKs to be used.
3420 *
Hanno Becker5d045a82021-08-02 21:21:30 +01003421 * \note If a pure-ephemeral key exchange mode shall be supported,
Hanno Becker71f1ed62021-07-24 06:01:47 +01003422 * server-side applications must also provide a certificate via
3423 * mbedtls_ssl_conf_own_cert().
3424 *
3425 */
3426
Gilles Peskine449bd832023-01-11 14:50:10 +01003427void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
3428 const int kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01003429#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00003430
Hanno Beckera0e20d02019-05-15 14:03:01 +01003431#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01003432#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
3433#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01003434/**
Hanno Becker11259522019-05-23 16:55:50 +01003435 * \brief Specify the length of Connection IDs for incoming
3436 * encrypted DTLS records, as well as the behaviour
3437 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01003438 *
3439 * By default, the CID length is set to \c 0,
3440 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003441 *
3442 * \param conf The SSL configuration to modify.
3443 * \param len The length in Bytes of the CID fields in encrypted
3444 * DTLS records using the CID mechanism. This must
3445 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01003446 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01003447 * receiving a record with an unexpected CID.
3448 * Possible values are:
3449 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
3450 * In this case, the record is silently ignored.
3451 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
3452 * In this case, the stack fails with the specific
3453 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003454 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01003455 * \note The CID specification allows implementations to either
3456 * use a common length for all incoming connection IDs or
3457 * allow variable-length incoming IDs. Mbed TLS currently
3458 * requires a common length for all connections sharing the
3459 * same SSL configuration; this allows simpler parsing of
3460 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003461 *
3462 * \return \c 0 on success.
Andrzej Kurek3bedb5b2022-02-17 14:39:00 -05003463 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p len
Hanno Beckerad4a1372019-05-03 13:06:44 +01003464 * is too large.
3465 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003466int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len,
3467 int ignore_other_cids);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003468#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01003469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003470#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02003471/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003472 * \brief Set the X.509 security profile used for verification
3473 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003474 * \note The restrictions are enforced for all certificates in the
3475 * chain. However, signatures in the handshake are not covered
3476 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
3477 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003478 * \param conf SSL configuration
3479 * \param profile Profile to use
3480 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003481void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
3482 const mbedtls_x509_crt_profile *profile);
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003483
3484/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003485 * \brief Set the data required to verify peer certificate
3486 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02003487 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02003488 * parameters ca_chain (maps to trust_ca for that function)
3489 * and ca_crl.
3490 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003491 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003492 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00003493 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00003494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003495void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003496 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01003497 mbedtls_x509_crl *ca_crl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003498
Glenn Strauss999ef702022-03-11 01:37:23 -05003499#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3500/**
3501 * \brief Set DN hints sent to client in CertificateRequest message
3502 *
3503 * \note If not set, subject distinguished names (DNs) are taken
3504 * from \c mbedtls_ssl_conf_ca_chain()
3505 * or \c mbedtls_ssl_set_hs_ca_chain())
3506 *
3507 * \param conf SSL configuration
3508 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3509 * from which the client should select client peer certificate.
3510 */
3511static inline
Gilles Peskine449bd832023-01-11 14:50:10 +01003512void mbedtls_ssl_conf_dn_hints(mbedtls_ssl_config *conf,
3513 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05003514{
3515 conf->MBEDTLS_PRIVATE(dn_hints) = crt;
3516}
3517#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3518
Hanno Becker8bf74f32019-03-27 11:01:30 +00003519#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3520/**
3521 * \brief Set the trusted certificate callback.
3522 *
3523 * This API allows to register the set of trusted certificates
3524 * through a callback, instead of a linked list as configured
3525 * by mbedtls_ssl_conf_ca_chain().
3526 *
3527 * This is useful for example in contexts where a large number
3528 * of CAs are used, and the inefficiency of maintaining them
3529 * in a linked list cannot be tolerated. It is also useful when
3530 * the set of trusted CAs needs to be modified frequently.
3531 *
3532 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
3533 * more information.
3534 *
3535 * \param conf The SSL configuration to register the callback with.
3536 * \param f_ca_cb The trusted certificate callback to use when verifying
3537 * certificate chains.
3538 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
3539 * a reference to a trusted CA database).
3540 *
3541 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
3542 * Any call to this function overwrites the values set through
3543 * earlier calls to mbedtls_ssl_conf_ca_chain() or
3544 * mbedtls_ssl_conf_ca_cb().
3545 *
3546 * \note This API is incompatible with CA indication in
3547 * CertificateRequest messages: A server-side SSL context which
3548 * is bound to an SSL configuration that uses a CA callback
3549 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
3550 * client authentication, will send an empty CA list in the
3551 * corresponding CertificateRequest message.
3552 *
3553 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
3554 * If an SSL context is bound to an SSL configuration which uses
3555 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
3556 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
3557 *
3558 * \note The use of this API disables the use of restartable ECC
3559 * during X.509 CRT signature verification (but doesn't affect
3560 * other uses).
3561 *
3562 * \warning This API is incompatible with the use of CRLs. Any call to
3563 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
3564 * earlier calls to mbedtls_ssl_conf_ca_chain().
3565 *
3566 * \warning In multi-threaded environments, the callback \p f_ca_cb
3567 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01003568 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00003569 * contained in the callback context pointed to by \p p_ca_cb).
3570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003571void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
3572 mbedtls_x509_crt_ca_cb_t f_ca_cb,
3573 void *p_ca_cb);
Hanno Becker8bf74f32019-03-27 11:01:30 +00003574#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
3575
Paul Bakker5121ce52009-01-03 21:22:43 +00003576/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003577 * \brief Set own certificate chain and private key
3578 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003579 * \note own_cert should contain in order from the bottom up your
3580 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003581 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00003582 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003583 * \note On server, this function can be called multiple times to
3584 * provision more than one cert/key pair (eg one ECDSA, one
3585 * RSA with SHA-256, one RSA with SHA-1). An adequate
3586 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01003587 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003588 * adequate, preference is given to the one set by the first
3589 * call to this function, then second, etc.
3590 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003591 * \note On client, only the first call has any effect. That is,
3592 * only one client certificate can be provisioned. The
bootstrap-prime6dbbf442022-05-17 19:30:44 -04003593 * server's preferences in its CertificateRequest message will
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003594 * be ignored and our only cert will be sent regardless of
3595 * whether it matches those preferences - the server can then
3596 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003597 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003598 * \note The provided \p pk_key needs to match the public key in the
3599 * first certificate in \p own_cert, or all handshakes using
3600 * that certificate will fail. It is your responsibility
3601 * to ensure that; this function will not perform any check.
3602 * You may use mbedtls_pk_check_pair() in order to perform
3603 * this check yourself, but be aware that this function can
3604 * be computationally expensive on some key types.
3605 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02003606 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003607 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02003608 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003609 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003610 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00003611 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003612int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003613 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01003614 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003615#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00003616
Ronald Cron73fe8df2022-10-05 14:31:43 +02003617#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003618/**
Hanno Becker196739b2021-05-28 05:25:46 +01003619 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01003620 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003621 *
Hanno Becker196739b2021-05-28 05:25:46 +01003622 * Only one PSK can be registered, through either
3623 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3624 * If you attempt to register more than one PSK, this function
3625 * fails, though this may change in future versions, which
3626 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003627 *
3628 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003629 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003630 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003631 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
3632 * takes precedence over a PSK configured by this function.
3633 *
Hanno Becker02283042018-10-22 15:28:02 +01003634 * \param conf The SSL configuration to register the PSK with.
3635 * \param psk The pointer to the pre-shared key to use.
3636 * \param psk_len The length of the pre-shared key in bytes.
3637 * \param psk_identity The pointer to the pre-shared key identity.
3638 * \param psk_identity_len The length of the pre-shared key identity
3639 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02003640 *
Hanno Becker02283042018-10-22 15:28:02 +01003641 * \note The PSK and its identity are copied internally and
3642 * hence need not be preserved by the caller for the lifetime
3643 * of the SSL configuration.
3644 *
3645 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003646 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003647 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003648 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003649 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003650int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
3651 const unsigned char *psk, size_t psk_len,
3652 const unsigned char *psk_identity, size_t psk_identity_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003653
Hanno Becker02283042018-10-22 15:28:02 +01003654#if defined(MBEDTLS_USE_PSA_CRYPTO)
3655/**
Hanno Becker946c9252021-04-19 21:41:47 +01003656 * \brief Configure one or more opaque pre-shared keys (PSKs) and
3657 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01003658 *
Hanno Becker196739b2021-05-28 05:25:46 +01003659 * Only one PSK can be registered, through either
3660 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3661 * If you attempt to register more than one PSK, this function
3662 * fails, though this may change in future versions, which
3663 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01003664 *
3665 * \note This is mainly useful for clients. Servers will usually
3666 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
3667 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003668 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
3669 * the PSK callback takes precedence over an opaque PSK
3670 * configured by this function.
3671 *
Hanno Becker02283042018-10-22 15:28:02 +01003672 * \param conf The SSL configuration to register the PSK with.
3673 * \param psk The identifier of the key slot holding the PSK.
3674 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00003675 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05003676 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00003677 * allows its use for the key derivation algorithm applied
3678 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01003679 * \param psk_identity The pointer to the pre-shared key identity.
3680 * \param psk_identity_len The length of the pre-shared key identity
3681 * in bytes.
3682 *
3683 * \note The PSK identity hint is copied internally and hence need
3684 * not be preserved by the caller for the lifetime of the
3685 * SSL configuration.
3686 *
3687 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003688 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003689 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003690 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01003691 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003692int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
3693 mbedtls_svc_key_id_t psk,
3694 const unsigned char *psk_identity,
3695 size_t psk_identity_len);
Hanno Becker02283042018-10-22 15:28:02 +01003696#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02003697
3698/**
Hanno Becker02283042018-10-22 15:28:02 +01003699 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003700 *
3701 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01003702 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003703 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003704 * \note A PSK set by this function takes precedence over a PSK
3705 * configured by \c mbedtls_ssl_conf_psk().
3706 *
Hanno Becker02283042018-10-22 15:28:02 +01003707 * \param ssl The SSL context to configure a PSK for.
3708 * \param psk The pointer to the pre-shared key.
3709 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003710 *
Hanno Becker02283042018-10-22 15:28:02 +01003711 * \return \c 0 if successful.
3712 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003713 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003714int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
3715 const unsigned char *psk, size_t psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003716
Hanno Becker02283042018-10-22 15:28:02 +01003717#if defined(MBEDTLS_USE_PSA_CRYPTO)
3718/**
3719 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
3720 *
3721 * \note This should only be called inside the PSK callback,
3722 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
3723 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003724 * \note An opaque PSK set by this function takes precedence over an
3725 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
3726 *
Hanno Becker02283042018-10-22 15:28:02 +01003727 * \param ssl The SSL context to configure a PSK for.
3728 * \param psk The identifier of the key slot holding the PSK.
3729 * For the duration of the current handshake, the key slot
3730 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05003731 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01003732 * use for the key derivation algorithm
3733 * applied in the handshake.
Gilles Peskine449bd832023-01-11 14:50:10 +01003734 *
Hanno Becker02283042018-10-22 15:28:02 +01003735 * \return \c 0 if successful.
3736 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
3737 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003738int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
3739 mbedtls_svc_key_id_t psk);
Hanno Becker02283042018-10-22 15:28:02 +01003740#endif /* MBEDTLS_USE_PSA_CRYPTO */
3741
Jerry Yu8897c072022-08-12 13:56:53 +08003742#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003743/**
3744 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02003745 *
3746 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01003747 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01003748 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02003749 * receive the actual PSK data and length.
3750 *
Hanno Becker02283042018-10-22 15:28:02 +01003751 * The callback has the following parameters:
3752 * - \c void*: The opaque pointer \p p_psk.
3753 * - \c mbedtls_ssl_context*: The SSL context to which
3754 * the operation applies.
3755 * - \c const unsigned char*: The PSK identity
3756 * selected by the client.
3757 * - \c size_t: The length of the PSK identity
3758 * selected by the client.
3759 *
Paul Bakker6db455e2013-09-18 17:29:31 +02003760 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01003761 * \c mbedtls_ssl_set_hs_psk() or
3762 * \c mbedtls_ssl_set_hs_psk_opaque()
3763 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02003764 * Any other return value will result in a denied PSK identity.
3765 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003766 * \note A dynamic PSK (i.e. set by the PSK callback) takes
3767 * precedence over a static PSK (i.e. set by
3768 * \c mbedtls_ssl_conf_psk() or
3769 * \c mbedtls_ssl_conf_psk_opaque()).
3770 * This means that if you set a PSK callback using this
3771 * function, you don't need to set a PSK using
3772 * \c mbedtls_ssl_conf_psk() or
3773 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003774 *
Hanno Becker02283042018-10-22 15:28:02 +01003775 * \param conf The SSL configuration to register the callback with.
3776 * \param f_psk The callback for selecting and setting the PSK based
3777 * in the PSK identity chosen by the client.
3778 * \param p_psk A pointer to an opaque structure to be passed to
3779 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02003780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003781void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
3782 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3783 size_t),
3784 void *p_psk);
Jerry Yu8897c072022-08-12 13:56:53 +08003785#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cron73fe8df2022-10-05 14:31:43 +02003786#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003787
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01003788#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01003789/**
3790 * \brief Set the Diffie-Hellman public P and G values
3791 * from big-endian binary presentations.
3792 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
3793 *
3794 * \param conf SSL configuration
3795 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
3796 * \param P_len Length of DHM modulus
3797 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
3798 * \param G_len Length of DHM generator
3799 *
3800 * \return 0 if successful
3801 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003802int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
3803 const unsigned char *dhm_P, size_t P_len,
3804 const unsigned char *dhm_G, size_t G_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003805
3806/**
Paul Bakker1b57b062011-01-06 15:48:19 +00003807 * \brief Set the Diffie-Hellman public P and G values,
3808 * read from existing context (server-side only)
3809 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003810 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00003811 * \param dhm_ctx Diffie-Hellman-Merkle context
3812 *
3813 * \return 0 if successful
3814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003815int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx);
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003816#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00003817
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003818#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3819/**
3820 * \brief Set the minimum length for Diffie-Hellman parameters.
3821 * (Client-side only.)
3822 * (Default: 1024 bits.)
3823 *
3824 * \param conf SSL configuration
3825 * \param bitlen Minimum bit length of the DHM prime
3826 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003827void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
3828 unsigned int bitlen);
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003829#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3830
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003831#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01003832#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gergely Budai987bfb52014-01-19 21:48:42 +01003833/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003834 * \brief Set the allowed curves in order of preference.
Gergely Budai987bfb52014-01-19 21:48:42 +01003835 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003836 * On server: this only affects selection of the ECDHE curve;
3837 * the curves used for ECDH and ECDSA are determined by the
3838 * list of available certificates instead.
3839 *
3840 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01003841 * use. The server can override our preference order.
3842 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003843 * Both sides: limits the set of curves accepted for use in
3844 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003845 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003846 * \deprecated Superseded by mbedtls_ssl_conf_groups().
Brett Warrene0edc842021-08-17 09:53:13 +01003847 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003848 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003849 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003850 * for that. For the end-entity certificate however, the key
3851 * will be accepted only if it is allowed both by this list
3852 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01003853 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003854 * \note This list should be ordered by decreasing preference
3855 * (preferred curve first).
3856 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003857 * \note The default list is the same set of curves that
3858 * #mbedtls_x509_crt_profile_default allows, plus
3859 * ECDHE-only curves selected according to the same criteria.
Gilles Peskineb1940a72021-06-02 15:18:12 +02003860 * The order favors curves with the lowest resource usage.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003861 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003862 * \note New minor versions of Mbed TLS may extend this list,
3863 * for example if new curves are added to the library.
3864 * New minor versions of Mbed TLS will not remove items
3865 * from this list unless serious security concerns require it.
3866 * New minor versions of Mbed TLS may change the order in
3867 * keeping with the general principle of favoring the lowest
3868 * resource usage.
3869 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003870 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003871 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003872 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01003873 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003874void MBEDTLS_DEPRECATED mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3875 const mbedtls_ecp_group_id *curves);
Brett Warrene0edc842021-08-17 09:53:13 +01003876#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardf07ce3b2023-09-22 11:53:41 +02003877#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01003878
Brett Warrene0edc842021-08-17 09:53:13 +01003879/**
3880 * \brief Set the allowed groups in order of preference.
3881 *
3882 * On server: This only affects the choice of key agreement mechanism
3883 *
3884 * On client: this affects the list of groups offered for any
3885 * use. The server can override our preference order.
3886 *
3887 * Both sides: limits the set of groups accepted for use in
3888 * key sharing.
3889 *
3890 * \note This function replaces the deprecated mbedtls_ssl_conf_curves(),
3891 * which only allows ECP curves to be configured.
3892 *
3893 * \note The most recent invocation of either mbedtls_ssl_conf_curves()
3894 * or mbedtls_ssl_conf_groups() nullifies all previous invocations
3895 * of both.
3896 *
3897 * \note This list should be ordered by decreasing preference
3898 * (preferred group first).
3899 *
3900 * \note When this function is not called, a default list is used,
3901 * consisting of all supported curves at 255 bits and above,
3902 * and all supported finite fields at 2048 bits and above.
3903 * The order favors groups with the lowest resource usage.
3904 *
3905 * \note New minor versions of Mbed TLS will not remove items
3906 * from the default list unless serious security concerns require it.
3907 * New minor versions of Mbed TLS may change the order in
3908 * keeping with the general principle of favoring the lowest
3909 * resource usage.
3910 *
3911 * \param conf SSL configuration
3912 * \param groups List of allowed groups ordered by preference, terminated by 0.
3913 * Must contain valid IANA NamedGroup IDs (provided via either an integer
Xiaofei Bai746f9482021-11-12 08:53:56 +00003914 * or using MBEDTLS_TLS1_3_NAMED_GROUP_XXX macros).
Brett Warrene0edc842021-08-17 09:53:13 +01003915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003916void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3917 const uint16_t *groups);
Brett Warrene0edc842021-08-17 09:53:13 +01003918
Ronald Crone68ab4f2022-10-05 12:46:29 +02003919#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003920#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003921/**
3922 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003923 *
3924 * \note This only affects which hashes are offered and can be used
3925 * for signatures during the handshake. Hashes for message
3926 * authentication and the TLS PRF are controlled by the
3927 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
3928 * used for certificate signature are controlled by the
3929 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
3930 *
Jerry Yu2c46ca32023-10-30 17:32:20 +08003931 * \deprecated Superseded by mbedtls_ssl_conf_sig_algs().
Jerry Yu01c73562023-10-27 17:03:20 +08003932 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003933 * \note This list should be ordered by decreasing preference
3934 * (preferred hash first).
3935 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003936 * \note By default, all supported hashes whose length is at least
3937 * 256 bits are allowed. This is the same set as the default
3938 * for certificate verification
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003939 * (#mbedtls_x509_crt_profile_default).
3940 * The preference order is currently unspecified and may
3941 * change in future versions.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003942 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003943 * \note New minor versions of Mbed TLS may extend this list,
3944 * for example if new curves are added to the library.
3945 * New minor versions of Mbed TLS will not remove items
3946 * from this list unless serious security concerns require it.
3947 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003948 * \param conf SSL configuration
3949 * \param hashes Ordered list of allowed signature hashes,
3950 * terminated by \c MBEDTLS_MD_NONE.
3951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003952void MBEDTLS_DEPRECATED mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
3953 const int *hashes);
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003954#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01003955
Hanno Becker1cd6e002021-08-10 13:27:10 +01003956/**
Jerry Yu1b23bce2023-11-13 13:45:14 +08003957 * \brief Configure allowed signature algorithms for use in TLS
Hanno Becker1cd6e002021-08-10 13:27:10 +01003958 *
3959 * \param conf The SSL configuration to use.
Jerry Yu7899de82021-08-17 13:09:23 +08003960 * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms,
Jerry Yu53c4a0d2023-11-09 10:38:17 +08003961 * terminated by #MBEDTLS_TLS1_3_SIG_NONE. The list must remain
3962 * available throughout the lifetime of the conf object.
3963 * - For TLS 1.3, values of \c MBEDTLS_TLS1_3_SIG_XXXX should be
3964 * used.
3965 * - For TLS 1.2, values should be given as
3966 * "(HashAlgorithm << 8) | SignatureAlgorithm".
Hanno Becker1cd6e002021-08-10 13:27:10 +01003967 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003968void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
3969 const uint16_t *sig_algs);
Ronald Crone68ab4f2022-10-05 12:46:29 +02003970#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003971
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003972#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003973/**
Darryl Green11999bb2018-03-13 15:22:58 +00003974 * \brief Set or reset the hostname to check against the received
3975 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003976 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003977 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003978 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003979 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003980
Hanno Becker0446a392017-04-07 12:59:32 +01003981 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003982 *
Darryl Green11999bb2018-03-13 15:22:58 +00003983 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3984 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003985 * too long input hostname.
3986 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003987 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003988 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003989 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003990 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003991int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname);
Pengyu Lv918ebf32023-03-07 10:17:31 +08003992
3993/**
3994 * \brief Get the hostname that checked against the received
3995 * server certificate. It is used to set the ServerName
3996 * TLS extension, too, if that extension is enabled.
3997 * (client-side only)
3998 *
3999 * \param ssl SSL context
4000 *
4001 * \return const pointer to the hostname value
4002 */
4003static inline const char *mbedtls_ssl_get_hostname(mbedtls_ssl_context *ssl)
4004{
4005 return ssl->MBEDTLS_PRIVATE(hostname);
4006}
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01004007#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00004008
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01004009#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00004010/**
Glenn Strauss69894072022-01-24 12:58:00 -05004011 * \brief Retrieve SNI extension value for the current handshake.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004012 * Available in \c f_cert_cb of \c mbedtls_ssl_conf_cert_cb(),
4013 * this is the same value passed to \c f_sni callback of
Glenn Strauss69894072022-01-24 12:58:00 -05004014 * \c mbedtls_ssl_conf_sni() and may be used instead of
4015 * \c mbedtls_ssl_conf_sni().
4016 *
4017 * \param ssl SSL context
4018 * \param name_len pointer into which to store length of returned value.
4019 * 0 if SNI extension is not present or not yet processed.
4020 *
4021 * \return const pointer to SNI extension value.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004022 * - value is valid only when called in \c f_cert_cb
Glenn Strauss69894072022-01-24 12:58:00 -05004023 * registered with \c mbedtls_ssl_conf_cert_cb().
4024 * - value is NULL if SNI extension is not present.
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004025 * - value is not '\0'-terminated. Use \c name_len for len.
Glenn Strauss69894072022-01-24 12:58:00 -05004026 * - value must not be freed.
4027 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004028const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
4029 size_t *name_len);
Glenn Strauss69894072022-01-24 12:58:00 -05004030
4031/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02004032 * \brief Set own certificate and key for the current handshake
4033 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004034 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05004035 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02004036 *
Glenn Strauss36872db2022-01-22 05:06:31 -05004037 * \note Passing null \c own_cert clears the certificate list for
4038 * the current handshake.
4039 *
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02004040 * \param ssl SSL context
4041 * \param own_cert own public certificate chain
4042 * \param pk_key own private key
4043 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02004044 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02004045 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004046int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
4047 mbedtls_x509_crt *own_cert,
4048 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02004049
4050/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02004051 * \brief Set the data required to verify peer certificate for the
4052 * current handshake
4053 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004054 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05004055 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02004056 *
4057 * \param ssl SSL context
4058 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
4059 * \param ca_crl trusted CA CRLs
4060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004061void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
4062 mbedtls_x509_crt *ca_chain,
4063 mbedtls_x509_crl *ca_crl);
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02004064
Glenn Strauss999ef702022-03-11 01:37:23 -05004065#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
4066/**
4067 * \brief Set DN hints sent to client in CertificateRequest message
4068 *
4069 * \note Same as \c mbedtls_ssl_conf_dn_hints() but for use within
4070 * the SNI callback or the certificate selection callback.
4071 *
4072 * \param ssl SSL context
4073 * \param crt crt chain whose subject DNs are issuer DNs of client certs
4074 * from which the client should select client peer certificate.
4075 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004076void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
4077 const mbedtls_x509_crt *crt);
Glenn Strauss999ef702022-03-11 01:37:23 -05004078#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
4079
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02004080/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02004081 * \brief Set authmode for the current handshake.
4082 *
4083 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05004084 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02004085 *
4086 * \param ssl SSL context
4087 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
4088 * MBEDTLS_SSL_VERIFY_REQUIRED
4089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004090void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
4091 int authmode);
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02004092
4093/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00004094 * \brief Set server side ServerName TLS extension callback
4095 * (optional, server-side only).
4096 *
4097 * If set, the ServerName callback is called whenever the
4098 * server receives a ServerName TLS extension from the client
4099 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004100 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00004101 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02004102 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02004103 * certificate(s) and key(s) to use with \c
4104 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02004105 * and may optionally adjust the CA and associated CRL with \c
4106 * mbedtls_ssl_set_hs_ca_chain() as well as the client
4107 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
4108 * then must return 0. If no matching name is found, the
Glenn Strauss0ebf24a2022-01-24 18:30:13 -05004109 * callback may return non-zero to abort the handshake.
Paul Bakker5701cdc2012-09-27 21:49:42 +00004110 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004111 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00004112 * \param f_sni verification function
4113 * \param p_sni verification parameter
4114 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004115void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
4116 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
4117 size_t),
4118 void *p_sni);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004119#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00004120
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004121#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02004122/**
4123 * \brief Set the EC J-PAKE password for current handshake.
4124 *
4125 * \note An internal copy is made, and destroyed as soon as the
4126 * handshake is completed, or when the SSL context is reset or
4127 * freed.
4128 *
4129 * \note The SSL context needs to be already set up. The right place
4130 * to call this function is between \c mbedtls_ssl_setup() or
4131 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settiaca21b72022-11-17 18:17:01 +01004132 * Password cannot be empty (see RFC 8236).
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02004133 *
4134 * \param ssl SSL context
Valerio Settiaca21b72022-11-17 18:17:01 +01004135 * \param pw EC J-PAKE password (pre-shared secret). It cannot be empty
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02004136 * \param pw_len length of pw in bytes
4137 *
4138 * \return 0 on success, or a negative error code.
4139 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004140int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
4141 const unsigned char *pw,
4142 size_t pw_len);
Valerio Settia9a97dc2022-11-28 18:26:16 +01004143
4144/**
4145 * \brief Set the EC J-PAKE opaque password for current handshake.
4146 *
Valerio Settic689ed82022-12-07 14:40:38 +01004147 * \note The key must remain valid until the handshake is over.
Valerio Settia9a97dc2022-11-28 18:26:16 +01004148 *
4149 * \note The SSL context needs to be already set up. The right place
4150 * to call this function is between \c mbedtls_ssl_setup() or
4151 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settia9a97dc2022-11-28 18:26:16 +01004152 *
4153 * \param ssl SSL context
4154 * \param pwd EC J-PAKE opaque password
4155 *
4156 * \return 0 on success, or a negative error code.
4157 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004158int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
4159 mbedtls_svc_key_id_t pwd);
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02004160#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02004161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004162#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02004163/**
4164 * \brief Set the supported Application Layer Protocols.
4165 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004166 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00004167 * \param protos Pointer to a NULL-terminated list of supported protocols,
4168 * in decreasing preference order. The pointer to the list is
4169 * recorded by the library for later reference as required, so
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004170 * the lifetime of the table must be at least as long as the
Aaron Jonesd96e5262016-06-17 14:40:41 +00004171 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02004172 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004173 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02004174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004175int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos);
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02004176
4177/**
4178 * \brief Get the name of the negotiated Application Layer Protocol.
4179 * This function should be called after the handshake is
4180 * completed.
4181 *
4182 * \param ssl SSL context
4183 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004184 * \return Protocol name, or NULL if no protocol was negotiated.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02004185 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004186const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004187#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02004188
Johan Pascalb62bb512015-12-03 21:56:45 +01004189#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02004190#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01004191static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile)
Johan Pascala455cd92020-09-22 15:28:11 +02004192{
Gilles Peskine449bd832023-01-11 14:50:10 +01004193 switch (profile) {
Johan Pascala455cd92020-09-22 15:28:11 +02004194 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01004195 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02004196 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01004197 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02004198 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01004199 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02004200 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01004201 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02004202 default: break;
4203 }
Gilles Peskine449bd832023-01-11 14:50:10 +01004204 return "";
Johan Pascala455cd92020-09-22 15:28:11 +02004205}
4206#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01004207/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02004208 * \brief Manage support for mki(master key id) value
4209 * in use_srtp extension.
4210 * MKI is an optional part of SRTP used for key management
4211 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02004212 * The default value is
4213 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02004214 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02004215 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02004216 * \param support_mki_value Enable or disable mki usage. Values are
4217 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
4218 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02004219 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004220void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
4221 int support_mki_value);
Ron Eldor591f1622018-01-22 12:30:04 +02004222
4223/**
Johan Pascalb62bb512015-12-03 21:56:45 +01004224 * \brief Set the supported DTLS-SRTP protection profiles.
4225 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07004226 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02004227 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
4228 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01004229 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02004230 * The pointer to the list is recorded by the library
4231 * for later reference as required, so the lifetime
4232 * of the table must be at least as long as the lifetime
4233 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02004234 * The list must not hold more than
4235 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02004236 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01004237 *
Johan Pascal85269572020-08-25 10:01:54 +02004238 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02004239 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
4240 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01004241 */
Ron Eldora9788042018-12-05 11:04:31 +02004242int mbedtls_ssl_conf_dtls_srtp_protection_profiles
Gilles Peskine449bd832023-01-11 14:50:10 +01004243 (mbedtls_ssl_config *conf,
4244 const mbedtls_ssl_srtp_profile *profiles);
Ron Eldor591f1622018-01-22 12:30:04 +02004245
4246/**
Ron Eldora9788042018-12-05 11:04:31 +02004247 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02004248 *
Ron Eldora9788042018-12-05 11:04:31 +02004249 * \param ssl SSL context to use.
4250 * \param mki_value The MKI value to set.
4251 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02004252 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004253 * \note This function is relevant on client side only.
4254 * The server discovers the mki value during handshake.
4255 * A mki value set on server side using this function
4256 * is ignored.
4257 *
Johan Pascal85269572020-08-25 10:01:54 +02004258 * \return 0 on success
4259 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
4260 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02004261 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004262int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
4263 unsigned char *mki_value,
4264 uint16_t mki_len);
Johan Pascalb62bb512015-12-03 21:56:45 +01004265/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004266 * \brief Get the negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004267 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004268 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004269 * \warning This function must be called after the handshake is
4270 * completed. The value returned by this function must
4271 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01004272 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004273 * \param ssl The SSL context to query.
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004274 * \param dtls_srtp_info The negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004275 * - Protection profile in use.
4276 * A direct mapping of the iana defined value for protection
4277 * profile on an uint16_t.
4278 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
4279 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
4280 * or peer's Hello packet was not parsed yet.
4281 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01004282 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004283void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
4284 mbedtls_dtls_srtp_info *dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01004285#endif /* MBEDTLS_SSL_DTLS_SRTP */
4286
Glenn Straussd09b3432022-04-11 13:58:11 -04004287#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Paul Bakker5701cdc2012-09-27 21:49:42 +00004288/**
Paul Bakker490ecc82011-10-06 13:04:09 +00004289 * \brief Set the maximum supported version sent from the client side
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004290 * and/or accepted at the server side.
4291 *
4292 * See also the documentation of mbedtls_ssl_conf_min_version().
Paul Bakker2fbefde2013-06-29 16:01:15 +02004293 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02004294 * \note This ignores ciphersuites from higher versions.
4295 *
Glenn Straussd09b3432022-04-11 13:58:11 -04004296 * \note This function is deprecated and has been replaced by
4297 * \c mbedtls_ssl_conf_max_tls_version().
4298 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004299 * \param conf SSL configuration
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004300 * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3)
4301 * \param minor Minor version number
4302 * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2,
4303 * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3)
Paul Bakker490ecc82011-10-06 13:04:09 +00004304 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004305void MBEDTLS_DEPRECATED mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major,
4306 int minor);
Glenn Straussd09b3432022-04-11 13:58:11 -04004307#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker490ecc82011-10-06 13:04:09 +00004308
Paul Bakker1d29fb52012-09-28 13:28:45 +00004309/**
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004310 * \brief Set the maximum supported version sent from the client side
4311 * and/or accepted at the server side.
4312 *
4313 * \note After the handshake, you can call
4314 * mbedtls_ssl_get_version_number() to see what version was
4315 * negotiated.
4316 *
4317 * \param conf SSL configuration
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004318 * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004319 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4320 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004321static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf,
4322 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004323{
4324 conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version;
4325}
4326
Glenn Straussd09b3432022-04-11 13:58:11 -04004327#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004328/**
Paul Bakker1d29fb52012-09-28 13:28:45 +00004329 * \brief Set the minimum accepted SSL/TLS protocol version
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004330 *
4331 * \note By default, all supported versions are accepted.
4332 * Future versions of the library may disable older
4333 * protocol versions by default if they become deprecated.
4334 *
4335 * \note The following versions are supported (if enabled at
4336 * compile time):
4337 * - (D)TLS 1.2: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3,
4338 * \p minor = #MBEDTLS_SSL_MINOR_VERSION_3
4339 * - TLS 1.3: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3,
4340 * \p minor = #MBEDTLS_SSL_MINOR_VERSION_4
4341 *
4342 * Note that the numbers in the constant names are the
4343 * TLS internal protocol numbers, and the minor versions
4344 * differ by one from the human-readable versions!
Paul Bakkerd2f068e2013-08-27 21:19:20 +02004345 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01004346 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
4347 * SSL_MIN_XXXXX_VERSION range is ignored.
4348 *
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004349 * \note After the handshake, you can call
Gilles Peskinece4f00d2022-02-12 00:47:23 +01004350 * mbedtls_ssl_get_version_number() to see what version was
4351 * negotiated.
4352 *
Glenn Straussd09b3432022-04-11 13:58:11 -04004353 * \note This function is deprecated and has been replaced by
4354 * \c mbedtls_ssl_conf_min_tls_version().
4355 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004356 * \param conf SSL configuration
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004357 * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3)
4358 * \param minor Minor version number
4359 * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2,
4360 * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3)
Paul Bakker1d29fb52012-09-28 13:28:45 +00004361 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004362void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major,
4363 int minor);
Glenn Straussd09b3432022-04-11 13:58:11 -04004364#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00004365
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004366/**
4367 * \brief Set the minimum supported version sent from the client side
4368 * and/or accepted at the server side.
4369 *
4370 * \note After the handshake, you can call
4371 * mbedtls_ssl_get_version_number() to see what version was
4372 * negotiated.
4373 *
4374 * \param conf SSL configuration
Andrzej Kurek00b54e62023-05-06 09:38:57 -04004375 * \param tls_version TLS protocol version number (\c mbedtls_ssl_protocol_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004376 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004378static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf,
4379 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004380{
4381 conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version;
4382}
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004384#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004385/**
4386 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004387 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004388 *
4389 * \note This should always be enabled, it is a security
4390 * improvement, and should not cause any interoperability
4391 * issue (used only if the peer supports it too).
4392 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004393 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004394 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004396void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004397#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004398
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004399#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004400/**
4401 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004402 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004403 *
4404 * \note This should always be enabled, it is a security fix to the
4405 * protocol, and should not cause any interoperability issue
4406 * (used only if the peer supports it too).
4407 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004408 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004409 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004410 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004411void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004412#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004413
Janos Follath088ce432017-04-10 12:42:31 +01004414#if defined(MBEDTLS_SSL_SRV_C)
4415/**
4416 * \brief Whether to send a list of acceptable CAs in
4417 * CertificateRequest messages.
4418 * (Default: do send)
4419 *
4420 * \param conf SSL configuration
4421 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
4422 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
4423 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004424void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
4425 char cert_req_ca_list);
Janos Follath088ce432017-04-10 12:42:31 +01004426#endif /* MBEDTLS_SSL_SRV_C */
4427
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004428#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00004429/**
k-stachowiak6d722122019-02-08 17:03:33 +01004430 * \brief Set the maximum fragment length to emit and/or negotiate.
4431 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
4432 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004433 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01004434 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004435 * (Client: set maximum fragment length to emit *and*
4436 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02004437 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004438 *
k-stachowiak6d722122019-02-08 17:03:33 +01004439 * \note On the client side, the maximum fragment length extension
4440 * *will not* be used, unless the maximum fragment length has
4441 * been set via this function to a value different than
4442 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004443 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004444 * \note With TLS, this currently only affects ApplicationData (sent
4445 * with \c mbedtls_ssl_read()), not handshake messages.
4446 * With DTLS, this affects both ApplicationData and handshake.
4447 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02004448 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004449 * excluding record overhead that will be added to it, see
4450 * \c mbedtls_ssl_get_record_expansion().
4451 *
4452 * \note For DTLS, it is also possible to set a limit for the total
Tom Cosgrove1e211442022-05-26 11:51:00 +01004453 * size of datagrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02004454 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004455 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01004456 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02004457 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004458 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
4459 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004460 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02004461 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004462 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004463int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004464#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004465
TRodziewicz8476f2f2021-06-02 14:34:47 +02004466#if defined(MBEDTLS_SSL_SRV_C)
4467/**
TRodziewicz3946f792021-06-14 12:11:18 +02004468 * \brief Pick the ciphersuites order according to the second parameter
4469 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
4470 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004471 *
4472 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02004473 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
4474 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004475 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004476void mbedtls_ssl_conf_preference_order(mbedtls_ssl_config *conf, int order);
TRodziewicz8476f2f2021-06-02 14:34:47 +02004477#endif /* MBEDTLS_SSL_SRV_C */
4478
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004479#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4480 defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02004481/**
Ronald Crond67f8012024-08-28 07:45:57 +02004482 * \brief Enable / Disable TLS 1.2 session tickets (client and TLS 1.2 only).
4483 * Disabled by default.
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004484 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004485 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004486 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01004487 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004488 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
4489 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004490 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004491void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets);
Ronald Cronbedddd72024-08-27 14:18:50 +02004492
Ronald Crond67f8012024-08-28 07:45:57 +02004493/**
4494 * \brief Get if TLS 1.2 session tickets usage is enabled or not
4495 *
4496 * \param conf SSL configuration
4497 *
4498 * \return MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
4499 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED
4500 */
4501int mbedtls_ssl_conf_get_session_tickets(const mbedtls_ssl_config *conf);
4502
Ronald Cronbedddd72024-08-27 14:18:50 +02004503#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
4504/**
Ronald Crone55659d2024-08-27 19:23:51 +02004505 * \brief Enable / Disable handling of TLS 1.3 NewSessionTicket messages (client and TLS 1.3 only).
4506 *
4507 * The handling of TLS 1.3 NewSessionTicket messages is disabled by
4508 * default.
4509 *
4510 * Contrary to TLS 1.2 tickets, the default value is disabled in Mbed TLS
4511 * 3.6.x for backward compatibility with applications based on the Mbed TLS
4512 * client in the default configuration connecting to TLS 1.3 servers
4513 * supporting NewSessionTicket messages.
4514 *
4515 * Up to Mbed TLS 3.5, in the default configuration TLS 1.3 was
4516 * disabled, and an Mbed TLS client in the default configuration would
4517 * establish a TLS 1.2 connection with a TLS 1.2 and TLS 1.3 capable
4518 * server.
4519 *
4520 * Starting with Mbed TLS 3.6.0, TLS 1.3 is enabled by default, and thus
4521 * an Mbed TLS client in the default configuration establishes a TLS 1.3
4522 * connection with a TLS 1.2 and TLS 1.3 capable server. If following
4523 * the handshake the TLS 1.3 server sends NewSessionTicket messages and
4524 * the Mbed TLS client processes them, this results in Mbed TLS high
4525 * level APIs (mbedtls_ssl_read(), mbedtls_ssl_handshake(), ...) to
4526 * eventually return an #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET non
4527 * fatal error code (see the documentation of that error code for more
4528 * information). Applications unaware of that TLS 1.3 specific non fatal
4529 * error code are then failing.
Ronald Cronbedddd72024-08-27 14:18:50 +02004530 *
4531 * \param conf SSL configuration
Ronald Crond67f8012024-08-28 07:45:57 +02004532 * \param use_new_session_tickets Enable or disable
4533 * (MBEDTLS_SSL_NEW_SESSION_TICKETS_ENABLED or
4534 * MBEDTLS_SSL_NEW_SESSION_TICKETS_DISABLED)
Ronald Cronbedddd72024-08-27 14:18:50 +02004535 */
4536void mbedtls_ssl_conf_enable_new_session_tickets(mbedtls_ssl_config *conf,
Ronald Crond67f8012024-08-28 07:45:57 +02004537 int use_new_session_tickets);
4538
4539/**
4540 * \brief Get if usage of TLS 1.3 NewSessionTicket messages is enabled or not
4541 *
4542 * \param conf SSL configuration
4543 *
4544 * \return MBEDTLS_SSL_NEW_SESSION_TICKETS_ENABLED or
4545 * MBEDTLS_SSL_NEW_SESSION_TICKETS_DISABLED
4546 */
4547int mbedtls_ssl_conf_is_new_session_tickets_enabled(const mbedtls_ssl_config *conf);
4548
Ronald Cronbedddd72024-08-27 14:18:50 +02004549#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004550#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4551 MBEDTLS_SSL_CLI_C */
4552
4553#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4554 defined(MBEDTLS_SSL_SRV_C) && \
4555 defined(MBEDTLS_SSL_PROTO_TLS1_3)
4556/**
Jerry Yuba627bf2022-09-23 09:58:22 +08004557 * \brief Number of NewSessionTicket messages for the server to send
4558 * after handshake completion.
4559 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004560 * \note The default value is
Jerry Yuba627bf2022-09-23 09:58:22 +08004561 * \c MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS.
4562 *
4563 * \note In case of a session resumption, this setting only partially apply.
4564 * At most one ticket is sent in that case to just renew the pool of
4565 * tickets of the client. The rationale is to avoid the number of
4566 * tickets on the server to become rapidly out of control when the
4567 * server has the same configuration for all its connection instances.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004568 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004569 * \param conf SSL configuration
4570 * \param num_tickets Number of NewSessionTicket.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004571 *
4572 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004573void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
4574 uint16_t num_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004575#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4576 MBEDTLS_SSL_SRV_C &&
4577 MBEDTLS_SSL_PROTO_TLS1_3*/
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004579#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004580/**
Paul Bakker09f097d2012-10-23 11:54:56 +00004581 * \brief Enable / Disable renegotiation support for connection when
4582 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004583 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00004584 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004585 * \warning It is recommended to always disable renegotiation unless you
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004586 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00004587 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004588 * renegotiation or a poor understanding of its properties.
4589 *
4590 * \note Server-side, enabling renegotiation also makes the server
4591 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00004592 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004593 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004594 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
4595 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00004596 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004597void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004598#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004599
4600/**
4601 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004602 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02004603 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004604 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004605 * be established even if the peer does not support
4606 * secure renegotiation, but does not allow renegotiation
4607 * to take place if not secure.
4608 * (Interoperable and secure option)
4609 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004610 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004611 * with non-upgraded peers. Allowing legacy renegotiation
4612 * makes the connection vulnerable to specific man in the
4613 * middle attacks. (See RFC 5746)
4614 * (Most interoperable and least secure option)
4615 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004616 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004617 * if peer does not support secure renegotiation. Results
4618 * in interoperability issues with non-upgraded peers
4619 * that do not support renegotiation altogether.
4620 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00004621 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004622 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00004623 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
4624 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004625 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00004626 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004627void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy);
Paul Bakker48916f92012-09-16 19:57:18 +00004628
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004629#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004630/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004631 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004632 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004633 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004634 * When we request a renegotiation, the peer can comply or
4635 * ignore the request. This function allows us to decide
4636 * whether to enforce our renegotiation requests by closing
4637 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004638 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004639 * However, records could already be in transit from the peer
4640 * when the request is emitted. In order to increase
4641 * reliability, we can accept a number of records before the
4642 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004643 *
4644 * The optimal value is highly dependent on the specific usage
4645 * scenario.
4646 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004647 * \note With DTLS and server-initiated renegotiation, the
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004648 * HelloRequest is retransmitted every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004649 * out or receives Application Data, until:
4650 * - max_records records have beens seen, if it is >= 0, or
4651 * - the number of retransmits that would happen during an
4652 * actual handshake has been reached.
4653 * Please remember the request might be lost a few times
4654 * if you consider setting max_records to a really low value.
4655 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004656 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004657 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004658 * which always behave as if max_record was 0. The reason is,
4659 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004660 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004661 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004662 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004663 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004664 * enforce renegotiation, or a non-negative value to enforce
4665 * it but allow for a grace period of max_records records.
4666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004667void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records);
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004668
4669/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004670 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00004671 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004672 *
4673 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01004674 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004675 * threshold. The default value is meant to prevent the
4676 * connection from being closed when the counter is about to
4677 * reached its maximal value (it is not allowed to wrap).
4678 *
4679 * Lower values can be used to enforce policies such as "keys
4680 * must be refreshed every N packets with cipher X".
4681 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00004682 * The renegotiation period can be disabled by setting
4683 * conf->disable_renegotiation to
4684 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
4685 *
4686 * \note When the configured transport is
4687 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
4688 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
4689 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00004690 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004691 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004692 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004693 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004694void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
4695 const unsigned char period[8]);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004696#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00004697
Paul Bakker43ca69c2011-01-15 17:35:19 +00004698/**
Hanno Becker8b170a02017-10-10 11:51:19 +01004699 * \brief Check if there is data already read from the
4700 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004701 *
4702 * \param ssl SSL context
4703 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004704 * \return 0 if nothing's pending, 1 otherwise.
4705 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004706 * \note This is different in purpose and behaviour from
4707 * \c mbedtls_ssl_get_bytes_avail in that it considers
4708 * any kind of unprocessed data, not only unread
4709 * application data. If \c mbedtls_ssl_get_bytes
4710 * returns a non-zero value, this function will
4711 * also signal pending data, but the converse does
4712 * not hold. For example, in DTLS there might be
4713 * further records waiting to be processed from
4714 * the current underlying transport's datagram.
4715 *
Hanno Becker9b19a122017-10-31 13:00:14 +00004716 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01004717 * does not imply that a subsequent call to
4718 * \c mbedtls_ssl_read will provide any data;
4719 * e.g., the unprocessed data might turn out
4720 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00004721 *
4722 * \note This function is useful in the following situation:
4723 * If the SSL/TLS module successfully returns from an
4724 * operation - e.g. a handshake or an application record
4725 * read - and you're awaiting incoming data next, you
4726 * must not immediately idle on the underlying transport
4727 * to have data ready, but you need to check the value
4728 * of this function first. The reason is that the desired
4729 * data might already be read but not yet processed.
4730 * If, in contrast, a previous call to the SSL/TLS module
4731 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
4732 * to call this function, as the latter error code entails
4733 * that all internal data has been processed.
4734 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004735 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004736int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl);
Hanno Becker8b170a02017-10-10 11:51:19 +01004737
4738/**
4739 * \brief Return the number of application data bytes
4740 * remaining to be read from the current record.
4741 *
4742 * \param ssl SSL context
4743 *
4744 * \return How many bytes are available in the application
4745 * data record read buffer.
4746 *
4747 * \note When working over a datagram transport, this is
4748 * useful to detect the current datagram's boundary
4749 * in case \c mbedtls_ssl_read has written the maximal
4750 * amount of data fitting into the input buffer.
4751 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004753size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004754
4755/**
4756 * \brief Return the result of the certificate verification
4757 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004758 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00004759 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004760 * \return \c 0 if the certificate verification was successful.
4761 * \return \c -1u if the result is not available. This may happen
4762 * e.g. if the handshake aborts early, or a verification
4763 * callback returned a fatal error.
4764 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
4765 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00004766 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004767uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004768
4769/**
Glenn Strauss8f526902022-01-13 00:04:49 -05004770 * \brief Return the id of the current ciphersuite
4771 *
4772 * \param ssl SSL context
4773 *
4774 * \return a ciphersuite id
4775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004776int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl);
Glenn Strauss8f526902022-01-13 00:04:49 -05004777
4778/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00004779 * \brief Return the name of the current ciphersuite
4780 *
4781 * \param ssl SSL context
4782 *
4783 * \return a string containing the ciphersuite name
4784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004785const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004786
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004787
4788/**
4789 * \brief Return the (D)TLS protocol version negotiated in the
4790 * given connection.
4791 *
Gilles Peskined44e0502022-02-12 00:45:21 +01004792 * \note If you call this function too early during the initial
4793 * handshake, before the two sides have agreed on a version,
4794 * this function returns #MBEDTLS_SSL_VERSION_UNKNOWN.
4795 *
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004796 * \param ssl The SSL context to query.
4797 * \return The negotiated protocol version.
4798 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04004799static inline mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(
Gilles Peskine449bd832023-01-11 14:50:10 +01004800 const mbedtls_ssl_context *ssl)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004801{
4802 return ssl->MBEDTLS_PRIVATE(tls_version);
4803}
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004804
Paul Bakker5121ce52009-01-03 21:22:43 +00004805/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004806 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004807 *
4808 * \param ssl SSL context
4809 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004810 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004811 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004812const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004813
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004814/**
4815 * \brief Return the (maximum) number of bytes added by the record
4816 * layer: header + encryption/MAC overhead (inc. padding)
4817 *
4818 * \param ssl SSL context
4819 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01004820 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004821 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004822int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004823
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004824/**
4825 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004826 *
4827 * \note The logic to determine the maximum outgoing record payload is
4828 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004829 * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004830 * such as the max fragment length or record size limit extension if
4831 * used, and for DTLS the path MTU as configured and current
4832 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004833 *
4834 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
4835 * called with a larger length value.
4836 * With TLS, \c mbedtls_ssl_write() will fragment the input if
4837 * necessary and return the number of bytes written; it is up
4838 * to the caller to call \c mbedtls_ssl_write() again in
4839 * order to send the remaining bytes if any.
4840 *
Hanno Becker80d163d2021-04-21 06:28:18 +01004841 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004842 * \sa mbedtls_ssl_get_record_expansion()
4843 *
4844 * \param ssl SSL context
4845 *
4846 * \return Current maximum payload for an outgoing record,
4847 * or a negative error code.
4848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004849int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004850
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004851/**
4852 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004853 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004854 * \note The logic to determine the maximum incoming record payload is
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004855 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004856 * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004857 * such as the max fragment length extension or record size limit
4858 * extension if used, and the current record expansion.
4859 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004860 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01004861 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004862 * \sa mbedtls_ssl_get_record_expansion()
4863 *
4864 * \param ssl SSL context
4865 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004866 * \return Current maximum payload for an incoming record,
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004867 * or a negative error code.
4868 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004869int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004871#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00004872/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004873 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004874 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004875 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004876 *
Hanno Becker958efeb2019-02-25 10:13:43 +00004877 * \return The current peer certificate, if available.
4878 * The returned certificate is owned by the SSL context and
4879 * is valid only until the next call to the SSL API.
4880 * \return \c NULL if no peer certificate is available. This might
4881 * be because the chosen ciphersuite doesn't use CRTs
4882 * (PSK-based ciphersuites, for example), or because
4883 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
4884 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004885 *
4886 * \note For one-time inspection of the peer's certificate during
4887 * the handshake, consider registering an X.509 CRT verification
4888 * callback through mbedtls_ssl_conf_verify() instead of calling
4889 * this function. Using mbedtls_ssl_conf_verify() also comes at
4890 * the benefit of allowing you to influence the verification
4891 * process, for example by masking expected and tolerated
4892 * verification failures.
4893 *
4894 * \warning You must not use the pointer returned by this function
4895 * after any further call to the SSL API, including
4896 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
4897 * because the pointer might change during renegotiation,
4898 * which happens transparently to the user.
4899 * If you want to use the certificate across API calls,
4900 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004902const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004903#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00004904
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004905#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00004906/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01004907 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004908 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004909 * \param ssl The SSL context representing the connection for which to
4910 * to export a session structure for later resumption.
4911 * \param session The target structure in which to store the exported session.
Benson Liou6d0a0932023-12-27 22:03:24 +08004912 * This must have been initialized with mbedtls_ssl_session_init()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004913 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004914 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01004915 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01004916 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01004917 * ticket-based resumption will be considered. For TLS 1.3,
Ronald Crone221f672024-04-04 15:34:22 +02004918 * sessions equate to tickets, and if session tickets are
4919 * enabled (see #MBEDTLS_SSL_SESSION_TICKETS configuration
4920 * option), this function exports the last received ticket and
4921 * the exported session may be used to resume the TLS 1.3
4922 * session. If session tickets are disabled, exported sessions
4923 * cannot be used to resume a TLS 1.3 session.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004924 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004925 * \return \c 0 if successful. In this case, \p session can be used for
4926 * session resumption by passing it to mbedtls_ssl_set_session(),
4927 * and serialized for storage via mbedtls_ssl_session_save().
Hanno Beckere810bbc2021-05-14 16:01:05 +01004928 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004929 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004930 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004931 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004932 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004933int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
4934 mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004935#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004936
4937/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004938 * \brief Perform the SSL handshake
4939 *
4940 * \param ssl SSL context
4941 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004942 * \return \c 0 if successful.
4943 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004944 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004945 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004946 * transport - in this case you must call this function again
4947 * when the underlying transport is ready for the operation.
4948 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4949 * operation is in progress (see
4950 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4951 * must call this function again when the operation is ready.
4952 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4953 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4954 * in this case you must call this function again to complete
4955 * the handshake when you're done attending other tasks.
4956 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
4957 * and the client did not demonstrate reachability yet - in
4958 * this case you must stop using the context (see below).
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02004959 * \return #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET if a TLS 1.3
Ronald Cron9df05632024-08-27 18:04:44 +02004960 * NewSessionTicket message has been received. See
4961 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET documentation
4962 * for more information.
Jerry Yu032985c2023-12-06 17:59:33 +08004963 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
4964 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01004965 * received as part of the handshake. This is server specific
4966 * and may occur only if the early data feature has been
4967 * enabled on server (see mbedtls_ssl_conf_early_data()
4968 * documentation). You must call mbedtls_ssl_read_early_data()
4969 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004970 * \return Another SSL error code - in this case you must stop using
4971 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02004972 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004973 * \warning If this function returns something other than
4974 * \c 0,
4975 * #MBEDTLS_ERR_SSL_WANT_READ,
4976 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4977 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
Jerry Yu032985c2023-12-06 17:59:33 +08004978 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02004979 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET or
Jerry Yu032985c2023-12-06 17:59:33 +08004980 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004981 * you must stop using the SSL context for reading or writing,
4982 * and either free it or call \c mbedtls_ssl_session_reset()
4983 * on it before re-using it for a new connection; the current
4984 * connection must be closed.
4985 *
4986 * \note If DTLS is in use, then you may choose to handle
4987 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
4988 * purposes, as it is an expected return value rather than an
4989 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01004990 *
4991 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004992 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004993 * from the underlying transport layer is currently being processed,
4994 * and it is safe to idle until the timer or the underlying transport
4995 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004996 * in which case the datagram of the underlying transport that is
4997 * currently being processed might or might not contain further
4998 * DTLS records.
Gilles Peskine8c2830a2022-08-04 23:37:51 +02004999 *
Gilles Peskine590bdcb2024-08-25 10:41:40 +02005000 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
Gilles Peskine8c2830a2022-08-04 23:37:51 +02005001 * subsystem must have been initialized by calling
5002 * psa_crypto_init() before calling this function.
Gilles Peskine590bdcb2024-08-25 10:41:40 +02005003 * Otherwise, the handshake may call psa_crypto_init()
Gilles Peskine92e803e2024-08-26 11:59:48 +02005004 * if a negotiation involving TLS 1.3 takes place (this may
5005 * be the case even if TLS 1.3 is offered but eventually
5006 * not selected).
Paul Bakker5121ce52009-01-03 21:22:43 +00005007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005008int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005009
5010/**
Paul Elliott93ba3e32022-03-18 21:51:13 +00005011 * \brief After calling mbedtls_ssl_handshake() to start the SSL
5012 * handshake you can call this function to check whether the
5013 * handshake is over for a given SSL context. This function
5014 * should be also used to determine when to stop calling
5015 * mbedtls_handshake_step() for that context.
5016 *
5017 * \param ssl SSL context
5018 *
5019 * \return \c 1 if handshake is over, \c 0 if it is still ongoing.
5020 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005021static inline int mbedtls_ssl_is_handshake_over(mbedtls_ssl_context *ssl)
Paul Elliott93ba3e32022-03-18 21:51:13 +00005022{
Gilles Peskine449bd832023-01-11 14:50:10 +01005023 return ssl->MBEDTLS_PRIVATE(state) >= MBEDTLS_SSL_HANDSHAKE_OVER;
Paul Elliott93ba3e32022-03-18 21:51:13 +00005024}
5025
5026/**
Paul Bakker1961b702013-01-25 14:49:24 +01005027 * \brief Perform a single step of the SSL handshake
5028 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02005029 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005030 * the next state after this function returns \c 0. Do not
Paul Elliott93ba3e32022-03-18 21:51:13 +00005031 * call this function if mbedtls_ssl_is_handshake_over()
5032 * returns \c 1.
5033 *
5034 * \warning Whilst in the past you may have used direct access to the
5035 * context state (ssl->state) in order to ascertain when to
5036 * stop calling this function and although you can still do
5037 * so with something like ssl->MBEDTLS_PRIVATE(state) or by
5038 * defining MBEDTLS_ALLOW_PRIVATE_ACCESS, this is now
5039 * considered deprecated and could be broken in any future
5040 * release. If you still find you have good reason for such
5041 * direct access, then please do contact the team to explain
5042 * this (raise an issue or post to the mailing list), so that
5043 * we can add a solution to your problem that will be
5044 * guaranteed to work in the future.
Paul Bakker1961b702013-01-25 14:49:24 +01005045 *
5046 * \param ssl SSL context
5047 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005048 * \return See mbedtls_ssl_handshake().
5049 *
5050 * \warning If this function returns something other than \c 0,
5051 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
Jerry Yu032985c2023-12-06 17:59:33 +08005052 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
5053 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02005054 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET or
Jerry Yu032985c2023-12-06 17:59:33 +08005055 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA, you must stop using
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005056 * the SSL context for reading or writing, and either free it
5057 * or call \c mbedtls_ssl_session_reset() on it before
5058 * re-using it for a new connection; the current connection
5059 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01005060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005061int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01005062
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005063#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01005064/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01005065 * \brief Initiate an SSL renegotiation on the running connection.
5066 * Client: perform the renegotiation right now.
5067 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00005068 * during the next call to mbedtls_ssl_read() if honored by
5069 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00005070 *
5071 * \param ssl SSL context
5072 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00005073 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005074 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
5075 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01005076 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005077 * \warning If this function returns something other than \c 0,
5078 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
5079 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
5080 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
5081 * the SSL context for reading or writing, and either free it
5082 * or call \c mbedtls_ssl_session_reset() on it before
5083 * re-using it for a new connection; the current connection
5084 * must be closed.
5085 *
Paul Bakker48916f92012-09-16 19:57:18 +00005086 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005087int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005088#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00005089
5090/**
Paul Bakker5121ce52009-01-03 21:22:43 +00005091 * \brief Read at most 'len' application data bytes
5092 *
5093 * \param ssl SSL context
5094 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02005095 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00005096 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005097 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02005098 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04005099 * without sending a CloseNotify beforehand, which might happen
5100 * because of various reasons (internal error of an underlying
5101 * stack, non-conformant peer not sending a CloseNotify and
5102 * such) - in this case you must stop using the context
5103 * (see below).
5104 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
5105 * transport is still functional, but the peer has
5106 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005107 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02005108 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005109 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005110 * transport - in this case you must call this function again
5111 * when the underlying transport is ready for the operation.
5112 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
5113 * operation is in progress (see
5114 * mbedtls_ssl_conf_async_private_cb()) - in this case you
5115 * must call this function again when the operation is ready.
5116 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
5117 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
5118 * in this case you must call this function again to complete
5119 * the handshake when you're done attending other tasks.
5120 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
5121 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005122 * new connection using the same source port. See below.
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02005123 * \return #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET if a TLS 1.3
Ronald Cron9df05632024-08-27 18:04:44 +02005124 * NewSessionTicket message has been received. See
5125 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET documentation
5126 * for more information.
Jerry Yu032985c2023-12-06 17:59:33 +08005127 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
5128 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01005129 * received as part of the handshake. This is server specific
5130 * and may occur only if the early data feature has been
5131 * enabled on server (see mbedtls_ssl_conf_early_data()
5132 * documentation). You must call mbedtls_ssl_read_early_data()
5133 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005134 * \return Another SSL error code - in this case you must stop using
5135 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02005136 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005137 * \warning If this function returns something other than
5138 * a positive value,
5139 * #MBEDTLS_ERR_SSL_WANT_READ,
5140 * #MBEDTLS_ERR_SSL_WANT_WRITE,
5141 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
Jerry Yu032985c2023-12-06 17:59:33 +08005142 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
5143 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT or
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02005144 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET or
Jerry Yu032985c2023-12-06 17:59:33 +08005145 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005146 * you must stop using the SSL context for reading or writing,
5147 * and either free it or call \c mbedtls_ssl_session_reset()
5148 * on it before re-using it for a new connection; the current
5149 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01005150 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005151 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02005152 * (which can only happen server-side), it means that a client
5153 * is initiating a new connection using the same source port.
5154 * You can either treat that as a connection close and wait
5155 * for the client to resend a ClientHello, or directly
5156 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005157 * context (as it has been reset internally). Either way, you
5158 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02005159 * connection: application state, if any, should be reset, and
5160 * most importantly the identity of the client must be checked
5161 * again. WARNING: not validating the identity of the client
5162 * again, or not transmitting the new identity to the
5163 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01005164 *
Hanno Becker8ec81022017-10-10 10:35:08 +01005165 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005166 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01005167 * from the underlying transport layer is currently being processed,
5168 * and it is safe to idle until the timer or the underlying transport
5169 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01005170 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
5171 * initially available on the underlying transport, as this data may have
5172 * been only e.g. duplicated messages or a renegotiation request.
5173 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
5174 * when reacting to an incoming-data event from the underlying transport.
5175 * - On success, the datagram of the underlying transport that is currently
5176 * being processed may contain further DTLS records. You should call
5177 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01005178 *
Paul Bakker5121ce52009-01-03 21:22:43 +00005179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005180int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005181
5182/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02005183 * \brief Try to write exactly 'len' application data bytes
5184 *
5185 * \warning This function will do partial writes in some cases. If the
5186 * return value is non-negative but less than length, the
5187 * function must be called again with updated arguments:
5188 * buf + ret, len - ret (if ret is the return value) until
5189 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00005190 *
5191 * \param ssl SSL context
5192 * \param buf buffer holding the data
5193 * \param len how many bytes must be written
5194 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005195 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005196 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005197 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02005198 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005199 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005200 * transport - in this case you must call this function again
5201 * when the underlying transport is ready for the operation.
5202 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
5203 * operation is in progress (see
5204 * mbedtls_ssl_conf_async_private_cb()) - in this case you
5205 * must call this function again when the operation is ready.
5206 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
5207 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
5208 * in this case you must call this function again to complete
5209 * the handshake when you're done attending other tasks.
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02005210 * \return #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET if a TLS 1.3
Ronald Cron9df05632024-08-27 18:04:44 +02005211 * NewSessionTicket message has been received. See
5212 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET documentation
5213 * for more information.
Jerry Yu032985c2023-12-06 17:59:33 +08005214 * \return #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA if early data, as
5215 * defined in RFC 8446 (TLS 1.3 specification), has been
Ronald Cron44d70a52024-01-30 18:16:47 +01005216 * received as part of the handshake. This is server specific
5217 * and may occur only if the early data feature has been
5218 * enabled on server (see mbedtls_ssl_conf_early_data()
5219 * documentation). You must call mbedtls_ssl_read_early_data()
5220 * to read the early data before resuming the handshake.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005221 * \return Another SSL error code - in this case you must stop using
5222 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00005223 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005224 * \warning If this function returns something other than
5225 * a non-negative value,
5226 * #MBEDTLS_ERR_SSL_WANT_READ,
5227 * #MBEDTLS_ERR_SSL_WANT_WRITE,
Jerry Yu032985c2023-12-06 17:59:33 +08005228 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
5229 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
Ronald Cron0e5d4fd2024-08-27 14:29:55 +02005230 * #MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET or
Jerry Yu032985c2023-12-06 17:59:33 +08005231 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA,
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02005232 * you must stop using the SSL context for reading or writing,
5233 * and either free it or call \c mbedtls_ssl_session_reset()
5234 * on it before re-using it for a new connection; the current
5235 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01005236 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005237 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00005238 * it must be called later with the *same* arguments,
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02005239 * until it returns a value greater than or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02005240 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01005241 * some partial data in the output buffer, however this is not
5242 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02005243 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00005244 * \note If the requested length is greater than the maximum
5245 * fragment length (either the built-in limit or the one set
5246 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02005247 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005248 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01005249 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04005250 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01005251 *
5252 * \note Attempting to write 0 bytes will result in an empty TLS
5253 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00005254 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005255int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00005256
5257/**
Paul Bakker0a925182012-04-16 06:46:41 +00005258 * \brief Send an alert message
5259 *
5260 * \param ssl SSL context
5261 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02005262 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00005263 * \param message The alert message (SSL_ALERT_MSG_*)
5264 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00005265 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01005266 *
5267 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00005268 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
5269 * the SSL context for reading or writing, and either free it or
5270 * call \c mbedtls_ssl_session_reset() on it before re-using it
5271 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00005272 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005273int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
5274 unsigned char level,
5275 unsigned char message);
Paul Bakker0a925182012-04-16 06:46:41 +00005276/**
Paul Bakker5121ce52009-01-03 21:22:43 +00005277 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00005278 *
5279 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01005280 *
5281 * \return 0 if successful, or a specific SSL error code.
5282 *
5283 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00005284 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
5285 * the SSL context for reading or writing, and either free it or
5286 * call \c mbedtls_ssl_session_reset() on it before re-using it
5287 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00005288 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005289int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005290
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005291#if defined(MBEDTLS_SSL_EARLY_DATA)
5292
5293#if defined(MBEDTLS_SSL_SRV_C)
5294/**
Ronald Cron3a045622024-01-08 18:44:59 +01005295 * \brief Read at most 'len' bytes of early data
5296 *
5297 * \note This API is server specific.
5298 *
Ronald Cron164537c2024-02-01 18:05:47 +01005299 * \warning Early data is defined in the TLS 1.3 specification, RFC 8446.
Ronald Cron44d70a52024-01-30 18:16:47 +01005300 * IMPORTANT NOTE from section 2.3 of the specification:
5301 *
5302 * The security properties for 0-RTT data are weaker than
5303 * those for other kinds of TLS data. Specifically:
5304 * - This data is not forward secret, as it is encrypted
5305 * solely under keys derived using the offered PSK.
5306 * - There are no guarantees of non-replay between connections.
5307 * Protection against replay for ordinary TLS 1.3 1-RTT data
5308 * is provided via the server's Random value, but 0-RTT data
5309 * does not depend on the ServerHello and therefore has
5310 * weaker guarantees. This is especially relevant if the
5311 * data is authenticated either with TLS client
5312 * authentication or inside the application protocol. The
5313 * same warnings apply to any use of the
5314 * early_exporter_master_secret.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005315 *
Ronald Cron3996ebc2024-03-15 14:57:05 +01005316 * \warning Mbed TLS does not implement any of the anti-replay defenses
Ronald Cron1987a7c2024-03-14 19:05:26 +01005317 * defined in section 8 of the TLS 1.3 specification:
Ronald Cron3996ebc2024-03-15 14:57:05 +01005318 * single-use of tickets or ClientHello recording within a
5319 * given time window.
Ronald Cron1987a7c2024-03-14 19:05:26 +01005320 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01005321 * \note This function is used in conjunction with
Ronald Cron3a045622024-01-08 18:44:59 +01005322 * mbedtls_ssl_handshake(), mbedtls_ssl_handshake_step(),
5323 * mbedtls_ssl_read() and mbedtls_ssl_write() to read early
5324 * data when these functions return
5325 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA.
5326 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01005327 * \param ssl SSL context, it must have been initialized and set up.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005328 * \param buf buffer that will hold the data
5329 * \param len maximum number of bytes to read
5330 *
Ronald Croned7d4bf2024-01-31 07:55:19 +01005331 * \return The (positive) number of bytes read if successful.
5332 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
5333 * \return #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA if it is not
5334 * possible to read early data for the SSL context \p ssl. Note
5335 * that this function is intended to be called for an SSL
5336 * context \p ssl only after a call to mbedtls_ssl_handshake(),
5337 * mbedtls_ssl_handshake_step(), mbedtls_ssl_read() or
5338 * mbedtls_ssl_write() for \p ssl that has returned
Ronald Cron3a045622024-01-08 18:44:59 +01005339 * #MBEDTLS_ERR_SSL_RECEIVED_EARLY_DATA.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005340 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005341int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5342 unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005343#endif /* MBEDTLS_SSL_SRV_C */
5344
5345#if defined(MBEDTLS_SSL_CLI_C)
5346/**
5347 * \brief Try to write exactly 'len' application data bytes while
5348 * performing the handshake (early data).
5349 *
Ronald Crond4069242024-02-21 13:45:52 +01005350 * \warning Early data is defined in the TLS 1.3 specification, RFC 8446.
5351 * IMPORTANT NOTE from section 2.3 of the specification:
5352 *
5353 * The security properties for 0-RTT data are weaker than
5354 * those for other kinds of TLS data. Specifically:
5355 * - This data is not forward secret, as it is encrypted
5356 * solely under keys derived using the offered PSK.
5357 * - There are no guarantees of non-replay between connections.
5358 * Protection against replay for ordinary TLS 1.3 1-RTT data
5359 * is provided via the server's Random value, but 0-RTT data
5360 * does not depend on the ServerHello and therefore has
5361 * weaker guarantees. This is especially relevant if the
5362 * data is authenticated either with TLS client
5363 * authentication or inside the application protocol. The
5364 * same warnings apply to any use of the
5365 * early_exporter_master_secret.
5366 *
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005367 * \note This function behaves mainly as mbedtls_ssl_write(). The
5368 * specification of mbedtls_ssl_write() relevant to TLS 1.3
5369 * (thus not the parts specific to (D)TLS1.2) applies to this
Ronald Crond4069242024-02-21 13:45:52 +01005370 * function and the present documentation is mainly restricted
5371 * to the differences with mbedtls_ssl_write(). One noticeable
5372 * difference though is that mbedtls_ssl_write() aims to
5373 * complete the handshake before to write application data
5374 * while mbedtls_ssl_write_early() aims to drive the handshake
5375 * just past the point where it is not possible to send early
5376 * data anymore.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005377 *
5378 * \param ssl SSL context
5379 * \param buf buffer holding the data
5380 * \param len how many bytes must be written
5381 *
Ronald Crond4069242024-02-21 13:45:52 +01005382 * \return The (non-negative) number of bytes actually written if
5383 * successful (may be less than \p len).
5384 *
5385 * \return One additional specific error code compared to
5386 * mbedtls_ssl_write():
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005387 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA.
5388 *
5389 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA is returned when it
5390 * is not possible to write early data for the SSL context
5391 * \p ssl.
5392 *
5393 * It may have been possible and it is not possible
5394 * anymore because the client received the server Finished
5395 * message, the server rejected early data or the maximum
5396 * number of allowed early data for the PSK in use has been
5397 * reached.
5398 *
5399 * It may never have been possible and will never be possible
5400 * for the SSL context \p ssl because the use of early data
5401 * is disabled for that context or more generally the context
5402 * is not suitably configured to enable early data or the first
5403 * call to the function was done while the handshake was
5404 * already completed.
5405 *
5406 * It is not possible to write early data for the SSL context
Ronald Cron8f1de7e2024-02-22 12:02:39 +01005407 * \p ssl and any subsequent call to this API will return this
5408 * error code. But this does not preclude for using it with
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005409 * mbedtls_ssl_write(), mbedtls_ssl_read() or
Ronald Cron8f1de7e2024-02-22 12:02:39 +01005410 * mbedtls_ssl_handshake() and the handshake can be
5411 * completed by calling one of these APIs.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005412 *
5413 * \note This function may write early data only if the SSL context
5414 * has been configured for the handshake with a PSK for which
5415 * early data is allowed.
5416 *
5417 * \note To maximize the number of early data that can be written in
5418 * the course of the handshake, it is expected that this
5419 * function starts the handshake for the SSL context \p ssl.
5420 * But this is not mandatory.
5421 *
5422 * \note This function does not provide any information on whether
5423 * the server has accepted or will accept early data or not.
5424 * When it returns a positive value, it just means that it
5425 * has written early data to the server. To know whether the
5426 * server has accepted early data or not, you should call
5427 * mbedtls_ssl_get_early_data_status() with the handshake
5428 * completed.
5429 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005430int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5431 const unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005432
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005433/**
5434 * \brief Get the status of the negotiation of the use of early data.
5435 *
5436 * \param ssl The SSL context to query
5437 *
5438 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called
5439 * from the server-side.
5440 *
5441 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called
5442 * prior to completion of the handshake.
5443 *
Ronald Cron840de7f2024-03-11 17:49:35 +01005444 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_INDICATED if the client
5445 * has not indicated the use of early data to the server.
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005446 *
5447 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED if the client has
5448 * indicated the use of early data and the server has accepted
5449 * it.
5450 *
5451 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED if the client has
5452 * indicated the use of early data but the server has rejected
5453 * it. In this situation, the client may want to re-send the
5454 * early data it may have tried to send by calling
5455 * mbedtls_ssl_write_early_data() as ordinary post-handshake
5456 * application data by calling mbedtls_ssl_write().
5457 *
5458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005459int mbedtls_ssl_get_early_data_status(mbedtls_ssl_context *ssl);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005460#endif /* MBEDTLS_SSL_CLI_C */
5461
5462#endif /* MBEDTLS_SSL_EARLY_DATA */
5463
Paul Bakker5121ce52009-01-03 21:22:43 +00005464/**
Paul Bakker48916f92012-09-16 19:57:18 +00005465 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00005466 *
5467 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00005468 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005469void mbedtls_ssl_free(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005470
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005471#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00005472/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005473 * \brief Save an active connection as serialized data in a buffer.
5474 * This allows the freeing or re-using of the SSL context
5475 * while still picking up the connection later in a way that
5476 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005477 *
5478 * \see mbedtls_ssl_context_load()
5479 *
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005480 * \note The serialized data only contains the data that is
5481 * necessary to resume the connection: negotiated protocol
5482 * options, session identifier, keys, etc.
5483 * Loading a saved SSL context does not restore settings and
5484 * state related to how the application accesses the context,
5485 * such as configured callback functions, user data, pending
5486 * incoming or outgoing data, etc.
5487 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005488 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005489 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005490 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
5491 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005492 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005493 * mbedtls_ssl_session_reset() on \p ssl which as a result is
5494 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005495 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005496 * state. You're then free to either re-use the context
5497 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005498 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005499 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005500 *
5501 * \param ssl The SSL context to save. On success, it is no longer
5502 * associated with the connection that has been serialized.
5503 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03005504 * writeable buffer of at least \p buf_len bytes, or may be \c
5505 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005506 * \param buf_len The number of bytes available for writing in \p buf.
5507 * \param olen The size in bytes of the data that has been or would have
5508 * been written. It must point to a valid \c size_t.
5509 *
5510 * \note \p olen is updated to the correct value regardless of
5511 * whether \p buf_len was large enough. This makes it possible
5512 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005513 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
5514 * the value of \p olen is only guaranteed to be correct when
5515 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
5516 * \c 0. If the return value is different, then the value of
5517 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005518 *
5519 * \return \c 0 if successful.
5520 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005521 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005522 * while resetting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005523 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005524 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005525 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005526 * ciphersuite, or renegotiation is enabled.
5527 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005528int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5529 unsigned char *buf,
5530 size_t buf_len,
5531 size_t *olen);
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005532
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005533/**
5534 * \brief Load serialized connection data to an SSL context.
5535 *
5536 * \see mbedtls_ssl_context_save()
5537 *
5538 * \warning The same serialized data must never be loaded into more
5539 * that one context. In order to ensure that, after
5540 * successfully loading serialized data to an SSL context, you
5541 * should immediately destroy or invalidate all copies of the
5542 * serialized data that was loaded. Loading the same data in
5543 * more than one context would cause severe security failures
5544 * including but not limited to loss of confidentiality.
5545 *
5546 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005547 * prepared in one of the two following ways. The first way is
5548 * to take a context freshly initialised with
5549 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005550 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005551 * the original connection. The second way is to
5552 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005553 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005554 * Either way, you must not use the context to perform a
5555 * handshake between calling mbedtls_ssl_setup() or
5556 * mbedtls_ssl_session_reset() and calling this function. You
5557 * may however call other setter functions in that time frame
5558 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005559 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005560 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005561 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005562 * and settings before you can use the connection again
5563 * (unless they were already set before calling
5564 * mbedtls_ssl_session_reset() and the values are suitable for
5565 * the present connection). Specifically, you want to call
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005566 * at least mbedtls_ssl_set_bio(),
5567 * mbedtls_ssl_set_timer_cb(), and
5568 * mbedtls_ssl_set_user_data_n() or
5569 * mbedtls_ssl_set_user_data_p() if they were set originally.
5570 * All other SSL setter functions
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02005571 * are not necessary to call, either because they're only used
5572 * in handshakes, or because the setting is already saved. You
5573 * might choose to call them anyway, for example in order to
5574 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005575 * connection and the case of loading an already-established
5576 * connection.
5577 *
5578 * \note If you have new information about the path MTU, you want to
5579 * call mbedtls_ssl_set_mtu() after calling this function, as
5580 * otherwise this function would overwrite your
5581 * newly-configured value with the value that was active when
5582 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005583 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005584 * \note When this function returns an error code, it calls
5585 * mbedtls_ssl_free() on \p ssl. In this case, you need to
5586 * prepare the context with the usual sequence starting with a
5587 * call to mbedtls_ssl_init() if you want to use it again.
5588 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005589 * \param ssl The SSL context structure to be populated. It must have
5590 * been prepared as described in the note above.
5591 * \param buf The buffer holding the serialized connection data. It must
5592 * be a readable buffer of at least \p len bytes.
5593 * \param len The size of the serialized data in bytes.
5594 *
5595 * \return \c 0 if successful.
5596 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005597 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
5598 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005599 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
5600 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005601int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl,
5602 const unsigned char *buf,
5603 size_t len);
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005604#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005605
5606/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005607 * \brief Initialize an SSL configuration context
5608 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005609 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005610 *
5611 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01005612 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005613 *
5614 * \param conf SSL configuration context
5615 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005616void mbedtls_ssl_config_init(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005617
5618/**
Adam Wolf039080f2019-09-10 09:53:08 -05005619 * \brief Load reasonable default SSL configuration values.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005620 * (You need to call mbedtls_ssl_config_init() first.)
5621 *
5622 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005623 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
5624 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
5625 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005626 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005627 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02005628 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01005629 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005630 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005631 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005632 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005633int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5634 int endpoint, int transport, int preset);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005635
5636/**
5637 * \brief Free an SSL configuration context
5638 *
5639 * \param conf SSL configuration context
5640 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005641void mbedtls_ssl_config_free(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005642
5643/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005644 * \brief Initialize SSL session structure
5645 *
5646 * \param session SSL session
5647 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005648void mbedtls_ssl_session_init(mbedtls_ssl_session *session);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005649
5650/**
Paul Bakker0a597072012-09-25 21:55:46 +00005651 * \brief Free referenced items in an SSL session including the
5652 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00005653 *
Ron Eldor00115032018-07-17 11:21:50 +03005654 * \note A session object can be freed even if the SSL context
5655 * that was used to retrieve the session is still in use.
5656 *
Paul Bakker48916f92012-09-16 19:57:18 +00005657 * \param session SSL session
5658 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005659void mbedtls_ssl_session_free(mbedtls_ssl_session *session);
Paul Bakker48916f92012-09-16 19:57:18 +00005660
Ron Eldor51d3ab52019-05-12 14:54:30 +03005661/**
5662 * \brief TLS-PRF function for key derivation.
5663 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005664 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005665 * \param secret Secret for the key derivation function.
5666 * \param slen Length of the secret.
5667 * \param label String label for the key derivation function,
5668 * terminated with null character.
5669 * \param random Random bytes.
5670 * \param rlen Length of the random bytes buffer.
5671 * \param dstbuf The buffer holding the derived key.
5672 * \param dlen Length of the output buffer.
5673 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005674 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005675 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005676int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
5677 const unsigned char *secret, size_t slen,
5678 const char *label,
5679 const unsigned char *random, size_t rlen,
5680 unsigned char *dstbuf, size_t dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +03005681
Paul Bakker5121ce52009-01-03 21:22:43 +00005682#ifdef __cplusplus
5683}
5684#endif
5685
5686#endif /* ssl.h */