blob: 26edecfda45e17defbf6ddf097f6412977887890 [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 */
Dave Rodgmanc628fc92021-06-29 14:32:46 +010062#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020063#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
64#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
65#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
66#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
67#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
Hanno Becker2fe5f612021-06-24 09:08:57 +010068#define MBEDTLS_ERR_SSL_DECODE_ERROR -0x7300 /**< A message could not be parsed due to a syntactic error. */
Dave Rodgmanbb05cd02021-06-29 10:37:43 +010069/* Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
71#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
Dave Rodgman53c86892021-06-29 10:02:06 +010072#define MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION -0x7500 /**< Client received an extended server hello containing an unsupported extension */
73#define MBEDTLS_ERR_SSL_NO_APPLICATION_PROTOCOL -0x7580 /**< No ALPN protocols supported that the client advertises */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020074#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
75#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
76#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
77#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
Hanno Becker93636cc2021-06-24 09:32:17 +010078#define MBEDTLS_ERR_SSL_UNRECOGNIZED_NAME -0x7800 /**< No server could be identified matching the client's SNI. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020079#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
Hanno Becker90d59dd2021-06-24 11:17:13 +010080/* Error space gap */
Hanno Beckerc3411d42021-06-24 11:09:00 +010081/* Error space gap */
Hanno Becker9ed1ba52021-06-24 11:03:13 +010082#define MBEDTLS_ERR_SSL_BAD_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
Hanno Becker5697af02021-06-24 10:33:51 +010083/* Error space gap */
Hanno Beckercbc8f6f2021-06-24 10:32:31 +010084/* Error space gap */
Hanno Becker029cc2f2021-06-24 10:09:50 +010085/* Error space gap */
Hanno Becker666b5b42021-06-24 10:13:31 +010086/* Error space gap */
Hanno Beckerb24e74b2021-06-24 09:52:01 +010087/* Error space gap */
Hanno Beckerd3eec782021-06-24 10:21:46 +010088/* Error space gap */
Hanno Beckerd934a2a2021-06-24 10:23:45 +010089/* Error space gap */
Hanno Beckerd2002962021-06-24 10:25:40 +010090/* Error space gap */
Hanno Beckera0ca87e2021-06-24 10:27:37 +010091/* Error space gap */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020092#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020093#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
94#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
Hanno Beckerbc000442021-06-24 09:18:19 +010095#define MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
Hanno Beckerb561bed2021-06-24 16:41:01 +010096#define MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE -0x6E00 /**< The handshake negotiation failed. */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020097#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
98#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
99#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
100#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
101#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
102#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
103#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
104#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
Dave Rodgman096c4112021-06-29 09:52:06 +0100105/* Error space gap */
Hanno Becker8ec81022017-10-10 10:35:08 +0100106#define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< No data of requested type currently available on underlying transport. */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100107#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
108#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200109#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +0100110#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100111#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
Hanno Becker2fe5f612021-06-24 09:08:57 +0100112#define MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER -0x6600 /**< A field in a message was incorrect or inconsistent with other fields. */
Hanno Becker8ec81022017-10-10 10:35:08 +0100113#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580 /**< Internal-only message signaling that further message-processing should be done */
Gilles Peskineb44692f2018-04-24 12:18:19 +0200114#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100115#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Dave Rodgmanc628fc92021-06-29 14:32:46 +0100116/* Error space gap */
117/* Error space gap */
118/* Error space gap */
119/* Error space gap */
120/* Error space gap */
121/* Error space gap */
122/* Error space gap */
123/* Error space gap */
Hanno Beckerc37c96a2019-05-14 11:02:36 +0100124#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000 /**< An encrypted DTLS-frame with an unexpected CID was received. */
Hanno Beckerf9b33032019-06-03 12:58:39 +0100125#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00 /**< An operation failed due to an unexpected version or configuration. */
Hanno Beckerb4c0b752017-04-12 14:54:42 +0100126#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80 /**< Invalid value in SSL config */
Paul Bakker5121ce52009-01-03 21:22:43 +0000127
128/*
129 * Various constants
130 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100131
132/* These are the high an low bytes of ProtocolVersion as defined by:
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100133 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
134 * - RFC 8446: see section 4.2.1
135 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200136#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200137#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Hanno Becker2ab47dc2020-05-04 12:19:12 +0100138#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 (experimental) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200140#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
141#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100142
Simon Butcher9f812312015-09-28 19:22:33 +0100143#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200144#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
145
146#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 +0100147
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200148/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200149 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
151#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
152#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
153#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
154#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
155#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157#define MBEDTLS_SSL_IS_CLIENT 0
158#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
161#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200162
Hanno Becker019f4b52019-04-09 15:12:56 +0100163#define MBEDTLS_SSL_CID_DISABLED 0
164#define MBEDTLS_SSL_CID_ENABLED 1
165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166#define MBEDTLS_SSL_ETM_DISABLED 0
167#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171#define MBEDTLS_SSL_VERIFY_NONE 0
172#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
173#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200174#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
177#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000178
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200179#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
180#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000181
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200182#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
183#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200185#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
186#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
189#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
190#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
193#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
194#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200195
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200196#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
197#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200198
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200199#define MBEDTLS_SSL_PRESET_DEFAULT 0
200#define MBEDTLS_SSL_PRESET_SUITEB 2
201
Janos Follath088ce432017-04-10 12:42:31 +0100202#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
203#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
204
Ron Eldor591f1622018-01-22 12:30:04 +0200205#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
206#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
207
TRodziewicz3946f792021-06-14 12:11:18 +0200208#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
209#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200210
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200211/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200212 * Default range for DTLS retransmission timer value, in milliseconds.
213 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
214 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200215#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
216#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200217
Paul Bakker088c5c52014-04-25 11:11:10 +0200218/**
219 * \name SECTION: Module settings
220 *
221 * The configuration options you can set for this module are in this section.
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +0200222 * Either change them in mbedtls_config.h or define them on the compiler command line.
Paul Bakker088c5c52014-04-25 11:11:10 +0200223 * \{
224 */
225
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200226/*
Angus Grattond8213d02016-05-25 20:56:48 +1000227 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200228 * determines the size of each of the two internal I/O buffers.
229 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200230 * Note: the RFC defines the default size of SSL / TLS messages. If you
231 * change the value here, other clients / servers may not be able to
232 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200233 * both sides of the connection and have it reduced at both sides, or
234 * if you're using the Max Fragment Length extension and you know all your
235 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200236 */
Angus Grattond8213d02016-05-25 20:56:48 +1000237#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100238#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000239#endif
240
241#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100242#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000243#endif
244
Hanno Becker28007512018-08-28 09:46:44 +0100245/*
246 * Maximum number of heap-allocated bytes for the purpose of
247 * DTLS handshake message reassembly and future message buffering.
248 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100249#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100250#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100251#endif
252
Hanno Becker019f4b52019-04-09 15:12:56 +0100253/*
254 * Maximum length of CIDs for incoming and outgoing messages.
255 */
256#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100257#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100258#endif
259
260#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
261#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
262#endif
263
TRodziewicze8dd7092021-05-12 14:19:11 +0200264#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
265#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100266#endif
267
Paul Bakker088c5c52014-04-25 11:11:10 +0200268/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000269
270/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100271 * Length of the verify data for secure renegotiation
272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100274
275/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200276 * Signaling ciphersuite values (SCSV)
277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000279
Paul Bakker5121ce52009-01-03 21:22:43 +0000280/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000281 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200282 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284#define MBEDTLS_SSL_HASH_NONE 0
285#define MBEDTLS_SSL_HASH_MD5 1
286#define MBEDTLS_SSL_HASH_SHA1 2
287#define MBEDTLS_SSL_HASH_SHA224 3
288#define MBEDTLS_SSL_HASH_SHA256 4
289#define MBEDTLS_SSL_HASH_SHA384 5
290#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000291
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200292#define MBEDTLS_SSL_SIG_ANON 0
293#define MBEDTLS_SSL_SIG_RSA 1
294#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000295
296/*
Paul Bakker926af752012-11-23 13:38:07 +0100297 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200298 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100299 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200300#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
301#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100302
303/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000304 * Message, alert and handshake types
305 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
307#define MBEDTLS_SSL_MSG_ALERT 21
308#define MBEDTLS_SSL_MSG_HANDSHAKE 22
309#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100310#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200312#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
313#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000314
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200315#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
316#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
317#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
318#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
319#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
320#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
321#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
322#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
323#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
324#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
325#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
326#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
327#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
328#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
329#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
330#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
331#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
332#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
333#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
334#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
335#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
336#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
337#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
338#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
339#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
340#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
341#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
342#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
343#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
346#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
347#define MBEDTLS_SSL_HS_SERVER_HELLO 2
348#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
349#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
350#define MBEDTLS_SSL_HS_CERTIFICATE 11
351#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
352#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
353#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
354#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
355#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
356#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000357
358/*
359 * TLS extensions
360 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361#define MBEDTLS_TLS_EXT_SERVERNAME 0
362#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200365
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
369#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100372
Johan Pascalb62bb512015-12-03 21:56:45 +0100373#define MBEDTLS_TLS_EXT_USE_SRTP 14
374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
378#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200381
Hanno Becker0652bc52019-04-25 16:24:57 +0100382/* The value of the CID extension is still TBD as of
Hanno Beckerebcc9132019-05-15 10:26:32 +0100383 * draft-ietf-tls-dtls-connection-id-05
384 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) */
Hanno Becker064b7322019-05-03 12:42:13 +0100385#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker0652bc52019-04-25 16:24:57 +0100386
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200387#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000390
Johan Pascalb62bb512015-12-03 21:56:45 +0100391/*
Paul Bakkered27a042013-04-18 22:46:23 +0200392 * Size defines
393 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200394#if !defined(MBEDTLS_PSK_MAX_LEN)
395#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200396#endif
397
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200398/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200399union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200400{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200402 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
403#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
405 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200406#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200407#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
408 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
409 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
410 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
411 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200412#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200413#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
414 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200415#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200416#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
417 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
418 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200419#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
421 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200422#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
424 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
425 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200426#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200427#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
428 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
429#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200430};
431
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200432#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200433
Paul Bakker407a0da2013-06-27 14:29:21 +0200434#ifdef __cplusplus
435extern "C" {
436#endif
437
Paul Bakkered27a042013-04-18 22:46:23 +0200438/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000439 * SSL state machine
440 */
441typedef enum
442{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443 MBEDTLS_SSL_HELLO_REQUEST,
444 MBEDTLS_SSL_CLIENT_HELLO,
445 MBEDTLS_SSL_SERVER_HELLO,
446 MBEDTLS_SSL_SERVER_CERTIFICATE,
447 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
448 MBEDTLS_SSL_CERTIFICATE_REQUEST,
449 MBEDTLS_SSL_SERVER_HELLO_DONE,
450 MBEDTLS_SSL_CLIENT_CERTIFICATE,
451 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
452 MBEDTLS_SSL_CERTIFICATE_VERIFY,
453 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
454 MBEDTLS_SSL_CLIENT_FINISHED,
455 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
456 MBEDTLS_SSL_SERVER_FINISHED,
457 MBEDTLS_SSL_FLUSH_BUFFERS,
458 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
459 MBEDTLS_SSL_HANDSHAKE_OVER,
460 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
461 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000462}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200463mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000464
Simon Butchere846b512016-03-01 17:31:49 +0000465/**
466 * \brief Callback type: send data on the network.
467 *
468 * \note That callback may be either blocking or non-blocking.
469 *
470 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000471 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000472 * \param len Length of the data to send
473 *
474 * \return The callback must return the number of bytes sent if any,
475 * or a non-zero error code.
476 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
477 * must be returned when the operation would block.
478 *
Simon Butcherd567a232016-03-09 20:19:21 +0000479 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000480 * It must always return the number of bytes actually sent.
481 */
482typedef int mbedtls_ssl_send_t( void *ctx,
483 const unsigned char *buf,
484 size_t len );
485
486/**
487 * \brief Callback type: receive data from the network.
488 *
489 * \note That callback may be either blocking or non-blocking.
490 *
491 * \param ctx Context for the receive callback (typically a file
492 * descriptor)
493 * \param buf Buffer to write the received data to
494 * \param len Length of the receive buffer
495 *
496 * \return The callback must return the number of bytes received,
497 * or a non-zero error code.
498 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
499 * must be returned when the operation would block.
500 *
Simon Butcherd567a232016-03-09 20:19:21 +0000501 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000502 * buffer. It must always return the number of bytes actually
503 * received and written to the buffer.
504 */
505typedef int mbedtls_ssl_recv_t( void *ctx,
506 unsigned char *buf,
507 size_t len );
508
509/**
510 * \brief Callback type: receive data from the network, with timeout
511 *
512 * \note That callback must block until data is received, or the
513 * timeout delay expires, or the operation is interrupted by a
514 * signal.
515 *
516 * \param ctx Context for the receive callback (typically a file descriptor)
517 * \param buf Buffer to write the received data to
518 * \param len Length of the receive buffer
519 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000520 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000521 *
522 * \return The callback must return the number of bytes received,
523 * or a non-zero error code:
524 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
525 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
526 *
Simon Butcherd567a232016-03-09 20:19:21 +0000527 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000528 * buffer. It must always return the number of bytes actually
529 * received and written to the buffer.
530 */
531typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
532 unsigned char *buf,
533 size_t len,
534 uint32_t timeout );
535/**
536 * \brief Callback type: set a pair of timers/delays to watch
537 *
538 * \param ctx Context pointer
539 * \param int_ms Intermediate delay in milliseconds
540 * \param fin_ms Final delay in milliseconds
541 * 0 cancels the current timer.
542 *
543 * \note This callback must at least store the necessary information
544 * for the associated \c mbedtls_ssl_get_timer_t callback to
545 * return correct information.
546 *
547 * \note If using a event-driven style of programming, an event must
548 * be generated when the final delay is passed. The event must
549 * cause a call to \c mbedtls_ssl_handshake() with the proper
550 * SSL context to be scheduled. Care must be taken to ensure
551 * that at most one such call happens at a time.
552 *
553 * \note Only one timer at a time must be running. Calling this
554 * function while a timer is running must cancel it. Cancelled
555 * timers must not generate any event.
556 */
557typedef void mbedtls_ssl_set_timer_t( void * ctx,
558 uint32_t int_ms,
559 uint32_t fin_ms );
560
561/**
562 * \brief Callback type: get status of timers/delays
563 *
564 * \param ctx Context pointer
565 *
566 * \return This callback must return:
567 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000568 * 0 if none of the delays have passed,
569 * 1 if only the intermediate delay has passed,
570 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000571 */
572typedef int mbedtls_ssl_get_timer_t( void * ctx );
573
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200574/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575typedef struct mbedtls_ssl_session mbedtls_ssl_session;
576typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200577typedef struct mbedtls_ssl_config mbedtls_ssl_config;
578
Chris Jones3848e312021-03-11 16:17:59 +0000579/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
581typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100582typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583#if defined(MBEDTLS_X509_CRT_PARSE_C)
584typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200585#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200586#if defined(MBEDTLS_SSL_PROTO_DTLS)
587typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200588#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000589
Hanno Becker02487852021-05-13 06:26:57 +0100590/**
591 * \brief Callback type: server-side session cache getter
592 *
593 * The session cache is logically a key value store, with
594 * keys being session IDs and values being instances of
595 * mbedtls_ssl_session.
596 *
597 * This callback retrieves an entry in this key-value store.
598 *
599 * \param data The address of the session cache structure to query.
600 * \param session_id The buffer holding the session ID to query.
601 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100602 * \param session The address of the session structure to populate.
603 * It is initialized with mbdtls_ssl_session_init(),
604 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100605 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100606 * mbedtls_ssl_session_free() independent of the
607 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100608 *
609 * \return \c 0 on success
610 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100611 *
Hanno Becker02487852021-05-13 06:26:57 +0100612 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100613typedef int mbedtls_ssl_cache_get_t( void *data,
614 unsigned char const *session_id,
615 size_t session_id_len,
616 mbedtls_ssl_session *session );
Hanno Becker02487852021-05-13 06:26:57 +0100617/**
618 * \brief Callback type: server-side session cache setter
619 *
620 * The session cache is logically a key value store, with
621 * keys being session IDs and values being instances of
622 * mbedtls_ssl_session.
623 *
624 * This callback sets an entry in this key-value store.
625 *
626 * \param data The address of the session cache structure to modify.
627 * \param session_id The buffer holding the session ID to query.
628 * \param session_id_len The length of \p session_id in Bytes.
629 * \param session The address of the session to be stored in the
630 * session cache.
631 *
632 * \return \c 0 on success
633 * \return A non-zero return value on failure.
634 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100635typedef int mbedtls_ssl_cache_set_t( void *data,
636 unsigned char const *session_id,
637 size_t session_id_len,
638 const mbedtls_ssl_session *session );
Hanno Beckera637ff62021-04-15 08:42:48 +0100639
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200640#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100641#if defined(MBEDTLS_X509_CRT_PARSE_C)
642/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200643 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100644 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200645 * This callback is called during an SSL handshake to start
646 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200647 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100648 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200649 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100650 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200651 * This function typically sends or enqueues a request, and
652 * does not wait for the operation to complete. This allows
653 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100654 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200655 * The parameters \p ssl and \p cert are guaranteed to remain
656 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200657 * function must save the contents of \p hash if the value
658 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200659 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100660 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200661 * This function may call mbedtls_ssl_set_async_operation_data()
662 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200663 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200664 *
Gilles Peskined3268832018-04-26 06:23:59 +0200665 * \note For RSA signatures, this function must produce output
666 * that is consistent with PKCS#1 v1.5 in the same way as
667 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
668 * apply the padding steps described in RFC 8017, section 9.2
669 * "EMSA-PKCS1-v1_5" as follows.
670 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
671 * encoding, treating \p hash as the DigestInfo to be
672 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
673 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200674 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200675 * encoding, treating \p hash as the hash to be encoded and
676 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
677 * from step 2, with `digestAlgorithm` obtained by calling
678 * mbedtls_oid_get_oid_by_md() on \p md_alg.
679 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200680 * \note For ECDSA signatures, the output format is the DER encoding
681 * `Ecdsa-Sig-Value` defined in
682 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
683 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200684 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200685 * modified other than via
686 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200687 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200688 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200689 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200690 * connection. However, if other callbacks are used, this
691 * property may not hold. For example, if an SNI callback
692 * is registered with mbedtls_ssl_conf_sni(), then
693 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200694 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100695 * \param hash Buffer containing the hash. This buffer is
696 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200697 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100698 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200699 * \return 0 if the operation was started successfully and the SSL
700 * stack should call the resume callback immediately.
701 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
702 * was started successfully and the SSL stack should return
703 * immediately without calling the resume callback yet.
704 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
705 * processor does not support this key. The SSL stack will
706 * use the private key object instead.
707 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200708 * propagated up the call chain. The callback should
709 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
710 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200711 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100712 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200713typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100714 mbedtls_x509_crt *cert,
715 mbedtls_md_type_t md_alg,
716 const unsigned char *hash,
717 size_t hash_len );
718
719/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200720 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100721 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200722 * This callback is called during an SSL handshake to start
723 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200724 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100725 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200726 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100727 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200728 * This function typically sends or enqueues a request, and
729 * does not wait for the operation to complete. This allows
730 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100731 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200732 * The parameters \p ssl and \p cert are guaranteed to remain
733 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200734 * function must save the contents of \p input if the value
735 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200736 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100737 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200738 * This function may call mbedtls_ssl_set_async_operation_data()
739 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200740 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200741 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200742 * \warning RSA decryption as used in TLS is subject to a potential
743 * timing side channel attack first discovered by Bleichenbacher
744 * in 1998. This attack can be remotely exploitable
745 * in practice. To avoid this attack, you must ensure that
746 * if the callback performs an RSA decryption, the time it
747 * takes to execute and return the result does not depend
748 * on whether the RSA decryption succeeded or reported
749 * invalid padding.
750 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200751 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200752 * modified other than via
753 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200754 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200755 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200756 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200757 * connection. However, if other callbacks are used, this
758 * property may not hold. For example, if an SNI callback
759 * is registered with mbedtls_ssl_conf_sni(), then
760 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100761 * \param input Buffer containing the input ciphertext. This buffer
762 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200763 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100764 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200765 * \return 0 if the operation was started successfully and the SSL
766 * stack should call the resume callback immediately.
767 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
768 * was started successfully and the SSL stack should return
769 * immediately without calling the resume callback yet.
770 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
771 * processor does not support this key. The SSL stack will
772 * use the private key object instead.
773 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200774 * propagated up the call chain. The callback should
775 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
776 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200777 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100778 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200779typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100780 mbedtls_x509_crt *cert,
781 const unsigned char *input,
782 size_t input_len );
783#endif /* MBEDTLS_X509_CRT_PARSE_C */
784
785/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200786 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100787 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200788 * This callback is called during an SSL handshake to resume
789 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200790 * ::mbedtls_ssl_async_sign_t or
791 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200792 *
793 * This function typically checks the status of a pending
794 * request or causes the request queue to make progress, and
795 * does not wait for the operation to complete. This allows
796 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100797 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200798 * This function may call mbedtls_ssl_get_async_operation_data()
799 * to retrieve an operation context set by the start callback.
800 * It may call mbedtls_ssl_set_async_operation_data() to modify
801 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200802 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200803 * Note that when this function returns a status other than
804 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
805 * resources associated with the operation.
806 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200807 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200808 * modified other than via
809 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200810 * \param output Buffer containing the output (signature or decrypted
811 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200812 * \param output_len On success, number of bytes written to \p output.
813 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100814 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200815 * \return 0 if output of the operation is available in the
816 * \p output buffer.
817 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
818 * is still in progress. Subsequent requests for progress
819 * on the SSL connection will call the resume callback
820 * again.
821 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200822 * The SSL handshake is aborted. The callback should
823 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
824 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200825 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100826 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200827typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100828 unsigned char *output,
829 size_t *output_len,
830 size_t output_size );
831
832/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200833 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100834 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200835 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200836 * while an asynchronous operation is in progress. Note that
837 * this callback is not called if the
838 * ::mbedtls_ssl_async_resume_t callback has run and has
839 * returned a value other than
840 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
841 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100842 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200843 * This function may call mbedtls_ssl_get_async_operation_data()
844 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200845 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200846 * \param ssl The SSL connection instance. It should not be
847 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100848 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200849typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200850#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000851
Gilles Peskineeccd8882020-03-10 12:19:08 +0100852#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000853 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000854#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
855#if defined(MBEDTLS_SHA256_C)
856#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
857#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +0200858#elif defined(MBEDTLS_SHA384_C)
Hanno Becker9198ad12019-02-05 17:00:50 +0000859#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
860#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
861#elif defined(MBEDTLS_SHA1_C)
862#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
863#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
864#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000865/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000866#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
867#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +0100868#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000869 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000870
Johan Pascalb62bb512015-12-03 21:56:45 +0100871#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +0200872
Johan Pascal85269572020-08-25 10:01:54 +0200873#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +0200874#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +0100875/*
Johan Pascal43f94902020-09-22 12:25:52 +0200876 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200877 *
878 * Use_srtp extension protection profiles values as defined in
879 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
880 *
881 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
882 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +0100883 */
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200884#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ( (uint16_t) 0x0001)
885#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ( (uint16_t) 0x0002)
886#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ( (uint16_t) 0x0005)
887#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ( (uint16_t) 0x0006)
888/* This one is not iana defined, but for code readability. */
889#define MBEDTLS_TLS_SRTP_UNSET ( (uint16_t) 0x0000)
890
Johan Pascal43f94902020-09-22 12:25:52 +0200891typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +0300892
Ron Eldor3adb9922017-12-21 10:15:08 +0200893typedef struct mbedtls_dtls_srtp_info_t
894{
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200895 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200896 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +0200897 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200898 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200899 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200900 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +0300901}
902mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +0200903
Johan Pascalb62bb512015-12-03 21:56:45 +0100904#endif /* MBEDTLS_SSL_DTLS_SRTP */
905
Paul Bakker5121ce52009-01-03 21:22:43 +0000906/*
Paul Bakker0a597072012-09-25 21:55:46 +0000907 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200908 *
909 * Note: when changing this definition, we need to check and update:
910 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +0200911 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200912 * - in library/ssl_tls.c:
913 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
914 * mbedtls_ssl_session_save() and ssl_session_load()
915 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000916 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200917struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000918{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200919#if defined(MBEDTLS_HAVE_TIME)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200920 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200921#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200922 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
923 int MBEDTLS_PRIVATE(compression); /*!< chosen compression */
924 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
925 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
926 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200927
Hanno Beckere810bbc2021-05-14 16:01:05 +0100928 unsigned char exported;
929
Hanno Becker57723132021-08-01 19:40:44 +0100930 /* This field is temporarily duplicated with mbedtls_ssl_context.minor_ver.
931 * Once runtime negotiation of TLS 1.2 and TLS 1.3 is implemented, it needs
932 * to be studied whether one of them can be removed. */
Hanno Beckerfadbdbb2021-07-23 06:25:48 +0100933 unsigned char MBEDTLS_PRIVATE(minor_ver); /*!< The TLS version used in the session. */
934
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200935#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000936#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200937 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000938#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000939 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
940 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +0200941 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
942 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
943 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +0000944#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200945#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200946 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200947
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200948#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200949 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
950 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
951 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200952#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200953
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200954#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200955 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200956#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200957
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200958#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200959 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100960#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000961};
962
Hanno Becker457d6162021-05-24 10:27:39 +0100963/*
964 * Identifiers for PRFs used in various versions of TLS.
965 */
966typedef enum
967{
968 MBEDTLS_SSL_TLS_PRF_NONE,
Hanno Becker457d6162021-05-24 10:27:39 +0100969 MBEDTLS_SSL_TLS_PRF_SHA384,
970 MBEDTLS_SSL_TLS_PRF_SHA256,
971 MBEDTLS_SSL_HKDF_EXPAND_SHA384,
972 MBEDTLS_SSL_HKDF_EXPAND_SHA256
973}
974mbedtls_tls_prf_types;
975
976#if defined(MBEDTLS_SSL_EXPORT_KEYS)
977typedef enum
978{
979 MBEDTLS_SSL_KEY_EXPORT_TLS12_MASTER_SECRET = 0,
980#if defined(MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL)
981 MBEDTLS_SSL_KEY_EXPORT_TLS13_CLIENT_EARLY_SECRET,
982 MBEDTLS_SSL_KEY_EXPORT_TLS13_EARLY_EXPORTER_SECRET,
983 MBEDTLS_SSL_KEY_EXPORT_TLS13_CLIENT_HANDSHAKE_TRAFFIC_SECRET,
984 MBEDTLS_SSL_KEY_EXPORT_TLS13_SERVER_HANDSHAKE_TRAFFIC_SECRET,
985 MBEDTLS_SSL_KEY_EXPORT_TLS13_CLIENT_APPLICATION_TRAFFIC_SECRET,
986 MBEDTLS_SSL_KEY_EXPORT_TLS13_SERVER_APPLICATION_TRAFFIC_SECRET,
987#endif /* MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL */
988} mbedtls_ssl_key_export_type;
989
990/**
991 * \brief Callback type: Export key alongside random values for
992 * session identification, and PRF for
993 * implementation of TLS key exporters.
994 *
Hanno Beckerddc739c2021-05-28 05:10:38 +0100995 * \param p_expkey Context for the callback.
996 * \param type The type of the key that is being exported.
997 * \param secret The address of the buffer holding the secret
998 * that's being exporterd.
999 * \param secret_len The length of \p secret in bytes.
Hanno Becker457d6162021-05-24 10:27:39 +01001000 * \param client_random The client random bytes.
1001 * \param server_random The server random bytes.
1002 * \param tls_prf_type The identifier for the PRF used in the handshake
1003 * to which the key belongs.
Hanno Becker457d6162021-05-24 10:27:39 +01001004 */
Hanno Beckere0dad722021-06-11 15:38:37 +01001005typedef void mbedtls_ssl_export_keys_t( void *p_expkey,
1006 mbedtls_ssl_key_export_type type,
1007 const unsigned char *secret,
1008 size_t secret_len,
1009 const unsigned char client_random[32],
1010 const unsigned char server_random[32],
1011 mbedtls_tls_prf_types tls_prf_type );
Hanno Becker457d6162021-05-24 10:27:39 +01001012#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1013
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001014/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001015 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001016 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001017struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001018{
1019 /* Group items by size (largest first) to minimize padding overhead */
1020
1021 /*
1022 * Pointers
1023 */
1024
Hanno Beckerd60b6c62021-04-29 12:04:11 +01001025 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +02001026 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001027
1028 /** Callback for printing debug output */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001029 void (*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
1030 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001031
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001032 /** Callback for getting (pseudo-)random numbers */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001033 int (*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
1034 void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001035
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001036 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001037 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001038 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001039 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
1040 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001041
1042#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1043 /** Callback for setting cert according to SNI extension */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001044 int (*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1045 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001046#endif
1047
1048#if defined(MBEDTLS_X509_CRT_PARSE_C)
1049 /** Callback to customize X.509 certificate chain verification */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001050 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1051 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001052#endif
1053
Gilles Peskineeccd8882020-03-10 12:19:08 +01001054#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001055 /** Callback to retrieve PSK key from identity */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001056 int (*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1057 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001058#endif
1059
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001060#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001061 /** Callback to create & write a cookie for ClientHello veirifcation */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001062 int (*MBEDTLS_PRIVATE(f_cookie_write))( void *, unsigned char **, unsigned char *,
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001063 const unsigned char *, size_t );
1064 /** Callback to verify validity of a ClientHello cookie */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001065 int (*MBEDTLS_PRIVATE(f_cookie_check))( void *, const unsigned char *, size_t,
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001066 const unsigned char *, size_t );
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001067 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001068#endif
1069
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001070#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001071 /** Callback to create & write a session ticket */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001072 int (*MBEDTLS_PRIVATE(f_ticket_write))( void *, const mbedtls_ssl_session *,
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001073 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1074 /** Callback to parse a session ticket into a session structure */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001075 int (*MBEDTLS_PRIVATE(f_ticket_parse))( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1076 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001077#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001078
Hanno Beckera0e20d02019-05-15 14:03:01 +01001079#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001080 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001081#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001082
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001083#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001084 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1085 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1086 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1087 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001088#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001089 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1090 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001091#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001092#endif /* MBEDTLS_X509_CRT_PARSE_C */
1093
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001094#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001095#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001096 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
1097 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start); /*!< start asynchronous decryption operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001098#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001099 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1100 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1101 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001102#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001103
Gilles Peskineeccd8882020-03-10 12:19:08 +01001104#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001105 const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001106#endif
1107
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001108#if defined(MBEDTLS_ECP_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001109 const mbedtls_ecp_group_id *MBEDTLS_PRIVATE(curve_list); /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001110#endif
1111
1112#if defined(MBEDTLS_DHM_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001113 mbedtls_mpi MBEDTLS_PRIVATE(dhm_P); /*!< prime modulus for DHM */
1114 mbedtls_mpi MBEDTLS_PRIVATE(dhm_G); /*!< generator for DHM */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001115#endif
1116
Gilles Peskineeccd8882020-03-10 12:19:08 +01001117#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001118
1119#if defined(MBEDTLS_USE_PSA_CRYPTO)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001120 psa_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Ronald Croncf56a0a2020-08-04 09:51:30 +02001121 * should only be set via
1122 * mbedtls_ssl_conf_psk_opaque().
1123 * If either no PSK or a raw PSK have been
1124 * configured, this has value \c 0.
1125 */
Hanno Becker43633132018-10-22 15:31:03 +01001126#endif /* MBEDTLS_USE_PSA_CRYPTO */
1127
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001128 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Hanno Becker43633132018-10-22 15:31:03 +01001129 * only be set via mbedtls_ssl_conf_psk().
1130 * If either no PSK or an opaque PSK
1131 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001132 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Hanno Becker43633132018-10-22 15:31:03 +01001133 * This field should only be set via
1134 * mbedtls_ssl_conf_psk().
1135 * Its value is non-zero if and only if
1136 * \c psk is not \c NULL. */
1137
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001138 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Hanno Becker43633132018-10-22 15:31:03 +01001139 * This field should only be set via
1140 * mbedtls_ssl_conf_psk().
1141 * This is set if and only if either
1142 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001143 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Hanno Becker43633132018-10-22 15:31:03 +01001144 * This field should only be set via
1145 * mbedtls_ssl_conf_psk().
1146 * Its value is non-zero if and only if
1147 * \c psk is not \c NULL or \c psk_opaque
1148 * is not \c 0. */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001149#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001150
1151#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001152 const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001153#endif
1154
Johan Pascalbbc057a2016-02-04 22:07:32 +01001155#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001156 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001157 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001158 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001159 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001160#endif /* MBEDTLS_SSL_DTLS_SRTP */
1161
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001162 /*
1163 * Numerical settings (int then char)
1164 */
1165
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001166 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001167
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001168#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001169 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001170 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001171 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001172 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001173#endif
1174
1175#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001176 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1177 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001178 that triggers renegotiation */
1179#endif
1180
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001181 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001182
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001183#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001184 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen); /*!< min. bit length of the DHM prime */
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001185#endif
1186
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001187 unsigned char MBEDTLS_PRIVATE(max_major_ver); /*!< max. major version used */
1188 unsigned char MBEDTLS_PRIVATE(max_minor_ver); /*!< max. minor version used */
1189 unsigned char MBEDTLS_PRIVATE(min_major_ver); /*!< min. major version used */
1190 unsigned char MBEDTLS_PRIVATE(min_minor_ver); /*!< min. minor version used */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001191
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001192 /*
1193 * Flags (bitfields)
1194 */
1195
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001196 unsigned int MBEDTLS_PRIVATE(endpoint) : 1; /*!< 0: client, 1: server */
1197 unsigned int MBEDTLS_PRIVATE(transport) : 1; /*!< stream (TLS) or datagram (DTLS) */
1198 unsigned int MBEDTLS_PRIVATE(authmode) : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001199 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001200 unsigned int MBEDTLS_PRIVATE(allow_legacy_renegotiation) : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001201#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001202 unsigned int MBEDTLS_PRIVATE(mfl_code) : 3; /*!< desired fragment length */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001203#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001204#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001205 unsigned int MBEDTLS_PRIVATE(encrypt_then_mac) : 1 ; /*!< negotiate encrypt-then-mac? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001206#endif
1207#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001208 unsigned int MBEDTLS_PRIVATE(extended_ms) : 1; /*!< negotiate extended master secret? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001209#endif
1210#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001211 unsigned int MBEDTLS_PRIVATE(anti_replay) : 1; /*!< detect and prevent replay? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001212#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001213#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001214 unsigned int MBEDTLS_PRIVATE(disable_renegotiation) : 1; /*!< disable renegotiation? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001215#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001216#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001217 unsigned int MBEDTLS_PRIVATE(session_tickets) : 1; /*!< use session tickets? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001218#endif
Janos Follath088ce432017-04-10 12:42:31 +01001219#if defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001220 unsigned int MBEDTLS_PRIVATE(cert_req_ca_list) : 1; /*!< enable sending CA list in
Janos Follath088ce432017-04-10 12:42:31 +01001221 Certificate Request messages? */
TRodziewicz8476f2f2021-06-02 14:34:47 +02001222 unsigned int respect_cli_pref : 1; /*!< pick the ciphersuite according to
1223 the client's preferences rather
1224 than ours */
Janos Follath088ce432017-04-10 12:42:31 +01001225#endif
Hanno Beckera0e20d02019-05-15 14:03:01 +01001226#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001227 unsigned int MBEDTLS_PRIVATE(ignore_unexpected_cid) : 1; /*!< Determines whether DTLS
Hanno Becker8367ccc2019-05-14 11:30:10 +01001228 * record with unexpected CID
1229 * should lead to failure. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001230#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Ron Eldor3adb9922017-12-21 10:15:08 +02001231#if defined(MBEDTLS_SSL_DTLS_SRTP)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001232 unsigned int MBEDTLS_PRIVATE(dtls_srtp_mki_support) : 1; /* support having mki_value
Ron Eldor591f1622018-01-22 12:30:04 +02001233 in the use_srtp extension */
Ron Eldor3adb9922017-12-21 10:15:08 +02001234#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001235};
1236
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001237struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001238{
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001239 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001240
Paul Bakker5121ce52009-01-03 21:22:43 +00001241 /*
1242 * Miscellaneous
1243 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001244 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001245#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001246 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1247 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001248 number of retransmissions of request if
1249 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001250#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001251
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001252 int MBEDTLS_PRIVATE(major_ver); /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Hanno Becker57723132021-08-01 19:40:44 +01001253
1254 /* This field is temporarily duplicated with mbedtls_ssl_context.minor_ver.
1255 * Once runtime negotiation of TLS 1.2 and TLS 1.3 is implemented, it needs
1256 * to be studied whether one of them can be removed. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001257 int MBEDTLS_PRIVATE(minor_ver); /*!< one of MBEDTLS_SSL_MINOR_VERSION_x macros */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001258 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001259
Hanno Becker8927c832019-04-03 12:52:50 +01001260#if defined(MBEDTLS_X509_CRT_PARSE_C)
1261 /** Callback to customize X.509 certificate chain verification */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001262 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1263 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001264#endif
1265
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001266 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1267 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1268 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Simon Butchere846b512016-03-01 17:31:49 +00001269 /*!< Callback for network receive with timeout */
1270
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001271 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001272
Paul Bakker5121ce52009-01-03 21:22:43 +00001273 /*
1274 * Session layer
1275 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001276 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1277 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1278 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1279 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001280
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001281 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001282 the handshake process */
1283
1284 /*
1285 * Record layer transformations
1286 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001287 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in) */
1288 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (in) */
1289 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params */
1290 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001291
Paul Bakker5121ce52009-01-03 21:22:43 +00001292 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001293 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001294 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001295 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001296
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001297 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1298 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001299
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001300 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001301 * Record layer (incoming data)
1302 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001303 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1304 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001305 TLS: maintained by us
1306 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001307 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001308#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001309 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001310 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001311#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001312 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1313 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1314 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1315 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001316
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001317 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1318 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1319 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001320#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001321 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001322#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001324 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1325 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001326 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001327#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001328#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001329 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1330 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001331#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001332
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001333 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001334 including the handshake header */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001335 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001336
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001337 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001338 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001339
Hanno Becker04da1892018-08-14 13:22:10 +01001340#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001341 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Hanno Becker04da1892018-08-14 13:22:10 +01001342 * within a single datagram. */
1343#endif /* MBEDTLS_SSL_PROTO_DTLS */
1344
Paul Bakker5121ce52009-01-03 21:22:43 +00001345 /*
1346 * Record layer (outgoing data)
1347 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001348 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1349 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1350 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001351#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001352 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001353 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001354#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001355 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1356 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1357 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001358
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001359 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1360 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1361 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001362#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001363 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001364#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001365
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001366 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[8]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001367
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001368#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001369 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001370#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001371
Paul Bakker5121ce52009-01-03 21:22:43 +00001372 /*
1373 * PKI layer
1374 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001375 int MBEDTLS_PRIVATE(client_auth); /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001376
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001377 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001378 * User settings
1379 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001380#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001381 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001382 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001383#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001386 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001387#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001388
Johan Pascalb62bb512015-12-03 21:56:45 +01001389#if defined(MBEDTLS_SSL_DTLS_SRTP)
1390 /*
1391 * use_srtp extension
1392 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001393 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001394#endif /* MBEDTLS_SSL_DTLS_SRTP */
1395
Paul Bakker48916f92012-09-16 19:57:18 +00001396 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001397 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001398 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001399#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001400 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1401 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001402#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001403
1404 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001405 * Secure renegotiation
1406 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001407 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001408 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Paul Bakker48916f92012-09-16 19:57:18 +00001409 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001410#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001411 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1412 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1413 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001414#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001415
Hanno Beckera0e20d02019-05-15 14:03:01 +01001416#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001417 /* CID configuration to use in subsequent handshakes. */
1418
1419 /*! The next incoming CID, chosen by the user and applying to
1420 * all subsequent handshakes. This may be different from the
1421 * CID currently used in case the user has re-configured the CID
1422 * after an initial handshake. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001423 unsigned char MBEDTLS_PRIVATE(own_cid)[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1424 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1425 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Hanno Becker2f28c102019-04-25 15:46:59 +01001426 * be negotiated in the next handshake or not.
1427 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1428 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001429#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerd8f32e72021-06-17 05:14:58 +01001430
1431#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1432 /** Callback to export key block and master secret */
1433 mbedtls_ssl_export_keys_t *MBEDTLS_PRIVATE(f_export_keys);
1434 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
1435#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001436};
1437
Paul Bakker5121ce52009-01-03 21:22:43 +00001438/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001439 * \brief Return the name of the ciphersuite associated with the
1440 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001441 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001442 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001443 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001444 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001445 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001446const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001447
1448/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001449 * \brief Return the ID of the ciphersuite associated with the
1450 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001451 *
1452 * \param ciphersuite_name SSL ciphersuite name
1453 *
1454 * \return the ID with the ciphersuite or 0 if not found
1455 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001456int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001457
1458/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001459 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001460 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001461 * mbedtls_ssl_free()
1462 *
1463 * \param ssl SSL context
1464 */
1465void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1466
1467/**
1468 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001469 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001470 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001471 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001472 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001473 * \warning The conf structure will be accessed during the session.
1474 * It must not be modified or freed as long as the session
1475 * is active.
1476 *
1477 * \warning This function must be called exactly once per context.
1478 * Calling mbedtls_ssl_setup again is not supported, even
1479 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001480 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001481 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001482 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001483 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001484 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001485 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001486 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001487int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001488 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001489
1490/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001491 * \brief Reset an already initialized SSL context for re-use
1492 * while retaining application-set variables, function
1493 * pointers and data.
1494 *
1495 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001496 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
1497 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001498 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001499int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001500
1501/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001502 * \brief Set the current endpoint type
1503 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001504 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001506 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001507void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001508
1509/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001510 * \brief Set the transport type (TLS or DTLS).
1511 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001512 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001513 * \note For DTLS, you must either provide a recv callback that
1514 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001515 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1516 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001517 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001518 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001519 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001520 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1521 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001522 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001523void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001524
1525/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001526 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001527 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001528 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001529 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001530 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001531 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001532 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001533 * (default on server)
1534 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001535 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001536 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001537 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001539 * handshake is complete.
1540 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001541 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001542 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001543 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001544 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001545 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1546 * 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 +01001547 * the right time(s), which may not be obvious, while REQUIRED always perform
1548 * the verification as soon as possible. For example, REQUIRED was protecting
1549 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001550 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001551void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001552
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001553#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001554/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001555 * \brief Set the verification callback (Optional).
1556 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001557 * If set, the provided verify callback is called for each
1558 * certificate in the peer's CRT chain, including the trusted
1559 * root. For more information, please see the documentation of
1560 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001561 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001562 * \note For per context callbacks and contexts, please use
1563 * mbedtls_ssl_set_verify() instead.
1564 *
1565 * \param conf The SSL configuration to use.
1566 * \param f_vrfy The verification callback to use during CRT verification.
1567 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001568 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001569void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001570 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001571 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001572#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001573
1574/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001575 * \brief Set the random number generator callback
1576 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001577 * \param conf SSL configuration
Manuel Pégourié-Gonnardad5390f2021-06-15 11:29:26 +02001578 * \param f_rng RNG function (mandatory)
Paul Bakker5121ce52009-01-03 21:22:43 +00001579 * \param p_rng RNG parameter
1580 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001581void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001582 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001583 void *p_rng );
1584
1585/**
1586 * \brief Set the debug callback
1587 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001588 * The callback has the following argument:
1589 * void * opaque context for the callback
1590 * int debug level
1591 * const char * file name
1592 * int line number
1593 * const char * message
1594 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001595 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001596 * \param f_dbg debug function
1597 * \param p_dbg debug parameter
1598 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001599void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001600 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001601 void *p_dbg );
1602
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001603/**
1604 * \brief Set the underlying BIO callbacks for write, read and
1605 * read-with-timeout.
1606 *
1607 * \param ssl SSL context
1608 * \param p_bio parameter (context) shared by BIO callbacks
1609 * \param f_send write callback
1610 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001611 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001612 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001613 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1614 * the other is used. If both are non-NULL, f_recv_timeout is
1615 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001616 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001617 * \note The two most common use cases are:
1618 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1619 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1620 *
1621 * \note For DTLS, you need to provide either a non-NULL
1622 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001623 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07001624 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001625 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001626 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001627 *
Andres AG3616f6f2016-09-14 14:32:09 +01001628 * \note On some platforms, net_sockets.c provides
1629 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1630 * \c mbedtls_net_recv_timeout() that are suitable to be used
1631 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001632 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001633void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001634 void *p_bio,
1635 mbedtls_ssl_send_t *f_send,
1636 mbedtls_ssl_recv_t *f_recv,
1637 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001638
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001639#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001640
Hanno Beckera0e20d02019-05-15 14:03:01 +01001641#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01001642
1643
1644/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001645 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001646 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001647 *
Hanno Beckerebcc9132019-05-15 10:26:32 +01001648 * Reference: draft-ietf-tls-dtls-connection-id-05
1649 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker019f4b52019-04-09 15:12:56 +01001650 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01001651 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01001652 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01001653 * underlying transport (changed IP and Port metadata) by
1654 * adding explicit connection identifiers (CIDs) to the
1655 * headers of encrypted DTLS records. The desired CIDs are
1656 * configured by the application layer and are exchanged in
1657 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01001658 * handshake, where each side indicates the CID it wants the
1659 * peer to use when writing encrypted messages. The CIDs are
1660 * put to use once records get encrypted: the stack discards
1661 * any incoming records that don't include the configured CID
1662 * in their header, and adds the peer's requested CID to the
1663 * headers of outgoing messages.
1664 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01001665 * This API enables or disables the use of the CID extension
1666 * in the next handshake and sets the value of the CID to
1667 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01001668 *
1669 * \param ssl The SSL context to configure. This must be initialized.
1670 * \param enable This value determines whether the CID extension should
1671 * be used or not. Possible values are:
1672 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001673 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1674 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001675 * \param own_cid The address of the readable buffer holding the CID we want
1676 * the peer to use when sending encrypted messages to us.
1677 * This may be \c NULL if \p own_cid_len is \c 0.
1678 * This parameter is unused if \p enabled is set to
1679 * MBEDTLS_SSL_CID_DISABLED.
1680 * \param own_cid_len The length of \p own_cid.
1681 * This parameter is unused if \p enabled is set to
1682 * MBEDTLS_SSL_CID_DISABLED.
1683 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001684 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01001685 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01001686 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001687 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001688 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001689 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001690 * performed on the SSL context \p ssl, but does not trigger
1691 * one. You still have to call `mbedtls_ssl_handshake()`
1692 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1693 * (for a renegotiation handshake) explicitly after a
1694 * successful call to this function to run the handshake.
1695 *
1696 * \note This call cannot guarantee that the use of the CID
1697 * will be successfully negotiated in the next handshake,
1698 * because the peer might not support it. Specifically:
1699 * - On the Client, enabling the use of the CID through
1700 * this call implies that the `ClientHello` in the next
1701 * handshake will include the CID extension, thereby
1702 * offering the use of the CID to the server. Only if
1703 * the `ServerHello` contains the CID extension, too,
1704 * the CID extension will actually be put to use.
1705 * - On the Server, enabling the use of the CID through
1706 * this call implies that that the server will look for
1707 * the CID extension in a `ClientHello` from the client,
1708 * and, if present, reply with a CID extension in its
1709 * `ServerHello`.
1710 *
1711 * \note To check whether the use of the CID was negotiated
1712 * after the subsequent handshake has completed, please
1713 * use the API mbedtls_ssl_get_peer_cid().
1714 *
1715 * \warning If the use of the CID extension is enabled in this call
1716 * and the subsequent handshake negotiates its use, Mbed TLS
1717 * will silently drop every packet whose CID does not match
1718 * the CID configured in \p own_cid. It is the responsibility
1719 * of the user to adapt the underlying transport to take care
1720 * of CID-based demultiplexing before handing datagrams to
1721 * Mbed TLS.
1722 *
1723 * \return \c 0 on success. In this case, the CID configuration
1724 * applies to the next handshake.
1725 * \return A negative error code on failure.
1726 */
1727int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1728 int enable,
1729 unsigned char const *own_cid,
1730 size_t own_cid_len );
1731
1732/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01001733 * \brief Get information about the use of the CID extension
1734 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01001735 *
1736 * \param ssl The SSL context to query.
1737 * \param enabled The address at which to store whether the CID extension
1738 * is currently in use or not. If the CID is in use,
1739 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1740 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1741 * \param peer_cid The address of the buffer in which to store the CID
1742 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01001743 * This may be \c NULL in case the value of peer CID
1744 * isn't needed. If it is not \c NULL, \p peer_cid_len
1745 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01001746 * \param peer_cid_len The address at which to store the size of the CID
1747 * chosen by the peer (if the CID extension is used).
1748 * This is also the number of Bytes in \p peer_cid that
1749 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01001750 * This may be \c NULL in case the length of the peer CID
1751 * isn't needed. If it is \c NULL, \p peer_cid must be
1752 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01001753 *
1754 * \note This applies to the state of the CID negotiated in
1755 * the last complete handshake. If a handshake is in
1756 * progress, this function will attempt to complete
1757 * the handshake first.
1758 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001759 * \note If CID extensions have been exchanged but both client
1760 * and server chose to use an empty CID, this function
1761 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1762 * (the rationale for this is that the resulting
1763 * communication is the same as if the CID extensions
1764 * hadn't been used).
1765 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001766 * \return \c 0 on success.
1767 * \return A negative error code on failure.
1768 */
1769int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1770 int *enabled,
1771 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1772 size_t *peer_cid_len );
1773
Hanno Beckera0e20d02019-05-15 14:03:01 +01001774#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01001775
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001776/**
1777 * \brief Set the Maximum Tranport Unit (MTU).
1778 * Special value: 0 means unset (no limit).
1779 * This represents the maximum size of a datagram payload
1780 * handled by the transport layer (usually UDP) as determined
1781 * by the network link and stack. In practice, this controls
1782 * the maximum size datagram the DTLS layer will pass to the
1783 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1784 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001785 * \note The limit on datagram size is converted to a limit on
1786 * record payload by subtracting the current overhead of
1787 * encapsulation and encryption/authentication if any.
1788 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001789 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001790 * example when a Path Maximum Transfer Unit (PMTU)
1791 * estimate becomes available from other sources,
1792 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001793 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001794 * \note This setting only controls the size of the packets we send,
1795 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001796 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001797 * server to use smaller records with \c
1798 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001799 *
1800 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001801 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001802 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001803 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001804 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001805 * of datagrams (hence records, see first note) sent. It
1806 * cannot be used to increase the maximum size of records over
1807 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001808 *
1809 * \note Values lower than the current record layer expansion will
1810 * result in an error when trying to send data.
1811 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001812 * \param ssl SSL context
1813 * \param mtu Value of the path MTU in bytes
1814 */
1815void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1816#endif /* MBEDTLS_SSL_PROTO_DTLS */
1817
Hanno Becker726c97a2019-04-03 12:52:35 +01001818#if defined(MBEDTLS_X509_CRT_PARSE_C)
1819/**
1820 * \brief Set a connection-specific verification callback (optional).
1821 *
1822 * If set, the provided verify callback is called for each
1823 * certificate in the peer's CRT chain, including the trusted
1824 * root. For more information, please see the documentation of
1825 * \c mbedtls_x509_crt_verify().
1826 *
1827 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1828 * binds the verification callback and context to an SSL context
1829 * as opposed to an SSL configuration.
1830 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1831 * are both used, mbedtls_ssl_set_verify() takes precedence.
1832 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001833 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001834 * \param f_vrfy The verification callback to use during CRT verification.
1835 * \param p_vrfy The opaque context to be passed to the callback.
1836 */
1837void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1838 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1839 void *p_vrfy );
1840#endif /* MBEDTLS_X509_CRT_PARSE_C */
1841
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001842/**
1843 * \brief Set the timeout period for mbedtls_ssl_read()
1844 * (Default: no timeout.)
1845 *
1846 * \param conf SSL configuration context
1847 * \param timeout Timeout value in milliseconds.
1848 * Use 0 for no timeout (default).
1849 *
1850 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001851 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001852 * With non-blocking I/O, this will only work if timer
1853 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1854 *
1855 * \note With non-blocking I/O, you may also skip this function
1856 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001857 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001858void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001859
Hanno Beckercfe45792019-07-03 16:13:00 +01001860/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001861 * \brief Check whether a buffer contains a valid and authentic record
1862 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01001863 *
1864 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01001865 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01001866 * an indication of the legitimacy of an incoming record.
1867 *
1868 * This can be useful e.g. in distributed server environments
1869 * using the DTLS Connection ID feature, in which connections
1870 * might need to be passed between service instances on a change
1871 * of peer address, but where such disruptive operations should
1872 * only happen after the validity of incoming records has been
1873 * confirmed.
1874 *
1875 * \param ssl The SSL context to use.
1876 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001877 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01001878 * \param buflen The length of \p buf in Bytes.
1879 *
1880 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001881 * with a valid and authentic record that has not been seen
1882 * before, but does not check potential data following the
1883 * initial record. In particular, it is possible to pass DTLS
1884 * datagrams containing multiple records, in which case only
1885 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01001886 *
1887 * \note This function modifies the input buffer \p buf. If you need
1888 * to preserve the original record, you have to maintain a copy.
1889 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001890 * \return \c 0 if the record is valid and authentic and has not been
1891 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01001892 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
1893 * successfully but the record was found to be not authentic.
1894 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
1895 * successfully but the record was found to be invalid for
1896 * a reason different from authenticity checking.
1897 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
1898 * successfully but the record was found to be unexpected
1899 * in the state of the SSL context, including replayed records.
1900 * \return Another negative error code on different kinds of failure.
1901 * In this case, the SSL context becomes unusable and needs
1902 * to be freed or reset before reuse.
1903 */
1904int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
1905 unsigned char *buf,
1906 size_t buflen );
Hanno Beckercfe45792019-07-03 16:13:00 +01001907
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001908/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001909 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001910 *
1911 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001912 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001913 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001914 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001915 *
1916 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1917 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001918 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001919 *
1920 * \note On some platforms, timing.c provides
1921 * \c mbedtls_timing_set_delay() and
1922 * \c mbedtls_timing_get_delay() that are suitable for using
1923 * here, except if using an event-driven style.
1924 *
1925 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001926 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001927 */
1928void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1929 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001930 mbedtls_ssl_set_timer_t *f_set_timer,
1931 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001932
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001933/**
1934 * \brief Callback type: generate and write session ticket
1935 *
1936 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001937 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001938 * authenticated ticket for the session and write it to the
1939 * output buffer. Here, ticket means the opaque ticket part
1940 * of the NewSessionTicket structure of RFC 5077.
1941 *
1942 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001943 * \param session SSL session to be written in the ticket
1944 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001945 * \param end End of the output buffer
1946 * \param tlen On exit, holds the length written
1947 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1948 *
1949 * \return 0 if successful, or
1950 * a specific MBEDTLS_ERR_XXX code.
1951 */
1952typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1953 const mbedtls_ssl_session *session,
1954 unsigned char *start,
1955 const unsigned char *end,
1956 size_t *tlen,
1957 uint32_t *lifetime );
1958
1959/**
1960 * \brief Callback type: parse and load session ticket
1961 *
1962 * \note This describes what a callback implementation should do.
1963 * This callback should parse a session ticket as generated
1964 * by the corresponding mbedtls_ssl_ticket_write_t function,
1965 * and, if the ticket is authentic and valid, load the
1966 * session.
1967 *
1968 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001969 * bytes of the input buffer, eg to use it as a temporary
1970 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001971 *
1972 * \param p_ticket Context for the callback
1973 * \param session SSL session to be loaded
1974 * \param buf Start of the buffer containing the ticket
1975 * \param len Length of the ticket.
1976 *
1977 * \return 0 if successful, or
1978 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1979 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1980 * any other non-zero code for other failures.
1981 */
1982typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1983 mbedtls_ssl_session *session,
1984 unsigned char *buf,
1985 size_t len );
1986
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001987#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001988/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001989 * \brief Configure SSL session ticket callbacks (server only).
1990 * (Default: none.)
1991 *
1992 * \note On server, session tickets are enabled by providing
1993 * non-NULL callbacks.
1994 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001995 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001996 *
1997 * \param conf SSL configuration context
1998 * \param f_ticket_write Callback for writing a ticket
1999 * \param f_ticket_parse Callback for parsing a ticket
2000 * \param p_ticket Context shared by the two callbacks
2001 */
2002void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2003 mbedtls_ssl_ticket_write_t *f_ticket_write,
2004 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2005 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002006#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002007
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002008#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2009/**
Hanno Becker457d6162021-05-24 10:27:39 +01002010 * \brief Configure a key export callback.
2011 * (Default: none.)
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002012 *
Hanno Becker457d6162021-05-24 10:27:39 +01002013 * This API can be used for two purposes:
2014 * - Debugging: Use this API to e.g. generate an NSSKeylog
2015 * file and use it to inspect encrypted traffic in tools
2016 * such as Wireshark.
2017 * - Application-specific export: Use this API to implement
2018 * key exporters, e.g. for EAP-TLS or DTLS-SRTP.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002019 *
Hanno Becker457d6162021-05-24 10:27:39 +01002020 *
Hanno Becker7e6c1782021-06-08 09:24:55 +01002021 * \param ssl The SSL context to which the export
2022 * callback should be attached.
Hanno Becker457d6162021-05-24 10:27:39 +01002023 * \param f_export_keys The callback for the key export.
2024 * \param p_export_keys The opaque context pointer to be passed to the
2025 * callback \p f_export_keys.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002026 */
Hanno Becker7e6c1782021-06-08 09:24:55 +01002027void mbedtls_ssl_set_export_keys_cb( mbedtls_ssl_context *ssl,
2028 mbedtls_ssl_export_keys_t *f_export_keys,
2029 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002030#endif /* MBEDTLS_SSL_EXPORT_KEYS */
2031
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002032#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002033/**
2034 * \brief Configure asynchronous private key operation callbacks.
2035 *
2036 * \param conf SSL configuration context
2037 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002038 * the description of ::mbedtls_ssl_async_sign_t
2039 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002040 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002041 * operation; in this case the private key object
2042 * associated with the certificate will be used.
2043 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002044 * the description of ::mbedtls_ssl_async_decrypt_t
2045 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002046 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002047 * operation; in this case the private key object
2048 * associated with the certificate will be used.
2049 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002050 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002051 * for more information. This may not be \c NULL unless
2052 * \p f_async_sign and \p f_async_decrypt are both
2053 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002054 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002055 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002056 * for more information. This may be \c NULL if
2057 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002058 * \param config_data A pointer to configuration data which can be
2059 * retrieved with
2060 * mbedtls_ssl_conf_get_async_config_data(). The
2061 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002062 */
2063void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2064 mbedtls_ssl_async_sign_t *f_async_sign,
2065 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2066 mbedtls_ssl_async_resume_t *f_async_resume,
2067 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002068 void *config_data );
2069
2070/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002071 * \brief Retrieve the configuration data set by
2072 * mbedtls_ssl_conf_async_private_cb().
2073 *
2074 * \param conf SSL configuration context
2075 * \return The configuration data set by
2076 * mbedtls_ssl_conf_async_private_cb().
2077 */
2078void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2079
2080/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002081 * \brief Retrieve the asynchronous operation user context.
2082 *
2083 * \note This function may only be called while a handshake
2084 * is in progress.
2085 *
2086 * \param ssl The SSL context to access.
2087 *
2088 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002089 * set during the current handshake. If
2090 * mbedtls_ssl_set_async_operation_data() has not yet been
2091 * called during the current handshake, this function returns
2092 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002093 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002094void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002095
2096/**
2097 * \brief Retrieve the asynchronous operation user context.
2098 *
2099 * \note This function may only be called while a handshake
2100 * is in progress.
2101 *
2102 * \param ssl The SSL context to access.
2103 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002104 * Call mbedtls_ssl_get_async_operation_data() later during the
2105 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002106 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002107void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002108 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002109#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002110
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002111/**
2112 * \brief Callback type: generate a cookie
2113 *
2114 * \param ctx Context for the callback
2115 * \param p Buffer to write to,
2116 * must be updated to point right after the cookie
2117 * \param end Pointer to one past the end of the output buffer
2118 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002119 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002120 * \param ilen Length of info in bytes
2121 *
2122 * \return The callback must return 0 on success,
2123 * or a negative error code.
2124 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002125typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002126 unsigned char **p, unsigned char *end,
2127 const unsigned char *info, size_t ilen );
2128
2129/**
2130 * \brief Callback type: verify a cookie
2131 *
2132 * \param ctx Context for the callback
2133 * \param cookie Cookie to verify
2134 * \param clen Length of cookie
2135 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002136 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002137 * \param ilen Length of info in bytes
2138 *
2139 * \return The callback must return 0 if cookie is valid,
2140 * or a negative error code.
2141 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002143 const unsigned char *cookie, size_t clen,
2144 const unsigned char *info, size_t ilen );
2145
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002146#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002147/**
2148 * \brief Register callbacks for DTLS cookies
2149 * (Server only. DTLS only.)
2150 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002151 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002152 * register working callbacks (and initialize their context).
2153 *
2154 * To disable HelloVerifyRequest, register NULL callbacks.
2155 *
2156 * \warning Disabling hello verification allows your server to be used
2157 * for amplification in DoS attacks against other hosts.
2158 * Only disable if you known this can't happen in your
2159 * particular environment.
2160 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002161 * \note See comments on \c mbedtls_ssl_handshake() about handling
2162 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2163 * on the first handshake attempt when this is enabled.
2164 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002165 * \note This is also necessary to handle client reconnection from
2166 * the same port as described in RFC 6347 section 4.2.8 (only
2167 * the variant with cookies is supported currently). See
2168 * comments on \c mbedtls_ssl_read() for details.
2169 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002170 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002171 * \param f_cookie_write Cookie write callback
2172 * \param f_cookie_check Cookie check callback
2173 * \param p_cookie Context for both callbacks
2174 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002175void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 mbedtls_ssl_cookie_write_t *f_cookie_write,
2177 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002178 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002179
2180/**
2181 * \brief Set client's transport-level identification info.
2182 * (Server only. DTLS only.)
2183 *
2184 * This is usually the IP address (and port), but could be
2185 * anything identify the client depending on the underlying
2186 * network stack. Used for HelloVerifyRequest with DTLS.
2187 * This is *not* used to route the actual packets.
2188 *
2189 * \param ssl SSL context
2190 * \param info Transport-level info identifying the client (eg IP + port)
2191 * \param ilen Length of info in bytes
2192 *
2193 * \note An internal copy is made, so the info buffer can be reused.
2194 *
2195 * \return 0 on success,
2196 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002197 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002198 */
2199int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2200 const unsigned char *info,
2201 size_t ilen );
2202
2203#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002204
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002206/**
2207 * \brief Enable or disable anti-replay protection for DTLS.
2208 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002209 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002210 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002211 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002212 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002213 *
2214 * \warning Disabling this is a security risk unless the application
2215 * protocol handles duplicated packets in a safe way. You
2216 * should not disable this without careful consideration.
2217 * However, if your application already detects duplicated
2218 * packets and needs information about them to adjust its
2219 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002220 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002221void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002223
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002224/**
2225 * \brief Set a limit on the number of records with a bad MAC
2226 * before terminating the connection.
2227 * (DTLS only, no effect on TLS.)
2228 * Default: 0 (disabled).
2229 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002230 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002231 * \param limit Limit, or 0 to disable.
2232 *
2233 * \note If the limit is N, then the connection is terminated when
2234 * the Nth non-authentic record is seen.
2235 *
2236 * \note Records with an invalid header are not counted, only the
2237 * ones going through the authentication-decryption phase.
2238 *
2239 * \note This is a security trade-off related to the fact that it's
2240 * often relatively easy for an active attacker ot inject UDP
2241 * datagrams. On one hand, setting a low limit here makes it
2242 * easier for such an attacker to forcibly terminated a
2243 * connection. On the other hand, a high limit or no limit
2244 * might make us waste resources checking authentication on
2245 * many bogus packets.
2246 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002247void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002248
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002250
2251/**
2252 * \brief Allow or disallow packing of multiple handshake records
2253 * within a single datagram.
2254 *
2255 * \param ssl The SSL context to configure.
2256 * \param allow_packing This determines whether datagram packing may
2257 * be used or not. A value of \c 0 means that every
2258 * record will be sent in a separate datagram; a
2259 * value of \c 1 means that, if space permits,
2260 * multiple handshake messages (including CCS) belonging to
2261 * a single flight may be packed within a single datagram.
2262 *
2263 * \note This is enabled by default and should only be disabled
2264 * for test purposes, or if datagram packing causes
2265 * interoperability issues with peers that don't support it.
2266 *
2267 * \note Allowing datagram packing reduces the network load since
2268 * there's less overhead if multiple messages share the same
2269 * datagram. Also, it increases the handshake efficiency
2270 * since messages belonging to a single datagram will not
2271 * be reordered in transit, and so future message buffering
2272 * or flight retransmission (if no buffering is used) as
2273 * means to deal with reordering are needed less frequently.
2274 *
Hanno Beckereb570082018-08-24 11:28:35 +01002275 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002276 * are currently always sent in separate datagrams.
2277 *
2278 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002279void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2280 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002281
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002282/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002283 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002284 * (DTLS only, no effect on TLS.)
2285 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002286 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002287 * \param min Initial timeout value in milliseconds.
2288 * Default: 1000 (1 second).
2289 * \param max Maximum timeout value in milliseconds.
2290 * Default: 60000 (60 seconds).
2291 *
2292 * \note Default values are from RFC 6347 section 4.2.4.1.
2293 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002294 * \note The 'min' value should typically be slightly above the
2295 * expected round-trip time to your peer, plus whatever time
2296 * it takes for the peer to process the message. For example,
2297 * if your RTT is about 600ms and you peer needs up to 1s to
2298 * do the cryptographic operations in the handshake, then you
2299 * should set 'min' slightly above 1600. Lower values of 'min'
2300 * might cause spurious resends which waste network resources,
2301 * while larger value of 'min' will increase overall latency
2302 * on unreliable network links.
2303 *
2304 * \note The more unreliable your network connection is, the larger
2305 * your max / min ratio needs to be in order to achieve
2306 * reliable handshakes.
2307 *
2308 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2309 * For example, if min = 1s and max = 5s, the retransmit plan
2310 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2311 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002312 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002313void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002314#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002315
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002316#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002317/**
Paul Bakker0a597072012-09-25 21:55:46 +00002318 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002319 * If not set, no session resuming is done (except if session
2320 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002321 *
Paul Bakker0a597072012-09-25 21:55:46 +00002322 * The session cache has the responsibility to check for stale
2323 * entries based on timeout. See RFC 5246 for recommendations.
2324 *
2325 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2326 * connection shutdown, so do not cache the pointer! Either set
2327 * it to NULL or make a full copy of the certificate.
2328 *
2329 * The get callback is called once during the initial handshake
2330 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002331 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002332 * If a valid entry is found, it should fill the master of
2333 * the session object with the cached values and return 0,
2334 * return 1 otherwise. Optionally peer_cert can be set as well
2335 * if it is properly present in cache entry.
2336 *
2337 * The set callback is called once during the initial handshake
2338 * to enable session resuming after the entire handshake has
2339 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002341 * should create a cache entry for future retrieval based on
2342 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002343 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002344 * data) is cleared by the SSL/TLS layer when the connection is
2345 * terminated. It is recommended to add metadata to determine if
2346 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002347 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002348 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002349 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002350 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002351 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002352 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002353 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002354void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01002355 void *p_cache,
2356 mbedtls_ssl_cache_get_t *f_get_cache,
2357 mbedtls_ssl_cache_set_t *f_set_cache );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002360#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002361/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01002362 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00002363 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01002364 * Sessions loaded through this call will be considered
2365 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002366 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01002367 * \note Even if this call succeeds, it is not guaranteed that
2368 * the next handshake will indeed be shortened through the
2369 * use of session resumption: The server is always free
2370 * to reject any attempt for resumption and fall back to
2371 * a full handshake.
2372 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01002373 * \note This function can handle a variety of mechanisms for session
2374 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01002375 * ticket-based resumption will be considered. For TLS 1.3,
2376 * once implemented, sessions equate to tickets, and loading
2377 * one or more sessions via this call will lead to their
2378 * corresponding tickets being advertised as resumption PSKs
2379 * by the client.
2380 *
2381 * \note Calling this function multiple times will only be useful
2382 * once TLS 1.3 is supported. For TLS 1.2 connections, this
2383 * function should be called at most once.
2384 *
2385 * \param ssl The SSL context representing the connection which should
2386 * be attempted to be setup using session resumption. This
2387 * must be initialized via mbedtls_ssl_init() and bound to
2388 * an SSL configuration via mbedtls_ssl_setup(), but
2389 * the handshake must not yet have been started.
2390 * \param session The session to be considered for session resumption.
2391 * This must be a session previously exported via
2392 * mbedtls_ssl_get_session(), and potentially serialized and
2393 * deserialized through mbedtls_ssl_session_save() and
2394 * mbedtls_ssl_session_load() in the meantime.
2395 *
2396 * \return \c 0 if successful.
2397 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
2398 * could not be loaded because of an implementation limitation.
2399 * This error is non-fatal, and has no observable effect on
2400 * the SSL context or the session that was attempted to be loaded.
2401 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002402 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002403 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01002404 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00002405 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2407#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002408
2409/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002410 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002411 * On client, this can be used for loading saved sessions
2412 * before resuming them with mbedstls_ssl_set_session().
2413 * On server, this can be used for alternative implementations
2414 * of session cache or session tickets.
2415 *
2416 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002417 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002418 * end-entity certificate and the result of the chain
2419 * verification (unless verification was disabled), but not
2420 * the rest of the chain.
2421 *
2422 * \see mbedtls_ssl_session_save()
2423 * \see mbedtls_ssl_set_session()
2424 *
2425 * \param session The session structure to be populated. It must have been
2426 * initialised with mbedtls_ssl_session_init() but not
2427 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002428 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002429 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002430 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002431 *
2432 * \return \c 0 if successful.
2433 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2434 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01002435 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2436 * was generated in a different version or configuration of
2437 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002438 * \return Another negative value for other kinds of errors (for
2439 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002440 */
2441int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2442 const unsigned char *buf,
2443 size_t len );
2444
2445/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002446 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002447 * On client, this can be used for saving session data,
2448 * potentially in non-volatile storage, for resuming later.
2449 * On server, this can be used for alternative implementations
2450 * of session cache or session tickets.
2451 *
2452 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002453 *
2454 * \param session The session structure to be saved.
2455 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002456 * writeable buffer of at least \p len bytes, or may be \c
2457 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002458 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002459 * \param olen The size in bytes of the data that has been or would have
2460 * been written. It must point to a valid \c size_t.
2461 *
2462 * \note \p olen is updated to the correct value regardless of
2463 * whether \p buf_len was large enough. This makes it possible
2464 * to determine the necessary size by calling this function
2465 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002466 *
2467 * \return \c 0 if successful.
2468 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2469 */
2470int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2471 unsigned char *buf,
2472 size_t buf_len,
2473 size_t *olen );
2474
2475/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002476 * \brief Set the list of allowed ciphersuites and the preference
2477 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002478 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002479 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002480 * The ciphersuites array is not copied, and must remain
2481 * valid for the lifetime of the ssl_config.
2482 *
TRodziewicz3946f792021-06-14 12:11:18 +02002483 * Note: By default, the server chooses its preferred
2484 * ciphersuite among those that the client supports. If
2485 * mbedtls_ssl_conf_preference_order() is called to prefer
2486 * the client's preferences, the server instead chooses
2487 * the client's preferred ciphersuite among those that
2488 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002489 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002490 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002491 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002492 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002493void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002494 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002495
Hanno Beckera0e20d02019-05-15 14:03:01 +01002496#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01002497#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2498#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01002499/**
Hanno Becker11259522019-05-23 16:55:50 +01002500 * \brief Specify the length of Connection IDs for incoming
2501 * encrypted DTLS records, as well as the behaviour
2502 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01002503 *
2504 * By default, the CID length is set to \c 0,
2505 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002506 *
2507 * \param conf The SSL configuration to modify.
2508 * \param len The length in Bytes of the CID fields in encrypted
2509 * DTLS records using the CID mechanism. This must
2510 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01002511 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01002512 * receiving a record with an unexpected CID.
2513 * Possible values are:
2514 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2515 * In this case, the record is silently ignored.
2516 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2517 * In this case, the stack fails with the specific
2518 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002519 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002520 * \note The CID specification allows implementations to either
2521 * use a common length for all incoming connection IDs or
2522 * allow variable-length incoming IDs. Mbed TLS currently
2523 * requires a common length for all connections sharing the
2524 * same SSL configuration; this allows simpler parsing of
2525 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002526 *
2527 * \return \c 0 on success.
2528 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2529 * is too large.
2530 */
Hanno Becker8367ccc2019-05-14 11:30:10 +01002531int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2532 int ignore_other_cids );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002533#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01002534
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002535#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002536/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002537 * \brief Set the X.509 security profile used for verification
2538 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002539 * \note The restrictions are enforced for all certificates in the
2540 * chain. However, signatures in the handshake are not covered
2541 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2542 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002543 * \param conf SSL configuration
2544 * \param profile Profile to use
2545 */
2546void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002547 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002548
2549/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002550 * \brief Set the data required to verify peer certificate
2551 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002552 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002553 * parameters ca_chain (maps to trust_ca for that function)
2554 * and ca_crl.
2555 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002556 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002557 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002558 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002559 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002560void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002561 mbedtls_x509_crt *ca_chain,
2562 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002563
Hanno Becker8bf74f32019-03-27 11:01:30 +00002564#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2565/**
2566 * \brief Set the trusted certificate callback.
2567 *
2568 * This API allows to register the set of trusted certificates
2569 * through a callback, instead of a linked list as configured
2570 * by mbedtls_ssl_conf_ca_chain().
2571 *
2572 * This is useful for example in contexts where a large number
2573 * of CAs are used, and the inefficiency of maintaining them
2574 * in a linked list cannot be tolerated. It is also useful when
2575 * the set of trusted CAs needs to be modified frequently.
2576 *
2577 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2578 * more information.
2579 *
2580 * \param conf The SSL configuration to register the callback with.
2581 * \param f_ca_cb The trusted certificate callback to use when verifying
2582 * certificate chains.
2583 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2584 * a reference to a trusted CA database).
2585 *
2586 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2587 * Any call to this function overwrites the values set through
2588 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2589 * mbedtls_ssl_conf_ca_cb().
2590 *
2591 * \note This API is incompatible with CA indication in
2592 * CertificateRequest messages: A server-side SSL context which
2593 * is bound to an SSL configuration that uses a CA callback
2594 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2595 * client authentication, will send an empty CA list in the
2596 * corresponding CertificateRequest message.
2597 *
2598 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2599 * If an SSL context is bound to an SSL configuration which uses
2600 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2601 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2602 *
2603 * \note The use of this API disables the use of restartable ECC
2604 * during X.509 CRT signature verification (but doesn't affect
2605 * other uses).
2606 *
2607 * \warning This API is incompatible with the use of CRLs. Any call to
2608 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2609 * earlier calls to mbedtls_ssl_conf_ca_chain().
2610 *
2611 * \warning In multi-threaded environments, the callback \p f_ca_cb
2612 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002613 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002614 * contained in the callback context pointed to by \p p_ca_cb).
2615 */
2616void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2617 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2618 void *p_ca_cb );
2619#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2620
Paul Bakker5121ce52009-01-03 21:22:43 +00002621/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002622 * \brief Set own certificate chain and private key
2623 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002624 * \note own_cert should contain in order from the bottom up your
2625 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002626 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002627 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002628 * \note On server, this function can be called multiple times to
2629 * provision more than one cert/key pair (eg one ECDSA, one
2630 * RSA with SHA-256, one RSA with SHA-1). An adequate
2631 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002632 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002633 * adequate, preference is given to the one set by the first
2634 * call to this function, then second, etc.
2635 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002636 * \note On client, only the first call has any effect. That is,
2637 * only one client certificate can be provisioned. The
2638 * server's preferences in its CertficateRequest message will
2639 * be ignored and our only cert will be sent regardless of
2640 * whether it matches those preferences - the server can then
2641 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002642 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002643 * \note The provided \p pk_key needs to match the public key in the
2644 * first certificate in \p own_cert, or all handshakes using
2645 * that certificate will fail. It is your responsibility
2646 * to ensure that; this function will not perform any check.
2647 * You may use mbedtls_pk_check_pair() in order to perform
2648 * this check yourself, but be aware that this function can
2649 * be computationally expensive on some key types.
2650 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002651 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002652 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002653 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002654 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002655 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002656 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002657int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002658 mbedtls_x509_crt *own_cert,
2659 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002660#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002661
Gilles Peskineeccd8882020-03-10 12:19:08 +01002662#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002663/**
Hanno Becker196739b2021-05-28 05:25:46 +01002664 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01002665 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002666 *
Hanno Becker196739b2021-05-28 05:25:46 +01002667 * Only one PSK can be registered, through either
2668 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
2669 * If you attempt to register more than one PSK, this function
2670 * fails, though this may change in future versions, which
2671 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002672 *
2673 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002674 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002675 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002676 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
2677 * takes precedence over a PSK configured by this function.
2678 *
Hanno Becker02283042018-10-22 15:28:02 +01002679 * \param conf The SSL configuration to register the PSK with.
2680 * \param psk The pointer to the pre-shared key to use.
2681 * \param psk_len The length of the pre-shared key in bytes.
2682 * \param psk_identity The pointer to the pre-shared key identity.
2683 * \param psk_identity_len The length of the pre-shared key identity
2684 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002685 *
Hanno Becker02283042018-10-22 15:28:02 +01002686 * \note The PSK and its identity are copied internally and
2687 * hence need not be preserved by the caller for the lifetime
2688 * of the SSL configuration.
2689 *
2690 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01002691 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01002692 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01002693 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002694 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002695int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002696 const unsigned char *psk, size_t psk_len,
2697 const unsigned char *psk_identity, size_t psk_identity_len );
2698
Hanno Becker02283042018-10-22 15:28:02 +01002699#if defined(MBEDTLS_USE_PSA_CRYPTO)
2700/**
Hanno Becker946c9252021-04-19 21:41:47 +01002701 * \brief Configure one or more opaque pre-shared keys (PSKs) and
2702 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01002703 *
Hanno Becker196739b2021-05-28 05:25:46 +01002704 * Only one PSK can be registered, through either
2705 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
2706 * If you attempt to register more than one PSK, this function
2707 * fails, though this may change in future versions, which
2708 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01002709 *
2710 * \note This is mainly useful for clients. Servers will usually
2711 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2712 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002713 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
2714 * the PSK callback takes precedence over an opaque PSK
2715 * configured by this function.
2716 *
Hanno Becker02283042018-10-22 15:28:02 +01002717 * \param conf The SSL configuration to register the PSK with.
2718 * \param psk The identifier of the key slot holding the PSK.
2719 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002720 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002721 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002722 * allows its use for the key derivation algorithm applied
2723 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002724 * \param psk_identity The pointer to the pre-shared key identity.
2725 * \param psk_identity_len The length of the pre-shared key identity
2726 * in bytes.
2727 *
2728 * \note The PSK identity hint is copied internally and hence need
2729 * not be preserved by the caller for the lifetime of the
2730 * SSL configuration.
2731 *
2732 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01002733 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01002734 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01002735 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01002736 */
2737int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002738 psa_key_id_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002739 const unsigned char *psk_identity,
2740 size_t psk_identity_len );
2741#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002742
2743/**
Hanno Becker02283042018-10-22 15:28:02 +01002744 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002745 *
2746 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002747 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002748 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002749 * \note A PSK set by this function takes precedence over a PSK
2750 * configured by \c mbedtls_ssl_conf_psk().
2751 *
Hanno Becker02283042018-10-22 15:28:02 +01002752 * \param ssl The SSL context to configure a PSK for.
2753 * \param psk The pointer to the pre-shared key.
2754 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002755 *
Hanno Becker02283042018-10-22 15:28:02 +01002756 * \return \c 0 if successful.
2757 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002758 */
2759int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2760 const unsigned char *psk, size_t psk_len );
2761
Hanno Becker02283042018-10-22 15:28:02 +01002762#if defined(MBEDTLS_USE_PSA_CRYPTO)
2763/**
2764 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2765 *
2766 * \note This should only be called inside the PSK callback,
2767 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2768 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002769 * \note An opaque PSK set by this function takes precedence over an
2770 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
2771 *
Hanno Becker02283042018-10-22 15:28:02 +01002772 * \param ssl The SSL context to configure a PSK for.
2773 * \param psk The identifier of the key slot holding the PSK.
2774 * For the duration of the current handshake, the key slot
2775 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002776 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002777 * use for the key derivation algorithm
2778 * applied in the handshake.
2779 *
2780 * \return \c 0 if successful.
2781 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2782 */
2783int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002784 psa_key_id_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002785#endif /* MBEDTLS_USE_PSA_CRYPTO */
2786
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002787/**
2788 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002789 *
2790 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002791 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002792 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002793 * receive the actual PSK data and length.
2794 *
Hanno Becker02283042018-10-22 15:28:02 +01002795 * The callback has the following parameters:
2796 * - \c void*: The opaque pointer \p p_psk.
2797 * - \c mbedtls_ssl_context*: The SSL context to which
2798 * the operation applies.
2799 * - \c const unsigned char*: The PSK identity
2800 * selected by the client.
2801 * - \c size_t: The length of the PSK identity
2802 * selected by the client.
2803 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002804 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002805 * \c mbedtls_ssl_set_hs_psk() or
2806 * \c mbedtls_ssl_set_hs_psk_opaque()
2807 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002808 * Any other return value will result in a denied PSK identity.
2809 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002810 * \note A dynamic PSK (i.e. set by the PSK callback) takes
2811 * precedence over a static PSK (i.e. set by
2812 * \c mbedtls_ssl_conf_psk() or
2813 * \c mbedtls_ssl_conf_psk_opaque()).
2814 * This means that if you set a PSK callback using this
2815 * function, you don't need to set a PSK using
2816 * \c mbedtls_ssl_conf_psk() or
2817 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002818 *
Hanno Becker02283042018-10-22 15:28:02 +01002819 * \param conf The SSL configuration to register the callback with.
2820 * \param f_psk The callback for selecting and setting the PSK based
2821 * in the PSK identity chosen by the client.
2822 * \param p_psk A pointer to an opaque structure to be passed to
2823 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002824 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002825void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002827 size_t),
2828 void *p_psk );
Gilles Peskineeccd8882020-03-10 12:19:08 +01002829#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002830
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002831#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002832/**
2833 * \brief Set the Diffie-Hellman public P and G values
2834 * from big-endian binary presentations.
2835 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2836 *
2837 * \param conf SSL configuration
2838 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2839 * \param P_len Length of DHM modulus
2840 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2841 * \param G_len Length of DHM generator
2842 *
2843 * \return 0 if successful
2844 */
2845int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2846 const unsigned char *dhm_P, size_t P_len,
2847 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002848
2849/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002850 * \brief Set the Diffie-Hellman public P and G values,
2851 * read from existing context (server-side only)
2852 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002853 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002854 * \param dhm_ctx Diffie-Hellman-Merkle context
2855 *
2856 * \return 0 if successful
2857 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002858int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002859#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002860
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002861#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2862/**
2863 * \brief Set the minimum length for Diffie-Hellman parameters.
2864 * (Client-side only.)
2865 * (Default: 1024 bits.)
2866 *
2867 * \param conf SSL configuration
2868 * \param bitlen Minimum bit length of the DHM prime
2869 */
2870void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2871 unsigned int bitlen );
2872#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2873
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002874#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002875/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002876 * \brief Set the allowed curves in order of preference.
Gergely Budai987bfb52014-01-19 21:48:42 +01002877 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002878 * On server: this only affects selection of the ECDHE curve;
2879 * the curves used for ECDH and ECDSA are determined by the
2880 * list of available certificates instead.
2881 *
2882 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002883 * use. The server can override our preference order.
2884 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002885 * Both sides: limits the set of curves accepted for use in
2886 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002887 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002888 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002889 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002890 * for that. For the end-entity certificate however, the key
2891 * will be accepted only if it is allowed both by this list
2892 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002893 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002894 * \note This list should be ordered by decreasing preference
2895 * (preferred curve first).
2896 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02002897 * \note The default list is the same set of curves that
2898 * #mbedtls_x509_crt_profile_default allows, plus
2899 * ECDHE-only curves selected according to the same criteria.
Gilles Peskineb1940a72021-06-02 15:18:12 +02002900 * The order favors curves with the lowest resource usage.
Gilles Peskineae270bf2021-06-02 00:05:29 +02002901 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02002902 * \note New minor versions of Mbed TLS may extend this list,
2903 * for example if new curves are added to the library.
2904 * New minor versions of Mbed TLS will not remove items
2905 * from this list unless serious security concerns require it.
2906 * New minor versions of Mbed TLS may change the order in
2907 * keeping with the general principle of favoring the lowest
2908 * resource usage.
2909 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002910 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002911 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002913 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002914void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2915 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002916#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002917
Gilles Peskineeccd8882020-03-10 12:19:08 +01002918#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002919/**
2920 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002921 *
2922 * \note This only affects which hashes are offered and can be used
2923 * for signatures during the handshake. Hashes for message
2924 * authentication and the TLS PRF are controlled by the
2925 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2926 * used for certificate signature are controlled by the
2927 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2928 *
2929 * \note This list should be ordered by decreasing preference
2930 * (preferred hash first).
2931 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02002932 * \note By default, all supported hashes whose length is at least
2933 * 256 bits are allowed. This is the same set as the default
2934 * for certificate verification
Gilles Peskinea28f0f52021-06-02 15:29:38 +02002935 * (#mbedtls_x509_crt_profile_default).
2936 * The preference order is currently unspecified and may
2937 * change in future versions.
Gilles Peskineae270bf2021-06-02 00:05:29 +02002938 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02002939 * \note New minor versions of Mbed TLS may extend this list,
2940 * for example if new curves are added to the library.
2941 * New minor versions of Mbed TLS will not remove items
2942 * from this list unless serious security concerns require it.
2943 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002944 * \param conf SSL configuration
2945 * \param hashes Ordered list of allowed signature hashes,
2946 * terminated by \c MBEDTLS_MD_NONE.
2947 */
2948void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2949 const int *hashes );
Gilles Peskineeccd8882020-03-10 12:19:08 +01002950#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002951
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002952#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002953/**
Darryl Green11999bb2018-03-13 15:22:58 +00002954 * \brief Set or reset the hostname to check against the received
2955 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002956 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002957 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002958 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002959 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002960
Hanno Becker0446a392017-04-07 12:59:32 +01002961 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002962 *
Darryl Green11999bb2018-03-13 15:22:58 +00002963 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2964 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002965 * too long input hostname.
2966 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002967 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002968 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002969 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002971int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002972#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002973
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002974#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002975/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002976 * \brief Set own certificate and key for the current handshake
2977 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002978 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002979 * the SNI callback.
2980 *
2981 * \param ssl SSL context
2982 * \param own_cert own public certificate chain
2983 * \param pk_key own private key
2984 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002985 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002986 */
2987int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2988 mbedtls_x509_crt *own_cert,
2989 mbedtls_pk_context *pk_key );
2990
2991/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002992 * \brief Set the data required to verify peer certificate for the
2993 * current handshake
2994 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002995 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002996 * the SNI callback.
2997 *
2998 * \param ssl SSL context
2999 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3000 * \param ca_crl trusted CA CRLs
3001 */
3002void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
3003 mbedtls_x509_crt *ca_chain,
3004 mbedtls_x509_crl *ca_crl );
3005
3006/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003007 * \brief Set authmode for the current handshake.
3008 *
3009 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
3010 * the SNI callback.
3011 *
3012 * \param ssl SSL context
3013 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3014 * MBEDTLS_SSL_VERIFY_REQUIRED
3015 */
3016void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
3017 int authmode );
3018
3019/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003020 * \brief Set server side ServerName TLS extension callback
3021 * (optional, server-side only).
3022 *
3023 * If set, the ServerName callback is called whenever the
3024 * server receives a ServerName TLS extension from the client
3025 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003027 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003028 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003029 * certificate(s) and key(s) to use with \c
3030 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003031 * and may optionally adjust the CA and associated CRL with \c
3032 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3033 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3034 * then must return 0. If no matching name is found, the
3035 * callback must either set a default cert, or
3036 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003037 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003038 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003039 * \param f_sni verification function
3040 * \param p_sni verification parameter
3041 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003042void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003043 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003044 size_t),
3045 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003046#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003047
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003048#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003049/**
3050 * \brief Set the EC J-PAKE password for current handshake.
3051 *
3052 * \note An internal copy is made, and destroyed as soon as the
3053 * handshake is completed, or when the SSL context is reset or
3054 * freed.
3055 *
3056 * \note The SSL context needs to be already set up. The right place
3057 * to call this function is between \c mbedtls_ssl_setup() or
3058 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
3059 *
3060 * \param ssl SSL context
3061 * \param pw EC J-PAKE password (pre-shared secret)
3062 * \param pw_len length of pw in bytes
3063 *
3064 * \return 0 on success, or a negative error code.
3065 */
3066int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3067 const unsigned char *pw,
3068 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003069#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003071#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003072/**
3073 * \brief Set the supported Application Layer Protocols.
3074 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003075 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003076 * \param protos Pointer to a NULL-terminated list of supported protocols,
3077 * in decreasing preference order. The pointer to the list is
3078 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00003079 * the lifetime of the table must be atleast as long as the
3080 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003081 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003083 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003084int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003085
3086/**
3087 * \brief Get the name of the negotiated Application Layer Protocol.
3088 * This function should be called after the handshake is
3089 * completed.
3090 *
3091 * \param ssl SSL context
3092 *
3093 * \return Protcol name, or NULL if no protocol was negotiated.
3094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
3096#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003097
Johan Pascalb62bb512015-12-03 21:56:45 +01003098#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003099#if defined(MBEDTLS_DEBUG_C)
Johan Pascalaae4d222020-09-22 21:21:39 +02003100static inline const char *mbedtls_ssl_get_srtp_profile_as_string( mbedtls_ssl_srtp_profile profile )
Johan Pascala455cd92020-09-22 15:28:11 +02003101{
3102 switch( profile )
3103 {
3104 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003105 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003106 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003107 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003108 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003109 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003110 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003111 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003112 default: break;
3113 }
3114 return( "" );
3115}
3116#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003117/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003118 * \brief Manage support for mki(master key id) value
3119 * in use_srtp extension.
3120 * MKI is an optional part of SRTP used for key management
3121 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003122 * The default value is
3123 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003124 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003125 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003126 * \param support_mki_value Enable or disable mki usage. Values are
3127 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3128 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003129 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003130void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3131 int support_mki_value );
Ron Eldor591f1622018-01-22 12:30:04 +02003132
3133/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003134 * \brief Set the supported DTLS-SRTP protection profiles.
3135 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003136 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003137 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3138 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003139 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003140 * The pointer to the list is recorded by the library
3141 * for later reference as required, so the lifetime
3142 * of the table must be at least as long as the lifetime
3143 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003144 * The list must not hold more than
3145 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003146 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01003147 *
Johan Pascal85269572020-08-25 10:01:54 +02003148 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003149 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
3150 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01003151 */
Ron Eldora9788042018-12-05 11:04:31 +02003152int mbedtls_ssl_conf_dtls_srtp_protection_profiles
3153 ( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02003154 const mbedtls_ssl_srtp_profile *profiles );
Ron Eldor591f1622018-01-22 12:30:04 +02003155
3156/**
Ron Eldora9788042018-12-05 11:04:31 +02003157 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02003158 *
Ron Eldora9788042018-12-05 11:04:31 +02003159 * \param ssl SSL context to use.
3160 * \param mki_value The MKI value to set.
3161 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02003162 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003163 * \note This function is relevant on client side only.
3164 * The server discovers the mki value during handshake.
3165 * A mki value set on server side using this function
3166 * is ignored.
3167 *
Johan Pascal85269572020-08-25 10:01:54 +02003168 * \return 0 on success
3169 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
3170 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02003171 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003172int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
3173 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02003174 uint16_t mki_len );
Johan Pascalb62bb512015-12-03 21:56:45 +01003175/**
Johan Pascal2258a4f2020-10-28 13:53:09 +01003176 * \brief Get the negotiated DTLS-SRTP informations:
3177 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003178 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003179 * \warning This function must be called after the handshake is
3180 * completed. The value returned by this function must
3181 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01003182 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003183 * \param ssl The SSL context to query.
3184 * \param dtls_srtp_info The negotiated DTLS-SRTP informations:
3185 * - Protection profile in use.
3186 * A direct mapping of the iana defined value for protection
3187 * profile on an uint16_t.
3188 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
3189 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
3190 * or peer's Hello packet was not parsed yet.
3191 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01003192 */
Johan Pascal2258a4f2020-10-28 13:53:09 +01003193void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
3194 mbedtls_dtls_srtp_info *dtls_srtp_info );
Johan Pascalb62bb512015-12-03 21:56:45 +01003195#endif /* MBEDTLS_SSL_DTLS_SRTP */
3196
Paul Bakker5701cdc2012-09-27 21:49:42 +00003197/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003198 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003199 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003200 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003201 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003202 * \note This ignores ciphersuites from higher versions.
3203 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003204 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003205 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003206 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003207 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Manuel Pégourié-Gonnard9371a402021-06-04 11:44:44 +02003208 * \param minor Minor version number (only MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003209 */
Ron Eldora9788042018-12-05 11:04:31 +02003210void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00003211
Paul Bakker1d29fb52012-09-28 13:28:45 +00003212/**
3213 * \brief Set the minimum accepted SSL/TLS protocol version
TRodziewicz0f82ec62021-05-12 17:49:18 +02003214 * (Default: TLS 1.2)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003215 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003216 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3217 * SSL_MIN_XXXXX_VERSION range is ignored.
3218 *
TRodziewicz4ca18aa2021-05-20 14:46:20 +02003219 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003220 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003221 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003222 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Manuel Pégourié-Gonnard9371a402021-06-04 11:44:44 +02003223 * \param minor Minor version number (only MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003224 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003225void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00003226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003227#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003228/**
3229 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003230 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003231 *
3232 * \note This should always be enabled, it is a security
3233 * improvement, and should not cause any interoperability
3234 * issue (used only if the peer supports it too).
3235 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003236 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003237 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003238 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003239void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003240#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003241
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003242#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003243/**
3244 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003245 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003246 *
3247 * \note This should always be enabled, it is a security fix to the
3248 * protocol, and should not cause any interoperability issue
3249 * (used only if the peer supports it too).
3250 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003251 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003253 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003254void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003255#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003256
Janos Follath088ce432017-04-10 12:42:31 +01003257#if defined(MBEDTLS_SSL_SRV_C)
3258/**
3259 * \brief Whether to send a list of acceptable CAs in
3260 * CertificateRequest messages.
3261 * (Default: do send)
3262 *
3263 * \param conf SSL configuration
3264 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3265 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3266 */
3267void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3268 char cert_req_ca_list );
3269#endif /* MBEDTLS_SSL_SRV_C */
3270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003271#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003272/**
k-stachowiak6d722122019-02-08 17:03:33 +01003273 * \brief Set the maximum fragment length to emit and/or negotiate.
3274 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3275 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003276 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003277 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003278 * (Client: set maximum fragment length to emit *and*
3279 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003280 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003281 *
k-stachowiak6d722122019-02-08 17:03:33 +01003282 * \note On the client side, the maximum fragment length extension
3283 * *will not* be used, unless the maximum fragment length has
3284 * been set via this function to a value different than
3285 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003286 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003287 * \note With TLS, this currently only affects ApplicationData (sent
3288 * with \c mbedtls_ssl_read()), not handshake messages.
3289 * With DTLS, this affects both ApplicationData and handshake.
3290 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003291 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003292 * excluding record overhead that will be added to it, see
3293 * \c mbedtls_ssl_get_record_expansion().
3294 *
3295 * \note For DTLS, it is also possible to set a limit for the total
3296 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003297 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003298 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003299 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003300 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3302 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003303 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003304 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003305 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003306int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003308
TRodziewicz8476f2f2021-06-02 14:34:47 +02003309#if defined(MBEDTLS_SSL_SRV_C)
3310/**
TRodziewicz3946f792021-06-14 12:11:18 +02003311 * \brief Pick the ciphersuites order according to the second parameter
3312 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
3313 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02003314 *
3315 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02003316 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
3317 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02003318 */
TRodziewicz3946f792021-06-14 12:11:18 +02003319void mbedtls_ssl_conf_preference_order( mbedtls_ssl_config *conf, int order );
TRodziewicz8476f2f2021-06-02 14:34:47 +02003320#endif /* MBEDTLS_SSL_SRV_C */
3321
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003322#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003323/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003324 * \brief Enable / Disable session tickets (client only).
3325 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003326 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003327 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003328 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003329 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3331 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003332 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003333void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3334#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003336#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003337/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003338 * \brief Enable / Disable renegotiation support for connection when
3339 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003340 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003341 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003342 * \warning It is recommended to always disable renegotation unless you
3343 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003344 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003345 * renegotiation or a poor understanding of its properties.
3346 *
3347 * \note Server-side, enabling renegotiation also makes the server
3348 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003349 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003350 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3352 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003353 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003354void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003355#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003356
3357/**
3358 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003359 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003360 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003361 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003362 * be established even if the peer does not support
3363 * secure renegotiation, but does not allow renegotiation
3364 * to take place if not secure.
3365 * (Interoperable and secure option)
3366 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003368 * with non-upgraded peers. Allowing legacy renegotiation
3369 * makes the connection vulnerable to specific man in the
3370 * middle attacks. (See RFC 5746)
3371 * (Most interoperable and least secure option)
3372 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003373 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003374 * if peer does not support secure renegotiation. Results
3375 * in interoperability issues with non-upgraded peers
3376 * that do not support renegotiation altogether.
3377 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003378 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003379 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003380 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3381 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003383 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003384void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003385
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003387/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003388 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003389 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003390 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003391 * When we request a renegotiation, the peer can comply or
3392 * ignore the request. This function allows us to decide
3393 * whether to enforce our renegotiation requests by closing
3394 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003395 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003396 * However, records could already be in transit from the peer
3397 * when the request is emitted. In order to increase
3398 * reliability, we can accept a number of records before the
3399 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003400 *
3401 * The optimal value is highly dependent on the specific usage
3402 * scenario.
3403 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003404 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003406 * out or receives Application Data, until:
3407 * - max_records records have beens seen, if it is >= 0, or
3408 * - the number of retransmits that would happen during an
3409 * actual handshake has been reached.
3410 * Please remember the request might be lost a few times
3411 * if you consider setting max_records to a really low value.
3412 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003413 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003415 * which always behave as if max_record was 0. The reason is,
3416 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003417 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003418 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003419 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003420 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003421 * enforce renegotiation, or a non-negative value to enforce
3422 * it but allow for a grace period of max_records records.
3423 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003424void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003425
3426/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003427 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003428 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003429 *
3430 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003431 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003432 * threshold. The default value is meant to prevent the
3433 * connection from being closed when the counter is about to
3434 * reached its maximal value (it is not allowed to wrap).
3435 *
3436 * Lower values can be used to enforce policies such as "keys
3437 * must be refreshed every N packets with cipher X".
3438 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003439 * The renegotiation period can be disabled by setting
3440 * conf->disable_renegotiation to
3441 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3442 *
3443 * \note When the configured transport is
3444 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3445 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3446 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003447 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003448 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003449 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003450 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003451void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003452 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003454
Paul Bakker43ca69c2011-01-15 17:35:19 +00003455/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003456 * \brief Check if there is data already read from the
3457 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003458 *
3459 * \param ssl SSL context
3460 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003461 * \return 0 if nothing's pending, 1 otherwise.
3462 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003463 * \note This is different in purpose and behaviour from
3464 * \c mbedtls_ssl_get_bytes_avail in that it considers
3465 * any kind of unprocessed data, not only unread
3466 * application data. If \c mbedtls_ssl_get_bytes
3467 * returns a non-zero value, this function will
3468 * also signal pending data, but the converse does
3469 * not hold. For example, in DTLS there might be
3470 * further records waiting to be processed from
3471 * the current underlying transport's datagram.
3472 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003473 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003474 * does not imply that a subsequent call to
3475 * \c mbedtls_ssl_read will provide any data;
3476 * e.g., the unprocessed data might turn out
3477 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003478 *
3479 * \note This function is useful in the following situation:
3480 * If the SSL/TLS module successfully returns from an
3481 * operation - e.g. a handshake or an application record
3482 * read - and you're awaiting incoming data next, you
3483 * must not immediately idle on the underlying transport
3484 * to have data ready, but you need to check the value
3485 * of this function first. The reason is that the desired
3486 * data might already be read but not yet processed.
3487 * If, in contrast, a previous call to the SSL/TLS module
3488 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3489 * to call this function, as the latter error code entails
3490 * that all internal data has been processed.
3491 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003492 */
3493int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3494
3495/**
3496 * \brief Return the number of application data bytes
3497 * remaining to be read from the current record.
3498 *
3499 * \param ssl SSL context
3500 *
3501 * \return How many bytes are available in the application
3502 * data record read buffer.
3503 *
3504 * \note When working over a datagram transport, this is
3505 * useful to detect the current datagram's boundary
3506 * in case \c mbedtls_ssl_read has written the maximal
3507 * amount of data fitting into the input buffer.
3508 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003509 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003510size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003511
3512/**
3513 * \brief Return the result of the certificate verification
3514 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003515 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003516 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003517 * \return \c 0 if the certificate verification was successful.
3518 * \return \c -1u if the result is not available. This may happen
3519 * e.g. if the handshake aborts early, or a verification
3520 * callback returned a fatal error.
3521 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3522 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003523 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003524uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003525
3526/**
3527 * \brief Return the name of the current ciphersuite
3528 *
3529 * \param ssl SSL context
3530 *
3531 * \return a string containing the ciphersuite name
3532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003534
3535/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003536 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003537 *
3538 * \param ssl SSL context
3539 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003540 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003541 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003542const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003543
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003544/**
3545 * \brief Return the (maximum) number of bytes added by the record
3546 * layer: header + encryption/MAC overhead (inc. padding)
3547 *
3548 * \param ssl SSL context
3549 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01003550 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003551 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003552int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003553
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003554/**
3555 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003556 *
3557 * \note The logic to determine the maximum outgoing record payload is
3558 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02003559 * the mbedtls_config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003560 * such as the max fragment length or record size limit extension if
3561 * used, and for DTLS the path MTU as configured and current
3562 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003563 *
3564 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3565 * called with a larger length value.
3566 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3567 * necessary and return the number of bytes written; it is up
3568 * to the caller to call \c mbedtls_ssl_write() again in
3569 * order to send the remaining bytes if any.
3570 *
Hanno Becker80d163d2021-04-21 06:28:18 +01003571 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003572 * \sa mbedtls_ssl_get_record_expansion()
3573 *
3574 * \param ssl SSL context
3575 *
3576 * \return Current maximum payload for an outgoing record,
3577 * or a negative error code.
3578 */
3579int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3580
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003581/**
3582 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003583 *
3584 * \note The logic to determine the maximum outgoing record payload is
3585 * version-specific. It takes into account various factors, such as
Bence Szépkútibb0cfeb2021-05-28 09:42:25 +02003586 * the mbedtls_config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003587 * such as the max fragment length extension or record size limit
3588 * extension if used, and the current record expansion.
3589 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003590 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01003591 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003592 * \sa mbedtls_ssl_get_record_expansion()
3593 *
3594 * \param ssl SSL context
3595 *
3596 * \return Current maximum payload for an outgoing record,
3597 * or a negative error code.
3598 */
3599int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl );
3600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003601#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003602/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003603 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003604 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003605 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003606 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003607 * \return The current peer certificate, if available.
3608 * The returned certificate is owned by the SSL context and
3609 * is valid only until the next call to the SSL API.
3610 * \return \c NULL if no peer certificate is available. This might
3611 * be because the chosen ciphersuite doesn't use CRTs
3612 * (PSK-based ciphersuites, for example), or because
3613 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3614 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003615 *
3616 * \note For one-time inspection of the peer's certificate during
3617 * the handshake, consider registering an X.509 CRT verification
3618 * callback through mbedtls_ssl_conf_verify() instead of calling
3619 * this function. Using mbedtls_ssl_conf_verify() also comes at
3620 * the benefit of allowing you to influence the verification
3621 * process, for example by masking expected and tolerated
3622 * verification failures.
3623 *
3624 * \warning You must not use the pointer returned by this function
3625 * after any further call to the SSL API, including
3626 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3627 * because the pointer might change during renegotiation,
3628 * which happens transparently to the user.
3629 * If you want to use the certificate across API calls,
3630 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003631 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003632const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3633#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003634
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003635#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003636/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003637 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003638 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003639 * \param ssl The SSL context representing the connection for which to
3640 * to export a session structure for later resumption.
3641 * \param session The target structure in which to store the exported session.
3642 * This must have been initialized with mbedtls_ssl_init_session()
3643 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003644 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01003645 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003646 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01003647 * ticket-based resumption will be considered. For TLS 1.3,
3648 * once implemented, sessions equate to tickets, and calling
3649 * this function multiple times will export the available
3650 * tickets one a time until no further tickets are available,
3651 * in which case MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE will
3652 * be returned.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003653 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003654 * \note Calling this function multiple times will only be useful
3655 * once TLS 1.3 is supported. For TLS 1.2 connections, this
3656 * function should be called at most once.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003657 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003658 * \return \c 0 if successful. In this case, \p session can be used for
3659 * session resumption by passing it to mbedtls_ssl_set_session(),
3660 * and serialized for storage via mbedtls_ssl_session_save().
3661 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no further session
3662 * is available for export.
3663 * This error is a non-fatal, and has no observable effect on
3664 * the SSL context or the destination session.
3665 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003666 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003667 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003668 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003669 */
Hanno Beckere810bbc2021-05-14 16:01:05 +01003670int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
3671 mbedtls_ssl_session *session );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003672#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003673
3674/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003675 * \brief Perform the SSL handshake
3676 *
3677 * \param ssl SSL context
3678 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003679 * \return \c 0 if successful.
3680 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003681 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003682 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003683 * transport - in this case you must call this function again
3684 * when the underlying transport is ready for the operation.
3685 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3686 * operation is in progress (see
3687 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3688 * must call this function again when the operation is ready.
3689 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3690 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3691 * in this case you must call this function again to complete
3692 * the handshake when you're done attending other tasks.
3693 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3694 * and the client did not demonstrate reachability yet - in
3695 * this case you must stop using the context (see below).
3696 * \return Another SSL error code - in this case you must stop using
3697 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003698 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003699 * \warning If this function returns something other than
3700 * \c 0,
3701 * #MBEDTLS_ERR_SSL_WANT_READ,
3702 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3703 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3704 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3705 * you must stop using the SSL context for reading or writing,
3706 * and either free it or call \c mbedtls_ssl_session_reset()
3707 * on it before re-using it for a new connection; the current
3708 * connection must be closed.
3709 *
3710 * \note If DTLS is in use, then you may choose to handle
3711 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3712 * purposes, as it is an expected return value rather than an
3713 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003714 *
3715 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003716 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003717 * from the underlying transport layer is currently being processed,
3718 * and it is safe to idle until the timer or the underlying transport
3719 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003720 * in which case the datagram of the underlying transport that is
3721 * currently being processed might or might not contain further
3722 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003723 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003724int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003725
3726/**
Paul Bakker1961b702013-01-25 14:49:24 +01003727 * \brief Perform a single step of the SSL handshake
3728 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003729 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003730 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003731 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003732 *
3733 * \param ssl SSL context
3734 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003735 * \return See mbedtls_ssl_handshake().
3736 *
3737 * \warning If this function returns something other than \c 0,
3738 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3739 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3740 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3741 * the SSL context for reading or writing, and either free it
3742 * or call \c mbedtls_ssl_session_reset() on it before
3743 * re-using it for a new connection; the current connection
3744 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003745 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003746int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003747
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003748#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003749/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003750 * \brief Initiate an SSL renegotiation on the running connection.
3751 * Client: perform the renegotiation right now.
3752 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003753 * during the next call to mbedtls_ssl_read() if honored by
3754 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003755 *
3756 * \param ssl SSL context
3757 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003758 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003759 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3760 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003761 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003762 * \warning If this function returns something other than \c 0,
3763 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3764 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3765 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3766 * the SSL context for reading or writing, and either free it
3767 * or call \c mbedtls_ssl_session_reset() on it before
3768 * re-using it for a new connection; the current connection
3769 * must be closed.
3770 *
Paul Bakker48916f92012-09-16 19:57:18 +00003771 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003772int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3773#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003774
3775/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003776 * \brief Read at most 'len' application data bytes
3777 *
3778 * \param ssl SSL context
3779 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003780 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003781 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003782 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003783 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04003784 * without sending a CloseNotify beforehand, which might happen
3785 * because of various reasons (internal error of an underlying
3786 * stack, non-conformant peer not sending a CloseNotify and
3787 * such) - in this case you must stop using the context
3788 * (see below).
3789 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
3790 * transport is still functional, but the peer has
3791 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003792 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003793 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003794 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003795 * transport - in this case you must call this function again
3796 * when the underlying transport is ready for the operation.
3797 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3798 * operation is in progress (see
3799 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3800 * must call this function again when the operation is ready.
3801 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3802 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3803 * in this case you must call this function again to complete
3804 * the handshake when you're done attending other tasks.
3805 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3806 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003807 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003808 * \return Another SSL error code - in this case you must stop using
3809 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003810 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003811 * \warning If this function returns something other than
3812 * a positive value,
3813 * #MBEDTLS_ERR_SSL_WANT_READ,
3814 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3815 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3816 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3817 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3818 * you must stop using the SSL context for reading or writing,
3819 * and either free it or call \c mbedtls_ssl_session_reset()
3820 * on it before re-using it for a new connection; the current
3821 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003822 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003823 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003824 * (which can only happen server-side), it means that a client
3825 * is initiating a new connection using the same source port.
3826 * You can either treat that as a connection close and wait
3827 * for the client to resend a ClientHello, or directly
3828 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003829 * context (as it has been reset internally). Either way, you
3830 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003831 * connection: application state, if any, should be reset, and
3832 * most importantly the identity of the client must be checked
3833 * again. WARNING: not validating the identity of the client
3834 * again, or not transmitting the new identity to the
3835 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003836 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003837 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003838 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003839 * from the underlying transport layer is currently being processed,
3840 * and it is safe to idle until the timer or the underlying transport
3841 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003842 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3843 * initially available on the underlying transport, as this data may have
3844 * been only e.g. duplicated messages or a renegotiation request.
3845 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3846 * when reacting to an incoming-data event from the underlying transport.
3847 * - On success, the datagram of the underlying transport that is currently
3848 * being processed may contain further DTLS records. You should call
3849 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003850 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003851 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003852int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003853
3854/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003855 * \brief Try to write exactly 'len' application data bytes
3856 *
3857 * \warning This function will do partial writes in some cases. If the
3858 * return value is non-negative but less than length, the
3859 * function must be called again with updated arguments:
3860 * buf + ret, len - ret (if ret is the return value) until
3861 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003862 *
3863 * \param ssl SSL context
3864 * \param buf buffer holding the data
3865 * \param len how many bytes must be written
3866 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003867 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003868 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003869 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003870 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003871 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003872 * transport - in this case you must call this function again
3873 * when the underlying transport is ready for the operation.
3874 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3875 * operation is in progress (see
3876 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3877 * must call this function again when the operation is ready.
3878 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3879 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3880 * in this case you must call this function again to complete
3881 * the handshake when you're done attending other tasks.
3882 * \return Another SSL error code - in this case you must stop using
3883 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003884 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003885 * \warning If this function returns something other than
3886 * a non-negative value,
3887 * #MBEDTLS_ERR_SSL_WANT_READ,
3888 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3889 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3890 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3891 * you must stop using the SSL context for reading or writing,
3892 * and either free it or call \c mbedtls_ssl_session_reset()
3893 * on it before re-using it for a new connection; the current
3894 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003895 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003896 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003897 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003898 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003899 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003900 * some partial data in the output buffer, however this is not
3901 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003902 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003903 * \note If the requested length is greater than the maximum
3904 * fragment length (either the built-in limit or the one set
3905 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003906 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003907 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01003908 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003909 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003910 *
3911 * \note Attempting to write 0 bytes will result in an empty TLS
3912 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003913 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003914int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003915
3916/**
Paul Bakker0a925182012-04-16 06:46:41 +00003917 * \brief Send an alert message
3918 *
3919 * \param ssl SSL context
3920 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003921 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003922 * \param message The alert message (SSL_ALERT_MSG_*)
3923 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003924 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003925 *
3926 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003927 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3928 * the SSL context for reading or writing, and either free it or
3929 * call \c mbedtls_ssl_session_reset() on it before re-using it
3930 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003931 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003932int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003933 unsigned char level,
3934 unsigned char message );
3935/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003936 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003937 *
3938 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003939 *
3940 * \return 0 if successful, or a specific SSL error code.
3941 *
3942 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003943 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3944 * the SSL context for reading or writing, and either free it or
3945 * call \c mbedtls_ssl_session_reset() on it before re-using it
3946 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003947 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003948int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003949
3950/**
Paul Bakker48916f92012-09-16 19:57:18 +00003951 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003952 *
3953 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003954 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003955void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003956
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003957#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003958/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003959 * \brief Save an active connection as serialized data in a buffer.
3960 * This allows the freeing or re-using of the SSL context
3961 * while still picking up the connection later in a way that
3962 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003963 *
3964 * \see mbedtls_ssl_context_load()
3965 *
3966 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003967 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003968 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
3969 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003970 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003971 * mbedtls_ssl_session_reset() on \p ssl which as a result is
3972 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02003973 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003974 * state. You're then free to either re-use the context
3975 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02003976 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003977 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003978 *
3979 * \param ssl The SSL context to save. On success, it is no longer
3980 * associated with the connection that has been serialized.
3981 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03003982 * writeable buffer of at least \p buf_len bytes, or may be \c
3983 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003984 * \param buf_len The number of bytes available for writing in \p buf.
3985 * \param olen The size in bytes of the data that has been or would have
3986 * been written. It must point to a valid \c size_t.
3987 *
3988 * \note \p olen is updated to the correct value regardless of
3989 * whether \p buf_len was large enough. This makes it possible
3990 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02003991 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
3992 * the value of \p olen is only guaranteed to be correct when
3993 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
3994 * \c 0. If the return value is different, then the value of
3995 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003996 *
3997 * \return \c 0 if successful.
3998 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02003999 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
4000 * while reseting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004001 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004002 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004003 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004004 * ciphersuite, or renegotiation is enabled.
4005 */
4006int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4007 unsigned char *buf,
4008 size_t buf_len,
4009 size_t *olen );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004010
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004011/**
4012 * \brief Load serialized connection data to an SSL context.
4013 *
4014 * \see mbedtls_ssl_context_save()
4015 *
4016 * \warning The same serialized data must never be loaded into more
4017 * that one context. In order to ensure that, after
4018 * successfully loading serialized data to an SSL context, you
4019 * should immediately destroy or invalidate all copies of the
4020 * serialized data that was loaded. Loading the same data in
4021 * more than one context would cause severe security failures
4022 * including but not limited to loss of confidentiality.
4023 *
4024 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004025 * prepared in one of the two following ways. The first way is
4026 * to take a context freshly initialised with
4027 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004028 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004029 * the original connection. The second way is to
4030 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004031 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004032 * Either way, you must not use the context to perform a
4033 * handshake between calling mbedtls_ssl_setup() or
4034 * mbedtls_ssl_session_reset() and calling this function. You
4035 * may however call other setter functions in that time frame
4036 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004037 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004038 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004039 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004040 * and settings before you can use the connection again
4041 * (unless they were already set before calling
4042 * mbedtls_ssl_session_reset() and the values are suitable for
4043 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02004044 * at least mbedtls_ssl_set_bio() and
4045 * mbedtls_ssl_set_timer_cb(). All other SSL setter functions
4046 * are not necessary to call, either because they're only used
4047 * in handshakes, or because the setting is already saved. You
4048 * might choose to call them anyway, for example in order to
4049 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004050 * connection and the case of loading an already-established
4051 * connection.
4052 *
4053 * \note If you have new information about the path MTU, you want to
4054 * call mbedtls_ssl_set_mtu() after calling this function, as
4055 * otherwise this function would overwrite your
4056 * newly-configured value with the value that was active when
4057 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004058 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004059 * \note When this function returns an error code, it calls
4060 * mbedtls_ssl_free() on \p ssl. In this case, you need to
4061 * prepare the context with the usual sequence starting with a
4062 * call to mbedtls_ssl_init() if you want to use it again.
4063 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004064 * \param ssl The SSL context structure to be populated. It must have
4065 * been prepared as described in the note above.
4066 * \param buf The buffer holding the serialized connection data. It must
4067 * be a readable buffer of at least \p len bytes.
4068 * \param len The size of the serialized data in bytes.
4069 *
4070 * \return \c 0 if successful.
4071 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004072 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
4073 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004074 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4075 */
4076int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
4077 const unsigned char *buf,
4078 size_t len );
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004079#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004080
4081/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004082 * \brief Initialize an SSL configuration context
4083 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004084 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004085 *
4086 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01004087 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004088 *
4089 * \param conf SSL configuration context
4090 */
4091void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
4092
4093/**
4094 * \brief Load reasonnable default SSL configuration values.
4095 * (You need to call mbedtls_ssl_config_init() first.)
4096 *
4097 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004098 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4099 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4100 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004101 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004102 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004103 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004104 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004105 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004106 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004107 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004108int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004109 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004110
4111/**
4112 * \brief Free an SSL configuration context
4113 *
4114 * \param conf SSL configuration context
4115 */
4116void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
4117
4118/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004119 * \brief Initialize SSL session structure
4120 *
4121 * \param session SSL session
4122 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004123void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004124
4125/**
Paul Bakker0a597072012-09-25 21:55:46 +00004126 * \brief Free referenced items in an SSL session including the
4127 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004128 *
Ron Eldor00115032018-07-17 11:21:50 +03004129 * \note A session object can be freed even if the SSL context
4130 * that was used to retrieve the session is still in use.
4131 *
Paul Bakker48916f92012-09-16 19:57:18 +00004132 * \param session SSL session
4133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004134void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00004135
Ron Eldor51d3ab52019-05-12 14:54:30 +03004136/**
4137 * \brief TLS-PRF function for key derivation.
4138 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004139 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004140 * \param secret Secret for the key derivation function.
4141 * \param slen Length of the secret.
4142 * \param label String label for the key derivation function,
4143 * terminated with null character.
4144 * \param random Random bytes.
4145 * \param rlen Length of the random bytes buffer.
4146 * \param dstbuf The buffer holding the derived key.
4147 * \param dlen Length of the output buffer.
4148 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004149 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004150 */
4151int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
4152 const unsigned char *secret, size_t slen,
4153 const char *label,
4154 const unsigned char *random, size_t rlen,
4155 unsigned char *dstbuf, size_t dlen );
4156
Paul Bakker5121ce52009-01-03 21:22:43 +00004157#ifdef __cplusplus
4158}
4159#endif
4160
4161#endif /* ssl.h */