blob: 194aee5fa43c0ea849bb4af24cc9965f1e05bf8e [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
Paul Bakker5121ce52009-01-03 21:22:43 +000024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#if !defined(MBEDTLS_CONFIG_FILE)
Jaeden Amero6609aef2019-07-04 20:01:14 +010026#include "mbedtls/config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020027#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020028#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010030
Jaeden Amero6609aef2019-07-04 20:01:14 +010031#include "mbedtls/bignum.h"
32#include "mbedtls/ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020033
Jaeden Amero6609aef2019-07-04 20:01:14 +010034#include "mbedtls/ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000035
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020036#if defined(MBEDTLS_X509_CRT_PARSE_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010037#include "mbedtls/x509_crt.h"
38#include "mbedtls/x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020039#endif
Paul Bakkered27a042013-04-18 22:46:23 +020040
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#if defined(MBEDTLS_DHM_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010042#include "mbedtls/dhm.h"
Paul Bakker48916f92012-09-16 19:57:18 +000043#endif
44
John Durkop07cc04a2020-11-16 22:08:34 -080045/* Adding guard for MBEDTLS_ECDSA_C to ensure no compile errors due
46 * to guards also being in ssl_srv.c and ssl_cli.c. There is a gap
47 * in functionality that access to ecdh_ctx structure is needed for
48 * MBEDTLS_ECDSA_C which does not seem correct.
49 */
50#if defined(MBEDTLS_ECDH_C) || defined(MBEDTLS_ECDSA_C)
Jaeden Amero6609aef2019-07-04 20:01:14 +010051#include "mbedtls/ecdh.h"
Paul Bakker41c83d32013-03-20 14:39:14 +010052#endif
53
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054#if defined(MBEDTLS_HAVE_TIME)
Jaeden Amero6609aef2019-07-04 20:01:14 +010055#include "mbedtls/platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020056#endif
57
Hanno Becker43633132018-10-22 15:31:03 +010058#if defined(MBEDTLS_USE_PSA_CRYPTO)
59#include "psa/crypto.h"
60#endif /* MBEDTLS_USE_PSA_CRYPTO */
61
Paul Bakker13e2dfe2009-07-28 07:18:38 +000062/*
63 * SSL Error codes
64 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020065#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
66#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
67#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
68#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
69#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
Hanno Beckerb86e5882021-04-30 05:14:25 +010070/* NOTE: Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020071#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
72#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
73#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 +010074/* NOTE: Error space gap */
Hanno Becker3268d842021-04-30 05:41:12 +010075/* NOTE: Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020076#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
77#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
78#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
79#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
Hanno Beckereca840f2021-04-30 05:19:55 +010080/* NOTE: Error space gap */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020081#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
82#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
83#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
84#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
85#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
86#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
87#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
88#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
89#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
90#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
91#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
92#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
93#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020094#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020095#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
96#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020097#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
98#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
99#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
100#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
101#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
102#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
103#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
104#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
105#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
106#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
107#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 +0100108#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 +0100109#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
110#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200111#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 +0100112#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100113#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
Hanno Becker56ee9e52021-04-30 05:36:02 +0100114/* NOTE: Error space gap */
Hanno Becker8ec81022017-10-10 10:35:08 +0100115#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 +0200116#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100117#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Hanno Beckerc37c96a2019-05-14 11:02:36 +0100118#define MBEDTLS_ERR_SSL_UNEXPECTED_CID -0x6000 /**< An encrypted DTLS-frame with an unexpected CID was received. */
Hanno Beckerf9b33032019-06-03 12:58:39 +0100119#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 +0200120#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Hanno Beckerb4c0b752017-04-12 14:54:42 +0100121#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80 /**< Invalid value in SSL config */
Paul Bakker5121ce52009-01-03 21:22:43 +0000122
123/*
124 * Various constants
125 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100126
127/* These are the high an low bytes of ProtocolVersion as defined by:
128 * - RFC 2246: ProtocolVersion version = { 3, 1 }; // TLS v1.0
129 * - RFC 4346: ProtocolVersion version = { 3, 2 }; // TLS v1.1
130 * - RFC 5246: ProtocolVersion version = { 3, 3 }; // TLS v1.2
131 * - RFC 8446: see section 4.2.1
132 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_SSL_MAJOR_VERSION_3 3
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
135#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
136#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Hanno Becker2ab47dc2020-05-04 12:19:12 +0100137#define MBEDTLS_SSL_MINOR_VERSION_4 4 /*!< TLS v1.3 (experimental) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000138
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200139#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
140#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100141
Simon Butcher9f812312015-09-28 19:22:33 +0100142#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Ronald Cron8216dd32020-04-23 16:41:44 +0200143#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
144
145#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 +0100146
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200147/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200148 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200149#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
150#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
151#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
152#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
153#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
154#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156#define MBEDTLS_SSL_IS_CLIENT 0
157#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200159#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
160#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200162#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
163#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200164
Hanno Becker019f4b52019-04-09 15:12:56 +0100165#define MBEDTLS_SSL_CID_DISABLED 0
166#define MBEDTLS_SSL_CID_ENABLED 1
167
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200168#define MBEDTLS_SSL_ETM_DISABLED 0
169#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100170
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200171#define MBEDTLS_SSL_COMPRESS_NULL 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173#define MBEDTLS_SSL_VERIFY_NONE 0
174#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
175#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200176#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
179#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
182#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
185#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
188#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
191#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
192#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
195#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
196#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200197
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200198#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
199#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200200
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100201#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
202#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100203
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200204#define MBEDTLS_SSL_PRESET_DEFAULT 0
205#define MBEDTLS_SSL_PRESET_SUITEB 2
206
Janos Follath088ce432017-04-10 12:42:31 +0100207#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
208#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
209
Ron Eldor591f1622018-01-22 12:30:04 +0200210#define MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED 0
211#define MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED 1
212
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200213/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200214 * Default range for DTLS retransmission timer value, in milliseconds.
215 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
216 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200217#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
218#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200219
Paul Bakker088c5c52014-04-25 11:11:10 +0200220/**
221 * \name SECTION: Module settings
222 *
223 * The configuration options you can set for this module are in this section.
224 * Either change them in config.h or define them on the compiler command line.
225 * \{
226 */
227
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200228/*
Angus Grattond8213d02016-05-25 20:56:48 +1000229 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200230 * determines the size of each of the two internal I/O buffers.
231 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200232 * Note: the RFC defines the default size of SSL / TLS messages. If you
233 * change the value here, other clients / servers may not be able to
234 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200235 * both sides of the connection and have it reduced at both sides, or
236 * if you're using the Max Fragment Length extension and you know all your
237 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200238 */
Angus Grattond8213d02016-05-25 20:56:48 +1000239#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100240#define MBEDTLS_SSL_IN_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000241#endif
242
243#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
David Horstmann95d516f2021-05-04 18:36:56 +0100244#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384
Angus Grattond8213d02016-05-25 20:56:48 +1000245#endif
246
Hanno Becker28007512018-08-28 09:46:44 +0100247/*
248 * Maximum number of heap-allocated bytes for the purpose of
249 * DTLS handshake message reassembly and future message buffering.
250 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100251#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100252#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100253#endif
254
Hanno Becker019f4b52019-04-09 15:12:56 +0100255/*
256 * Maximum length of CIDs for incoming and outgoing messages.
257 */
258#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
Hanno Becker08cbc0c2019-05-15 10:09:15 +0100259#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
Hanno Becker019f4b52019-04-09 15:12:56 +0100260#endif
261
262#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
263#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
264#endif
265
Hanno Beckerb1aa1b32019-05-08 17:37:58 +0100266#if !defined(MBEDTLS_SSL_CID_PADDING_GRANULARITY)
267#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
268#endif
269
Hanno Beckerceef8482020-06-02 06:16:00 +0100270#if !defined(MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY)
271#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1
Hanno Becker13996922020-05-28 16:15:19 +0100272#endif
273
Paul Bakker088c5c52014-04-25 11:11:10 +0200274/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000275
276/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100277 * Length of the verify data for secure renegotiation
278 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200279#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100280
281/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200282 * Signaling ciphersuite values (SCSV)
283 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200284#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000285#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000286
Paul Bakker5121ce52009-01-03 21:22:43 +0000287/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000288 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200289 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291#define MBEDTLS_SSL_HASH_NONE 0
292#define MBEDTLS_SSL_HASH_MD5 1
293#define MBEDTLS_SSL_HASH_SHA1 2
294#define MBEDTLS_SSL_HASH_SHA224 3
295#define MBEDTLS_SSL_HASH_SHA256 4
296#define MBEDTLS_SSL_HASH_SHA384 5
297#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200299#define MBEDTLS_SSL_SIG_ANON 0
300#define MBEDTLS_SSL_SIG_RSA 1
301#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000302
303/*
Paul Bakker926af752012-11-23 13:38:07 +0100304 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200305 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
308#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100309
310/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000311 * Message, alert and handshake types
312 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200313#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
314#define MBEDTLS_SSL_MSG_ALERT 21
315#define MBEDTLS_SSL_MSG_HANDSHAKE 22
316#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100317#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000318
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200319#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
320#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200322#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
323#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
324#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
325#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
326#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
327#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
328#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
329#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
330#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
331#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
332#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
333#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
334#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
335#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
336#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
337#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
338#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
339#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
340#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
341#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
342#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
343#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
344#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
345#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
346#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
347#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
348#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
349#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
350#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000351
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200352#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
353#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
354#define MBEDTLS_SSL_HS_SERVER_HELLO 2
355#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
356#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
357#define MBEDTLS_SSL_HS_CERTIFICATE 11
358#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
359#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
360#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
361#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
362#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
363#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000364
365/*
366 * TLS extensions
367 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368#define MBEDTLS_TLS_EXT_SERVERNAME 0
369#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200371#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
376#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100379
Johan Pascalb62bb512015-12-03 21:56:45 +0100380#define MBEDTLS_TLS_EXT_USE_SRTP 14
381
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
385#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200388
Hanno Becker0652bc52019-04-25 16:24:57 +0100389/* The value of the CID extension is still TBD as of
Hanno Beckerebcc9132019-05-15 10:26:32 +0100390 * draft-ietf-tls-dtls-connection-id-05
391 * (https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) */
Hanno Becker064b7322019-05-03 12:42:13 +0100392#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker0652bc52019-04-25 16:24:57 +0100393
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200394#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000397
Johan Pascalb62bb512015-12-03 21:56:45 +0100398/*
Paul Bakkered27a042013-04-18 22:46:23 +0200399 * Size defines
400 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#if !defined(MBEDTLS_PSK_MAX_LEN)
402#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200403#endif
404
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200405/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200406union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200407{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200409 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
410#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200411#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
412 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200413#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200414#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
415 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
416 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
417 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
418 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200419#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
421 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200422#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200423#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
424 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
425 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200426#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
428 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200429#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200430#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
431 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
432 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200433#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200434#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
435 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
436#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200437};
438
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200439#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200440
Paul Bakker407a0da2013-06-27 14:29:21 +0200441#ifdef __cplusplus
442extern "C" {
443#endif
444
Paul Bakkered27a042013-04-18 22:46:23 +0200445/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000446 * SSL state machine
447 */
448typedef enum
449{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200450 MBEDTLS_SSL_HELLO_REQUEST,
451 MBEDTLS_SSL_CLIENT_HELLO,
452 MBEDTLS_SSL_SERVER_HELLO,
453 MBEDTLS_SSL_SERVER_CERTIFICATE,
454 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
455 MBEDTLS_SSL_CERTIFICATE_REQUEST,
456 MBEDTLS_SSL_SERVER_HELLO_DONE,
457 MBEDTLS_SSL_CLIENT_CERTIFICATE,
458 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
459 MBEDTLS_SSL_CERTIFICATE_VERIFY,
460 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
461 MBEDTLS_SSL_CLIENT_FINISHED,
462 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
463 MBEDTLS_SSL_SERVER_FINISHED,
464 MBEDTLS_SSL_FLUSH_BUFFERS,
465 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
466 MBEDTLS_SSL_HANDSHAKE_OVER,
467 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
468 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000469}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200470mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000471
Ron Eldor51d3ab52019-05-12 14:54:30 +0300472/*
473 * The tls_prf function types.
474 */
475typedef enum
476{
477 MBEDTLS_SSL_TLS_PRF_NONE,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300478 MBEDTLS_SSL_TLS_PRF_TLS1,
479 MBEDTLS_SSL_TLS_PRF_SHA384,
480 MBEDTLS_SSL_TLS_PRF_SHA256
481}
482mbedtls_tls_prf_types;
Hanno Beckera637ff62021-04-15 08:42:48 +0100483
Simon Butchere846b512016-03-01 17:31:49 +0000484/**
485 * \brief Callback type: send data on the network.
486 *
487 * \note That callback may be either blocking or non-blocking.
488 *
489 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000490 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000491 * \param len Length of the data to send
492 *
493 * \return The callback must return the number of bytes sent if any,
494 * or a non-zero error code.
495 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
496 * must be returned when the operation would block.
497 *
Simon Butcherd567a232016-03-09 20:19:21 +0000498 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000499 * It must always return the number of bytes actually sent.
500 */
501typedef int mbedtls_ssl_send_t( void *ctx,
502 const unsigned char *buf,
503 size_t len );
504
505/**
506 * \brief Callback type: receive data from the network.
507 *
508 * \note That callback may be either blocking or non-blocking.
509 *
510 * \param ctx Context for the receive callback (typically a file
511 * descriptor)
512 * \param buf Buffer to write the received data to
513 * \param len Length of the receive buffer
514 *
515 * \return The callback must return the number of bytes received,
516 * or a non-zero error code.
517 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
518 * must be returned when the operation would block.
519 *
Simon Butcherd567a232016-03-09 20:19:21 +0000520 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000521 * buffer. It must always return the number of bytes actually
522 * received and written to the buffer.
523 */
524typedef int mbedtls_ssl_recv_t( void *ctx,
525 unsigned char *buf,
526 size_t len );
527
528/**
529 * \brief Callback type: receive data from the network, with timeout
530 *
531 * \note That callback must block until data is received, or the
532 * timeout delay expires, or the operation is interrupted by a
533 * signal.
534 *
535 * \param ctx Context for the receive callback (typically a file descriptor)
536 * \param buf Buffer to write the received data to
537 * \param len Length of the receive buffer
538 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000539 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000540 *
541 * \return The callback must return the number of bytes received,
542 * or a non-zero error code:
543 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
544 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
545 *
Simon Butcherd567a232016-03-09 20:19:21 +0000546 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000547 * buffer. It must always return the number of bytes actually
548 * received and written to the buffer.
549 */
550typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
551 unsigned char *buf,
552 size_t len,
553 uint32_t timeout );
554/**
555 * \brief Callback type: set a pair of timers/delays to watch
556 *
557 * \param ctx Context pointer
558 * \param int_ms Intermediate delay in milliseconds
559 * \param fin_ms Final delay in milliseconds
560 * 0 cancels the current timer.
561 *
562 * \note This callback must at least store the necessary information
563 * for the associated \c mbedtls_ssl_get_timer_t callback to
564 * return correct information.
565 *
566 * \note If using a event-driven style of programming, an event must
567 * be generated when the final delay is passed. The event must
568 * cause a call to \c mbedtls_ssl_handshake() with the proper
569 * SSL context to be scheduled. Care must be taken to ensure
570 * that at most one such call happens at a time.
571 *
572 * \note Only one timer at a time must be running. Calling this
573 * function while a timer is running must cancel it. Cancelled
574 * timers must not generate any event.
575 */
576typedef void mbedtls_ssl_set_timer_t( void * ctx,
577 uint32_t int_ms,
578 uint32_t fin_ms );
579
580/**
581 * \brief Callback type: get status of timers/delays
582 *
583 * \param ctx Context pointer
584 *
585 * \return This callback must return:
586 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000587 * 0 if none of the delays have passed,
588 * 1 if only the intermediate delay has passed,
589 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000590 */
591typedef int mbedtls_ssl_get_timer_t( void * ctx );
592
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200593/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594typedef struct mbedtls_ssl_session mbedtls_ssl_session;
595typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200596typedef struct mbedtls_ssl_config mbedtls_ssl_config;
597
Chris Jones3848e312021-03-11 16:17:59 +0000598/* Defined in library/ssl_misc.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200599typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
600typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100601typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200602#if defined(MBEDTLS_X509_CRT_PARSE_C)
603typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200604#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200605#if defined(MBEDTLS_SSL_PROTO_DTLS)
606typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200607#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000608
Hanno Becker02487852021-05-13 06:26:57 +0100609/**
610 * \brief Callback type: server-side session cache getter
611 *
612 * The session cache is logically a key value store, with
613 * keys being session IDs and values being instances of
614 * mbedtls_ssl_session.
615 *
616 * This callback retrieves an entry in this key-value store.
617 *
618 * \param data The address of the session cache structure to query.
619 * \param session_id The buffer holding the session ID to query.
620 * \param session_id_len The length of \p session_id in Bytes.
Hanno Becker0d05f402021-05-14 04:54:01 +0100621 * \param session The address of the session structure to populate.
622 * It is initialized with mbdtls_ssl_session_init(),
623 * and the callback must always leave it in a state
Hanno Becker9caed142021-05-14 14:57:13 +0100624 * where it can safely be freed via
Hanno Becker0d05f402021-05-14 04:54:01 +0100625 * mbedtls_ssl_session_free() independent of the
626 * return code of this function.
Hanno Becker02487852021-05-13 06:26:57 +0100627 *
628 * \return \c 0 on success
629 * \return A non-zero return value on failure.
Hanno Becker0d05f402021-05-14 04:54:01 +0100630 *
Hanno Becker02487852021-05-13 06:26:57 +0100631 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100632typedef int mbedtls_ssl_cache_get_t( void *data,
633 unsigned char const *session_id,
634 size_t session_id_len,
635 mbedtls_ssl_session *session );
Hanno Becker02487852021-05-13 06:26:57 +0100636/**
637 * \brief Callback type: server-side session cache setter
638 *
639 * The session cache is logically a key value store, with
640 * keys being session IDs and values being instances of
641 * mbedtls_ssl_session.
642 *
643 * This callback sets an entry in this key-value store.
644 *
645 * \param data The address of the session cache structure to modify.
646 * \param session_id The buffer holding the session ID to query.
647 * \param session_id_len The length of \p session_id in Bytes.
648 * \param session The address of the session to be stored in the
649 * session cache.
650 *
651 * \return \c 0 on success
652 * \return A non-zero return value on failure.
653 */
Hanno Beckerccdaf6e2021-04-15 09:26:17 +0100654typedef int mbedtls_ssl_cache_set_t( void *data,
655 unsigned char const *session_id,
656 size_t session_id_len,
657 const mbedtls_ssl_session *session );
Hanno Beckera637ff62021-04-15 08:42:48 +0100658
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200659#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100660#if defined(MBEDTLS_X509_CRT_PARSE_C)
661/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200662 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100663 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200664 * This callback is called during an SSL handshake to start
665 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200666 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100667 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200668 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100669 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200670 * This function typically sends or enqueues a request, and
671 * does not wait for the operation to complete. This allows
672 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100673 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200674 * The parameters \p ssl and \p cert are guaranteed to remain
675 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200676 * function must save the contents of \p hash if the value
677 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200678 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100679 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200680 * This function may call mbedtls_ssl_set_async_operation_data()
681 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200682 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200683 *
Gilles Peskined3268832018-04-26 06:23:59 +0200684 * \note For RSA signatures, this function must produce output
685 * that is consistent with PKCS#1 v1.5 in the same way as
686 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
687 * apply the padding steps described in RFC 8017, section 9.2
688 * "EMSA-PKCS1-v1_5" as follows.
689 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
690 * encoding, treating \p hash as the DigestInfo to be
691 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
692 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200693 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200694 * encoding, treating \p hash as the hash to be encoded and
695 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
696 * from step 2, with `digestAlgorithm` obtained by calling
697 * mbedtls_oid_get_oid_by_md() on \p md_alg.
698 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200699 * \note For ECDSA signatures, the output format is the DER encoding
700 * `Ecdsa-Sig-Value` defined in
701 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
702 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200703 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200704 * modified other than via
705 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200706 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200707 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200708 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200709 * connection. However, if other callbacks are used, this
710 * property may not hold. For example, if an SNI callback
711 * is registered with mbedtls_ssl_conf_sni(), then
712 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200713 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100714 * \param hash Buffer containing the hash. This buffer is
715 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200716 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100717 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200718 * \return 0 if the operation was started successfully and the SSL
719 * stack should call the resume callback immediately.
720 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
721 * was started successfully and the SSL stack should return
722 * immediately without calling the resume callback yet.
723 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
724 * processor does not support this key. The SSL stack will
725 * use the private key object instead.
726 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200727 * propagated up the call chain. The callback should
728 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
729 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200730 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100731 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200732typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100733 mbedtls_x509_crt *cert,
734 mbedtls_md_type_t md_alg,
735 const unsigned char *hash,
736 size_t hash_len );
737
738/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200739 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100740 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200741 * This callback is called during an SSL handshake to start
742 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200743 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100744 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200745 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100746 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200747 * This function typically sends or enqueues a request, and
748 * does not wait for the operation to complete. This allows
749 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100750 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200751 * The parameters \p ssl and \p cert are guaranteed to remain
752 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200753 * function must save the contents of \p input if the value
754 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200755 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100756 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200757 * This function may call mbedtls_ssl_set_async_operation_data()
758 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200759 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200760 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200761 * \warning RSA decryption as used in TLS is subject to a potential
762 * timing side channel attack first discovered by Bleichenbacher
763 * in 1998. This attack can be remotely exploitable
764 * in practice. To avoid this attack, you must ensure that
765 * if the callback performs an RSA decryption, the time it
766 * takes to execute and return the result does not depend
767 * on whether the RSA decryption succeeded or reported
768 * invalid padding.
769 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200770 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200771 * modified other than via
772 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200773 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200774 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200775 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200776 * connection. However, if other callbacks are used, this
777 * property may not hold. For example, if an SNI callback
778 * is registered with mbedtls_ssl_conf_sni(), then
779 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100780 * \param input Buffer containing the input ciphertext. This buffer
781 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200782 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100783 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200784 * \return 0 if the operation was started successfully and the SSL
785 * stack should call the resume callback immediately.
786 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
787 * was started successfully and the SSL stack should return
788 * immediately without calling the resume callback yet.
789 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
790 * processor does not support this key. The SSL stack will
791 * use the private key object instead.
792 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200793 * propagated up the call chain. The callback should
794 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
795 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200796 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100797 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200798typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100799 mbedtls_x509_crt *cert,
800 const unsigned char *input,
801 size_t input_len );
802#endif /* MBEDTLS_X509_CRT_PARSE_C */
803
804/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200805 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100806 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200807 * This callback is called during an SSL handshake to resume
808 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200809 * ::mbedtls_ssl_async_sign_t or
810 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200811 *
812 * This function typically checks the status of a pending
813 * request or causes the request queue to make progress, and
814 * does not wait for the operation to complete. This allows
815 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100816 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200817 * This function may call mbedtls_ssl_get_async_operation_data()
818 * to retrieve an operation context set by the start callback.
819 * It may call mbedtls_ssl_set_async_operation_data() to modify
820 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200821 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200822 * Note that when this function returns a status other than
823 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
824 * resources associated with the operation.
825 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200826 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200827 * modified other than via
828 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200829 * \param output Buffer containing the output (signature or decrypted
830 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200831 * \param output_len On success, number of bytes written to \p output.
832 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100833 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200834 * \return 0 if output of the operation is available in the
835 * \p output buffer.
836 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
837 * is still in progress. Subsequent requests for progress
838 * on the SSL connection will call the resume callback
839 * again.
840 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200841 * The SSL handshake is aborted. The callback should
842 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
843 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200844 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100845 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200846typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100847 unsigned char *output,
848 size_t *output_len,
849 size_t output_size );
850
851/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200852 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100853 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200854 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200855 * while an asynchronous operation is in progress. Note that
856 * this callback is not called if the
857 * ::mbedtls_ssl_async_resume_t callback has run and has
858 * returned a value other than
859 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
860 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100861 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200862 * This function may call mbedtls_ssl_get_async_operation_data()
863 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200864 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200865 * \param ssl The SSL connection instance. It should not be
866 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100867 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200868typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200869#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000870
Gilles Peskineeccd8882020-03-10 12:19:08 +0100871#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED) && \
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000872 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000873#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
874#if defined(MBEDTLS_SHA256_C)
875#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
876#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
Mateusz Starzyk6326a8d2021-05-10 13:51:53 +0200877#elif defined(MBEDTLS_SHA384_C)
Hanno Becker9198ad12019-02-05 17:00:50 +0000878#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
879#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
880#elif defined(MBEDTLS_SHA1_C)
881#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
882#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
883#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000884/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000885#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
886#endif
Gilles Peskineeccd8882020-03-10 12:19:08 +0100887#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED &&
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000888 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000889
Johan Pascalb62bb512015-12-03 21:56:45 +0100890#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldor3adb9922017-12-21 10:15:08 +0200891
Johan Pascal85269572020-08-25 10:01:54 +0200892#define MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH 255
Johan Pascalaae4d222020-09-22 21:21:39 +0200893#define MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH 4
Johan Pascalb62bb512015-12-03 21:56:45 +0100894/*
Johan Pascal43f94902020-09-22 12:25:52 +0200895 * For code readability use a typedef for DTLS-SRTP profiles
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200896 *
897 * Use_srtp extension protection profiles values as defined in
898 * http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
899 *
900 * Reminder: if this list is expanded mbedtls_ssl_check_srtp_profile_value
901 * must be updated too.
Johan Pascalb62bb512015-12-03 21:56:45 +0100902 */
Johan Pascal76fdf1d2020-10-22 23:31:00 +0200903#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80 ( (uint16_t) 0x0001)
904#define MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32 ( (uint16_t) 0x0002)
905#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80 ( (uint16_t) 0x0005)
906#define MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32 ( (uint16_t) 0x0006)
907/* This one is not iana defined, but for code readability. */
908#define MBEDTLS_TLS_SRTP_UNSET ( (uint16_t) 0x0000)
909
Johan Pascal43f94902020-09-22 12:25:52 +0200910typedef uint16_t mbedtls_ssl_srtp_profile;
Ron Eldor311b95a2018-07-08 08:50:31 +0300911
Ron Eldor3adb9922017-12-21 10:15:08 +0200912typedef struct mbedtls_dtls_srtp_info_t
913{
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200914 /*! The SRTP profile that was negotiated. */
Ron Eldora9788042018-12-05 11:04:31 +0200915 mbedtls_ssl_srtp_profile chosen_dtls_srtp_profile;
Johan Pascalf6417ec2020-09-22 15:15:19 +0200916 /*! The length of mki_value. */
917 uint16_t mki_len;
Johan Pascal9bc97ca2020-09-21 23:44:45 +0200918 /*! The mki_value used, with max size of 256 bytes. */
Johan Pascal85269572020-08-25 10:01:54 +0200919 unsigned char mki_value[MBEDTLS_TLS_SRTP_MAX_MKI_LENGTH];
Ron Eldor349877e2018-03-29 18:35:09 +0300920}
921mbedtls_dtls_srtp_info;
Ron Eldor3adb9922017-12-21 10:15:08 +0200922
Johan Pascalb62bb512015-12-03 21:56:45 +0100923#endif /* MBEDTLS_SSL_DTLS_SRTP */
924
Paul Bakker5121ce52009-01-03 21:22:43 +0000925/*
Paul Bakker0a597072012-09-25 21:55:46 +0000926 * This structure is used for storing current session data.
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200927 *
928 * Note: when changing this definition, we need to check and update:
929 * - in tests/suites/test_suite_ssl.function:
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +0200930 * ssl_populate_session() and ssl_serialize_session_save_load()
Manuel Pégourié-Gonnard7b3a8872019-05-24 09:48:05 +0200931 * - in library/ssl_tls.c:
932 * mbedtls_ssl_session_init() and mbedtls_ssl_session_free()
933 * mbedtls_ssl_session_save() and ssl_session_load()
934 * ssl_session_copy()
Paul Bakker5121ce52009-01-03 21:22:43 +0000935 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200936struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000937{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200938#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100939 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200940#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000941 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000942 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200943 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000944 unsigned char id[32]; /*!< session identifier */
945 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200946
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200947#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000948#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000949 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000950#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000951 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
952 * changes during renegotiation, mitigating the triple handshake attack. */
953 unsigned char *peer_cert_digest;
954 size_t peer_cert_digest_len;
955 mbedtls_md_type_t peer_cert_digest_type;
Hanno Beckerabe6f662019-02-07 13:29:55 +0000956#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200957#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200958 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200959
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200960#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200961 unsigned char *ticket; /*!< RFC 5077 session ticket */
962 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200963 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200964#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200965
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200966#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200967 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200968#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200969
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200970#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200971 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200972#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200974#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100975 int encrypt_then_mac; /*!< flag for EtM activation */
976#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000977};
978
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200979/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200980 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200981 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200982struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200983{
984 /* Group items by size (largest first) to minimize padding overhead */
985
986 /*
987 * Pointers
988 */
989
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +0100990 /** Allowed ciphersuites per version. To access list's elements, please use
991 * \c mbedtls_ssl_get_protocol_version_ciphersuites
992 */
993 const int *ciphersuite_list[3];
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200994
995 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200996 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200997 void *p_dbg; /*!< context for the debug function */
998
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100999 /** Callback for getting (pseudo-)random numbers */
1000 int (*f_rng)(void *, unsigned char *, size_t);
1001 void *p_rng; /*!< context for the RNG function */
1002
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001003 /** Callback to retrieve a session from the cache */
Hanno Beckera637ff62021-04-15 08:42:48 +01001004 mbedtls_ssl_cache_get_t *f_get_cache;
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001005 /** Callback to store a session into the cache */
Hanno Beckera637ff62021-04-15 08:42:48 +01001006 mbedtls_ssl_cache_set_t *f_set_cache;
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001007 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001008
1009#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1010 /** Callback for setting cert according to SNI extension */
1011 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1012 void *p_sni; /*!< context for SNI callback */
1013#endif
1014
1015#if defined(MBEDTLS_X509_CRT_PARSE_C)
1016 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001017 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001018 void *p_vrfy; /*!< context for X.509 verify calllback */
1019#endif
1020
Gilles Peskineeccd8882020-03-10 12:19:08 +01001021#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001022 /** Callback to retrieve PSK key from identity */
1023 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
1024 void *p_psk; /*!< context for PSK callback */
1025#endif
1026
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001027#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001028 /** Callback to create & write a cookie for ClientHello veirifcation */
1029 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
1030 const unsigned char *, size_t );
1031 /** Callback to verify validity of a ClientHello cookie */
1032 int (*f_cookie_check)( void *, const unsigned char *, size_t,
1033 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001034 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001035#endif
1036
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001037#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001038 /** Callback to create & write a session ticket */
1039 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
1040 unsigned char *, const unsigned char *, size_t *, uint32_t * );
1041 /** Callback to parse a session ticket into a session structure */
1042 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
1043 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001044#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001045
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001046#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001047 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001048 int (*f_export_keys)( void *, const unsigned char *,
1049 const unsigned char *, size_t, size_t, size_t );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001050 /** Callback to export key block, master secret,
1051 * tls_prf and random bytes. Should replace f_export_keys */
1052 int (*f_export_keys_ext)( void *, const unsigned char *,
1053 const unsigned char *, size_t, size_t, size_t,
Jaeden Amero63d813d2019-09-12 10:09:57 +01001054 const unsigned char[32], const unsigned char[32],
1055 mbedtls_tls_prf_types );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001056 void *p_export_keys; /*!< context for key export callback */
1057#endif
1058
Hanno Beckera0e20d02019-05-15 14:03:01 +01001059#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerad4a1372019-05-03 13:06:44 +01001060 size_t cid_len; /*!< The length of CIDs for incoming DTLS records. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001061#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01001062
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001063#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001064 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001065 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
1066 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
1067 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +00001068#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
1069 mbedtls_x509_crt_ca_cb_t f_ca_cb;
1070 void *p_ca_cb;
1071#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001072#endif /* MBEDTLS_X509_CRT_PARSE_C */
1073
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001074#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001075#if defined(MBEDTLS_X509_CRT_PARSE_C)
1076 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
1077 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
1078#endif /* MBEDTLS_X509_CRT_PARSE_C */
1079 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
1080 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +02001081 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001082#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001083
Gilles Peskineeccd8882020-03-10 12:19:08 +01001084#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001085 const int *sig_hashes; /*!< allowed signature hashes */
1086#endif
1087
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001088#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001089 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001090#endif
1091
1092#if defined(MBEDTLS_DHM_C)
1093 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
1094 mbedtls_mpi dhm_G; /*!< generator for DHM */
1095#endif
1096
Gilles Peskineeccd8882020-03-10 12:19:08 +01001097#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001098
1099#if defined(MBEDTLS_USE_PSA_CRYPTO)
Ronald Croncf56a0a2020-08-04 09:51:30 +02001100 psa_key_id_t psk_opaque; /*!< PSA key slot holding opaque PSK. This field
1101 * should only be set via
1102 * mbedtls_ssl_conf_psk_opaque().
1103 * If either no PSK or a raw PSK have been
1104 * configured, this has value \c 0.
1105 */
Hanno Becker43633132018-10-22 15:31:03 +01001106#endif /* MBEDTLS_USE_PSA_CRYPTO */
1107
1108 unsigned char *psk; /*!< The raw pre-shared key. This field should
1109 * only be set via mbedtls_ssl_conf_psk().
1110 * If either no PSK or an opaque PSK
1111 * have been configured, this has value NULL. */
1112 size_t psk_len; /*!< The length of the raw pre-shared key.
1113 * This field should only be set via
1114 * mbedtls_ssl_conf_psk().
1115 * Its value is non-zero if and only if
1116 * \c psk is not \c NULL. */
1117
1118 unsigned char *psk_identity; /*!< The PSK identity for PSK negotiation.
1119 * This field should only be set via
1120 * mbedtls_ssl_conf_psk().
1121 * This is set if and only if either
1122 * \c psk or \c psk_opaque are set. */
1123 size_t psk_identity_len;/*!< The length of PSK identity.
1124 * This field should only be set via
1125 * mbedtls_ssl_conf_psk().
1126 * Its value is non-zero if and only if
1127 * \c psk is not \c NULL or \c psk_opaque
1128 * is not \c 0. */
Gilles Peskineeccd8882020-03-10 12:19:08 +01001129#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001130
1131#if defined(MBEDTLS_SSL_ALPN)
1132 const char **alpn_list; /*!< ordered list of protocols */
1133#endif
1134
Johan Pascalbbc057a2016-02-04 22:07:32 +01001135#if defined(MBEDTLS_SSL_DTLS_SRTP)
Ron Eldora9788042018-12-05 11:04:31 +02001136 /*! ordered list of supported srtp profile */
Johan Pascal9bc97ca2020-09-21 23:44:45 +02001137 const mbedtls_ssl_srtp_profile *dtls_srtp_profile_list;
Ron Eldora9788042018-12-05 11:04:31 +02001138 /*! number of supported profiles */
1139 size_t dtls_srtp_profile_list_len;
Johan Pascalbbc057a2016-02-04 22:07:32 +01001140#endif /* MBEDTLS_SSL_DTLS_SRTP */
1141
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001142 /*
1143 * Numerical settings (int then char)
1144 */
1145
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001146 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
1147
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001148#if defined(MBEDTLS_SSL_PROTO_DTLS)
1149 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001150 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001151 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001152 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001153#endif
1154
1155#if defined(MBEDTLS_SSL_RENEGOTIATION)
1156 int renego_max_records; /*!< grace period for renegotiation */
1157 unsigned char renego_period[8]; /*!< value of the record counters
1158 that triggers renegotiation */
1159#endif
1160
1161#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1162 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1163#endif
1164
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001165#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1166 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1167#endif
1168
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001169 unsigned char max_major_ver; /*!< max. major version used */
1170 unsigned char max_minor_ver; /*!< max. minor version used */
1171 unsigned char min_major_ver; /*!< min. major version used */
1172 unsigned char min_minor_ver; /*!< min. minor version used */
1173
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001174 /*
1175 * Flags (bitfields)
1176 */
1177
1178 unsigned int endpoint : 1; /*!< 0: client, 1: server */
1179 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001180 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
1181 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1182 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001183#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1184 unsigned int mfl_code : 3; /*!< desired fragment length */
1185#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001186#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1187 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1188#endif
1189#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1190 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
1191#endif
1192#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1193 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
1194#endif
1195#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1196 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1197#endif
1198#if defined(MBEDTLS_SSL_RENEGOTIATION)
1199 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1200#endif
1201#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1202 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1203#endif
1204#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1205 unsigned int session_tickets : 1; /*!< use session tickets? */
1206#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001207#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1208 unsigned int fallback : 1; /*!< is this a fallback? */
1209#endif
Janos Follath088ce432017-04-10 12:42:31 +01001210#if defined(MBEDTLS_SSL_SRV_C)
1211 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1212 Certificate Request messages? */
1213#endif
Hanno Beckera0e20d02019-05-15 14:03:01 +01001214#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker8367ccc2019-05-14 11:30:10 +01001215 unsigned int ignore_unexpected_cid : 1; /*!< Determines whether DTLS
1216 * record with unexpected CID
1217 * should lead to failure. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001218#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Ron Eldor3adb9922017-12-21 10:15:08 +02001219#if defined(MBEDTLS_SSL_DTLS_SRTP)
1220 unsigned int dtls_srtp_mki_support : 1; /* support having mki_value
Ron Eldor591f1622018-01-22 12:30:04 +02001221 in the use_srtp extension */
Ron Eldor3adb9922017-12-21 10:15:08 +02001222#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001223};
1224
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001225struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001226{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001227 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001228
Paul Bakker5121ce52009-01-03 21:22:43 +00001229 /*
1230 * Miscellaneous
1231 */
1232 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001233#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001234 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001235 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1236 number of retransmissions of request if
1237 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001238#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001239
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001240 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01001241 int minor_ver; /*!< one of MBEDTLS_SSL_MINOR_VERSION_x macros */
Paul Bakker5121ce52009-01-03 21:22:43 +00001242
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001243#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001244 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001245#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001246
Hanno Becker8927c832019-04-03 12:52:50 +01001247#if defined(MBEDTLS_X509_CRT_PARSE_C)
1248 /** Callback to customize X.509 certificate chain verification */
1249 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Janos Follath924270f2019-04-04 12:49:44 +01001250 void *p_vrfy; /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001251#endif
1252
Simon Butchere846b512016-03-01 17:31:49 +00001253 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1254 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1255 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1256 /*!< Callback for network receive with timeout */
1257
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001258 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001259
Paul Bakker5121ce52009-01-03 21:22:43 +00001260 /*
1261 * Session layer
1262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1264 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1265 mbedtls_ssl_session *session; /*!< negotiated session data */
1266 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001267
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001268 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001269 the handshake process */
1270
1271 /*
1272 * Record layer transformations
1273 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001274 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1275 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1276 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1277 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001278
Paul Bakker5121ce52009-01-03 21:22:43 +00001279 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001280 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001281 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001282 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001283
1284 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1285 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001286
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001287 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001288 * Record layer (incoming data)
1289 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001290 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001291 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1292 TLS: maintained by us
1293 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001294 unsigned char *in_hdr; /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001295#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001296 unsigned char *in_cid; /*!< The start of the CID;
1297 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001298#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001299 unsigned char *in_len; /*!< two-bytes message length field */
1300 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001301 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001302 unsigned char *in_offt; /*!< read offset in application data */
1303
1304 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001305 size_t in_msglen; /*!< record header: message length */
1306 size_t in_left; /*!< amount of data read so far */
Darryl Greenb33cc762019-11-28 14:29:44 +00001307#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1308 size_t in_buf_len; /*!< length of input buffer */
1309#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001311 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001312 size_t next_record_offset; /*!< offset of the next record in datagram
1313 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001314#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001315#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001316 uint64_t in_window_top; /*!< last validated record seq_num */
1317 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001318#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001319
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001320 size_t in_hslen; /*!< current handshake message length,
1321 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001322 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001323
1324 int keep_current_message; /*!< drop or reuse current message
1325 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
Hanno Becker04da1892018-08-14 13:22:10 +01001327#if defined(MBEDTLS_SSL_PROTO_DTLS)
1328 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1329 * within a single datagram. */
1330#endif /* MBEDTLS_SSL_PROTO_DTLS */
1331
Paul Bakker5121ce52009-01-03 21:22:43 +00001332 /*
1333 * Record layer (outgoing data)
1334 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001335 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001336 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001337 unsigned char *out_hdr; /*!< start of record header */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001338#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001339 unsigned char *out_cid; /*!< The start of the CID;
1340 * (the end is marked by in_len). */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001341#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001342 unsigned char *out_len; /*!< two-bytes message length field */
1343 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001344 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001345
1346 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001347 size_t out_msglen; /*!< record header: message length */
1348 size_t out_left; /*!< amount of data not yet written */
Darryl Greenb33cc762019-11-28 14:29:44 +00001349#if defined(MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH)
1350 size_t out_buf_len; /*!< length of output buffer */
1351#endif
Paul Bakker5121ce52009-01-03 21:22:43 +00001352
Hanno Becker19859472018-08-06 09:40:20 +01001353 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1354
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001355#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001356 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001357#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001360 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001361#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001362
Paul Bakker5121ce52009-01-03 21:22:43 +00001363 /*
1364 * PKI layer
1365 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001366 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001367
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001368 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001369 * User settings
1370 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001371#if defined(MBEDTLS_X509_CRT_PARSE_C)
1372 char *hostname; /*!< expected peer CN for verification
1373 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001374#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001375
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001376#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001377 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001378#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001379
Johan Pascalb62bb512015-12-03 21:56:45 +01001380#if defined(MBEDTLS_SSL_DTLS_SRTP)
1381 /*
1382 * use_srtp extension
1383 */
Ron Eldor3adb9922017-12-21 10:15:08 +02001384 mbedtls_dtls_srtp_info dtls_srtp_info;
Johan Pascalb62bb512015-12-03 21:56:45 +01001385#endif /* MBEDTLS_SSL_DTLS_SRTP */
1386
Paul Bakker48916f92012-09-16 19:57:18 +00001387 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001388 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001389 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001390#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001391 unsigned char *cli_id; /*!< transport-level ID of the client */
1392 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001393#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001394
1395 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001396 * Secure renegotiation
1397 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001398 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001399 int secure_renegotiation; /*!< does peer support legacy or
1400 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001402 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1404 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001405#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001406
Hanno Beckera0e20d02019-05-15 14:03:01 +01001407#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker2f28c102019-04-25 15:46:59 +01001408 /* CID configuration to use in subsequent handshakes. */
1409
1410 /*! The next incoming CID, chosen by the user and applying to
1411 * all subsequent handshakes. This may be different from the
1412 * CID currently used in case the user has re-configured the CID
1413 * after an initial handshake. */
1414 unsigned char own_cid[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1415 uint8_t own_cid_len; /*!< The length of \c own_cid. */
1416 uint8_t negotiate_cid; /*!< This indicates whether the CID extension should
1417 * be negotiated in the next handshake or not.
1418 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1419 * and #MBEDTLS_SSL_CID_DISABLED. */
Hanno Beckera0e20d02019-05-15 14:03:01 +01001420#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001421};
1422
Paul Bakker5121ce52009-01-03 21:22:43 +00001423/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001424 * \brief Return the name of the ciphersuite associated with the
1425 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001426 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001427 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001428 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001429 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001430 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001432
1433/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001434 * \brief Return the ID of the ciphersuite associated with the
1435 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001436 *
1437 * \param ciphersuite_name SSL ciphersuite name
1438 *
1439 * \return the ID with the ciphersuite or 0 if not found
1440 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001441int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001442
1443/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001444 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001445 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001446 * mbedtls_ssl_free()
1447 *
1448 * \param ssl SSL context
1449 */
1450void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1451
1452/**
1453 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001454 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001455 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001456 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001457 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001458 * \warning The conf structure will be accessed during the session.
1459 * It must not be modified or freed as long as the session
1460 * is active.
1461 *
1462 * \warning This function must be called exactly once per context.
1463 * Calling mbedtls_ssl_setup again is not supported, even
1464 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001465 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001466 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001467 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001468 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001469 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001470 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001471 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001472int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001473 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001474
1475/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001476 * \brief Reset an already initialized SSL context for re-use
1477 * while retaining application-set variables, function
1478 * pointers and data.
1479 *
1480 * \param ssl SSL context
Mateusz Starzyka3a99842021-02-19 14:27:22 +01001481 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED or
1482 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001483 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001484int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001485
1486/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001487 * \brief Set the current endpoint type
1488 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001489 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001490 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001491 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001492void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001493
1494/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001495 * \brief Set the transport type (TLS or DTLS).
1496 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001497 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001498 * \note For DTLS, you must either provide a recv callback that
1499 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001500 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1501 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001502 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001503 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001504 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001505 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1506 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001507 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001508void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001509
1510/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001511 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001512 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001513 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001514 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001515 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001516 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001517 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001518 * (default on server)
1519 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001520 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001521 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001522 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001523 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001524 * handshake is complete.
1525 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001526 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001527 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001528 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001529 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1531 * 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 +01001532 * the right time(s), which may not be obvious, while REQUIRED always perform
1533 * the verification as soon as possible. For example, REQUIRED was protecting
1534 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001535 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001536void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001537
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001538#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001539/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001540 * \brief Set the verification callback (Optional).
1541 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001542 * If set, the provided verify callback is called for each
1543 * certificate in the peer's CRT chain, including the trusted
1544 * root. For more information, please see the documentation of
1545 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001546 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001547 * \note For per context callbacks and contexts, please use
1548 * mbedtls_ssl_set_verify() instead.
1549 *
1550 * \param conf The SSL configuration to use.
1551 * \param f_vrfy The verification callback to use during CRT verification.
1552 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001553 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001554void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001555 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001556 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001557#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001558
1559/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001560 * \brief Set the random number generator callback
1561 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001562 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001563 * \param f_rng RNG function
1564 * \param p_rng RNG parameter
1565 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001566void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001567 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001568 void *p_rng );
1569
1570/**
1571 * \brief Set the debug callback
1572 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001573 * The callback has the following argument:
1574 * void * opaque context for the callback
1575 * int debug level
1576 * const char * file name
1577 * int line number
1578 * const char * message
1579 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001580 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001581 * \param f_dbg debug function
1582 * \param p_dbg debug parameter
1583 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001584void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001585 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001586 void *p_dbg );
1587
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001588/**
1589 * \brief Set the underlying BIO callbacks for write, read and
1590 * read-with-timeout.
1591 *
1592 * \param ssl SSL context
1593 * \param p_bio parameter (context) shared by BIO callbacks
1594 * \param f_send write callback
1595 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001596 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001597 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001598 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1599 * the other is used. If both are non-NULL, f_recv_timeout is
1600 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001601 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001602 * \note The two most common use cases are:
1603 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1604 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1605 *
1606 * \note For DTLS, you need to provide either a non-NULL
1607 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001608 *
Christopher Moynihan74e25342020-08-14 12:27:21 -07001609 * \note See the documentations of \c mbedtls_ssl_send_t,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001610 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001611 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001612 *
Andres AG3616f6f2016-09-14 14:32:09 +01001613 * \note On some platforms, net_sockets.c provides
1614 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1615 * \c mbedtls_net_recv_timeout() that are suitable to be used
1616 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001617 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001618void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001619 void *p_bio,
1620 mbedtls_ssl_send_t *f_send,
1621 mbedtls_ssl_recv_t *f_recv,
1622 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001623
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001624#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001625
Hanno Beckera0e20d02019-05-15 14:03:01 +01001626#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker019f4b52019-04-09 15:12:56 +01001627
1628
1629/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001630 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001631 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001632 *
Hanno Beckerebcc9132019-05-15 10:26:32 +01001633 * Reference: draft-ietf-tls-dtls-connection-id-05
1634 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05
Hanno Becker019f4b52019-04-09 15:12:56 +01001635 *
Hanno Beckerd9d4adb2019-05-15 10:08:35 +01001636 * The DTLS CID extension allows the reliable association of
Hanno Becker019f4b52019-04-09 15:12:56 +01001637 * DTLS records to DTLS connections across changes in the
Hanno Becker08cd9db2019-05-15 10:10:36 +01001638 * underlying transport (changed IP and Port metadata) by
1639 * adding explicit connection identifiers (CIDs) to the
1640 * headers of encrypted DTLS records. The desired CIDs are
1641 * configured by the application layer and are exchanged in
1642 * new `ClientHello` / `ServerHello` extensions during the
Hanno Becker019f4b52019-04-09 15:12:56 +01001643 * handshake, where each side indicates the CID it wants the
1644 * peer to use when writing encrypted messages. The CIDs are
1645 * put to use once records get encrypted: the stack discards
1646 * any incoming records that don't include the configured CID
1647 * in their header, and adds the peer's requested CID to the
1648 * headers of outgoing messages.
1649 *
Hanno Becker5cc145d2019-05-15 10:12:11 +01001650 * This API enables or disables the use of the CID extension
1651 * in the next handshake and sets the value of the CID to
1652 * be used for incoming messages.
Hanno Becker019f4b52019-04-09 15:12:56 +01001653 *
1654 * \param ssl The SSL context to configure. This must be initialized.
1655 * \param enable This value determines whether the CID extension should
1656 * be used or not. Possible values are:
1657 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001658 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1659 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001660 * \param own_cid The address of the readable buffer holding the CID we want
1661 * the peer to use when sending encrypted messages to us.
1662 * This may be \c NULL if \p own_cid_len is \c 0.
1663 * This parameter is unused if \p enabled is set to
1664 * MBEDTLS_SSL_CID_DISABLED.
1665 * \param own_cid_len The length of \p own_cid.
1666 * This parameter is unused if \p enabled is set to
1667 * MBEDTLS_SSL_CID_DISABLED.
1668 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001669 * \note The value of \p own_cid_len must match the value of the
Hanno Becker8367ccc2019-05-14 11:30:10 +01001670 * \c len parameter passed to mbedtls_ssl_conf_cid()
Hanno Beckerad4a1372019-05-03 13:06:44 +01001671 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001672 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001673 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001674 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001675 * performed on the SSL context \p ssl, but does not trigger
1676 * one. You still have to call `mbedtls_ssl_handshake()`
1677 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1678 * (for a renegotiation handshake) explicitly after a
1679 * successful call to this function to run the handshake.
1680 *
1681 * \note This call cannot guarantee that the use of the CID
1682 * will be successfully negotiated in the next handshake,
1683 * because the peer might not support it. Specifically:
1684 * - On the Client, enabling the use of the CID through
1685 * this call implies that the `ClientHello` in the next
1686 * handshake will include the CID extension, thereby
1687 * offering the use of the CID to the server. Only if
1688 * the `ServerHello` contains the CID extension, too,
1689 * the CID extension will actually be put to use.
1690 * - On the Server, enabling the use of the CID through
1691 * this call implies that that the server will look for
1692 * the CID extension in a `ClientHello` from the client,
1693 * and, if present, reply with a CID extension in its
1694 * `ServerHello`.
1695 *
1696 * \note To check whether the use of the CID was negotiated
1697 * after the subsequent handshake has completed, please
1698 * use the API mbedtls_ssl_get_peer_cid().
1699 *
1700 * \warning If the use of the CID extension is enabled in this call
1701 * and the subsequent handshake negotiates its use, Mbed TLS
1702 * will silently drop every packet whose CID does not match
1703 * the CID configured in \p own_cid. It is the responsibility
1704 * of the user to adapt the underlying transport to take care
1705 * of CID-based demultiplexing before handing datagrams to
1706 * Mbed TLS.
1707 *
1708 * \return \c 0 on success. In this case, the CID configuration
1709 * applies to the next handshake.
1710 * \return A negative error code on failure.
1711 */
1712int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1713 int enable,
1714 unsigned char const *own_cid,
1715 size_t own_cid_len );
1716
1717/**
Hanno Beckerfb034e82019-05-15 10:14:16 +01001718 * \brief Get information about the use of the CID extension
1719 * in the current connection.
Hanno Becker019f4b52019-04-09 15:12:56 +01001720 *
1721 * \param ssl The SSL context to query.
1722 * \param enabled The address at which to store whether the CID extension
1723 * is currently in use or not. If the CID is in use,
1724 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1725 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1726 * \param peer_cid The address of the buffer in which to store the CID
1727 * chosen by the peer (if the CID extension is used).
Hanno Becker615ef172019-05-22 16:50:35 +01001728 * This may be \c NULL in case the value of peer CID
1729 * isn't needed. If it is not \c NULL, \p peer_cid_len
1730 * must not be \c NULL.
Hanno Becker019f4b52019-04-09 15:12:56 +01001731 * \param peer_cid_len The address at which to store the size of the CID
1732 * chosen by the peer (if the CID extension is used).
1733 * This is also the number of Bytes in \p peer_cid that
1734 * have been written.
Hanno Becker615ef172019-05-22 16:50:35 +01001735 * This may be \c NULL in case the length of the peer CID
1736 * isn't needed. If it is \c NULL, \p peer_cid must be
1737 * \c NULL, too.
Hanno Becker019f4b52019-04-09 15:12:56 +01001738 *
1739 * \note This applies to the state of the CID negotiated in
1740 * the last complete handshake. If a handshake is in
1741 * progress, this function will attempt to complete
1742 * the handshake first.
1743 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001744 * \note If CID extensions have been exchanged but both client
1745 * and server chose to use an empty CID, this function
1746 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1747 * (the rationale for this is that the resulting
1748 * communication is the same as if the CID extensions
1749 * hadn't been used).
1750 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001751 * \return \c 0 on success.
1752 * \return A negative error code on failure.
1753 */
1754int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1755 int *enabled,
1756 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1757 size_t *peer_cid_len );
1758
Hanno Beckera0e20d02019-05-15 14:03:01 +01001759#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Becker019f4b52019-04-09 15:12:56 +01001760
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001761/**
1762 * \brief Set the Maximum Tranport Unit (MTU).
1763 * Special value: 0 means unset (no limit).
1764 * This represents the maximum size of a datagram payload
1765 * handled by the transport layer (usually UDP) as determined
1766 * by the network link and stack. In practice, this controls
1767 * the maximum size datagram the DTLS layer will pass to the
1768 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1769 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001770 * \note The limit on datagram size is converted to a limit on
1771 * record payload by subtracting the current overhead of
1772 * encapsulation and encryption/authentication if any.
1773 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001774 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001775 * example when a Path Maximum Transfer Unit (PMTU)
1776 * estimate becomes available from other sources,
1777 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001778 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001779 * \note This setting only controls the size of the packets we send,
1780 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001781 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001782 * server to use smaller records with \c
1783 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001784 *
1785 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001786 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001787 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001788 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001789 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001790 * of datagrams (hence records, see first note) sent. It
1791 * cannot be used to increase the maximum size of records over
1792 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001793 *
1794 * \note Values lower than the current record layer expansion will
1795 * result in an error when trying to send data.
1796 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001797 * \param ssl SSL context
1798 * \param mtu Value of the path MTU in bytes
1799 */
1800void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1801#endif /* MBEDTLS_SSL_PROTO_DTLS */
1802
Hanno Becker726c97a2019-04-03 12:52:35 +01001803#if defined(MBEDTLS_X509_CRT_PARSE_C)
1804/**
1805 * \brief Set a connection-specific verification callback (optional).
1806 *
1807 * If set, the provided verify callback is called for each
1808 * certificate in the peer's CRT chain, including the trusted
1809 * root. For more information, please see the documentation of
1810 * \c mbedtls_x509_crt_verify().
1811 *
1812 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1813 * binds the verification callback and context to an SSL context
1814 * as opposed to an SSL configuration.
1815 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1816 * are both used, mbedtls_ssl_set_verify() takes precedence.
1817 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001818 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001819 * \param f_vrfy The verification callback to use during CRT verification.
1820 * \param p_vrfy The opaque context to be passed to the callback.
1821 */
1822void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1823 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1824 void *p_vrfy );
1825#endif /* MBEDTLS_X509_CRT_PARSE_C */
1826
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001827/**
1828 * \brief Set the timeout period for mbedtls_ssl_read()
1829 * (Default: no timeout.)
1830 *
1831 * \param conf SSL configuration context
1832 * \param timeout Timeout value in milliseconds.
1833 * Use 0 for no timeout (default).
1834 *
1835 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001836 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001837 * With non-blocking I/O, this will only work if timer
1838 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1839 *
1840 * \note With non-blocking I/O, you may also skip this function
1841 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001842 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001843void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001844
Hanno Beckercfe45792019-07-03 16:13:00 +01001845/**
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001846 * \brief Check whether a buffer contains a valid and authentic record
1847 * that has not been seen before. (DTLS only).
Hanno Beckercfe45792019-07-03 16:13:00 +01001848 *
1849 * This function does not change the user-visible state
Hanno Beckerb7d1dff2019-07-18 08:21:17 +01001850 * of the SSL context. Its sole purpose is to provide
Hanno Beckercfe45792019-07-03 16:13:00 +01001851 * an indication of the legitimacy of an incoming record.
1852 *
1853 * This can be useful e.g. in distributed server environments
1854 * using the DTLS Connection ID feature, in which connections
1855 * might need to be passed between service instances on a change
1856 * of peer address, but where such disruptive operations should
1857 * only happen after the validity of incoming records has been
1858 * confirmed.
1859 *
1860 * \param ssl The SSL context to use.
1861 * \param buf The address of the buffer holding the record to be checked.
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001862 * This must be a read/write buffer of length \p buflen Bytes.
Hanno Beckercfe45792019-07-03 16:13:00 +01001863 * \param buflen The length of \p buf in Bytes.
1864 *
1865 * \note This routine only checks whether the provided buffer begins
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001866 * with a valid and authentic record that has not been seen
1867 * before, but does not check potential data following the
1868 * initial record. In particular, it is possible to pass DTLS
1869 * datagrams containing multiple records, in which case only
1870 * the first record is checked.
Hanno Beckercfe45792019-07-03 16:13:00 +01001871 *
1872 * \note This function modifies the input buffer \p buf. If you need
1873 * to preserve the original record, you have to maintain a copy.
1874 *
Jarno Lamsa31c3b142019-08-14 10:39:32 +03001875 * \return \c 0 if the record is valid and authentic and has not been
1876 * seen before.
Hanno Beckercfe45792019-07-03 16:13:00 +01001877 * \return MBEDTLS_ERR_SSL_INVALID_MAC if the check completed
1878 * successfully but the record was found to be not authentic.
1879 * \return MBEDTLS_ERR_SSL_INVALID_RECORD if the check completed
1880 * successfully but the record was found to be invalid for
1881 * a reason different from authenticity checking.
1882 * \return MBEDTLS_ERR_SSL_UNEXPECTED_RECORD if the check completed
1883 * successfully but the record was found to be unexpected
1884 * in the state of the SSL context, including replayed records.
1885 * \return Another negative error code on different kinds of failure.
1886 * In this case, the SSL context becomes unusable and needs
1887 * to be freed or reset before reuse.
1888 */
1889int mbedtls_ssl_check_record( mbedtls_ssl_context const *ssl,
1890 unsigned char *buf,
1891 size_t buflen );
Hanno Beckercfe45792019-07-03 16:13:00 +01001892
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001893/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001894 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001895 *
1896 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001897 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001898 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001899 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001900 *
1901 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1902 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001903 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001904 *
1905 * \note On some platforms, timing.c provides
1906 * \c mbedtls_timing_set_delay() and
1907 * \c mbedtls_timing_get_delay() that are suitable for using
1908 * here, except if using an event-driven style.
1909 *
1910 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001911 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001912 */
1913void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1914 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001915 mbedtls_ssl_set_timer_t *f_set_timer,
1916 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001917
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001918/**
1919 * \brief Callback type: generate and write session ticket
1920 *
1921 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001922 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001923 * authenticated ticket for the session and write it to the
1924 * output buffer. Here, ticket means the opaque ticket part
1925 * of the NewSessionTicket structure of RFC 5077.
1926 *
1927 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001928 * \param session SSL session to be written in the ticket
1929 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001930 * \param end End of the output buffer
1931 * \param tlen On exit, holds the length written
1932 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1933 *
1934 * \return 0 if successful, or
1935 * a specific MBEDTLS_ERR_XXX code.
1936 */
1937typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1938 const mbedtls_ssl_session *session,
1939 unsigned char *start,
1940 const unsigned char *end,
1941 size_t *tlen,
1942 uint32_t *lifetime );
1943
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001944#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1945/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001946 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001947 *
1948 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001949 * (RFC 5216) and Thread. The key pointers are ephemeral and
1950 * therefore must not be stored. The master secret and keys
1951 * should not be used directly except as an input to a key
1952 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001953 *
1954 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001955 * \param ms Pointer to master secret (fixed length: 48 bytes)
1956 * \param kb Pointer to key block, see RFC 5246 section 6.3
1957 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001958 * \param maclen MAC length
1959 * \param keylen Key length
1960 * \param ivlen IV length
1961 *
1962 * \return 0 if successful, or
1963 * a specific MBEDTLS_ERR_XXX code.
1964 */
1965typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001966 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001967 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001968 size_t maclen,
1969 size_t keylen,
1970 size_t ivlen );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001971
1972/**
1973 * \brief Callback type: Export key block, master secret,
1974 * handshake randbytes and the tls_prf function
1975 * used to derive keys.
1976 *
1977 * \note This is required for certain uses of TLS, e.g. EAP-TLS
1978 * (RFC 5216) and Thread. The key pointers are ephemeral and
1979 * therefore must not be stored. The master secret and keys
1980 * should not be used directly except as an input to a key
1981 * derivation function.
1982 *
1983 * \param p_expkey Context for the callback.
1984 * \param ms Pointer to master secret (fixed length: 48 bytes).
1985 * \param kb Pointer to key block, see RFC 5246 section 6.3.
1986 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
1987 * \param maclen MAC length.
1988 * \param keylen Key length.
1989 * \param ivlen IV length.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001990 * \param client_random The client random bytes.
1991 * \param server_random The server random bytes.
Ron Eldor51d3ab52019-05-12 14:54:30 +03001992 * \param tls_prf_type The tls_prf enum type.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001993 *
1994 * \return 0 if successful, or
1995 * a specific MBEDTLS_ERR_XXX code.
1996 */
1997typedef int mbedtls_ssl_export_keys_ext_t( void *p_expkey,
1998 const unsigned char *ms,
1999 const unsigned char *kb,
2000 size_t maclen,
2001 size_t keylen,
2002 size_t ivlen,
Jaeden Amero63d813d2019-09-12 10:09:57 +01002003 const unsigned char client_random[32],
2004 const unsigned char server_random[32],
Ron Eldor51d3ab52019-05-12 14:54:30 +03002005 mbedtls_tls_prf_types tls_prf_type );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002006#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002007
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002008/**
2009 * \brief Callback type: parse and load session ticket
2010 *
2011 * \note This describes what a callback implementation should do.
2012 * This callback should parse a session ticket as generated
2013 * by the corresponding mbedtls_ssl_ticket_write_t function,
2014 * and, if the ticket is authentic and valid, load the
2015 * session.
2016 *
2017 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002018 * bytes of the input buffer, eg to use it as a temporary
2019 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002020 *
2021 * \param p_ticket Context for the callback
2022 * \param session SSL session to be loaded
2023 * \param buf Start of the buffer containing the ticket
2024 * \param len Length of the ticket.
2025 *
2026 * \return 0 if successful, or
2027 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
2028 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
2029 * any other non-zero code for other failures.
2030 */
2031typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
2032 mbedtls_ssl_session *session,
2033 unsigned char *buf,
2034 size_t len );
2035
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002036#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002037/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002038 * \brief Configure SSL session ticket callbacks (server only).
2039 * (Default: none.)
2040 *
2041 * \note On server, session tickets are enabled by providing
2042 * non-NULL callbacks.
2043 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002044 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002045 *
2046 * \param conf SSL configuration context
2047 * \param f_ticket_write Callback for writing a ticket
2048 * \param f_ticket_parse Callback for parsing a ticket
2049 * \param p_ticket Context shared by the two callbacks
2050 */
2051void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
2052 mbedtls_ssl_ticket_write_t *f_ticket_write,
2053 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
2054 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002055#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02002056
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002057#if defined(MBEDTLS_SSL_EXPORT_KEYS)
2058/**
2059 * \brief Configure key export callback.
2060 * (Default: none.)
2061 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002062 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002063 *
2064 * \param conf SSL configuration context
2065 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02002066 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002067 */
2068void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
2069 mbedtls_ssl_export_keys_t *f_export_keys,
2070 void *p_export_keys );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002071
2072/**
2073 * \brief Configure extended key export callback.
2074 * (Default: none.)
2075 *
2076 * \note See \c mbedtls_ssl_export_keys_ext_t.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02002077 * \warning Exported key material must not be used for any purpose
2078 * before the (D)TLS handshake is completed
Ron Eldorf5cc10d2019-05-07 18:33:40 +03002079 *
2080 * \param conf SSL configuration context
2081 * \param f_export_keys_ext Callback for exporting keys
2082 * \param p_export_keys Context for the callback
2083 */
2084void mbedtls_ssl_conf_export_keys_ext_cb( mbedtls_ssl_config *conf,
2085 mbedtls_ssl_export_keys_ext_t *f_export_keys_ext,
2086 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01002087#endif /* MBEDTLS_SSL_EXPORT_KEYS */
2088
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002089#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002090/**
2091 * \brief Configure asynchronous private key operation callbacks.
2092 *
2093 * \param conf SSL configuration context
2094 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002095 * the description of ::mbedtls_ssl_async_sign_t
2096 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002097 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002098 * operation; in this case the private key object
2099 * associated with the certificate will be used.
2100 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002101 * the description of ::mbedtls_ssl_async_decrypt_t
2102 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02002103 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002104 * operation; in this case the private key object
2105 * associated with the certificate will be used.
2106 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002107 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002108 * for more information. This may not be \c NULL unless
2109 * \p f_async_sign and \p f_async_decrypt are both
2110 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002111 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02002112 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02002113 * for more information. This may be \c NULL if
2114 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02002115 * \param config_data A pointer to configuration data which can be
2116 * retrieved with
2117 * mbedtls_ssl_conf_get_async_config_data(). The
2118 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002119 */
2120void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
2121 mbedtls_ssl_async_sign_t *f_async_sign,
2122 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
2123 mbedtls_ssl_async_resume_t *f_async_resume,
2124 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002125 void *config_data );
2126
2127/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02002128 * \brief Retrieve the configuration data set by
2129 * mbedtls_ssl_conf_async_private_cb().
2130 *
2131 * \param conf SSL configuration context
2132 * \return The configuration data set by
2133 * mbedtls_ssl_conf_async_private_cb().
2134 */
2135void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
2136
2137/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002138 * \brief Retrieve the asynchronous operation user context.
2139 *
2140 * \note This function may only be called while a handshake
2141 * is in progress.
2142 *
2143 * \param ssl The SSL context to access.
2144 *
2145 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02002146 * set during the current handshake. If
2147 * mbedtls_ssl_set_async_operation_data() has not yet been
2148 * called during the current handshake, this function returns
2149 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002150 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002151void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002152
2153/**
2154 * \brief Retrieve the asynchronous operation user context.
2155 *
2156 * \note This function may only be called while a handshake
2157 * is in progress.
2158 *
2159 * \param ssl The SSL context to access.
2160 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002161 * Call mbedtls_ssl_get_async_operation_data() later during the
2162 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002163 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002164void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002165 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002166#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002167
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002168/**
2169 * \brief Callback type: generate a cookie
2170 *
2171 * \param ctx Context for the callback
2172 * \param p Buffer to write to,
2173 * must be updated to point right after the cookie
2174 * \param end Pointer to one past the end of the output buffer
2175 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002177 * \param ilen Length of info in bytes
2178 *
2179 * \return The callback must return 0 on success,
2180 * or a negative error code.
2181 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002182typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002183 unsigned char **p, unsigned char *end,
2184 const unsigned char *info, size_t ilen );
2185
2186/**
2187 * \brief Callback type: verify a cookie
2188 *
2189 * \param ctx Context for the callback
2190 * \param cookie Cookie to verify
2191 * \param clen Length of cookie
2192 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002194 * \param ilen Length of info in bytes
2195 *
2196 * \return The callback must return 0 if cookie is valid,
2197 * or a negative error code.
2198 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002199typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002200 const unsigned char *cookie, size_t clen,
2201 const unsigned char *info, size_t ilen );
2202
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002203#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002204/**
2205 * \brief Register callbacks for DTLS cookies
2206 * (Server only. DTLS only.)
2207 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002208 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002209 * register working callbacks (and initialize their context).
2210 *
2211 * To disable HelloVerifyRequest, register NULL callbacks.
2212 *
2213 * \warning Disabling hello verification allows your server to be used
2214 * for amplification in DoS attacks against other hosts.
2215 * Only disable if you known this can't happen in your
2216 * particular environment.
2217 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002218 * \note See comments on \c mbedtls_ssl_handshake() about handling
2219 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2220 * on the first handshake attempt when this is enabled.
2221 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002222 * \note This is also necessary to handle client reconnection from
2223 * the same port as described in RFC 6347 section 4.2.8 (only
2224 * the variant with cookies is supported currently). See
2225 * comments on \c mbedtls_ssl_read() for details.
2226 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002227 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002228 * \param f_cookie_write Cookie write callback
2229 * \param f_cookie_check Cookie check callback
2230 * \param p_cookie Context for both callbacks
2231 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002232void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233 mbedtls_ssl_cookie_write_t *f_cookie_write,
2234 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002235 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002236
2237/**
2238 * \brief Set client's transport-level identification info.
2239 * (Server only. DTLS only.)
2240 *
2241 * This is usually the IP address (and port), but could be
2242 * anything identify the client depending on the underlying
2243 * network stack. Used for HelloVerifyRequest with DTLS.
2244 * This is *not* used to route the actual packets.
2245 *
2246 * \param ssl SSL context
2247 * \param info Transport-level info identifying the client (eg IP + port)
2248 * \param ilen Length of info in bytes
2249 *
2250 * \note An internal copy is made, so the info buffer can be reused.
2251 *
2252 * \return 0 on success,
2253 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002254 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002255 */
2256int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2257 const unsigned char *info,
2258 size_t ilen );
2259
2260#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002261
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002262#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002263/**
2264 * \brief Enable or disable anti-replay protection for DTLS.
2265 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002266 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002267 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002268 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002269 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002270 *
2271 * \warning Disabling this is a security risk unless the application
2272 * protocol handles duplicated packets in a safe way. You
2273 * should not disable this without careful consideration.
2274 * However, if your application already detects duplicated
2275 * packets and needs information about them to adjust its
2276 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002277 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002278void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002279#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002282/**
2283 * \brief Set a limit on the number of records with a bad MAC
2284 * before terminating the connection.
2285 * (DTLS only, no effect on TLS.)
2286 * Default: 0 (disabled).
2287 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002288 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002289 * \param limit Limit, or 0 to disable.
2290 *
2291 * \note If the limit is N, then the connection is terminated when
2292 * the Nth non-authentic record is seen.
2293 *
2294 * \note Records with an invalid header are not counted, only the
2295 * ones going through the authentication-decryption phase.
2296 *
2297 * \note This is a security trade-off related to the fact that it's
2298 * often relatively easy for an active attacker ot inject UDP
2299 * datagrams. On one hand, setting a low limit here makes it
2300 * easier for such an attacker to forcibly terminated a
2301 * connection. On the other hand, a high limit or no limit
2302 * might make us waste resources checking authentication on
2303 * many bogus packets.
2304 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002305void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002306#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002308#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002309
2310/**
2311 * \brief Allow or disallow packing of multiple handshake records
2312 * within a single datagram.
2313 *
2314 * \param ssl The SSL context to configure.
2315 * \param allow_packing This determines whether datagram packing may
2316 * be used or not. A value of \c 0 means that every
2317 * record will be sent in a separate datagram; a
2318 * value of \c 1 means that, if space permits,
2319 * multiple handshake messages (including CCS) belonging to
2320 * a single flight may be packed within a single datagram.
2321 *
2322 * \note This is enabled by default and should only be disabled
2323 * for test purposes, or if datagram packing causes
2324 * interoperability issues with peers that don't support it.
2325 *
2326 * \note Allowing datagram packing reduces the network load since
2327 * there's less overhead if multiple messages share the same
2328 * datagram. Also, it increases the handshake efficiency
2329 * since messages belonging to a single datagram will not
2330 * be reordered in transit, and so future message buffering
2331 * or flight retransmission (if no buffering is used) as
2332 * means to deal with reordering are needed less frequently.
2333 *
Hanno Beckereb570082018-08-24 11:28:35 +01002334 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002335 * are currently always sent in separate datagrams.
2336 *
2337 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002338void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2339 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002340
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002341/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002342 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002343 * (DTLS only, no effect on TLS.)
2344 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002345 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002346 * \param min Initial timeout value in milliseconds.
2347 * Default: 1000 (1 second).
2348 * \param max Maximum timeout value in milliseconds.
2349 * Default: 60000 (60 seconds).
2350 *
2351 * \note Default values are from RFC 6347 section 4.2.4.1.
2352 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002353 * \note The 'min' value should typically be slightly above the
2354 * expected round-trip time to your peer, plus whatever time
2355 * it takes for the peer to process the message. For example,
2356 * if your RTT is about 600ms and you peer needs up to 1s to
2357 * do the cryptographic operations in the handshake, then you
2358 * should set 'min' slightly above 1600. Lower values of 'min'
2359 * might cause spurious resends which waste network resources,
2360 * while larger value of 'min' will increase overall latency
2361 * on unreliable network links.
2362 *
2363 * \note The more unreliable your network connection is, the larger
2364 * your max / min ratio needs to be in order to achieve
2365 * reliable handshakes.
2366 *
2367 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2368 * For example, if min = 1s and max = 5s, the retransmit plan
2369 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2370 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002371 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002372void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002373#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002374
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002375#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002376/**
Paul Bakker0a597072012-09-25 21:55:46 +00002377 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002378 * If not set, no session resuming is done (except if session
2379 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002380 *
Paul Bakker0a597072012-09-25 21:55:46 +00002381 * The session cache has the responsibility to check for stale
2382 * entries based on timeout. See RFC 5246 for recommendations.
2383 *
2384 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2385 * connection shutdown, so do not cache the pointer! Either set
2386 * it to NULL or make a full copy of the certificate.
2387 *
2388 * The get callback is called once during the initial handshake
2389 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002391 * If a valid entry is found, it should fill the master of
2392 * the session object with the cached values and return 0,
2393 * return 1 otherwise. Optionally peer_cert can be set as well
2394 * if it is properly present in cache entry.
2395 *
2396 * The set callback is called once during the initial handshake
2397 * to enable session resuming after the entire handshake has
2398 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002399 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002400 * should create a cache entry for future retrieval based on
2401 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002402 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002403 * data) is cleared by the SSL/TLS layer when the connection is
2404 * terminated. It is recommended to add metadata to determine if
2405 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002406 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002407 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002408 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002409 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002410 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002411 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002412 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002413void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Hanno Beckera637ff62021-04-15 08:42:48 +01002414 void *p_cache,
2415 mbedtls_ssl_cache_get_t *f_get_cache,
2416 mbedtls_ssl_cache_set_t *f_set_cache );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002417#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002418
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002419#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002420/**
Paul Bakker0a597072012-09-25 21:55:46 +00002421 * \brief Request resumption of session (client-side only)
2422 * Session data is copied from presented session structure.
2423 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002425 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002426 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002427 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002428 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002429 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002430 * arguments are otherwise invalid
2431 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002432 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002433 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002434int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2435#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002436
2437/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002438 * \brief Load serialized session data into a session structure.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002439 * On client, this can be used for loading saved sessions
2440 * before resuming them with mbedstls_ssl_set_session().
2441 * On server, this can be used for alternative implementations
2442 * of session cache or session tickets.
2443 *
2444 * \warning If a peer certificate chain is associated with the session,
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002445 * the serialized state will only contain the peer's
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002446 * end-entity certificate and the result of the chain
2447 * verification (unless verification was disabled), but not
2448 * the rest of the chain.
2449 *
2450 * \see mbedtls_ssl_session_save()
2451 * \see mbedtls_ssl_set_session()
2452 *
2453 * \param session The session structure to be populated. It must have been
2454 * initialised with mbedtls_ssl_session_init() but not
2455 * populated yet.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002456 * \param buf The buffer holding the serialized session data. It must be a
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002457 * readable buffer of at least \p len bytes.
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002458 * \param len The size of the serialized data in bytes.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002459 *
2460 * \return \c 0 if successful.
2461 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
2462 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
Hanno Beckerf9b33032019-06-03 12:58:39 +01002463 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
2464 * was generated in a different version or configuration of
2465 * Mbed TLS.
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002466 * \return Another negative value for other kinds of errors (for
2467 * example, unsupported features in the embedded certificate).
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002468 */
2469int mbedtls_ssl_session_load( mbedtls_ssl_session *session,
2470 const unsigned char *buf,
2471 size_t len );
2472
2473/**
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002474 * \brief Save session structure as serialized data in a buffer.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002475 * On client, this can be used for saving session data,
2476 * potentially in non-volatile storage, for resuming later.
2477 * On server, this can be used for alternative implementations
2478 * of session cache or session tickets.
2479 *
2480 * \see mbedtls_ssl_session_load()
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002481 * \see mbedtls_ssl_get_session_pointer()
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002482 *
2483 * \param session The session structure to be saved.
2484 * \param buf The buffer to write the serialized data to. It must be a
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002485 * writeable buffer of at least \p len bytes, or may be \c
2486 * NULL if \p len is \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002487 * \param buf_len The number of bytes available for writing in \p buf.
Manuel Pégourié-Gonnard26f982f2019-05-21 11:01:32 +02002488 * \param olen The size in bytes of the data that has been or would have
2489 * been written. It must point to a valid \c size_t.
2490 *
2491 * \note \p olen is updated to the correct value regardless of
2492 * whether \p buf_len was large enough. This makes it possible
2493 * to determine the necessary size by calling this function
2494 * with \p buf set to \c NULL and \p buf_len to \c 0.
Manuel Pégourié-Gonnard5a6d6ec2019-05-15 16:13:59 +02002495 *
2496 * \return \c 0 if successful.
2497 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
2498 */
2499int mbedtls_ssl_session_save( const mbedtls_ssl_session *session,
2500 unsigned char *buf,
2501 size_t buf_len,
2502 size_t *olen );
2503
2504/**
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002505 * \brief Get a pointer to the current session structure, for example
Manuel Pégourié-Gonnard686adb42019-06-03 09:55:16 +02002506 * to serialize it.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002507 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002508 * \warning Ownership of the session remains with the SSL context, and
2509 * the returned pointer is only guaranteed to be valid until
2510 * the next API call operating on the same \p ssl context.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002511 *
2512 * \see mbedtls_ssl_session_save()
2513 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002514 * \param ssl The SSL context.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002515 *
Manuel Pégourié-Gonnarddf9bc212019-05-27 09:58:07 +02002516 * \return A pointer to the current session if successful.
2517 * \return \c NULL if no session is active.
Manuel Pégourié-Gonnardb5e4e0a2019-05-20 11:12:28 +02002518 */
2519const mbedtls_ssl_session *mbedtls_ssl_get_session_pointer( const mbedtls_ssl_context *ssl );
2520
2521/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002522 * \brief Set the list of allowed ciphersuites and the preference
2523 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002524 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002525 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002526 * The ciphersuites array is not copied, and must remain
2527 * valid for the lifetime of the ssl_config.
2528 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002529 * Note: The server uses its own preferences
2530 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002531 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002532 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002533 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002534 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002535 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002536void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002537 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002538
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002539/**
2540 * \brief Get ciphersuite for given protocol's minor version.
2541 *
2542 * \param conf The SSL configuration.
2543 * \param prot_version Protocol version. One of MBEDTLS_SSL_MINOR_VERSION_x macros.
Tobias Nießen1e8ca122021-05-10 19:53:15 +02002544 * \return Ciphersuites pointer if successful.
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002545 * \return \c NULL if no ciphersuites where found.
2546 */
2547const int *mbedtls_ssl_get_protocol_version_ciphersuites(
2548 const mbedtls_ssl_config *conf, int prot_version );
2549
Hanno Beckera0e20d02019-05-15 14:03:01 +01002550#if defined(MBEDTLS_SSL_DTLS_CONNECTION_ID)
Hanno Becker7fefd832019-05-14 11:44:35 +01002551#define MBEDTLS_SSL_UNEXPECTED_CID_IGNORE 0
2552#define MBEDTLS_SSL_UNEXPECTED_CID_FAIL 1
Hanno Beckerad4a1372019-05-03 13:06:44 +01002553/**
Hanno Becker11259522019-05-23 16:55:50 +01002554 * \brief Specify the length of Connection IDs for incoming
2555 * encrypted DTLS records, as well as the behaviour
2556 * on unexpected CIDs.
Hanno Becker8367ccc2019-05-14 11:30:10 +01002557 *
2558 * By default, the CID length is set to \c 0,
2559 * and unexpected CIDs are silently ignored.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002560 *
2561 * \param conf The SSL configuration to modify.
2562 * \param len The length in Bytes of the CID fields in encrypted
2563 * DTLS records using the CID mechanism. This must
2564 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
Hanno Becker62e5afa2019-05-20 10:19:56 +01002565 * \param ignore_other_cids This determines the stack's behaviour when
Hanno Becker8367ccc2019-05-14 11:30:10 +01002566 * receiving a record with an unexpected CID.
2567 * Possible values are:
2568 * - #MBEDTLS_SSL_UNEXPECTED_CID_IGNORE
2569 * In this case, the record is silently ignored.
2570 * - #MBEDTLS_SSL_UNEXPECTED_CID_FAIL
2571 * In this case, the stack fails with the specific
2572 * error code #MBEDTLS_ERR_SSL_UNEXPECTED_CID.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002573 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002574 * \note The CID specification allows implementations to either
2575 * use a common length for all incoming connection IDs or
2576 * allow variable-length incoming IDs. Mbed TLS currently
2577 * requires a common length for all connections sharing the
2578 * same SSL configuration; this allows simpler parsing of
2579 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002580 *
2581 * \return \c 0 on success.
2582 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2583 * is too large.
2584 */
Hanno Becker8367ccc2019-05-14 11:30:10 +01002585int mbedtls_ssl_conf_cid( mbedtls_ssl_config *conf, size_t len,
2586 int ignore_other_cids );
Hanno Beckera0e20d02019-05-15 14:03:01 +01002587#endif /* MBEDTLS_SSL_DTLS_CONNECTION_ID */
Hanno Beckerad4a1372019-05-03 13:06:44 +01002588
Paul Bakker5121ce52009-01-03 21:22:43 +00002589/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002590 * \brief Set the list of allowed ciphersuites and the
2591 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002592 * (Only useful on the server side)
2593 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002594 * The ciphersuites array is not copied, and must remain
2595 * valid for the lifetime of the ssl_config.
2596 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002597 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002598 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002599 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002600 * supported)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01002601 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_1,
2602 * MBEDTLS_SSL_MINOR_VERSION_2,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002603 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002604 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002605 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2606 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002607 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002608void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002609 const int *ciphersuites,
2610 int major, int minor );
2611
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002612#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002613/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002614 * \brief Set the X.509 security profile used for verification
2615 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002616 * \note The restrictions are enforced for all certificates in the
2617 * chain. However, signatures in the handshake are not covered
2618 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2619 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002620 * \param conf SSL configuration
2621 * \param profile Profile to use
2622 */
2623void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002624 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002625
2626/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002627 * \brief Set the data required to verify peer certificate
2628 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002629 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002630 * parameters ca_chain (maps to trust_ca for that function)
2631 * and ca_crl.
2632 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002633 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002634 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002635 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002636 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002637void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002638 mbedtls_x509_crt *ca_chain,
2639 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002640
Hanno Becker8bf74f32019-03-27 11:01:30 +00002641#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2642/**
2643 * \brief Set the trusted certificate callback.
2644 *
2645 * This API allows to register the set of trusted certificates
2646 * through a callback, instead of a linked list as configured
2647 * by mbedtls_ssl_conf_ca_chain().
2648 *
2649 * This is useful for example in contexts where a large number
2650 * of CAs are used, and the inefficiency of maintaining them
2651 * in a linked list cannot be tolerated. It is also useful when
2652 * the set of trusted CAs needs to be modified frequently.
2653 *
2654 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2655 * more information.
2656 *
2657 * \param conf The SSL configuration to register the callback with.
2658 * \param f_ca_cb The trusted certificate callback to use when verifying
2659 * certificate chains.
2660 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2661 * a reference to a trusted CA database).
2662 *
2663 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2664 * Any call to this function overwrites the values set through
2665 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2666 * mbedtls_ssl_conf_ca_cb().
2667 *
2668 * \note This API is incompatible with CA indication in
2669 * CertificateRequest messages: A server-side SSL context which
2670 * is bound to an SSL configuration that uses a CA callback
2671 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2672 * client authentication, will send an empty CA list in the
2673 * corresponding CertificateRequest message.
2674 *
2675 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2676 * If an SSL context is bound to an SSL configuration which uses
2677 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2678 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2679 *
2680 * \note The use of this API disables the use of restartable ECC
2681 * during X.509 CRT signature verification (but doesn't affect
2682 * other uses).
2683 *
2684 * \warning This API is incompatible with the use of CRLs. Any call to
2685 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2686 * earlier calls to mbedtls_ssl_conf_ca_chain().
2687 *
2688 * \warning In multi-threaded environments, the callback \p f_ca_cb
2689 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002690 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002691 * contained in the callback context pointed to by \p p_ca_cb).
2692 */
2693void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2694 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2695 void *p_ca_cb );
2696#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2697
Paul Bakker5121ce52009-01-03 21:22:43 +00002698/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002699 * \brief Set own certificate chain and private key
2700 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002701 * \note own_cert should contain in order from the bottom up your
2702 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002703 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002704 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002705 * \note On server, this function can be called multiple times to
2706 * provision more than one cert/key pair (eg one ECDSA, one
2707 * RSA with SHA-256, one RSA with SHA-1). An adequate
2708 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002709 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002710 * adequate, preference is given to the one set by the first
2711 * call to this function, then second, etc.
2712 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002713 * \note On client, only the first call has any effect. That is,
2714 * only one client certificate can be provisioned. The
2715 * server's preferences in its CertficateRequest message will
2716 * be ignored and our only cert will be sent regardless of
2717 * whether it matches those preferences - the server can then
2718 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002719 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002720 * \note The provided \p pk_key needs to match the public key in the
2721 * first certificate in \p own_cert, or all handshakes using
2722 * that certificate will fail. It is your responsibility
2723 * to ensure that; this function will not perform any check.
2724 * You may use mbedtls_pk_check_pair() in order to perform
2725 * this check yourself, but be aware that this function can
2726 * be computationally expensive on some key types.
2727 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002728 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002729 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002730 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002731 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002732 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002733 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002734int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002735 mbedtls_x509_crt *own_cert,
2736 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002737#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002738
Gilles Peskineeccd8882020-03-10 12:19:08 +01002739#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002740/**
Hanno Becker02283042018-10-22 15:28:02 +01002741 * \brief Configure a pre-shared key (PSK) and identity
2742 * to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002743 *
2744 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002745 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002746 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002747 * \note A PSK set by \c mbedtls_ssl_set_hs_psk() in the PSK callback
2748 * takes precedence over a PSK configured by this function.
2749 *
Hanno Becker02283042018-10-22 15:28:02 +01002750 * \warning Currently, clients can only register a single pre-shared key.
Hanno Beckerf9a32872018-11-15 13:18:25 +00002751 * Calling this function or mbedtls_ssl_conf_psk_opaque() more
Hanno Becker02283042018-10-22 15:28:02 +01002752 * than once will overwrite values configured in previous calls.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002753 * Support for setting multiple PSKs on clients and selecting
Hanno Becker02283042018-10-22 15:28:02 +01002754 * one based on the identity hint is not a planned feature,
2755 * but feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002756 *
Hanno Becker02283042018-10-22 15:28:02 +01002757 * \param conf The SSL configuration to register the PSK with.
2758 * \param psk The pointer to the pre-shared key to use.
2759 * \param psk_len The length of the pre-shared key in bytes.
2760 * \param psk_identity The pointer to the pre-shared key identity.
2761 * \param psk_identity_len The length of the pre-shared key identity
2762 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002763 *
Hanno Becker02283042018-10-22 15:28:02 +01002764 * \note The PSK and its identity are copied internally and
2765 * hence need not be preserved by the caller for the lifetime
2766 * of the SSL configuration.
2767 *
2768 * \return \c 0 if successful.
2769 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002770 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002771int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002772 const unsigned char *psk, size_t psk_len,
2773 const unsigned char *psk_identity, size_t psk_identity_len );
2774
Hanno Becker02283042018-10-22 15:28:02 +01002775#if defined(MBEDTLS_USE_PSA_CRYPTO)
2776/**
2777 * \brief Configure an opaque pre-shared key (PSK) and identity
2778 * to be used in PSK-based ciphersuites.
2779 *
2780 * \note This is mainly useful for clients. Servers will usually
2781 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2782 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002783 * \note An opaque PSK set by \c mbedtls_ssl_set_hs_psk_opaque() in
2784 * the PSK callback takes precedence over an opaque PSK
2785 * configured by this function.
2786 *
Hanno Becker02283042018-10-22 15:28:02 +01002787 * \warning Currently, clients can only register a single pre-shared key.
2788 * Calling this function or mbedtls_ssl_conf_psk() more than
2789 * once will overwrite values configured in previous calls.
2790 * Support for setting multiple PSKs on clients and selecting
2791 * one based on the identity hint is not a planned feature,
2792 * but feedback is welcomed.
2793 *
2794 * \param conf The SSL configuration to register the PSK with.
2795 * \param psk The identifier of the key slot holding the PSK.
2796 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002797 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002798 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002799 * allows its use for the key derivation algorithm applied
2800 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002801 * \param psk_identity The pointer to the pre-shared key identity.
2802 * \param psk_identity_len The length of the pre-shared key identity
2803 * in bytes.
2804 *
2805 * \note The PSK identity hint is copied internally and hence need
2806 * not be preserved by the caller for the lifetime of the
2807 * SSL configuration.
2808 *
2809 * \return \c 0 if successful.
2810 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2811 */
2812int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002813 psa_key_id_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002814 const unsigned char *psk_identity,
2815 size_t psk_identity_len );
2816#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002817
2818/**
Hanno Becker02283042018-10-22 15:28:02 +01002819 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002820 *
2821 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002822 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002823 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002824 * \note A PSK set by this function takes precedence over a PSK
2825 * configured by \c mbedtls_ssl_conf_psk().
2826 *
Hanno Becker02283042018-10-22 15:28:02 +01002827 * \param ssl The SSL context to configure a PSK for.
2828 * \param psk The pointer to the pre-shared key.
2829 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002830 *
Hanno Becker02283042018-10-22 15:28:02 +01002831 * \return \c 0 if successful.
2832 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002833 */
2834int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2835 const unsigned char *psk, size_t psk_len );
2836
Hanno Becker02283042018-10-22 15:28:02 +01002837#if defined(MBEDTLS_USE_PSA_CRYPTO)
2838/**
2839 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2840 *
2841 * \note This should only be called inside the PSK callback,
2842 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2843 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002844 * \note An opaque PSK set by this function takes precedence over an
2845 * opaque PSK configured by \c mbedtls_ssl_conf_psk_opaque().
2846 *
Hanno Becker02283042018-10-22 15:28:02 +01002847 * \param ssl The SSL context to configure a PSK for.
2848 * \param psk The identifier of the key slot holding the PSK.
2849 * For the duration of the current handshake, the key slot
2850 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002851 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002852 * use for the key derivation algorithm
2853 * applied in the handshake.
2854 *
2855 * \return \c 0 if successful.
2856 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2857 */
2858int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Ronald Croncf56a0a2020-08-04 09:51:30 +02002859 psa_key_id_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002860#endif /* MBEDTLS_USE_PSA_CRYPTO */
2861
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002862/**
2863 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002864 *
2865 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002866 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002867 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002868 * receive the actual PSK data and length.
2869 *
Hanno Becker02283042018-10-22 15:28:02 +01002870 * The callback has the following parameters:
2871 * - \c void*: The opaque pointer \p p_psk.
2872 * - \c mbedtls_ssl_context*: The SSL context to which
2873 * the operation applies.
2874 * - \c const unsigned char*: The PSK identity
2875 * selected by the client.
2876 * - \c size_t: The length of the PSK identity
2877 * selected by the client.
2878 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002879 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002880 * \c mbedtls_ssl_set_hs_psk() or
2881 * \c mbedtls_ssl_set_hs_psk_opaque()
2882 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002883 * Any other return value will result in a denied PSK identity.
2884 *
Guilhem Bryante40a2f72020-03-25 16:57:00 +00002885 * \note A dynamic PSK (i.e. set by the PSK callback) takes
2886 * precedence over a static PSK (i.e. set by
2887 * \c mbedtls_ssl_conf_psk() or
2888 * \c mbedtls_ssl_conf_psk_opaque()).
2889 * This means that if you set a PSK callback using this
2890 * function, you don't need to set a PSK using
2891 * \c mbedtls_ssl_conf_psk() or
2892 * \c mbedtls_ssl_conf_psk_opaque()).
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002893 *
Hanno Becker02283042018-10-22 15:28:02 +01002894 * \param conf The SSL configuration to register the callback with.
2895 * \param f_psk The callback for selecting and setting the PSK based
2896 * in the PSK identity chosen by the client.
2897 * \param p_psk A pointer to an opaque structure to be passed to
2898 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002899 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002900void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002901 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002902 size_t),
2903 void *p_psk );
Gilles Peskineeccd8882020-03-10 12:19:08 +01002904#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002905
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002906#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Beckera90658f2017-10-04 15:29:08 +01002907/**
2908 * \brief Set the Diffie-Hellman public P and G values
2909 * from big-endian binary presentations.
2910 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2911 *
2912 * \param conf SSL configuration
2913 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2914 * \param P_len Length of DHM modulus
2915 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2916 * \param G_len Length of DHM generator
2917 *
2918 * \return 0 if successful
2919 */
2920int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2921 const unsigned char *dhm_P, size_t P_len,
2922 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002923
2924/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002925 * \brief Set the Diffie-Hellman public P and G values,
2926 * read from existing context (server-side only)
2927 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002928 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002929 * \param dhm_ctx Diffie-Hellman-Merkle context
2930 *
2931 * \return 0 if successful
2932 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002933int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002934#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002935
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002936#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2937/**
2938 * \brief Set the minimum length for Diffie-Hellman parameters.
2939 * (Client-side only.)
2940 * (Default: 1024 bits.)
2941 *
2942 * \param conf SSL configuration
2943 * \param bitlen Minimum bit length of the DHM prime
2944 */
2945void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2946 unsigned int bitlen );
2947#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2948
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002949#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002950/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002951 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002952 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002953 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002954 * On server: this only affects selection of the ECDHE curve;
2955 * the curves used for ECDH and ECDSA are determined by the
2956 * list of available certificates instead.
2957 *
2958 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002959 * use. The server can override our preference order.
2960 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002961 * Both sides: limits the set of curves accepted for use in
2962 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002963 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002964 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002965 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002966 * for that. For the end-entity certificate however, the key
2967 * will be accepted only if it is allowed both by this list
2968 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002969 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002970 * \note This list should be ordered by decreasing preference
2971 * (preferred curve first).
2972 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002973 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002974 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002976 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002977void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2978 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002979#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002980
Gilles Peskineeccd8882020-03-10 12:19:08 +01002981#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002982/**
2983 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002984 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002985 *
2986 * \note This only affects which hashes are offered and can be used
2987 * for signatures during the handshake. Hashes for message
2988 * authentication and the TLS PRF are controlled by the
2989 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2990 * used for certificate signature are controlled by the
2991 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2992 *
2993 * \note This list should be ordered by decreasing preference
2994 * (preferred hash first).
2995 *
2996 * \param conf SSL configuration
2997 * \param hashes Ordered list of allowed signature hashes,
2998 * terminated by \c MBEDTLS_MD_NONE.
2999 */
3000void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
3001 const int *hashes );
Gilles Peskineeccd8882020-03-10 12:19:08 +01003002#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02003003
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003004#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00003005/**
Darryl Green11999bb2018-03-13 15:22:58 +00003006 * \brief Set or reset the hostname to check against the received
3007 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01003008 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02003009 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003010 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01003011 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00003012
Hanno Becker0446a392017-04-07 12:59:32 +01003013 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00003014 *
Darryl Green11999bb2018-03-13 15:22:58 +00003015 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
3016 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01003017 * too long input hostname.
3018 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01003019 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00003020 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01003021 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00003022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003023int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003024#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00003025
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01003026#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00003027/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003028 * \brief Set own certificate and key for the current handshake
3029 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003030 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003031 * the SNI callback.
3032 *
3033 * \param ssl SSL context
3034 * \param own_cert own public certificate chain
3035 * \param pk_key own private key
3036 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003037 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02003038 */
3039int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
3040 mbedtls_x509_crt *own_cert,
3041 mbedtls_pk_context *pk_key );
3042
3043/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003044 * \brief Set the data required to verify peer certificate for the
3045 * current handshake
3046 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003047 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003048 * the SNI callback.
3049 *
3050 * \param ssl SSL context
3051 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
3052 * \param ca_crl trusted CA CRLs
3053 */
3054void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
3055 mbedtls_x509_crt *ca_chain,
3056 mbedtls_x509_crl *ca_crl );
3057
3058/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003059 * \brief Set authmode for the current handshake.
3060 *
3061 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
3062 * the SNI callback.
3063 *
3064 * \param ssl SSL context
3065 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
3066 * MBEDTLS_SSL_VERIFY_REQUIRED
3067 */
3068void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
3069 int authmode );
3070
3071/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00003072 * \brief Set server side ServerName TLS extension callback
3073 * (optional, server-side only).
3074 *
3075 * If set, the ServerName callback is called whenever the
3076 * server receives a ServerName TLS extension from the client
3077 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003079 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003080 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02003081 * certificate(s) and key(s) to use with \c
3082 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02003083 * and may optionally adjust the CA and associated CRL with \c
3084 * mbedtls_ssl_set_hs_ca_chain() as well as the client
3085 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
3086 * then must return 0. If no matching name is found, the
3087 * callback must either set a default cert, or
3088 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00003089 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003090 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00003091 * \param f_sni verification function
3092 * \param p_sni verification parameter
3093 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003094void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00003096 size_t),
3097 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00003099
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003100#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003101/**
3102 * \brief Set the EC J-PAKE password for current handshake.
3103 *
3104 * \note An internal copy is made, and destroyed as soon as the
3105 * handshake is completed, or when the SSL context is reset or
3106 * freed.
3107 *
3108 * \note The SSL context needs to be already set up. The right place
3109 * to call this function is between \c mbedtls_ssl_setup() or
3110 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
3111 *
3112 * \param ssl SSL context
3113 * \param pw EC J-PAKE password (pre-shared secret)
3114 * \param pw_len length of pw in bytes
3115 *
3116 * \return 0 on success, or a negative error code.
3117 */
3118int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
3119 const unsigned char *pw,
3120 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02003121#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02003122
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003124/**
3125 * \brief Set the supported Application Layer Protocols.
3126 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003127 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00003128 * \param protos Pointer to a NULL-terminated list of supported protocols,
3129 * in decreasing preference order. The pointer to the list is
3130 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00003131 * the lifetime of the table must be atleast as long as the
3132 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02003133 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003134 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003135 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003136int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003137
3138/**
3139 * \brief Get the name of the negotiated Application Layer Protocol.
3140 * This function should be called after the handshake is
3141 * completed.
3142 *
3143 * \param ssl SSL context
3144 *
3145 * \return Protcol name, or NULL if no protocol was negotiated.
3146 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003147const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
3148#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02003149
Johan Pascalb62bb512015-12-03 21:56:45 +01003150#if defined(MBEDTLS_SSL_DTLS_SRTP)
Johan Pascala455cd92020-09-22 15:28:11 +02003151#if defined(MBEDTLS_DEBUG_C)
Johan Pascalaae4d222020-09-22 21:21:39 +02003152static inline const char *mbedtls_ssl_get_srtp_profile_as_string( mbedtls_ssl_srtp_profile profile )
Johan Pascala455cd92020-09-22 15:28:11 +02003153{
3154 switch( profile )
3155 {
3156 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003157 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003158 case MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003159 return( "MBEDTLS_TLS_SRTP_AES128_CM_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003160 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80:
Johan Pascale79c1e82020-09-22 15:51:27 +02003161 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_80" );
Johan Pascala455cd92020-09-22 15:28:11 +02003162 case MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32:
Johan Pascale79c1e82020-09-22 15:51:27 +02003163 return( "MBEDTLS_TLS_SRTP_NULL_HMAC_SHA1_32" );
Johan Pascala455cd92020-09-22 15:28:11 +02003164 default: break;
3165 }
3166 return( "" );
3167}
3168#endif /* MBEDTLS_DEBUG_C */
Johan Pascalb62bb512015-12-03 21:56:45 +01003169/**
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003170 * \brief Manage support for mki(master key id) value
3171 * in use_srtp extension.
3172 * MKI is an optional part of SRTP used for key management
3173 * and re-keying. See RFC3711 section 3.1 for details.
Ron Eldora9788042018-12-05 11:04:31 +02003174 * The default value is
3175 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003176 *
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003177 * \param conf The SSL configuration to manage mki support.
Ron Eldora9788042018-12-05 11:04:31 +02003178 * \param support_mki_value Enable or disable mki usage. Values are
3179 * #MBEDTLS_SSL_DTLS_SRTP_MKI_UNSUPPORTED
3180 * or #MBEDTLS_SSL_DTLS_SRTP_MKI_SUPPORTED.
Ron Eldor591f1622018-01-22 12:30:04 +02003181 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003182void mbedtls_ssl_conf_srtp_mki_value_supported( mbedtls_ssl_config *conf,
3183 int support_mki_value );
Ron Eldor591f1622018-01-22 12:30:04 +02003184
3185/**
Johan Pascalb62bb512015-12-03 21:56:45 +01003186 * \brief Set the supported DTLS-SRTP protection profiles.
3187 *
Johan Pascalc28f1f62017-02-09 08:55:16 +07003188 * \param conf SSL configuration
Johan Pascal253d0262020-09-22 13:04:45 +02003189 * \param profiles Pointer to a List of MBEDTLS_TLS_SRTP_UNSET terminated
3190 * supported protection profiles
Johan Pascalb62bb512015-12-03 21:56:45 +01003191 * in decreasing preference order.
Johan Pascal253d0262020-09-22 13:04:45 +02003192 * The pointer to the list is recorded by the library
3193 * for later reference as required, so the lifetime
3194 * of the table must be at least as long as the lifetime
3195 * of the SSL configuration structure.
Johan Pascalaae4d222020-09-22 21:21:39 +02003196 * The list must not hold more than
3197 * MBEDTLS_TLS_SRTP_MAX_PROFILE_LIST_LENGTH elements
Johan Pascald387aa02020-09-23 18:47:56 +02003198 * (excluding the terminating MBEDTLS_TLS_SRTP_UNSET).
Johan Pascalb62bb512015-12-03 21:56:45 +01003199 *
Johan Pascal85269572020-08-25 10:01:54 +02003200 * \return 0 on success
Johan Pascal9bc97ca2020-09-21 23:44:45 +02003201 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA when the list of
3202 * protection profiles is incorrect.
Johan Pascalb62bb512015-12-03 21:56:45 +01003203 */
Ron Eldora9788042018-12-05 11:04:31 +02003204int mbedtls_ssl_conf_dtls_srtp_protection_profiles
3205 ( mbedtls_ssl_config *conf,
Johan Pascal253d0262020-09-22 13:04:45 +02003206 const mbedtls_ssl_srtp_profile *profiles );
Ron Eldor591f1622018-01-22 12:30:04 +02003207
3208/**
Ron Eldora9788042018-12-05 11:04:31 +02003209 * \brief Set the mki_value for the current DTLS-SRTP session.
Ron Eldor591f1622018-01-22 12:30:04 +02003210 *
Ron Eldora9788042018-12-05 11:04:31 +02003211 * \param ssl SSL context to use.
3212 * \param mki_value The MKI value to set.
3213 * \param mki_len The length of the MKI value.
Ron Eldor591f1622018-01-22 12:30:04 +02003214 *
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003215 * \note This function is relevant on client side only.
3216 * The server discovers the mki value during handshake.
3217 * A mki value set on server side using this function
3218 * is ignored.
3219 *
Johan Pascal85269572020-08-25 10:01:54 +02003220 * \return 0 on success
3221 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA
3222 * \return #MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE
Ron Eldor591f1622018-01-22 12:30:04 +02003223 */
Ron Eldoref72faf2018-07-12 11:54:20 +03003224int mbedtls_ssl_dtls_srtp_set_mki_value( mbedtls_ssl_context *ssl,
3225 unsigned char *mki_value,
Johan Pascalf6417ec2020-09-22 15:15:19 +02003226 uint16_t mki_len );
Johan Pascalb62bb512015-12-03 21:56:45 +01003227/**
Johan Pascal2258a4f2020-10-28 13:53:09 +01003228 * \brief Get the negotiated DTLS-SRTP informations:
3229 * Protection profile and MKI value.
Johan Pascal76fdf1d2020-10-22 23:31:00 +02003230 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003231 * \warning This function must be called after the handshake is
3232 * completed. The value returned by this function must
3233 * not be trusted or acted upon before the handshake completes.
Johan Pascalb62bb512015-12-03 21:56:45 +01003234 *
Johan Pascal2258a4f2020-10-28 13:53:09 +01003235 * \param ssl The SSL context to query.
3236 * \param dtls_srtp_info The negotiated DTLS-SRTP informations:
3237 * - Protection profile in use.
3238 * A direct mapping of the iana defined value for protection
3239 * profile on an uint16_t.
3240 http://www.iana.org/assignments/srtp-protection/srtp-protection.xhtml
3241 * #MBEDTLS_TLS_SRTP_UNSET if the use of SRTP was not negotiated
3242 * or peer's Hello packet was not parsed yet.
3243 * - mki size and value( if size is > 0 ).
Johan Pascalb62bb512015-12-03 21:56:45 +01003244 */
Johan Pascal2258a4f2020-10-28 13:53:09 +01003245void mbedtls_ssl_get_dtls_srtp_negotiation_result( const mbedtls_ssl_context *ssl,
3246 mbedtls_dtls_srtp_info *dtls_srtp_info );
Johan Pascalb62bb512015-12-03 21:56:45 +01003247#endif /* MBEDTLS_SSL_DTLS_SRTP */
3248
Paul Bakker5701cdc2012-09-27 21:49:42 +00003249/**
Paul Bakker490ecc82011-10-06 13:04:09 +00003250 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02003251 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003252 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02003253 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003254 * \note This ignores ciphersuites from higher versions.
3255 *
3256 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3257 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003258 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003259 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003260 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003261 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003262 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00003263 */
Ron Eldora9788042018-12-05 11:04:31 +02003264void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00003265
Paul Bakker1d29fb52012-09-28 13:28:45 +00003266/**
3267 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02003268 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02003269 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01003270 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
3271 * SSL_MIN_XXXXX_VERSION range is ignored.
3272 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003273 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
3274 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
3275 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003276 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003277 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003278 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_1,
3279 * MBEDTLS_SSL_MINOR_VERSION_2,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003280 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00003281 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003282void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00003283
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003284#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003285/**
3286 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003287 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003288 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003289 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003290 * connection, that is a connection with max_version set to a
3291 * lower value than the value you're willing to use. Such
3292 * fallback connections are not recommended but are sometimes
3293 * necessary to interoperate with buggy (version-intolerant)
3294 * servers.
3295 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003296 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003297 * non-fallback connections! This would appear to work for a
3298 * while, then cause failures when the server is upgraded to
3299 * support a newer TLS version.
3300 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01003301 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003302 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003303 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003304void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003305#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02003306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003307#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003308/**
3309 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003311 *
3312 * \note This should always be enabled, it is a security
3313 * improvement, and should not cause any interoperability
3314 * issue (used only if the peer supports it too).
3315 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003316 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003317 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003318 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003319void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003320#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01003321
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003323/**
3324 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003326 *
3327 * \note This should always be enabled, it is a security fix to the
3328 * protocol, and should not cause any interoperability issue
3329 * (used only if the peer supports it too).
3330 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003331 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003332 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003333 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003334void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003335#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02003336
Janos Follath088ce432017-04-10 12:42:31 +01003337#if defined(MBEDTLS_SSL_SRV_C)
3338/**
3339 * \brief Whether to send a list of acceptable CAs in
3340 * CertificateRequest messages.
3341 * (Default: do send)
3342 *
3343 * \param conf SSL configuration
3344 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3345 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3346 */
3347void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3348 char cert_req_ca_list );
3349#endif /* MBEDTLS_SSL_SRV_C */
3350
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003351#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003352/**
k-stachowiak6d722122019-02-08 17:03:33 +01003353 * \brief Set the maximum fragment length to emit and/or negotiate.
3354 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3355 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003356 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003357 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003358 * (Client: set maximum fragment length to emit *and*
3359 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003360 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003361 *
k-stachowiak6d722122019-02-08 17:03:33 +01003362 * \note On the client side, the maximum fragment length extension
3363 * *will not* be used, unless the maximum fragment length has
3364 * been set via this function to a value different than
3365 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003366 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003367 * \note With TLS, this currently only affects ApplicationData (sent
3368 * with \c mbedtls_ssl_read()), not handshake messages.
3369 * With DTLS, this affects both ApplicationData and handshake.
3370 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003371 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003372 * excluding record overhead that will be added to it, see
3373 * \c mbedtls_ssl_get_record_expansion().
3374 *
3375 * \note For DTLS, it is also possible to set a limit for the total
3376 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003377 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003378 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003379 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003380 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003381 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3382 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003383 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003384 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003385 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003386int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003387#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003389#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003390/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01003391 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01003392 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003393 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003394 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003395 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
3396 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003397 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003398void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003399#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003400
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003401#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003402/**
3403 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003404 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003405 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003406 * \note Only affects TLS 1.0, not higher versions.
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003407 * Does not affect non-CBC ciphersuites in any version.
3408 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01003409 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003410 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
3411 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003412 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003413void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003414#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003415
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003416#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003417/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003418 * \brief Enable / Disable session tickets (client only).
3419 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003420 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003421 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003422 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003423 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003424 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3425 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003426 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003427void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3428#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003429
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003431/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003432 * \brief Enable / Disable renegotiation support for connection when
3433 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003434 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003435 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003436 * \warning It is recommended to always disable renegotation unless you
3437 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003438 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003439 * renegotiation or a poor understanding of its properties.
3440 *
3441 * \note Server-side, enabling renegotiation also makes the server
3442 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003443 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003444 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003445 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3446 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003447 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003448void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003449#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003450
3451/**
3452 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003453 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003454 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003455 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003456 * be established even if the peer does not support
3457 * secure renegotiation, but does not allow renegotiation
3458 * to take place if not secure.
3459 * (Interoperable and secure option)
3460 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003462 * with non-upgraded peers. Allowing legacy renegotiation
3463 * makes the connection vulnerable to specific man in the
3464 * middle attacks. (See RFC 5746)
3465 * (Most interoperable and least secure option)
3466 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003467 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003468 * if peer does not support secure renegotiation. Results
3469 * in interoperability issues with non-upgraded peers
3470 * that do not support renegotiation altogether.
3471 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003472 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003473 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003474 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3475 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003476 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003477 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003478void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003480#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003481/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003482 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003483 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003484 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003485 * When we request a renegotiation, the peer can comply or
3486 * ignore the request. This function allows us to decide
3487 * whether to enforce our renegotiation requests by closing
3488 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003489 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003490 * However, records could already be in transit from the peer
3491 * when the request is emitted. In order to increase
3492 * reliability, we can accept a number of records before the
3493 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003494 *
3495 * The optimal value is highly dependent on the specific usage
3496 * scenario.
3497 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003498 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003499 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003500 * out or receives Application Data, until:
3501 * - max_records records have beens seen, if it is >= 0, or
3502 * - the number of retransmits that would happen during an
3503 * actual handshake has been reached.
3504 * Please remember the request might be lost a few times
3505 * if you consider setting max_records to a really low value.
3506 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003507 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003508 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003509 * which always behave as if max_record was 0. The reason is,
3510 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003511 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003512 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003513 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003514 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003515 * enforce renegotiation, or a non-negative value to enforce
3516 * it but allow for a grace period of max_records records.
3517 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003518void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003519
3520/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003521 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003522 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003523 *
3524 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003525 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003526 * threshold. The default value is meant to prevent the
3527 * connection from being closed when the counter is about to
3528 * reached its maximal value (it is not allowed to wrap).
3529 *
3530 * Lower values can be used to enforce policies such as "keys
3531 * must be refreshed every N packets with cipher X".
3532 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003533 * The renegotiation period can be disabled by setting
3534 * conf->disable_renegotiation to
3535 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3536 *
3537 * \note When the configured transport is
3538 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3539 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3540 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003541 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003542 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003543 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003544 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003545void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003546 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003547#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003548
Paul Bakker43ca69c2011-01-15 17:35:19 +00003549/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003550 * \brief Check if there is data already read from the
3551 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003552 *
3553 * \param ssl SSL context
3554 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003555 * \return 0 if nothing's pending, 1 otherwise.
3556 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003557 * \note This is different in purpose and behaviour from
3558 * \c mbedtls_ssl_get_bytes_avail in that it considers
3559 * any kind of unprocessed data, not only unread
3560 * application data. If \c mbedtls_ssl_get_bytes
3561 * returns a non-zero value, this function will
3562 * also signal pending data, but the converse does
3563 * not hold. For example, in DTLS there might be
3564 * further records waiting to be processed from
3565 * the current underlying transport's datagram.
3566 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003567 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003568 * does not imply that a subsequent call to
3569 * \c mbedtls_ssl_read will provide any data;
3570 * e.g., the unprocessed data might turn out
3571 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003572 *
3573 * \note This function is useful in the following situation:
3574 * If the SSL/TLS module successfully returns from an
3575 * operation - e.g. a handshake or an application record
3576 * read - and you're awaiting incoming data next, you
3577 * must not immediately idle on the underlying transport
3578 * to have data ready, but you need to check the value
3579 * of this function first. The reason is that the desired
3580 * data might already be read but not yet processed.
3581 * If, in contrast, a previous call to the SSL/TLS module
3582 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3583 * to call this function, as the latter error code entails
3584 * that all internal data has been processed.
3585 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003586 */
3587int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3588
3589/**
3590 * \brief Return the number of application data bytes
3591 * remaining to be read from the current record.
3592 *
3593 * \param ssl SSL context
3594 *
3595 * \return How many bytes are available in the application
3596 * data record read buffer.
3597 *
3598 * \note When working over a datagram transport, this is
3599 * useful to detect the current datagram's boundary
3600 * in case \c mbedtls_ssl_read has written the maximal
3601 * amount of data fitting into the input buffer.
3602 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003604size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003605
3606/**
3607 * \brief Return the result of the certificate verification
3608 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003609 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003610 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003611 * \return \c 0 if the certificate verification was successful.
3612 * \return \c -1u if the result is not available. This may happen
3613 * e.g. if the handshake aborts early, or a verification
3614 * callback returned a fatal error.
3615 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3616 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003617 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003618uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003619
3620/**
3621 * \brief Return the name of the current ciphersuite
3622 *
3623 * \param ssl SSL context
3624 *
3625 * \return a string containing the ciphersuite name
3626 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003627const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003628
3629/**
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003630 * \brief Return the current TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003631 *
3632 * \param ssl SSL context
3633 *
Mateusz Starzyk06b07fb2021-02-18 13:55:21 +01003634 * \return a string containing the TLS version
Paul Bakker43ca69c2011-01-15 17:35:19 +00003635 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003636const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003637
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003638/**
3639 * \brief Return the (maximum) number of bytes added by the record
3640 * layer: header + encryption/MAC overhead (inc. padding)
3641 *
3642 * \param ssl SSL context
3643 *
Mateusz Starzyka3a99842021-02-19 14:27:22 +01003644 * \return Current maximum record expansion in bytes
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003645 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003646int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003647
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003648/**
3649 * \brief Return the current maximum outgoing record payload in bytes.
Hanno Beckerbe746942021-04-21 06:18:37 +01003650 * This takes into account various factors, such as the config.h
3651 * setting \c MBEDTLS_SSL_OUT_CONTENT_LEN, extensions such as the
3652 * max fragment length or record size limit extension if used, and
3653 * for DTLS the path MTU as configured and current record expansion.
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003654 *
3655 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3656 * called with a larger length value.
3657 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3658 * necessary and return the number of bytes written; it is up
3659 * to the caller to call \c mbedtls_ssl_write() again in
3660 * order to send the remaining bytes if any.
3661 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003662 * \sa mbedtls_ssl_set_mtu()
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003663 * \sa mbedtls_ssl_get_output_max_frag_len()
3664 * \sa mbedtls_ssl_get_input_max_frag_len()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003665 * \sa mbedtls_ssl_get_record_expansion()
3666 *
3667 * \param ssl SSL context
3668 *
3669 * \return Current maximum payload for an outgoing record,
3670 * or a negative error code.
3671 */
3672int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3673
Hanno Becker2d8e99b2021-04-21 06:19:50 +01003674/**
3675 * \brief Return the current maximum incoming record payload in bytes.
3676 * This takes into account various factors, such as the
3677 * config.h setting \c MBEDTLS_SSL_IN_CONTENT_LEN, extensions
3678 * such as the max fragment length extension or record size limit
3679 * extension if used, and the current record expansion.
3680 *
3681 * \note With DTLS, \c mbedtls_ssl_read() will return an error if
3682 * called with a larger length value.
3683 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3684 * necessary and return the number of bytes written; it is up
3685 * to the caller to call \c mbedtls_ssl_write() again in
3686 * order to send the remaining bytes if any.
3687 *
3688 * \sa mbedtls_ssl_set_mtu()
3689 * \sa mbedtls_ssl_get_output_max_frag_len()
3690 * \sa mbedtls_ssl_get_input_max_frag_len()
3691 * \sa mbedtls_ssl_get_record_expansion()
3692 *
3693 * \param ssl SSL context
3694 *
3695 * \return Current maximum payload for an outgoing record,
3696 * or a negative error code.
3697 */
3698int mbedtls_ssl_get_max_in_record_payload( const mbedtls_ssl_context *ssl );
3699
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003700#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003701/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003702 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003703 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003704 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003705 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003706 * \return The current peer certificate, if available.
3707 * The returned certificate is owned by the SSL context and
3708 * is valid only until the next call to the SSL API.
3709 * \return \c NULL if no peer certificate is available. This might
3710 * be because the chosen ciphersuite doesn't use CRTs
3711 * (PSK-based ciphersuites, for example), or because
3712 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3713 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003714 *
3715 * \note For one-time inspection of the peer's certificate during
3716 * the handshake, consider registering an X.509 CRT verification
3717 * callback through mbedtls_ssl_conf_verify() instead of calling
3718 * this function. Using mbedtls_ssl_conf_verify() also comes at
3719 * the benefit of allowing you to influence the verification
3720 * process, for example by masking expected and tolerated
3721 * verification failures.
3722 *
3723 * \warning You must not use the pointer returned by this function
3724 * after any further call to the SSL API, including
3725 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3726 * because the pointer might change during renegotiation,
3727 * which happens transparently to the user.
3728 * If you want to use the certificate across API calls,
3729 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003730 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003731const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3732#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003733
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003734#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003735/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003736 * \brief Save session in order to resume it later (client-side only)
3737 * Session data is copied to presented session structure.
3738 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003739 *
3740 * \param ssl SSL context
3741 * \param session session context
3742 *
3743 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003744 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003745 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003746 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003747 *
Ron Eldor00115032018-07-17 11:21:50 +03003748 * \note Only the server certificate is copied, and not the full chain,
3749 * so you should not attempt to validate the certificate again
3750 * by calling \c mbedtls_x509_crt_verify() on it.
3751 * Instead, you should use the results from the verification
3752 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3753 * after loading the session again into a new SSL context
3754 * using \c mbedtls_ssl_set_session().
3755 *
3756 * \note Once the session object is not needed anymore, you should
3757 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003758 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003759 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003760 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003761int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3762#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003763
3764/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003765 * \brief Perform the SSL handshake
3766 *
3767 * \param ssl SSL context
3768 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003769 * \return \c 0 if successful.
3770 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003771 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003772 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003773 * transport - in this case you must call this function again
3774 * when the underlying transport is ready for the operation.
3775 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3776 * operation is in progress (see
3777 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3778 * must call this function again when the operation is ready.
3779 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3780 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3781 * in this case you must call this function again to complete
3782 * the handshake when you're done attending other tasks.
3783 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3784 * and the client did not demonstrate reachability yet - in
3785 * this case you must stop using the context (see below).
3786 * \return Another SSL error code - in this case you must stop using
3787 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003788 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003789 * \warning If this function returns something other than
3790 * \c 0,
3791 * #MBEDTLS_ERR_SSL_WANT_READ,
3792 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3793 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3794 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3795 * you must stop using the SSL context for reading or writing,
3796 * and either free it or call \c mbedtls_ssl_session_reset()
3797 * on it before re-using it for a new connection; the current
3798 * connection must be closed.
3799 *
3800 * \note If DTLS is in use, then you may choose to handle
3801 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3802 * purposes, as it is an expected return value rather than an
3803 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003804 *
3805 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003806 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003807 * from the underlying transport layer is currently being processed,
3808 * and it is safe to idle until the timer or the underlying transport
3809 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003810 * in which case the datagram of the underlying transport that is
3811 * currently being processed might or might not contain further
3812 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003813 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003814int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003815
3816/**
Paul Bakker1961b702013-01-25 14:49:24 +01003817 * \brief Perform a single step of the SSL handshake
3818 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003819 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003820 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003821 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003822 *
3823 * \param ssl SSL context
3824 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003825 * \return See mbedtls_ssl_handshake().
3826 *
3827 * \warning If this function returns something other than \c 0,
3828 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3829 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3830 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3831 * the SSL context for reading or writing, and either free it
3832 * or call \c mbedtls_ssl_session_reset() on it before
3833 * re-using it for a new connection; the current connection
3834 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003835 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003836int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003837
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003838#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003839/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003840 * \brief Initiate an SSL renegotiation on the running connection.
3841 * Client: perform the renegotiation right now.
3842 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003843 * during the next call to mbedtls_ssl_read() if honored by
3844 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003845 *
3846 * \param ssl SSL context
3847 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003848 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003849 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3850 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003851 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003852 * \warning If this function returns something other than \c 0,
3853 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3854 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3855 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3856 * the SSL context for reading or writing, and either free it
3857 * or call \c mbedtls_ssl_session_reset() on it before
3858 * re-using it for a new connection; the current connection
3859 * must be closed.
3860 *
Paul Bakker48916f92012-09-16 19:57:18 +00003861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003862int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3863#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003864
3865/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003866 * \brief Read at most 'len' application data bytes
3867 *
3868 * \param ssl SSL context
3869 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003870 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003871 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003872 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003873 * \return \c 0 if the read end of the underlying transport was closed
Andrzej Kurek03da0842020-03-17 11:11:36 -04003874 * without sending a CloseNotify beforehand, which might happen
3875 * because of various reasons (internal error of an underlying
3876 * stack, non-conformant peer not sending a CloseNotify and
3877 * such) - in this case you must stop using the context
3878 * (see below).
3879 * \return #MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY if the underlying
3880 * transport is still functional, but the peer has
3881 * acknowledged to not send anything anymore.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003882 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003883 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003884 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003885 * transport - in this case you must call this function again
3886 * when the underlying transport is ready for the operation.
3887 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3888 * operation is in progress (see
3889 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3890 * must call this function again when the operation is ready.
3891 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3892 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3893 * in this case you must call this function again to complete
3894 * the handshake when you're done attending other tasks.
3895 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3896 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003897 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003898 * \return Another SSL error code - in this case you must stop using
3899 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003900 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003901 * \warning If this function returns something other than
3902 * a positive value,
3903 * #MBEDTLS_ERR_SSL_WANT_READ,
3904 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3905 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3906 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3907 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3908 * you must stop using the SSL context for reading or writing,
3909 * and either free it or call \c mbedtls_ssl_session_reset()
3910 * on it before re-using it for a new connection; the current
3911 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003912 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003913 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003914 * (which can only happen server-side), it means that a client
3915 * is initiating a new connection using the same source port.
3916 * You can either treat that as a connection close and wait
3917 * for the client to resend a ClientHello, or directly
3918 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003919 * context (as it has been reset internally). Either way, you
3920 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003921 * connection: application state, if any, should be reset, and
3922 * most importantly the identity of the client must be checked
3923 * again. WARNING: not validating the identity of the client
3924 * again, or not transmitting the new identity to the
3925 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003926 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003927 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003928 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003929 * from the underlying transport layer is currently being processed,
3930 * and it is safe to idle until the timer or the underlying transport
3931 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003932 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3933 * initially available on the underlying transport, as this data may have
3934 * been only e.g. duplicated messages or a renegotiation request.
3935 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3936 * when reacting to an incoming-data event from the underlying transport.
3937 * - On success, the datagram of the underlying transport that is currently
3938 * being processed may contain further DTLS records. You should call
3939 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003940 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003942int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003943
3944/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003945 * \brief Try to write exactly 'len' application data bytes
3946 *
3947 * \warning This function will do partial writes in some cases. If the
3948 * return value is non-negative but less than length, the
3949 * function must be called again with updated arguments:
3950 * buf + ret, len - ret (if ret is the return value) until
3951 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003952 *
3953 * \param ssl SSL context
3954 * \param buf buffer holding the data
3955 * \param len how many bytes must be written
3956 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003957 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003958 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003959 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003960 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003961 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003962 * transport - in this case you must call this function again
3963 * when the underlying transport is ready for the operation.
3964 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3965 * operation is in progress (see
3966 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3967 * must call this function again when the operation is ready.
3968 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3969 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3970 * in this case you must call this function again to complete
3971 * the handshake when you're done attending other tasks.
3972 * \return Another SSL error code - in this case you must stop using
3973 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003974 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003975 * \warning If this function returns something other than
3976 * a non-negative value,
3977 * #MBEDTLS_ERR_SSL_WANT_READ,
3978 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3979 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3980 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3981 * you must stop using the SSL context for reading or writing,
3982 * and either free it or call \c mbedtls_ssl_session_reset()
3983 * on it before re-using it for a new connection; the current
3984 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003985 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003986 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003987 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003988 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003989 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003990 * some partial data in the output buffer, however this is not
3991 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003992 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003993 * \note If the requested length is greater than the maximum
3994 * fragment length (either the built-in limit or the one set
3995 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003996 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003997 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Andrzej Kurek90c6e842020-04-03 05:25:29 -04003998 * \c mbedtls_ssl_get_output_max_frag_len() may be used to
3999 * query the active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01004000 *
4001 * \note Attempting to write 0 bytes will result in an empty TLS
4002 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00004003 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004004int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00004005
4006/**
Paul Bakker0a925182012-04-16 06:46:41 +00004007 * \brief Send an alert message
4008 *
4009 * \param ssl SSL context
4010 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004011 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00004012 * \param message The alert message (SSL_ALERT_MSG_*)
4013 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00004014 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004015 *
4016 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004017 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4018 * the SSL context for reading or writing, and either free it or
4019 * call \c mbedtls_ssl_session_reset() on it before re-using it
4020 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00004021 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004022int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00004023 unsigned char level,
4024 unsigned char message );
4025/**
Paul Bakker5121ce52009-01-03 21:22:43 +00004026 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004027 *
4028 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01004029 *
4030 * \return 0 if successful, or a specific SSL error code.
4031 *
4032 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00004033 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
4034 * the SSL context for reading or writing, and either free it or
4035 * call \c mbedtls_ssl_session_reset() on it before re-using it
4036 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00004037 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004038int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00004039
4040/**
Paul Bakker48916f92012-09-16 19:57:18 +00004041 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00004042 *
4043 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00004044 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004045void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00004046
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004047#if defined(MBEDTLS_SSL_CONTEXT_SERIALIZATION)
Paul Bakker48916f92012-09-16 19:57:18 +00004048/**
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004049 * \brief Save an active connection as serialized data in a buffer.
4050 * This allows the freeing or re-using of the SSL context
4051 * while still picking up the connection later in a way that
4052 * it entirely transparent to the peer.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004053 *
4054 * \see mbedtls_ssl_context_load()
4055 *
4056 * \note This feature is currently only available under certain
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004057 * conditions, see the documentation of the return value
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004058 * #MBEDTLS_ERR_SSL_BAD_INPUT_DATA for details.
4059 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004060 * \note When this function succeeds, it calls
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004061 * mbedtls_ssl_session_reset() on \p ssl which as a result is
4062 * no longer associated with the connection that has been
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004063 * serialized. This avoids creating copies of the connection
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004064 * state. You're then free to either re-use the context
4065 * structure for a different connection, or call
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004066 * mbedtls_ssl_free() on it. See the documentation of
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004067 * mbedtls_ssl_session_reset() for more details.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004068 *
4069 * \param ssl The SSL context to save. On success, it is no longer
4070 * associated with the connection that has been serialized.
4071 * \param buf The buffer to write the serialized data to. It must be a
Jarno Lamsab9ca1b02019-08-20 12:05:57 +03004072 * writeable buffer of at least \p buf_len bytes, or may be \c
4073 * NULL if \p buf_len is \c 0.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004074 * \param buf_len The number of bytes available for writing in \p buf.
4075 * \param olen The size in bytes of the data that has been or would have
4076 * been written. It must point to a valid \c size_t.
4077 *
4078 * \note \p olen is updated to the correct value regardless of
4079 * whether \p buf_len was large enough. This makes it possible
4080 * to determine the necessary size by calling this function
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004081 * with \p buf set to \c NULL and \p buf_len to \c 0. However,
4082 * the value of \p olen is only guaranteed to be correct when
4083 * the function returns #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL or
4084 * \c 0. If the return value is different, then the value of
4085 * \p olen is undefined.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004086 *
4087 * \return \c 0 if successful.
4088 * \return #MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL if \p buf is too small.
Manuel Pégourié-Gonnard9df5a822019-07-23 14:51:09 +02004089 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed
4090 * while reseting the context.
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004091 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if a handshake is in
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004092 * progress, or there is pending data for reading or sending,
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004093 * or the connection does not use DTLS 1.2 with an AEAD
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004094 * ciphersuite, or renegotiation is enabled.
4095 */
4096int mbedtls_ssl_context_save( mbedtls_ssl_context *ssl,
4097 unsigned char *buf,
4098 size_t buf_len,
4099 size_t *olen );
Manuel Pégourié-Gonnard1aaf6692019-07-10 14:14:05 +02004100
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004101/**
4102 * \brief Load serialized connection data to an SSL context.
4103 *
4104 * \see mbedtls_ssl_context_save()
4105 *
4106 * \warning The same serialized data must never be loaded into more
4107 * that one context. In order to ensure that, after
4108 * successfully loading serialized data to an SSL context, you
4109 * should immediately destroy or invalidate all copies of the
4110 * serialized data that was loaded. Loading the same data in
4111 * more than one context would cause severe security failures
4112 * including but not limited to loss of confidentiality.
4113 *
4114 * \note Before calling this function, the SSL context must be
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004115 * prepared in one of the two following ways. The first way is
4116 * to take a context freshly initialised with
4117 * mbedtls_ssl_init() and call mbedtls_ssl_setup() on it with
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004118 * the same ::mbedtls_ssl_config structure that was used in
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004119 * the original connection. The second way is to
4120 * call mbedtls_ssl_session_reset() on a context that was
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004121 * previously prepared as above but used in the meantime.
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004122 * Either way, you must not use the context to perform a
4123 * handshake between calling mbedtls_ssl_setup() or
4124 * mbedtls_ssl_session_reset() and calling this function. You
4125 * may however call other setter functions in that time frame
4126 * as indicated in the note below.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004127 *
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004128 * \note Before or after calling this function successfully, you
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004129 * also need to configure some connection-specific callbacks
Manuel Pégourié-Gonnard6d8f1282019-06-05 09:47:18 +02004130 * and settings before you can use the connection again
4131 * (unless they were already set before calling
4132 * mbedtls_ssl_session_reset() and the values are suitable for
4133 * the present connection). Specifically, you want to call
Manuel Pégourié-Gonnard13c8e682019-07-15 12:23:22 +02004134 * at least mbedtls_ssl_set_bio() and
4135 * mbedtls_ssl_set_timer_cb(). All other SSL setter functions
4136 * are not necessary to call, either because they're only used
4137 * in handshakes, or because the setting is already saved. You
4138 * might choose to call them anyway, for example in order to
4139 * share code between the cases of establishing a new
Manuel Pégourié-Gonnardd0a86f92019-06-11 11:25:10 +02004140 * connection and the case of loading an already-established
4141 * connection.
4142 *
4143 * \note If you have new information about the path MTU, you want to
4144 * call mbedtls_ssl_set_mtu() after calling this function, as
4145 * otherwise this function would overwrite your
4146 * newly-configured value with the value that was active when
4147 * the context was saved.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004148 *
Manuel Pégourié-Gonnard4b7e6b92019-07-11 12:50:53 +02004149 * \note When this function returns an error code, it calls
4150 * mbedtls_ssl_free() on \p ssl. In this case, you need to
4151 * prepare the context with the usual sequence starting with a
4152 * call to mbedtls_ssl_init() if you want to use it again.
4153 *
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004154 * \param ssl The SSL context structure to be populated. It must have
4155 * been prepared as described in the note above.
4156 * \param buf The buffer holding the serialized connection data. It must
4157 * be a readable buffer of at least \p len bytes.
4158 * \param len The size of the serialized data in bytes.
4159 *
4160 * \return \c 0 if successful.
4161 * \return #MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed.
Manuel Pégourié-Gonnard4c90e852019-07-11 10:58:10 +02004162 * \return #MBEDTLS_ERR_SSL_VERSION_MISMATCH if the serialized data
4163 * comes from a different Mbed TLS version or build.
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004164 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if input data is invalid.
4165 */
4166int mbedtls_ssl_context_load( mbedtls_ssl_context *ssl,
4167 const unsigned char *buf,
4168 size_t len );
Manuel Pégourié-Gonnard5c0e3772019-07-23 16:13:17 +02004169#endif /* MBEDTLS_SSL_CONTEXT_SERIALIZATION */
Manuel Pégourié-Gonnardac87e282019-05-28 13:02:16 +02004170
4171/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004172 * \brief Initialize an SSL configuration context
4173 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004174 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004175 *
4176 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01004177 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004178 *
4179 * \param conf SSL configuration context
4180 */
4181void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
4182
4183/**
4184 * \brief Load reasonnable default SSL configuration values.
4185 * (You need to call mbedtls_ssl_config_init() first.)
4186 *
4187 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004188 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
4189 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
4190 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004191 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004192 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02004193 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01004194 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004195 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02004196 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004197 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02004198int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02004199 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02004200
4201/**
4202 * \brief Free an SSL configuration context
4203 *
4204 * \param conf SSL configuration context
4205 */
4206void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
4207
4208/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004209 * \brief Initialize SSL session structure
4210 *
4211 * \param session SSL session
4212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004213void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02004214
4215/**
Paul Bakker0a597072012-09-25 21:55:46 +00004216 * \brief Free referenced items in an SSL session including the
4217 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00004218 *
Ron Eldor00115032018-07-17 11:21:50 +03004219 * \note A session object can be freed even if the SSL context
4220 * that was used to retrieve the session is still in use.
4221 *
Paul Bakker48916f92012-09-16 19:57:18 +00004222 * \param session SSL session
4223 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02004224void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00004225
Ron Eldor51d3ab52019-05-12 14:54:30 +03004226/**
4227 * \brief TLS-PRF function for key derivation.
4228 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004229 * \param prf The tls_prf type function type to be used.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004230 * \param secret Secret for the key derivation function.
4231 * \param slen Length of the secret.
4232 * \param label String label for the key derivation function,
4233 * terminated with null character.
4234 * \param random Random bytes.
4235 * \param rlen Length of the random bytes buffer.
4236 * \param dstbuf The buffer holding the derived key.
4237 * \param dlen Length of the output buffer.
4238 *
Tobias Nießen1e8ca122021-05-10 19:53:15 +02004239 * \return 0 on success. An SSL specific error on failure.
Ron Eldor51d3ab52019-05-12 14:54:30 +03004240 */
4241int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
4242 const unsigned char *secret, size_t slen,
4243 const char *label,
4244 const unsigned char *random, size_t rlen,
4245 unsigned char *dstbuf, size_t dlen );
4246
Paul Bakker5121ce52009-01-03 21:22:43 +00004247#ifdef __cplusplus
4248}
4249#endif
4250
4251#endif /* ssl.h */