blob: 9ff5096f81fc3d69825e9db5417fc6b4ee0ae821 [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 */
Ronald Crona32236c2020-04-23 16:41:44 +0200128#define MBEDTLS_SSL_MAX_ALPN_NAME_LEN 255 /*!< Maximum size in bytes of a protocol name in alpn ext., RFC 7301 */
129
130#define MBEDTLS_SSL_MAX_ALPN_LIST_LEN 65535 /*!< Maximum size in bytes of list in alpn ext., RFC 7301 */
Simon Butcher89f77622015-09-27 22:50:49 +0100131
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200132/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200133 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
135#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
136#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
137#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
138#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
139#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200140
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200141#define MBEDTLS_SSL_IS_CLIENT 0
142#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200143
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200144#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
145#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200146
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
148#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200149
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200150#define MBEDTLS_SSL_ETM_DISABLED 0
151#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100152
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153#define MBEDTLS_SSL_COMPRESS_NULL 0
154#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000155
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200156#define MBEDTLS_SSL_VERIFY_NONE 0
157#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
158#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200159#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000160
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200161#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
162#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
165#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
168#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
171#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
174#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
175#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
178#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
179#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200180
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200181#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
182#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200183
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100184#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
185#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100186
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200187#define MBEDTLS_SSL_ARC4_ENABLED 0
188#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100189
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200190#define MBEDTLS_SSL_PRESET_DEFAULT 0
191#define MBEDTLS_SSL_PRESET_SUITEB 2
192
Janos Follath088ce432017-04-10 12:42:31 +0100193#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
194#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
195
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200196/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200197 * Default range for DTLS retransmission timer value, in milliseconds.
198 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
199 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
201#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200202
Paul Bakker088c5c52014-04-25 11:11:10 +0200203/**
204 * \name SECTION: Module settings
205 *
206 * The configuration options you can set for this module are in this section.
207 * Either change them in config.h or define them on the compiler command line.
208 * \{
209 */
210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200211#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
212#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200213#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200214
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200215/*
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200216 * Maxium fragment length in bytes,
217 * determines the size of each of the two internal I/O buffers.
218 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200219 * Note: the RFC defines the default size of SSL / TLS messages. If you
220 * change the value here, other clients / servers may not be able to
221 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200222 * both sides of the connection and have it reduced at both sides, or
223 * if you're using the Max Fragment Length extension and you know all your
224 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200225 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200226#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
227#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200228#endif
229
230/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000231
232/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100233 * Length of the verify data for secure renegotiation
234 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200235#if defined(MBEDTLS_SSL_PROTO_SSL3)
236#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100237#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200238#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100239#endif
240
241/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200242 * Signaling ciphersuite values (SCSV)
243 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200244#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000245#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000246
Paul Bakker5121ce52009-01-03 21:22:43 +0000247/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000248 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200249 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000250 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200251#define MBEDTLS_SSL_HASH_NONE 0
252#define MBEDTLS_SSL_HASH_MD5 1
253#define MBEDTLS_SSL_HASH_SHA1 2
254#define MBEDTLS_SSL_HASH_SHA224 3
255#define MBEDTLS_SSL_HASH_SHA256 4
256#define MBEDTLS_SSL_HASH_SHA384 5
257#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000258
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200259#define MBEDTLS_SSL_SIG_ANON 0
260#define MBEDTLS_SSL_SIG_RSA 1
261#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000262
263/*
Paul Bakker926af752012-11-23 13:38:07 +0100264 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200265 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100266 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
268#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100269
270/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000271 * Message, alert and handshake types
272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
274#define MBEDTLS_SSL_MSG_ALERT 21
275#define MBEDTLS_SSL_MSG_HANDSHAKE 22
276#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Paul Bakker5121ce52009-01-03 21:22:43 +0000277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
279#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
282#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
283#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
284#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
285#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
286#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
287#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
288#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
289#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
290#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
291#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
292#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
293#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
294#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
295#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
296#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
297#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
298#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
299#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
300#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
301#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
302#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
303#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
304#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
305#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
306#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
307#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
308#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
309#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000310
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200311#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
312#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
313#define MBEDTLS_SSL_HS_SERVER_HELLO 2
314#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
315#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
316#define MBEDTLS_SSL_HS_CERTIFICATE 11
317#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
318#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
319#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
320#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
321#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
322#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000323
324/*
325 * TLS extensions
326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327#define MBEDTLS_TLS_EXT_SERVERNAME 0
328#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000329
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200330#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200334#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
335#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000336
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200337#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
342#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200343
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200344#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200345
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200346#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
347
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200348#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000349
Paul Bakkereb2c6582012-09-27 19:15:01 +0000350/*
Paul Bakkered27a042013-04-18 22:46:23 +0200351 * Size defines
352 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353#if !defined(MBEDTLS_PSK_MAX_LEN)
354#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200355#endif
356
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200357/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200358union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200359{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200360#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200361 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
362#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
364 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200365#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
367 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
368 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
369 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
370 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
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_PSK_ENABLED)
373 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200374#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
376 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
377 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
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_RSA_PSK_ENABLED)
380 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200381#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
383 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
384 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200385#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200386#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
387 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
388#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200389};
390
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200391#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200392
Paul Bakker407a0da2013-06-27 14:29:21 +0200393#ifdef __cplusplus
394extern "C" {
395#endif
396
Paul Bakkered27a042013-04-18 22:46:23 +0200397/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000398 * SSL state machine
399 */
400typedef enum
401{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200402 MBEDTLS_SSL_HELLO_REQUEST,
403 MBEDTLS_SSL_CLIENT_HELLO,
404 MBEDTLS_SSL_SERVER_HELLO,
405 MBEDTLS_SSL_SERVER_CERTIFICATE,
406 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
407 MBEDTLS_SSL_CERTIFICATE_REQUEST,
408 MBEDTLS_SSL_SERVER_HELLO_DONE,
409 MBEDTLS_SSL_CLIENT_CERTIFICATE,
410 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
411 MBEDTLS_SSL_CERTIFICATE_VERIFY,
412 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
413 MBEDTLS_SSL_CLIENT_FINISHED,
414 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
415 MBEDTLS_SSL_SERVER_FINISHED,
416 MBEDTLS_SSL_FLUSH_BUFFERS,
417 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
418 MBEDTLS_SSL_HANDSHAKE_OVER,
419 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
420 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000421}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000423
Simon Butchere846b512016-03-01 17:31:49 +0000424/**
425 * \brief Callback type: send data on the network.
426 *
427 * \note That callback may be either blocking or non-blocking.
428 *
429 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000430 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000431 * \param len Length of the data to send
432 *
433 * \return The callback must return the number of bytes sent if any,
434 * or a non-zero error code.
435 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
436 * must be returned when the operation would block.
437 *
Simon Butcherd567a232016-03-09 20:19:21 +0000438 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000439 * It must always return the number of bytes actually sent.
440 */
441typedef int mbedtls_ssl_send_t( void *ctx,
442 const unsigned char *buf,
443 size_t len );
444
445/**
446 * \brief Callback type: receive data from the network.
447 *
448 * \note That callback may be either blocking or non-blocking.
449 *
450 * \param ctx Context for the receive callback (typically a file
451 * descriptor)
452 * \param buf Buffer to write the received data to
453 * \param len Length of the receive buffer
454 *
455 * \return The callback must return the number of bytes received,
456 * or a non-zero error code.
457 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
458 * must be returned when the operation would block.
459 *
Simon Butcherd567a232016-03-09 20:19:21 +0000460 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000461 * buffer. It must always return the number of bytes actually
462 * received and written to the buffer.
463 */
464typedef int mbedtls_ssl_recv_t( void *ctx,
465 unsigned char *buf,
466 size_t len );
467
468/**
469 * \brief Callback type: receive data from the network, with timeout
470 *
471 * \note That callback must block until data is received, or the
472 * timeout delay expires, or the operation is interrupted by a
473 * signal.
474 *
475 * \param ctx Context for the receive callback (typically a file descriptor)
476 * \param buf Buffer to write the received data to
477 * \param len Length of the receive buffer
478 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000479 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000480 *
481 * \return The callback must return the number of bytes received,
482 * or a non-zero error code:
483 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
484 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
485 *
Simon Butcherd567a232016-03-09 20:19:21 +0000486 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000487 * buffer. It must always return the number of bytes actually
488 * received and written to the buffer.
489 */
490typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
491 unsigned char *buf,
492 size_t len,
493 uint32_t timeout );
494/**
495 * \brief Callback type: set a pair of timers/delays to watch
496 *
497 * \param ctx Context pointer
498 * \param int_ms Intermediate delay in milliseconds
499 * \param fin_ms Final delay in milliseconds
500 * 0 cancels the current timer.
501 *
502 * \note This callback must at least store the necessary information
503 * for the associated \c mbedtls_ssl_get_timer_t callback to
504 * return correct information.
505 *
506 * \note If using a event-driven style of programming, an event must
507 * be generated when the final delay is passed. The event must
508 * cause a call to \c mbedtls_ssl_handshake() with the proper
509 * SSL context to be scheduled. Care must be taken to ensure
510 * that at most one such call happens at a time.
511 *
512 * \note Only one timer at a time must be running. Calling this
513 * function while a timer is running must cancel it. Cancelled
514 * timers must not generate any event.
515 */
516typedef void mbedtls_ssl_set_timer_t( void * ctx,
517 uint32_t int_ms,
518 uint32_t fin_ms );
519
520/**
521 * \brief Callback type: get status of timers/delays
522 *
523 * \param ctx Context pointer
524 *
525 * \return This callback must return:
526 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000527 * 0 if none of the delays have passed,
528 * 1 if only the intermediate delay has passed,
529 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000530 */
531typedef int mbedtls_ssl_get_timer_t( void * ctx );
532
533
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200534/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200535typedef struct mbedtls_ssl_session mbedtls_ssl_session;
536typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200537typedef struct mbedtls_ssl_config mbedtls_ssl_config;
538
539/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200540typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
541typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100542typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200543#if defined(MBEDTLS_X509_CRT_PARSE_C)
544typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200545#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200546#if defined(MBEDTLS_SSL_PROTO_DTLS)
547typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200548#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000549
550/*
Paul Bakker0a597072012-09-25 21:55:46 +0000551 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000552 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200553struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000554{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200555#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100556 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200557#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000558 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000559 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200560 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000561 unsigned char id[32]; /*!< session identifier */
562 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200563
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200564#if defined(MBEDTLS_X509_CRT_PARSE_C)
565 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
566#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200567 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200568
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200569#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200570 unsigned char *ticket; /*!< RFC 5077 session ticket */
571 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200572 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200573#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200574
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200575#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200576 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200577#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200578
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200579#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200580 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200581#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100582
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200583#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100584 int encrypt_then_mac; /*!< flag for EtM activation */
585#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000586};
587
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200588/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200589 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200590 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200591struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200592{
593 /* Group items by size (largest first) to minimize padding overhead */
594
595 /*
596 * Pointers
597 */
598
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100599 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200600
601 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200602 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200603 void *p_dbg; /*!< context for the debug function */
604
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100605 /** Callback for getting (pseudo-)random numbers */
606 int (*f_rng)(void *, unsigned char *, size_t);
607 void *p_rng; /*!< context for the RNG function */
608
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200609 /** Callback to retrieve a session from the cache */
610 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200611 /** Callback to store a session into the cache */
612 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100613 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200614
615#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
616 /** Callback for setting cert according to SNI extension */
617 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
618 void *p_sni; /*!< context for SNI callback */
619#endif
620
621#if defined(MBEDTLS_X509_CRT_PARSE_C)
622 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200623 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200624 void *p_vrfy; /*!< context for X.509 verify calllback */
625#endif
626
627#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
628 /** Callback to retrieve PSK key from identity */
629 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
630 void *p_psk; /*!< context for PSK callback */
631#endif
632
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200633#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200634 /** Callback to create & write a cookie for ClientHello veirifcation */
635 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
636 const unsigned char *, size_t );
637 /** Callback to verify validity of a ClientHello cookie */
638 int (*f_cookie_check)( void *, const unsigned char *, size_t,
639 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100640 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200641#endif
642
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200643#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200644 /** Callback to create & write a session ticket */
645 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
646 unsigned char *, const unsigned char *, size_t *, uint32_t * );
647 /** Callback to parse a session ticket into a session structure */
648 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
649 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200650#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200651
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100652#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200653 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100654 int (*f_export_keys)( void *, const unsigned char *,
655 const unsigned char *, size_t, size_t, size_t );
656 void *p_export_keys; /*!< context for key export callback */
657#endif
658
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200659#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200660 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200661 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
662 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
663 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
664#endif /* MBEDTLS_X509_CRT_PARSE_C */
665
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200666#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200667 const int *sig_hashes; /*!< allowed signature hashes */
668#endif
669
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200670#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100671 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200672#endif
673
674#if defined(MBEDTLS_DHM_C)
675 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
676 mbedtls_mpi dhm_G; /*!< generator for DHM */
677#endif
678
679#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
680 unsigned char *psk; /*!< pre-shared key */
681 size_t psk_len; /*!< length of the pre-shared key */
682 unsigned char *psk_identity; /*!< identity for PSK negotiation */
683 size_t psk_identity_len;/*!< length of identity */
684#endif
685
686#if defined(MBEDTLS_SSL_ALPN)
687 const char **alpn_list; /*!< ordered list of protocols */
688#endif
689
690 /*
691 * Numerical settings (int then char)
692 */
693
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200694 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
695
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200696#if defined(MBEDTLS_SSL_PROTO_DTLS)
697 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200698 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200699 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200700 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200701#endif
702
703#if defined(MBEDTLS_SSL_RENEGOTIATION)
704 int renego_max_records; /*!< grace period for renegotiation */
705 unsigned char renego_period[8]; /*!< value of the record counters
706 that triggers renegotiation */
707#endif
708
709#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
710 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
711#endif
712
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +0200713#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
714 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
715#endif
716
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200717 unsigned char max_major_ver; /*!< max. major version used */
718 unsigned char max_minor_ver; /*!< max. minor version used */
719 unsigned char min_major_ver; /*!< min. major version used */
720 unsigned char min_minor_ver; /*!< min. minor version used */
721
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200722 /*
723 * Flags (bitfields)
724 */
725
726 unsigned int endpoint : 1; /*!< 0: client, 1: server */
727 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200728 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
729 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
730 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +0200731#if defined(MBEDTLS_ARC4_C)
732 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
733#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +0100734#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
735 unsigned int mfl_code : 3; /*!< desired fragment length */
736#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200737#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
738 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
739#endif
740#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
741 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
742#endif
743#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
744 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
745#endif
746#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
747 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
748#endif
749#if defined(MBEDTLS_SSL_RENEGOTIATION)
750 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
751#endif
752#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
753 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
754#endif
755#if defined(MBEDTLS_SSL_SESSION_TICKETS)
756 unsigned int session_tickets : 1; /*!< use session tickets? */
757#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +0100758#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
759 unsigned int fallback : 1; /*!< is this a fallback? */
760#endif
Janos Follath088ce432017-04-10 12:42:31 +0100761#if defined(MBEDTLS_SSL_SRV_C)
762 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
763 Certificate Request messages? */
764#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200765};
766
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200767
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200768struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +0000769{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200770 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200771
Paul Bakker5121ce52009-01-03 21:22:43 +0000772 /*
773 * Miscellaneous
774 */
775 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200776#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +0000777 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +0200778 int renego_records_seen; /*!< Records since renego request, or with DTLS,
779 number of retransmissions of request if
780 renego_max_records is < 0 */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100781#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000782
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000784 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
785
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200786#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +0200787 unsigned badmac_seen; /*!< records with a bad MAC received */
788#endif
789
Simon Butchere846b512016-03-01 17:31:49 +0000790 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
791 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
792 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
793 /*!< Callback for network receive with timeout */
794
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +0200795 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +0200796
Paul Bakker5121ce52009-01-03 21:22:43 +0000797 /*
798 * Session layer
799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200800 mbedtls_ssl_session *session_in; /*!< current session data (in) */
801 mbedtls_ssl_session *session_out; /*!< current session data (out) */
802 mbedtls_ssl_session *session; /*!< negotiated session data */
803 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000804
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200805 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +0000806 the handshake process */
807
808 /*
809 * Record layer transformations
810 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200811 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
812 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
813 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
814 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +0000815
Paul Bakker5121ce52009-01-03 21:22:43 +0000816 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +0200817 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200818 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200819 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +0000820
821 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
822 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +0200823
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200824 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000825 * Record layer (incoming data)
826 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100827 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +0200828 unsigned char *in_ctr; /*!< 64-bit incoming message counter
829 TLS: maintained by us
830 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100831 unsigned char *in_hdr; /*!< start of record header */
832 unsigned char *in_len; /*!< two-bytes message length field */
833 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +0100834 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000835 unsigned char *in_offt; /*!< read offset in application data */
836
837 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000838 size_t in_msglen; /*!< record header: message length */
839 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +0200841 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +0200842 size_t next_record_offset; /*!< offset of the next record in datagram
843 (equal to in_left if none) */
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +0200844#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200845#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +0200846 uint64_t in_window_top; /*!< last validated record seq_num */
847 uint64_t in_window; /*!< bitmask for replay detection */
848#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000849
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +0200850 size_t in_hslen; /*!< current handshake message length,
851 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +0000852 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +0100853
854 int keep_current_message; /*!< drop or reuse current message
855 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +0000856
857 /*
858 * Record layer (outgoing data)
859 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100860 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +0000861 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100862 unsigned char *out_hdr; /*!< start of record header */
863 unsigned char *out_len; /*!< two-bytes message length field */
864 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +0100865 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000866
867 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000868 size_t out_msglen; /*!< record header: message length */
869 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +0000870
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200871#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +0200872 unsigned char *compress_buf; /*!< zlib data buffer */
873#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100875 signed char split_done; /*!< current record already splitted? */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +0100876#endif
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200877
Paul Bakker5121ce52009-01-03 21:22:43 +0000878 /*
879 * PKI layer
880 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200881 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200882
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +0200883 /*
Paul Bakker48916f92012-09-16 19:57:18 +0000884 * User settings
885 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +0100886#if defined(MBEDTLS_X509_CRT_PARSE_C)
887 char *hostname; /*!< expected peer CN for verification
888 (and SNI if available) */
Paul Bakker0be444a2013-08-27 21:55:01 +0200889#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000890
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200891#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200892 const char *alpn_chosen; /*!< negotiated protocol */
893#endif
894
Paul Bakker48916f92012-09-16 19:57:18 +0000895 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +0200896 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +0200897 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200898#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +0200899 unsigned char *cli_id; /*!< transport-level ID of the client */
900 size_t cli_id_len; /*!< length of cli_id */
901#endif
902
903 /*
Paul Bakker48916f92012-09-16 19:57:18 +0000904 * Secure renegotiation
905 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +0000906 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +0000907 int secure_renegotiation; /*!< does peer support legacy or
908 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200909#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +0000910 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200911 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
912 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100913#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000914};
915
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200916#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +0100917
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200918#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
919#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +0100920
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200921extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +0000922 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100923 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +0000924 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100925 size_t ivlen,
926 const unsigned char *mac_enc, const unsigned char *mac_dec,
927 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200928extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
929extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
930extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
931extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
932extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
933#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000934
Paul Bakker5121ce52009-01-03 21:22:43 +0000935/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200936 * \brief Return the name of the ciphersuite associated with the
937 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +0000938 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000939 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +0000940 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000941 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +0000942 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200943const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +0000944
945/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200946 * \brief Return the ID of the ciphersuite associated with the
947 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +0000948 *
949 * \param ciphersuite_name SSL ciphersuite name
950 *
951 * \return the ID with the ciphersuite or 0 if not found
952 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200953int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +0000954
955/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000956 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +0200957 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200958 * mbedtls_ssl_free()
959 *
960 * \param ssl SSL context
961 */
962void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
963
964/**
965 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +0000966 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200967 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +0200968 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200969 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +0200970 * \warning The conf structure will be accessed during the session.
971 * It must not be modified or freed as long as the session
972 * is active.
973 *
974 * \warning This function must be called exactly once per context.
975 * Calling mbedtls_ssl_setup again is not supported, even
976 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200977 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000978 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200979 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +0000980 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200981 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +0000982 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000983 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200984int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200985 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +0000986
987/**
Paul Bakker7eb013f2011-10-06 12:37:39 +0000988 * \brief Reset an already initialized SSL context for re-use
989 * while retaining application-set variables, function
990 * pointers and data.
991 *
992 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +0200993 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200994 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
995 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +0000996 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200997int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +0000998
999/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001000 * \brief Set the current endpoint type
1001 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001002 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001003 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001004 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001005void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001006
1007/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001008 * \brief Set the transport type (TLS or DTLS).
1009 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001010 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001011 * \note For DTLS, you must either provide a recv callback that
1012 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001013 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1014 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001015 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001016 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001017 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001018 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1019 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001020 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001021void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001022
1023/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001024 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001025 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001026 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001027 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001028 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001029 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001030 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001031 * (default on server)
1032 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001034 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001035 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001036 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001037 * handshake is complete.
1038 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001039 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001040 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001041 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001042 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001043 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1044 * 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 +01001045 * the right time(s), which may not be obvious, while REQUIRED always perform
1046 * the verification as soon as possible. For example, REQUIRED was protecting
1047 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001048 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001049void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001050
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001051#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001052/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001053 * \brief Set the verification callback (Optional).
1054 *
Paul Bakker915275b2012-09-28 07:10:55 +00001055 * If set, the verify callback is called for each
1056 * certificate in the chain. For implementation
Manuel Pégourié-Gonnard31458a12017-06-26 10:11:49 +02001057 * information, please see \c mbedtls_x509_crt_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001058 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001059 * \param conf SSL configuration
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001060 * \param f_vrfy verification function
1061 * \param p_vrfy verification parameter
1062 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001063void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001064 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001065 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001066#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001067
1068/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001069 * \brief Set the random number generator callback
1070 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001071 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001072 * \param f_rng RNG function
1073 * \param p_rng RNG parameter
1074 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001075void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001076 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001077 void *p_rng );
1078
1079/**
1080 * \brief Set the debug callback
1081 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001082 * The callback has the following argument:
1083 * void * opaque context for the callback
1084 * int debug level
1085 * const char * file name
1086 * int line number
1087 * const char * message
1088 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001089 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001090 * \param f_dbg debug function
1091 * \param p_dbg debug parameter
1092 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001093void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001094 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001095 void *p_dbg );
1096
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001097/**
1098 * \brief Set the underlying BIO callbacks for write, read and
1099 * read-with-timeout.
1100 *
1101 * \param ssl SSL context
1102 * \param p_bio parameter (context) shared by BIO callbacks
1103 * \param f_send write callback
1104 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001105 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001106 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001107 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1108 * the other is used. If both are non-NULL, f_recv_timeout is
1109 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001110 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001111 * \note The two most common use cases are:
1112 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1113 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1114 *
1115 * \note For DTLS, you need to provide either a non-NULL
1116 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001117 *
1118 * \note See the documentations of \c mbedtls_ssl_sent_t,
1119 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001120 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001121 *
Andres AG3616f6f2016-09-14 14:32:09 +01001122 * \note On some platforms, net_sockets.c provides
1123 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1124 * \c mbedtls_net_recv_timeout() that are suitable to be used
1125 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001126 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001127void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001128 void *p_bio,
1129 mbedtls_ssl_send_t *f_send,
1130 mbedtls_ssl_recv_t *f_recv,
1131 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001132
1133/**
1134 * \brief Set the timeout period for mbedtls_ssl_read()
1135 * (Default: no timeout.)
1136 *
1137 * \param conf SSL configuration context
1138 * \param timeout Timeout value in milliseconds.
1139 * Use 0 for no timeout (default).
1140 *
1141 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001142 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001143 * With non-blocking I/O, this will only work if timer
1144 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1145 *
1146 * \note With non-blocking I/O, you may also skip this function
1147 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001148 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001149void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001150
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001151/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001152 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001153 *
1154 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001155 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001156 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001157 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001158 *
1159 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1160 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001161 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001162 *
1163 * \note On some platforms, timing.c provides
1164 * \c mbedtls_timing_set_delay() and
1165 * \c mbedtls_timing_get_delay() that are suitable for using
1166 * here, except if using an event-driven style.
1167 *
1168 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001169 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001170 */
1171void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1172 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001173 mbedtls_ssl_set_timer_t *f_set_timer,
1174 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001175
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001176/**
1177 * \brief Callback type: generate and write session ticket
1178 *
1179 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001180 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001181 * authenticated ticket for the session and write it to the
1182 * output buffer. Here, ticket means the opaque ticket part
1183 * of the NewSessionTicket structure of RFC 5077.
1184 *
1185 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001186 * \param session SSL session to be written in the ticket
1187 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001188 * \param end End of the output buffer
1189 * \param tlen On exit, holds the length written
1190 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1191 *
1192 * \return 0 if successful, or
1193 * a specific MBEDTLS_ERR_XXX code.
1194 */
1195typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1196 const mbedtls_ssl_session *session,
1197 unsigned char *start,
1198 const unsigned char *end,
1199 size_t *tlen,
1200 uint32_t *lifetime );
1201
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001202#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1203/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001204 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001205 *
1206 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001207 * (RFC 5216) and Thread. The key pointers are ephemeral and
1208 * therefore must not be stored. The master secret and keys
1209 * should not be used directly except as an input to a key
1210 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001211 *
1212 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001213 * \param ms Pointer to master secret (fixed length: 48 bytes)
1214 * \param kb Pointer to key block, see RFC 5246 section 6.3
1215 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001216 * \param maclen MAC length
1217 * \param keylen Key length
1218 * \param ivlen IV length
1219 *
1220 * \return 0 if successful, or
1221 * a specific MBEDTLS_ERR_XXX code.
1222 */
1223typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001224 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001225 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001226 size_t maclen,
1227 size_t keylen,
1228 size_t ivlen );
1229#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001230
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001231/**
1232 * \brief Callback type: parse and load session ticket
1233 *
1234 * \note This describes what a callback implementation should do.
1235 * This callback should parse a session ticket as generated
1236 * by the corresponding mbedtls_ssl_ticket_write_t function,
1237 * and, if the ticket is authentic and valid, load the
1238 * session.
1239 *
1240 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001241 * bytes of the input buffer, eg to use it as a temporary
1242 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001243 *
1244 * \param p_ticket Context for the callback
1245 * \param session SSL session to be loaded
1246 * \param buf Start of the buffer containing the ticket
1247 * \param len Length of the ticket.
1248 *
1249 * \return 0 if successful, or
1250 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1251 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1252 * any other non-zero code for other failures.
1253 */
1254typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1255 mbedtls_ssl_session *session,
1256 unsigned char *buf,
1257 size_t len );
1258
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001259#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001260/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001261 * \brief Configure SSL session ticket callbacks (server only).
1262 * (Default: none.)
1263 *
1264 * \note On server, session tickets are enabled by providing
1265 * non-NULL callbacks.
1266 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001267 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001268 *
1269 * \param conf SSL configuration context
1270 * \param f_ticket_write Callback for writing a ticket
1271 * \param f_ticket_parse Callback for parsing a ticket
1272 * \param p_ticket Context shared by the two callbacks
1273 */
1274void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1275 mbedtls_ssl_ticket_write_t *f_ticket_write,
1276 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1277 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001278#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001279
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001280#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1281/**
1282 * \brief Configure key export callback.
1283 * (Default: none.)
1284 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001285 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001286 *
1287 * \param conf SSL configuration context
1288 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001289 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001290 */
1291void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1292 mbedtls_ssl_export_keys_t *f_export_keys,
1293 void *p_export_keys );
1294#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1295
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001296/**
1297 * \brief Callback type: generate a cookie
1298 *
1299 * \param ctx Context for the callback
1300 * \param p Buffer to write to,
1301 * must be updated to point right after the cookie
1302 * \param end Pointer to one past the end of the output buffer
1303 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001304 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001305 * \param ilen Length of info in bytes
1306 *
1307 * \return The callback must return 0 on success,
1308 * or a negative error code.
1309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001311 unsigned char **p, unsigned char *end,
1312 const unsigned char *info, size_t ilen );
1313
1314/**
1315 * \brief Callback type: verify a cookie
1316 *
1317 * \param ctx Context for the callback
1318 * \param cookie Cookie to verify
1319 * \param clen Length of cookie
1320 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001321 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001322 * \param ilen Length of info in bytes
1323 *
1324 * \return The callback must return 0 if cookie is valid,
1325 * or a negative error code.
1326 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001327typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001328 const unsigned char *cookie, size_t clen,
1329 const unsigned char *info, size_t ilen );
1330
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001331#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001332/**
1333 * \brief Register callbacks for DTLS cookies
1334 * (Server only. DTLS only.)
1335 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001336 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001337 * register working callbacks (and initialize their context).
1338 *
1339 * To disable HelloVerifyRequest, register NULL callbacks.
1340 *
1341 * \warning Disabling hello verification allows your server to be used
1342 * for amplification in DoS attacks against other hosts.
1343 * Only disable if you known this can't happen in your
1344 * particular environment.
1345 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001346 * \note See comments on \c mbedtls_ssl_handshake() about handling
1347 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1348 * on the first handshake attempt when this is enabled.
1349 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02001350 * \note This is also necessary to handle client reconnection from
1351 * the same port as described in RFC 6347 section 4.2.8 (only
1352 * the variant with cookies is supported currently). See
1353 * comments on \c mbedtls_ssl_read() for details.
1354 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001355 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001356 * \param f_cookie_write Cookie write callback
1357 * \param f_cookie_check Cookie check callback
1358 * \param p_cookie Context for both callbacks
1359 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001360void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001361 mbedtls_ssl_cookie_write_t *f_cookie_write,
1362 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001363 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001364
1365/**
1366 * \brief Set client's transport-level identification info.
1367 * (Server only. DTLS only.)
1368 *
1369 * This is usually the IP address (and port), but could be
1370 * anything identify the client depending on the underlying
1371 * network stack. Used for HelloVerifyRequest with DTLS.
1372 * This is *not* used to route the actual packets.
1373 *
1374 * \param ssl SSL context
1375 * \param info Transport-level info identifying the client (eg IP + port)
1376 * \param ilen Length of info in bytes
1377 *
1378 * \note An internal copy is made, so the info buffer can be reused.
1379 *
1380 * \return 0 on success,
1381 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001382 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001383 */
1384int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
1385 const unsigned char *info,
1386 size_t ilen );
1387
1388#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001389
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001391/**
1392 * \brief Enable or disable anti-replay protection for DTLS.
1393 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001394 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001395 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001396 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001397 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001398 *
1399 * \warning Disabling this is a security risk unless the application
1400 * protocol handles duplicated packets in a safe way. You
1401 * should not disable this without careful consideration.
1402 * However, if your application already detects duplicated
1403 * packets and needs information about them to adjust its
1404 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001405 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001406void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001407#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001408
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001409#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001410/**
1411 * \brief Set a limit on the number of records with a bad MAC
1412 * before terminating the connection.
1413 * (DTLS only, no effect on TLS.)
1414 * Default: 0 (disabled).
1415 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001416 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001417 * \param limit Limit, or 0 to disable.
1418 *
1419 * \note If the limit is N, then the connection is terminated when
1420 * the Nth non-authentic record is seen.
1421 *
1422 * \note Records with an invalid header are not counted, only the
1423 * ones going through the authentication-decryption phase.
1424 *
1425 * \note This is a security trade-off related to the fact that it's
1426 * often relatively easy for an active attacker ot inject UDP
1427 * datagrams. On one hand, setting a low limit here makes it
1428 * easier for such an attacker to forcibly terminated a
1429 * connection. On the other hand, a high limit or no limit
1430 * might make us waste resources checking authentication on
1431 * many bogus packets.
1432 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001433void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001435
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001436#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001437/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00001438 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001439 * (DTLS only, no effect on TLS.)
1440 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001441 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001442 * \param min Initial timeout value in milliseconds.
1443 * Default: 1000 (1 second).
1444 * \param max Maximum timeout value in milliseconds.
1445 * Default: 60000 (60 seconds).
1446 *
1447 * \note Default values are from RFC 6347 section 4.2.4.1.
1448 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01001449 * \note The 'min' value should typically be slightly above the
1450 * expected round-trip time to your peer, plus whatever time
1451 * it takes for the peer to process the message. For example,
1452 * if your RTT is about 600ms and you peer needs up to 1s to
1453 * do the cryptographic operations in the handshake, then you
1454 * should set 'min' slightly above 1600. Lower values of 'min'
1455 * might cause spurious resends which waste network resources,
1456 * while larger value of 'min' will increase overall latency
1457 * on unreliable network links.
1458 *
1459 * \note The more unreliable your network connection is, the larger
1460 * your max / min ratio needs to be in order to achieve
1461 * reliable handshakes.
1462 *
1463 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
1464 * For example, if min = 1s and max = 5s, the retransmit plan
1465 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
1466 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001467 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001468void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001469#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001470
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01001471#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001472/**
Paul Bakker0a597072012-09-25 21:55:46 +00001473 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01001474 * If not set, no session resuming is done (except if session
1475 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00001476 *
Paul Bakker0a597072012-09-25 21:55:46 +00001477 * The session cache has the responsibility to check for stale
1478 * entries based on timeout. See RFC 5246 for recommendations.
1479 *
1480 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1481 * connection shutdown, so do not cache the pointer! Either set
1482 * it to NULL or make a full copy of the certificate.
1483 *
1484 * The get callback is called once during the initial handshake
1485 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001486 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00001487 * If a valid entry is found, it should fill the master of
1488 * the session object with the cached values and return 0,
1489 * return 1 otherwise. Optionally peer_cert can be set as well
1490 * if it is properly present in cache entry.
1491 *
1492 * The set callback is called once during the initial handshake
1493 * to enable session resuming after the entire handshake has
1494 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001495 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00001496 * should create a cache entry for future retrieval based on
1497 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001498 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00001499 * data) is cleared by the SSL/TLS layer when the connection is
1500 * terminated. It is recommended to add metadata to determine if
1501 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00001502 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00001503 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001504 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001505 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00001506 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00001507 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00001508 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001509void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001510 void *p_cache,
1511 int (*f_get_cache)(void *, mbedtls_ssl_session *),
1512 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001513#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001514
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001515#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001516/**
Paul Bakker0a597072012-09-25 21:55:46 +00001517 * \brief Request resumption of session (client-side only)
1518 * Session data is copied from presented session structure.
1519 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001520 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001521 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001522 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001523 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001524 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001525 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001526 * arguments are otherwise invalid
1527 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001528 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00001529 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001530int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
1531#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001532
1533/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001534 * \brief Set the list of allowed ciphersuites and the preference
1535 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001536 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00001537 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001538 * The ciphersuites array is not copied, and must remain
1539 * valid for the lifetime of the ssl_config.
1540 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001541 * Note: The server uses its own preferences
1542 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001543 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001544 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001545 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00001546 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00001547 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001548void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001549 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00001550
1551/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001552 * \brief Set the list of allowed ciphersuites and the
1553 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001554 * (Only useful on the server side)
1555 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001556 * The ciphersuites array is not copied, and must remain
1557 * valid for the lifetime of the ssl_config.
1558 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001559 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001560 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001561 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001562 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001563 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1564 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1565 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01001566 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001567 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
1568 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001569 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001570void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001571 const int *ciphersuites,
1572 int major, int minor );
1573
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001574#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001575/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001576 * \brief Set the X.509 security profile used for verification
1577 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001578 * \note The restrictions are enforced for all certificates in the
1579 * chain. However, signatures in the handshake are not covered
1580 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
1581 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001582 * \param conf SSL configuration
1583 * \param profile Profile to use
1584 */
1585void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01001586 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001587
1588/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001589 * \brief Set the data required to verify peer certificate
1590 *
Manuel Pégourié-Gonnardfcc43482017-08-21 10:57:57 +02001591 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnard3a130842017-06-21 09:35:44 +02001592 * parameters ca_chain (maps to trust_ca for that function)
1593 * and ca_crl.
1594 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001595 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001596 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00001597 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00001598 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001599void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001600 mbedtls_x509_crt *ca_chain,
1601 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001602
1603/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001604 * \brief Set own certificate chain and private key
1605 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001606 * \note own_cert should contain in order from the bottom up your
1607 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001608 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00001609 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001610 * \note On server, this function can be called multiple times to
1611 * provision more than one cert/key pair (eg one ECDSA, one
1612 * RSA with SHA-256, one RSA with SHA-1). An adequate
1613 * certificate will be selected according to the client's
Antonin Décimo8fd91562019-01-23 15:24:37 +01001614 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001615 * adequate, preference is given to the one set by the first
1616 * call to this function, then second, etc.
1617 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00001618 * \note On client, only the first call has any effect. That is,
1619 * only one client certificate can be provisioned. The
1620 * server's preferences in its CertficateRequest message will
1621 * be ignored and our only cert will be sent regardless of
1622 * whether it matches those preferences - the server can then
1623 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001624 *
Manuel Pégourié-Gonnard3aed5972018-10-25 13:24:21 +02001625 * \note The provided \p pk_key needs to match the public key in the
1626 * first certificate in \p own_cert, or all handshakes using
1627 * that certificate will fail. It is your responsibility
1628 * to ensure that; this function will not perform any check.
1629 * You may use mbedtls_pk_check_pair() in order to perform
1630 * this check yourself, but be aware that this function can
1631 * be computationally expensive on some key types.
1632 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001633 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001634 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02001635 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001636 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001637 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00001638 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001639int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001640 mbedtls_x509_crt *own_cert,
1641 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001642#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00001643
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001644#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001645/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001646 * \brief Set the Pre Shared Key (PSK) and the expected identity name
1647 *
1648 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001649 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001650 *
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01001651 * \note Currently clients can only register one pre-shared key.
Simon Butcherc0957bd2016-03-01 13:16:57 +00001652 * In other words, the servers' identity hint is ignored.
1653 * Support for setting multiple PSKs on clients and selecting
1654 * one based on the identity hint is not a planned feature but
1655 * feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01001656 *
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001657 * \param conf SSL configuration
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001658 * \param psk pointer to the pre-shared key
1659 * \param psk_len pre-shared key length
1660 * \param psk_identity pointer to the pre-shared key identity
1661 * \param psk_identity_len identity key length
Paul Bakker6db455e2013-09-18 17:29:31 +02001662 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001663 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001664 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001665int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001666 const unsigned char *psk, size_t psk_len,
1667 const unsigned char *psk_identity, size_t psk_identity_len );
1668
Paul Bakker6db455e2013-09-18 17:29:31 +02001669
1670/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001671 * \brief Set the Pre Shared Key (PSK) for the current handshake
1672 *
1673 * \note This should only be called inside the PSK callback,
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001674 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001675 *
1676 * \param ssl SSL context
1677 * \param psk pointer to the pre-shared key
1678 * \param psk_len pre-shared key length
1679 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001680 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001681 */
1682int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1683 const unsigned char *psk, size_t psk_len );
1684
1685/**
1686 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02001687 *
1688 * If set, the PSK callback is called for each
1689 * handshake where a PSK ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01001690 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02001691 * receive the actual PSK data and length.
1692 *
1693 * The callback has the following parameters: (void *parameter,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001694 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
Paul Bakker6db455e2013-09-18 17:29:31 +02001695 * size_t identity_len)
1696 * If a valid PSK identity is found, the callback should use
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001697 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
1698 * correct PSK and return 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02001699 * Any other return value will result in a denied PSK identity.
1700 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001701 * \note If you set a PSK callback using this function, then you
1702 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001703 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001704 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001705 * \param conf SSL configuration
Paul Bakker6db455e2013-09-18 17:29:31 +02001706 * \param f_psk PSK identity function
1707 * \param p_psk PSK identity parameter
1708 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001709void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001710 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02001711 size_t),
1712 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001713#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001714
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001715#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01001716
1717#if !defined(MBEDTLS_DEPRECATED_REMOVED)
1718
1719#if defined(MBEDTLS_DEPRECATED_WARNING)
1720#define MBEDTLS_DEPRECATED __attribute__((deprecated))
1721#else
1722#define MBEDTLS_DEPRECATED
1723#endif
1724
Paul Bakker5121ce52009-01-03 21:22:43 +00001725/**
1726 * \brief Set the Diffie-Hellman public P and G values,
1727 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01001728 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00001729 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001730 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001731 * \param dhm_P Diffie-Hellman-Merkle modulus
1732 * \param dhm_G Diffie-Hellman-Merkle generator
1733 *
Hanno Becker470a8c42017-10-04 15:28:46 +01001734 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
1735 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001736 * \return 0 if successful
1737 */
Hanno Becker470a8c42017-10-04 15:28:46 +01001738MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
1739 const char *dhm_P,
1740 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00001741
Hanno Becker470a8c42017-10-04 15:28:46 +01001742#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01001743
1744/**
1745 * \brief Set the Diffie-Hellman public P and G values
1746 * from big-endian binary presentations.
1747 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
1748 *
1749 * \param conf SSL configuration
1750 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
1751 * \param P_len Length of DHM modulus
1752 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
1753 * \param G_len Length of DHM generator
1754 *
1755 * \return 0 if successful
1756 */
1757int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
1758 const unsigned char *dhm_P, size_t P_len,
1759 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00001760
1761/**
Paul Bakker1b57b062011-01-06 15:48:19 +00001762 * \brief Set the Diffie-Hellman public P and G values,
1763 * read from existing context (server-side only)
1764 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001765 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00001766 * \param dhm_ctx Diffie-Hellman-Merkle context
1767 *
1768 * \return 0 if successful
1769 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001770int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001771#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00001772
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001773#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1774/**
1775 * \brief Set the minimum length for Diffie-Hellman parameters.
1776 * (Client-side only.)
1777 * (Default: 1024 bits.)
1778 *
1779 * \param conf SSL configuration
1780 * \param bitlen Minimum bit length of the DHM prime
1781 */
1782void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1783 unsigned int bitlen );
1784#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1785
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001786#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01001787/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001788 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01001789 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01001790 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001791 * On server: this only affects selection of the ECDHE curve;
1792 * the curves used for ECDH and ECDSA are determined by the
1793 * list of available certificates instead.
1794 *
1795 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01001796 * use. The server can override our preference order.
1797 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001798 * Both sides: limits the set of curves accepted for use in
1799 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02001800 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001801 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02001802 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02001803 * for that. For the end-entity certificate however, the key
1804 * will be accepted only if it is allowed both by this list
1805 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01001806 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001807 * \note This list should be ordered by decreasing preference
1808 * (preferred curve first).
1809 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001810 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001811 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01001813 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001814void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
1815 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02001816#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01001817
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001818#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001819/**
1820 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01001821 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001822 *
1823 * \note This only affects which hashes are offered and can be used
1824 * for signatures during the handshake. Hashes for message
1825 * authentication and the TLS PRF are controlled by the
1826 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
1827 * used for certificate signature are controlled by the
1828 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
1829 *
1830 * \note This list should be ordered by decreasing preference
1831 * (preferred hash first).
1832 *
1833 * \param conf SSL configuration
1834 * \param hashes Ordered list of allowed signature hashes,
1835 * terminated by \c MBEDTLS_MD_NONE.
1836 */
1837void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
1838 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02001839#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02001840
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001841#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00001842/**
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001843 * \brief Set or reset the hostname to check against the received
1844 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01001845 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02001846 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001847 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01001848 * \param hostname the server hostname, may be NULL to clear hostname
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001849 *
Hanno Becker0446a392017-04-07 12:59:32 +01001850 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00001851 *
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001852 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
1853 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01001854 * too long input hostname.
1855 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01001856 * Hostname set to the one provided on success (cleared
Simon Butcherbb5e1c32018-06-08 11:14:43 +01001857 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01001858 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00001859 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001860int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001861#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001862
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001863#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00001864/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001865 * \brief Set own certificate and key for the current handshake
1866 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001867 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001868 * the SNI callback.
1869 *
1870 * \param ssl SSL context
1871 * \param own_cert own public certificate chain
1872 * \param pk_key own private key
1873 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001874 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001875 */
1876int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1877 mbedtls_x509_crt *own_cert,
1878 mbedtls_pk_context *pk_key );
1879
1880/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001881 * \brief Set the data required to verify peer certificate for the
1882 * current handshake
1883 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001884 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001885 * the SNI callback.
1886 *
1887 * \param ssl SSL context
1888 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1889 * \param ca_crl trusted CA CRLs
1890 */
1891void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1892 mbedtls_x509_crt *ca_chain,
1893 mbedtls_x509_crl *ca_crl );
1894
1895/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001896 * \brief Set authmode for the current handshake.
1897 *
1898 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
1899 * the SNI callback.
1900 *
1901 * \param ssl SSL context
1902 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
1903 * MBEDTLS_SSL_VERIFY_REQUIRED
1904 */
1905void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
1906 int authmode );
1907
1908/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00001909 * \brief Set server side ServerName TLS extension callback
1910 * (optional, server-side only).
1911 *
1912 * If set, the ServerName callback is called whenever the
1913 * server receives a ServerName TLS extension from the client
1914 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001915 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001916 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001917 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001918 * certificate(s) and key(s) to use with \c
1919 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02001920 * and may optionally adjust the CA and associated CRL with \c
1921 * mbedtls_ssl_set_hs_ca_chain() as well as the client
1922 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
1923 * then must return 0. If no matching name is found, the
1924 * callback must either set a default cert, or
1925 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00001926 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001927 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00001928 * \param f_sni verification function
1929 * \param p_sni verification parameter
1930 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001931void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001932 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001933 size_t),
1934 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001935#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00001936
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001937#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001938/**
1939 * \brief Set the EC J-PAKE password for current handshake.
1940 *
1941 * \note An internal copy is made, and destroyed as soon as the
1942 * handshake is completed, or when the SSL context is reset or
1943 * freed.
1944 *
1945 * \note The SSL context needs to be already set up. The right place
1946 * to call this function is between \c mbedtls_ssl_setup() or
1947 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
1948 *
1949 * \param ssl SSL context
1950 * \param pw EC J-PAKE password (pre-shared secret)
1951 * \param pw_len length of pw in bytes
1952 *
1953 * \return 0 on success, or a negative error code.
1954 */
1955int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
1956 const unsigned char *pw,
1957 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02001958#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02001959
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001960#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001961/**
1962 * \brief Set the supported Application Layer Protocols.
1963 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001964 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00001965 * \param protos Pointer to a NULL-terminated list of supported protocols,
1966 * in decreasing preference order. The pointer to the list is
1967 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00001968 * the lifetime of the table must be atleast as long as the
1969 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001970 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001972 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001973int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001974
1975/**
1976 * \brief Get the name of the negotiated Application Layer Protocol.
1977 * This function should be called after the handshake is
1978 * completed.
1979 *
1980 * \param ssl SSL context
1981 *
1982 * \return Protcol name, or NULL if no protocol was negotiated.
1983 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001984const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
1985#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001986
Paul Bakker5701cdc2012-09-27 21:49:42 +00001987/**
Paul Bakker490ecc82011-10-06 13:04:09 +00001988 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02001989 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001990 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02001991 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001992 * \note This ignores ciphersuites from higher versions.
1993 *
1994 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1995 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001996 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001997 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001998 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1999 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2000 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2001 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00002002 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002003void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002004
Paul Bakker1d29fb52012-09-28 13:28:45 +00002005/**
2006 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002007 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002008 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002009 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2010 * SSL_MIN_XXXXX_VERSION range is ignored.
2011 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002012 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002013 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002014 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2015 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2016 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002017 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2019 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2020 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2021 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002022 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002023void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002026/**
2027 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002028 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002029 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002031 * connection, that is a connection with max_version set to a
2032 * lower value than the value you're willing to use. Such
2033 * fallback connections are not recommended but are sometimes
2034 * necessary to interoperate with buggy (version-intolerant)
2035 * servers.
2036 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002037 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002038 * non-fallback connections! This would appear to work for a
2039 * while, then cause failures when the server is upgraded to
2040 * support a newer TLS version.
2041 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002042 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002043 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002044 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002045void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002046#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002047
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002049/**
2050 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002051 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002052 *
2053 * \note This should always be enabled, it is a security
2054 * improvement, and should not cause any interoperability
2055 * issue (used only if the peer supports it too).
2056 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002057 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002058 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002059 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002060void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002061#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002062
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002063#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002064/**
2065 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002067 *
2068 * \note This should always be enabled, it is a security fix to the
2069 * protocol, and should not cause any interoperability issue
2070 * (used only if the peer supports it too).
2071 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002072 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002073 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002074 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002075void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002076#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002077
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002078#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002079/**
2080 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002081 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002082 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002083 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002084 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002085 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00002086 * \note This function is deprecated and will likely be removed in
2087 * a future version of the library.
2088 * RC4 is disabled by default at compile time and needs to be
2089 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002090 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002091 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002092 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002093 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002094void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002095#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002096
Janos Follath088ce432017-04-10 12:42:31 +01002097#if defined(MBEDTLS_SSL_SRV_C)
2098/**
2099 * \brief Whether to send a list of acceptable CAs in
2100 * CertificateRequest messages.
2101 * (Default: do send)
2102 *
2103 * \param conf SSL configuration
2104 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
2105 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
2106 */
2107void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2108 char cert_req_ca_list );
2109#endif /* MBEDTLS_SSL_SRV_C */
2110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00002112/**
k-stachowiak79ad2862019-04-29 11:15:43 +02002113 * \brief Set the maximum fragment length to emit and/or negotiate.
k-stachowiak8aed8e12019-05-10 15:09:21 +02002114 * (Typical: #MBEDTLS_SSL_MAX_CONTENT_LEN, by default that is
2115 * set to `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002116 * (Server: set maximum fragment length to emit,
k-stachowiak79ad2862019-04-29 11:15:43 +02002117 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002118 * (Client: set maximum fragment length to emit *and*
2119 * negotiate with the server during handshake)
k-stachowiak79ad2862019-04-29 11:15:43 +02002120 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
2121 *
k-stachowiak2dd69e12019-04-30 12:32:11 +02002122 * \note With TLS, this currently only affects ApplicationData (sent
2123 * with \c mbedtls_ssl_read()), not handshake messages.
2124 * With DTLS, this affects both ApplicationData and handshake.
2125 *
k-stachowiak79ad2862019-04-29 11:15:43 +02002126 * \note On the client side, the maximum fragment length extension
2127 * *will not* be used, unless the maximum fragment length has
2128 * been set via this function to a value different than
2129 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
2130 *
2131 * \note This sets the maximum length for a record's payload,
2132 * excluding record overhead that will be added to it, see
2133 * \c mbedtls_ssl_get_record_expansion().
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002134 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002135 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002136 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002137 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2138 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002139 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002140 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002141 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002142int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002143#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002145#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002146/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01002147 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01002148 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002149 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002150 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002151 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2152 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002153 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002154void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002155#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002158/**
2159 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002160 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002161 *
2162 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2163 * Does not affect non-CBC ciphersuites in any version.
2164 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01002165 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002166 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2167 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002168 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002169void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002170#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002171
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002172#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002173/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002174 * \brief Enable / Disable session tickets (client only).
2175 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002176 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002177 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002178 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002179 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002180 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2181 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002182 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002183void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
2184#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002186#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002187/**
Paul Bakker09f097d2012-10-23 11:54:56 +00002188 * \brief Enable / Disable renegotiation support for connection when
2189 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002190 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00002191 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002192 * \warning It is recommended to always disable renegotation unless you
2193 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00002194 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002195 * renegotiation or a poor understanding of its properties.
2196 *
2197 * \note Server-side, enabling renegotiation also makes the server
2198 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00002199 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002200 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002201 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
2202 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00002203 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002204void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002206
2207/**
2208 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002209 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02002210 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002211 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002212 * be established even if the peer does not support
2213 * secure renegotiation, but does not allow renegotiation
2214 * to take place if not secure.
2215 * (Interoperable and secure option)
2216 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002217 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002218 * with non-upgraded peers. Allowing legacy renegotiation
2219 * makes the connection vulnerable to specific man in the
2220 * middle attacks. (See RFC 5746)
2221 * (Most interoperable and least secure option)
2222 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002223 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002224 * if peer does not support secure renegotiation. Results
2225 * in interoperability issues with non-upgraded peers
2226 * that do not support renegotiation altogether.
2227 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00002228 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002229 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00002230 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
2231 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00002233 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002234void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00002235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002236#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00002237/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002238 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002239 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002240 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002241 * When we request a renegotiation, the peer can comply or
2242 * ignore the request. This function allows us to decide
2243 * whether to enforce our renegotiation requests by closing
2244 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002245 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002246 * However, records could already be in transit from the peer
2247 * when the request is emitted. In order to increase
2248 * reliability, we can accept a number of records before the
2249 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002250 *
2251 * The optimal value is highly dependent on the specific usage
2252 * scenario.
2253 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002254 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002255 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002256 * out or receives Application Data, until:
2257 * - max_records records have beens seen, if it is >= 0, or
2258 * - the number of retransmits that would happen during an
2259 * actual handshake has been reached.
2260 * Please remember the request might be lost a few times
2261 * if you consider setting max_records to a really low value.
2262 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002263 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002264 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002265 * which always behave as if max_record was 0. The reason is,
2266 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002267 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002268 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002269 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002271 * enforce renegotiation, or a non-negative value to enforce
2272 * it but allow for a grace period of max_records records.
2273 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002274void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002275
2276/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002277 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00002278 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002279 *
2280 * Renegotiation is automatically triggered when a record
2281 * counter (outgoing or ingoing) crosses the defined
2282 * threshold. The default value is meant to prevent the
2283 * connection from being closed when the counter is about to
2284 * reached its maximal value (it is not allowed to wrap).
2285 *
2286 * Lower values can be used to enforce policies such as "keys
2287 * must be refreshed every N packets with cipher X".
2288 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00002289 * The renegotiation period can be disabled by setting
2290 * conf->disable_renegotiation to
2291 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
2292 *
2293 * \note When the configured transport is
2294 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
2295 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
2296 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00002297 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002298 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002299 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002300 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002301void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002302 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002303#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002304
Paul Bakker43ca69c2011-01-15 17:35:19 +00002305/**
2306 * \brief Return the number of data bytes available to read
2307 *
2308 * \param ssl SSL context
2309 *
2310 * \return how many bytes are available in the read buffer
2311 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002312size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002313
2314/**
2315 * \brief Return the result of the certificate verification
2316 *
Hanno Becker995878c2018-10-23 10:28:01 +01002317 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00002318 *
Hanno Becker995878c2018-10-23 10:28:01 +01002319 * \return \c 0 if the certificate verification was successful.
2320 * \return \c -1u if the result is not available. This may happen
2321 * e.g. if the handshake aborts early, or a verification
2322 * callback returned a fatal error.
2323 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
2324 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00002325 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002326uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002327
2328/**
2329 * \brief Return the name of the current ciphersuite
2330 *
2331 * \param ssl SSL context
2332 *
2333 * \return a string containing the ciphersuite name
2334 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002335const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002336
2337/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00002338 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
2339 *
2340 * \param ssl SSL context
2341 *
2342 * \return a string containing the SSL version
2343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002344const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002345
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002346/**
2347 * \brief Return the (maximum) number of bytes added by the record
2348 * layer: header + encryption/MAC overhead (inc. padding)
2349 *
2350 * \param ssl SSL context
2351 *
2352 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02002354 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002356int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002357
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002358#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2359/**
2360 * \brief Return the maximum fragment length (payload, in bytes).
2361 * This is the value negotiated with peer if any,
2362 * or the locally configured value.
2363 *
2364 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
2365 * called with a larger length value.
2366 * With TLS, \c mbedtls_ssl_write() will fragment the input if
2367 * necessary and return the number of bytes written; it is up
2368 * to the caller to call \c mbedtls_ssl_write() again in
2369 * order to send the remaining bytes if any.
2370 *
2371 * \param ssl SSL context
2372 *
2373 * \return Current maximum fragment length.
2374 */
2375size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
2376#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
2377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002378#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00002379/**
Paul Bakkerb0550d92012-10-30 07:51:03 +00002380 * \brief Return the peer certificate from the current connection
2381 *
2382 * Note: Can be NULL in case no certificate was sent during
2383 * the handshake. Different calls for the same connection can
2384 * return the same or different pointers for the same
2385 * certificate and even a different certificate altogether.
2386 * The peer cert CAN change in a single connection if
2387 * renegotiation is performed.
2388 *
2389 * \param ssl SSL context
2390 *
2391 * \return the current peer certificate
2392 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002393const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
2394#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00002395
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002396#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00002397/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002398 * \brief Save session in order to resume it later (client-side only)
2399 * Session data is copied to presented session structure.
2400 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002401 *
2402 * \param ssl SSL context
2403 * \param session session context
2404 *
2405 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002406 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002407 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor98848f02018-07-04 17:42:47 +03002408 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002409 *
Ron Eldora9779f12018-07-17 11:21:50 +03002410 * \note Only the server certificate is copied, and not the full chain,
2411 * so you should not attempt to validate the certificate again
2412 * by calling \c mbedtls_x509_crt_verify() on it.
2413 * Instead, you should use the results from the verification
2414 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
2415 * after loading the session again into a new SSL context
2416 * using \c mbedtls_ssl_set_session().
2417 *
2418 * \note Once the session object is not needed anymore, you should
2419 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002420 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002421 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002422 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002423int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
2424#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002425
2426/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002427 * \brief Perform the SSL handshake
2428 *
2429 * \param ssl SSL context
2430 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002431 * \return 0 if successful, or
2432 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
Simon Butcher1a57af12015-09-11 17:14:16 +01002433 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED (see below), or
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002434 * a specific SSL error code.
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002435 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002436 * \note If this function returns something other than 0 or
2437 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002438 * becomes unusable, and you should either free it or call
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002439 * \c mbedtls_ssl_session_reset() on it before re-using it for
2440 * a new connection; the current connection must be closed.
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002441 *
2442 * \note If DTLS is in use, then you may choose to handle
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002443 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002444 * purposes, as it is an expected return value rather than an
2445 * actual error, but you still need to reset/free the context.
Paul Bakker5121ce52009-01-03 21:22:43 +00002446 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002447int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002448
2449/**
Paul Bakker1961b702013-01-25 14:49:24 +01002450 * \brief Perform a single step of the SSL handshake
2451 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002452 * \note The state of the context (ssl->state) will be at
Aaron Jonesd96e5262016-06-17 14:40:41 +00002453 * the next state after execution of this function. Do not
2454 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01002455 *
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002456 * \note If this function returns something other than 0 or
2457 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2458 * becomes unusable, and you should either free it or call
2459 * \c mbedtls_ssl_session_reset() on it before re-using it for
2460 * a new connection; the current connection must be closed.
2461 *
Paul Bakker1961b702013-01-25 14:49:24 +01002462 * \param ssl SSL context
2463 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02002464 * \return 0 if successful, or
2465 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2466 * a specific SSL error code.
Paul Bakker1961b702013-01-25 14:49:24 +01002467 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002468int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002469
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002470#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01002471/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002472 * \brief Initiate an SSL renegotiation on the running connection.
2473 * Client: perform the renegotiation right now.
2474 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00002475 * during the next call to mbedtls_ssl_read() if honored by
2476 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00002477 *
2478 * \param ssl SSL context
2479 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002480 * \return 0 if successful, or any mbedtls_ssl_handshake() return
2481 * value.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002482 *
2483 * \note If this function returns something other than 0 or
2484 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2485 * becomes unusable, and you should either free it or call
2486 * \c mbedtls_ssl_session_reset() on it before re-using it for
2487 * a new connection; the current connection must be closed.
Paul Bakker48916f92012-09-16 19:57:18 +00002488 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002489int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
2490#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002491
2492/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002493 * \brief Read at most 'len' application data bytes
2494 *
2495 * \param ssl SSL context
2496 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02002497 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00002498 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02002499 * \return the number of bytes read, or
2500 * 0 for EOF, or
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002501 * MBEDTLS_ERR_SSL_WANT_READ or MBEDTLS_ERR_SSL_WANT_WRITE, or
2502 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT (see below), or
2503 * another negative error code.
2504 *
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002505 * \note If this function returns something other than a positive
2506 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE or
2507 * MBEDTLS_ERR_SSL_CLIENT_RECONNECT, then the ssl context
2508 * becomes unusable, and you should either free it or call
2509 * \c mbedtls_ssl_session_reset() on it before re-using it for
2510 * a new connection; the current connection must be closed.
2511 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002512 * \note When this function return MBEDTLS_ERR_SSL_CLIENT_RECONNECT
2513 * (which can only happen server-side), it means that a client
2514 * is initiating a new connection using the same source port.
2515 * You can either treat that as a connection close and wait
2516 * for the client to resend a ClientHello, or directly
2517 * continue with \c mbedtls_ssl_handshake() with the same
2518 * context (as it has beeen reset internally). Either way, you
2519 * should make sure this is seen by the application as a new
2520 * connection: application state, if any, should be reset, and
2521 * most importantly the identity of the client must be checked
2522 * again. WARNING: not validating the identity of the client
2523 * again, or not transmitting the new identity to the
2524 * application layer, would allow authentication bypass!
Paul Bakker5121ce52009-01-03 21:22:43 +00002525 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002526int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002527
2528/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002529 * \brief Try to write exactly 'len' application data bytes
2530 *
2531 * \warning This function will do partial writes in some cases. If the
2532 * return value is non-negative but less than length, the
2533 * function must be called again with updated arguments:
2534 * buf + ret, len - ret (if ret is the return value) until
2535 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00002536 *
2537 * \param ssl SSL context
2538 * \param buf buffer holding the data
2539 * \param len how many bytes must be written
2540 *
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002541 * \return the number of bytes actually written (may be less than len),
Jaakko Korhonenaca11a02017-02-07 14:44:40 +02002542 * or MBEDTLS_ERR_SSL_WANT_WRITE or MBEDTLS_ERR_SSL_WANT_READ,
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002543 * or another negative error code.
Paul Bakker5121ce52009-01-03 21:22:43 +00002544 *
Andres Amaya Garciadbd17b72017-07-11 16:15:54 +01002545 * \note If this function returns something other than 0, a positive
2546 * value or MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop
2547 * using the SSL context for reading or writing, and either
2548 * free it or call \c mbedtls_ssl_session_reset() on it before
2549 * re-using it for a new connection; the current connection
2550 * must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002551 *
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002552 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00002553 * it must be called later with the *same* arguments,
Andres Amaya Garciadbd17b72017-07-11 16:15:54 +01002554 * until it returns a value greater that or equal to 0. When
2555 * the function returns MBEDTLS_ERR_SSL_WANT_WRITE there may be
2556 * some partial data in the output buffer, however this is not
2557 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02002558 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00002559 * \note If the requested length is greater than the maximum
2560 * fragment length (either the built-in limit or the one set
2561 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002562 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002563 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02002564 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
2565 * active maximum fragment length.
Andres Amaya Garciadbd17b72017-07-11 16:15:54 +01002566 *
2567 * \note Attempting to write 0 bytes will result in an empty TLS
2568 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00002569 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002570int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002571
2572/**
Paul Bakker0a925182012-04-16 06:46:41 +00002573 * \brief Send an alert message
2574 *
2575 * \param ssl SSL context
2576 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002577 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00002578 * \param message The alert message (SSL_ALERT_MSG_*)
2579 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00002580 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002581 *
2582 * \note If this function returns something other than 0 or
2583 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2584 * becomes unusable, and you should either free it or call
2585 * \c mbedtls_ssl_session_reset() on it before re-using it for
2586 * a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00002587 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002588int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00002589 unsigned char level,
2590 unsigned char message );
2591/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002592 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00002593 *
2594 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01002595 *
2596 * \return 0 if successful, or a specific SSL error code.
2597 *
2598 * \note If this function returns something other than 0 or
2599 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, then the ssl context
2600 * becomes unusable, and you should either free it or call
2601 * \c mbedtls_ssl_session_reset() on it before re-using it for
2602 * a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00002603 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002604int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002605
2606/**
Paul Bakker48916f92012-09-16 19:57:18 +00002607 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00002608 *
2609 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002610 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002612
Paul Bakker48916f92012-09-16 19:57:18 +00002613/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002614 * \brief Initialize an SSL configuration context
2615 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002616 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002617 *
2618 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo8fd91562019-01-23 15:24:37 +01002619 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002620 *
2621 * \param conf SSL configuration context
2622 */
2623void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
2624
2625/**
2626 * \brief Load reasonnable default SSL configuration values.
2627 * (You need to call mbedtls_ssl_config_init() first.)
2628 *
2629 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002630 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
2631 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
2632 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02002633 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002634 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002635 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01002636 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002637 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002638 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002639 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02002640int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02002641 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002642
2643/**
2644 * \brief Free an SSL configuration context
2645 *
2646 * \param conf SSL configuration context
2647 */
2648void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
2649
2650/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002651 * \brief Initialize SSL session structure
2652 *
2653 * \param session SSL session
2654 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002655void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002656
2657/**
Paul Bakker0a597072012-09-25 21:55:46 +00002658 * \brief Free referenced items in an SSL session including the
2659 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00002660 *
Ron Eldora9779f12018-07-17 11:21:50 +03002661 * \note A session object can be freed even if the SSL context
2662 * that was used to retrieve the session is still in use.
2663 *
Paul Bakker48916f92012-09-16 19:57:18 +00002664 * \param session SSL session
2665 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002666void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00002667
Paul Bakker5121ce52009-01-03 21:22:43 +00002668#ifdef __cplusplus
2669}
2670#endif
2671
2672#endif /* ssl.h */