blob: 956afc68448f13576d0becad658827776742f1f8 [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
Mateusz Starzyk846f0212021-05-19 19:44:07 +020024#include "mbedtls/private_access.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000025
Bence Szépkútic662b362021-05-27 11:25:03 +020026#include "mbedtls/build_info.h"
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010027
Jaeden Amero6609aef2019-07-04 20:01:14 +010028#include "mbedtls/bignum.h"
29#include "mbedtls/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020030
Jaeden Amero6609aef2019-07-04 20:01:14 +010031#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010034#include "mbedtls/x509_crt.h"
35#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020036#endif
Paul Bakkered27a042013-04-18 22:46:23 +020037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010039#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000040#endif
41
John Durkop07cc04a2020-11-16 22:08:34 -080042/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
43 * to guards also being in ssl_srv.c and ssl_cli.c. There is a gap
44 * in functionality that access to ecdh_ctx structure is needed for
45 * MBEDTLS_ECDSA_C which does not seem correct.
46 */
47#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010048#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010049#endif
50
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010052#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020053#endif
54
Hanno Becker43633132018-10-22 15:31:03 +010055#if defined(MBEDTLS_USE_PSA_CRYPTO)
56#include "psa/crypto.h"
57#endif /* MBEDTLS_USE_PSA_CRYPTO */
58
Paul Bakker13e2dfe2009-07-28 07:18:38 +000059/*
60 * SSL Error codes
61 */
Gilles Peskined2971572021-07-26 18:48:10 +020062/** A cryptographic operation is in progress. Try again later. */
63#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000
64/** The requested feature is not available. */
65#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080
66/** Bad input parameters to function. */
67#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100
68/** Verification of the message MAC failed. */
69#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180
70/** An invalid SSL record was received. */
71#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200
72/** The connection indicated an EOF. */
73#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280
74/** A message could not be parsed due to a syntactic error. */
75#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300
Dave Rodgmanbb05cd02021-06-29 10:37:43 +010076/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020077/** No RNG was provided to the SSL module. */
78#define MBEDTLS_ERR_SSL_NO_RNG -0x7400
79/** No client certification received from the client, but required by the authentication mode. */
80#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480
81/** Client received an extended server hello containing an unsupported extension */
82#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500
83/** No ALPN protocols supported that the client advertises */
84#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580
85/** The own private key or pre-shared key is not set, but needed. */
86#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600
87/** No CA Chain is set, but required to operate. */
88#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680
89/** An unexpected message was received from our peer. */
90#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700
91/** A fatal alert message was received from our peer. */
92#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780
93/** No server could be identified matching the client's SNI. */
94#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800
95/** The peer notified us that the connection is going to be closed. */
96#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880
Hanno Becker90d59dd2021-06-24 11:17:13 +010097/* Error space gap */
Hanno Beckerc3411d42021-06-24 11:09:00 +010098/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +020099/** Processing of the Certificate handshake message failed. */
100#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00
Hanno Becker5697af02021-06-24 10:33:51 +0100101/* Error space gap */
Hanno Beckercbc8f6f2021-06-24 10:32:31 +0100102/* Error space gap */
Hanno Becker029cc2f2021-06-24 10:09:50 +0100103/* Error space gap */
Hanno Becker666b5b42021-06-24 10:13:31 +0100104/* Error space gap */
Hanno Beckerb24e74b2021-06-24 09:52:01 +0100105/* Error space gap */
Hanno Beckerd3eec782021-06-24 10:21:46 +0100106/* Error space gap */
Hanno Beckerd934a2a2021-06-24 10:23:45 +0100107/* Error space gap */
Hanno Beckerd2002962021-06-24 10:25:40 +0100108/* Error space gap */
Hanno Beckera0ca87e2021-06-24 10:27:37 +0100109/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200110/** Memory allocation failed */
111#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00
112/** Hardware acceleration function returned with error */
113#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80
114/** Hardware acceleration function skipped / left alone data */
115#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80
116/** Handshake protocol not within min/max boundaries */
117#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80
118/** The handshake negotiation failed. */
119#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00
120/** Session ticket has expired. */
121#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80
122/** Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
123#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00
124/** Unknown identity received (eg, PSK identity) */
125#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80
126/** Internal error (eg, unexpected failure in lower-level module) */
127#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00
128/** A counter would wrap (eg, too many messages exchanged). */
129#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80
130/** Unexpected message at ServerHello in renegotiation. */
131#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00
132/** DTLS client must retry for hello verification */
133#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80
134/** A buffer is too small to receive or write a message */
135#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00
Dave Rodgman096c4112021-06-29 09:52:06 +0100136/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200137/** No data of requested type currently available on underlying transport. */
138#define MBEDTLS_ERR_SSL_WANT_READ -0x6900
139/** Connection requires a write call. */
140#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880
141/** The operation timed out. */
142#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800
143/** The client initiated a reconnect from the same port. */
144#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780
145/** Record header looks valid but is not expected. */
146#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700
147/** The alert message received indicates a non-fatal error. */
148#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680
149/** A field in a message was incorrect or inconsistent with other fields. */
150#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600
151/** Internal-only message signaling that further message-processing should be done */
152#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580
153/** The asynchronous operation is not completed yet. */
154#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500
155/** Internal-only message signaling that a message arrived early. */
156#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480
Dave Rodgmanc628fc92021-06-29 14:32:46 +0100157/* Error space gap */
158/* Error space gap */
159/* Error space gap */
160/* Error space gap */
161/* Error space gap */
162/* Error space gap */
163/* Error space gap */
164/* Error space gap */
Gilles Peskined2971572021-07-26 18:48:10 +0200165/** An encrypted DTLS-frame with an unexpected CID was received. */
166#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000
167/** An operation failed due to an unexpected version or configuration. */
168#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00
169/** Invalid value in SSL config */
170#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80
Paul Bakker5121ce52009-01-03 21:22:43 +0000171
172/*
Jerry Yue226cef2021-08-27 22:06:20 +0800173 * TLS 1.3 NamedGroup values
174 *
175 * From RF 8446
176 * enum {
177 * // Elliptic Curve Groups (ECDHE)
178 * secp256r1(0x0017), secp384r1(0x0018), secp521r1(0x0019),
179 * x25519(0x001D), x448(0x001E),
180 * // Finite Field Groups (DHE)
181 * ffdhe2048(0x0100), ffdhe3072(0x0101), ffdhe4096(0x0102),
182 * ffdhe6144(0x0103), ffdhe8192(0x0104),
183 * // Reserved Code Points
184 * ffdhe_private_use(0x01FC..0x01FF),
185 * ecdhe_private_use(0xFE00..0xFEFF),
186 * (0xFFFF)
187 * } NamedGroup;
188 *
189 */
190/* Elliptic Curve Groups (ECDHE) */
191#define MBEDTLS_SSL_TLS13_NAMED_GROUP_SECP256R1 0x0017
192#define MBEDTLS_SSL_TLS13_NAMED_GROUP_SECP384R1 0x0018
193#define MBEDTLS_SSL_TLS13_NAMED_GROUP_SECP521R1 0x0019
194#define MBEDTLS_SSL_TLS13_NAMED_GROUP_X25519 0x001D
195#define MBEDTLS_SSL_TLS13_NAMED_GROUP_X448 0x001E
196/* Finite Field Groups (DHE) */
197#define MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE2048 0x0100
198#define MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE3072 0x0101
199#define MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE4096 0x0102
200#define MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE6144 0x0103
201#define MBEDTLS_SSL_TLS13_NAMED_GROUP_FFDHE8192 0x0104
202
203/*
Hanno Becker71f1ed62021-07-24 06:01:47 +0100204 * TLS 1.3 Key Exchange Modes
205 *
206 * Mbed TLS internal identifiers for use with the SSL configuration API
207 * mbedtls_ssl_conf_tls13_key_exchange_modes().
208 */
209
Hanno Beckera2535932021-08-02 21:20:54 +0100210#define MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK ( 1u << 0 ) /*!< Pure-PSK TLS 1.3 key exchange,
211 * encompassing both externally agreed PSKs
212 * as well as resumption PSKs. */
213#define MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL ( 1u << 1 ) /*!< Pure-Ephemeral TLS 1.3 key exchanges,
214 * including for example ECDHE and DHE
215 * key exchanges. */
216#define MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ( 1u << 2 ) /*!< PSK-Ephemeral TLS 1.3 key exchanges,
217 * using both a PSK and an ephemeral
218 * key exchange. */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100219
220/* Convenience macros for sets of key exchanges. */
221#define MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_ALL \
222 ( MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK | \
223 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL | \
Hanno Beckera2535932021-08-02 21:20:54 +0100224 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL ) /*!< All TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100225#define MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_ALL \
226 ( MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK | \
Hanno Beckera2535932021-08-02 21:20:54 +0100227 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) /*!< All PSK-based TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100228#define MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL_ALL \
229 ( MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL | \
Hanno Beckera2535932021-08-02 21:20:54 +0100230 MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL ) /*!< All ephemeral TLS 1.3 key exchanges */
Hanno Becker71f1ed62021-07-24 06:01:47 +0100231
232/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000233 * Various constants
234 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100235
236/* These are the high an low bytes of ProtocolVersion as defined by:
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100237 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
238 * - RFC 8446: see section 4.2.1
239 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200240#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Hanno Becker2ab47dc2020-05-04 12:19:12 +0100242#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 (experimental) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000243
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
245#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100246
Simon Butcher9f812312015-09-28 19:22:33 +0100247#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200248#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
249
250#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 +0100251
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200252/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200253 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
255#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
256#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
257#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
258#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
259#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200260
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200261#define MBEDTLS_SSL_IS_CLIENT 0
262#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200263
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
265#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200266
Hanno Becker019f4b52019-04-09 15:12:56 +0100267#define MBEDTLS_SSL_CID_DISABLED 0
268#define MBEDTLS_SSL_CID_ENABLED 1
269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200270#define MBEDTLS_SSL_ETM_DISABLED 0
271#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#define MBEDTLS_SSL_VERIFY_NONE 0
276#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
277#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200278#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000279
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
281#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000282
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200283#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
284#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000285
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200286#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
287#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200288
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200289#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
290#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
293#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
294#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000295
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
297#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
298#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200299
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
301#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200302
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200303#define MBEDTLS_SSL_PRESET_DEFAULT 0
304#define MBEDTLS_SSL_PRESET_SUITEB 2
305
Janos Follath088ce432017-04-10 12:42:31 +0100306#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
307#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
308
Ron Eldor591f1622018-01-22 12:30:04 +0200309#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
310#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
311
TRodziewicz3946f792021-06-14 12:11:18 +0200312#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
313#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200314
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200315/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200316 * Default range for DTLS retransmission timer value, in milliseconds.
317 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
318 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
320#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200321
Paul Bakker088c5c52014-04-25 11:11:10 +0200322/**
323 * \name SECTION: Module settings
324 *
325 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200326 * Either change them in mbedtls_config.h or define them on the compiler command line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200327 * \{
328 */
329
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200330/*
Angus Grattond8213d02016-05-25 20:56:48 +1000331 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200332 * determines the size of each of the two internal I/O buffers.
333 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200334 * Note: the RFC defines the default size of SSL / TLS messages. If you
335 * change the value here, other clients / servers may not be able to
336 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200337 * both sides of the connection and have it reduced at both sides, or
338 * if you're using the Max Fragment Length extension and you know all your
339 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200340 */
Angus Grattond8213d02016-05-25 20:56:48 +1000341#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100342#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000343#endif
344
345#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100346#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000347#endif
348
Hanno Becker28007512018-08-28 09:46:44 +0100349/*
350 * Maximum number of heap-allocated bytes for the purpose of
351 * DTLS handshake message reassembly and future message buffering.
352 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100353#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100354#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100355#endif
356
Hanno Becker019f4b52019-04-09 15:12:56 +0100357/*
358 * Maximum length of CIDs for incoming and outgoing messages.
359 */
360#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100361#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100362#endif
363
364#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
365#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
366#endif
367
TRodziewicze8dd7092021-05-12 14:19:11 +0200368#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
369#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100370#endif
371
Paul Bakker088c5c52014-04-25 11:11:10 +0200372/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000373
374/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100375 * Length of the verify data for secure renegotiation
376 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100378
379/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200380 * Signaling ciphersuite values (SCSV)
381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000383
Paul Bakker5121ce52009-01-03 21:22:43 +0000384/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000385 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200386 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200388#define MBEDTLS_SSL_HASH_NONE 0
389#define MBEDTLS_SSL_HASH_MD5 1
390#define MBEDTLS_SSL_HASH_SHA1 2
391#define MBEDTLS_SSL_HASH_SHA224 3
392#define MBEDTLS_SSL_HASH_SHA256 4
393#define MBEDTLS_SSL_HASH_SHA384 5
394#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396#define MBEDTLS_SSL_SIG_ANON 0
397#define MBEDTLS_SSL_SIG_RSA 1
398#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000399
400/*
Hanno Becker551265f2021-08-10 13:03:48 +0100401 * TLS 1.3 signature algorithms
402 * RFC 8446, Section 4.2.2
403 */
404
405/* RSASSA-PKCS1-v1_5 algorithms */
406#define MBEDTLS_TLS13_SIG_RSA_PKCS1_SHA256 0x0401
407#define MBEDTLS_TLS13_SIG_RSA_PKCS1_SHA384 0x0501
408#define MBEDTLS_TLS13_SIG_RSA_PKCS1_SHA512 0x0601
409
410/* ECDSA algorithms */
411#define MBEDTLS_TLS13_SIG_ECDSA_SECP256R1_SHA256 0x0403
412#define MBEDTLS_TLS13_SIG_ECDSA_SECP384R1_SHA384 0x0503
413#define MBEDTLS_TLS13_SIG_ECDSA_SECP521R1_SHA512 0x0603
414
415/* RSASSA-PSS algorithms with public key OID rsaEncryption */
416#define MBEDTLS_TLS13_SIG_RSA_PSS_RSAE_SHA256 0x0804
417#define MBEDTLS_TLS13_SIG_RSA_PSS_RSAE_SHA384 0x0805
418#define MBEDTLS_TLS13_SIG_RSA_PSS_RSAE_SHA512 0x0806
419
420/* EdDSA algorithms */
421#define MBEDTLS_TLS13_SIG_ED25519 0x0807
422#define MBEDTLS_TLS13_SIG_ED448 0x0808
423
424/* RSASSA-PSS algorithms with public key OID RSASSA-PSS */
425#define MBEDTLS_TLS13_SIG_RSA_PSS_PSS_SHA256 0x0809
426#define MBEDTLS_TLS13_SIG_RSA_PSS_PSS_SHA384 0x080A
427#define MBEDTLS_TLS13_SIG_RSA_PSS_PSS_SHA512 0x080B
428
429/* LEGACY ALGORITHMS */
430#define MBEDTLS_TLS13_SIG_RSA_PKCS1_SHA1 0x0201
431#define MBEDTLS_TLS13_SIG_ECDSA_SHA1 0x0203
432
433#define MBEDTLS_TLS13_SIG_NONE 0x0
434
435/*
Paul Bakker926af752012-11-23 13:38:07 +0100436 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200437 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100438 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
440#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100441
442/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000443 * Message, alert and handshake types
444 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
446#define MBEDTLS_SSL_MSG_ALERT 21
447#define MBEDTLS_SSL_MSG_HANDSHAKE 22
448#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100449#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000450
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
452#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
455#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
456#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
457#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
458#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
459#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
460#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
461#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
462#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
463#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
464#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
465#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
466#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
467#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
468#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
469#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
470#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
471#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
472#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
473#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
474#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
475#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
476#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
477#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
478#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
479#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
480#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
481#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
482#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000483
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200484#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
485#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
486#define MBEDTLS_SSL_HS_SERVER_HELLO 2
487#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
488#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
489#define MBEDTLS_SSL_HS_CERTIFICATE 11
490#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
491#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
492#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
493#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
494#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
495#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000496
497/*
498 * TLS extensions
499 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200500#define MBEDTLS_TLS_EXT_SERVERNAME 0
501#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000502
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200503#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200504
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200505#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800506#define MBEDTLS_TLS_EXT_STATUS_REQUEST 5 /* RFC 6066 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200507
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200508#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800509#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 +0200510#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000511
Jerry Yub3317e12021-08-26 14:30:22 +0800512#define MBEDTLS_TLS_EXT_SIG_ALG 13 /* RFC 8446 TLS 1.3 */
Johan Pascalb62bb512015-12-03 21:56:45 +0100513#define MBEDTLS_TLS_EXT_USE_SRTP 14
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800514#define MBEDTLS_TLS_EXT_HEARTBEAT 15 /* RFC 6520 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200515#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200516
Jerry Yua2cf7bd2021-08-31 16:12:00 +0800517#define MBEDTLS_TLS_EXT_SCT 18 /* RFC 6962 TLS 1.2 and 1.3 */
Jerry Yu1bc2c1f2021-09-01 12:57:29 +0800518#define MBEDTLS_TLS_EXT_CLI_CERT_TYPE 19 /* RFC 7250 TLS 1.2 and 1.3 */
519#define MBEDTLS_TLS_EXT_SERV_CERT_TYPE 20 /* RFC 7250 TLS 1.2 and 1.3 */
520#define MBEDTLS_TLS_EXT_PADDING 21 /* RFC 7685 TLS 1.2 and 1.3 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200521#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
522#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200523
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200524#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200525
Jerry Yub3317e12021-08-26 14:30:22 +0800526#define MBEDTLS_TLS_EXT_PRE_SHARED_KEY 41 /* RFC 8446 TLS 1.3 */
527#define MBEDTLS_TLS_EXT_EARLY_DATA 42 /* RFC 8446 TLS 1.3 */
528#define MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS 43 /* RFC 8446 TLS 1.3 */
529#define MBEDTLS_TLS_EXT_COOKIE 44 /* RFC 8446 TLS 1.3 */
530#define MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES 45 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800531
Jerry Yub3317e12021-08-26 14:30:22 +0800532#define MBEDTLS_TLS_EXT_CERT_AUTH 47 /* RFC 8446 TLS 1.3 */
533#define MBEDTLS_TLS_EXT_OID_FILTERS 48 /* RFC 8446 TLS 1.3 */
534#define MBEDTLS_TLS_EXT_POST_HANDSHAKE_AUTH 49 /* RFC 8446 TLS 1.3 */
535#define MBEDTLS_TLS_EXT_SIG_ALG_CERT 50 /* RFC 8446 TLS 1.3 */
536#define MBEDTLS_TLS_EXT_KEY_SHARE 51 /* RFC 8446 TLS 1.3 */
Jerry Yu7984d992021-08-18 10:31:29 +0800537
Hanno Becker0652bc52019-04-25 16:24:57 +0100538/* The value of the CID extension is still TBD as of
Hanno Beckerebcc9132019-05-15 10:26:32 +0100539 * draft-ietf-tls-dtls-connection-id-05
Gilles Peskine7dd2f502021-04-24 13:35:41 +0200540 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05).
541 *
542 * A future minor revision of Mbed TLS may change the default value of
543 * this option to match evolving standards and usage.
544 */
545#if !defined(MBEDTLS_TLS_EXT_CID)
Hanno Becker064b7322019-05-03 12:42:13 +0100546#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Gilles Peskine7dd2f502021-04-24 13:35:41 +0200547#endif
Hanno Becker0652bc52019-04-25 16:24:57 +0100548
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200549#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
550
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200551#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000552
Johan Pascalb62bb512015-12-03 21:56:45 +0100553/*
Paul Bakkered27a042013-04-18 22:46:23 +0200554 * Size defines
555 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200556#if !defined(MBEDTLS_PSK_MAX_LEN)
557#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200558#endif
559
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200560/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200561union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200562{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200564 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
565#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200566#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
567 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200568#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200569#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
570 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
571 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
572 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
573 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200574#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
576 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200577#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
579 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
580 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200581#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200582#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
583 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200584#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200585#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
586 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
587 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200588#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200589#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
590 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
591#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200592};
593
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200594#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200595
Paul Bakker407a0da2013-06-27 14:29:21 +0200596#ifdef __cplusplus
597extern "C" {
598#endif
599
Paul Bakkered27a042013-04-18 22:46:23 +0200600/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000601 * SSL state machine
602 */
603typedef enum
604{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605 MBEDTLS_SSL_HELLO_REQUEST,
606 MBEDTLS_SSL_CLIENT_HELLO,
607 MBEDTLS_SSL_SERVER_HELLO,
608 MBEDTLS_SSL_SERVER_CERTIFICATE,
609 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
610 MBEDTLS_SSL_CERTIFICATE_REQUEST,
611 MBEDTLS_SSL_SERVER_HELLO_DONE,
612 MBEDTLS_SSL_CLIENT_CERTIFICATE,
613 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
614 MBEDTLS_SSL_CERTIFICATE_VERIFY,
615 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
616 MBEDTLS_SSL_CLIENT_FINISHED,
617 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
618 MBEDTLS_SSL_SERVER_FINISHED,
619 MBEDTLS_SSL_FLUSH_BUFFERS,
620 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
621 MBEDTLS_SSL_HANDSHAKE_OVER,
622 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
623 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Jerry Yua13c7e72021-08-17 10:44:40 +0800624#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
625 MBEDTLS_SSL_ENCRYPTED_EXTENSIONS,
626#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Paul Bakker5121ce52009-01-03 21:22:43 +0000627}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200628mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000629
Simon Butchere846b512016-03-01 17:31:49 +0000630/**
631 * \brief Callback type: send data on the network.
632 *
633 * \note That callback may be either blocking or non-blocking.
634 *
635 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000636 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000637 * \param len Length of the data to send
638 *
639 * \return The callback must return the number of bytes sent if any,
640 * or a non-zero error code.
641 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
642 * must be returned when the operation would block.
643 *
Simon Butcherd567a232016-03-09 20:19:21 +0000644 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000645 * It must always return the number of bytes actually sent.
646 */
647typedef int mbedtls_ssl_send_t( void *ctx,
648 const unsigned char *buf,
649 size_t len );
650
651/**
652 * \brief Callback type: receive data from the network.
653 *
654 * \note That callback may be either blocking or non-blocking.
655 *
656 * \param ctx Context for the receive callback (typically a file
657 * descriptor)
658 * \param buf Buffer to write the received data to
659 * \param len Length of the receive buffer
660 *
Hanno Becker218dec82021-07-23 07:23:47 +0100661 * \returns If data has been received, the positive number of bytes received.
662 * \returns \c 0 if the connection has been closed.
663 * \returns If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
Simon Butchere846b512016-03-01 17:31:49 +0000664 * must be returned when the operation would block.
Hanno Becker218dec82021-07-23 07:23:47 +0100665 * \returns Another negative error code on other kinds of failures.
Simon Butchere846b512016-03-01 17:31:49 +0000666 *
Simon Butcherd567a232016-03-09 20:19:21 +0000667 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000668 * buffer. It must always return the number of bytes actually
669 * received and written to the buffer.
670 */
671typedef int mbedtls_ssl_recv_t( void *ctx,
672 unsigned char *buf,
673 size_t len );
674
675/**
676 * \brief Callback type: receive data from the network, with timeout
677 *
678 * \note That callback must block until data is received, or the
679 * timeout delay expires, or the operation is interrupted by a
680 * signal.
681 *
682 * \param ctx Context for the receive callback (typically a file descriptor)
683 * \param buf Buffer to write the received data to
684 * \param len Length of the receive buffer
Andrey Starodubtsev90cc33a2021-08-23 12:14:56 +0300685 * \param timeout Maximum number of milliseconds to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000686 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000687 *
688 * \return The callback must return the number of bytes received,
689 * or a non-zero error code:
690 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
691 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
692 *
Simon Butcherd567a232016-03-09 20:19:21 +0000693 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000694 * buffer. It must always return the number of bytes actually
695 * received and written to the buffer.
696 */
697typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
698 unsigned char *buf,
699 size_t len,
700 uint32_t timeout );
701/**
702 * \brief Callback type: set a pair of timers/delays to watch
703 *
704 * \param ctx Context pointer
705 * \param int_ms Intermediate delay in milliseconds
706 * \param fin_ms Final delay in milliseconds
707 * 0 cancels the current timer.
708 *
709 * \note This callback must at least store the necessary information
710 * for the associated \c mbedtls_ssl_get_timer_t callback to
711 * return correct information.
712 *
713 * \note If using a event-driven style of programming, an event must
714 * be generated when the final delay is passed. The event must
715 * cause a call to \c mbedtls_ssl_handshake() with the proper
716 * SSL context to be scheduled. Care must be taken to ensure
717 * that at most one such call happens at a time.
718 *
719 * \note Only one timer at a time must be running. Calling this
720 * function while a timer is running must cancel it. Cancelled
721 * timers must not generate any event.
722 */
723typedef void mbedtls_ssl_set_timer_t( void * ctx,
724 uint32_t int_ms,
725 uint32_t fin_ms );
726
727/**
728 * \brief Callback type: get status of timers/delays
729 *
730 * \param ctx Context pointer
731 *
732 * \return This callback must return:
733 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000734 * 0 if none of the delays have passed,
735 * 1 if only the intermediate delay has passed,
736 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000737 */
738typedef int mbedtls_ssl_get_timer_t( void * ctx );
739
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200740/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200741typedef struct mbedtls_ssl_session mbedtls_ssl_session;
742typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200743typedef struct mbedtls_ssl_config mbedtls_ssl_config;
744
Chris Jones3848e312021-03-11 16:17:59 +0000745/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200746typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
747typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100748typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200749#if defined(MBEDTLS_X509_CRT_PARSE_C)
750typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200751#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200752#if defined(MBEDTLS_SSL_PROTO_DTLS)
753typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200754#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000755
Hanno Becker02487852021-05-13 06:26:57 +0100756/**
757 * \brief Callback type: server-side session cache getter
758 *
759 * The session cache is logically a key value store, with
760 * keys being session IDs and values being instances of
761 * mbedtls_ssl_session.
762 *
763 * This callback retrieves an entry in this key-value store.
764 *
765 * \param data The address of the session cache structure to query.
766 * \param session_id The buffer holding the session ID to query.
767 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100768 * \param session The address of the session structure to populate.
769 * It is initialized with mbdtls_ssl_session_init(),
770 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100771 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100772 * mbedtls_ssl_session_free() independent of the
773 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100774 *
775 * \return \c 0 on success
776 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100777 *
Hanno Becker02487852021-05-13 06:26:57 +0100778 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100779typedef int mbedtls_ssl_cache_get_t( void *data,
780 unsigned char const *session_id,
781 size_t session_id_len,
782 mbedtls_ssl_session *session );
Hanno Becker02487852021-05-13 06:26:57 +0100783/**
784 * \brief Callback type: server-side session cache setter
785 *
786 * The session cache is logically a key value store, with
787 * keys being session IDs and values being instances of
788 * mbedtls_ssl_session.
789 *
790 * This callback sets an entry in this key-value store.
791 *
792 * \param data The address of the session cache structure to modify.
793 * \param session_id The buffer holding the session ID to query.
794 * \param session_id_len The length of \p session_id in Bytes.
795 * \param session The address of the session to be stored in the
796 * session cache.
797 *
798 * \return \c 0 on success
799 * \return A non-zero return value on failure.
800 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100801typedef int mbedtls_ssl_cache_set_t( void *data,
802 unsigned char const *session_id,
803 size_t session_id_len,
804 const mbedtls_ssl_session *session );
Hanno Beckera637ff62021-04-15 08:42:48 +0100805
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200806#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100807#if defined(MBEDTLS_X509_CRT_PARSE_C)
808/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200809 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100810 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200811 * This callback is called during an SSL handshake to start
812 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200813 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100814 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200815 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100816 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200817 * This function typically sends or enqueues a request, and
818 * does not wait for the operation to complete. This allows
819 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100820 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200821 * The parameters \p ssl and \p cert are guaranteed to remain
822 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200823 * function must save the contents of \p hash if the value
824 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200825 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100826 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200827 * This function may call mbedtls_ssl_set_async_operation_data()
828 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200829 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200830 *
Gilles Peskined3268832018-04-26 06:23:59 +0200831 * \note For RSA signatures, this function must produce output
832 * that is consistent with PKCS#1 v1.5 in the same way as
833 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
834 * apply the padding steps described in RFC 8017, section 9.2
835 * "EMSA-PKCS1-v1_5" as follows.
836 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
837 * encoding, treating \p hash as the DigestInfo to be
838 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
839 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200840 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200841 * encoding, treating \p hash as the hash to be encoded and
842 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
843 * from step 2, with `digestAlgorithm` obtained by calling
844 * mbedtls_oid_get_oid_by_md() on \p md_alg.
845 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200846 * \note For ECDSA signatures, the output format is the DER encoding
847 * `Ecdsa-Sig-Value` defined in
848 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
849 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200850 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200851 * modified other than via
852 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200853 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200854 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200855 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200856 * connection. However, if other callbacks are used, this
857 * property may not hold. For example, if an SNI callback
858 * is registered with mbedtls_ssl_conf_sni(), then
859 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200860 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100861 * \param hash Buffer containing the hash. This buffer is
862 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200863 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100864 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200865 * \return 0 if the operation was started successfully and the SSL
866 * stack should call the resume callback immediately.
867 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
868 * was started successfully and the SSL stack should return
869 * immediately without calling the resume callback yet.
870 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
871 * processor does not support this key. The SSL stack will
872 * use the private key object instead.
873 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200874 * propagated up the call chain. The callback should
875 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
876 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200877 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100878 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200879typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100880 mbedtls_x509_crt *cert,
881 mbedtls_md_type_t md_alg,
882 const unsigned char *hash,
883 size_t hash_len );
884
885/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200886 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100887 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200888 * This callback is called during an SSL handshake to start
889 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200890 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100891 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200892 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100893 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200894 * This function typically sends or enqueues a request, and
895 * does not wait for the operation to complete. This allows
896 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100897 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200898 * The parameters \p ssl and \p cert are guaranteed to remain
899 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200900 * function must save the contents of \p input if the value
901 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200902 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100903 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200904 * This function may call mbedtls_ssl_set_async_operation_data()
905 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200906 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200907 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200908 * \warning RSA decryption as used in TLS is subject to a potential
909 * timing side channel attack first discovered by Bleichenbacher
910 * in 1998. This attack can be remotely exploitable
911 * in practice. To avoid this attack, you must ensure that
912 * if the callback performs an RSA decryption, the time it
913 * takes to execute and return the result does not depend
914 * on whether the RSA decryption succeeded or reported
915 * invalid padding.
916 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200917 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200918 * modified other than via
919 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200920 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200921 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200922 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200923 * connection. However, if other callbacks are used, this
924 * property may not hold. For example, if an SNI callback
925 * is registered with mbedtls_ssl_conf_sni(), then
926 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100927 * \param input Buffer containing the input ciphertext. This buffer
928 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200929 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100930 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200931 * \return 0 if the operation was started successfully and the SSL
932 * stack should call the resume callback immediately.
933 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
934 * was started successfully and the SSL stack should return
935 * immediately without calling the resume callback yet.
936 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
937 * processor does not support this key. The SSL stack will
938 * use the private key object instead.
939 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200940 * propagated up the call chain. The callback should
941 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
942 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200943 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100944 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200945typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100946 mbedtls_x509_crt *cert,
947 const unsigned char *input,
948 size_t input_len );
949#endif /* MBEDTLS_X509_CRT_PARSE_C */
950
951/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200952 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100953 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200954 * This callback is called during an SSL handshake to resume
955 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200956 * ::mbedtls_ssl_async_sign_t or
957 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200958 *
959 * This function typically checks the status of a pending
960 * request or causes the request queue to make progress, and
961 * does not wait for the operation to complete. This allows
962 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100963 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200964 * This function may call mbedtls_ssl_get_async_operation_data()
965 * to retrieve an operation context set by the start callback.
966 * It may call mbedtls_ssl_set_async_operation_data() to modify
967 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200968 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200969 * Note that when this function returns a status other than
970 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
971 * resources associated with the operation.
972 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200973 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200974 * modified other than via
975 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200976 * \param output Buffer containing the output (signature or decrypted
977 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200978 * \param output_len On success, number of bytes written to \p output.
979 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100980 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200981 * \return 0 if output of the operation is available in the
982 * \p output buffer.
983 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
984 * is still in progress. Subsequent requests for progress
985 * on the SSL connection will call the resume callback
986 * again.
987 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200988 * The SSL handshake is aborted. The callback should
989 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
990 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200991 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100992 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200993typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100994 unsigned char *output,
995 size_t *output_len,
996 size_t output_size );
997
998/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200999 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001000 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001001 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +02001002 * while an asynchronous operation is in progress. Note that
1003 * this callback is not called if the
1004 * ::mbedtls_ssl_async_resume_t callback has run and has
1005 * returned a value other than
1006 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
1007 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001008 *
Gilles Peskine1febfef2018-04-30 11:54:39 +02001009 * This function may call mbedtls_ssl_get_async_operation_data()
1010 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001011 *
Gilles Peskinead28bf02018-04-26 00:19:16 +02001012 * \param ssl The SSL connection instance. It should not be
1013 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001014 */
Gilles Peskine8f97af72018-04-26 11:46:10 +02001015typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001016#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +00001017
Gilles Peskineeccd8882020-03-10 12:19:08 +01001018#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001019 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +00001020#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
1021#if defined(MBEDTLS_SHA256_C)
1022#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
1023#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +02001024#elif defined(MBEDTLS_SHA384_C)
Hanno Becker9198ad12019-02-05 17:00:50 +00001025#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
1026#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
1027#elif defined(MBEDTLS_SHA1_C)
1028#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
1029#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
1030#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001031/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +00001032#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
1033#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +01001034#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +00001035 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001036
Johan Pascalb62bb512015-12-03 21:56:45 +01001037#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +02001038
Johan Pascal85269572020-08-25 10:01:54 +02001039#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +02001040#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +01001041/*
Johan Pascal43f94902020-09-22 12:25:52 +02001042 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001043 *
1044 * Use_srtp extension protection profiles values as defined in
1045 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
1046 *
1047 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
1048 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +01001049 */
Johan Pascal76fdf1d2020-10-22 23:31:00 +02001050#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ( (uint16_t) 0x0001)
1051#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ( (uint16_t) 0x0002)
1052#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ( (uint16_t) 0x0005)
1053#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ( (uint16_t) 0x0006)
1054/* This one is not iana defined, but for code readability. */
1055#define MBEDTLS_TLS_SRTP_UNSET ( (uint16_t) 0x0000)
1056
Johan Pascal43f94902020-09-22 12:25:52 +02001057typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +03001058
Ron Eldor3adb9922017-12-21 10:15:08 +02001059typedef struct mbedtls_dtls_srtp_info_t
1060{
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001061 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001062 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +02001063 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001064 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001065 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001066 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +03001067}
1068mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +02001069
Johan Pascalb62bb512015-12-03 21:56:45 +01001070#endif /* MBEDTLS_SSL_DTLS_SRTP */
1071
Paul Bakker5121ce52009-01-03 21:22:43 +00001072/*
Paul Bakker0a597072012-09-25 21:55:46 +00001073 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001074 *
1075 * Note: when changing this definition, we need to check and update:
1076 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02001077 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +02001078 * - in library/ssl_tls.c:
1079 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
1080 * mbedtls_ssl_session_save() and ssl_session_load()
1081 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +00001082 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001083struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +00001084{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001085#if defined(MBEDTLS_HAVE_TIME)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001086 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +02001087#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001088 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
1089 int MBEDTLS_PRIVATE(compression); /*!< chosen compression */
1090 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
1091 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
1092 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +02001093
Hanno Becker95832d82021-07-22 09:44:53 +01001094 unsigned char MBEDTLS_PRIVATE(exported);
Hanno Beckere810bbc2021-05-14 16:01:05 +01001095
Hanno Becker57723132021-08-01 19:40:44 +01001096 /* This field is temporarily duplicated with mbedtls_ssl_context.minor_ver.
1097 * Once runtime negotiation of TLS 1.2 and TLS 1.3 is implemented, it needs
1098 * to be studied whether one of them can be removed. */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +01001099 unsigned char MBEDTLS_PRIVATE(minor_ver); /*!< The TLS version used in the session. */
1100
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001101#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +00001102#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001103 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +00001104#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +00001105 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
1106 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +02001107 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
1108 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
1109 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +00001110#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001111#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001112 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +02001113
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001114#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001115 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
1116 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
1117 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001118#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +02001119
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001121 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001122#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +02001123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001125 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001126#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001127};
1128
Hanno Becker457d6162021-05-24 10:27:39 +01001129/*
1130 * Identifiers for PRFs used in various versions of TLS.
1131 */
1132typedef enum
1133{
1134 MBEDTLS_SSL_TLS_PRF_NONE,
Hanno Becker457d6162021-05-24 10:27:39 +01001135 MBEDTLS_SSL_TLS_PRF_SHA384,
1136 MBEDTLS_SSL_TLS_PRF_SHA256,
1137 MBEDTLS_SSL_HKDF_EXPAND_SHA384,
1138 MBEDTLS_SSL_HKDF_EXPAND_SHA256
1139}
1140mbedtls_tls_prf_types;
1141
Hanno Becker457d6162021-05-24 10:27:39 +01001142typedef enum
1143{
1144 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0,
1145#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1146 MBEDTLS_SSL_KEY_EXPORT_TLS13_CLIENT_EARLY_SECRET,
1147 MBEDTLS_SSL_KEY_EXPORT_TLS13_EARLY_EXPORTER_SECRET,
1148 MBEDTLS_SSL_KEY_EXPORT_TLS13_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
1149 MBEDTLS_SSL_KEY_EXPORT_TLS13_SERVER_HANDSHAKE_TRAFFIC_SECRET,
1150 MBEDTLS_SSL_KEY_EXPORT_TLS13_CLIENT_APPLICATION_TRAFFIC_SECRET,
1151 MBEDTLS_SSL_KEY_EXPORT_TLS13_SERVER_APPLICATION_TRAFFIC_SECRET,
1152#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1153} mbedtls_ssl_key_export_type;
1154
1155/**
1156 * \brief Callback type: Export key alongside random values for
1157 * session identification, and PRF for
1158 * implementation of TLS key exporters.
1159 *
Hanno Beckerddc739c2021-05-28 05:10:38 +01001160 * \param p_expkey Context for the callback.
1161 * \param type The type of the key that is being exported.
1162 * \param secret The address of the buffer holding the secret
1163 * that's being exporterd.
1164 * \param secret_len The length of \p secret in bytes.
Hanno Becker457d6162021-05-24 10:27:39 +01001165 * \param client_random The client random bytes.
1166 * \param server_random The server random bytes.
1167 * \param tls_prf_type The identifier for the PRF used in the handshake
1168 * to which the key belongs.
Hanno Becker457d6162021-05-24 10:27:39 +01001169 */
Hanno Beckere0dad722021-06-11 15:38:37 +01001170typedef void mbedtls_ssl_export_keys_t( void *p_expkey,
1171 mbedtls_ssl_key_export_type type,
1172 const unsigned char *secret,
1173 size_t secret_len,
1174 const unsigned char client_random[32],
1175 const unsigned char server_random[32],
1176 mbedtls_tls_prf_types tls_prf_type );
Hanno Becker457d6162021-05-24 10:27:39 +01001177
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001178/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001179 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001180 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001181struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001182{
1183 /* Group items by size (largest first) to minimize padding overhead */
1184
1185 /*
1186 * Pointers
1187 */
1188
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001189 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +02001190 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001191
Hanno Becker71f1ed62021-07-24 06:01:47 +01001192#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
1193 /** Allowed TLS 1.3 key exchange modes. */
1194 int MBEDTLS_PRIVATE(tls13_kex_modes);
1195#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1196
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001197 /** Callback for printing debug output */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001198 void (*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
1199 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001200
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001201 /** Callback for getting (pseudo-)random numbers */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001202 int (*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
1203 void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001204
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001205 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001206 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001207 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001208 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
1209 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001210
1211#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1212 /** Callback for setting cert according to SNI extension */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001213 int (*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1214 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001215#endif
1216
1217#if defined(MBEDTLS_X509_CRT_PARSE_C)
1218 /** Callback to customize X.509 certificate chain verification */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001219 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1220 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001221#endif
1222
Gilles Peskineeccd8882020-03-10 12:19:08 +01001223#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001224 /** Callback to retrieve PSK key from identity */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001225 int (*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1226 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001227#endif
1228
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001229#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001230 /** Callback to create & write a cookie for ClientHello veirifcation */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001231 int (*MBEDTLS_PRIVATE(f_cookie_write))( void *, unsigned char **, unsigned char *,
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001232 const unsigned char *, size_t );
1233 /** Callback to verify validity of a ClientHello cookie */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001234 int (*MBEDTLS_PRIVATE(f_cookie_check))( void *, const unsigned char *, size_t,
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001235 const unsigned char *, size_t );
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001236 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001237#endif
1238
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001239#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001240 /** Callback to create & write a session ticket */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001241 int (*MBEDTLS_PRIVATE(f_ticket_write))( void *, const mbedtls_ssl_session *,
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001242 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1243 /** Callback to parse a session ticket into a session structure */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001244 int (*MBEDTLS_PRIVATE(f_ticket_parse))( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1245 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001246#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001247
Hanno Beckera0e20d02019-05-15 14:03:01 +01001248#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001249 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001250#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001251
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001252#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001253 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1254 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1255 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1256 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001257#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001258 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1259 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001260#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001261#endif /* MBEDTLS_X509_CRT_PARSE_C */
1262
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001263#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001264#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001265 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
1266 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start); /*!< start asynchronous decryption operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001267#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001268 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1269 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1270 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001271#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001272
Gilles Peskineeccd8882020-03-10 12:19:08 +01001273#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001274 const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001275
1276#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Jerry Yu7899de82021-08-17 13:09:23 +08001277 const uint16_t *MBEDTLS_PRIVATE(tls13_sig_algs); /*!< allowed signature algorithms for TLS 1.3 */
Hanno Becker1cd6e002021-08-10 13:27:10 +01001278#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001279#endif
1280
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001281#if defined(MBEDTLS_ECP_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001282 const mbedtls_ecp_group_id *MBEDTLS_PRIVATE(curve_list); /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001283#endif
1284
1285#if defined(MBEDTLS_DHM_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001286 mbedtls_mpi MBEDTLS_PRIVATE(dhm_P); /*!< prime modulus for DHM */
1287 mbedtls_mpi MBEDTLS_PRIVATE(dhm_G); /*!< generator for DHM */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001288#endif
1289
Gilles Peskineeccd8882020-03-10 12:19:08 +01001290#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001291
1292#if defined(MBEDTLS_USE_PSA_CRYPTO)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001293 psa_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Ronald Croncf56a0a2020-08-04 09:51:30 +02001294 * should only be set via
1295 * mbedtls_ssl_conf_psk_opaque().
1296 * If either no PSK or a raw PSK have been
1297 * configured, this has value \c 0.
1298 */
Hanno Becker43633132018-10-22 15:31:03 +01001299#endif /* MBEDTLS_USE_PSA_CRYPTO */
1300
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001301 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Hanno Becker43633132018-10-22 15:31:03 +01001302 * only be set via mbedtls_ssl_conf_psk().
1303 * If either no PSK or an opaque PSK
1304 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001305 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Hanno Becker43633132018-10-22 15:31:03 +01001306 * This field should only be set via
1307 * mbedtls_ssl_conf_psk().
1308 * Its value is non-zero if and only if
1309 * \c psk is not \c NULL. */
1310
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001311 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Hanno Becker43633132018-10-22 15:31:03 +01001312 * This field should only be set via
1313 * mbedtls_ssl_conf_psk().
1314 * This is set if and only if either
1315 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001316 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Hanno Becker43633132018-10-22 15:31:03 +01001317 * This field should only be set via
1318 * mbedtls_ssl_conf_psk().
1319 * Its value is non-zero if and only if
1320 * \c psk is not \c NULL or \c psk_opaque
1321 * is not \c 0. */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001322#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001323
1324#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001325 const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001326#endif
1327
Johan Pascalbbc057a2016-02-04 22:07:32 +01001328#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001329 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001330 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001331 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001332 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001333#endif /* MBEDTLS_SSL_DTLS_SRTP */
1334
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001335 /*
1336 * Numerical settings (int then char)
1337 */
1338
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001339 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001340
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001341#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001342 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001343 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001344 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001345 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001346#endif
1347
1348#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001349 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1350 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001351 that triggers renegotiation */
1352#endif
1353
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001354 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001355
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001356#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001357 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen); /*!< min. bit length of the DHM prime */
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001358#endif
1359
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001360 unsigned char MBEDTLS_PRIVATE(max_major_ver); /*!< max. major version used */
1361 unsigned char MBEDTLS_PRIVATE(max_minor_ver); /*!< max. minor version used */
1362 unsigned char MBEDTLS_PRIVATE(min_major_ver); /*!< min. major version used */
1363 unsigned char MBEDTLS_PRIVATE(min_minor_ver); /*!< min. minor version used */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001364
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001365 /*
1366 * Flags (bitfields)
1367 */
1368
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001369 unsigned int MBEDTLS_PRIVATE(endpoint) : 1; /*!< 0: client, 1: server */
1370 unsigned int MBEDTLS_PRIVATE(transport) : 1; /*!< stream (TLS) or datagram (DTLS) */
1371 unsigned int MBEDTLS_PRIVATE(authmode) : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001372 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001373 unsigned int MBEDTLS_PRIVATE(allow_legacy_renegotiation) : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001374#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001375 unsigned int MBEDTLS_PRIVATE(mfl_code) : 3; /*!< desired fragment length */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001376#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001377#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001378 unsigned int MBEDTLS_PRIVATE(encrypt_then_mac) : 1 ; /*!< negotiate encrypt-then-mac? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001379#endif
1380#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001381 unsigned int MBEDTLS_PRIVATE(extended_ms) : 1; /*!< negotiate extended master secret? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001382#endif
1383#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001384 unsigned int MBEDTLS_PRIVATE(anti_replay) : 1; /*!< detect and prevent replay? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001385#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001386#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001387 unsigned int MBEDTLS_PRIVATE(disable_renegotiation) : 1; /*!< disable renegotiation? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001388#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001389#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001390 unsigned int MBEDTLS_PRIVATE(session_tickets) : 1; /*!< use session tickets? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001391#endif
Janos Follath088ce432017-04-10 12:42:31 +01001392#if defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001393 unsigned int MBEDTLS_PRIVATE(cert_req_ca_list) : 1; /*!< enable sending CA list in
Janos Follath088ce432017-04-10 12:42:31 +01001394 Certificate Request messages? */
Hanno Becker03799422021-07-22 11:33:12 +01001395 unsigned int MBEDTLS_PRIVATE(respect_cli_pref) : 1; /*!< pick the ciphersuite according to
TRodziewicz8476f2f2021-06-02 14:34:47 +02001396 the client's preferences rather
1397 than ours */
Janos Follath088ce432017-04-10 12:42:31 +01001398#endif
Hanno Beckera0e20d02019-05-15 14:03:01 +01001399#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001400 unsigned int MBEDTLS_PRIVATE(ignore_unexpected_cid) : 1; /*!< Determines whether DTLS
Hanno Becker8367ccc2019-05-14 11:30:10 +01001401 * record with unexpected CID
1402 * should lead to failure. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001403#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Ron Eldor3adb9922017-12-21 10:15:08 +02001404#if defined(MBEDTLS_SSL_DTLS_SRTP)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001405 unsigned int MBEDTLS_PRIVATE(dtls_srtp_mki_support) : 1; /* support having mki_value
Ron Eldor591f1622018-01-22 12:30:04 +02001406 in the use_srtp extension */
Ron Eldor3adb9922017-12-21 10:15:08 +02001407#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001408};
1409
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001411{
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001412 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001413
Paul Bakker5121ce52009-01-03 21:22:43 +00001414 /*
1415 * Miscellaneous
1416 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001417 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001418#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001419 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1420 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001421 number of retransmissions of request if
1422 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001423#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001424
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001425 int MBEDTLS_PRIVATE(major_ver); /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Hanno Becker57723132021-08-01 19:40:44 +01001426
1427 /* This field is temporarily duplicated with mbedtls_ssl_context.minor_ver.
1428 * Once runtime negotiation of TLS 1.2 and TLS 1.3 is implemented, it needs
1429 * to be studied whether one of them can be removed. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001430 int MBEDTLS_PRIVATE(minor_ver); /*!< one of MBEDTLS_SSL_MINOR_VERSION_x macros */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001431 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001432
Hanno Becker8927c832019-04-03 12:52:50 +01001433#if defined(MBEDTLS_X509_CRT_PARSE_C)
1434 /** Callback to customize X.509 certificate chain verification */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001435 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1436 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001437#endif
1438
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001439 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1440 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1441 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Simon Butchere846b512016-03-01 17:31:49 +00001442 /*!< Callback for network receive with timeout */
1443
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001444 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001445
Paul Bakker5121ce52009-01-03 21:22:43 +00001446 /*
1447 * Session layer
1448 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001449 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1450 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1451 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1452 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001453
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001454 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001455 the handshake process */
1456
1457 /*
1458 * Record layer transformations
1459 */
Hanno Becker0e719ff2021-08-10 09:24:08 +01001460 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in)
1461 * This is always a reference,
1462 * never an owning pointer. */
1463 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (out)
1464 * This is always a reference,
1465 * never an owning pointer. */
1466 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params
1467 * This pointer owns the transform
1468 * it references. */
1469 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation
1470 * This pointer owns the transform
1471 * it references. */
Paul Bakker48916f92012-09-16 19:57:18 +00001472
Hanno Becker3aa186f2021-08-10 09:24:19 +01001473#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
Hanno Beckere043d152021-08-12 06:22:32 +01001474 /*! The application data transform in TLS 1.3.
1475 * This pointer owns the transform it references. */
Hanno Becker3aa186f2021-08-10 09:24:19 +01001476 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_application);
1477#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
1478
Paul Bakker5121ce52009-01-03 21:22:43 +00001479 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001480 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001481 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001482 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001483
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001484 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1485 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001486
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001487 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001488 * Record layer (incoming data)
1489 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001490 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1491 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001492 TLS: maintained by us
1493 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001494 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001495#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001496 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001497 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001498#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001499 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1500 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1501 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1502 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001503
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001504 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1505 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1506 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001507#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001508 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001509#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001511 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1512 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001513 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001514#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001516 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1517 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001518#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001519
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001520 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001521 including the handshake header */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001522 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001523
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001524 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001525 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001526
Hanno Becker04da1892018-08-14 13:22:10 +01001527#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001528 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Hanno Becker04da1892018-08-14 13:22:10 +01001529 * within a single datagram. */
1530#endif /* MBEDTLS_SSL_PROTO_DTLS */
1531
Paul Bakker5121ce52009-01-03 21:22:43 +00001532 /*
1533 * Record layer (outgoing data)
1534 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001535 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1536 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1537 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001538#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001539 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001540 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001541#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001542 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1543 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1544 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001545
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001546 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1547 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1548 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001549#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001550 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001551#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001552
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001553 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[8]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001554
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001555#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001556 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001557#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001558
Paul Bakker5121ce52009-01-03 21:22:43 +00001559 /*
1560 * PKI layer
1561 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001562 int MBEDTLS_PRIVATE(client_auth); /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001563
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001564 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001565 * User settings
1566 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001567#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001568 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001569 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001570#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001573 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001574#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001575
Johan Pascalb62bb512015-12-03 21:56:45 +01001576#if defined(MBEDTLS_SSL_DTLS_SRTP)
1577 /*
1578 * use_srtp extension
1579 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001580 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001581#endif /* MBEDTLS_SSL_DTLS_SRTP */
1582
Paul Bakker48916f92012-09-16 19:57:18 +00001583 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001584 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001585 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001586#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001587 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1588 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001589#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001590
1591 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001592 * Secure renegotiation
1593 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001594 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001595 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Paul Bakker48916f92012-09-16 19:57:18 +00001596 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001597#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001598 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1599 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1600 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001601#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001602
Hanno Beckera0e20d02019-05-15 14:03:01 +01001603#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001604 /* CID configuration to use in subsequent handshakes. */
1605
1606 /*! The next incoming CID, chosen by the user and applying to
1607 * all subsequent handshakes. This may be different from the
1608 * CID currently used in case the user has re-configured the CID
1609 * after an initial handshake. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001610 unsigned char MBEDTLS_PRIVATE(own_cid)[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1611 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1612 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Hanno Becker2f28c102019-04-25 15:46:59 +01001613 * be negotiated in the next handshake or not.
1614 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1615 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001616#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001617
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001618 /** Callback to export key block and master secret */
1619 mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys);
1620 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
Paul Bakker5121ce52009-01-03 21:22:43 +00001621};
1622
Paul Bakker5121ce52009-01-03 21:22:43 +00001623/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001624 * \brief Return the name of the ciphersuite associated with the
1625 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001626 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001627 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001628 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001629 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001630 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001631const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001632
1633/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001634 * \brief Return the ID of the ciphersuite associated with the
1635 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001636 *
1637 * \param ciphersuite_name SSL ciphersuite name
1638 *
1639 * \return the ID with the ciphersuite or 0 if not found
1640 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001642
1643/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001644 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001645 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001646 * mbedtls_ssl_free()
1647 *
1648 * \param ssl SSL context
1649 */
1650void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1651
1652/**
1653 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001654 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001655 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001656 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001657 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001658 * \warning The conf structure will be accessed during the session.
1659 * It must not be modified or freed as long as the session
1660 * is active.
1661 *
1662 * \warning This function must be called exactly once per context.
1663 * Calling mbedtls_ssl_setup again is not supported, even
1664 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001665 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001666 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001667 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001668 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001669 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001670 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001671 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001672int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001673 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001674
1675/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001676 * \brief Reset an already initialized SSL context for re-use
1677 * while retaining application-set variables, function
1678 * pointers and data.
1679 *
1680 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001681 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
1682 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001683 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001685
1686/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001687 * \brief Set the current endpoint type
1688 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001689 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001690 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001691 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001692void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001693
1694/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001695 * \brief Set the transport type (TLS or DTLS).
1696 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001697 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001698 * \note For DTLS, you must either provide a recv callback that
1699 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001700 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1701 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001702 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001703 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001704 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001705 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1706 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001707 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001708void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001709
1710/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001711 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001712 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001713 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001714 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001715 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001716 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001717 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001718 * (default on server)
1719 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001720 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001721 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001722 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001723 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001724 * handshake is complete.
1725 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001726 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001727 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001728 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001729 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001730 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1731 * 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 +01001732 * the right time(s), which may not be obvious, while REQUIRED always perform
1733 * the verification as soon as possible. For example, REQUIRED was protecting
1734 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001735 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001736void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001738#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001739/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001740 * \brief Set the verification callback (Optional).
1741 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001742 * If set, the provided verify callback is called for each
1743 * certificate in the peer's CRT chain, including the trusted
1744 * root. For more information, please see the documentation of
1745 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001746 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001747 * \note For per context callbacks and contexts, please use
1748 * mbedtls_ssl_set_verify() instead.
1749 *
1750 * \param conf The SSL configuration to use.
1751 * \param f_vrfy The verification callback to use during CRT verification.
1752 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001753 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001754void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001755 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001756 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001757#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001758
1759/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001760 * \brief Set the random number generator callback
1761 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001762 * \param conf SSL configuration
Manuel Pégourié-Gonnardad5390f2021-06-15 11:29:26 +02001763 * \param f_rng RNG function (mandatory)
Paul Bakker5121ce52009-01-03 21:22:43 +00001764 * \param p_rng RNG parameter
1765 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001766void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001767 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001768 void *p_rng );
1769
1770/**
1771 * \brief Set the debug callback
1772 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001773 * The callback has the following argument:
1774 * void * opaque context for the callback
1775 * int debug level
1776 * const char * file name
1777 * int line number
1778 * const char * message
1779 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001780 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001781 * \param f_dbg debug function
1782 * \param p_dbg debug parameter
1783 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001784void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001785 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001786 void *p_dbg );
1787
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001788/**
1789 * \brief Set the underlying BIO callbacks for write, read and
1790 * read-with-timeout.
1791 *
1792 * \param ssl SSL context
1793 * \param p_bio parameter (context) shared by BIO callbacks
1794 * \param f_send write callback
1795 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001796 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001797 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001798 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1799 * the other is used. If both are non-NULL, f_recv_timeout is
1800 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001801 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001802 * \note The two most common use cases are:
1803 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1804 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1805 *
1806 * \note For DTLS, you need to provide either a non-NULL
1807 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001808 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07001809 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001810 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001811 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001812 *
Andres AG3616f6f2016-09-14 14:32:09 +01001813 * \note On some platforms, net_sockets.c provides
1814 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1815 * \c mbedtls_net_recv_timeout() that are suitable to be used
1816 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001817 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001818void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001819 void *p_bio,
1820 mbedtls_ssl_send_t *f_send,
1821 mbedtls_ssl_recv_t *f_recv,
1822 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001823
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001824#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001825
Hanno Beckera0e20d02019-05-15 14:03:01 +01001826#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01001827
1828
1829/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001830 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001831 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001832 *
Hanno Beckerebcc9132019-05-15 10:26:32 +01001833 * Reference: draft-ietf-tls-dtls-connection-id-05
1834 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker019f4b52019-04-09 15:12:56 +01001835 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01001836 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01001837 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01001838 * underlying transport (changed IP and Port metadata) by
1839 * adding explicit connection identifiers (CIDs) to the
1840 * headers of encrypted DTLS records. The desired CIDs are
1841 * configured by the application layer and are exchanged in
1842 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01001843 * handshake, where each side indicates the CID it wants the
1844 * peer to use when writing encrypted messages. The CIDs are
1845 * put to use once records get encrypted: the stack discards
1846 * any incoming records that don't include the configured CID
1847 * in their header, and adds the peer's requested CID to the
1848 * headers of outgoing messages.
1849 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01001850 * This API enables or disables the use of the CID extension
1851 * in the next handshake and sets the value of the CID to
1852 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01001853 *
1854 * \param ssl The SSL context to configure. This must be initialized.
1855 * \param enable This value determines whether the CID extension should
1856 * be used or not. Possible values are:
1857 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001858 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1859 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001860 * \param own_cid The address of the readable buffer holding the CID we want
1861 * the peer to use when sending encrypted messages to us.
1862 * This may be \c NULL if \p own_cid_len is \c 0.
1863 * This parameter is unused if \p enabled is set to
1864 * MBEDTLS_SSL_CID_DISABLED.
1865 * \param own_cid_len The length of \p own_cid.
1866 * This parameter is unused if \p enabled is set to
1867 * MBEDTLS_SSL_CID_DISABLED.
1868 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001869 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01001870 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01001871 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001872 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001873 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001874 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001875 * performed on the SSL context \p ssl, but does not trigger
1876 * one. You still have to call `mbedtls_ssl_handshake()`
1877 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1878 * (for a renegotiation handshake) explicitly after a
1879 * successful call to this function to run the handshake.
1880 *
1881 * \note This call cannot guarantee that the use of the CID
1882 * will be successfully negotiated in the next handshake,
1883 * because the peer might not support it. Specifically:
1884 * - On the Client, enabling the use of the CID through
1885 * this call implies that the `ClientHello` in the next
1886 * handshake will include the CID extension, thereby
1887 * offering the use of the CID to the server. Only if
1888 * the `ServerHello` contains the CID extension, too,
1889 * the CID extension will actually be put to use.
1890 * - On the Server, enabling the use of the CID through
1891 * this call implies that that the server will look for
1892 * the CID extension in a `ClientHello` from the client,
1893 * and, if present, reply with a CID extension in its
1894 * `ServerHello`.
1895 *
1896 * \note To check whether the use of the CID was negotiated
1897 * after the subsequent handshake has completed, please
1898 * use the API mbedtls_ssl_get_peer_cid().
1899 *
1900 * \warning If the use of the CID extension is enabled in this call
1901 * and the subsequent handshake negotiates its use, Mbed TLS
1902 * will silently drop every packet whose CID does not match
1903 * the CID configured in \p own_cid. It is the responsibility
1904 * of the user to adapt the underlying transport to take care
1905 * of CID-based demultiplexing before handing datagrams to
1906 * Mbed TLS.
1907 *
1908 * \return \c 0 on success. In this case, the CID configuration
1909 * applies to the next handshake.
1910 * \return A negative error code on failure.
1911 */
1912int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1913 int enable,
1914 unsigned char const *own_cid,
1915 size_t own_cid_len );
1916
1917/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01001918 * \brief Get information about the use of the CID extension
1919 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01001920 *
1921 * \param ssl The SSL context to query.
1922 * \param enabled The address at which to store whether the CID extension
1923 * is currently in use or not. If the CID is in use,
1924 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1925 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1926 * \param peer_cid The address of the buffer in which to store the CID
1927 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01001928 * This may be \c NULL in case the value of peer CID
1929 * isn't needed. If it is not \c NULL, \p peer_cid_len
1930 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01001931 * \param peer_cid_len The address at which to store the size of the CID
1932 * chosen by the peer (if the CID extension is used).
1933 * This is also the number of Bytes in \p peer_cid that
1934 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01001935 * This may be \c NULL in case the length of the peer CID
1936 * isn't needed. If it is \c NULL, \p peer_cid must be
1937 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01001938 *
1939 * \note This applies to the state of the CID negotiated in
1940 * the last complete handshake. If a handshake is in
1941 * progress, this function will attempt to complete
1942 * the handshake first.
1943 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001944 * \note If CID extensions have been exchanged but both client
1945 * and server chose to use an empty CID, this function
1946 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1947 * (the rationale for this is that the resulting
1948 * communication is the same as if the CID extensions
1949 * hadn't been used).
1950 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001951 * \return \c 0 on success.
1952 * \return A negative error code on failure.
1953 */
1954int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1955 int *enabled,
1956 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1957 size_t *peer_cid_len );
1958
Hanno Beckera0e20d02019-05-15 14:03:01 +01001959#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01001960
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001961/**
1962 * \brief Set the Maximum Tranport Unit (MTU).
1963 * Special value: 0 means unset (no limit).
1964 * This represents the maximum size of a datagram payload
1965 * handled by the transport layer (usually UDP) as determined
1966 * by the network link and stack. In practice, this controls
1967 * the maximum size datagram the DTLS layer will pass to the
1968 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1969 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001970 * \note The limit on datagram size is converted to a limit on
1971 * record payload by subtracting the current overhead of
1972 * encapsulation and encryption/authentication if any.
1973 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001974 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001975 * example when a Path Maximum Transfer Unit (PMTU)
1976 * estimate becomes available from other sources,
1977 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001978 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001979 * \note This setting only controls the size of the packets we send,
1980 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001981 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001982 * server to use smaller records with \c
1983 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001984 *
1985 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001986 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001987 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001988 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001989 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001990 * of datagrams (hence records, see first note) sent. It
1991 * cannot be used to increase the maximum size of records over
1992 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001993 *
1994 * \note Values lower than the current record layer expansion will
1995 * result in an error when trying to send data.
1996 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001997 * \param ssl SSL context
1998 * \param mtu Value of the path MTU in bytes
1999 */
2000void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
2001#endif /* MBEDTLS_SSL_PROTO_DTLS */
2002
Hanno Becker726c97a2019-04-03 12:52:35 +01002003#if defined(MBEDTLS_X509_CRT_PARSE_C)
2004/**
2005 * \brief Set a connection-specific verification callback (optional).
2006 *
2007 * If set, the provided verify callback is called for each
2008 * certificate in the peer's CRT chain, including the trusted
2009 * root. For more information, please see the documentation of
2010 * \c mbedtls_x509_crt_verify().
2011 *
2012 * \note This call is analogous to mbedtls_ssl_conf_verify() but
2013 * binds the verification callback and context to an SSL context
2014 * as opposed to an SSL configuration.
2015 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
2016 * are both used, mbedtls_ssl_set_verify() takes precedence.
2017 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01002018 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01002019 * \param f_vrfy The verification callback to use during CRT verification.
2020 * \param p_vrfy The opaque context to be passed to the callback.
2021 */
2022void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
2023 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
2024 void *p_vrfy );
2025#endif /* MBEDTLS_X509_CRT_PARSE_C */
2026
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002027/**
2028 * \brief Set the timeout period for mbedtls_ssl_read()
2029 * (Default: no timeout.)
2030 *
2031 * \param conf SSL configuration context
2032 * \param timeout Timeout value in milliseconds.
2033 * Use 0 for no timeout (default).
2034 *
2035 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01002036 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02002037 * With non-blocking I/O, this will only work if timer
2038 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
2039 *
2040 * \note With non-blocking I/O, you may also skip this function
2041 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01002042 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002043void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02002044
Hanno Beckercfe45792019-07-03 16:13:00 +01002045/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002046 * \brief Check whether a buffer contains a valid and authentic record
2047 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01002048 *
2049 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01002050 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01002051 * an indication of the legitimacy of an incoming record.
2052 *
2053 * This can be useful e.g. in distributed server environments
2054 * using the DTLS Connection ID feature, in which connections
2055 * might need to be passed between service instances on a change
2056 * of peer address, but where such disruptive operations should
2057 * only happen after the validity of incoming records has been
2058 * confirmed.
2059 *
2060 * \param ssl The SSL context to use.
2061 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002062 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01002063 * \param buflen The length of \p buf in Bytes.
2064 *
2065 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002066 * with a valid and authentic record that has not been seen
2067 * before, but does not check potential data following the
2068 * initial record. In particular, it is possible to pass DTLS
2069 * datagrams containing multiple records, in which case only
2070 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01002071 *
2072 * \note This function modifies the input buffer \p buf. If you need
2073 * to preserve the original record, you have to maintain a copy.
2074 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03002075 * \return \c 0 if the record is valid and authentic and has not been
2076 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01002077 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
2078 * successfully but the record was found to be not authentic.
2079 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
2080 * successfully but the record was found to be invalid for
2081 * a reason different from authenticity checking.
2082 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
2083 * successfully but the record was found to be unexpected
2084 * in the state of the SSL context, including replayed records.
2085 * \return Another negative error code on different kinds of failure.
2086 * In this case, the SSL context becomes unusable and needs
2087 * to be freed or reset before reuse.
2088 */
2089int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
2090 unsigned char *buf,
2091 size_t buflen );
Hanno Beckercfe45792019-07-03 16:13:00 +01002092
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002093/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002094 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002095 *
2096 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002097 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002098 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002099 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002100 *
2101 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
2102 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02002103 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002104 *
2105 * \note On some platforms, timing.c provides
2106 * \c mbedtls_timing_set_delay() and
2107 * \c mbedtls_timing_get_delay() that are suitable for using
2108 * here, except if using an event-driven style.
2109 *
2110 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00002111 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002112 */
2113void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
2114 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01002115 mbedtls_ssl_set_timer_t *f_set_timer,
2116 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02002117
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002118/**
2119 * \brief Callback type: generate and write session ticket
2120 *
2121 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002122 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002123 * authenticated ticket for the session and write it to the
2124 * output buffer. Here, ticket means the opaque ticket part
2125 * of the NewSessionTicket structure of RFC 5077.
2126 *
2127 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00002128 * \param session SSL session to be written in the ticket
2129 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002130 * \param end End of the output buffer
2131 * \param tlen On exit, holds the length written
2132 * \param lifetime On exit, holds the lifetime of the ticket in seconds
2133 *
2134 * \return 0 if successful, or
2135 * a specific MBEDTLS_ERR_XXX code.
2136 */
2137typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
2138 const mbedtls_ssl_session *session,
2139 unsigned char *start,
2140 const unsigned char *end,
2141 size_t *tlen,
2142 uint32_t *lifetime );
2143
2144/**
2145 * \brief Callback type: parse and load session ticket
2146 *
2147 * \note This describes what a callback implementation should do.
2148 * This callback should parse a session ticket as generated
2149 * by the corresponding mbedtls_ssl_ticket_write_t function,
2150 * and, if the ticket is authentic and valid, load the
2151 * session.
2152 *
2153 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002154 * bytes of the input buffer, eg to use it as a temporary
2155 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002156 *
2157 * \param p_ticket Context for the callback
2158 * \param session SSL session to be loaded
2159 * \param buf Start of the buffer containing the ticket
2160 * \param len Length of the ticket.
2161 *
2162 * \return 0 if successful, or
2163 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2164 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2165 * any other non-zero code for other failures.
2166 */
2167typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
2168 mbedtls_ssl_session *session,
2169 unsigned char *buf,
2170 size_t len );
2171
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002172#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002173/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002174 * \brief Configure SSL session ticket callbacks (server only).
2175 * (Default: none.)
2176 *
2177 * \note On server, session tickets are enabled by providing
2178 * non-NULL callbacks.
2179 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002180 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002181 *
2182 * \param conf SSL configuration context
2183 * \param f_ticket_write Callback for writing a ticket
2184 * \param f_ticket_parse Callback for parsing a ticket
2185 * \param p_ticket Context shared by the two callbacks
2186 */
2187void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2188 mbedtls_ssl_ticket_write_t *f_ticket_write,
2189 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2190 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002191#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002192
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002193/**
Hanno Becker457d6162021-05-24 10:27:39 +01002194 * \brief Configure a key export callback.
2195 * (Default: none.)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002196 *
Hanno Becker457d6162021-05-24 10:27:39 +01002197 * This API can be used for two purposes:
2198 * - Debugging: Use this API to e.g. generate an NSSKeylog
2199 * file and use it to inspect encrypted traffic in tools
2200 * such as Wireshark.
2201 * - Application-specific export: Use this API to implement
2202 * key exporters, e.g. for EAP-TLS or DTLS-SRTP.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002203 *
Hanno Becker457d6162021-05-24 10:27:39 +01002204 *
Hanno Becker7e6c1782021-06-08 09:24:55 +01002205 * \param ssl The SSL context to which the export
2206 * callback should be attached.
Hanno Becker457d6162021-05-24 10:27:39 +01002207 * \param f_export_keys The callback for the key export.
2208 * \param p_export_keys The opaque context pointer to be passed to the
2209 * callback \p f_export_keys.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002210 */
Hanno Becker7e6c1782021-06-08 09:24:55 +01002211void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2212 mbedtls_ssl_export_keys_t *f_export_keys,
2213 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002214
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002215#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002216/**
2217 * \brief Configure asynchronous private key operation callbacks.
2218 *
2219 * \param conf SSL configuration context
2220 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002221 * the description of ::mbedtls_ssl_async_sign_t
2222 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002223 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002224 * operation; in this case the private key object
2225 * associated with the certificate will be used.
2226 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002227 * the description of ::mbedtls_ssl_async_decrypt_t
2228 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002229 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002230 * operation; in this case the private key object
2231 * associated with the certificate will be used.
2232 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002233 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002234 * for more information. This may not be \c NULL unless
2235 * \p f_async_sign and \p f_async_decrypt are both
2236 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002237 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002238 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002239 * for more information. This may be \c NULL if
2240 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002241 * \param config_data A pointer to configuration data which can be
2242 * retrieved with
2243 * mbedtls_ssl_conf_get_async_config_data(). The
2244 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002245 */
2246void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2247 mbedtls_ssl_async_sign_t *f_async_sign,
2248 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2249 mbedtls_ssl_async_resume_t *f_async_resume,
2250 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002251 void *config_data );
2252
2253/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002254 * \brief Retrieve the configuration data set by
2255 * mbedtls_ssl_conf_async_private_cb().
2256 *
2257 * \param conf SSL configuration context
2258 * \return The configuration data set by
2259 * mbedtls_ssl_conf_async_private_cb().
2260 */
2261void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2262
2263/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002264 * \brief Retrieve the asynchronous operation user context.
2265 *
2266 * \note This function may only be called while a handshake
2267 * is in progress.
2268 *
2269 * \param ssl The SSL context to access.
2270 *
2271 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002272 * set during the current handshake. If
2273 * mbedtls_ssl_set_async_operation_data() has not yet been
2274 * called during the current handshake, this function returns
2275 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002276 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002277void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002278
2279/**
2280 * \brief Retrieve the asynchronous operation user context.
2281 *
2282 * \note This function may only be called while a handshake
2283 * is in progress.
2284 *
2285 * \param ssl The SSL context to access.
2286 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002287 * Call mbedtls_ssl_get_async_operation_data() later during the
2288 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002289 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002290void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002291 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002292#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002293
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002294/**
2295 * \brief Callback type: generate a cookie
2296 *
2297 * \param ctx Context for the callback
2298 * \param p Buffer to write to,
2299 * must be updated to point right after the cookie
2300 * \param end Pointer to one past the end of the output buffer
2301 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002302 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002303 * \param ilen Length of info in bytes
2304 *
2305 * \return The callback must return 0 on success,
2306 * or a negative error code.
2307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002309 unsigned char **p, unsigned char *end,
2310 const unsigned char *info, size_t ilen );
2311
2312/**
2313 * \brief Callback type: verify a cookie
2314 *
2315 * \param ctx Context for the callback
2316 * \param cookie Cookie to verify
2317 * \param clen Length of cookie
2318 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002319 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002320 * \param ilen Length of info in bytes
2321 *
2322 * \return The callback must return 0 if cookie is valid,
2323 * or a negative error code.
2324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002325typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002326 const unsigned char *cookie, size_t clen,
2327 const unsigned char *info, size_t ilen );
2328
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002329#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002330/**
2331 * \brief Register callbacks for DTLS cookies
2332 * (Server only. DTLS only.)
2333 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002334 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002335 * register working callbacks (and initialize their context).
2336 *
2337 * To disable HelloVerifyRequest, register NULL callbacks.
2338 *
2339 * \warning Disabling hello verification allows your server to be used
2340 * for amplification in DoS attacks against other hosts.
2341 * Only disable if you known this can't happen in your
2342 * particular environment.
2343 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002344 * \note See comments on \c mbedtls_ssl_handshake() about handling
2345 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2346 * on the first handshake attempt when this is enabled.
2347 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002348 * \note This is also necessary to handle client reconnection from
2349 * the same port as described in RFC 6347 section 4.2.8 (only
2350 * the variant with cookies is supported currently). See
2351 * comments on \c mbedtls_ssl_read() for details.
2352 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002353 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002354 * \param f_cookie_write Cookie write callback
2355 * \param f_cookie_check Cookie check callback
2356 * \param p_cookie Context for both callbacks
2357 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002358void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002359 mbedtls_ssl_cookie_write_t *f_cookie_write,
2360 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002361 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002362
2363/**
2364 * \brief Set client's transport-level identification info.
2365 * (Server only. DTLS only.)
2366 *
2367 * This is usually the IP address (and port), but could be
2368 * anything identify the client depending on the underlying
2369 * network stack. Used for HelloVerifyRequest with DTLS.
2370 * This is *not* used to route the actual packets.
2371 *
2372 * \param ssl SSL context
2373 * \param info Transport-level info identifying the client (eg IP + port)
2374 * \param ilen Length of info in bytes
2375 *
2376 * \note An internal copy is made, so the info buffer can be reused.
2377 *
2378 * \return 0 on success,
2379 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002380 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002381 */
2382int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2383 const unsigned char *info,
2384 size_t ilen );
2385
2386#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002387
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002388#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002389/**
2390 * \brief Enable or disable anti-replay protection for DTLS.
2391 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002392 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002393 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002394 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002396 *
2397 * \warning Disabling this is a security risk unless the application
2398 * protocol handles duplicated packets in a safe way. You
2399 * should not disable this without careful consideration.
2400 * However, if your application already detects duplicated
2401 * packets and needs information about them to adjust its
2402 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002403 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002404void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002405#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002406
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002407/**
2408 * \brief Set a limit on the number of records with a bad MAC
2409 * before terminating the connection.
2410 * (DTLS only, no effect on TLS.)
2411 * Default: 0 (disabled).
2412 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002413 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002414 * \param limit Limit, or 0 to disable.
2415 *
2416 * \note If the limit is N, then the connection is terminated when
2417 * the Nth non-authentic record is seen.
2418 *
2419 * \note Records with an invalid header are not counted, only the
2420 * ones going through the authentication-decryption phase.
2421 *
2422 * \note This is a security trade-off related to the fact that it's
2423 * often relatively easy for an active attacker ot inject UDP
2424 * datagrams. On one hand, setting a low limit here makes it
2425 * easier for such an attacker to forcibly terminated a
2426 * connection. On the other hand, a high limit or no limit
2427 * might make us waste resources checking authentication on
2428 * many bogus packets.
2429 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002430void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002431
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002433
2434/**
2435 * \brief Allow or disallow packing of multiple handshake records
2436 * within a single datagram.
2437 *
2438 * \param ssl The SSL context to configure.
2439 * \param allow_packing This determines whether datagram packing may
2440 * be used or not. A value of \c 0 means that every
2441 * record will be sent in a separate datagram; a
2442 * value of \c 1 means that, if space permits,
2443 * multiple handshake messages (including CCS) belonging to
2444 * a single flight may be packed within a single datagram.
2445 *
2446 * \note This is enabled by default and should only be disabled
2447 * for test purposes, or if datagram packing causes
2448 * interoperability issues with peers that don't support it.
2449 *
2450 * \note Allowing datagram packing reduces the network load since
2451 * there's less overhead if multiple messages share the same
2452 * datagram. Also, it increases the handshake efficiency
2453 * since messages belonging to a single datagram will not
2454 * be reordered in transit, and so future message buffering
2455 * or flight retransmission (if no buffering is used) as
2456 * means to deal with reordering are needed less frequently.
2457 *
Hanno Beckereb570082018-08-24 11:28:35 +01002458 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002459 * are currently always sent in separate datagrams.
2460 *
2461 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002462void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2463 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002464
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002465/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002466 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002467 * (DTLS only, no effect on TLS.)
2468 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002469 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002470 * \param min Initial timeout value in milliseconds.
2471 * Default: 1000 (1 second).
2472 * \param max Maximum timeout value in milliseconds.
2473 * Default: 60000 (60 seconds).
2474 *
2475 * \note Default values are from RFC 6347 section 4.2.4.1.
2476 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002477 * \note The 'min' value should typically be slightly above the
2478 * expected round-trip time to your peer, plus whatever time
2479 * it takes for the peer to process the message. For example,
2480 * if your RTT is about 600ms and you peer needs up to 1s to
2481 * do the cryptographic operations in the handshake, then you
2482 * should set 'min' slightly above 1600. Lower values of 'min'
2483 * might cause spurious resends which waste network resources,
2484 * while larger value of 'min' will increase overall latency
2485 * on unreliable network links.
2486 *
2487 * \note The more unreliable your network connection is, the larger
2488 * your max / min ratio needs to be in order to achieve
2489 * reliable handshakes.
2490 *
2491 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2492 * For example, if min = 1s and max = 5s, the retransmit plan
2493 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2494 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002495 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002496void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002497#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002498
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002499#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002500/**
Paul Bakker0a597072012-09-25 21:55:46 +00002501 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002502 * If not set, no session resuming is done (except if session
2503 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002504 *
Paul Bakker0a597072012-09-25 21:55:46 +00002505 * The session cache has the responsibility to check for stale
2506 * entries based on timeout. See RFC 5246 for recommendations.
2507 *
2508 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2509 * connection shutdown, so do not cache the pointer! Either set
2510 * it to NULL or make a full copy of the certificate.
2511 *
2512 * The get callback is called once during the initial handshake
2513 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002514 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002515 * If a valid entry is found, it should fill the master of
2516 * the session object with the cached values and return 0,
2517 * return 1 otherwise. Optionally peer_cert can be set as well
2518 * if it is properly present in cache entry.
2519 *
2520 * The set callback is called once during the initial handshake
2521 * to enable session resuming after the entire handshake has
2522 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002524 * should create a cache entry for future retrieval based on
2525 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002527 * data) is cleared by the SSL/TLS layer when the connection is
2528 * terminated. It is recommended to add metadata to determine if
2529 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002530 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002531 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002532 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002533 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002534 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002535 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002536 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002537void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01002538 void *p_cache,
2539 mbedtls_ssl_cache_get_t *f_get_cache,
2540 mbedtls_ssl_cache_set_t *f_set_cache );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002541#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002544/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01002545 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00002546 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01002547 * Sessions loaded through this call will be considered
2548 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002549 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01002550 * \note Even if this call succeeds, it is not guaranteed that
2551 * the next handshake will indeed be shortened through the
2552 * use of session resumption: The server is always free
2553 * to reject any attempt for resumption and fall back to
2554 * a full handshake.
2555 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01002556 * \note This function can handle a variety of mechanisms for session
2557 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01002558 * ticket-based resumption will be considered. For TLS 1.3,
2559 * once implemented, sessions equate to tickets, and loading
2560 * one or more sessions via this call will lead to their
2561 * corresponding tickets being advertised as resumption PSKs
2562 * by the client.
2563 *
2564 * \note Calling this function multiple times will only be useful
2565 * once TLS 1.3 is supported. For TLS 1.2 connections, this
2566 * function should be called at most once.
2567 *
2568 * \param ssl The SSL context representing the connection which should
2569 * be attempted to be setup using session resumption. This
2570 * must be initialized via mbedtls_ssl_init() and bound to
2571 * an SSL configuration via mbedtls_ssl_setup(), but
2572 * the handshake must not yet have been started.
2573 * \param session The session to be considered for session resumption.
2574 * This must be a session previously exported via
2575 * mbedtls_ssl_get_session(), and potentially serialized and
2576 * deserialized through mbedtls_ssl_session_save() and
2577 * mbedtls_ssl_session_load() in the meantime.
2578 *
2579 * \return \c 0 if successful.
2580 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
2581 * could not be loaded because of an implementation limitation.
2582 * This error is non-fatal, and has no observable effect on
2583 * the SSL context or the session that was attempted to be loaded.
2584 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002585 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002586 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01002587 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00002588 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002589int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2590#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002591
2592/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002593 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002594 * On client, this can be used for loading saved sessions
2595 * before resuming them with mbedstls_ssl_set_session().
2596 * On server, this can be used for alternative implementations
2597 * of session cache or session tickets.
2598 *
2599 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002600 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002601 * end-entity certificate and the result of the chain
2602 * verification (unless verification was disabled), but not
2603 * the rest of the chain.
2604 *
2605 * \see mbedtls_ssl_session_save()
2606 * \see mbedtls_ssl_set_session()
2607 *
2608 * \param session The session structure to be populated. It must have been
2609 * initialised with mbedtls_ssl_session_init() but not
2610 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002611 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002612 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002613 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002614 *
2615 * \return \c 0 if successful.
2616 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2617 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01002618 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2619 * was generated in a different version or configuration of
2620 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002621 * \return Another negative value for other kinds of errors (for
2622 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002623 */
2624int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2625 const unsigned char *buf,
2626 size_t len );
2627
2628/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002629 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002630 * On client, this can be used for saving session data,
2631 * potentially in non-volatile storage, for resuming later.
2632 * On server, this can be used for alternative implementations
2633 * of session cache or session tickets.
2634 *
2635 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002636 *
2637 * \param session The session structure to be saved.
2638 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002639 * writeable buffer of at least \p len bytes, or may be \c
2640 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002641 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002642 * \param olen The size in bytes of the data that has been or would have
2643 * been written. It must point to a valid \c size_t.
2644 *
2645 * \note \p olen is updated to the correct value regardless of
2646 * whether \p buf_len was large enough. This makes it possible
2647 * to determine the necessary size by calling this function
2648 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002649 *
2650 * \return \c 0 if successful.
2651 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2652 */
2653int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2654 unsigned char *buf,
2655 size_t buf_len,
2656 size_t *olen );
2657
2658/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002659 * \brief Set the list of allowed ciphersuites and the preference
2660 * order. First in the list has the highest preference.
Paul Bakker5121ce52009-01-03 21:22:43 +00002661 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01002662 * For TLS 1.2, the notion of ciphersuite determines both
2663 * the key exchange mechanism and the suite of symmetric
2664 * algorithms to be used during and after the handshake.
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002665 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01002666 * For TLS 1.3 (in development), the notion of ciphersuite
Hanno Becker674f9482021-08-02 21:21:19 +01002667 * only determines the suite of symmetric algorithms to be
Hanno Beckere486b2d2021-07-23 19:24:30 +01002668 * used during and after the handshake, while key exchange
2669 * mechanisms are configured separately.
2670 *
2671 * In Mbed TLS, ciphersuites for both TLS 1.2 and TLS 1.3
2672 * are configured via this function. For users of TLS 1.3,
2673 * there will be separate API for the configuration of key
2674 * exchange mechanisms.
2675 *
2676 * The list of ciphersuites passed to this function may
2677 * contain a mixture of TLS 1.2 and TLS 1.3 ciphersuite
2678 * identifiers. This is useful if negotiation of TLS 1.3
2679 * should be attempted, but a fallback to TLS 1.2 would
2680 * be tolerated.
2681 *
2682 * \note By default, the server chooses its preferred
TRodziewicz3946f792021-06-14 12:11:18 +02002683 * ciphersuite among those that the client supports. If
2684 * mbedtls_ssl_conf_preference_order() is called to prefer
2685 * the client's preferences, the server instead chooses
2686 * the client's preferred ciphersuite among those that
2687 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002688 *
Hanno Beckere486b2d2021-07-23 19:24:30 +01002689 * \warning The ciphersuites array \p ciphersuites is not copied.
Jerry Yucadebe52021-08-24 10:36:45 +08002690 * It must remain valid for the lifetime of the SSL
Hanno Beckere486b2d2021-07-23 19:24:30 +01002691 * configuration \p conf.
2692 *
2693 * \param conf The SSL configuration to modify.
2694 * \param ciphersuites A 0-terminated list of IANA identifiers of supported
2695 * ciphersuites, accessible through \c MBEDTLS_TLS_XXX
2696 * and \c MBEDTLS_TLS1_3_XXX macros defined in
2697 * ssl_ciphersuites.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00002698 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002699void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Hanno Beckere486b2d2021-07-23 19:24:30 +01002700 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002701
Hanno Becker71f1ed62021-07-24 06:01:47 +01002702#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
2703/**
2704 * \brief Set the supported key exchange modes for TLS 1.3 connections.
2705 *
2706 * In contrast to TLS 1.2, the ciphersuite concept in TLS 1.3 does not
2707 * include the choice of key exchange mechanism. It is therefore not
2708 * covered by the API mbedtls_ssl_conf_ciphersuites(). See the
2709 * documentation of mbedtls_ssl_conf_ciphersuites() for more
2710 * information on the ciphersuite concept in TLS 1.2 and TLS 1.3.
2711 *
2712 * The present function is specific to TLS 1.3 and allows users to
2713 * configure the set of supported key exchange mechanisms in TLS 1.3.
2714 *
2715 * \param conf The SSL configuration the change should apply to.
2716 * \param kex_modes A bitwise combination of one or more of the following:
2717 * - MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK
2718 * This flag enables pure-PSK key exchanges.
2719 * - MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_EPHEMERAL
2720 * This flag enables combined PSK-ephemeral key exchanges.
2721 * - MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL
2722 * This flag enables pure-ephemeral key exchanges.
2723 * For convenience, the following pre-defined macros are
2724 * available for combinations of the above:
2725 * - MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_ALL
2726 * Includes all of pure-PSK, PSK-ephemeral and pure-ephemeral.
2727 * - MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_PSK_ALL
2728 * Includes both pure-PSK and combined PSK-ephemeral
2729 * key exchanges, but excludes pure-ephemeral key exchanges.
2730 * - MBEDTLS_SSL_TLS13_KEY_EXCHANGE_MODE_EPHEMERAL_ALL
2731 * Includes both pure-ephemeral and combined PSK-ephemeral
2732 * key exchanges.
2733 *
2734 * \note If a PSK-based key exchange mode shall be supported, applications
2735 * must also use the APIs mbedtls_ssl_conf_psk() or
2736 * mbedtls_ssl_conf_psk_cb() or mbedtls_ssl_conf_psk_opaque()
2737 * to configure the PSKs to be used.
2738 *
Hanno Becker5d045a82021-08-02 21:21:30 +01002739 * \note If a pure-ephemeral key exchange mode shall be supported,
Hanno Becker71f1ed62021-07-24 06:01:47 +01002740 * server-side applications must also provide a certificate via
2741 * mbedtls_ssl_conf_own_cert().
2742 *
2743 */
2744
2745void mbedtls_ssl_conf_tls13_key_exchange_modes( mbedtls_ssl_config* conf,
2746 const int kex_modes );
2747#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Paul Bakker5121ce52009-01-03 21:22:43 +00002748
Hanno Beckera0e20d02019-05-15 14:03:01 +01002749#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01002750#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2751#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01002752/**
Hanno Becker11259522019-05-23 16:55:50 +01002753 * \brief Specify the length of Connection IDs for incoming
2754 * encrypted DTLS records, as well as the behaviour
2755 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01002756 *
2757 * By default, the CID length is set to \c 0,
2758 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002759 *
2760 * \param conf The SSL configuration to modify.
2761 * \param len The length in Bytes of the CID fields in encrypted
2762 * DTLS records using the CID mechanism. This must
2763 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01002764 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01002765 * receiving a record with an unexpected CID.
2766 * Possible values are:
2767 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2768 * In this case, the record is silently ignored.
2769 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2770 * In this case, the stack fails with the specific
2771 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002772 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002773 * \note The CID specification allows implementations to either
2774 * use a common length for all incoming connection IDs or
2775 * allow variable-length incoming IDs. Mbed TLS currently
2776 * requires a common length for all connections sharing the
2777 * same SSL configuration; this allows simpler parsing of
2778 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002779 *
2780 * \return \c 0 on success.
2781 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2782 * is too large.
2783 */
Hanno Becker8367ccc2019-05-14 11:30:10 +01002784int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2785 int ignore_other_cids );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002786#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01002787
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002788#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002789/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002790 * \brief Set the X.509 security profile used for verification
2791 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002792 * \note The restrictions are enforced for all certificates in the
2793 * chain. However, signatures in the handshake are not covered
2794 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2795 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002796 * \param conf SSL configuration
2797 * \param profile Profile to use
2798 */
2799void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002800 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002801
2802/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002803 * \brief Set the data required to verify peer certificate
2804 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002805 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002806 * parameters ca_chain (maps to trust_ca for that function)
2807 * and ca_crl.
2808 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002809 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002810 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002811 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002812 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002813void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002814 mbedtls_x509_crt *ca_chain,
2815 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002816
Hanno Becker8bf74f32019-03-27 11:01:30 +00002817#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2818/**
2819 * \brief Set the trusted certificate callback.
2820 *
2821 * This API allows to register the set of trusted certificates
2822 * through a callback, instead of a linked list as configured
2823 * by mbedtls_ssl_conf_ca_chain().
2824 *
2825 * This is useful for example in contexts where a large number
2826 * of CAs are used, and the inefficiency of maintaining them
2827 * in a linked list cannot be tolerated. It is also useful when
2828 * the set of trusted CAs needs to be modified frequently.
2829 *
2830 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2831 * more information.
2832 *
2833 * \param conf The SSL configuration to register the callback with.
2834 * \param f_ca_cb The trusted certificate callback to use when verifying
2835 * certificate chains.
2836 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2837 * a reference to a trusted CA database).
2838 *
2839 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2840 * Any call to this function overwrites the values set through
2841 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2842 * mbedtls_ssl_conf_ca_cb().
2843 *
2844 * \note This API is incompatible with CA indication in
2845 * CertificateRequest messages: A server-side SSL context which
2846 * is bound to an SSL configuration that uses a CA callback
2847 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2848 * client authentication, will send an empty CA list in the
2849 * corresponding CertificateRequest message.
2850 *
2851 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2852 * If an SSL context is bound to an SSL configuration which uses
2853 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2854 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2855 *
2856 * \note The use of this API disables the use of restartable ECC
2857 * during X.509 CRT signature verification (but doesn't affect
2858 * other uses).
2859 *
2860 * \warning This API is incompatible with the use of CRLs. Any call to
2861 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2862 * earlier calls to mbedtls_ssl_conf_ca_chain().
2863 *
2864 * \warning In multi-threaded environments, the callback \p f_ca_cb
2865 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002866 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002867 * contained in the callback context pointed to by \p p_ca_cb).
2868 */
2869void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2870 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2871 void *p_ca_cb );
2872#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2873
Paul Bakker5121ce52009-01-03 21:22:43 +00002874/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002875 * \brief Set own certificate chain and private key
2876 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002877 * \note own_cert should contain in order from the bottom up your
2878 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002879 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002880 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002881 * \note On server, this function can be called multiple times to
2882 * provision more than one cert/key pair (eg one ECDSA, one
2883 * RSA with SHA-256, one RSA with SHA-1). An adequate
2884 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002885 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002886 * adequate, preference is given to the one set by the first
2887 * call to this function, then second, etc.
2888 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002889 * \note On client, only the first call has any effect. That is,
2890 * only one client certificate can be provisioned. The
2891 * server's preferences in its CertficateRequest message will
2892 * be ignored and our only cert will be sent regardless of
2893 * whether it matches those preferences - the server can then
2894 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002895 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002896 * \note The provided \p pk_key needs to match the public key in the
2897 * first certificate in \p own_cert, or all handshakes using
2898 * that certificate will fail. It is your responsibility
2899 * to ensure that; this function will not perform any check.
2900 * You may use mbedtls_pk_check_pair() in order to perform
2901 * this check yourself, but be aware that this function can
2902 * be computationally expensive on some key types.
2903 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002904 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002905 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002906 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002907 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002908 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002909 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002910int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002911 mbedtls_x509_crt *own_cert,
2912 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002913#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002914
Gilles Peskineeccd8882020-03-10 12:19:08 +01002915#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002916/**
Hanno Becker196739b2021-05-28 05:25:46 +01002917 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01002918 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002919 *
Hanno Becker196739b2021-05-28 05:25:46 +01002920 * Only one PSK can be registered, through either
2921 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
2922 * If you attempt to register more than one PSK, this function
2923 * fails, though this may change in future versions, which
2924 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002925 *
2926 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002927 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002928 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002929 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
2930 * takes precedence over a PSK configured by this function.
2931 *
Hanno Becker02283042018-10-22 15:28:02 +01002932 * \param conf The SSL configuration to register the PSK with.
2933 * \param psk The pointer to the pre-shared key to use.
2934 * \param psk_len The length of the pre-shared key in bytes.
2935 * \param psk_identity The pointer to the pre-shared key identity.
2936 * \param psk_identity_len The length of the pre-shared key identity
2937 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002938 *
Hanno Becker02283042018-10-22 15:28:02 +01002939 * \note The PSK and its identity are copied internally and
2940 * hence need not be preserved by the caller for the lifetime
2941 * of the SSL configuration.
2942 *
2943 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01002944 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01002945 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01002946 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002947 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002948int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002949 const unsigned char *psk, size_t psk_len,
2950 const unsigned char *psk_identity, size_t psk_identity_len );
2951
Hanno Becker02283042018-10-22 15:28:02 +01002952#if defined(MBEDTLS_USE_PSA_CRYPTO)
2953/**
Hanno Becker946c9252021-04-19 21:41:47 +01002954 * \brief Configure one or more opaque pre-shared keys (PSKs) and
2955 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01002956 *
Hanno Becker196739b2021-05-28 05:25:46 +01002957 * Only one PSK can be registered, through either
2958 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
2959 * If you attempt to register more than one PSK, this function
2960 * fails, though this may change in future versions, which
2961 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01002962 *
2963 * \note This is mainly useful for clients. Servers will usually
2964 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2965 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002966 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
2967 * the PSK callback takes precedence over an opaque PSK
2968 * configured by this function.
2969 *
Hanno Becker02283042018-10-22 15:28:02 +01002970 * \param conf The SSL configuration to register the PSK with.
2971 * \param psk The identifier of the key slot holding the PSK.
2972 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002973 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002974 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002975 * allows its use for the key derivation algorithm applied
2976 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002977 * \param psk_identity The pointer to the pre-shared key identity.
2978 * \param psk_identity_len The length of the pre-shared key identity
2979 * in bytes.
2980 *
2981 * \note The PSK identity hint is copied internally and hence need
2982 * not be preserved by the caller for the lifetime of the
2983 * SSL configuration.
2984 *
2985 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01002986 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01002987 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01002988 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01002989 */
2990int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002991 psa_key_id_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002992 const unsigned char *psk_identity,
2993 size_t psk_identity_len );
2994#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002995
2996/**
Hanno Becker02283042018-10-22 15:28:02 +01002997 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002998 *
2999 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01003000 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003001 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003002 * \note A PSK set by this function takes precedence over a PSK
3003 * configured by \c mbedtls_ssl_conf_psk().
3004 *
Hanno Becker02283042018-10-22 15:28:02 +01003005 * \param ssl The SSL context to configure a PSK for.
3006 * \param psk The pointer to the pre-shared key.
3007 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003008 *
Hanno Becker02283042018-10-22 15:28:02 +01003009 * \return \c 0 if successful.
3010 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003011 */
3012int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
3013 const unsigned char *psk, size_t psk_len );
3014
Hanno Becker02283042018-10-22 15:28:02 +01003015#if defined(MBEDTLS_USE_PSA_CRYPTO)
3016/**
3017 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
3018 *
3019 * \note This should only be called inside the PSK callback,
3020 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
3021 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003022 * \note An opaque PSK set by this function takes precedence over an
3023 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
3024 *
Hanno Becker02283042018-10-22 15:28:02 +01003025 * \param ssl The SSL context to configure a PSK for.
3026 * \param psk The identifier of the key slot holding the PSK.
3027 * For the duration of the current handshake, the key slot
3028 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05003029 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01003030 * use for the key derivation algorithm
3031 * applied in the handshake.
3032 *
3033 * \return \c 0 if successful.
3034 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
3035 */
3036int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Ronald Croncf56a0a2020-08-04 09:51:30 +02003037 psa_key_id_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01003038#endif /* MBEDTLS_USE_PSA_CRYPTO */
3039
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003040/**
3041 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02003042 *
3043 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01003044 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01003045 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02003046 * receive the actual PSK data and length.
3047 *
Hanno Becker02283042018-10-22 15:28:02 +01003048 * The callback has the following parameters:
3049 * - \c void*: The opaque pointer \p p_psk.
3050 * - \c mbedtls_ssl_context*: The SSL context to which
3051 * the operation applies.
3052 * - \c const unsigned char*: The PSK identity
3053 * selected by the client.
3054 * - \c size_t: The length of the PSK identity
3055 * selected by the client.
3056 *
Paul Bakker6db455e2013-09-18 17:29:31 +02003057 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01003058 * \c mbedtls_ssl_set_hs_psk() or
3059 * \c mbedtls_ssl_set_hs_psk_opaque()
3060 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02003061 * Any other return value will result in a denied PSK identity.
3062 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00003063 * \note A dynamic PSK (i.e. set by the PSK callback) takes
3064 * precedence over a static PSK (i.e. set by
3065 * \c mbedtls_ssl_conf_psk() or
3066 * \c mbedtls_ssl_conf_psk_opaque()).
3067 * This means that if you set a PSK callback using this
3068 * function, you don't need to set a PSK using
3069 * \c mbedtls_ssl_conf_psk() or
3070 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01003071 *
Hanno Becker02283042018-10-22 15:28:02 +01003072 * \param conf The SSL configuration to register the callback with.
3073 * \param f_psk The callback for selecting and setting the PSK based
3074 * in the PSK identity chosen by the client.
3075 * \param p_psk A pointer to an opaque structure to be passed to
3076 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02003077 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003078void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02003080 size_t),
3081 void *p_psk );
Gilles Peskineeccd8882020-03-10 12:19:08 +01003082#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02003083
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01003084#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01003085/**
3086 * \brief Set the Diffie-Hellman public P and G values
3087 * from big-endian binary presentations.
3088 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
3089 *
3090 * \param conf SSL configuration
3091 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
3092 * \param P_len Length of DHM modulus
3093 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
3094 * \param G_len Length of DHM generator
3095 *
3096 * \return 0 if successful
3097 */
3098int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
3099 const unsigned char *dhm_P, size_t P_len,
3100 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003101
3102/**
Paul Bakker1b57b062011-01-06 15:48:19 +00003103 * \brief Set the Diffie-Hellman public P and G values,
3104 * read from existing context (server-side only)
3105 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003106 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00003107 * \param dhm_ctx Diffie-Hellman-Merkle context
3108 *
3109 * \return 0 if successful
3110 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003111int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02003112#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00003113
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02003114#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
3115/**
3116 * \brief Set the minimum length for Diffie-Hellman parameters.
3117 * (Client-side only.)
3118 * (Default: 1024 bits.)
3119 *
3120 * \param conf SSL configuration
3121 * \param bitlen Minimum bit length of the DHM prime
3122 */
3123void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
3124 unsigned int bitlen );
3125#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
3126
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003127#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01003128/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003129 * \brief Set the allowed curves in order of preference.
Gergely Budai987bfb52014-01-19 21:48:42 +01003130 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003131 * On server: this only affects selection of the ECDHE curve;
3132 * the curves used for ECDH and ECDSA are determined by the
3133 * list of available certificates instead.
3134 *
3135 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01003136 * use. The server can override our preference order.
3137 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003138 * Both sides: limits the set of curves accepted for use in
3139 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003140 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003141 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02003142 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02003143 * for that. For the end-entity certificate however, the key
3144 * will be accepted only if it is allowed both by this list
3145 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01003146 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003147 * \note This list should be ordered by decreasing preference
3148 * (preferred curve first).
3149 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003150 * \note The default list is the same set of curves that
3151 * #mbedtls_x509_crt_profile_default allows, plus
3152 * ECDHE-only curves selected according to the same criteria.
Gilles Peskineb1940a72021-06-02 15:18:12 +02003153 * The order favors curves with the lowest resource usage.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003154 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003155 * \note New minor versions of Mbed TLS may extend this list,
3156 * for example if new curves are added to the library.
3157 * New minor versions of Mbed TLS will not remove items
3158 * from this list unless serious security concerns require it.
3159 * New minor versions of Mbed TLS may change the order in
3160 * keeping with the general principle of favoring the lowest
3161 * resource usage.
3162 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003163 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01003164 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003165 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01003166 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003167void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
3168 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02003169#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01003170
Gilles Peskineeccd8882020-03-10 12:19:08 +01003171#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003172/**
3173 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003174 *
3175 * \note This only affects which hashes are offered and can be used
3176 * for signatures during the handshake. Hashes for message
3177 * authentication and the TLS PRF are controlled by the
3178 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
3179 * used for certificate signature are controlled by the
3180 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
3181 *
3182 * \note This list should be ordered by decreasing preference
3183 * (preferred hash first).
3184 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02003185 * \note By default, all supported hashes whose length is at least
3186 * 256 bits are allowed. This is the same set as the default
3187 * for certificate verification
Gilles Peskinea28f0f52021-06-02 15:29:38 +02003188 * (#mbedtls_x509_crt_profile_default).
3189 * The preference order is currently unspecified and may
3190 * change in future versions.
Gilles Peskineae270bf2021-06-02 00:05:29 +02003191 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02003192 * \note New minor versions of Mbed TLS may extend this list,
3193 * for example if new curves are added to the library.
3194 * New minor versions of Mbed TLS will not remove items
3195 * from this list unless serious security concerns require it.
3196 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003197 * \param conf SSL configuration
3198 * \param hashes Ordered list of allowed signature hashes,
3199 * terminated by \c MBEDTLS_MD_NONE.
3200 */
3201void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
3202 const int *hashes );
Hanno Becker1cd6e002021-08-10 13:27:10 +01003203
3204#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
3205/**
3206 * \brief Configure allowed signature algorithms for use in TLS 1.3
3207 *
3208 * \param conf The SSL configuration to use.
Jerry Yu7899de82021-08-17 13:09:23 +08003209 * \param sig_algs List of allowed IANA values for TLS 1.3 signature algorithms,
3210 * terminated by \c MBEDTLS_TLS13_SIG_NONE. The list must remain
Jerry Yu447a3be2021-08-18 09:55:32 +08003211 * available throughout the lifetime of the conf object. Supported
Jerry Yu7899de82021-08-17 13:09:23 +08003212 * values are available as \c MBEDTLS_TLS13_SIG_XXXX
Hanno Becker1cd6e002021-08-10 13:27:10 +01003213 */
3214void mbedtls_ssl_conf_sig_algs( mbedtls_ssl_config *conf,
3215 const uint16_t* sig_algs );
3216#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
Gilles Peskineeccd8882020-03-10 12:19:08 +01003217#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003218
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003219#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003220/**
Darryl Green11999bb2018-03-13 15:22:58 +00003221 * \brief Set or reset the hostname to check against the received
3222 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003223 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003224 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003225 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003226 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003227
Hanno Becker0446a392017-04-07 12:59:32 +01003228 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003229 *
Darryl Green11999bb2018-03-13 15:22:58 +00003230 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3231 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003232 * too long input hostname.
3233 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003234 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003235 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003236 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003239#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003240
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003241#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003242/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003243 * \brief Set own certificate and key for the current handshake
3244 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003245 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003246 * the SNI callback.
3247 *
3248 * \param ssl SSL context
3249 * \param own_cert own public certificate chain
3250 * \param pk_key own private key
3251 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003252 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003253 */
3254int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
3255 mbedtls_x509_crt *own_cert,
3256 mbedtls_pk_context *pk_key );
3257
3258/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003259 * \brief Set the data required to verify peer certificate for the
3260 * current handshake
3261 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003262 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003263 * the SNI callback.
3264 *
3265 * \param ssl SSL context
3266 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3267 * \param ca_crl trusted CA CRLs
3268 */
3269void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
3270 mbedtls_x509_crt *ca_chain,
3271 mbedtls_x509_crl *ca_crl );
3272
3273/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003274 * \brief Set authmode for the current handshake.
3275 *
3276 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
3277 * the SNI callback.
3278 *
3279 * \param ssl SSL context
3280 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3281 * MBEDTLS_SSL_VERIFY_REQUIRED
3282 */
3283void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
3284 int authmode );
3285
3286/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003287 * \brief Set server side ServerName TLS extension callback
3288 * (optional, server-side only).
3289 *
3290 * If set, the ServerName callback is called whenever the
3291 * server receives a ServerName TLS extension from the client
3292 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003293 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003294 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003295 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003296 * certificate(s) and key(s) to use with \c
3297 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003298 * and may optionally adjust the CA and associated CRL with \c
3299 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3300 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3301 * then must return 0. If no matching name is found, the
3302 * callback must either set a default cert, or
3303 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003304 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003305 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003306 * \param f_sni verification function
3307 * \param p_sni verification parameter
3308 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003309void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003311 size_t),
3312 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003313#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003314
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003315#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003316/**
3317 * \brief Set the EC J-PAKE password for current handshake.
3318 *
3319 * \note An internal copy is made, and destroyed as soon as the
3320 * handshake is completed, or when the SSL context is reset or
3321 * freed.
3322 *
3323 * \note The SSL context needs to be already set up. The right place
3324 * to call this function is between \c mbedtls_ssl_setup() or
3325 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
3326 *
3327 * \param ssl SSL context
3328 * \param pw EC J-PAKE password (pre-shared secret)
3329 * \param pw_len length of pw in bytes
3330 *
3331 * \return 0 on success, or a negative error code.
3332 */
3333int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3334 const unsigned char *pw,
3335 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003336#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003339/**
3340 * \brief Set the supported Application Layer Protocols.
3341 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003342 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003343 * \param protos Pointer to a NULL-terminated list of supported protocols,
3344 * in decreasing preference order. The pointer to the list is
3345 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00003346 * the lifetime of the table must be atleast as long as the
3347 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003348 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003350 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003351int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003352
3353/**
3354 * \brief Get the name of the negotiated Application Layer Protocol.
3355 * This function should be called after the handshake is
3356 * completed.
3357 *
3358 * \param ssl SSL context
3359 *
3360 * \return Protcol name, or NULL if no protocol was negotiated.
3361 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003362const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
3363#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003364
Johan Pascalb62bb512015-12-03 21:56:45 +01003365#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003366#if defined(MBEDTLS_DEBUG_C)
Johan Pascalaae4d222020-09-22 21:21:39 +02003367static inline const char *mbedtls_ssl_get_srtp_profile_as_string( mbedtls_ssl_srtp_profile profile )
Johan Pascala455cd92020-09-22 15:28:11 +02003368{
3369 switch( profile )
3370 {
3371 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003372 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003373 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003374 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003375 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003376 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003377 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003378 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003379 default: break;
3380 }
3381 return( "" );
3382}
3383#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003384/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003385 * \brief Manage support for mki(master key id) value
3386 * in use_srtp extension.
3387 * MKI is an optional part of SRTP used for key management
3388 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003389 * The default value is
3390 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003391 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003392 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003393 * \param support_mki_value Enable or disable mki usage. Values are
3394 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3395 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003396 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003397void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3398 int support_mki_value );
Ron Eldor591f1622018-01-22 12:30:04 +02003399
3400/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003401 * \brief Set the supported DTLS-SRTP protection profiles.
3402 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003403 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003404 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3405 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003406 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003407 * The pointer to the list is recorded by the library
3408 * for later reference as required, so the lifetime
3409 * of the table must be at least as long as the lifetime
3410 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003411 * The list must not hold more than
3412 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003413 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01003414 *
Johan Pascal85269572020-08-25 10:01:54 +02003415 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003416 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
3417 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01003418 */
Ron Eldora9788042018-12-05 11:04:31 +02003419int mbedtls_ssl_conf_dtls_srtp_protection_profiles
3420 ( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02003421 const mbedtls_ssl_srtp_profile *profiles );
Ron Eldor591f1622018-01-22 12:30:04 +02003422
3423/**
Ron Eldora9788042018-12-05 11:04:31 +02003424 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02003425 *
Ron Eldora9788042018-12-05 11:04:31 +02003426 * \param ssl SSL context to use.
3427 * \param mki_value The MKI value to set.
3428 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02003429 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003430 * \note This function is relevant on client side only.
3431 * The server discovers the mki value during handshake.
3432 * A mki value set on server side using this function
3433 * is ignored.
3434 *
Johan Pascal85269572020-08-25 10:01:54 +02003435 * \return 0 on success
3436 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
3437 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02003438 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003439int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
3440 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02003441 uint16_t mki_len );
Johan Pascalb62bb512015-12-03 21:56:45 +01003442/**
Johan Pascal2258a4f2020-10-28 13:53:09 +01003443 * \brief Get the negotiated DTLS-SRTP informations:
3444 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003445 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003446 * \warning This function must be called after the handshake is
3447 * completed. The value returned by this function must
3448 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01003449 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003450 * \param ssl The SSL context to query.
3451 * \param dtls_srtp_info The negotiated DTLS-SRTP informations:
3452 * - Protection profile in use.
3453 * A direct mapping of the iana defined value for protection
3454 * profile on an uint16_t.
3455 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
3456 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
3457 * or peer's Hello packet was not parsed yet.
3458 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01003459 */
Johan Pascal2258a4f2020-10-28 13:53:09 +01003460void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
3461 mbedtls_dtls_srtp_info *dtls_srtp_info );
Johan Pascalb62bb512015-12-03 21:56:45 +01003462#endif /* MBEDTLS_SSL_DTLS_SRTP */
3463
Paul Bakker5701cdc2012-09-27 21:49:42 +00003464/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003465 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003466 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003468 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003469 * \note This ignores ciphersuites from higher versions.
3470 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003471 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003472 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003473 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003474 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Manuel Pégourié-Gonnard9371a402021-06-04 11:44:44 +02003475 * \param minor Minor version number (only MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003476 */
Ron Eldora9788042018-12-05 11:04:31 +02003477void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00003478
Paul Bakker1d29fb52012-09-28 13:28:45 +00003479/**
3480 * \brief Set the minimum accepted SSL/TLS protocol version
TRodziewicz0f82ec62021-05-12 17:49:18 +02003481 * (Default: TLS 1.2)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003482 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003483 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3484 * SSL_MIN_XXXXX_VERSION range is ignored.
3485 *
TRodziewicz4ca18aa2021-05-20 14:46:20 +02003486 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003487 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003488 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003489 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Manuel Pégourié-Gonnard9371a402021-06-04 11:44:44 +02003490 * \param minor Minor version number (only MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003491 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003492void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00003493
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003494#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003495/**
3496 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003497 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003498 *
3499 * \note This should always be enabled, it is a security
3500 * improvement, and should not cause any interoperability
3501 * issue (used only if the peer supports it too).
3502 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003503 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003504 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003505 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003506void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003510/**
3511 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003512 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003513 *
3514 * \note This should always be enabled, it is a security fix to the
3515 * protocol, and should not cause any interoperability issue
3516 * (used only if the peer supports it too).
3517 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003518 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003519 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003520 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003521void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003522#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003523
Janos Follath088ce432017-04-10 12:42:31 +01003524#if defined(MBEDTLS_SSL_SRV_C)
3525/**
3526 * \brief Whether to send a list of acceptable CAs in
3527 * CertificateRequest messages.
3528 * (Default: do send)
3529 *
3530 * \param conf SSL configuration
3531 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3532 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3533 */
3534void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3535 char cert_req_ca_list );
3536#endif /* MBEDTLS_SSL_SRV_C */
3537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003538#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003539/**
k-stachowiak6d722122019-02-08 17:03:33 +01003540 * \brief Set the maximum fragment length to emit and/or negotiate.
3541 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3542 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003543 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003544 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003545 * (Client: set maximum fragment length to emit *and*
3546 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003547 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003548 *
k-stachowiak6d722122019-02-08 17:03:33 +01003549 * \note On the client side, the maximum fragment length extension
3550 * *will not* be used, unless the maximum fragment length has
3551 * been set via this function to a value different than
3552 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003553 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003554 * \note With TLS, this currently only affects ApplicationData (sent
3555 * with \c mbedtls_ssl_read()), not handshake messages.
3556 * With DTLS, this affects both ApplicationData and handshake.
3557 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003558 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003559 * excluding record overhead that will be added to it, see
3560 * \c mbedtls_ssl_get_record_expansion().
3561 *
3562 * \note For DTLS, it is also possible to set a limit for the total
3563 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003564 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003565 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003566 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003567 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003568 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3569 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003570 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003571 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003572 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003573int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003574#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003575
TRodziewicz8476f2f2021-06-02 14:34:47 +02003576#if defined(MBEDTLS_SSL_SRV_C)
3577/**
TRodziewicz3946f792021-06-14 12:11:18 +02003578 * \brief Pick the ciphersuites order according to the second parameter
3579 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
3580 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02003581 *
3582 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02003583 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
3584 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02003585 */
TRodziewicz3946f792021-06-14 12:11:18 +02003586void mbedtls_ssl_conf_preference_order( mbedtls_ssl_config *conf, int order );
TRodziewicz8476f2f2021-06-02 14:34:47 +02003587#endif /* MBEDTLS_SSL_SRV_C */
3588
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003589#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003590/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003591 * \brief Enable / Disable session tickets (client only).
3592 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003593 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003594 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003595 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003596 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003597 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3598 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003599 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003600void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3601#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003602
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003604/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003605 * \brief Enable / Disable renegotiation support for connection when
3606 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003607 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003608 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003609 * \warning It is recommended to always disable renegotation unless you
3610 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003611 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003612 * renegotiation or a poor understanding of its properties.
3613 *
3614 * \note Server-side, enabling renegotiation also makes the server
3615 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003616 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003617 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003618 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3619 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003620 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003621void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003622#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003623
3624/**
3625 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003626 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003627 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003629 * be established even if the peer does not support
3630 * secure renegotiation, but does not allow renegotiation
3631 * to take place if not secure.
3632 * (Interoperable and secure option)
3633 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003634 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003635 * with non-upgraded peers. Allowing legacy renegotiation
3636 * makes the connection vulnerable to specific man in the
3637 * middle attacks. (See RFC 5746)
3638 * (Most interoperable and least secure option)
3639 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003640 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003641 * if peer does not support secure renegotiation. Results
3642 * in interoperability issues with non-upgraded peers
3643 * that do not support renegotiation altogether.
3644 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003645 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003646 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003647 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3648 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003649 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003650 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003651void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003652
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003653#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003654/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003655 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003656 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003657 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003658 * When we request a renegotiation, the peer can comply or
3659 * ignore the request. This function allows us to decide
3660 * whether to enforce our renegotiation requests by closing
3661 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003662 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003663 * However, records could already be in transit from the peer
3664 * when the request is emitted. In order to increase
3665 * reliability, we can accept a number of records before the
3666 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003667 *
3668 * The optimal value is highly dependent on the specific usage
3669 * scenario.
3670 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003671 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003672 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003673 * out or receives Application Data, until:
3674 * - max_records records have beens seen, if it is >= 0, or
3675 * - the number of retransmits that would happen during an
3676 * actual handshake has been reached.
3677 * Please remember the request might be lost a few times
3678 * if you consider setting max_records to a really low value.
3679 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003680 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003682 * which always behave as if max_record was 0. The reason is,
3683 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003684 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003685 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003686 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003687 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003688 * enforce renegotiation, or a non-negative value to enforce
3689 * it but allow for a grace period of max_records records.
3690 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003691void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003692
3693/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003694 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003695 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003696 *
3697 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003698 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003699 * threshold. The default value is meant to prevent the
3700 * connection from being closed when the counter is about to
3701 * reached its maximal value (it is not allowed to wrap).
3702 *
3703 * Lower values can be used to enforce policies such as "keys
3704 * must be refreshed every N packets with cipher X".
3705 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003706 * The renegotiation period can be disabled by setting
3707 * conf->disable_renegotiation to
3708 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3709 *
3710 * \note When the configured transport is
3711 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3712 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3713 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003714 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003715 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003716 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003717 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003718void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003719 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003720#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003721
Paul Bakker43ca69c2011-01-15 17:35:19 +00003722/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003723 * \brief Check if there is data already read from the
3724 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003725 *
3726 * \param ssl SSL context
3727 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003728 * \return 0 if nothing's pending, 1 otherwise.
3729 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003730 * \note This is different in purpose and behaviour from
3731 * \c mbedtls_ssl_get_bytes_avail in that it considers
3732 * any kind of unprocessed data, not only unread
3733 * application data. If \c mbedtls_ssl_get_bytes
3734 * returns a non-zero value, this function will
3735 * also signal pending data, but the converse does
3736 * not hold. For example, in DTLS there might be
3737 * further records waiting to be processed from
3738 * the current underlying transport's datagram.
3739 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003740 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003741 * does not imply that a subsequent call to
3742 * \c mbedtls_ssl_read will provide any data;
3743 * e.g., the unprocessed data might turn out
3744 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003745 *
3746 * \note This function is useful in the following situation:
3747 * If the SSL/TLS module successfully returns from an
3748 * operation - e.g. a handshake or an application record
3749 * read - and you're awaiting incoming data next, you
3750 * must not immediately idle on the underlying transport
3751 * to have data ready, but you need to check the value
3752 * of this function first. The reason is that the desired
3753 * data might already be read but not yet processed.
3754 * If, in contrast, a previous call to the SSL/TLS module
3755 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3756 * to call this function, as the latter error code entails
3757 * that all internal data has been processed.
3758 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003759 */
3760int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3761
3762/**
3763 * \brief Return the number of application data bytes
3764 * remaining to be read from the current record.
3765 *
3766 * \param ssl SSL context
3767 *
3768 * \return How many bytes are available in the application
3769 * data record read buffer.
3770 *
3771 * \note When working over a datagram transport, this is
3772 * useful to detect the current datagram's boundary
3773 * in case \c mbedtls_ssl_read has written the maximal
3774 * amount of data fitting into the input buffer.
3775 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003776 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003777size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003778
3779/**
3780 * \brief Return the result of the certificate verification
3781 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003782 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003783 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003784 * \return \c 0 if the certificate verification was successful.
3785 * \return \c -1u if the result is not available. This may happen
3786 * e.g. if the handshake aborts early, or a verification
3787 * callback returned a fatal error.
3788 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3789 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003790 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003791uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003792
3793/**
3794 * \brief Return the name of the current ciphersuite
3795 *
3796 * \param ssl SSL context
3797 *
3798 * \return a string containing the ciphersuite name
3799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003800const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003801
3802/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003803 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003804 *
3805 * \param ssl SSL context
3806 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003807 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003808 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003809const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003810
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003811/**
3812 * \brief Return the (maximum) number of bytes added by the record
3813 * layer: header + encryption/MAC overhead (inc. padding)
3814 *
3815 * \param ssl SSL context
3816 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01003817 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003818 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003819int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003820
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003821/**
3822 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003823 *
3824 * \note The logic to determine the maximum outgoing record payload is
3825 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02003826 * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003827 * such as the max fragment length or record size limit extension if
3828 * used, and for DTLS the path MTU as configured and current
3829 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003830 *
3831 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3832 * called with a larger length value.
3833 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3834 * necessary and return the number of bytes written; it is up
3835 * to the caller to call \c mbedtls_ssl_write() again in
3836 * order to send the remaining bytes if any.
3837 *
Hanno Becker80d163d2021-04-21 06:28:18 +01003838 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003839 * \sa mbedtls_ssl_get_record_expansion()
3840 *
3841 * \param ssl SSL context
3842 *
3843 * \return Current maximum payload for an outgoing record,
3844 * or a negative error code.
3845 */
3846int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3847
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003848/**
3849 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003850 *
3851 * \note The logic to determine the maximum outgoing record payload is
3852 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02003853 * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003854 * such as the max fragment length extension or record size limit
3855 * extension if used, and the current record expansion.
3856 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003857 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01003858 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003859 * \sa mbedtls_ssl_get_record_expansion()
3860 *
3861 * \param ssl SSL context
3862 *
3863 * \return Current maximum payload for an outgoing record,
3864 * or a negative error code.
3865 */
3866int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl );
3867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003868#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003869/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003870 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003871 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003872 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003873 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003874 * \return The current peer certificate, if available.
3875 * The returned certificate is owned by the SSL context and
3876 * is valid only until the next call to the SSL API.
3877 * \return \c NULL if no peer certificate is available. This might
3878 * be because the chosen ciphersuite doesn't use CRTs
3879 * (PSK-based ciphersuites, for example), or because
3880 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3881 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003882 *
3883 * \note For one-time inspection of the peer's certificate during
3884 * the handshake, consider registering an X.509 CRT verification
3885 * callback through mbedtls_ssl_conf_verify() instead of calling
3886 * this function. Using mbedtls_ssl_conf_verify() also comes at
3887 * the benefit of allowing you to influence the verification
3888 * process, for example by masking expected and tolerated
3889 * verification failures.
3890 *
3891 * \warning You must not use the pointer returned by this function
3892 * after any further call to the SSL API, including
3893 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3894 * because the pointer might change during renegotiation,
3895 * which happens transparently to the user.
3896 * If you want to use the certificate across API calls,
3897 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003898 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003899const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3900#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003901
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003902#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003903/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003904 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003905 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003906 * \param ssl The SSL context representing the connection for which to
3907 * to export a session structure for later resumption.
3908 * \param session The target structure in which to store the exported session.
3909 * This must have been initialized with mbedtls_ssl_init_session()
3910 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003911 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01003912 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003913 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01003914 * ticket-based resumption will be considered. For TLS 1.3,
3915 * once implemented, sessions equate to tickets, and calling
3916 * this function multiple times will export the available
3917 * tickets one a time until no further tickets are available,
3918 * in which case MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE will
3919 * be returned.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003920 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003921 * \note Calling this function multiple times will only be useful
3922 * once TLS 1.3 is supported. For TLS 1.2 connections, this
3923 * function should be called at most once.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003924 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003925 * \return \c 0 if successful. In this case, \p session can be used for
3926 * session resumption by passing it to mbedtls_ssl_set_session(),
3927 * and serialized for storage via mbedtls_ssl_session_save().
3928 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no further session
3929 * is available for export.
3930 * This error is a non-fatal, and has no observable effect on
3931 * the SSL context or the destination session.
3932 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003933 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003934 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003935 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003936 */
Hanno Beckere810bbc2021-05-14 16:01:05 +01003937int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
3938 mbedtls_ssl_session *session );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003939#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003940
3941/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003942 * \brief Perform the SSL handshake
3943 *
3944 * \param ssl SSL context
3945 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003946 * \return \c 0 if successful.
3947 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003948 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003949 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003950 * transport - in this case you must call this function again
3951 * when the underlying transport is ready for the operation.
3952 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3953 * operation is in progress (see
3954 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3955 * must call this function again when the operation is ready.
3956 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3957 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3958 * in this case you must call this function again to complete
3959 * the handshake when you're done attending other tasks.
3960 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3961 * and the client did not demonstrate reachability yet - in
3962 * this case you must stop using the context (see below).
3963 * \return Another SSL error code - in this case you must stop using
3964 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003965 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003966 * \warning If this function returns something other than
3967 * \c 0,
3968 * #MBEDTLS_ERR_SSL_WANT_READ,
3969 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3970 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3971 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3972 * you must stop using the SSL context for reading or writing,
3973 * and either free it or call \c mbedtls_ssl_session_reset()
3974 * on it before re-using it for a new connection; the current
3975 * connection must be closed.
3976 *
3977 * \note If DTLS is in use, then you may choose to handle
3978 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3979 * purposes, as it is an expected return value rather than an
3980 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003981 *
3982 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003983 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003984 * from the underlying transport layer is currently being processed,
3985 * and it is safe to idle until the timer or the underlying transport
3986 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003987 * in which case the datagram of the underlying transport that is
3988 * currently being processed might or might not contain further
3989 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003991int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003992
3993/**
Paul Bakker1961b702013-01-25 14:49:24 +01003994 * \brief Perform a single step of the SSL handshake
3995 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003996 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003997 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003998 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003999 *
4000 * \param ssl SSL context
4001 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004002 * \return See mbedtls_ssl_handshake().
4003 *
4004 * \warning If this function returns something other than \c 0,
4005 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4006 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4007 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4008 * the SSL context for reading or writing, and either free it
4009 * or call \c mbedtls_ssl_session_reset() on it before
4010 * re-using it for a new connection; the current connection
4011 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01004012 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004013int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01004014
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004015#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01004016/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01004017 * \brief Initiate an SSL renegotiation on the running connection.
4018 * Client: perform the renegotiation right now.
4019 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00004020 * during the next call to mbedtls_ssl_read() if honored by
4021 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00004022 *
4023 * \param ssl SSL context
4024 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00004025 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004026 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
4027 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004028 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004029 * \warning If this function returns something other than \c 0,
4030 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
4031 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4032 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
4033 * the SSL context for reading or writing, and either free it
4034 * or call \c mbedtls_ssl_session_reset() on it before
4035 * re-using it for a new connection; the current connection
4036 * must be closed.
4037 *
Paul Bakker48916f92012-09-16 19:57:18 +00004038 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004039int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
4040#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00004041
4042/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004043 * \brief Read at most 'len' application data bytes
4044 *
4045 * \param ssl SSL context
4046 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02004047 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00004048 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004049 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004050 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04004051 * without sending a CloseNotify beforehand, which might happen
4052 * because of various reasons (internal error of an underlying
4053 * stack, non-conformant peer not sending a CloseNotify and
4054 * such) - in this case you must stop using the context
4055 * (see below).
4056 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
4057 * transport is still functional, but the peer has
4058 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004059 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004060 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004061 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004062 * transport - in this case you must call this function again
4063 * when the underlying transport is ready for the operation.
4064 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4065 * operation is in progress (see
4066 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4067 * must call this function again when the operation is ready.
4068 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4069 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4070 * in this case you must call this function again to complete
4071 * the handshake when you're done attending other tasks.
4072 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
4073 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004074 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004075 * \return Another SSL error code - in this case you must stop using
4076 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004077 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004078 * \warning If this function returns something other than
4079 * a positive value,
4080 * #MBEDTLS_ERR_SSL_WANT_READ,
4081 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4082 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
4083 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
4084 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
4085 * you must stop using the SSL context for reading or writing,
4086 * and either free it or call \c mbedtls_ssl_session_reset()
4087 * on it before re-using it for a new connection; the current
4088 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004089 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004090 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004091 * (which can only happen server-side), it means that a client
4092 * is initiating a new connection using the same source port.
4093 * You can either treat that as a connection close and wait
4094 * for the client to resend a ClientHello, or directly
4095 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004096 * context (as it has been reset internally). Either way, you
4097 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02004098 * connection: application state, if any, should be reset, and
4099 * most importantly the identity of the client must be checked
4100 * again. WARNING: not validating the identity of the client
4101 * again, or not transmitting the new identity to the
4102 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01004103 *
Hanno Becker8ec81022017-10-10 10:35:08 +01004104 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004105 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01004106 * from the underlying transport layer is currently being processed,
4107 * and it is safe to idle until the timer or the underlying transport
4108 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01004109 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
4110 * initially available on the underlying transport, as this data may have
4111 * been only e.g. duplicated messages or a renegotiation request.
4112 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
4113 * when reacting to an incoming-data event from the underlying transport.
4114 * - On success, the datagram of the underlying transport that is currently
4115 * being processed may contain further DTLS records. You should call
4116 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01004117 *
Paul Bakker5121ce52009-01-03 21:22:43 +00004118 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004119int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00004120
4121/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004122 * \brief Try to write exactly 'len' application data bytes
4123 *
4124 * \warning This function will do partial writes in some cases. If the
4125 * return value is non-negative but less than length, the
4126 * function must be called again with updated arguments:
4127 * buf + ret, len - ret (if ret is the return value) until
4128 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00004129 *
4130 * \param ssl SSL context
4131 * \param buf buffer holding the data
4132 * \param len how many bytes must be written
4133 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004134 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004135 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004136 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02004137 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004138 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004139 * transport - in this case you must call this function again
4140 * when the underlying transport is ready for the operation.
4141 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
4142 * operation is in progress (see
4143 * mbedtls_ssl_conf_async_private_cb()) - in this case you
4144 * must call this function again when the operation is ready.
4145 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
4146 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
4147 * in this case you must call this function again to complete
4148 * the handshake when you're done attending other tasks.
4149 * \return Another SSL error code - in this case you must stop using
4150 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00004151 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02004152 * \warning If this function returns something other than
4153 * a non-negative value,
4154 * #MBEDTLS_ERR_SSL_WANT_READ,
4155 * #MBEDTLS_ERR_SSL_WANT_WRITE,
4156 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
4157 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
4158 * you must stop using the SSL context for reading or writing,
4159 * and either free it or call \c mbedtls_ssl_session_reset()
4160 * on it before re-using it for a new connection; the current
4161 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004162 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004163 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00004164 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004165 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02004166 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004167 * some partial data in the output buffer, however this is not
4168 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02004169 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00004170 * \note If the requested length is greater than the maximum
4171 * fragment length (either the built-in limit or the one set
4172 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02004173 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004174 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01004175 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04004176 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004177 *
4178 * \note Attempting to write 0 bytes will result in an empty TLS
4179 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004180 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004181int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00004182
4183/**
Paul Bakker0a925182012-04-16 06:46:41 +00004184 * \brief Send an alert message
4185 *
4186 * \param ssl SSL context
4187 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004188 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004189 * \param message The alert message (SSL_ALERT_MSG_*)
4190 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004191 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004192 *
4193 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004194 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4195 * the SSL context for reading or writing, and either free it or
4196 * call \c mbedtls_ssl_session_reset() on it before re-using it
4197 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004199int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004200 unsigned char level,
4201 unsigned char message );
4202/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004203 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004204 *
4205 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004206 *
4207 * \return 0 if successful, or a specific SSL error code.
4208 *
4209 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004210 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4211 * the SSL context for reading or writing, and either free it or
4212 * call \c mbedtls_ssl_session_reset() on it before re-using it
4213 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004215int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00004216
4217/**
Paul Bakker48916f92012-09-16 19:57:18 +00004218 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004219 *
4220 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00004221 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004222void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00004223
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004224#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004225/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004226 * \brief Save an active connection as serialized data in a buffer.
4227 * This allows the freeing or re-using of the SSL context
4228 * while still picking up the connection later in a way that
4229 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004230 *
4231 * \see mbedtls_ssl_context_load()
4232 *
4233 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004234 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004235 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
4236 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004237 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004238 * mbedtls_ssl_session_reset() on \p ssl which as a result is
4239 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004240 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004241 * state. You're then free to either re-use the context
4242 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004243 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004244 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004245 *
4246 * \param ssl The SSL context to save. On success, it is no longer
4247 * associated with the connection that has been serialized.
4248 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03004249 * writeable buffer of at least \p buf_len bytes, or may be \c
4250 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004251 * \param buf_len The number of bytes available for writing in \p buf.
4252 * \param olen The size in bytes of the data that has been or would have
4253 * been written. It must point to a valid \c size_t.
4254 *
4255 * \note \p olen is updated to the correct value regardless of
4256 * whether \p buf_len was large enough. This makes it possible
4257 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004258 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
4259 * the value of \p olen is only guaranteed to be correct when
4260 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
4261 * \c 0. If the return value is different, then the value of
4262 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004263 *
4264 * \return \c 0 if successful.
4265 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004266 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
4267 * while reseting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004268 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004269 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004270 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004271 * ciphersuite, or renegotiation is enabled.
4272 */
4273int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4274 unsigned char *buf,
4275 size_t buf_len,
4276 size_t *olen );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004277
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004278/**
4279 * \brief Load serialized connection data to an SSL context.
4280 *
4281 * \see mbedtls_ssl_context_save()
4282 *
4283 * \warning The same serialized data must never be loaded into more
4284 * that one context. In order to ensure that, after
4285 * successfully loading serialized data to an SSL context, you
4286 * should immediately destroy or invalidate all copies of the
4287 * serialized data that was loaded. Loading the same data in
4288 * more than one context would cause severe security failures
4289 * including but not limited to loss of confidentiality.
4290 *
4291 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004292 * prepared in one of the two following ways. The first way is
4293 * to take a context freshly initialised with
4294 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004295 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004296 * the original connection. The second way is to
4297 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004298 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004299 * Either way, you must not use the context to perform a
4300 * handshake between calling mbedtls_ssl_setup() or
4301 * mbedtls_ssl_session_reset() and calling this function. You
4302 * may however call other setter functions in that time frame
4303 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004304 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004305 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004306 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004307 * and settings before you can use the connection again
4308 * (unless they were already set before calling
4309 * mbedtls_ssl_session_reset() and the values are suitable for
4310 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02004311 * at least mbedtls_ssl_set_bio() and
4312 * mbedtls_ssl_set_timer_cb(). All other SSL setter functions
4313 * are not necessary to call, either because they're only used
4314 * in handshakes, or because the setting is already saved. You
4315 * might choose to call them anyway, for example in order to
4316 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004317 * connection and the case of loading an already-established
4318 * connection.
4319 *
4320 * \note If you have new information about the path MTU, you want to
4321 * call mbedtls_ssl_set_mtu() after calling this function, as
4322 * otherwise this function would overwrite your
4323 * newly-configured value with the value that was active when
4324 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004325 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004326 * \note When this function returns an error code, it calls
4327 * mbedtls_ssl_free() on \p ssl. In this case, you need to
4328 * prepare the context with the usual sequence starting with a
4329 * call to mbedtls_ssl_init() if you want to use it again.
4330 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004331 * \param ssl The SSL context structure to be populated. It must have
4332 * been prepared as described in the note above.
4333 * \param buf The buffer holding the serialized connection data. It must
4334 * be a readable buffer of at least \p len bytes.
4335 * \param len The size of the serialized data in bytes.
4336 *
4337 * \return \c 0 if successful.
4338 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004339 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
4340 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004341 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4342 */
4343int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
4344 const unsigned char *buf,
4345 size_t len );
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004346#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004347
4348/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004349 * \brief Initialize an SSL configuration context
4350 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004351 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004352 *
4353 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01004354 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004355 *
4356 * \param conf SSL configuration context
4357 */
4358void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
4359
4360/**
4361 * \brief Load reasonnable default SSL configuration values.
4362 * (You need to call mbedtls_ssl_config_init() first.)
4363 *
4364 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004365 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4366 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4367 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004368 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004369 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004370 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004371 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004372 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004373 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004374 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004375int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004376 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004377
4378/**
4379 * \brief Free an SSL configuration context
4380 *
4381 * \param conf SSL configuration context
4382 */
4383void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
4384
4385/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004386 * \brief Initialize SSL session structure
4387 *
4388 * \param session SSL session
4389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004390void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004391
4392/**
Paul Bakker0a597072012-09-25 21:55:46 +00004393 * \brief Free referenced items in an SSL session including the
4394 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004395 *
Ron Eldor00115032018-07-17 11:21:50 +03004396 * \note A session object can be freed even if the SSL context
4397 * that was used to retrieve the session is still in use.
4398 *
Paul Bakker48916f92012-09-16 19:57:18 +00004399 * \param session SSL session
4400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004401void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00004402
Ron Eldor51d3ab52019-05-12 14:54:30 +03004403/**
4404 * \brief TLS-PRF function for key derivation.
4405 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004406 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004407 * \param secret Secret for the key derivation function.
4408 * \param slen Length of the secret.
4409 * \param label String label for the key derivation function,
4410 * terminated with null character.
4411 * \param random Random bytes.
4412 * \param rlen Length of the random bytes buffer.
4413 * \param dstbuf The buffer holding the derived key.
4414 * \param dlen Length of the output buffer.
4415 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004416 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004417 */
4418int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
4419 const unsigned char *secret, size_t slen,
4420 const char *label,
4421 const unsigned char *random, size_t rlen,
4422 unsigned char *dstbuf, size_t dlen );
4423
Paul Bakker5121ce52009-01-03 21:22:43 +00004424#ifdef __cplusplus
4425}
4426#endif
4427
4428#endif /* ssl.h */