blob: 84c4beffcfacc6cd1513515829b226e65fc31d8d [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file ssl.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief SSL/TLS functions.
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Bence Szépkúti1e148272020-08-07 13:07:28 +02007 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020022#ifndef MBEDTLS_SSL_H
23#define MBEDTLS_SSL_H
Brett Warrene0edc842021-08-17 09:53:13 +010024#include "mbedtls/platform_util.h"
Mateusz Starzyk846f0212021-05-19 19:44:07 +020025#include "mbedtls/private_access.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Bence Szépkútic662b362021-05-27 11:25:03 +020027#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010028
Jaeden Amero6609aef2019-07-04 20:01:14 +010029#include "mbedtls/bignum.h"
30#include "mbedtls/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020031
Jaeden Amero6609aef2019-07-04 20:01:14 +010032#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020034#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010035#include "mbedtls/x509_crt.h"
36#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020037#endif
Paul Bakkered27a042013-04-18 22:46:23 +020038
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020039#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010040#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000041#endif
XiaokangQiana7634982021-10-22 06:32:32 +000042
Andrzej Kurek1b75e5f2023-04-04 09:55:06 -040043#include "mbedtls/md.h"
44
Valerio Setti77a904c2023-03-24 07:28:49 +010045#if defined(MBEDTLS_ECDH_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010046#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010047#endif
48
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020049#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010050#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020051#endif
52
Hanno Becker43633132018-10-22 15:31:03 +010053#include "psa/crypto.h"
Hanno Becker43633132018-10-22 15:31:03 +010054
Paul Bakker13e2dfe2009-07-28 07:18:38 +000055/*
56 * SSL Error codes
57 */
Gilles Peskined2971572021-07-26 18:48:10 +020058/** A cryptographic operation is in progress. Try again later. */
59#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
60/** The requested feature is not available. */
61#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
62/** Bad input parameters to function. */
63#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
64/** Verification of the message MAC failed. */
65#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
66/** An invalid SSL record was received. */
67#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
68/** The connection indicated an EOF. */
69#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
70/** A message could not be parsed due to a syntactic error. */
71#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300
Dave Rodgmanbb05cd02021-06-29 10:37:43 +010072/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020073/** No RNG was provided to the SSL module. */
74#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
75/** No client certification received from the client, but required by the authentication mode. */
76#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
77/** Client received an extended server hello containing an unsupported extension */
78#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500
79/** No ALPN protocols supported that the client advertises */
80#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580
81/** The own private key or pre-shared key is not set, but needed. */
82#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
83/** No CA Chain is set, but required to operate. */
84#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
85/** An unexpected message was received from our peer. */
86#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
87/** A fatal alert message was received from our peer. */
88#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
89/** No server could be identified matching the client's SNI. */
90#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800
91/** The peer notified us that the connection is going to be closed. */
92#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
Hanno Becker90d59dd2021-06-24 11:17:13 +010093/* Error space gap */
Hanno Beckerc3411d42021-06-24 11:09:00 +010094/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020095/** Processing of the Certificate handshake message failed. */
96#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00
Pengyu Lv18946532023-01-12 12:28:09 +080097/* Error space gap */
Ronald Cronda130722022-11-22 09:08:57 +010098/**
99 * Received NewSessionTicket Post Handshake Message.
100 * This error code is experimental and may be changed or removed without notice.
101 */
Jerry Yuf8a49942022-07-07 11:32:32 +0000102#define MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET -0x7B00
Ronald Cron4a8c9e22022-10-26 18:49:09 +0200103/** Not possible to read early data */
104#define MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA -0x7B80
105/** Not possible to write early data */
106#define MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA -0x7C00
Hanno Beckerb24e74b2021-06-24 09:52:01 +0100107/* Error space gap */
Hanno Beckerd3eec782021-06-24 10:21:46 +0100108/* Error space gap */
Hanno Beckerd934a2a2021-06-24 10:23:45 +0100109/* Error space gap */
Hanno Beckerd2002962021-06-24 10:25:40 +0100110/* Error space gap */
Hanno Beckera0ca87e2021-06-24 10:27:37 +0100111/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200112/** Memory allocation failed */
113#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
114/** Hardware acceleration function returned with error */
115#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
116/** Hardware acceleration function skipped / left alone data */
117#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
118/** Handshake protocol not within min/max boundaries */
119#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80
120/** The handshake negotiation failed. */
121#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00
122/** Session ticket has expired. */
123#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
124/** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
125#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
126/** Unknown identity received (eg, PSK identity) */
127#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
128/** Internal error (eg, unexpected failure in lower-level module) */
129#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
130/** A counter would wrap (eg, too many messages exchanged). */
131#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
132/** Unexpected message at ServerHello in renegotiation. */
133#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
134/** DTLS client must retry for hello verification */
135#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
136/** A buffer is too small to receive or write a message */
137#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
Dave Rodgman096c4112021-06-29 09:52:06 +0100138/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200139/** No data of requested type currently available on underlying transport. */
140#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
141/** Connection requires a write call. */
142#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
143/** The operation timed out. */
144#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
145/** The client initiated a reconnect from the same port. */
146#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
147/** Record header looks valid but is not expected. */
148#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
149/** The alert message received indicates a non-fatal error. */
150#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
151/** A field in a message was incorrect or inconsistent with other fields. */
152#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600
153/** Internal-only message signaling that further message-processing should be done */
154#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
155/** The asynchronous operation is not completed yet. */
156#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
157/** Internal-only message signaling that a message arrived early. */
158#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
Dave Rodgmanc628fc92021-06-29 14:32:46 +0100159/* Error space gap */
160/* Error space gap */
161/* Error space gap */
162/* Error space gap */
163/* Error space gap */
164/* Error space gap */
165/* Error space gap */
166/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200167/** An encrypted DTLS-frame with an unexpected CID was received. */
168#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
169/** An operation failed due to an unexpected version or configuration. */
170#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
171/** Invalid value in SSL config */
172#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
Paul Bakker5121ce52009-01-03 21:22:43 +0000173
174/*
Jerry Yue19e3b92022-07-08 12:04:51 +0000175 * Constants from RFC 8446 for TLS 1.3 PSK modes
176 *
177 * Those are used in the Pre-Shared Key Exchange Modes extension.
178 * See Section 4.2.9 in RFC 8446.
179 */
180#define MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE 0 /* Pure PSK-based exchange */
181#define MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE 1 /* PSK+ECDHE-based exchange */
182
183/*
Jerry Yue226cef2021-08-27 22:06:20 +0800184 * TLS 1.3 NamedGroup values
185 *
186 * From RF 8446
187 * enum {
188 * // Elliptic Curve Groups (ECDHE)
189 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
190 * x25519(0x001D), x448(0x001E),
191 * // Finite Field Groups (DHE)
192 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
193 * ffdhe6144(0x0103), ffdhe8192(0x0104),
194 * // Reserved Code Points
195 * ffdhe_private_use(0x01FC..0x01FF),
196 * ecdhe_private_use(0xFE00..0xFEFF),
197 * (0xFFFF)
198 * } NamedGroup;
199 *
200 */
Brett Warrene0edc842021-08-17 09:53:13 +0100201
Jerry Yue226cef2021-08-27 22:06:20 +0800202/* Elliptic Curve Groups (ECDHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100203#define MBEDTLS_SSL_IANA_TLS_GROUP_NONE 0
204#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192K1 0x0012
205#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP192R1 0x0013
206#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224K1 0x0014
207#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP224R1 0x0015
208#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256K1 0x0016
209#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP256R1 0x0017
210#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP384R1 0x0018
211#define MBEDTLS_SSL_IANA_TLS_GROUP_SECP521R1 0x0019
212#define MBEDTLS_SSL_IANA_TLS_GROUP_BP256R1 0x001A
213#define MBEDTLS_SSL_IANA_TLS_GROUP_BP384R1 0x001B
214#define MBEDTLS_SSL_IANA_TLS_GROUP_BP512R1 0x001C
215#define MBEDTLS_SSL_IANA_TLS_GROUP_X25519 0x001D
216#define MBEDTLS_SSL_IANA_TLS_GROUP_X448 0x001E
Jerry Yue226cef2021-08-27 22:06:20 +0800217/* Finite Field Groups (DHE) */
Brett Warrene0edc842021-08-17 09:53:13 +0100218#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE2048 0x0100
219#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE3072 0x0101
220#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE4096 0x0102
221#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE6144 0x0103
222#define MBEDTLS_SSL_IANA_TLS_GROUP_FFDHE8192 0x0104
Jerry Yue226cef2021-08-27 22:06:20 +0800223
224/*
Hanno Becker71f1ed62021-07-24 06:01:47 +0100225 * TLS 1.3 Key Exchange Modes
226 *
227 * Mbed TLS internal identifiers for use with the SSL configuration API
228 * mbedtls_ssl_conf_tls13_key_exchange_modes().
229 */
230
Gilles Peskine449bd832023-01-11 14:50:10 +0100231#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 +0000232 * encompassing both externally agreed PSKs
233 * as well as resumption PSKs. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100234#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 +0000235 * including for example ECDHE and DHE
236 * key exchanges. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100237#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 +0000238 * using both a PSK and an ephemeral
239 * key exchange. */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100240
241/* Convenience macros for sets of key exchanges. */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000242#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
244 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
245 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL) /*!< All TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000246#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK | \
248 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All PSK-based TLS 1.3 key exchanges */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000249#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 (MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL | \
251 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) /*!< All ephemeral TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100252
Gilles Peskine449bd832023-01-11 14:50:10 +0100253#define MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE (0)
Jerry Yu77f01482022-07-11 07:03:24 +0000254
Hanno Becker71f1ed62021-07-24 06:01:47 +0100255/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000256 * Various constants
257 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100258
Glenn Straussd09b3432022-04-11 13:58:11 -0400259#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Jan Bruckner25fdc2a2022-07-26 10:45:07 +0200260/* These are the high and low bytes of ProtocolVersion as defined by:
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100261 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
262 * - RFC 8446: see section 4.2.1
263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200265#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Ronald Cron6f135e12021-12-08 16:57:54 +0100266#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 */
Glenn Straussd09b3432022-04-11 13:58:11 -0400267#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker5121ce52009-01-03 21:22:43 +0000268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200269#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
270#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100271
Simon Butcher9f812312015-09-28 19:22:33 +0100272#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200273#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
274
275#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 +0100276
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200277/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200278 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200279#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
280#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
281#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
282#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
283#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
284#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200285
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286#define MBEDTLS_SSL_IS_CLIENT 0
287#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200289#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
290#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200291
Hanno Becker019f4b52019-04-09 15:12:56 +0100292#define MBEDTLS_SSL_CID_DISABLED 0
293#define MBEDTLS_SSL_CID_ENABLED 1
294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200295#define MBEDTLS_SSL_ETM_DISABLED 0
296#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#define MBEDTLS_SSL_VERIFY_NONE 0
301#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
302#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200303#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000304
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200305#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
306#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
309#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
312#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200313
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
315#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200316
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200317#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
318#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
319#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
322#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
323#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
326#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200327
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200328#define MBEDTLS_SSL_PRESET_DEFAULT 0
329#define MBEDTLS_SSL_PRESET_SUITEB 2
330
Janos Follath088ce432017-04-10 12:42:31 +0100331#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
332#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
333
Xiaokang Qian54413b12022-10-20 05:57:03 +0000334#define MBEDTLS_SSL_EARLY_DATA_DISABLED 0
335#define MBEDTLS_SSL_EARLY_DATA_ENABLED 1
336
Ron Eldor591f1622018-01-22 12:30:04 +0200337#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
338#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
339
TRodziewicz3946f792021-06-14 12:11:18 +0200340#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
341#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200342
Jerry Yu0a430c82022-07-20 11:02:48 +0800343#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200344#if defined(PSA_WANT_ALG_SHA_384)
Jerry Yu0a430c82022-07-20 11:02:48 +0800345#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 48
Przemyslaw Stekiel034492b2022-09-14 11:09:20 +0200346#elif defined(PSA_WANT_ALG_SHA_256)
Jerry Yu0a430c82022-07-20 11:02:48 +0800347#define MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN 32
Przemek Stekiela9a88162022-09-02 13:18:55 +0200348#endif
Jerry Yu0a430c82022-07-20 11:02:48 +0800349#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200350/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200351 * Default range for DTLS retransmission timer value, in milliseconds.
352 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
353 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
355#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200356
Paul Bakker088c5c52014-04-25 11:11:10 +0200357/**
358 * \name SECTION: Module settings
359 *
360 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200361 * Either change them in mbedtls_config.h or define them on the compiler command line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200362 * \{
363 */
364
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200365/*
Angus Grattond8213d02016-05-25 20:56:48 +1000366 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200367 * determines the size of each of the two internal I/O buffers.
368 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200369 * Note: the RFC defines the default size of SSL / TLS messages. If you
370 * change the value here, other clients / servers may not be able to
371 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200372 * both sides of the connection and have it reduced at both sides, or
373 * if you're using the Max Fragment Length extension and you know all your
374 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200375 */
Angus Grattond8213d02016-05-25 20:56:48 +1000376#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100377#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000378#endif
379
380#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100381#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000382#endif
383
Hanno Becker28007512018-08-28 09:46:44 +0100384/*
385 * Maximum number of heap-allocated bytes for the purpose of
386 * DTLS handshake message reassembly and future message buffering.
387 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100388#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100389#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100390#endif
391
Hanno Becker019f4b52019-04-09 15:12:56 +0100392/*
393 * Maximum length of CIDs for incoming and outgoing messages.
394 */
395#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100396#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100397#endif
398
399#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
400#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
401#endif
402
TRodziewicze8dd7092021-05-12 14:19:11 +0200403#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
404#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100405#endif
406
Andrzej Kurek38d4fdd2021-12-28 16:22:52 +0100407/** \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000408
409/*
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200410 * Default to standard CID mode
411 */
412#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID) && \
413 !defined(MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT)
414#define MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT 0
415#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000416
417/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100418 * Length of the verify data for secure renegotiation
419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100421
422/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200423 * Signaling ciphersuite values (SCSV)
424 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000426
Paul Bakker5121ce52009-01-03 21:22:43 +0000427/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000428 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200429 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431#define MBEDTLS_SSL_HASH_NONE 0
432#define MBEDTLS_SSL_HASH_MD5 1
433#define MBEDTLS_SSL_HASH_SHA1 2
434#define MBEDTLS_SSL_HASH_SHA224 3
435#define MBEDTLS_SSL_HASH_SHA256 4
436#define MBEDTLS_SSL_HASH_SHA384 5
437#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000438
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439#define MBEDTLS_SSL_SIG_ANON 0
440#define MBEDTLS_SSL_SIG_RSA 1
441#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000442
443/*
Hanno Becker551265f2021-08-10 13:03:48 +0100444 * TLS 1.3 signature algorithms
445 * RFC 8446, Section 4.2.2
446 */
447
448/* RSASSA-PKCS1-v1_5 algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000449#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256 0x0401
450#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384 0x0501
451#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512 0x0601
Hanno Becker551265f2021-08-10 13:03:48 +0100452
453/* ECDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000454#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256 0x0403
455#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384 0x0503
456#define MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512 0x0603
Hanno Becker551265f2021-08-10 13:03:48 +0100457
458/* RSASSA-PSS algorithms with public key OID rsaEncryption */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000459#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256 0x0804
460#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384 0x0805
461#define MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512 0x0806
Hanno Becker551265f2021-08-10 13:03:48 +0100462
463/* EdDSA algorithms */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000464#define MBEDTLS_TLS1_3_SIG_ED25519 0x0807
465#define MBEDTLS_TLS1_3_SIG_ED448 0x0808
Hanno Becker551265f2021-08-10 13:03:48 +0100466
467/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000468#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA256 0x0809
469#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA384 0x080A
470#define MBEDTLS_TLS1_3_SIG_RSA_PSS_PSS_SHA512 0x080B
Hanno Becker551265f2021-08-10 13:03:48 +0100471
472/* LEGACY ALGORITHMS */
Xiaofei Bai746f9482021-11-12 08:53:56 +0000473#define MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA1 0x0201
474#define MBEDTLS_TLS1_3_SIG_ECDSA_SHA1 0x0203
Hanno Becker551265f2021-08-10 13:03:48 +0100475
Xiaofei Bai746f9482021-11-12 08:53:56 +0000476#define MBEDTLS_TLS1_3_SIG_NONE 0x0
Hanno Becker551265f2021-08-10 13:03:48 +0100477
478/*
Paul Bakker926af752012-11-23 13:38:07 +0100479 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200480 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100481 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200482#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
483#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100484
485/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000486 * Message, alert and handshake types
487 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200488#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
489#define MBEDTLS_SSL_MSG_ALERT 21
490#define MBEDTLS_SSL_MSG_HANDSHAKE 22
491#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100492#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200494#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
495#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000496
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200497#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
498#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
499#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
500#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
501#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
502#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
503#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
504#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
505#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
506#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
507#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
508#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
509#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
510#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
511#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
512#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
513#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
514#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
515#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
516#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
517#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
518#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
519#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
520#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
521#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000522#define MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION 109 /* 0x6d -- new in TLS 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200523#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
524#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
525#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
XiaokangQian6b916b12022-04-25 07:29:34 +0000526#define MBEDTLS_SSL_ALERT_MSG_CERT_REQUIRED 116 /* 0x74 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200527#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000528
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200529#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
530#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
531#define MBEDTLS_SSL_HS_SERVER_HELLO 2
532#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
533#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
Xiaokang Qian5b410072023-01-03 10:31:15 +0000534#define MBEDTLS_SSL_HS_END_OF_EARLY_DATA 5
535#define MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS 8
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200536#define MBEDTLS_SSL_HS_CERTIFICATE 11
537#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
538#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
539#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
540#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
541#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
542#define MBEDTLS_SSL_HS_FINISHED 20
XiaokangQian647719a2021-12-07 09:16:29 +0000543#define MBEDTLS_SSL_HS_MESSAGE_HASH 254
Paul Bakker5121ce52009-01-03 21:22:43 +0000544
545/*
546 * TLS extensions
547 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200548#define MBEDTLS_TLS_EXT_SERVERNAME 0
549#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800554#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200555
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800557#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 +0200558#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000559
Jerry Yub3317e12021-08-26 14:30:22 +0800560#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
Johan Pascalb62bb512015-12-03 21:56:45 +0100561#define MBEDTLS_TLS_EXT_USE_SRTP 14
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800562#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200564
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800565#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
Jerry Yu1bc2c1f2021-09-01 12:57:29 +0800566#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
567#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
568#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
570#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200571
Jan Bruckner151f6422023-02-10 12:45:19 +0100572#define MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT 28 /* RFC 8449 (implemented for TLS 1.3 only) */
573
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200575
Jerry Yub3317e12021-08-26 14:30:22 +0800576#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
577#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
578#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
579#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
580#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800581
Jerry Yub3317e12021-08-26 14:30:22 +0800582#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
583#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
584#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
585#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
586#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800587
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +0200588#if MBEDTLS_SSL_DTLS_CONNECTION_ID_COMPAT == 0
589#define MBEDTLS_TLS_EXT_CID 54 /* RFC 9146 DTLS 1.2 CID */
590#else
591#define MBEDTLS_TLS_EXT_CID 254 /* Pre-RFC 9146 DTLS 1.2 CID */
Gilles Peskine7dd2f502021-04-24 13:35:41 +0200592#endif
Hanno Becker0652bc52019-04-25 16:24:57 +0100593
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200594#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
595
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200596#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000597
Johan Pascalb62bb512015-12-03 21:56:45 +0100598/*
Paul Bakkered27a042013-04-18 22:46:23 +0200599 * Size defines
600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200601#if !defined(MBEDTLS_PSK_MAX_LEN)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100602/*
603 * If the library supports TLS 1.3 tickets and the cipher suite
604 * TLS1-3-AES-256-GCM-SHA384, set the PSK maximum length to 48 instead of 32.
605 * That way, the TLS 1.3 client and server are able to resume sessions where
Ronald Cronee54de02023-02-24 12:06:30 +0100606 * the cipher suite is TLS1-3-AES-256-GCM-SHA384 (pre-shared keys are 48
607 * bytes long in that case).
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100608 */
609#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && \
610 defined(MBEDTLS_SSL_SESSION_TICKETS) && \
611 defined(MBEDTLS_AES_C) && defined(MBEDTLS_GCM_C) && \
Paul Elliott69034382023-03-27 21:24:45 +0100612 defined(MBEDTLS_MD_CAN_SHA384)
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100613#define MBEDTLS_PSK_MAX_LEN 48 /* 384 bits */
614#else
615#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200616#endif
Ronald Cron1aa6e8d2023-02-23 09:46:54 +0100617#endif /* !MBEDTLS_PSK_MAX_LEN */
Paul Bakkered27a042013-04-18 22:46:23 +0200618
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200619/* Dummy type used only for its size */
Gilles Peskine449bd832023-01-11 14:50:10 +0100620union mbedtls_ssl_premaster_secret {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200621#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200622 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
623#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200624#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
625 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200626#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200627#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
628 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
629 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
630 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
631 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200632#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200633#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
634 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200635#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200636#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
637 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200639#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200640#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
641 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200642#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200643#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
644 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200646#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200647#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
648 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
649#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200650};
651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652#define MBEDTLS_PREMASTER_SIZE sizeof(union mbedtls_ssl_premaster_secret)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200653
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200654#define MBEDTLS_TLS1_3_MD_MAX_SIZE PSA_HASH_MAX_SIZE
Przemyslaw Stekiel67ffab52022-09-14 14:07:01 +0200655
XiaokangQianc5c39d52021-11-09 11:55:10 +0000656
Jerry Yud96a5c22021-09-29 17:46:51 +0800657/* Length in number of bytes of the TLS sequence number */
Jerry Yuae0b2e22021-10-08 15:21:19 +0800658#define MBEDTLS_SSL_SEQUENCE_NUMBER_LEN 8
Jerry Yu957f0fa2021-09-24 10:27:07 +0800659
Paul Bakker407a0da2013-06-27 14:29:21 +0200660#ifdef __cplusplus
661extern "C" {
662#endif
663
Paul Bakkered27a042013-04-18 22:46:23 +0200664/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000665 * SSL state machine
666 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100667typedef enum {
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200668 MBEDTLS_SSL_HELLO_REQUEST,
669 MBEDTLS_SSL_CLIENT_HELLO,
670 MBEDTLS_SSL_SERVER_HELLO,
671 MBEDTLS_SSL_SERVER_CERTIFICATE,
672 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
673 MBEDTLS_SSL_CERTIFICATE_REQUEST,
674 MBEDTLS_SSL_SERVER_HELLO_DONE,
675 MBEDTLS_SSL_CLIENT_CERTIFICATE,
676 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
677 MBEDTLS_SSL_CERTIFICATE_VERIFY,
678 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
679 MBEDTLS_SSL_CLIENT_FINISHED,
680 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
681 MBEDTLS_SSL_SERVER_FINISHED,
682 MBEDTLS_SSL_FLUSH_BUFFERS,
683 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
Jerry Yua8d3c502022-10-30 14:51:23 +0800684
Jerry Yua357cf42022-07-12 05:36:45 +0000685 MBEDTLS_SSL_NEW_SESSION_TICKET,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200686 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000687 MBEDTLS_SSL_HELLO_RETRY_REQUEST,
Jerry Yua13c7e72021-08-17 10:44:40 +0800688 MBEDTLS_SSL_ENCRYPTED_EXTENSIONS,
Xiaokang Qian125afcb2022-10-28 06:04:06 +0000689 MBEDTLS_SSL_END_OF_EARLY_DATA,
Jerry Yu687101b2021-09-14 16:03:56 +0800690 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY,
Ronald Cron49ad6192021-11-24 16:25:31 +0100691 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED,
XiaokangQian647719a2021-12-07 09:16:29 +0000692 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO,
Gabor Mezei7b39bf12022-05-24 16:04:14 +0200693 MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO,
Xiaokang Qian592021a2023-01-04 10:47:05 +0000694 MBEDTLS_SSL_CLIENT_CCS_AFTER_CLIENT_HELLO,
Gabor Mezeif7044ea2022-06-28 16:01:49 +0200695 MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST,
Jerry Yu5ed73ff2022-10-27 13:08:42 +0800696 MBEDTLS_SSL_HANDSHAKE_OVER,
Jerry Yua8d3c502022-10-30 14:51:23 +0800697 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET,
698 MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH,
Paul Bakker5121ce52009-01-03 21:22:43 +0000699}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200700mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000701
Simon Butchere846b512016-03-01 17:31:49 +0000702/**
703 * \brief Callback type: send data on the network.
704 *
705 * \note That callback may be either blocking or non-blocking.
706 *
707 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000708 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000709 * \param len Length of the data to send
710 *
711 * \return The callback must return the number of bytes sent if any,
712 * or a non-zero error code.
713 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
714 * must be returned when the operation would block.
715 *
Simon Butcherd567a232016-03-09 20:19:21 +0000716 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000717 * It must always return the number of bytes actually sent.
718 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100719typedef int mbedtls_ssl_send_t(void *ctx,
720 const unsigned char *buf,
721 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000722
723/**
724 * \brief Callback type: receive data from the network.
725 *
726 * \note That callback may be either blocking or non-blocking.
727 *
728 * \param ctx Context for the receive callback (typically a file
729 * descriptor)
730 * \param buf Buffer to write the received data to
731 * \param len Length of the receive buffer
732 *
Hanno Becker218dec82021-07-23 07:23:47 +0100733 * \returns If data has been received, the positive number of bytes received.
734 * \returns \c 0 if the connection has been closed.
735 * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
Simon Butchere846b512016-03-01 17:31:49 +0000736 * must be returned when the operation would block.
Hanno Becker218dec82021-07-23 07:23:47 +0100737 * \returns Another negative error code on other kinds of failures.
Simon Butchere846b512016-03-01 17:31:49 +0000738 *
Simon Butcherd567a232016-03-09 20:19:21 +0000739 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000740 * buffer. It must always return the number of bytes actually
741 * received and written to the buffer.
742 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100743typedef int mbedtls_ssl_recv_t(void *ctx,
744 unsigned char *buf,
745 size_t len);
Simon Butchere846b512016-03-01 17:31:49 +0000746
747/**
748 * \brief Callback type: receive data from the network, with timeout
749 *
750 * \note That callback must block until data is received, or the
751 * timeout delay expires, or the operation is interrupted by a
752 * signal.
753 *
754 * \param ctx Context for the receive callback (typically a file descriptor)
755 * \param buf Buffer to write the received data to
756 * \param len Length of the receive buffer
Andrey Starodubtsev90cc33a2021-08-23 12:14:56 +0300757 * \param timeout Maximum number of milliseconds to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000758 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000759 *
760 * \return The callback must return the number of bytes received,
761 * or a non-zero error code:
762 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
763 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
764 *
Simon Butcherd567a232016-03-09 20:19:21 +0000765 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000766 * buffer. It must always return the number of bytes actually
767 * received and written to the buffer.
768 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100769typedef int mbedtls_ssl_recv_timeout_t(void *ctx,
770 unsigned char *buf,
771 size_t len,
772 uint32_t timeout);
Simon Butchere846b512016-03-01 17:31:49 +0000773/**
774 * \brief Callback type: set a pair of timers/delays to watch
775 *
776 * \param ctx Context pointer
777 * \param int_ms Intermediate delay in milliseconds
778 * \param fin_ms Final delay in milliseconds
779 * 0 cancels the current timer.
780 *
781 * \note This callback must at least store the necessary information
782 * for the associated \c mbedtls_ssl_get_timer_t callback to
783 * return correct information.
784 *
Tom Cosgrovece7f18c2022-07-28 05:50:56 +0100785 * \note If using an event-driven style of programming, an event must
Simon Butchere846b512016-03-01 17:31:49 +0000786 * be generated when the final delay is passed. The event must
787 * cause a call to \c mbedtls_ssl_handshake() with the proper
788 * SSL context to be scheduled. Care must be taken to ensure
789 * that at most one such call happens at a time.
790 *
791 * \note Only one timer at a time must be running. Calling this
792 * function while a timer is running must cancel it. Cancelled
793 * timers must not generate any event.
794 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100795typedef void mbedtls_ssl_set_timer_t(void *ctx,
796 uint32_t int_ms,
797 uint32_t fin_ms);
Simon Butchere846b512016-03-01 17:31:49 +0000798
799/**
800 * \brief Callback type: get status of timers/delays
801 *
802 * \param ctx Context pointer
803 *
804 * \return This callback must return:
805 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000806 * 0 if none of the delays have passed,
807 * 1 if only the intermediate delay has passed,
808 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000809 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100810typedef int mbedtls_ssl_get_timer_t(void *ctx);
Simon Butchere846b512016-03-01 17:31:49 +0000811
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200812/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813typedef struct mbedtls_ssl_session mbedtls_ssl_session;
814typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200815typedef struct mbedtls_ssl_config mbedtls_ssl_config;
816
Chris Jones3848e312021-03-11 16:17:59 +0000817/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200818typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
819typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100820typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200821#if defined(MBEDTLS_X509_CRT_PARSE_C)
822typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200823#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200824#if defined(MBEDTLS_SSL_PROTO_DTLS)
825typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200826#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000827
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000828#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000829#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100830 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK /* 1U << 0 */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000831#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION \
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL /* 1U << 2 */
833#define MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA (1U << 3)
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000834
835#define MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK \
Gilles Peskine449bd832023-01-11 14:50:10 +0100836 (MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION | \
837 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION | \
838 MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_EARLY_DATA)
Xiaokang Qianf447e8a2022-11-08 07:02:27 +0000839#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
Xiaokang Qian51c5a8b2022-11-16 08:32:51 +0000840
Hanno Becker02487852021-05-13 06:26:57 +0100841/**
842 * \brief Callback type: server-side session cache getter
843 *
844 * The session cache is logically a key value store, with
845 * keys being session IDs and values being instances of
846 * mbedtls_ssl_session.
847 *
848 * This callback retrieves an entry in this key-value store.
849 *
850 * \param data The address of the session cache structure to query.
851 * \param session_id The buffer holding the session ID to query.
852 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100853 * \param session The address of the session structure to populate.
854 * It is initialized with mbdtls_ssl_session_init(),
855 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100856 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100857 * mbedtls_ssl_session_free() independent of the
858 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100859 *
860 * \return \c 0 on success
861 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100862 *
Hanno Becker02487852021-05-13 06:26:57 +0100863 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100864typedef int mbedtls_ssl_cache_get_t(void *data,
865 unsigned char const *session_id,
866 size_t session_id_len,
867 mbedtls_ssl_session *session);
Hanno Becker02487852021-05-13 06:26:57 +0100868/**
869 * \brief Callback type: server-side session cache setter
870 *
871 * The session cache is logically a key value store, with
872 * keys being session IDs and values being instances of
873 * mbedtls_ssl_session.
874 *
875 * This callback sets an entry in this key-value store.
876 *
877 * \param data The address of the session cache structure to modify.
878 * \param session_id The buffer holding the session ID to query.
879 * \param session_id_len The length of \p session_id in Bytes.
880 * \param session The address of the session to be stored in the
881 * session cache.
882 *
883 * \return \c 0 on success
884 * \return A non-zero return value on failure.
885 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886typedef int mbedtls_ssl_cache_set_t(void *data,
887 unsigned char const *session_id,
888 size_t session_id_len,
889 const mbedtls_ssl_session *session);
Hanno Beckera637ff62021-04-15 08:42:48 +0100890
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200891#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100892#if defined(MBEDTLS_X509_CRT_PARSE_C)
893/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200894 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100895 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200896 * This callback is called during an SSL handshake to start
897 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200898 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100899 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200900 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100901 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200902 * This function typically sends or enqueues a request, and
903 * does not wait for the operation to complete. This allows
904 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100905 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200906 * The parameters \p ssl and \p cert are guaranteed to remain
907 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200908 * function must save the contents of \p hash if the value
909 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200910 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100911 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200912 * This function may call mbedtls_ssl_set_async_operation_data()
913 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200914 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200915 *
Gilles Peskined3268832018-04-26 06:23:59 +0200916 * \note For RSA signatures, this function must produce output
917 * that is consistent with PKCS#1 v1.5 in the same way as
918 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
919 * apply the padding steps described in RFC 8017, section 9.2
920 * "EMSA-PKCS1-v1_5" as follows.
921 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
922 * encoding, treating \p hash as the DigestInfo to be
923 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
924 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200925 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200926 * encoding, treating \p hash as the hash to be encoded and
927 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
928 * from step 2, with `digestAlgorithm` obtained by calling
929 * mbedtls_oid_get_oid_by_md() on \p md_alg.
930 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200931 * \note For ECDSA signatures, the output format is the DER encoding
932 * `Ecdsa-Sig-Value` defined in
933 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
934 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200935 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200936 * modified other than via
937 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200938 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200939 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200940 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200941 * connection. However, if other callbacks are used, this
942 * property may not hold. For example, if an SNI callback
943 * is registered with mbedtls_ssl_conf_sni(), then
944 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200945 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100946 * \param hash Buffer containing the hash. This buffer is
947 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200948 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100949 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200950 * \return 0 if the operation was started successfully and the SSL
951 * stack should call the resume callback immediately.
952 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
953 * was started successfully and the SSL stack should return
954 * immediately without calling the resume callback yet.
955 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
956 * processor does not support this key. The SSL stack will
957 * use the private key object instead.
958 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200959 * propagated up the call chain. The callback should
960 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
961 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200962 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100963 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100964typedef int mbedtls_ssl_async_sign_t(mbedtls_ssl_context *ssl,
965 mbedtls_x509_crt *cert,
966 mbedtls_md_type_t md_alg,
967 const unsigned char *hash,
968 size_t hash_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100969
970/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200971 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100972 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200973 * This callback is called during an SSL handshake to start
974 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200975 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100976 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200977 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100978 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200979 * This function typically sends or enqueues a request, and
980 * does not wait for the operation to complete. This allows
981 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100982 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200983 * The parameters \p ssl and \p cert are guaranteed to remain
984 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200985 * function must save the contents of \p input if the value
986 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200987 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100988 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200989 * This function may call mbedtls_ssl_set_async_operation_data()
990 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200991 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200992 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200993 * \warning RSA decryption as used in TLS is subject to a potential
994 * timing side channel attack first discovered by Bleichenbacher
995 * in 1998. This attack can be remotely exploitable
996 * in practice. To avoid this attack, you must ensure that
997 * if the callback performs an RSA decryption, the time it
998 * takes to execute and return the result does not depend
999 * on whether the RSA decryption succeeded or reported
1000 * invalid padding.
1001 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001002 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +02001003 * modified other than via
1004 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +02001005 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +02001006 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +02001007 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +02001008 * connection. However, if other callbacks are used, this
1009 * property may not hold. For example, if an SNI callback
1010 * is registered with mbedtls_ssl_conf_sni(), then
1011 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001012 * \param input Buffer containing the input ciphertext. This buffer
1013 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +02001014 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001015 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001016 * \return 0 if the operation was started successfully and the SSL
1017 * stack should call the resume callback immediately.
1018 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1019 * was started successfully and the SSL stack should return
1020 * immediately without calling the resume callback yet.
1021 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
1022 * processor does not support this key. The SSL stack will
1023 * use the private key object instead.
1024 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001025 * propagated up the call chain. The callback should
1026 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1027 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001028 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001029 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001030typedef int mbedtls_ssl_async_decrypt_t(mbedtls_ssl_context *ssl,
1031 mbedtls_x509_crt *cert,
1032 const unsigned char *input,
1033 size_t input_len);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001034#endif /* MBEDTLS_X509_CRT_PARSE_C */
1035
1036/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001037 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001038 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001039 * This callback is called during an SSL handshake to resume
1040 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +02001041 * ::mbedtls_ssl_async_sign_t or
1042 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +02001043 *
1044 * This function typically checks the status of a pending
1045 * request or causes the request queue to make progress, and
1046 * does not wait for the operation to complete. This allows
1047 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001048 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001049 * This function may call mbedtls_ssl_get_async_operation_data()
1050 * to retrieve an operation context set by the start callback.
1051 * It may call mbedtls_ssl_set_async_operation_data() to modify
1052 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001053 *
Gilles Peskineea5fab82018-04-30 13:57:45 +02001054 * Note that when this function returns a status other than
1055 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
1056 * resources associated with the operation.
1057 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001058 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +02001059 * modified other than via
1060 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +02001061 * \param output Buffer containing the output (signature or decrypted
1062 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +02001063 * \param output_len On success, number of bytes written to \p output.
1064 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001065 *
Gilles Peskine2481a712018-04-26 07:28:44 +02001066 * \return 0 if output of the operation is available in the
1067 * \p output buffer.
1068 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
1069 * is still in progress. Subsequent requests for progress
1070 * on the SSL connection will call the resume callback
1071 * again.
1072 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +02001073 * The SSL handshake is aborted. The callback should
1074 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
1075 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +02001076 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001077 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001078typedef int mbedtls_ssl_async_resume_t(mbedtls_ssl_context *ssl,
1079 unsigned char *output,
1080 size_t *output_len,
1081 size_t output_size);
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001082
1083/**
Gilles Peskinead28bf02018-04-26 00:19:16 +02001084 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001085 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001086 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +02001087 * while an asynchronous operation is in progress. Note that
1088 * this callback is not called if the
1089 * ::mbedtls_ssl_async_resume_t callback has run and has
1090 * returned a value other than
1091 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
1092 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001093 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001094 * This function may call mbedtls_ssl_get_async_operation_data()
1095 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001096 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001097 * \param ssl The SSL connection instance. It should not be
1098 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001099 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001100typedef void mbedtls_ssl_async_cancel_t(mbedtls_ssl_context *ssl);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001101#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +00001102
Gilles Peskineeccd8882020-03-10 12:19:08 +01001103#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001104 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +00001105#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
Manuel Pégourié-Gonnard93302422023-03-21 17:23:08 +01001106#if defined(MBEDTLS_MD_CAN_SHA256)
Hanno Becker9198ad12019-02-05 17:00:50 +00001107#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1108#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Manuel Pégourié-Gonnard93302422023-03-21 17:23:08 +01001109#elif defined(MBEDTLS_MD_CAN_SHA384)
Hanno Becker9198ad12019-02-05 17:00:50 +00001110#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1111#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
Manuel Pégourié-Gonnard93302422023-03-21 17:23:08 +01001112#elif defined(MBEDTLS_MD_CAN_SHA1)
Hanno Becker9198ad12019-02-05 17:00:50 +00001113#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1114#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1115#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001116/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +00001117#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1118#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +01001119#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001120 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001121
Gilles Peskine449bd832023-01-11 14:50:10 +01001122typedef struct {
1123 unsigned char client_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1124 unsigned char server_application_traffic_secret_N[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1125 unsigned char exporter_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
1126 unsigned char resumption_master_secret[MBEDTLS_TLS1_3_MD_MAX_SIZE];
Xiaofei Bai746f9482021-11-12 08:53:56 +00001127} mbedtls_ssl_tls13_application_secrets;
XiaokangQianaa5f5c12021-09-18 06:20:25 +00001128
Johan Pascalb62bb512015-12-03 21:56:45 +01001129#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001130
Johan Pascal85269572020-08-25 10:01:54 +02001131#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +02001132#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +01001133/*
Johan Pascal43f94902020-09-22 12:25:52 +02001134 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001135 *
1136 * Use_srtp extension protection profiles values as defined in
1137 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1138 *
1139 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1140 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +01001141 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001142#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ((uint16_t) 0x0001)
1143#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ((uint16_t) 0x0002)
1144#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ((uint16_t) 0x0005)
1145#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ((uint16_t) 0x0006)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001146/* This one is not iana defined, but for code readability. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001147#define MBEDTLS_TLS_SRTP_UNSET ((uint16_t) 0x0000)
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001148
Johan Pascal43f94902020-09-22 12:25:52 +02001149typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +03001150
Gilles Peskine449bd832023-01-11 14:50:10 +01001151typedef struct mbedtls_dtls_srtp_info_t {
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001152 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001153 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +02001154 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001155 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001156 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001157 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +03001158}
1159mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +02001160
Johan Pascalb62bb512015-12-03 21:56:45 +01001161#endif /* MBEDTLS_SSL_DTLS_SRTP */
1162
Glenn Straussdff84622022-03-14 11:12:57 -04001163/** Human-friendly representation of the (D)TLS protocol version. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001164typedef enum {
Glenn Straussdff84622022-03-14 11:12:57 -04001165 MBEDTLS_SSL_VERSION_UNKNOWN, /*!< Context not in use or version not yet negotiated. */
1166 MBEDTLS_SSL_VERSION_TLS1_2 = 0x0303, /*!< (D)TLS 1.2 */
1167 MBEDTLS_SSL_VERSION_TLS1_3 = 0x0304, /*!< (D)TLS 1.3 */
1168} mbedtls_ssl_protocol_version;
1169
Paul Bakker5121ce52009-01-03 21:22:43 +00001170/*
Paul Bakker0a597072012-09-25 21:55:46 +00001171 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001172 *
1173 * Note: when changing this definition, we need to check and update:
1174 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02001175 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001176 * - in library/ssl_tls.c:
1177 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1178 * mbedtls_ssl_session_save() and ssl_session_load()
1179 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +00001180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001181struct mbedtls_ssl_session {
Gilles Peskine8834d872021-11-29 12:36:50 +01001182#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1183 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
1184#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
1185
1186 unsigned char MBEDTLS_PRIVATE(exported);
1187
Ronald Cron217d6992022-04-04 10:23:22 +02001188 /** TLS version negotiated in the session. Used if and when renegotiating
1189 * or resuming a session instead of the configured minor TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001190 */
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001191 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Gilles Peskine8834d872021-11-29 12:36:50 +01001192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001193#if defined(MBEDTLS_HAVE_TIME)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001194 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +02001195#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001196 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001197 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
1198 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
1199 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +02001200
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +00001202#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001203 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +00001204#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001205 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
1206 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +02001207 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1208 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1209 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +00001210#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001212 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +02001213
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001214#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001215 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
1216 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
1217 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001218#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001219
Jerry Yua270f672022-07-07 06:51:06 +00001220#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_SESSION_TICKETS)
Xiaokang Qian03409292022-10-12 02:49:52 +00001221 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Jerry Yua66fece2022-07-13 14:30:29 +08001222 uint8_t MBEDTLS_PRIVATE(ticket_flags); /*!< Ticket flags */
Jerry Yua270f672022-07-07 06:51:06 +00001223 uint32_t MBEDTLS_PRIVATE(ticket_age_add); /*!< Randomly generated value used to obscure the age of the ticket */
Jerry Yu0a430c82022-07-20 11:02:48 +08001224 uint8_t MBEDTLS_PRIVATE(resumption_key_len); /*!< resumption_key length */
1225 unsigned char MBEDTLS_PRIVATE(resumption_key)[MBEDTLS_SSL_TLS1_3_TICKET_RESUMPTION_KEY_LEN];
Jerry Yua270f672022-07-07 06:51:06 +00001226
Xiaokang Qianed3afcd2022-10-12 08:31:11 +00001227#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) && defined(MBEDTLS_SSL_CLI_C)
1228 char *MBEDTLS_PRIVATE(hostname); /*!< host name binded with tickets */
1229#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION && MBEDTLS_SSL_CLI_C */
1230
Jerry Yua270f672022-07-07 06:51:06 +00001231#if defined(MBEDTLS_HAVE_TIME) && defined(MBEDTLS_SSL_CLI_C)
Jerry Yu08aed4d2022-07-20 10:36:12 +08001232 mbedtls_time_t MBEDTLS_PRIVATE(ticket_received); /*!< time ticket was received */
Jerry Yua270f672022-07-07 06:51:06 +00001233#endif /* MBEDTLS_HAVE_TIME && MBEDTLS_SSL_CLI_C */
1234
1235#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_SESSION_TICKETS */
1236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001238 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001239#endif
XiaokangQian33062842021-11-11 03:37:45 +00001240
Ronald Cron6f135e12021-12-08 16:57:54 +01001241#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001242 mbedtls_ssl_tls13_application_secrets MBEDTLS_PRIVATE(app_secrets);
Xiaokang Qianbaa47642022-10-12 10:21:27 +00001243#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001244};
1245
Hanno Becker457d6162021-05-24 10:27:39 +01001246/*
1247 * Identifiers for PRFs used in various versions of TLS.
1248 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001249typedef enum {
1250 MBEDTLS_SSL_TLS_PRF_NONE,
1251 MBEDTLS_SSL_TLS_PRF_SHA384,
1252 MBEDTLS_SSL_TLS_PRF_SHA256,
1253 MBEDTLS_SSL_HKDF_EXPAND_SHA384,
1254 MBEDTLS_SSL_HKDF_EXPAND_SHA256
Hanno Becker457d6162021-05-24 10:27:39 +01001255}
1256mbedtls_tls_prf_types;
1257
Gilles Peskine449bd832023-01-11 14:50:10 +01001258typedef enum {
Hanno Becker457d6162021-05-24 10:27:39 +01001259 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0,
Ronald Cron6f135e12021-12-08 16:57:54 +01001260#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Xiaofei Bai746f9482021-11-12 08:53:56 +00001261 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_EARLY_SECRET,
1262 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_EARLY_EXPORTER_SECRET,
1263 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1264 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1265 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_CLIENT_APPLICATION_TRAFFIC_SECRET,
1266 MBEDTLS_SSL_KEY_EXPORT_TLS1_3_SERVER_APPLICATION_TRAFFIC_SECRET,
Ronald Cron6f135e12021-12-08 16:57:54 +01001267#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker457d6162021-05-24 10:27:39 +01001268} mbedtls_ssl_key_export_type;
1269
1270/**
1271 * \brief Callback type: Export key alongside random values for
1272 * session identification, and PRF for
1273 * implementation of TLS key exporters.
1274 *
Hanno Beckerddc739c2021-05-28 05:10:38 +01001275 * \param p_expkey Context for the callback.
1276 * \param type The type of the key that is being exported.
1277 * \param secret The address of the buffer holding the secret
1278 * that's being exporterd.
1279 * \param secret_len The length of \p secret in bytes.
Hanno Becker457d6162021-05-24 10:27:39 +01001280 * \param client_random The client random bytes.
1281 * \param server_random The server random bytes.
1282 * \param tls_prf_type The identifier for the PRF used in the handshake
1283 * to which the key belongs.
Hanno Becker457d6162021-05-24 10:27:39 +01001284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001285typedef void mbedtls_ssl_export_keys_t(void *p_expkey,
1286 mbedtls_ssl_key_export_type type,
1287 const unsigned char *secret,
1288 size_t secret_len,
1289 const unsigned char client_random[32],
1290 const unsigned char server_random[32],
1291 mbedtls_tls_prf_types tls_prf_type);
Hanno Becker457d6162021-05-24 10:27:39 +01001292
Glenn Strauss236e17e2022-03-13 23:39:40 -04001293#if defined(MBEDTLS_SSL_SRV_C)
1294/**
1295 * \brief Callback type: generic handshake callback
1296 *
1297 * \note Callbacks may use user_data funcs to set/get app user data.
1298 * See \c mbedtls_ssl_get_user_data_p()
1299 * \c mbedtls_ssl_get_user_data_n()
1300 * \c mbedtls_ssl_conf_get_user_data_p()
1301 * \c mbedtls_ssl_conf_get_user_data_n()
1302 *
1303 * \param ssl \c mbedtls_ssl_context on which the callback is run
1304 *
1305 * \return The return value of the callback is 0 if successful,
1306 * or a specific MBEDTLS_ERR_XXX code, which will cause
1307 * the handshake to be aborted.
1308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001309typedef int (*mbedtls_ssl_hs_cb_t)(mbedtls_ssl_context *ssl);
Glenn Strauss236e17e2022-03-13 23:39:40 -04001310#endif
1311
Gilles Peskineded2a422022-02-12 00:20:08 +01001312/* A type for storing user data in a library structure.
1313 *
1314 * The representation of type may change in future versions of the library.
1315 * Only the behaviors guaranteed by documented accessor functions are
1316 * guaranteed to remain stable.
1317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001318typedef union {
Gilles Peskineded2a422022-02-12 00:20:08 +01001319 uintptr_t n; /* typically a handle to an associated object */
1320 void *p; /* typically a pointer to extra data */
1321} mbedtls_ssl_user_data_t;
1322
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001323/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001324 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001325 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001326struct mbedtls_ssl_config {
Gilles Peskine8834d872021-11-29 12:36:50 +01001327 /* Group items mostly by size. This helps to reduce memory wasted to
1328 * padding. It also helps to keep smaller fields early in the structure,
1329 * so that elements tend to be in the 128-element direct access window
1330 * on Arm Thumb, which reduces the code size. */
1331
Glenn Straussbbdc83b2022-04-12 07:31:46 -04001332 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(max_tls_version); /*!< max. TLS version used */
1333 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(min_tls_version); /*!< min. TLS version used */
Gilles Peskine8834d872021-11-29 12:36:50 +01001334
1335 /*
Gilles Peskine533a7282021-11-16 18:31:46 +01001336 * Flags (could be bit-fields to save RAM, but separate bytes make
1337 * the code smaller on architectures with an instruction for direct
1338 * byte access).
Gilles Peskine8834d872021-11-29 12:36:50 +01001339 */
1340
Gilles Peskine533a7282021-11-16 18:31:46 +01001341 uint8_t MBEDTLS_PRIVATE(endpoint); /*!< 0: client, 1: server */
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001342 uint8_t MBEDTLS_PRIVATE(transport); /*!< 0: stream (TLS), 1: datagram (DTLS) */
Gilles Peskine533a7282021-11-16 18:31:46 +01001343 uint8_t MBEDTLS_PRIVATE(authmode); /*!< MBEDTLS_SSL_VERIFY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001344 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Gilles Peskine533a7282021-11-16 18:31:46 +01001345 uint8_t MBEDTLS_PRIVATE(allow_legacy_renegotiation); /*!< MBEDTLS_LEGACY_XXX */
Gilles Peskine8834d872021-11-29 12:36:50 +01001346#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001347 uint8_t MBEDTLS_PRIVATE(mfl_code); /*!< desired fragment length indicator
1348 (MBEDTLS_SSL_MAX_FRAG_LEN_XXX) */
Gilles Peskine8834d872021-11-29 12:36:50 +01001349#endif
1350#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Gilles Peskine533a7282021-11-16 18:31:46 +01001351 uint8_t MBEDTLS_PRIVATE(encrypt_then_mac); /*!< negotiate encrypt-then-mac? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001352#endif
1353#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Gilles Peskine533a7282021-11-16 18:31:46 +01001354 uint8_t MBEDTLS_PRIVATE(extended_ms); /*!< negotiate extended master secret? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001355#endif
1356#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Gilles Peskine533a7282021-11-16 18:31:46 +01001357 uint8_t MBEDTLS_PRIVATE(anti_replay); /*!< detect and prevent replay? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001358#endif
1359#if defined(MBEDTLS_SSL_RENEGOTIATION)
Gilles Peskine533a7282021-11-16 18:31:46 +01001360 uint8_t MBEDTLS_PRIVATE(disable_renegotiation); /*!< disable renegotiation? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001361#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001362#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1363 defined(MBEDTLS_SSL_CLI_C)
1364 uint8_t MBEDTLS_PRIVATE(session_tickets); /*!< use session tickets? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001365#endif
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001366
1367#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
1368 defined(MBEDTLS_SSL_SRV_C) && \
1369 defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yud0766ec2022-09-22 10:46:57 +08001370 uint16_t MBEDTLS_PRIVATE(new_session_tickets_count); /*!< number of NewSessionTicket */
Jerry Yu1ad7ace2022-08-09 13:28:39 +08001371#endif
1372
Gilles Peskine8834d872021-11-29 12:36:50 +01001373#if defined(MBEDTLS_SSL_SRV_C)
Gilles Peskine533a7282021-11-16 18:31:46 +01001374 uint8_t MBEDTLS_PRIVATE(cert_req_ca_list); /*!< enable sending CA list in
1375 Certificate Request messages? */
1376 uint8_t MBEDTLS_PRIVATE(respect_cli_pref); /*!< pick the ciphersuite according to
1377 the client's preferences rather
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001378 than ours? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001379#endif
1380#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001381 uint8_t MBEDTLS_PRIVATE(ignore_unexpected_cid); /*!< Should DTLS record with
1382 * unexpected CID
1383 * lead to failure? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001384#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
1385#if defined(MBEDTLS_SSL_DTLS_SRTP)
Gilles Peskine533a7282021-11-16 18:31:46 +01001386 uint8_t MBEDTLS_PRIVATE(dtls_srtp_mki_support); /* support having mki_value
Gilles Peskineb3ec69d2021-12-08 18:32:12 +01001387 in the use_srtp extension? */
Gilles Peskine8834d872021-11-29 12:36:50 +01001388#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001389
1390 /*
1391 * Pointers
1392 */
1393
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001394 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +02001395 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001396
Ronald Cron6f135e12021-12-08 16:57:54 +01001397#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01001398 /** Allowed TLS 1.3 key exchange modes. */
1399 int MBEDTLS_PRIVATE(tls13_kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01001400#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker71f1ed62021-07-24 06:01:47 +01001401
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001402 /** Callback for printing debug output */
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 void(*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001404 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001405
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001406 /** Callback for getting (pseudo-)random numbers */
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 int(*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001408 void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001409
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001410 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001411 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001412 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001413 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
1414 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001415
1416#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1417 /** Callback for setting cert according to SNI extension */
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 int(*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001419 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001420#endif
1421
1422#if defined(MBEDTLS_X509_CRT_PARSE_C)
1423 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001425 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001426#endif
1427
Ronald Cron73fe8df2022-10-05 14:31:43 +02001428#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Jerry Yu8897c072022-08-12 13:56:53 +08001429#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001430 /** Callback to retrieve PSK key from identity */
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 int(*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001432 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001433#endif
Jerry Yu8897c072022-08-12 13:56:53 +08001434#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001435
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001436#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Tom Cosgrove1e211442022-05-26 11:51:00 +01001437 /** Callback to create & write a cookie for ClientHello verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 int(*MBEDTLS_PRIVATE(f_cookie_write))(void *, unsigned char **, unsigned char *,
1439 const unsigned char *, size_t);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001440 /** Callback to verify validity of a ClientHello cookie */
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 int(*MBEDTLS_PRIVATE(f_cookie_check))(void *, const unsigned char *, size_t,
1442 const unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001443 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001444#endif
1445
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001446#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001447 /** Callback to create & write a session ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 int(*MBEDTLS_PRIVATE(f_ticket_write))(void *, const mbedtls_ssl_session *,
1449 unsigned char *, const unsigned char *, size_t *,
1450 uint32_t *);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001451 /** Callback to parse a session ticket into a session structure */
Gilles Peskine449bd832023-01-11 14:50:10 +01001452 int(*MBEDTLS_PRIVATE(f_ticket_parse))(void *, mbedtls_ssl_session *, unsigned char *, size_t);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001453 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001454#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001455#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001456 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001457#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001458
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001459#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001460 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1461 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1462 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1463 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001464#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001465 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1466 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001467#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001468#endif /* MBEDTLS_X509_CRT_PARSE_C */
1469
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001470#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001471#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001472 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
1473 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start); /*!< start asynchronous decryption operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001474#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001475 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1476 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1477 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001478#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001479
Ronald Crone68ab4f2022-10-05 12:46:29 +02001480#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Hanno Becker1cd6e002021-08-10 13:27:10 +01001481
Jerry Yuf017ee42022-01-12 15:49:48 +08001482#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1483 const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */
1484#endif
1485 const uint16_t *MBEDTLS_PRIVATE(sig_algs); /*!< allowed signature algorithms */
Ronald Crone68ab4f2022-10-05 12:46:29 +02001486#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001487
Brett Warrene0edc842021-08-17 09:53:13 +01001488#if defined(MBEDTLS_ECP_C) && !defined(MBEDTLS_DEPRECATED_REMOVED)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001489 const mbedtls_ecp_group_id *MBEDTLS_PRIVATE(curve_list); /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001490#endif
1491
Brett Warrene0edc842021-08-17 09:53:13 +01001492 const uint16_t *MBEDTLS_PRIVATE(group_list); /*!< allowed IANA NamedGroups */
1493
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001494#if defined(MBEDTLS_DHM_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001495 mbedtls_mpi MBEDTLS_PRIVATE(dhm_P); /*!< prime modulus for DHM */
1496 mbedtls_mpi MBEDTLS_PRIVATE(dhm_G); /*!< generator for DHM */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001497#endif
1498
Ronald Cron73fe8df2022-10-05 14:31:43 +02001499#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001500
1501#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek03e01462022-01-03 12:53:24 +01001502 mbedtls_svc_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 * should only be set via
1504 * mbedtls_ssl_conf_psk_opaque().
1505 * If either no PSK or a raw PSK have been
1506 * configured, this has value \c 0.
1507 */
Neil Armstrong8ecd6682022-05-05 11:40:35 +02001508#endif /* MBEDTLS_USE_PSA_CRYPTO */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001509 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 * only be set via mbedtls_ssl_conf_psk().
1511 * If either no PSK or an opaque PSK
1512 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001513 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 * This field should only be set via
1515 * mbedtls_ssl_conf_psk().
1516 * Its value is non-zero if and only if
1517 * \c psk is not \c NULL. */
Hanno Becker43633132018-10-22 15:31:03 +01001518
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001519 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 * This field should only be set via
1521 * mbedtls_ssl_conf_psk().
1522 * This is set if and only if either
1523 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001524 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 * This field should only be set via
1526 * mbedtls_ssl_conf_psk().
1527 * Its value is non-zero if and only if
1528 * \c psk is not \c NULL or \c psk_opaque
1529 * is not \c 0. */
Ronald Cron73fe8df2022-10-05 14:31:43 +02001530#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001531
Xiaokang Qian54413b12022-10-20 05:57:03 +00001532#if defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian72de95d2022-10-25 02:54:33 +00001533 int MBEDTLS_PRIVATE(early_data_enabled); /*!< Early data enablement:
Xiaokang Qiand69d06f2022-10-25 06:51:25 +00001534 * - MBEDTLS_SSL_EARLY_DATA_DISABLED,
1535 * - MBEDTLS_SSL_EARLY_DATA_ENABLED */
Jerry Yucc4e0072022-11-22 17:22:22 +08001536
1537#if defined(MBEDTLS_SSL_SRV_C)
Jerry Yu12c46bd2022-12-06 11:02:51 +08001538 /* The maximum amount of 0-RTT data. RFC 8446 section 4.6.1 */
Jerry Yucc4e0072022-11-22 17:22:22 +08001539 uint32_t MBEDTLS_PRIVATE(max_early_data_size);
1540#endif /* MBEDTLS_SSL_SRV_C */
1541
Xiaokang Qian54413b12022-10-20 05:57:03 +00001542#endif /* MBEDTLS_SSL_EARLY_DATA */
1543
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001544#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001545 const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001546#endif
1547
Johan Pascalbbc057a2016-02-04 22:07:32 +01001548#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001549 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001550 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001551 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001552 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001553#endif /* MBEDTLS_SSL_DTLS_SRTP */
1554
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001555 /*
Gilles Peskine8834d872021-11-29 12:36:50 +01001556 * Numerical settings (int)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001557 */
1558
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001559 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001560
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001561#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001562 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001564 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001566#endif
1567
1568#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001569 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1570 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 that triggers renegotiation */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001572#endif
1573
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001574 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001575
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001576#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001577 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen); /*!< min. bit length of the DHM prime */
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001578#endif
Gilles Peskine69477b52022-01-13 01:01:45 +01001579
1580 /** User data pointer or handle.
1581 *
1582 * The library sets this to \p 0 when creating a context and does not
1583 * access it afterwards.
1584 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001585 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Glenn Strauss2ed95272022-01-21 18:02:17 -05001586
1587#if defined(MBEDTLS_SSL_SRV_C)
Glenn Strauss236e17e2022-03-13 23:39:40 -04001588 mbedtls_ssl_hs_cb_t MBEDTLS_PRIVATE(f_cert_cb); /*!< certificate selection callback */
Glenn Strauss2ed95272022-01-21 18:02:17 -05001589#endif /* MBEDTLS_SSL_SRV_C */
Glenn Strauss999ef702022-03-11 01:37:23 -05001590
1591#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
1592 const mbedtls_x509_crt *MBEDTLS_PRIVATE(dn_hints);/*!< acceptable client cert issuers */
1593#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001594};
1595
Gilles Peskine449bd832023-01-11 14:50:10 +01001596struct mbedtls_ssl_context {
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001597 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001598
Paul Bakker5121ce52009-01-03 21:22:43 +00001599 /*
1600 * Miscellaneous
1601 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001602 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001603#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001604 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1605 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 number of retransmissions of request if
1607 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001608#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001609
Ronald Cron217d6992022-04-04 10:23:22 +02001610 /** Server: Negotiated TLS protocol version.
1611 * Client: Maximum TLS version to be negotiated, then negotiated TLS
1612 * version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001613 *
Ronald Cron217d6992022-04-04 10:23:22 +02001614 * It is initialized as the maximum TLS version to be negotiated in the
1615 * ClientHello writing preparation stage and used throughout the
1616 * ClientHello writing. For a fresh handshake not linked to any previous
1617 * handshake, it is initialized to the configured maximum TLS version
1618 * to be negotiated. When renegotiating or resuming a session, it is
1619 * initialized to the previously negotiated TLS version.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001620 *
Ronald Cron217d6992022-04-04 10:23:22 +02001621 * Updated to the negotiated TLS version as soon as the ServerHello is
1622 * received.
Ronald Cronbdb4f582022-03-31 15:37:44 +02001623 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001624 mbedtls_ssl_protocol_version MBEDTLS_PRIVATE(tls_version);
Ronald Cronbdb4f582022-03-31 15:37:44 +02001625
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001626 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001627
Hanno Becker8927c832019-04-03 12:52:50 +01001628#if defined(MBEDTLS_X509_CRT_PARSE_C)
1629 /** Callback to customize X.509 certificate chain verification */
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 int(*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001631 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001632#endif
1633
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001634 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1635 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1636 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 /*!< Callback for network receive with timeout */
Simon Butchere846b512016-03-01 17:31:49 +00001638
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001639 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001640
Paul Bakker5121ce52009-01-03 21:22:43 +00001641 /*
1642 * Session layer
1643 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001644 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1645 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1646 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1647 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001648
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001649 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 the handshake process */
Paul Bakker48916f92012-09-16 19:57:18 +00001651
1652 /*
1653 * Record layer transformations
1654 */
Hanno Becker0e719ff2021-08-10 09:24:08 +01001655 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in)
1656 * This is always a reference,
1657 * never an owning pointer. */
1658 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (out)
1659 * This is always a reference,
1660 * never an owning pointer. */
1661 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params
1662 * This pointer owns the transform
1663 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001664#if defined(MBEDTLS_SSL_PROTO_TLS1_2)
Hanno Becker0e719ff2021-08-10 09:24:08 +01001665 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation
1666 * This pointer owns the transform
1667 * it references. */
Jerry Yu2e199812022-12-01 18:57:19 +08001668#endif /* MBEDTLS_SSL_PROTO_TLS1_2 */
Paul Bakker48916f92012-09-16 19:57:18 +00001669
Ronald Cron6f135e12021-12-08 16:57:54 +01001670#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Beckere043d152021-08-12 06:22:32 +01001671 /*! The application data transform in TLS 1.3.
1672 * This pointer owns the transform it references. */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001673 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
Ronald Cron6f135e12021-12-08 16:57:54 +01001674#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001675
Paul Bakker5121ce52009-01-03 21:22:43 +00001676 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001677 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001678 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001679 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001680
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001681 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1682 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001683
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001684 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001685 * Record layer (incoming data)
1686 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001687 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1688 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 TLS: maintained by us
1690 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001691 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001692#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001693 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001695#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001696 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1697 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1698 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1699 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001700
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001701 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1702 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1703 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001704#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001705 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001706#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001708 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1709 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001711#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001712#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001713 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1714 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001715#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001716
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001717 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 including the handshake header */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001719 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001720
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001721 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Gilles Peskine449bd832023-01-11 14:50:10 +01001722 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001723
Jerry Yue7047812021-09-13 19:26:39 +08001724 /* The following three variables indicate if and, if yes,
Jerry Yu394ece62021-09-14 22:17:21 +08001725 * what kind of alert is pending to be sent.
Jerry Yue7047812021-09-13 19:26:39 +08001726 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001727 unsigned char MBEDTLS_PRIVATE(send_alert); /*!< Determines if a fatal alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 should be sent. Values:
1729 - \c 0 , no alert is to be sent.
1730 - \c 1 , alert is to be sent. */
Jerry Yu33cedca2021-09-14 19:55:49 +08001731 unsigned char MBEDTLS_PRIVATE(alert_type); /*!< Type of alert if send_alert
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 != 0 */
Jerry Yu33cedca2021-09-14 19:55:49 +08001733 int MBEDTLS_PRIVATE(alert_reason); /*!< The error code to be returned
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 to the user once the fatal alert
1735 has been sent. */
Jerry Yue7047812021-09-13 19:26:39 +08001736
Hanno Becker04da1892018-08-14 13:22:10 +01001737#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001738 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 * within a single datagram. */
Hanno Becker04da1892018-08-14 13:22:10 +01001740#endif /* MBEDTLS_SSL_PROTO_DTLS */
1741
Paul Bakker5121ce52009-01-03 21:22:43 +00001742 /*
1743 * Record layer (outgoing data)
1744 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001745 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1746 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1747 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001748#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001749 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001751#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001752 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1753 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1754 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001755
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001756 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1757 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1758 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001759#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001760 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001761#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001762
Jerry Yuae0b2e22021-10-08 15:21:19 +08001763 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[MBEDTLS_SSL_SEQUENCE_NUMBER_LEN]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001764
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001765#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001766 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001767#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001768
Paul Bakker5121ce52009-01-03 21:22:43 +00001769 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001770 * User settings
1771 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001772#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001773 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001775#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001776
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001778 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001779#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001780
Johan Pascalb62bb512015-12-03 21:56:45 +01001781#if defined(MBEDTLS_SSL_DTLS_SRTP)
1782 /*
1783 * use_srtp extension
1784 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001785 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001786#endif /* MBEDTLS_SSL_DTLS_SRTP */
1787
Paul Bakker48916f92012-09-16 19:57:18 +00001788 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001789 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001790 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001791#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001792 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1793 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001794#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001795
1796 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001797 * Secure renegotiation
1798 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001799 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001800 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001802#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001803 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1804 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1805 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001806#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001807
Hanno Beckera0e20d02019-05-15 14:03:01 +01001808#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001809 /* CID configuration to use in subsequent handshakes. */
1810
1811 /*! The next incoming CID, chosen by the user and applying to
1812 * all subsequent handshakes. This may be different from the
1813 * CID currently used in case the user has re-configured the CID
1814 * after an initial handshake. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 unsigned char MBEDTLS_PRIVATE(own_cid)[MBEDTLS_SSL_CID_IN_LEN_MAX];
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001816 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1817 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 * be negotiated in the next handshake or not.
1819 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1820 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001821#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001822
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001823#if defined(MBEDTLS_SSL_EARLY_DATA) && defined(MBEDTLS_SSL_CLI_C)
Xiaokang Qian0e97d4d2022-10-24 11:12:51 +00001824 int MBEDTLS_PRIVATE(early_data_status);
1825#endif /* MBEDTLS_SSL_EARLY_DATA && MBEDTLS_SSL_CLI_C */
1826
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001827 /** Callback to export key block and master secret */
1828 mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys);
1829 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
Gilles Peskine69477b52022-01-13 01:01:45 +01001830
1831 /** User data pointer or handle.
1832 *
1833 * The library sets this to \p 0 when creating a context and does not
1834 * access it afterwards.
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01001835 *
1836 * \warning Serializing and restoring an SSL context with
1837 * mbedtls_ssl_context_save() and mbedtls_ssl_context_load()
1838 * does not currently restore the user data.
Gilles Peskine69477b52022-01-13 01:01:45 +01001839 */
Gilles Peskineded2a422022-02-12 00:20:08 +01001840 mbedtls_ssl_user_data_t MBEDTLS_PRIVATE(user_data);
Paul Bakker5121ce52009-01-03 21:22:43 +00001841};
1842
Paul Bakker5121ce52009-01-03 21:22:43 +00001843/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001844 * \brief Return the name of the ciphersuite associated with the
1845 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001846 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001847 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001848 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001849 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001850 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001851const char *mbedtls_ssl_get_ciphersuite_name(const int ciphersuite_id);
Paul Bakkere3166ce2011-01-27 17:40:50 +00001852
1853/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001854 * \brief Return the ID of the ciphersuite associated with the
1855 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001856 *
1857 * \param ciphersuite_name SSL ciphersuite name
1858 *
1859 * \return the ID with the ciphersuite or 0 if not found
1860 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001861int mbedtls_ssl_get_ciphersuite_id(const char *ciphersuite_name);
Paul Bakker72f62662011-01-16 21:27:44 +00001862
1863/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001864 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001865 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001866 * mbedtls_ssl_free()
1867 *
1868 * \param ssl SSL context
1869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001870void mbedtls_ssl_init(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001871
1872/**
1873 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001874 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001875 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001876 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001877 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001878 * \warning The conf structure will be accessed during the session.
1879 * It must not be modified or freed as long as the session
1880 * is active.
1881 *
1882 * \warning This function must be called exactly once per context.
1883 * Calling mbedtls_ssl_setup again is not supported, even
1884 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001885 *
Gilles Peskine5b7e1642022-08-04 23:44:59 +02001886 * \note If #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
1887 * subsystem must have been initialized by calling
1888 * psa_crypto_init() before calling this function.
1889 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001890 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001891 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001892 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001893 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001894 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001895 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001896int mbedtls_ssl_setup(mbedtls_ssl_context *ssl,
1897 const mbedtls_ssl_config *conf);
Paul Bakker5121ce52009-01-03 21:22:43 +00001898
1899/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001900 * \brief Reset an already initialized SSL context for re-use
1901 * while retaining application-set variables, function
1902 * pointers and data.
1903 *
1904 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001905 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
1906 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001908int mbedtls_ssl_session_reset(mbedtls_ssl_context *ssl);
Paul Bakker7eb013f2011-10-06 12:37:39 +00001909
1910/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001911 * \brief Set the current endpoint type
1912 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001913 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001914 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001915 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001916void mbedtls_ssl_conf_endpoint(mbedtls_ssl_config *conf, int endpoint);
Paul Bakker5121ce52009-01-03 21:22:43 +00001917
1918/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001919 * \brief Set the transport type (TLS or DTLS).
1920 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001921 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001922 * \note For DTLS, you must either provide a recv callback that
1923 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001924 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1925 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001926 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001927 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001928 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1930 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001931 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001932void mbedtls_ssl_conf_transport(mbedtls_ssl_config *conf, int transport);
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001933
1934/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001935 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001936 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001937 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001938 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001939 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001940 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001941 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001942 * (default on server)
1943 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001944 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001945 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001946 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001947 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001948 * handshake is complete.
1949 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001950 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001951 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001952 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001953 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1955 * 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 +01001956 * the right time(s), which may not be obvious, while REQUIRED always perform
1957 * the verification as soon as possible. For example, REQUIRED was protecting
1958 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001959 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001960void mbedtls_ssl_conf_authmode(mbedtls_ssl_config *conf, int authmode);
Paul Bakker5121ce52009-01-03 21:22:43 +00001961
Xiaokang Qiand69d06f2022-10-25 06:51:25 +00001962#if defined(MBEDTLS_SSL_PROTO_TLS1_3) && defined(MBEDTLS_SSL_EARLY_DATA)
Xiaokang Qian54413b12022-10-20 05:57:03 +00001963/**
Gilles Peskine449bd832023-01-11 14:50:10 +01001964 * \brief Set the early data mode
1965 * Default: disabled on server and client
1966 *
1967 * \param conf The SSL configuration to use.
1968 * \param early_data_enabled can be:
1969 *
1970 * MBEDTLS_SSL_EARLY_DATA_DISABLED: early data functionality is disabled
1971 * This is the default on client and server.
1972 *
1973 * MBEDTLS_SSL_EARLY_DATA_ENABLED: early data functionality is enabled and
1974 * may be negotiated in the handshake. Application using
1975 * early data functionality needs to be aware of the
1976 * lack of replay protection of the early data application
1977 * payloads.
1978 *
1979 * \warning This interface is experimental and may change without notice.
1980 *
1981 */
1982void mbedtls_ssl_tls13_conf_early_data(mbedtls_ssl_config *conf,
1983 int early_data_enabled);
Jerry Yucc4e0072022-11-22 17:22:22 +08001984
1985#if defined(MBEDTLS_SSL_SRV_C)
1986/**
Jerry Yu12c46bd2022-12-06 11:02:51 +08001987 * \brief Set the maximum amount of 0-RTT data in bytes
1988 * Default: #MBEDTLS_SSL_MAX_EARLY_DATA_SIZE
1989 *
1990 * This function sets the value of the max_early_data_size
1991 * field of the early data indication extension included in
1992 * the NewSessionTicket messages that the server may send.
1993 *
1994 * The value defines the maximum amount of 0-RTT data
1995 * in bytes that a client will be allowed to send when using
1996 * one of the tickets defined by the NewSessionTicket messages.
1997 *
1998 * \note When resuming a session using a ticket, if the server receives more
1999 * early data than allowed for the ticket, it terminates the connection.
2000 * The maximum amount of 0-RTT data should thus be large enough
2001 * to allow a minimum of early data to be exchanged.
Jerry Yucc4e0072022-11-22 17:22:22 +08002002 *
2003 * \param[in] conf The SSL configuration to use.
2004 * \param[in] max_early_data_size The maximum amount of 0-RTT data.
Jerry Yucc4e0072022-11-22 17:22:22 +08002005 *
2006 * \warning This interface is experimental and may change without notice.
2007 *
2008 */
2009void mbedtls_ssl_tls13_conf_max_early_data_size(
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 mbedtls_ssl_config *conf, uint32_t max_early_data_size);
Jerry Yucc4e0072022-11-22 17:22:22 +08002011#endif /* MBEDTLS_SSL_SRV_C */
2012
Xiaokang Qian54413b12022-10-20 05:57:03 +00002013#endif /* MBEDTLS_SSL_PROTO_TLS1_3 && MBEDTLS_SSL_EARLY_DATA */
2014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002016/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002017 * \brief Set the verification callback (Optional).
2018 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002019 * If set, the provided verify callback is called for each
2020 * certificate in the peer's CRT chain, including the trusted
2021 * root. For more information, please see the documentation of
2022 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002023 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01002024 * \note For per context callbacks and contexts, please use
2025 * mbedtls_ssl_set_verify() instead.
2026 *
2027 * \param conf The SSL configuration to use.
2028 * \param f_vrfy The verification callback to use during CRT verification.
2029 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002030 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002031void mbedtls_ssl_conf_verify(mbedtls_ssl_config *conf,
2032 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2033 void *p_vrfy);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00002035
2036/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002037 * \brief Set the random number generator callback
2038 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01002039 * \param conf SSL configuration
Manuel Pégourié-Gonnardad5390f2021-06-15 11:29:26 +02002040 * \param f_rng RNG function (mandatory)
Paul Bakker5121ce52009-01-03 21:22:43 +00002041 * \param p_rng RNG parameter
2042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002043void mbedtls_ssl_conf_rng(mbedtls_ssl_config *conf,
2044 int (*f_rng)(void *, unsigned char *, size_t),
2045 void *p_rng);
Paul Bakker5121ce52009-01-03 21:22:43 +00002046
2047/**
2048 * \brief Set the debug callback
2049 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02002050 * The callback has the following argument:
2051 * void * opaque context for the callback
2052 * int debug level
2053 * const char * file name
2054 * int line number
2055 * const char * message
2056 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002057 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002058 * \param f_dbg debug function
2059 * \param p_dbg debug parameter
2060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002061void mbedtls_ssl_conf_dbg(mbedtls_ssl_config *conf,
2062 void (*f_dbg)(void *, int, const char *, int, const char *),
2063 void *p_dbg);
Paul Bakker5121ce52009-01-03 21:22:43 +00002064
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002065/**
Gilles Peskine915896f2022-01-13 01:05:10 +01002066 * \brief Return the SSL configuration structure associated
2067 * with the given SSL context.
2068 *
2069 * \note The pointer returned by this function is guaranteed to
2070 * remain valid until the context is freed.
2071 *
2072 * \param ssl The SSL context to query.
2073 * \return Pointer to the SSL configuration associated with \p ssl.
2074 */
2075static inline const mbedtls_ssl_config *mbedtls_ssl_context_get_config(
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 const mbedtls_ssl_context *ssl)
Gilles Peskine915896f2022-01-13 01:05:10 +01002077{
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 return ssl->MBEDTLS_PRIVATE(conf);
Gilles Peskine915896f2022-01-13 01:05:10 +01002079}
2080
2081/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002082 * \brief Set the underlying BIO callbacks for write, read and
2083 * read-with-timeout.
2084 *
2085 * \param ssl SSL context
2086 * \param p_bio parameter (context) shared by BIO callbacks
2087 * \param f_send write callback
2088 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002089 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002090 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002091 * \note One of f_recv or f_recv_timeout can be NULL, in which case
2092 * the other is used. If both are non-NULL, f_recv_timeout is
2093 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002094 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002095 * \note The two most common use cases are:
2096 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
bootstrap-prime6dbbf442022-05-17 19:30:44 -04002097 * - blocking I/O, f_recv == NULL, f_recv_timeout != NULL
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002098 *
2099 * \note For DTLS, you need to provide either a non-NULL
2100 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002101 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07002102 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002103 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00002104 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002105 *
Andres AG3616f6f2016-09-14 14:32:09 +01002106 * \note On some platforms, net_sockets.c provides
2107 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
2108 * \c mbedtls_net_recv_timeout() that are suitable to be used
2109 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002110 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002111void mbedtls_ssl_set_bio(mbedtls_ssl_context *ssl,
2112 void *p_bio,
2113 mbedtls_ssl_send_t *f_send,
2114 mbedtls_ssl_recv_t *f_recv,
2115 mbedtls_ssl_recv_timeout_t *f_recv_timeout);
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002116
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002117#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01002118
Hanno Beckera0e20d02019-05-15 14:03:01 +01002119#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01002120
2121
2122/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01002123 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01002124 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01002125 *
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002126 * Reference: RFC 9146 (or draft-ietf-tls-dtls-connection-id-05
Hanno Beckerebcc9132019-05-15 10:26:32 +01002127 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hannes Tschofenigfd6cca42021-10-12 09:22:33 +02002128 * for legacy version)
Hanno Becker019f4b52019-04-09 15:12:56 +01002129 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01002130 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01002131 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01002132 * underlying transport (changed IP and Port metadata) by
2133 * adding explicit connection identifiers (CIDs) to the
2134 * headers of encrypted DTLS records. The desired CIDs are
2135 * configured by the application layer and are exchanged in
2136 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01002137 * handshake, where each side indicates the CID it wants the
2138 * peer to use when writing encrypted messages. The CIDs are
2139 * put to use once records get encrypted: the stack discards
2140 * any incoming records that don't include the configured CID
2141 * in their header, and adds the peer's requested CID to the
2142 * headers of outgoing messages.
2143 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01002144 * This API enables or disables the use of the CID extension
2145 * in the next handshake and sets the value of the CID to
2146 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01002147 *
2148 * \param ssl The SSL context to configure. This must be initialized.
2149 * \param enable This value determines whether the CID extension should
2150 * be used or not. Possible values are:
2151 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01002152 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
2153 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01002154 * \param own_cid The address of the readable buffer holding the CID we want
2155 * the peer to use when sending encrypted messages to us.
2156 * This may be \c NULL if \p own_cid_len is \c 0.
2157 * This parameter is unused if \p enabled is set to
2158 * MBEDTLS_SSL_CID_DISABLED.
2159 * \param own_cid_len The length of \p own_cid.
2160 * This parameter is unused if \p enabled is set to
2161 * MBEDTLS_SSL_CID_DISABLED.
2162 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01002163 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01002164 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01002165 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01002166 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002167 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01002168 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01002169 * performed on the SSL context \p ssl, but does not trigger
2170 * one. You still have to call `mbedtls_ssl_handshake()`
2171 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
2172 * (for a renegotiation handshake) explicitly after a
2173 * successful call to this function to run the handshake.
2174 *
2175 * \note This call cannot guarantee that the use of the CID
2176 * will be successfully negotiated in the next handshake,
2177 * because the peer might not support it. Specifically:
2178 * - On the Client, enabling the use of the CID through
2179 * this call implies that the `ClientHello` in the next
2180 * handshake will include the CID extension, thereby
2181 * offering the use of the CID to the server. Only if
2182 * the `ServerHello` contains the CID extension, too,
2183 * the CID extension will actually be put to use.
2184 * - On the Server, enabling the use of the CID through
Tom Cosgrove1797b052022-12-04 17:19:59 +00002185 * this call implies that the server will look for
Hanno Becker019f4b52019-04-09 15:12:56 +01002186 * the CID extension in a `ClientHello` from the client,
2187 * and, if present, reply with a CID extension in its
2188 * `ServerHello`.
2189 *
2190 * \note To check whether the use of the CID was negotiated
2191 * after the subsequent handshake has completed, please
2192 * use the API mbedtls_ssl_get_peer_cid().
2193 *
2194 * \warning If the use of the CID extension is enabled in this call
2195 * and the subsequent handshake negotiates its use, Mbed TLS
2196 * will silently drop every packet whose CID does not match
2197 * the CID configured in \p own_cid. It is the responsibility
2198 * of the user to adapt the underlying transport to take care
2199 * of CID-based demultiplexing before handing datagrams to
2200 * Mbed TLS.
2201 *
2202 * \return \c 0 on success. In this case, the CID configuration
2203 * applies to the next handshake.
2204 * \return A negative error code on failure.
2205 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002206int mbedtls_ssl_set_cid(mbedtls_ssl_context *ssl,
2207 int enable,
2208 unsigned char const *own_cid,
2209 size_t own_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002210
2211/**
Paul Elliott0113cf12022-03-11 20:26:47 +00002212 * \brief Get information about our request for usage of the CID
2213 * extension in the current connection.
2214 *
2215 * \param ssl The SSL context to query.
2216 * \param enabled The address at which to store whether the CID extension
2217 * is requested to be used or not. If the CID is
2218 * requested, `*enabled` is set to
2219 * MBEDTLS_SSL_CID_ENABLED; otherwise, it is set to
2220 * MBEDTLS_SSL_CID_DISABLED.
2221 * \param own_cid The address of the buffer in which to store our own
2222 * CID (if the CID extension is requested). This may be
2223 * \c NULL in case the value of our CID isn't needed. If
2224 * it is not \c NULL, \p own_cid_len must not be \c NULL.
2225 * \param own_cid_len The address at which to store the size of our own CID
2226 * (if the CID extension is requested). This is also the
2227 * number of Bytes in \p own_cid that have been written.
2228 * This may be \c NULL in case the length of our own CID
2229 * isn't needed. If it is \c NULL, \p own_cid must be
2230 * \c NULL, too.
2231 *
2232 *\note If we are requesting an empty CID this function sets
2233 * `*enabled` to #MBEDTLS_SSL_CID_DISABLED (the rationale
2234 * for this is that the resulting outcome is the
2235 * same as if the CID extensions wasn't requested).
2236 *
2237 * \return \c 0 on success.
2238 * \return A negative error code on failure.
2239 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002240int mbedtls_ssl_get_own_cid(mbedtls_ssl_context *ssl,
Paul Elliott0113cf12022-03-11 20:26:47 +00002241 int *enabled,
2242 unsigned char own_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
Gilles Peskine449bd832023-01-11 14:50:10 +01002243 size_t *own_cid_len);
Paul Elliott0113cf12022-03-11 20:26:47 +00002244
2245/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01002246 * \brief Get information about the use of the CID extension
2247 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01002248 *
2249 * \param ssl The SSL context to query.
2250 * \param enabled The address at which to store whether the CID extension
2251 * is currently in use or not. If the CID is in use,
2252 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
2253 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
2254 * \param peer_cid The address of the buffer in which to store the CID
2255 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01002256 * This may be \c NULL in case the value of peer CID
2257 * isn't needed. If it is not \c NULL, \p peer_cid_len
2258 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01002259 * \param peer_cid_len The address at which to store the size of the CID
2260 * chosen by the peer (if the CID extension is used).
2261 * This is also the number of Bytes in \p peer_cid that
2262 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01002263 * This may be \c NULL in case the length of the peer CID
2264 * isn't needed. If it is \c NULL, \p peer_cid must be
2265 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01002266 *
2267 * \note This applies to the state of the CID negotiated in
2268 * the last complete handshake. If a handshake is in
2269 * progress, this function will attempt to complete
2270 * the handshake first.
2271 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01002272 * \note If CID extensions have been exchanged but both client
2273 * and server chose to use an empty CID, this function
2274 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
2275 * (the rationale for this is that the resulting
2276 * communication is the same as if the CID extensions
2277 * hadn't been used).
2278 *
Hanno Becker019f4b52019-04-09 15:12:56 +01002279 * \return \c 0 on success.
2280 * \return A negative error code on failure.
2281 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002282int mbedtls_ssl_get_peer_cid(mbedtls_ssl_context *ssl,
2283 int *enabled,
2284 unsigned char peer_cid[MBEDTLS_SSL_CID_OUT_LEN_MAX],
2285 size_t *peer_cid_len);
Hanno Becker019f4b52019-04-09 15:12:56 +01002286
Hanno Beckera0e20d02019-05-15 14:03:01 +01002287#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01002288
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002289/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08002290 * \brief Set the Maximum Transport Unit (MTU).
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002291 * Special value: 0 means unset (no limit).
2292 * This represents the maximum size of a datagram payload
2293 * handled by the transport layer (usually UDP) as determined
2294 * by the network link and stack. In practice, this controls
2295 * the maximum size datagram the DTLS layer will pass to the
2296 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
2297 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002298 * \note The limit on datagram size is converted to a limit on
2299 * record payload by subtracting the current overhead of
2300 * encapsulation and encryption/authentication if any.
2301 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002302 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01002303 * example when a Path Maximum Transfer Unit (PMTU)
2304 * estimate becomes available from other sources,
2305 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002306 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002307 * \note This setting only controls the size of the packets we send,
2308 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02002309 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02002310 * server to use smaller records with \c
2311 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002312 *
2313 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002314 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002315 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002316 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002317 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02002318 * of datagrams (hence records, see first note) sent. It
2319 * cannot be used to increase the maximum size of records over
2320 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02002321 *
2322 * \note Values lower than the current record layer expansion will
2323 * result in an error when trying to send data.
2324 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002325 * \param ssl SSL context
2326 * \param mtu Value of the path MTU in bytes
2327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002328void mbedtls_ssl_set_mtu(mbedtls_ssl_context *ssl, uint16_t mtu);
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002329#endif /* MBEDTLS_SSL_PROTO_DTLS */
2330
Hanno Becker726c97a2019-04-03 12:52:35 +01002331#if defined(MBEDTLS_X509_CRT_PARSE_C)
2332/**
2333 * \brief Set a connection-specific verification callback (optional).
2334 *
2335 * If set, the provided verify callback is called for each
2336 * certificate in the peer's CRT chain, including the trusted
2337 * root. For more information, please see the documentation of
2338 * \c mbedtls_x509_crt_verify().
2339 *
2340 * \note This call is analogous to mbedtls_ssl_conf_verify() but
2341 * binds the verification callback and context to an SSL context
2342 * as opposed to an SSL configuration.
2343 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
2344 * are both used, mbedtls_ssl_set_verify() takes precedence.
2345 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01002346 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01002347 * \param f_vrfy The verification callback to use during CRT verification.
2348 * \param p_vrfy The opaque context to be passed to the callback.
2349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002350void mbedtls_ssl_set_verify(mbedtls_ssl_context *ssl,
2351 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2352 void *p_vrfy);
Hanno Becker726c97a2019-04-03 12:52:35 +01002353#endif /* MBEDTLS_X509_CRT_PARSE_C */
2354
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002355/**
2356 * \brief Set the timeout period for mbedtls_ssl_read()
2357 * (Default: no timeout.)
2358 *
2359 * \param conf SSL configuration context
2360 * \param timeout Timeout value in milliseconds.
2361 * Use 0 for no timeout (default).
2362 *
2363 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002364 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002365 * With non-blocking I/O, this will only work if timer
2366 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
2367 *
2368 * \note With non-blocking I/O, you may also skip this function
2369 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002370 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002371void mbedtls_ssl_conf_read_timeout(mbedtls_ssl_config *conf, uint32_t timeout);
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002372
Hanno Beckercfe45792019-07-03 16:13:00 +01002373/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002374 * \brief Check whether a buffer contains a valid and authentic record
2375 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01002376 *
2377 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01002378 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01002379 * an indication of the legitimacy of an incoming record.
2380 *
2381 * This can be useful e.g. in distributed server environments
2382 * using the DTLS Connection ID feature, in which connections
2383 * might need to be passed between service instances on a change
2384 * of peer address, but where such disruptive operations should
2385 * only happen after the validity of incoming records has been
2386 * confirmed.
2387 *
2388 * \param ssl The SSL context to use.
2389 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002390 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01002391 * \param buflen The length of \p buf in Bytes.
2392 *
2393 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002394 * with a valid and authentic record that has not been seen
2395 * before, but does not check potential data following the
2396 * initial record. In particular, it is possible to pass DTLS
2397 * datagrams containing multiple records, in which case only
2398 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01002399 *
2400 * \note This function modifies the input buffer \p buf. If you need
2401 * to preserve the original record, you have to maintain a copy.
2402 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002403 * \return \c 0 if the record is valid and authentic and has not been
2404 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01002405 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
2406 * successfully but the record was found to be not authentic.
2407 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
2408 * successfully but the record was found to be invalid for
2409 * a reason different from authenticity checking.
2410 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
2411 * successfully but the record was found to be unexpected
2412 * in the state of the SSL context, including replayed records.
2413 * \return Another negative error code on different kinds of failure.
2414 * In this case, the SSL context becomes unusable and needs
2415 * to be freed or reset before reuse.
2416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002417int mbedtls_ssl_check_record(mbedtls_ssl_context const *ssl,
2418 unsigned char *buf,
2419 size_t buflen);
Hanno Beckercfe45792019-07-03 16:13:00 +01002420
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002421/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002422 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002423 *
2424 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002425 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002426 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002427 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002428 *
2429 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
2430 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02002431 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002432 *
2433 * \note On some platforms, timing.c provides
2434 * \c mbedtls_timing_set_delay() and
2435 * \c mbedtls_timing_get_delay() that are suitable for using
2436 * here, except if using an event-driven style.
2437 *
2438 * \note See also the "DTLS tutorial" article in our knowledge base.
Dave Rodgmanb3196842022-10-12 16:47:08 +01002439 * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002440 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002441void mbedtls_ssl_set_timer_cb(mbedtls_ssl_context *ssl,
2442 void *p_timer,
2443 mbedtls_ssl_set_timer_t *f_set_timer,
2444 mbedtls_ssl_get_timer_t *f_get_timer);
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002445
Glenn Strauss2ed95272022-01-21 18:02:17 -05002446#if defined(MBEDTLS_SSL_SRV_C)
2447/**
2448 * \brief Set the certificate selection callback (server-side only).
2449 *
2450 * If set, the callback is always called for each handshake,
2451 * after `ClientHello` processing has finished.
2452 *
Glenn Strauss2ed95272022-01-21 18:02:17 -05002453 * \param conf The SSL configuration to register the callback with.
2454 * \param f_cert_cb The callback for selecting server certificate after
2455 * `ClientHello` processing has finished.
2456 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002457static inline void mbedtls_ssl_conf_cert_cb(mbedtls_ssl_config *conf,
2458 mbedtls_ssl_hs_cb_t f_cert_cb)
Glenn Strauss236e17e2022-03-13 23:39:40 -04002459{
2460 conf->MBEDTLS_PRIVATE(f_cert_cb) = f_cert_cb;
2461}
Glenn Strauss2ed95272022-01-21 18:02:17 -05002462#endif /* MBEDTLS_SSL_SRV_C */
2463
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002464/**
2465 * \brief Callback type: generate and write session ticket
2466 *
2467 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002468 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002469 * authenticated ticket for the session and write it to the
2470 * output buffer. Here, ticket means the opaque ticket part
2471 * of the NewSessionTicket structure of RFC 5077.
2472 *
2473 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002474 * \param session SSL session to be written in the ticket
2475 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002476 * \param end End of the output buffer
2477 * \param tlen On exit, holds the length written
2478 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2479 *
2480 * \return 0 if successful, or
2481 * a specific MBEDTLS_ERR_XXX code.
2482 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002483typedef int mbedtls_ssl_ticket_write_t(void *p_ticket,
2484 const mbedtls_ssl_session *session,
2485 unsigned char *start,
2486 const unsigned char *end,
2487 size_t *tlen,
2488 uint32_t *lifetime);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002489
2490/**
2491 * \brief Callback type: parse and load session ticket
2492 *
2493 * \note This describes what a callback implementation should do.
2494 * This callback should parse a session ticket as generated
2495 * by the corresponding mbedtls_ssl_ticket_write_t function,
2496 * and, if the ticket is authentic and valid, load the
2497 * session.
2498 *
2499 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002500 * bytes of the input buffer, eg to use it as a temporary
2501 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002502 *
2503 * \param p_ticket Context for the callback
2504 * \param session SSL session to be loaded
2505 * \param buf Start of the buffer containing the ticket
2506 * \param len Length of the ticket.
2507 *
2508 * \return 0 if successful, or
2509 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2510 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2511 * any other non-zero code for other failures.
2512 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002513typedef int mbedtls_ssl_ticket_parse_t(void *p_ticket,
2514 mbedtls_ssl_session *session,
2515 unsigned char *buf,
2516 size_t len);
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002517
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002518#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002519/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002520 * \brief Configure SSL session ticket callbacks (server only).
2521 * (Default: none.)
2522 *
2523 * \note On server, session tickets are enabled by providing
2524 * non-NULL callbacks.
2525 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002526 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002527 *
2528 * \param conf SSL configuration context
2529 * \param f_ticket_write Callback for writing a ticket
2530 * \param f_ticket_parse Callback for parsing a ticket
2531 * \param p_ticket Context shared by the two callbacks
2532 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002533void mbedtls_ssl_conf_session_tickets_cb(mbedtls_ssl_config *conf,
2534 mbedtls_ssl_ticket_write_t *f_ticket_write,
2535 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2536 void *p_ticket);
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002537#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002538
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002539/**
Hanno Becker457d6162021-05-24 10:27:39 +01002540 * \brief Configure a key export callback.
2541 * (Default: none.)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002542 *
Hanno Becker457d6162021-05-24 10:27:39 +01002543 * This API can be used for two purposes:
2544 * - Debugging: Use this API to e.g. generate an NSSKeylog
2545 * file and use it to inspect encrypted traffic in tools
2546 * such as Wireshark.
2547 * - Application-specific export: Use this API to implement
2548 * key exporters, e.g. for EAP-TLS or DTLS-SRTP.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002549 *
Hanno Becker457d6162021-05-24 10:27:39 +01002550 *
Hanno Becker7e6c1782021-06-08 09:24:55 +01002551 * \param ssl The SSL context to which the export
2552 * callback should be attached.
Hanno Becker457d6162021-05-24 10:27:39 +01002553 * \param f_export_keys The callback for the key export.
2554 * \param p_export_keys The opaque context pointer to be passed to the
2555 * callback \p f_export_keys.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002556 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002557void mbedtls_ssl_set_export_keys_cb(mbedtls_ssl_context *ssl,
2558 mbedtls_ssl_export_keys_t *f_export_keys,
2559 void *p_export_keys);
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002560
Gilles Peskine80dae042022-01-21 23:50:39 +01002561/** \brief Set the user data in an SSL configuration to a pointer.
2562 *
2563 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_p().
2564 *
2565 * \note The library stores \c p without accessing it. It is the responsibility
2566 * of the caller to ensure that the pointer remains valid.
2567 *
2568 * \param conf The SSL configuration context to modify.
2569 * \param p The new value of the user data.
2570 */
2571static inline void mbedtls_ssl_conf_set_user_data_p(
2572 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002574{
Gilles Peskineded2a422022-02-12 00:20:08 +01002575 conf->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002576}
2577
2578/** \brief Set the user data in an SSL configuration to an integer.
2579 *
2580 * You can retrieve this value later with mbedtls_ssl_conf_get_user_data_n().
2581 *
2582 * \param conf The SSL configuration context to modify.
2583 * \param n The new value of the user data.
2584 */
2585static inline void mbedtls_ssl_conf_set_user_data_n(
2586 mbedtls_ssl_config *conf,
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002588{
Gilles Peskineded2a422022-02-12 00:20:08 +01002589 conf->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002590}
2591
2592/** \brief Retrieve the user data in an SSL configuration as a pointer.
2593 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002594 * This is the value last set with mbedtls_ssl_conf_set_user_data_p(), or
2595 * \c NULL if mbedtls_ssl_conf_set_user_data_p() has not previously been
2596 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_n() has
2597 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002598 *
2599 * \param conf The SSL configuration context to modify.
2600 * \return The current value of the user data.
2601 */
2602static inline void *mbedtls_ssl_conf_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002604{
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 return conf->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002606}
2607
2608/** \brief Retrieve the user data in an SSL configuration as an integer.
2609 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002610 * This is the value last set with mbedtls_ssl_conf_set_user_data_n(), or
2611 * \c 0 if mbedtls_ssl_conf_set_user_data_n() has not previously been
2612 * called. The value is undefined if mbedtls_ssl_conf_set_user_data_p() has
2613 * been called without a subsequent call to mbedtls_ssl_conf_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002614 *
2615 * \param conf The SSL configuration context to modify.
2616 * \return The current value of the user data.
2617 */
2618static inline uintptr_t mbedtls_ssl_conf_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 mbedtls_ssl_config *conf)
Gilles Peskine80dae042022-01-21 23:50:39 +01002620{
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 return conf->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002622}
2623
2624/** \brief Set the user data in an SSL context to a pointer.
2625 *
2626 * You can retrieve this value later with mbedtls_ssl_get_user_data_p().
2627 *
2628 * \note The library stores \c p without accessing it. It is the responsibility
2629 * of the caller to ensure that the pointer remains valid.
2630 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002631 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002632 * \param p The new value of the user data.
2633 */
2634static inline void mbedtls_ssl_set_user_data_p(
2635 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 void *p)
Gilles Peskine80dae042022-01-21 23:50:39 +01002637{
Gilles Peskineded2a422022-02-12 00:20:08 +01002638 ssl->MBEDTLS_PRIVATE(user_data).p = p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002639}
2640
2641/** \brief Set the user data in an SSL context to an integer.
2642 *
2643 * You can retrieve this value later with mbedtls_ssl_get_user_data_n().
2644 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002645 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002646 * \param n The new value of the user data.
2647 */
2648static inline void mbedtls_ssl_set_user_data_n(
2649 mbedtls_ssl_context *ssl,
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 uintptr_t n)
Gilles Peskine80dae042022-01-21 23:50:39 +01002651{
Gilles Peskineded2a422022-02-12 00:20:08 +01002652 ssl->MBEDTLS_PRIVATE(user_data).n = n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002653}
2654
2655/** \brief Retrieve the user data in an SSL context as a pointer.
2656 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002657 * This is the value last set with mbedtls_ssl_set_user_data_p(), or
2658 * \c NULL if mbedtls_ssl_set_user_data_p() has not previously been
2659 * called. The value is undefined if mbedtls_ssl_set_user_data_n() has
2660 * been called without a subsequent call to mbedtls_ssl_set_user_data_p().
Gilles Peskine80dae042022-01-21 23:50:39 +01002661 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002662 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002663 * \return The current value of the user data.
2664 */
2665static inline void *mbedtls_ssl_get_user_data_p(
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002667{
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 return ssl->MBEDTLS_PRIVATE(user_data).p;
Gilles Peskine80dae042022-01-21 23:50:39 +01002669}
2670
2671/** \brief Retrieve the user data in an SSL context as an integer.
2672 *
Gilles Peskine1e265d22022-01-27 23:30:52 +01002673 * This is the value last set with mbedtls_ssl_set_user_data_n(), or
2674 * \c 0 if mbedtls_ssl_set_user_data_n() has not previously been
2675 * called. The value is undefined if mbedtls_ssl_set_user_data_p() has
2676 * been called without a subsequent call to mbedtls_ssl_set_user_data_n().
Gilles Peskine80dae042022-01-21 23:50:39 +01002677 *
Tom Cosgrove1797b052022-12-04 17:19:59 +00002678 * \param ssl The SSL context to modify.
Gilles Peskine80dae042022-01-21 23:50:39 +01002679 * \return The current value of the user data.
2680 */
2681static inline uintptr_t mbedtls_ssl_get_user_data_n(
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 mbedtls_ssl_context *ssl)
Gilles Peskine80dae042022-01-21 23:50:39 +01002683{
Gilles Peskine449bd832023-01-11 14:50:10 +01002684 return ssl->MBEDTLS_PRIVATE(user_data).n;
Gilles Peskine80dae042022-01-21 23:50:39 +01002685}
2686
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002687#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002688/**
2689 * \brief Configure asynchronous private key operation callbacks.
2690 *
2691 * \param conf SSL configuration context
2692 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002693 * the description of ::mbedtls_ssl_async_sign_t
2694 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002695 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002696 * operation; in this case the private key object
2697 * associated with the certificate will be used.
2698 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002699 * the description of ::mbedtls_ssl_async_decrypt_t
2700 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002701 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002702 * operation; in this case the private key object
2703 * associated with the certificate will be used.
2704 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002705 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002706 * for more information. This may not be \c NULL unless
2707 * \p f_async_sign and \p f_async_decrypt are both
2708 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002709 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002710 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002711 * for more information. This may be \c NULL if
2712 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002713 * \param config_data A pointer to configuration data which can be
2714 * retrieved with
2715 * mbedtls_ssl_conf_get_async_config_data(). The
2716 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002717 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002718void mbedtls_ssl_conf_async_private_cb(mbedtls_ssl_config *conf,
2719 mbedtls_ssl_async_sign_t *f_async_sign,
2720 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2721 mbedtls_ssl_async_resume_t *f_async_resume,
2722 mbedtls_ssl_async_cancel_t *f_async_cancel,
2723 void *config_data);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002724
2725/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002726 * \brief Retrieve the configuration data set by
2727 * mbedtls_ssl_conf_async_private_cb().
2728 *
2729 * \param conf SSL configuration context
2730 * \return The configuration data set by
2731 * mbedtls_ssl_conf_async_private_cb().
2732 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002733void *mbedtls_ssl_conf_get_async_config_data(const mbedtls_ssl_config *conf);
Gilles Peskine8f97af72018-04-26 11:46:10 +02002734
2735/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002736 * \brief Retrieve the asynchronous operation user context.
2737 *
2738 * \note This function may only be called while a handshake
2739 * is in progress.
2740 *
2741 * \param ssl The SSL context to access.
2742 *
2743 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002744 * set during the current handshake. If
2745 * mbedtls_ssl_set_async_operation_data() has not yet been
2746 * called during the current handshake, this function returns
2747 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002748 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002749void *mbedtls_ssl_get_async_operation_data(const mbedtls_ssl_context *ssl);
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002750
2751/**
2752 * \brief Retrieve the asynchronous operation user context.
2753 *
2754 * \note This function may only be called while a handshake
2755 * is in progress.
2756 *
2757 * \param ssl The SSL context to access.
2758 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002759 * Call mbedtls_ssl_get_async_operation_data() later during the
2760 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002762void mbedtls_ssl_set_async_operation_data(mbedtls_ssl_context *ssl,
2763 void *ctx);
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002764#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002765
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002766/**
2767 * \brief Callback type: generate a cookie
2768 *
2769 * \param ctx Context for the callback
2770 * \param p Buffer to write to,
2771 * must be updated to point right after the cookie
2772 * \param end Pointer to one past the end of the output buffer
2773 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002775 * \param ilen Length of info in bytes
2776 *
2777 * \return The callback must return 0 on success,
2778 * or a negative error code.
2779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780typedef int mbedtls_ssl_cookie_write_t(void *ctx,
2781 unsigned char **p, unsigned char *end,
2782 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002783
2784/**
2785 * \brief Callback type: verify a cookie
2786 *
2787 * \param ctx Context for the callback
2788 * \param cookie Cookie to verify
2789 * \param clen Length of cookie
2790 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002791 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002792 * \param ilen Length of info in bytes
2793 *
2794 * \return The callback must return 0 if cookie is valid,
2795 * or a negative error code.
2796 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002797typedef int mbedtls_ssl_cookie_check_t(void *ctx,
2798 const unsigned char *cookie, size_t clen,
2799 const unsigned char *info, size_t ilen);
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002800
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002801#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002802/**
2803 * \brief Register callbacks for DTLS cookies
2804 * (Server only. DTLS only.)
2805 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002806 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002807 * register working callbacks (and initialize their context).
2808 *
2809 * To disable HelloVerifyRequest, register NULL callbacks.
2810 *
2811 * \warning Disabling hello verification allows your server to be used
2812 * for amplification in DoS attacks against other hosts.
2813 * Only disable if you known this can't happen in your
2814 * particular environment.
2815 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002816 * \note See comments on \c mbedtls_ssl_handshake() about handling
2817 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2818 * on the first handshake attempt when this is enabled.
2819 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002820 * \note This is also necessary to handle client reconnection from
2821 * the same port as described in RFC 6347 section 4.2.8 (only
2822 * the variant with cookies is supported currently). See
2823 * comments on \c mbedtls_ssl_read() for details.
2824 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002825 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002826 * \param f_cookie_write Cookie write callback
2827 * \param f_cookie_check Cookie check callback
2828 * \param p_cookie Context for both callbacks
2829 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002830void mbedtls_ssl_conf_dtls_cookies(mbedtls_ssl_config *conf,
2831 mbedtls_ssl_cookie_write_t *f_cookie_write,
2832 mbedtls_ssl_cookie_check_t *f_cookie_check,
2833 void *p_cookie);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002834
2835/**
2836 * \brief Set client's transport-level identification info.
2837 * (Server only. DTLS only.)
2838 *
2839 * This is usually the IP address (and port), but could be
2840 * anything identify the client depending on the underlying
2841 * network stack. Used for HelloVerifyRequest with DTLS.
2842 * This is *not* used to route the actual packets.
2843 *
2844 * \param ssl SSL context
2845 * \param info Transport-level info identifying the client (eg IP + port)
2846 * \param ilen Length of info in bytes
2847 *
2848 * \note An internal copy is made, so the info buffer can be reused.
2849 *
2850 * \return 0 on success,
2851 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002852 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002853 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002854int mbedtls_ssl_set_client_transport_id(mbedtls_ssl_context *ssl,
2855 const unsigned char *info,
2856 size_t ilen);
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002857
2858#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002859
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002861/**
2862 * \brief Enable or disable anti-replay protection for DTLS.
2863 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002864 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002865 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002866 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002868 *
2869 * \warning Disabling this is a security risk unless the application
2870 * protocol handles duplicated packets in a safe way. You
2871 * should not disable this without careful consideration.
2872 * However, if your application already detects duplicated
2873 * packets and needs information about them to adjust its
2874 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002875 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002876void mbedtls_ssl_conf_dtls_anti_replay(mbedtls_ssl_config *conf, char mode);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002877#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002878
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002879/**
2880 * \brief Set a limit on the number of records with a bad MAC
2881 * before terminating the connection.
2882 * (DTLS only, no effect on TLS.)
2883 * Default: 0 (disabled).
2884 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002885 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002886 * \param limit Limit, or 0 to disable.
2887 *
2888 * \note If the limit is N, then the connection is terminated when
2889 * the Nth non-authentic record is seen.
2890 *
2891 * \note Records with an invalid header are not counted, only the
2892 * ones going through the authentication-decryption phase.
2893 *
2894 * \note This is a security trade-off related to the fact that it's
Andrzej Kurek5c65c572022-04-13 14:28:52 -04002895 * often relatively easy for an active attacker to inject UDP
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002896 * datagrams. On one hand, setting a low limit here makes it
2897 * easier for such an attacker to forcibly terminated a
2898 * connection. On the other hand, a high limit or no limit
2899 * might make us waste resources checking authentication on
2900 * many bogus packets.
2901 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002902void mbedtls_ssl_conf_dtls_badmac_limit(mbedtls_ssl_config *conf, unsigned limit);
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002903
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002905
2906/**
2907 * \brief Allow or disallow packing of multiple handshake records
2908 * within a single datagram.
2909 *
2910 * \param ssl The SSL context to configure.
2911 * \param allow_packing This determines whether datagram packing may
2912 * be used or not. A value of \c 0 means that every
2913 * record will be sent in a separate datagram; a
2914 * value of \c 1 means that, if space permits,
2915 * multiple handshake messages (including CCS) belonging to
2916 * a single flight may be packed within a single datagram.
2917 *
2918 * \note This is enabled by default and should only be disabled
2919 * for test purposes, or if datagram packing causes
2920 * interoperability issues with peers that don't support it.
2921 *
2922 * \note Allowing datagram packing reduces the network load since
2923 * there's less overhead if multiple messages share the same
2924 * datagram. Also, it increases the handshake efficiency
2925 * since messages belonging to a single datagram will not
2926 * be reordered in transit, and so future message buffering
2927 * or flight retransmission (if no buffering is used) as
2928 * means to deal with reordering are needed less frequently.
2929 *
Hanno Beckereb570082018-08-24 11:28:35 +01002930 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002931 * are currently always sent in separate datagrams.
2932 *
2933 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002934void mbedtls_ssl_set_datagram_packing(mbedtls_ssl_context *ssl,
2935 unsigned allow_packing);
Hanno Becker04da1892018-08-14 13:22:10 +01002936
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002937/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002938 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002939 * (DTLS only, no effect on TLS.)
2940 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002941 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002942 * \param min Initial timeout value in milliseconds.
2943 * Default: 1000 (1 second).
2944 * \param max Maximum timeout value in milliseconds.
2945 * Default: 60000 (60 seconds).
2946 *
2947 * \note Default values are from RFC 6347 section 4.2.4.1.
2948 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002949 * \note The 'min' value should typically be slightly above the
2950 * expected round-trip time to your peer, plus whatever time
2951 * it takes for the peer to process the message. For example,
2952 * if your RTT is about 600ms and you peer needs up to 1s to
2953 * do the cryptographic operations in the handshake, then you
2954 * should set 'min' slightly above 1600. Lower values of 'min'
2955 * might cause spurious resends which waste network resources,
2956 * while larger value of 'min' will increase overall latency
2957 * on unreliable network links.
2958 *
2959 * \note The more unreliable your network connection is, the larger
2960 * your max / min ratio needs to be in order to achieve
2961 * reliable handshakes.
2962 *
2963 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2964 * For example, if min = 1s and max = 5s, the retransmit plan
2965 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2966 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002967 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002968void mbedtls_ssl_conf_handshake_timeout(mbedtls_ssl_config *conf, uint32_t min, uint32_t max);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002969#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002970
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002971#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002972/**
Paul Bakker0a597072012-09-25 21:55:46 +00002973 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002974 * If not set, no session resuming is done (except if session
2975 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002976 *
Paul Bakker0a597072012-09-25 21:55:46 +00002977 * The session cache has the responsibility to check for stale
2978 * entries based on timeout. See RFC 5246 for recommendations.
2979 *
2980 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2981 * connection shutdown, so do not cache the pointer! Either set
2982 * it to NULL or make a full copy of the certificate.
2983 *
2984 * The get callback is called once during the initial handshake
2985 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002986 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002987 * If a valid entry is found, it should fill the master of
2988 * the session object with the cached values and return 0,
2989 * return 1 otherwise. Optionally peer_cert can be set as well
2990 * if it is properly present in cache entry.
2991 *
2992 * The set callback is called once during the initial handshake
2993 * to enable session resuming after the entire handshake has
2994 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002996 * should create a cache entry for future retrieval based on
2997 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002999 * data) is cleared by the SSL/TLS layer when the connection is
3000 * terminated. It is recommended to add metadata to determine if
3001 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00003002 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00003003 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003004 * \param conf SSL configuration
Tom Cosgrove1e211442022-05-26 11:51:00 +01003005 * \param p_cache parameter (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00003006 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00003007 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00003008 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003009void mbedtls_ssl_conf_session_cache(mbedtls_ssl_config *conf,
3010 void *p_cache,
3011 mbedtls_ssl_cache_get_t *f_get_cache,
3012 mbedtls_ssl_cache_set_t *f_set_cache);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003013#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003015#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00003016/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003017 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00003018 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003019 * Sessions loaded through this call will be considered
3020 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003021 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003022 * \note Even if this call succeeds, it is not guaranteed that
3023 * the next handshake will indeed be shortened through the
3024 * use of session resumption: The server is always free
3025 * to reject any attempt for resumption and fall back to
3026 * a full handshake.
3027 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003028 * \note This function can handle a variety of mechanisms for session
3029 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01003030 * ticket-based resumption will be considered. For TLS 1.3,
3031 * once implemented, sessions equate to tickets, and loading
3032 * one or more sessions via this call will lead to their
3033 * corresponding tickets being advertised as resumption PSKs
3034 * by the client.
3035 *
3036 * \note Calling this function multiple times will only be useful
3037 * once TLS 1.3 is supported. For TLS 1.2 connections, this
3038 * function should be called at most once.
3039 *
3040 * \param ssl The SSL context representing the connection which should
3041 * be attempted to be setup using session resumption. This
3042 * must be initialized via mbedtls_ssl_init() and bound to
3043 * an SSL configuration via mbedtls_ssl_setup(), but
3044 * the handshake must not yet have been started.
3045 * \param session The session to be considered for session resumption.
3046 * This must be a session previously exported via
3047 * mbedtls_ssl_get_session(), and potentially serialized and
3048 * deserialized through mbedtls_ssl_session_save() and
3049 * mbedtls_ssl_session_load() in the meantime.
3050 *
3051 * \return \c 0 if successful.
3052 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
3053 * could not be loaded because of an implementation limitation.
3054 * This error is non-fatal, and has no observable effect on
3055 * the SSL context or the session that was attempted to be loaded.
3056 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02003057 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003058 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003059 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00003060 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003061int mbedtls_ssl_set_session(mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003062#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003063
3064/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003065 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003066 * On client, this can be used for loading saved sessions
Tom Cosgrove1e211442022-05-26 11:51:00 +01003067 * before resuming them with mbedtls_ssl_set_session().
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003068 * On server, this can be used for alternative implementations
3069 * of session cache or session tickets.
3070 *
3071 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003072 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003073 * end-entity certificate and the result of the chain
3074 * verification (unless verification was disabled), but not
3075 * the rest of the chain.
3076 *
3077 * \see mbedtls_ssl_session_save()
3078 * \see mbedtls_ssl_set_session()
3079 *
3080 * \param session The session structure to be populated. It must have been
3081 * initialised with mbedtls_ssl_session_init() but not
3082 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003083 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003084 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003085 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003086 *
3087 * \return \c 0 if successful.
3088 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
3089 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01003090 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
3091 * was generated in a different version or configuration of
3092 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02003093 * \return Another negative value for other kinds of errors (for
3094 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003095 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003096int mbedtls_ssl_session_load(mbedtls_ssl_session *session,
3097 const unsigned char *buf,
3098 size_t len);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003099
3100/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02003101 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003102 * On client, this can be used for saving session data,
3103 * potentially in non-volatile storage, for resuming later.
3104 * On server, this can be used for alternative implementations
3105 * of session cache or session tickets.
3106 *
3107 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003108 *
3109 * \param session The session structure to be saved.
3110 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003111 * writeable buffer of at least \p len bytes, or may be \c
3112 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003113 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02003114 * \param olen The size in bytes of the data that has been or would have
3115 * been written. It must point to a valid \c size_t.
3116 *
3117 * \note \p olen is updated to the correct value regardless of
3118 * whether \p buf_len was large enough. This makes it possible
3119 * to determine the necessary size by calling this function
3120 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003121 *
3122 * \return \c 0 if successful.
3123 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
3124 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003125int mbedtls_ssl_session_save(const mbedtls_ssl_session *session,
3126 unsigned char *buf,
3127 size_t buf_len,
3128 size_t *olen);
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02003129
3130/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003131 * \brief Set the list of allowed ciphersuites and the preference
3132 * order. First in the list has the highest preference.
Paul Bakker5121ce52009-01-03 21:22:43 +00003133 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003134 * For TLS 1.2, the notion of ciphersuite determines both
3135 * the key exchange mechanism and the suite of symmetric
3136 * algorithms to be used during and after the handshake.
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003137 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003138 * For TLS 1.3 (in development), the notion of ciphersuite
Hanno Becker674f9482021-08-02 21:21:19 +01003139 * only determines the suite of symmetric algorithms to be
Hanno Beckere486b2d2021-07-23 19:24:30 +01003140 * used during and after the handshake, while key exchange
3141 * mechanisms are configured separately.
3142 *
3143 * In Mbed TLS, ciphersuites for both TLS 1.2 and TLS 1.3
3144 * are configured via this function. For users of TLS 1.3,
3145 * there will be separate API for the configuration of key
3146 * exchange mechanisms.
3147 *
3148 * The list of ciphersuites passed to this function may
3149 * contain a mixture of TLS 1.2 and TLS 1.3 ciphersuite
3150 * identifiers. This is useful if negotiation of TLS 1.3
3151 * should be attempted, but a fallback to TLS 1.2 would
3152 * be tolerated.
3153 *
3154 * \note By default, the server chooses its preferred
TRodziewicz3946f792021-06-14 12:11:18 +02003155 * ciphersuite among those that the client supports. If
3156 * mbedtls_ssl_conf_preference_order() is called to prefer
3157 * the client's preferences, the server instead chooses
3158 * the client's preferred ciphersuite among those that
3159 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01003160 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01003161 * \warning The ciphersuites array \p ciphersuites is not copied.
Jerry Yucadebe52021-08-24 10:36:45 +08003162 * It must remain valid for the lifetime of the SSL
Hanno Beckere486b2d2021-07-23 19:24:30 +01003163 * configuration \p conf.
3164 *
3165 * \param conf The SSL configuration to modify.
3166 * \param ciphersuites A 0-terminated list of IANA identifiers of supported
3167 * ciphersuites, accessible through \c MBEDTLS_TLS_XXX
3168 * and \c MBEDTLS_TLS1_3_XXX macros defined in
3169 * ssl_ciphersuites.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003170 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003171void mbedtls_ssl_conf_ciphersuites(mbedtls_ssl_config *conf,
3172 const int *ciphersuites);
Paul Bakker5121ce52009-01-03 21:22:43 +00003173
Ronald Cron6f135e12021-12-08 16:57:54 +01003174#if defined(MBEDTLS_SSL_PROTO_TLS1_3)
Hanno Becker71f1ed62021-07-24 06:01:47 +01003175/**
3176 * \brief Set the supported key exchange modes for TLS 1.3 connections.
3177 *
3178 * In contrast to TLS 1.2, the ciphersuite concept in TLS 1.3 does not
3179 * include the choice of key exchange mechanism. It is therefore not
3180 * covered by the API mbedtls_ssl_conf_ciphersuites(). See the
3181 * documentation of mbedtls_ssl_conf_ciphersuites() for more
3182 * information on the ciphersuite concept in TLS 1.2 and TLS 1.3.
3183 *
3184 * The present function is specific to TLS 1.3 and allows users to
3185 * configure the set of supported key exchange mechanisms in TLS 1.3.
3186 *
3187 * \param conf The SSL configuration the change should apply to.
3188 * \param kex_modes A bitwise combination of one or more of the following:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003189 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK
Hanno Becker71f1ed62021-07-24 06:01:47 +01003190 * This flag enables pure-PSK key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003191 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003192 * This flag enables combined PSK-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003193 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003194 * This flag enables pure-ephemeral key exchanges.
3195 * For convenience, the following pre-defined macros are
3196 * available for combinations of the above:
Xiaofei Bai746f9482021-11-12 08:53:56 +00003197 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003198 * Includes all of pure-PSK, PSK-ephemeral and pure-ephemeral.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003199 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003200 * Includes both pure-PSK and combined PSK-ephemeral
3201 * key exchanges, but excludes pure-ephemeral key exchanges.
Xiaofei Bai746f9482021-11-12 08:53:56 +00003202 * - MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ALL
Hanno Becker71f1ed62021-07-24 06:01:47 +01003203 * Includes both pure-ephemeral and combined PSK-ephemeral
3204 * key exchanges.
3205 *
3206 * \note If a PSK-based key exchange mode shall be supported, applications
3207 * must also use the APIs mbedtls_ssl_conf_psk() or
3208 * mbedtls_ssl_conf_psk_cb() or mbedtls_ssl_conf_psk_opaque()
3209 * to configure the PSKs to be used.
3210 *
Hanno Becker5d045a82021-08-02 21:21:30 +01003211 * \note If a pure-ephemeral key exchange mode shall be supported,
Hanno Becker71f1ed62021-07-24 06:01:47 +01003212 * server-side applications must also provide a certificate via
3213 * mbedtls_ssl_conf_own_cert().
3214 *
3215 */
3216
Gilles Peskine449bd832023-01-11 14:50:10 +01003217void mbedtls_ssl_conf_tls13_key_exchange_modes(mbedtls_ssl_config *conf,
3218 const int kex_modes);
Ronald Cron6f135e12021-12-08 16:57:54 +01003219#endif /* MBEDTLS_SSL_PROTO_TLS1_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00003220
Hanno Beckera0e20d02019-05-15 14:03:01 +01003221#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01003222#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
3223#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01003224/**
Hanno Becker11259522019-05-23 16:55:50 +01003225 * \brief Specify the length of Connection IDs for incoming
3226 * encrypted DTLS records, as well as the behaviour
3227 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01003228 *
3229 * By default, the CID length is set to \c 0,
3230 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003231 *
3232 * \param conf The SSL configuration to modify.
3233 * \param len The length in Bytes of the CID fields in encrypted
3234 * DTLS records using the CID mechanism. This must
3235 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01003236 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01003237 * receiving a record with an unexpected CID.
3238 * Possible values are:
3239 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
3240 * In this case, the record is silently ignored.
3241 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
3242 * In this case, the stack fails with the specific
3243 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003244 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01003245 * \note The CID specification allows implementations to either
3246 * use a common length for all incoming connection IDs or
3247 * allow variable-length incoming IDs. Mbed TLS currently
3248 * requires a common length for all connections sharing the
3249 * same SSL configuration; this allows simpler parsing of
3250 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01003251 *
3252 * \return \c 0 on success.
3253 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
3254 * is too large.
3255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003256int mbedtls_ssl_conf_cid(mbedtls_ssl_config *conf, size_t len,
3257 int ignore_other_cids);
Hanno Beckera0e20d02019-05-15 14:03:01 +01003258#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01003259
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02003261/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003262 * \brief Set the X.509 security profile used for verification
3263 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003264 * \note The restrictions are enforced for all certificates in the
3265 * chain. However, signatures in the handshake are not covered
3266 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
3267 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003268 * \param conf SSL configuration
3269 * \param profile Profile to use
3270 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003271void mbedtls_ssl_conf_cert_profile(mbedtls_ssl_config *conf,
3272 const mbedtls_x509_crt_profile *profile);
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02003273
3274/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003275 * \brief Set the data required to verify peer certificate
3276 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02003277 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02003278 * parameters ca_chain (maps to trust_ca for that function)
3279 * and ca_crl.
3280 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003281 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003282 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00003283 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00003284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003285void mbedtls_ssl_conf_ca_chain(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003286 mbedtls_x509_crt *ca_chain,
Gilles Peskine449bd832023-01-11 14:50:10 +01003287 mbedtls_x509_crl *ca_crl);
Paul Bakker5121ce52009-01-03 21:22:43 +00003288
Glenn Strauss999ef702022-03-11 01:37:23 -05003289#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3290/**
3291 * \brief Set DN hints sent to client in CertificateRequest message
3292 *
3293 * \note If not set, subject distinguished names (DNs) are taken
3294 * from \c mbedtls_ssl_conf_ca_chain()
3295 * or \c mbedtls_ssl_set_hs_ca_chain())
3296 *
3297 * \param conf SSL configuration
3298 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3299 * from which the client should select client peer certificate.
3300 */
3301static inline
Gilles Peskine449bd832023-01-11 14:50:10 +01003302void mbedtls_ssl_conf_dn_hints(mbedtls_ssl_config *conf,
3303 const mbedtls_x509_crt *crt)
Glenn Strauss999ef702022-03-11 01:37:23 -05003304{
3305 conf->MBEDTLS_PRIVATE(dn_hints) = crt;
3306}
3307#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3308
Hanno Becker8bf74f32019-03-27 11:01:30 +00003309#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
3310/**
3311 * \brief Set the trusted certificate callback.
3312 *
3313 * This API allows to register the set of trusted certificates
3314 * through a callback, instead of a linked list as configured
3315 * by mbedtls_ssl_conf_ca_chain().
3316 *
3317 * This is useful for example in contexts where a large number
3318 * of CAs are used, and the inefficiency of maintaining them
3319 * in a linked list cannot be tolerated. It is also useful when
3320 * the set of trusted CAs needs to be modified frequently.
3321 *
3322 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
3323 * more information.
3324 *
3325 * \param conf The SSL configuration to register the callback with.
3326 * \param f_ca_cb The trusted certificate callback to use when verifying
3327 * certificate chains.
3328 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
3329 * a reference to a trusted CA database).
3330 *
3331 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
3332 * Any call to this function overwrites the values set through
3333 * earlier calls to mbedtls_ssl_conf_ca_chain() or
3334 * mbedtls_ssl_conf_ca_cb().
3335 *
3336 * \note This API is incompatible with CA indication in
3337 * CertificateRequest messages: A server-side SSL context which
3338 * is bound to an SSL configuration that uses a CA callback
3339 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
3340 * client authentication, will send an empty CA list in the
3341 * corresponding CertificateRequest message.
3342 *
3343 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
3344 * If an SSL context is bound to an SSL configuration which uses
3345 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
3346 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
3347 *
3348 * \note The use of this API disables the use of restartable ECC
3349 * during X.509 CRT signature verification (but doesn't affect
3350 * other uses).
3351 *
3352 * \warning This API is incompatible with the use of CRLs. Any call to
3353 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
3354 * earlier calls to mbedtls_ssl_conf_ca_chain().
3355 *
3356 * \warning In multi-threaded environments, the callback \p f_ca_cb
3357 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01003358 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00003359 * contained in the callback context pointed to by \p p_ca_cb).
3360 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003361void mbedtls_ssl_conf_ca_cb(mbedtls_ssl_config *conf,
3362 mbedtls_x509_crt_ca_cb_t f_ca_cb,
3363 void *p_ca_cb);
Hanno Becker8bf74f32019-03-27 11:01:30 +00003364#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
3365
Paul Bakker5121ce52009-01-03 21:22:43 +00003366/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003367 * \brief Set own certificate chain and private key
3368 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003369 * \note own_cert should contain in order from the bottom up your
3370 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003371 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00003372 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003373 * \note On server, this function can be called multiple times to
3374 * provision more than one cert/key pair (eg one ECDSA, one
3375 * RSA with SHA-256, one RSA with SHA-1). An adequate
3376 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01003377 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003378 * adequate, preference is given to the one set by the first
3379 * call to this function, then second, etc.
3380 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003381 * \note On client, only the first call has any effect. That is,
3382 * only one client certificate can be provisioned. The
bootstrap-prime6dbbf442022-05-17 19:30:44 -04003383 * server's preferences in its CertificateRequest message will
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00003384 * be ignored and our only cert will be sent regardless of
3385 * whether it matches those preferences - the server can then
3386 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003387 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05003388 * \note The provided \p pk_key needs to match the public key in the
3389 * first certificate in \p own_cert, or all handshakes using
3390 * that certificate will fail. It is your responsibility
3391 * to ensure that; this function will not perform any check.
3392 * You may use mbedtls_pk_check_pair() in order to perform
3393 * this check yourself, but be aware that this function can
3394 * be computationally expensive on some key types.
3395 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02003396 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01003397 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02003398 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02003399 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003400 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00003401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003402int mbedtls_ssl_conf_own_cert(mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02003403 mbedtls_x509_crt *own_cert,
Gilles Peskine449bd832023-01-11 14:50:10 +01003404 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00003406
Ronald Cron73fe8df2022-10-05 14:31:43 +02003407#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003408/**
Hanno Becker196739b2021-05-28 05:25:46 +01003409 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01003410 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003411 *
Hanno Becker196739b2021-05-28 05:25:46 +01003412 * Only one PSK can be registered, through either
3413 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3414 * If you attempt to register more than one PSK, this function
3415 * fails, though this may change in future versions, which
3416 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003417 *
3418 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003419 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003420 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003421 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
3422 * takes precedence over a PSK configured by this function.
3423 *
Hanno Becker02283042018-10-22 15:28:02 +01003424 * \param conf The SSL configuration to register the PSK with.
3425 * \param psk The pointer to the pre-shared key to use.
3426 * \param psk_len The length of the pre-shared key in bytes.
3427 * \param psk_identity The pointer to the pre-shared key identity.
3428 * \param psk_identity_len The length of the pre-shared key identity
3429 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02003430 *
Hanno Becker02283042018-10-22 15:28:02 +01003431 * \note The PSK and its identity are copied internally and
3432 * hence need not be preserved by the caller for the lifetime
3433 * of the SSL configuration.
3434 *
3435 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003436 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003437 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003438 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003440int mbedtls_ssl_conf_psk(mbedtls_ssl_config *conf,
3441 const unsigned char *psk, size_t psk_len,
3442 const unsigned char *psk_identity, size_t psk_identity_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003443
Hanno Becker02283042018-10-22 15:28:02 +01003444#if defined(MBEDTLS_USE_PSA_CRYPTO)
3445/**
Hanno Becker946c9252021-04-19 21:41:47 +01003446 * \brief Configure one or more opaque pre-shared keys (PSKs) and
3447 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01003448 *
Hanno Becker196739b2021-05-28 05:25:46 +01003449 * Only one PSK can be registered, through either
3450 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
3451 * If you attempt to register more than one PSK, this function
3452 * fails, though this may change in future versions, which
3453 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01003454 *
3455 * \note This is mainly useful for clients. Servers will usually
3456 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
3457 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003458 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
3459 * the PSK callback takes precedence over an opaque PSK
3460 * configured by this function.
3461 *
Hanno Becker02283042018-10-22 15:28:02 +01003462 * \param conf The SSL configuration to register the PSK with.
3463 * \param psk The identifier of the key slot holding the PSK.
3464 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00003465 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05003466 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00003467 * allows its use for the key derivation algorithm applied
3468 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01003469 * \param psk_identity The pointer to the pre-shared key identity.
3470 * \param psk_identity_len The length of the pre-shared key identity
3471 * in bytes.
3472 *
3473 * \note The PSK identity hint is copied internally and hence need
3474 * not be preserved by the caller for the lifetime of the
3475 * SSL configuration.
3476 *
3477 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01003478 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01003479 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01003480 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01003481 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003482int mbedtls_ssl_conf_psk_opaque(mbedtls_ssl_config *conf,
3483 mbedtls_svc_key_id_t psk,
3484 const unsigned char *psk_identity,
3485 size_t psk_identity_len);
Hanno Becker02283042018-10-22 15:28:02 +01003486#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02003487
3488/**
Hanno Becker02283042018-10-22 15:28:02 +01003489 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003490 *
3491 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01003492 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003493 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003494 * \note A PSK set by this function takes precedence over a PSK
3495 * configured by \c mbedtls_ssl_conf_psk().
3496 *
Hanno Becker02283042018-10-22 15:28:02 +01003497 * \param ssl The SSL context to configure a PSK for.
3498 * \param psk The pointer to the pre-shared key.
3499 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003500 *
Hanno Becker02283042018-10-22 15:28:02 +01003501 * \return \c 0 if successful.
3502 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003503 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003504int mbedtls_ssl_set_hs_psk(mbedtls_ssl_context *ssl,
3505 const unsigned char *psk, size_t psk_len);
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003506
Hanno Becker02283042018-10-22 15:28:02 +01003507#if defined(MBEDTLS_USE_PSA_CRYPTO)
3508/**
3509 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
3510 *
3511 * \note This should only be called inside the PSK callback,
3512 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
3513 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003514 * \note An opaque PSK set by this function takes precedence over an
3515 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
3516 *
Hanno Becker02283042018-10-22 15:28:02 +01003517 * \param ssl The SSL context to configure a PSK for.
3518 * \param psk The identifier of the key slot holding the PSK.
3519 * For the duration of the current handshake, the key slot
3520 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05003521 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01003522 * use for the key derivation algorithm
3523 * applied in the handshake.
Gilles Peskine449bd832023-01-11 14:50:10 +01003524 *
Hanno Becker02283042018-10-22 15:28:02 +01003525 * \return \c 0 if successful.
3526 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
3527 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003528int mbedtls_ssl_set_hs_psk_opaque(mbedtls_ssl_context *ssl,
3529 mbedtls_svc_key_id_t psk);
Hanno Becker02283042018-10-22 15:28:02 +01003530#endif /* MBEDTLS_USE_PSA_CRYPTO */
3531
Jerry Yu8897c072022-08-12 13:56:53 +08003532#if defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003533/**
3534 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02003535 *
3536 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01003537 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01003538 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02003539 * receive the actual PSK data and length.
3540 *
Hanno Becker02283042018-10-22 15:28:02 +01003541 * The callback has the following parameters:
3542 * - \c void*: The opaque pointer \p p_psk.
3543 * - \c mbedtls_ssl_context*: The SSL context to which
3544 * the operation applies.
3545 * - \c const unsigned char*: The PSK identity
3546 * selected by the client.
3547 * - \c size_t: The length of the PSK identity
3548 * selected by the client.
3549 *
Paul Bakker6db455e2013-09-18 17:29:31 +02003550 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01003551 * \c mbedtls_ssl_set_hs_psk() or
3552 * \c mbedtls_ssl_set_hs_psk_opaque()
3553 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02003554 * Any other return value will result in a denied PSK identity.
3555 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003556 * \note A dynamic PSK (i.e. set by the PSK callback) takes
3557 * precedence over a static PSK (i.e. set by
3558 * \c mbedtls_ssl_conf_psk() or
3559 * \c mbedtls_ssl_conf_psk_opaque()).
3560 * This means that if you set a PSK callback using this
3561 * function, you don't need to set a PSK using
3562 * \c mbedtls_ssl_conf_psk() or
3563 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003564 *
Hanno Becker02283042018-10-22 15:28:02 +01003565 * \param conf The SSL configuration to register the callback with.
3566 * \param f_psk The callback for selecting and setting the PSK based
3567 * in the PSK identity chosen by the client.
3568 * \param p_psk A pointer to an opaque structure to be passed to
3569 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02003570 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003571void mbedtls_ssl_conf_psk_cb(mbedtls_ssl_config *conf,
3572 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
3573 size_t),
3574 void *p_psk);
Jerry Yu8897c072022-08-12 13:56:53 +08003575#endif /* MBEDTLS_SSL_SRV_C */
Ronald Cron73fe8df2022-10-05 14:31:43 +02003576#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003577
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01003578#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01003579/**
3580 * \brief Set the Diffie-Hellman public P and G values
3581 * from big-endian binary presentations.
3582 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
3583 *
3584 * \param conf SSL configuration
3585 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
3586 * \param P_len Length of DHM modulus
3587 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
3588 * \param G_len Length of DHM generator
3589 *
3590 * \return 0 if successful
3591 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003592int mbedtls_ssl_conf_dh_param_bin(mbedtls_ssl_config *conf,
3593 const unsigned char *dhm_P, size_t P_len,
3594 const unsigned char *dhm_G, size_t G_len);
Paul Bakker5121ce52009-01-03 21:22:43 +00003595
3596/**
Paul Bakker1b57b062011-01-06 15:48:19 +00003597 * \brief Set the Diffie-Hellman public P and G values,
3598 * read from existing context (server-side only)
3599 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003600 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00003601 * \param dhm_ctx Diffie-Hellman-Merkle context
3602 *
3603 * \return 0 if successful
3604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003605int mbedtls_ssl_conf_dh_param_ctx(mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx);
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003606#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00003607
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003608#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3609/**
3610 * \brief Set the minimum length for Diffie-Hellman parameters.
3611 * (Client-side only.)
3612 * (Default: 1024 bits.)
3613 *
3614 * \param conf SSL configuration
3615 * \param bitlen Minimum bit length of the DHM prime
3616 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003617void mbedtls_ssl_conf_dhm_min_bitlen(mbedtls_ssl_config *conf,
3618 unsigned int bitlen);
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003619#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3620
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003621#if defined(MBEDTLS_ECP_C)
Brett Warrene0edc842021-08-17 09:53:13 +01003622#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Gergely Budai987bfb52014-01-19 21:48:42 +01003623/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003624 * \brief Set the allowed curves in order of preference.
Gergely Budai987bfb52014-01-19 21:48:42 +01003625 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003626 * On server: this only affects selection of the ECDHE curve;
3627 * the curves used for ECDH and ECDSA are determined by the
3628 * list of available certificates instead.
3629 *
3630 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01003631 * use. The server can override our preference order.
3632 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003633 * Both sides: limits the set of curves accepted for use in
3634 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003635 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003636 * \deprecated Superseded by mbedtls_ssl_conf_groups().
Brett Warrene0edc842021-08-17 09:53:13 +01003637 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003638 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003639 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003640 * for that. For the end-entity certificate however, the key
3641 * will be accepted only if it is allowed both by this list
3642 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01003643 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003644 * \note This list should be ordered by decreasing preference
3645 * (preferred curve first).
3646 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003647 * \note The default list is the same set of curves that
3648 * #mbedtls_x509_crt_profile_default allows, plus
3649 * ECDHE-only curves selected according to the same criteria.
Gilles Peskineb1940a72021-06-02 15:18:12 +02003650 * The order favors curves with the lowest resource usage.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003651 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003652 * \note New minor versions of Mbed TLS may extend this list,
3653 * for example if new curves are added to the library.
3654 * New minor versions of Mbed TLS will not remove items
3655 * from this list unless serious security concerns require it.
3656 * New minor versions of Mbed TLS may change the order in
3657 * keeping with the general principle of favoring the lowest
3658 * resource usage.
3659 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003660 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003661 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003662 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01003663 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003664void MBEDTLS_DEPRECATED mbedtls_ssl_conf_curves(mbedtls_ssl_config *conf,
3665 const mbedtls_ecp_group_id *curves);
Brett Warrene0edc842021-08-17 09:53:13 +01003666#endif /* MBEDTLS_DEPRECATED_REMOVED */
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003667#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01003668
Brett Warrene0edc842021-08-17 09:53:13 +01003669/**
3670 * \brief Set the allowed groups in order of preference.
3671 *
3672 * On server: This only affects the choice of key agreement mechanism
3673 *
3674 * On client: this affects the list of groups offered for any
3675 * use. The server can override our preference order.
3676 *
3677 * Both sides: limits the set of groups accepted for use in
3678 * key sharing.
3679 *
3680 * \note This function replaces the deprecated mbedtls_ssl_conf_curves(),
3681 * which only allows ECP curves to be configured.
3682 *
3683 * \note The most recent invocation of either mbedtls_ssl_conf_curves()
3684 * or mbedtls_ssl_conf_groups() nullifies all previous invocations
3685 * of both.
3686 *
3687 * \note This list should be ordered by decreasing preference
3688 * (preferred group first).
3689 *
3690 * \note When this function is not called, a default list is used,
3691 * consisting of all supported curves at 255 bits and above,
3692 * and all supported finite fields at 2048 bits and above.
3693 * The order favors groups with the lowest resource usage.
3694 *
3695 * \note New minor versions of Mbed TLS will not remove items
3696 * from the default list unless serious security concerns require it.
3697 * New minor versions of Mbed TLS may change the order in
3698 * keeping with the general principle of favoring the lowest
3699 * resource usage.
3700 *
3701 * \param conf SSL configuration
3702 * \param groups List of allowed groups ordered by preference, terminated by 0.
3703 * Must contain valid IANA NamedGroup IDs (provided via either an integer
Xiaofei Bai746f9482021-11-12 08:53:56 +00003704 * or using MBEDTLS_TLS1_3_NAMED_GROUP_XXX macros).
Brett Warrene0edc842021-08-17 09:53:13 +01003705 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003706void mbedtls_ssl_conf_groups(mbedtls_ssl_config *conf,
3707 const uint16_t *groups);
Brett Warrene0edc842021-08-17 09:53:13 +01003708
Ronald Crone68ab4f2022-10-05 12:46:29 +02003709#if defined(MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED)
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003710#if !defined(MBEDTLS_DEPRECATED_REMOVED) && defined(MBEDTLS_SSL_PROTO_TLS1_2)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003711/**
3712 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003713 *
3714 * \note This only affects which hashes are offered and can be used
3715 * for signatures during the handshake. Hashes for message
3716 * authentication and the TLS PRF are controlled by the
3717 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
3718 * used for certificate signature are controlled by the
3719 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
3720 *
3721 * \note This list should be ordered by decreasing preference
3722 * (preferred hash first).
3723 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003724 * \note By default, all supported hashes whose length is at least
3725 * 256 bits are allowed. This is the same set as the default
3726 * for certificate verification
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003727 * (#mbedtls_x509_crt_profile_default).
3728 * The preference order is currently unspecified and may
3729 * change in future versions.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003730 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003731 * \note New minor versions of Mbed TLS may extend this list,
3732 * for example if new curves are added to the library.
3733 * New minor versions of Mbed TLS will not remove items
3734 * from this list unless serious security concerns require it.
3735 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003736 * \param conf SSL configuration
3737 * \param hashes Ordered list of allowed signature hashes,
3738 * terminated by \c MBEDTLS_MD_NONE.
3739 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003740void MBEDTLS_DEPRECATED mbedtls_ssl_conf_sig_hashes(mbedtls_ssl_config *conf,
3741 const int *hashes);
Jerry Yu7ddc38c2022-01-19 11:08:05 +08003742#endif /* !MBEDTLS_DEPRECATED_REMOVED && MBEDTLS_SSL_PROTO_TLS1_2 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01003743
Hanno Becker1cd6e002021-08-10 13:27:10 +01003744/**
3745 * \brief Configure allowed signature algorithms for use in TLS 1.3
3746 *
3747 * \param conf The SSL configuration to use.
Jerry Yu7899de82021-08-17 13:09:23 +08003748 * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms,
Xiaofei Bai746f9482021-11-12 08:53:56 +00003749 * terminated by \c MBEDTLS_TLS1_3_SIG_NONE. The list must remain
Jerry Yu447a3be2021-08-18 09:55:32 +08003750 * available throughout the lifetime of the conf object. Supported
Xiaofei Bai746f9482021-11-12 08:53:56 +00003751 * values are available as \c MBEDTLS_TLS1_3_SIG_XXXX
Hanno Becker1cd6e002021-08-10 13:27:10 +01003752 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003753void mbedtls_ssl_conf_sig_algs(mbedtls_ssl_config *conf,
3754 const uint16_t *sig_algs);
Ronald Crone68ab4f2022-10-05 12:46:29 +02003755#endif /* MBEDTLS_SSL_HANDSHAKE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003756
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003757#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003758/**
Darryl Green11999bb2018-03-13 15:22:58 +00003759 * \brief Set or reset the hostname to check against the received
3760 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003761 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003762 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003763 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003764 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003765
Hanno Becker0446a392017-04-07 12:59:32 +01003766 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003767 *
Darryl Green11999bb2018-03-13 15:22:58 +00003768 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3769 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003770 * too long input hostname.
3771 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003772 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003773 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003774 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003775 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003776int mbedtls_ssl_set_hostname(mbedtls_ssl_context *ssl, const char *hostname);
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003777#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003778
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003779#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003780/**
Glenn Strauss69894072022-01-24 12:58:00 -05003781 * \brief Retrieve SNI extension value for the current handshake.
3782 * Available in \p f_cert_cb of \c mbedtls_ssl_conf_cert_cb(),
3783 * this is the same value passed to \p f_sni callback of
3784 * \c mbedtls_ssl_conf_sni() and may be used instead of
3785 * \c mbedtls_ssl_conf_sni().
3786 *
3787 * \param ssl SSL context
3788 * \param name_len pointer into which to store length of returned value.
3789 * 0 if SNI extension is not present or not yet processed.
3790 *
3791 * \return const pointer to SNI extension value.
3792 * - value is valid only when called in \p f_cert_cb
3793 * registered with \c mbedtls_ssl_conf_cert_cb().
3794 * - value is NULL if SNI extension is not present.
3795 * - value is not '\0'-terminated. Use \c name_len for len.
3796 * - value must not be freed.
3797 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003798const unsigned char *mbedtls_ssl_get_hs_sni(mbedtls_ssl_context *ssl,
3799 size_t *name_len);
Glenn Strauss69894072022-01-24 12:58:00 -05003800
3801/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003802 * \brief Set own certificate and key for the current handshake
3803 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003804 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003805 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003806 *
Glenn Strauss36872db2022-01-22 05:06:31 -05003807 * \note Passing null \c own_cert clears the certificate list for
3808 * the current handshake.
3809 *
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003810 * \param ssl SSL context
3811 * \param own_cert own public certificate chain
3812 * \param pk_key own private key
3813 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003814 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003815 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003816int mbedtls_ssl_set_hs_own_cert(mbedtls_ssl_context *ssl,
3817 mbedtls_x509_crt *own_cert,
3818 mbedtls_pk_context *pk_key);
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003819
3820/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003821 * \brief Set the data required to verify peer certificate for the
3822 * current handshake
3823 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003824 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003825 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003826 *
3827 * \param ssl SSL context
3828 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3829 * \param ca_crl trusted CA CRLs
3830 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003831void mbedtls_ssl_set_hs_ca_chain(mbedtls_ssl_context *ssl,
3832 mbedtls_x509_crt *ca_chain,
3833 mbedtls_x509_crl *ca_crl);
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003834
Glenn Strauss999ef702022-03-11 01:37:23 -05003835#if defined(MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED)
3836/**
3837 * \brief Set DN hints sent to client in CertificateRequest message
3838 *
3839 * \note Same as \c mbedtls_ssl_conf_dn_hints() but for use within
3840 * the SNI callback or the certificate selection callback.
3841 *
3842 * \param ssl SSL context
3843 * \param crt crt chain whose subject DNs are issuer DNs of client certs
3844 * from which the client should select client peer certificate.
3845 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003846void mbedtls_ssl_set_hs_dn_hints(mbedtls_ssl_context *ssl,
3847 const mbedtls_x509_crt *crt);
Glenn Strauss999ef702022-03-11 01:37:23 -05003848#endif /* MBEDTLS_KEY_EXCHANGE_CERT_REQ_ALLOWED_ENABLED */
3849
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003850/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003851 * \brief Set authmode for the current handshake.
3852 *
3853 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
Glenn Strauss9bff95f2022-03-09 14:39:08 -05003854 * the SNI callback or the certificate selection callback.
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003855 *
3856 * \param ssl SSL context
3857 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3858 * MBEDTLS_SSL_VERIFY_REQUIRED
3859 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003860void mbedtls_ssl_set_hs_authmode(mbedtls_ssl_context *ssl,
3861 int authmode);
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003862
3863/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003864 * \brief Set server side ServerName TLS extension callback
3865 * (optional, server-side only).
3866 *
3867 * If set, the ServerName callback is called whenever the
3868 * server receives a ServerName TLS extension from the client
3869 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003870 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003871 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003872 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003873 * certificate(s) and key(s) to use with \c
3874 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003875 * and may optionally adjust the CA and associated CRL with \c
3876 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3877 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3878 * then must return 0. If no matching name is found, the
Glenn Strauss0ebf24a2022-01-24 18:30:13 -05003879 * callback may return non-zero to abort the handshake.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003880 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003881 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003882 * \param f_sni verification function
3883 * \param p_sni verification parameter
3884 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003885void mbedtls_ssl_conf_sni(mbedtls_ssl_config *conf,
3886 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
3887 size_t),
3888 void *p_sni);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003889#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003890
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003891#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003892/**
3893 * \brief Set the EC J-PAKE password for current handshake.
3894 *
3895 * \note An internal copy is made, and destroyed as soon as the
3896 * handshake is completed, or when the SSL context is reset or
3897 * freed.
3898 *
3899 * \note The SSL context needs to be already set up. The right place
3900 * to call this function is between \c mbedtls_ssl_setup() or
3901 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settiaca21b72022-11-17 18:17:01 +01003902 * Password cannot be empty (see RFC 8236).
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003903 *
3904 * \param ssl SSL context
Valerio Settiaca21b72022-11-17 18:17:01 +01003905 * \param pw EC J-PAKE password (pre-shared secret). It cannot be empty
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003906 * \param pw_len length of pw in bytes
3907 *
3908 * \return 0 on success, or a negative error code.
3909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003910int mbedtls_ssl_set_hs_ecjpake_password(mbedtls_ssl_context *ssl,
3911 const unsigned char *pw,
3912 size_t pw_len);
Valerio Settia9a97dc2022-11-28 18:26:16 +01003913
3914/**
3915 * \brief Set the EC J-PAKE opaque password for current handshake.
3916 *
Valerio Settic689ed82022-12-07 14:40:38 +01003917 * \note The key must remain valid until the handshake is over.
Valerio Settia9a97dc2022-11-28 18:26:16 +01003918 *
3919 * \note The SSL context needs to be already set up. The right place
3920 * to call this function is between \c mbedtls_ssl_setup() or
3921 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
Valerio Settia9a97dc2022-11-28 18:26:16 +01003922 *
3923 * \param ssl SSL context
3924 * \param pwd EC J-PAKE opaque password
3925 *
3926 * \return 0 on success, or a negative error code.
3927 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003928int mbedtls_ssl_set_hs_ecjpake_password_opaque(mbedtls_ssl_context *ssl,
3929 mbedtls_svc_key_id_t pwd);
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003930#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003931
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003932#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003933/**
3934 * \brief Set the supported Application Layer Protocols.
3935 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003936 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003937 * \param protos Pointer to a NULL-terminated list of supported protocols,
3938 * in decreasing preference order. The pointer to the list is
3939 * recorded by the library for later reference as required, so
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003940 * the lifetime of the table must be at least as long as the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003941 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003942 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003943 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003945int mbedtls_ssl_conf_alpn_protocols(mbedtls_ssl_config *conf, const char **protos);
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003946
3947/**
3948 * \brief Get the name of the negotiated Application Layer Protocol.
3949 * This function should be called after the handshake is
3950 * completed.
3951 *
3952 * \param ssl SSL context
3953 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08003954 * \return Protocol name, or NULL if no protocol was negotiated.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003955 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003956const char *mbedtls_ssl_get_alpn_protocol(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003957#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003958
Johan Pascalb62bb512015-12-03 21:56:45 +01003959#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003960#if defined(MBEDTLS_DEBUG_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01003961static inline const char *mbedtls_ssl_get_srtp_profile_as_string(mbedtls_ssl_srtp_profile profile)
Johan Pascala455cd92020-09-22 15:28:11 +02003962{
Gilles Peskine449bd832023-01-11 14:50:10 +01003963 switch (profile) {
Johan Pascala455cd92020-09-22 15:28:11 +02003964 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01003965 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003966 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01003967 return "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003968 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Gilles Peskine449bd832023-01-11 14:50:10 +01003969 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80";
Johan Pascala455cd92020-09-22 15:28:11 +02003970 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Gilles Peskine449bd832023-01-11 14:50:10 +01003971 return "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32";
Johan Pascala455cd92020-09-22 15:28:11 +02003972 default: break;
3973 }
Gilles Peskine449bd832023-01-11 14:50:10 +01003974 return "";
Johan Pascala455cd92020-09-22 15:28:11 +02003975}
3976#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003977/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003978 * \brief Manage support for mki(master key id) value
3979 * in use_srtp extension.
3980 * MKI is an optional part of SRTP used for key management
3981 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003982 * The default value is
3983 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003984 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003985 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003986 * \param support_mki_value Enable or disable mki usage. Values are
3987 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3988 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003989 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003990void mbedtls_ssl_conf_srtp_mki_value_supported(mbedtls_ssl_config *conf,
3991 int support_mki_value);
Ron Eldor591f1622018-01-22 12:30:04 +02003992
3993/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003994 * \brief Set the supported DTLS-SRTP protection profiles.
3995 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003996 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003997 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3998 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003999 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02004000 * The pointer to the list is recorded by the library
4001 * for later reference as required, so the lifetime
4002 * of the table must be at least as long as the lifetime
4003 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02004004 * The list must not hold more than
4005 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02004006 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01004007 *
Johan Pascal85269572020-08-25 10:01:54 +02004008 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02004009 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
4010 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01004011 */
Ron Eldora9788042018-12-05 11:04:31 +02004012int mbedtls_ssl_conf_dtls_srtp_protection_profiles
Gilles Peskine449bd832023-01-11 14:50:10 +01004013 (mbedtls_ssl_config *conf,
4014 const mbedtls_ssl_srtp_profile *profiles);
Ron Eldor591f1622018-01-22 12:30:04 +02004015
4016/**
Ron Eldora9788042018-12-05 11:04:31 +02004017 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02004018 *
Ron Eldora9788042018-12-05 11:04:31 +02004019 * \param ssl SSL context to use.
4020 * \param mki_value The MKI value to set.
4021 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02004022 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004023 * \note This function is relevant on client side only.
4024 * The server discovers the mki value during handshake.
4025 * A mki value set on server side using this function
4026 * is ignored.
4027 *
Johan Pascal85269572020-08-25 10:01:54 +02004028 * \return 0 on success
4029 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
4030 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02004031 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004032int mbedtls_ssl_dtls_srtp_set_mki_value(mbedtls_ssl_context *ssl,
4033 unsigned char *mki_value,
4034 uint16_t mki_len);
Johan Pascalb62bb512015-12-03 21:56:45 +01004035/**
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004036 * \brief Get the negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004037 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02004038 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004039 * \warning This function must be called after the handshake is
4040 * completed. The value returned by this function must
4041 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01004042 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01004043 * \param ssl The SSL context to query.
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004044 * \param dtls_srtp_info The negotiated DTLS-SRTP information:
Johan Pascal2258a4f2020-10-28 13:53:09 +01004045 * - Protection profile in use.
4046 * A direct mapping of the iana defined value for protection
4047 * profile on an uint16_t.
4048 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
4049 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
4050 * or peer's Hello packet was not parsed yet.
4051 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01004052 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004053void mbedtls_ssl_get_dtls_srtp_negotiation_result(const mbedtls_ssl_context *ssl,
4054 mbedtls_dtls_srtp_info *dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01004055#endif /* MBEDTLS_SSL_DTLS_SRTP */
4056
Glenn Straussd09b3432022-04-11 13:58:11 -04004057#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Paul Bakker5701cdc2012-09-27 21:49:42 +00004058/**
Paul Bakker490ecc82011-10-06 13:04:09 +00004059 * \brief Set the maximum supported version sent from the client side
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004060 * and/or accepted at the server side.
4061 *
4062 * See also the documentation of mbedtls_ssl_conf_min_version().
Paul Bakker2fbefde2013-06-29 16:01:15 +02004063 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02004064 * \note This ignores ciphersuites from higher versions.
4065 *
Glenn Straussd09b3432022-04-11 13:58:11 -04004066 * \note This function is deprecated and has been replaced by
4067 * \c mbedtls_ssl_conf_max_tls_version().
4068 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004069 * \param conf SSL configuration
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004070 * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3)
4071 * \param minor Minor version number
4072 * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2,
4073 * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3)
Paul Bakker490ecc82011-10-06 13:04:09 +00004074 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004075void MBEDTLS_DEPRECATED mbedtls_ssl_conf_max_version(mbedtls_ssl_config *conf, int major,
4076 int minor);
Glenn Straussd09b3432022-04-11 13:58:11 -04004077#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker490ecc82011-10-06 13:04:09 +00004078
Paul Bakker1d29fb52012-09-28 13:28:45 +00004079/**
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004080 * \brief Set the maximum supported version sent from the client side
4081 * and/or accepted at the server side.
4082 *
4083 * \note After the handshake, you can call
4084 * mbedtls_ssl_get_version_number() to see what version was
4085 * negotiated.
4086 *
4087 * \param conf SSL configuration
4088 * \param tls_version TLS protocol version number (\p mbedtls_ssl_protocol_version)
4089 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4090 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004091static inline void mbedtls_ssl_conf_max_tls_version(mbedtls_ssl_config *conf,
4092 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004093{
4094 conf->MBEDTLS_PRIVATE(max_tls_version) = tls_version;
4095}
4096
Glenn Straussd09b3432022-04-11 13:58:11 -04004097#if !defined(MBEDTLS_DEPRECATED_REMOVED)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004098/**
Paul Bakker1d29fb52012-09-28 13:28:45 +00004099 * \brief Set the minimum accepted SSL/TLS protocol version
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004100 *
4101 * \note By default, all supported versions are accepted.
4102 * Future versions of the library may disable older
4103 * protocol versions by default if they become deprecated.
4104 *
4105 * \note The following versions are supported (if enabled at
4106 * compile time):
4107 * - (D)TLS 1.2: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3,
4108 * \p minor = #MBEDTLS_SSL_MINOR_VERSION_3
4109 * - TLS 1.3: \p major = #MBEDTLS_SSL_MAJOR_VERSION_3,
4110 * \p minor = #MBEDTLS_SSL_MINOR_VERSION_4
4111 *
4112 * Note that the numbers in the constant names are the
4113 * TLS internal protocol numbers, and the minor versions
4114 * differ by one from the human-readable versions!
Paul Bakkerd2f068e2013-08-27 21:19:20 +02004115 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01004116 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
4117 * SSL_MIN_XXXXX_VERSION range is ignored.
4118 *
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004119 * \note After the handshake, you can call
Gilles Peskinece4f00d2022-02-12 00:47:23 +01004120 * mbedtls_ssl_get_version_number() to see what version was
4121 * negotiated.
4122 *
Glenn Straussd09b3432022-04-11 13:58:11 -04004123 * \note This function is deprecated and has been replaced by
4124 * \c mbedtls_ssl_conf_min_tls_version().
4125 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004126 * \param conf SSL configuration
Gilles Peskine57bf02b2022-02-16 12:06:22 +01004127 * \param major Major version number (#MBEDTLS_SSL_MAJOR_VERSION_3)
4128 * \param minor Minor version number
4129 * (#MBEDTLS_SSL_MINOR_VERSION_3 for (D)TLS 1.2,
4130 * #MBEDTLS_SSL_MINOR_VERSION_4 for TLS 1.3)
Paul Bakker1d29fb52012-09-28 13:28:45 +00004131 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004132void MBEDTLS_DEPRECATED mbedtls_ssl_conf_min_version(mbedtls_ssl_config *conf, int major,
4133 int minor);
Glenn Straussd09b3432022-04-11 13:58:11 -04004134#endif /* MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker1d29fb52012-09-28 13:28:45 +00004135
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004136/**
4137 * \brief Set the minimum supported version sent from the client side
4138 * and/or accepted at the server side.
4139 *
4140 * \note After the handshake, you can call
4141 * mbedtls_ssl_get_version_number() to see what version was
4142 * negotiated.
4143 *
4144 * \param conf SSL configuration
4145 * \param tls_version TLS protocol version number (\p mbedtls_ssl_protocol_version)
4146 * (#MBEDTLS_SSL_VERSION_UNKNOWN is not valid)
4147 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004148static inline void mbedtls_ssl_conf_min_tls_version(mbedtls_ssl_config *conf,
4149 mbedtls_ssl_protocol_version tls_version)
Glenn Strauss2dfcea22022-03-14 17:26:42 -04004150{
4151 conf->MBEDTLS_PRIVATE(min_tls_version) = tls_version;
4152}
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004154#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004155/**
4156 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004157 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004158 *
4159 * \note This should always be enabled, it is a security
4160 * improvement, and should not cause any interoperability
4161 * issue (used only if the peer supports it too).
4162 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004163 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004164 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004165 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004166void mbedtls_ssl_conf_encrypt_then_mac(mbedtls_ssl_config *conf, char etm);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004167#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01004168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004169#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004170/**
4171 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004172 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004173 *
4174 * \note This should always be enabled, it is a security fix to the
4175 * protocol, and should not cause any interoperability issue
4176 * (used only if the peer supports it too).
4177 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004178 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004179 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004180 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004181void mbedtls_ssl_conf_extended_master_secret(mbedtls_ssl_config *conf, char ems);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004182#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02004183
Janos Follath088ce432017-04-10 12:42:31 +01004184#if defined(MBEDTLS_SSL_SRV_C)
4185/**
4186 * \brief Whether to send a list of acceptable CAs in
4187 * CertificateRequest messages.
4188 * (Default: do send)
4189 *
4190 * \param conf SSL configuration
4191 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
4192 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
4193 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004194void mbedtls_ssl_conf_cert_req_ca_list(mbedtls_ssl_config *conf,
4195 char cert_req_ca_list);
Janos Follath088ce432017-04-10 12:42:31 +01004196#endif /* MBEDTLS_SSL_SRV_C */
4197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004198#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00004199/**
k-stachowiak6d722122019-02-08 17:03:33 +01004200 * \brief Set the maximum fragment length to emit and/or negotiate.
4201 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
4202 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004203 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01004204 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004205 * (Client: set maximum fragment length to emit *and*
4206 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02004207 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004208 *
k-stachowiak6d722122019-02-08 17:03:33 +01004209 * \note On the client side, the maximum fragment length extension
4210 * *will not* be used, unless the maximum fragment length has
4211 * been set via this function to a value different than
4212 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004213 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004214 * \note With TLS, this currently only affects ApplicationData (sent
4215 * with \c mbedtls_ssl_read()), not handshake messages.
4216 * With DTLS, this affects both ApplicationData and handshake.
4217 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02004218 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004219 * excluding record overhead that will be added to it, see
4220 * \c mbedtls_ssl_get_record_expansion().
4221 *
4222 * \note For DTLS, it is also possible to set a limit for the total
Tom Cosgrove1e211442022-05-26 11:51:00 +01004223 * size of datagrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02004224 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02004225 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01004226 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02004227 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004228 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
4229 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004230 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02004231 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004232 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004233int mbedtls_ssl_conf_max_frag_len(mbedtls_ssl_config *conf, unsigned char mfl_code);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004234#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02004235
TRodziewicz8476f2f2021-06-02 14:34:47 +02004236#if defined(MBEDTLS_SSL_SRV_C)
4237/**
TRodziewicz3946f792021-06-14 12:11:18 +02004238 * \brief Pick the ciphersuites order according to the second parameter
4239 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
4240 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004241 *
4242 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02004243 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
4244 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02004245 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004246void mbedtls_ssl_conf_preference_order(mbedtls_ssl_config *conf, int order);
TRodziewicz8476f2f2021-06-02 14:34:47 +02004247#endif /* MBEDTLS_SSL_SRV_C */
4248
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004249#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4250 defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02004251/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004252 * \brief Enable / Disable session tickets (client only).
4253 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004254 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02004255 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004256 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01004257 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004258 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
4259 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004260 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004261void mbedtls_ssl_conf_session_tickets(mbedtls_ssl_config *conf, int use_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004262#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4263 MBEDTLS_SSL_CLI_C */
4264
4265#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
4266 defined(MBEDTLS_SSL_SRV_C) && \
4267 defined(MBEDTLS_SSL_PROTO_TLS1_3)
4268/**
Jerry Yuba627bf2022-09-23 09:58:22 +08004269 * \brief Number of NewSessionTicket messages for the server to send
4270 * after handshake completion.
4271 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004272 * \note The default value is
Jerry Yuba627bf2022-09-23 09:58:22 +08004273 * \c MBEDTLS_SSL_TLS1_3_DEFAULT_NEW_SESSION_TICKETS.
4274 *
4275 * \note In case of a session resumption, this setting only partially apply.
4276 * At most one ticket is sent in that case to just renew the pool of
4277 * tickets of the client. The rationale is to avoid the number of
4278 * tickets on the server to become rapidly out of control when the
4279 * server has the same configuration for all its connection instances.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004280 *
Jerry Yu40b4a012022-09-22 23:48:38 +08004281 * \param conf SSL configuration
4282 * \param num_tickets Number of NewSessionTicket.
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004283 *
4284 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004285void mbedtls_ssl_conf_new_session_tickets(mbedtls_ssl_config *conf,
4286 uint16_t num_tickets);
Jerry Yu1ad7ace2022-08-09 13:28:39 +08004287#endif /* MBEDTLS_SSL_SESSION_TICKETS &&
4288 MBEDTLS_SSL_SRV_C &&
4289 MBEDTLS_SSL_PROTO_TLS1_3*/
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004290
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004291#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02004292/**
Paul Bakker09f097d2012-10-23 11:54:56 +00004293 * \brief Enable / Disable renegotiation support for connection when
4294 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004295 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00004296 *
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004297 * \warning It is recommended to always disable renegotiation unless you
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004298 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00004299 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02004300 * renegotiation or a poor understanding of its properties.
4301 *
4302 * \note Server-side, enabling renegotiation also makes the server
4303 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00004304 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004305 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004306 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
4307 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00004308 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004309void mbedtls_ssl_conf_renegotiation(mbedtls_ssl_config *conf, int renegotiation);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004310#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004311
4312/**
4313 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004314 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02004315 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004316 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004317 * be established even if the peer does not support
4318 * secure renegotiation, but does not allow renegotiation
4319 * to take place if not secure.
4320 * (Interoperable and secure option)
4321 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004322 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004323 * with non-upgraded peers. Allowing legacy renegotiation
4324 * makes the connection vulnerable to specific man in the
4325 * middle attacks. (See RFC 5746)
4326 * (Most interoperable and least secure option)
4327 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004328 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00004329 * if peer does not support secure renegotiation. Results
4330 * in interoperability issues with non-upgraded peers
4331 * that do not support renegotiation altogether.
4332 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00004333 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004334 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00004335 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
4336 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004337 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00004338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004339void mbedtls_ssl_conf_legacy_renegotiation(mbedtls_ssl_config *conf, int allow_legacy);
Paul Bakker48916f92012-09-16 19:57:18 +00004340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004341#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004342/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004343 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004344 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004345 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004346 * When we request a renegotiation, the peer can comply or
4347 * ignore the request. This function allows us to decide
4348 * whether to enforce our renegotiation requests by closing
4349 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004350 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004351 * However, records could already be in transit from the peer
4352 * when the request is emitted. In order to increase
4353 * reliability, we can accept a number of records before the
4354 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004355 *
4356 * The optimal value is highly dependent on the specific usage
4357 * scenario.
4358 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004359 * \note With DTLS and server-initiated renegotiation, the
Shaun Case8b0ecbc2021-12-20 21:14:10 -08004360 * HelloRequest is retransmitted every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02004361 * out or receives Application Data, until:
4362 * - max_records records have beens seen, if it is >= 0, or
4363 * - the number of retransmits that would happen during an
4364 * actual handshake has been reached.
4365 * Please remember the request might be lost a few times
4366 * if you consider setting max_records to a really low value.
4367 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004368 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004369 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004370 * which always behave as if max_record was 0. The reason is,
4371 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004372 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02004373 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004374 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004375 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004376 * enforce renegotiation, or a non-negative value to enforce
4377 * it but allow for a grace period of max_records records.
4378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004379void mbedtls_ssl_conf_renegotiation_enforced(mbedtls_ssl_config *conf, int max_records);
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02004380
4381/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004382 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00004383 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004384 *
4385 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01004386 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004387 * threshold. The default value is meant to prevent the
4388 * connection from being closed when the counter is about to
4389 * reached its maximal value (it is not allowed to wrap).
4390 *
4391 * Lower values can be used to enforce policies such as "keys
4392 * must be refreshed every N packets with cipher X".
4393 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00004394 * The renegotiation period can be disabled by setting
4395 * conf->disable_renegotiation to
4396 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
4397 *
4398 * \note When the configured transport is
4399 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
4400 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
4401 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00004402 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02004403 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004404 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01004405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004406void mbedtls_ssl_conf_renegotiation_period(mbedtls_ssl_config *conf,
4407 const unsigned char period[8]);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004408#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00004409
Paul Bakker43ca69c2011-01-15 17:35:19 +00004410/**
Hanno Becker8b170a02017-10-10 11:51:19 +01004411 * \brief Check if there is data already read from the
4412 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004413 *
4414 * \param ssl SSL context
4415 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004416 * \return 0 if nothing's pending, 1 otherwise.
4417 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004418 * \note This is different in purpose and behaviour from
4419 * \c mbedtls_ssl_get_bytes_avail in that it considers
4420 * any kind of unprocessed data, not only unread
4421 * application data. If \c mbedtls_ssl_get_bytes
4422 * returns a non-zero value, this function will
4423 * also signal pending data, but the converse does
4424 * not hold. For example, in DTLS there might be
4425 * further records waiting to be processed from
4426 * the current underlying transport's datagram.
4427 *
Hanno Becker9b19a122017-10-31 13:00:14 +00004428 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01004429 * does not imply that a subsequent call to
4430 * \c mbedtls_ssl_read will provide any data;
4431 * e.g., the unprocessed data might turn out
4432 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00004433 *
4434 * \note This function is useful in the following situation:
4435 * If the SSL/TLS module successfully returns from an
4436 * operation - e.g. a handshake or an application record
4437 * read - and you're awaiting incoming data next, you
4438 * must not immediately idle on the underlying transport
4439 * to have data ready, but you need to check the value
4440 * of this function first. The reason is that the desired
4441 * data might already be read but not yet processed.
4442 * If, in contrast, a previous call to the SSL/TLS module
4443 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
4444 * to call this function, as the latter error code entails
4445 * that all internal data has been processed.
4446 *
Hanno Becker8b170a02017-10-10 11:51:19 +01004447 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004448int mbedtls_ssl_check_pending(const mbedtls_ssl_context *ssl);
Hanno Becker8b170a02017-10-10 11:51:19 +01004449
4450/**
4451 * \brief Return the number of application data bytes
4452 * remaining to be read from the current record.
4453 *
4454 * \param ssl SSL context
4455 *
4456 * \return How many bytes are available in the application
4457 * data record read buffer.
4458 *
4459 * \note When working over a datagram transport, this is
4460 * useful to detect the current datagram's boundary
4461 * in case \c mbedtls_ssl_read has written the maximal
4462 * amount of data fitting into the input buffer.
4463 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004464 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004465size_t mbedtls_ssl_get_bytes_avail(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004466
4467/**
4468 * \brief Return the result of the certificate verification
4469 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004470 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00004471 *
Hanno Beckercc40d862018-10-23 10:28:01 +01004472 * \return \c 0 if the certificate verification was successful.
4473 * \return \c -1u if the result is not available. This may happen
4474 * e.g. if the handshake aborts early, or a verification
4475 * callback returned a fatal error.
4476 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
4477 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00004478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004479uint32_t mbedtls_ssl_get_verify_result(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004480
4481/**
Glenn Strauss8f526902022-01-13 00:04:49 -05004482 * \brief Return the id of the current ciphersuite
4483 *
4484 * \param ssl SSL context
4485 *
4486 * \return a ciphersuite id
4487 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004488int mbedtls_ssl_get_ciphersuite_id_from_ssl(const mbedtls_ssl_context *ssl);
Glenn Strauss8f526902022-01-13 00:04:49 -05004489
4490/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00004491 * \brief Return the name of the current ciphersuite
4492 *
4493 * \param ssl SSL context
4494 *
4495 * \return a string containing the ciphersuite name
4496 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004497const char *mbedtls_ssl_get_ciphersuite(const mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004498
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004499
4500/**
4501 * \brief Return the (D)TLS protocol version negotiated in the
4502 * given connection.
4503 *
Gilles Peskined44e0502022-02-12 00:45:21 +01004504 * \note If you call this function too early during the initial
4505 * handshake, before the two sides have agreed on a version,
4506 * this function returns #MBEDTLS_SSL_VERSION_UNKNOWN.
4507 *
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004508 * \param ssl The SSL context to query.
4509 * \return The negotiated protocol version.
4510 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04004511static inline mbedtls_ssl_protocol_version mbedtls_ssl_get_version_number(
Gilles Peskine449bd832023-01-11 14:50:10 +01004512 const mbedtls_ssl_context *ssl)
Glenn Strauss60bfe602022-03-14 19:04:24 -04004513{
4514 return ssl->MBEDTLS_PRIVATE(tls_version);
4515}
Gilles Peskinee1a0c252022-01-13 01:08:03 +01004516
Paul Bakker5121ce52009-01-03 21:22:43 +00004517/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004518 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004519 *
4520 * \param ssl SSL context
4521 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01004522 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00004523 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004524const char *mbedtls_ssl_get_version(const mbedtls_ssl_context *ssl);
Paul Bakker43ca69c2011-01-15 17:35:19 +00004525
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004526/**
4527 * \brief Return the (maximum) number of bytes added by the record
4528 * layer: header + encryption/MAC overhead (inc. padding)
4529 *
4530 * \param ssl SSL context
4531 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01004532 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004533 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004534int mbedtls_ssl_get_record_expansion(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02004535
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004536/**
4537 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004538 *
4539 * \note The logic to determine the maximum outgoing record payload is
4540 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004541 * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004542 * such as the max fragment length or record size limit extension if
4543 * used, and for DTLS the path MTU as configured and current
4544 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004545 *
4546 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
4547 * called with a larger length value.
4548 * With TLS, \c mbedtls_ssl_write() will fragment the input if
4549 * necessary and return the number of bytes written; it is up
4550 * to the caller to call \c mbedtls_ssl_write() again in
4551 * order to send the remaining bytes if any.
4552 *
Hanno Becker80d163d2021-04-21 06:28:18 +01004553 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004554 * \sa mbedtls_ssl_get_record_expansion()
4555 *
4556 * \param ssl SSL context
4557 *
4558 * \return Current maximum payload for an outgoing record,
4559 * or a negative error code.
4560 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004561int mbedtls_ssl_get_max_out_record_payload(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02004562
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004563/**
4564 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004565 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004566 * \note The logic to determine the maximum incoming record payload is
Hanno Beckerebd6ab72021-05-23 05:59:46 +01004567 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02004568 * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004569 * such as the max fragment length extension or record size limit
4570 * extension if used, and the current record expansion.
4571 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004572 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01004573 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004574 * \sa mbedtls_ssl_get_record_expansion()
4575 *
4576 * \param ssl SSL context
4577 *
Jan Bruckner1aabe5c2023-02-06 12:54:53 +01004578 * \return Current maximum payload for an incoming record,
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004579 * or a negative error code.
4580 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004581int mbedtls_ssl_get_max_in_record_payload(const mbedtls_ssl_context *ssl);
Hanno Becker2d8e99b2021-04-21 06:19:50 +01004582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004583#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00004584/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004585 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004586 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004587 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004588 *
Hanno Becker958efeb2019-02-25 10:13:43 +00004589 * \return The current peer certificate, if available.
4590 * The returned certificate is owned by the SSL context and
4591 * is valid only until the next call to the SSL API.
4592 * \return \c NULL if no peer certificate is available. This might
4593 * be because the chosen ciphersuite doesn't use CRTs
4594 * (PSK-based ciphersuites, for example), or because
4595 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
4596 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00004597 *
4598 * \note For one-time inspection of the peer's certificate during
4599 * the handshake, consider registering an X.509 CRT verification
4600 * callback through mbedtls_ssl_conf_verify() instead of calling
4601 * this function. Using mbedtls_ssl_conf_verify() also comes at
4602 * the benefit of allowing you to influence the verification
4603 * process, for example by masking expected and tolerated
4604 * verification failures.
4605 *
4606 * \warning You must not use the pointer returned by this function
4607 * after any further call to the SSL API, including
4608 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
4609 * because the pointer might change during renegotiation,
4610 * which happens transparently to the user.
4611 * If you want to use the certificate across API calls,
4612 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00004613 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004614const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert(const mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004615#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00004616
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004617#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00004618/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01004619 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004620 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004621 * \param ssl The SSL context representing the connection for which to
4622 * to export a session structure for later resumption.
4623 * \param session The target structure in which to store the exported session.
4624 * This must have been initialized with mbedtls_ssl_init_session()
4625 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004626 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01004627 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01004628 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01004629 * ticket-based resumption will be considered. For TLS 1.3,
4630 * once implemented, sessions equate to tickets, and calling
4631 * this function multiple times will export the available
4632 * tickets one a time until no further tickets are available,
4633 * in which case MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE will
4634 * be returned.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004635 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004636 * \note Calling this function multiple times will only be useful
4637 * once TLS 1.3 is supported. For TLS 1.2 connections, this
4638 * function should be called at most once.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004639 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01004640 * \return \c 0 if successful. In this case, \p session can be used for
4641 * session resumption by passing it to mbedtls_ssl_set_session(),
4642 * and serialized for storage via mbedtls_ssl_session_save().
4643 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no further session
4644 * is available for export.
4645 * This error is a non-fatal, and has no observable effect on
4646 * the SSL context or the destination session.
4647 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004648 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004649 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01004650 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004651 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004652int mbedtls_ssl_get_session(const mbedtls_ssl_context *ssl,
4653 mbedtls_ssl_session *session);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004654#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02004655
4656/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004657 * \brief Perform the SSL handshake
4658 *
4659 * \param ssl SSL context
4660 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004661 * \return \c 0 if successful.
4662 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004663 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004664 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004665 * transport - in this case you must call this function again
4666 * when the underlying transport is ready for the operation.
4667 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4668 * operation is in progress (see
4669 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4670 * must call this function again when the operation is ready.
4671 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4672 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4673 * in this case you must call this function again to complete
4674 * the handshake when you're done attending other tasks.
4675 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
4676 * and the client did not demonstrate reachability yet - in
4677 * this case you must stop using the context (see below).
4678 * \return Another SSL error code - in this case you must stop using
4679 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02004680 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004681 * \warning If this function returns something other than
4682 * \c 0,
4683 * #MBEDTLS_ERR_SSL_WANT_READ,
4684 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4685 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4686 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4687 * you must stop using the SSL context for reading or writing,
4688 * and either free it or call \c mbedtls_ssl_session_reset()
4689 * on it before re-using it for a new connection; the current
4690 * connection must be closed.
4691 *
4692 * \note If DTLS is in use, then you may choose to handle
4693 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
4694 * purposes, as it is an expected return value rather than an
4695 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01004696 *
4697 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004698 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004699 * from the underlying transport layer is currently being processed,
4700 * and it is safe to idle until the timer or the underlying transport
4701 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004702 * in which case the datagram of the underlying transport that is
4703 * currently being processed might or might not contain further
4704 * DTLS records.
Gilles Peskine8c2830a2022-08-04 23:37:51 +02004705 *
4706 * \note If the context is configured to allow TLS 1.3, or if
4707 * #MBEDTLS_USE_PSA_CRYPTO is enabled, the PSA crypto
4708 * subsystem must have been initialized by calling
4709 * psa_crypto_init() before calling this function.
Paul Bakker5121ce52009-01-03 21:22:43 +00004710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004711int mbedtls_ssl_handshake(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004712
4713/**
Paul Elliott93ba3e32022-03-18 21:51:13 +00004714 * \brief After calling mbedtls_ssl_handshake() to start the SSL
4715 * handshake you can call this function to check whether the
4716 * handshake is over for a given SSL context. This function
4717 * should be also used to determine when to stop calling
4718 * mbedtls_handshake_step() for that context.
4719 *
4720 * \param ssl SSL context
4721 *
4722 * \return \c 1 if handshake is over, \c 0 if it is still ongoing.
4723 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004724static inline int mbedtls_ssl_is_handshake_over(mbedtls_ssl_context *ssl)
Paul Elliott93ba3e32022-03-18 21:51:13 +00004725{
Gilles Peskine449bd832023-01-11 14:50:10 +01004726 return ssl->MBEDTLS_PRIVATE(state) >= MBEDTLS_SSL_HANDSHAKE_OVER;
Paul Elliott93ba3e32022-03-18 21:51:13 +00004727}
4728
4729/**
Paul Bakker1961b702013-01-25 14:49:24 +01004730 * \brief Perform a single step of the SSL handshake
4731 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02004732 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004733 * the next state after this function returns \c 0. Do not
Paul Elliott93ba3e32022-03-18 21:51:13 +00004734 * call this function if mbedtls_ssl_is_handshake_over()
4735 * returns \c 1.
4736 *
4737 * \warning Whilst in the past you may have used direct access to the
4738 * context state (ssl->state) in order to ascertain when to
4739 * stop calling this function and although you can still do
4740 * so with something like ssl->MBEDTLS_PRIVATE(state) or by
4741 * defining MBEDTLS_ALLOW_PRIVATE_ACCESS, this is now
4742 * considered deprecated and could be broken in any future
4743 * release. If you still find you have good reason for such
4744 * direct access, then please do contact the team to explain
4745 * this (raise an issue or post to the mailing list), so that
4746 * we can add a solution to your problem that will be
4747 * guaranteed to work in the future.
Paul Bakker1961b702013-01-25 14:49:24 +01004748 *
4749 * \param ssl SSL context
4750 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004751 * \return See mbedtls_ssl_handshake().
4752 *
4753 * \warning If this function returns something other than \c 0,
4754 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4755 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4756 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4757 * the SSL context for reading or writing, and either free it
4758 * or call \c mbedtls_ssl_session_reset() on it before
4759 * re-using it for a new connection; the current connection
4760 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01004761 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004762int mbedtls_ssl_handshake_step(mbedtls_ssl_context *ssl);
Paul Bakker1961b702013-01-25 14:49:24 +01004763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004764#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01004765/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004766 * \brief Initiate an SSL renegotiation on the running connection.
4767 * Client: perform the renegotiation right now.
4768 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00004769 * during the next call to mbedtls_ssl_read() if honored by
4770 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00004771 *
4772 * \param ssl SSL context
4773 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00004774 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004775 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
4776 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004777 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004778 * \warning If this function returns something other than \c 0,
4779 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4780 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4781 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4782 * the SSL context for reading or writing, and either free it
4783 * or call \c mbedtls_ssl_session_reset() on it before
4784 * re-using it for a new connection; the current connection
4785 * must be closed.
4786 *
Paul Bakker48916f92012-09-16 19:57:18 +00004787 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004788int mbedtls_ssl_renegotiate(mbedtls_ssl_context *ssl);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004789#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004790
4791/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004792 * \brief Read at most 'len' application data bytes
4793 *
4794 * \param ssl SSL context
4795 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02004796 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00004797 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004798 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004799 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04004800 * without sending a CloseNotify beforehand, which might happen
4801 * because of various reasons (internal error of an underlying
4802 * stack, non-conformant peer not sending a CloseNotify and
4803 * such) - in this case you must stop using the context
4804 * (see below).
4805 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
4806 * transport is still functional, but the peer has
4807 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004808 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004809 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004810 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004811 * transport - in this case you must call this function again
4812 * when the underlying transport is ready for the operation.
4813 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4814 * operation is in progress (see
4815 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4816 * must call this function again when the operation is ready.
4817 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4818 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4819 * in this case you must call this function again to complete
4820 * the handshake when you're done attending other tasks.
4821 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
4822 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004823 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004824 * \return Another SSL error code - in this case you must stop using
4825 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004826 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004827 * \warning If this function returns something other than
4828 * a positive value,
4829 * #MBEDTLS_ERR_SSL_WANT_READ,
4830 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4831 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4832 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4833 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
4834 * you must stop using the SSL context for reading or writing,
4835 * and either free it or call \c mbedtls_ssl_session_reset()
4836 * on it before re-using it for a new connection; the current
4837 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004838 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004839 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004840 * (which can only happen server-side), it means that a client
4841 * is initiating a new connection using the same source port.
4842 * You can either treat that as a connection close and wait
4843 * for the client to resend a ClientHello, or directly
4844 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004845 * context (as it has been reset internally). Either way, you
4846 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004847 * connection: application state, if any, should be reset, and
4848 * most importantly the identity of the client must be checked
4849 * again. WARNING: not validating the identity of the client
4850 * again, or not transmitting the new identity to the
4851 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01004852 *
Hanno Becker8ec81022017-10-10 10:35:08 +01004853 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004854 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004855 * from the underlying transport layer is currently being processed,
4856 * and it is safe to idle until the timer or the underlying transport
4857 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004858 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
4859 * initially available on the underlying transport, as this data may have
4860 * been only e.g. duplicated messages or a renegotiation request.
4861 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
4862 * when reacting to an incoming-data event from the underlying transport.
4863 * - On success, the datagram of the underlying transport that is currently
4864 * being processed may contain further DTLS records. You should call
4865 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01004866 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004867 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004868int mbedtls_ssl_read(mbedtls_ssl_context *ssl, unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004869
4870/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004871 * \brief Try to write exactly 'len' application data bytes
4872 *
4873 * \warning This function will do partial writes in some cases. If the
4874 * return value is non-negative but less than length, the
4875 * function must be called again with updated arguments:
4876 * buf + ret, len - ret (if ret is the return value) until
4877 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00004878 *
4879 * \param ssl SSL context
4880 * \param buf buffer holding the data
4881 * \param len how many bytes must be written
4882 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004883 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004884 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004885 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004886 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004887 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004888 * transport - in this case you must call this function again
4889 * when the underlying transport is ready for the operation.
4890 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4891 * operation is in progress (see
4892 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4893 * must call this function again when the operation is ready.
4894 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4895 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4896 * in this case you must call this function again to complete
4897 * the handshake when you're done attending other tasks.
4898 * \return Another SSL error code - in this case you must stop using
4899 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00004900 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004901 * \warning If this function returns something other than
4902 * a non-negative value,
4903 * #MBEDTLS_ERR_SSL_WANT_READ,
4904 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4905 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4906 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4907 * you must stop using the SSL context for reading or writing,
4908 * and either free it or call \c mbedtls_ssl_session_reset()
4909 * on it before re-using it for a new connection; the current
4910 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004911 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004912 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00004913 * it must be called later with the *same* arguments,
Jan Bruckner9ff6f8c2022-08-22 16:05:58 +02004914 * until it returns a value greater than or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004915 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004916 * some partial data in the output buffer, however this is not
4917 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02004918 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00004919 * \note If the requested length is greater than the maximum
4920 * fragment length (either the built-in limit or the one set
4921 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004922 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004923 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01004924 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004925 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004926 *
4927 * \note Attempting to write 0 bytes will result in an empty TLS
4928 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004930int mbedtls_ssl_write(mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len);
Paul Bakker5121ce52009-01-03 21:22:43 +00004931
4932/**
Paul Bakker0a925182012-04-16 06:46:41 +00004933 * \brief Send an alert message
4934 *
4935 * \param ssl SSL context
4936 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004937 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004938 * \param message The alert message (SSL_ALERT_MSG_*)
4939 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004940 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004941 *
4942 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004943 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4944 * the SSL context for reading or writing, and either free it or
4945 * call \c mbedtls_ssl_session_reset() on it before re-using it
4946 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004947 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004948int mbedtls_ssl_send_alert_message(mbedtls_ssl_context *ssl,
4949 unsigned char level,
4950 unsigned char message);
Paul Bakker0a925182012-04-16 06:46:41 +00004951/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004952 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004953 *
4954 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004955 *
4956 * \return 0 if successful, or a specific SSL error code.
4957 *
4958 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004959 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4960 * the SSL context for reading or writing, and either free it or
4961 * call \c mbedtls_ssl_session_reset() on it before re-using it
4962 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004963 */
Gilles Peskine449bd832023-01-11 14:50:10 +01004964int mbedtls_ssl_close_notify(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00004965
Ronald Cron4a8c9e22022-10-26 18:49:09 +02004966#if defined(MBEDTLS_SSL_EARLY_DATA)
4967
4968#if defined(MBEDTLS_SSL_SRV_C)
4969/**
4970 * \brief Read at most 'len' application data bytes while performing
4971 * the handshake (early data).
4972 *
4973 * \note This function behaves mainly as mbedtls_ssl_read(). The
4974 * specification of mbedtls_ssl_read() relevant to TLS 1.3
4975 * (thus not the parts specific to (D)TLS 1.2) applies to this
4976 * function and the present documentation is restricted to the
4977 * differences with mbedtls_ssl_read().
4978 *
4979 * \param ssl SSL context
4980 * \param buf buffer that will hold the data
4981 * \param len maximum number of bytes to read
4982 *
4983 * \return One additional specific return value:
4984 * #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA.
4985 *
4986 * #MBEDTLS_ERR_SSL_CANNOT_READ_EARLY_DATA is returned when it
4987 * is not possible to read early data for the SSL context
4988 * \p ssl.
4989 *
4990 * It may have been possible and it is not possible
4991 * anymore because the server received the End of Early Data
4992 * message or the maximum number of allowed early data for the
4993 * PSK in use has been reached.
4994 *
4995 * It may never have been possible and will never be possible
4996 * for the SSL context \p ssl because the use of early data
4997 * is disabled for that context or more generally the context
4998 * is not suitably configured to enable early data or the
4999 * client does not use early data or the first call to the
5000 * function was done while the handshake was already too
5001 * advanced to gather and accept early data.
5002 *
5003 * It is not possible to read early data for the SSL context
5004 * \p ssl but this does not preclude for using it with
5005 * mbedtls_ssl_write(), mbedtls_ssl_read() or
5006 * mbedtls_ssl_handshake().
5007 *
5008 * \note When a server wants to retrieve early data, it is expected
5009 * that this function starts the handshake for the SSL context
5010 * \p ssl. But this is not mandatory.
5011 *
5012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005013int mbedtls_ssl_read_early_data(mbedtls_ssl_context *ssl,
5014 unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005015#endif /* MBEDTLS_SSL_SRV_C */
5016
5017#if defined(MBEDTLS_SSL_CLI_C)
5018/**
5019 * \brief Try to write exactly 'len' application data bytes while
5020 * performing the handshake (early data).
5021 *
5022 * \note This function behaves mainly as mbedtls_ssl_write(). The
5023 * specification of mbedtls_ssl_write() relevant to TLS 1.3
5024 * (thus not the parts specific to (D)TLS1.2) applies to this
5025 * function and the present documentation is restricted to the
5026 * differences with mbedtls_ssl_write().
5027 *
5028 * \param ssl SSL context
5029 * \param buf buffer holding the data
5030 * \param len how many bytes must be written
5031 *
5032 * \return One additional specific return value:
5033 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA.
5034 *
5035 * #MBEDTLS_ERR_SSL_CANNOT_WRITE_EARLY_DATA is returned when it
5036 * is not possible to write early data for the SSL context
5037 * \p ssl.
5038 *
5039 * It may have been possible and it is not possible
5040 * anymore because the client received the server Finished
5041 * message, the server rejected early data or the maximum
5042 * number of allowed early data for the PSK in use has been
5043 * reached.
5044 *
5045 * It may never have been possible and will never be possible
5046 * for the SSL context \p ssl because the use of early data
5047 * is disabled for that context or more generally the context
5048 * is not suitably configured to enable early data or the first
5049 * call to the function was done while the handshake was
5050 * already completed.
5051 *
5052 * It is not possible to write early data for the SSL context
5053 * \p ssl but this does not preclude for using it with
5054 * mbedtls_ssl_write(), mbedtls_ssl_read() or
5055 * mbedtls_ssl_handshake().
5056 *
5057 * \note This function may write early data only if the SSL context
5058 * has been configured for the handshake with a PSK for which
5059 * early data is allowed.
5060 *
5061 * \note To maximize the number of early data that can be written in
5062 * the course of the handshake, it is expected that this
5063 * function starts the handshake for the SSL context \p ssl.
5064 * But this is not mandatory.
5065 *
5066 * \note This function does not provide any information on whether
5067 * the server has accepted or will accept early data or not.
5068 * When it returns a positive value, it just means that it
5069 * has written early data to the server. To know whether the
5070 * server has accepted early data or not, you should call
5071 * mbedtls_ssl_get_early_data_status() with the handshake
5072 * completed.
5073 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005074int mbedtls_ssl_write_early_data(mbedtls_ssl_context *ssl,
5075 const unsigned char *buf, size_t len);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005076
5077#define MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT 0
5078#define MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED 1
5079#define MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED 2
5080/**
5081 * \brief Get the status of the negotiation of the use of early data.
5082 *
5083 * \param ssl The SSL context to query
5084 *
5085 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called
5086 * from the server-side.
5087 *
5088 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if this function is called
5089 * prior to completion of the handshake.
5090 *
5091 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_SENT if the client has
5092 * not indicated the use of early data to the server.
5093 *
5094 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED if the client has
5095 * indicated the use of early data and the server has accepted
5096 * it.
5097 *
5098 * \return #MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED if the client has
5099 * indicated the use of early data but the server has rejected
5100 * it. In this situation, the client may want to re-send the
5101 * early data it may have tried to send by calling
5102 * mbedtls_ssl_write_early_data() as ordinary post-handshake
5103 * application data by calling mbedtls_ssl_write().
5104 *
5105 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005106int mbedtls_ssl_get_early_data_status(mbedtls_ssl_context *ssl);
Ronald Cron4a8c9e22022-10-26 18:49:09 +02005107#endif /* MBEDTLS_SSL_CLI_C */
5108
5109#endif /* MBEDTLS_SSL_EARLY_DATA */
5110
Paul Bakker5121ce52009-01-03 21:22:43 +00005111/**
Paul Bakker48916f92012-09-16 19:57:18 +00005112 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00005113 *
5114 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00005115 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005116void mbedtls_ssl_free(mbedtls_ssl_context *ssl);
Paul Bakker5121ce52009-01-03 21:22:43 +00005117
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005118#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00005119/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005120 * \brief Save an active connection as serialized data in a buffer.
5121 * This allows the freeing or re-using of the SSL context
5122 * while still picking up the connection later in a way that
5123 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005124 *
5125 * \see mbedtls_ssl_context_load()
5126 *
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005127 * \note The serialized data only contains the data that is
5128 * necessary to resume the connection: negotiated protocol
5129 * options, session identifier, keys, etc.
5130 * Loading a saved SSL context does not restore settings and
5131 * state related to how the application accesses the context,
5132 * such as configured callback functions, user data, pending
5133 * incoming or outgoing data, etc.
5134 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005135 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005136 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005137 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
5138 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005139 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005140 * mbedtls_ssl_session_reset() on \p ssl which as a result is
5141 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005142 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005143 * state. You're then free to either re-use the context
5144 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005145 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005146 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005147 *
5148 * \param ssl The SSL context to save. On success, it is no longer
5149 * associated with the connection that has been serialized.
5150 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03005151 * writeable buffer of at least \p buf_len bytes, or may be \c
5152 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005153 * \param buf_len The number of bytes available for writing in \p buf.
5154 * \param olen The size in bytes of the data that has been or would have
5155 * been written. It must point to a valid \c size_t.
5156 *
5157 * \note \p olen is updated to the correct value regardless of
5158 * whether \p buf_len was large enough. This makes it possible
5159 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005160 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
5161 * the value of \p olen is only guaranteed to be correct when
5162 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
5163 * \c 0. If the return value is different, then the value of
5164 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005165 *
5166 * \return \c 0 if successful.
5167 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02005168 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
Shaun Case8b0ecbc2021-12-20 21:14:10 -08005169 * while resetting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005170 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005171 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005172 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005173 * ciphersuite, or renegotiation is enabled.
5174 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005175int mbedtls_ssl_context_save(mbedtls_ssl_context *ssl,
5176 unsigned char *buf,
5177 size_t buf_len,
5178 size_t *olen);
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02005179
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005180/**
5181 * \brief Load serialized connection data to an SSL context.
5182 *
5183 * \see mbedtls_ssl_context_save()
5184 *
5185 * \warning The same serialized data must never be loaded into more
5186 * that one context. In order to ensure that, after
5187 * successfully loading serialized data to an SSL context, you
5188 * should immediately destroy or invalidate all copies of the
5189 * serialized data that was loaded. Loading the same data in
5190 * more than one context would cause severe security failures
5191 * including but not limited to loss of confidentiality.
5192 *
5193 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005194 * prepared in one of the two following ways. The first way is
5195 * to take a context freshly initialised with
5196 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005197 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005198 * the original connection. The second way is to
5199 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005200 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005201 * Either way, you must not use the context to perform a
5202 * handshake between calling mbedtls_ssl_setup() or
5203 * mbedtls_ssl_session_reset() and calling this function. You
5204 * may however call other setter functions in that time frame
5205 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005206 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005207 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005208 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02005209 * and settings before you can use the connection again
5210 * (unless they were already set before calling
5211 * mbedtls_ssl_session_reset() and the values are suitable for
5212 * the present connection). Specifically, you want to call
Gilles Peskine49d7ddf2022-01-27 23:25:51 +01005213 * at least mbedtls_ssl_set_bio(),
5214 * mbedtls_ssl_set_timer_cb(), and
5215 * mbedtls_ssl_set_user_data_n() or
5216 * mbedtls_ssl_set_user_data_p() if they were set originally.
5217 * All other SSL setter functions
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02005218 * are not necessary to call, either because they're only used
5219 * in handshakes, or because the setting is already saved. You
5220 * might choose to call them anyway, for example in order to
5221 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02005222 * connection and the case of loading an already-established
5223 * connection.
5224 *
5225 * \note If you have new information about the path MTU, you want to
5226 * call mbedtls_ssl_set_mtu() after calling this function, as
5227 * otherwise this function would overwrite your
5228 * newly-configured value with the value that was active when
5229 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005230 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02005231 * \note When this function returns an error code, it calls
5232 * mbedtls_ssl_free() on \p ssl. In this case, you need to
5233 * prepare the context with the usual sequence starting with a
5234 * call to mbedtls_ssl_init() if you want to use it again.
5235 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005236 * \param ssl The SSL context structure to be populated. It must have
5237 * been prepared as described in the note above.
5238 * \param buf The buffer holding the serialized connection data. It must
5239 * be a readable buffer of at least \p len bytes.
5240 * \param len The size of the serialized data in bytes.
5241 *
5242 * \return \c 0 if successful.
5243 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02005244 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
5245 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005246 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
5247 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005248int mbedtls_ssl_context_load(mbedtls_ssl_context *ssl,
5249 const unsigned char *buf,
5250 size_t len);
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02005251#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02005252
5253/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005254 * \brief Initialize an SSL configuration context
5255 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005256 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005257 *
5258 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01005259 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005260 *
5261 * \param conf SSL configuration context
5262 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005263void mbedtls_ssl_config_init(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005264
5265/**
Adam Wolf039080f2019-09-10 09:53:08 -05005266 * \brief Load reasonable default SSL configuration values.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005267 * (You need to call mbedtls_ssl_config_init() first.)
5268 *
5269 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005270 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
5271 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
5272 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02005273 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005274 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02005275 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01005276 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005277 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02005278 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005280int mbedtls_ssl_config_defaults(mbedtls_ssl_config *conf,
5281 int endpoint, int transport, int preset);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005282
5283/**
5284 * \brief Free an SSL configuration context
5285 *
5286 * \param conf SSL configuration context
5287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005288void mbedtls_ssl_config_free(mbedtls_ssl_config *conf);
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02005289
5290/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005291 * \brief Initialize SSL session structure
5292 *
5293 * \param session SSL session
5294 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005295void mbedtls_ssl_session_init(mbedtls_ssl_session *session);
Paul Bakkeraccaffe2014-06-26 13:37:14 +02005296
5297/**
Paul Bakker0a597072012-09-25 21:55:46 +00005298 * \brief Free referenced items in an SSL session including the
5299 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00005300 *
Ron Eldor00115032018-07-17 11:21:50 +03005301 * \note A session object can be freed even if the SSL context
5302 * that was used to retrieve the session is still in use.
5303 *
Paul Bakker48916f92012-09-16 19:57:18 +00005304 * \param session SSL session
5305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005306void mbedtls_ssl_session_free(mbedtls_ssl_session *session);
Paul Bakker48916f92012-09-16 19:57:18 +00005307
Ron Eldor51d3ab52019-05-12 14:54:30 +03005308/**
5309 * \brief TLS-PRF function for key derivation.
5310 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005311 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005312 * \param secret Secret for the key derivation function.
5313 * \param slen Length of the secret.
5314 * \param label String label for the key derivation function,
5315 * terminated with null character.
5316 * \param random Random bytes.
5317 * \param rlen Length of the random bytes buffer.
5318 * \param dstbuf The buffer holding the derived key.
5319 * \param dlen Length of the output buffer.
5320 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02005321 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03005322 */
Gilles Peskine449bd832023-01-11 14:50:10 +01005323int mbedtls_ssl_tls_prf(const mbedtls_tls_prf_types prf,
5324 const unsigned char *secret, size_t slen,
5325 const char *label,
5326 const unsigned char *random, size_t rlen,
5327 unsigned char *dstbuf, size_t dlen);
Ron Eldor51d3ab52019-05-12 14:54:30 +03005328
Paul Bakker5121ce52009-01-03 21:22:43 +00005329#ifdef __cplusplus
5330}
5331#endif
5332
5333#endif /* ssl.h */