blob: 2c0c4dd9a50e0b01ebe039078713ed7ff03d2e65 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file ssl.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief SSL/TLS functions.
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02007 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Paul Bakkerb96f1542010-07-18 20:36:00 +000021 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000022 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_SSL_H
25#define MBEDTLS_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakkered27a042013-04-18 22:46:23 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010032
Paul Bakkered27a042013-04-18 22:46:23 +020033#include "bignum.h"
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +020034#include "ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020035
Paul Bakker68884e32013-01-07 18:20:04 +010036#include "ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020039#include "x509_crt.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020040#include "x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020041#endif
Paul Bakkered27a042013-04-18 22:46:23 +020042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_DHM_C)
Paul Bakker48916f92012-09-16 19:57:18 +000044#include "dhm.h"
45#endif
46
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#if defined(MBEDTLS_ECDH_C)
Paul Bakker41c83d32013-03-20 14:39:14 +010048#include "ecdh.h"
49#endif
50
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +000052#include "zlib.h"
53#endif
54
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055#if defined(MBEDTLS_HAVE_TIME)
Ron Eldordf9b93e2017-05-14 16:17:33 +030056#include "platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020057#endif
58
Paul Bakker13e2dfe2009-07-28 07:18:38 +000059/*
60 * SSL Error codes
61 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020062#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
63#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
64#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
65#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
66#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
67#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
68#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
69#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
70#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
71#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
72#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
73#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
74#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
75#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
76#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
77#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
78#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
79#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
80#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
81#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
82#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
83#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
84#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
85#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
86#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
87#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
88#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
89#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
90#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +020091#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020092#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
93#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
94#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
95#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
96#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
97#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
98#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
99#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
100#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
101#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
102#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
103#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
104#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
105#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100106#define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< Connection requires a read call. */
107#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
108#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200109#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +0100110#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100111#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
112#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */
Hanno Beckerd8562b52017-04-12 14:54:42 +0100113#define MBEDTLS_ERR_SSL_BAD_CONFIG -0x5E80 /**< Invalid value in SSL config */
Paul Bakker5121ce52009-01-03 21:22:43 +0000114
115/*
116 * Various constants
117 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200118#define MBEDTLS_SSL_MAJOR_VERSION_3 3
119#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
120#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
121#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
122#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200124#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
125#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100126
Simon Butcher9f812312015-09-28 19:22:33 +0100127#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Simon Butcher89f77622015-09-27 22:50:49 +0100128
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200129/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200130 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200131#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
132#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
133#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
134#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
135#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
136#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200137
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138#define MBEDTLS_SSL_IS_CLIENT 0
139#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
142#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200144#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
145#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147#define MBEDTLS_SSL_ETM_DISABLED 0
148#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150#define MBEDTLS_SSL_COMPRESS_NULL 0
151#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153#define MBEDTLS_SSL_VERIFY_NONE 0
154#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
155#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200156#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000157
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200158#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
159#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200161#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
162#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
165#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
168#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
171#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
172#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
175#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
176#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200177
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200178#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
179#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200180
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100181#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
182#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#define MBEDTLS_SSL_ARC4_ENABLED 0
185#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100186
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200187#define MBEDTLS_SSL_PRESET_DEFAULT 0
188#define MBEDTLS_SSL_PRESET_SUITEB 2
189
Janos Follath088ce432017-04-10 12:42:31 +0100190#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
191#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
192
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200193/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194 * Default range for DTLS retransmission timer value, in milliseconds.
195 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
198#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Paul Bakker088c5c52014-04-25 11:11:10 +0200200/**
201 * \name SECTION: Module settings
202 *
203 * The configuration options you can set for this module are in this section.
204 * Either change them in config.h or define them on the compiler command line.
205 * \{
206 */
207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
209#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200210#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200211
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200212/*
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200213 * Maxium fragment length in bytes,
214 * determines the size of each of the two internal I/O buffers.
215 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200216 * Note: the RFC defines the default size of SSL / TLS messages. If you
217 * change the value here, other clients / servers may not be able to
218 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200219 * both sides of the connection and have it reduced at both sides, or
220 * if you're using the Max Fragment Length extension and you know all your
221 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200222 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200223#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
224#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200225#endif
226
227/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000228
229/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100230 * Length of the verify data for secure renegotiation
231 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200232#if defined(MBEDTLS_SSL_PROTO_SSL3)
233#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100234#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200235#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100236#endif
237
238/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200239 * Signaling ciphersuite values (SCSV)
240 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200241#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000242#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000243
Paul Bakker5121ce52009-01-03 21:22:43 +0000244/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000245 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200246 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000247 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200248#define MBEDTLS_SSL_HASH_NONE 0
249#define MBEDTLS_SSL_HASH_MD5 1
250#define MBEDTLS_SSL_HASH_SHA1 2
251#define MBEDTLS_SSL_HASH_SHA224 3
252#define MBEDTLS_SSL_HASH_SHA256 4
253#define MBEDTLS_SSL_HASH_SHA384 5
254#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000255
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200256#define MBEDTLS_SSL_SIG_ANON 0
257#define MBEDTLS_SSL_SIG_RSA 1
258#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000259
260/*
Paul Bakker926af752012-11-23 13:38:07 +0100261 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200262 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
265#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100266
267/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000268 * Message, alert and handshake types
269 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200270#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
271#define MBEDTLS_SSL_MSG_ALERT 21
272#define MBEDTLS_SSL_MSG_HANDSHAKE 22
273#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Paul Bakker5121ce52009-01-03 21:22:43 +0000274
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200275#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
276#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
279#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
280#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
281#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
282#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
283#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
284#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
285#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
286#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
287#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
288#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
289#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
290#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
291#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
292#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
293#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
294#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
295#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
296#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
297#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
298#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
299#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
300#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
301#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
302#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
303#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
304#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
305#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
306#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000307
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200308#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
309#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
310#define MBEDTLS_SSL_HS_SERVER_HELLO 2
311#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
312#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
313#define MBEDTLS_SSL_HS_CERTIFICATE 11
314#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
315#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
316#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
317#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
318#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
319#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000320
321/*
322 * TLS extensions
323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324#define MBEDTLS_TLS_EXT_SERVERNAME 0
325#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200330
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200331#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
332#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200334#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200336#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200337
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200338#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
339#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200342
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200343#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
344
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200345#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000346
Paul Bakkereb2c6582012-09-27 19:15:01 +0000347/*
Paul Bakkered27a042013-04-18 22:46:23 +0200348 * Size defines
349 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200350#if !defined(MBEDTLS_PSK_MAX_LEN)
351#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200352#endif
353
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200354/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200355union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200356{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200357#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200358 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
359#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
361 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200362#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
364 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
365 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
366 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
367 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200368#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200369#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
370 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200371#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
373 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
374 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200375#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200376#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
377 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200378#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200379#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
380 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
381 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200382#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200383#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
384 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
385#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200386};
387
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200388#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200389
Paul Bakker407a0da2013-06-27 14:29:21 +0200390#ifdef __cplusplus
391extern "C" {
392#endif
393
Paul Bakkered27a042013-04-18 22:46:23 +0200394/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000395 * SSL state machine
396 */
397typedef enum
398{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200399 MBEDTLS_SSL_HELLO_REQUEST,
400 MBEDTLS_SSL_CLIENT_HELLO,
401 MBEDTLS_SSL_SERVER_HELLO,
402 MBEDTLS_SSL_SERVER_CERTIFICATE,
403 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
404 MBEDTLS_SSL_CERTIFICATE_REQUEST,
405 MBEDTLS_SSL_SERVER_HELLO_DONE,
406 MBEDTLS_SSL_CLIENT_CERTIFICATE,
407 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
408 MBEDTLS_SSL_CERTIFICATE_VERIFY,
409 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
410 MBEDTLS_SSL_CLIENT_FINISHED,
411 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
412 MBEDTLS_SSL_SERVER_FINISHED,
413 MBEDTLS_SSL_FLUSH_BUFFERS,
414 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
415 MBEDTLS_SSL_HANDSHAKE_OVER,
416 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
417 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000418}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200419mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000420
Simon Butchere846b512016-03-01 17:31:49 +0000421/**
422 * \brief Callback type: send data on the network.
423 *
424 * \note That callback may be either blocking or non-blocking.
425 *
426 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000427 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000428 * \param len Length of the data to send
429 *
430 * \return The callback must return the number of bytes sent if any,
431 * or a non-zero error code.
432 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
433 * must be returned when the operation would block.
434 *
Simon Butcherd567a232016-03-09 20:19:21 +0000435 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000436 * It must always return the number of bytes actually sent.
437 */
438typedef int mbedtls_ssl_send_t( void *ctx,
439 const unsigned char *buf,
440 size_t len );
441
442/**
443 * \brief Callback type: receive data from the network.
444 *
445 * \note That callback may be either blocking or non-blocking.
446 *
447 * \param ctx Context for the receive callback (typically a file
448 * descriptor)
449 * \param buf Buffer to write the received data to
450 * \param len Length of the receive buffer
451 *
452 * \return The callback must return the number of bytes received,
453 * or a non-zero error code.
454 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
455 * must be returned when the operation would block.
456 *
Simon Butcherd567a232016-03-09 20:19:21 +0000457 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000458 * buffer. It must always return the number of bytes actually
459 * received and written to the buffer.
460 */
461typedef int mbedtls_ssl_recv_t( void *ctx,
462 unsigned char *buf,
463 size_t len );
464
465/**
466 * \brief Callback type: receive data from the network, with timeout
467 *
468 * \note That callback must block until data is received, or the
469 * timeout delay expires, or the operation is interrupted by a
470 * signal.
471 *
472 * \param ctx Context for the receive callback (typically a file descriptor)
473 * \param buf Buffer to write the received data to
474 * \param len Length of the receive buffer
475 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000476 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000477 *
478 * \return The callback must return the number of bytes received,
479 * or a non-zero error code:
480 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
481 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
482 *
Simon Butcherd567a232016-03-09 20:19:21 +0000483 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000484 * buffer. It must always return the number of bytes actually
485 * received and written to the buffer.
486 */
487typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
488 unsigned char *buf,
489 size_t len,
490 uint32_t timeout );
491/**
492 * \brief Callback type: set a pair of timers/delays to watch
493 *
494 * \param ctx Context pointer
495 * \param int_ms Intermediate delay in milliseconds
496 * \param fin_ms Final delay in milliseconds
497 * 0 cancels the current timer.
498 *
499 * \note This callback must at least store the necessary information
500 * for the associated \c mbedtls_ssl_get_timer_t callback to
501 * return correct information.
502 *
503 * \note If using a event-driven style of programming, an event must
504 * be generated when the final delay is passed. The event must
505 * cause a call to \c mbedtls_ssl_handshake() with the proper
506 * SSL context to be scheduled. Care must be taken to ensure
507 * that at most one such call happens at a time.
508 *
509 * \note Only one timer at a time must be running. Calling this
510 * function while a timer is running must cancel it. Cancelled
511 * timers must not generate any event.
512 */
513typedef void mbedtls_ssl_set_timer_t( void * ctx,
514 uint32_t int_ms,
515 uint32_t fin_ms );
516
517/**
518 * \brief Callback type: get status of timers/delays
519 *
520 * \param ctx Context pointer
521 *
522 * \return This callback must return:
523 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000524 * 0 if none of the delays have passed,
525 * 1 if only the intermediate delay has passed,
526 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000527 */
528typedef int mbedtls_ssl_get_timer_t( void * ctx );
529
530
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200531/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200532typedef struct mbedtls_ssl_session mbedtls_ssl_session;
533typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200534typedef struct mbedtls_ssl_config mbedtls_ssl_config;
535
536/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200537typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
538typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100539typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540#if defined(MBEDTLS_X509_CRT_PARSE_C)
541typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200542#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#if defined(MBEDTLS_SSL_PROTO_DTLS)
544typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200545#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000546
547/*
Paul Bakker0a597072012-09-25 21:55:46 +0000548 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000549 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200550struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000551{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200552#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100553 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200554#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000555 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000556 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200557 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000558 unsigned char id[32]; /*!< session identifier */
559 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200560
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200561#if defined(MBEDTLS_X509_CRT_PARSE_C)
562 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
563#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200564 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200565
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200566#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200567 unsigned char *ticket; /*!< RFC 5077 session ticket */
568 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200569 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200570#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200571
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200572#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200573 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200575
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200576#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200577 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200578#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100579
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200580#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100581 int encrypt_then_mac; /*!< flag for EtM activation */
582#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000583};
584
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200585/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200586 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200587 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200588struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200589{
590 /* Group items by size (largest first) to minimize padding overhead */
591
592 /*
593 * Pointers
594 */
595
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100596 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200597
598 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200599 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200600 void *p_dbg; /*!< context for the debug function */
601
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100602 /** Callback for getting (pseudo-)random numbers */
603 int (*f_rng)(void *, unsigned char *, size_t);
604 void *p_rng; /*!< context for the RNG function */
605
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200606 /** Callback to retrieve a session from the cache */
607 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200608 /** Callback to store a session into the cache */
609 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100610 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200611
612#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
613 /** Callback for setting cert according to SNI extension */
614 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
615 void *p_sni; /*!< context for SNI callback */
616#endif
617
618#if defined(MBEDTLS_X509_CRT_PARSE_C)
619 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200620 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200621 void *p_vrfy; /*!< context for X.509 verify calllback */
622#endif
623
624#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
625 /** Callback to retrieve PSK key from identity */
626 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
627 void *p_psk; /*!< context for PSK callback */
628#endif
629
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200630#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200631 /** Callback to create & write a cookie for ClientHello veirifcation */
632 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
633 const unsigned char *, size_t );
634 /** Callback to verify validity of a ClientHello cookie */
635 int (*f_cookie_check)( void *, const unsigned char *, size_t,
636 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100637 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200638#endif
639
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200640#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200641 /** Callback to create & write a session ticket */
642 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
643 unsigned char *, const unsigned char *, size_t *, uint32_t * );
644 /** Callback to parse a session ticket into a session structure */
645 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
646 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200647#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200648
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100649#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200650 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100651 int (*f_export_keys)( void *, const unsigned char *,
652 const unsigned char *, size_t, size_t, size_t );
653 void *p_export_keys; /*!< context for key export callback */
654#endif
655
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200656#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200657 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200658 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
659 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
660 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
661#endif /* MBEDTLS_X509_CRT_PARSE_C */
662
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200663#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200664 const int *sig_hashes; /*!< allowed signature hashes */
665#endif
666
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200667#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100668 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200669#endif
670
671#if defined(MBEDTLS_DHM_C)
672 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
673 mbedtls_mpi dhm_G; /*!< generator for DHM */
674#endif
675
676#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
677 unsigned char *psk; /*!< pre-shared key */
678 size_t psk_len; /*!< length of the pre-shared key */
679 unsigned char *psk_identity; /*!< identity for PSK negotiation */
680 size_t psk_identity_len;/*!< length of identity */
681#endif
682
683#if defined(MBEDTLS_SSL_ALPN)
684 const char **alpn_list; /*!< ordered list of protocols */
685#endif
686
687 /*
688 * Numerical settings (int then char)
689 */
690
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200691 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
692
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200693#if defined(MBEDTLS_SSL_PROTO_DTLS)
694 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200695 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200696 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200697 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200698#endif
699
700#if defined(MBEDTLS_SSL_RENEGOTIATION)
701 int renego_max_records; /*!< grace period for renegotiation */
702 unsigned char renego_period[8]; /*!< value of the record counters
703 that triggers renegotiation */
704#endif
705
706#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
707 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
708#endif
709
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +0200710#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
711 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
712#endif
713
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200714 unsigned char max_major_ver; /*!< max. major version used */
715 unsigned char max_minor_ver; /*!< max. minor version used */
716 unsigned char min_major_ver; /*!< min. major version used */
717 unsigned char min_minor_ver; /*!< min. minor version used */
718
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200719 /*
720 * Flags (bitfields)
721 */
722
723 unsigned int endpoint : 1; /*!< 0: client, 1: server */
724 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200725 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
726 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
727 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +0200728#if defined(MBEDTLS_ARC4_C)
729 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
730#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +0100731#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
732 unsigned int mfl_code : 3; /*!< desired fragment length */
733#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200734#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
735 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
736#endif
737#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
738 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
739#endif
740#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
741 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
742#endif
743#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
744 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
745#endif
746#if defined(MBEDTLS_SSL_RENEGOTIATION)
747 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
748#endif
749#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
750 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
751#endif
752#if defined(MBEDTLS_SSL_SESSION_TICKETS)
753 unsigned int session_tickets : 1; /*!< use session tickets? */
754#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +0100755#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
756 unsigned int fallback : 1; /*!< is this a fallback? */
757#endif
Janos Follath088ce432017-04-10 12:42:31 +0100758#if defined(MBEDTLS_SSL_SRV_C)
759 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
760 Certificate Request messages? */
761#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200762};
763
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200764
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200765struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +0000766{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200767 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200768
Paul Bakker5121ce52009-01-03 21:22:43 +0000769 /*
770 * Miscellaneous
771 */
772 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +0000774 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +0200775 int renego_records_seen; /*!< Records since renego request, or with DTLS,
776 number of retransmissions of request if
777 renego_max_records is < 0 */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100778#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000779
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000781 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
782
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +0200784 unsigned badmac_seen; /*!< records with a bad MAC received */
785#endif
786
Simon Butchere846b512016-03-01 17:31:49 +0000787 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
788 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
789 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
790 /*!< Callback for network receive with timeout */
791
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +0200792 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +0200793
Paul Bakker5121ce52009-01-03 21:22:43 +0000794 /*
795 * Session layer
796 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200797 mbedtls_ssl_session *session_in; /*!< current session data (in) */
798 mbedtls_ssl_session *session_out; /*!< current session data (out) */
799 mbedtls_ssl_session *session; /*!< negotiated session data */
800 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200802 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +0000803 the handshake process */
804
805 /*
806 * Record layer transformations
807 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200808 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
809 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
810 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
811 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +0000812
Paul Bakker5121ce52009-01-03 21:22:43 +0000813 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +0200814 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200815 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200816 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +0000817
818 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
819 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +0200820
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200821 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000822 * Record layer (incoming data)
823 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100824 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +0200825 unsigned char *in_ctr; /*!< 64-bit incoming message counter
826 TLS: maintained by us
827 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100828 unsigned char *in_hdr; /*!< start of record header */
829 unsigned char *in_len; /*!< two-bytes message length field */
830 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +0100831 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000832 unsigned char *in_offt; /*!< read offset in application data */
833
834 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000835 size_t in_msglen; /*!< record header: message length */
836 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200837#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +0200838 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +0200839 size_t next_record_offset; /*!< offset of the next record in datagram
840 (equal to in_left if none) */
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +0200841#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +0200843 uint64_t in_window_top; /*!< last validated record seq_num */
844 uint64_t in_window; /*!< bitmask for replay detection */
845#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000846
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +0200847 size_t in_hslen; /*!< current handshake message length,
848 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +0000849 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +0100850
851 int keep_current_message; /*!< drop or reuse current message
852 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +0000853
854 /*
855 * Record layer (outgoing data)
856 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100857 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +0000858 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100859 unsigned char *out_hdr; /*!< start of record header */
860 unsigned char *out_len; /*!< two-bytes message length field */
861 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +0100862 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000863
864 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000865 size_t out_msglen; /*!< record header: message length */
866 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +0000867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +0200869 unsigned char *compress_buf; /*!< zlib data buffer */
870#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100872 signed char split_done; /*!< current record already splitted? */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +0100873#endif
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200874
Paul Bakker5121ce52009-01-03 21:22:43 +0000875 /*
876 * PKI layer
877 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200878 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200879
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +0200880 /*
Paul Bakker48916f92012-09-16 19:57:18 +0000881 * User settings
882 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +0100883#if defined(MBEDTLS_X509_CRT_PARSE_C)
884 char *hostname; /*!< expected peer CN for verification
885 (and SNI if available) */
Paul Bakker0be444a2013-08-27 21:55:01 +0200886#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000887
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200888#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200889 const char *alpn_chosen; /*!< negotiated protocol */
890#endif
891
Paul Bakker48916f92012-09-16 19:57:18 +0000892 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +0200893 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +0200894 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200895#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +0200896 unsigned char *cli_id; /*!< transport-level ID of the client */
897 size_t cli_id_len; /*!< length of cli_id */
898#endif
899
900 /*
Paul Bakker48916f92012-09-16 19:57:18 +0000901 * Secure renegotiation
902 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +0000903 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +0000904 int secure_renegotiation; /*!< does peer support legacy or
905 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200906#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +0000907 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200908 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
909 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100910#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000911};
912
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200913#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +0100914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
916#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +0100917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +0000919 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100920 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +0000921 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100922 size_t ivlen,
923 const unsigned char *mac_enc, const unsigned char *mac_dec,
924 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200925extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
926extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
927extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
928extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
929extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
930#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000931
Paul Bakker5121ce52009-01-03 21:22:43 +0000932/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200933 * \brief Return the name of the ciphersuite associated with the
934 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +0000935 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000936 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +0000937 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000938 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +0000939 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200940const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +0000941
942/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200943 * \brief Return the ID of the ciphersuite associated with the
944 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +0000945 *
946 * \param ciphersuite_name SSL ciphersuite name
947 *
948 * \return the ID with the ciphersuite or 0 if not found
949 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200950int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +0000951
952/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000953 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +0200954 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200955 * mbedtls_ssl_free()
956 *
957 * \param ssl SSL context
958 */
959void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
960
961/**
962 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +0000963 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200964 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +0200965 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200966 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +0200967 * \warning The conf structure will be accessed during the session.
968 * It must not be modified or freed as long as the session
969 * is active.
970 *
971 * \warning This function must be called exactly once per context.
972 * Calling mbedtls_ssl_setup again is not supported, even
973 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200974 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000975 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200976 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +0000977 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200978 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +0000979 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000980 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200981int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200982 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +0000983
984/**
Paul Bakker7eb013f2011-10-06 12:37:39 +0000985 * \brief Reset an already initialized SSL context for re-use
986 * while retaining application-set variables, function
987 * pointers and data.
988 *
989 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +0200990 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200991 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
992 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +0000993 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +0000995
996/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000997 * \brief Set the current endpoint type
998 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200999 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001000 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001001 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001002void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001003
1004/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001005 * \brief Set the transport type (TLS or DTLS).
1006 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001007 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001008 * \note For DTLS, you must either provide a recv callback that
1009 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001010 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1011 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001012 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001013 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001014 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001015 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1016 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001017 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001018void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001019
1020/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001021 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001022 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001023 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001024 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001025 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001027 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001028 * (default on server)
1029 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001030 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001031 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001032 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001033 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001034 * handshake is complete.
1035 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001037 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001038 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001039 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001040 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1041 * With MBEDTLS_SSL_VERIFY_OPTIONAL, the user needs to call mbedtls_ssl_get_verify_result() at
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001042 * the right time(s), which may not be obvious, while REQUIRED always perform
1043 * the verification as soon as possible. For example, REQUIRED was protecting
1044 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001045 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001046void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001048#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001049/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001050 * \brief Set the verification callback (Optional).
1051 *
Paul Bakker915275b2012-09-28 07:10:55 +00001052 * If set, the verify callback is called for each
1053 * certificate in the chain. For implementation
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +02001054 * information, please see \c mbedtls_x509_crt_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001055 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001056 * \param conf SSL configuration
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001057 * \param f_vrfy verification function
1058 * \param p_vrfy verification parameter
1059 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001060void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001061 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001062 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001063#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001064
1065/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001066 * \brief Set the random number generator callback
1067 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001068 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001069 * \param f_rng RNG function
1070 * \param p_rng RNG parameter
1071 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001072void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001073 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001074 void *p_rng );
1075
1076/**
1077 * \brief Set the debug callback
1078 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001079 * The callback has the following argument:
1080 * void * opaque context for the callback
1081 * int debug level
1082 * const char * file name
1083 * int line number
1084 * const char * message
1085 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001086 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001087 * \param f_dbg debug function
1088 * \param p_dbg debug parameter
1089 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001090void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001091 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001092 void *p_dbg );
1093
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001094/**
1095 * \brief Set the underlying BIO callbacks for write, read and
1096 * read-with-timeout.
1097 *
1098 * \param ssl SSL context
1099 * \param p_bio parameter (context) shared by BIO callbacks
1100 * \param f_send write callback
1101 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001102 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001103 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001104 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1105 * the other is used. If both are non-NULL, f_recv_timeout is
1106 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001107 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001108 * \note The two most common use cases are:
1109 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1110 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1111 *
1112 * \note For DTLS, you need to provide either a non-NULL
1113 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001114 *
1115 * \note See the documentations of \c mbedtls_ssl_sent_t,
1116 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001117 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001118 *
Andres AG3616f6f2016-09-14 14:32:09 +01001119 * \note On some platforms, net_sockets.c provides
1120 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1121 * \c mbedtls_net_recv_timeout() that are suitable to be used
1122 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001123 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001124void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001125 void *p_bio,
1126 mbedtls_ssl_send_t *f_send,
1127 mbedtls_ssl_recv_t *f_recv,
1128 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001129
1130/**
1131 * \brief Set the timeout period for mbedtls_ssl_read()
1132 * (Default: no timeout.)
1133 *
1134 * \param conf SSL configuration context
1135 * \param timeout Timeout value in milliseconds.
1136 * Use 0 for no timeout (default).
1137 *
1138 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001139 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001140 * With non-blocking I/O, this will only work if timer
1141 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1142 *
1143 * \note With non-blocking I/O, you may also skip this function
1144 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001145 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001146void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001147
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001148/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001149 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001150 *
1151 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001152 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001153 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001154 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001155 *
1156 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1157 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001158 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001159 *
1160 * \note On some platforms, timing.c provides
1161 * \c mbedtls_timing_set_delay() and
1162 * \c mbedtls_timing_get_delay() that are suitable for using
1163 * here, except if using an event-driven style.
1164 *
1165 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001166 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001167 */
1168void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1169 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001170 mbedtls_ssl_set_timer_t *f_set_timer,
1171 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001172
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001173/**
1174 * \brief Callback type: generate and write session ticket
1175 *
1176 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001177 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001178 * authenticated ticket for the session and write it to the
1179 * output buffer. Here, ticket means the opaque ticket part
1180 * of the NewSessionTicket structure of RFC 5077.
1181 *
1182 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001183 * \param session SSL session to be written in the ticket
1184 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001185 * \param end End of the output buffer
1186 * \param tlen On exit, holds the length written
1187 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1188 *
1189 * \return 0 if successful, or
1190 * a specific MBEDTLS_ERR_XXX code.
1191 */
1192typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1193 const mbedtls_ssl_session *session,
1194 unsigned char *start,
1195 const unsigned char *end,
1196 size_t *tlen,
1197 uint32_t *lifetime );
1198
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001199#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1200/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001201 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001202 *
1203 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001204 * (RFC 5216) and Thread. The key pointers are ephemeral and
1205 * therefore must not be stored. The master secret and keys
1206 * should not be used directly except as an input to a key
1207 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001208 *
1209 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001210 * \param ms Pointer to master secret (fixed length: 48 bytes)
1211 * \param kb Pointer to key block, see RFC 5246 section 6.3
1212 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001213 * \param maclen MAC length
1214 * \param keylen Key length
1215 * \param ivlen IV length
1216 *
1217 * \return 0 if successful, or
1218 * a specific MBEDTLS_ERR_XXX code.
1219 */
1220typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001221 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001222 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001223 size_t maclen,
1224 size_t keylen,
1225 size_t ivlen );
1226#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001227
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001228/**
1229 * \brief Callback type: parse and load session ticket
1230 *
1231 * \note This describes what a callback implementation should do.
1232 * This callback should parse a session ticket as generated
1233 * by the corresponding mbedtls_ssl_ticket_write_t function,
1234 * and, if the ticket is authentic and valid, load the
1235 * session.
1236 *
1237 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001238 * bytes of the input buffer, eg to use it as a temporary
1239 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001240 *
1241 * \param p_ticket Context for the callback
1242 * \param session SSL session to be loaded
1243 * \param buf Start of the buffer containing the ticket
1244 * \param len Length of the ticket.
1245 *
1246 * \return 0 if successful, or
1247 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1248 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1249 * any other non-zero code for other failures.
1250 */
1251typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1252 mbedtls_ssl_session *session,
1253 unsigned char *buf,
1254 size_t len );
1255
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001256#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001257/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001258 * \brief Configure SSL session ticket callbacks (server only).
1259 * (Default: none.)
1260 *
1261 * \note On server, session tickets are enabled by providing
1262 * non-NULL callbacks.
1263 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001264 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001265 *
1266 * \param conf SSL configuration context
1267 * \param f_ticket_write Callback for writing a ticket
1268 * \param f_ticket_parse Callback for parsing a ticket
1269 * \param p_ticket Context shared by the two callbacks
1270 */
1271void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1272 mbedtls_ssl_ticket_write_t *f_ticket_write,
1273 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1274 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001275#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001276
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001277#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1278/**
1279 * \brief Configure key export callback.
1280 * (Default: none.)
1281 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001282 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001283 *
1284 * \param conf SSL configuration context
1285 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001286 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001287 */
1288void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1289 mbedtls_ssl_export_keys_t *f_export_keys,
1290 void *p_export_keys );
1291#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1292
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001293/**
1294 * \brief Callback type: generate a cookie
1295 *
1296 * \param ctx Context for the callback
1297 * \param p Buffer to write to,
1298 * must be updated to point right after the cookie
1299 * \param end Pointer to one past the end of the output buffer
1300 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001301 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001302 * \param ilen Length of info in bytes
1303 *
1304 * \return The callback must return 0 on success,
1305 * or a negative error code.
1306 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001308 unsigned char **p, unsigned char *end,
1309 const unsigned char *info, size_t ilen );
1310
1311/**
1312 * \brief Callback type: verify a cookie
1313 *
1314 * \param ctx Context for the callback
1315 * \param cookie Cookie to verify
1316 * \param clen Length of cookie
1317 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001318 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001319 * \param ilen Length of info in bytes
1320 *
1321 * \return The callback must return 0 if cookie is valid,
1322 * or a negative error code.
1323 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001324typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001325 const unsigned char *cookie, size_t clen,
1326 const unsigned char *info, size_t ilen );
1327
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001328#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001329/**
1330 * \brief Register callbacks for DTLS cookies
1331 * (Server only. DTLS only.)
1332 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001333 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001334 * register working callbacks (and initialize their context).
1335 *
1336 * To disable HelloVerifyRequest, register NULL callbacks.
1337 *
1338 * \warning Disabling hello verification allows your server to be used
1339 * for amplification in DoS attacks against other hosts.
1340 * Only disable if you known this can't happen in your
1341 * particular environment.
1342 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001343 * \note See comments on \c mbedtls_ssl_handshake() about handling
1344 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1345 * on the first handshake attempt when this is enabled.
1346 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02001347 * \note This is also necessary to handle client reconnection from
1348 * the same port as described in RFC 6347 section 4.2.8 (only
1349 * the variant with cookies is supported currently). See
1350 * comments on \c mbedtls_ssl_read() for details.
1351 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001352 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001353 * \param f_cookie_write Cookie write callback
1354 * \param f_cookie_check Cookie check callback
1355 * \param p_cookie Context for both callbacks
1356 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001357void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 mbedtls_ssl_cookie_write_t *f_cookie_write,
1359 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001360 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001361
1362/**
1363 * \brief Set client's transport-level identification info.
1364 * (Server only. DTLS only.)
1365 *
1366 * This is usually the IP address (and port), but could be
1367 * anything identify the client depending on the underlying
1368 * network stack. Used for HelloVerifyRequest with DTLS.
1369 * This is *not* used to route the actual packets.
1370 *
1371 * \param ssl SSL context
1372 * \param info Transport-level info identifying the client (eg IP + port)
1373 * \param ilen Length of info in bytes
1374 *
1375 * \note An internal copy is made, so the info buffer can be reused.
1376 *
1377 * \return 0 on success,
1378 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001379 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001380 */
1381int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
1382 const unsigned char *info,
1383 size_t ilen );
1384
1385#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001387#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001388/**
1389 * \brief Enable or disable anti-replay protection for DTLS.
1390 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001391 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001392 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001393 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001395 *
1396 * \warning Disabling this is a security risk unless the application
1397 * protocol handles duplicated packets in a safe way. You
1398 * should not disable this without careful consideration.
1399 * However, if your application already detects duplicated
1400 * packets and needs information about them to adjust its
1401 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001402 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001403void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001404#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001406#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001407/**
1408 * \brief Set a limit on the number of records with a bad MAC
1409 * before terminating the connection.
1410 * (DTLS only, no effect on TLS.)
1411 * Default: 0 (disabled).
1412 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001413 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001414 * \param limit Limit, or 0 to disable.
1415 *
1416 * \note If the limit is N, then the connection is terminated when
1417 * the Nth non-authentic record is seen.
1418 *
1419 * \note Records with an invalid header are not counted, only the
1420 * ones going through the authentication-decryption phase.
1421 *
1422 * \note This is a security trade-off related to the fact that it's
1423 * often relatively easy for an active attacker ot inject UDP
1424 * datagrams. On one hand, setting a low limit here makes it
1425 * easier for such an attacker to forcibly terminated a
1426 * connection. On the other hand, a high limit or no limit
1427 * might make us waste resources checking authentication on
1428 * many bogus packets.
1429 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001430void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001431#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001432
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001433#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001434/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00001435 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001436 * (DTLS only, no effect on TLS.)
1437 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001438 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001439 * \param min Initial timeout value in milliseconds.
1440 * Default: 1000 (1 second).
1441 * \param max Maximum timeout value in milliseconds.
1442 * Default: 60000 (60 seconds).
1443 *
1444 * \note Default values are from RFC 6347 section 4.2.4.1.
1445 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01001446 * \note The 'min' value should typically be slightly above the
1447 * expected round-trip time to your peer, plus whatever time
1448 * it takes for the peer to process the message. For example,
1449 * if your RTT is about 600ms and you peer needs up to 1s to
1450 * do the cryptographic operations in the handshake, then you
1451 * should set 'min' slightly above 1600. Lower values of 'min'
1452 * might cause spurious resends which waste network resources,
1453 * while larger value of 'min' will increase overall latency
1454 * on unreliable network links.
1455 *
1456 * \note The more unreliable your network connection is, the larger
1457 * your max / min ratio needs to be in order to achieve
1458 * reliable handshakes.
1459 *
1460 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
1461 * For example, if min = 1s and max = 5s, the retransmit plan
1462 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
1463 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001464 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001465void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001467
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01001468#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001469/**
Paul Bakker0a597072012-09-25 21:55:46 +00001470 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01001471 * If not set, no session resuming is done (except if session
1472 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00001473 *
Paul Bakker0a597072012-09-25 21:55:46 +00001474 * The session cache has the responsibility to check for stale
1475 * entries based on timeout. See RFC 5246 for recommendations.
1476 *
1477 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1478 * connection shutdown, so do not cache the pointer! Either set
1479 * it to NULL or make a full copy of the certificate.
1480 *
1481 * The get callback is called once during the initial handshake
1482 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001483 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00001484 * If a valid entry is found, it should fill the master of
1485 * the session object with the cached values and return 0,
1486 * return 1 otherwise. Optionally peer_cert can be set as well
1487 * if it is properly present in cache entry.
1488 *
1489 * The set callback is called once during the initial handshake
1490 * to enable session resuming after the entire handshake has
1491 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001492 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00001493 * should create a cache entry for future retrieval based on
1494 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00001496 * data) is cleared by the SSL/TLS layer when the connection is
1497 * terminated. It is recommended to add metadata to determine if
1498 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00001499 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00001500 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001501 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001502 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00001503 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00001504 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00001505 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001506void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001507 void *p_cache,
1508 int (*f_get_cache)(void *, mbedtls_ssl_session *),
1509 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001510#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001511
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001512#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001513/**
Paul Bakker0a597072012-09-25 21:55:46 +00001514 * \brief Request resumption of session (client-side only)
1515 * Session data is copied from presented session structure.
1516 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001517 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001518 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001519 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001520 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001521 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001522 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001523 * arguments are otherwise invalid
1524 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00001526 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
1528#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001529
1530/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001531 * \brief Set the list of allowed ciphersuites and the preference
1532 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001533 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00001534 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001535 * The ciphersuites array is not copied, and must remain
1536 * valid for the lifetime of the ssl_config.
1537 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001538 * Note: The server uses its own preferences
1539 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001541 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001542 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00001543 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00001544 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001545void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001546 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00001547
1548/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001549 * \brief Set the list of allowed ciphersuites and the
1550 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001551 * (Only useful on the server side)
1552 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001553 * The ciphersuites array is not copied, and must remain
1554 * valid for the lifetime of the ssl_config.
1555 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001556 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001557 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001558 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001559 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001560 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1561 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1562 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01001563 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001564 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
1565 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001566 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001567void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001568 const int *ciphersuites,
1569 int major, int minor );
1570
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001571#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001572/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001573 * \brief Set the X.509 security profile used for verification
1574 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001575 * \note The restrictions are enforced for all certificates in the
1576 * chain. However, signatures in the handshake are not covered
1577 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
1578 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001579 * \param conf SSL configuration
1580 * \param profile Profile to use
1581 */
1582void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001583 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001584
1585/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001586 * \brief Set the data required to verify peer certificate
1587 *
Manuel Pégourié-Gonnardfcc43482017-08-21 10:57:57 +02001588 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnard3a130842017-06-21 09:35:44 +02001589 * parameters ca_chain (maps to trust_ca for that function)
1590 * and ca_crl.
1591 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001592 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001593 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00001594 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00001595 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001596void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001597 mbedtls_x509_crt *ca_chain,
1598 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001599
1600/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001601 * \brief Set own certificate chain and private key
1602 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001603 * \note own_cert should contain in order from the bottom up your
1604 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001605 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00001606 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001607 * \note On server, this function can be called multiple times to
1608 * provision more than one cert/key pair (eg one ECDSA, one
1609 * RSA with SHA-256, one RSA with SHA-1). An adequate
1610 * certificate will be selected according to the client's
Antonin Décimo8fd91562019-01-23 15:24:37 +01001611 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001612 * adequate, preference is given to the one set by the first
1613 * call to this function, then second, etc.
1614 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00001615 * \note On client, only the first call has any effect. That is,
1616 * only one client certificate can be provisioned. The
1617 * server's preferences in its CertficateRequest message will
1618 * be ignored and our only cert will be sent regardless of
1619 * whether it matches those preferences - the server can then
1620 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001621 *
Manuel Pégourié-Gonnard3aed5972018-10-25 13:24:21 +02001622 * \note The provided \p pk_key needs to match the public key in the
1623 * first certificate in \p own_cert, or all handshakes using
1624 * that certificate will fail. It is your responsibility
1625 * to ensure that; this function will not perform any check.
1626 * You may use mbedtls_pk_check_pair() in order to perform
1627 * this check yourself, but be aware that this function can
1628 * be computationally expensive on some key types.
1629 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001630 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001631 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02001632 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001633 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001634 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00001635 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001636int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001637 mbedtls_x509_crt *own_cert,
1638 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001639#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00001640
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001641#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001642/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001643 * \brief Set the Pre Shared Key (PSK) and the expected identity name
1644 *
1645 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001646 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001647 *
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01001648 * \note Currently clients can only register one pre-shared key.
Simon Butcherc0957bd2016-03-01 13:16:57 +00001649 * In other words, the servers' identity hint is ignored.
1650 * Support for setting multiple PSKs on clients and selecting
1651 * one based on the identity hint is not a planned feature but
1652 * feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01001653 *
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001654 * \param conf SSL configuration
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001655 * \param psk pointer to the pre-shared key
1656 * \param psk_len pre-shared key length
1657 * \param psk_identity pointer to the pre-shared key identity
1658 * \param psk_identity_len identity key length
Paul Bakker6db455e2013-09-18 17:29:31 +02001659 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001660 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001661 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001662int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001663 const unsigned char *psk, size_t psk_len,
1664 const unsigned char *psk_identity, size_t psk_identity_len );
1665
Paul Bakker6db455e2013-09-18 17:29:31 +02001666
1667/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001668 * \brief Set the Pre Shared Key (PSK) for the current handshake
1669 *
1670 * \note This should only be called inside the PSK callback,
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001671 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001672 *
1673 * \param ssl SSL context
1674 * \param psk pointer to the pre-shared key
1675 * \param psk_len pre-shared key length
1676 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001677 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001678 */
1679int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1680 const unsigned char *psk, size_t psk_len );
1681
1682/**
1683 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02001684 *
1685 * If set, the PSK callback is called for each
1686 * handshake where a PSK ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01001687 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02001688 * receive the actual PSK data and length.
1689 *
1690 * The callback has the following parameters: (void *parameter,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001691 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
Paul Bakker6db455e2013-09-18 17:29:31 +02001692 * size_t identity_len)
1693 * If a valid PSK identity is found, the callback should use
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001694 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
1695 * correct PSK and return 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02001696 * Any other return value will result in a denied PSK identity.
1697 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001698 * \note If you set a PSK callback using this function, then you
1699 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001700 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001701 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001702 * \param conf SSL configuration
Paul Bakker6db455e2013-09-18 17:29:31 +02001703 * \param f_psk PSK identity function
1704 * \param p_psk PSK identity parameter
1705 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001706void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001707 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02001708 size_t),
1709 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001711
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001712#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01001713
1714#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1715
1716#if defined(MBEDTLS_DEPRECATED_WARNING)
1717#define MBEDTLS_DEPRECATED __attribute__((deprecated))
1718#else
1719#define MBEDTLS_DEPRECATED
1720#endif
1721
Paul Bakker5121ce52009-01-03 21:22:43 +00001722/**
1723 * \brief Set the Diffie-Hellman public P and G values,
1724 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01001725 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00001726 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001727 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001728 * \param dhm_P Diffie-Hellman-Merkle modulus
1729 * \param dhm_G Diffie-Hellman-Merkle generator
1730 *
Hanno Becker470a8c42017-10-04 15:28:46 +01001731 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
1732 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001733 * \return 0 if successful
1734 */
Hanno Becker470a8c42017-10-04 15:28:46 +01001735MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
1736 const char *dhm_P,
1737 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00001738
Hanno Becker470a8c42017-10-04 15:28:46 +01001739#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01001740
1741/**
1742 * \brief Set the Diffie-Hellman public P and G values
1743 * from big-endian binary presentations.
1744 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
1745 *
1746 * \param conf SSL configuration
1747 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
1748 * \param P_len Length of DHM modulus
1749 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
1750 * \param G_len Length of DHM generator
1751 *
1752 * \return 0 if successful
1753 */
1754int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1755 const unsigned char *dhm_P, size_t P_len,
1756 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00001757
1758/**
Paul Bakker1b57b062011-01-06 15:48:19 +00001759 * \brief Set the Diffie-Hellman public P and G values,
1760 * read from existing context (server-side only)
1761 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001762 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00001763 * \param dhm_ctx Diffie-Hellman-Merkle context
1764 *
1765 * \return 0 if successful
1766 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001767int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001768#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00001769
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001770#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1771/**
1772 * \brief Set the minimum length for Diffie-Hellman parameters.
1773 * (Client-side only.)
1774 * (Default: 1024 bits.)
1775 *
1776 * \param conf SSL configuration
1777 * \param bitlen Minimum bit length of the DHM prime
1778 */
1779void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1780 unsigned int bitlen );
1781#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1782
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001783#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01001784/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001785 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01001786 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01001787 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001788 * On server: this only affects selection of the ECDHE curve;
1789 * the curves used for ECDH and ECDSA are determined by the
1790 * list of available certificates instead.
1791 *
1792 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01001793 * use. The server can override our preference order.
1794 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001795 * Both sides: limits the set of curves accepted for use in
1796 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02001797 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001798 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02001799 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001800 * for that. For the end-entity certificate however, the key
1801 * will be accepted only if it is allowed both by this list
1802 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01001803 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001804 * \note This list should be ordered by decreasing preference
1805 * (preferred curve first).
1806 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001807 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001808 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001809 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01001810 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001811void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
1812 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001813#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01001814
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001815#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001816/**
1817 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01001818 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001819 *
1820 * \note This only affects which hashes are offered and can be used
1821 * for signatures during the handshake. Hashes for message
1822 * authentication and the TLS PRF are controlled by the
1823 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
1824 * used for certificate signature are controlled by the
1825 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
1826 *
1827 * \note This list should be ordered by decreasing preference
1828 * (preferred hash first).
1829 *
1830 * \param conf SSL configuration
1831 * \param hashes Ordered list of allowed signature hashes,
1832 * terminated by \c MBEDTLS_MD_NONE.
1833 */
1834void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1835 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001836#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001837
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001838#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00001839/**
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001840 * \brief Set or reset the hostname to check against the received
1841 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01001842 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02001843 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001844 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01001845 * \param hostname the server hostname, may be NULL to clear hostname
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001846 *
Hanno Becker0446a392017-04-07 12:59:32 +01001847 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00001848 *
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001849 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
1850 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01001851 * too long input hostname.
1852 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01001853 * Hostname set to the one provided on success (cleared
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001854 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01001855 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00001856 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001857int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001858#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001859
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001860#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00001861/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001862 * \brief Set own certificate and key for the current handshake
1863 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001864 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001865 * the SNI callback.
1866 *
1867 * \param ssl SSL context
1868 * \param own_cert own public certificate chain
1869 * \param pk_key own private key
1870 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001871 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001872 */
1873int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1874 mbedtls_x509_crt *own_cert,
1875 mbedtls_pk_context *pk_key );
1876
1877/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001878 * \brief Set the data required to verify peer certificate for the
1879 * current handshake
1880 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001881 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001882 * the SNI callback.
1883 *
1884 * \param ssl SSL context
1885 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1886 * \param ca_crl trusted CA CRLs
1887 */
1888void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1889 mbedtls_x509_crt *ca_chain,
1890 mbedtls_x509_crl *ca_crl );
1891
1892/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001893 * \brief Set authmode for the current handshake.
1894 *
1895 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
1896 * the SNI callback.
1897 *
1898 * \param ssl SSL context
1899 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
1900 * MBEDTLS_SSL_VERIFY_REQUIRED
1901 */
1902void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1903 int authmode );
1904
1905/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00001906 * \brief Set server side ServerName TLS extension callback
1907 * (optional, server-side only).
1908 *
1909 * If set, the ServerName callback is called whenever the
1910 * server receives a ServerName TLS extension from the client
1911 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001912 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001913 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001914 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001915 * certificate(s) and key(s) to use with \c
1916 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001917 * and may optionally adjust the CA and associated CRL with \c
1918 * mbedtls_ssl_set_hs_ca_chain() as well as the client
1919 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
1920 * then must return 0. If no matching name is found, the
1921 * callback must either set a default cert, or
1922 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00001923 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001924 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00001925 * \param f_sni verification function
1926 * \param p_sni verification parameter
1927 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001928void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001929 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001930 size_t),
1931 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00001933
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001934#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001935/**
1936 * \brief Set the EC J-PAKE password for current handshake.
1937 *
1938 * \note An internal copy is made, and destroyed as soon as the
1939 * handshake is completed, or when the SSL context is reset or
1940 * freed.
1941 *
1942 * \note The SSL context needs to be already set up. The right place
1943 * to call this function is between \c mbedtls_ssl_setup() or
1944 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
1945 *
1946 * \param ssl SSL context
1947 * \param pw EC J-PAKE password (pre-shared secret)
1948 * \param pw_len length of pw in bytes
1949 *
1950 * \return 0 on success, or a negative error code.
1951 */
1952int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1953 const unsigned char *pw,
1954 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001955#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001956
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001957#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001958/**
1959 * \brief Set the supported Application Layer Protocols.
1960 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001961 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00001962 * \param protos Pointer to a NULL-terminated list of supported protocols,
1963 * in decreasing preference order. The pointer to the list is
1964 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00001965 * the lifetime of the table must be atleast as long as the
1966 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001967 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001968 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001969 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001970int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001971
1972/**
1973 * \brief Get the name of the negotiated Application Layer Protocol.
1974 * This function should be called after the handshake is
1975 * completed.
1976 *
1977 * \param ssl SSL context
1978 *
1979 * \return Protcol name, or NULL if no protocol was negotiated.
1980 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001981const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
1982#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001983
Paul Bakker5701cdc2012-09-27 21:49:42 +00001984/**
Paul Bakker490ecc82011-10-06 13:04:09 +00001985 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02001986 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001987 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02001988 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001989 * \note This ignores ciphersuites from higher versions.
1990 *
1991 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1992 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001993 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001994 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001995 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1996 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1997 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1998 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00001999 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002000void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002001
Paul Bakker1d29fb52012-09-28 13:28:45 +00002002/**
2003 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002004 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002005 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002006 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2007 * SSL_MIN_XXXXX_VERSION range is ignored.
2008 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002010 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002011 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2012 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2013 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002014 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002015 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2016 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2017 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2018 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002019 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002020void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002021
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002022#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002023/**
2024 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002026 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002028 * connection, that is a connection with max_version set to a
2029 * lower value than the value you're willing to use. Such
2030 * fallback connections are not recommended but are sometimes
2031 * necessary to interoperate with buggy (version-intolerant)
2032 * servers.
2033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002035 * non-fallback connections! This would appear to work for a
2036 * while, then cause failures when the server is upgraded to
2037 * support a newer TLS version.
2038 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002039 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002040 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002041 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002042void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002044
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002045#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002046/**
2047 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002049 *
2050 * \note This should always be enabled, it is a security
2051 * improvement, and should not cause any interoperability
2052 * issue (used only if the peer supports it too).
2053 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002054 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002055 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002056 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002057void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002059
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002060#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002061/**
2062 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002064 *
2065 * \note This should always be enabled, it is a security fix to the
2066 * protocol, and should not cause any interoperability issue
2067 * (used only if the peer supports it too).
2068 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002069 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002070 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002071 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002072void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002074
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002075#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002076/**
2077 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002078 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002079 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002080 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002081 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002082 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00002083 * \note This function is deprecated and will likely be removed in
2084 * a future version of the library.
2085 * RC4 is disabled by default at compile time and needs to be
2086 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002087 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002088 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002089 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002090 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002091void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002092#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002093
Janos Follath088ce432017-04-10 12:42:31 +01002094#if defined(MBEDTLS_SSL_SRV_C)
2095/**
2096 * \brief Whether to send a list of acceptable CAs in
2097 * CertificateRequest messages.
2098 * (Default: do send)
2099 *
2100 * \param conf SSL configuration
2101 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
2102 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
2103 */
2104void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2105 char cert_req_ca_list );
2106#endif /* MBEDTLS_SSL_SRV_C */
2107
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002108#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00002109/**
k-stachowiak79ad2862019-04-29 11:15:43 +02002110 * \brief Set the maximum fragment length to emit and/or negotiate.
k-stachowiak8aed8e12019-05-10 15:09:21 +02002111 * (Typical: #MBEDTLS_SSL_MAX_CONTENT_LEN, by default that is
2112 * set to `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002113 * (Server: set maximum fragment length to emit,
k-stachowiak79ad2862019-04-29 11:15:43 +02002114 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002115 * (Client: set maximum fragment length to emit *and*
2116 * negotiate with the server during handshake)
k-stachowiak79ad2862019-04-29 11:15:43 +02002117 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
2118 *
k-stachowiak2dd69e12019-04-30 12:32:11 +02002119 * \note With TLS, this currently only affects ApplicationData (sent
2120 * with \c mbedtls_ssl_read()), not handshake messages.
2121 * With DTLS, this affects both ApplicationData and handshake.
2122 *
k-stachowiak79ad2862019-04-29 11:15:43 +02002123 * \note On the client side, the maximum fragment length extension
2124 * *will not* be used, unless the maximum fragment length has
2125 * been set via this function to a value different than
2126 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
2127 *
2128 * \note This sets the maximum length for a record's payload,
2129 * excluding record overhead that will be added to it, see
2130 * \c mbedtls_ssl_get_record_expansion().
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002131 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002132 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002133 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002134 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2135 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002136 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002137 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002138 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002139int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002140#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002141
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002142#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002143/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01002144 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01002145 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002146 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002147 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002148 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2149 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002150 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002151void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002154#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002155/**
2156 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002158 *
2159 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2160 * Does not affect non-CBC ciphersuites in any version.
2161 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01002162 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002163 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2164 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002165 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002166void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002167#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002168
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002169#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002170/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002171 * \brief Enable / Disable session tickets (client only).
2172 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002173 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002174 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002175 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002176 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002177 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2178 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002179 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002180void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
2181#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002183#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002184/**
Paul Bakker09f097d2012-10-23 11:54:56 +00002185 * \brief Enable / Disable renegotiation support for connection when
2186 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002187 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00002188 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002189 * \warning It is recommended to always disable renegotation unless you
2190 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00002191 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002192 * renegotiation or a poor understanding of its properties.
2193 *
2194 * \note Server-side, enabling renegotiation also makes the server
2195 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00002196 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002197 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002198 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
2199 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00002200 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002201void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002203
2204/**
2205 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002206 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02002207 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002208 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002209 * be established even if the peer does not support
2210 * secure renegotiation, but does not allow renegotiation
2211 * to take place if not secure.
2212 * (Interoperable and secure option)
2213 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002214 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002215 * with non-upgraded peers. Allowing legacy renegotiation
2216 * makes the connection vulnerable to specific man in the
2217 * middle attacks. (See RFC 5746)
2218 * (Most interoperable and least secure option)
2219 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002220 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002221 * if peer does not support secure renegotiation. Results
2222 * in interoperability issues with non-upgraded peers
2223 * that do not support renegotiation altogether.
2224 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00002225 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002226 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00002227 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
2228 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002229 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00002230 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002231void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00002232
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002233#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00002234/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002235 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002236 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002237 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002238 * When we request a renegotiation, the peer can comply or
2239 * ignore the request. This function allows us to decide
2240 * whether to enforce our renegotiation requests by closing
2241 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002242 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002243 * However, records could already be in transit from the peer
2244 * when the request is emitted. In order to increase
2245 * reliability, we can accept a number of records before the
2246 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002247 *
2248 * The optimal value is highly dependent on the specific usage
2249 * scenario.
2250 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002251 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002252 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002253 * out or receives Application Data, until:
2254 * - max_records records have beens seen, if it is >= 0, or
2255 * - the number of retransmits that would happen during an
2256 * actual handshake has been reached.
2257 * Please remember the request might be lost a few times
2258 * if you consider setting max_records to a really low value.
2259 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002260 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002261 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002262 * which always behave as if max_record was 0. The reason is,
2263 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002265 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002266 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002268 * enforce renegotiation, or a non-negative value to enforce
2269 * it but allow for a grace period of max_records records.
2270 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002271void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002272
2273/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002274 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00002275 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002276 *
2277 * Renegotiation is automatically triggered when a record
2278 * counter (outgoing or ingoing) crosses the defined
2279 * threshold. The default value is meant to prevent the
2280 * connection from being closed when the counter is about to
2281 * reached its maximal value (it is not allowed to wrap).
2282 *
2283 * Lower values can be used to enforce policies such as "keys
2284 * must be refreshed every N packets with cipher X".
2285 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00002286 * The renegotiation period can be disabled by setting
2287 * conf->disable_renegotiation to
2288 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
2289 *
2290 * \note When the configured transport is
2291 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
2292 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
2293 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00002294 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002295 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002296 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002297 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002298void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002299 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002300#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002301
Paul Bakker43ca69c2011-01-15 17:35:19 +00002302/**
2303 * \brief Return the number of data bytes available to read
2304 *
2305 * \param ssl SSL context
2306 *
2307 * \return how many bytes are available in the read buffer
2308 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002309size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002310
2311/**
2312 * \brief Return the result of the certificate verification
2313 *
Hanno Becker995878c2018-10-23 10:28:01 +01002314 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00002315 *
Hanno Becker995878c2018-10-23 10:28:01 +01002316 * \return \c 0 if the certificate verification was successful.
2317 * \return \c -1u if the result is not available. This may happen
2318 * e.g. if the handshake aborts early, or a verification
2319 * callback returned a fatal error.
2320 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
2321 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00002322 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002323uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002324
2325/**
2326 * \brief Return the name of the current ciphersuite
2327 *
2328 * \param ssl SSL context
2329 *
2330 * \return a string containing the ciphersuite name
2331 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002332const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002333
2334/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00002335 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
2336 *
2337 * \param ssl SSL context
2338 *
2339 * \return a string containing the SSL version
2340 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002341const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002342
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002343/**
2344 * \brief Return the (maximum) number of bytes added by the record
2345 * layer: header + encryption/MAC overhead (inc. padding)
2346 *
2347 * \param ssl SSL context
2348 *
2349 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002350 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02002351 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002354
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002355#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2356/**
2357 * \brief Return the maximum fragment length (payload, in bytes).
2358 * This is the value negotiated with peer if any,
2359 * or the locally configured value.
2360 *
2361 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
2362 * called with a larger length value.
2363 * With TLS, \c mbedtls_ssl_write() will fragment the input if
2364 * necessary and return the number of bytes written; it is up
2365 * to the caller to call \c mbedtls_ssl_write() again in
2366 * order to send the remaining bytes if any.
2367 *
2368 * \param ssl SSL context
2369 *
2370 * \return Current maximum fragment length.
2371 */
2372size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
2373#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002375#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002376/**
Paul Bakkerb0550d92012-10-30 07:51:03 +00002377 * \brief Return the peer certificate from the current connection
2378 *
2379 * Note: Can be NULL in case no certificate was sent during
2380 * the handshake. Different calls for the same connection can
2381 * return the same or different pointers for the same
2382 * certificate and even a different certificate altogether.
2383 * The peer cert CAN change in a single connection if
2384 * renegotiation is performed.
2385 *
2386 * \param ssl SSL context
2387 *
2388 * \return the current peer certificate
2389 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002390const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
2391#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002392
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00002394/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002395 * \brief Save session in order to resume it later (client-side only)
2396 * Session data is copied to presented session structure.
2397 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002398 *
2399 * \param ssl SSL context
2400 * \param session session context
2401 *
2402 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002403 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002404 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor98848f02018-07-04 17:42:47 +03002405 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002406 *
Ron Eldora9779f12018-07-17 11:21:50 +03002407 * \note Only the server certificate is copied, and not the full chain,
2408 * so you should not attempt to validate the certificate again
2409 * by calling \c mbedtls_x509_crt_verify() on it.
2410 * Instead, you should use the results from the verification
2411 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
2412 * after loading the session again into a new SSL context
2413 * using \c mbedtls_ssl_set_session().
2414 *
2415 * \note Once the session object is not needed anymore, you should
2416 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002417 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002418 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002419 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002420int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
2421#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002422
2423/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002424 * \brief Perform the SSL handshake
2425 *
2426 * \param ssl SSL context
2427 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002428 * \return 0 if successful, or
2429 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
Simon Butcher1a57af12015-09-11 17:14:16 +01002430 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED (see below), or
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002431 * a specific SSL error code.
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002432 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002433 * \note If this function returns something other than 0 or
2434 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002435 * becomes unusable, and you should either free it or call
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002436 * \c mbedtls_ssl_session_reset() on it before re-using it for
2437 * a new connection; the current connection must be closed.
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002438 *
2439 * \note If DTLS is in use, then you may choose to handle
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002440 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002441 * purposes, as it is an expected return value rather than an
2442 * actual error, but you still need to reset/free the context.
Paul Bakker5121ce52009-01-03 21:22:43 +00002443 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002444int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002445
2446/**
Paul Bakker1961b702013-01-25 14:49:24 +01002447 * \brief Perform a single step of the SSL handshake
2448 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002449 * \note The state of the context (ssl->state) will be at
Aaron Jonesd96e5262016-06-17 14:40:41 +00002450 * the next state after execution of this function. Do not
2451 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01002452 *
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002453 * \note If this function returns something other than 0 or
2454 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2455 * becomes unusable, and you should either free it or call
2456 * \c mbedtls_ssl_session_reset() on it before re-using it for
2457 * a new connection; the current connection must be closed.
2458 *
Paul Bakker1961b702013-01-25 14:49:24 +01002459 * \param ssl SSL context
2460 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002461 * \return 0 if successful, or
2462 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2463 * a specific SSL error code.
Paul Bakker1961b702013-01-25 14:49:24 +01002464 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002465int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002466
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002467#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01002468/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002469 * \brief Initiate an SSL renegotiation on the running connection.
2470 * Client: perform the renegotiation right now.
2471 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00002472 * during the next call to mbedtls_ssl_read() if honored by
2473 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00002474 *
2475 * \param ssl SSL context
2476 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002477 * \return 0 if successful, or any mbedtls_ssl_handshake() return
2478 * value.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002479 *
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.
Paul Bakker48916f92012-09-16 19:57:18 +00002485 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002486int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
2487#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002488
2489/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002490 * \brief Read at most 'len' application data bytes
2491 *
2492 * \param ssl SSL context
2493 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02002494 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00002495 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02002496 * \return the number of bytes read, or
2497 * 0 for EOF, or
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002498 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2499 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT (see below), or
2500 * another negative error code.
2501 *
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002502 * \note If this function returns something other than a positive
2503 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE or
2504 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT, then the ssl context
2505 * becomes unusable, and you should either free it or call
2506 * \c mbedtls_ssl_session_reset() on it before re-using it for
2507 * a new connection; the current connection must be closed.
2508 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002509 * \note When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
2510 * (which can only happen server-side), it means that a client
2511 * is initiating a new connection using the same source port.
2512 * You can either treat that as a connection close and wait
2513 * for the client to resend a ClientHello, or directly
2514 * continue with \c mbedtls_ssl_handshake() with the same
2515 * context (as it has beeen reset internally). Either way, you
2516 * should make sure this is seen by the application as a new
2517 * connection: application state, if any, should be reset, and
2518 * most importantly the identity of the client must be checked
2519 * again. WARNING: not validating the identity of the client
2520 * again, or not transmitting the new identity to the
2521 * application layer, would allow authentication bypass!
Paul Bakker5121ce52009-01-03 21:22:43 +00002522 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002523int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002524
2525/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002526 * \brief Try to write exactly 'len' application data bytes
2527 *
2528 * \warning This function will do partial writes in some cases. If the
2529 * return value is non-negative but less than length, the
2530 * function must be called again with updated arguments:
2531 * buf + ret, len - ret (if ret is the return value) until
2532 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00002533 *
2534 * \param ssl SSL context
2535 * \param buf buffer holding the data
2536 * \param len how many bytes must be written
2537 *
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002538 * \return the number of bytes actually written (may be less than len),
Jaakko Korhonenaca11a02017-02-07 14:44:40 +02002539 * or MBEDTLS_ERR_SSL_WANT_WRITE or MBEDTLS_ERR_SSL_WANT_READ,
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002540 * or another negative error code.
Paul Bakker5121ce52009-01-03 21:22:43 +00002541 *
Andres Amaya Garciadbd17b72017-07-11 16:15:54 +01002542 * \note If this function returns something other than 0, a positive
2543 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop
2544 * using the SSL context for reading or writing, and either
2545 * free it or call \c mbedtls_ssl_session_reset() on it before
2546 * re-using it for a new connection; the current connection
2547 * must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002548 *
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002549 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00002550 * it must be called later with the *same* arguments,
Andres Amaya Garciadbd17b72017-07-11 16:15:54 +01002551 * until it returns a value greater that or equal to 0. When
2552 * the function returns MBEDTLS_ERR_SSL_WANT_WRITE there may be
2553 * some partial data in the output buffer, however this is not
2554 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02002555 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00002556 * \note If the requested length is greater than the maximum
2557 * fragment length (either the built-in limit or the one set
2558 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002559 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002560 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002561 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
2562 * active maximum fragment length.
Andres Amaya Garciadbd17b72017-07-11 16:15:54 +01002563 *
2564 * \note Attempting to write 0 bytes will result in an empty TLS
2565 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00002566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002568
2569/**
Paul Bakker0a925182012-04-16 06:46:41 +00002570 * \brief Send an alert message
2571 *
2572 * \param ssl SSL context
2573 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002574 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00002575 * \param message The alert message (SSL_ALERT_MSG_*)
2576 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00002577 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002578 *
2579 * \note If this function returns something other than 0 or
2580 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2581 * becomes unusable, and you should either free it or call
2582 * \c mbedtls_ssl_session_reset() on it before re-using it for
2583 * a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00002584 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002585int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00002586 unsigned char level,
2587 unsigned char message );
2588/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002589 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00002590 *
2591 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002592 *
2593 * \return 0 if successful, or a specific SSL error code.
2594 *
2595 * \note If this function returns something other than 0 or
2596 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2597 * becomes unusable, and you should either free it or call
2598 * \c mbedtls_ssl_session_reset() on it before re-using it for
2599 * a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00002600 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002602
2603/**
Paul Bakker48916f92012-09-16 19:57:18 +00002604 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00002605 *
2606 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002607 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002609
Paul Bakker48916f92012-09-16 19:57:18 +00002610/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002611 * \brief Initialize an SSL configuration context
2612 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002613 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002614 *
2615 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo8fd91562019-01-23 15:24:37 +01002616 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002617 *
2618 * \param conf SSL configuration context
2619 */
2620void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
2621
2622/**
2623 * \brief Load reasonnable default SSL configuration values.
2624 * (You need to call mbedtls_ssl_config_init() first.)
2625 *
2626 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002627 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
2628 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
2629 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02002630 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002631 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002632 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01002633 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002634 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002635 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002636 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02002637int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02002638 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002639
2640/**
2641 * \brief Free an SSL configuration context
2642 *
2643 * \param conf SSL configuration context
2644 */
2645void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
2646
2647/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002648 * \brief Initialize SSL session structure
2649 *
2650 * \param session SSL session
2651 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002652void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002653
2654/**
Paul Bakker0a597072012-09-25 21:55:46 +00002655 * \brief Free referenced items in an SSL session including the
2656 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00002657 *
Ron Eldora9779f12018-07-17 11:21:50 +03002658 * \note A session object can be freed even if the SSL context
2659 * that was used to retrieve the session is still in use.
2660 *
Paul Bakker48916f92012-09-16 19:57:18 +00002661 * \param session SSL session
2662 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002663void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00002664
Paul Bakker5121ce52009-01-03 21:22:43 +00002665#ifdef __cplusplus
2666}
2667#endif
2668
2669#endif /* ssl.h */