4 * \brief SSL/TLS functions.
6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
7 * SPDX-License-Identifier: GPL-2.0
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 * This file is part of mbed TLS (https://tls.mbed.org)
28 #if !defined(MBEDTLS_CONFIG_FILE)
31 #include MBEDTLS_CONFIG_FILE
37 #include "ssl_ciphersuites.h"
39 #if defined(MBEDTLS_X509_CRT_PARSE_C)
44 #if defined(MBEDTLS_DHM_C)
48 #if defined(MBEDTLS_ECDH_C)
52 #if defined(MBEDTLS_ZLIB_SUPPORT)
56 #if defined(MBEDTLS_HAVE_TIME)
63 #define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
64 #define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
65 #define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
66 #define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
67 #define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
68 #define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
69 #define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
70 #define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
71 #define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
72 #define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
73 #define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
74 #define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
75 #define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
76 #define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
77 #define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
78 #define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
79 #define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
80 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
81 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
82 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
83 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
84 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
85 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
86 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
87 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
88 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
89 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
90 #define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
91 #define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
92 #define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
93 #define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
94 #define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
95 #define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
96 #define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
97 #define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
98 #define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
99 #define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
100 #define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
101 #define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
102 #define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
103 #define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
104 #define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
105 #define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
106 #define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
107 #define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< Connection requires a read call. */
108 #define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
109 #define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
110 #define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */
111 #define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
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 unsigned char _pms_ecdh
[MBEDTLS_ECP_MAX_BYTES
]; /* RFC 4492 5.10 */
364 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
365 unsigned char _pms_psk
[4 + 2 * MBEDTLS_PSK_MAX_LEN
]; /* RFC 4279 2 */
367 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
368 unsigned char _pms_dhe_psk
[4 + MBEDTLS_MPI_MAX_SIZE
369 + MBEDTLS_PSK_MAX_LEN
]; /* RFC 4279 3 */
371 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
372 unsigned char _pms_rsa_psk
[52 + MBEDTLS_PSK_MAX_LEN
]; /* RFC 4279 4 */
374 #if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
375 unsigned char _pms_ecdhe_psk
[4 + MBEDTLS_ECP_MAX_BYTES
376 + MBEDTLS_PSK_MAX_LEN
]; /* RFC 5489 2 */
378 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
379 unsigned char _pms_ecjpake
[32]; /* Thread spec: SHA-256 output */
383 #define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
394 MBEDTLS_SSL_HELLO_REQUEST
,
395 MBEDTLS_SSL_CLIENT_HELLO
,
396 MBEDTLS_SSL_SERVER_HELLO
,
397 MBEDTLS_SSL_SERVER_CERTIFICATE
,
398 MBEDTLS_SSL_SERVER_KEY_EXCHANGE
,
399 MBEDTLS_SSL_CERTIFICATE_REQUEST
,
400 MBEDTLS_SSL_SERVER_HELLO_DONE
,
401 MBEDTLS_SSL_CLIENT_CERTIFICATE
,
402 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE
,
403 MBEDTLS_SSL_CERTIFICATE_VERIFY
,
404 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC
,
405 MBEDTLS_SSL_CLIENT_FINISHED
,
406 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC
,
407 MBEDTLS_SSL_SERVER_FINISHED
,
408 MBEDTLS_SSL_FLUSH_BUFFERS
,
409 MBEDTLS_SSL_HANDSHAKE_WRAPUP
,
410 MBEDTLS_SSL_HANDSHAKE_OVER
,
411 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET
,
412 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT
,
417 * \brief Callback type: send data on the network.
419 * \note That callback may be either blocking or non-blocking.
421 * \param ctx Context for the send callback (typically a file descriptor)
422 * \param buf Buffer holding the data to send
423 * \param len Length of the data to send
425 * \return The callback must return the number of bytes sent if any,
426 * or a non-zero error code.
427 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
428 * must be returned when the operation would block.
430 * \note The callback is allowed to send fewer bytes than requested.
431 * It must always return the number of bytes actually sent.
433 typedef int mbedtls_ssl_send_t( void *ctx
,
434 const unsigned char *buf
,
438 * \brief Callback type: receive data from the network.
440 * \note That callback may be either blocking or non-blocking.
442 * \param ctx Context for the receive callback (typically a file
444 * \param buf Buffer to write the received data to
445 * \param len Length of the receive buffer
447 * \return The callback must return the number of bytes received,
448 * or a non-zero error code.
449 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
450 * must be returned when the operation would block.
452 * \note The callback may receive fewer bytes than the length of the
453 * buffer. It must always return the number of bytes actually
454 * received and written to the buffer.
456 typedef int mbedtls_ssl_recv_t( void *ctx
,
461 * \brief Callback type: receive data from the network, with timeout
463 * \note That callback must block until data is received, or the
464 * timeout delay expires, or the operation is interrupted by a
467 * \param ctx Context for the receive callback (typically a file descriptor)
468 * \param buf Buffer to write the received data to
469 * \param len Length of the receive buffer
470 * \param timeout Maximum nomber of millisecondes to wait for data
471 * 0 means no timeout (potentially waiting forever)
473 * \return The callback must return the number of bytes received,
474 * or a non-zero error code:
475 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
476 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
478 * \note The callback may receive fewer bytes than the length of the
479 * buffer. It must always return the number of bytes actually
480 * received and written to the buffer.
482 typedef int mbedtls_ssl_recv_timeout_t( void *ctx
,
487 * \brief Callback type: set a pair of timers/delays to watch
489 * \param ctx Context pointer
490 * \param int_ms Intermediate delay in milliseconds
491 * \param fin_ms Final delay in milliseconds
492 * 0 cancels the current timer.
494 * \note This callback must at least store the necessary information
495 * for the associated \c mbedtls_ssl_get_timer_t callback to
496 * return correct information.
498 * \note If using a event-driven style of programming, an event must
499 * be generated when the final delay is passed. The event must
500 * cause a call to \c mbedtls_ssl_handshake() with the proper
501 * SSL context to be scheduled. Care must be taken to ensure
502 * that at most one such call happens at a time.
504 * \note Only one timer at a time must be running. Calling this
505 * function while a timer is running must cancel it. Cancelled
506 * timers must not generate any event.
508 typedef void mbedtls_ssl_set_timer_t( void * ctx
,
513 * \brief Callback type: get status of timers/delays
515 * \param ctx Context pointer
517 * \return This callback must return:
518 * -1 if cancelled (fin_ms == 0),
519 * 0 if none of the delays have passed,
520 * 1 if only the intermediate delay has passed,
521 * 2 if the final delay has passed.
523 typedef int mbedtls_ssl_get_timer_t( void * ctx
);
527 typedef struct mbedtls_ssl_session mbedtls_ssl_session
;
528 typedef struct mbedtls_ssl_context mbedtls_ssl_context
;
529 typedef struct mbedtls_ssl_config mbedtls_ssl_config
;
531 /* Defined in ssl_internal.h */
532 typedef struct mbedtls_ssl_transform mbedtls_ssl_transform
;
533 typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params
;
534 #if defined(MBEDTLS_X509_CRT_PARSE_C)
535 typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert
;
537 #if defined(MBEDTLS_SSL_PROTO_DTLS)
538 typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item
;
542 * This structure is used for storing current session data.
544 struct mbedtls_ssl_session
546 #if defined(MBEDTLS_HAVE_TIME)
547 mbedtls_time_t start
; /*!< starting time */
549 int ciphersuite
; /*!< chosen ciphersuite */
550 int compression
; /*!< chosen compression */
551 size_t id_len
; /*!< session id length */
552 unsigned char id
[32]; /*!< session identifier */
553 unsigned char master
[48]; /*!< the master secret */
555 #if defined(MBEDTLS_X509_CRT_PARSE_C)
556 mbedtls_x509_crt
*peer_cert
; /*!< peer X.509 cert chain */
557 #endif /* MBEDTLS_X509_CRT_PARSE_C */
558 uint32_t verify_result
; /*!< verification result */
560 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
561 unsigned char *ticket
; /*!< RFC 5077 session ticket */
562 size_t ticket_len
; /*!< session ticket length */
563 uint32_t ticket_lifetime
; /*!< ticket lifetime hint */
564 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
566 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
567 unsigned char mfl_code
; /*!< MaxFragmentLength negotiated by peer */
568 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
570 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
571 int trunc_hmac
; /*!< flag for truncated hmac activation */
572 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
574 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
575 int encrypt_then_mac
; /*!< flag for EtM activation */
580 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
582 struct mbedtls_ssl_config
584 /* Group items by size (largest first) to minimize padding overhead */
590 const int *ciphersuite_list
[4]; /*!< allowed ciphersuites per version */
592 /** Callback for printing debug output */
593 void (*f_dbg
)(void *, int, const char *, int, const char *);
594 void *p_dbg
; /*!< context for the debug function */
596 /** Callback for getting (pseudo-)random numbers */
597 int (*f_rng
)(void *, unsigned char *, size_t);
598 void *p_rng
; /*!< context for the RNG function */
600 /** Callback to retrieve a session from the cache */
601 int (*f_get_cache
)(void *, mbedtls_ssl_session
*);
602 /** Callback to store a session into the cache */
603 int (*f_set_cache
)(void *, const mbedtls_ssl_session
*);
604 void *p_cache
; /*!< context for cache callbacks */
606 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
607 /** Callback for setting cert according to SNI extension */
608 int (*f_sni
)(void *, mbedtls_ssl_context
*, const unsigned char *, size_t);
609 void *p_sni
; /*!< context for SNI callback */
612 #if defined(MBEDTLS_X509_CRT_PARSE_C)
613 /** Callback to customize X.509 certificate chain verification */
614 int (*f_vrfy
)(void *, mbedtls_x509_crt
*, int, uint32_t *);
615 void *p_vrfy
; /*!< context for X.509 verify calllback */
618 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
619 /** Callback to retrieve PSK key from identity */
620 int (*f_psk
)(void *, mbedtls_ssl_context
*, const unsigned char *, size_t);
621 void *p_psk
; /*!< context for PSK callback */
624 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
625 /** Callback to create & write a cookie for ClientHello veirifcation */
626 int (*f_cookie_write
)( void *, unsigned char **, unsigned char *,
627 const unsigned char *, size_t );
628 /** Callback to verify validity of a ClientHello cookie */
629 int (*f_cookie_check
)( void *, const unsigned char *, size_t,
630 const unsigned char *, size_t );
631 void *p_cookie
; /*!< context for the cookie callbacks */
634 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
635 /** Callback to create & write a session ticket */
636 int (*f_ticket_write
)( void *, const mbedtls_ssl_session
*,
637 unsigned char *, const unsigned char *, size_t *, uint32_t * );
638 /** Callback to parse a session ticket into a session structure */
639 int (*f_ticket_parse
)( void *, mbedtls_ssl_session
*, unsigned char *, size_t);
640 void *p_ticket
; /*!< context for the ticket callbacks */
641 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
643 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
644 /** Callback to export key block and master secret */
645 int (*f_export_keys
)( void *, const unsigned char *,
646 const unsigned char *, size_t, size_t, size_t );
647 void *p_export_keys
; /*!< context for key export callback */
650 #if defined(MBEDTLS_X509_CRT_PARSE_C)
651 const mbedtls_x509_crt_profile
*cert_profile
; /*!< verification profile */
652 mbedtls_ssl_key_cert
*key_cert
; /*!< own certificate/key pair(s) */
653 mbedtls_x509_crt
*ca_chain
; /*!< trusted CAs */
654 mbedtls_x509_crl
*ca_crl
; /*!< trusted CAs CRLs */
655 #endif /* MBEDTLS_X509_CRT_PARSE_C */
657 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
658 const int *sig_hashes
; /*!< allowed signature hashes */
661 #if defined(MBEDTLS_ECP_C)
662 const mbedtls_ecp_group_id
*curve_list
; /*!< allowed curves */
665 #if defined(MBEDTLS_DHM_C)
666 mbedtls_mpi dhm_P
; /*!< prime modulus for DHM */
667 mbedtls_mpi dhm_G
; /*!< generator for DHM */
670 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
671 unsigned char *psk
; /*!< pre-shared key */
672 size_t psk_len
; /*!< length of the pre-shared key */
673 unsigned char *psk_identity
; /*!< identity for PSK negotiation */
674 size_t psk_identity_len
;/*!< length of identity */
677 #if defined(MBEDTLS_SSL_ALPN)
678 const char **alpn_list
; /*!< ordered list of protocols */
682 * Numerical settings (int then char)
685 uint32_t read_timeout
; /*!< timeout for mbedtls_ssl_read (ms) */
687 #if defined(MBEDTLS_SSL_PROTO_DTLS)
688 uint32_t hs_timeout_min
; /*!< initial value of the handshake
689 retransmission timeout (ms) */
690 uint32_t hs_timeout_max
; /*!< maximum value of the handshake
691 retransmission timeout (ms) */
694 #if defined(MBEDTLS_SSL_RENEGOTIATION)
695 int renego_max_records
; /*!< grace period for renegotiation */
696 unsigned char renego_period
[8]; /*!< value of the record counters
697 that triggers renegotiation */
700 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
701 unsigned int badmac_limit
; /*!< limit of records with a bad MAC */
704 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
705 unsigned int dhm_min_bitlen
; /*!< min. bit length of the DHM prime */
708 unsigned char max_major_ver
; /*!< max. major version used */
709 unsigned char max_minor_ver
; /*!< max. minor version used */
710 unsigned char min_major_ver
; /*!< min. major version used */
711 unsigned char min_minor_ver
; /*!< min. minor version used */
717 unsigned int endpoint
: 1; /*!< 0: client, 1: server */
718 unsigned int transport
: 1; /*!< stream (TLS) or datagram (DTLS) */
719 unsigned int authmode
: 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
720 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
721 unsigned int allow_legacy_renegotiation
: 2 ; /*!< MBEDTLS_LEGACY_XXX */
722 #if defined(MBEDTLS_ARC4_C)
723 unsigned int arc4_disabled
: 1; /*!< blacklist RC4 ciphersuites? */
725 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
726 unsigned int mfl_code
: 3; /*!< desired fragment length */
728 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
729 unsigned int encrypt_then_mac
: 1 ; /*!< negotiate encrypt-then-mac? */
731 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
732 unsigned int extended_ms
: 1; /*!< negotiate extended master secret? */
734 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
735 unsigned int anti_replay
: 1; /*!< detect and prevent replay? */
737 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
738 unsigned int cbc_record_splitting
: 1; /*!< do cbc record splitting */
740 #if defined(MBEDTLS_SSL_RENEGOTIATION)
741 unsigned int disable_renegotiation
: 1; /*!< disable renegotiation? */
743 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
744 unsigned int trunc_hmac
: 1; /*!< negotiate truncated hmac? */
746 #if defined(MBEDTLS_SSL_SESSION_TICKETS)
747 unsigned int session_tickets
: 1; /*!< use session tickets? */
749 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
750 unsigned int fallback
: 1; /*!< is this a fallback? */
755 struct mbedtls_ssl_context
757 const mbedtls_ssl_config
*conf
; /*!< configuration information */
762 int state
; /*!< SSL handshake: current state */
763 #if defined(MBEDTLS_SSL_RENEGOTIATION)
764 int renego_status
; /*!< Initial, in progress, pending? */
765 int renego_records_seen
; /*!< Records since renego request, or with DTLS,
766 number of retransmissions of request if
767 renego_max_records is < 0 */
770 int major_ver
; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
771 int minor_ver
; /*!< either 0 (SSL3) or 1 (TLS1.0) */
773 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
774 unsigned badmac_seen
; /*!< records with a bad MAC received */
777 mbedtls_ssl_send_t
*f_send
; /*!< Callback for network send */
778 mbedtls_ssl_recv_t
*f_recv
; /*!< Callback for network receive */
779 mbedtls_ssl_recv_timeout_t
*f_recv_timeout
;
780 /*!< Callback for network receive with timeout */
782 void *p_bio
; /*!< context for I/O operations */
787 mbedtls_ssl_session
*session_in
; /*!< current session data (in) */
788 mbedtls_ssl_session
*session_out
; /*!< current session data (out) */
789 mbedtls_ssl_session
*session
; /*!< negotiated session data */
790 mbedtls_ssl_session
*session_negotiate
; /*!< session data in negotiation */
792 mbedtls_ssl_handshake_params
*handshake
; /*!< params required only during
793 the handshake process */
796 * Record layer transformations
798 mbedtls_ssl_transform
*transform_in
; /*!< current transform params (in) */
799 mbedtls_ssl_transform
*transform_out
; /*!< current transform params (in) */
800 mbedtls_ssl_transform
*transform
; /*!< negotiated transform params */
801 mbedtls_ssl_transform
*transform_negotiate
; /*!< transform params in negotiation */
806 void *p_timer
; /*!< context for the timer callbacks */
808 mbedtls_ssl_set_timer_t
*f_set_timer
; /*!< set timer callback */
809 mbedtls_ssl_get_timer_t
*f_get_timer
; /*!< get timer callback */
812 * Record layer (incoming data)
814 unsigned char *in_buf
; /*!< input buffer */
815 unsigned char *in_ctr
; /*!< 64-bit incoming message counter
816 TLS: maintained by us
817 DTLS: read from peer */
818 unsigned char *in_hdr
; /*!< start of record header */
819 unsigned char *in_len
; /*!< two-bytes message length field */
820 unsigned char *in_iv
; /*!< ivlen-byte IV */
821 unsigned char *in_msg
; /*!< message contents (in_iv+ivlen) */
822 unsigned char *in_offt
; /*!< read offset in application data */
824 int in_msgtype
; /*!< record header: message type */
825 size_t in_msglen
; /*!< record header: message length */
826 size_t in_left
; /*!< amount of data read so far */
827 #if defined(MBEDTLS_SSL_PROTO_DTLS)
828 uint16_t in_epoch
; /*!< DTLS epoch for incoming records */
829 size_t next_record_offset
; /*!< offset of the next record in datagram
830 (equal to in_left if none) */
832 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
833 uint64_t in_window_top
; /*!< last validated record seq_num */
834 uint64_t in_window
; /*!< bitmask for replay detection */
837 size_t in_hslen
; /*!< current handshake message length,
838 including the handshake header */
839 int nb_zero
; /*!< # of 0-length encrypted messages */
840 int record_read
; /*!< record is already present */
843 * Record layer (outgoing data)
845 unsigned char *out_buf
; /*!< output buffer */
846 unsigned char *out_ctr
; /*!< 64-bit outgoing message counter */
847 unsigned char *out_hdr
; /*!< start of record header */
848 unsigned char *out_len
; /*!< two-bytes message length field */
849 unsigned char *out_iv
; /*!< ivlen-byte IV */
850 unsigned char *out_msg
; /*!< message contents (out_iv+ivlen) */
852 int out_msgtype
; /*!< record header: message type */
853 size_t out_msglen
; /*!< record header: message length */
854 size_t out_left
; /*!< amount of data not yet written */
856 #if defined(MBEDTLS_ZLIB_SUPPORT)
857 unsigned char *compress_buf
; /*!< zlib data buffer */
859 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
860 signed char split_done
; /*!< current record already splitted? */
866 int client_auth
; /*!< flag for client auth. */
871 #if defined(MBEDTLS_X509_CRT_PARSE_C)
872 char *hostname
; /*!< expected peer CN for verification
873 (and SNI if available) */
876 #if defined(MBEDTLS_SSL_ALPN)
877 const char *alpn_chosen
; /*!< negotiated protocol */
881 * Information for DTLS hello verify
883 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
884 unsigned char *cli_id
; /*!< transport-level ID of the client */
885 size_t cli_id_len
; /*!< length of cli_id */
889 * Secure renegotiation
891 /* needed to know when to send extension on server */
892 int secure_renegotiation
; /*!< does peer support legacy or
893 secure renegotiation */
894 #if defined(MBEDTLS_SSL_RENEGOTIATION)
895 size_t verify_data_len
; /*!< length of verify data stored */
896 char own_verify_data
[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN
]; /*!< previous handshake verify data */
897 char peer_verify_data
[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN
]; /*!< previous handshake verify data */
901 #if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
903 #define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
904 #define MBEDTLS_SSL_CHANNEL_INBOUND 1
906 extern int (*mbedtls_ssl_hw_record_init
)(mbedtls_ssl_context
*ssl
,
907 const unsigned char *key_enc
, const unsigned char *key_dec
,
909 const unsigned char *iv_enc
, const unsigned char *iv_dec
,
911 const unsigned char *mac_enc
, const unsigned char *mac_dec
,
913 extern int (*mbedtls_ssl_hw_record_activate
)(mbedtls_ssl_context
*ssl
, int direction
);
914 extern int (*mbedtls_ssl_hw_record_reset
)(mbedtls_ssl_context
*ssl
);
915 extern int (*mbedtls_ssl_hw_record_write
)(mbedtls_ssl_context
*ssl
);
916 extern int (*mbedtls_ssl_hw_record_read
)(mbedtls_ssl_context
*ssl
);
917 extern int (*mbedtls_ssl_hw_record_finish
)(mbedtls_ssl_context
*ssl
);
918 #endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
921 * \brief Returns the list of ciphersuites supported by the SSL/TLS module.
923 * \return a statically allocated array of ciphersuites, the last
926 const int *mbedtls_ssl_list_ciphersuites( void );
929 * \brief Return the name of the ciphersuite associated with the
932 * \param ciphersuite_id SSL ciphersuite ID
934 * \return a string containing the ciphersuite name
936 const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id
);
939 * \brief Return the ID of the ciphersuite associated with the
942 * \param ciphersuite_name SSL ciphersuite name
944 * \return the ID with the ciphersuite or 0 if not found
946 int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name
);
949 * \brief Initialize an SSL context
950 * Just makes the context ready for mbedtls_ssl_setup() or
953 * \param ssl SSL context
955 void mbedtls_ssl_init( mbedtls_ssl_context
*ssl
);
958 * \brief Set up an SSL context for use
960 * \note No copy of the configuration context is made, it can be
961 * shared by many mbedtls_ssl_context structures.
963 * \warning Modifying the conf structure after it has been used in this
964 * function is unsupported!
966 * \param ssl SSL context
967 * \param conf SSL configuration to use
969 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
970 * memory allocation failed
972 int mbedtls_ssl_setup( mbedtls_ssl_context
*ssl
,
973 const mbedtls_ssl_config
*conf
);
976 * \brief Reset an already initialized SSL context for re-use
977 * while retaining application-set variables, function
980 * \param ssl SSL context
981 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
982 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
983 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
985 int mbedtls_ssl_session_reset( mbedtls_ssl_context
*ssl
);
988 * \brief Set the current endpoint type
990 * \param conf SSL configuration
991 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
993 void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config
*conf
, int endpoint
);
996 * \brief Set the transport type (TLS or DTLS).
999 * \note For DTLS, you must either provide a recv callback that
1000 * doesn't block, or one that handles timeouts, see
1001 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1002 * callbacks with \c mbedtls_ssl_set_timer_cb().
1004 * \param conf SSL configuration
1005 * \param transport transport type:
1006 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1007 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
1009 void mbedtls_ssl_conf_transport( mbedtls_ssl_config
*conf
, int transport
);
1012 * \brief Set the certificate verification mode
1013 * Default: NONE on server, REQUIRED on client
1015 * \param conf SSL configuration
1016 * \param authmode can be:
1018 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
1019 * (default on server)
1020 * (insecure on client)
1022 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
1023 * handshake continues even if verification failed;
1024 * mbedtls_ssl_get_verify_result() can be called after the
1025 * handshake is complete.
1027 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
1028 * handshake is aborted if verification failed.
1029 * (default on client)
1031 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1032 * With MBEDTLS_SSL_VERIFY_OPTIONAL, the user needs to call mbedtls_ssl_get_verify_result() at
1033 * the right time(s), which may not be obvious, while REQUIRED always perform
1034 * the verification as soon as possible. For example, REQUIRED was protecting
1035 * against the "triple handshake" attack even before it was found.
1037 void mbedtls_ssl_conf_authmode( mbedtls_ssl_config
*conf
, int authmode
);
1039 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1041 * \brief Set the verification callback (Optional).
1043 * If set, the verify callback is called for each
1044 * certificate in the chain. For implementation
1045 * information, please see \c x509parse_verify()
1047 * \param conf SSL configuration
1048 * \param f_vrfy verification function
1049 * \param p_vrfy verification parameter
1051 void mbedtls_ssl_conf_verify( mbedtls_ssl_config
*conf
,
1052 int (*f_vrfy
)(void *, mbedtls_x509_crt
*, int, uint32_t *),
1054 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1057 * \brief Set the random number generator callback
1059 * \param conf SSL configuration
1060 * \param f_rng RNG function
1061 * \param p_rng RNG parameter
1063 void mbedtls_ssl_conf_rng( mbedtls_ssl_config
*conf
,
1064 int (*f_rng
)(void *, unsigned char *, size_t),
1068 * \brief Set the debug callback
1070 * The callback has the following argument:
1071 * void * opaque context for the callback
1073 * const char * file name
1075 * const char * message
1077 * \param conf SSL configuration
1078 * \param f_dbg debug function
1079 * \param p_dbg debug parameter
1081 void mbedtls_ssl_conf_dbg( mbedtls_ssl_config
*conf
,
1082 void (*f_dbg
)(void *, int, const char *, int, const char *),
1086 * \brief Set the underlying BIO callbacks for write, read and
1087 * read-with-timeout.
1089 * \param ssl SSL context
1090 * \param p_bio parameter (context) shared by BIO callbacks
1091 * \param f_send write callback
1092 * \param f_recv read callback
1093 * \param f_recv_timeout blocking read callback with timeout.
1095 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1096 * the other is used. If both are non-NULL, f_recv_timeout is
1097 * used and f_recv is ignored (as if it were NULL).
1099 * \note The two most common use cases are:
1100 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1101 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1103 * \note For DTLS, you need to provide either a non-NULL
1104 * f_recv_timeout callback, or a f_recv that doesn't block.
1106 * \note See the documentations of \c mbedtls_ssl_sent_t,
1107 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
1108 * the conventions those callbacks must follow.
1110 * \note On some platforms, net.c provides \c mbedtls_net_send(),
1111 * \c mbedtls_net_recv() and \c mbedtls_net_recv_timeout()
1112 * that are suitable to be used here.
1114 void mbedtls_ssl_set_bio( mbedtls_ssl_context
*ssl
,
1116 mbedtls_ssl_send_t
*f_send
,
1117 mbedtls_ssl_recv_t
*f_recv
,
1118 mbedtls_ssl_recv_timeout_t
*f_recv_timeout
);
1121 * \brief Set the timeout period for mbedtls_ssl_read()
1122 * (Default: no timeout.)
1124 * \param conf SSL configuration context
1125 * \param timeout Timeout value in milliseconds.
1126 * Use 0 for no timeout (default).
1128 * \note With blocking I/O, this will only work if a non-NULL
1129 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
1130 * With non-blocking I/O, this will only work if timer
1131 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1133 * \note With non-blocking I/O, you may also skip this function
1134 * altogether and handle timeouts at the application layer.
1136 void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config
*conf
, uint32_t timeout
);
1139 * \brief Set the timer callbacks (Mandatory for DTLS.)
1141 * \param ssl SSL context
1142 * \param p_timer parameter (context) shared by timer callbacks
1143 * \param f_set_timer set timer callback
1144 * \param f_get_timer get timer callback. Must return:
1146 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1147 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
1148 * callbacks must fallow.
1150 * \note On some platforms, timing.c provides
1151 * \c mbedtls_timing_set_delay() and
1152 * \c mbedtls_timing_get_delay() that are suitable for using
1153 * here, except if using an event-driven style.
1155 * \note See also the "DTLS tutorial" article in our knowledge base.
1156 * https://tls.mbed.org/kb/how-to/dtls-tutorial
1158 void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context
*ssl
,
1160 mbedtls_ssl_set_timer_t
*f_set_timer
,
1161 mbedtls_ssl_get_timer_t
*f_get_timer
);
1164 * \brief Callback type: generate and write session ticket
1166 * \note This describes what a callback implementation should do.
1167 * This callback should generate an encrypted and
1168 * authenticated ticket for the session and write it to the
1169 * output buffer. Here, ticket means the opaque ticket part
1170 * of the NewSessionTicket structure of RFC 5077.
1172 * \param p_ticket Context for the callback
1173 * \param session SSL session to be written in the ticket
1174 * \param start Start of the output buffer
1175 * \param end End of the output buffer
1176 * \param tlen On exit, holds the length written
1177 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1179 * \return 0 if successful, or
1180 * a specific MBEDTLS_ERR_XXX code.
1182 typedef int mbedtls_ssl_ticket_write_t( void *p_ticket
,
1183 const mbedtls_ssl_session
*session
,
1184 unsigned char *start
,
1185 const unsigned char *end
,
1187 uint32_t *lifetime
);
1189 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
1191 * \brief Callback type: Export key block and master secret
1193 * \note This is required for certain uses of TLS, e.g. EAP-TLS
1194 * (RFC 5216) and Thread. The key pointers are ephemeral and
1195 * therefore must not be stored. The master secret and keys
1196 * should not be used directly except as an input to a key
1197 * derivation function.
1199 * \param p_expkey Context for the callback
1200 * \param ms Pointer to master secret (fixed length: 48 bytes)
1201 * \param kb Pointer to key block, see RFC 5246 section 6.3
1202 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
1203 * \param maclen MAC length
1204 * \param keylen Key length
1205 * \param ivlen IV length
1207 * \return 0 if successful, or
1208 * a specific MBEDTLS_ERR_XXX code.
1210 typedef int mbedtls_ssl_export_keys_t( void *p_expkey
,
1211 const unsigned char *ms
,
1212 const unsigned char *kb
,
1216 #endif /* MBEDTLS_SSL_EXPORT_KEYS */
1219 * \brief Callback type: parse and load session ticket
1221 * \note This describes what a callback implementation should do.
1222 * This callback should parse a session ticket as generated
1223 * by the corresponding mbedtls_ssl_ticket_write_t function,
1224 * and, if the ticket is authentic and valid, load the
1227 * \note The implementation is allowed to modify the first len
1228 * bytes of the input buffer, eg to use it as a temporary
1229 * area for the decrypted ticket contents.
1231 * \param p_ticket Context for the callback
1232 * \param session SSL session to be loaded
1233 * \param buf Start of the buffer containing the ticket
1234 * \param len Length of the ticket.
1236 * \return 0 if successful, or
1237 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1238 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1239 * any other non-zero code for other failures.
1241 typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket
,
1242 mbedtls_ssl_session
*session
,
1246 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
1248 * \brief Configure SSL session ticket callbacks (server only).
1251 * \note On server, session tickets are enabled by providing
1252 * non-NULL callbacks.
1254 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
1256 * \param conf SSL configuration context
1257 * \param f_ticket_write Callback for writing a ticket
1258 * \param f_ticket_parse Callback for parsing a ticket
1259 * \param p_ticket Context shared by the two callbacks
1261 void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config
*conf
,
1262 mbedtls_ssl_ticket_write_t
*f_ticket_write
,
1263 mbedtls_ssl_ticket_parse_t
*f_ticket_parse
,
1265 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
1267 #if defined(MBEDTLS_SSL_EXPORT_KEYS)
1269 * \brief Configure key export callback.
1272 * \note See \c mbedtls_ssl_export_keys_t.
1274 * \param conf SSL configuration context
1275 * \param f_export_keys Callback for exporting keys
1276 * \param p_export_keys Context for the callback
1278 void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config
*conf
,
1279 mbedtls_ssl_export_keys_t
*f_export_keys
,
1280 void *p_export_keys
);
1281 #endif /* MBEDTLS_SSL_EXPORT_KEYS */
1284 * \brief Callback type: generate a cookie
1286 * \param ctx Context for the callback
1287 * \param p Buffer to write to,
1288 * must be updated to point right after the cookie
1289 * \param end Pointer to one past the end of the output buffer
1290 * \param info Client ID info that was passed to
1291 * \c mbedtls_ssl_set_client_transport_id()
1292 * \param ilen Length of info in bytes
1294 * \return The callback must return 0 on success,
1295 * or a negative error code.
1297 typedef int mbedtls_ssl_cookie_write_t( void *ctx
,
1298 unsigned char **p
, unsigned char *end
,
1299 const unsigned char *info
, size_t ilen
);
1302 * \brief Callback type: verify a cookie
1304 * \param ctx Context for the callback
1305 * \param cookie Cookie to verify
1306 * \param clen Length of cookie
1307 * \param info Client ID info that was passed to
1308 * \c mbedtls_ssl_set_client_transport_id()
1309 * \param ilen Length of info in bytes
1311 * \return The callback must return 0 if cookie is valid,
1312 * or a negative error code.
1314 typedef int mbedtls_ssl_cookie_check_t( void *ctx
,
1315 const unsigned char *cookie
, size_t clen
,
1316 const unsigned char *info
, size_t ilen
);
1318 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
1320 * \brief Register callbacks for DTLS cookies
1321 * (Server only. DTLS only.)
1323 * Default: dummy callbacks that fail, in order to force you to
1324 * register working callbacks (and initialize their context).
1326 * To disable HelloVerifyRequest, register NULL callbacks.
1328 * \warning Disabling hello verification allows your server to be used
1329 * for amplification in DoS attacks against other hosts.
1330 * Only disable if you known this can't happen in your
1331 * particular environment.
1333 * \note See comments on \c mbedtls_ssl_handshake() about handling
1334 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1335 * on the first handshake attempt when this is enabled.
1337 * \note This is also necessary to handle client reconnection from
1338 * the same port as described in RFC 6347 section 4.2.8 (only
1339 * the variant with cookies is supported currently). See
1340 * comments on \c mbedtls_ssl_read() for details.
1342 * \param conf SSL configuration
1343 * \param f_cookie_write Cookie write callback
1344 * \param f_cookie_check Cookie check callback
1345 * \param p_cookie Context for both callbacks
1347 void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config
*conf
,
1348 mbedtls_ssl_cookie_write_t
*f_cookie_write
,
1349 mbedtls_ssl_cookie_check_t
*f_cookie_check
,
1353 * \brief Set client's transport-level identification info.
1354 * (Server only. DTLS only.)
1356 * This is usually the IP address (and port), but could be
1357 * anything identify the client depending on the underlying
1358 * network stack. Used for HelloVerifyRequest with DTLS.
1359 * This is *not* used to route the actual packets.
1361 * \param ssl SSL context
1362 * \param info Transport-level info identifying the client (eg IP + port)
1363 * \param ilen Length of info in bytes
1365 * \note An internal copy is made, so the info buffer can be reused.
1367 * \return 0 on success,
1368 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
1369 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
1371 int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context
*ssl
,
1372 const unsigned char *info
,
1375 #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
1377 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1379 * \brief Enable or disable anti-replay protection for DTLS.
1380 * (DTLS only, no effect on TLS.)
1383 * \param conf SSL configuration
1384 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
1386 * \warning Disabling this is a security risk unless the application
1387 * protocol handles duplicated packets in a safe way. You
1388 * should not disable this without careful consideration.
1389 * However, if your application already detects duplicated
1390 * packets and needs information about them to adjust its
1391 * transmission strategy, then you'll want to disable this.
1393 void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config
*conf
, char mode
);
1394 #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
1396 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1398 * \brief Set a limit on the number of records with a bad MAC
1399 * before terminating the connection.
1400 * (DTLS only, no effect on TLS.)
1401 * Default: 0 (disabled).
1403 * \param conf SSL configuration
1404 * \param limit Limit, or 0 to disable.
1406 * \note If the limit is N, then the connection is terminated when
1407 * the Nth non-authentic record is seen.
1409 * \note Records with an invalid header are not counted, only the
1410 * ones going through the authentication-decryption phase.
1412 * \note This is a security trade-off related to the fact that it's
1413 * often relatively easy for an active attacker ot inject UDP
1414 * datagrams. On one hand, setting a low limit here makes it
1415 * easier for such an attacker to forcibly terminated a
1416 * connection. On the other hand, a high limit or no limit
1417 * might make us waste resources checking authentication on
1418 * many bogus packets.
1420 void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config
*conf
, unsigned limit
);
1421 #endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
1423 #if defined(MBEDTLS_SSL_PROTO_DTLS)
1425 * \brief Set retransmit timeout values for the DTLS handshake.
1426 * (DTLS only, no effect on TLS.)
1428 * \param conf SSL configuration
1429 * \param min Initial timeout value in milliseconds.
1430 * Default: 1000 (1 second).
1431 * \param max Maximum timeout value in milliseconds.
1432 * Default: 60000 (60 seconds).
1434 * \note Default values are from RFC 6347 section 4.2.4.1.
1436 * \note The 'min' value should typically be slightly above the
1437 * expected round-trip time to your peer, plus whatever time
1438 * it takes for the peer to process the message. For example,
1439 * if your RTT is about 600ms and you peer needs up to 1s to
1440 * do the cryptographic operations in the handshake, then you
1441 * should set 'min' slightly above 1600. Lower values of 'min'
1442 * might cause spurious resends which waste network resources,
1443 * while larger value of 'min' will increase overall latency
1444 * on unreliable network links.
1446 * \note The more unreliable your network connection is, the larger
1447 * your max / min ratio needs to be in order to achieve
1448 * reliable handshakes.
1450 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
1451 * For example, if min = 1s and max = 5s, the retransmit plan
1452 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
1453 * resend ... 5s -> give up and return a timeout error.
1455 void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config
*conf
, uint32_t min
, uint32_t max
);
1456 #endif /* MBEDTLS_SSL_PROTO_DTLS */
1458 #if defined(MBEDTLS_SSL_SRV_C)
1460 * \brief Set the session cache callbacks (server-side only)
1461 * If not set, no session resuming is done (except if session
1462 * tickets are enabled too).
1464 * The session cache has the responsibility to check for stale
1465 * entries based on timeout. See RFC 5246 for recommendations.
1467 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1468 * connection shutdown, so do not cache the pointer! Either set
1469 * it to NULL or make a full copy of the certificate.
1471 * The get callback is called once during the initial handshake
1472 * to enable session resuming. The get function has the
1473 * following parameters: (void *parameter, mbedtls_ssl_session *session)
1474 * If a valid entry is found, it should fill the master of
1475 * the session object with the cached values and return 0,
1476 * return 1 otherwise. Optionally peer_cert can be set as well
1477 * if it is properly present in cache entry.
1479 * The set callback is called once during the initial handshake
1480 * to enable session resuming after the entire handshake has
1481 * been finished. The set function has the following parameters:
1482 * (void *parameter, const mbedtls_ssl_session *session). The function
1483 * should create a cache entry for future retrieval based on
1484 * the data in the session structure and should keep in mind
1485 * that the mbedtls_ssl_session object presented (and all its referenced
1486 * data) is cleared by the SSL/TLS layer when the connection is
1487 * terminated. It is recommended to add metadata to determine if
1488 * an entry is still valid in the future. Return 0 if
1489 * successfully cached, return 1 otherwise.
1491 * \param conf SSL configuration
1492 * \param p_cache parmater (context) for both callbacks
1493 * \param f_get_cache session get callback
1494 * \param f_set_cache session set callback
1496 void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config
*conf
,
1498 int (*f_get_cache
)(void *, mbedtls_ssl_session
*),
1499 int (*f_set_cache
)(void *, const mbedtls_ssl_session
*) );
1500 #endif /* MBEDTLS_SSL_SRV_C */
1502 #if defined(MBEDTLS_SSL_CLI_C)
1504 * \brief Request resumption of session (client-side only)
1505 * Session data is copied from presented session structure.
1507 * \param ssl SSL context
1508 * \param session session context
1510 * \return 0 if successful,
1511 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
1512 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
1513 * arguments are otherwise invalid
1515 * \sa mbedtls_ssl_get_session()
1517 int mbedtls_ssl_set_session( mbedtls_ssl_context
*ssl
, const mbedtls_ssl_session
*session
);
1518 #endif /* MBEDTLS_SSL_CLI_C */
1521 * \brief Set the list of allowed ciphersuites and the preference
1522 * order. First in the list has the highest preference.
1523 * (Overrides all version-specific lists)
1525 * The ciphersuites array is not copied, and must remain
1526 * valid for the lifetime of the ssl_config.
1528 * Note: The server uses its own preferences
1529 * over the preference of the client unless
1530 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
1532 * \param conf SSL configuration
1533 * \param ciphersuites 0-terminated list of allowed ciphersuites
1535 void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config
*conf
,
1536 const int *ciphersuites
);
1539 * \brief Set the list of allowed ciphersuites and the
1540 * preference order for a specific version of the protocol.
1541 * (Only useful on the server side)
1543 * The ciphersuites array is not copied, and must remain
1544 * valid for the lifetime of the ssl_config.
1546 * \param conf SSL configuration
1547 * \param ciphersuites 0-terminated list of allowed ciphersuites
1548 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
1550 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1551 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1552 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
1554 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
1555 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1557 void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config
*conf
,
1558 const int *ciphersuites
,
1559 int major
, int minor
);
1561 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1563 * \brief Set the X.509 security profile used for verification
1565 * \note The restrictions are enforced for all certificates in the
1566 * chain. However, signatures in the handshake are not covered
1567 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
1569 * \param conf SSL configuration
1570 * \param profile Profile to use
1572 void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config
*conf
,
1573 const mbedtls_x509_crt_profile
*profile
);
1576 * \brief Set the data required to verify peer certificate
1578 * \param conf SSL configuration
1579 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1580 * \param ca_crl trusted CA CRLs
1582 void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config
*conf
,
1583 mbedtls_x509_crt
*ca_chain
,
1584 mbedtls_x509_crl
*ca_crl
);
1587 * \brief Set own certificate chain and private key
1589 * \note own_cert should contain in order from the bottom up your
1590 * certificate chain. The top certificate (self-signed)
1593 * \note On server, this function can be called multiple times to
1594 * provision more than one cert/key pair (eg one ECDSA, one
1595 * RSA with SHA-256, one RSA with SHA-1). An adequate
1596 * certificate will be selected according to the client's
1597 * advertised capabilities. In case mutliple certificates are
1598 * adequate, preference is given to the one set by the first
1599 * call to this function, then second, etc.
1601 * \note On client, only the first call has any effect. That is,
1602 * only one client certificate can be provisioned. The
1603 * server's preferences in its CertficateRequest message will
1604 * be ignored and our only cert will be sent regardless of
1605 * whether it matches those preferences - the server can then
1606 * decide what it wants to do with it.
1608 * \param conf SSL configuration
1609 * \param own_cert own public certificate chain
1610 * \param pk_key own private key
1612 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
1614 int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config
*conf
,
1615 mbedtls_x509_crt
*own_cert
,
1616 mbedtls_pk_context
*pk_key
);
1617 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1619 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
1621 * \brief Set the Pre Shared Key (PSK) and the expected identity name
1623 * \note This is mainly useful for clients. Servers will usually
1624 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
1626 * \note Currently clients can only register one pre-shared key.
1627 * In other words, the servers' identity hint is ignored.
1628 * Support for setting multiple PSKs on clients and selecting
1629 * one based on the identity hint is not a planned feature but
1630 * feedback is welcomed.
1632 * \param conf SSL configuration
1633 * \param psk pointer to the pre-shared key
1634 * \param psk_len pre-shared key length
1635 * \param psk_identity pointer to the pre-shared key identity
1636 * \param psk_identity_len identity key length
1638 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
1640 int mbedtls_ssl_conf_psk( mbedtls_ssl_config
*conf
,
1641 const unsigned char *psk
, size_t psk_len
,
1642 const unsigned char *psk_identity
, size_t psk_identity_len
);
1646 * \brief Set the Pre Shared Key (PSK) for the current handshake
1648 * \note This should only be called inside the PSK callback,
1649 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
1651 * \param ssl SSL context
1652 * \param psk pointer to the pre-shared key
1653 * \param psk_len pre-shared key length
1655 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
1657 int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context
*ssl
,
1658 const unsigned char *psk
, size_t psk_len
);
1661 * \brief Set the PSK callback (server-side only).
1663 * If set, the PSK callback is called for each
1664 * handshake where a PSK ciphersuite was negotiated.
1665 * The caller provides the identity received and wants to
1666 * receive the actual PSK data and length.
1668 * The callback has the following parameters: (void *parameter,
1669 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
1670 * size_t identity_len)
1671 * If a valid PSK identity is found, the callback should use
1672 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
1673 * correct PSK and return 0.
1674 * Any other return value will result in a denied PSK identity.
1676 * \note If you set a PSK callback using this function, then you
1677 * don't need to set a PSK key and identity using
1678 * \c mbedtls_ssl_conf_psk().
1680 * \param conf SSL configuration
1681 * \param f_psk PSK identity function
1682 * \param p_psk PSK identity parameter
1684 void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config
*conf
,
1685 int (*f_psk
)(void *, mbedtls_ssl_context
*, const unsigned char *,
1688 #endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
1690 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
1692 * \brief Set the Diffie-Hellman public P and G values,
1693 * read as hexadecimal strings (server-side only)
1694 * (Default: MBEDTLS_DHM_RFC5114_MODP_2048_[PG])
1696 * \param conf SSL configuration
1697 * \param dhm_P Diffie-Hellman-Merkle modulus
1698 * \param dhm_G Diffie-Hellman-Merkle generator
1700 * \return 0 if successful
1702 int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config
*conf
, const char *dhm_P
, const char *dhm_G
);
1705 * \brief Set the Diffie-Hellman public P and G values,
1706 * read from existing context (server-side only)
1708 * \param conf SSL configuration
1709 * \param dhm_ctx Diffie-Hellman-Merkle context
1711 * \return 0 if successful
1713 int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config
*conf
, mbedtls_dhm_context
*dhm_ctx
);
1714 #endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
1716 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1718 * \brief Set the minimum length for Diffie-Hellman parameters.
1719 * (Client-side only.)
1720 * (Default: 1024 bits.)
1722 * \param conf SSL configuration
1723 * \param bitlen Minimum bit length of the DHM prime
1725 void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config
*conf
,
1726 unsigned int bitlen
);
1727 #endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1729 #if defined(MBEDTLS_ECP_C)
1731 * \brief Set the allowed curves in order of preference.
1732 * (Default: all defined curves.)
1734 * On server: this only affects selection of the ECDHE curve;
1735 * the curves used for ECDH and ECDSA are determined by the
1736 * list of available certificates instead.
1738 * On client: this affects the list of curves offered for any
1739 * use. The server can override our preference order.
1741 * Both sides: limits the set of curves accepted for use in
1742 * ECDHE and in the peer's end-entity certificate.
1744 * \note This has no influence on which curves are allowed inside the
1745 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
1746 * for that. For the end-entity certificate however, the key
1747 * will be accepted only if it is allowed both by this list
1748 * and by the cert profile.
1750 * \note This list should be ordered by decreasing preference
1751 * (preferred curve first).
1753 * \param conf SSL configuration
1754 * \param curves Ordered list of allowed curves,
1755 * terminated by MBEDTLS_ECP_DP_NONE.
1757 void mbedtls_ssl_conf_curves( mbedtls_ssl_config
*conf
,
1758 const mbedtls_ecp_group_id
*curves
);
1759 #endif /* MBEDTLS_ECP_C */
1761 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
1763 * \brief Set the allowed hashes for signatures during the handshake.
1764 * (Default: all available hashes except MD5.)
1766 * \note This only affects which hashes are offered and can be used
1767 * for signatures during the handshake. Hashes for message
1768 * authentication and the TLS PRF are controlled by the
1769 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
1770 * used for certificate signature are controlled by the
1771 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
1773 * \note This list should be ordered by decreasing preference
1774 * (preferred hash first).
1776 * \param conf SSL configuration
1777 * \param hashes Ordered list of allowed signature hashes,
1778 * terminated by \c MBEDTLS_MD_NONE.
1780 void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config
*conf
,
1781 const int *hashes
);
1782 #endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
1784 #if defined(MBEDTLS_X509_CRT_PARSE_C)
1786 * \brief Set the hostname to check against the received server
1787 * certificate. It sets the ServerName TLS extension too,
1788 * if the extension is enabled.
1789 * (client-side only)
1791 * \param ssl SSL context
1792 * \param hostname the server hostname
1794 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
1796 int mbedtls_ssl_set_hostname( mbedtls_ssl_context
*ssl
, const char *hostname
);
1797 #endif /* MBEDTLS_X509_CRT_PARSE_C */
1799 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1801 * \brief Set own certificate and key for the current handshake
1803 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
1806 * \param ssl SSL context
1807 * \param own_cert own public certificate chain
1808 * \param pk_key own private key
1810 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
1812 int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context
*ssl
,
1813 mbedtls_x509_crt
*own_cert
,
1814 mbedtls_pk_context
*pk_key
);
1817 * \brief Set the data required to verify peer certificate for the
1820 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
1823 * \param ssl SSL context
1824 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1825 * \param ca_crl trusted CA CRLs
1827 void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context
*ssl
,
1828 mbedtls_x509_crt
*ca_chain
,
1829 mbedtls_x509_crl
*ca_crl
);
1832 * \brief Set authmode for the current handshake.
1834 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
1837 * \param ssl SSL context
1838 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
1839 * MBEDTLS_SSL_VERIFY_REQUIRED
1841 void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context
*ssl
,
1845 * \brief Set server side ServerName TLS extension callback
1846 * (optional, server-side only).
1848 * If set, the ServerName callback is called whenever the
1849 * server receives a ServerName TLS extension from the client
1850 * during a handshake. The ServerName callback has the
1851 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
1852 * const unsigned char *hostname, size_t len). If a suitable
1853 * certificate is found, the callback must set the
1854 * certificate(s) and key(s) to use with \c
1855 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
1856 * and may optionally adjust the CA and associated CRL with \c
1857 * mbedtls_ssl_set_hs_ca_chain() as well as the client
1858 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
1859 * then must return 0. If no matching name is found, the
1860 * callback must either set a default cert, or
1861 * return non-zero to abort the handshake at this point.
1863 * \param conf SSL configuration
1864 * \param f_sni verification function
1865 * \param p_sni verification parameter
1867 void mbedtls_ssl_conf_sni( mbedtls_ssl_config
*conf
,
1868 int (*f_sni
)(void *, mbedtls_ssl_context
*, const unsigned char *,
1871 #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1873 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
1875 * \brief Set the EC J-PAKE password for current handshake.
1877 * \note An internal copy is made, and destroyed as soon as the
1878 * handshake is completed, or when the SSL context is reset or
1881 * \note The SSL context needs to be already set up. The right place
1882 * to call this function is between \c mbedtls_ssl_setup() or
1883 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
1885 * \param ssl SSL context
1886 * \param pw EC J-PAKE password (pre-shared secret)
1887 * \param pw_len length of pw in bytes
1889 * \return 0 on success, or a negative error code.
1891 int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context
*ssl
,
1892 const unsigned char *pw
,
1894 #endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
1896 #if defined(MBEDTLS_SSL_ALPN)
1898 * \brief Set the supported Application Layer Protocols.
1900 * \param conf SSL configuration
1901 * \param protos Pointer to a NULL-terminated list of supported protocols,
1902 * in decreasing preference order. The pointer to the list is
1903 * recorded by the library for later reference as required, so
1904 * the lifetime of the table must be atleast as long as the
1905 * lifetime of the SSL configuration structure.
1907 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
1909 int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config
*conf
, const char **protos
);
1912 * \brief Get the name of the negotiated Application Layer Protocol.
1913 * This function should be called after the handshake is
1916 * \param ssl SSL context
1918 * \return Protcol name, or NULL if no protocol was negotiated.
1920 const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context
*ssl
);
1921 #endif /* MBEDTLS_SSL_ALPN */
1924 * \brief Set the maximum supported version sent from the client side
1925 * and/or accepted at the server side
1926 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
1928 * \note This ignores ciphersuites from higher versions.
1930 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1931 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1933 * \param conf SSL configuration
1934 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1935 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1936 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1937 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
1939 void mbedtls_ssl_conf_max_version( mbedtls_ssl_config
*conf
, int major
, int minor
);
1942 * \brief Set the minimum accepted SSL/TLS protocol version
1943 * (Default: TLS 1.0)
1945 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
1946 * SSL_MIN_XXXXX_VERSION range is ignored.
1948 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
1950 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1951 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1953 * \param conf SSL configuration
1954 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1955 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1956 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1957 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
1959 void mbedtls_ssl_conf_min_version( mbedtls_ssl_config
*conf
, int major
, int minor
);
1961 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1963 * \brief Set the fallback flag (client-side only).
1964 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
1966 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
1967 * connection, that is a connection with max_version set to a
1968 * lower value than the value you're willing to use. Such
1969 * fallback connections are not recommended but are sometimes
1970 * necessary to interoperate with buggy (version-intolerant)
1973 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
1974 * non-fallback connections! This would appear to work for a
1975 * while, then cause failures when the server is upgraded to
1976 * support a newer TLS version.
1978 * \param conf SSL configuration
1979 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
1981 void mbedtls_ssl_conf_fallback( mbedtls_ssl_config
*conf
, char fallback
);
1982 #endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
1984 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1986 * \brief Enable or disable Encrypt-then-MAC
1987 * (Default: MBEDTLS_SSL_ETM_ENABLED)
1989 * \note This should always be enabled, it is a security
1990 * improvement, and should not cause any interoperability
1991 * issue (used only if the peer supports it too).
1993 * \param conf SSL configuration
1994 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
1996 void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config
*conf
, char etm
);
1997 #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
1999 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
2001 * \brief Enable or disable Extended Master Secret negotiation.
2002 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
2004 * \note This should always be enabled, it is a security fix to the
2005 * protocol, and should not cause any interoperability issue
2006 * (used only if the peer supports it too).
2008 * \param conf SSL configuration
2009 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
2011 void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config
*conf
, char ems
);
2012 #endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
2014 #if defined(MBEDTLS_ARC4_C)
2016 * \brief Disable or enable support for RC4
2017 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
2019 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
2020 * for security reasons. Use at your own risk.
2022 * \note This function is deprecated and will likely be removed in
2023 * a future version of the library.
2024 * RC4 is disabled by default at compile time and needs to be
2025 * actively enabled for use with legacy systems.
2027 * \param conf SSL configuration
2028 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
2030 void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config
*conf
, char arc4
);
2031 #endif /* MBEDTLS_ARC4_C */
2033 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2035 * \brief Set the maximum fragment length to emit and/or negotiate
2036 * (Default: MBEDTLS_SSL_MAX_CONTENT_LEN, usually 2^14 bytes)
2037 * (Server: set maximum fragment length to emit,
2038 * usually negotiated by the client during handshake
2039 * (Client: set maximum fragment length to emit *and*
2040 * negotiate with the server during handshake)
2042 * \param conf SSL configuration
2043 * \param mfl_code Code for maximum fragment length (allowed values:
2044 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2045 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
2047 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
2049 int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config
*conf
, unsigned char mfl_code
);
2050 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2052 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
2054 * \brief Activate negotiation of truncated HMAC
2055 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
2057 * \param conf SSL configuration
2058 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2059 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
2061 void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config
*conf
, int truncate
);
2062 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
2064 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
2066 * \brief Enable / Disable 1/n-1 record splitting
2067 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
2069 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2070 * Does not affect non-CBC ciphersuites in any version.
2072 * \param conf SSL configuration
2073 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2074 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
2076 void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config
*conf
, char split
);
2077 #endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
2079 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
2081 * \brief Enable / Disable session tickets (client only).
2082 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
2084 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
2086 * \param conf SSL configuration
2087 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2088 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
2090 void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config
*conf
, int use_tickets
);
2091 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
2093 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2095 * \brief Enable / Disable renegotiation support for connection when
2097 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
2099 * \warning It is recommended to always disable renegotation unless you
2100 * know you need it and you know what you're doing. In the
2101 * past, there have been several issues associated with
2102 * renegotiation or a poor understanding of its properties.
2104 * \note Server-side, enabling renegotiation also makes the server
2105 * susceptible to a resource DoS by a malicious client.
2107 * \param conf SSL configuration
2108 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
2109 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
2111 void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config
*conf
, int renegotiation
);
2112 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2115 * \brief Prevent or allow legacy renegotiation.
2116 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
2118 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
2119 * be established even if the peer does not support
2120 * secure renegotiation, but does not allow renegotiation
2121 * to take place if not secure.
2122 * (Interoperable and secure option)
2124 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
2125 * with non-upgraded peers. Allowing legacy renegotiation
2126 * makes the connection vulnerable to specific man in the
2127 * middle attacks. (See RFC 5746)
2128 * (Most interoperable and least secure option)
2130 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
2131 * if peer does not support secure renegotiation. Results
2132 * in interoperability issues with non-upgraded peers
2133 * that do not support renegotiation altogether.
2134 * (Most secure option, interoperability issues)
2136 * \param conf SSL configuration
2137 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
2138 * SSL_ALLOW_LEGACY_RENEGOTIATION or
2139 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
2141 void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config
*conf
, int allow_legacy
);
2143 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2145 * \brief Enforce renegotiation requests.
2146 * (Default: enforced, max_records = 16)
2148 * When we request a renegotiation, the peer can comply or
2149 * ignore the request. This function allows us to decide
2150 * whether to enforce our renegotiation requests by closing
2151 * the connection if the peer doesn't comply.
2153 * However, records could already be in transit from the peer
2154 * when the request is emitted. In order to increase
2155 * reliability, we can accept a number of records before the
2156 * expected handshake records.
2158 * The optimal value is highly dependent on the specific usage
2161 * \note With DTLS and server-initiated renegotiation, the
2162 * HelloRequest is retransmited every time mbedtls_ssl_read() times
2163 * out or receives Application Data, until:
2164 * - max_records records have beens seen, if it is >= 0, or
2165 * - the number of retransmits that would happen during an
2166 * actual handshake has been reached.
2167 * Please remember the request might be lost a few times
2168 * if you consider setting max_records to a really low value.
2170 * \warning On client, the grace period can only happen during
2171 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
2172 * which always behave as if max_record was 0. The reason is,
2173 * if we receive application data from the server, we need a
2174 * place to write it, which only happens during mbedtls_ssl_read().
2176 * \param conf SSL configuration
2177 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
2178 * enforce renegotiation, or a non-negative value to enforce
2179 * it but allow for a grace period of max_records records.
2181 void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config
*conf
, int max_records
);
2184 * \brief Set record counter threshold for periodic renegotiation.
2185 * (Default: 2^64 - 256.)
2187 * Renegotiation is automatically triggered when a record
2188 * counter (outgoing or ingoing) crosses the defined
2189 * threshold. The default value is meant to prevent the
2190 * connection from being closed when the counter is about to
2191 * reached its maximal value (it is not allowed to wrap).
2193 * Lower values can be used to enforce policies such as "keys
2194 * must be refreshed every N packets with cipher X".
2196 * \param conf SSL configuration
2197 * \param period The threshold value: a big-endian 64-bit number.
2198 * Set to 2^64 - 1 to disable periodic renegotiation
2200 void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config
*conf
,
2201 const unsigned char period
[8] );
2202 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2205 * \brief Return the number of data bytes available to read
2207 * \param ssl SSL context
2209 * \return how many bytes are available in the read buffer
2211 size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context
*ssl
);
2214 * \brief Return the result of the certificate verification
2216 * \param ssl SSL context
2218 * \return 0 if successful,
2219 * -1 if result is not available (eg because the handshake was
2220 * aborted too early), or
2221 * a combination of BADCERT_xxx and BADCRL_xxx flags, see
2224 uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context
*ssl
);
2227 * \brief Return the name of the current ciphersuite
2229 * \param ssl SSL context
2231 * \return a string containing the ciphersuite name
2233 const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context
*ssl
);
2236 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
2238 * \param ssl SSL context
2240 * \return a string containing the SSL version
2242 const char *mbedtls_ssl_get_version( const mbedtls_ssl_context
*ssl
);
2245 * \brief Return the (maximum) number of bytes added by the record
2246 * layer: header + encryption/MAC overhead (inc. padding)
2248 * \param ssl SSL context
2250 * \return Current maximum record expansion in bytes, or
2251 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
2252 * enabled, which makes expansion much less predictable
2254 int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context
*ssl
);
2256 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2258 * \brief Return the maximum fragment length (payload, in bytes).
2259 * This is the value negotiated with peer if any,
2260 * or the locally configured value.
2262 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
2263 * called with a larger length value.
2264 * With TLS, \c mbedtls_ssl_write() will fragment the input if
2265 * necessary and return the number of bytes written; it is up
2266 * to the caller to call \c mbedtls_ssl_write() again in
2267 * order to send the remaining bytes if any.
2269 * \param ssl SSL context
2271 * \return Current maximum fragment length.
2273 size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context
*ssl
);
2274 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2276 #if defined(MBEDTLS_X509_CRT_PARSE_C)
2278 * \brief Return the peer certificate from the current connection
2280 * Note: Can be NULL in case no certificate was sent during
2281 * the handshake. Different calls for the same connection can
2282 * return the same or different pointers for the same
2283 * certificate and even a different certificate altogether.
2284 * The peer cert CAN change in a single connection if
2285 * renegotiation is performed.
2287 * \param ssl SSL context
2289 * \return the current peer certificate
2291 const mbedtls_x509_crt
*mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context
*ssl
);
2292 #endif /* MBEDTLS_X509_CRT_PARSE_C */
2294 #if defined(MBEDTLS_SSL_CLI_C)
2296 * \brief Save session in order to resume it later (client-side only)
2297 * Session data is copied to presented session structure.
2299 * \warning Currently, peer certificate is lost in the operation.
2301 * \param ssl SSL context
2302 * \param session session context
2304 * \return 0 if successful,
2305 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
2306 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
2307 * arguments are otherwise invalid
2309 * \sa mbedtls_ssl_set_session()
2311 int mbedtls_ssl_get_session( const mbedtls_ssl_context
*ssl
, mbedtls_ssl_session
*session
);
2312 #endif /* MBEDTLS_SSL_CLI_C */
2315 * \brief Perform the SSL handshake
2317 * \param ssl SSL context
2319 * \return 0 if successful, or
2320 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2321 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED (see below), or
2322 * a specific SSL error code.
2324 * \note If this function returns something other than 0 or
2325 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2326 * becomes unusable, and you should either free it or call
2327 * \c mbedtls_ssl_session_reset() on it before re-using it for
2328 * a new connection; the current connection must be closed.
2330 * \note If DTLS is in use, then you may choose to handle
2331 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
2332 * purposes, as it is an expected return value rather than an
2333 * actual error, but you still need to reset/free the context.
2335 int mbedtls_ssl_handshake( mbedtls_ssl_context
*ssl
);
2338 * \brief Perform a single step of the SSL handshake
2340 * \note The state of the context (ssl->state) will be at
2341 * the next state after execution of this function. Do not
2342 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
2344 * \note If this function returns something other than 0 or
2345 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2346 * becomes unusable, and you should either free it or call
2347 * \c mbedtls_ssl_session_reset() on it before re-using it for
2348 * a new connection; the current connection must be closed.
2350 * \param ssl SSL context
2352 * \return 0 if successful, or
2353 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2354 * a specific SSL error code.
2356 int mbedtls_ssl_handshake_step( mbedtls_ssl_context
*ssl
);
2358 #if defined(MBEDTLS_SSL_RENEGOTIATION)
2360 * \brief Initiate an SSL renegotiation on the running connection.
2361 * Client: perform the renegotiation right now.
2362 * Server: request renegotiation, which will be performed
2363 * during the next call to mbedtls_ssl_read() if honored by
2366 * \param ssl SSL context
2368 * \return 0 if successful, or any mbedtls_ssl_handshake() return
2371 * \note If this function returns something other than 0 or
2372 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2373 * becomes unusable, and you should either free it or call
2374 * \c mbedtls_ssl_session_reset() on it before re-using it for
2375 * a new connection; the current connection must be closed.
2377 int mbedtls_ssl_renegotiate( mbedtls_ssl_context
*ssl
);
2378 #endif /* MBEDTLS_SSL_RENEGOTIATION */
2381 * \brief Read at most 'len' application data bytes
2383 * \param ssl SSL context
2384 * \param buf buffer that will hold the data
2385 * \param len maximum number of bytes to read
2387 * \return the number of bytes read, or
2389 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2390 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT (see below), or
2391 * another negative error code.
2393 * \note If this function returns something other than a positive
2394 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE or
2395 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT, then the ssl context
2396 * becomes unusable, and you should either free it or call
2397 * \c mbedtls_ssl_session_reset() on it before re-using it for
2398 * a new connection; the current connection must be closed.
2400 * \note When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
2401 * (which can only happen server-side), it means that a client
2402 * is initiating a new connection using the same source port.
2403 * You can either treat that as a connection close and wait
2404 * for the client to resend a ClientHello, or directly
2405 * continue with \c mbedtls_ssl_handshake() with the same
2406 * context (as it has beeen reset internally). Either way, you
2407 * should make sure this is seen by the application as a new
2408 * connection: application state, if any, should be reset, and
2409 * most importantly the identity of the client must be checked
2410 * again. WARNING: not validating the identity of the client
2411 * again, or not transmitting the new identity to the
2412 * application layer, would allow authentication bypass!
2414 int mbedtls_ssl_read( mbedtls_ssl_context
*ssl
, unsigned char *buf
, size_t len
);
2417 * \brief Try to write exactly 'len' application data bytes
2419 * \warning This function will do partial writes in some cases. If the
2420 * return value is non-negative but less than length, the
2421 * function must be called again with updated arguments:
2422 * buf + ret, len - ret (if ret is the return value) until
2423 * it returns a value equal to the last 'len' argument.
2425 * \param ssl SSL context
2426 * \param buf buffer holding the data
2427 * \param len how many bytes must be written
2429 * \return the number of bytes actually written (may be less than len),
2430 * or MBEDTLS_ERR_SSL_WANT_WRITE of MBEDTLS_ERR_SSL_WANT_READ,
2431 * or another negative error code.
2433 * \note If this function returns something other than a positive
2434 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, the ssl context
2435 * becomes unusable, and you should either free it or call
2436 * \c mbedtls_ssl_session_reset() on it before re-using it for
2437 * a new connection; the current connection must be closed.
2439 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
2440 * it must be called later with the *same* arguments,
2441 * until it returns a positive value.
2443 * \note If the requested length is greater than the maximum
2444 * fragment length (either the built-in limit or the one set
2445 * or negotiated with the peer), then:
2446 * - with TLS, less bytes than requested are written.
2447 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
2448 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
2449 * active maximum fragment length.
2451 int mbedtls_ssl_write( mbedtls_ssl_context
*ssl
, const unsigned char *buf
, size_t len
);
2454 * \brief Send an alert message
2456 * \param ssl SSL context
2457 * \param level The alert level of the message
2458 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
2459 * \param message The alert message (SSL_ALERT_MSG_*)
2461 * \return 0 if successful, or a specific SSL error code.
2463 * \note If this function returns something other than 0 or
2464 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2465 * becomes unusable, and you should either free it or call
2466 * \c mbedtls_ssl_session_reset() on it before re-using it for
2467 * a new connection; the current connection must be closed.
2469 int mbedtls_ssl_send_alert_message( mbedtls_ssl_context
*ssl
,
2470 unsigned char level
,
2471 unsigned char message
);
2473 * \brief Notify the peer that the connection is being closed
2475 * \param ssl SSL context
2477 * \return 0 if successful, or a specific SSL error code.
2479 * \note If this function returns something other than 0 or
2480 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2481 * becomes unusable, and you should either free it or call
2482 * \c mbedtls_ssl_session_reset() on it before re-using it for
2483 * a new connection; the current connection must be closed.
2485 int mbedtls_ssl_close_notify( mbedtls_ssl_context
*ssl
);
2488 * \brief Free referenced items in an SSL context and clear memory
2490 * \param ssl SSL context
2492 void mbedtls_ssl_free( mbedtls_ssl_context
*ssl
);
2495 * \brief Initialize an SSL configuration context
2496 * Just makes the context ready for
2497 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
2499 * \note You need to call mbedtls_ssl_config_defaults() unless you
2500 * manually set all of the relevent fields yourself.
2502 * \param conf SSL configuration context
2504 void mbedtls_ssl_config_init( mbedtls_ssl_config
*conf
);
2507 * \brief Load reasonnable default SSL configuration values.
2508 * (You need to call mbedtls_ssl_config_init() first.)
2510 * \param conf SSL configuration context
2511 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
2512 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
2513 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
2514 * \param preset a MBEDTLS_SSL_PRESET_XXX value
2515 * (currently unused).
2517 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
2519 * \return 0 if successful, or
2520 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
2522 int mbedtls_ssl_config_defaults( mbedtls_ssl_config
*conf
,
2523 int endpoint
, int transport
, int preset
);
2526 * \brief Free an SSL configuration context
2528 * \param conf SSL configuration context
2530 void mbedtls_ssl_config_free( mbedtls_ssl_config
*conf
);
2533 * \brief Initialize SSL session structure
2535 * \param session SSL session
2537 void mbedtls_ssl_session_init( mbedtls_ssl_session
*session
);
2540 * \brief Free referenced items in an SSL session including the
2541 * peer certificate and clear memory
2543 * \param session SSL session
2545 void mbedtls_ssl_session_free( mbedtls_ssl_session
*session
);