blob: 909258c5cef30e4717fac8468af5749747083d29 [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)
Hanno Beckere494e202018-03-08 13:26:12 +000052
53#if defined(MBEDTLS_DEPRECATED_WARNING)
54#warning "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and will be removed in the next major revision of the library"
55#endif
56
57#if defined(MBEDTLS_DEPRECATED_REMOVED)
58#error "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and cannot be used if MBEDTLS_DEPRECATED_REMOVED is set"
59#endif
60
Paul Bakker2770fbd2012-07-03 13:30:23 +000061#include "zlib.h"
62#endif
63
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#if defined(MBEDTLS_HAVE_TIME)
Ron Eldor6fd941f2017-05-14 16:17:33 +030065#include "platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020066#endif
67
Hanno Becker43633132018-10-22 15:31:03 +010068#if defined(MBEDTLS_USE_PSA_CRYPTO)
69#include "psa/crypto.h"
70#endif /* MBEDTLS_USE_PSA_CRYPTO */
71
Paul Bakker13e2dfe2009-07-28 07:18:38 +000072/*
73 * SSL Error codes
74 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
76#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
77#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
78#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
79#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
80#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
81#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
82#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
83#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
84#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
85#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
86#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
87#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
88#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
89#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
90#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
91#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
92#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
93#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
94#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
95#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
96#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
97#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
98#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
99#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
100#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
101#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
102#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
103#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200104#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
106#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
107#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
108#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
109#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
110#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
111#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
112#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
113#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
114#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
115#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
116#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
117#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
118#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
Hanno Becker8ec81022017-10-10 10:35:08 +0100119#define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< No data of requested type currently available on underlying transport. */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100120#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
121#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200122#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 +0100123#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100124#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
125#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */
Hanno Becker8ec81022017-10-10 10:35:08 +0100126#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580 /**< Internal-only message signaling that further message-processing should be done */
Gilles Peskineb44692f2018-04-24 12:18:19 +0200127#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100128#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Manuel Pégourié-Gonnard125af942018-09-11 11:08:12 +0200129#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000130
131/*
132 * Various constants
133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134#define MBEDTLS_SSL_MAJOR_VERSION_3 3
135#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
136#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
137#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
138#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200140#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
141#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100142
Simon Butcher9f812312015-09-28 19:22:33 +0100143#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Simon Butcher89f77622015-09-27 22:50:49 +0100144
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200145/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200146 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
148#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
149#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
150#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
151#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
152#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154#define MBEDTLS_SSL_IS_CLIENT 0
155#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
158#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
161#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200162
Hanno Becker019f4b52019-04-09 15:12:56 +0100163#define MBEDTLS_SSL_CID_DISABLED 0
164#define MBEDTLS_SSL_CID_ENABLED 1
165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166#define MBEDTLS_SSL_ETM_DISABLED 0
167#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#define MBEDTLS_SSL_COMPRESS_NULL 0
170#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172#define MBEDTLS_SSL_VERIFY_NONE 0
173#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
174#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200175#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
178#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
181#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
184#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
187#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
190#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
191#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
194#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
195#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
198#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200199
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100200#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
201#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203#define MBEDTLS_SSL_ARC4_ENABLED 0
204#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100205
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200206#define MBEDTLS_SSL_PRESET_DEFAULT 0
207#define MBEDTLS_SSL_PRESET_SUITEB 2
208
Janos Follath088ce432017-04-10 12:42:31 +0100209#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
210#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
211
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200212/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200213 * Default range for DTLS retransmission timer value, in milliseconds.
214 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
217#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200218
Paul Bakker088c5c52014-04-25 11:11:10 +0200219/**
220 * \name SECTION: Module settings
221 *
222 * The configuration options you can set for this module are in this section.
223 * Either change them in config.h or define them on the compiler command line.
224 * \{
225 */
226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
228#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200229#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200230
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200231/*
Angus Grattond8213d02016-05-25 20:56:48 +1000232 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200233 * determines the size of each of the two internal I/O buffers.
234 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200235 * Note: the RFC defines the default size of SSL / TLS messages. If you
236 * change the value here, other clients / servers may not be able to
237 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200238 * both sides of the connection and have it reduced at both sides, or
239 * if you're using the Max Fragment Length extension and you know all your
240 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
243#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200244#endif
245
Angus Grattond8213d02016-05-25 20:56:48 +1000246#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
247#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
248#endif
249
250#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
251#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
252#endif
253
Hanno Becker28007512018-08-28 09:46:44 +0100254/*
255 * Maximum number of heap-allocated bytes for the purpose of
256 * DTLS handshake message reassembly and future message buffering.
257 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100258#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100259#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100260#endif
261
Hanno Becker019f4b52019-04-09 15:12:56 +0100262/*
263 * Maximum length of CIDs for incoming and outgoing messages.
264 */
265#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
266#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
267#endif
268
269#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
270#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
271#endif
272
Hanno Beckerb1aa1b32019-05-08 17:37:58 +0100273#if !defined(MBEDTLS_SSL_CID_PADDING_GRANULARITY)
274#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16
275#endif
276
Paul Bakker088c5c52014-04-25 11:11:10 +0200277/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000278
279/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100280 * Length of the verify data for secure renegotiation
281 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200282#if defined(MBEDTLS_SSL_PROTO_SSL3)
283#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100284#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200285#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100286#endif
287
288/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200289 * Signaling ciphersuite values (SCSV)
290 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200291#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000292#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000293
Paul Bakker5121ce52009-01-03 21:22:43 +0000294/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000295 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200296 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200298#define MBEDTLS_SSL_HASH_NONE 0
299#define MBEDTLS_SSL_HASH_MD5 1
300#define MBEDTLS_SSL_HASH_SHA1 2
301#define MBEDTLS_SSL_HASH_SHA224 3
302#define MBEDTLS_SSL_HASH_SHA256 4
303#define MBEDTLS_SSL_HASH_SHA384 5
304#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306#define MBEDTLS_SSL_SIG_ANON 0
307#define MBEDTLS_SSL_SIG_RSA 1
308#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000309
310/*
Paul Bakker926af752012-11-23 13:38:07 +0100311 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200312 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100313 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200314#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
315#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100316
317/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000318 * Message, alert and handshake types
319 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200320#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
321#define MBEDTLS_SSL_MSG_ALERT 21
322#define MBEDTLS_SSL_MSG_HANDSHAKE 22
323#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Hanno Becker8b3eb5a2019-04-29 17:31:37 +0100324#define MBEDTLS_SSL_MSG_CID 25
Paul Bakker5121ce52009-01-03 21:22:43 +0000325
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200326#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
327#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
330#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
331#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
332#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
333#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
334#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
335#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
336#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
337#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
338#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
339#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
340#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
341#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
342#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
343#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
344#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
345#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
346#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
347#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
348#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
349#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
350#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
351#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
352#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
353#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
354#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
355#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
356#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
357#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
360#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
361#define MBEDTLS_SSL_HS_SERVER_HELLO 2
362#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
363#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
364#define MBEDTLS_SSL_HS_CERTIFICATE 11
365#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
366#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
367#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
368#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
369#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
370#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000371
372/*
373 * TLS extensions
374 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#define MBEDTLS_TLS_EXT_SERVERNAME 0
376#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000377
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200378#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200381
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
383#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000384
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200385#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200388
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
390#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200391
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200393
Hanno Becker0652bc52019-04-25 16:24:57 +0100394/* The value of the CID extension is still TBD as of
395 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-04. */
Hanno Becker064b7322019-05-03 12:42:13 +0100396#define MBEDTLS_TLS_EXT_CID 254 /* TBD */
Hanno Becker0652bc52019-04-25 16:24:57 +0100397
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200398#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
399
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200400#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000401
Paul Bakkereb2c6582012-09-27 19:15:01 +0000402/*
Paul Bakkered27a042013-04-18 22:46:23 +0200403 * Size defines
404 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200405#if !defined(MBEDTLS_PSK_MAX_LEN)
406#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200407#endif
408
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200409/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200410union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200411{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200413 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
414#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
416 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200417#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
419 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
420 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
421 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
422 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200423#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200424#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
425 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200426#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200427#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
428 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
429 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200430#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
432 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200433#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
435 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
436 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200437#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200438#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
439 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
440#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200441};
442
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200443#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200444
Paul Bakker407a0da2013-06-27 14:29:21 +0200445#ifdef __cplusplus
446extern "C" {
447#endif
448
Paul Bakkered27a042013-04-18 22:46:23 +0200449/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000450 * SSL state machine
451 */
452typedef enum
453{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454 MBEDTLS_SSL_HELLO_REQUEST,
455 MBEDTLS_SSL_CLIENT_HELLO,
456 MBEDTLS_SSL_SERVER_HELLO,
457 MBEDTLS_SSL_SERVER_CERTIFICATE,
458 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
459 MBEDTLS_SSL_CERTIFICATE_REQUEST,
460 MBEDTLS_SSL_SERVER_HELLO_DONE,
461 MBEDTLS_SSL_CLIENT_CERTIFICATE,
462 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
463 MBEDTLS_SSL_CERTIFICATE_VERIFY,
464 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
465 MBEDTLS_SSL_CLIENT_FINISHED,
466 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
467 MBEDTLS_SSL_SERVER_FINISHED,
468 MBEDTLS_SSL_FLUSH_BUFFERS,
469 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
470 MBEDTLS_SSL_HANDSHAKE_OVER,
471 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
472 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000473}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200474mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000475
Ron Eldor51d3ab52019-05-12 14:54:30 +0300476/*
477 * The tls_prf function types.
478 */
479typedef enum
480{
481 MBEDTLS_SSL_TLS_PRF_NONE,
482 MBEDTLS_SSL_TLS_PRF_SSL3,
483 MBEDTLS_SSL_TLS_PRF_TLS1,
484 MBEDTLS_SSL_TLS_PRF_SHA384,
485 MBEDTLS_SSL_TLS_PRF_SHA256
486}
487mbedtls_tls_prf_types;
Simon Butchere846b512016-03-01 17:31:49 +0000488/**
489 * \brief Callback type: send data on the network.
490 *
491 * \note That callback may be either blocking or non-blocking.
492 *
493 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000494 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000495 * \param len Length of the data to send
496 *
497 * \return The callback must return the number of bytes sent if any,
498 * or a non-zero error code.
499 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
500 * must be returned when the operation would block.
501 *
Simon Butcherd567a232016-03-09 20:19:21 +0000502 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000503 * It must always return the number of bytes actually sent.
504 */
505typedef int mbedtls_ssl_send_t( void *ctx,
506 const unsigned char *buf,
507 size_t len );
508
509/**
510 * \brief Callback type: receive data from the network.
511 *
512 * \note That callback may be either blocking or non-blocking.
513 *
514 * \param ctx Context for the receive callback (typically a file
515 * descriptor)
516 * \param buf Buffer to write the received data to
517 * \param len Length of the receive buffer
518 *
519 * \return The callback must return the number of bytes received,
520 * or a non-zero error code.
521 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
522 * must be returned when the operation would block.
523 *
Simon Butcherd567a232016-03-09 20:19:21 +0000524 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000525 * buffer. It must always return the number of bytes actually
526 * received and written to the buffer.
527 */
528typedef int mbedtls_ssl_recv_t( void *ctx,
529 unsigned char *buf,
530 size_t len );
531
532/**
533 * \brief Callback type: receive data from the network, with timeout
534 *
535 * \note That callback must block until data is received, or the
536 * timeout delay expires, or the operation is interrupted by a
537 * signal.
538 *
539 * \param ctx Context for the receive callback (typically a file descriptor)
540 * \param buf Buffer to write the received data to
541 * \param len Length of the receive buffer
542 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000543 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000544 *
545 * \return The callback must return the number of bytes received,
546 * or a non-zero error code:
547 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
548 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
549 *
Simon Butcherd567a232016-03-09 20:19:21 +0000550 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000551 * buffer. It must always return the number of bytes actually
552 * received and written to the buffer.
553 */
554typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
555 unsigned char *buf,
556 size_t len,
557 uint32_t timeout );
558/**
559 * \brief Callback type: set a pair of timers/delays to watch
560 *
561 * \param ctx Context pointer
562 * \param int_ms Intermediate delay in milliseconds
563 * \param fin_ms Final delay in milliseconds
564 * 0 cancels the current timer.
565 *
566 * \note This callback must at least store the necessary information
567 * for the associated \c mbedtls_ssl_get_timer_t callback to
568 * return correct information.
569 *
570 * \note If using a event-driven style of programming, an event must
571 * be generated when the final delay is passed. The event must
572 * cause a call to \c mbedtls_ssl_handshake() with the proper
573 * SSL context to be scheduled. Care must be taken to ensure
574 * that at most one such call happens at a time.
575 *
576 * \note Only one timer at a time must be running. Calling this
577 * function while a timer is running must cancel it. Cancelled
578 * timers must not generate any event.
579 */
580typedef void mbedtls_ssl_set_timer_t( void * ctx,
581 uint32_t int_ms,
582 uint32_t fin_ms );
583
584/**
585 * \brief Callback type: get status of timers/delays
586 *
587 * \param ctx Context pointer
588 *
589 * \return This callback must return:
590 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000591 * 0 if none of the delays have passed,
592 * 1 if only the intermediate delay has passed,
593 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000594 */
595typedef int mbedtls_ssl_get_timer_t( void * ctx );
596
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200597/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200598typedef struct mbedtls_ssl_session mbedtls_ssl_session;
599typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200600typedef struct mbedtls_ssl_config mbedtls_ssl_config;
601
602/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200603typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
604typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100605typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200606#if defined(MBEDTLS_X509_CRT_PARSE_C)
607typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200608#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200609#if defined(MBEDTLS_SSL_PROTO_DTLS)
610typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200611#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000612
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200613#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100614#if defined(MBEDTLS_X509_CRT_PARSE_C)
615/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200616 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100617 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200618 * This callback is called during an SSL handshake to start
619 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200620 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100621 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200622 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100623 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200624 * This function typically sends or enqueues a request, and
625 * does not wait for the operation to complete. This allows
626 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100627 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200628 * The parameters \p ssl and \p cert are guaranteed to remain
629 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200630 * function must save the contents of \p hash if the value
631 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200632 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100633 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200634 * This function may call mbedtls_ssl_set_async_operation_data()
635 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200636 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200637 *
Gilles Peskined3268832018-04-26 06:23:59 +0200638 * \note For RSA signatures, this function must produce output
639 * that is consistent with PKCS#1 v1.5 in the same way as
640 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
641 * apply the padding steps described in RFC 8017, section 9.2
642 * "EMSA-PKCS1-v1_5" as follows.
643 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
644 * encoding, treating \p hash as the DigestInfo to be
645 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
646 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200647 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200648 * encoding, treating \p hash as the hash to be encoded and
649 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
650 * from step 2, with `digestAlgorithm` obtained by calling
651 * mbedtls_oid_get_oid_by_md() on \p md_alg.
652 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200653 * \note For ECDSA signatures, the output format is the DER encoding
654 * `Ecdsa-Sig-Value` defined in
655 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
656 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200657 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200658 * modified other than via
659 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200660 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200661 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200662 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200663 * connection. However, if other callbacks are used, this
664 * property may not hold. For example, if an SNI callback
665 * is registered with mbedtls_ssl_conf_sni(), then
666 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200667 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100668 * \param hash Buffer containing the hash. This buffer is
669 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200670 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100671 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200672 * \return 0 if the operation was started successfully and the SSL
673 * stack should call the resume callback immediately.
674 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
675 * was started successfully and the SSL stack should return
676 * immediately without calling the resume callback yet.
677 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
678 * processor does not support this key. The SSL stack will
679 * use the private key object instead.
680 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200681 * propagated up the call chain. The callback should
682 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
683 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200684 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100685 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200686typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100687 mbedtls_x509_crt *cert,
688 mbedtls_md_type_t md_alg,
689 const unsigned char *hash,
690 size_t hash_len );
691
692/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200693 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100694 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200695 * This callback is called during an SSL handshake to start
696 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200697 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100698 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200699 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100700 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200701 * This function typically sends or enqueues a request, and
702 * does not wait for the operation to complete. This allows
703 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100704 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200705 * The parameters \p ssl and \p cert are guaranteed to remain
706 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200707 * function must save the contents of \p input if the value
708 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200709 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100710 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200711 * This function may call mbedtls_ssl_set_async_operation_data()
712 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200713 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200714 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200715 * \warning RSA decryption as used in TLS is subject to a potential
716 * timing side channel attack first discovered by Bleichenbacher
717 * in 1998. This attack can be remotely exploitable
718 * in practice. To avoid this attack, you must ensure that
719 * if the callback performs an RSA decryption, the time it
720 * takes to execute and return the result does not depend
721 * on whether the RSA decryption succeeded or reported
722 * invalid padding.
723 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200724 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200725 * modified other than via
726 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200727 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200728 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200729 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200730 * connection. However, if other callbacks are used, this
731 * property may not hold. For example, if an SNI callback
732 * is registered with mbedtls_ssl_conf_sni(), then
733 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100734 * \param input Buffer containing the input ciphertext. This buffer
735 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200736 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100737 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200738 * \return 0 if the operation was started successfully and the SSL
739 * stack should call the resume callback immediately.
740 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
741 * was started successfully and the SSL stack should return
742 * immediately without calling the resume callback yet.
743 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
744 * processor does not support this key. The SSL stack will
745 * use the private key object instead.
746 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200747 * propagated up the call chain. The callback should
748 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
749 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200750 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100751 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200752typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100753 mbedtls_x509_crt *cert,
754 const unsigned char *input,
755 size_t input_len );
756#endif /* MBEDTLS_X509_CRT_PARSE_C */
757
758/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200759 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100760 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200761 * This callback is called during an SSL handshake to resume
762 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200763 * ::mbedtls_ssl_async_sign_t or
764 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200765 *
766 * This function typically checks the status of a pending
767 * request or causes the request queue to make progress, and
768 * does not wait for the operation to complete. This allows
769 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100770 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200771 * This function may call mbedtls_ssl_get_async_operation_data()
772 * to retrieve an operation context set by the start callback.
773 * It may call mbedtls_ssl_set_async_operation_data() to modify
774 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200775 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200776 * Note that when this function returns a status other than
777 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
778 * resources associated with the operation.
779 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200780 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200781 * modified other than via
782 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200783 * \param output Buffer containing the output (signature or decrypted
784 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200785 * \param output_len On success, number of bytes written to \p output.
786 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100787 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200788 * \return 0 if output of the operation is available in the
789 * \p output buffer.
790 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
791 * is still in progress. Subsequent requests for progress
792 * on the SSL connection will call the resume callback
793 * again.
794 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200795 * The SSL handshake is aborted. The callback should
796 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
797 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200798 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100799 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200800typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100801 unsigned char *output,
802 size_t *output_len,
803 size_t output_size );
804
805/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200806 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100807 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200808 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200809 * while an asynchronous operation is in progress. Note that
810 * this callback is not called if the
811 * ::mbedtls_ssl_async_resume_t callback has run and has
812 * returned a value other than
813 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
814 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100815 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200816 * This function may call mbedtls_ssl_get_async_operation_data()
817 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200818 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200819 * \param ssl The SSL connection instance. It should not be
820 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100821 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200822typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200823#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000824
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000825#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) && \
826 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000827#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
828#if defined(MBEDTLS_SHA256_C)
829#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
830#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
831#elif defined(MBEDTLS_SHA512_C)
832#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
833#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
834#elif defined(MBEDTLS_SHA1_C)
835#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
836#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
837#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000838/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000839#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
840#endif
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000841#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED &&
842 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000843
Paul Bakker5121ce52009-01-03 21:22:43 +0000844/*
Paul Bakker0a597072012-09-25 21:55:46 +0000845 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000846 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200847struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000848{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100850 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200851#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000852 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000853 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200854 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000855 unsigned char id[32]; /*!< session identifier */
856 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200857
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200858#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000859#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000860 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000861#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000862 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
863 * changes during renegotiation, mitigating the triple handshake attack. */
864 unsigned char *peer_cert_digest;
865 size_t peer_cert_digest_len;
866 mbedtls_md_type_t peer_cert_digest_type;
Hanno Beckerabe6f662019-02-07 13:29:55 +0000867#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200869 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200870
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200871#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200872 unsigned char *ticket; /*!< RFC 5077 session ticket */
873 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200874 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200875#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200876
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200877#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200878 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200879#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200880
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200881#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200882 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100884
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200885#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100886 int encrypt_then_mac; /*!< flag for EtM activation */
887#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000888};
889
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200890/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200891 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200892 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200893struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200894{
895 /* Group items by size (largest first) to minimize padding overhead */
896
897 /*
898 * Pointers
899 */
900
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100901 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200902
903 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200904 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200905 void *p_dbg; /*!< context for the debug function */
906
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100907 /** Callback for getting (pseudo-)random numbers */
908 int (*f_rng)(void *, unsigned char *, size_t);
909 void *p_rng; /*!< context for the RNG function */
910
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200911 /** Callback to retrieve a session from the cache */
912 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200913 /** Callback to store a session into the cache */
914 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100915 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200916
917#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
918 /** Callback for setting cert according to SNI extension */
919 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
920 void *p_sni; /*!< context for SNI callback */
921#endif
922
923#if defined(MBEDTLS_X509_CRT_PARSE_C)
924 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200925 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200926 void *p_vrfy; /*!< context for X.509 verify calllback */
927#endif
928
929#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
930 /** Callback to retrieve PSK key from identity */
931 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
932 void *p_psk; /*!< context for PSK callback */
933#endif
934
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200935#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200936 /** Callback to create & write a cookie for ClientHello veirifcation */
937 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
938 const unsigned char *, size_t );
939 /** Callback to verify validity of a ClientHello cookie */
940 int (*f_cookie_check)( void *, const unsigned char *, size_t,
941 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100942 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200943#endif
944
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200945#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200946 /** Callback to create & write a session ticket */
947 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
948 unsigned char *, const unsigned char *, size_t *, uint32_t * );
949 /** Callback to parse a session ticket into a session structure */
950 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
951 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200952#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200953
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100954#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200955 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100956 int (*f_export_keys)( void *, const unsigned char *,
957 const unsigned char *, size_t, size_t, size_t );
Ron Eldorf5cc10d2019-05-07 18:33:40 +0300958 /** Callback to export key block, master secret,
959 * tls_prf and random bytes. Should replace f_export_keys */
960 int (*f_export_keys_ext)( void *, const unsigned char *,
961 const unsigned char *, size_t, size_t, size_t,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300962 unsigned char[32], unsigned char[32], mbedtls_tls_prf_types );
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100963 void *p_export_keys; /*!< context for key export callback */
964#endif
965
Hanno Beckerad4a1372019-05-03 13:06:44 +0100966#if defined(MBEDTLS_SSL_CID)
967 size_t cid_len; /*!< The length of CIDs for incoming DTLS records. */
968#endif /* MBEDTLS_SSL_CID */
969
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200970#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200971 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200972 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
973 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
974 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +0000975#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
976 mbedtls_x509_crt_ca_cb_t f_ca_cb;
977 void *p_ca_cb;
978#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200979#endif /* MBEDTLS_X509_CRT_PARSE_C */
980
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200981#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100982#if defined(MBEDTLS_X509_CRT_PARSE_C)
983 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
984 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
985#endif /* MBEDTLS_X509_CRT_PARSE_C */
986 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
987 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200988 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200989#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100990
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200991#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200992 const int *sig_hashes; /*!< allowed signature hashes */
993#endif
994
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200995#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100996 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200997#endif
998
999#if defined(MBEDTLS_DHM_C)
1000 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
1001 mbedtls_mpi dhm_G; /*!< generator for DHM */
1002#endif
1003
1004#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +01001005
1006#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05001007 psa_key_handle_t psk_opaque; /*!< PSA key slot holding opaque PSK.
1008 * This field should only be set via
1009 * mbedtls_ssl_conf_psk_opaque().
1010 * If either no PSK or a raw PSK have
1011 * been configured, this has value \c 0. */
Hanno Becker43633132018-10-22 15:31:03 +01001012#endif /* MBEDTLS_USE_PSA_CRYPTO */
1013
1014 unsigned char *psk; /*!< The raw pre-shared key. This field should
1015 * only be set via mbedtls_ssl_conf_psk().
1016 * If either no PSK or an opaque PSK
1017 * have been configured, this has value NULL. */
1018 size_t psk_len; /*!< The length of the raw pre-shared key.
1019 * This field should only be set via
1020 * mbedtls_ssl_conf_psk().
1021 * Its value is non-zero if and only if
1022 * \c psk is not \c NULL. */
1023
1024 unsigned char *psk_identity; /*!< The PSK identity for PSK negotiation.
1025 * This field should only be set via
1026 * mbedtls_ssl_conf_psk().
1027 * This is set if and only if either
1028 * \c psk or \c psk_opaque are set. */
1029 size_t psk_identity_len;/*!< The length of PSK identity.
1030 * This field should only be set via
1031 * mbedtls_ssl_conf_psk().
1032 * Its value is non-zero if and only if
1033 * \c psk is not \c NULL or \c psk_opaque
1034 * is not \c 0. */
1035#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001036
1037#if defined(MBEDTLS_SSL_ALPN)
1038 const char **alpn_list; /*!< ordered list of protocols */
1039#endif
1040
1041 /*
1042 * Numerical settings (int then char)
1043 */
1044
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001045 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
1046
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001047#if defined(MBEDTLS_SSL_PROTO_DTLS)
1048 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001049 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001050 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001051 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001052#endif
1053
1054#if defined(MBEDTLS_SSL_RENEGOTIATION)
1055 int renego_max_records; /*!< grace period for renegotiation */
1056 unsigned char renego_period[8]; /*!< value of the record counters
1057 that triggers renegotiation */
1058#endif
1059
1060#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1061 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1062#endif
1063
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001064#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1065 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1066#endif
1067
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001068 unsigned char max_major_ver; /*!< max. major version used */
1069 unsigned char max_minor_ver; /*!< max. minor version used */
1070 unsigned char min_major_ver; /*!< min. major version used */
1071 unsigned char min_minor_ver; /*!< min. minor version used */
1072
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001073 /*
1074 * Flags (bitfields)
1075 */
1076
1077 unsigned int endpoint : 1; /*!< 0: client, 1: server */
1078 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001079 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
1080 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1081 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001082#if defined(MBEDTLS_ARC4_C)
1083 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
1084#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001085#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1086 unsigned int mfl_code : 3; /*!< desired fragment length */
1087#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001088#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1089 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1090#endif
1091#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1092 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
1093#endif
1094#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1095 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
1096#endif
1097#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1098 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1099#endif
1100#if defined(MBEDTLS_SSL_RENEGOTIATION)
1101 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1102#endif
1103#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1104 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1105#endif
1106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1107 unsigned int session_tickets : 1; /*!< use session tickets? */
1108#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001109#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1110 unsigned int fallback : 1; /*!< is this a fallback? */
1111#endif
Janos Follath088ce432017-04-10 12:42:31 +01001112#if defined(MBEDTLS_SSL_SRV_C)
1113 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1114 Certificate Request messages? */
1115#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001116};
1117
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001118
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001119struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001120{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001121 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001122
Paul Bakker5121ce52009-01-03 21:22:43 +00001123 /*
1124 * Miscellaneous
1125 */
1126 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001128 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001129 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1130 number of retransmissions of request if
1131 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001132#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001133
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001134 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001135 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1136
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001137#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001138 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001139#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001140
Hanno Becker8927c832019-04-03 12:52:50 +01001141#if defined(MBEDTLS_X509_CRT_PARSE_C)
1142 /** Callback to customize X.509 certificate chain verification */
1143 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Janos Follath924270f2019-04-04 12:49:44 +01001144 void *p_vrfy; /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001145#endif
1146
Simon Butchere846b512016-03-01 17:31:49 +00001147 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1148 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1149 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1150 /*!< Callback for network receive with timeout */
1151
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001152 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001153
Paul Bakker5121ce52009-01-03 21:22:43 +00001154 /*
1155 * Session layer
1156 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001157 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1158 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1159 mbedtls_ssl_session *session; /*!< negotiated session data */
1160 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001161
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001162 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001163 the handshake process */
1164
1165 /*
1166 * Record layer transformations
1167 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001168 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1169 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1170 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1171 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001172
Paul Bakker5121ce52009-01-03 21:22:43 +00001173 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001174 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001175 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001176 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001177
1178 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1179 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001180
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001181 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001182 * Record layer (incoming data)
1183 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001184 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001185 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1186 TLS: maintained by us
1187 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001188 unsigned char *in_hdr; /*!< start of record header */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001189#if defined(MBEDTLS_SSL_CID)
1190 unsigned char *in_cid; /*!< The start of the CID;
1191 * (the end is marked by in_len). */
1192#endif /* MBEDTLS_SSL_CID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001193 unsigned char *in_len; /*!< two-bytes message length field */
1194 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001195 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001196 unsigned char *in_offt; /*!< read offset in application data */
1197
1198 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001199 size_t in_msglen; /*!< record header: message length */
1200 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001201#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001202 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001203 size_t next_record_offset; /*!< offset of the next record in datagram
1204 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001205#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001206#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001207 uint64_t in_window_top; /*!< last validated record seq_num */
1208 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001209#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001210
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001211 size_t in_hslen; /*!< current handshake message length,
1212 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001213 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001214
1215 int keep_current_message; /*!< drop or reuse current message
1216 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001217
Hanno Becker04da1892018-08-14 13:22:10 +01001218#if defined(MBEDTLS_SSL_PROTO_DTLS)
1219 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1220 * within a single datagram. */
1221#endif /* MBEDTLS_SSL_PROTO_DTLS */
1222
Paul Bakker5121ce52009-01-03 21:22:43 +00001223 /*
1224 * Record layer (outgoing data)
1225 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001226 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001227 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001228 unsigned char *out_hdr; /*!< start of record header */
Hanno Beckerf9c6a4b2019-05-03 14:34:53 +01001229#if defined(MBEDTLS_SSL_CID)
1230 unsigned char *out_cid; /*!< The start of the CID;
1231 * (the end is marked by in_len). */
1232#endif /* MBEDTLS_SSL_CID */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001233 unsigned char *out_len; /*!< two-bytes message length field */
1234 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001235 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001236
1237 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001238 size_t out_msglen; /*!< record header: message length */
1239 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +00001240
Hanno Becker19859472018-08-06 09:40:20 +01001241 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1242
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001243#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001244 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001245#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001246
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001247#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001248 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001249#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001250#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001251 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001252#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001253
Paul Bakker5121ce52009-01-03 21:22:43 +00001254 /*
1255 * PKI layer
1256 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001257 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001258
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001259 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001260 * User settings
1261 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001262#if defined(MBEDTLS_X509_CRT_PARSE_C)
1263 char *hostname; /*!< expected peer CN for verification
1264 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001265#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001266
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001267#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001268 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001269#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001270
Paul Bakker48916f92012-09-16 19:57:18 +00001271 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001272 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001273 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001274#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001275 unsigned char *cli_id; /*!< transport-level ID of the client */
1276 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001277#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001278
1279 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001280 * Secure renegotiation
1281 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001282 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001283 int secure_renegotiation; /*!< does peer support legacy or
1284 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001285#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001286 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001287 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1288 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001289#endif /* MBEDTLS_SSL_RENEGOTIATION */
Hanno Becker2f28c102019-04-25 15:46:59 +01001290
1291#if defined(MBEDTLS_SSL_CID)
1292 /* CID configuration to use in subsequent handshakes. */
1293
1294 /*! The next incoming CID, chosen by the user and applying to
1295 * all subsequent handshakes. This may be different from the
1296 * CID currently used in case the user has re-configured the CID
1297 * after an initial handshake. */
1298 unsigned char own_cid[ MBEDTLS_SSL_CID_IN_LEN_MAX ];
1299 uint8_t own_cid_len; /*!< The length of \c own_cid. */
1300 uint8_t negotiate_cid; /*!< This indicates whether the CID extension should
1301 * be negotiated in the next handshake or not.
1302 * Possible values are #MBEDTLS_SSL_CID_ENABLED
1303 * and #MBEDTLS_SSL_CID_DISABLED. */
1304#endif /* MBEDTLS_SSL_CID */
Paul Bakker5121ce52009-01-03 21:22:43 +00001305};
1306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001307#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001308
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001309#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
1310#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +01001311
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001312extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +00001313 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001314 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +00001315 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001316 size_t ivlen,
1317 const unsigned char *mac_enc, const unsigned char *mac_dec,
1318 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001319extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
1320extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
1321extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
1322extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
1323extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
1324#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001325
Paul Bakker5121ce52009-01-03 21:22:43 +00001326/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001327 * \brief Return the name of the ciphersuite associated with the
1328 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001329 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001330 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001331 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001332 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001333 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001334const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001335
1336/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001337 * \brief Return the ID of the ciphersuite associated with the
1338 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001339 *
1340 * \param ciphersuite_name SSL ciphersuite name
1341 *
1342 * \return the ID with the ciphersuite or 0 if not found
1343 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001344int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001345
1346/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001347 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001348 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001349 * mbedtls_ssl_free()
1350 *
1351 * \param ssl SSL context
1352 */
1353void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1354
1355/**
1356 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001357 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001358 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001359 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001360 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001361 * \warning The conf structure will be accessed during the session.
1362 * It must not be modified or freed as long as the session
1363 * is active.
1364 *
1365 * \warning This function must be called exactly once per context.
1366 * Calling mbedtls_ssl_setup again is not supported, even
1367 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001368 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001369 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001370 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001371 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001372 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001373 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001374 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001375int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001376 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001377
1378/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001379 * \brief Reset an already initialized SSL context for re-use
1380 * while retaining application-set variables, function
1381 * pointers and data.
1382 *
1383 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001384 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1386 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001387 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001388int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001389
1390/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001391 * \brief Set the current endpoint type
1392 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001393 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001395 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001396void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001397
1398/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001399 * \brief Set the transport type (TLS or DTLS).
1400 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001401 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001402 * \note For DTLS, you must either provide a recv callback that
1403 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001404 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1405 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001406 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001407 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001408 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001409 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1410 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001411 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001412void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001413
1414/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001415 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001416 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001417 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001418 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001419 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001420 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001421 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001422 * (default on server)
1423 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001424 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001426 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001427 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001428 * handshake is complete.
1429 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001430 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001431 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001432 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001433 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001434 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1435 * 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 +01001436 * the right time(s), which may not be obvious, while REQUIRED always perform
1437 * the verification as soon as possible. For example, REQUIRED was protecting
1438 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001439 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001440void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001441
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001442#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001443/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001444 * \brief Set the verification callback (Optional).
1445 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001446 * If set, the provided verify callback is called for each
1447 * certificate in the peer's CRT chain, including the trusted
1448 * root. For more information, please see the documentation of
1449 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001450 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001451 * \note For per context callbacks and contexts, please use
1452 * mbedtls_ssl_set_verify() instead.
1453 *
1454 * \param conf The SSL configuration to use.
1455 * \param f_vrfy The verification callback to use during CRT verification.
1456 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001457 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001458void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001459 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001460 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001461#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001462
1463/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001464 * \brief Set the random number generator callback
1465 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001466 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001467 * \param f_rng RNG function
1468 * \param p_rng RNG parameter
1469 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001470void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001471 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001472 void *p_rng );
1473
1474/**
1475 * \brief Set the debug callback
1476 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001477 * The callback has the following argument:
1478 * void * opaque context for the callback
1479 * int debug level
1480 * const char * file name
1481 * int line number
1482 * const char * message
1483 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001484 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001485 * \param f_dbg debug function
1486 * \param p_dbg debug parameter
1487 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001488void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001489 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001490 void *p_dbg );
1491
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001492/**
1493 * \brief Set the underlying BIO callbacks for write, read and
1494 * read-with-timeout.
1495 *
1496 * \param ssl SSL context
1497 * \param p_bio parameter (context) shared by BIO callbacks
1498 * \param f_send write callback
1499 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001500 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001501 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001502 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1503 * the other is used. If both are non-NULL, f_recv_timeout is
1504 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001505 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001506 * \note The two most common use cases are:
1507 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1508 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1509 *
1510 * \note For DTLS, you need to provide either a non-NULL
1511 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001512 *
1513 * \note See the documentations of \c mbedtls_ssl_sent_t,
1514 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001515 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001516 *
Andres AG3616f6f2016-09-14 14:32:09 +01001517 * \note On some platforms, net_sockets.c provides
1518 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1519 * \c mbedtls_net_recv_timeout() that are suitable to be used
1520 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001521 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001522void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001523 void *p_bio,
1524 mbedtls_ssl_send_t *f_send,
1525 mbedtls_ssl_recv_t *f_recv,
1526 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001527
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001528#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001529
1530#if defined(MBEDTLS_SSL_CID)
1531
1532
1533/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001534 * \brief Configure the use of the Connection ID (CID)
Hanno Beckerf1f9a822019-04-23 12:01:20 +01001535 * extension in the next handshake.
Hanno Becker019f4b52019-04-09 15:12:56 +01001536 *
1537 * Reference:
1538 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-04
1539 *
1540 * The DTLS CID extension allows to reliably associate
1541 * DTLS records to DTLS connections across changes in the
1542 * underlying transport (changed IP+Port metadata) by adding
1543 * explicit connection identifiers (CIDs) to the headers of
1544 * encrypted DTLS records. The desired CIDs are configured
1545 * by the application layer and are exchanged in new
1546 * `ClientHello` / `ServerHello` extensions during the
1547 * handshake, where each side indicates the CID it wants the
1548 * peer to use when writing encrypted messages. The CIDs are
1549 * put to use once records get encrypted: the stack discards
1550 * any incoming records that don't include the configured CID
1551 * in their header, and adds the peer's requested CID to the
1552 * headers of outgoing messages.
1553 *
1554 * This API allows to enable/disable the use of the CID
1555 * extension in the next handshake and to set the value of
1556 * the CID to be used for incoming messages.
1557 *
1558 * \param ssl The SSL context to configure. This must be initialized.
1559 * \param enable This value determines whether the CID extension should
1560 * be used or not. Possible values are:
1561 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001562 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1563 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001564 * \param own_cid The address of the readable buffer holding the CID we want
1565 * the peer to use when sending encrypted messages to us.
1566 * This may be \c NULL if \p own_cid_len is \c 0.
1567 * This parameter is unused if \p enabled is set to
1568 * MBEDTLS_SSL_CID_DISABLED.
1569 * \param own_cid_len The length of \p own_cid.
1570 * This parameter is unused if \p enabled is set to
1571 * MBEDTLS_SSL_CID_DISABLED.
1572 *
Hanno Beckerad4a1372019-05-03 13:06:44 +01001573 * \note The value of \p own_cid_len must match the value of the
1574 * \c len parameter passed to mbedtls_ssl_conf_cid_len()
1575 * when configuring the ::mbedtls_ssl_config that \p ssl
Hanno Beckerddf775a2019-05-13 15:26:11 +01001576 * is bound to.
Hanno Beckerad4a1372019-05-03 13:06:44 +01001577 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001578 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001579 * performed on the SSL context \p ssl, but does not trigger
1580 * one. You still have to call `mbedtls_ssl_handshake()`
1581 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1582 * (for a renegotiation handshake) explicitly after a
1583 * successful call to this function to run the handshake.
1584 *
1585 * \note This call cannot guarantee that the use of the CID
1586 * will be successfully negotiated in the next handshake,
1587 * because the peer might not support it. Specifically:
1588 * - On the Client, enabling the use of the CID through
1589 * this call implies that the `ClientHello` in the next
1590 * handshake will include the CID extension, thereby
1591 * offering the use of the CID to the server. Only if
1592 * the `ServerHello` contains the CID extension, too,
1593 * the CID extension will actually be put to use.
1594 * - On the Server, enabling the use of the CID through
1595 * this call implies that that the server will look for
1596 * the CID extension in a `ClientHello` from the client,
1597 * and, if present, reply with a CID extension in its
1598 * `ServerHello`.
1599 *
1600 * \note To check whether the use of the CID was negotiated
1601 * after the subsequent handshake has completed, please
1602 * use the API mbedtls_ssl_get_peer_cid().
1603 *
1604 * \warning If the use of the CID extension is enabled in this call
1605 * and the subsequent handshake negotiates its use, Mbed TLS
1606 * will silently drop every packet whose CID does not match
1607 * the CID configured in \p own_cid. It is the responsibility
1608 * of the user to adapt the underlying transport to take care
1609 * of CID-based demultiplexing before handing datagrams to
1610 * Mbed TLS.
1611 *
1612 * \return \c 0 on success. In this case, the CID configuration
1613 * applies to the next handshake.
1614 * \return A negative error code on failure.
1615 */
1616int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1617 int enable,
1618 unsigned char const *own_cid,
1619 size_t own_cid_len );
1620
1621/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01001622 * \brief Get information about the current use of the
Hanno Becker019f4b52019-04-09 15:12:56 +01001623 * CID extension.
1624 *
1625 * \param ssl The SSL context to query.
1626 * \param enabled The address at which to store whether the CID extension
1627 * is currently in use or not. If the CID is in use,
1628 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1629 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1630 * \param peer_cid The address of the buffer in which to store the CID
1631 * chosen by the peer (if the CID extension is used).
1632 * \param peer_cid_len The address at which to store the size of the CID
1633 * chosen by the peer (if the CID extension is used).
1634 * This is also the number of Bytes in \p peer_cid that
1635 * have been written.
1636 *
1637 * \note This applies to the state of the CID negotiated in
1638 * the last complete handshake. If a handshake is in
1639 * progress, this function will attempt to complete
1640 * the handshake first.
1641 *
Hanno Beckerc5f24222019-05-03 12:54:52 +01001642 * \note If CID extensions have been exchanged but both client
1643 * and server chose to use an empty CID, this function
1644 * sets `*enabled` to #MBEDTLS_SSL_CID_DISABLED
1645 * (the rationale for this is that the resulting
1646 * communication is the same as if the CID extensions
1647 * hadn't been used).
1648 *
Hanno Becker019f4b52019-04-09 15:12:56 +01001649 * \return \c 0 on success.
1650 * \return A negative error code on failure.
1651 */
1652int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1653 int *enabled,
1654 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1655 size_t *peer_cid_len );
1656
1657#endif /* MBEDTLS_SSL_CID */
1658
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001659/**
1660 * \brief Set the Maximum Tranport Unit (MTU).
1661 * Special value: 0 means unset (no limit).
1662 * This represents the maximum size of a datagram payload
1663 * handled by the transport layer (usually UDP) as determined
1664 * by the network link and stack. In practice, this controls
1665 * the maximum size datagram the DTLS layer will pass to the
1666 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1667 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001668 * \note The limit on datagram size is converted to a limit on
1669 * record payload by subtracting the current overhead of
1670 * encapsulation and encryption/authentication if any.
1671 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001672 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001673 * example when a Path Maximum Transfer Unit (PMTU)
1674 * estimate becomes available from other sources,
1675 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001676 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001677 * \note This setting only controls the size of the packets we send,
1678 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001679 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001680 * server to use smaller records with \c
1681 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001682 *
1683 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001684 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001685 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001686 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001687 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001688 * of datagrams (hence records, see first note) sent. It
1689 * cannot be used to increase the maximum size of records over
1690 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001691 *
1692 * \note Values lower than the current record layer expansion will
1693 * result in an error when trying to send data.
1694 *
1695 * \note Using record compression together with a non-zero MTU value
1696 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001697 *
1698 * \param ssl SSL context
1699 * \param mtu Value of the path MTU in bytes
1700 */
1701void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1702#endif /* MBEDTLS_SSL_PROTO_DTLS */
1703
Hanno Becker726c97a2019-04-03 12:52:35 +01001704#if defined(MBEDTLS_X509_CRT_PARSE_C)
1705/**
1706 * \brief Set a connection-specific verification callback (optional).
1707 *
1708 * If set, the provided verify callback is called for each
1709 * certificate in the peer's CRT chain, including the trusted
1710 * root. For more information, please see the documentation of
1711 * \c mbedtls_x509_crt_verify().
1712 *
1713 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1714 * binds the verification callback and context to an SSL context
1715 * as opposed to an SSL configuration.
1716 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1717 * are both used, mbedtls_ssl_set_verify() takes precedence.
1718 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001719 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001720 * \param f_vrfy The verification callback to use during CRT verification.
1721 * \param p_vrfy The opaque context to be passed to the callback.
1722 */
1723void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1724 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1725 void *p_vrfy );
1726#endif /* MBEDTLS_X509_CRT_PARSE_C */
1727
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001728/**
1729 * \brief Set the timeout period for mbedtls_ssl_read()
1730 * (Default: no timeout.)
1731 *
1732 * \param conf SSL configuration context
1733 * \param timeout Timeout value in milliseconds.
1734 * Use 0 for no timeout (default).
1735 *
1736 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001737 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001738 * With non-blocking I/O, this will only work if timer
1739 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1740 *
1741 * \note With non-blocking I/O, you may also skip this function
1742 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001743 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001744void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001745
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001746/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001747 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001748 *
1749 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001750 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001751 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001752 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001753 *
1754 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1755 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001756 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001757 *
1758 * \note On some platforms, timing.c provides
1759 * \c mbedtls_timing_set_delay() and
1760 * \c mbedtls_timing_get_delay() that are suitable for using
1761 * here, except if using an event-driven style.
1762 *
1763 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001764 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001765 */
1766void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1767 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001768 mbedtls_ssl_set_timer_t *f_set_timer,
1769 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001770
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001771/**
1772 * \brief Callback type: generate and write session ticket
1773 *
1774 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001775 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001776 * authenticated ticket for the session and write it to the
1777 * output buffer. Here, ticket means the opaque ticket part
1778 * of the NewSessionTicket structure of RFC 5077.
1779 *
1780 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001781 * \param session SSL session to be written in the ticket
1782 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001783 * \param end End of the output buffer
1784 * \param tlen On exit, holds the length written
1785 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1786 *
1787 * \return 0 if successful, or
1788 * a specific MBEDTLS_ERR_XXX code.
1789 */
1790typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1791 const mbedtls_ssl_session *session,
1792 unsigned char *start,
1793 const unsigned char *end,
1794 size_t *tlen,
1795 uint32_t *lifetime );
1796
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001797#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1798/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001799 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001800 *
1801 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001802 * (RFC 5216) and Thread. The key pointers are ephemeral and
1803 * therefore must not be stored. The master secret and keys
1804 * should not be used directly except as an input to a key
1805 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001806 *
1807 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001808 * \param ms Pointer to master secret (fixed length: 48 bytes)
1809 * \param kb Pointer to key block, see RFC 5246 section 6.3
1810 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001811 * \param maclen MAC length
1812 * \param keylen Key length
1813 * \param ivlen IV length
1814 *
1815 * \return 0 if successful, or
1816 * a specific MBEDTLS_ERR_XXX code.
1817 */
1818typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001819 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001820 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001821 size_t maclen,
1822 size_t keylen,
1823 size_t ivlen );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001824
1825/**
1826 * \brief Callback type: Export key block, master secret,
1827 * handshake randbytes and the tls_prf function
1828 * used to derive keys.
1829 *
1830 * \note This is required for certain uses of TLS, e.g. EAP-TLS
1831 * (RFC 5216) and Thread. The key pointers are ephemeral and
1832 * therefore must not be stored. The master secret and keys
1833 * should not be used directly except as an input to a key
1834 * derivation function.
1835 *
1836 * \param p_expkey Context for the callback.
1837 * \param ms Pointer to master secret (fixed length: 48 bytes).
1838 * \param kb Pointer to key block, see RFC 5246 section 6.3.
1839 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
1840 * \param maclen MAC length.
1841 * \param keylen Key length.
1842 * \param ivlen IV length.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001843 * \param client_random The client random bytes.
1844 * \param server_random The server random bytes.
Ron Eldor51d3ab52019-05-12 14:54:30 +03001845 * \param tls_prf_type The tls_prf enum type.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001846 *
1847 * \return 0 if successful, or
1848 * a specific MBEDTLS_ERR_XXX code.
1849 */
1850typedef int mbedtls_ssl_export_keys_ext_t( void *p_expkey,
1851 const unsigned char *ms,
1852 const unsigned char *kb,
1853 size_t maclen,
1854 size_t keylen,
1855 size_t ivlen,
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001856 unsigned char client_random[32],
Ron Eldor51d3ab52019-05-12 14:54:30 +03001857 unsigned char server_random[32],
1858 mbedtls_tls_prf_types tls_prf_type );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001859#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001860
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001861/**
1862 * \brief Callback type: parse and load session ticket
1863 *
1864 * \note This describes what a callback implementation should do.
1865 * This callback should parse a session ticket as generated
1866 * by the corresponding mbedtls_ssl_ticket_write_t function,
1867 * and, if the ticket is authentic and valid, load the
1868 * session.
1869 *
1870 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001871 * bytes of the input buffer, eg to use it as a temporary
1872 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001873 *
1874 * \param p_ticket Context for the callback
1875 * \param session SSL session to be loaded
1876 * \param buf Start of the buffer containing the ticket
1877 * \param len Length of the ticket.
1878 *
1879 * \return 0 if successful, or
1880 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1881 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1882 * any other non-zero code for other failures.
1883 */
1884typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1885 mbedtls_ssl_session *session,
1886 unsigned char *buf,
1887 size_t len );
1888
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001889#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001890/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001891 * \brief Configure SSL session ticket callbacks (server only).
1892 * (Default: none.)
1893 *
1894 * \note On server, session tickets are enabled by providing
1895 * non-NULL callbacks.
1896 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001897 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001898 *
1899 * \param conf SSL configuration context
1900 * \param f_ticket_write Callback for writing a ticket
1901 * \param f_ticket_parse Callback for parsing a ticket
1902 * \param p_ticket Context shared by the two callbacks
1903 */
1904void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1905 mbedtls_ssl_ticket_write_t *f_ticket_write,
1906 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1907 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001908#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001909
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001910#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1911/**
1912 * \brief Configure key export callback.
1913 * (Default: none.)
1914 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001915 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001916 *
1917 * \param conf SSL configuration context
1918 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001919 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001920 */
1921void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1922 mbedtls_ssl_export_keys_t *f_export_keys,
1923 void *p_export_keys );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001924
1925/**
1926 * \brief Configure extended key export callback.
1927 * (Default: none.)
1928 *
1929 * \note See \c mbedtls_ssl_export_keys_ext_t.
1930 *
1931 * \param conf SSL configuration context
1932 * \param f_export_keys_ext Callback for exporting keys
1933 * \param p_export_keys Context for the callback
1934 */
1935void mbedtls_ssl_conf_export_keys_ext_cb( mbedtls_ssl_config *conf,
1936 mbedtls_ssl_export_keys_ext_t *f_export_keys_ext,
1937 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001938#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1939
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001940#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001941/**
1942 * \brief Configure asynchronous private key operation callbacks.
1943 *
1944 * \param conf SSL configuration context
1945 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001946 * the description of ::mbedtls_ssl_async_sign_t
1947 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001948 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001949 * operation; in this case the private key object
1950 * associated with the certificate will be used.
1951 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001952 * the description of ::mbedtls_ssl_async_decrypt_t
1953 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001954 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001955 * operation; in this case the private key object
1956 * associated with the certificate will be used.
1957 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001958 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001959 * for more information. This may not be \c NULL unless
1960 * \p f_async_sign and \p f_async_decrypt are both
1961 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001962 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001963 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001964 * for more information. This may be \c NULL if
1965 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02001966 * \param config_data A pointer to configuration data which can be
1967 * retrieved with
1968 * mbedtls_ssl_conf_get_async_config_data(). The
1969 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001970 */
1971void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
1972 mbedtls_ssl_async_sign_t *f_async_sign,
1973 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
1974 mbedtls_ssl_async_resume_t *f_async_resume,
1975 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001976 void *config_data );
1977
1978/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02001979 * \brief Retrieve the configuration data set by
1980 * mbedtls_ssl_conf_async_private_cb().
1981 *
1982 * \param conf SSL configuration context
1983 * \return The configuration data set by
1984 * mbedtls_ssl_conf_async_private_cb().
1985 */
1986void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
1987
1988/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001989 * \brief Retrieve the asynchronous operation user context.
1990 *
1991 * \note This function may only be called while a handshake
1992 * is in progress.
1993 *
1994 * \param ssl The SSL context to access.
1995 *
1996 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02001997 * set during the current handshake. If
1998 * mbedtls_ssl_set_async_operation_data() has not yet been
1999 * called during the current handshake, this function returns
2000 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002001 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002002void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002003
2004/**
2005 * \brief Retrieve the asynchronous operation user context.
2006 *
2007 * \note This function may only be called while a handshake
2008 * is in progress.
2009 *
2010 * \param ssl The SSL context to access.
2011 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02002012 * Call mbedtls_ssl_get_async_operation_data() later during the
2013 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002014 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02002015void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02002016 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02002017#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01002018
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002019/**
2020 * \brief Callback type: generate a cookie
2021 *
2022 * \param ctx Context for the callback
2023 * \param p Buffer to write to,
2024 * must be updated to point right after the cookie
2025 * \param end Pointer to one past the end of the output buffer
2026 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002027 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002028 * \param ilen Length of info in bytes
2029 *
2030 * \return The callback must return 0 on success,
2031 * or a negative error code.
2032 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002034 unsigned char **p, unsigned char *end,
2035 const unsigned char *info, size_t ilen );
2036
2037/**
2038 * \brief Callback type: verify a cookie
2039 *
2040 * \param ctx Context for the callback
2041 * \param cookie Cookie to verify
2042 * \param clen Length of cookie
2043 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002044 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002045 * \param ilen Length of info in bytes
2046 *
2047 * \return The callback must return 0 if cookie is valid,
2048 * or a negative error code.
2049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002051 const unsigned char *cookie, size_t clen,
2052 const unsigned char *info, size_t ilen );
2053
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002054#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002055/**
2056 * \brief Register callbacks for DTLS cookies
2057 * (Server only. DTLS only.)
2058 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002059 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002060 * register working callbacks (and initialize their context).
2061 *
2062 * To disable HelloVerifyRequest, register NULL callbacks.
2063 *
2064 * \warning Disabling hello verification allows your server to be used
2065 * for amplification in DoS attacks against other hosts.
2066 * Only disable if you known this can't happen in your
2067 * particular environment.
2068 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002069 * \note See comments on \c mbedtls_ssl_handshake() about handling
2070 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2071 * on the first handshake attempt when this is enabled.
2072 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002073 * \note This is also necessary to handle client reconnection from
2074 * the same port as described in RFC 6347 section 4.2.8 (only
2075 * the variant with cookies is supported currently). See
2076 * comments on \c mbedtls_ssl_read() for details.
2077 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002078 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002079 * \param f_cookie_write Cookie write callback
2080 * \param f_cookie_check Cookie check callback
2081 * \param p_cookie Context for both callbacks
2082 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002083void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084 mbedtls_ssl_cookie_write_t *f_cookie_write,
2085 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002086 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002087
2088/**
2089 * \brief Set client's transport-level identification info.
2090 * (Server only. DTLS only.)
2091 *
2092 * This is usually the IP address (and port), but could be
2093 * anything identify the client depending on the underlying
2094 * network stack. Used for HelloVerifyRequest with DTLS.
2095 * This is *not* used to route the actual packets.
2096 *
2097 * \param ssl SSL context
2098 * \param info Transport-level info identifying the client (eg IP + port)
2099 * \param ilen Length of info in bytes
2100 *
2101 * \note An internal copy is made, so the info buffer can be reused.
2102 *
2103 * \return 0 on success,
2104 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002105 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002106 */
2107int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2108 const unsigned char *info,
2109 size_t ilen );
2110
2111#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002112
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002113#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002114/**
2115 * \brief Enable or disable anti-replay protection for DTLS.
2116 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002117 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002118 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002119 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002120 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002121 *
2122 * \warning Disabling this is a security risk unless the application
2123 * protocol handles duplicated packets in a safe way. You
2124 * should not disable this without careful consideration.
2125 * However, if your application already detects duplicated
2126 * packets and needs information about them to adjust its
2127 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002128 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002129void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002130#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002131
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002132#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002133/**
2134 * \brief Set a limit on the number of records with a bad MAC
2135 * before terminating the connection.
2136 * (DTLS only, no effect on TLS.)
2137 * Default: 0 (disabled).
2138 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002139 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002140 * \param limit Limit, or 0 to disable.
2141 *
2142 * \note If the limit is N, then the connection is terminated when
2143 * the Nth non-authentic record is seen.
2144 *
2145 * \note Records with an invalid header are not counted, only the
2146 * ones going through the authentication-decryption phase.
2147 *
2148 * \note This is a security trade-off related to the fact that it's
2149 * often relatively easy for an active attacker ot inject UDP
2150 * datagrams. On one hand, setting a low limit here makes it
2151 * easier for such an attacker to forcibly terminated a
2152 * connection. On the other hand, a high limit or no limit
2153 * might make us waste resources checking authentication on
2154 * many bogus packets.
2155 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002156void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002157#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002158
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002159#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002160
2161/**
2162 * \brief Allow or disallow packing of multiple handshake records
2163 * within a single datagram.
2164 *
2165 * \param ssl The SSL context to configure.
2166 * \param allow_packing This determines whether datagram packing may
2167 * be used or not. A value of \c 0 means that every
2168 * record will be sent in a separate datagram; a
2169 * value of \c 1 means that, if space permits,
2170 * multiple handshake messages (including CCS) belonging to
2171 * a single flight may be packed within a single datagram.
2172 *
2173 * \note This is enabled by default and should only be disabled
2174 * for test purposes, or if datagram packing causes
2175 * interoperability issues with peers that don't support it.
2176 *
2177 * \note Allowing datagram packing reduces the network load since
2178 * there's less overhead if multiple messages share the same
2179 * datagram. Also, it increases the handshake efficiency
2180 * since messages belonging to a single datagram will not
2181 * be reordered in transit, and so future message buffering
2182 * or flight retransmission (if no buffering is used) as
2183 * means to deal with reordering are needed less frequently.
2184 *
Hanno Beckereb570082018-08-24 11:28:35 +01002185 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002186 * are currently always sent in separate datagrams.
2187 *
2188 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002189void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2190 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002191
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002192/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002193 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002194 * (DTLS only, no effect on TLS.)
2195 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002196 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002197 * \param min Initial timeout value in milliseconds.
2198 * Default: 1000 (1 second).
2199 * \param max Maximum timeout value in milliseconds.
2200 * Default: 60000 (60 seconds).
2201 *
2202 * \note Default values are from RFC 6347 section 4.2.4.1.
2203 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002204 * \note The 'min' value should typically be slightly above the
2205 * expected round-trip time to your peer, plus whatever time
2206 * it takes for the peer to process the message. For example,
2207 * if your RTT is about 600ms and you peer needs up to 1s to
2208 * do the cryptographic operations in the handshake, then you
2209 * should set 'min' slightly above 1600. Lower values of 'min'
2210 * might cause spurious resends which waste network resources,
2211 * while larger value of 'min' will increase overall latency
2212 * on unreliable network links.
2213 *
2214 * \note The more unreliable your network connection is, the larger
2215 * your max / min ratio needs to be in order to achieve
2216 * reliable handshakes.
2217 *
2218 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2219 * For example, if min = 1s and max = 5s, the retransmit plan
2220 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2221 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002222 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002223void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002224#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002225
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002226#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002227/**
Paul Bakker0a597072012-09-25 21:55:46 +00002228 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002229 * If not set, no session resuming is done (except if session
2230 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002231 *
Paul Bakker0a597072012-09-25 21:55:46 +00002232 * The session cache has the responsibility to check for stale
2233 * entries based on timeout. See RFC 5246 for recommendations.
2234 *
2235 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2236 * connection shutdown, so do not cache the pointer! Either set
2237 * it to NULL or make a full copy of the certificate.
2238 *
2239 * The get callback is called once during the initial handshake
2240 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002241 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002242 * If a valid entry is found, it should fill the master of
2243 * the session object with the cached values and return 0,
2244 * return 1 otherwise. Optionally peer_cert can be set as well
2245 * if it is properly present in cache entry.
2246 *
2247 * The set callback is called once during the initial handshake
2248 * to enable session resuming after the entire handshake has
2249 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002251 * should create a cache entry for future retrieval based on
2252 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002253 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002254 * data) is cleared by the SSL/TLS layer when the connection is
2255 * terminated. It is recommended to add metadata to determine if
2256 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002257 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002258 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002259 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002260 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002261 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002262 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002263 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002264void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002265 void *p_cache,
2266 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2267 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002269
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002271/**
Paul Bakker0a597072012-09-25 21:55:46 +00002272 * \brief Request resumption of session (client-side only)
2273 * Session data is copied from presented session structure.
2274 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002275 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002276 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002277 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002278 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002279 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002280 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002281 * arguments are otherwise invalid
2282 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002283 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002284 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002285int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2286#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002287
2288/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002289 * \brief Set the list of allowed ciphersuites and the preference
2290 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002291 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002292 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002293 * The ciphersuites array is not copied, and must remain
2294 * valid for the lifetime of the ssl_config.
2295 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002296 * Note: The server uses its own preferences
2297 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002298 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002299 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002300 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002301 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002302 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002303void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002304 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002305
Hanno Beckerad4a1372019-05-03 13:06:44 +01002306#if defined(MBEDTLS_SSL_CID)
2307/**
Hanno Becker22a59fd2019-05-08 13:24:25 +01002308 * \brief Specify the length of CIDs for incoming encrypted
Hanno Beckerad4a1372019-05-03 13:06:44 +01002309 * DTLS records. (Default: \c 0)
2310 *
2311 * \param conf The SSL configuration to modify.
2312 * \param len The length in Bytes of the CID fields in encrypted
2313 * DTLS records using the CID mechanism. This must
2314 * not be larger than #MBEDTLS_SSL_CID_OUT_LEN_MAX.
2315 *
Hanno Beckerddf775a2019-05-13 15:26:11 +01002316 * \note The CID specification allows implementations to either
2317 * use a common length for all incoming connection IDs or
2318 * allow variable-length incoming IDs. Mbed TLS currently
2319 * requires a common length for all connections sharing the
2320 * same SSL configuration; this allows simpler parsing of
2321 * record headers.
Hanno Beckerad4a1372019-05-03 13:06:44 +01002322 *
2323 * \return \c 0 on success.
2324 * \return #MBEDTLS_ERR_SSL_BAD_INPUT_DATA if \p own_cid_len
2325 * is too large.
2326 */
2327int mbedtls_ssl_conf_cid_len( mbedtls_ssl_config *conf, size_t len );
2328#endif /* MBEDTLS_SSL_CID */
2329
Paul Bakker5121ce52009-01-03 21:22:43 +00002330/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002331 * \brief Set the list of allowed ciphersuites and the
2332 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002333 * (Only useful on the server side)
2334 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002335 * The ciphersuites array is not copied, and must remain
2336 * valid for the lifetime of the ssl_config.
2337 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002338 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002339 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002340 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002341 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002342 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2343 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2344 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002345 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002346 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2347 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002348 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002349void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002350 const int *ciphersuites,
2351 int major, int minor );
2352
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002353#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002354/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002355 * \brief Set the X.509 security profile used for verification
2356 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002357 * \note The restrictions are enforced for all certificates in the
2358 * chain. However, signatures in the handshake are not covered
2359 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2360 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002361 * \param conf SSL configuration
2362 * \param profile Profile to use
2363 */
2364void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002365 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002366
2367/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002368 * \brief Set the data required to verify peer certificate
2369 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002370 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002371 * parameters ca_chain (maps to trust_ca for that function)
2372 * and ca_crl.
2373 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002374 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002375 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002376 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002377 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002378void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002379 mbedtls_x509_crt *ca_chain,
2380 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002381
Hanno Becker8bf74f32019-03-27 11:01:30 +00002382#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2383/**
2384 * \brief Set the trusted certificate callback.
2385 *
2386 * This API allows to register the set of trusted certificates
2387 * through a callback, instead of a linked list as configured
2388 * by mbedtls_ssl_conf_ca_chain().
2389 *
2390 * This is useful for example in contexts where a large number
2391 * of CAs are used, and the inefficiency of maintaining them
2392 * in a linked list cannot be tolerated. It is also useful when
2393 * the set of trusted CAs needs to be modified frequently.
2394 *
2395 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2396 * more information.
2397 *
2398 * \param conf The SSL configuration to register the callback with.
2399 * \param f_ca_cb The trusted certificate callback to use when verifying
2400 * certificate chains.
2401 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2402 * a reference to a trusted CA database).
2403 *
2404 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2405 * Any call to this function overwrites the values set through
2406 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2407 * mbedtls_ssl_conf_ca_cb().
2408 *
2409 * \note This API is incompatible with CA indication in
2410 * CertificateRequest messages: A server-side SSL context which
2411 * is bound to an SSL configuration that uses a CA callback
2412 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2413 * client authentication, will send an empty CA list in the
2414 * corresponding CertificateRequest message.
2415 *
2416 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2417 * If an SSL context is bound to an SSL configuration which uses
2418 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2419 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2420 *
2421 * \note The use of this API disables the use of restartable ECC
2422 * during X.509 CRT signature verification (but doesn't affect
2423 * other uses).
2424 *
2425 * \warning This API is incompatible with the use of CRLs. Any call to
2426 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2427 * earlier calls to mbedtls_ssl_conf_ca_chain().
2428 *
2429 * \warning In multi-threaded environments, the callback \p f_ca_cb
2430 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002431 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002432 * contained in the callback context pointed to by \p p_ca_cb).
2433 */
2434void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2435 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2436 void *p_ca_cb );
2437#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2438
Paul Bakker5121ce52009-01-03 21:22:43 +00002439/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002440 * \brief Set own certificate chain and private key
2441 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002442 * \note own_cert should contain in order from the bottom up your
2443 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002444 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002445 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002446 * \note On server, this function can be called multiple times to
2447 * provision more than one cert/key pair (eg one ECDSA, one
2448 * RSA with SHA-256, one RSA with SHA-1). An adequate
2449 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002450 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002451 * adequate, preference is given to the one set by the first
2452 * call to this function, then second, etc.
2453 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002454 * \note On client, only the first call has any effect. That is,
2455 * only one client certificate can be provisioned. The
2456 * server's preferences in its CertficateRequest message will
2457 * be ignored and our only cert will be sent regardless of
2458 * whether it matches those preferences - the server can then
2459 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002460 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002461 * \note The provided \p pk_key needs to match the public key in the
2462 * first certificate in \p own_cert, or all handshakes using
2463 * that certificate will fail. It is your responsibility
2464 * to ensure that; this function will not perform any check.
2465 * You may use mbedtls_pk_check_pair() in order to perform
2466 * this check yourself, but be aware that this function can
2467 * be computationally expensive on some key types.
2468 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002469 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002470 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002471 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002472 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002473 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002474 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002475int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002476 mbedtls_x509_crt *own_cert,
2477 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002478#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002479
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002480#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002481/**
Hanno Becker02283042018-10-22 15:28:02 +01002482 * \brief Configure a pre-shared key (PSK) and identity
2483 * to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002484 *
2485 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002486 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002487 *
Hanno Becker02283042018-10-22 15:28:02 +01002488 * \warning Currently, clients can only register a single pre-shared key.
Hanno Beckerf9a32872018-11-15 13:18:25 +00002489 * Calling this function or mbedtls_ssl_conf_psk_opaque() more
Hanno Becker02283042018-10-22 15:28:02 +01002490 * than once will overwrite values configured in previous calls.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002491 * Support for setting multiple PSKs on clients and selecting
Hanno Becker02283042018-10-22 15:28:02 +01002492 * one based on the identity hint is not a planned feature,
2493 * but feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002494 *
Hanno Becker02283042018-10-22 15:28:02 +01002495 * \param conf The SSL configuration to register the PSK with.
2496 * \param psk The pointer to the pre-shared key to use.
2497 * \param psk_len The length of the pre-shared key in bytes.
2498 * \param psk_identity The pointer to the pre-shared key identity.
2499 * \param psk_identity_len The length of the pre-shared key identity
2500 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002501 *
Hanno Becker02283042018-10-22 15:28:02 +01002502 * \note The PSK and its identity are copied internally and
2503 * hence need not be preserved by the caller for the lifetime
2504 * of the SSL configuration.
2505 *
2506 * \return \c 0 if successful.
2507 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002508 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002509int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002510 const unsigned char *psk, size_t psk_len,
2511 const unsigned char *psk_identity, size_t psk_identity_len );
2512
Hanno Becker02283042018-10-22 15:28:02 +01002513#if defined(MBEDTLS_USE_PSA_CRYPTO)
2514/**
2515 * \brief Configure an opaque pre-shared key (PSK) and identity
2516 * to be used in PSK-based ciphersuites.
2517 *
2518 * \note This is mainly useful for clients. Servers will usually
2519 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2520 *
2521 * \warning Currently, clients can only register a single pre-shared key.
2522 * Calling this function or mbedtls_ssl_conf_psk() more than
2523 * once will overwrite values configured in previous calls.
2524 * Support for setting multiple PSKs on clients and selecting
2525 * one based on the identity hint is not a planned feature,
2526 * but feedback is welcomed.
2527 *
2528 * \param conf The SSL configuration to register the PSK with.
2529 * \param psk The identifier of the key slot holding the PSK.
2530 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002531 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002532 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002533 * allows its use for the key derivation algorithm applied
2534 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002535 * \param psk_identity The pointer to the pre-shared key identity.
2536 * \param psk_identity_len The length of the pre-shared key identity
2537 * in bytes.
2538 *
2539 * \note The PSK identity hint is copied internally and hence need
2540 * not be preserved by the caller for the lifetime of the
2541 * SSL configuration.
2542 *
2543 * \return \c 0 if successful.
2544 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2545 */
2546int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05002547 psa_key_handle_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002548 const unsigned char *psk_identity,
2549 size_t psk_identity_len );
2550#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002551
2552/**
Hanno Becker02283042018-10-22 15:28:02 +01002553 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002554 *
2555 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002556 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002557 *
Hanno Becker02283042018-10-22 15:28:02 +01002558 * \param ssl The SSL context to configure a PSK for.
2559 * \param psk The pointer to the pre-shared key.
2560 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002561 *
Hanno Becker02283042018-10-22 15:28:02 +01002562 * \return \c 0 if successful.
2563 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002564 */
2565int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2566 const unsigned char *psk, size_t psk_len );
2567
Hanno Becker02283042018-10-22 15:28:02 +01002568#if defined(MBEDTLS_USE_PSA_CRYPTO)
2569/**
2570 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2571 *
2572 * \note This should only be called inside the PSK callback,
2573 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2574 *
2575 * \param ssl The SSL context to configure a PSK for.
2576 * \param psk The identifier of the key slot holding the PSK.
2577 * For the duration of the current handshake, the key slot
2578 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002579 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002580 * use for the key derivation algorithm
2581 * applied in the handshake.
2582 *
2583 * \return \c 0 if successful.
2584 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2585 */
2586int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05002587 psa_key_handle_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002588#endif /* MBEDTLS_USE_PSA_CRYPTO */
2589
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002590/**
2591 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002592 *
2593 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002594 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002595 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002596 * receive the actual PSK data and length.
2597 *
Hanno Becker02283042018-10-22 15:28:02 +01002598 * The callback has the following parameters:
2599 * - \c void*: The opaque pointer \p p_psk.
2600 * - \c mbedtls_ssl_context*: The SSL context to which
2601 * the operation applies.
2602 * - \c const unsigned char*: The PSK identity
2603 * selected by the client.
2604 * - \c size_t: The length of the PSK identity
2605 * selected by the client.
2606 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002607 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002608 * \c mbedtls_ssl_set_hs_psk() or
2609 * \c mbedtls_ssl_set_hs_psk_opaque()
2610 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002611 * Any other return value will result in a denied PSK identity.
2612 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002613 * \note If you set a PSK callback using this function, then you
2614 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002615 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002616 *
Hanno Becker02283042018-10-22 15:28:02 +01002617 * \param conf The SSL configuration to register the callback with.
2618 * \param f_psk The callback for selecting and setting the PSK based
2619 * in the PSK identity chosen by the client.
2620 * \param p_psk A pointer to an opaque structure to be passed to
2621 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002622 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002623void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002624 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002625 size_t),
2626 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002627#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002628
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002629#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002630
2631#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2632
2633#if defined(MBEDTLS_DEPRECATED_WARNING)
2634#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2635#else
2636#define MBEDTLS_DEPRECATED
2637#endif
2638
Paul Bakker5121ce52009-01-03 21:22:43 +00002639/**
2640 * \brief Set the Diffie-Hellman public P and G values,
2641 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002642 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002643 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002644 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002645 * \param dhm_P Diffie-Hellman-Merkle modulus
2646 * \param dhm_G Diffie-Hellman-Merkle generator
2647 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002648 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2649 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002650 * \return 0 if successful
2651 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002652MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2653 const char *dhm_P,
2654 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00002655
Hanno Becker470a8c42017-10-04 15:28:46 +01002656#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01002657
2658/**
2659 * \brief Set the Diffie-Hellman public P and G values
2660 * from big-endian binary presentations.
2661 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2662 *
2663 * \param conf SSL configuration
2664 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2665 * \param P_len Length of DHM modulus
2666 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2667 * \param G_len Length of DHM generator
2668 *
2669 * \return 0 if successful
2670 */
2671int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2672 const unsigned char *dhm_P, size_t P_len,
2673 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002674
2675/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002676 * \brief Set the Diffie-Hellman public P and G values,
2677 * read from existing context (server-side only)
2678 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002679 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002680 * \param dhm_ctx Diffie-Hellman-Merkle context
2681 *
2682 * \return 0 if successful
2683 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002684int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002685#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002686
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002687#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2688/**
2689 * \brief Set the minimum length for Diffie-Hellman parameters.
2690 * (Client-side only.)
2691 * (Default: 1024 bits.)
2692 *
2693 * \param conf SSL configuration
2694 * \param bitlen Minimum bit length of the DHM prime
2695 */
2696void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2697 unsigned int bitlen );
2698#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2699
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002700#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002701/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002702 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002703 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002704 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002705 * On server: this only affects selection of the ECDHE curve;
2706 * the curves used for ECDH and ECDSA are determined by the
2707 * list of available certificates instead.
2708 *
2709 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002710 * use. The server can override our preference order.
2711 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002712 * Both sides: limits the set of curves accepted for use in
2713 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002714 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002715 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002716 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002717 * for that. For the end-entity certificate however, the key
2718 * will be accepted only if it is allowed both by this list
2719 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002720 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002721 * \note This list should be ordered by decreasing preference
2722 * (preferred curve first).
2723 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002724 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002725 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002727 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002728void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2729 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002730#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002731
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002732#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002733/**
2734 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002735 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002736 *
2737 * \note This only affects which hashes are offered and can be used
2738 * for signatures during the handshake. Hashes for message
2739 * authentication and the TLS PRF are controlled by the
2740 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2741 * used for certificate signature are controlled by the
2742 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2743 *
2744 * \note This list should be ordered by decreasing preference
2745 * (preferred hash first).
2746 *
2747 * \param conf SSL configuration
2748 * \param hashes Ordered list of allowed signature hashes,
2749 * terminated by \c MBEDTLS_MD_NONE.
2750 */
2751void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2752 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002753#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002754
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002755#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002756/**
Darryl Green11999bb2018-03-13 15:22:58 +00002757 * \brief Set or reset the hostname to check against the received
2758 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002759 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002760 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002761 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002762 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002763
Hanno Becker0446a392017-04-07 12:59:32 +01002764 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002765 *
Darryl Green11999bb2018-03-13 15:22:58 +00002766 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2767 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002768 * too long input hostname.
2769 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002770 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002771 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002772 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002773 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002775#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002776
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002777#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002778/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002779 * \brief Set own certificate and key for the current handshake
2780 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002781 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002782 * the SNI callback.
2783 *
2784 * \param ssl SSL context
2785 * \param own_cert own public certificate chain
2786 * \param pk_key own private key
2787 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002788 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002789 */
2790int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2791 mbedtls_x509_crt *own_cert,
2792 mbedtls_pk_context *pk_key );
2793
2794/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002795 * \brief Set the data required to verify peer certificate for the
2796 * current handshake
2797 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002798 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002799 * the SNI callback.
2800 *
2801 * \param ssl SSL context
2802 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
2803 * \param ca_crl trusted CA CRLs
2804 */
2805void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2806 mbedtls_x509_crt *ca_chain,
2807 mbedtls_x509_crl *ca_crl );
2808
2809/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002810 * \brief Set authmode for the current handshake.
2811 *
2812 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
2813 * the SNI callback.
2814 *
2815 * \param ssl SSL context
2816 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
2817 * MBEDTLS_SSL_VERIFY_REQUIRED
2818 */
2819void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2820 int authmode );
2821
2822/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00002823 * \brief Set server side ServerName TLS extension callback
2824 * (optional, server-side only).
2825 *
2826 * If set, the ServerName callback is called whenever the
2827 * server receives a ServerName TLS extension from the client
2828 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002829 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002830 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002831 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002832 * certificate(s) and key(s) to use with \c
2833 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002834 * and may optionally adjust the CA and associated CRL with \c
2835 * mbedtls_ssl_set_hs_ca_chain() as well as the client
2836 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
2837 * then must return 0. If no matching name is found, the
2838 * callback must either set a default cert, or
2839 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00002840 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002841 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00002842 * \param f_sni verification function
2843 * \param p_sni verification parameter
2844 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002845void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002846 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002847 size_t),
2848 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002849#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002850
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002851#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002852/**
2853 * \brief Set the EC J-PAKE password for current handshake.
2854 *
2855 * \note An internal copy is made, and destroyed as soon as the
2856 * handshake is completed, or when the SSL context is reset or
2857 * freed.
2858 *
2859 * \note The SSL context needs to be already set up. The right place
2860 * to call this function is between \c mbedtls_ssl_setup() or
2861 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
2862 *
2863 * \param ssl SSL context
2864 * \param pw EC J-PAKE password (pre-shared secret)
2865 * \param pw_len length of pw in bytes
2866 *
2867 * \return 0 on success, or a negative error code.
2868 */
2869int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2870 const unsigned char *pw,
2871 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002872#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002873
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002874#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002875/**
2876 * \brief Set the supported Application Layer Protocols.
2877 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002878 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00002879 * \param protos Pointer to a NULL-terminated list of supported protocols,
2880 * in decreasing preference order. The pointer to the list is
2881 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00002882 * the lifetime of the table must be atleast as long as the
2883 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002884 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002886 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002887int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002888
2889/**
2890 * \brief Get the name of the negotiated Application Layer Protocol.
2891 * This function should be called after the handshake is
2892 * completed.
2893 *
2894 * \param ssl SSL context
2895 *
2896 * \return Protcol name, or NULL if no protocol was negotiated.
2897 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002898const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
2899#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002900
Paul Bakker5701cdc2012-09-27 21:49:42 +00002901/**
Paul Bakker490ecc82011-10-06 13:04:09 +00002902 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02002903 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002904 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02002905 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002906 * \note This ignores ciphersuites from higher versions.
2907 *
2908 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2909 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002910 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002911 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002912 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2913 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2914 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2915 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00002916 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002917void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002918
Paul Bakker1d29fb52012-09-28 13:28:45 +00002919/**
2920 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002921 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002922 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002923 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2924 * SSL_MIN_XXXXX_VERSION range is ignored.
2925 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002926 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002927 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002928 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2929 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2930 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002931 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002932 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2933 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2934 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2935 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002936 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002937void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002938
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002939#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002940/**
2941 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002942 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002943 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002944 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002945 * connection, that is a connection with max_version set to a
2946 * lower value than the value you're willing to use. Such
2947 * fallback connections are not recommended but are sometimes
2948 * necessary to interoperate with buggy (version-intolerant)
2949 * servers.
2950 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002951 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002952 * non-fallback connections! This would appear to work for a
2953 * while, then cause failures when the server is upgraded to
2954 * support a newer TLS version.
2955 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002956 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002957 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002958 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002959void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002960#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002961
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002962#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002963/**
2964 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002965 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002966 *
2967 * \note This should always be enabled, it is a security
2968 * improvement, and should not cause any interoperability
2969 * issue (used only if the peer supports it too).
2970 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002971 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002972 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002973 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002974void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002975#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002976
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002977#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002978/**
2979 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002980 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002981 *
2982 * \note This should always be enabled, it is a security fix to the
2983 * protocol, and should not cause any interoperability issue
2984 * (used only if the peer supports it too).
2985 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002986 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002987 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002988 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002989void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002990#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002991
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002992#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002993/**
2994 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002995 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002996 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002997 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002998 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002999 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00003000 * \note This function is deprecated and will likely be removed in
3001 * a future version of the library.
3002 * RC4 is disabled by default at compile time and needs to be
3003 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003004 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003005 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003007 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003008void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02003009#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01003010
Janos Follath088ce432017-04-10 12:42:31 +01003011#if defined(MBEDTLS_SSL_SRV_C)
3012/**
3013 * \brief Whether to send a list of acceptable CAs in
3014 * CertificateRequest messages.
3015 * (Default: do send)
3016 *
3017 * \param conf SSL configuration
3018 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
3019 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
3020 */
3021void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
3022 char cert_req_ca_list );
3023#endif /* MBEDTLS_SSL_SRV_C */
3024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003025#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00003026/**
k-stachowiak6d722122019-02-08 17:03:33 +01003027 * \brief Set the maximum fragment length to emit and/or negotiate.
3028 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
3029 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003030 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01003031 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003032 * (Client: set maximum fragment length to emit *and*
3033 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02003034 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003035 *
k-stachowiak6d722122019-02-08 17:03:33 +01003036 * \note On the client side, the maximum fragment length extension
3037 * *will not* be used, unless the maximum fragment length has
3038 * been set via this function to a value different than
3039 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003040 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003041 * \note With TLS, this currently only affects ApplicationData (sent
3042 * with \c mbedtls_ssl_read()), not handshake messages.
3043 * With DTLS, this affects both ApplicationData and handshake.
3044 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02003045 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003046 * excluding record overhead that will be added to it, see
3047 * \c mbedtls_ssl_get_record_expansion().
3048 *
3049 * \note For DTLS, it is also possible to set a limit for the total
3050 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003051 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02003052 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01003053 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02003054 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
3056 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003057 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02003058 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003059 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003060int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003061#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003062
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02003064/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01003065 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01003066 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003067 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003068 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
3070 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003071 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003072void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003073#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003074
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003075#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003076/**
3077 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003079 *
3080 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
3081 * Does not affect non-CBC ciphersuites in any version.
3082 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01003083 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003084 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
3085 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003086 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003087void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003088#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003089
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003090#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003091/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003092 * \brief Enable / Disable session tickets (client only).
3093 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003094 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003095 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003096 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003097 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003098 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3099 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003100 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003101void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3102#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003103
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003104#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003105/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003106 * \brief Enable / Disable renegotiation support for connection when
3107 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003108 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003109 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003110 * \warning It is recommended to always disable renegotation unless you
3111 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003112 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003113 * renegotiation or a poor understanding of its properties.
3114 *
3115 * \note Server-side, enabling renegotiation also makes the server
3116 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003117 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003118 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003119 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3120 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003121 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003122void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003123#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003124
3125/**
3126 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003127 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003128 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003129 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003130 * be established even if the peer does not support
3131 * secure renegotiation, but does not allow renegotiation
3132 * to take place if not secure.
3133 * (Interoperable and secure option)
3134 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003135 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003136 * with non-upgraded peers. Allowing legacy renegotiation
3137 * makes the connection vulnerable to specific man in the
3138 * middle attacks. (See RFC 5746)
3139 * (Most interoperable and least secure option)
3140 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003141 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003142 * if peer does not support secure renegotiation. Results
3143 * in interoperability issues with non-upgraded peers
3144 * that do not support renegotiation altogether.
3145 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003146 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003147 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003148 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3149 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003150 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003151 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003152void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003154#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003155/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003156 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003157 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003158 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003159 * When we request a renegotiation, the peer can comply or
3160 * ignore the request. This function allows us to decide
3161 * whether to enforce our renegotiation requests by closing
3162 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003163 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003164 * However, records could already be in transit from the peer
3165 * when the request is emitted. In order to increase
3166 * reliability, we can accept a number of records before the
3167 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003168 *
3169 * The optimal value is highly dependent on the specific usage
3170 * scenario.
3171 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003172 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003173 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003174 * out or receives Application Data, until:
3175 * - max_records records have beens seen, if it is >= 0, or
3176 * - the number of retransmits that would happen during an
3177 * actual handshake has been reached.
3178 * Please remember the request might be lost a few times
3179 * if you consider setting max_records to a really low value.
3180 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003181 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003182 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003183 * which always behave as if max_record was 0. The reason is,
3184 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003185 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003186 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003187 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003188 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003189 * enforce renegotiation, or a non-negative value to enforce
3190 * it but allow for a grace period of max_records records.
3191 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003192void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003193
3194/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003195 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003196 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003197 *
3198 * Renegotiation is automatically triggered when a record
Hanno Becker1c1f0462019-05-03 12:55:51 +01003199 * counter (outgoing or incoming) crosses the defined
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003200 * threshold. The default value is meant to prevent the
3201 * connection from being closed when the counter is about to
3202 * reached its maximal value (it is not allowed to wrap).
3203 *
3204 * Lower values can be used to enforce policies such as "keys
3205 * must be refreshed every N packets with cipher X".
3206 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003207 * The renegotiation period can be disabled by setting
3208 * conf->disable_renegotiation to
3209 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3210 *
3211 * \note When the configured transport is
3212 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3213 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3214 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003215 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003216 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003217 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003218 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003219void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003220 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003221#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003222
Paul Bakker43ca69c2011-01-15 17:35:19 +00003223/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003224 * \brief Check if there is data already read from the
3225 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003226 *
3227 * \param ssl SSL context
3228 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003229 * \return 0 if nothing's pending, 1 otherwise.
3230 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003231 * \note This is different in purpose and behaviour from
3232 * \c mbedtls_ssl_get_bytes_avail in that it considers
3233 * any kind of unprocessed data, not only unread
3234 * application data. If \c mbedtls_ssl_get_bytes
3235 * returns a non-zero value, this function will
3236 * also signal pending data, but the converse does
3237 * not hold. For example, in DTLS there might be
3238 * further records waiting to be processed from
3239 * the current underlying transport's datagram.
3240 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003241 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003242 * does not imply that a subsequent call to
3243 * \c mbedtls_ssl_read will provide any data;
3244 * e.g., the unprocessed data might turn out
3245 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003246 *
3247 * \note This function is useful in the following situation:
3248 * If the SSL/TLS module successfully returns from an
3249 * operation - e.g. a handshake or an application record
3250 * read - and you're awaiting incoming data next, you
3251 * must not immediately idle on the underlying transport
3252 * to have data ready, but you need to check the value
3253 * of this function first. The reason is that the desired
3254 * data might already be read but not yet processed.
3255 * If, in contrast, a previous call to the SSL/TLS module
3256 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3257 * to call this function, as the latter error code entails
3258 * that all internal data has been processed.
3259 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003260 */
3261int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3262
3263/**
3264 * \brief Return the number of application data bytes
3265 * remaining to be read from the current record.
3266 *
3267 * \param ssl SSL context
3268 *
3269 * \return How many bytes are available in the application
3270 * data record read buffer.
3271 *
3272 * \note When working over a datagram transport, this is
3273 * useful to detect the current datagram's boundary
3274 * in case \c mbedtls_ssl_read has written the maximal
3275 * amount of data fitting into the input buffer.
3276 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003278size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003279
3280/**
3281 * \brief Return the result of the certificate verification
3282 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003283 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003284 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003285 * \return \c 0 if the certificate verification was successful.
3286 * \return \c -1u if the result is not available. This may happen
3287 * e.g. if the handshake aborts early, or a verification
3288 * callback returned a fatal error.
3289 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3290 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003291 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003292uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003293
3294/**
3295 * \brief Return the name of the current ciphersuite
3296 *
3297 * \param ssl SSL context
3298 *
3299 * \return a string containing the ciphersuite name
3300 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003301const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003302
3303/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00003304 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
3305 *
3306 * \param ssl SSL context
3307 *
3308 * \return a string containing the SSL version
3309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003310const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003311
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003312/**
3313 * \brief Return the (maximum) number of bytes added by the record
3314 * layer: header + encryption/MAC overhead (inc. padding)
3315 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003316 * \note This function is not available (always returns an error)
3317 * when record compression is enabled.
3318 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003319 * \param ssl SSL context
3320 *
3321 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003322 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02003323 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003324 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003325int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003326
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003327#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3328/**
3329 * \brief Return the maximum fragment length (payload, in bytes).
3330 * This is the value negotiated with peer if any,
3331 * or the locally configured value.
3332 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003333 * \sa mbedtls_ssl_conf_max_frag_len()
3334 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003335 *
3336 * \param ssl SSL context
3337 *
3338 * \return Current maximum fragment length.
3339 */
3340size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
3341#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3342
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003343/**
3344 * \brief Return the current maximum outgoing record payload in bytes.
3345 * This takes into account the config.h setting \c
3346 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3347 * max fragment length extension if used, and for DTLS the
3348 * path MTU as configured and current record expansion.
3349 *
3350 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3351 * called with a larger length value.
3352 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3353 * necessary and return the number of bytes written; it is up
3354 * to the caller to call \c mbedtls_ssl_write() again in
3355 * order to send the remaining bytes if any.
3356 *
3357 * \note This function is not available (always returns an error)
3358 * when record compression is enabled.
3359 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003360 * \sa mbedtls_ssl_set_mtu()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003361 * \sa mbedtls_ssl_get_max_frag_len()
3362 * \sa mbedtls_ssl_get_record_expansion()
3363 *
3364 * \param ssl SSL context
3365 *
3366 * \return Current maximum payload for an outgoing record,
3367 * or a negative error code.
3368 */
3369int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003371#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003372/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003373 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003374 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003375 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003376 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003377 * \return The current peer certificate, if available.
3378 * The returned certificate is owned by the SSL context and
3379 * is valid only until the next call to the SSL API.
3380 * \return \c NULL if no peer certificate is available. This might
3381 * be because the chosen ciphersuite doesn't use CRTs
3382 * (PSK-based ciphersuites, for example), or because
3383 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3384 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003385 *
3386 * \note For one-time inspection of the peer's certificate during
3387 * the handshake, consider registering an X.509 CRT verification
3388 * callback through mbedtls_ssl_conf_verify() instead of calling
3389 * this function. Using mbedtls_ssl_conf_verify() also comes at
3390 * the benefit of allowing you to influence the verification
3391 * process, for example by masking expected and tolerated
3392 * verification failures.
3393 *
3394 * \warning You must not use the pointer returned by this function
3395 * after any further call to the SSL API, including
3396 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3397 * because the pointer might change during renegotiation,
3398 * which happens transparently to the user.
3399 * If you want to use the certificate across API calls,
3400 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003401 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003402const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3403#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003404
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003405#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003406/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003407 * \brief Save session in order to resume it later (client-side only)
3408 * Session data is copied to presented session structure.
3409 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003410 *
3411 * \param ssl SSL context
3412 * \param session session context
3413 *
3414 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003415 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003417 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003418 *
Ron Eldor00115032018-07-17 11:21:50 +03003419 * \note Only the server certificate is copied, and not the full chain,
3420 * so you should not attempt to validate the certificate again
3421 * by calling \c mbedtls_x509_crt_verify() on it.
3422 * Instead, you should use the results from the verification
3423 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3424 * after loading the session again into a new SSL context
3425 * using \c mbedtls_ssl_set_session().
3426 *
3427 * \note Once the session object is not needed anymore, you should
3428 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003429 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003430 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003432int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3433#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003434
3435/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003436 * \brief Perform the SSL handshake
3437 *
3438 * \param ssl SSL context
3439 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003440 * \return \c 0 if successful.
3441 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003442 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003443 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003444 * transport - in this case you must call this function again
3445 * when the underlying transport is ready for the operation.
3446 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3447 * operation is in progress (see
3448 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3449 * must call this function again when the operation is ready.
3450 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3451 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3452 * in this case you must call this function again to complete
3453 * the handshake when you're done attending other tasks.
3454 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3455 * and the client did not demonstrate reachability yet - in
3456 * this case you must stop using the context (see below).
3457 * \return Another SSL error code - in this case you must stop using
3458 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003459 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003460 * \warning If this function returns something other than
3461 * \c 0,
3462 * #MBEDTLS_ERR_SSL_WANT_READ,
3463 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3464 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3465 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3466 * you must stop using the SSL context for reading or writing,
3467 * and either free it or call \c mbedtls_ssl_session_reset()
3468 * on it before re-using it for a new connection; the current
3469 * connection must be closed.
3470 *
3471 * \note If DTLS is in use, then you may choose to handle
3472 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3473 * purposes, as it is an expected return value rather than an
3474 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003475 *
3476 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003477 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003478 * from the underlying transport layer is currently being processed,
3479 * and it is safe to idle until the timer or the underlying transport
3480 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003481 * in which case the datagram of the underlying transport that is
3482 * currently being processed might or might not contain further
3483 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003484 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003485int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003486
3487/**
Paul Bakker1961b702013-01-25 14:49:24 +01003488 * \brief Perform a single step of the SSL handshake
3489 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003490 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003491 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003492 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003493 *
3494 * \param ssl SSL context
3495 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003496 * \return See mbedtls_ssl_handshake().
3497 *
3498 * \warning If this function returns something other than \c 0,
3499 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3500 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3501 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3502 * the SSL context for reading or writing, and either free it
3503 * or call \c mbedtls_ssl_session_reset() on it before
3504 * re-using it for a new connection; the current connection
3505 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003506 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003507int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003508
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003509#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003510/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003511 * \brief Initiate an SSL renegotiation on the running connection.
3512 * Client: perform the renegotiation right now.
3513 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003514 * during the next call to mbedtls_ssl_read() if honored by
3515 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003516 *
3517 * \param ssl SSL context
3518 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003519 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003520 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3521 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003522 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003523 * \warning If this function returns something other than \c 0,
3524 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3525 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3526 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3527 * the SSL context for reading or writing, and either free it
3528 * or call \c mbedtls_ssl_session_reset() on it before
3529 * re-using it for a new connection; the current connection
3530 * must be closed.
3531 *
Paul Bakker48916f92012-09-16 19:57:18 +00003532 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003533int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3534#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003535
3536/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003537 * \brief Read at most 'len' application data bytes
3538 *
3539 * \param ssl SSL context
3540 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003541 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003542 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003543 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003544 * \return \c 0 if the read end of the underlying transport was closed
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003545 * - in this case you must stop using the context (see below).
3546 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003547 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003548 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003549 * transport - in this case you must call this function again
3550 * when the underlying transport is ready for the operation.
3551 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3552 * operation is in progress (see
3553 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3554 * must call this function again when the operation is ready.
3555 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3556 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3557 * in this case you must call this function again to complete
3558 * the handshake when you're done attending other tasks.
3559 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3560 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003561 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003562 * \return Another SSL error code - in this case you must stop using
3563 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003564 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003565 * \warning If this function returns something other than
3566 * a positive value,
3567 * #MBEDTLS_ERR_SSL_WANT_READ,
3568 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3569 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3570 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3571 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3572 * you must stop using the SSL context for reading or writing,
3573 * and either free it or call \c mbedtls_ssl_session_reset()
3574 * on it before re-using it for a new connection; the current
3575 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003576 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003577 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003578 * (which can only happen server-side), it means that a client
3579 * is initiating a new connection using the same source port.
3580 * You can either treat that as a connection close and wait
3581 * for the client to resend a ClientHello, or directly
3582 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003583 * context (as it has been reset internally). Either way, you
3584 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003585 * connection: application state, if any, should be reset, and
3586 * most importantly the identity of the client must be checked
3587 * again. WARNING: not validating the identity of the client
3588 * again, or not transmitting the new identity to the
3589 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003590 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003591 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003592 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003593 * from the underlying transport layer is currently being processed,
3594 * and it is safe to idle until the timer or the underlying transport
3595 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003596 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3597 * initially available on the underlying transport, as this data may have
3598 * been only e.g. duplicated messages or a renegotiation request.
3599 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3600 * when reacting to an incoming-data event from the underlying transport.
3601 * - On success, the datagram of the underlying transport that is currently
3602 * being processed may contain further DTLS records. You should call
3603 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003604 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003605 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003606int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003607
3608/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003609 * \brief Try to write exactly 'len' application data bytes
3610 *
3611 * \warning This function will do partial writes in some cases. If the
3612 * return value is non-negative but less than length, the
3613 * function must be called again with updated arguments:
3614 * buf + ret, len - ret (if ret is the return value) until
3615 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003616 *
3617 * \param ssl SSL context
3618 * \param buf buffer holding the data
3619 * \param len how many bytes must be written
3620 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003621 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003622 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003623 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003624 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003625 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003626 * transport - in this case you must call this function again
3627 * when the underlying transport is ready for the operation.
3628 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3629 * operation is in progress (see
3630 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3631 * must call this function again when the operation is ready.
3632 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3633 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3634 * in this case you must call this function again to complete
3635 * the handshake when you're done attending other tasks.
3636 * \return Another SSL error code - in this case you must stop using
3637 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003638 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003639 * \warning If this function returns something other than
3640 * a non-negative value,
3641 * #MBEDTLS_ERR_SSL_WANT_READ,
3642 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3643 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3644 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3645 * you must stop using the SSL context for reading or writing,
3646 * and either free it or call \c mbedtls_ssl_session_reset()
3647 * on it before re-using it for a new connection; the current
3648 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003649 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003650 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003651 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003652 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003653 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003654 * some partial data in the output buffer, however this is not
3655 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003656 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003657 * \note If the requested length is greater than the maximum
3658 * fragment length (either the built-in limit or the one set
3659 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003660 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003661 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003662 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
3663 * active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003664 *
3665 * \note Attempting to write 0 bytes will result in an empty TLS
3666 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003667 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003668int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003669
3670/**
Paul Bakker0a925182012-04-16 06:46:41 +00003671 * \brief Send an alert message
3672 *
3673 * \param ssl SSL context
3674 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003675 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003676 * \param message The alert message (SSL_ALERT_MSG_*)
3677 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003678 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003679 *
3680 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003681 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3682 * the SSL context for reading or writing, and either free it or
3683 * call \c mbedtls_ssl_session_reset() on it before re-using it
3684 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003685 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003686int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003687 unsigned char level,
3688 unsigned char message );
3689/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003690 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003691 *
3692 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003693 *
3694 * \return 0 if successful, or a specific SSL error code.
3695 *
3696 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003697 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3698 * the SSL context for reading or writing, and either free it or
3699 * call \c mbedtls_ssl_session_reset() on it before re-using it
3700 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003702int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003703
3704/**
Paul Bakker48916f92012-09-16 19:57:18 +00003705 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003706 *
3707 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003708 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003709void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003710
Paul Bakker48916f92012-09-16 19:57:18 +00003711/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003712 * \brief Initialize an SSL configuration context
3713 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003714 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003715 *
3716 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01003717 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003718 *
3719 * \param conf SSL configuration context
3720 */
3721void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
3722
3723/**
3724 * \brief Load reasonnable default SSL configuration values.
3725 * (You need to call mbedtls_ssl_config_init() first.)
3726 *
3727 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003728 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
3729 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
3730 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003731 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003732 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003733 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01003734 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003735 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003736 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003737 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02003738int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003739 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003740
3741/**
3742 * \brief Free an SSL configuration context
3743 *
3744 * \param conf SSL configuration context
3745 */
3746void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
3747
3748/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003749 * \brief Initialize SSL session structure
3750 *
3751 * \param session SSL session
3752 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003753void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003754
3755/**
Paul Bakker0a597072012-09-25 21:55:46 +00003756 * \brief Free referenced items in an SSL session including the
3757 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00003758 *
Ron Eldor00115032018-07-17 11:21:50 +03003759 * \note A session object can be freed even if the SSL context
3760 * that was used to retrieve the session is still in use.
3761 *
Paul Bakker48916f92012-09-16 19:57:18 +00003762 * \param session SSL session
3763 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003764void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00003765
Ron Eldor51d3ab52019-05-12 14:54:30 +03003766/**
3767 * \brief TLS-PRF function for key derivation.
3768 *
3769 * \param prf The tls_prf type funtion type to be used.
3770 * \param secret Secret for the key derivation function.
3771 * \param slen Length of the secret.
3772 * \param label String label for the key derivation function,
3773 * terminated with null character.
3774 * \param random Random bytes.
3775 * \param rlen Length of the random bytes buffer.
3776 * \param dstbuf The buffer holding the derived key.
3777 * \param dlen Length of the output buffer.
3778 *
3779 * \return 0 on sucess. An SSL specific error on failure.
3780 */
3781int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
3782 const unsigned char *secret, size_t slen,
3783 const char *label,
3784 const unsigned char *random, size_t rlen,
3785 unsigned char *dstbuf, size_t dlen );
3786
Paul Bakker5121ce52009-01-03 21:22:43 +00003787#ifdef __cplusplus
3788}
3789#endif
3790
3791#endif /* ssl.h */