blob: 04f8c17a9df3a0928c85823ce7196fa79ad7fe6a [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
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200163#define MBEDTLS_SSL_ETM_DISABLED 0
164#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166#define MBEDTLS_SSL_COMPRESS_NULL 0
167#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#define MBEDTLS_SSL_VERIFY_NONE 0
170#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
171#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200172#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000173
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200174#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
175#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
178#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
181#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
184#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
187#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
188#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
191#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
192#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200193
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200194#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
195#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200196
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100197#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
198#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100199
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200200#define MBEDTLS_SSL_ARC4_ENABLED 0
201#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100202
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200203#define MBEDTLS_SSL_PRESET_DEFAULT 0
204#define MBEDTLS_SSL_PRESET_SUITEB 2
205
Janos Follath088ce432017-04-10 12:42:31 +0100206#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
207#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
208
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200209/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200210 * Default range for DTLS retransmission timer value, in milliseconds.
211 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
212 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200213#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
214#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200215
Paul Bakker088c5c52014-04-25 11:11:10 +0200216/**
217 * \name SECTION: Module settings
218 *
219 * The configuration options you can set for this module are in this section.
220 * Either change them in config.h or define them on the compiler command line.
221 * \{
222 */
223
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200224#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
225#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200226#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200227
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200228/*
Angus Grattond8213d02016-05-25 20:56:48 +1000229 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200230 * determines the size of each of the two internal I/O buffers.
231 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200232 * Note: the RFC defines the default size of SSL / TLS messages. If you
233 * change the value here, other clients / servers may not be able to
234 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200235 * both sides of the connection and have it reduced at both sides, or
236 * if you're using the Max Fragment Length extension and you know all your
237 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
240#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200241#endif
242
Angus Grattond8213d02016-05-25 20:56:48 +1000243#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
244#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
245#endif
246
247#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
248#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
249#endif
250
Hanno Becker28007512018-08-28 09:46:44 +0100251/*
252 * Maximum number of heap-allocated bytes for the purpose of
253 * DTLS handshake message reassembly and future message buffering.
254 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100255#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100256#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100257#endif
258
Paul Bakker088c5c52014-04-25 11:11:10 +0200259/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000260
261/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100262 * Length of the verify data for secure renegotiation
263 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200264#if defined(MBEDTLS_SSL_PROTO_SSL3)
265#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100266#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200267#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100268#endif
269
270/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200271 * Signaling ciphersuite values (SCSV)
272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000274#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000275
Paul Bakker5121ce52009-01-03 21:22:43 +0000276/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000277 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200278 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000279 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200280#define MBEDTLS_SSL_HASH_NONE 0
281#define MBEDTLS_SSL_HASH_MD5 1
282#define MBEDTLS_SSL_HASH_SHA1 2
283#define MBEDTLS_SSL_HASH_SHA224 3
284#define MBEDTLS_SSL_HASH_SHA256 4
285#define MBEDTLS_SSL_HASH_SHA384 5
286#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000287
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200288#define MBEDTLS_SSL_SIG_ANON 0
289#define MBEDTLS_SSL_SIG_RSA 1
290#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000291
292/*
Paul Bakker926af752012-11-23 13:38:07 +0100293 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200294 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100295 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200296#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
297#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100298
299/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000300 * Message, alert and handshake types
301 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
303#define MBEDTLS_SSL_MSG_ALERT 21
304#define MBEDTLS_SSL_MSG_HANDSHAKE 22
305#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Paul Bakker5121ce52009-01-03 21:22:43 +0000306
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200307#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
308#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000309
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
311#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
312#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
313#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
314#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
315#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
316#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
317#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
318#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
319#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
320#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
321#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
322#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
323#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
324#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
325#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
326#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
327#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
328#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
329#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
330#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
331#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
332#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
333#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
334#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
335#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
336#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
337#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
338#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000339
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200340#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
341#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
342#define MBEDTLS_SSL_HS_SERVER_HELLO 2
343#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
344#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
345#define MBEDTLS_SSL_HS_CERTIFICATE 11
346#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
347#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
348#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
349#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
350#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
351#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000352
353/*
354 * TLS extensions
355 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356#define MBEDTLS_TLS_EXT_SERVERNAME 0
357#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000358
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200360
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200361#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200362
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200363#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
364#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000365
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200366#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100367
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200369
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
371#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200374
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200375#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000378
Paul Bakkereb2c6582012-09-27 19:15:01 +0000379/*
Paul Bakkered27a042013-04-18 22:46:23 +0200380 * Size defines
381 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#if !defined(MBEDTLS_PSK_MAX_LEN)
383#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200384#endif
385
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200386/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200387union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200388{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200389#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200390 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
391#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
393 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200394#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200395#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
396 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
397 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
398 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
399 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200400#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200401#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
402 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200403#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200404#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
405 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
406 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200407#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200408#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
409 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200410#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200411#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
412 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
413 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200414#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200415#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
416 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
417#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200418};
419
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200420#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200421
Paul Bakker407a0da2013-06-27 14:29:21 +0200422#ifdef __cplusplus
423extern "C" {
424#endif
425
Paul Bakkered27a042013-04-18 22:46:23 +0200426/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000427 * SSL state machine
428 */
429typedef enum
430{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200431 MBEDTLS_SSL_HELLO_REQUEST,
432 MBEDTLS_SSL_CLIENT_HELLO,
433 MBEDTLS_SSL_SERVER_HELLO,
434 MBEDTLS_SSL_SERVER_CERTIFICATE,
435 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
436 MBEDTLS_SSL_CERTIFICATE_REQUEST,
437 MBEDTLS_SSL_SERVER_HELLO_DONE,
438 MBEDTLS_SSL_CLIENT_CERTIFICATE,
439 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
440 MBEDTLS_SSL_CERTIFICATE_VERIFY,
441 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
442 MBEDTLS_SSL_CLIENT_FINISHED,
443 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
444 MBEDTLS_SSL_SERVER_FINISHED,
445 MBEDTLS_SSL_FLUSH_BUFFERS,
446 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
447 MBEDTLS_SSL_HANDSHAKE_OVER,
448 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
449 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000450}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200451mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000452
Simon Butchere846b512016-03-01 17:31:49 +0000453/**
454 * \brief Callback type: send data on the network.
455 *
456 * \note That callback may be either blocking or non-blocking.
457 *
458 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000459 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000460 * \param len Length of the data to send
461 *
462 * \return The callback must return the number of bytes sent if any,
463 * or a non-zero error code.
464 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
465 * must be returned when the operation would block.
466 *
Simon Butcherd567a232016-03-09 20:19:21 +0000467 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000468 * It must always return the number of bytes actually sent.
469 */
470typedef int mbedtls_ssl_send_t( void *ctx,
471 const unsigned char *buf,
472 size_t len );
473
474/**
475 * \brief Callback type: receive data from the network.
476 *
477 * \note That callback may be either blocking or non-blocking.
478 *
479 * \param ctx Context for the receive callback (typically a file
480 * descriptor)
481 * \param buf Buffer to write the received data to
482 * \param len Length of the receive buffer
483 *
484 * \return The callback must return the number of bytes received,
485 * or a non-zero error code.
486 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
487 * must be returned when the operation would block.
488 *
Simon Butcherd567a232016-03-09 20:19:21 +0000489 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000490 * buffer. It must always return the number of bytes actually
491 * received and written to the buffer.
492 */
493typedef int mbedtls_ssl_recv_t( void *ctx,
494 unsigned char *buf,
495 size_t len );
496
497/**
498 * \brief Callback type: receive data from the network, with timeout
499 *
500 * \note That callback must block until data is received, or the
501 * timeout delay expires, or the operation is interrupted by a
502 * signal.
503 *
504 * \param ctx Context for the receive callback (typically a file descriptor)
505 * \param buf Buffer to write the received data to
506 * \param len Length of the receive buffer
507 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000508 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000509 *
510 * \return The callback must return the number of bytes received,
511 * or a non-zero error code:
512 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
513 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
514 *
Simon Butcherd567a232016-03-09 20:19:21 +0000515 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000516 * buffer. It must always return the number of bytes actually
517 * received and written to the buffer.
518 */
519typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
520 unsigned char *buf,
521 size_t len,
522 uint32_t timeout );
523/**
524 * \brief Callback type: set a pair of timers/delays to watch
525 *
526 * \param ctx Context pointer
527 * \param int_ms Intermediate delay in milliseconds
528 * \param fin_ms Final delay in milliseconds
529 * 0 cancels the current timer.
530 *
531 * \note This callback must at least store the necessary information
532 * for the associated \c mbedtls_ssl_get_timer_t callback to
533 * return correct information.
534 *
535 * \note If using a event-driven style of programming, an event must
536 * be generated when the final delay is passed. The event must
537 * cause a call to \c mbedtls_ssl_handshake() with the proper
538 * SSL context to be scheduled. Care must be taken to ensure
539 * that at most one such call happens at a time.
540 *
541 * \note Only one timer at a time must be running. Calling this
542 * function while a timer is running must cancel it. Cancelled
543 * timers must not generate any event.
544 */
545typedef void mbedtls_ssl_set_timer_t( void * ctx,
546 uint32_t int_ms,
547 uint32_t fin_ms );
548
549/**
550 * \brief Callback type: get status of timers/delays
551 *
552 * \param ctx Context pointer
553 *
554 * \return This callback must return:
555 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000556 * 0 if none of the delays have passed,
557 * 1 if only the intermediate delay has passed,
558 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000559 */
560typedef int mbedtls_ssl_get_timer_t( void * ctx );
561
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200562/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200563typedef struct mbedtls_ssl_session mbedtls_ssl_session;
564typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200565typedef struct mbedtls_ssl_config mbedtls_ssl_config;
566
567/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200568typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
569typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100570typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200571#if defined(MBEDTLS_X509_CRT_PARSE_C)
572typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200573#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200574#if defined(MBEDTLS_SSL_PROTO_DTLS)
575typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200576#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000577
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200578#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100579#if defined(MBEDTLS_X509_CRT_PARSE_C)
580/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200581 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100582 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200583 * This callback is called during an SSL handshake to start
584 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200585 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100586 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200587 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100588 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200589 * This function typically sends or enqueues a request, and
590 * does not wait for the operation to complete. This allows
591 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100592 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200593 * The parameters \p ssl and \p cert are guaranteed to remain
594 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200595 * function must save the contents of \p hash if the value
596 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200597 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100598 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200599 * This function may call mbedtls_ssl_set_async_operation_data()
600 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200601 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200602 *
Gilles Peskined3268832018-04-26 06:23:59 +0200603 * \note For RSA signatures, this function must produce output
604 * that is consistent with PKCS#1 v1.5 in the same way as
605 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
606 * apply the padding steps described in RFC 8017, section 9.2
607 * "EMSA-PKCS1-v1_5" as follows.
608 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
609 * encoding, treating \p hash as the DigestInfo to be
610 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
611 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200612 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200613 * encoding, treating \p hash as the hash to be encoded and
614 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
615 * from step 2, with `digestAlgorithm` obtained by calling
616 * mbedtls_oid_get_oid_by_md() on \p md_alg.
617 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200618 * \note For ECDSA signatures, the output format is the DER encoding
619 * `Ecdsa-Sig-Value` defined in
620 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
621 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200622 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200623 * modified other than via
624 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200625 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200626 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200627 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200628 * connection. However, if other callbacks are used, this
629 * property may not hold. For example, if an SNI callback
630 * is registered with mbedtls_ssl_conf_sni(), then
631 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200632 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100633 * \param hash Buffer containing the hash. This buffer is
634 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200635 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100636 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200637 * \return 0 if the operation was started successfully and the SSL
638 * stack should call the resume callback immediately.
639 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
640 * was started successfully and the SSL stack should return
641 * immediately without calling the resume callback yet.
642 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
643 * processor does not support this key. The SSL stack will
644 * use the private key object instead.
645 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200646 * propagated up the call chain. The callback should
647 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
648 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200649 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100650 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200651typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100652 mbedtls_x509_crt *cert,
653 mbedtls_md_type_t md_alg,
654 const unsigned char *hash,
655 size_t hash_len );
656
657/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200658 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100659 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200660 * This callback is called during an SSL handshake to start
661 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200662 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100663 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200664 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100665 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200666 * This function typically sends or enqueues a request, and
667 * does not wait for the operation to complete. This allows
668 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100669 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200670 * The parameters \p ssl and \p cert are guaranteed to remain
671 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200672 * function must save the contents of \p input if the value
673 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200674 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100675 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200676 * This function may call mbedtls_ssl_set_async_operation_data()
677 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200678 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200679 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200680 * \warning RSA decryption as used in TLS is subject to a potential
681 * timing side channel attack first discovered by Bleichenbacher
682 * in 1998. This attack can be remotely exploitable
683 * in practice. To avoid this attack, you must ensure that
684 * if the callback performs an RSA decryption, the time it
685 * takes to execute and return the result does not depend
686 * on whether the RSA decryption succeeded or reported
687 * invalid padding.
688 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200689 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200690 * modified other than via
691 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200692 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200693 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200694 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200695 * connection. However, if other callbacks are used, this
696 * property may not hold. For example, if an SNI callback
697 * is registered with mbedtls_ssl_conf_sni(), then
698 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100699 * \param input Buffer containing the input ciphertext. This buffer
700 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200701 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100702 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200703 * \return 0 if the operation was started successfully and the SSL
704 * stack should call the resume callback immediately.
705 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
706 * was started successfully and the SSL stack should return
707 * immediately without calling the resume callback yet.
708 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
709 * processor does not support this key. The SSL stack will
710 * use the private key object instead.
711 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200712 * propagated up the call chain. The callback should
713 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
714 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200715 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100716 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200717typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100718 mbedtls_x509_crt *cert,
719 const unsigned char *input,
720 size_t input_len );
721#endif /* MBEDTLS_X509_CRT_PARSE_C */
722
723/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200724 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100725 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200726 * This callback is called during an SSL handshake to resume
727 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200728 * ::mbedtls_ssl_async_sign_t or
729 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200730 *
731 * This function typically checks the status of a pending
732 * request or causes the request queue to make progress, and
733 * does not wait for the operation to complete. This allows
734 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100735 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200736 * This function may call mbedtls_ssl_get_async_operation_data()
737 * to retrieve an operation context set by the start callback.
738 * It may call mbedtls_ssl_set_async_operation_data() to modify
739 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200740 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200741 * Note that when this function returns a status other than
742 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
743 * resources associated with the operation.
744 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200745 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200746 * modified other than via
747 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200748 * \param output Buffer containing the output (signature or decrypted
749 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200750 * \param output_len On success, number of bytes written to \p output.
751 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100752 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200753 * \return 0 if output of the operation is available in the
754 * \p output buffer.
755 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
756 * is still in progress. Subsequent requests for progress
757 * on the SSL connection will call the resume callback
758 * again.
759 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200760 * The SSL handshake is aborted. The callback should
761 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
762 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200763 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100764 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200765typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100766 unsigned char *output,
767 size_t *output_len,
768 size_t output_size );
769
770/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200771 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100772 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200773 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200774 * while an asynchronous operation is in progress. Note that
775 * this callback is not called if the
776 * ::mbedtls_ssl_async_resume_t callback has run and has
777 * returned a value other than
778 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
779 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100780 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200781 * This function may call mbedtls_ssl_get_async_operation_data()
782 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200783 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200784 * \param ssl The SSL connection instance. It should not be
785 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100786 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200787typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200788#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000789
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000790#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) && \
791 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000792#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
793#if defined(MBEDTLS_SHA256_C)
794#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
795#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
796#elif defined(MBEDTLS_SHA512_C)
797#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
798#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
799#elif defined(MBEDTLS_SHA1_C)
800#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
801#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
802#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000803/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000804#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
805#endif
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000806#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED &&
807 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000808
Paul Bakker5121ce52009-01-03 21:22:43 +0000809/*
Paul Bakker0a597072012-09-25 21:55:46 +0000810 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000811 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200812struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000813{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200814#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100815 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200816#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000817 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000818 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200819 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000820 unsigned char id[32]; /*!< session identifier */
821 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200822
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000824#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000825 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000826#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000827 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
828 * changes during renegotiation, mitigating the triple handshake attack. */
829 unsigned char *peer_cert_digest;
830 size_t peer_cert_digest_len;
831 mbedtls_md_type_t peer_cert_digest_type;
Hanno Beckerabe6f662019-02-07 13:29:55 +0000832#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200833#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200834 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200835
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200836#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200837 unsigned char *ticket; /*!< RFC 5077 session ticket */
838 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200839 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200840#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200841
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200842#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200843 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200844#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200845
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200846#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200847 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200848#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100849
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200850#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100851 int encrypt_then_mac; /*!< flag for EtM activation */
852#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000853};
854
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200855/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200856 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200857 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200858struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200859{
860 /* Group items by size (largest first) to minimize padding overhead */
861
862 /*
863 * Pointers
864 */
865
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100866 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200867
868 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200869 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200870 void *p_dbg; /*!< context for the debug function */
871
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100872 /** Callback for getting (pseudo-)random numbers */
873 int (*f_rng)(void *, unsigned char *, size_t);
874 void *p_rng; /*!< context for the RNG function */
875
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200876 /** Callback to retrieve a session from the cache */
877 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200878 /** Callback to store a session into the cache */
879 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100880 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200881
882#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
883 /** Callback for setting cert according to SNI extension */
884 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
885 void *p_sni; /*!< context for SNI callback */
886#endif
887
888#if defined(MBEDTLS_X509_CRT_PARSE_C)
889 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200890 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200891 void *p_vrfy; /*!< context for X.509 verify calllback */
892#endif
893
894#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
895 /** Callback to retrieve PSK key from identity */
896 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
897 void *p_psk; /*!< context for PSK callback */
898#endif
899
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200900#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200901 /** Callback to create & write a cookie for ClientHello veirifcation */
902 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
903 const unsigned char *, size_t );
904 /** Callback to verify validity of a ClientHello cookie */
905 int (*f_cookie_check)( void *, const unsigned char *, size_t,
906 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100907 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200908#endif
909
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200910#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200911 /** Callback to create & write a session ticket */
912 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
913 unsigned char *, const unsigned char *, size_t *, uint32_t * );
914 /** Callback to parse a session ticket into a session structure */
915 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
916 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200917#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200918
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100919#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200920 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100921 int (*f_export_keys)( void *, const unsigned char *,
922 const unsigned char *, size_t, size_t, size_t );
923 void *p_export_keys; /*!< context for key export callback */
924#endif
925
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200926#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200927 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200928 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
929 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
930 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
931#endif /* MBEDTLS_X509_CRT_PARSE_C */
932
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200933#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100934#if defined(MBEDTLS_X509_CRT_PARSE_C)
935 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
936 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
937#endif /* MBEDTLS_X509_CRT_PARSE_C */
938 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
939 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200940 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200941#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100942
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200943#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200944 const int *sig_hashes; /*!< allowed signature hashes */
945#endif
946
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200947#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100948 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200949#endif
950
951#if defined(MBEDTLS_DHM_C)
952 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
953 mbedtls_mpi dhm_G; /*!< generator for DHM */
954#endif
955
956#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +0100957
958#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek2349c4d2019-01-08 09:36:01 -0500959 psa_key_handle_t psk_opaque; /*!< PSA key slot holding opaque PSK.
960 * This field should only be set via
961 * mbedtls_ssl_conf_psk_opaque().
962 * If either no PSK or a raw PSK have
963 * been configured, this has value \c 0. */
Hanno Becker43633132018-10-22 15:31:03 +0100964#endif /* MBEDTLS_USE_PSA_CRYPTO */
965
966 unsigned char *psk; /*!< The raw pre-shared key. This field should
967 * only be set via mbedtls_ssl_conf_psk().
968 * If either no PSK or an opaque PSK
969 * have been configured, this has value NULL. */
970 size_t psk_len; /*!< The length of the raw pre-shared key.
971 * This field should only be set via
972 * mbedtls_ssl_conf_psk().
973 * Its value is non-zero if and only if
974 * \c psk is not \c NULL. */
975
976 unsigned char *psk_identity; /*!< The PSK identity for PSK negotiation.
977 * This field should only be set via
978 * mbedtls_ssl_conf_psk().
979 * This is set if and only if either
980 * \c psk or \c psk_opaque are set. */
981 size_t psk_identity_len;/*!< The length of PSK identity.
982 * This field should only be set via
983 * mbedtls_ssl_conf_psk().
984 * Its value is non-zero if and only if
985 * \c psk is not \c NULL or \c psk_opaque
986 * is not \c 0. */
987#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200988
989#if defined(MBEDTLS_SSL_ALPN)
990 const char **alpn_list; /*!< ordered list of protocols */
991#endif
992
993 /*
994 * Numerical settings (int then char)
995 */
996
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200997 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
998
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200999#if defined(MBEDTLS_SSL_PROTO_DTLS)
1000 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001001 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001002 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001003 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001004#endif
1005
1006#if defined(MBEDTLS_SSL_RENEGOTIATION)
1007 int renego_max_records; /*!< grace period for renegotiation */
1008 unsigned char renego_period[8]; /*!< value of the record counters
1009 that triggers renegotiation */
1010#endif
1011
1012#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1013 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1014#endif
1015
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001016#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1017 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1018#endif
1019
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001020 unsigned char max_major_ver; /*!< max. major version used */
1021 unsigned char max_minor_ver; /*!< max. minor version used */
1022 unsigned char min_major_ver; /*!< min. major version used */
1023 unsigned char min_minor_ver; /*!< min. minor version used */
1024
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001025 /*
1026 * Flags (bitfields)
1027 */
1028
1029 unsigned int endpoint : 1; /*!< 0: client, 1: server */
1030 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001031 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
1032 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1033 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001034#if defined(MBEDTLS_ARC4_C)
1035 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
1036#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001037#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1038 unsigned int mfl_code : 3; /*!< desired fragment length */
1039#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001040#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1041 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1042#endif
1043#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1044 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
1045#endif
1046#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1047 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
1048#endif
1049#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1050 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1051#endif
1052#if defined(MBEDTLS_SSL_RENEGOTIATION)
1053 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1054#endif
1055#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1056 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1057#endif
1058#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1059 unsigned int session_tickets : 1; /*!< use session tickets? */
1060#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001061#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1062 unsigned int fallback : 1; /*!< is this a fallback? */
1063#endif
Janos Follath088ce432017-04-10 12:42:31 +01001064#if defined(MBEDTLS_SSL_SRV_C)
1065 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1066 Certificate Request messages? */
1067#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001068};
1069
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001070
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001071struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001072{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001073 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001074
Paul Bakker5121ce52009-01-03 21:22:43 +00001075 /*
1076 * Miscellaneous
1077 */
1078 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001079#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001080 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001081 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1082 number of retransmissions of request if
1083 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001084#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001085
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001086 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001087 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1088
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001089#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001090 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001091#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001092
Hanno Becker8927c832019-04-03 12:52:50 +01001093#if defined(MBEDTLS_X509_CRT_PARSE_C)
1094 /** Callback to customize X.509 certificate chain verification */
1095 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
1096 void *p_vrfy; /*!< context for X.509 verify calllback */
1097#endif
1098
Simon Butchere846b512016-03-01 17:31:49 +00001099 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1100 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1101 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1102 /*!< Callback for network receive with timeout */
1103
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001104 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001105
Paul Bakker5121ce52009-01-03 21:22:43 +00001106 /*
1107 * Session layer
1108 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001109 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1110 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1111 mbedtls_ssl_session *session; /*!< negotiated session data */
1112 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001113
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001115 the handshake process */
1116
1117 /*
1118 * Record layer transformations
1119 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001120 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1121 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1122 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1123 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001124
Paul Bakker5121ce52009-01-03 21:22:43 +00001125 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001126 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001127 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001128 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001129
1130 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1131 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001132
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001133 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001134 * Record layer (incoming data)
1135 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001136 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001137 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1138 TLS: maintained by us
1139 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001140 unsigned char *in_hdr; /*!< start of record header */
1141 unsigned char *in_len; /*!< two-bytes message length field */
1142 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001143 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001144 unsigned char *in_offt; /*!< read offset in application data */
1145
1146 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001147 size_t in_msglen; /*!< record header: message length */
1148 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001150 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001151 size_t next_record_offset; /*!< offset of the next record in datagram
1152 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001153#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001154#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001155 uint64_t in_window_top; /*!< last validated record seq_num */
1156 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001157#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001158
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001159 size_t in_hslen; /*!< current handshake message length,
1160 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001161 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001162
1163 int keep_current_message; /*!< drop or reuse current message
1164 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001165
Hanno Becker04da1892018-08-14 13:22:10 +01001166#if defined(MBEDTLS_SSL_PROTO_DTLS)
1167 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1168 * within a single datagram. */
1169#endif /* MBEDTLS_SSL_PROTO_DTLS */
1170
Paul Bakker5121ce52009-01-03 21:22:43 +00001171 /*
1172 * Record layer (outgoing data)
1173 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001174 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001175 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001176 unsigned char *out_hdr; /*!< start of record header */
1177 unsigned char *out_len; /*!< two-bytes message length field */
1178 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001179 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001180
1181 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001182 size_t out_msglen; /*!< record header: message length */
1183 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +00001184
Hanno Becker19859472018-08-06 09:40:20 +01001185 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1186
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001187#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001188 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001189#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001190
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001191#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001192 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001193#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001194#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001195 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001196#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001197
Paul Bakker5121ce52009-01-03 21:22:43 +00001198 /*
1199 * PKI layer
1200 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001201 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001202
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001203 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001204 * User settings
1205 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001206#if defined(MBEDTLS_X509_CRT_PARSE_C)
1207 char *hostname; /*!< expected peer CN for verification
1208 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001209#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001210
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001211#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001212 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001213#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001214
Paul Bakker48916f92012-09-16 19:57:18 +00001215 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001216 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001217 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001218#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001219 unsigned char *cli_id; /*!< transport-level ID of the client */
1220 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001221#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001222
1223 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001224 * Secure renegotiation
1225 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001226 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001227 int secure_renegotiation; /*!< does peer support legacy or
1228 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001230 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1232 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001233#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001234};
1235
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001236#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001237
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001238#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
1239#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +01001240
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001241extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +00001242 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001243 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +00001244 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001245 size_t ivlen,
1246 const unsigned char *mac_enc, const unsigned char *mac_dec,
1247 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001248extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
1249extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
1250extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
1251extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
1252extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
1253#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001254
Paul Bakker5121ce52009-01-03 21:22:43 +00001255/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001256 * \brief Return the name of the ciphersuite associated with the
1257 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001258 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001259 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001260 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001261 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001262 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001263const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001264
1265/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001266 * \brief Return the ID of the ciphersuite associated with the
1267 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001268 *
1269 * \param ciphersuite_name SSL ciphersuite name
1270 *
1271 * \return the ID with the ciphersuite or 0 if not found
1272 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001274
1275/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001276 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001277 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001278 * mbedtls_ssl_free()
1279 *
1280 * \param ssl SSL context
1281 */
1282void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1283
1284/**
1285 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001286 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001287 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001288 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001289 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001290 * \warning The conf structure will be accessed during the session.
1291 * It must not be modified or freed as long as the session
1292 * is active.
1293 *
1294 * \warning This function must be called exactly once per context.
1295 * Calling mbedtls_ssl_setup again is not supported, even
1296 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001297 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001298 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001299 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001300 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001301 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001302 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001303 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001304int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001305 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001306
1307/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001308 * \brief Reset an already initialized SSL context for re-use
1309 * while retaining application-set variables, function
1310 * pointers and data.
1311 *
1312 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001313 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001314 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1315 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001316 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001317int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001318
1319/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001320 * \brief Set the current endpoint type
1321 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001322 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001324 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001325void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001326
1327/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001328 * \brief Set the transport type (TLS or DTLS).
1329 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001330 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001331 * \note For DTLS, you must either provide a recv callback that
1332 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001333 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1334 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001335 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001336 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001337 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001338 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1339 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001340 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001341void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001342
1343/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001344 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001345 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001346 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001347 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001348 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001349 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001350 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001351 * (default on server)
1352 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001353 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001355 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001356 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001357 * handshake is complete.
1358 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001359 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001360 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001361 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001362 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001363 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1364 * 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 +01001365 * the right time(s), which may not be obvious, while REQUIRED always perform
1366 * the verification as soon as possible. For example, REQUIRED was protecting
1367 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001368 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001369void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001370
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001371#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001372/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001373 * \brief Set the verification callback (Optional).
1374 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001375 * If set, the provided verify callback is called for each
1376 * certificate in the peer's CRT chain, including the trusted
1377 * root. For more information, please see the documentation of
1378 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001379 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001380 * \note For per context callbacks and contexts, please use
1381 * mbedtls_ssl_set_verify() instead.
1382 *
1383 * \param conf The SSL configuration to use.
1384 * \param f_vrfy The verification callback to use during CRT verification.
1385 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001386 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001387void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001388 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001389 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001390#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001391
1392/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001393 * \brief Set the random number generator callback
1394 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001395 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001396 * \param f_rng RNG function
1397 * \param p_rng RNG parameter
1398 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001399void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001400 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001401 void *p_rng );
1402
1403/**
1404 * \brief Set the debug callback
1405 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001406 * The callback has the following argument:
1407 * void * opaque context for the callback
1408 * int debug level
1409 * const char * file name
1410 * int line number
1411 * const char * message
1412 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001413 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001414 * \param f_dbg debug function
1415 * \param p_dbg debug parameter
1416 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001417void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001418 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001419 void *p_dbg );
1420
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001421/**
1422 * \brief Set the underlying BIO callbacks for write, read and
1423 * read-with-timeout.
1424 *
1425 * \param ssl SSL context
1426 * \param p_bio parameter (context) shared by BIO callbacks
1427 * \param f_send write callback
1428 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001429 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001430 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001431 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1432 * the other is used. If both are non-NULL, f_recv_timeout is
1433 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001434 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001435 * \note The two most common use cases are:
1436 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1437 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1438 *
1439 * \note For DTLS, you need to provide either a non-NULL
1440 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001441 *
1442 * \note See the documentations of \c mbedtls_ssl_sent_t,
1443 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001444 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001445 *
Andres AG3616f6f2016-09-14 14:32:09 +01001446 * \note On some platforms, net_sockets.c provides
1447 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1448 * \c mbedtls_net_recv_timeout() that are suitable to be used
1449 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001450 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001451void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001452 void *p_bio,
1453 mbedtls_ssl_send_t *f_send,
1454 mbedtls_ssl_recv_t *f_recv,
1455 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001456
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001457#if defined(MBEDTLS_SSL_PROTO_DTLS)
1458/**
1459 * \brief Set the Maximum Tranport Unit (MTU).
1460 * Special value: 0 means unset (no limit).
1461 * This represents the maximum size of a datagram payload
1462 * handled by the transport layer (usually UDP) as determined
1463 * by the network link and stack. In practice, this controls
1464 * the maximum size datagram the DTLS layer will pass to the
1465 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1466 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001467 * \note The limit on datagram size is converted to a limit on
1468 * record payload by subtracting the current overhead of
1469 * encapsulation and encryption/authentication if any.
1470 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001471 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001472 * example when a Path Maximum Transfer Unit (PMTU)
1473 * estimate becomes available from other sources,
1474 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001475 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001476 * \note This setting only controls the size of the packets we send,
1477 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001478 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001479 * server to use smaller records with \c
1480 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001481 *
1482 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001483 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001484 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001485 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001486 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001487 * of datagrams (hence records, see first note) sent. It
1488 * cannot be used to increase the maximum size of records over
1489 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001490 *
1491 * \note Values lower than the current record layer expansion will
1492 * result in an error when trying to send data.
1493 *
1494 * \note Using record compression together with a non-zero MTU value
1495 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001496 *
1497 * \param ssl SSL context
1498 * \param mtu Value of the path MTU in bytes
1499 */
1500void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1501#endif /* MBEDTLS_SSL_PROTO_DTLS */
1502
Hanno Becker726c97a2019-04-03 12:52:35 +01001503#if defined(MBEDTLS_X509_CRT_PARSE_C)
1504/**
1505 * \brief Set a connection-specific verification callback (optional).
1506 *
1507 * If set, the provided verify callback is called for each
1508 * certificate in the peer's CRT chain, including the trusted
1509 * root. For more information, please see the documentation of
1510 * \c mbedtls_x509_crt_verify().
1511 *
1512 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1513 * binds the verification callback and context to an SSL context
1514 * as opposed to an SSL configuration.
1515 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1516 * are both used, mbedtls_ssl_set_verify() takes precedence.
1517 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001518 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001519 * \param f_vrfy The verification callback to use during CRT verification.
1520 * \param p_vrfy The opaque context to be passed to the callback.
1521 */
1522void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1523 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1524 void *p_vrfy );
1525#endif /* MBEDTLS_X509_CRT_PARSE_C */
1526
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001527/**
1528 * \brief Set the timeout period for mbedtls_ssl_read()
1529 * (Default: no timeout.)
1530 *
1531 * \param conf SSL configuration context
1532 * \param timeout Timeout value in milliseconds.
1533 * Use 0 for no timeout (default).
1534 *
1535 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001536 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001537 * With non-blocking I/O, this will only work if timer
1538 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1539 *
1540 * \note With non-blocking I/O, you may also skip this function
1541 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001542 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001543void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001544
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001545/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001546 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001547 *
1548 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001549 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001550 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001551 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001552 *
1553 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1554 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001555 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001556 *
1557 * \note On some platforms, timing.c provides
1558 * \c mbedtls_timing_set_delay() and
1559 * \c mbedtls_timing_get_delay() that are suitable for using
1560 * here, except if using an event-driven style.
1561 *
1562 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001563 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001564 */
1565void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1566 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001567 mbedtls_ssl_set_timer_t *f_set_timer,
1568 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001569
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001570/**
1571 * \brief Callback type: generate and write session ticket
1572 *
1573 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001574 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001575 * authenticated ticket for the session and write it to the
1576 * output buffer. Here, ticket means the opaque ticket part
1577 * of the NewSessionTicket structure of RFC 5077.
1578 *
1579 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001580 * \param session SSL session to be written in the ticket
1581 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001582 * \param end End of the output buffer
1583 * \param tlen On exit, holds the length written
1584 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1585 *
1586 * \return 0 if successful, or
1587 * a specific MBEDTLS_ERR_XXX code.
1588 */
1589typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1590 const mbedtls_ssl_session *session,
1591 unsigned char *start,
1592 const unsigned char *end,
1593 size_t *tlen,
1594 uint32_t *lifetime );
1595
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001596#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1597/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001598 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001599 *
1600 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001601 * (RFC 5216) and Thread. The key pointers are ephemeral and
1602 * therefore must not be stored. The master secret and keys
1603 * should not be used directly except as an input to a key
1604 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001605 *
1606 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001607 * \param ms Pointer to master secret (fixed length: 48 bytes)
1608 * \param kb Pointer to key block, see RFC 5246 section 6.3
1609 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001610 * \param maclen MAC length
1611 * \param keylen Key length
1612 * \param ivlen IV length
1613 *
1614 * \return 0 if successful, or
1615 * a specific MBEDTLS_ERR_XXX code.
1616 */
1617typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001618 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001619 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001620 size_t maclen,
1621 size_t keylen,
1622 size_t ivlen );
1623#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001624
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001625/**
1626 * \brief Callback type: parse and load session ticket
1627 *
1628 * \note This describes what a callback implementation should do.
1629 * This callback should parse a session ticket as generated
1630 * by the corresponding mbedtls_ssl_ticket_write_t function,
1631 * and, if the ticket is authentic and valid, load the
1632 * session.
1633 *
1634 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001635 * bytes of the input buffer, eg to use it as a temporary
1636 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001637 *
1638 * \param p_ticket Context for the callback
1639 * \param session SSL session to be loaded
1640 * \param buf Start of the buffer containing the ticket
1641 * \param len Length of the ticket.
1642 *
1643 * \return 0 if successful, or
1644 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1645 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1646 * any other non-zero code for other failures.
1647 */
1648typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1649 mbedtls_ssl_session *session,
1650 unsigned char *buf,
1651 size_t len );
1652
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001653#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001654/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001655 * \brief Configure SSL session ticket callbacks (server only).
1656 * (Default: none.)
1657 *
1658 * \note On server, session tickets are enabled by providing
1659 * non-NULL callbacks.
1660 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001661 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001662 *
1663 * \param conf SSL configuration context
1664 * \param f_ticket_write Callback for writing a ticket
1665 * \param f_ticket_parse Callback for parsing a ticket
1666 * \param p_ticket Context shared by the two callbacks
1667 */
1668void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1669 mbedtls_ssl_ticket_write_t *f_ticket_write,
1670 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1671 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001672#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001673
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001674#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1675/**
1676 * \brief Configure key export callback.
1677 * (Default: none.)
1678 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001679 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001680 *
1681 * \param conf SSL configuration context
1682 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001683 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001684 */
1685void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1686 mbedtls_ssl_export_keys_t *f_export_keys,
1687 void *p_export_keys );
1688#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1689
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001690#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001691/**
1692 * \brief Configure asynchronous private key operation callbacks.
1693 *
1694 * \param conf SSL configuration context
1695 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001696 * the description of ::mbedtls_ssl_async_sign_t
1697 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001698 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001699 * operation; in this case the private key object
1700 * associated with the certificate will be used.
1701 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001702 * the description of ::mbedtls_ssl_async_decrypt_t
1703 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001704 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001705 * operation; in this case the private key object
1706 * associated with the certificate will be used.
1707 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001708 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001709 * for more information. This may not be \c NULL unless
1710 * \p f_async_sign and \p f_async_decrypt are both
1711 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001712 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001713 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001714 * for more information. This may be \c NULL if
1715 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02001716 * \param config_data A pointer to configuration data which can be
1717 * retrieved with
1718 * mbedtls_ssl_conf_get_async_config_data(). The
1719 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001720 */
1721void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
1722 mbedtls_ssl_async_sign_t *f_async_sign,
1723 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
1724 mbedtls_ssl_async_resume_t *f_async_resume,
1725 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001726 void *config_data );
1727
1728/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02001729 * \brief Retrieve the configuration data set by
1730 * mbedtls_ssl_conf_async_private_cb().
1731 *
1732 * \param conf SSL configuration context
1733 * \return The configuration data set by
1734 * mbedtls_ssl_conf_async_private_cb().
1735 */
1736void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
1737
1738/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001739 * \brief Retrieve the asynchronous operation user context.
1740 *
1741 * \note This function may only be called while a handshake
1742 * is in progress.
1743 *
1744 * \param ssl The SSL context to access.
1745 *
1746 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02001747 * set during the current handshake. If
1748 * mbedtls_ssl_set_async_operation_data() has not yet been
1749 * called during the current handshake, this function returns
1750 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001751 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001752void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001753
1754/**
1755 * \brief Retrieve the asynchronous operation user context.
1756 *
1757 * \note This function may only be called while a handshake
1758 * is in progress.
1759 *
1760 * \param ssl The SSL context to access.
1761 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02001762 * Call mbedtls_ssl_get_async_operation_data() later during the
1763 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001764 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001765void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001766 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001767#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001768
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001769/**
1770 * \brief Callback type: generate a cookie
1771 *
1772 * \param ctx Context for the callback
1773 * \param p Buffer to write to,
1774 * must be updated to point right after the cookie
1775 * \param end Pointer to one past the end of the output buffer
1776 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001778 * \param ilen Length of info in bytes
1779 *
1780 * \return The callback must return 0 on success,
1781 * or a negative error code.
1782 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001783typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001784 unsigned char **p, unsigned char *end,
1785 const unsigned char *info, size_t ilen );
1786
1787/**
1788 * \brief Callback type: verify a cookie
1789 *
1790 * \param ctx Context for the callback
1791 * \param cookie Cookie to verify
1792 * \param clen Length of cookie
1793 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001794 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001795 * \param ilen Length of info in bytes
1796 *
1797 * \return The callback must return 0 if cookie is valid,
1798 * or a negative error code.
1799 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001800typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001801 const unsigned char *cookie, size_t clen,
1802 const unsigned char *info, size_t ilen );
1803
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001804#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001805/**
1806 * \brief Register callbacks for DTLS cookies
1807 * (Server only. DTLS only.)
1808 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001809 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001810 * register working callbacks (and initialize their context).
1811 *
1812 * To disable HelloVerifyRequest, register NULL callbacks.
1813 *
1814 * \warning Disabling hello verification allows your server to be used
1815 * for amplification in DoS attacks against other hosts.
1816 * Only disable if you known this can't happen in your
1817 * particular environment.
1818 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001819 * \note See comments on \c mbedtls_ssl_handshake() about handling
1820 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1821 * on the first handshake attempt when this is enabled.
1822 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02001823 * \note This is also necessary to handle client reconnection from
1824 * the same port as described in RFC 6347 section 4.2.8 (only
1825 * the variant with cookies is supported currently). See
1826 * comments on \c mbedtls_ssl_read() for details.
1827 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001828 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001829 * \param f_cookie_write Cookie write callback
1830 * \param f_cookie_check Cookie check callback
1831 * \param p_cookie Context for both callbacks
1832 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001833void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001834 mbedtls_ssl_cookie_write_t *f_cookie_write,
1835 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001836 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001837
1838/**
1839 * \brief Set client's transport-level identification info.
1840 * (Server only. DTLS only.)
1841 *
1842 * This is usually the IP address (and port), but could be
1843 * anything identify the client depending on the underlying
1844 * network stack. Used for HelloVerifyRequest with DTLS.
1845 * This is *not* used to route the actual packets.
1846 *
1847 * \param ssl SSL context
1848 * \param info Transport-level info identifying the client (eg IP + port)
1849 * \param ilen Length of info in bytes
1850 *
1851 * \note An internal copy is made, so the info buffer can be reused.
1852 *
1853 * \return 0 on success,
1854 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001855 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001856 */
1857int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
1858 const unsigned char *info,
1859 size_t ilen );
1860
1861#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001862
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001863#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001864/**
1865 * \brief Enable or disable anti-replay protection for DTLS.
1866 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001867 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001868 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001869 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001870 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001871 *
1872 * \warning Disabling this is a security risk unless the application
1873 * protocol handles duplicated packets in a safe way. You
1874 * should not disable this without careful consideration.
1875 * However, if your application already detects duplicated
1876 * packets and needs information about them to adjust its
1877 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001878 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001879void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001880#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001881
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001882#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001883/**
1884 * \brief Set a limit on the number of records with a bad MAC
1885 * before terminating the connection.
1886 * (DTLS only, no effect on TLS.)
1887 * Default: 0 (disabled).
1888 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001889 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001890 * \param limit Limit, or 0 to disable.
1891 *
1892 * \note If the limit is N, then the connection is terminated when
1893 * the Nth non-authentic record is seen.
1894 *
1895 * \note Records with an invalid header are not counted, only the
1896 * ones going through the authentication-decryption phase.
1897 *
1898 * \note This is a security trade-off related to the fact that it's
1899 * often relatively easy for an active attacker ot inject UDP
1900 * datagrams. On one hand, setting a low limit here makes it
1901 * easier for such an attacker to forcibly terminated a
1902 * connection. On the other hand, a high limit or no limit
1903 * might make us waste resources checking authentication on
1904 * many bogus packets.
1905 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001906void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001907#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001908
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001909#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01001910
1911/**
1912 * \brief Allow or disallow packing of multiple handshake records
1913 * within a single datagram.
1914 *
1915 * \param ssl The SSL context to configure.
1916 * \param allow_packing This determines whether datagram packing may
1917 * be used or not. A value of \c 0 means that every
1918 * record will be sent in a separate datagram; a
1919 * value of \c 1 means that, if space permits,
1920 * multiple handshake messages (including CCS) belonging to
1921 * a single flight may be packed within a single datagram.
1922 *
1923 * \note This is enabled by default and should only be disabled
1924 * for test purposes, or if datagram packing causes
1925 * interoperability issues with peers that don't support it.
1926 *
1927 * \note Allowing datagram packing reduces the network load since
1928 * there's less overhead if multiple messages share the same
1929 * datagram. Also, it increases the handshake efficiency
1930 * since messages belonging to a single datagram will not
1931 * be reordered in transit, and so future message buffering
1932 * or flight retransmission (if no buffering is used) as
1933 * means to deal with reordering are needed less frequently.
1934 *
Hanno Beckereb570082018-08-24 11:28:35 +01001935 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01001936 * are currently always sent in separate datagrams.
1937 *
1938 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01001939void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
1940 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01001941
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001942/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00001943 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001944 * (DTLS only, no effect on TLS.)
1945 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001946 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001947 * \param min Initial timeout value in milliseconds.
1948 * Default: 1000 (1 second).
1949 * \param max Maximum timeout value in milliseconds.
1950 * Default: 60000 (60 seconds).
1951 *
1952 * \note Default values are from RFC 6347 section 4.2.4.1.
1953 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01001954 * \note The 'min' value should typically be slightly above the
1955 * expected round-trip time to your peer, plus whatever time
1956 * it takes for the peer to process the message. For example,
1957 * if your RTT is about 600ms and you peer needs up to 1s to
1958 * do the cryptographic operations in the handshake, then you
1959 * should set 'min' slightly above 1600. Lower values of 'min'
1960 * might cause spurious resends which waste network resources,
1961 * while larger value of 'min' will increase overall latency
1962 * on unreliable network links.
1963 *
1964 * \note The more unreliable your network connection is, the larger
1965 * your max / min ratio needs to be in order to achieve
1966 * reliable handshakes.
1967 *
1968 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
1969 * For example, if min = 1s and max = 5s, the retransmit plan
1970 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
1971 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001972 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001973void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001975
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01001976#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001977/**
Paul Bakker0a597072012-09-25 21:55:46 +00001978 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01001979 * If not set, no session resuming is done (except if session
1980 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00001981 *
Paul Bakker0a597072012-09-25 21:55:46 +00001982 * The session cache has the responsibility to check for stale
1983 * entries based on timeout. See RFC 5246 for recommendations.
1984 *
1985 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1986 * connection shutdown, so do not cache the pointer! Either set
1987 * it to NULL or make a full copy of the certificate.
1988 *
1989 * The get callback is called once during the initial handshake
1990 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00001992 * If a valid entry is found, it should fill the master of
1993 * the session object with the cached values and return 0,
1994 * return 1 otherwise. Optionally peer_cert can be set as well
1995 * if it is properly present in cache entry.
1996 *
1997 * The set callback is called once during the initial handshake
1998 * to enable session resuming after the entire handshake has
1999 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002000 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002001 * should create a cache entry for future retrieval based on
2002 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002003 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002004 * data) is cleared by the SSL/TLS layer when the connection is
2005 * terminated. It is recommended to add metadata to determine if
2006 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002007 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002008 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002009 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002010 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002011 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002012 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002013 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002014void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002015 void *p_cache,
2016 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2017 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002018#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002019
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002020#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002021/**
Paul Bakker0a597072012-09-25 21:55:46 +00002022 * \brief Request resumption of session (client-side only)
2023 * Session data is copied from presented session structure.
2024 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002025 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002026 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002027 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002028 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002029 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002031 * arguments are otherwise invalid
2032 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002033 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002034 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002035int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2036#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002037
2038/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002039 * \brief Set the list of allowed ciphersuites and the preference
2040 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002041 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002042 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002043 * The ciphersuites array is not copied, and must remain
2044 * valid for the lifetime of the ssl_config.
2045 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002046 * Note: The server uses its own preferences
2047 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002048 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002049 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002050 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002051 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002052 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002053void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002054 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002055
2056/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002057 * \brief Set the list of allowed ciphersuites and the
2058 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002059 * (Only useful on the server side)
2060 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002061 * The ciphersuites array is not copied, and must remain
2062 * valid for the lifetime of the ssl_config.
2063 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002064 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002065 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002066 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002067 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002068 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2069 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2070 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002071 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2073 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002074 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002075void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002076 const int *ciphersuites,
2077 int major, int minor );
2078
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002079#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002080/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002081 * \brief Set the X.509 security profile used for verification
2082 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002083 * \note The restrictions are enforced for all certificates in the
2084 * chain. However, signatures in the handshake are not covered
2085 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2086 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002087 * \param conf SSL configuration
2088 * \param profile Profile to use
2089 */
2090void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002091 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002092
2093/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002094 * \brief Set the data required to verify peer certificate
2095 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002096 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002097 * parameters ca_chain (maps to trust_ca for that function)
2098 * and ca_crl.
2099 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002100 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002101 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002102 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002103 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002104void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002105 mbedtls_x509_crt *ca_chain,
2106 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002107
2108/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002109 * \brief Set own certificate chain and private key
2110 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002111 * \note own_cert should contain in order from the bottom up your
2112 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002113 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002114 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002115 * \note On server, this function can be called multiple times to
2116 * provision more than one cert/key pair (eg one ECDSA, one
2117 * RSA with SHA-256, one RSA with SHA-1). An adequate
2118 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002119 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002120 * adequate, preference is given to the one set by the first
2121 * call to this function, then second, etc.
2122 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002123 * \note On client, only the first call has any effect. That is,
2124 * only one client certificate can be provisioned. The
2125 * server's preferences in its CertficateRequest message will
2126 * be ignored and our only cert will be sent regardless of
2127 * whether it matches those preferences - the server can then
2128 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002129 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002130 * \note The provided \p pk_key needs to match the public key in the
2131 * first certificate in \p own_cert, or all handshakes using
2132 * that certificate will fail. It is your responsibility
2133 * to ensure that; this function will not perform any check.
2134 * You may use mbedtls_pk_check_pair() in order to perform
2135 * this check yourself, but be aware that this function can
2136 * be computationally expensive on some key types.
2137 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002138 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002139 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002140 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002141 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002142 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002143 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002144int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002145 mbedtls_x509_crt *own_cert,
2146 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002147#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002149#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002150/**
Hanno Becker02283042018-10-22 15:28:02 +01002151 * \brief Configure a pre-shared key (PSK) and identity
2152 * to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002153 *
2154 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002155 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002156 *
Hanno Becker02283042018-10-22 15:28:02 +01002157 * \warning Currently, clients can only register a single pre-shared key.
Hanno Beckerf9a32872018-11-15 13:18:25 +00002158 * Calling this function or mbedtls_ssl_conf_psk_opaque() more
Hanno Becker02283042018-10-22 15:28:02 +01002159 * than once will overwrite values configured in previous calls.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002160 * Support for setting multiple PSKs on clients and selecting
Hanno Becker02283042018-10-22 15:28:02 +01002161 * one based on the identity hint is not a planned feature,
2162 * but feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002163 *
Hanno Becker02283042018-10-22 15:28:02 +01002164 * \param conf The SSL configuration to register the PSK with.
2165 * \param psk The pointer to the pre-shared key to use.
2166 * \param psk_len The length of the pre-shared key in bytes.
2167 * \param psk_identity The pointer to the pre-shared key identity.
2168 * \param psk_identity_len The length of the pre-shared key identity
2169 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002170 *
Hanno Becker02283042018-10-22 15:28:02 +01002171 * \note The PSK and its identity are copied internally and
2172 * hence need not be preserved by the caller for the lifetime
2173 * of the SSL configuration.
2174 *
2175 * \return \c 0 if successful.
2176 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002177 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002178int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002179 const unsigned char *psk, size_t psk_len,
2180 const unsigned char *psk_identity, size_t psk_identity_len );
2181
Hanno Becker02283042018-10-22 15:28:02 +01002182#if defined(MBEDTLS_USE_PSA_CRYPTO)
2183/**
2184 * \brief Configure an opaque pre-shared key (PSK) and identity
2185 * to be used in PSK-based ciphersuites.
2186 *
2187 * \note This is mainly useful for clients. Servers will usually
2188 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2189 *
2190 * \warning Currently, clients can only register a single pre-shared key.
2191 * Calling this function or mbedtls_ssl_conf_psk() more than
2192 * once will overwrite values configured in previous calls.
2193 * Support for setting multiple PSKs on clients and selecting
2194 * one based on the identity hint is not a planned feature,
2195 * but feedback is welcomed.
2196 *
2197 * \param conf The SSL configuration to register the PSK with.
2198 * \param psk The identifier of the key slot holding the PSK.
2199 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002200 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002201 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002202 * allows its use for the key derivation algorithm applied
2203 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002204 * \param psk_identity The pointer to the pre-shared key identity.
2205 * \param psk_identity_len The length of the pre-shared key identity
2206 * in bytes.
2207 *
2208 * \note The PSK identity hint is copied internally and hence need
2209 * not be preserved by the caller for the lifetime of the
2210 * SSL configuration.
2211 *
2212 * \return \c 0 if successful.
2213 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2214 */
2215int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05002216 psa_key_handle_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002217 const unsigned char *psk_identity,
2218 size_t psk_identity_len );
2219#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002220
2221/**
Hanno Becker02283042018-10-22 15:28:02 +01002222 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002223 *
2224 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002225 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002226 *
Hanno Becker02283042018-10-22 15:28:02 +01002227 * \param ssl The SSL context to configure a PSK for.
2228 * \param psk The pointer to the pre-shared key.
2229 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002230 *
Hanno Becker02283042018-10-22 15:28:02 +01002231 * \return \c 0 if successful.
2232 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002233 */
2234int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2235 const unsigned char *psk, size_t psk_len );
2236
Hanno Becker02283042018-10-22 15:28:02 +01002237#if defined(MBEDTLS_USE_PSA_CRYPTO)
2238/**
2239 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2240 *
2241 * \note This should only be called inside the PSK callback,
2242 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2243 *
2244 * \param ssl The SSL context to configure a PSK for.
2245 * \param psk The identifier of the key slot holding the PSK.
2246 * For the duration of the current handshake, the key slot
2247 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002248 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002249 * use for the key derivation algorithm
2250 * applied in the handshake.
2251 *
2252 * \return \c 0 if successful.
2253 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2254 */
2255int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05002256 psa_key_handle_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002257#endif /* MBEDTLS_USE_PSA_CRYPTO */
2258
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002259/**
2260 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002261 *
2262 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002263 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002264 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002265 * receive the actual PSK data and length.
2266 *
Hanno Becker02283042018-10-22 15:28:02 +01002267 * The callback has the following parameters:
2268 * - \c void*: The opaque pointer \p p_psk.
2269 * - \c mbedtls_ssl_context*: The SSL context to which
2270 * the operation applies.
2271 * - \c const unsigned char*: The PSK identity
2272 * selected by the client.
2273 * - \c size_t: The length of the PSK identity
2274 * selected by the client.
2275 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002276 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002277 * \c mbedtls_ssl_set_hs_psk() or
2278 * \c mbedtls_ssl_set_hs_psk_opaque()
2279 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002280 * Any other return value will result in a denied PSK identity.
2281 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002282 * \note If you set a PSK callback using this function, then you
2283 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002284 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002285 *
Hanno Becker02283042018-10-22 15:28:02 +01002286 * \param conf The SSL configuration to register the callback with.
2287 * \param f_psk The callback for selecting and setting the PSK based
2288 * in the PSK identity chosen by the client.
2289 * \param p_psk A pointer to an opaque structure to be passed to
2290 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002291 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002292void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002293 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002294 size_t),
2295 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002296#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002297
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002298#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002299
2300#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2301
2302#if defined(MBEDTLS_DEPRECATED_WARNING)
2303#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2304#else
2305#define MBEDTLS_DEPRECATED
2306#endif
2307
Paul Bakker5121ce52009-01-03 21:22:43 +00002308/**
2309 * \brief Set the Diffie-Hellman public P and G values,
2310 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002311 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002312 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002313 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002314 * \param dhm_P Diffie-Hellman-Merkle modulus
2315 * \param dhm_G Diffie-Hellman-Merkle generator
2316 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002317 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2318 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002319 * \return 0 if successful
2320 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002321MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2322 const char *dhm_P,
2323 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00002324
Hanno Becker470a8c42017-10-04 15:28:46 +01002325#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01002326
2327/**
2328 * \brief Set the Diffie-Hellman public P and G values
2329 * from big-endian binary presentations.
2330 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2331 *
2332 * \param conf SSL configuration
2333 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2334 * \param P_len Length of DHM modulus
2335 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2336 * \param G_len Length of DHM generator
2337 *
2338 * \return 0 if successful
2339 */
2340int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2341 const unsigned char *dhm_P, size_t P_len,
2342 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002343
2344/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002345 * \brief Set the Diffie-Hellman public P and G values,
2346 * read from existing context (server-side only)
2347 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002348 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002349 * \param dhm_ctx Diffie-Hellman-Merkle context
2350 *
2351 * \return 0 if successful
2352 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002353int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002354#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002355
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002356#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2357/**
2358 * \brief Set the minimum length for Diffie-Hellman parameters.
2359 * (Client-side only.)
2360 * (Default: 1024 bits.)
2361 *
2362 * \param conf SSL configuration
2363 * \param bitlen Minimum bit length of the DHM prime
2364 */
2365void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2366 unsigned int bitlen );
2367#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2368
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002369#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002370/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002371 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002372 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002373 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002374 * On server: this only affects selection of the ECDHE curve;
2375 * the curves used for ECDH and ECDSA are determined by the
2376 * list of available certificates instead.
2377 *
2378 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002379 * use. The server can override our preference order.
2380 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002381 * Both sides: limits the set of curves accepted for use in
2382 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002383 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002384 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002385 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002386 * for that. For the end-entity certificate however, the key
2387 * will be accepted only if it is allowed both by this list
2388 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002389 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002390 * \note This list should be ordered by decreasing preference
2391 * (preferred curve first).
2392 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002393 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002394 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002395 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002396 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002397void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2398 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002399#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002400
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002401#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002402/**
2403 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002404 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002405 *
2406 * \note This only affects which hashes are offered and can be used
2407 * for signatures during the handshake. Hashes for message
2408 * authentication and the TLS PRF are controlled by the
2409 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2410 * used for certificate signature are controlled by the
2411 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2412 *
2413 * \note This list should be ordered by decreasing preference
2414 * (preferred hash first).
2415 *
2416 * \param conf SSL configuration
2417 * \param hashes Ordered list of allowed signature hashes,
2418 * terminated by \c MBEDTLS_MD_NONE.
2419 */
2420void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2421 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002422#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002423
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002424#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002425/**
Darryl Green11999bb2018-03-13 15:22:58 +00002426 * \brief Set or reset the hostname to check against the received
2427 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002428 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002429 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002430 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002431 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002432
Hanno Becker0446a392017-04-07 12:59:32 +01002433 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002434 *
Darryl Green11999bb2018-03-13 15:22:58 +00002435 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2436 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002437 * too long input hostname.
2438 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002439 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002440 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002441 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002442 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002443int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002444#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002445
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002446#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002447/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002448 * \brief Set own certificate and key for the current handshake
2449 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002450 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002451 * the SNI callback.
2452 *
2453 * \param ssl SSL context
2454 * \param own_cert own public certificate chain
2455 * \param pk_key own private key
2456 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002457 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002458 */
2459int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2460 mbedtls_x509_crt *own_cert,
2461 mbedtls_pk_context *pk_key );
2462
2463/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002464 * \brief Set the data required to verify peer certificate for the
2465 * current handshake
2466 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002467 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002468 * the SNI callback.
2469 *
2470 * \param ssl SSL context
2471 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
2472 * \param ca_crl trusted CA CRLs
2473 */
2474void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2475 mbedtls_x509_crt *ca_chain,
2476 mbedtls_x509_crl *ca_crl );
2477
2478/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002479 * \brief Set authmode for the current handshake.
2480 *
2481 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
2482 * the SNI callback.
2483 *
2484 * \param ssl SSL context
2485 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
2486 * MBEDTLS_SSL_VERIFY_REQUIRED
2487 */
2488void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2489 int authmode );
2490
2491/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00002492 * \brief Set server side ServerName TLS extension callback
2493 * (optional, server-side only).
2494 *
2495 * If set, the ServerName callback is called whenever the
2496 * server receives a ServerName TLS extension from the client
2497 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002498 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002499 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002500 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002501 * certificate(s) and key(s) to use with \c
2502 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002503 * and may optionally adjust the CA and associated CRL with \c
2504 * mbedtls_ssl_set_hs_ca_chain() as well as the client
2505 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
2506 * then must return 0. If no matching name is found, the
2507 * callback must either set a default cert, or
2508 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00002509 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002510 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00002511 * \param f_sni verification function
2512 * \param p_sni verification parameter
2513 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002514void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002515 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002516 size_t),
2517 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002518#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002519
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002520#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002521/**
2522 * \brief Set the EC J-PAKE password for current handshake.
2523 *
2524 * \note An internal copy is made, and destroyed as soon as the
2525 * handshake is completed, or when the SSL context is reset or
2526 * freed.
2527 *
2528 * \note The SSL context needs to be already set up. The right place
2529 * to call this function is between \c mbedtls_ssl_setup() or
2530 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
2531 *
2532 * \param ssl SSL context
2533 * \param pw EC J-PAKE password (pre-shared secret)
2534 * \param pw_len length of pw in bytes
2535 *
2536 * \return 0 on success, or a negative error code.
2537 */
2538int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2539 const unsigned char *pw,
2540 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002541#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002542
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002543#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002544/**
2545 * \brief Set the supported Application Layer Protocols.
2546 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002547 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00002548 * \param protos Pointer to a NULL-terminated list of supported protocols,
2549 * in decreasing preference order. The pointer to the list is
2550 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00002551 * the lifetime of the table must be atleast as long as the
2552 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002553 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002554 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002555 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002556int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002557
2558/**
2559 * \brief Get the name of the negotiated Application Layer Protocol.
2560 * This function should be called after the handshake is
2561 * completed.
2562 *
2563 * \param ssl SSL context
2564 *
2565 * \return Protcol name, or NULL if no protocol was negotiated.
2566 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002567const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
2568#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002569
Paul Bakker5701cdc2012-09-27 21:49:42 +00002570/**
Paul Bakker490ecc82011-10-06 13:04:09 +00002571 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02002572 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002573 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02002574 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002575 * \note This ignores ciphersuites from higher versions.
2576 *
2577 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2578 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002579 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002580 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002581 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2582 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2583 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2584 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00002585 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002586void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002587
Paul Bakker1d29fb52012-09-28 13:28:45 +00002588/**
2589 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002590 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002591 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002592 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2593 * SSL_MIN_XXXXX_VERSION range is ignored.
2594 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002595 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002596 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002597 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2598 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2599 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002600 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002601 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2602 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2603 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2604 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002605 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002606void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002607
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002608#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002609/**
2610 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002611 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002612 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002613 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002614 * connection, that is a connection with max_version set to a
2615 * lower value than the value you're willing to use. Such
2616 * fallback connections are not recommended but are sometimes
2617 * necessary to interoperate with buggy (version-intolerant)
2618 * servers.
2619 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002620 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002621 * non-fallback connections! This would appear to work for a
2622 * while, then cause failures when the server is upgraded to
2623 * support a newer TLS version.
2624 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002625 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002626 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002627 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002628void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002629#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002630
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002631#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002632/**
2633 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002634 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002635 *
2636 * \note This should always be enabled, it is a security
2637 * improvement, and should not cause any interoperability
2638 * issue (used only if the peer supports it too).
2639 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002640 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002641 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002642 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002643void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002644#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002645
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002646#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002647/**
2648 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002649 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002650 *
2651 * \note This should always be enabled, it is a security fix to the
2652 * protocol, and should not cause any interoperability issue
2653 * (used only if the peer supports it too).
2654 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002655 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002656 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002657 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002658void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002659#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002660
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002661#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002662/**
2663 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002664 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002665 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002666 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002667 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002668 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00002669 * \note This function is deprecated and will likely be removed in
2670 * a future version of the library.
2671 * RC4 is disabled by default at compile time and needs to be
2672 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002673 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002674 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002675 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002676 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002677void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002678#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002679
Janos Follath088ce432017-04-10 12:42:31 +01002680#if defined(MBEDTLS_SSL_SRV_C)
2681/**
2682 * \brief Whether to send a list of acceptable CAs in
2683 * CertificateRequest messages.
2684 * (Default: do send)
2685 *
2686 * \param conf SSL configuration
2687 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
2688 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
2689 */
2690void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2691 char cert_req_ca_list );
2692#endif /* MBEDTLS_SSL_SRV_C */
2693
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002694#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00002695/**
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002696 * \brief Set the maximum fragment length to emit and/or negotiate
Angus Grattond8213d02016-05-25 20:56:48 +10002697 * (Default: the smaller of MBEDTLS_SSL_IN_CONTENT_LEN and
2698 * MBEDTLS_SSL_OUT_CONTENT_LEN, usually 2^14 bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002699 * (Server: set maximum fragment length to emit,
2700 * usually negotiated by the client during handshake
2701 * (Client: set maximum fragment length to emit *and*
2702 * negotiate with the server during handshake)
2703 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002704 * \note With TLS, this currently only affects ApplicationData (sent
2705 * with \c mbedtls_ssl_read()), not handshake messages.
2706 * With DTLS, this affects both ApplicationData and handshake.
2707 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02002708 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002709 * excluding record overhead that will be added to it, see
2710 * \c mbedtls_ssl_get_record_expansion().
2711 *
2712 * \note For DTLS, it is also possible to set a limit for the total
2713 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002714 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002715 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002716 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002717 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002718 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2719 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002720 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002721 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002722 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002723int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002724#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002725
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002726#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002727/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01002728 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01002729 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002730 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002731 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002732 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2733 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002734 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002735void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002736#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002737
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002738#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002739/**
2740 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002741 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002742 *
2743 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
2744 * Does not affect non-CBC ciphersuites in any version.
2745 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01002746 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002747 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
2748 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002749 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002750void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002751#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01002752
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002753#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002754/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002755 * \brief Enable / Disable session tickets (client only).
2756 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002757 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002758 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002759 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01002760 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002761 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
2762 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002763 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02002764void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
2765#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002766
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002767#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02002768/**
Paul Bakker09f097d2012-10-23 11:54:56 +00002769 * \brief Enable / Disable renegotiation support for connection when
2770 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002771 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00002772 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002773 * \warning It is recommended to always disable renegotation unless you
2774 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00002775 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02002776 * renegotiation or a poor understanding of its properties.
2777 *
2778 * \note Server-side, enabling renegotiation also makes the server
2779 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00002780 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002781 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002782 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
2783 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00002784 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002785void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002786#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002787
2788/**
2789 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002790 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02002791 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002792 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002793 * be established even if the peer does not support
2794 * secure renegotiation, but does not allow renegotiation
2795 * to take place if not secure.
2796 * (Interoperable and secure option)
2797 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002798 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002799 * with non-upgraded peers. Allowing legacy renegotiation
2800 * makes the connection vulnerable to specific man in the
2801 * middle attacks. (See RFC 5746)
2802 * (Most interoperable and least secure option)
2803 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002804 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00002805 * if peer does not support secure renegotiation. Results
2806 * in interoperability issues with non-upgraded peers
2807 * that do not support renegotiation altogether.
2808 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00002809 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002810 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00002811 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
2812 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00002814 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002815void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00002816
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002817#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00002818/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002819 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002820 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002821 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002822 * When we request a renegotiation, the peer can comply or
2823 * ignore the request. This function allows us to decide
2824 * whether to enforce our renegotiation requests by closing
2825 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002826 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002827 * However, records could already be in transit from the peer
2828 * when the request is emitted. In order to increase
2829 * reliability, we can accept a number of records before the
2830 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002831 *
2832 * The optimal value is highly dependent on the specific usage
2833 * scenario.
2834 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002835 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002836 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02002837 * out or receives Application Data, until:
2838 * - max_records records have beens seen, if it is >= 0, or
2839 * - the number of retransmits that would happen during an
2840 * actual handshake has been reached.
2841 * Please remember the request might be lost a few times
2842 * if you consider setting max_records to a really low value.
2843 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002844 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002845 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002846 * which always behave as if max_record was 0. The reason is,
2847 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002848 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02002849 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002850 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002851 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002852 * enforce renegotiation, or a non-negative value to enforce
2853 * it but allow for a grace period of max_records records.
2854 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002855void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02002856
2857/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002858 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00002859 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002860 *
2861 * Renegotiation is automatically triggered when a record
2862 * counter (outgoing or ingoing) crosses the defined
2863 * threshold. The default value is meant to prevent the
2864 * connection from being closed when the counter is about to
2865 * reached its maximal value (it is not allowed to wrap).
2866 *
2867 * Lower values can be used to enforce policies such as "keys
2868 * must be refreshed every N packets with cipher X".
2869 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00002870 * The renegotiation period can be disabled by setting
2871 * conf->disable_renegotiation to
2872 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
2873 *
2874 * \note When the configured transport is
2875 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
2876 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
2877 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00002878 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002879 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002880 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002881 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002882void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01002883 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002884#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00002885
Paul Bakker43ca69c2011-01-15 17:35:19 +00002886/**
Hanno Becker8b170a02017-10-10 11:51:19 +01002887 * \brief Check if there is data already read from the
2888 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00002889 *
2890 * \param ssl SSL context
2891 *
Hanno Becker8b170a02017-10-10 11:51:19 +01002892 * \return 0 if nothing's pending, 1 otherwise.
2893 *
Hanno Becker8b170a02017-10-10 11:51:19 +01002894 * \note This is different in purpose and behaviour from
2895 * \c mbedtls_ssl_get_bytes_avail in that it considers
2896 * any kind of unprocessed data, not only unread
2897 * application data. If \c mbedtls_ssl_get_bytes
2898 * returns a non-zero value, this function will
2899 * also signal pending data, but the converse does
2900 * not hold. For example, in DTLS there might be
2901 * further records waiting to be processed from
2902 * the current underlying transport's datagram.
2903 *
Hanno Becker9b19a122017-10-31 13:00:14 +00002904 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01002905 * does not imply that a subsequent call to
2906 * \c mbedtls_ssl_read will provide any data;
2907 * e.g., the unprocessed data might turn out
2908 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00002909 *
2910 * \note This function is useful in the following situation:
2911 * If the SSL/TLS module successfully returns from an
2912 * operation - e.g. a handshake or an application record
2913 * read - and you're awaiting incoming data next, you
2914 * must not immediately idle on the underlying transport
2915 * to have data ready, but you need to check the value
2916 * of this function first. The reason is that the desired
2917 * data might already be read but not yet processed.
2918 * If, in contrast, a previous call to the SSL/TLS module
2919 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
2920 * to call this function, as the latter error code entails
2921 * that all internal data has been processed.
2922 *
Hanno Becker8b170a02017-10-10 11:51:19 +01002923 */
2924int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
2925
2926/**
2927 * \brief Return the number of application data bytes
2928 * remaining to be read from the current record.
2929 *
2930 * \param ssl SSL context
2931 *
2932 * \return How many bytes are available in the application
2933 * data record read buffer.
2934 *
2935 * \note When working over a datagram transport, this is
2936 * useful to detect the current datagram's boundary
2937 * in case \c mbedtls_ssl_read has written the maximal
2938 * amount of data fitting into the input buffer.
2939 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002940 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002941size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002942
2943/**
2944 * \brief Return the result of the certificate verification
2945 *
Hanno Beckercc40d862018-10-23 10:28:01 +01002946 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00002947 *
Hanno Beckercc40d862018-10-23 10:28:01 +01002948 * \return \c 0 if the certificate verification was successful.
2949 * \return \c -1u if the result is not available. This may happen
2950 * e.g. if the handshake aborts early, or a verification
2951 * callback returned a fatal error.
2952 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
2953 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00002954 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02002955uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002956
2957/**
2958 * \brief Return the name of the current ciphersuite
2959 *
2960 * \param ssl SSL context
2961 *
2962 * \return a string containing the ciphersuite name
2963 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002964const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002965
2966/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00002967 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
2968 *
2969 * \param ssl SSL context
2970 *
2971 * \return a string containing the SSL version
2972 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002973const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00002974
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002975/**
2976 * \brief Return the (maximum) number of bytes added by the record
2977 * layer: header + encryption/MAC overhead (inc. padding)
2978 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002979 * \note This function is not available (always returns an error)
2980 * when record compression is enabled.
2981 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002982 * \param ssl SSL context
2983 *
2984 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002985 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02002986 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002987 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002988int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02002989
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002990#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
2991/**
2992 * \brief Return the maximum fragment length (payload, in bytes).
2993 * This is the value negotiated with peer if any,
2994 * or the locally configured value.
2995 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02002996 * \sa mbedtls_ssl_conf_max_frag_len()
2997 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02002998 *
2999 * \param ssl SSL context
3000 *
3001 * \return Current maximum fragment length.
3002 */
3003size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
3004#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3005
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003006/**
3007 * \brief Return the current maximum outgoing record payload in bytes.
3008 * This takes into account the config.h setting \c
3009 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3010 * max fragment length extension if used, and for DTLS the
3011 * path MTU as configured and current record expansion.
3012 *
3013 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3014 * called with a larger length value.
3015 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3016 * necessary and return the number of bytes written; it is up
3017 * to the caller to call \c mbedtls_ssl_write() again in
3018 * order to send the remaining bytes if any.
3019 *
3020 * \note This function is not available (always returns an error)
3021 * when record compression is enabled.
3022 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003023 * \sa mbedtls_ssl_set_mtu()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003024 * \sa mbedtls_ssl_get_max_frag_len()
3025 * \sa mbedtls_ssl_get_record_expansion()
3026 *
3027 * \param ssl SSL context
3028 *
3029 * \return Current maximum payload for an outgoing record,
3030 * or a negative error code.
3031 */
3032int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3033
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003034#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003035/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003036 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003037 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003038 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003039 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003040 * \return The current peer certificate, if available.
3041 * The returned certificate is owned by the SSL context and
3042 * is valid only until the next call to the SSL API.
3043 * \return \c NULL if no peer certificate is available. This might
3044 * be because the chosen ciphersuite doesn't use CRTs
3045 * (PSK-based ciphersuites, for example), or because
3046 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3047 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003048 *
3049 * \note For one-time inspection of the peer's certificate during
3050 * the handshake, consider registering an X.509 CRT verification
3051 * callback through mbedtls_ssl_conf_verify() instead of calling
3052 * this function. Using mbedtls_ssl_conf_verify() also comes at
3053 * the benefit of allowing you to influence the verification
3054 * process, for example by masking expected and tolerated
3055 * verification failures.
3056 *
3057 * \warning You must not use the pointer returned by this function
3058 * after any further call to the SSL API, including
3059 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3060 * because the pointer might change during renegotiation,
3061 * which happens transparently to the user.
3062 * If you want to use the certificate across API calls,
3063 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003064 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003065const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3066#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003067
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003068#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003069/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003070 * \brief Save session in order to resume it later (client-side only)
3071 * Session data is copied to presented session structure.
3072 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003073 *
3074 * \param ssl SSL context
3075 * \param session session context
3076 *
3077 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003078 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003079 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003080 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003081 *
Ron Eldor00115032018-07-17 11:21:50 +03003082 * \note Only the server certificate is copied, and not the full chain,
3083 * so you should not attempt to validate the certificate again
3084 * by calling \c mbedtls_x509_crt_verify() on it.
3085 * Instead, you should use the results from the verification
3086 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3087 * after loading the session again into a new SSL context
3088 * using \c mbedtls_ssl_set_session().
3089 *
3090 * \note Once the session object is not needed anymore, you should
3091 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003092 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003093 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003094 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003095int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3096#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003097
3098/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003099 * \brief Perform the SSL handshake
3100 *
3101 * \param ssl SSL context
3102 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003103 * \return \c 0 if successful.
3104 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003105 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003106 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003107 * transport - in this case you must call this function again
3108 * when the underlying transport is ready for the operation.
3109 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3110 * operation is in progress (see
3111 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3112 * must call this function again when the operation is ready.
3113 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3114 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3115 * in this case you must call this function again to complete
3116 * the handshake when you're done attending other tasks.
3117 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3118 * and the client did not demonstrate reachability yet - in
3119 * this case you must stop using the context (see below).
3120 * \return Another SSL error code - in this case you must stop using
3121 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003122 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003123 * \warning If this function returns something other than
3124 * \c 0,
3125 * #MBEDTLS_ERR_SSL_WANT_READ,
3126 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3127 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3128 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3129 * you must stop using the SSL context for reading or writing,
3130 * and either free it or call \c mbedtls_ssl_session_reset()
3131 * on it before re-using it for a new connection; the current
3132 * connection must be closed.
3133 *
3134 * \note If DTLS is in use, then you may choose to handle
3135 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3136 * purposes, as it is an expected return value rather than an
3137 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003138 *
3139 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003140 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003141 * from the underlying transport layer is currently being processed,
3142 * and it is safe to idle until the timer or the underlying transport
3143 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003144 * in which case the datagram of the underlying transport that is
3145 * currently being processed might or might not contain further
3146 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003147 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003148int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003149
3150/**
Paul Bakker1961b702013-01-25 14:49:24 +01003151 * \brief Perform a single step of the SSL handshake
3152 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003153 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003154 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003155 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003156 *
3157 * \param ssl SSL context
3158 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003159 * \return See mbedtls_ssl_handshake().
3160 *
3161 * \warning If this function returns something other than \c 0,
3162 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3163 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3164 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3165 * the SSL context for reading or writing, and either free it
3166 * or call \c mbedtls_ssl_session_reset() on it before
3167 * re-using it for a new connection; the current connection
3168 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003169 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003170int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003172#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003173/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003174 * \brief Initiate an SSL renegotiation on the running connection.
3175 * Client: perform the renegotiation right now.
3176 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003177 * during the next call to mbedtls_ssl_read() if honored by
3178 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003179 *
3180 * \param ssl SSL context
3181 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003182 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003183 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3184 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003185 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003186 * \warning If this function returns something other than \c 0,
3187 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3188 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3189 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3190 * the SSL context for reading or writing, and either free it
3191 * or call \c mbedtls_ssl_session_reset() on it before
3192 * re-using it for a new connection; the current connection
3193 * must be closed.
3194 *
Paul Bakker48916f92012-09-16 19:57:18 +00003195 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003196int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3197#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003198
3199/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003200 * \brief Read at most 'len' application data bytes
3201 *
3202 * \param ssl SSL context
3203 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003204 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003205 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003206 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003207 * \return \c 0 if the read end of the underlying transport was closed
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003208 * - in this case you must stop using the context (see below).
3209 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003210 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003211 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003212 * transport - in this case you must call this function again
3213 * when the underlying transport is ready for the operation.
3214 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3215 * operation is in progress (see
3216 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3217 * must call this function again when the operation is ready.
3218 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3219 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3220 * in this case you must call this function again to complete
3221 * the handshake when you're done attending other tasks.
3222 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3223 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003224 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003225 * \return Another SSL error code - in this case you must stop using
3226 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003227 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003228 * \warning If this function returns something other than
3229 * a positive value,
3230 * #MBEDTLS_ERR_SSL_WANT_READ,
3231 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3232 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3233 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3234 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3235 * you must stop using the SSL context for reading or writing,
3236 * and either free it or call \c mbedtls_ssl_session_reset()
3237 * on it before re-using it for a new connection; the current
3238 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003239 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003240 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003241 * (which can only happen server-side), it means that a client
3242 * is initiating a new connection using the same source port.
3243 * You can either treat that as a connection close and wait
3244 * for the client to resend a ClientHello, or directly
3245 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003246 * context (as it has been reset internally). Either way, you
3247 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003248 * connection: application state, if any, should be reset, and
3249 * most importantly the identity of the client must be checked
3250 * again. WARNING: not validating the identity of the client
3251 * again, or not transmitting the new identity to the
3252 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003253 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003254 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003255 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003256 * from the underlying transport layer is currently being processed,
3257 * and it is safe to idle until the timer or the underlying transport
3258 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003259 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3260 * initially available on the underlying transport, as this data may have
3261 * been only e.g. duplicated messages or a renegotiation request.
3262 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3263 * when reacting to an incoming-data event from the underlying transport.
3264 * - On success, the datagram of the underlying transport that is currently
3265 * being processed may contain further DTLS records. You should call
3266 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003267 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003268 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003269int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003270
3271/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003272 * \brief Try to write exactly 'len' application data bytes
3273 *
3274 * \warning This function will do partial writes in some cases. If the
3275 * return value is non-negative but less than length, the
3276 * function must be called again with updated arguments:
3277 * buf + ret, len - ret (if ret is the return value) until
3278 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003279 *
3280 * \param ssl SSL context
3281 * \param buf buffer holding the data
3282 * \param len how many bytes must be written
3283 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003284 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003285 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003286 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003287 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003288 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003289 * transport - in this case you must call this function again
3290 * when the underlying transport is ready for the operation.
3291 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3292 * operation is in progress (see
3293 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3294 * must call this function again when the operation is ready.
3295 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3296 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3297 * in this case you must call this function again to complete
3298 * the handshake when you're done attending other tasks.
3299 * \return Another SSL error code - in this case you must stop using
3300 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003301 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003302 * \warning If this function returns something other than
3303 * a non-negative value,
3304 * #MBEDTLS_ERR_SSL_WANT_READ,
3305 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3306 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3307 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3308 * you must stop using the SSL context for reading or writing,
3309 * and either free it or call \c mbedtls_ssl_session_reset()
3310 * on it before re-using it for a new connection; the current
3311 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003312 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003313 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003314 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003315 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003316 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003317 * some partial data in the output buffer, however this is not
3318 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003319 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003320 * \note If the requested length is greater than the maximum
3321 * fragment length (either the built-in limit or the one set
3322 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003323 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003324 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003325 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
3326 * active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003327 *
3328 * \note Attempting to write 0 bytes will result in an empty TLS
3329 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003330 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003331int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003332
3333/**
Paul Bakker0a925182012-04-16 06:46:41 +00003334 * \brief Send an alert message
3335 *
3336 * \param ssl SSL context
3337 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003338 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003339 * \param message The alert message (SSL_ALERT_MSG_*)
3340 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003341 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003342 *
3343 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003344 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3345 * the SSL context for reading or writing, and either free it or
3346 * call \c mbedtls_ssl_session_reset() on it before re-using it
3347 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003348 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003349int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003350 unsigned char level,
3351 unsigned char message );
3352/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003353 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003354 *
3355 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003356 *
3357 * \return 0 if successful, or a specific SSL error code.
3358 *
3359 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003360 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3361 * the SSL context for reading or writing, and either free it or
3362 * call \c mbedtls_ssl_session_reset() on it before re-using it
3363 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003365int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003366
3367/**
Paul Bakker48916f92012-09-16 19:57:18 +00003368 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003369 *
3370 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003371 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003372void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003373
Paul Bakker48916f92012-09-16 19:57:18 +00003374/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003375 * \brief Initialize an SSL configuration context
3376 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003377 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003378 *
3379 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01003380 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003381 *
3382 * \param conf SSL configuration context
3383 */
3384void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
3385
3386/**
3387 * \brief Load reasonnable default SSL configuration values.
3388 * (You need to call mbedtls_ssl_config_init() first.)
3389 *
3390 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003391 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
3392 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
3393 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003394 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003395 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003396 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01003397 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003398 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003399 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003400 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02003401int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003402 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003403
3404/**
3405 * \brief Free an SSL configuration context
3406 *
3407 * \param conf SSL configuration context
3408 */
3409void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
3410
3411/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003412 * \brief Initialize SSL session structure
3413 *
3414 * \param session SSL session
3415 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003416void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003417
3418/**
Paul Bakker0a597072012-09-25 21:55:46 +00003419 * \brief Free referenced items in an SSL session including the
3420 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00003421 *
Ron Eldor00115032018-07-17 11:21:50 +03003422 * \note A session object can be freed even if the SSL context
3423 * that was used to retrieve the session is still in use.
3424 *
Paul Bakker48916f92012-09-16 19:57:18 +00003425 * \param session SSL session
3426 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003427void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00003428
Paul Bakker5121ce52009-01-03 21:22:43 +00003429#ifdef __cplusplus
3430}
3431#endif
3432
3433#endif /* ssl.h */