blob: 32ed6385c60d55607c57688d32a986b17c88b25a [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Amero6609aef2019-07-04 20:01:14 +010027#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020028#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020030#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010031
Jaeden Amero6609aef2019-07-04 20:01:14 +010032#include "mbedtls/bignum.h"
33#include "mbedtls/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020034
Jaeden Amero6609aef2019-07-04 20:01:14 +010035#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000036
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020037#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010038#include "mbedtls/x509_crt.h"
39#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020040#endif
Paul Bakkered27a042013-04-18 22:46:23 +020041
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020042#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010043#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000044#endif
45
John Durkop07cc04a2020-11-16 22:08:34 -080046/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
47 * to guards also being in ssl_srv.c and ssl_cli.c. There is a gap
48 * in functionality that access to ecdh_ctx structure is needed for
49 * MBEDTLS_ECDSA_C which does not seem correct.
50 */
51#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010052#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010053#endif
54
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010056#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020057#endif
58
Hanno Becker43633132018-10-22 15:31:03 +010059#if defined(MBEDTLS_USE_PSA_CRYPTO)
60#include "psa/crypto.h"
61#endif /* MBEDTLS_USE_PSA_CRYPTO */
62
Paul Bakker13e2dfe2009-07-28 07:18:38 +000063/*
64 * SSL Error codes
65 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020066#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
67#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
68#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
69#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
70#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
Hanno Beckerb86e5882021-04-30 05:14:25 +010071/* NOTE: Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020072#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
73#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
74#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
Hanno Becker91e1cc32021-04-30 05:28:49 +010075/* NOTE: Error space gap */
Hanno Becker3268d842021-04-30 05:41:12 +010076/* NOTE: Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
78#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
79#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
80#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
Hanno Beckereca840f2021-04-30 05:19:55 +010081/* NOTE: Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020082#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
83#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
84#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
85#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
86#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
87#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
88#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
89#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
90#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
91#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
92#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
93#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
94#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020095#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020096#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
97#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020098#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
99#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
100#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
101#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
102#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
103#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
104#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
105#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
106#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
107#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
108#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
Hanno Becker8ec81022017-10-10 10:35:08 +0100109#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 +0100110#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
111#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200112#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 +0100113#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100114#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
Hanno Becker56ee9e52021-04-30 05:36:02 +0100115/* NOTE: Error space gap */
Hanno Becker8ec81022017-10-10 10:35:08 +0100116#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 +0200117#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100118#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Hanno Beckerc37c96a2019-05-14 11:02:36 +0100119#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000 /**< An encrypted DTLS-frame with an unexpected CID was received. */
Hanno Beckerf9b33032019-06-03 12:58:39 +0100120#define MBEDTLS_ERR_SSL_VERSION_MISMATCH -0x5F00 /**< An operation failed due to an unexpected version or configuration. */
Manuel Pégourié-Gonnard125af942018-09-11 11:08:12 +0200121#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Hanno Beckerb4c0b752017-04-12 14:54:42 +0100122#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80 /**< Invalid value in SSL config */
Paul Bakker5121ce52009-01-03 21:22:43 +0000123
124/*
125 * Various constants
126 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100127
128/* These are the high an low bytes of ProtocolVersion as defined by:
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100129 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
130 * - RFC 8446: see section 4.2.1
131 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200132#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Hanno Becker2ab47dc2020-05-04 12:19:12 +0100134#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 (experimental) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000135
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200136#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
137#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100138
Simon Butcher9f812312015-09-28 19:22:33 +0100139#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200140#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
141
142#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 +0100143
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200144/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200145 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200146#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
147#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
148#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
149#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
150#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
151#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153#define MBEDTLS_SSL_IS_CLIENT 0
154#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
157#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200158
Hanno Becker019f4b52019-04-09 15:12:56 +0100159#define MBEDTLS_SSL_CID_DISABLED 0
160#define MBEDTLS_SSL_CID_ENABLED 1
161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162#define MBEDTLS_SSL_ETM_DISABLED 0
163#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100164
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200165#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167#define MBEDTLS_SSL_VERIFY_NONE 0
168#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
169#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200170#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
173#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000174
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200175#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
176#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
179#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
182#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
185#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
186#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000187
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200188#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
189#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
190#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200191
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200192#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
193#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200194
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200195#define MBEDTLS_SSL_PRESET_DEFAULT 0
196#define MBEDTLS_SSL_PRESET_SUITEB 2
197
Janos Follath088ce432017-04-10 12:42:31 +0100198#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
199#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
200
Ron Eldor591f1622018-01-22 12:30:04 +0200201#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
202#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
203
TRodziewicz3946f792021-06-14 12:11:18 +0200204#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT 1
205#define MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER 0
TRodziewicz8476f2f2021-06-02 14:34:47 +0200206
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200207/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200208 * Default range for DTLS retransmission timer value, in milliseconds.
209 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
210 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
212#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200213
Paul Bakker088c5c52014-04-25 11:11:10 +0200214/**
215 * \name SECTION: Module settings
216 *
217 * The configuration options you can set for this module are in this section.
218 * Either change them in config.h or define them on the compiler command line.
219 * \{
220 */
221
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200222/*
Angus Grattond8213d02016-05-25 20:56:48 +1000223 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200224 * determines the size of each of the two internal I/O buffers.
225 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200226 * Note: the RFC defines the default size of SSL / TLS messages. If you
227 * change the value here, other clients / servers may not be able to
228 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200229 * both sides of the connection and have it reduced at both sides, or
230 * if you're using the Max Fragment Length extension and you know all your
231 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200232 */
Angus Grattond8213d02016-05-25 20:56:48 +1000233#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100234#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000235#endif
236
237#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100238#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000239#endif
240
Hanno Becker28007512018-08-28 09:46:44 +0100241/*
242 * Maximum number of heap-allocated bytes for the purpose of
243 * DTLS handshake message reassembly and future message buffering.
244 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100245#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100246#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100247#endif
248
Hanno Becker019f4b52019-04-09 15:12:56 +0100249/*
250 * Maximum length of CIDs for incoming and outgoing messages.
251 */
252#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100253#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100254#endif
255
256#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
257#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
258#endif
259
TRodziewicze8dd7092021-05-12 14:19:11 +0200260#if !defined(MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY)
261#define MBEDTLS_SSL_CID_TLS1_3_PADDING_GRANULARITY 16
Hanno Becker13996922020-05-28 16:15:19 +0100262#endif
263
Paul Bakker088c5c52014-04-25 11:11:10 +0200264/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000265
266/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100267 * Length of the verify data for secure renegotiation
268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200269#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100270
271/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200272 * Signaling ciphersuite values (SCSV)
273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200274#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Paul Bakker48916f92012-09-16 19:57:18 +0000275
Paul Bakker5121ce52009-01-03 21:22:43 +0000276/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000277 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200278 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000279 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280#define MBEDTLS_SSL_HASH_NONE 0
281#define MBEDTLS_SSL_HASH_MD5 1
282#define MBEDTLS_SSL_HASH_SHA1 2
283#define MBEDTLS_SSL_HASH_SHA224 3
284#define MBEDTLS_SSL_HASH_SHA256 4
285#define MBEDTLS_SSL_HASH_SHA384 5
286#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288#define MBEDTLS_SSL_SIG_ANON 0
289#define MBEDTLS_SSL_SIG_RSA 1
290#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000291
292/*
Paul Bakker926af752012-11-23 13:38:07 +0100293 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200294 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
297#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100298
299/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000300 * Message, alert and handshake types
301 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
303#define MBEDTLS_SSL_MSG_ALERT 21
304#define MBEDTLS_SSL_MSG_HANDSHAKE 22
305#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100306#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
309#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
312#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
313#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
314#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
315#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
316#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
317#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
318#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
319#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
320#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
321#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
322#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
323#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
324#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
325#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
326#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
327#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
328#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
329#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
330#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
331#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
332#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
333#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
334#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
335#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
336#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
337#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
338#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
339#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
342#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
343#define MBEDTLS_SSL_HS_SERVER_HELLO 2
344#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
345#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
346#define MBEDTLS_SSL_HS_CERTIFICATE 11
347#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
348#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
349#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
350#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
351#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
352#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000353
354/*
355 * TLS extensions
356 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357#define MBEDTLS_TLS_EXT_SERVERNAME 0
358#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000359
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200361
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200362#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200363
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200364#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
365#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000366
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200367#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100368
Johan Pascalb62bb512015-12-03 21:56:45 +0100369#define MBEDTLS_TLS_EXT_USE_SRTP 14
370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
374#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200377
Hanno Becker0652bc52019-04-25 16:24:57 +0100378/* The value of the CID extension is still TBD as of
Hanno Beckerebcc9132019-05-15 10:26:32 +0100379 * draft-ietf-tls-dtls-connection-id-05
380 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) */
Hanno Becker064b7322019-05-03 12:42:13 +0100381#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker0652bc52019-04-25 16:24:57 +0100382
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200383#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000386
Johan Pascalb62bb512015-12-03 21:56:45 +0100387/*
Paul Bakkered27a042013-04-18 22:46:23 +0200388 * Size defines
389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200390#if !defined(MBEDTLS_PSK_MAX_LEN)
391#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200392#endif
393
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200394/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200395union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200396{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200397#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200398 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
399#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
401 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200402#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
404 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
405 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
406 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
407 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200408#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200409#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
410 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200411#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
413 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
414 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
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_RSA_PSK_ENABLED)
417 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200418#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
420 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
421 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200422#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200423#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
424 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
425#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200426};
427
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200428#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200429
Paul Bakker407a0da2013-06-27 14:29:21 +0200430#ifdef __cplusplus
431extern "C" {
432#endif
433
Paul Bakkered27a042013-04-18 22:46:23 +0200434/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000435 * SSL state machine
436 */
437typedef enum
438{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200439 MBEDTLS_SSL_HELLO_REQUEST,
440 MBEDTLS_SSL_CLIENT_HELLO,
441 MBEDTLS_SSL_SERVER_HELLO,
442 MBEDTLS_SSL_SERVER_CERTIFICATE,
443 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
444 MBEDTLS_SSL_CERTIFICATE_REQUEST,
445 MBEDTLS_SSL_SERVER_HELLO_DONE,
446 MBEDTLS_SSL_CLIENT_CERTIFICATE,
447 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
448 MBEDTLS_SSL_CERTIFICATE_VERIFY,
449 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
450 MBEDTLS_SSL_CLIENT_FINISHED,
451 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
452 MBEDTLS_SSL_SERVER_FINISHED,
453 MBEDTLS_SSL_FLUSH_BUFFERS,
454 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
455 MBEDTLS_SSL_HANDSHAKE_OVER,
456 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
457 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000458}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200459mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000460
Ron Eldor51d3ab52019-05-12 14:54:30 +0300461/*
462 * The tls_prf function types.
463 */
464typedef enum
465{
466 MBEDTLS_SSL_TLS_PRF_NONE,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467 MBEDTLS_SSL_TLS_PRF_TLS1,
468 MBEDTLS_SSL_TLS_PRF_SHA384,
469 MBEDTLS_SSL_TLS_PRF_SHA256
470}
471mbedtls_tls_prf_types;
Hanno Beckera637ff62021-04-15 08:42:48 +0100472
Simon Butchere846b512016-03-01 17:31:49 +0000473/**
474 * \brief Callback type: send data on the network.
475 *
476 * \note That callback may be either blocking or non-blocking.
477 *
478 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000479 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000480 * \param len Length of the data to send
481 *
482 * \return The callback must return the number of bytes sent if any,
483 * or a non-zero error code.
484 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
485 * must be returned when the operation would block.
486 *
Simon Butcherd567a232016-03-09 20:19:21 +0000487 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000488 * It must always return the number of bytes actually sent.
489 */
490typedef int mbedtls_ssl_send_t( void *ctx,
491 const unsigned char *buf,
492 size_t len );
493
494/**
495 * \brief Callback type: receive data from the network.
496 *
497 * \note That callback may be either blocking or non-blocking.
498 *
499 * \param ctx Context for the receive callback (typically a file
500 * descriptor)
501 * \param buf Buffer to write the received data to
502 * \param len Length of the receive buffer
503 *
504 * \return The callback must return the number of bytes received,
505 * or a non-zero error code.
506 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
507 * must be returned when the operation would block.
508 *
Simon Butcherd567a232016-03-09 20:19:21 +0000509 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000510 * buffer. It must always return the number of bytes actually
511 * received and written to the buffer.
512 */
513typedef int mbedtls_ssl_recv_t( void *ctx,
514 unsigned char *buf,
515 size_t len );
516
517/**
518 * \brief Callback type: receive data from the network, with timeout
519 *
520 * \note That callback must block until data is received, or the
521 * timeout delay expires, or the operation is interrupted by a
522 * signal.
523 *
524 * \param ctx Context for the receive callback (typically a file descriptor)
525 * \param buf Buffer to write the received data to
526 * \param len Length of the receive buffer
527 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000528 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000529 *
530 * \return The callback must return the number of bytes received,
531 * or a non-zero error code:
532 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
533 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
534 *
Simon Butcherd567a232016-03-09 20:19:21 +0000535 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000536 * buffer. It must always return the number of bytes actually
537 * received and written to the buffer.
538 */
539typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
540 unsigned char *buf,
541 size_t len,
542 uint32_t timeout );
543/**
544 * \brief Callback type: set a pair of timers/delays to watch
545 *
546 * \param ctx Context pointer
547 * \param int_ms Intermediate delay in milliseconds
548 * \param fin_ms Final delay in milliseconds
549 * 0 cancels the current timer.
550 *
551 * \note This callback must at least store the necessary information
552 * for the associated \c mbedtls_ssl_get_timer_t callback to
553 * return correct information.
554 *
555 * \note If using a event-driven style of programming, an event must
556 * be generated when the final delay is passed. The event must
557 * cause a call to \c mbedtls_ssl_handshake() with the proper
558 * SSL context to be scheduled. Care must be taken to ensure
559 * that at most one such call happens at a time.
560 *
561 * \note Only one timer at a time must be running. Calling this
562 * function while a timer is running must cancel it. Cancelled
563 * timers must not generate any event.
564 */
565typedef void mbedtls_ssl_set_timer_t( void * ctx,
566 uint32_t int_ms,
567 uint32_t fin_ms );
568
569/**
570 * \brief Callback type: get status of timers/delays
571 *
572 * \param ctx Context pointer
573 *
574 * \return This callback must return:
575 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000576 * 0 if none of the delays have passed,
577 * 1 if only the intermediate delay has passed,
578 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000579 */
580typedef int mbedtls_ssl_get_timer_t( void * ctx );
581
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200582/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583typedef struct mbedtls_ssl_session mbedtls_ssl_session;
584typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200585typedef struct mbedtls_ssl_config mbedtls_ssl_config;
586
Chris Jones3848e312021-03-11 16:17:59 +0000587/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200588typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
589typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100590typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200591#if defined(MBEDTLS_X509_CRT_PARSE_C)
592typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200593#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594#if defined(MBEDTLS_SSL_PROTO_DTLS)
595typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200596#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000597
Hanno Becker02487852021-05-13 06:26:57 +0100598/**
599 * \brief Callback type: server-side session cache getter
600 *
601 * The session cache is logically a key value store, with
602 * keys being session IDs and values being instances of
603 * mbedtls_ssl_session.
604 *
605 * This callback retrieves an entry in this key-value store.
606 *
607 * \param data The address of the session cache structure to query.
608 * \param session_id The buffer holding the session ID to query.
609 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100610 * \param session The address of the session structure to populate.
611 * It is initialized with mbdtls_ssl_session_init(),
612 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100613 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100614 * mbedtls_ssl_session_free() independent of the
615 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100616 *
617 * \return \c 0 on success
618 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100619 *
Hanno Becker02487852021-05-13 06:26:57 +0100620 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100621typedef int mbedtls_ssl_cache_get_t( void *data,
622 unsigned char const *session_id,
623 size_t session_id_len,
624 mbedtls_ssl_session *session );
Hanno Becker02487852021-05-13 06:26:57 +0100625/**
626 * \brief Callback type: server-side session cache setter
627 *
628 * The session cache is logically a key value store, with
629 * keys being session IDs and values being instances of
630 * mbedtls_ssl_session.
631 *
632 * This callback sets an entry in this key-value store.
633 *
634 * \param data The address of the session cache structure to modify.
635 * \param session_id The buffer holding the session ID to query.
636 * \param session_id_len The length of \p session_id in Bytes.
637 * \param session The address of the session to be stored in the
638 * session cache.
639 *
640 * \return \c 0 on success
641 * \return A non-zero return value on failure.
642 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100643typedef int mbedtls_ssl_cache_set_t( void *data,
644 unsigned char const *session_id,
645 size_t session_id_len,
646 const mbedtls_ssl_session *session );
Hanno Beckera637ff62021-04-15 08:42:48 +0100647
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200648#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100649#if defined(MBEDTLS_X509_CRT_PARSE_C)
650/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200651 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100652 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200653 * This callback is called during an SSL handshake to start
654 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200655 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100656 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200657 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100658 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200659 * This function typically sends or enqueues a request, and
660 * does not wait for the operation to complete. This allows
661 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100662 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200663 * The parameters \p ssl and \p cert are guaranteed to remain
664 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200665 * function must save the contents of \p hash if the value
666 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200667 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100668 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200669 * This function may call mbedtls_ssl_set_async_operation_data()
670 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200671 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200672 *
Gilles Peskined3268832018-04-26 06:23:59 +0200673 * \note For RSA signatures, this function must produce output
674 * that is consistent with PKCS#1 v1.5 in the same way as
675 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
676 * apply the padding steps described in RFC 8017, section 9.2
677 * "EMSA-PKCS1-v1_5" as follows.
678 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
679 * encoding, treating \p hash as the DigestInfo to be
680 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
681 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200682 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200683 * encoding, treating \p hash as the hash to be encoded and
684 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
685 * from step 2, with `digestAlgorithm` obtained by calling
686 * mbedtls_oid_get_oid_by_md() on \p md_alg.
687 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200688 * \note For ECDSA signatures, the output format is the DER encoding
689 * `Ecdsa-Sig-Value` defined in
690 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
691 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200692 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200693 * modified other than via
694 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200695 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200696 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200697 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200698 * connection. However, if other callbacks are used, this
699 * property may not hold. For example, if an SNI callback
700 * is registered with mbedtls_ssl_conf_sni(), then
701 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200702 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100703 * \param hash Buffer containing the hash. This buffer is
704 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200705 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100706 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200707 * \return 0 if the operation was started successfully and the SSL
708 * stack should call the resume callback immediately.
709 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
710 * was started successfully and the SSL stack should return
711 * immediately without calling the resume callback yet.
712 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
713 * processor does not support this key. The SSL stack will
714 * use the private key object instead.
715 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200716 * propagated up the call chain. The callback should
717 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
718 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200719 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100720 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200721typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100722 mbedtls_x509_crt *cert,
723 mbedtls_md_type_t md_alg,
724 const unsigned char *hash,
725 size_t hash_len );
726
727/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200728 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100729 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200730 * This callback is called during an SSL handshake to start
731 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200732 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100733 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200734 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100735 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200736 * This function typically sends or enqueues a request, and
737 * does not wait for the operation to complete. This allows
738 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100739 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200740 * The parameters \p ssl and \p cert are guaranteed to remain
741 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200742 * function must save the contents of \p input if the value
743 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200744 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100745 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200746 * This function may call mbedtls_ssl_set_async_operation_data()
747 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200748 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200749 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200750 * \warning RSA decryption as used in TLS is subject to a potential
751 * timing side channel attack first discovered by Bleichenbacher
752 * in 1998. This attack can be remotely exploitable
753 * in practice. To avoid this attack, you must ensure that
754 * if the callback performs an RSA decryption, the time it
755 * takes to execute and return the result does not depend
756 * on whether the RSA decryption succeeded or reported
757 * invalid padding.
758 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200759 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200760 * modified other than via
761 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200762 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200763 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200764 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200765 * connection. However, if other callbacks are used, this
766 * property may not hold. For example, if an SNI callback
767 * is registered with mbedtls_ssl_conf_sni(), then
768 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100769 * \param input Buffer containing the input ciphertext. This buffer
770 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200771 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100772 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200773 * \return 0 if the operation was started successfully and the SSL
774 * stack should call the resume callback immediately.
775 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
776 * was started successfully and the SSL stack should return
777 * immediately without calling the resume callback yet.
778 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
779 * processor does not support this key. The SSL stack will
780 * use the private key object instead.
781 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200782 * propagated up the call chain. The callback should
783 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
784 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200785 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100786 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200787typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100788 mbedtls_x509_crt *cert,
789 const unsigned char *input,
790 size_t input_len );
791#endif /* MBEDTLS_X509_CRT_PARSE_C */
792
793/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200794 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100795 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200796 * This callback is called during an SSL handshake to resume
797 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200798 * ::mbedtls_ssl_async_sign_t or
799 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200800 *
801 * This function typically checks the status of a pending
802 * request or causes the request queue to make progress, and
803 * does not wait for the operation to complete. This allows
804 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100805 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200806 * This function may call mbedtls_ssl_get_async_operation_data()
807 * to retrieve an operation context set by the start callback.
808 * It may call mbedtls_ssl_set_async_operation_data() to modify
809 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200810 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200811 * Note that when this function returns a status other than
812 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
813 * resources associated with the operation.
814 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200815 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200816 * modified other than via
817 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200818 * \param output Buffer containing the output (signature or decrypted
819 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200820 * \param output_len On success, number of bytes written to \p output.
821 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100822 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200823 * \return 0 if output of the operation is available in the
824 * \p output buffer.
825 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
826 * is still in progress. Subsequent requests for progress
827 * on the SSL connection will call the resume callback
828 * again.
829 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200830 * The SSL handshake is aborted. The callback should
831 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
832 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200833 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100834 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200835typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100836 unsigned char *output,
837 size_t *output_len,
838 size_t output_size );
839
840/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200841 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100842 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200843 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200844 * while an asynchronous operation is in progress. Note that
845 * this callback is not called if the
846 * ::mbedtls_ssl_async_resume_t callback has run and has
847 * returned a value other than
848 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
849 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100850 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200851 * This function may call mbedtls_ssl_get_async_operation_data()
852 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200853 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200854 * \param ssl The SSL connection instance. It should not be
855 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100856 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200857typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200858#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000859
Gilles Peskineeccd8882020-03-10 12:19:08 +0100860#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000861 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000862#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
863#if defined(MBEDTLS_SHA256_C)
864#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
865#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +0200866#elif defined(MBEDTLS_SHA384_C)
Hanno Becker9198ad12019-02-05 17:00:50 +0000867#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
868#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
869#elif defined(MBEDTLS_SHA1_C)
870#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
871#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
872#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000873/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000874#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
875#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +0100876#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000877 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000878
Johan Pascalb62bb512015-12-03 21:56:45 +0100879#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +0200880
Johan Pascal85269572020-08-25 10:01:54 +0200881#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +0200882#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +0100883/*
Johan Pascal43f94902020-09-22 12:25:52 +0200884 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200885 *
886 * Use_srtp extension protection profiles values as defined in
887 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
888 *
889 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
890 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +0100891 */
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200892#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ( (uint16_t) 0x0001)
893#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ( (uint16_t) 0x0002)
894#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ( (uint16_t) 0x0005)
895#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ( (uint16_t) 0x0006)
896/* This one is not iana defined, but for code readability. */
897#define MBEDTLS_TLS_SRTP_UNSET ( (uint16_t) 0x0000)
898
Johan Pascal43f94902020-09-22 12:25:52 +0200899typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +0300900
Ron Eldor3adb9922017-12-21 10:15:08 +0200901typedef struct mbedtls_dtls_srtp_info_t
902{
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200903 /*! The SRTP profile that was negotiated. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200904 mbedtls_ssl_srtp_profile MBEDTLS_PRIVATE(chosen_dtls_srtp_profile);
Johan Pascalf6417ec2020-09-22 15:15:19 +0200905 /*! The length of mki_value. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200906 uint16_t MBEDTLS_PRIVATE(mki_len);
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200907 /*! The mki_value used, with max size of 256 bytes. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200908 unsigned char MBEDTLS_PRIVATE(mki_value)[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +0300909}
910mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +0200911
Johan Pascalb62bb512015-12-03 21:56:45 +0100912#endif /* MBEDTLS_SSL_DTLS_SRTP */
913
Paul Bakker5121ce52009-01-03 21:22:43 +0000914/*
Paul Bakker0a597072012-09-25 21:55:46 +0000915 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200916 *
917 * Note: when changing this definition, we need to check and update:
918 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +0200919 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200920 * - in library/ssl_tls.c:
921 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
922 * mbedtls_ssl_session_save() and ssl_session_load()
923 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000924 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000926{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200927#if defined(MBEDTLS_HAVE_TIME)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200928 mbedtls_time_t MBEDTLS_PRIVATE(start); /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200929#endif
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200930 int MBEDTLS_PRIVATE(ciphersuite); /*!< chosen ciphersuite */
931 int MBEDTLS_PRIVATE(compression); /*!< chosen compression */
932 size_t MBEDTLS_PRIVATE(id_len); /*!< session id length */
933 unsigned char MBEDTLS_PRIVATE(id)[32]; /*!< session identifier */
934 unsigned char MBEDTLS_PRIVATE(master)[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200935
Hanno Beckere810bbc2021-05-14 16:01:05 +0100936 unsigned char exported;
937
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000939#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200940 mbedtls_x509_crt *MBEDTLS_PRIVATE(peer_cert); /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000941#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000942 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
943 * changes during renegotiation, mitigating the triple handshake attack. */
Mateusz Starzyk2abe51c2021-06-07 11:08:01 +0200944 unsigned char *MBEDTLS_PRIVATE(peer_cert_digest);
945 size_t MBEDTLS_PRIVATE(peer_cert_digest_len);
946 mbedtls_md_type_t MBEDTLS_PRIVATE(peer_cert_digest_type);
Hanno Beckerabe6f662019-02-07 13:29:55 +0000947#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200948#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200949 uint32_t MBEDTLS_PRIVATE(verify_result); /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200950
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200951#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200952 unsigned char *MBEDTLS_PRIVATE(ticket); /*!< RFC 5077 session ticket */
953 size_t MBEDTLS_PRIVATE(ticket_len); /*!< session ticket length */
954 uint32_t MBEDTLS_PRIVATE(ticket_lifetime); /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200955#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200958 unsigned char MBEDTLS_PRIVATE(mfl_code); /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200959#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200960
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200961#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200962 int MBEDTLS_PRIVATE(encrypt_then_mac); /*!< flag for EtM activation */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100963#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000964};
965
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200966/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200967 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200968 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200969struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200970{
971 /* Group items by size (largest first) to minimize padding overhead */
972
973 /*
974 * Pointers
975 */
976
Hanno Beckerd60b6c62021-04-29 12:04:11 +0100977 /** Allowed ciphersuites for (D)TLS 1.2 (0-terminated) */
Ronald Cronc4c761e2021-06-14 16:17:32 +0200978 const int *MBEDTLS_PRIVATE(ciphersuite_list);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200979
980 /** Callback for printing debug output */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200981 void (*MBEDTLS_PRIVATE(f_dbg))(void *, int, const char *, int, const char *);
982 void *MBEDTLS_PRIVATE(p_dbg); /*!< context for the debug function */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200983
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100984 /** Callback for getting (pseudo-)random numbers */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200985 int (*MBEDTLS_PRIVATE(f_rng))(void *, unsigned char *, size_t);
986 void *MBEDTLS_PRIVATE(p_rng); /*!< context for the RNG function */
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100987
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200988 /** Callback to retrieve a session from the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200989 mbedtls_ssl_cache_get_t *MBEDTLS_PRIVATE(f_get_cache);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200990 /** Callback to store a session into the cache */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200991 mbedtls_ssl_cache_set_t *MBEDTLS_PRIVATE(f_set_cache);
992 void *MBEDTLS_PRIVATE(p_cache); /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200993
994#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
995 /** Callback for setting cert according to SNI extension */
Mateusz Starzyk846f0212021-05-19 19:44:07 +0200996 int (*MBEDTLS_PRIVATE(f_sni))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
997 void *MBEDTLS_PRIVATE(p_sni); /*!< context for SNI callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200998#endif
999
1000#if defined(MBEDTLS_X509_CRT_PARSE_C)
1001 /** Callback to customize X.509 certificate chain verification */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001002 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1003 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify calllback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001004#endif
1005
Gilles Peskineeccd8882020-03-10 12:19:08 +01001006#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001007 /** Callback to retrieve PSK key from identity */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001008 int (*MBEDTLS_PRIVATE(f_psk))(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1009 void *MBEDTLS_PRIVATE(p_psk); /*!< context for PSK callback */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001010#endif
1011
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001012#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001013 /** Callback to create & write a cookie for ClientHello veirifcation */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001014 int (*MBEDTLS_PRIVATE(f_cookie_write))( void *, unsigned char **, unsigned char *,
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001015 const unsigned char *, size_t );
1016 /** Callback to verify validity of a ClientHello cookie */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001017 int (*MBEDTLS_PRIVATE(f_cookie_check))( void *, const unsigned char *, size_t,
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001018 const unsigned char *, size_t );
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001019 void *MBEDTLS_PRIVATE(p_cookie); /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001020#endif
1021
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001022#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001023 /** Callback to create & write a session ticket */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001024 int (*MBEDTLS_PRIVATE(f_ticket_write))( void *, const mbedtls_ssl_session *,
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001025 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1026 /** Callback to parse a session ticket into a session structure */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001027 int (*MBEDTLS_PRIVATE(f_ticket_parse))( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1028 void *MBEDTLS_PRIVATE(p_ticket); /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001029#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001030
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001031#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001032 /** Callback to export key block and master secret */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001033 int (*MBEDTLS_PRIVATE(f_export_keys))( void *, const unsigned char *,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001034 const unsigned char *, size_t, size_t, size_t );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001035 /** Callback to export key block, master secret,
1036 * tls_prf and random bytes. Should replace f_export_keys */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001037 int (*MBEDTLS_PRIVATE(f_export_keys_ext))( void *, const unsigned char *,
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001038 const unsigned char *, size_t, size_t, size_t,
Jaeden Amero63d813d2019-09-12 10:09:57 +01001039 const unsigned char[32], const unsigned char[32],
1040 mbedtls_tls_prf_types );
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001041 void *MBEDTLS_PRIVATE(p_export_keys); /*!< context for key export callback */
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001042#endif
1043
Hanno Beckera0e20d02019-05-15 14:03:01 +01001044#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001045 size_t MBEDTLS_PRIVATE(cid_len); /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001046#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001047
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001048#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001049 const mbedtls_x509_crt_profile *MBEDTLS_PRIVATE(cert_profile); /*!< verification profile */
1050 mbedtls_ssl_key_cert *MBEDTLS_PRIVATE(key_cert); /*!< own certificate/key pair(s) */
1051 mbedtls_x509_crt *MBEDTLS_PRIVATE(ca_chain); /*!< trusted CAs */
1052 mbedtls_x509_crl *MBEDTLS_PRIVATE(ca_crl); /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001053#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001054 mbedtls_x509_crt_ca_cb_t MBEDTLS_PRIVATE(f_ca_cb);
1055 void *MBEDTLS_PRIVATE(p_ca_cb);
Hanno Becker5adaad92019-03-27 16:54:37 +00001056#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001057#endif /* MBEDTLS_X509_CRT_PARSE_C */
1058
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001059#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001060#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001061 mbedtls_ssl_async_sign_t *MBEDTLS_PRIVATE(f_async_sign_start); /*!< start asynchronous signature operation */
1062 mbedtls_ssl_async_decrypt_t *MBEDTLS_PRIVATE(f_async_decrypt_start); /*!< start asynchronous decryption operation */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001063#endif /* MBEDTLS_X509_CRT_PARSE_C */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001064 mbedtls_ssl_async_resume_t *MBEDTLS_PRIVATE(f_async_resume); /*!< resume asynchronous operation */
1065 mbedtls_ssl_async_cancel_t *MBEDTLS_PRIVATE(f_async_cancel); /*!< cancel asynchronous operation */
1066 void *MBEDTLS_PRIVATE(p_async_config_data); /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001067#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001068
Gilles Peskineeccd8882020-03-10 12:19:08 +01001069#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001070 const int *MBEDTLS_PRIVATE(sig_hashes); /*!< allowed signature hashes */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001071#endif
1072
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001073#if defined(MBEDTLS_ECP_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001074 const mbedtls_ecp_group_id *MBEDTLS_PRIVATE(curve_list); /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001075#endif
1076
1077#if defined(MBEDTLS_DHM_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001078 mbedtls_mpi MBEDTLS_PRIVATE(dhm_P); /*!< prime modulus for DHM */
1079 mbedtls_mpi MBEDTLS_PRIVATE(dhm_G); /*!< generator for DHM */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001080#endif
1081
Gilles Peskineeccd8882020-03-10 12:19:08 +01001082#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001083
1084#if defined(MBEDTLS_USE_PSA_CRYPTO)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001085 psa_key_id_t MBEDTLS_PRIVATE(psk_opaque); /*!< PSA key slot holding opaque PSK. This field
Ronald Croncf56a0a2020-08-04 09:51:30 +02001086 * should only be set via
1087 * mbedtls_ssl_conf_psk_opaque().
1088 * If either no PSK or a raw PSK have been
1089 * configured, this has value \c 0.
1090 */
Hanno Becker43633132018-10-22 15:31:03 +01001091#endif /* MBEDTLS_USE_PSA_CRYPTO */
1092
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001093 unsigned char *MBEDTLS_PRIVATE(psk); /*!< The raw pre-shared key. This field should
Hanno Becker43633132018-10-22 15:31:03 +01001094 * only be set via mbedtls_ssl_conf_psk().
1095 * If either no PSK or an opaque PSK
1096 * have been configured, this has value NULL. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001097 size_t MBEDTLS_PRIVATE(psk_len); /*!< The length of the raw pre-shared key.
Hanno Becker43633132018-10-22 15:31:03 +01001098 * This field should only be set via
1099 * mbedtls_ssl_conf_psk().
1100 * Its value is non-zero if and only if
1101 * \c psk is not \c NULL. */
1102
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001103 unsigned char *MBEDTLS_PRIVATE(psk_identity); /*!< The PSK identity for PSK negotiation.
Hanno Becker43633132018-10-22 15:31:03 +01001104 * This field should only be set via
1105 * mbedtls_ssl_conf_psk().
1106 * This is set if and only if either
1107 * \c psk or \c psk_opaque are set. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001108 size_t MBEDTLS_PRIVATE(psk_identity_len);/*!< The length of PSK identity.
Hanno Becker43633132018-10-22 15:31:03 +01001109 * This field should only be set via
1110 * mbedtls_ssl_conf_psk().
1111 * Its value is non-zero if and only if
1112 * \c psk is not \c NULL or \c psk_opaque
1113 * is not \c 0. */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001114#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001115
1116#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001117 const char **MBEDTLS_PRIVATE(alpn_list); /*!< ordered list of protocols */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001118#endif
1119
Johan Pascalbbc057a2016-02-04 22:07:32 +01001120#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001121 /*! ordered list of supported srtp profile */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001122 const mbedtls_ssl_srtp_profile *MBEDTLS_PRIVATE(dtls_srtp_profile_list);
Ron Eldora9788042018-12-05 11:04:31 +02001123 /*! number of supported profiles */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001124 size_t MBEDTLS_PRIVATE(dtls_srtp_profile_list_len);
Johan Pascalbbc057a2016-02-04 22:07:32 +01001125#endif /* MBEDTLS_SSL_DTLS_SRTP */
1126
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001127 /*
1128 * Numerical settings (int then char)
1129 */
1130
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001131 uint32_t MBEDTLS_PRIVATE(read_timeout); /*!< timeout for mbedtls_ssl_read (ms) */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001132
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001133#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001134 uint32_t MBEDTLS_PRIVATE(hs_timeout_min); /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001135 retransmission timeout (ms) */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001136 uint32_t MBEDTLS_PRIVATE(hs_timeout_max); /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001137 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001138#endif
1139
1140#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001141 int MBEDTLS_PRIVATE(renego_max_records); /*!< grace period for renegotiation */
1142 unsigned char MBEDTLS_PRIVATE(renego_period)[8]; /*!< value of the record counters
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001143 that triggers renegotiation */
1144#endif
1145
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001146 unsigned int MBEDTLS_PRIVATE(badmac_limit); /*!< limit of records with a bad MAC */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001147
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001148#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001149 unsigned int MBEDTLS_PRIVATE(dhm_min_bitlen); /*!< min. bit length of the DHM prime */
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001150#endif
1151
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001152 unsigned char MBEDTLS_PRIVATE(max_major_ver); /*!< max. major version used */
1153 unsigned char MBEDTLS_PRIVATE(max_minor_ver); /*!< max. minor version used */
1154 unsigned char MBEDTLS_PRIVATE(min_major_ver); /*!< min. major version used */
1155 unsigned char MBEDTLS_PRIVATE(min_minor_ver); /*!< min. minor version used */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001156
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001157 /*
1158 * Flags (bitfields)
1159 */
1160
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001161 unsigned int MBEDTLS_PRIVATE(endpoint) : 1; /*!< 0: client, 1: server */
1162 unsigned int MBEDTLS_PRIVATE(transport) : 1; /*!< stream (TLS) or datagram (DTLS) */
1163 unsigned int MBEDTLS_PRIVATE(authmode) : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001164 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001165 unsigned int MBEDTLS_PRIVATE(allow_legacy_renegotiation) : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001166#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001167 unsigned int MBEDTLS_PRIVATE(mfl_code) : 3; /*!< desired fragment length */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001168#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001169#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001170 unsigned int MBEDTLS_PRIVATE(encrypt_then_mac) : 1 ; /*!< negotiate encrypt-then-mac? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001171#endif
1172#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001173 unsigned int MBEDTLS_PRIVATE(extended_ms) : 1; /*!< negotiate extended master secret? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001174#endif
1175#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001176 unsigned int MBEDTLS_PRIVATE(anti_replay) : 1; /*!< detect and prevent replay? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001177#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001178#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001179 unsigned int MBEDTLS_PRIVATE(disable_renegotiation) : 1; /*!< disable renegotiation? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001180#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001181#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001182 unsigned int MBEDTLS_PRIVATE(session_tickets) : 1; /*!< use session tickets? */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001183#endif
Janos Follath088ce432017-04-10 12:42:31 +01001184#if defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001185 unsigned int MBEDTLS_PRIVATE(cert_req_ca_list) : 1; /*!< enable sending CA list in
Janos Follath088ce432017-04-10 12:42:31 +01001186 Certificate Request messages? */
TRodziewicz8476f2f2021-06-02 14:34:47 +02001187 unsigned int respect_cli_pref : 1; /*!< pick the ciphersuite according to
1188 the client's preferences rather
1189 than ours */
Janos Follath088ce432017-04-10 12:42:31 +01001190#endif
Hanno Beckera0e20d02019-05-15 14:03:01 +01001191#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001192 unsigned int MBEDTLS_PRIVATE(ignore_unexpected_cid) : 1; /*!< Determines whether DTLS
Hanno Becker8367ccc2019-05-14 11:30:10 +01001193 * record with unexpected CID
1194 * should lead to failure. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001195#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Ron Eldor3adb9922017-12-21 10:15:08 +02001196#if defined(MBEDTLS_SSL_DTLS_SRTP)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001197 unsigned int MBEDTLS_PRIVATE(dtls_srtp_mki_support) : 1; /* support having mki_value
Ron Eldor591f1622018-01-22 12:30:04 +02001198 in the use_srtp extension */
Ron Eldor3adb9922017-12-21 10:15:08 +02001199#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001200};
1201
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001203{
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001204 const mbedtls_ssl_config *MBEDTLS_PRIVATE(conf); /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001205
Paul Bakker5121ce52009-01-03 21:22:43 +00001206 /*
1207 * Miscellaneous
1208 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001209 int MBEDTLS_PRIVATE(state); /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001210#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001211 int MBEDTLS_PRIVATE(renego_status); /*!< Initial, in progress, pending? */
1212 int MBEDTLS_PRIVATE(renego_records_seen); /*!< Records since renego request, or with DTLS,
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001213 number of retransmissions of request if
1214 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001215#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001216
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001217 int MBEDTLS_PRIVATE(major_ver); /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
1218 int MBEDTLS_PRIVATE(minor_ver); /*!< one of MBEDTLS_SSL_MINOR_VERSION_x macros */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001219 unsigned MBEDTLS_PRIVATE(badmac_seen); /*!< records with a bad MAC received */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001220
Hanno Becker8927c832019-04-03 12:52:50 +01001221#if defined(MBEDTLS_X509_CRT_PARSE_C)
1222 /** Callback to customize X.509 certificate chain verification */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001223 int (*MBEDTLS_PRIVATE(f_vrfy))(void *, mbedtls_x509_crt *, int, uint32_t *);
1224 void *MBEDTLS_PRIVATE(p_vrfy); /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001225#endif
1226
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001227 mbedtls_ssl_send_t *MBEDTLS_PRIVATE(f_send); /*!< Callback for network send */
1228 mbedtls_ssl_recv_t *MBEDTLS_PRIVATE(f_recv); /*!< Callback for network receive */
1229 mbedtls_ssl_recv_timeout_t *MBEDTLS_PRIVATE(f_recv_timeout);
Simon Butchere846b512016-03-01 17:31:49 +00001230 /*!< Callback for network receive with timeout */
1231
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001232 void *MBEDTLS_PRIVATE(p_bio); /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001233
Paul Bakker5121ce52009-01-03 21:22:43 +00001234 /*
1235 * Session layer
1236 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001237 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_in); /*!< current session data (in) */
1238 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_out); /*!< current session data (out) */
1239 mbedtls_ssl_session *MBEDTLS_PRIVATE(session); /*!< negotiated session data */
1240 mbedtls_ssl_session *MBEDTLS_PRIVATE(session_negotiate); /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001241
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001242 mbedtls_ssl_handshake_params *MBEDTLS_PRIVATE(handshake); /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001243 the handshake process */
1244
1245 /*
1246 * Record layer transformations
1247 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001248 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_in); /*!< current transform params (in) */
1249 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_out); /*!< current transform params (in) */
1250 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform); /*!< negotiated transform params */
1251 mbedtls_ssl_transform *MBEDTLS_PRIVATE(transform_negotiate); /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001252
Paul Bakker5121ce52009-01-03 21:22:43 +00001253 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001254 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001255 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001256 void *MBEDTLS_PRIVATE(p_timer); /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001257
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001258 mbedtls_ssl_set_timer_t *MBEDTLS_PRIVATE(f_set_timer); /*!< set timer callback */
1259 mbedtls_ssl_get_timer_t *MBEDTLS_PRIVATE(f_get_timer); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001260
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001261 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001262 * Record layer (incoming data)
1263 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001264 unsigned char *MBEDTLS_PRIVATE(in_buf); /*!< input buffer */
1265 unsigned char *MBEDTLS_PRIVATE(in_ctr); /*!< 64-bit incoming message counter
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001266 TLS: maintained by us
1267 DTLS: read from peer */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001268 unsigned char *MBEDTLS_PRIVATE(in_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001269#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001270 unsigned char *MBEDTLS_PRIVATE(in_cid); /*!< The start of the CID;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001271 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001272#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001273 unsigned char *MBEDTLS_PRIVATE(in_len); /*!< two-bytes message length field */
1274 unsigned char *MBEDTLS_PRIVATE(in_iv); /*!< ivlen-byte IV */
1275 unsigned char *MBEDTLS_PRIVATE(in_msg); /*!< message contents (in_iv+ivlen) */
1276 unsigned char *MBEDTLS_PRIVATE(in_offt); /*!< read offset in application data */
Paul Bakker5121ce52009-01-03 21:22:43 +00001277
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001278 int MBEDTLS_PRIVATE(in_msgtype); /*!< record header: message type */
1279 size_t MBEDTLS_PRIVATE(in_msglen); /*!< record header: message length */
1280 size_t MBEDTLS_PRIVATE(in_left); /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001281#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001282 size_t MBEDTLS_PRIVATE(in_buf_len); /*!< length of input buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001283#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001284#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001285 uint16_t MBEDTLS_PRIVATE(in_epoch); /*!< DTLS epoch for incoming records */
1286 size_t MBEDTLS_PRIVATE(next_record_offset); /*!< offset of the next record in datagram
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001287 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001288#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001289#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001290 uint64_t MBEDTLS_PRIVATE(in_window_top); /*!< last validated record seq_num */
1291 uint64_t MBEDTLS_PRIVATE(in_window); /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001292#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001293
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001294 size_t MBEDTLS_PRIVATE(in_hslen); /*!< current handshake message length,
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001295 including the handshake header */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001296 int MBEDTLS_PRIVATE(nb_zero); /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001297
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001298 int MBEDTLS_PRIVATE(keep_current_message); /*!< drop or reuse current message
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001299 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001300
Hanno Becker04da1892018-08-14 13:22:10 +01001301#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001302 uint8_t MBEDTLS_PRIVATE(disable_datagram_packing); /*!< Disable packing multiple records
Hanno Becker04da1892018-08-14 13:22:10 +01001303 * within a single datagram. */
1304#endif /* MBEDTLS_SSL_PROTO_DTLS */
1305
Paul Bakker5121ce52009-01-03 21:22:43 +00001306 /*
1307 * Record layer (outgoing data)
1308 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001309 unsigned char *MBEDTLS_PRIVATE(out_buf); /*!< output buffer */
1310 unsigned char *MBEDTLS_PRIVATE(out_ctr); /*!< 64-bit outgoing message counter */
1311 unsigned char *MBEDTLS_PRIVATE(out_hdr); /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001312#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001313 unsigned char *MBEDTLS_PRIVATE(out_cid); /*!< The start of the CID;
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001314 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001315#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001316 unsigned char *MBEDTLS_PRIVATE(out_len); /*!< two-bytes message length field */
1317 unsigned char *MBEDTLS_PRIVATE(out_iv); /*!< ivlen-byte IV */
1318 unsigned char *MBEDTLS_PRIVATE(out_msg); /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001319
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001320 int MBEDTLS_PRIVATE(out_msgtype); /*!< record header: message type */
1321 size_t MBEDTLS_PRIVATE(out_msglen); /*!< record header: message length */
1322 size_t MBEDTLS_PRIVATE(out_left); /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001323#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001324 size_t MBEDTLS_PRIVATE(out_buf_len); /*!< length of output buffer */
Darryl Greenb33cc762019-11-28 14:29:44 +00001325#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001327 unsigned char MBEDTLS_PRIVATE(cur_out_ctr)[8]; /*!< Outgoing record sequence number. */
Hanno Becker19859472018-08-06 09:40:20 +01001328
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001329#if defined(MBEDTLS_SSL_PROTO_DTLS)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001330 uint16_t MBEDTLS_PRIVATE(mtu); /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001331#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001332
Paul Bakker5121ce52009-01-03 21:22:43 +00001333 /*
1334 * PKI layer
1335 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001336 int MBEDTLS_PRIVATE(client_auth); /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001337
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001338 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001339 * User settings
1340 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001341#if defined(MBEDTLS_X509_CRT_PARSE_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001342 char *MBEDTLS_PRIVATE(hostname); /*!< expected peer CN for verification
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001343 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001344#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001345
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001346#if defined(MBEDTLS_SSL_ALPN)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001347 const char *MBEDTLS_PRIVATE(alpn_chosen); /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001348#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001349
Johan Pascalb62bb512015-12-03 21:56:45 +01001350#if defined(MBEDTLS_SSL_DTLS_SRTP)
1351 /*
1352 * use_srtp extension
1353 */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001354 mbedtls_dtls_srtp_info MBEDTLS_PRIVATE(dtls_srtp_info);
Johan Pascalb62bb512015-12-03 21:56:45 +01001355#endif /* MBEDTLS_SSL_DTLS_SRTP */
1356
Paul Bakker48916f92012-09-16 19:57:18 +00001357 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001358 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001359 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001360#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001361 unsigned char *MBEDTLS_PRIVATE(cli_id); /*!< transport-level ID of the client */
1362 size_t MBEDTLS_PRIVATE(cli_id_len); /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001363#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001364
1365 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001366 * Secure renegotiation
1367 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001368 /* needed to know when to send extension on server */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001369 int MBEDTLS_PRIVATE(secure_renegotiation); /*!< does peer support legacy or
Paul Bakker48916f92012-09-16 19:57:18 +00001370 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371#if defined(MBEDTLS_SSL_RENEGOTIATION)
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001372 size_t MBEDTLS_PRIVATE(verify_data_len); /*!< length of verify data stored */
1373 char MBEDTLS_PRIVATE(own_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1374 char MBEDTLS_PRIVATE(peer_verify_data)[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001375#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001376
Hanno Beckera0e20d02019-05-15 14:03:01 +01001377#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001378 /* CID configuration to use in subsequent handshakes. */
1379
1380 /*! The next incoming CID, chosen by the user and applying to
1381 * all subsequent handshakes. This may be different from the
1382 * CID currently used in case the user has re-configured the CID
1383 * after an initial handshake. */
Mateusz Starzyk846f0212021-05-19 19:44:07 +02001384 unsigned char MBEDTLS_PRIVATE(own_cid)[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1385 uint8_t MBEDTLS_PRIVATE(own_cid_len); /*!< The length of \c own_cid. */
1386 uint8_t MBEDTLS_PRIVATE(negotiate_cid); /*!< This indicates whether the CID extension should
Hanno Becker2f28c102019-04-25 15:46:59 +01001387 * be negotiated in the next handshake or not.
1388 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1389 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001390#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001391};
1392
Paul Bakker5121ce52009-01-03 21:22:43 +00001393/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001394 * \brief Return the name of the ciphersuite associated with the
1395 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001396 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001397 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001398 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001399 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001402
1403/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001404 * \brief Return the ID of the ciphersuite associated with the
1405 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001406 *
1407 * \param ciphersuite_name SSL ciphersuite name
1408 *
1409 * \return the ID with the ciphersuite or 0 if not found
1410 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001411int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001412
1413/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001414 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001415 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001416 * mbedtls_ssl_free()
1417 *
1418 * \param ssl SSL context
1419 */
1420void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1421
1422/**
1423 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001424 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001425 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001426 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001427 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001428 * \warning The conf structure will be accessed during the session.
1429 * It must not be modified or freed as long as the session
1430 * is active.
1431 *
1432 * \warning This function must be called exactly once per context.
1433 * Calling mbedtls_ssl_setup again is not supported, even
1434 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001435 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001436 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001437 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001438 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001439 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001440 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001441 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001442int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001443 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001444
1445/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001446 * \brief Reset an already initialized SSL context for re-use
1447 * while retaining application-set variables, function
1448 * pointers and data.
1449 *
1450 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001451 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
1452 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001453 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001454int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001455
1456/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001457 * \brief Set the current endpoint type
1458 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001459 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001460 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001461 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001462void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001463
1464/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001465 * \brief Set the transport type (TLS or DTLS).
1466 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001467 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001468 * \note For DTLS, you must either provide a recv callback that
1469 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001470 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1471 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001472 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001473 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001474 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001475 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1476 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001477 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001478void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001479
1480/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001481 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001482 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001483 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001484 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001485 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001486 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001487 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001488 * (default on server)
1489 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001490 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001491 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001492 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001493 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001494 * handshake is complete.
1495 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001496 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001497 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001498 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001499 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001500 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1501 * 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 +01001502 * the right time(s), which may not be obvious, while REQUIRED always perform
1503 * the verification as soon as possible. For example, REQUIRED was protecting
1504 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001505 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001506void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001507
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001508#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001509/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001510 * \brief Set the verification callback (Optional).
1511 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001512 * If set, the provided verify callback is called for each
1513 * certificate in the peer's CRT chain, including the trusted
1514 * root. For more information, please see the documentation of
1515 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001516 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001517 * \note For per context callbacks and contexts, please use
1518 * mbedtls_ssl_set_verify() instead.
1519 *
1520 * \param conf The SSL configuration to use.
1521 * \param f_vrfy The verification callback to use during CRT verification.
1522 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001523 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001524void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001525 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001526 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001528
1529/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001530 * \brief Set the random number generator callback
1531 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001532 * \param conf SSL configuration
Manuel Pégourié-Gonnardad5390f2021-06-15 11:29:26 +02001533 * \param f_rng RNG function (mandatory)
Paul Bakker5121ce52009-01-03 21:22:43 +00001534 * \param p_rng RNG parameter
1535 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001536void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001537 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001538 void *p_rng );
1539
1540/**
1541 * \brief Set the debug callback
1542 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001543 * The callback has the following argument:
1544 * void * opaque context for the callback
1545 * int debug level
1546 * const char * file name
1547 * int line number
1548 * const char * message
1549 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001550 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001551 * \param f_dbg debug function
1552 * \param p_dbg debug parameter
1553 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001554void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001555 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001556 void *p_dbg );
1557
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001558/**
1559 * \brief Set the underlying BIO callbacks for write, read and
1560 * read-with-timeout.
1561 *
1562 * \param ssl SSL context
1563 * \param p_bio parameter (context) shared by BIO callbacks
1564 * \param f_send write callback
1565 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001566 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001567 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001568 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1569 * the other is used. If both are non-NULL, f_recv_timeout is
1570 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001571 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001572 * \note The two most common use cases are:
1573 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1574 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1575 *
1576 * \note For DTLS, you need to provide either a non-NULL
1577 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001578 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07001579 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001580 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001581 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001582 *
Andres AG3616f6f2016-09-14 14:32:09 +01001583 * \note On some platforms, net_sockets.c provides
1584 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1585 * \c mbedtls_net_recv_timeout() that are suitable to be used
1586 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001587 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001588void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001589 void *p_bio,
1590 mbedtls_ssl_send_t *f_send,
1591 mbedtls_ssl_recv_t *f_recv,
1592 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001593
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001594#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001595
Hanno Beckera0e20d02019-05-15 14:03:01 +01001596#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01001597
1598
1599/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001600 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001601 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001602 *
Hanno Beckerebcc9132019-05-15 10:26:32 +01001603 * Reference: draft-ietf-tls-dtls-connection-id-05
1604 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker019f4b52019-04-09 15:12:56 +01001605 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01001606 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01001607 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01001608 * underlying transport (changed IP and Port metadata) by
1609 * adding explicit connection identifiers (CIDs) to the
1610 * headers of encrypted DTLS records. The desired CIDs are
1611 * configured by the application layer and are exchanged in
1612 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01001613 * handshake, where each side indicates the CID it wants the
1614 * peer to use when writing encrypted messages. The CIDs are
1615 * put to use once records get encrypted: the stack discards
1616 * any incoming records that don't include the configured CID
1617 * in their header, and adds the peer's requested CID to the
1618 * headers of outgoing messages.
1619 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01001620 * This API enables or disables the use of the CID extension
1621 * in the next handshake and sets the value of the CID to
1622 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01001623 *
1624 * \param ssl The SSL context to configure. This must be initialized.
1625 * \param enable This value determines whether the CID extension should
1626 * be used or not. Possible values are:
1627 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001628 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1629 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001630 * \param own_cid The address of the readable buffer holding the CID we want
1631 * the peer to use when sending encrypted messages to us.
1632 * This may be \c NULL if \p own_cid_len is \c 0.
1633 * This parameter is unused if \p enabled is set to
1634 * MBEDTLS_SSL_CID_DISABLED.
1635 * \param own_cid_len The length of \p own_cid.
1636 * This parameter is unused if \p enabled is set to
1637 * MBEDTLS_SSL_CID_DISABLED.
1638 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001639 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01001640 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01001641 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001642 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001643 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001644 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001645 * performed on the SSL context \p ssl, but does not trigger
1646 * one. You still have to call `mbedtls_ssl_handshake()`
1647 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1648 * (for a renegotiation handshake) explicitly after a
1649 * successful call to this function to run the handshake.
1650 *
1651 * \note This call cannot guarantee that the use of the CID
1652 * will be successfully negotiated in the next handshake,
1653 * because the peer might not support it. Specifically:
1654 * - On the Client, enabling the use of the CID through
1655 * this call implies that the `ClientHello` in the next
1656 * handshake will include the CID extension, thereby
1657 * offering the use of the CID to the server. Only if
1658 * the `ServerHello` contains the CID extension, too,
1659 * the CID extension will actually be put to use.
1660 * - On the Server, enabling the use of the CID through
1661 * this call implies that that the server will look for
1662 * the CID extension in a `ClientHello` from the client,
1663 * and, if present, reply with a CID extension in its
1664 * `ServerHello`.
1665 *
1666 * \note To check whether the use of the CID was negotiated
1667 * after the subsequent handshake has completed, please
1668 * use the API mbedtls_ssl_get_peer_cid().
1669 *
1670 * \warning If the use of the CID extension is enabled in this call
1671 * and the subsequent handshake negotiates its use, Mbed TLS
1672 * will silently drop every packet whose CID does not match
1673 * the CID configured in \p own_cid. It is the responsibility
1674 * of the user to adapt the underlying transport to take care
1675 * of CID-based demultiplexing before handing datagrams to
1676 * Mbed TLS.
1677 *
1678 * \return \c 0 on success. In this case, the CID configuration
1679 * applies to the next handshake.
1680 * \return A negative error code on failure.
1681 */
1682int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1683 int enable,
1684 unsigned char const *own_cid,
1685 size_t own_cid_len );
1686
1687/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01001688 * \brief Get information about the use of the CID extension
1689 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01001690 *
1691 * \param ssl The SSL context to query.
1692 * \param enabled The address at which to store whether the CID extension
1693 * is currently in use or not. If the CID is in use,
1694 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1695 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1696 * \param peer_cid The address of the buffer in which to store the CID
1697 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01001698 * This may be \c NULL in case the value of peer CID
1699 * isn't needed. If it is not \c NULL, \p peer_cid_len
1700 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01001701 * \param peer_cid_len The address at which to store the size of the CID
1702 * chosen by the peer (if the CID extension is used).
1703 * This is also the number of Bytes in \p peer_cid that
1704 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01001705 * This may be \c NULL in case the length of the peer CID
1706 * isn't needed. If it is \c NULL, \p peer_cid must be
1707 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01001708 *
1709 * \note This applies to the state of the CID negotiated in
1710 * the last complete handshake. If a handshake is in
1711 * progress, this function will attempt to complete
1712 * the handshake first.
1713 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001714 * \note If CID extensions have been exchanged but both client
1715 * and server chose to use an empty CID, this function
1716 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1717 * (the rationale for this is that the resulting
1718 * communication is the same as if the CID extensions
1719 * hadn't been used).
1720 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001721 * \return \c 0 on success.
1722 * \return A negative error code on failure.
1723 */
1724int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1725 int *enabled,
1726 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1727 size_t *peer_cid_len );
1728
Hanno Beckera0e20d02019-05-15 14:03:01 +01001729#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01001730
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001731/**
1732 * \brief Set the Maximum Tranport Unit (MTU).
1733 * Special value: 0 means unset (no limit).
1734 * This represents the maximum size of a datagram payload
1735 * handled by the transport layer (usually UDP) as determined
1736 * by the network link and stack. In practice, this controls
1737 * the maximum size datagram the DTLS layer will pass to the
1738 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1739 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001740 * \note The limit on datagram size is converted to a limit on
1741 * record payload by subtracting the current overhead of
1742 * encapsulation and encryption/authentication if any.
1743 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001744 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001745 * example when a Path Maximum Transfer Unit (PMTU)
1746 * estimate becomes available from other sources,
1747 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001748 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001749 * \note This setting only controls the size of the packets we send,
1750 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001751 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001752 * server to use smaller records with \c
1753 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001754 *
1755 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001756 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001757 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001758 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001759 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001760 * of datagrams (hence records, see first note) sent. It
1761 * cannot be used to increase the maximum size of records over
1762 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001763 *
1764 * \note Values lower than the current record layer expansion will
1765 * result in an error when trying to send data.
1766 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001767 * \param ssl SSL context
1768 * \param mtu Value of the path MTU in bytes
1769 */
1770void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1771#endif /* MBEDTLS_SSL_PROTO_DTLS */
1772
Hanno Becker726c97a2019-04-03 12:52:35 +01001773#if defined(MBEDTLS_X509_CRT_PARSE_C)
1774/**
1775 * \brief Set a connection-specific verification callback (optional).
1776 *
1777 * If set, the provided verify callback is called for each
1778 * certificate in the peer's CRT chain, including the trusted
1779 * root. For more information, please see the documentation of
1780 * \c mbedtls_x509_crt_verify().
1781 *
1782 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1783 * binds the verification callback and context to an SSL context
1784 * as opposed to an SSL configuration.
1785 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1786 * are both used, mbedtls_ssl_set_verify() takes precedence.
1787 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001788 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001789 * \param f_vrfy The verification callback to use during CRT verification.
1790 * \param p_vrfy The opaque context to be passed to the callback.
1791 */
1792void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1793 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1794 void *p_vrfy );
1795#endif /* MBEDTLS_X509_CRT_PARSE_C */
1796
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001797/**
1798 * \brief Set the timeout period for mbedtls_ssl_read()
1799 * (Default: no timeout.)
1800 *
1801 * \param conf SSL configuration context
1802 * \param timeout Timeout value in milliseconds.
1803 * Use 0 for no timeout (default).
1804 *
1805 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001806 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001807 * With non-blocking I/O, this will only work if timer
1808 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1809 *
1810 * \note With non-blocking I/O, you may also skip this function
1811 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001812 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001813void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001814
Hanno Beckercfe45792019-07-03 16:13:00 +01001815/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001816 * \brief Check whether a buffer contains a valid and authentic record
1817 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01001818 *
1819 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01001820 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01001821 * an indication of the legitimacy of an incoming record.
1822 *
1823 * This can be useful e.g. in distributed server environments
1824 * using the DTLS Connection ID feature, in which connections
1825 * might need to be passed between service instances on a change
1826 * of peer address, but where such disruptive operations should
1827 * only happen after the validity of incoming records has been
1828 * confirmed.
1829 *
1830 * \param ssl The SSL context to use.
1831 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001832 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01001833 * \param buflen The length of \p buf in Bytes.
1834 *
1835 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001836 * with a valid and authentic record that has not been seen
1837 * before, but does not check potential data following the
1838 * initial record. In particular, it is possible to pass DTLS
1839 * datagrams containing multiple records, in which case only
1840 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01001841 *
1842 * \note This function modifies the input buffer \p buf. If you need
1843 * to preserve the original record, you have to maintain a copy.
1844 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001845 * \return \c 0 if the record is valid and authentic and has not been
1846 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01001847 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
1848 * successfully but the record was found to be not authentic.
1849 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
1850 * successfully but the record was found to be invalid for
1851 * a reason different from authenticity checking.
1852 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
1853 * successfully but the record was found to be unexpected
1854 * in the state of the SSL context, including replayed records.
1855 * \return Another negative error code on different kinds of failure.
1856 * In this case, the SSL context becomes unusable and needs
1857 * to be freed or reset before reuse.
1858 */
1859int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
1860 unsigned char *buf,
1861 size_t buflen );
Hanno Beckercfe45792019-07-03 16:13:00 +01001862
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001863/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001864 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001865 *
1866 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001867 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001868 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001869 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001870 *
1871 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1872 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001873 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001874 *
1875 * \note On some platforms, timing.c provides
1876 * \c mbedtls_timing_set_delay() and
1877 * \c mbedtls_timing_get_delay() that are suitable for using
1878 * here, except if using an event-driven style.
1879 *
1880 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001881 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001882 */
1883void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1884 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001885 mbedtls_ssl_set_timer_t *f_set_timer,
1886 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001887
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001888/**
1889 * \brief Callback type: generate and write session ticket
1890 *
1891 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001892 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001893 * authenticated ticket for the session and write it to the
1894 * output buffer. Here, ticket means the opaque ticket part
1895 * of the NewSessionTicket structure of RFC 5077.
1896 *
1897 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001898 * \param session SSL session to be written in the ticket
1899 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001900 * \param end End of the output buffer
1901 * \param tlen On exit, holds the length written
1902 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1903 *
1904 * \return 0 if successful, or
1905 * a specific MBEDTLS_ERR_XXX code.
1906 */
1907typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1908 const mbedtls_ssl_session *session,
1909 unsigned char *start,
1910 const unsigned char *end,
1911 size_t *tlen,
1912 uint32_t *lifetime );
1913
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001914#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1915/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001916 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001917 *
1918 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001919 * (RFC 5216) and Thread. The key pointers are ephemeral and
1920 * therefore must not be stored. The master secret and keys
1921 * should not be used directly except as an input to a key
1922 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001923 *
1924 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001925 * \param ms Pointer to master secret (fixed length: 48 bytes)
1926 * \param kb Pointer to key block, see RFC 5246 section 6.3
1927 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001928 * \param maclen MAC length
1929 * \param keylen Key length
1930 * \param ivlen IV length
1931 *
1932 * \return 0 if successful, or
1933 * a specific MBEDTLS_ERR_XXX code.
1934 */
1935typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001936 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001937 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001938 size_t maclen,
1939 size_t keylen,
1940 size_t ivlen );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001941
1942/**
1943 * \brief Callback type: Export key block, master secret,
1944 * handshake randbytes and the tls_prf function
1945 * used to derive keys.
1946 *
1947 * \note This is required for certain uses of TLS, e.g. EAP-TLS
1948 * (RFC 5216) and Thread. The key pointers are ephemeral and
1949 * therefore must not be stored. The master secret and keys
1950 * should not be used directly except as an input to a key
1951 * derivation function.
1952 *
1953 * \param p_expkey Context for the callback.
1954 * \param ms Pointer to master secret (fixed length: 48 bytes).
1955 * \param kb Pointer to key block, see RFC 5246 section 6.3.
1956 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
1957 * \param maclen MAC length.
1958 * \param keylen Key length.
1959 * \param ivlen IV length.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001960 * \param client_random The client random bytes.
1961 * \param server_random The server random bytes.
Ron Eldor51d3ab52019-05-12 14:54:30 +03001962 * \param tls_prf_type The tls_prf enum type.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001963 *
1964 * \return 0 if successful, or
1965 * a specific MBEDTLS_ERR_XXX code.
1966 */
1967typedef int mbedtls_ssl_export_keys_ext_t( void *p_expkey,
1968 const unsigned char *ms,
1969 const unsigned char *kb,
1970 size_t maclen,
1971 size_t keylen,
1972 size_t ivlen,
Jaeden Amero63d813d2019-09-12 10:09:57 +01001973 const unsigned char client_random[32],
1974 const unsigned char server_random[32],
Ron Eldor51d3ab52019-05-12 14:54:30 +03001975 mbedtls_tls_prf_types tls_prf_type );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001976#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001977
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001978/**
1979 * \brief Callback type: parse and load session ticket
1980 *
1981 * \note This describes what a callback implementation should do.
1982 * This callback should parse a session ticket as generated
1983 * by the corresponding mbedtls_ssl_ticket_write_t function,
1984 * and, if the ticket is authentic and valid, load the
1985 * session.
1986 *
1987 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001988 * bytes of the input buffer, eg to use it as a temporary
1989 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001990 *
1991 * \param p_ticket Context for the callback
1992 * \param session SSL session to be loaded
1993 * \param buf Start of the buffer containing the ticket
1994 * \param len Length of the ticket.
1995 *
1996 * \return 0 if successful, or
1997 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1998 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1999 * any other non-zero code for other failures.
2000 */
2001typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
2002 mbedtls_ssl_session *session,
2003 unsigned char *buf,
2004 size_t len );
2005
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002006#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002007/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002008 * \brief Configure SSL session ticket callbacks (server only).
2009 * (Default: none.)
2010 *
2011 * \note On server, session tickets are enabled by providing
2012 * non-NULL callbacks.
2013 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002014 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002015 *
2016 * \param conf SSL configuration context
2017 * \param f_ticket_write Callback for writing a ticket
2018 * \param f_ticket_parse Callback for parsing a ticket
2019 * \param p_ticket Context shared by the two callbacks
2020 */
2021void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2022 mbedtls_ssl_ticket_write_t *f_ticket_write,
2023 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2024 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002025#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002026
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002027#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2028/**
2029 * \brief Configure key export callback.
2030 * (Default: none.)
2031 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002032 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002033 *
2034 * \param conf SSL configuration context
2035 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002036 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002037 */
2038void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
2039 mbedtls_ssl_export_keys_t *f_export_keys,
2040 void *p_export_keys );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002041
2042/**
2043 * \brief Configure extended key export callback.
2044 * (Default: none.)
2045 *
2046 * \note See \c mbedtls_ssl_export_keys_ext_t.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002047 * \warning Exported key material must not be used for any purpose
2048 * before the (D)TLS handshake is completed
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002049 *
2050 * \param conf SSL configuration context
2051 * \param f_export_keys_ext Callback for exporting keys
2052 * \param p_export_keys Context for the callback
2053 */
2054void mbedtls_ssl_conf_export_keys_ext_cb( mbedtls_ssl_config *conf,
2055 mbedtls_ssl_export_keys_ext_t *f_export_keys_ext,
2056 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002057#endif /* MBEDTLS_SSL_EXPORT_KEYS */
2058
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002059#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002060/**
2061 * \brief Configure asynchronous private key operation callbacks.
2062 *
2063 * \param conf SSL configuration context
2064 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002065 * the description of ::mbedtls_ssl_async_sign_t
2066 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002067 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002068 * operation; in this case the private key object
2069 * associated with the certificate will be used.
2070 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002071 * the description of ::mbedtls_ssl_async_decrypt_t
2072 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002073 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002074 * operation; in this case the private key object
2075 * associated with the certificate will be used.
2076 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002077 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002078 * for more information. This may not be \c NULL unless
2079 * \p f_async_sign and \p f_async_decrypt are both
2080 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002081 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002082 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002083 * for more information. This may be \c NULL if
2084 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002085 * \param config_data A pointer to configuration data which can be
2086 * retrieved with
2087 * mbedtls_ssl_conf_get_async_config_data(). The
2088 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002089 */
2090void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2091 mbedtls_ssl_async_sign_t *f_async_sign,
2092 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2093 mbedtls_ssl_async_resume_t *f_async_resume,
2094 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002095 void *config_data );
2096
2097/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002098 * \brief Retrieve the configuration data set by
2099 * mbedtls_ssl_conf_async_private_cb().
2100 *
2101 * \param conf SSL configuration context
2102 * \return The configuration data set by
2103 * mbedtls_ssl_conf_async_private_cb().
2104 */
2105void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2106
2107/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002108 * \brief Retrieve the asynchronous operation user context.
2109 *
2110 * \note This function may only be called while a handshake
2111 * is in progress.
2112 *
2113 * \param ssl The SSL context to access.
2114 *
2115 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002116 * set during the current handshake. If
2117 * mbedtls_ssl_set_async_operation_data() has not yet been
2118 * called during the current handshake, this function returns
2119 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002120 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002121void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002122
2123/**
2124 * \brief Retrieve the asynchronous operation user context.
2125 *
2126 * \note This function may only be called while a handshake
2127 * is in progress.
2128 *
2129 * \param ssl The SSL context to access.
2130 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002131 * Call mbedtls_ssl_get_async_operation_data() later during the
2132 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002133 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002134void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002135 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002136#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002137
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002138/**
2139 * \brief Callback type: generate a cookie
2140 *
2141 * \param ctx Context for the callback
2142 * \param p Buffer to write to,
2143 * must be updated to point right after the cookie
2144 * \param end Pointer to one past the end of the output buffer
2145 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002146 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002147 * \param ilen Length of info in bytes
2148 *
2149 * \return The callback must return 0 on success,
2150 * or a negative error code.
2151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002153 unsigned char **p, unsigned char *end,
2154 const unsigned char *info, size_t ilen );
2155
2156/**
2157 * \brief Callback type: verify a cookie
2158 *
2159 * \param ctx Context for the callback
2160 * \param cookie Cookie to verify
2161 * \param clen Length of cookie
2162 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002164 * \param ilen Length of info in bytes
2165 *
2166 * \return The callback must return 0 if cookie is valid,
2167 * or a negative error code.
2168 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002169typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002170 const unsigned char *cookie, size_t clen,
2171 const unsigned char *info, size_t ilen );
2172
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002173#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002174/**
2175 * \brief Register callbacks for DTLS cookies
2176 * (Server only. DTLS only.)
2177 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002178 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002179 * register working callbacks (and initialize their context).
2180 *
2181 * To disable HelloVerifyRequest, register NULL callbacks.
2182 *
2183 * \warning Disabling hello verification allows your server to be used
2184 * for amplification in DoS attacks against other hosts.
2185 * Only disable if you known this can't happen in your
2186 * particular environment.
2187 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002188 * \note See comments on \c mbedtls_ssl_handshake() about handling
2189 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2190 * on the first handshake attempt when this is enabled.
2191 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002192 * \note This is also necessary to handle client reconnection from
2193 * the same port as described in RFC 6347 section 4.2.8 (only
2194 * the variant with cookies is supported currently). See
2195 * comments on \c mbedtls_ssl_read() for details.
2196 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002197 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002198 * \param f_cookie_write Cookie write callback
2199 * \param f_cookie_check Cookie check callback
2200 * \param p_cookie Context for both callbacks
2201 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002202void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002203 mbedtls_ssl_cookie_write_t *f_cookie_write,
2204 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002205 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002206
2207/**
2208 * \brief Set client's transport-level identification info.
2209 * (Server only. DTLS only.)
2210 *
2211 * This is usually the IP address (and port), but could be
2212 * anything identify the client depending on the underlying
2213 * network stack. Used for HelloVerifyRequest with DTLS.
2214 * This is *not* used to route the actual packets.
2215 *
2216 * \param ssl SSL context
2217 * \param info Transport-level info identifying the client (eg IP + port)
2218 * \param ilen Length of info in bytes
2219 *
2220 * \note An internal copy is made, so the info buffer can be reused.
2221 *
2222 * \return 0 on success,
2223 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002224 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002225 */
2226int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2227 const unsigned char *info,
2228 size_t ilen );
2229
2230#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002231
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002233/**
2234 * \brief Enable or disable anti-replay protection for DTLS.
2235 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002236 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002237 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002238 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002239 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002240 *
2241 * \warning Disabling this is a security risk unless the application
2242 * protocol handles duplicated packets in a safe way. You
2243 * should not disable this without careful consideration.
2244 * However, if your application already detects duplicated
2245 * packets and needs information about them to adjust its
2246 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002247 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002248void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002249#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002250
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002251/**
2252 * \brief Set a limit on the number of records with a bad MAC
2253 * before terminating the connection.
2254 * (DTLS only, no effect on TLS.)
2255 * Default: 0 (disabled).
2256 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002257 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002258 * \param limit Limit, or 0 to disable.
2259 *
2260 * \note If the limit is N, then the connection is terminated when
2261 * the Nth non-authentic record is seen.
2262 *
2263 * \note Records with an invalid header are not counted, only the
2264 * ones going through the authentication-decryption phase.
2265 *
2266 * \note This is a security trade-off related to the fact that it's
2267 * often relatively easy for an active attacker ot inject UDP
2268 * datagrams. On one hand, setting a low limit here makes it
2269 * easier for such an attacker to forcibly terminated a
2270 * connection. On the other hand, a high limit or no limit
2271 * might make us waste resources checking authentication on
2272 * many bogus packets.
2273 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002274void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002276#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002277
2278/**
2279 * \brief Allow or disallow packing of multiple handshake records
2280 * within a single datagram.
2281 *
2282 * \param ssl The SSL context to configure.
2283 * \param allow_packing This determines whether datagram packing may
2284 * be used or not. A value of \c 0 means that every
2285 * record will be sent in a separate datagram; a
2286 * value of \c 1 means that, if space permits,
2287 * multiple handshake messages (including CCS) belonging to
2288 * a single flight may be packed within a single datagram.
2289 *
2290 * \note This is enabled by default and should only be disabled
2291 * for test purposes, or if datagram packing causes
2292 * interoperability issues with peers that don't support it.
2293 *
2294 * \note Allowing datagram packing reduces the network load since
2295 * there's less overhead if multiple messages share the same
2296 * datagram. Also, it increases the handshake efficiency
2297 * since messages belonging to a single datagram will not
2298 * be reordered in transit, and so future message buffering
2299 * or flight retransmission (if no buffering is used) as
2300 * means to deal with reordering are needed less frequently.
2301 *
Hanno Beckereb570082018-08-24 11:28:35 +01002302 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002303 * are currently always sent in separate datagrams.
2304 *
2305 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002306void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2307 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002308
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002309/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002310 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002311 * (DTLS only, no effect on TLS.)
2312 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002313 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002314 * \param min Initial timeout value in milliseconds.
2315 * Default: 1000 (1 second).
2316 * \param max Maximum timeout value in milliseconds.
2317 * Default: 60000 (60 seconds).
2318 *
2319 * \note Default values are from RFC 6347 section 4.2.4.1.
2320 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002321 * \note The 'min' value should typically be slightly above the
2322 * expected round-trip time to your peer, plus whatever time
2323 * it takes for the peer to process the message. For example,
2324 * if your RTT is about 600ms and you peer needs up to 1s to
2325 * do the cryptographic operations in the handshake, then you
2326 * should set 'min' slightly above 1600. Lower values of 'min'
2327 * might cause spurious resends which waste network resources,
2328 * while larger value of 'min' will increase overall latency
2329 * on unreliable network links.
2330 *
2331 * \note The more unreliable your network connection is, the larger
2332 * your max / min ratio needs to be in order to achieve
2333 * reliable handshakes.
2334 *
2335 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2336 * For example, if min = 1s and max = 5s, the retransmit plan
2337 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2338 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002339 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002340void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002342
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002343#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002344/**
Paul Bakker0a597072012-09-25 21:55:46 +00002345 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002346 * If not set, no session resuming is done (except if session
2347 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002348 *
Paul Bakker0a597072012-09-25 21:55:46 +00002349 * The session cache has the responsibility to check for stale
2350 * entries based on timeout. See RFC 5246 for recommendations.
2351 *
2352 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2353 * connection shutdown, so do not cache the pointer! Either set
2354 * it to NULL or make a full copy of the certificate.
2355 *
2356 * The get callback is called once during the initial handshake
2357 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002358 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002359 * If a valid entry is found, it should fill the master of
2360 * the session object with the cached values and return 0,
2361 * return 1 otherwise. Optionally peer_cert can be set as well
2362 * if it is properly present in cache entry.
2363 *
2364 * The set callback is called once during the initial handshake
2365 * to enable session resuming after the entire handshake has
2366 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002367 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002368 * should create a cache entry for future retrieval based on
2369 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002370 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002371 * data) is cleared by the SSL/TLS layer when the connection is
2372 * terminated. It is recommended to add metadata to determine if
2373 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002374 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002375 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002376 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002377 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002378 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002379 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002380 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002381void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01002382 void *p_cache,
2383 mbedtls_ssl_cache_get_t *f_get_cache,
2384 mbedtls_ssl_cache_set_t *f_set_cache );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002385#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002387#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002388/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01002389 * \brief Load a session for session resumption.
Paul Bakker0a597072012-09-25 21:55:46 +00002390 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01002391 * Sessions loaded through this call will be considered
2392 * for session resumption in the next handshake.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002393 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01002394 * \note Even if this call succeeds, it is not guaranteed that
2395 * the next handshake will indeed be shortened through the
2396 * use of session resumption: The server is always free
2397 * to reject any attempt for resumption and fall back to
2398 * a full handshake.
2399 *
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01002400 * \note This function can handle a variety of mechanisms for session
2401 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01002402 * ticket-based resumption will be considered. For TLS 1.3,
2403 * once implemented, sessions equate to tickets, and loading
2404 * one or more sessions via this call will lead to their
2405 * corresponding tickets being advertised as resumption PSKs
2406 * by the client.
2407 *
2408 * \note Calling this function multiple times will only be useful
2409 * once TLS 1.3 is supported. For TLS 1.2 connections, this
2410 * function should be called at most once.
2411 *
2412 * \param ssl The SSL context representing the connection which should
2413 * be attempted to be setup using session resumption. This
2414 * must be initialized via mbedtls_ssl_init() and bound to
2415 * an SSL configuration via mbedtls_ssl_setup(), but
2416 * the handshake must not yet have been started.
2417 * \param session The session to be considered for session resumption.
2418 * This must be a session previously exported via
2419 * mbedtls_ssl_get_session(), and potentially serialized and
2420 * deserialized through mbedtls_ssl_session_save() and
2421 * mbedtls_ssl_session_load() in the meantime.
2422 *
2423 * \return \c 0 if successful.
2424 * \return \c MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if the session
2425 * could not be loaded because of an implementation limitation.
2426 * This error is non-fatal, and has no observable effect on
2427 * the SSL context or the session that was attempted to be loaded.
2428 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002429 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002430 * \sa mbedtls_ssl_get_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01002431 * \sa mbedtls_ssl_session_load()
Paul Bakker5121ce52009-01-03 21:22:43 +00002432 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002433int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2434#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002435
2436/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002437 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002438 * On client, this can be used for loading saved sessions
2439 * before resuming them with mbedstls_ssl_set_session().
2440 * On server, this can be used for alternative implementations
2441 * of session cache or session tickets.
2442 *
2443 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002444 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002445 * end-entity certificate and the result of the chain
2446 * verification (unless verification was disabled), but not
2447 * the rest of the chain.
2448 *
2449 * \see mbedtls_ssl_session_save()
2450 * \see mbedtls_ssl_set_session()
2451 *
2452 * \param session The session structure to be populated. It must have been
2453 * initialised with mbedtls_ssl_session_init() but not
2454 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002455 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002456 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002457 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002458 *
2459 * \return \c 0 if successful.
2460 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2461 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01002462 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2463 * was generated in a different version or configuration of
2464 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002465 * \return Another negative value for other kinds of errors (for
2466 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002467 */
2468int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2469 const unsigned char *buf,
2470 size_t len );
2471
2472/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002473 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002474 * On client, this can be used for saving session data,
2475 * potentially in non-volatile storage, for resuming later.
2476 * On server, this can be used for alternative implementations
2477 * of session cache or session tickets.
2478 *
2479 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002480 *
2481 * \param session The session structure to be saved.
2482 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002483 * writeable buffer of at least \p len bytes, or may be \c
2484 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002485 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002486 * \param olen The size in bytes of the data that has been or would have
2487 * been written. It must point to a valid \c size_t.
2488 *
2489 * \note \p olen is updated to the correct value regardless of
2490 * whether \p buf_len was large enough. This makes it possible
2491 * to determine the necessary size by calling this function
2492 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002493 *
2494 * \return \c 0 if successful.
2495 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2496 */
2497int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2498 unsigned char *buf,
2499 size_t buf_len,
2500 size_t *olen );
2501
2502/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002503 * \brief Set the list of allowed ciphersuites and the preference
2504 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002505 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002506 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002507 * The ciphersuites array is not copied, and must remain
2508 * valid for the lifetime of the ssl_config.
2509 *
TRodziewicz3946f792021-06-14 12:11:18 +02002510 * Note: By default, the server chooses its preferred
2511 * ciphersuite among those that the client supports. If
2512 * mbedtls_ssl_conf_preference_order() is called to prefer
2513 * the client's preferences, the server instead chooses
2514 * the client's preferred ciphersuite among those that
2515 * the server supports.
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002516 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002517 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002518 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002519 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002520void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002521 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002522
Hanno Beckera0e20d02019-05-15 14:03:01 +01002523#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01002524#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2525#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01002526/**
Hanno Becker11259522019-05-23 16:55:50 +01002527 * \brief Specify the length of Connection IDs for incoming
2528 * encrypted DTLS records, as well as the behaviour
2529 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01002530 *
2531 * By default, the CID length is set to \c 0,
2532 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002533 *
2534 * \param conf The SSL configuration to modify.
2535 * \param len The length in Bytes of the CID fields in encrypted
2536 * DTLS records using the CID mechanism. This must
2537 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01002538 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01002539 * receiving a record with an unexpected CID.
2540 * Possible values are:
2541 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2542 * In this case, the record is silently ignored.
2543 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2544 * In this case, the stack fails with the specific
2545 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002546 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002547 * \note The CID specification allows implementations to either
2548 * use a common length for all incoming connection IDs or
2549 * allow variable-length incoming IDs. Mbed TLS currently
2550 * requires a common length for all connections sharing the
2551 * same SSL configuration; this allows simpler parsing of
2552 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002553 *
2554 * \return \c 0 on success.
2555 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2556 * is too large.
2557 */
Hanno Becker8367ccc2019-05-14 11:30:10 +01002558int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2559 int ignore_other_cids );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002560#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01002561
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002562#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002563/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002564 * \brief Set the X.509 security profile used for verification
2565 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002566 * \note The restrictions are enforced for all certificates in the
2567 * chain. However, signatures in the handshake are not covered
2568 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2569 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002570 * \param conf SSL configuration
2571 * \param profile Profile to use
2572 */
2573void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002574 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002575
2576/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002577 * \brief Set the data required to verify peer certificate
2578 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002579 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002580 * parameters ca_chain (maps to trust_ca for that function)
2581 * and ca_crl.
2582 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002583 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002584 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002585 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002586 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002587void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002588 mbedtls_x509_crt *ca_chain,
2589 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002590
Hanno Becker8bf74f32019-03-27 11:01:30 +00002591#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2592/**
2593 * \brief Set the trusted certificate callback.
2594 *
2595 * This API allows to register the set of trusted certificates
2596 * through a callback, instead of a linked list as configured
2597 * by mbedtls_ssl_conf_ca_chain().
2598 *
2599 * This is useful for example in contexts where a large number
2600 * of CAs are used, and the inefficiency of maintaining them
2601 * in a linked list cannot be tolerated. It is also useful when
2602 * the set of trusted CAs needs to be modified frequently.
2603 *
2604 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2605 * more information.
2606 *
2607 * \param conf The SSL configuration to register the callback with.
2608 * \param f_ca_cb The trusted certificate callback to use when verifying
2609 * certificate chains.
2610 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2611 * a reference to a trusted CA database).
2612 *
2613 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2614 * Any call to this function overwrites the values set through
2615 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2616 * mbedtls_ssl_conf_ca_cb().
2617 *
2618 * \note This API is incompatible with CA indication in
2619 * CertificateRequest messages: A server-side SSL context which
2620 * is bound to an SSL configuration that uses a CA callback
2621 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2622 * client authentication, will send an empty CA list in the
2623 * corresponding CertificateRequest message.
2624 *
2625 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2626 * If an SSL context is bound to an SSL configuration which uses
2627 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2628 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2629 *
2630 * \note The use of this API disables the use of restartable ECC
2631 * during X.509 CRT signature verification (but doesn't affect
2632 * other uses).
2633 *
2634 * \warning This API is incompatible with the use of CRLs. Any call to
2635 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2636 * earlier calls to mbedtls_ssl_conf_ca_chain().
2637 *
2638 * \warning In multi-threaded environments, the callback \p f_ca_cb
2639 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002640 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002641 * contained in the callback context pointed to by \p p_ca_cb).
2642 */
2643void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2644 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2645 void *p_ca_cb );
2646#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2647
Paul Bakker5121ce52009-01-03 21:22:43 +00002648/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002649 * \brief Set own certificate chain and private key
2650 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002651 * \note own_cert should contain in order from the bottom up your
2652 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002653 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002654 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002655 * \note On server, this function can be called multiple times to
2656 * provision more than one cert/key pair (eg one ECDSA, one
2657 * RSA with SHA-256, one RSA with SHA-1). An adequate
2658 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002659 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002660 * adequate, preference is given to the one set by the first
2661 * call to this function, then second, etc.
2662 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002663 * \note On client, only the first call has any effect. That is,
2664 * only one client certificate can be provisioned. The
2665 * server's preferences in its CertficateRequest message will
2666 * be ignored and our only cert will be sent regardless of
2667 * whether it matches those preferences - the server can then
2668 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002669 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002670 * \note The provided \p pk_key needs to match the public key in the
2671 * first certificate in \p own_cert, or all handshakes using
2672 * that certificate will fail. It is your responsibility
2673 * to ensure that; this function will not perform any check.
2674 * You may use mbedtls_pk_check_pair() in order to perform
2675 * this check yourself, but be aware that this function can
2676 * be computationally expensive on some key types.
2677 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002678 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002679 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002680 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002681 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002682 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002683 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002684int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002685 mbedtls_x509_crt *own_cert,
2686 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002687#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002688
Gilles Peskineeccd8882020-03-10 12:19:08 +01002689#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002690/**
Hanno Becker196739b2021-05-28 05:25:46 +01002691 * \brief Configure pre-shared keys (PSKs) and their
Hanno Becker946c9252021-04-19 21:41:47 +01002692 * identities to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002693 *
Hanno Becker196739b2021-05-28 05:25:46 +01002694 * Only one PSK can be registered, through either
2695 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
2696 * If you attempt to register more than one PSK, this function
2697 * fails, though this may change in future versions, which
2698 * may add support for multiple PSKs.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002699 *
2700 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002701 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002702 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002703 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
2704 * takes precedence over a PSK configured by this function.
2705 *
Hanno Becker02283042018-10-22 15:28:02 +01002706 * \param conf The SSL configuration to register the PSK with.
2707 * \param psk The pointer to the pre-shared key to use.
2708 * \param psk_len The length of the pre-shared key in bytes.
2709 * \param psk_identity The pointer to the pre-shared key identity.
2710 * \param psk_identity_len The length of the pre-shared key identity
2711 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002712 *
Hanno Becker02283042018-10-22 15:28:02 +01002713 * \note The PSK and its identity are copied internally and
2714 * hence need not be preserved by the caller for the lifetime
2715 * of the SSL configuration.
2716 *
2717 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01002718 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01002719 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01002720 * \return Another negative error code on other kinds of failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002721 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002722int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002723 const unsigned char *psk, size_t psk_len,
2724 const unsigned char *psk_identity, size_t psk_identity_len );
2725
Hanno Becker02283042018-10-22 15:28:02 +01002726#if defined(MBEDTLS_USE_PSA_CRYPTO)
2727/**
Hanno Becker946c9252021-04-19 21:41:47 +01002728 * \brief Configure one or more opaque pre-shared keys (PSKs) and
2729 * their identities to be used in PSK-based ciphersuites.
Hanno Becker02283042018-10-22 15:28:02 +01002730 *
Hanno Becker196739b2021-05-28 05:25:46 +01002731 * Only one PSK can be registered, through either
2732 * mbedtls_ssl_conf_psk() or mbedtls_ssl_conf_psk_opaque().
2733 * If you attempt to register more than one PSK, this function
2734 * fails, though this may change in future versions, which
2735 * may add support for multiple PSKs.
Hanno Becker02283042018-10-22 15:28:02 +01002736 *
2737 * \note This is mainly useful for clients. Servers will usually
2738 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2739 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002740 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
2741 * the PSK callback takes precedence over an opaque PSK
2742 * configured by this function.
2743 *
Hanno Becker02283042018-10-22 15:28:02 +01002744 * \param conf The SSL configuration to register the PSK with.
2745 * \param psk The identifier of the key slot holding the PSK.
2746 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002747 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002748 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002749 * allows its use for the key derivation algorithm applied
2750 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002751 * \param psk_identity The pointer to the pre-shared key identity.
2752 * \param psk_identity_len The length of the pre-shared key identity
2753 * in bytes.
2754 *
2755 * \note The PSK identity hint is copied internally and hence need
2756 * not be preserved by the caller for the lifetime of the
2757 * SSL configuration.
2758 *
2759 * \return \c 0 if successful.
Hanno Becker946c9252021-04-19 21:41:47 +01002760 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no more PSKs
Hanno Becker196739b2021-05-28 05:25:46 +01002761 * can be configured. In this case, the old PSK(s) remain intact.
Hanno Becker946c9252021-04-19 21:41:47 +01002762 * \return Another negative error code on other kinds of failure.
Hanno Becker02283042018-10-22 15:28:02 +01002763 */
2764int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002765 psa_key_id_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002766 const unsigned char *psk_identity,
2767 size_t psk_identity_len );
2768#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002769
2770/**
Hanno Becker02283042018-10-22 15:28:02 +01002771 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002772 *
2773 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002774 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002775 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002776 * \note A PSK set by this function takes precedence over a PSK
2777 * configured by \c mbedtls_ssl_conf_psk().
2778 *
Hanno Becker02283042018-10-22 15:28:02 +01002779 * \param ssl The SSL context to configure a PSK for.
2780 * \param psk The pointer to the pre-shared key.
2781 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002782 *
Hanno Becker02283042018-10-22 15:28:02 +01002783 * \return \c 0 if successful.
2784 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002785 */
2786int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2787 const unsigned char *psk, size_t psk_len );
2788
Hanno Becker02283042018-10-22 15:28:02 +01002789#if defined(MBEDTLS_USE_PSA_CRYPTO)
2790/**
2791 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2792 *
2793 * \note This should only be called inside the PSK callback,
2794 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2795 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002796 * \note An opaque PSK set by this function takes precedence over an
2797 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
2798 *
Hanno Becker02283042018-10-22 15:28:02 +01002799 * \param ssl The SSL context to configure a PSK for.
2800 * \param psk The identifier of the key slot holding the PSK.
2801 * For the duration of the current handshake, the key slot
2802 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002803 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002804 * use for the key derivation algorithm
2805 * applied in the handshake.
2806 *
2807 * \return \c 0 if successful.
2808 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2809 */
2810int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002811 psa_key_id_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002812#endif /* MBEDTLS_USE_PSA_CRYPTO */
2813
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002814/**
2815 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002816 *
2817 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002818 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002819 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002820 * receive the actual PSK data and length.
2821 *
Hanno Becker02283042018-10-22 15:28:02 +01002822 * The callback has the following parameters:
2823 * - \c void*: The opaque pointer \p p_psk.
2824 * - \c mbedtls_ssl_context*: The SSL context to which
2825 * the operation applies.
2826 * - \c const unsigned char*: The PSK identity
2827 * selected by the client.
2828 * - \c size_t: The length of the PSK identity
2829 * selected by the client.
2830 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002831 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002832 * \c mbedtls_ssl_set_hs_psk() or
2833 * \c mbedtls_ssl_set_hs_psk_opaque()
2834 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002835 * Any other return value will result in a denied PSK identity.
2836 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002837 * \note A dynamic PSK (i.e. set by the PSK callback) takes
2838 * precedence over a static PSK (i.e. set by
2839 * \c mbedtls_ssl_conf_psk() or
2840 * \c mbedtls_ssl_conf_psk_opaque()).
2841 * This means that if you set a PSK callback using this
2842 * function, you don't need to set a PSK using
2843 * \c mbedtls_ssl_conf_psk() or
2844 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002845 *
Hanno Becker02283042018-10-22 15:28:02 +01002846 * \param conf The SSL configuration to register the callback with.
2847 * \param f_psk The callback for selecting and setting the PSK based
2848 * in the PSK identity chosen by the client.
2849 * \param p_psk A pointer to an opaque structure to be passed to
2850 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002851 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002852void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002853 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002854 size_t),
2855 void *p_psk );
Gilles Peskineeccd8882020-03-10 12:19:08 +01002856#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002857
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002858#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002859/**
2860 * \brief Set the Diffie-Hellman public P and G values
2861 * from big-endian binary presentations.
2862 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2863 *
2864 * \param conf SSL configuration
2865 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2866 * \param P_len Length of DHM modulus
2867 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2868 * \param G_len Length of DHM generator
2869 *
2870 * \return 0 if successful
2871 */
2872int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2873 const unsigned char *dhm_P, size_t P_len,
2874 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002875
2876/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002877 * \brief Set the Diffie-Hellman public P and G values,
2878 * read from existing context (server-side only)
2879 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002880 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002881 * \param dhm_ctx Diffie-Hellman-Merkle context
2882 *
2883 * \return 0 if successful
2884 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002885int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002886#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002887
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002888#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2889/**
2890 * \brief Set the minimum length for Diffie-Hellman parameters.
2891 * (Client-side only.)
2892 * (Default: 1024 bits.)
2893 *
2894 * \param conf SSL configuration
2895 * \param bitlen Minimum bit length of the DHM prime
2896 */
2897void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2898 unsigned int bitlen );
2899#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2900
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002901#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002902/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002903 * \brief Set the allowed curves in order of preference.
Gergely Budai987bfb52014-01-19 21:48:42 +01002904 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002905 * On server: this only affects selection of the ECDHE curve;
2906 * the curves used for ECDH and ECDSA are determined by the
2907 * list of available certificates instead.
2908 *
2909 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002910 * use. The server can override our preference order.
2911 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002912 * Both sides: limits the set of curves accepted for use in
2913 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002914 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002915 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002916 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002917 * for that. For the end-entity certificate however, the key
2918 * will be accepted only if it is allowed both by this list
2919 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002920 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002921 * \note This list should be ordered by decreasing preference
2922 * (preferred curve first).
2923 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02002924 * \note The default list is the same set of curves that
2925 * #mbedtls_x509_crt_profile_default allows, plus
2926 * ECDHE-only curves selected according to the same criteria.
Gilles Peskineb1940a72021-06-02 15:18:12 +02002927 * The order favors curves with the lowest resource usage.
Gilles Peskineae270bf2021-06-02 00:05:29 +02002928 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02002929 * \note New minor versions of Mbed TLS may extend this list,
2930 * for example if new curves are added to the library.
2931 * New minor versions of Mbed TLS will not remove items
2932 * from this list unless serious security concerns require it.
2933 * New minor versions of Mbed TLS may change the order in
2934 * keeping with the general principle of favoring the lowest
2935 * resource usage.
2936 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002937 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002938 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002940 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002941void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2942 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002943#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002944
Gilles Peskineeccd8882020-03-10 12:19:08 +01002945#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002946/**
2947 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002948 *
2949 * \note This only affects which hashes are offered and can be used
2950 * for signatures during the handshake. Hashes for message
2951 * authentication and the TLS PRF are controlled by the
2952 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2953 * used for certificate signature are controlled by the
2954 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2955 *
2956 * \note This list should be ordered by decreasing preference
2957 * (preferred hash first).
2958 *
Gilles Peskineae270bf2021-06-02 00:05:29 +02002959 * \note By default, all supported hashes whose length is at least
2960 * 256 bits are allowed. This is the same set as the default
2961 * for certificate verification
Gilles Peskinea28f0f52021-06-02 15:29:38 +02002962 * (#mbedtls_x509_crt_profile_default).
2963 * The preference order is currently unspecified and may
2964 * change in future versions.
Gilles Peskineae270bf2021-06-02 00:05:29 +02002965 *
Gilles Peskinea03fb292021-06-17 23:17:05 +02002966 * \note New minor versions of Mbed TLS may extend this list,
2967 * for example if new curves are added to the library.
2968 * New minor versions of Mbed TLS will not remove items
2969 * from this list unless serious security concerns require it.
2970 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002971 * \param conf SSL configuration
2972 * \param hashes Ordered list of allowed signature hashes,
2973 * terminated by \c MBEDTLS_MD_NONE.
2974 */
2975void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2976 const int *hashes );
Gilles Peskineeccd8882020-03-10 12:19:08 +01002977#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002978
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002979#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002980/**
Darryl Green11999bb2018-03-13 15:22:58 +00002981 * \brief Set or reset the hostname to check against the received
2982 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002983 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002984 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002985 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002986 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002987
Hanno Becker0446a392017-04-07 12:59:32 +01002988 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002989 *
Darryl Green11999bb2018-03-13 15:22:58 +00002990 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2991 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002992 * too long input hostname.
2993 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002994 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002995 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002996 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002997 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002998int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002999#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003000
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003001#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003002/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003003 * \brief Set own certificate and key for the current handshake
3004 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003005 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003006 * the SNI callback.
3007 *
3008 * \param ssl SSL context
3009 * \param own_cert own public certificate chain
3010 * \param pk_key own private key
3011 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003012 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003013 */
3014int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
3015 mbedtls_x509_crt *own_cert,
3016 mbedtls_pk_context *pk_key );
3017
3018/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003019 * \brief Set the data required to verify peer certificate for the
3020 * current handshake
3021 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003022 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003023 * the SNI callback.
3024 *
3025 * \param ssl SSL context
3026 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3027 * \param ca_crl trusted CA CRLs
3028 */
3029void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
3030 mbedtls_x509_crt *ca_chain,
3031 mbedtls_x509_crl *ca_crl );
3032
3033/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003034 * \brief Set authmode for the current handshake.
3035 *
3036 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
3037 * the SNI callback.
3038 *
3039 * \param ssl SSL context
3040 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3041 * MBEDTLS_SSL_VERIFY_REQUIRED
3042 */
3043void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
3044 int authmode );
3045
3046/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003047 * \brief Set server side ServerName TLS extension callback
3048 * (optional, server-side only).
3049 *
3050 * If set, the ServerName callback is called whenever the
3051 * server receives a ServerName TLS extension from the client
3052 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003053 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003054 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003055 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003056 * certificate(s) and key(s) to use with \c
3057 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003058 * and may optionally adjust the CA and associated CRL with \c
3059 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3060 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3061 * then must return 0. If no matching name is found, the
3062 * callback must either set a default cert, or
3063 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003064 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003065 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003066 * \param f_sni verification function
3067 * \param p_sni verification parameter
3068 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003069void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003070 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003071 size_t),
3072 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003074
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003075#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003076/**
3077 * \brief Set the EC J-PAKE password for current handshake.
3078 *
3079 * \note An internal copy is made, and destroyed as soon as the
3080 * handshake is completed, or when the SSL context is reset or
3081 * freed.
3082 *
3083 * \note The SSL context needs to be already set up. The right place
3084 * to call this function is between \c mbedtls_ssl_setup() or
3085 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
3086 *
3087 * \param ssl SSL context
3088 * \param pw EC J-PAKE password (pre-shared secret)
3089 * \param pw_len length of pw in bytes
3090 *
3091 * \return 0 on success, or a negative error code.
3092 */
3093int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3094 const unsigned char *pw,
3095 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003096#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003097
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003099/**
3100 * \brief Set the supported Application Layer Protocols.
3101 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003102 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003103 * \param protos Pointer to a NULL-terminated list of supported protocols,
3104 * in decreasing preference order. The pointer to the list is
3105 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00003106 * the lifetime of the table must be atleast as long as the
3107 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003108 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003109 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003110 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003111int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003112
3113/**
3114 * \brief Get the name of the negotiated Application Layer Protocol.
3115 * This function should be called after the handshake is
3116 * completed.
3117 *
3118 * \param ssl SSL context
3119 *
3120 * \return Protcol name, or NULL if no protocol was negotiated.
3121 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003122const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
3123#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003124
Johan Pascalb62bb512015-12-03 21:56:45 +01003125#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003126#if defined(MBEDTLS_DEBUG_C)
Johan Pascalaae4d222020-09-22 21:21:39 +02003127static inline const char *mbedtls_ssl_get_srtp_profile_as_string( mbedtls_ssl_srtp_profile profile )
Johan Pascala455cd92020-09-22 15:28:11 +02003128{
3129 switch( profile )
3130 {
3131 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003132 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003133 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003134 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003135 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003136 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003137 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003138 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003139 default: break;
3140 }
3141 return( "" );
3142}
3143#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003144/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003145 * \brief Manage support for mki(master key id) value
3146 * in use_srtp extension.
3147 * MKI is an optional part of SRTP used for key management
3148 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003149 * The default value is
3150 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003151 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003152 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003153 * \param support_mki_value Enable or disable mki usage. Values are
3154 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3155 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003156 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003157void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3158 int support_mki_value );
Ron Eldor591f1622018-01-22 12:30:04 +02003159
3160/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003161 * \brief Set the supported DTLS-SRTP protection profiles.
3162 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003163 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003164 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3165 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003166 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003167 * The pointer to the list is recorded by the library
3168 * for later reference as required, so the lifetime
3169 * of the table must be at least as long as the lifetime
3170 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003171 * The list must not hold more than
3172 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003173 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01003174 *
Johan Pascal85269572020-08-25 10:01:54 +02003175 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003176 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
3177 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01003178 */
Ron Eldora9788042018-12-05 11:04:31 +02003179int mbedtls_ssl_conf_dtls_srtp_protection_profiles
3180 ( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02003181 const mbedtls_ssl_srtp_profile *profiles );
Ron Eldor591f1622018-01-22 12:30:04 +02003182
3183/**
Ron Eldora9788042018-12-05 11:04:31 +02003184 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02003185 *
Ron Eldora9788042018-12-05 11:04:31 +02003186 * \param ssl SSL context to use.
3187 * \param mki_value The MKI value to set.
3188 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02003189 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003190 * \note This function is relevant on client side only.
3191 * The server discovers the mki value during handshake.
3192 * A mki value set on server side using this function
3193 * is ignored.
3194 *
Johan Pascal85269572020-08-25 10:01:54 +02003195 * \return 0 on success
3196 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
3197 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02003198 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003199int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
3200 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02003201 uint16_t mki_len );
Johan Pascalb62bb512015-12-03 21:56:45 +01003202/**
Johan Pascal2258a4f2020-10-28 13:53:09 +01003203 * \brief Get the negotiated DTLS-SRTP informations:
3204 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003205 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003206 * \warning This function must be called after the handshake is
3207 * completed. The value returned by this function must
3208 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01003209 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003210 * \param ssl The SSL context to query.
3211 * \param dtls_srtp_info The negotiated DTLS-SRTP informations:
3212 * - Protection profile in use.
3213 * A direct mapping of the iana defined value for protection
3214 * profile on an uint16_t.
3215 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
3216 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
3217 * or peer's Hello packet was not parsed yet.
3218 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01003219 */
Johan Pascal2258a4f2020-10-28 13:53:09 +01003220void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
3221 mbedtls_dtls_srtp_info *dtls_srtp_info );
Johan Pascalb62bb512015-12-03 21:56:45 +01003222#endif /* MBEDTLS_SSL_DTLS_SRTP */
3223
Paul Bakker5701cdc2012-09-27 21:49:42 +00003224/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003225 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003226 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003227 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003228 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003229 * \note This ignores ciphersuites from higher versions.
3230 *
TRodziewicz0f82ec62021-05-12 17:49:18 +02003231 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003232 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003233 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003234 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Manuel Pégourié-Gonnard9371a402021-06-04 11:44:44 +02003235 * \param minor Minor version number (only MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003236 */
Ron Eldora9788042018-12-05 11:04:31 +02003237void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00003238
Paul Bakker1d29fb52012-09-28 13:28:45 +00003239/**
3240 * \brief Set the minimum accepted SSL/TLS protocol version
TRodziewicz0f82ec62021-05-12 17:49:18 +02003241 * (Default: TLS 1.2)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003242 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003243 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3244 * SSL_MIN_XXXXX_VERSION range is ignored.
3245 *
TRodziewicz4ca18aa2021-05-20 14:46:20 +02003246 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003247 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003248 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003249 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Manuel Pégourié-Gonnard9371a402021-06-04 11:44:44 +02003250 * \param minor Minor version number (only MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003251 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003252void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00003253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003254#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003255/**
3256 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003257 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003258 *
3259 * \note This should always be enabled, it is a security
3260 * improvement, and should not cause any interoperability
3261 * issue (used only if the peer supports it too).
3262 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003263 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003264 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003265 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003266void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003267#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003268
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003270/**
3271 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003272 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003273 *
3274 * \note This should always be enabled, it is a security fix to the
3275 * protocol, and should not cause any interoperability issue
3276 * (used only if the peer supports it too).
3277 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003278 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003279 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003280 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003281void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003282#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003283
Janos Follath088ce432017-04-10 12:42:31 +01003284#if defined(MBEDTLS_SSL_SRV_C)
3285/**
3286 * \brief Whether to send a list of acceptable CAs in
3287 * CertificateRequest messages.
3288 * (Default: do send)
3289 *
3290 * \param conf SSL configuration
3291 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3292 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3293 */
3294void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3295 char cert_req_ca_list );
3296#endif /* MBEDTLS_SSL_SRV_C */
3297
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003298#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003299/**
k-stachowiak6d722122019-02-08 17:03:33 +01003300 * \brief Set the maximum fragment length to emit and/or negotiate.
3301 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3302 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003303 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003304 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003305 * (Client: set maximum fragment length to emit *and*
3306 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003307 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003308 *
k-stachowiak6d722122019-02-08 17:03:33 +01003309 * \note On the client side, the maximum fragment length extension
3310 * *will not* be used, unless the maximum fragment length has
3311 * been set via this function to a value different than
3312 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003313 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003314 * \note With TLS, this currently only affects ApplicationData (sent
3315 * with \c mbedtls_ssl_read()), not handshake messages.
3316 * With DTLS, this affects both ApplicationData and handshake.
3317 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003318 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003319 * excluding record overhead that will be added to it, see
3320 * \c mbedtls_ssl_get_record_expansion().
3321 *
3322 * \note For DTLS, it is also possible to set a limit for the total
3323 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003324 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003325 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003326 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003327 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003328 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3329 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003330 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003331 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003332 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003333int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003334#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003335
TRodziewicz8476f2f2021-06-02 14:34:47 +02003336#if defined(MBEDTLS_SSL_SRV_C)
3337/**
TRodziewicz3946f792021-06-14 12:11:18 +02003338 * \brief Pick the ciphersuites order according to the second parameter
3339 * in the SSL Server module (MBEDTLS_SSL_SRV_C).
3340 * (Default, if never called: MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER)
TRodziewicz8476f2f2021-06-02 14:34:47 +02003341 *
3342 * \param conf SSL configuration
TRodziewicz3946f792021-06-14 12:11:18 +02003343 * \param order Server or client (MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_SERVER
3344 * or MBEDTLS_SSL_SRV_CIPHERSUITE_ORDER_CLIENT)
TRodziewicz8476f2f2021-06-02 14:34:47 +02003345 */
TRodziewicz3946f792021-06-14 12:11:18 +02003346void mbedtls_ssl_conf_preference_order( mbedtls_ssl_config *conf, int order );
TRodziewicz8476f2f2021-06-02 14:34:47 +02003347#endif /* MBEDTLS_SSL_SRV_C */
3348
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003349#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003350/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003351 * \brief Enable / Disable session tickets (client only).
3352 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003353 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003354 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003355 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003356 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003357 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3358 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003359 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003360void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3361#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003363#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003364/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003365 * \brief Enable / Disable renegotiation support for connection when
3366 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003367 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003368 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003369 * \warning It is recommended to always disable renegotation unless you
3370 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003371 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003372 * renegotiation or a poor understanding of its properties.
3373 *
3374 * \note Server-side, enabling renegotiation also makes the server
3375 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003376 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003377 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003378 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3379 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003380 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003381void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003382#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003383
3384/**
3385 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003386 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003387 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003388 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003389 * be established even if the peer does not support
3390 * secure renegotiation, but does not allow renegotiation
3391 * to take place if not secure.
3392 * (Interoperable and secure option)
3393 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003394 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003395 * with non-upgraded peers. Allowing legacy renegotiation
3396 * makes the connection vulnerable to specific man in the
3397 * middle attacks. (See RFC 5746)
3398 * (Most interoperable and least secure option)
3399 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003400 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003401 * if peer does not support secure renegotiation. Results
3402 * in interoperability issues with non-upgraded peers
3403 * that do not support renegotiation altogether.
3404 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003405 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003406 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003407 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3408 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003409 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003410 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003411void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003412
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003414/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003415 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003416 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003417 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003418 * When we request a renegotiation, the peer can comply or
3419 * ignore the request. This function allows us to decide
3420 * whether to enforce our renegotiation requests by closing
3421 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003422 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003423 * However, records could already be in transit from the peer
3424 * when the request is emitted. In order to increase
3425 * reliability, we can accept a number of records before the
3426 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003427 *
3428 * The optimal value is highly dependent on the specific usage
3429 * scenario.
3430 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003431 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003433 * out or receives Application Data, until:
3434 * - max_records records have beens seen, if it is >= 0, or
3435 * - the number of retransmits that would happen during an
3436 * actual handshake has been reached.
3437 * Please remember the request might be lost a few times
3438 * if you consider setting max_records to a really low value.
3439 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003440 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003441 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003442 * which always behave as if max_record was 0. The reason is,
3443 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003444 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003445 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003446 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003447 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003448 * enforce renegotiation, or a non-negative value to enforce
3449 * it but allow for a grace period of max_records records.
3450 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003451void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003452
3453/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003454 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003455 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003456 *
3457 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003458 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003459 * threshold. The default value is meant to prevent the
3460 * connection from being closed when the counter is about to
3461 * reached its maximal value (it is not allowed to wrap).
3462 *
3463 * Lower values can be used to enforce policies such as "keys
3464 * must be refreshed every N packets with cipher X".
3465 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003466 * The renegotiation period can be disabled by setting
3467 * conf->disable_renegotiation to
3468 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3469 *
3470 * \note When the configured transport is
3471 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3472 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3473 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003474 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003475 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003476 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003477 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003478void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003479 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003481
Paul Bakker43ca69c2011-01-15 17:35:19 +00003482/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003483 * \brief Check if there is data already read from the
3484 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003485 *
3486 * \param ssl SSL context
3487 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003488 * \return 0 if nothing's pending, 1 otherwise.
3489 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003490 * \note This is different in purpose and behaviour from
3491 * \c mbedtls_ssl_get_bytes_avail in that it considers
3492 * any kind of unprocessed data, not only unread
3493 * application data. If \c mbedtls_ssl_get_bytes
3494 * returns a non-zero value, this function will
3495 * also signal pending data, but the converse does
3496 * not hold. For example, in DTLS there might be
3497 * further records waiting to be processed from
3498 * the current underlying transport's datagram.
3499 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003500 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003501 * does not imply that a subsequent call to
3502 * \c mbedtls_ssl_read will provide any data;
3503 * e.g., the unprocessed data might turn out
3504 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003505 *
3506 * \note This function is useful in the following situation:
3507 * If the SSL/TLS module successfully returns from an
3508 * operation - e.g. a handshake or an application record
3509 * read - and you're awaiting incoming data next, you
3510 * must not immediately idle on the underlying transport
3511 * to have data ready, but you need to check the value
3512 * of this function first. The reason is that the desired
3513 * data might already be read but not yet processed.
3514 * If, in contrast, a previous call to the SSL/TLS module
3515 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3516 * to call this function, as the latter error code entails
3517 * that all internal data has been processed.
3518 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003519 */
3520int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3521
3522/**
3523 * \brief Return the number of application data bytes
3524 * remaining to be read from the current record.
3525 *
3526 * \param ssl SSL context
3527 *
3528 * \return How many bytes are available in the application
3529 * data record read buffer.
3530 *
3531 * \note When working over a datagram transport, this is
3532 * useful to detect the current datagram's boundary
3533 * in case \c mbedtls_ssl_read has written the maximal
3534 * amount of data fitting into the input buffer.
3535 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003536 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003537size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003538
3539/**
3540 * \brief Return the result of the certificate verification
3541 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003542 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003543 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003544 * \return \c 0 if the certificate verification was successful.
3545 * \return \c -1u if the result is not available. This may happen
3546 * e.g. if the handshake aborts early, or a verification
3547 * callback returned a fatal error.
3548 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3549 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003550 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003551uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003552
3553/**
3554 * \brief Return the name of the current ciphersuite
3555 *
3556 * \param ssl SSL context
3557 *
3558 * \return a string containing the ciphersuite name
3559 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003560const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003561
3562/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003563 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003564 *
3565 * \param ssl SSL context
3566 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003567 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003568 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003569const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003570
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003571/**
3572 * \brief Return the (maximum) number of bytes added by the record
3573 * layer: header + encryption/MAC overhead (inc. padding)
3574 *
3575 * \param ssl SSL context
3576 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01003577 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003578 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003579int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003580
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003581/**
3582 * \brief Return the current maximum outgoing 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
3586 * the config.h setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions
3587 * such as the max fragment length or record size limit extension if
3588 * used, and for DTLS the path MTU as configured and current
3589 * record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003590 *
3591 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3592 * called with a larger length value.
3593 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3594 * necessary and return the number of bytes written; it is up
3595 * to the caller to call \c mbedtls_ssl_write() again in
3596 * order to send the remaining bytes if any.
3597 *
Hanno Becker80d163d2021-04-21 06:28:18 +01003598 * \sa mbedtls_ssl_get_max_out_record_payload()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003599 * \sa mbedtls_ssl_get_record_expansion()
3600 *
3601 * \param ssl SSL context
3602 *
3603 * \return Current maximum payload for an outgoing record,
3604 * or a negative error code.
3605 */
3606int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3607
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003608/**
3609 * \brief Return the current maximum incoming record payload in bytes.
Hanno Beckerebd6ab72021-05-23 05:59:46 +01003610 *
3611 * \note The logic to determine the maximum outgoing record payload is
3612 * version-specific. It takes into account various factors, such as
3613 * the config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003614 * such as the max fragment length extension or record size limit
3615 * extension if used, and the current record expansion.
3616 *
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003617 * \sa mbedtls_ssl_set_mtu()
Hanno Becker80d163d2021-04-21 06:28:18 +01003618 * \sa mbedtls_ssl_get_max_in_record_payload()
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003619 * \sa mbedtls_ssl_get_record_expansion()
3620 *
3621 * \param ssl SSL context
3622 *
3623 * \return Current maximum payload for an outgoing record,
3624 * or a negative error code.
3625 */
3626int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl );
3627
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003628#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003629/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003630 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003631 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003632 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003633 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003634 * \return The current peer certificate, if available.
3635 * The returned certificate is owned by the SSL context and
3636 * is valid only until the next call to the SSL API.
3637 * \return \c NULL if no peer certificate is available. This might
3638 * be because the chosen ciphersuite doesn't use CRTs
3639 * (PSK-based ciphersuites, for example), or because
3640 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3641 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003642 *
3643 * \note For one-time inspection of the peer's certificate during
3644 * the handshake, consider registering an X.509 CRT verification
3645 * callback through mbedtls_ssl_conf_verify() instead of calling
3646 * this function. Using mbedtls_ssl_conf_verify() also comes at
3647 * the benefit of allowing you to influence the verification
3648 * process, for example by masking expected and tolerated
3649 * verification failures.
3650 *
3651 * \warning You must not use the pointer returned by this function
3652 * after any further call to the SSL API, including
3653 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3654 * because the pointer might change during renegotiation,
3655 * which happens transparently to the user.
3656 * If you want to use the certificate across API calls,
3657 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003658 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003659const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3660#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003661
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003662#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003663/**
Hanno Beckere810bbc2021-05-14 16:01:05 +01003664 * \brief Export a session in order to resume it later.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003665 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003666 * \param ssl The SSL context representing the connection for which to
3667 * to export a session structure for later resumption.
3668 * \param session The target structure in which to store the exported session.
3669 * This must have been initialized with mbedtls_ssl_init_session()
3670 * but otherwise be unused.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003671 *
Hanno Becker5c5b8202021-06-18 12:21:25 +01003672 * \note This function can handle a variety of mechanisms for session
Hanno Beckerab4ecfc2021-06-17 05:12:16 +01003673 * resumption: For TLS 1.2, both session ID-based resumption and
Hanno Beckere810bbc2021-05-14 16:01:05 +01003674 * ticket-based resumption will be considered. For TLS 1.3,
3675 * once implemented, sessions equate to tickets, and calling
3676 * this function multiple times will export the available
3677 * tickets one a time until no further tickets are available,
3678 * in which case MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE will
3679 * be returned.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003680 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003681 * \note Calling this function multiple times will only be useful
3682 * once TLS 1.3 is supported. For TLS 1.2 connections, this
3683 * function should be called at most once.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003684 *
Hanno Beckere810bbc2021-05-14 16:01:05 +01003685 * \return \c 0 if successful. In this case, \p session can be used for
3686 * session resumption by passing it to mbedtls_ssl_set_session(),
3687 * and serialized for storage via mbedtls_ssl_session_save().
3688 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if no further session
3689 * is available for export.
3690 * This error is a non-fatal, and has no observable effect on
3691 * the SSL context or the destination session.
3692 * \return Another negative error code on other kinds of failure.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003693 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003694 * \sa mbedtls_ssl_set_session()
Hanno Beckere810bbc2021-05-14 16:01:05 +01003695 * \sa mbedtls_ssl_session_save()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003696 */
Hanno Beckere810bbc2021-05-14 16:01:05 +01003697int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl,
3698 mbedtls_ssl_session *session );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003699#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003700
3701/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003702 * \brief Perform the SSL handshake
3703 *
3704 * \param ssl SSL context
3705 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003706 * \return \c 0 if successful.
3707 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003708 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003709 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003710 * transport - in this case you must call this function again
3711 * when the underlying transport is ready for the operation.
3712 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3713 * operation is in progress (see
3714 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3715 * must call this function again when the operation is ready.
3716 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3717 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3718 * in this case you must call this function again to complete
3719 * the handshake when you're done attending other tasks.
3720 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3721 * and the client did not demonstrate reachability yet - in
3722 * this case you must stop using the context (see below).
3723 * \return Another SSL error code - in this case you must stop using
3724 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003725 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003726 * \warning If this function returns something other than
3727 * \c 0,
3728 * #MBEDTLS_ERR_SSL_WANT_READ,
3729 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3730 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3731 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3732 * you must stop using the SSL context for reading or writing,
3733 * and either free it or call \c mbedtls_ssl_session_reset()
3734 * on it before re-using it for a new connection; the current
3735 * connection must be closed.
3736 *
3737 * \note If DTLS is in use, then you may choose to handle
3738 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3739 * purposes, as it is an expected return value rather than an
3740 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003741 *
3742 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003743 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003744 * from the underlying transport layer is currently being processed,
3745 * and it is safe to idle until the timer or the underlying transport
3746 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003747 * in which case the datagram of the underlying transport that is
3748 * currently being processed might or might not contain further
3749 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003750 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003751int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003752
3753/**
Paul Bakker1961b702013-01-25 14:49:24 +01003754 * \brief Perform a single step of the SSL handshake
3755 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003756 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003757 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003758 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003759 *
3760 * \param ssl SSL context
3761 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003762 * \return See mbedtls_ssl_handshake().
3763 *
3764 * \warning If this function returns something other than \c 0,
3765 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3766 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3767 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3768 * the SSL context for reading or writing, and either free it
3769 * or call \c mbedtls_ssl_session_reset() on it before
3770 * re-using it for a new connection; the current connection
3771 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003772 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003773int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003774
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003775#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003776/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003777 * \brief Initiate an SSL renegotiation on the running connection.
3778 * Client: perform the renegotiation right now.
3779 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003780 * during the next call to mbedtls_ssl_read() if honored by
3781 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003782 *
3783 * \param ssl SSL context
3784 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003785 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003786 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3787 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003788 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003789 * \warning If this function returns something other than \c 0,
3790 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3791 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3792 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3793 * the SSL context for reading or writing, and either free it
3794 * or call \c mbedtls_ssl_session_reset() on it before
3795 * re-using it for a new connection; the current connection
3796 * must be closed.
3797 *
Paul Bakker48916f92012-09-16 19:57:18 +00003798 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003799int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3800#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003801
3802/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003803 * \brief Read at most 'len' application data bytes
3804 *
3805 * \param ssl SSL context
3806 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003807 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003808 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003809 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003810 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04003811 * without sending a CloseNotify beforehand, which might happen
3812 * because of various reasons (internal error of an underlying
3813 * stack, non-conformant peer not sending a CloseNotify and
3814 * such) - in this case you must stop using the context
3815 * (see below).
3816 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
3817 * transport is still functional, but the peer has
3818 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003819 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003820 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003821 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003822 * transport - in this case you must call this function again
3823 * when the underlying transport is ready for the operation.
3824 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3825 * operation is in progress (see
3826 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3827 * must call this function again when the operation is ready.
3828 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3829 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3830 * in this case you must call this function again to complete
3831 * the handshake when you're done attending other tasks.
3832 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3833 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003834 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003835 * \return Another SSL error code - in this case you must stop using
3836 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003837 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003838 * \warning If this function returns something other than
3839 * a positive value,
3840 * #MBEDTLS_ERR_SSL_WANT_READ,
3841 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3842 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3843 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3844 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3845 * you must stop using the SSL context for reading or writing,
3846 * and either free it or call \c mbedtls_ssl_session_reset()
3847 * on it before re-using it for a new connection; the current
3848 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003849 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003850 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003851 * (which can only happen server-side), it means that a client
3852 * is initiating a new connection using the same source port.
3853 * You can either treat that as a connection close and wait
3854 * for the client to resend a ClientHello, or directly
3855 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003856 * context (as it has been reset internally). Either way, you
3857 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003858 * connection: application state, if any, should be reset, and
3859 * most importantly the identity of the client must be checked
3860 * again. WARNING: not validating the identity of the client
3861 * again, or not transmitting the new identity to the
3862 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003863 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003864 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003865 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003866 * from the underlying transport layer is currently being processed,
3867 * and it is safe to idle until the timer or the underlying transport
3868 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003869 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3870 * initially available on the underlying transport, as this data may have
3871 * been only e.g. duplicated messages or a renegotiation request.
3872 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3873 * when reacting to an incoming-data event from the underlying transport.
3874 * - On success, the datagram of the underlying transport that is currently
3875 * being processed may contain further DTLS records. You should call
3876 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003877 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003878 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003879int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003880
3881/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003882 * \brief Try to write exactly 'len' application data bytes
3883 *
3884 * \warning This function will do partial writes in some cases. If the
3885 * return value is non-negative but less than length, the
3886 * function must be called again with updated arguments:
3887 * buf + ret, len - ret (if ret is the return value) until
3888 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003889 *
3890 * \param ssl SSL context
3891 * \param buf buffer holding the data
3892 * \param len how many bytes must be written
3893 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003894 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003895 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003896 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003897 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003898 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003899 * transport - in this case you must call this function again
3900 * when the underlying transport is ready for the operation.
3901 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3902 * operation is in progress (see
3903 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3904 * must call this function again when the operation is ready.
3905 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3906 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3907 * in this case you must call this function again to complete
3908 * the handshake when you're done attending other tasks.
3909 * \return Another SSL error code - in this case you must stop using
3910 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003911 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003912 * \warning If this function returns something other than
3913 * a non-negative value,
3914 * #MBEDTLS_ERR_SSL_WANT_READ,
3915 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3916 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3917 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3918 * you must stop using the SSL context for reading or writing,
3919 * and either free it or call \c mbedtls_ssl_session_reset()
3920 * on it before re-using it for a new connection; the current
3921 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003922 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003923 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003924 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003925 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003926 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003927 * some partial data in the output buffer, however this is not
3928 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003929 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003930 * \note If the requested length is greater than the maximum
3931 * fragment length (either the built-in limit or the one set
3932 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003933 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003934 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Hanno Becker80d163d2021-04-21 06:28:18 +01003935 * \c mbedtls_ssl_get_max_out_record_payload() may be used to
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003936 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003937 *
3938 * \note Attempting to write 0 bytes will result in an empty TLS
3939 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003941int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003942
3943/**
Paul Bakker0a925182012-04-16 06:46:41 +00003944 * \brief Send an alert message
3945 *
3946 * \param ssl SSL context
3947 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003948 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003949 * \param message The alert message (SSL_ALERT_MSG_*)
3950 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003951 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003952 *
3953 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003954 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3955 * the SSL context for reading or writing, and either free it or
3956 * call \c mbedtls_ssl_session_reset() on it before re-using it
3957 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003958 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003959int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003960 unsigned char level,
3961 unsigned char message );
3962/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003963 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003964 *
3965 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003966 *
3967 * \return 0 if successful, or a specific SSL error code.
3968 *
3969 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003970 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3971 * the SSL context for reading or writing, and either free it or
3972 * call \c mbedtls_ssl_session_reset() on it before re-using it
3973 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003974 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003975int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003976
3977/**
Paul Bakker48916f92012-09-16 19:57:18 +00003978 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003979 *
3980 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003981 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003982void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003983
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02003984#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003985/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003986 * \brief Save an active connection as serialized data in a buffer.
3987 * This allows the freeing or re-using of the SSL context
3988 * while still picking up the connection later in a way that
3989 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003990 *
3991 * \see mbedtls_ssl_context_load()
3992 *
3993 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003994 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003995 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
3996 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02003997 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02003998 * mbedtls_ssl_session_reset() on \p ssl which as a result is
3999 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004000 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004001 * state. You're then free to either re-use the context
4002 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004003 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004004 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004005 *
4006 * \param ssl The SSL context to save. On success, it is no longer
4007 * associated with the connection that has been serialized.
4008 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03004009 * writeable buffer of at least \p buf_len bytes, or may be \c
4010 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004011 * \param buf_len The number of bytes available for writing in \p buf.
4012 * \param olen The size in bytes of the data that has been or would have
4013 * been written. It must point to a valid \c size_t.
4014 *
4015 * \note \p olen is updated to the correct value regardless of
4016 * whether \p buf_len was large enough. This makes it possible
4017 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004018 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
4019 * the value of \p olen is only guaranteed to be correct when
4020 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
4021 * \c 0. If the return value is different, then the value of
4022 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004023 *
4024 * \return \c 0 if successful.
4025 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004026 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
4027 * while reseting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004028 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004029 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004030 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004031 * ciphersuite, or renegotiation is enabled.
4032 */
4033int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4034 unsigned char *buf,
4035 size_t buf_len,
4036 size_t *olen );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004037
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004038/**
4039 * \brief Load serialized connection data to an SSL context.
4040 *
4041 * \see mbedtls_ssl_context_save()
4042 *
4043 * \warning The same serialized data must never be loaded into more
4044 * that one context. In order to ensure that, after
4045 * successfully loading serialized data to an SSL context, you
4046 * should immediately destroy or invalidate all copies of the
4047 * serialized data that was loaded. Loading the same data in
4048 * more than one context would cause severe security failures
4049 * including but not limited to loss of confidentiality.
4050 *
4051 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004052 * prepared in one of the two following ways. The first way is
4053 * to take a context freshly initialised with
4054 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004055 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004056 * the original connection. The second way is to
4057 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004058 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004059 * Either way, you must not use the context to perform a
4060 * handshake between calling mbedtls_ssl_setup() or
4061 * mbedtls_ssl_session_reset() and calling this function. You
4062 * may however call other setter functions in that time frame
4063 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004064 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004065 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004066 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004067 * and settings before you can use the connection again
4068 * (unless they were already set before calling
4069 * mbedtls_ssl_session_reset() and the values are suitable for
4070 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02004071 * at least mbedtls_ssl_set_bio() and
4072 * mbedtls_ssl_set_timer_cb(). All other SSL setter functions
4073 * are not necessary to call, either because they're only used
4074 * in handshakes, or because the setting is already saved. You
4075 * might choose to call them anyway, for example in order to
4076 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004077 * connection and the case of loading an already-established
4078 * connection.
4079 *
4080 * \note If you have new information about the path MTU, you want to
4081 * call mbedtls_ssl_set_mtu() after calling this function, as
4082 * otherwise this function would overwrite your
4083 * newly-configured value with the value that was active when
4084 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004085 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004086 * \note When this function returns an error code, it calls
4087 * mbedtls_ssl_free() on \p ssl. In this case, you need to
4088 * prepare the context with the usual sequence starting with a
4089 * call to mbedtls_ssl_init() if you want to use it again.
4090 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004091 * \param ssl The SSL context structure to be populated. It must have
4092 * been prepared as described in the note above.
4093 * \param buf The buffer holding the serialized connection data. It must
4094 * be a readable buffer of at least \p len bytes.
4095 * \param len The size of the serialized data in bytes.
4096 *
4097 * \return \c 0 if successful.
4098 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004099 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
4100 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004101 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4102 */
4103int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
4104 const unsigned char *buf,
4105 size_t len );
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004106#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004107
4108/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004109 * \brief Initialize an SSL configuration context
4110 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004111 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004112 *
4113 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01004114 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004115 *
4116 * \param conf SSL configuration context
4117 */
4118void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
4119
4120/**
4121 * \brief Load reasonnable default SSL configuration values.
4122 * (You need to call mbedtls_ssl_config_init() first.)
4123 *
4124 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004125 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4126 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4127 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004128 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004129 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004130 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004131 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004132 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004133 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004134 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004135int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004136 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004137
4138/**
4139 * \brief Free an SSL configuration context
4140 *
4141 * \param conf SSL configuration context
4142 */
4143void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
4144
4145/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004146 * \brief Initialize SSL session structure
4147 *
4148 * \param session SSL session
4149 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004150void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004151
4152/**
Paul Bakker0a597072012-09-25 21:55:46 +00004153 * \brief Free referenced items in an SSL session including the
4154 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004155 *
Ron Eldor00115032018-07-17 11:21:50 +03004156 * \note A session object can be freed even if the SSL context
4157 * that was used to retrieve the session is still in use.
4158 *
Paul Bakker48916f92012-09-16 19:57:18 +00004159 * \param session SSL session
4160 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004161void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00004162
Ron Eldor51d3ab52019-05-12 14:54:30 +03004163/**
4164 * \brief TLS-PRF function for key derivation.
4165 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004166 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004167 * \param secret Secret for the key derivation function.
4168 * \param slen Length of the secret.
4169 * \param label String label for the key derivation function,
4170 * terminated with null character.
4171 * \param random Random bytes.
4172 * \param rlen Length of the random bytes buffer.
4173 * \param dstbuf The buffer holding the derived key.
4174 * \param dlen Length of the output buffer.
4175 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004176 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004177 */
4178int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
4179 const unsigned char *secret, size_t slen,
4180 const char *label,
4181 const unsigned char *random, size_t rlen,
4182 unsigned char *dstbuf, size_t dlen );
4183
Paul Bakker5121ce52009-01-03 21:22:43 +00004184#ifdef __cplusplus
4185}
4186#endif
4187
4188#endif /* ssl.h */