1 /** 2 * \file ssl.h 3 * 4 * \brief SSL/TLS functions. 5 * 6 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved 7 * SPDX-License-Identifier: Apache-2.0 8 * 9 * Licensed under the Apache License, Version 2.0 (the "License"); you may 10 * not use this file except in compliance with the License. 11 * You may obtain a copy of the License at 12 * 13 * http://www.apache.org/licenses/LICENSE-2.0 14 * 15 * Unless required by applicable law or agreed to in writing, software 16 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 17 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 18 * See the License for the specific language governing permissions and 19 * limitations under the License. 20 * 21 * This file is part of mbed TLS (https://tls.mbed.org) 22 */ 23 #ifndef MBEDTLS_SSL_H 24 #define MBEDTLS_SSL_H 25 26 #if !defined(MBEDTLS_CONFIG_FILE) 27 #include "config.h" 28 #else 29 #include MBEDTLS_CONFIG_FILE 30 #endif 31 32 #include "bignum.h" 33 #include "ecp.h" 34 35 #include "ssl_ciphersuites.h" 36 37 #if defined(MBEDTLS_X509_CRT_PARSE_C) 38 #include "x509_crt.h" 39 #include "x509_crl.h" 40 #endif 41 42 #if defined(MBEDTLS_DHM_C) 43 #include "dhm.h" 44 #endif 45 46 #if defined(MBEDTLS_ECDH_C) 47 #include "ecdh.h" 48 #endif 49 50 #if defined(MBEDTLS_ZLIB_SUPPORT) 51 #include "zlib.h" 52 #endif 53 54 #if defined(MBEDTLS_HAVE_TIME) 55 #include "mbedtls/platform_time.h" 56 #endif 57 58 /* 59 * SSL Error codes 60 */ 61 #define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */ 62 #define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */ 63 #define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */ 64 #define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */ 65 #define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */ 66 #define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */ 67 #define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */ 68 #define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */ 69 #define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */ 70 #define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */ 71 #define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */ 72 #define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */ 73 #define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */ 74 #define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */ 75 #define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */ 76 #define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */ 77 #define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */ 78 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */ 79 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */ 80 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */ 81 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */ 82 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */ 83 #define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */ 84 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */ 85 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */ 86 #define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */ 87 #define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */ 88 #define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */ 89 #define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */ 90 #define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */ 91 #define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */ 92 #define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */ 93 #define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */ 94 #define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */ 95 #define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */ 96 #define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */ 97 #define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */ 98 #define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */ 99 #define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */ 100 #define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */ 101 #define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */ 102 #define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */ 103 #define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */ 104 #define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */ 105 #define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< Connection requires a read call. */ 106 #define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */ 107 #define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */ 108 #define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */ 109 #define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */ 110 #define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */ 111 #define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */ 112 113 /* 114 * Various constants 115 */ 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 */ 121 122 #define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */ 123 #define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */ 124 125 #define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */ 126 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 */ 135 136 #define MBEDTLS_SSL_IS_CLIENT 0 137 #define MBEDTLS_SSL_IS_SERVER 1 138 139 #define MBEDTLS_SSL_IS_NOT_FALLBACK 0 140 #define MBEDTLS_SSL_IS_FALLBACK 1 141 142 #define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0 143 #define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1 144 145 #define MBEDTLS_SSL_ETM_DISABLED 0 146 #define MBEDTLS_SSL_ETM_ENABLED 1 147 148 #define MBEDTLS_SSL_COMPRESS_NULL 0 149 #define MBEDTLS_SSL_COMPRESS_DEFLATE 1 150 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 */ 155 156 #define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0 157 #define MBEDTLS_SSL_SECURE_RENEGOTIATION 1 158 159 #define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0 160 #define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1 161 162 #define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0 163 #define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1 164 165 #define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1 166 #define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16 167 168 #define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0 169 #define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1 170 #define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2 171 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 */ 175 176 #define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0 177 #define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1 178 179 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0 180 #define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1 181 182 #define MBEDTLS_SSL_ARC4_ENABLED 0 183 #define MBEDTLS_SSL_ARC4_DISABLED 1 184 185 #define MBEDTLS_SSL_PRESET_DEFAULT 0 186 #define MBEDTLS_SSL_PRESET_SUITEB 2 187 188 /* 189 * Default range for DTLS retransmission timer value, in milliseconds. 190 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds. 191 */ 192 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000 193 #define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000 194 195 /** 196 * \name SECTION: Module settings 197 * 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. 200 * \{ 201 */ 202 203 #if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME) 204 #define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */ 205 #endif 206 207 /* 208 * Maxium fragment length in bytes, 209 * determines the size of each of the two internal I/O buffers. 210 * 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! 217 */ 218 #if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN) 219 #define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */ 220 #endif 221 222 /* \} name SECTION: Module settings */ 223 224 /* 225 * Length of the verify data for secure renegotiation 226 */ 227 #if defined(MBEDTLS_SSL_PROTO_SSL3) 228 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36 229 #else 230 #define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12 231 #endif 232 233 /* 234 * Signaling ciphersuite values (SCSV) 235 */ 236 #define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */ 237 #define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */ 238 239 /* 240 * Supported Signature and Hash algorithms (For TLS 1.2) 241 * RFC 5246 section 7.4.1.4.1 242 */ 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 250 251 #define MBEDTLS_SSL_SIG_ANON 0 252 #define MBEDTLS_SSL_SIG_RSA 1 253 #define MBEDTLS_SSL_SIG_ECDSA 3 254 255 /* 256 * Client Certificate Types 257 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5 258 */ 259 #define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1 260 #define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64 261 262 /* 263 * Message, alert and handshake types 264 */ 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 269 270 #define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1 271 #define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2 272 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 */ 302 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 315 316 /* 317 * TLS extensions 318 */ 319 #define MBEDTLS_TLS_EXT_SERVERNAME 0 320 #define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0 321 322 #define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1 323 324 #define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4 325 326 #define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10 327 #define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11 328 329 #define MBEDTLS_TLS_EXT_SIG_ALG 13 330 331 #define MBEDTLS_TLS_EXT_ALPN 16 332 333 #define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */ 334 #define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */ 335 336 #define MBEDTLS_TLS_EXT_SESSION_TICKET 35 337 338 #define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */ 339 340 #define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01 341 342 /* 343 * Size defines 344 */ 345 #if !defined(MBEDTLS_PSK_MAX_LEN) 346 #define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */ 347 #endif 348 349 /* Dummy type used only for its size */ 350 union mbedtls_ssl_premaster_secret 351 { 352 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED) 353 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */ 354 #endif 355 #if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED) 356 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */ 357 #endif 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 */ 363 #endif 364 #if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) 365 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */ 366 #endif 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 */ 370 #endif 371 #if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) 372 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */ 373 #endif 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 */ 377 #endif 378 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) 379 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */ 380 #endif 381 }; 382 383 #define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret ) 384 385 #ifdef __cplusplus 386 extern "C" { 387 #endif 388 389 /* 390 * SSL state machine 391 */ 392 typedef enum 393 { 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, 413 } 414 mbedtls_ssl_states; 415 416 /** 417 * \brief Callback type: send data on the network. 418 * 419 * \note That callback may be either blocking or non-blocking. 420 * 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 424 * 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. 429 * 430 * \note The callback is allowed to send fewer bytes than requested. 431 * It must always return the number of bytes actually sent. 432 */ 433 typedef int mbedtls_ssl_send_t( void *ctx, 434 const unsigned char *buf, 435 size_t len ); 436 437 /** 438 * \brief Callback type: receive data from the network. 439 * 440 * \note That callback may be either blocking or non-blocking. 441 * 442 * \param ctx Context for the receive callback (typically a file 443 * descriptor) 444 * \param buf Buffer to write the received data to 445 * \param len Length of the receive buffer 446 * 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. 451 * 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. 455 */ 456 typedef int mbedtls_ssl_recv_t( void *ctx, 457 unsigned char *buf, 458 size_t len ); 459 460 /** 461 * \brief Callback type: receive data from the network, with timeout 462 * 463 * \note That callback must block until data is received, or the 464 * timeout delay expires, or the operation is interrupted by a 465 * signal. 466 * 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) 472 * 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. 477 * 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. 481 */ 482 typedef int mbedtls_ssl_recv_timeout_t( void *ctx, 483 unsigned char *buf, 484 size_t len, 485 uint32_t timeout ); 486 /** 487 * \brief Callback type: set a pair of timers/delays to watch 488 * 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. 493 * 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. 497 * 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. 503 * 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. 507 */ 508 typedef void mbedtls_ssl_set_timer_t( void * ctx, 509 uint32_t int_ms, 510 uint32_t fin_ms ); 511 512 /** 513 * \brief Callback type: get status of timers/delays 514 * 515 * \param ctx Context pointer 516 * 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. 522 */ 523 typedef int mbedtls_ssl_get_timer_t( void * ctx ); 524 525 526 /* Defined below */ 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; 530 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; 536 #endif 537 #if defined(MBEDTLS_SSL_PROTO_DTLS) 538 typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item; 539 #endif 540 541 /* 542 * This structure is used for storing current session data. 543 */ 544 struct mbedtls_ssl_session 545 { 546 #if defined(MBEDTLS_HAVE_TIME) 547 mbedtls_time_t start; /*!< starting time */ 548 #endif 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 */ 554 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 */ 559 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 */ 565 566 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) 567 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */ 568 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */ 569 570 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC) 571 int trunc_hmac; /*!< flag for truncated hmac activation */ 572 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */ 573 574 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) 575 int encrypt_then_mac; /*!< flag for EtM activation */ 576 #endif 577 }; 578 579 /** 580 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures. 581 */ 582 struct mbedtls_ssl_config 583 { 584 /* Group items by size (largest first) to minimize padding overhead */ 585 586 /* 587 * Pointers 588 */ 589 590 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */ 591 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 */ 595 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 */ 599 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 */ 605 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 */ 610 #endif 611 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 */ 616 #endif 617 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 */ 622 #endif 623 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 */ 632 #endif 633 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 */ 642 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 */ 648 #endif 649 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 */ 656 657 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) 658 const int *sig_hashes; /*!< allowed signature hashes */ 659 #endif 660 661 #if defined(MBEDTLS_ECP_C) 662 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */ 663 #endif 664 665 #if defined(MBEDTLS_DHM_C) 666 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */ 667 mbedtls_mpi dhm_G; /*!< generator for DHM */ 668 #endif 669 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 */ 675 #endif 676 677 #if defined(MBEDTLS_SSL_ALPN) 678 const char **alpn_list; /*!< ordered list of protocols */ 679 #endif 680 681 /* 682 * Numerical settings (int then char) 683 */ 684 685 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */ 686 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) */ 692 #endif 693 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 */ 698 #endif 699 700 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT) 701 unsigned int badmac_limit; /*!< limit of records with a bad MAC */ 702 #endif 703 704 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C) 705 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */ 706 #endif 707 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 */ 712 713 /* 714 * Flags (bitfields) 715 */ 716 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? */ 724 #endif 725 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) 726 unsigned int mfl_code : 3; /*!< desired fragment length */ 727 #endif 728 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) 729 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */ 730 #endif 731 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) 732 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */ 733 #endif 734 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) 735 unsigned int anti_replay : 1; /*!< detect and prevent replay? */ 736 #endif 737 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING) 738 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */ 739 #endif 740 #if defined(MBEDTLS_SSL_RENEGOTIATION) 741 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */ 742 #endif 743 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC) 744 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */ 745 #endif 746 #if defined(MBEDTLS_SSL_SESSION_TICKETS) 747 unsigned int session_tickets : 1; /*!< use session tickets? */ 748 #endif 749 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C) 750 unsigned int fallback : 1; /*!< is this a fallback? */ 751 #endif 752 }; 753 754 755 struct mbedtls_ssl_context 756 { 757 const mbedtls_ssl_config *conf; /*!< configuration information */ 758 759 /* 760 * Miscellaneous 761 */ 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 */ 768 #endif 769 770 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */ 771 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */ 772 773 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT) 774 unsigned badmac_seen; /*!< records with a bad MAC received */ 775 #endif 776 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 */ 781 782 void *p_bio; /*!< context for I/O operations */ 783 784 /* 785 * Session layer 786 */ 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 */ 791 792 mbedtls_ssl_handshake_params *handshake; /*!< params required only during 793 the handshake process */ 794 795 /* 796 * Record layer transformations 797 */ 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 */ 802 803 /* 804 * Timers 805 */ 806 void *p_timer; /*!< context for the timer callbacks */ 807 808 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */ 809 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */ 810 811 /* 812 * Record layer (incoming data) 813 */ 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 */ 823 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) */ 831 #endif 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 */ 835 #endif 836 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 */ 841 842 /* 843 * Record layer (outgoing data) 844 */ 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) */ 851 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 */ 855 856 #if defined(MBEDTLS_ZLIB_SUPPORT) 857 unsigned char *compress_buf; /*!< zlib data buffer */ 858 #endif 859 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING) 860 signed char split_done; /*!< current record already splitted? */ 861 #endif 862 863 /* 864 * PKI layer 865 */ 866 int client_auth; /*!< flag for client auth. */ 867 868 /* 869 * User settings 870 */ 871 #if defined(MBEDTLS_X509_CRT_PARSE_C) 872 char *hostname; /*!< expected peer CN for verification 873 (and SNI if available) */ 874 #endif 875 876 #if defined(MBEDTLS_SSL_ALPN) 877 const char *alpn_chosen; /*!< negotiated protocol */ 878 #endif 879 880 /* 881 * Information for DTLS hello verify 882 */ 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 */ 886 #endif 887 888 /* 889 * Secure renegotiation 890 */ 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 */ 898 #endif 899 }; 900 901 #if defined(MBEDTLS_SSL_HW_RECORD_ACCEL) 902 903 #define MBEDTLS_SSL_CHANNEL_OUTBOUND 0 904 #define MBEDTLS_SSL_CHANNEL_INBOUND 1 905 906 extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl, 907 const unsigned char *key_enc, const unsigned char *key_dec, 908 size_t keylen, 909 const unsigned char *iv_enc, const unsigned char *iv_dec, 910 size_t ivlen, 911 const unsigned char *mac_enc, const unsigned char *mac_dec, 912 size_t maclen); 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 */ 919 920 /** 921 * \brief Returns the list of ciphersuites supported by the SSL/TLS module. 922 * 923 * \return a statically allocated array of ciphersuites, the last 924 * entry is 0. 925 */ 926 const int *mbedtls_ssl_list_ciphersuites( void ); 927 928 /** 929 * \brief Return the name of the ciphersuite associated with the 930 * given ID 931 * 932 * \param ciphersuite_id SSL ciphersuite ID 933 * 934 * \return a string containing the ciphersuite name 935 */ 936 const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id ); 937 938 /** 939 * \brief Return the ID of the ciphersuite associated with the 940 * given name 941 * 942 * \param ciphersuite_name SSL ciphersuite name 943 * 944 * \return the ID with the ciphersuite or 0 if not found 945 */ 946 int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name ); 947 948 /** 949 * \brief Initialize an SSL context 950 * Just makes the context ready for mbedtls_ssl_setup() or 951 * mbedtls_ssl_free() 952 * 953 * \param ssl SSL context 954 */ 955 void mbedtls_ssl_init( mbedtls_ssl_context *ssl ); 956 957 /** 958 * \brief Set up an SSL context for use 959 * 960 * \note No copy of the configuration context is made, it can be 961 * shared by many mbedtls_ssl_context structures. 962 * 963 * \warning Modifying the conf structure after it has been used in this 964 * function is unsupported! 965 * 966 * \param ssl SSL context 967 * \param conf SSL configuration to use 968 * 969 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if 970 * memory allocation failed 971 */ 972 int mbedtls_ssl_setup( mbedtls_ssl_context *ssl, 973 const mbedtls_ssl_config *conf ); 974 975 /** 976 * \brief Reset an already initialized SSL context for re-use 977 * while retaining application-set variables, function 978 * pointers and data. 979 * 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 984 */ 985 int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl ); 986 987 /** 988 * \brief Set the current endpoint type 989 * 990 * \param conf SSL configuration 991 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER 992 */ 993 void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint ); 994 995 /** 996 * \brief Set the transport type (TLS or DTLS). 997 * Default: TLS 998 * 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(). 1003 * 1004 * \param conf SSL configuration 1005 * \param transport transport type: 1006 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS, 1007 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS. 1008 */ 1009 void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport ); 1010 1011 /** 1012 * \brief Set the certificate verification mode 1013 * Default: NONE on server, REQUIRED on client 1014 * 1015 * \param conf SSL configuration 1016 * \param authmode can be: 1017 * 1018 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked 1019 * (default on server) 1020 * (insecure on client) 1021 * 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. 1026 * 1027 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate, 1028 * handshake is aborted if verification failed. 1029 * (default on client) 1030 * 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. 1036 */ 1037 void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode ); 1038 1039 #if defined(MBEDTLS_X509_CRT_PARSE_C) 1040 /** 1041 * \brief Set the verification callback (Optional). 1042 * 1043 * If set, the verify callback is called for each 1044 * certificate in the chain. For implementation 1045 * information, please see \c x509parse_verify() 1046 * 1047 * \param conf SSL configuration 1048 * \param f_vrfy verification function 1049 * \param p_vrfy verification parameter 1050 */ 1051 void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf, 1052 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *), 1053 void *p_vrfy ); 1054 #endif /* MBEDTLS_X509_CRT_PARSE_C */ 1055 1056 /** 1057 * \brief Set the random number generator callback 1058 * 1059 * \param conf SSL configuration 1060 * \param f_rng RNG function 1061 * \param p_rng RNG parameter 1062 */ 1063 void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf, 1064 int (*f_rng)(void *, unsigned char *, size_t), 1065 void *p_rng ); 1066 1067 /** 1068 * \brief Set the debug callback 1069 * 1070 * The callback has the following argument: 1071 * void * opaque context for the callback 1072 * int debug level 1073 * const char * file name 1074 * int line number 1075 * const char * message 1076 * 1077 * \param conf SSL configuration 1078 * \param f_dbg debug function 1079 * \param p_dbg debug parameter 1080 */ 1081 void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf, 1082 void (*f_dbg)(void *, int, const char *, int, const char *), 1083 void *p_dbg ); 1084 1085 /** 1086 * \brief Set the underlying BIO callbacks for write, read and 1087 * read-with-timeout. 1088 * 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. 1094 * 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). 1098 * 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 1102 * 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. 1105 * 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. 1109 * 1110 * \note On some platforms, net_sockets.c provides 1111 * \c mbedtls_net_send(), \c mbedtls_net_recv() and 1112 * \c mbedtls_net_recv_timeout() that are suitable to be used 1113 * here. 1114 */ 1115 void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl, 1116 void *p_bio, 1117 mbedtls_ssl_send_t *f_send, 1118 mbedtls_ssl_recv_t *f_recv, 1119 mbedtls_ssl_recv_timeout_t *f_recv_timeout ); 1120 1121 /** 1122 * \brief Set the timeout period for mbedtls_ssl_read() 1123 * (Default: no timeout.) 1124 * 1125 * \param conf SSL configuration context 1126 * \param timeout Timeout value in milliseconds. 1127 * Use 0 for no timeout (default). 1128 * 1129 * \note With blocking I/O, this will only work if a non-NULL 1130 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio(). 1131 * With non-blocking I/O, this will only work if timer 1132 * callbacks were set with \c mbedtls_ssl_set_timer_cb(). 1133 * 1134 * \note With non-blocking I/O, you may also skip this function 1135 * altogether and handle timeouts at the application layer. 1136 */ 1137 void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout ); 1138 1139 /** 1140 * \brief Set the timer callbacks (Mandatory for DTLS.) 1141 * 1142 * \param ssl SSL context 1143 * \param p_timer parameter (context) shared by timer callbacks 1144 * \param f_set_timer set timer callback 1145 * \param f_get_timer get timer callback. Must return: 1146 * 1147 * \note See the documentation of \c mbedtls_ssl_set_timer_t and 1148 * \c mbedtls_ssl_get_timer_t for the conventions this pair of 1149 * callbacks must fallow. 1150 * 1151 * \note On some platforms, timing.c provides 1152 * \c mbedtls_timing_set_delay() and 1153 * \c mbedtls_timing_get_delay() that are suitable for using 1154 * here, except if using an event-driven style. 1155 * 1156 * \note See also the "DTLS tutorial" article in our knowledge base. 1157 * https://tls.mbed.org/kb/how-to/dtls-tutorial 1158 */ 1159 void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl, 1160 void *p_timer, 1161 mbedtls_ssl_set_timer_t *f_set_timer, 1162 mbedtls_ssl_get_timer_t *f_get_timer ); 1163 1164 /** 1165 * \brief Callback type: generate and write session ticket 1166 * 1167 * \note This describes what a callback implementation should do. 1168 * This callback should generate an encrypted and 1169 * authenticated ticket for the session and write it to the 1170 * output buffer. Here, ticket means the opaque ticket part 1171 * of the NewSessionTicket structure of RFC 5077. 1172 * 1173 * \param p_ticket Context for the callback 1174 * \param session SSL session to be written in the ticket 1175 * \param start Start of the output buffer 1176 * \param end End of the output buffer 1177 * \param tlen On exit, holds the length written 1178 * \param lifetime On exit, holds the lifetime of the ticket in seconds 1179 * 1180 * \return 0 if successful, or 1181 * a specific MBEDTLS_ERR_XXX code. 1182 */ 1183 typedef int mbedtls_ssl_ticket_write_t( void *p_ticket, 1184 const mbedtls_ssl_session *session, 1185 unsigned char *start, 1186 const unsigned char *end, 1187 size_t *tlen, 1188 uint32_t *lifetime ); 1189 1190 #if defined(MBEDTLS_SSL_EXPORT_KEYS) 1191 /** 1192 * \brief Callback type: Export key block and master secret 1193 * 1194 * \note This is required for certain uses of TLS, e.g. EAP-TLS 1195 * (RFC 5216) and Thread. The key pointers are ephemeral and 1196 * therefore must not be stored. The master secret and keys 1197 * should not be used directly except as an input to a key 1198 * derivation function. 1199 * 1200 * \param p_expkey Context for the callback 1201 * \param ms Pointer to master secret (fixed length: 48 bytes) 1202 * \param kb Pointer to key block, see RFC 5246 section 6.3 1203 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen). 1204 * \param maclen MAC length 1205 * \param keylen Key length 1206 * \param ivlen IV length 1207 * 1208 * \return 0 if successful, or 1209 * a specific MBEDTLS_ERR_XXX code. 1210 */ 1211 typedef int mbedtls_ssl_export_keys_t( void *p_expkey, 1212 const unsigned char *ms, 1213 const unsigned char *kb, 1214 size_t maclen, 1215 size_t keylen, 1216 size_t ivlen ); 1217 #endif /* MBEDTLS_SSL_EXPORT_KEYS */ 1218 1219 /** 1220 * \brief Callback type: parse and load session ticket 1221 * 1222 * \note This describes what a callback implementation should do. 1223 * This callback should parse a session ticket as generated 1224 * by the corresponding mbedtls_ssl_ticket_write_t function, 1225 * and, if the ticket is authentic and valid, load the 1226 * session. 1227 * 1228 * \note The implementation is allowed to modify the first len 1229 * bytes of the input buffer, eg to use it as a temporary 1230 * area for the decrypted ticket contents. 1231 * 1232 * \param p_ticket Context for the callback 1233 * \param session SSL session to be loaded 1234 * \param buf Start of the buffer containing the ticket 1235 * \param len Length of the ticket. 1236 * 1237 * \return 0 if successful, or 1238 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or 1239 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or 1240 * any other non-zero code for other failures. 1241 */ 1242 typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket, 1243 mbedtls_ssl_session *session, 1244 unsigned char *buf, 1245 size_t len ); 1246 1247 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C) 1248 /** 1249 * \brief Configure SSL session ticket callbacks (server only). 1250 * (Default: none.) 1251 * 1252 * \note On server, session tickets are enabled by providing 1253 * non-NULL callbacks. 1254 * 1255 * \note On client, use \c mbedtls_ssl_conf_session_tickets(). 1256 * 1257 * \param conf SSL configuration context 1258 * \param f_ticket_write Callback for writing a ticket 1259 * \param f_ticket_parse Callback for parsing a ticket 1260 * \param p_ticket Context shared by the two callbacks 1261 */ 1262 void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf, 1263 mbedtls_ssl_ticket_write_t *f_ticket_write, 1264 mbedtls_ssl_ticket_parse_t *f_ticket_parse, 1265 void *p_ticket ); 1266 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */ 1267 1268 #if defined(MBEDTLS_SSL_EXPORT_KEYS) 1269 /** 1270 * \brief Configure key export callback. 1271 * (Default: none.) 1272 * 1273 * \note See \c mbedtls_ssl_export_keys_t. 1274 * 1275 * \param conf SSL configuration context 1276 * \param f_export_keys Callback for exporting keys 1277 * \param p_export_keys Context for the callback 1278 */ 1279 void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf, 1280 mbedtls_ssl_export_keys_t *f_export_keys, 1281 void *p_export_keys ); 1282 #endif /* MBEDTLS_SSL_EXPORT_KEYS */ 1283 1284 /** 1285 * \brief Callback type: generate a cookie 1286 * 1287 * \param ctx Context for the callback 1288 * \param p Buffer to write to, 1289 * must be updated to point right after the cookie 1290 * \param end Pointer to one past the end of the output buffer 1291 * \param info Client ID info that was passed to 1292 * \c mbedtls_ssl_set_client_transport_id() 1293 * \param ilen Length of info in bytes 1294 * 1295 * \return The callback must return 0 on success, 1296 * or a negative error code. 1297 */ 1298 typedef int mbedtls_ssl_cookie_write_t( void *ctx, 1299 unsigned char **p, unsigned char *end, 1300 const unsigned char *info, size_t ilen ); 1301 1302 /** 1303 * \brief Callback type: verify a cookie 1304 * 1305 * \param ctx Context for the callback 1306 * \param cookie Cookie to verify 1307 * \param clen Length of cookie 1308 * \param info Client ID info that was passed to 1309 * \c mbedtls_ssl_set_client_transport_id() 1310 * \param ilen Length of info in bytes 1311 * 1312 * \return The callback must return 0 if cookie is valid, 1313 * or a negative error code. 1314 */ 1315 typedef int mbedtls_ssl_cookie_check_t( void *ctx, 1316 const unsigned char *cookie, size_t clen, 1317 const unsigned char *info, size_t ilen ); 1318 1319 #if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C) 1320 /** 1321 * \brief Register callbacks for DTLS cookies 1322 * (Server only. DTLS only.) 1323 * 1324 * Default: dummy callbacks that fail, in order to force you to 1325 * register working callbacks (and initialize their context). 1326 * 1327 * To disable HelloVerifyRequest, register NULL callbacks. 1328 * 1329 * \warning Disabling hello verification allows your server to be used 1330 * for amplification in DoS attacks against other hosts. 1331 * Only disable if you known this can't happen in your 1332 * particular environment. 1333 * 1334 * \note See comments on \c mbedtls_ssl_handshake() about handling 1335 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected 1336 * on the first handshake attempt when this is enabled. 1337 * 1338 * \note This is also necessary to handle client reconnection from 1339 * the same port as described in RFC 6347 section 4.2.8 (only 1340 * the variant with cookies is supported currently). See 1341 * comments on \c mbedtls_ssl_read() for details. 1342 * 1343 * \param conf SSL configuration 1344 * \param f_cookie_write Cookie write callback 1345 * \param f_cookie_check Cookie check callback 1346 * \param p_cookie Context for both callbacks 1347 */ 1348 void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf, 1349 mbedtls_ssl_cookie_write_t *f_cookie_write, 1350 mbedtls_ssl_cookie_check_t *f_cookie_check, 1351 void *p_cookie ); 1352 1353 /** 1354 * \brief Set client's transport-level identification info. 1355 * (Server only. DTLS only.) 1356 * 1357 * This is usually the IP address (and port), but could be 1358 * anything identify the client depending on the underlying 1359 * network stack. Used for HelloVerifyRequest with DTLS. 1360 * This is *not* used to route the actual packets. 1361 * 1362 * \param ssl SSL context 1363 * \param info Transport-level info identifying the client (eg IP + port) 1364 * \param ilen Length of info in bytes 1365 * 1366 * \note An internal copy is made, so the info buffer can be reused. 1367 * 1368 * \return 0 on success, 1369 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client, 1370 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory. 1371 */ 1372 int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl, 1373 const unsigned char *info, 1374 size_t ilen ); 1375 1376 #endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */ 1377 1378 #if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY) 1379 /** 1380 * \brief Enable or disable anti-replay protection for DTLS. 1381 * (DTLS only, no effect on TLS.) 1382 * Default: enabled. 1383 * 1384 * \param conf SSL configuration 1385 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED. 1386 * 1387 * \warning Disabling this is a security risk unless the application 1388 * protocol handles duplicated packets in a safe way. You 1389 * should not disable this without careful consideration. 1390 * However, if your application already detects duplicated 1391 * packets and needs information about them to adjust its 1392 * transmission strategy, then you'll want to disable this. 1393 */ 1394 void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode ); 1395 #endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */ 1396 1397 #if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT) 1398 /** 1399 * \brief Set a limit on the number of records with a bad MAC 1400 * before terminating the connection. 1401 * (DTLS only, no effect on TLS.) 1402 * Default: 0 (disabled). 1403 * 1404 * \param conf SSL configuration 1405 * \param limit Limit, or 0 to disable. 1406 * 1407 * \note If the limit is N, then the connection is terminated when 1408 * the Nth non-authentic record is seen. 1409 * 1410 * \note Records with an invalid header are not counted, only the 1411 * ones going through the authentication-decryption phase. 1412 * 1413 * \note This is a security trade-off related to the fact that it's 1414 * often relatively easy for an active attacker ot inject UDP 1415 * datagrams. On one hand, setting a low limit here makes it 1416 * easier for such an attacker to forcibly terminated a 1417 * connection. On the other hand, a high limit or no limit 1418 * might make us waste resources checking authentication on 1419 * many bogus packets. 1420 */ 1421 void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit ); 1422 #endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */ 1423 1424 #if defined(MBEDTLS_SSL_PROTO_DTLS) 1425 /** 1426 * \brief Set retransmit timeout values for the DTLS handshake. 1427 * (DTLS only, no effect on TLS.) 1428 * 1429 * \param conf SSL configuration 1430 * \param min Initial timeout value in milliseconds. 1431 * Default: 1000 (1 second). 1432 * \param max Maximum timeout value in milliseconds. 1433 * Default: 60000 (60 seconds). 1434 * 1435 * \note Default values are from RFC 6347 section 4.2.4.1. 1436 * 1437 * \note The 'min' value should typically be slightly above the 1438 * expected round-trip time to your peer, plus whatever time 1439 * it takes for the peer to process the message. For example, 1440 * if your RTT is about 600ms and you peer needs up to 1s to 1441 * do the cryptographic operations in the handshake, then you 1442 * should set 'min' slightly above 1600. Lower values of 'min' 1443 * might cause spurious resends which waste network resources, 1444 * while larger value of 'min' will increase overall latency 1445 * on unreliable network links. 1446 * 1447 * \note The more unreliable your network connection is, the larger 1448 * your max / min ratio needs to be in order to achieve 1449 * reliable handshakes. 1450 * 1451 * \note Messages are retransmitted up to log2(ceil(max/min)) times. 1452 * For example, if min = 1s and max = 5s, the retransmit plan 1453 * goes: send ... 1s -> resend ... 2s -> resend ... 4s -> 1454 * resend ... 5s -> give up and return a timeout error. 1455 */ 1456 void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max ); 1457 #endif /* MBEDTLS_SSL_PROTO_DTLS */ 1458 1459 #if defined(MBEDTLS_SSL_SRV_C) 1460 /** 1461 * \brief Set the session cache callbacks (server-side only) 1462 * If not set, no session resuming is done (except if session 1463 * tickets are enabled too). 1464 * 1465 * The session cache has the responsibility to check for stale 1466 * entries based on timeout. See RFC 5246 for recommendations. 1467 * 1468 * Warning: session.peer_cert is cleared by the SSL/TLS layer on 1469 * connection shutdown, so do not cache the pointer! Either set 1470 * it to NULL or make a full copy of the certificate. 1471 * 1472 * The get callback is called once during the initial handshake 1473 * to enable session resuming. The get function has the 1474 * following parameters: (void *parameter, mbedtls_ssl_session *session) 1475 * If a valid entry is found, it should fill the master of 1476 * the session object with the cached values and return 0, 1477 * return 1 otherwise. Optionally peer_cert can be set as well 1478 * if it is properly present in cache entry. 1479 * 1480 * The set callback is called once during the initial handshake 1481 * to enable session resuming after the entire handshake has 1482 * been finished. The set function has the following parameters: 1483 * (void *parameter, const mbedtls_ssl_session *session). The function 1484 * should create a cache entry for future retrieval based on 1485 * the data in the session structure and should keep in mind 1486 * that the mbedtls_ssl_session object presented (and all its referenced 1487 * data) is cleared by the SSL/TLS layer when the connection is 1488 * terminated. It is recommended to add metadata to determine if 1489 * an entry is still valid in the future. Return 0 if 1490 * successfully cached, return 1 otherwise. 1491 * 1492 * \param conf SSL configuration 1493 * \param p_cache parmater (context) for both callbacks 1494 * \param f_get_cache session get callback 1495 * \param f_set_cache session set callback 1496 */ 1497 void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf, 1498 void *p_cache, 1499 int (*f_get_cache)(void *, mbedtls_ssl_session *), 1500 int (*f_set_cache)(void *, const mbedtls_ssl_session *) ); 1501 #endif /* MBEDTLS_SSL_SRV_C */ 1502 1503 #if defined(MBEDTLS_SSL_CLI_C) 1504 /** 1505 * \brief Request resumption of session (client-side only) 1506 * Session data is copied from presented session structure. 1507 * 1508 * \param ssl SSL context 1509 * \param session session context 1510 * 1511 * \return 0 if successful, 1512 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed, 1513 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or 1514 * arguments are otherwise invalid 1515 * 1516 * \sa mbedtls_ssl_get_session() 1517 */ 1518 int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session ); 1519 #endif /* MBEDTLS_SSL_CLI_C */ 1520 1521 /** 1522 * \brief Set the list of allowed ciphersuites and the preference 1523 * order. First in the list has the highest preference. 1524 * (Overrides all version-specific lists) 1525 * 1526 * The ciphersuites array is not copied, and must remain 1527 * valid for the lifetime of the ssl_config. 1528 * 1529 * Note: The server uses its own preferences 1530 * over the preference of the client unless 1531 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined! 1532 * 1533 * \param conf SSL configuration 1534 * \param ciphersuites 0-terminated list of allowed ciphersuites 1535 */ 1536 void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf, 1537 const int *ciphersuites ); 1538 1539 /** 1540 * \brief Set the list of allowed ciphersuites and the 1541 * preference order for a specific version of the protocol. 1542 * (Only useful on the server side) 1543 * 1544 * The ciphersuites array is not copied, and must remain 1545 * valid for the lifetime of the ssl_config. 1546 * 1547 * \param conf SSL configuration 1548 * \param ciphersuites 0-terminated list of allowed ciphersuites 1549 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 1550 * supported) 1551 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0, 1552 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2, 1553 * MBEDTLS_SSL_MINOR_VERSION_3 supported) 1554 * 1555 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 1556 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2 1557 */ 1558 void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf, 1559 const int *ciphersuites, 1560 int major, int minor ); 1561 1562 #if defined(MBEDTLS_X509_CRT_PARSE_C) 1563 /** 1564 * \brief Set the X.509 security profile used for verification 1565 * 1566 * \note The restrictions are enforced for all certificates in the 1567 * chain. However, signatures in the handshake are not covered 1568 * by this setting but by \b mbedtls_ssl_conf_sig_hashes(). 1569 * 1570 * \param conf SSL configuration 1571 * \param profile Profile to use 1572 */ 1573 void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf, 1574 const mbedtls_x509_crt_profile *profile ); 1575 1576 /** 1577 * \brief Set the data required to verify peer certificate 1578 * 1579 * \param conf SSL configuration 1580 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs) 1581 * \param ca_crl trusted CA CRLs 1582 */ 1583 void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf, 1584 mbedtls_x509_crt *ca_chain, 1585 mbedtls_x509_crl *ca_crl ); 1586 1587 /** 1588 * \brief Set own certificate chain and private key 1589 * 1590 * \note own_cert should contain in order from the bottom up your 1591 * certificate chain. The top certificate (self-signed) 1592 * can be omitted. 1593 * 1594 * \note On server, this function can be called multiple times to 1595 * provision more than one cert/key pair (eg one ECDSA, one 1596 * RSA with SHA-256, one RSA with SHA-1). An adequate 1597 * certificate will be selected according to the client's 1598 * advertised capabilities. In case mutliple certificates are 1599 * adequate, preference is given to the one set by the first 1600 * call to this function, then second, etc. 1601 * 1602 * \note On client, only the first call has any effect. That is, 1603 * only one client certificate can be provisioned. The 1604 * server's preferences in its CertficateRequest message will 1605 * be ignored and our only cert will be sent regardless of 1606 * whether it matches those preferences - the server can then 1607 * decide what it wants to do with it. 1608 * 1609 * \param conf SSL configuration 1610 * \param own_cert own public certificate chain 1611 * \param pk_key own private key 1612 * 1613 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED 1614 */ 1615 int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf, 1616 mbedtls_x509_crt *own_cert, 1617 mbedtls_pk_context *pk_key ); 1618 #endif /* MBEDTLS_X509_CRT_PARSE_C */ 1619 1620 #if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED) 1621 /** 1622 * \brief Set the Pre Shared Key (PSK) and the expected identity name 1623 * 1624 * \note This is mainly useful for clients. Servers will usually 1625 * want to use \c mbedtls_ssl_conf_psk_cb() instead. 1626 * 1627 * \note Currently clients can only register one pre-shared key. 1628 * In other words, the servers' identity hint is ignored. 1629 * Support for setting multiple PSKs on clients and selecting 1630 * one based on the identity hint is not a planned feature but 1631 * feedback is welcomed. 1632 * 1633 * \param conf SSL configuration 1634 * \param psk pointer to the pre-shared key 1635 * \param psk_len pre-shared key length 1636 * \param psk_identity pointer to the pre-shared key identity 1637 * \param psk_identity_len identity key length 1638 * 1639 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED 1640 */ 1641 int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf, 1642 const unsigned char *psk, size_t psk_len, 1643 const unsigned char *psk_identity, size_t psk_identity_len ); 1644 1645 1646 /** 1647 * \brief Set the Pre Shared Key (PSK) for the current handshake 1648 * 1649 * \note This should only be called inside the PSK callback, 1650 * ie the function passed to \c mbedtls_ssl_conf_psk_cb(). 1651 * 1652 * \param ssl SSL context 1653 * \param psk pointer to the pre-shared key 1654 * \param psk_len pre-shared key length 1655 * 1656 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED 1657 */ 1658 int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl, 1659 const unsigned char *psk, size_t psk_len ); 1660 1661 /** 1662 * \brief Set the PSK callback (server-side only). 1663 * 1664 * If set, the PSK callback is called for each 1665 * handshake where a PSK ciphersuite was negotiated. 1666 * The caller provides the identity received and wants to 1667 * receive the actual PSK data and length. 1668 * 1669 * The callback has the following parameters: (void *parameter, 1670 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity, 1671 * size_t identity_len) 1672 * If a valid PSK identity is found, the callback should use 1673 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the 1674 * correct PSK and return 0. 1675 * Any other return value will result in a denied PSK identity. 1676 * 1677 * \note If you set a PSK callback using this function, then you 1678 * don't need to set a PSK key and identity using 1679 * \c mbedtls_ssl_conf_psk(). 1680 * 1681 * \param conf SSL configuration 1682 * \param f_psk PSK identity function 1683 * \param p_psk PSK identity parameter 1684 */ 1685 void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf, 1686 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, 1687 size_t), 1688 void *p_psk ); 1689 #endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */ 1690 1691 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C) 1692 /** 1693 * \brief Set the Diffie-Hellman public P and G values, 1694 * read as hexadecimal strings (server-side only) 1695 * (Default: MBEDTLS_DHM_RFC5114_MODP_2048_[PG]) 1696 * 1697 * \param conf SSL configuration 1698 * \param dhm_P Diffie-Hellman-Merkle modulus 1699 * \param dhm_G Diffie-Hellman-Merkle generator 1700 * 1701 * \return 0 if successful 1702 */ 1703 int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf, const char *dhm_P, const char *dhm_G ); 1704 1705 /** 1706 * \brief Set the Diffie-Hellman public P and G values, 1707 * read from existing context (server-side only) 1708 * 1709 * \param conf SSL configuration 1710 * \param dhm_ctx Diffie-Hellman-Merkle context 1711 * 1712 * \return 0 if successful 1713 */ 1714 int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx ); 1715 #endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */ 1716 1717 #if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C) 1718 /** 1719 * \brief Set the minimum length for Diffie-Hellman parameters. 1720 * (Client-side only.) 1721 * (Default: 1024 bits.) 1722 * 1723 * \param conf SSL configuration 1724 * \param bitlen Minimum bit length of the DHM prime 1725 */ 1726 void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf, 1727 unsigned int bitlen ); 1728 #endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */ 1729 1730 #if defined(MBEDTLS_ECP_C) 1731 /** 1732 * \brief Set the allowed curves in order of preference. 1733 * (Default: all defined curves.) 1734 * 1735 * On server: this only affects selection of the ECDHE curve; 1736 * the curves used for ECDH and ECDSA are determined by the 1737 * list of available certificates instead. 1738 * 1739 * On client: this affects the list of curves offered for any 1740 * use. The server can override our preference order. 1741 * 1742 * Both sides: limits the set of curves accepted for use in 1743 * ECDHE and in the peer's end-entity certificate. 1744 * 1745 * \note This has no influence on which curves are allowed inside the 1746 * certificate chains, see \c mbedtls_ssl_conf_cert_profile() 1747 * for that. For the end-entity certificate however, the key 1748 * will be accepted only if it is allowed both by this list 1749 * and by the cert profile. 1750 * 1751 * \note This list should be ordered by decreasing preference 1752 * (preferred curve first). 1753 * 1754 * \param conf SSL configuration 1755 * \param curves Ordered list of allowed curves, 1756 * terminated by MBEDTLS_ECP_DP_NONE. 1757 */ 1758 void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf, 1759 const mbedtls_ecp_group_id *curves ); 1760 #endif /* MBEDTLS_ECP_C */ 1761 1762 #if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) 1763 /** 1764 * \brief Set the allowed hashes for signatures during the handshake. 1765 * (Default: all available hashes except MD5.) 1766 * 1767 * \note This only affects which hashes are offered and can be used 1768 * for signatures during the handshake. Hashes for message 1769 * authentication and the TLS PRF are controlled by the 1770 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes 1771 * used for certificate signature are controlled by the 1772 * verification profile, see \c mbedtls_ssl_conf_cert_profile(). 1773 * 1774 * \note This list should be ordered by decreasing preference 1775 * (preferred hash first). 1776 * 1777 * \param conf SSL configuration 1778 * \param hashes Ordered list of allowed signature hashes, 1779 * terminated by \c MBEDTLS_MD_NONE. 1780 */ 1781 void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf, 1782 const int *hashes ); 1783 #endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */ 1784 1785 #if defined(MBEDTLS_X509_CRT_PARSE_C) 1786 /** 1787 * \brief Set the hostname to check against the received server 1788 * certificate. It sets the ServerName TLS extension too, 1789 * if the extension is enabled. 1790 * (client-side only) 1791 * 1792 * \param ssl SSL context 1793 * \param hostname the server hostname 1794 * 1795 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED 1796 */ 1797 int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname ); 1798 #endif /* MBEDTLS_X509_CRT_PARSE_C */ 1799 1800 #if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION) 1801 /** 1802 * \brief Set own certificate and key for the current handshake 1803 * 1804 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within 1805 * the SNI callback. 1806 * 1807 * \param ssl SSL context 1808 * \param own_cert own public certificate chain 1809 * \param pk_key own private key 1810 * 1811 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED 1812 */ 1813 int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl, 1814 mbedtls_x509_crt *own_cert, 1815 mbedtls_pk_context *pk_key ); 1816 1817 /** 1818 * \brief Set the data required to verify peer certificate for the 1819 * current handshake 1820 * 1821 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within 1822 * the SNI callback. 1823 * 1824 * \param ssl SSL context 1825 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs) 1826 * \param ca_crl trusted CA CRLs 1827 */ 1828 void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl, 1829 mbedtls_x509_crt *ca_chain, 1830 mbedtls_x509_crl *ca_crl ); 1831 1832 /** 1833 * \brief Set authmode for the current handshake. 1834 * 1835 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within 1836 * the SNI callback. 1837 * 1838 * \param ssl SSL context 1839 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or 1840 * MBEDTLS_SSL_VERIFY_REQUIRED 1841 */ 1842 void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl, 1843 int authmode ); 1844 1845 /** 1846 * \brief Set server side ServerName TLS extension callback 1847 * (optional, server-side only). 1848 * 1849 * If set, the ServerName callback is called whenever the 1850 * server receives a ServerName TLS extension from the client 1851 * during a handshake. The ServerName callback has the 1852 * following parameters: (void *parameter, mbedtls_ssl_context *ssl, 1853 * const unsigned char *hostname, size_t len). If a suitable 1854 * certificate is found, the callback must set the 1855 * certificate(s) and key(s) to use with \c 1856 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly), 1857 * and may optionally adjust the CA and associated CRL with \c 1858 * mbedtls_ssl_set_hs_ca_chain() as well as the client 1859 * authentication mode with \c mbedtls_ssl_set_hs_authmode(), 1860 * then must return 0. If no matching name is found, the 1861 * callback must either set a default cert, or 1862 * return non-zero to abort the handshake at this point. 1863 * 1864 * \param conf SSL configuration 1865 * \param f_sni verification function 1866 * \param p_sni verification parameter 1867 */ 1868 void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf, 1869 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, 1870 size_t), 1871 void *p_sni ); 1872 #endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */ 1873 1874 #if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED) 1875 /** 1876 * \brief Set the EC J-PAKE password for current handshake. 1877 * 1878 * \note An internal copy is made, and destroyed as soon as the 1879 * handshake is completed, or when the SSL context is reset or 1880 * freed. 1881 * 1882 * \note The SSL context needs to be already set up. The right place 1883 * to call this function is between \c mbedtls_ssl_setup() or 1884 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake(). 1885 * 1886 * \param ssl SSL context 1887 * \param pw EC J-PAKE password (pre-shared secret) 1888 * \param pw_len length of pw in bytes 1889 * 1890 * \return 0 on success, or a negative error code. 1891 */ 1892 int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl, 1893 const unsigned char *pw, 1894 size_t pw_len ); 1895 #endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */ 1896 1897 #if defined(MBEDTLS_SSL_ALPN) 1898 /** 1899 * \brief Set the supported Application Layer Protocols. 1900 * 1901 * \param conf SSL configuration 1902 * \param protos Pointer to a NULL-terminated list of supported protocols, 1903 * in decreasing preference order. The pointer to the list is 1904 * recorded by the library for later reference as required, so 1905 * the lifetime of the table must be atleast as long as the 1906 * lifetime of the SSL configuration structure. 1907 * 1908 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA. 1909 */ 1910 int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos ); 1911 1912 /** 1913 * \brief Get the name of the negotiated Application Layer Protocol. 1914 * This function should be called after the handshake is 1915 * completed. 1916 * 1917 * \param ssl SSL context 1918 * 1919 * \return Protcol name, or NULL if no protocol was negotiated. 1920 */ 1921 const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl ); 1922 #endif /* MBEDTLS_SSL_ALPN */ 1923 1924 /** 1925 * \brief Set the maximum supported version sent from the client side 1926 * and/or accepted at the server side 1927 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION) 1928 * 1929 * \note This ignores ciphersuites from higher versions. 1930 * 1931 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and 1932 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2 1933 * 1934 * \param conf SSL configuration 1935 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported) 1936 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0, 1937 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2, 1938 * MBEDTLS_SSL_MINOR_VERSION_3 supported) 1939 */ 1940 void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor ); 1941 1942 /** 1943 * \brief Set the minimum accepted SSL/TLS protocol version 1944 * (Default: TLS 1.0) 1945 * 1946 * \note Input outside of the SSL_MAX_XXXXX_VERSION and 1947 * SSL_MIN_XXXXX_VERSION range is ignored. 1948 * 1949 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided. 1950 * 1951 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and 1952 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2 1953 * 1954 * \param conf SSL configuration 1955 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported) 1956 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0, 1957 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2, 1958 * MBEDTLS_SSL_MINOR_VERSION_3 supported) 1959 */ 1960 void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor ); 1961 1962 #if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C) 1963 /** 1964 * \brief Set the fallback flag (client-side only). 1965 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK). 1966 * 1967 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback 1968 * connection, that is a connection with max_version set to a 1969 * lower value than the value you're willing to use. Such 1970 * fallback connections are not recommended but are sometimes 1971 * necessary to interoperate with buggy (version-intolerant) 1972 * servers. 1973 * 1974 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for 1975 * non-fallback connections! This would appear to work for a 1976 * while, then cause failures when the server is upgraded to 1977 * support a newer TLS version. 1978 * 1979 * \param conf SSL configuration 1980 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK 1981 */ 1982 void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback ); 1983 #endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */ 1984 1985 #if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC) 1986 /** 1987 * \brief Enable or disable Encrypt-then-MAC 1988 * (Default: MBEDTLS_SSL_ETM_ENABLED) 1989 * 1990 * \note This should always be enabled, it is a security 1991 * improvement, and should not cause any interoperability 1992 * issue (used only if the peer supports it too). 1993 * 1994 * \param conf SSL configuration 1995 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED 1996 */ 1997 void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm ); 1998 #endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */ 1999 2000 #if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET) 2001 /** 2002 * \brief Enable or disable Extended Master Secret negotiation. 2003 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED) 2004 * 2005 * \note This should always be enabled, it is a security fix to the 2006 * protocol, and should not cause any interoperability issue 2007 * (used only if the peer supports it too). 2008 * 2009 * \param conf SSL configuration 2010 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED 2011 */ 2012 void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems ); 2013 #endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */ 2014 2015 #if defined(MBEDTLS_ARC4_C) 2016 /** 2017 * \brief Disable or enable support for RC4 2018 * (Default: MBEDTLS_SSL_ARC4_DISABLED) 2019 * 2020 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465 2021 * for security reasons. Use at your own risk. 2022 * 2023 * \note This function is deprecated and will likely be removed in 2024 * a future version of the library. 2025 * RC4 is disabled by default at compile time and needs to be 2026 * actively enabled for use with legacy systems. 2027 * 2028 * \param conf SSL configuration 2029 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED 2030 */ 2031 void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 ); 2032 #endif /* MBEDTLS_ARC4_C */ 2033 2034 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) 2035 /** 2036 * \brief Set the maximum fragment length to emit and/or negotiate 2037 * (Default: MBEDTLS_SSL_MAX_CONTENT_LEN, usually 2^14 bytes) 2038 * (Server: set maximum fragment length to emit, 2039 * usually negotiated by the client during handshake 2040 * (Client: set maximum fragment length to emit *and* 2041 * negotiate with the server during handshake) 2042 * 2043 * \param conf SSL configuration 2044 * \param mfl_code Code for maximum fragment length (allowed values: 2045 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024, 2046 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096) 2047 * 2048 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA 2049 */ 2050 int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code ); 2051 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */ 2052 2053 #if defined(MBEDTLS_SSL_TRUNCATED_HMAC) 2054 /** 2055 * \brief Activate negotiation of truncated HMAC 2056 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED) 2057 * 2058 * \param conf SSL configuration 2059 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or 2060 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED) 2061 */ 2062 void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate ); 2063 #endif /* MBEDTLS_SSL_TRUNCATED_HMAC */ 2064 2065 #if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING) 2066 /** 2067 * \brief Enable / Disable 1/n-1 record splitting 2068 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED) 2069 * 2070 * \note Only affects SSLv3 and TLS 1.0, not higher versions. 2071 * Does not affect non-CBC ciphersuites in any version. 2072 * 2073 * \param conf SSL configuration 2074 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or 2075 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 2076 */ 2077 void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split ); 2078 #endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */ 2079 2080 #if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C) 2081 /** 2082 * \brief Enable / Disable session tickets (client only). 2083 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.) 2084 * 2085 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb(). 2086 * 2087 * \param conf SSL configuration 2088 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or 2089 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED) 2090 */ 2091 void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets ); 2092 #endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */ 2093 2094 #if defined(MBEDTLS_SSL_RENEGOTIATION) 2095 /** 2096 * \brief Enable / Disable renegotiation support for connection when 2097 * initiated by peer 2098 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED) 2099 * 2100 * \warning It is recommended to always disable renegotation unless you 2101 * know you need it and you know what you're doing. In the 2102 * past, there have been several issues associated with 2103 * renegotiation or a poor understanding of its properties. 2104 * 2105 * \note Server-side, enabling renegotiation also makes the server 2106 * susceptible to a resource DoS by a malicious client. 2107 * 2108 * \param conf SSL configuration 2109 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or 2110 * MBEDTLS_SSL_RENEGOTIATION_DISABLED) 2111 */ 2112 void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation ); 2113 #endif /* MBEDTLS_SSL_RENEGOTIATION */ 2114 2115 /** 2116 * \brief Prevent or allow legacy renegotiation. 2117 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION) 2118 * 2119 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to 2120 * be established even if the peer does not support 2121 * secure renegotiation, but does not allow renegotiation 2122 * to take place if not secure. 2123 * (Interoperable and secure option) 2124 * 2125 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations 2126 * with non-upgraded peers. Allowing legacy renegotiation 2127 * makes the connection vulnerable to specific man in the 2128 * middle attacks. (See RFC 5746) 2129 * (Most interoperable and least secure option) 2130 * 2131 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections 2132 * if peer does not support secure renegotiation. Results 2133 * in interoperability issues with non-upgraded peers 2134 * that do not support renegotiation altogether. 2135 * (Most secure option, interoperability issues) 2136 * 2137 * \param conf SSL configuration 2138 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION, 2139 * SSL_ALLOW_LEGACY_RENEGOTIATION or 2140 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE) 2141 */ 2142 void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy ); 2143 2144 #if defined(MBEDTLS_SSL_RENEGOTIATION) 2145 /** 2146 * \brief Enforce renegotiation requests. 2147 * (Default: enforced, max_records = 16) 2148 * 2149 * When we request a renegotiation, the peer can comply or 2150 * ignore the request. This function allows us to decide 2151 * whether to enforce our renegotiation requests by closing 2152 * the connection if the peer doesn't comply. 2153 * 2154 * However, records could already be in transit from the peer 2155 * when the request is emitted. In order to increase 2156 * reliability, we can accept a number of records before the 2157 * expected handshake records. 2158 * 2159 * The optimal value is highly dependent on the specific usage 2160 * scenario. 2161 * 2162 * \note With DTLS and server-initiated renegotiation, the 2163 * HelloRequest is retransmited every time mbedtls_ssl_read() times 2164 * out or receives Application Data, until: 2165 * - max_records records have beens seen, if it is >= 0, or 2166 * - the number of retransmits that would happen during an 2167 * actual handshake has been reached. 2168 * Please remember the request might be lost a few times 2169 * if you consider setting max_records to a really low value. 2170 * 2171 * \warning On client, the grace period can only happen during 2172 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate() 2173 * which always behave as if max_record was 0. The reason is, 2174 * if we receive application data from the server, we need a 2175 * place to write it, which only happens during mbedtls_ssl_read(). 2176 * 2177 * \param conf SSL configuration 2178 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to 2179 * enforce renegotiation, or a non-negative value to enforce 2180 * it but allow for a grace period of max_records records. 2181 */ 2182 void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records ); 2183 2184 /** 2185 * \brief Set record counter threshold for periodic renegotiation. 2186 * (Default: 2^64 - 256.) 2187 * 2188 * Renegotiation is automatically triggered when a record 2189 * counter (outgoing or ingoing) crosses the defined 2190 * threshold. The default value is meant to prevent the 2191 * connection from being closed when the counter is about to 2192 * reached its maximal value (it is not allowed to wrap). 2193 * 2194 * Lower values can be used to enforce policies such as "keys 2195 * must be refreshed every N packets with cipher X". 2196 * 2197 * \param conf SSL configuration 2198 * \param period The threshold value: a big-endian 64-bit number. 2199 * Set to 2^64 - 1 to disable periodic renegotiation 2200 */ 2201 void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf, 2202 const unsigned char period[8] ); 2203 #endif /* MBEDTLS_SSL_RENEGOTIATION */ 2204 2205 /** 2206 * \brief Return the number of data bytes available to read 2207 * 2208 * \param ssl SSL context 2209 * 2210 * \return how many bytes are available in the read buffer 2211 */ 2212 size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl ); 2213 2214 /** 2215 * \brief Return the result of the certificate verification 2216 * 2217 * \param ssl SSL context 2218 * 2219 * \return 0 if successful, 2220 * -1 if result is not available (eg because the handshake was 2221 * aborted too early), or 2222 * a combination of BADCERT_xxx and BADCRL_xxx flags, see 2223 * x509.h 2224 */ 2225 uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl ); 2226 2227 /** 2228 * \brief Return the name of the current ciphersuite 2229 * 2230 * \param ssl SSL context 2231 * 2232 * \return a string containing the ciphersuite name 2233 */ 2234 const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl ); 2235 2236 /** 2237 * \brief Return the current SSL version (SSLv3/TLSv1/etc) 2238 * 2239 * \param ssl SSL context 2240 * 2241 * \return a string containing the SSL version 2242 */ 2243 const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl ); 2244 2245 /** 2246 * \brief Return the (maximum) number of bytes added by the record 2247 * layer: header + encryption/MAC overhead (inc. padding) 2248 * 2249 * \param ssl SSL context 2250 * 2251 * \return Current maximum record expansion in bytes, or 2252 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is 2253 * enabled, which makes expansion much less predictable 2254 */ 2255 int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl ); 2256 2257 #if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH) 2258 /** 2259 * \brief Return the maximum fragment length (payload, in bytes). 2260 * This is the value negotiated with peer if any, 2261 * or the locally configured value. 2262 * 2263 * \note With DTLS, \c mbedtls_ssl_write() will return an error if 2264 * called with a larger length value. 2265 * With TLS, \c mbedtls_ssl_write() will fragment the input if 2266 * necessary and return the number of bytes written; it is up 2267 * to the caller to call \c mbedtls_ssl_write() again in 2268 * order to send the remaining bytes if any. 2269 * 2270 * \param ssl SSL context 2271 * 2272 * \return Current maximum fragment length. 2273 */ 2274 size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl ); 2275 #endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */ 2276 2277 #if defined(MBEDTLS_X509_CRT_PARSE_C) 2278 /** 2279 * \brief Return the peer certificate from the current connection 2280 * 2281 * Note: Can be NULL in case no certificate was sent during 2282 * the handshake. Different calls for the same connection can 2283 * return the same or different pointers for the same 2284 * certificate and even a different certificate altogether. 2285 * The peer cert CAN change in a single connection if 2286 * renegotiation is performed. 2287 * 2288 * \param ssl SSL context 2289 * 2290 * \return the current peer certificate 2291 */ 2292 const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl ); 2293 #endif /* MBEDTLS_X509_CRT_PARSE_C */ 2294 2295 #if defined(MBEDTLS_SSL_CLI_C) 2296 /** 2297 * \brief Save session in order to resume it later (client-side only) 2298 * Session data is copied to presented session structure. 2299 * 2300 * \warning Currently, peer certificate is lost in the operation. 2301 * 2302 * \param ssl SSL context 2303 * \param session session context 2304 * 2305 * \return 0 if successful, 2306 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed, 2307 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or 2308 * arguments are otherwise invalid 2309 * 2310 * \sa mbedtls_ssl_set_session() 2311 */ 2312 int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session ); 2313 #endif /* MBEDTLS_SSL_CLI_C */ 2314 2315 /** 2316 * \brief Perform the SSL handshake 2317 * 2318 * \param ssl SSL context 2319 * 2320 * \return 0 if successful, or 2321 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or 2322 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED (see below), or 2323 * a specific SSL error code. 2324 * 2325 * \note If this function returns something other than 0 or 2326 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context 2327 * becomes unusable, and you should either free it or call 2328 * \c mbedtls_ssl_session_reset() on it before re-using it for 2329 * a new connection; the current connection must be closed. 2330 * 2331 * \note If DTLS is in use, then you may choose to handle 2332 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging 2333 * purposes, as it is an expected return value rather than an 2334 * actual error, but you still need to reset/free the context. 2335 */ 2336 int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl ); 2337 2338 /** 2339 * \brief Perform a single step of the SSL handshake 2340 * 2341 * \note The state of the context (ssl->state) will be at 2342 * the next state after execution of this function. Do not 2343 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER. 2344 * 2345 * \note If this function returns something other than 0 or 2346 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context 2347 * becomes unusable, and you should either free it or call 2348 * \c mbedtls_ssl_session_reset() on it before re-using it for 2349 * a new connection; the current connection must be closed. 2350 * 2351 * \param ssl SSL context 2352 * 2353 * \return 0 if successful, or 2354 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or 2355 * a specific SSL error code. 2356 */ 2357 int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl ); 2358 2359 #if defined(MBEDTLS_SSL_RENEGOTIATION) 2360 /** 2361 * \brief Initiate an SSL renegotiation on the running connection. 2362 * Client: perform the renegotiation right now. 2363 * Server: request renegotiation, which will be performed 2364 * during the next call to mbedtls_ssl_read() if honored by 2365 * client. 2366 * 2367 * \param ssl SSL context 2368 * 2369 * \return 0 if successful, or any mbedtls_ssl_handshake() return 2370 * value. 2371 * 2372 * \note If this function returns something other than 0 or 2373 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context 2374 * becomes unusable, and you should either free it or call 2375 * \c mbedtls_ssl_session_reset() on it before re-using it for 2376 * a new connection; the current connection must be closed. 2377 */ 2378 int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl ); 2379 #endif /* MBEDTLS_SSL_RENEGOTIATION */ 2380 2381 /** 2382 * \brief Read at most 'len' application data bytes 2383 * 2384 * \param ssl SSL context 2385 * \param buf buffer that will hold the data 2386 * \param len maximum number of bytes to read 2387 * 2388 * \return the number of bytes read, or 2389 * 0 for EOF, or 2390 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or 2391 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT (see below), or 2392 * another negative error code. 2393 * 2394 * \note If this function returns something other than a positive 2395 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE or 2396 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT, then the ssl context 2397 * becomes unusable, and you should either free it or call 2398 * \c mbedtls_ssl_session_reset() on it before re-using it for 2399 * a new connection; the current connection must be closed. 2400 * 2401 * \note When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT 2402 * (which can only happen server-side), it means that a client 2403 * is initiating a new connection using the same source port. 2404 * You can either treat that as a connection close and wait 2405 * for the client to resend a ClientHello, or directly 2406 * continue with \c mbedtls_ssl_handshake() with the same 2407 * context (as it has beeen reset internally). Either way, you 2408 * should make sure this is seen by the application as a new 2409 * connection: application state, if any, should be reset, and 2410 * most importantly the identity of the client must be checked 2411 * again. WARNING: not validating the identity of the client 2412 * again, or not transmitting the new identity to the 2413 * application layer, would allow authentication bypass! 2414 */ 2415 int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len ); 2416 2417 /** 2418 * \brief Try to write exactly 'len' application data bytes 2419 * 2420 * \warning This function will do partial writes in some cases. If the 2421 * return value is non-negative but less than length, the 2422 * function must be called again with updated arguments: 2423 * buf + ret, len - ret (if ret is the return value) until 2424 * it returns a value equal to the last 'len' argument. 2425 * 2426 * \param ssl SSL context 2427 * \param buf buffer holding the data 2428 * \param len how many bytes must be written 2429 * 2430 * \return the number of bytes actually written (may be less than len), 2431 * or MBEDTLS_ERR_SSL_WANT_WRITE of MBEDTLS_ERR_SSL_WANT_READ, 2432 * or another negative error code. 2433 * 2434 * \note If this function returns something other than a positive 2435 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, the ssl context 2436 * becomes unusable, and you should either free it or call 2437 * \c mbedtls_ssl_session_reset() on it before re-using it for 2438 * a new connection; the current connection must be closed. 2439 * 2440 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ, 2441 * it must be called later with the *same* arguments, 2442 * until it returns a positive value. 2443 * 2444 * \note If the requested length is greater than the maximum 2445 * fragment length (either the built-in limit or the one set 2446 * or negotiated with the peer), then: 2447 * - with TLS, less bytes than requested are written. 2448 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned. 2449 * \c mbedtls_ssl_get_max_frag_len() may be used to query the 2450 * active maximum fragment length. 2451 */ 2452 int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len ); 2453 2454 /** 2455 * \brief Send an alert message 2456 * 2457 * \param ssl SSL context 2458 * \param level The alert level of the message 2459 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL) 2460 * \param message The alert message (SSL_ALERT_MSG_*) 2461 * 2462 * \return 0 if successful, or a specific SSL error code. 2463 * 2464 * \note If this function returns something other than 0 or 2465 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context 2466 * becomes unusable, and you should either free it or call 2467 * \c mbedtls_ssl_session_reset() on it before re-using it for 2468 * a new connection; the current connection must be closed. 2469 */ 2470 int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl, 2471 unsigned char level, 2472 unsigned char message ); 2473 /** 2474 * \brief Notify the peer that the connection is being closed 2475 * 2476 * \param ssl SSL context 2477 * 2478 * \return 0 if successful, or a specific SSL error code. 2479 * 2480 * \note If this function returns something other than 0 or 2481 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context 2482 * becomes unusable, and you should either free it or call 2483 * \c mbedtls_ssl_session_reset() on it before re-using it for 2484 * a new connection; the current connection must be closed. 2485 */ 2486 int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl ); 2487 2488 /** 2489 * \brief Free referenced items in an SSL context and clear memory 2490 * 2491 * \param ssl SSL context 2492 */ 2493 void mbedtls_ssl_free( mbedtls_ssl_context *ssl ); 2494 2495 /** 2496 * \brief Initialize an SSL configuration context 2497 * Just makes the context ready for 2498 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free(). 2499 * 2500 * \note You need to call mbedtls_ssl_config_defaults() unless you 2501 * manually set all of the relevent fields yourself. 2502 * 2503 * \param conf SSL configuration context 2504 */ 2505 void mbedtls_ssl_config_init( mbedtls_ssl_config *conf ); 2506 2507 /** 2508 * \brief Load reasonnable default SSL configuration values. 2509 * (You need to call mbedtls_ssl_config_init() first.) 2510 * 2511 * \param conf SSL configuration context 2512 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER 2513 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or 2514 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS 2515 * \param preset a MBEDTLS_SSL_PRESET_XXX value 2516 * (currently unused). 2517 * 2518 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS. 2519 * 2520 * \return 0 if successful, or 2521 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error. 2522 */ 2523 int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf, 2524 int endpoint, int transport, int preset ); 2525 2526 /** 2527 * \brief Free an SSL configuration context 2528 * 2529 * \param conf SSL configuration context 2530 */ 2531 void mbedtls_ssl_config_free( mbedtls_ssl_config *conf ); 2532 2533 /** 2534 * \brief Initialize SSL session structure 2535 * 2536 * \param session SSL session 2537 */ 2538 void mbedtls_ssl_session_init( mbedtls_ssl_session *session ); 2539 2540 /** 2541 * \brief Free referenced items in an SSL session including the 2542 * peer certificate and clear memory 2543 * 2544 * \param session SSL session 2545 */ 2546 void mbedtls_ssl_session_free( mbedtls_ssl_session *session ); 2547 2548 #ifdef __cplusplus 2549 } 2550 #endif 2551 2552 #endif /* ssl.h */ 2553
