4 * \brief SSL/TLS functions.
6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
7 * SPDX-License-Identifier: Apache-2.0
9 * Licensed under the Apache License, Version 2.0 (the "License"); you may
10 * not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * This file is part of mbed TLS (https://tls.mbed.org)
26 #if !defined(MBEDTLS_CONFIG_FILE)
29 #include MBEDTLS_CONFIG_FILE
35 #include "ssl_ciphersuites.h"
37 #if defined(MBEDTLS_X509_CRT_PARSE_C)
42 #if defined(MBEDTLS_DHM_C)
46 #if defined(MBEDTLS_ECDH_C)
50 #if defined(MBEDTLS_ZLIB_SUPPORT)
54 #if defined(MBEDTLS_HAVE_TIME)
55 #include "mbedtls/platform_time.h"
61 #define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
62 #define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
63 #define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
64 #define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
65 #define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
66 #define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
67 #define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
68 #define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
69 #define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
70 #define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
71 #define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
72 #define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
73 #define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
74 #define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
75 #define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
76 #define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
77 #define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
78 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
79 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
80 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
81 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
82 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
83 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
84 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
85 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
86 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
87 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
88 #define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
89 #define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
90 #define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
91 #define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
92 #define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
93 #define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
94 #define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
95 #define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
96 #define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
97 #define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
98 #define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
99 #define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
100 #define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
101 #define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
102 #define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
103 #define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
104 #define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
105 #define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< Connection requires a read call. */
106 #define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
107 #define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
108 #define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */
109 #define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
110 #define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
111 #define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */
116 #define MBEDTLS_SSL_MAJOR_VERSION_3 3
117 #define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
118 #define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
119 #define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
120 #define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
122 #define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
123 #define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
125 #define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
127 /* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
128 * NONE must be zero so that memset()ing structure to zero works */
129 #define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
130 #define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
131 #define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
132 #define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
133 #define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
134 #define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
136 #define MBEDTLS_SSL_IS_CLIENT 0
137 #define MBEDTLS_SSL_IS_SERVER 1
139 #define MBEDTLS_SSL_IS_NOT_FALLBACK 0
140 #define MBEDTLS_SSL_IS_FALLBACK 1
142 #define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
143 #define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
145 #define MBEDTLS_SSL_ETM_DISABLED 0
146 #define MBEDTLS_SSL_ETM_ENABLED 1
148 #define MBEDTLS_SSL_COMPRESS_NULL 0
149 #define MBEDTLS_SSL_COMPRESS_DEFLATE 1
151 #define MBEDTLS_SSL_VERIFY_NONE 0
152 #define MBEDTLS_SSL_VERIFY_OPTIONAL 1
153 #define MBEDTLS_SSL_VERIFY_REQUIRED 2
154 #define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
156 #define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
157 #define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
159 #define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
160 #define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
162 #define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
163 #define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
165 #define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
166 #define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
168 #define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
169 #define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
170 #define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
172 #define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
173 #define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
174 #define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
176 #define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
177 #define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
179 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
180 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
182 #define MBEDTLS_SSL_ARC4_ENABLED 0
183 #define MBEDTLS_SSL_ARC4_DISABLED 1
185 #define MBEDTLS_SSL_PRESET_DEFAULT 0
186 #define MBEDTLS_SSL_PRESET_SUITEB 2
189 * Default range for DTLS retransmission timer value, in milliseconds.
190 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
192 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
193 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
196 * \name SECTION: Module settings
198 * The configuration options you can set for this module are in this section.
199 * Either change them in config.h or define them on the compiler command line.
203 #if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
204 #define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
208 * Maxium fragment length in bytes,
209 * determines the size of each of the two internal I/O buffers.
211 * Note: the RFC defines the default size of SSL / TLS messages. If you
212 * change the value here, other clients / servers may not be able to
213 * communicate with you anymore. Only change this value if you control
214 * both sides of the connection and have it reduced at both sides, or
215 * if you're using the Max Fragment Length extension and you know all your
216 * peers are using it too!
218 #if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
219 #define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
222 /* \} name SECTION: Module settings */
225 * Length of the verify data for secure renegotiation
227 #if defined(MBEDTLS_SSL_PROTO_SSL3)
228 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
230 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
234 * Signaling ciphersuite values (SCSV)
236 #define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
237 #define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
240 * Supported Signature and Hash algorithms (For TLS 1.2)
241 * RFC 5246 section 7.4.1.4.1
243 #define MBEDTLS_SSL_HASH_NONE 0
244 #define MBEDTLS_SSL_HASH_MD5 1
245 #define MBEDTLS_SSL_HASH_SHA1 2
246 #define MBEDTLS_SSL_HASH_SHA224 3
247 #define MBEDTLS_SSL_HASH_SHA256 4
248 #define MBEDTLS_SSL_HASH_SHA384 5
249 #define MBEDTLS_SSL_HASH_SHA512 6
251 #define MBEDTLS_SSL_SIG_ANON 0
252 #define MBEDTLS_SSL_SIG_RSA 1
253 #define MBEDTLS_SSL_SIG_ECDSA 3
256 * Client Certificate Types
257 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
259 #define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
260 #define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
263 * Message, alert and handshake types
265 #define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
266 #define MBEDTLS_SSL_MSG_ALERT 21
267 #define MBEDTLS_SSL_MSG_HANDSHAKE 22
268 #define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
270 #define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
271 #define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
273 #define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
274 #define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
275 #define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
276 #define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
277 #define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
278 #define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
279 #define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
280 #define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
281 #define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
282 #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
283 #define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
284 #define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
285 #define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
286 #define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
287 #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
288 #define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
289 #define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
290 #define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
291 #define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
292 #define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
293 #define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
294 #define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
295 #define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
296 #define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
297 #define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
298 #define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
299 #define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
300 #define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
301 #define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
303 #define MBEDTLS_SSL_HS_HELLO_REQUEST 0
304 #define MBEDTLS_SSL_HS_CLIENT_HELLO 1
305 #define MBEDTLS_SSL_HS_SERVER_HELLO 2
306 #define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
307 #define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
308 #define MBEDTLS_SSL_HS_CERTIFICATE 11
309 #define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
310 #define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
311 #define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
312 #define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
313 #define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
314 #define MBEDTLS_SSL_HS_FINISHED 20
319 #define MBEDTLS_TLS_EXT_SERVERNAME 0
320 #define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
322 #define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
324 #define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
326 #define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
327 #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
329 #define MBEDTLS_TLS_EXT_SIG_ALG 13
331 #define MBEDTLS_TLS_EXT_ALPN 16
333 #define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
334 #define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
336 #define MBEDTLS_TLS_EXT_SESSION_TICKET 35
338 #define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
340 #define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
345 #if !defined(MBEDTLS_PSK_MAX_LEN)
346 #define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
349 /* Dummy type used only for its size */
350 union mbedtls_ssl_premaster_secret
352 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
353 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
355 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
356 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
358 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
359 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
360 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
361 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED) || \
362 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ANON_ENABLED)
363 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
365 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
366 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
368 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
369 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
370 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
372 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
373 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
375 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
376 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
377 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
379 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
380 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
384 #define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
395 MBEDTLS_SSL_HELLO_REQUEST,
396 MBEDTLS_SSL_CLIENT_HELLO,
397 MBEDTLS_SSL_SERVER_HELLO,
398 MBEDTLS_SSL_SERVER_CERTIFICATE,
399 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
400 MBEDTLS_SSL_CERTIFICATE_REQUEST,
401 MBEDTLS_SSL_SERVER_HELLO_DONE,
402 MBEDTLS_SSL_CLIENT_CERTIFICATE,
403 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
404 MBEDTLS_SSL_CERTIFICATE_VERIFY,
405 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
406 MBEDTLS_SSL_CLIENT_FINISHED,
407 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
408 MBEDTLS_SSL_SERVER_FINISHED,
409 MBEDTLS_SSL_FLUSH_BUFFERS,
410 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
411 MBEDTLS_SSL_HANDSHAKE_OVER,
412 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
413 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
418 * \brief Callback type: send data on the network.
420 * \note That callback may be either blocking or non-blocking.
422 * \param ctx Context for the send callback (typically a file descriptor)
423 * \param buf Buffer holding the data to send
424 * \param len Length of the data to send
426 * \return The callback must return the number of bytes sent if any,
427 * or a non-zero error code.
428 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
429 * must be returned when the operation would block.
431 * \note The callback is allowed to send fewer bytes than requested.
432 * It must always return the number of bytes actually sent.
434 typedef int mbedtls_ssl_send_t( void *ctx,
435 const unsigned char *buf,
439 * \brief Callback type: receive data from the network.
441 * \note That callback may be either blocking or non-blocking.
443 * \param ctx Context for the receive callback (typically a file
445 * \param buf Buffer to write the received data to
446 * \param len Length of the receive buffer
448 * \return The callback must return the number of bytes received,
449 * or a non-zero error code.
450 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
451 * must be returned when the operation would block.
453 * \note The callback may receive fewer bytes than the length of the
454 * buffer. It must always return the number of bytes actually
455 * received and written to the buffer.
457 typedef int mbedtls_ssl_recv_t( void *ctx,
462 * \brief Callback type: receive data from the network, with timeout
464 * \note That callback must block until data is received, or the
465 * timeout delay expires, or the operation is interrupted by a
468 * \param ctx Context for the receive callback (typically a file descriptor)
469 * \param buf Buffer to write the received data to
470 * \param len Length of the receive buffer
471 * \param timeout Maximum nomber of millisecondes to wait for data
472 * 0 means no timeout (potentially waiting forever)
474 * \return The callback must return the number of bytes received,
475 * or a non-zero error code:
476 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
477 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
479 * \note The callback may receive fewer bytes than the length of the
480 * buffer. It must always return the number of bytes actually
481 * received and written to the buffer.
483 typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
488 * \brief Callback type: set a pair of timers/delays to watch
490 * \param ctx Context pointer
491 * \param int_ms Intermediate delay in milliseconds
492 * \param fin_ms Final delay in milliseconds
493 * 0 cancels the current timer.
495 * \note This callback must at least store the necessary information
496 * for the associated \c mbedtls_ssl_get_timer_t callback to
497 * return correct information.
499 * \note If using a event-driven style of programming, an event must
500 * be generated when the final delay is passed. The event must
501 * cause a call to \c mbedtls_ssl_handshake() with the proper
502 * SSL context to be scheduled. Care must be taken to ensure
503 * that at most one such call happens at a time.
505 * \note Only one timer at a time must be running. Calling this
506 * function while a timer is running must cancel it. Cancelled
507 * timers must not generate any event.
509 typedef void mbedtls_ssl_set_timer_t( void * ctx,
514 * \brief Callback type: get status of timers/delays
516 * \param ctx Context pointer
518 * \return This callback must return:
519 * -1 if cancelled (fin_ms == 0),
520 * 0 if none of the delays have passed,
521 * 1 if only the intermediate delay has passed,
522 * 2 if the final delay has passed.
524 typedef int mbedtls_ssl_get_timer_t( void * ctx );
528 typedef struct mbedtls_ssl_session mbedtls_ssl_session;
529 typedef struct mbedtls_ssl_context mbedtls_ssl_context;
530 typedef struct mbedtls_ssl_config mbedtls_ssl_config;
532 /* Defined in ssl_internal.h */
533 typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
534 typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
535 #if defined(MBEDTLS_X509_CRT_PARSE_C)
536 typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
538 #if defined(MBEDTLS_SSL_PROTO_DTLS)
539 typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
543 * This structure is used for storing current session data.
545 struct mbedtls_ssl_session
547 #if defined(MBEDTLS_HAVE_TIME)
548 mbedtls_time_t start; /*!< starting time */
550 int ciphersuite; /*!< chosen ciphersuite */
551 int compression; /*!< chosen compression */
552 size_t id_len; /*!< session id length */
553 unsigned char id[32]; /*!< session identifier */
554 unsigned char master[48]; /*!< the master secret */
556 #if defined(MBEDTLS_X509_CRT_PARSE_C)
557 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
558 #endif /* MBEDTLS_X509_CRT_PARSE_C */
559 uint32_t verify_result; /*!< verification result */
561 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
562 unsigned char *ticket; /*!< RFC 5077 session ticket */
563 size_t ticket_len; /*!< session ticket length */
564 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
565 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
567 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
568 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
569 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
571 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
572 int trunc_hmac; /*!< flag for truncated hmac activation */
573 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
575 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
576 int encrypt_then_mac; /*!< flag for EtM activation */
581 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
583 struct mbedtls_ssl_config
585 /* Group items by size (largest first) to minimize padding overhead */
591 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
593 /** Callback for printing debug output */
594 void (*f_dbg)(void *, int, const char *, int, const char *);
595 void *p_dbg; /*!< context for the debug function */
597 /** Callback for getting (pseudo-)random numbers */
598 int (*f_rng)(void *, unsigned char *, size_t);
599 void *p_rng; /*!< context for the RNG function */
601 /** Callback to retrieve a session from the cache */
602 int (*f_get_cache)(void *, mbedtls_ssl_session *);
603 /** Callback to store a session into the cache */
604 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
605 void *p_cache; /*!< context for cache callbacks */
607 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
608 /** Callback for setting cert according to SNI extension */
609 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
610 void *p_sni; /*!< context for SNI callback */
613 #if defined(MBEDTLS_X509_CRT_PARSE_C)
614 /** Callback to customize X.509 certificate chain verification */
615 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
616 void *p_vrfy; /*!< context for X.509 verify calllback */
619 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
620 /** Callback to retrieve PSK key from identity */
621 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
622 void *p_psk; /*!< context for PSK callback */
625 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
626 /** Callback to create & write a cookie for ClientHello veirifcation */
627 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
628 const unsigned char *, size_t );
629 /** Callback to verify validity of a ClientHello cookie */
630 int (*f_cookie_check)( void *, const unsigned char *, size_t,
631 const unsigned char *, size_t );
632 void *p_cookie; /*!< context for the cookie callbacks */
635 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
636 /** Callback to create & write a session ticket */
637 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
638 unsigned char *, const unsigned char *, size_t *, uint32_t * );
639 /** Callback to parse a session ticket into a session structure */
640 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
641 void *p_ticket; /*!< context for the ticket callbacks */
642 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
644 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
645 /** Callback to export key block and master secret */
646 int (*f_export_keys)( void *, const unsigned char *,
647 const unsigned char *, size_t, size_t, size_t );
648 void *p_export_keys; /*!< context for key export callback */
651 #if defined(MBEDTLS_X509_CRT_PARSE_C)
652 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
653 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
654 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
655 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
656 #endif /* MBEDTLS_X509_CRT_PARSE_C */
658 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
659 const int *sig_hashes; /*!< allowed signature hashes */
662 #if defined(MBEDTLS_ECP_C)
663 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
666 #if defined(MBEDTLS_DHM_C)
667 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
668 mbedtls_mpi dhm_G; /*!< generator for DHM */
671 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
672 unsigned char *psk; /*!< pre-shared key */
673 size_t psk_len; /*!< length of the pre-shared key */
674 unsigned char *psk_identity; /*!< identity for PSK negotiation */
675 size_t psk_identity_len;/*!< length of identity */
678 #if defined(MBEDTLS_SSL_ALPN)
679 const char **alpn_list; /*!< ordered list of protocols */
683 * Numerical settings (int then char)
686 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
688 #if defined(MBEDTLS_SSL_PROTO_DTLS)
689 uint32_t hs_timeout_min; /*!< initial value of the handshake
690 retransmission timeout (ms) */
691 uint32_t hs_timeout_max; /*!< maximum value of the handshake
692 retransmission timeout (ms) */
695 #if defined(MBEDTLS_SSL_RENEGOTIATION)
696 int renego_max_records; /*!< grace period for renegotiation */
697 unsigned char renego_period[8]; /*!< value of the record counters
698 that triggers renegotiation */
701 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
702 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
705 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
706 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
709 unsigned char max_major_ver; /*!< max. major version used */
710 unsigned char max_minor_ver; /*!< max. minor version used */
711 unsigned char min_major_ver; /*!< min. major version used */
712 unsigned char min_minor_ver; /*!< min. minor version used */
718 unsigned int endpoint : 1; /*!< 0: client, 1: server */
719 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
720 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
721 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
722 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
723 #if defined(MBEDTLS_ARC4_C)
724 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
726 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
727 unsigned int mfl_code : 3; /*!< desired fragment length */
729 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
730 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
732 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
733 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
735 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
736 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
738 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
739 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
741 #if defined(MBEDTLS_SSL_RENEGOTIATION)
742 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
744 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
745 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
747 #if defined(MBEDTLS_SSL_SESSION_TICKETS)
748 unsigned int session_tickets : 1; /*!< use session tickets? */
750 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
751 unsigned int fallback : 1; /*!< is this a fallback? */
756 struct mbedtls_ssl_context
758 const mbedtls_ssl_config *conf; /*!< configuration information */
763 int state; /*!< SSL handshake: current state */
764 #if defined(MBEDTLS_SSL_RENEGOTIATION)
765 int renego_status; /*!< Initial, in progress, pending? */
766 int renego_records_seen; /*!< Records since renego request, or with DTLS,
767 number of retransmissions of request if
768 renego_max_records is < 0 */
771 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
772 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
774 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
775 unsigned badmac_seen; /*!< records with a bad MAC received */
778 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
779 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
780 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
781 /*!< Callback for network receive with timeout */
783 void *p_bio; /*!< context for I/O operations */
788 mbedtls_ssl_session *session_in; /*!< current session data (in) */
789 mbedtls_ssl_session *session_out; /*!< current session data (out) */
790 mbedtls_ssl_session *session; /*!< negotiated session data */
791 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
793 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
794 the handshake process */
797 * Record layer transformations
799 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
800 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
801 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
802 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
807 void *p_timer; /*!< context for the timer callbacks */
809 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
810 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
813 * Record layer (incoming data)
815 unsigned char *in_buf; /*!< input buffer */
816 unsigned char *in_ctr; /*!< 64-bit incoming message counter
817 TLS: maintained by us
818 DTLS: read from peer */
819 unsigned char *in_hdr; /*!< start of record header */
820 unsigned char *in_len; /*!< two-bytes message length field */
821 unsigned char *in_iv; /*!< ivlen-byte IV */
822 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
823 unsigned char *in_offt; /*!< read offset in application data */
825 int in_msgtype; /*!< record header: message type */
826 size_t in_msglen; /*!< record header: message length */
827 size_t in_left; /*!< amount of data read so far */
828 #if defined(MBEDTLS_SSL_PROTO_DTLS)
829 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
830 size_t next_record_offset; /*!< offset of the next record in datagram
831 (equal to in_left if none) */
833 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
834 uint64_t in_window_top; /*!< last validated record seq_num */
835 uint64_t in_window; /*!< bitmask for replay detection */
838 size_t in_hslen; /*!< current handshake message length,
839 including the handshake header */
840 int nb_zero; /*!< # of 0-length encrypted messages */
841 int record_read; /*!< record is already present */
844 * Record layer (outgoing data)
846 unsigned char *out_buf; /*!< output buffer */
847 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
848 unsigned char *out_hdr; /*!< start of record header */
849 unsigned char *out_len; /*!< two-bytes message length field */
850 unsigned char *out_iv; /*!< ivlen-byte IV */
851 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
853 int out_msgtype; /*!< record header: message type */
854 size_t out_msglen; /*!< record header: message length */
855 size_t out_left; /*!< amount of data not yet written */
857 #if defined(MBEDTLS_ZLIB_SUPPORT)
858 unsigned char *compress_buf; /*!< zlib data buffer */
860 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
861 signed char split_done; /*!< current record already splitted? */
867 int client_auth; /*!< flag for client auth. */
872 #if defined(MBEDTLS_X509_CRT_PARSE_C)
873 char *hostname; /*!< expected peer CN for verification
874 (and SNI if available) */
877 #if defined(MBEDTLS_SSL_ALPN)
878 const char *alpn_chosen; /*!< negotiated protocol */
882 * Information for DTLS hello verify
884 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
885 unsigned char *cli_id; /*!< transport-level ID of the client */
886 size_t cli_id_len; /*!< length of cli_id */
890 * Secure renegotiation
892 /* needed to know when to send extension on server */
893 int secure_renegotiation; /*!< does peer support legacy or
894 secure renegotiation */
895 #if defined(MBEDTLS_SSL_RENEGOTIATION)
896 size_t verify_data_len; /*!< length of verify data stored */
897 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
898 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
902 #if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
904 #define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
905 #define MBEDTLS_SSL_CHANNEL_INBOUND 1
907 extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
908 const unsigned char *key_enc, const unsigned char *key_dec,
910 const unsigned char *iv_enc, const unsigned char *iv_dec,
912 const unsigned char *mac_enc, const unsigned char *mac_dec,
914 extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
915 extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
916 extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
917 extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
918 extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
919 #endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
922 * \brief Returns the list of ciphersuites supported by the SSL/TLS module.
924 * \return a statically allocated array of ciphersuites, the last
927 const int *mbedtls_ssl_list_ciphersuites( void );
930 * \brief Return the name of the ciphersuite associated with the
933 * \param ciphersuite_id SSL ciphersuite ID
935 * \return a string containing the ciphersuite name
937 const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
940 * \brief Return the ID of the ciphersuite associated with the
943 * \param ciphersuite_name SSL ciphersuite name
945 * \return the ID with the ciphersuite or 0 if not found
947 int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
950 * \brief Initialize an SSL context
951 * Just makes the context ready for mbedtls_ssl_setup() or
954 * \param ssl SSL context
956 void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
959 * \brief Set up an SSL context for use
961 * \note No copy of the configuration context is made, it can be
962 * shared by many mbedtls_ssl_context structures.
964 * \warning Modifying the conf structure after it has been used in this
965 * function is unsupported!
967 * \param ssl SSL context
968 * \param conf SSL configuration to use
970 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
971 * memory allocation failed
973 int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
974 const mbedtls_ssl_config *conf );
977 * \brief Reset an already initialized SSL context for re-use
978 * while retaining application-set variables, function
981 * \param ssl SSL context
982 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
983 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
984 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
986 int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
989 * \brief Set the current endpoint type
991 * \param conf SSL configuration
992 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
994 void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
997 * \brief Set the transport type (TLS or DTLS).
1000 * \note For DTLS, you must either provide a recv callback that
1001 * doesn't block, or one that handles timeouts, see
1002 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1003 * callbacks with \c mbedtls_ssl_set_timer_cb().
1005 * \param conf SSL configuration
1006 * \param transport transport type:
1007 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1008 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
1010 void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
1013 * \brief Set the certificate verification mode
1014 * Default: NONE on server, REQUIRED on client
1016 * \param conf SSL configuration
1017 * \param authmode can be:
1019 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
1020 * (default on server)
1021 * (insecure on client)
1023 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
1024 * handshake continues even if verification failed;
1025 * mbedtls_ssl_get_verify_result() can be called after the
1026 * handshake is complete.
1028 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
1029 * handshake is aborted if verification failed.
1030 * (default on client)
1032 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1033 * With MBEDTLS_SSL_VERIFY_OPTIONAL, the user needs to call mbedtls_ssl_get_verify_result() at
1034 * the right time(s), which may not be obvious, while REQUIRED always perform
1035 * the verification as soon as possible. For example, REQUIRED was protecting
1036 * against the "triple handshake" attack even before it was found.
1038 void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
1040 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1042 * \brief Set the verification callback (Optional).
1044 * If set, the verify callback is called for each
1045 * certificate in the chain. For implementation
1046 * information, please see \c mbedtls_x509_crt_verify()
1048 * \param conf SSL configuration
1049 * \param f_vrfy verification function
1050 * \param p_vrfy verification parameter
1052 void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
1053 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1055 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1058 * \brief Set the random number generator callback
1060 * \param conf SSL configuration
1061 * \param f_rng RNG function
1062 * \param p_rng RNG parameter
1064 void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
1065 int (*f_rng)(void *, unsigned char *, size_t),
1069 * \brief Set the debug callback
1071 * The callback has the following argument:
1072 * void * opaque context for the callback
1074 * const char * file name
1076 * const char * message
1078 * \param conf SSL configuration
1079 * \param f_dbg debug function
1080 * \param p_dbg debug parameter
1082 void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
1083 void (*f_dbg)(void *, int, const char *, int, const char *),
1087 * \brief Set the underlying BIO callbacks for write, read and
1088 * read-with-timeout.
1090 * \param ssl SSL context
1091 * \param p_bio parameter (context) shared by BIO callbacks
1092 * \param f_send write callback
1093 * \param f_recv read callback
1094 * \param f_recv_timeout blocking read callback with timeout.
1096 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1097 * the other is used. If both are non-NULL, f_recv_timeout is
1098 * used and f_recv is ignored (as if it were NULL).
1100 * \note The two most common use cases are:
1101 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1102 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1104 * \note For DTLS, you need to provide either a non-NULL
1105 * f_recv_timeout callback, or a f_recv that doesn't block.
1107 * \note See the documentations of \c mbedtls_ssl_sent_t,
1108 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
1109 * the conventions those callbacks must follow.
1111 * \note On some platforms, net_sockets.c provides
1112 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1113 * \c mbedtls_net_recv_timeout() that are suitable to be used
1116 void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
1118 mbedtls_ssl_send_t *f_send,
1119 mbedtls_ssl_recv_t *f_recv,
1120 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
1123 * \brief Set the timeout period for mbedtls_ssl_read()
1124 * (Default: no timeout.)
1126 * \param conf SSL configuration context
1127 * \param timeout Timeout value in milliseconds.
1128 * Use 0 for no timeout (default).
1130 * \note With blocking I/O, this will only work if a non-NULL
1131 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
1132 * With non-blocking I/O, this will only work if timer
1133 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1135 * \note With non-blocking I/O, you may also skip this function
1136 * altogether and handle timeouts at the application layer.
1138 void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
1141 * \brief Set the timer callbacks (Mandatory for DTLS.)
1143 * \param ssl SSL context
1144 * \param p_timer parameter (context) shared by timer callbacks
1145 * \param f_set_timer set timer callback
1146 * \param f_get_timer get timer callback. Must return:
1148 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1149 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
1150 * callbacks must fallow.
1152 * \note On some platforms, timing.c provides
1153 * \c mbedtls_timing_set_delay() and
1154 * \c mbedtls_timing_get_delay() that are suitable for using
1155 * here, except if using an event-driven style.
1157 * \note See also the "DTLS tutorial" article in our knowledge base.
1158 * https://tls.mbed.org/kb/how-to/dtls-tutorial
1160 void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1162 mbedtls_ssl_set_timer_t *f_set_timer,
1163 mbedtls_ssl_get_timer_t *f_get_timer );
1166 * \brief Callback type: generate and write session ticket
1168 * \note This describes what a callback implementation should do.
1169 * This callback should generate an encrypted and
1170 * authenticated ticket for the session and write it to the
1171 * output buffer. Here, ticket means the opaque ticket part
1172 * of the NewSessionTicket structure of RFC 5077.
1174 * \param p_ticket Context for the callback
1175 * \param session SSL session to be written in the ticket
1176 * \param start Start of the output buffer
1177 * \param end End of the output buffer
1178 * \param tlen On exit, holds the length written
1179 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1181 * \return 0 if successful, or
1182 * a specific MBEDTLS_ERR_XXX code.
1184 typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1185 const mbedtls_ssl_session *session,
1186 unsigned char *start,
1187 const unsigned char *end,
1189 uint32_t *lifetime );
1191 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
1193 * \brief Callback type: Export key block and master secret
1195 * \note This is required for certain uses of TLS, e.g. EAP-TLS
1196 * (RFC 5216) and Thread. The key pointers are ephemeral and
1197 * therefore must not be stored. The master secret and keys
1198 * should not be used directly except as an input to a key
1199 * derivation function.
1201 * \param p_expkey Context for the callback
1202 * \param ms Pointer to master secret (fixed length: 48 bytes)
1203 * \param kb Pointer to key block, see RFC 5246 section 6.3
1204 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
1205 * \param maclen MAC length
1206 * \param keylen Key length
1207 * \param ivlen IV length
1209 * \return 0 if successful, or
1210 * a specific MBEDTLS_ERR_XXX code.
1212 typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
1213 const unsigned char *ms,
1214 const unsigned char *kb,
1218 #endif /* MBEDTLS_SSL_EXPORT_KEYS */
1221 * \brief Callback type: parse and load session ticket
1223 * \note This describes what a callback implementation should do.
1224 * This callback should parse a session ticket as generated
1225 * by the corresponding mbedtls_ssl_ticket_write_t function,
1226 * and, if the ticket is authentic and valid, load the
1229 * \note The implementation is allowed to modify the first len
1230 * bytes of the input buffer, eg to use it as a temporary
1231 * area for the decrypted ticket contents.
1233 * \param p_ticket Context for the callback
1234 * \param session SSL session to be loaded
1235 * \param buf Start of the buffer containing the ticket
1236 * \param len Length of the ticket.
1238 * \return 0 if successful, or
1239 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1240 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1241 * any other non-zero code for other failures.
1243 typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1244 mbedtls_ssl_session *session,
1248 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
1250 * \brief Configure SSL session ticket callbacks (server only).
1253 * \note On server, session tickets are enabled by providing
1254 * non-NULL callbacks.
1256 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
1258 * \param conf SSL configuration context
1259 * \param f_ticket_write Callback for writing a ticket
1260 * \param f_ticket_parse Callback for parsing a ticket
1261 * \param p_ticket Context shared by the two callbacks
1263 void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1264 mbedtls_ssl_ticket_write_t *f_ticket_write,
1265 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1267 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
1269 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
1271 * \brief Configure key export callback.
1274 * \note See \c mbedtls_ssl_export_keys_t.
1276 * \param conf SSL configuration context
1277 * \param f_export_keys Callback for exporting keys
1278 * \param p_export_keys Context for the callback
1280 void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1281 mbedtls_ssl_export_keys_t *f_export_keys,
1282 void *p_export_keys );
1283 #endif /* MBEDTLS_SSL_EXPORT_KEYS */
1286 * \brief Callback type: generate a cookie
1288 * \param ctx Context for the callback
1289 * \param p Buffer to write to,
1290 * must be updated to point right after the cookie
1291 * \param end Pointer to one past the end of the output buffer
1292 * \param info Client ID info that was passed to
1293 * \c mbedtls_ssl_set_client_transport_id()
1294 * \param ilen Length of info in bytes
1296 * \return The callback must return 0 on success,
1297 * or a negative error code.
1299 typedef int mbedtls_ssl_cookie_write_t( void *ctx,
1300 unsigned char **p, unsigned char *end,
1301 const unsigned char *info, size_t ilen );
1304 * \brief Callback type: verify a cookie
1306 * \param ctx Context for the callback
1307 * \param cookie Cookie to verify
1308 * \param clen Length of cookie
1309 * \param info Client ID info that was passed to
1310 * \c mbedtls_ssl_set_client_transport_id()
1311 * \param ilen Length of info in bytes
1313 * \return The callback must return 0 if cookie is valid,
1314 * or a negative error code.
1316 typedef int mbedtls_ssl_cookie_check_t( void *ctx,
1317 const unsigned char *cookie, size_t clen,
1318 const unsigned char *info, size_t ilen );
1320 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1322 * \brief Register callbacks for DTLS cookies
1323 * (Server only. DTLS only.)
1325 * Default: dummy callbacks that fail, in order to force you to
1326 * register working callbacks (and initialize their context).
1328 * To disable HelloVerifyRequest, register NULL callbacks.
1330 * \warning Disabling hello verification allows your server to be used
1331 * for amplification in DoS attacks against other hosts.
1332 * Only disable if you known this can't happen in your
1333 * particular environment.
1335 * \note See comments on \c mbedtls_ssl_handshake() about handling
1336 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1337 * on the first handshake attempt when this is enabled.
1339 * \note This is also necessary to handle client reconnection from
1340 * the same port as described in RFC 6347 section 4.2.8 (only
1341 * the variant with cookies is supported currently). See
1342 * comments on \c mbedtls_ssl_read() for details.
1344 * \param conf SSL configuration
1345 * \param f_cookie_write Cookie write callback
1346 * \param f_cookie_check Cookie check callback
1347 * \param p_cookie Context for both callbacks
1349 void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
1350 mbedtls_ssl_cookie_write_t *f_cookie_write,
1351 mbedtls_ssl_cookie_check_t *f_cookie_check,
1355 * \brief Set client's transport-level identification info.
1356 * (Server only. DTLS only.)
1358 * This is usually the IP address (and port), but could be
1359 * anything identify the client depending on the underlying
1360 * network stack. Used for HelloVerifyRequest with DTLS.
1361 * This is *not* used to route the actual packets.
1363 * \param ssl SSL context
1364 * \param info Transport-level info identifying the client (eg IP + port)
1365 * \param ilen Length of info in bytes
1367 * \note An internal copy is made, so the info buffer can be reused.
1369 * \return 0 on success,
1370 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
1371 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
1373 int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
1374 const unsigned char *info,
1377 #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
1379 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1381 * \brief Enable or disable anti-replay protection for DTLS.
1382 * (DTLS only, no effect on TLS.)
1385 * \param conf SSL configuration
1386 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
1388 * \warning Disabling this is a security risk unless the application
1389 * protocol handles duplicated packets in a safe way. You
1390 * should not disable this without careful consideration.
1391 * However, if your application already detects duplicated
1392 * packets and needs information about them to adjust its
1393 * transmission strategy, then you'll want to disable this.
1395 void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
1396 #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1398 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1400 * \brief Set a limit on the number of records with a bad MAC
1401 * before terminating the connection.
1402 * (DTLS only, no effect on TLS.)
1403 * Default: 0 (disabled).
1405 * \param conf SSL configuration
1406 * \param limit Limit, or 0 to disable.
1408 * \note If the limit is N, then the connection is terminated when
1409 * the Nth non-authentic record is seen.
1411 * \note Records with an invalid header are not counted, only the
1412 * ones going through the authentication-decryption phase.
1414 * \note This is a security trade-off related to the fact that it's
1415 * often relatively easy for an active attacker ot inject UDP
1416 * datagrams. On one hand, setting a low limit here makes it
1417 * easier for such an attacker to forcibly terminated a
1418 * connection. On the other hand, a high limit or no limit
1419 * might make us waste resources checking authentication on
1420 * many bogus packets.
1422 void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
1423 #endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1425 #if defined(MBEDTLS_SSL_PROTO_DTLS)
1427 * \brief Set retransmit timeout values for the DTLS handshake.
1428 * (DTLS only, no effect on TLS.)
1430 * \param conf SSL configuration
1431 * \param min Initial timeout value in milliseconds.
1432 * Default: 1000 (1 second).
1433 * \param max Maximum timeout value in milliseconds.
1434 * Default: 60000 (60 seconds).
1436 * \note Default values are from RFC 6347 section 4.2.4.1.
1438 * \note The 'min' value should typically be slightly above the
1439 * expected round-trip time to your peer, plus whatever time
1440 * it takes for the peer to process the message. For example,
1441 * if your RTT is about 600ms and you peer needs up to 1s to
1442 * do the cryptographic operations in the handshake, then you
1443 * should set 'min' slightly above 1600. Lower values of 'min'
1444 * might cause spurious resends which waste network resources,
1445 * while larger value of 'min' will increase overall latency
1446 * on unreliable network links.
1448 * \note The more unreliable your network connection is, the larger
1449 * your max / min ratio needs to be in order to achieve
1450 * reliable handshakes.
1452 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
1453 * For example, if min = 1s and max = 5s, the retransmit plan
1454 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
1455 * resend ... 5s -> give up and return a timeout error.
1457 void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
1458 #endif /* MBEDTLS_SSL_PROTO_DTLS */
1460 #if defined(MBEDTLS_SSL_SRV_C)
1462 * \brief Set the session cache callbacks (server-side only)
1463 * If not set, no session resuming is done (except if session
1464 * tickets are enabled too).
1466 * The session cache has the responsibility to check for stale
1467 * entries based on timeout. See RFC 5246 for recommendations.
1469 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1470 * connection shutdown, so do not cache the pointer! Either set
1471 * it to NULL or make a full copy of the certificate.
1473 * The get callback is called once during the initial handshake
1474 * to enable session resuming. The get function has the
1475 * following parameters: (void *parameter, mbedtls_ssl_session *session)
1476 * If a valid entry is found, it should fill the master of
1477 * the session object with the cached values and return 0,
1478 * return 1 otherwise. Optionally peer_cert can be set as well
1479 * if it is properly present in cache entry.
1481 * The set callback is called once during the initial handshake
1482 * to enable session resuming after the entire handshake has
1483 * been finished. The set function has the following parameters:
1484 * (void *parameter, const mbedtls_ssl_session *session). The function
1485 * should create a cache entry for future retrieval based on
1486 * the data in the session structure and should keep in mind
1487 * that the mbedtls_ssl_session object presented (and all its referenced
1488 * data) is cleared by the SSL/TLS layer when the connection is
1489 * terminated. It is recommended to add metadata to determine if
1490 * an entry is still valid in the future. Return 0 if
1491 * successfully cached, return 1 otherwise.
1493 * \param conf SSL configuration
1494 * \param p_cache parmater (context) for both callbacks
1495 * \param f_get_cache session get callback
1496 * \param f_set_cache session set callback
1498 void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
1500 int (*f_get_cache)(void *, mbedtls_ssl_session *),
1501 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
1502 #endif /* MBEDTLS_SSL_SRV_C */
1504 #if defined(MBEDTLS_SSL_CLI_C)
1506 * \brief Request resumption of session (client-side only)
1507 * Session data is copied from presented session structure.
1509 * \param ssl SSL context
1510 * \param session session context
1512 * \return 0 if successful,
1513 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
1514 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
1515 * arguments are otherwise invalid
1517 * \sa mbedtls_ssl_get_session()
1519 int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
1520 #endif /* MBEDTLS_SSL_CLI_C */
1523 * \brief Set the list of allowed ciphersuites and the preference
1524 * order. First in the list has the highest preference.
1525 * (Overrides all version-specific lists)
1527 * The ciphersuites array is not copied, and must remain
1528 * valid for the lifetime of the ssl_config.
1530 * Note: The server uses its own preferences
1531 * over the preference of the client unless
1532 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
1534 * \param conf SSL configuration
1535 * \param ciphersuites 0-terminated list of allowed ciphersuites
1537 void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
1538 const int *ciphersuites );
1541 * \brief Set the list of allowed ciphersuites and the
1542 * preference order for a specific version of the protocol.
1543 * (Only useful on the server side)
1545 * The ciphersuites array is not copied, and must remain
1546 * valid for the lifetime of the ssl_config.
1548 * \param conf SSL configuration
1549 * \param ciphersuites 0-terminated list of allowed ciphersuites
1550 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
1552 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1553 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1554 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
1556 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
1557 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1559 void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
1560 const int *ciphersuites,
1561 int major, int minor );
1563 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1565 * \brief Set the X.509 security profile used for verification
1567 * \note The restrictions are enforced for all certificates in the
1568 * chain. However, signatures in the handshake are not covered
1569 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
1571 * \param conf SSL configuration
1572 * \param profile Profile to use
1574 void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
1575 const mbedtls_x509_crt_profile *profile );
1578 * \brief Set the data required to verify peer certificate
1580 * \param conf SSL configuration
1581 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1582 * \param ca_crl trusted CA CRLs
1584 void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
1585 mbedtls_x509_crt *ca_chain,
1586 mbedtls_x509_crl *ca_crl );
1589 * \brief Set own certificate chain and private key
1591 * \note own_cert should contain in order from the bottom up your
1592 * certificate chain. The top certificate (self-signed)
1595 * \note On server, this function can be called multiple times to
1596 * provision more than one cert/key pair (eg one ECDSA, one
1597 * RSA with SHA-256, one RSA with SHA-1). An adequate
1598 * certificate will be selected according to the client's
1599 * advertised capabilities. In case mutliple certificates are
1600 * adequate, preference is given to the one set by the first
1601 * call to this function, then second, etc.
1603 * \note On client, only the first call has any effect. That is,
1604 * only one client certificate can be provisioned. The
1605 * server's preferences in its CertficateRequest message will
1606 * be ignored and our only cert will be sent regardless of
1607 * whether it matches those preferences - the server can then
1608 * decide what it wants to do with it.
1610 * \param conf SSL configuration
1611 * \param own_cert own public certificate chain
1612 * \param pk_key own private key
1614 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
1616 int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
1617 mbedtls_x509_crt *own_cert,
1618 mbedtls_pk_context *pk_key );
1619 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1621 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1623 * \brief Set the Pre Shared Key (PSK) and the expected identity name
1625 * \note This is mainly useful for clients. Servers will usually
1626 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
1628 * \note Currently clients can only register one pre-shared key.
1629 * In other words, the servers' identity hint is ignored.
1630 * Support for setting multiple PSKs on clients and selecting
1631 * one based on the identity hint is not a planned feature but
1632 * feedback is welcomed.
1634 * \param conf SSL configuration
1635 * \param psk pointer to the pre-shared key
1636 * \param psk_len pre-shared key length
1637 * \param psk_identity pointer to the pre-shared key identity
1638 * \param psk_identity_len identity key length
1640 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
1642 int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
1643 const unsigned char *psk, size_t psk_len,
1644 const unsigned char *psk_identity, size_t psk_identity_len );
1648 * \brief Set the Pre Shared Key (PSK) for the current handshake
1650 * \note This should only be called inside the PSK callback,
1651 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
1653 * \param ssl SSL context
1654 * \param psk pointer to the pre-shared key
1655 * \param psk_len pre-shared key length
1657 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
1659 int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1660 const unsigned char *psk, size_t psk_len );
1663 * \brief Set the PSK callback (server-side only).
1665 * If set, the PSK callback is called for each
1666 * handshake where a PSK ciphersuite was negotiated.
1667 * The caller provides the identity received and wants to
1668 * receive the actual PSK data and length.
1670 * The callback has the following parameters: (void *parameter,
1671 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
1672 * size_t identity_len)
1673 * If a valid PSK identity is found, the callback should use
1674 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
1675 * correct PSK and return 0.
1676 * Any other return value will result in a denied PSK identity.
1678 * \note If you set a PSK callback using this function, then you
1679 * don't need to set a PSK key and identity using
1680 * \c mbedtls_ssl_conf_psk().
1682 * \param conf SSL configuration
1683 * \param f_psk PSK identity function
1684 * \param p_psk PSK identity parameter
1686 void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
1687 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
1690 #endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
1692 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
1694 * \brief Set the Diffie-Hellman public P and G values,
1695 * read as hexadecimal strings (server-side only)
1696 * (Default: MBEDTLS_DHM_RFC5114_MODP_2048_[PG])
1698 * \param conf SSL configuration
1699 * \param dhm_P Diffie-Hellman-Merkle modulus
1700 * \param dhm_G Diffie-Hellman-Merkle generator
1702 * \return 0 if successful
1704 int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf, const char *dhm_P, const char *dhm_G );
1707 * \brief Set the Diffie-Hellman public P and G values,
1708 * read from existing context (server-side only)
1710 * \param conf SSL configuration
1711 * \param dhm_ctx Diffie-Hellman-Merkle context
1713 * \return 0 if successful
1715 int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
1716 #endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
1718 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1720 * \brief Set the minimum length for Diffie-Hellman parameters.
1721 * (Client-side only.)
1722 * (Default: 1024 bits.)
1724 * \param conf SSL configuration
1725 * \param bitlen Minimum bit length of the DHM prime
1727 void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1728 unsigned int bitlen );
1729 #endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1731 #if defined(MBEDTLS_ECP_C)
1733 * \brief Set the allowed curves in order of preference.
1734 * (Default: all defined curves.)
1736 * On server: this only affects selection of the ECDHE curve;
1737 * the curves used for ECDH and ECDSA are determined by the
1738 * list of available certificates instead.
1740 * On client: this affects the list of curves offered for any
1741 * use. The server can override our preference order.
1743 * Both sides: limits the set of curves accepted for use in
1744 * ECDHE and in the peer's end-entity certificate.
1746 * \note This has no influence on which curves are allowed inside the
1747 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
1748 * for that. For the end-entity certificate however, the key
1749 * will be accepted only if it is allowed both by this list
1750 * and by the cert profile.
1752 * \note This list should be ordered by decreasing preference
1753 * (preferred curve first).
1755 * \param conf SSL configuration
1756 * \param curves Ordered list of allowed curves,
1757 * terminated by MBEDTLS_ECP_DP_NONE.
1759 void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
1760 const mbedtls_ecp_group_id *curves );
1761 #endif /* MBEDTLS_ECP_C */
1763 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
1765 * \brief Set the allowed hashes for signatures during the handshake.
1766 * (Default: all available hashes except MD5.)
1768 * \note This only affects which hashes are offered and can be used
1769 * for signatures during the handshake. Hashes for message
1770 * authentication and the TLS PRF are controlled by the
1771 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
1772 * used for certificate signature are controlled by the
1773 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
1775 * \note This list should be ordered by decreasing preference
1776 * (preferred hash first).
1778 * \param conf SSL configuration
1779 * \param hashes Ordered list of allowed signature hashes,
1780 * terminated by \c MBEDTLS_MD_NONE.
1782 void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1783 const int *hashes );
1784 #endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
1786 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1788 * \brief Set the hostname to check against the received server
1789 * certificate. It sets the ServerName TLS extension too,
1790 * if the extension is enabled.
1791 * (client-side only)
1793 * \param ssl SSL context
1794 * \param hostname the server hostname
1796 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
1798 int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
1799 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1801 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1803 * \brief Set own certificate and key for the current handshake
1805 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
1808 * \param ssl SSL context
1809 * \param own_cert own public certificate chain
1810 * \param pk_key own private key
1812 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
1814 int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1815 mbedtls_x509_crt *own_cert,
1816 mbedtls_pk_context *pk_key );
1819 * \brief Set the data required to verify peer certificate for the
1822 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
1825 * \param ssl SSL context
1826 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1827 * \param ca_crl trusted CA CRLs
1829 void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1830 mbedtls_x509_crt *ca_chain,
1831 mbedtls_x509_crl *ca_crl );
1834 * \brief Set authmode for the current handshake.
1836 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
1839 * \param ssl SSL context
1840 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
1841 * MBEDTLS_SSL_VERIFY_REQUIRED
1843 void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1847 * \brief Set server side ServerName TLS extension callback
1848 * (optional, server-side only).
1850 * If set, the ServerName callback is called whenever the
1851 * server receives a ServerName TLS extension from the client
1852 * during a handshake. The ServerName callback has the
1853 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
1854 * const unsigned char *hostname, size_t len). If a suitable
1855 * certificate is found, the callback must set the
1856 * certificate(s) and key(s) to use with \c
1857 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
1858 * and may optionally adjust the CA and associated CRL with \c
1859 * mbedtls_ssl_set_hs_ca_chain() as well as the client
1860 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
1861 * then must return 0. If no matching name is found, the
1862 * callback must either set a default cert, or
1863 * return non-zero to abort the handshake at this point.
1865 * \param conf SSL configuration
1866 * \param f_sni verification function
1867 * \param p_sni verification parameter
1869 void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
1870 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
1873 #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1875 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1877 * \brief Set the EC J-PAKE password for current handshake.
1879 * \note An internal copy is made, and destroyed as soon as the
1880 * handshake is completed, or when the SSL context is reset or
1883 * \note The SSL context needs to be already set up. The right place
1884 * to call this function is between \c mbedtls_ssl_setup() or
1885 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
1887 * \param ssl SSL context
1888 * \param pw EC J-PAKE password (pre-shared secret)
1889 * \param pw_len length of pw in bytes
1891 * \return 0 on success, or a negative error code.
1893 int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1894 const unsigned char *pw,
1896 #endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
1898 #if defined(MBEDTLS_SSL_ALPN)
1900 * \brief Set the supported Application Layer Protocols.
1902 * \param conf SSL configuration
1903 * \param protos Pointer to a NULL-terminated list of supported protocols,
1904 * in decreasing preference order. The pointer to the list is
1905 * recorded by the library for later reference as required, so
1906 * the lifetime of the table must be atleast as long as the
1907 * lifetime of the SSL configuration structure.
1909 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
1911 int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
1914 * \brief Get the name of the negotiated Application Layer Protocol.
1915 * This function should be called after the handshake is
1918 * \param ssl SSL context
1920 * \return Protcol name, or NULL if no protocol was negotiated.
1922 const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
1923 #endif /* MBEDTLS_SSL_ALPN */
1926 * \brief Set the maximum supported version sent from the client side
1927 * and/or accepted at the server side
1928 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
1930 * \note This ignores ciphersuites from higher versions.
1932 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1933 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1935 * \param conf SSL configuration
1936 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1937 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1938 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1939 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
1941 void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
1944 * \brief Set the minimum accepted SSL/TLS protocol version
1945 * (Default: TLS 1.0)
1947 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
1948 * SSL_MIN_XXXXX_VERSION range is ignored.
1950 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
1952 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1953 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1955 * \param conf SSL configuration
1956 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1957 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1958 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1959 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
1961 void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
1963 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1965 * \brief Set the fallback flag (client-side only).
1966 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
1968 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
1969 * connection, that is a connection with max_version set to a
1970 * lower value than the value you're willing to use. Such
1971 * fallback connections are not recommended but are sometimes
1972 * necessary to interoperate with buggy (version-intolerant)
1975 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
1976 * non-fallback connections! This would appear to work for a
1977 * while, then cause failures when the server is upgraded to
1978 * support a newer TLS version.
1980 * \param conf SSL configuration
1981 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
1983 void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
1984 #endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
1986 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1988 * \brief Enable or disable Encrypt-then-MAC
1989 * (Default: MBEDTLS_SSL_ETM_ENABLED)
1991 * \note This should always be enabled, it is a security
1992 * improvement, and should not cause any interoperability
1993 * issue (used only if the peer supports it too).
1995 * \param conf SSL configuration
1996 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
1998 void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
1999 #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
2001 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
2003 * \brief Enable or disable Extended Master Secret negotiation.
2004 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
2006 * \note This should always be enabled, it is a security fix to the
2007 * protocol, and should not cause any interoperability issue
2008 * (used only if the peer supports it too).
2010 * \param conf SSL configuration
2011 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
2013 void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
2014 #endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
2016 #if defined(MBEDTLS_ARC4_C)
2018 * \brief Disable or enable support for RC4
2019 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
2021 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
2022 * for security reasons. Use at your own risk.
2024 * \note This function is deprecated and will likely be removed in
2025 * a future version of the library.
2026 * RC4 is disabled by default at compile time and needs to be
2027 * actively enabled for use with legacy systems.
2029 * \param conf SSL configuration
2030 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
2032 void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
2033 #endif /* MBEDTLS_ARC4_C */
2035 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2037 * \brief Set the maximum fragment length to emit and/or negotiate
2038 * (Default: MBEDTLS_SSL_MAX_CONTENT_LEN, usually 2^14 bytes)
2039 * (Server: set maximum fragment length to emit,
2040 * usually negotiated by the client during handshake
2041 * (Client: set maximum fragment length to emit *and*
2042 * negotiate with the server during handshake)
2044 * \param conf SSL configuration
2045 * \param mfl_code Code for maximum fragment length (allowed values:
2046 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2047 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
2049 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
2051 int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
2052 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2054 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
2056 * \brief Activate negotiation of truncated HMAC
2057 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
2059 * \param conf SSL configuration
2060 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2061 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
2063 void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
2064 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
2066 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
2068 * \brief Enable / Disable 1/n-1 record splitting
2069 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
2071 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2072 * Does not affect non-CBC ciphersuites in any version.
2074 * \param conf SSL configuration
2075 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2076 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
2078 void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
2079 #endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
2081 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
2083 * \brief Enable / Disable session tickets (client only).
2084 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
2086 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
2088 * \param conf SSL configuration
2089 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2090 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
2092 void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
2093 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
2095 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2097 * \brief Enable / Disable renegotiation support for connection when
2099 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
2101 * \warning It is recommended to always disable renegotation unless you
2102 * know you need it and you know what you're doing. In the
2103 * past, there have been several issues associated with
2104 * renegotiation or a poor understanding of its properties.
2106 * \note Server-side, enabling renegotiation also makes the server
2107 * susceptible to a resource DoS by a malicious client.
2109 * \param conf SSL configuration
2110 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
2111 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
2113 void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
2114 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2117 * \brief Prevent or allow legacy renegotiation.
2118 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
2120 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
2121 * be established even if the peer does not support
2122 * secure renegotiation, but does not allow renegotiation
2123 * to take place if not secure.
2124 * (Interoperable and secure option)
2126 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
2127 * with non-upgraded peers. Allowing legacy renegotiation
2128 * makes the connection vulnerable to specific man in the
2129 * middle attacks. (See RFC 5746)
2130 * (Most interoperable and least secure option)
2132 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
2133 * if peer does not support secure renegotiation. Results
2134 * in interoperability issues with non-upgraded peers
2135 * that do not support renegotiation altogether.
2136 * (Most secure option, interoperability issues)
2138 * \param conf SSL configuration
2139 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
2140 * SSL_ALLOW_LEGACY_RENEGOTIATION or
2141 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
2143 void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
2145 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2147 * \brief Enforce renegotiation requests.
2148 * (Default: enforced, max_records = 16)
2150 * When we request a renegotiation, the peer can comply or
2151 * ignore the request. This function allows us to decide
2152 * whether to enforce our renegotiation requests by closing
2153 * the connection if the peer doesn't comply.
2155 * However, records could already be in transit from the peer
2156 * when the request is emitted. In order to increase
2157 * reliability, we can accept a number of records before the
2158 * expected handshake records.
2160 * The optimal value is highly dependent on the specific usage
2163 * \note With DTLS and server-initiated renegotiation, the
2164 * HelloRequest is retransmited every time mbedtls_ssl_read() times
2165 * out or receives Application Data, until:
2166 * - max_records records have beens seen, if it is >= 0, or
2167 * - the number of retransmits that would happen during an
2168 * actual handshake has been reached.
2169 * Please remember the request might be lost a few times
2170 * if you consider setting max_records to a really low value.
2172 * \warning On client, the grace period can only happen during
2173 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
2174 * which always behave as if max_record was 0. The reason is,
2175 * if we receive application data from the server, we need a
2176 * place to write it, which only happens during mbedtls_ssl_read().
2178 * \param conf SSL configuration
2179 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
2180 * enforce renegotiation, or a non-negative value to enforce
2181 * it but allow for a grace period of max_records records.
2183 void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
2186 * \brief Set record counter threshold for periodic renegotiation.
2187 * (Default: 2^64 - 256.)
2189 * Renegotiation is automatically triggered when a record
2190 * counter (outgoing or ingoing) crosses the defined
2191 * threshold. The default value is meant to prevent the
2192 * connection from being closed when the counter is about to
2193 * reached its maximal value (it is not allowed to wrap).
2195 * Lower values can be used to enforce policies such as "keys
2196 * must be refreshed every N packets with cipher X".
2198 * \param conf SSL configuration
2199 * \param period The threshold value: a big-endian 64-bit number.
2200 * Set to 2^64 - 1 to disable periodic renegotiation
2202 void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
2203 const unsigned char period[8] );
2204 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2207 * \brief Return the number of data bytes available to read
2209 * \param ssl SSL context
2211 * \return how many bytes are available in the read buffer
2213 size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
2216 * \brief Return the result of the certificate verification
2218 * \param ssl SSL context
2220 * \return 0 if successful,
2221 * -1 if result is not available (eg because the handshake was
2222 * aborted too early), or
2223 * a combination of BADCERT_xxx and BADCRL_xxx flags, see
2226 uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
2229 * \brief Return the name of the current ciphersuite
2231 * \param ssl SSL context
2233 * \return a string containing the ciphersuite name
2235 const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
2238 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
2240 * \param ssl SSL context
2242 * \return a string containing the SSL version
2244 const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
2247 * \brief Return the (maximum) number of bytes added by the record
2248 * layer: header + encryption/MAC overhead (inc. padding)
2250 * \param ssl SSL context
2252 * \return Current maximum record expansion in bytes, or
2253 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
2254 * enabled, which makes expansion much less predictable
2256 int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
2258 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2260 * \brief Return the maximum fragment length (payload, in bytes).
2261 * This is the value negotiated with peer if any,
2262 * or the locally configured value.
2264 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
2265 * called with a larger length value.
2266 * With TLS, \c mbedtls_ssl_write() will fragment the input if
2267 * necessary and return the number of bytes written; it is up
2268 * to the caller to call \c mbedtls_ssl_write() again in
2269 * order to send the remaining bytes if any.
2271 * \param ssl SSL context
2273 * \return Current maximum fragment length.
2275 size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
2276 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2278 #if defined(MBEDTLS_X509_CRT_PARSE_C)
2280 * \brief Return the peer certificate from the current connection
2282 * Note: Can be NULL in case no certificate was sent during
2283 * the handshake. Different calls for the same connection can
2284 * return the same or different pointers for the same
2285 * certificate and even a different certificate altogether.
2286 * The peer cert CAN change in a single connection if
2287 * renegotiation is performed.
2289 * \param ssl SSL context
2291 * \return the current peer certificate
2293 const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
2294 #endif /* MBEDTLS_X509_CRT_PARSE_C */
2296 #if defined(MBEDTLS_SSL_CLI_C)
2298 * \brief Save session in order to resume it later (client-side only)
2299 * Session data is copied to presented session structure.
2301 * \warning Currently, peer certificate is lost in the operation.
2303 * \param ssl SSL context
2304 * \param session session context
2306 * \return 0 if successful,
2307 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
2308 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
2309 * arguments are otherwise invalid
2311 * \sa mbedtls_ssl_set_session()
2313 int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
2314 #endif /* MBEDTLS_SSL_CLI_C */
2317 * \brief Perform the SSL handshake
2319 * \param ssl SSL context
2321 * \return 0 if successful, or
2322 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2323 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED (see below), or
2324 * a specific SSL error code.
2326 * \note If this function returns something other than 0 or
2327 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2328 * becomes unusable, and you should either free it or call
2329 * \c mbedtls_ssl_session_reset() on it before re-using it for
2330 * a new connection; the current connection must be closed.
2332 * \note If DTLS is in use, then you may choose to handle
2333 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
2334 * purposes, as it is an expected return value rather than an
2335 * actual error, but you still need to reset/free the context.
2337 int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
2340 * \brief Perform a single step of the SSL handshake
2342 * \note The state of the context (ssl->state) will be at
2343 * the next state after execution of this function. Do not
2344 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
2346 * \note If this function returns something other than 0 or
2347 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2348 * becomes unusable, and you should either free it or call
2349 * \c mbedtls_ssl_session_reset() on it before re-using it for
2350 * a new connection; the current connection must be closed.
2352 * \param ssl SSL context
2354 * \return 0 if successful, or
2355 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2356 * a specific SSL error code.
2358 int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
2360 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2362 * \brief Initiate an SSL renegotiation on the running connection.
2363 * Client: perform the renegotiation right now.
2364 * Server: request renegotiation, which will be performed
2365 * during the next call to mbedtls_ssl_read() if honored by
2368 * \param ssl SSL context
2370 * \return 0 if successful, or any mbedtls_ssl_handshake() return
2373 * \note If this function returns something other than 0 or
2374 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2375 * becomes unusable, and you should either free it or call
2376 * \c mbedtls_ssl_session_reset() on it before re-using it for
2377 * a new connection; the current connection must be closed.
2379 int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
2380 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2383 * \brief Read at most 'len' application data bytes
2385 * \param ssl SSL context
2386 * \param buf buffer that will hold the data
2387 * \param len maximum number of bytes to read
2389 * \return the number of bytes read, or
2391 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2392 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT (see below), or
2393 * another negative error code.
2395 * \note If this function returns something other than a positive
2396 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE or
2397 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT, then the ssl context
2398 * becomes unusable, and you should either free it or call
2399 * \c mbedtls_ssl_session_reset() on it before re-using it for
2400 * a new connection; the current connection must be closed.
2402 * \note When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
2403 * (which can only happen server-side), it means that a client
2404 * is initiating a new connection using the same source port.
2405 * You can either treat that as a connection close and wait
2406 * for the client to resend a ClientHello, or directly
2407 * continue with \c mbedtls_ssl_handshake() with the same
2408 * context (as it has beeen reset internally). Either way, you
2409 * should make sure this is seen by the application as a new
2410 * connection: application state, if any, should be reset, and
2411 * most importantly the identity of the client must be checked
2412 * again. WARNING: not validating the identity of the client
2413 * again, or not transmitting the new identity to the
2414 * application layer, would allow authentication bypass!
2416 int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
2419 * \brief Try to write exactly 'len' application data bytes
2421 * \warning This function will do partial writes in some cases. If the
2422 * return value is non-negative but less than length, the
2423 * function must be called again with updated arguments:
2424 * buf + ret, len - ret (if ret is the return value) until
2425 * it returns a value equal to the last 'len' argument.
2427 * \param ssl SSL context
2428 * \param buf buffer holding the data
2429 * \param len how many bytes must be written
2431 * \return the number of bytes actually written (may be less than len),
2432 * or MBEDTLS_ERR_SSL_WANT_WRITE of MBEDTLS_ERR_SSL_WANT_READ,
2433 * or another negative error code.
2435 * \note If this function returns something other than a positive
2436 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, the ssl context
2437 * becomes unusable, and you should either free it or call
2438 * \c mbedtls_ssl_session_reset() on it before re-using it for
2439 * a new connection; the current connection must be closed.
2441 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
2442 * it must be called later with the *same* arguments,
2443 * until it returns a positive value.
2445 * \note If the requested length is greater than the maximum
2446 * fragment length (either the built-in limit or the one set
2447 * or negotiated with the peer), then:
2448 * - with TLS, less bytes than requested are written.
2449 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
2450 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
2451 * active maximum fragment length.
2453 int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
2456 * \brief Send an alert message
2458 * \param ssl SSL context
2459 * \param level The alert level of the message
2460 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
2461 * \param message The alert message (SSL_ALERT_MSG_*)
2463 * \return 0 if successful, or a specific SSL error code.
2465 * \note If this function returns something other than 0 or
2466 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2467 * becomes unusable, and you should either free it or call
2468 * \c mbedtls_ssl_session_reset() on it before re-using it for
2469 * a new connection; the current connection must be closed.
2471 int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
2472 unsigned char level,
2473 unsigned char message );
2475 * \brief Notify the peer that the connection is being closed
2477 * \param ssl SSL context
2479 * \return 0 if successful, or a specific SSL error code.
2481 * \note If this function returns something other than 0 or
2482 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2483 * becomes unusable, and you should either free it or call
2484 * \c mbedtls_ssl_session_reset() on it before re-using it for
2485 * a new connection; the current connection must be closed.
2487 int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
2490 * \brief Free referenced items in an SSL context and clear memory
2492 * \param ssl SSL context
2494 void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
2497 * \brief Initialize an SSL configuration context
2498 * Just makes the context ready for
2499 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
2501 * \note You need to call mbedtls_ssl_config_defaults() unless you
2502 * manually set all of the relevent fields yourself.
2504 * \param conf SSL configuration context
2506 void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
2509 * \brief Load reasonnable default SSL configuration values.
2510 * (You need to call mbedtls_ssl_config_init() first.)
2512 * \param conf SSL configuration context
2513 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
2514 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
2515 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
2516 * \param preset a MBEDTLS_SSL_PRESET_XXX value
2517 * (currently unused).
2519 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
2521 * \return 0 if successful, or
2522 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
2524 int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
2525 int endpoint, int transport, int preset );
2528 * \brief Free an SSL configuration context
2530 * \param conf SSL configuration context
2532 void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
2535 * \brief Initialize SSL session structure
2537 * \param session SSL session
2539 void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
2542 * \brief Free referenced items in an SSL session including the
2543 * peer certificate and clear memory
2545 * \param session SSL session
2547 void mbedtls_ssl_session_free( mbedtls_ssl_session *session );