blob: 63cf2f83a9ea420c5962011abd703f585c1aee01 [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file ssl.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakker37ca75d2011-01-06 12:28:03 +00004 * \brief SSL/TLS functions.
Darryl Greena40a1012018-01-05 15:33:17 +00005 */
6/*
Manuel Pégourié-Gonnard6fb81872015-07-27 11:11:48 +02007 * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +02008 * SPDX-License-Identifier: Apache-2.0
9 *
10 * Licensed under the Apache License, Version 2.0 (the "License"); you may
11 * not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software
17 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19 * See the License for the specific language governing permissions and
20 * limitations under the License.
Paul Bakkerb96f1542010-07-18 20:36:00 +000021 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +000022 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_SSL_H
25#define MBEDTLS_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakkered27a042013-04-18 22:46:23 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010032
Paul Bakkered27a042013-04-18 22:46:23 +020033#include "bignum.h"
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +020034#include "ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020035
Paul Bakker68884e32013-01-07 18:20:04 +010036#include "ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020039#include "x509_crt.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020040#include "x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020041#endif
Paul Bakkered27a042013-04-18 22:46:23 +020042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_DHM_C)
Paul Bakker48916f92012-09-16 19:57:18 +000044#include "dhm.h"
45#endif
46
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#if defined(MBEDTLS_ECDH_C)
Paul Bakker41c83d32013-03-20 14:39:14 +010048#include "ecdh.h"
49#endif
50
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_ZLIB_SUPPORT)
Hanno Beckere494e202018-03-08 13:26:12 +000052
53#if defined(MBEDTLS_DEPRECATED_WARNING)
54#warning "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and will be removed in the next major revision of the library"
55#endif
56
57#if defined(MBEDTLS_DEPRECATED_REMOVED)
58#error "Record compression support via MBEDTLS_ZLIB_SUPPORT is deprecated and cannot be used if MBEDTLS_DEPRECATED_REMOVED is set"
59#endif
60
Paul Bakker2770fbd2012-07-03 13:30:23 +000061#include "zlib.h"
62#endif
63
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020064#if defined(MBEDTLS_HAVE_TIME)
Ron Eldor6fd941f2017-05-14 16:17:33 +030065#include "platform_time.h"
Paul Bakkerfa9b1002013-07-03 15:31:03 +020066#endif
67
Hanno Becker43633132018-10-22 15:31:03 +010068#if defined(MBEDTLS_USE_PSA_CRYPTO)
69#include "psa/crypto.h"
70#endif /* MBEDTLS_USE_PSA_CRYPTO */
71
Paul Bakker13e2dfe2009-07-28 07:18:38 +000072/*
73 * SSL Error codes
74 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020075#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
76#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
77#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
78#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
79#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
80#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
81#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
82#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
83#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
84#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
85#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
86#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
87#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
88#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
89#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
90#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
91#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
92#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
93#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
94#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
95#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
96#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
97#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
98#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
99#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
100#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
101#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
102#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
103#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200104#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200105#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
106#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
107#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
108#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
109#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
110#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
111#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
112#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
113#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
114#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
115#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
116#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
117#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
118#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
Hanno Becker8ec81022017-10-10 10:35:08 +0100119#define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< No data of requested type currently available on underlying transport. */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100120#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
121#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Manuel Pégourié-Gonnardbe619c12015-09-08 11:21:21 +0200122#define MBEDTLS_ERR_SSL_CLIENT_RECONNECT -0x6780 /**< The client initiated a reconnect from the same port. */
Manuel Pégourié-Gonnarde2e25e72015-12-03 16:13:17 +0100123#define MBEDTLS_ERR_SSL_UNEXPECTED_RECORD -0x6700 /**< Record header looks valid but is not expected. */
Simon Butcher99000142016-10-13 17:21:01 +0100124#define MBEDTLS_ERR_SSL_NON_FATAL -0x6680 /**< The alert message received indicates a non-fatal error. */
125#define MBEDTLS_ERR_SSL_INVALID_VERIFY_HASH -0x6600 /**< Couldn't set the hash for verifying CertificateVerify */
Hanno Becker8ec81022017-10-10 10:35:08 +0100126#define MBEDTLS_ERR_SSL_CONTINUE_PROCESSING -0x6580 /**< Internal-only message signaling that further message-processing should be done */
Gilles Peskineb44692f2018-04-24 12:18:19 +0200127#define MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS -0x6500 /**< The asynchronous operation is not completed yet. */
Hanno Becker40f50842018-08-15 14:48:01 +0100128#define MBEDTLS_ERR_SSL_EARLY_MESSAGE -0x6480 /**< Internal-only message signaling that a message arrived early. */
Manuel Pégourié-Gonnard125af942018-09-11 11:08:12 +0200129#define MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS -0x7000 /**< A cryptographic operation is in progress. Try again later. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000130
131/*
132 * Various constants
133 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200134#define MBEDTLS_SSL_MAJOR_VERSION_3 3
135#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
136#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
137#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
138#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000139
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200140#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
141#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100142
Simon Butcher9f812312015-09-28 19:22:33 +0100143#define MBEDTLS_SSL_MAX_HOST_NAME_LEN 255 /*!< Maximum host name defined in RFC 1035 */
Simon Butcher89f77622015-09-27 22:50:49 +0100144
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200145/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200146 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200147#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
148#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
149#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
150#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
151#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
152#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154#define MBEDTLS_SSL_IS_CLIENT 0
155#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
158#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
161#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200162
Hanno Becker019f4b52019-04-09 15:12:56 +0100163#define MBEDTLS_SSL_CID_DISABLED 0
164#define MBEDTLS_SSL_CID_ENABLED 1
165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166#define MBEDTLS_SSL_ETM_DISABLED 0
167#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100168
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200169#define MBEDTLS_SSL_COMPRESS_NULL 0
170#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000171
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200172#define MBEDTLS_SSL_VERIFY_NONE 0
173#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
174#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +0200175#define MBEDTLS_SSL_VERIFY_UNSET 3 /* Used only for sni_authmode */
Paul Bakker5121ce52009-01-03 21:22:43 +0000176
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200177#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
178#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
181#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000182
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200183#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
184#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200185
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200186#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
187#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200188
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200189#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
190#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
191#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000192
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200193#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
194#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
195#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200196
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
198#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200199
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100200#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
201#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100202
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200203#define MBEDTLS_SSL_ARC4_ENABLED 0
204#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100205
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +0200206#define MBEDTLS_SSL_PRESET_DEFAULT 0
207#define MBEDTLS_SSL_PRESET_SUITEB 2
208
Janos Follath088ce432017-04-10 12:42:31 +0100209#define MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED 1
210#define MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED 0
211
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200212/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200213 * Default range for DTLS retransmission timer value, in milliseconds.
214 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
215 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200216#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
217#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200218
Paul Bakker088c5c52014-04-25 11:11:10 +0200219/**
220 * \name SECTION: Module settings
221 *
222 * The configuration options you can set for this module are in this section.
223 * Either change them in config.h or define them on the compiler command line.
224 * \{
225 */
226
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200227#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
228#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200229#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200230
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200231/*
Angus Grattond8213d02016-05-25 20:56:48 +1000232 * Maximum fragment length in bytes,
Manuel Pégourié-Gonnardbb838442015-08-31 12:46:01 +0200233 * determines the size of each of the two internal I/O buffers.
234 *
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200235 * Note: the RFC defines the default size of SSL / TLS messages. If you
236 * change the value here, other clients / servers may not be able to
237 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200238 * both sides of the connection and have it reduced at both sides, or
239 * if you're using the Max Fragment Length extension and you know all your
240 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200241 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200242#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
243#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200244#endif
245
Angus Grattond8213d02016-05-25 20:56:48 +1000246#if !defined(MBEDTLS_SSL_IN_CONTENT_LEN)
247#define MBEDTLS_SSL_IN_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
248#endif
249
250#if !defined(MBEDTLS_SSL_OUT_CONTENT_LEN)
251#define MBEDTLS_SSL_OUT_CONTENT_LEN MBEDTLS_SSL_MAX_CONTENT_LEN
252#endif
253
Hanno Becker28007512018-08-28 09:46:44 +0100254/*
255 * Maximum number of heap-allocated bytes for the purpose of
256 * DTLS handshake message reassembly and future message buffering.
257 */
Hanno Beckere0b150f2018-08-21 15:51:03 +0100258#if !defined(MBEDTLS_SSL_DTLS_MAX_BUFFERING)
Hanno Becker28007512018-08-28 09:46:44 +0100259#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768
Hanno Beckere0b150f2018-08-21 15:51:03 +0100260#endif
261
Hanno Becker019f4b52019-04-09 15:12:56 +0100262/*
263 * Maximum length of CIDs for incoming and outgoing messages.
264 */
265#if !defined(MBEDTLS_SSL_CID_IN_LEN_MAX)
266#define MBEDTLS_SSL_CID_IN_LEN_MAX 32
267#endif
268
269#if !defined(MBEDTLS_SSL_CID_OUT_LEN_MAX)
270#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32
271#endif
272
Paul Bakker088c5c52014-04-25 11:11:10 +0200273/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000274
275/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100276 * Length of the verify data for secure renegotiation
277 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278#if defined(MBEDTLS_SSL_PROTO_SSL3)
279#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100280#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200281#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100282#endif
283
284/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200285 * Signaling ciphersuite values (SCSV)
286 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200287#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
Aaron Jonesd96e5262016-06-17 14:40:41 +0000288#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< RFC 7507 section 2 */
Paul Bakker48916f92012-09-16 19:57:18 +0000289
Paul Bakker5121ce52009-01-03 21:22:43 +0000290/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000291 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200292 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000293 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200294#define MBEDTLS_SSL_HASH_NONE 0
295#define MBEDTLS_SSL_HASH_MD5 1
296#define MBEDTLS_SSL_HASH_SHA1 2
297#define MBEDTLS_SSL_HASH_SHA224 3
298#define MBEDTLS_SSL_HASH_SHA256 4
299#define MBEDTLS_SSL_HASH_SHA384 5
300#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000301
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200302#define MBEDTLS_SSL_SIG_ANON 0
303#define MBEDTLS_SSL_SIG_RSA 1
304#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000305
306/*
Paul Bakker926af752012-11-23 13:38:07 +0100307 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200308 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200310#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
311#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100312
313/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000314 * Message, alert and handshake types
315 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200316#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
317#define MBEDTLS_SSL_MSG_ALERT 21
318#define MBEDTLS_SSL_MSG_HANDSHAKE 22
319#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Paul Bakker5121ce52009-01-03 21:22:43 +0000320
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200321#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
322#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000323
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200324#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
325#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
326#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
327#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
328#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
329#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
330#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
331#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
332#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
333#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
334#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
335#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
336#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
337#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
338#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
339#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
340#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
341#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
342#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
343#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
344#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
345#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
346#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
347#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
348#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
349#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
350#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
351#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
352#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200354#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
355#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
356#define MBEDTLS_SSL_HS_SERVER_HELLO 2
357#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
358#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
359#define MBEDTLS_SSL_HS_CERTIFICATE 11
360#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
361#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
362#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
363#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
364#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
365#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000366
367/*
368 * TLS extensions
369 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200370#define MBEDTLS_TLS_EXT_SERVERNAME 0
371#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000372
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200373#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200374
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200376
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200377#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
378#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000379
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200380#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100381
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200382#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200383
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200384#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
385#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200386
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200387#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200388
Manuel Pégourié-Gonnard294139b2015-09-15 16:55:05 +0200389#define MBEDTLS_TLS_EXT_ECJPAKE_KKPP 256 /* experimental */
390
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200391#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000392
Paul Bakkereb2c6582012-09-27 19:15:01 +0000393/*
Paul Bakkered27a042013-04-18 22:46:23 +0200394 * Size defines
395 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200396#if !defined(MBEDTLS_PSK_MAX_LEN)
397#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200398#endif
399
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200400/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200401union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200402{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200403#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200404 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
405#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200406#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
407 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200408#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200409#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
410 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
411 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
412 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
413 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200414#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
416 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200417#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200418#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
419 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
420 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200421#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
423 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200424#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
426 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
427 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200428#endif
Manuel Pégourié-Gonnard557535d2015-09-15 17:53:32 +0200429#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
430 unsigned char _pms_ecjpake[32]; /* Thread spec: SHA-256 output */
431#endif
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200432};
433
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200434#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200435
Paul Bakker407a0da2013-06-27 14:29:21 +0200436#ifdef __cplusplus
437extern "C" {
438#endif
439
Paul Bakkered27a042013-04-18 22:46:23 +0200440/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000441 * SSL state machine
442 */
443typedef enum
444{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200445 MBEDTLS_SSL_HELLO_REQUEST,
446 MBEDTLS_SSL_CLIENT_HELLO,
447 MBEDTLS_SSL_SERVER_HELLO,
448 MBEDTLS_SSL_SERVER_CERTIFICATE,
449 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
450 MBEDTLS_SSL_CERTIFICATE_REQUEST,
451 MBEDTLS_SSL_SERVER_HELLO_DONE,
452 MBEDTLS_SSL_CLIENT_CERTIFICATE,
453 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
454 MBEDTLS_SSL_CERTIFICATE_VERIFY,
455 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
456 MBEDTLS_SSL_CLIENT_FINISHED,
457 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
458 MBEDTLS_SSL_SERVER_FINISHED,
459 MBEDTLS_SSL_FLUSH_BUFFERS,
460 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
461 MBEDTLS_SSL_HANDSHAKE_OVER,
462 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
463 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000464}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200465mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000466
Ron Eldor51d3ab52019-05-12 14:54:30 +0300467/*
468 * The tls_prf function types.
469 */
470typedef enum
471{
472 MBEDTLS_SSL_TLS_PRF_NONE,
473 MBEDTLS_SSL_TLS_PRF_SSL3,
474 MBEDTLS_SSL_TLS_PRF_TLS1,
475 MBEDTLS_SSL_TLS_PRF_SHA384,
476 MBEDTLS_SSL_TLS_PRF_SHA256
477}
478mbedtls_tls_prf_types;
Simon Butchere846b512016-03-01 17:31:49 +0000479/**
480 * \brief Callback type: send data on the network.
481 *
482 * \note That callback may be either blocking or non-blocking.
483 *
484 * \param ctx Context for the send callback (typically a file descriptor)
Simon Butcherd567a232016-03-09 20:19:21 +0000485 * \param buf Buffer holding the data to send
Simon Butchere846b512016-03-01 17:31:49 +0000486 * \param len Length of the data to send
487 *
488 * \return The callback must return the number of bytes sent if any,
489 * or a non-zero error code.
490 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_WRITE
491 * must be returned when the operation would block.
492 *
Simon Butcherd567a232016-03-09 20:19:21 +0000493 * \note The callback is allowed to send fewer bytes than requested.
Simon Butchere846b512016-03-01 17:31:49 +0000494 * It must always return the number of bytes actually sent.
495 */
496typedef int mbedtls_ssl_send_t( void *ctx,
497 const unsigned char *buf,
498 size_t len );
499
500/**
501 * \brief Callback type: receive data from the network.
502 *
503 * \note That callback may be either blocking or non-blocking.
504 *
505 * \param ctx Context for the receive callback (typically a file
506 * descriptor)
507 * \param buf Buffer to write the received data to
508 * \param len Length of the receive buffer
509 *
510 * \return The callback must return the number of bytes received,
511 * or a non-zero error code.
512 * If performing non-blocking I/O, \c MBEDTLS_ERR_SSL_WANT_READ
513 * must be returned when the operation would block.
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_t( void *ctx,
520 unsigned char *buf,
521 size_t len );
522
523/**
524 * \brief Callback type: receive data from the network, with timeout
525 *
526 * \note That callback must block until data is received, or the
527 * timeout delay expires, or the operation is interrupted by a
528 * signal.
529 *
530 * \param ctx Context for the receive callback (typically a file descriptor)
531 * \param buf Buffer to write the received data to
532 * \param len Length of the receive buffer
533 * \param timeout Maximum nomber of millisecondes to wait for data
Aaron Jonesd96e5262016-06-17 14:40:41 +0000534 * 0 means no timeout (potentially waiting forever)
Simon Butchere846b512016-03-01 17:31:49 +0000535 *
536 * \return The callback must return the number of bytes received,
537 * or a non-zero error code:
538 * \c MBEDTLS_ERR_SSL_TIMEOUT if the operation timed out,
539 * \c MBEDTLS_ERR_SSL_WANT_READ if interrupted by a signal.
540 *
Simon Butcherd567a232016-03-09 20:19:21 +0000541 * \note The callback may receive fewer bytes than the length of the
Simon Butchere846b512016-03-01 17:31:49 +0000542 * buffer. It must always return the number of bytes actually
543 * received and written to the buffer.
544 */
545typedef int mbedtls_ssl_recv_timeout_t( void *ctx,
546 unsigned char *buf,
547 size_t len,
548 uint32_t timeout );
549/**
550 * \brief Callback type: set a pair of timers/delays to watch
551 *
552 * \param ctx Context pointer
553 * \param int_ms Intermediate delay in milliseconds
554 * \param fin_ms Final delay in milliseconds
555 * 0 cancels the current timer.
556 *
557 * \note This callback must at least store the necessary information
558 * for the associated \c mbedtls_ssl_get_timer_t callback to
559 * return correct information.
560 *
561 * \note If using a event-driven style of programming, an event must
562 * be generated when the final delay is passed. The event must
563 * cause a call to \c mbedtls_ssl_handshake() with the proper
564 * SSL context to be scheduled. Care must be taken to ensure
565 * that at most one such call happens at a time.
566 *
567 * \note Only one timer at a time must be running. Calling this
568 * function while a timer is running must cancel it. Cancelled
569 * timers must not generate any event.
570 */
571typedef void mbedtls_ssl_set_timer_t( void * ctx,
572 uint32_t int_ms,
573 uint32_t fin_ms );
574
575/**
576 * \brief Callback type: get status of timers/delays
577 *
578 * \param ctx Context pointer
579 *
580 * \return This callback must return:
581 * -1 if cancelled (fin_ms == 0),
Aaron Jonesd96e5262016-06-17 14:40:41 +0000582 * 0 if none of the delays have passed,
583 * 1 if only the intermediate delay has passed,
584 * 2 if the final delay has passed.
Simon Butchere846b512016-03-01 17:31:49 +0000585 */
586typedef int mbedtls_ssl_get_timer_t( void * ctx );
587
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200588/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200589typedef struct mbedtls_ssl_session mbedtls_ssl_session;
590typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200591typedef struct mbedtls_ssl_config mbedtls_ssl_config;
592
593/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200594typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
595typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Hanno Becker7e5437a2017-04-28 17:15:26 +0100596typedef struct mbedtls_ssl_sig_hash_set_t mbedtls_ssl_sig_hash_set_t;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200597#if defined(MBEDTLS_X509_CRT_PARSE_C)
598typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200599#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200600#if defined(MBEDTLS_SSL_PROTO_DTLS)
601typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200602#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000603
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200604#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100605#if defined(MBEDTLS_X509_CRT_PARSE_C)
606/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200607 * \brief Callback type: start external signature operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100608 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200609 * This callback is called during an SSL handshake to start
610 * a signature decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200611 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100612 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200613 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100614 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200615 * This function typically sends or enqueues a request, and
616 * does not wait for the operation to complete. This allows
617 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100618 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200619 * The parameters \p ssl and \p cert are guaranteed to remain
620 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200621 * function must save the contents of \p hash if the value
622 * is needed for later processing, because the \p hash buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200623 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100624 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200625 * This function may call mbedtls_ssl_set_async_operation_data()
626 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200627 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200628 *
Gilles Peskined3268832018-04-26 06:23:59 +0200629 * \note For RSA signatures, this function must produce output
630 * that is consistent with PKCS#1 v1.5 in the same way as
631 * mbedtls_rsa_pkcs1_sign(). Before the private key operation,
632 * apply the padding steps described in RFC 8017, section 9.2
633 * "EMSA-PKCS1-v1_5" as follows.
634 * - If \p md_alg is #MBEDTLS_MD_NONE, apply the PKCS#1 v1.5
635 * encoding, treating \p hash as the DigestInfo to be
636 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
637 * from step 3, with `T = hash` and `tLen = hash_len`.
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200638 * - If `md_alg != MBEDTLS_MD_NONE`, apply the PKCS#1 v1.5
Gilles Peskined3268832018-04-26 06:23:59 +0200639 * encoding, treating \p hash as the hash to be encoded and
640 * padded. In other words, apply EMSA-PKCS1-v1_5 starting
641 * from step 2, with `digestAlgorithm` obtained by calling
642 * mbedtls_oid_get_oid_by_md() on \p md_alg.
643 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200644 * \note For ECDSA signatures, the output format is the DER encoding
645 * `Ecdsa-Sig-Value` defined in
646 * [RFC 4492 section 5.4](https://tools.ietf.org/html/rfc4492#section-5.4).
647 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200648 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200649 * modified other than via
650 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200651 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200652 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200653 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200654 * connection. However, if other callbacks are used, this
655 * property may not hold. For example, if an SNI callback
656 * is registered with mbedtls_ssl_conf_sni(), then
657 * this callback determines what certificate is used.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200658 * \param md_alg Hash algorithm.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100659 * \param hash Buffer containing the hash. This buffer is
660 * no longer valid when the function returns.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200661 * \param hash_len Size of the \c hash buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100662 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200663 * \return 0 if the operation was started successfully and the SSL
664 * stack should call the resume callback immediately.
665 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
666 * was started successfully and the SSL stack should return
667 * immediately without calling the resume callback yet.
668 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
669 * processor does not support this key. The SSL stack will
670 * use the private key object instead.
671 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200672 * propagated up the call chain. The callback should
673 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
674 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200675 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100676 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200677typedef int mbedtls_ssl_async_sign_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100678 mbedtls_x509_crt *cert,
679 mbedtls_md_type_t md_alg,
680 const unsigned char *hash,
681 size_t hash_len );
682
683/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200684 * \brief Callback type: start external decryption operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100685 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200686 * This callback is called during an SSL handshake to start
687 * an RSA decryption operation using an
Gilles Peskine2481a712018-04-26 07:28:44 +0200688 * external processor. The parameter \p cert contains
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100689 * the public key; it is up to the callback function to
Gilles Peskinead28bf02018-04-26 00:19:16 +0200690 * determine how to access the associated private key.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100691 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200692 * This function typically sends or enqueues a request, and
693 * does not wait for the operation to complete. This allows
694 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100695 *
Gilles Peskine6a8cb362018-04-30 11:54:14 +0200696 * The parameters \p ssl and \p cert are guaranteed to remain
697 * valid throughout the handshake. On the other hand, this
Gilles Peskine2481a712018-04-26 07:28:44 +0200698 * function must save the contents of \p input if the value
699 * is needed for later processing, because the \p input buffer
Gilles Peskinead28bf02018-04-26 00:19:16 +0200700 * is no longer valid after this function returns.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100701 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200702 * This function may call mbedtls_ssl_set_async_operation_data()
703 * to store an operation context for later retrieval
Gilles Peskineea5fab82018-04-30 13:57:45 +0200704 * by the resume or cancel callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200705 *
Gilles Peskine20deb012018-04-26 17:57:37 +0200706 * \warning RSA decryption as used in TLS is subject to a potential
707 * timing side channel attack first discovered by Bleichenbacher
708 * in 1998. This attack can be remotely exploitable
709 * in practice. To avoid this attack, you must ensure that
710 * if the callback performs an RSA decryption, the time it
711 * takes to execute and return the result does not depend
712 * on whether the RSA decryption succeeded or reported
713 * invalid padding.
714 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200715 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200716 * modified other than via
717 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200718 * \param cert Certificate containing the public key.
Gilles Peskine807d74a2018-04-30 10:30:49 +0200719 * In simple cases, this is one of the pointers passed to
Gilles Peskine20deb012018-04-26 17:57:37 +0200720 * mbedtls_ssl_conf_own_cert() when configuring the SSL
Gilles Peskine807d74a2018-04-30 10:30:49 +0200721 * connection. However, if other callbacks are used, this
722 * property may not hold. For example, if an SNI callback
723 * is registered with mbedtls_ssl_conf_sni(), then
724 * this callback determines what certificate is used.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100725 * \param input Buffer containing the input ciphertext. This buffer
726 * is no longer valid when the function returns.
Gilles Peskine2481a712018-04-26 07:28:44 +0200727 * \param input_len Size of the \p input buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100728 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200729 * \return 0 if the operation was started successfully and the SSL
730 * stack should call the resume callback immediately.
731 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
732 * was started successfully and the SSL stack should return
733 * immediately without calling the resume callback yet.
734 * \return #MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH if the external
735 * processor does not support this key. The SSL stack will
736 * use the private key object instead.
737 * \return Any other error indicates a fatal failure and is
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200738 * propagated up the call chain. The callback should
739 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
740 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200741 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100742 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200743typedef int mbedtls_ssl_async_decrypt_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100744 mbedtls_x509_crt *cert,
745 const unsigned char *input,
746 size_t input_len );
747#endif /* MBEDTLS_X509_CRT_PARSE_C */
748
749/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200750 * \brief Callback type: resume external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100751 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200752 * This callback is called during an SSL handshake to resume
753 * an external operation started by the
Gilles Peskine2481a712018-04-26 07:28:44 +0200754 * ::mbedtls_ssl_async_sign_t or
755 * ::mbedtls_ssl_async_decrypt_t callback.
Gilles Peskinead28bf02018-04-26 00:19:16 +0200756 *
757 * This function typically checks the status of a pending
758 * request or causes the request queue to make progress, and
759 * does not wait for the operation to complete. This allows
760 * the handshake step to be non-blocking.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100761 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200762 * This function may call mbedtls_ssl_get_async_operation_data()
763 * to retrieve an operation context set by the start callback.
764 * It may call mbedtls_ssl_set_async_operation_data() to modify
765 * this context.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200766 *
Gilles Peskineea5fab82018-04-30 13:57:45 +0200767 * Note that when this function returns a status other than
768 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, it must free any
769 * resources associated with the operation.
770 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200771 * \param ssl The SSL connection instance. It should not be
Gilles Peskine1febfef2018-04-30 11:54:39 +0200772 * modified other than via
773 * mbedtls_ssl_set_async_operation_data().
Gilles Peskinead28bf02018-04-26 00:19:16 +0200774 * \param output Buffer containing the output (signature or decrypted
775 * data) on success.
Gilles Peskine2481a712018-04-26 07:28:44 +0200776 * \param output_len On success, number of bytes written to \p output.
777 * \param output_size Size of the \p output buffer in bytes.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100778 *
Gilles Peskine2481a712018-04-26 07:28:44 +0200779 * \return 0 if output of the operation is available in the
780 * \p output buffer.
781 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if the operation
782 * is still in progress. Subsequent requests for progress
783 * on the SSL connection will call the resume callback
784 * again.
785 * \return Any other error means that the operation is aborted.
Gilles Peskineac5e8a32018-04-26 11:50:07 +0200786 * The SSL handshake is aborted. The callback should
787 * use \c MBEDTLS_ERR_PK_xxx error codes, and <b>must not</b>
788 * use \c MBEDTLS_ERR_SSL_xxx error codes except as
Gilles Peskine9ceae8b2018-04-30 16:37:03 +0200789 * directed in the documentation of this callback.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100790 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200791typedef int mbedtls_ssl_async_resume_t( mbedtls_ssl_context *ssl,
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100792 unsigned char *output,
793 size_t *output_len,
794 size_t output_size );
795
796/**
Gilles Peskinead28bf02018-04-26 00:19:16 +0200797 * \brief Callback type: cancel external operation.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100798 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200799 * This callback is called if an SSL connection is closed
Gilles Peskineea5fab82018-04-30 13:57:45 +0200800 * while an asynchronous operation is in progress. Note that
801 * this callback is not called if the
802 * ::mbedtls_ssl_async_resume_t callback has run and has
803 * returned a value other than
804 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS, since in that case
805 * the asynchronous operation has already completed.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100806 *
Gilles Peskine1febfef2018-04-30 11:54:39 +0200807 * This function may call mbedtls_ssl_get_async_operation_data()
808 * to retrieve an operation context set by the start callback.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +0200809 *
Gilles Peskinead28bf02018-04-26 00:19:16 +0200810 * \param ssl The SSL connection instance. It should not be
811 * modified.
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100812 */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200813typedef void mbedtls_ssl_async_cancel_t( mbedtls_ssl_context *ssl );
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200814#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Paul Bakker5121ce52009-01-03 21:22:43 +0000815
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000816#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED) && \
817 !defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000818#define MBEDTLS_SSL_PEER_CERT_DIGEST_MAX_LEN 48
819#if defined(MBEDTLS_SHA256_C)
820#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA256
821#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 32
822#elif defined(MBEDTLS_SHA512_C)
823#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA384
824#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 48
825#elif defined(MBEDTLS_SHA1_C)
826#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_TYPE MBEDTLS_MD_SHA1
827#define MBEDTLS_SSL_PEER_CERT_DIGEST_DFL_LEN 20
828#else
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000829/* This is already checked in check_config.h, but be sure. */
Hanno Becker9198ad12019-02-05 17:00:50 +0000830#error "Bad configuration - need SHA-1, SHA-256 or SHA-512 enabled to compute digest of peer CRT."
831#endif
Hanno Beckerfe4ef0c2019-02-26 11:43:09 +0000832#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED &&
833 !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000834
Paul Bakker5121ce52009-01-03 21:22:43 +0000835/*
Paul Bakker0a597072012-09-25 21:55:46 +0000836 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000837 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200838struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000839{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200840#if defined(MBEDTLS_HAVE_TIME)
SimonBd5800b72016-04-26 07:43:27 +0100841 mbedtls_time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200842#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000843 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000844 int compression; /*!< chosen compression */
Manuel Pégourié-Gonnard12ad7982015-06-18 15:50:37 +0200845 size_t id_len; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000846 unsigned char id[32]; /*!< session identifier */
847 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200848
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200849#if defined(MBEDTLS_X509_CRT_PARSE_C)
Hanno Beckerabe6f662019-02-07 13:29:55 +0000850#if defined(MBEDTLS_SSL_KEEP_PEER_CERTIFICATE)
Hanno Becker9198ad12019-02-05 17:00:50 +0000851 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
Hanno Beckerabe6f662019-02-07 13:29:55 +0000852#else /* MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Hanno Becker9198ad12019-02-05 17:00:50 +0000853 /*! The digest of the peer's end-CRT. This must be kept to detect CRT
854 * changes during renegotiation, mitigating the triple handshake attack. */
855 unsigned char *peer_cert_digest;
856 size_t peer_cert_digest_len;
857 mbedtls_md_type_t peer_cert_digest_type;
Hanno Beckerabe6f662019-02-07 13:29:55 +0000858#endif /* !MBEDTLS_SSL_KEEP_PEER_CERTIFICATE */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200860 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200861
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200862#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200863 unsigned char *ticket; /*!< RFC 5077 session ticket */
864 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200865 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200866#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200867
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200869 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200870#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200871
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200872#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200873 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200874#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100875
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200876#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100877 int encrypt_then_mac; /*!< flag for EtM activation */
878#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000879};
880
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200881/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200882 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200883 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200884struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200885{
886 /* Group items by size (largest first) to minimize padding overhead */
887
888 /*
889 * Pointers
890 */
891
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100892 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200893
894 /** Callback for printing debug output */
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +0200895 void (*f_dbg)(void *, int, const char *, int, const char *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200896 void *p_dbg; /*!< context for the debug function */
897
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100898 /** Callback for getting (pseudo-)random numbers */
899 int (*f_rng)(void *, unsigned char *, size_t);
900 void *p_rng; /*!< context for the RNG function */
901
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200902 /** Callback to retrieve a session from the cache */
903 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200904 /** Callback to store a session into the cache */
905 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100906 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200907
908#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
909 /** Callback for setting cert according to SNI extension */
910 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
911 void *p_sni; /*!< context for SNI callback */
912#endif
913
914#if defined(MBEDTLS_X509_CRT_PARSE_C)
915 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200916 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200917 void *p_vrfy; /*!< context for X.509 verify calllback */
918#endif
919
920#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
921 /** Callback to retrieve PSK key from identity */
922 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
923 void *p_psk; /*!< context for PSK callback */
924#endif
925
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200926#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200927 /** Callback to create & write a cookie for ClientHello veirifcation */
928 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
929 const unsigned char *, size_t );
930 /** Callback to verify validity of a ClientHello cookie */
931 int (*f_cookie_check)( void *, const unsigned char *, size_t,
932 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100933 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200934#endif
935
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200936#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200937 /** Callback to create & write a session ticket */
938 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
939 unsigned char *, const unsigned char *, size_t *, uint32_t * );
940 /** Callback to parse a session ticket into a session structure */
941 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
942 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200943#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200944
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100945#if defined(MBEDTLS_SSL_EXPORT_KEYS)
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +0200946 /** Callback to export key block and master secret */
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100947 int (*f_export_keys)( void *, const unsigned char *,
948 const unsigned char *, size_t, size_t, size_t );
Ron Eldorf5cc10d2019-05-07 18:33:40 +0300949 /** Callback to export key block, master secret,
950 * tls_prf and random bytes. Should replace f_export_keys */
951 int (*f_export_keys_ext)( void *, const unsigned char *,
952 const unsigned char *, size_t, size_t, size_t,
Ron Eldor51d3ab52019-05-12 14:54:30 +0300953 unsigned char[32], unsigned char[32], mbedtls_tls_prf_types );
Robert Cragie4feb7ae2015-10-02 13:33:37 +0100954 void *p_export_keys; /*!< context for key export callback */
955#endif
956
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200957#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200958 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200959 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
960 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
961 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
Hanno Becker5adaad92019-03-27 16:54:37 +0000962#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
963 mbedtls_x509_crt_ca_cb_t f_ca_cb;
964 void *p_ca_cb;
965#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200966#endif /* MBEDTLS_X509_CRT_PARSE_C */
967
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200968#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100969#if defined(MBEDTLS_X509_CRT_PARSE_C)
970 mbedtls_ssl_async_sign_t *f_async_sign_start; /*!< start asynchronous signature operation */
971 mbedtls_ssl_async_decrypt_t *f_async_decrypt_start; /*!< start asynchronous decryption operation */
972#endif /* MBEDTLS_X509_CRT_PARSE_C */
973 mbedtls_ssl_async_resume_t *f_async_resume; /*!< resume asynchronous operation */
974 mbedtls_ssl_async_cancel_t *f_async_cancel; /*!< cancel asynchronous operation */
Gilles Peskine8f97af72018-04-26 11:46:10 +0200975 void *p_async_config_data; /*!< Configuration data set by mbedtls_ssl_conf_async_private_cb(). */
Gilles Peskineb74a1c72018-04-24 13:09:22 +0200976#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +0100977
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +0200978#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +0200979 const int *sig_hashes; /*!< allowed signature hashes */
980#endif
981
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +0200982#if defined(MBEDTLS_ECP_C)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100983 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200984#endif
985
986#if defined(MBEDTLS_DHM_C)
987 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
988 mbedtls_mpi dhm_G; /*!< generator for DHM */
989#endif
990
991#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Hanno Becker43633132018-10-22 15:31:03 +0100992
993#if defined(MBEDTLS_USE_PSA_CRYPTO)
Andrzej Kurek2349c4d2019-01-08 09:36:01 -0500994 psa_key_handle_t psk_opaque; /*!< PSA key slot holding opaque PSK.
995 * This field should only be set via
996 * mbedtls_ssl_conf_psk_opaque().
997 * If either no PSK or a raw PSK have
998 * been configured, this has value \c 0. */
Hanno Becker43633132018-10-22 15:31:03 +0100999#endif /* MBEDTLS_USE_PSA_CRYPTO */
1000
1001 unsigned char *psk; /*!< The raw pre-shared key. This field should
1002 * only be set via mbedtls_ssl_conf_psk().
1003 * If either no PSK or an opaque PSK
1004 * have been configured, this has value NULL. */
1005 size_t psk_len; /*!< The length of the raw pre-shared key.
1006 * This field should only be set via
1007 * mbedtls_ssl_conf_psk().
1008 * Its value is non-zero if and only if
1009 * \c psk is not \c NULL. */
1010
1011 unsigned char *psk_identity; /*!< The PSK identity for PSK negotiation.
1012 * This field should only be set via
1013 * mbedtls_ssl_conf_psk().
1014 * This is set if and only if either
1015 * \c psk or \c psk_opaque are set. */
1016 size_t psk_identity_len;/*!< The length of PSK identity.
1017 * This field should only be set via
1018 * mbedtls_ssl_conf_psk().
1019 * Its value is non-zero if and only if
1020 * \c psk is not \c NULL or \c psk_opaque
1021 * is not \c 0. */
1022#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001023
1024#if defined(MBEDTLS_SSL_ALPN)
1025 const char **alpn_list; /*!< ordered list of protocols */
1026#endif
1027
1028 /*
1029 * Numerical settings (int then char)
1030 */
1031
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001032 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
1033
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001034#if defined(MBEDTLS_SSL_PROTO_DTLS)
1035 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001036 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001037 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001038 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001039#endif
1040
1041#if defined(MBEDTLS_SSL_RENEGOTIATION)
1042 int renego_max_records; /*!< grace period for renegotiation */
1043 unsigned char renego_period[8]; /*!< value of the record counters
1044 that triggers renegotiation */
1045#endif
1046
1047#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
1048 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
1049#endif
1050
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001051#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1052 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
1053#endif
1054
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001055 unsigned char max_major_ver; /*!< max. major version used */
1056 unsigned char max_minor_ver; /*!< max. minor version used */
1057 unsigned char min_major_ver; /*!< min. major version used */
1058 unsigned char min_minor_ver; /*!< min. minor version used */
1059
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001060 /*
1061 * Flags (bitfields)
1062 */
1063
1064 unsigned int endpoint : 1; /*!< 0: client, 1: server */
1065 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001066 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
1067 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
1068 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001069#if defined(MBEDTLS_ARC4_C)
1070 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
1071#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +01001072#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
1073 unsigned int mfl_code : 3; /*!< desired fragment length */
1074#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001075#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
1076 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
1077#endif
1078#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
1079 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
1080#endif
1081#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
1082 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
1083#endif
1084#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
1085 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
1086#endif
1087#if defined(MBEDTLS_SSL_RENEGOTIATION)
1088 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
1089#endif
1090#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
1091 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
1092#endif
1093#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1094 unsigned int session_tickets : 1; /*!< use session tickets? */
1095#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001096#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
1097 unsigned int fallback : 1; /*!< is this a fallback? */
1098#endif
Janos Follath088ce432017-04-10 12:42:31 +01001099#if defined(MBEDTLS_SSL_SRV_C)
1100 unsigned int cert_req_ca_list : 1; /*!< enable sending CA list in
1101 Certificate Request messages? */
1102#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +02001103};
1104
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +02001105
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001106struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +00001107{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001108 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001109
Paul Bakker5121ce52009-01-03 21:22:43 +00001110 /*
1111 * Miscellaneous
1112 */
1113 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001114#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +00001115 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001116 int renego_records_seen; /*!< Records since renego request, or with DTLS,
1117 number of retransmissions of request if
1118 renego_max_records is < 0 */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001119#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001120
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +00001122 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
1123
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001124#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001125 unsigned badmac_seen; /*!< records with a bad MAC received */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001126#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001127
Hanno Becker8927c832019-04-03 12:52:50 +01001128#if defined(MBEDTLS_X509_CRT_PARSE_C)
1129 /** Callback to customize X.509 certificate chain verification */
1130 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Janos Follath924270f2019-04-04 12:49:44 +01001131 void *p_vrfy; /*!< context for X.509 verify callback */
Hanno Becker8927c832019-04-03 12:52:50 +01001132#endif
1133
Simon Butchere846b512016-03-01 17:31:49 +00001134 mbedtls_ssl_send_t *f_send; /*!< Callback for network send */
1135 mbedtls_ssl_recv_t *f_recv; /*!< Callback for network receive */
1136 mbedtls_ssl_recv_timeout_t *f_recv_timeout;
1137 /*!< Callback for network receive with timeout */
1138
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +02001139 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +02001140
Paul Bakker5121ce52009-01-03 21:22:43 +00001141 /*
1142 * Session layer
1143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001144 mbedtls_ssl_session *session_in; /*!< current session data (in) */
1145 mbedtls_ssl_session *session_out; /*!< current session data (out) */
1146 mbedtls_ssl_session *session; /*!< negotiated session data */
1147 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +00001148
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001149 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +00001150 the handshake process */
1151
1152 /*
1153 * Record layer transformations
1154 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001155 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
1156 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
1157 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
1158 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +00001159
Paul Bakker5121ce52009-01-03 21:22:43 +00001160 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +02001161 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001162 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001163 void *p_timer; /*!< context for the timer callbacks */
Simon Butchere846b512016-03-01 17:31:49 +00001164
1165 mbedtls_ssl_set_timer_t *f_set_timer; /*!< set timer callback */
1166 mbedtls_ssl_get_timer_t *f_get_timer; /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001167
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +02001168 /*
Paul Bakker5121ce52009-01-03 21:22:43 +00001169 * Record layer (incoming data)
1170 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001171 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001172 unsigned char *in_ctr; /*!< 64-bit incoming message counter
1173 TLS: maintained by us
1174 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001175 unsigned char *in_hdr; /*!< start of record header */
1176 unsigned char *in_len; /*!< two-bytes message length field */
1177 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001178 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001179 unsigned char *in_offt; /*!< read offset in application data */
1180
1181 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001182 size_t in_msglen; /*!< record header: message length */
1183 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001184#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +02001185 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +02001186 size_t next_record_offset; /*!< offset of the next record in datagram
1187 (equal to in_left if none) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001188#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001189#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +02001190 uint64_t in_window_top; /*!< last validated record seq_num */
1191 uint64_t in_window; /*!< bitmask for replay detection */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001192#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Paul Bakker5121ce52009-01-03 21:22:43 +00001193
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +02001194 size_t in_hslen; /*!< current handshake message length,
1195 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +00001196 int nb_zero; /*!< # of 0-length encrypted messages */
Hanno Beckeraf0665d2017-05-24 09:16:26 +01001197
1198 int keep_current_message; /*!< drop or reuse current message
1199 on next call to record layer? */
Paul Bakker5121ce52009-01-03 21:22:43 +00001200
Hanno Becker04da1892018-08-14 13:22:10 +01001201#if defined(MBEDTLS_SSL_PROTO_DTLS)
1202 uint8_t disable_datagram_packing; /*!< Disable packing multiple records
1203 * within a single datagram. */
1204#endif /* MBEDTLS_SSL_PROTO_DTLS */
1205
Paul Bakker5121ce52009-01-03 21:22:43 +00001206 /*
1207 * Record layer (outgoing data)
1208 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001209 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +00001210 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +01001211 unsigned char *out_hdr; /*!< start of record header */
1212 unsigned char *out_len; /*!< two-bytes message length field */
1213 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +01001214 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +00001215
1216 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +00001217 size_t out_msglen; /*!< record header: message length */
1218 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +00001219
Hanno Becker19859472018-08-06 09:40:20 +01001220 unsigned char cur_out_ctr[8]; /*!< Outgoing record sequence number. */
1221
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001222#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard065a2a32018-08-20 11:09:26 +02001223 uint16_t mtu; /*!< path mtu, used to fragment outgoing messages */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001224#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001225
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001226#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +02001227 unsigned char *compress_buf; /*!< zlib data buffer */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001228#endif /* MBEDTLS_ZLIB_SUPPORT */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001230 signed char split_done; /*!< current record already splitted? */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001231#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001232
Paul Bakker5121ce52009-01-03 21:22:43 +00001233 /*
1234 * PKI layer
1235 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001236 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +02001237
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +02001238 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001239 * User settings
1240 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001241#if defined(MBEDTLS_X509_CRT_PARSE_C)
1242 char *hostname; /*!< expected peer CN for verification
1243 (and SNI if available) */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001244#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker48916f92012-09-16 19:57:18 +00001245
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001246#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001247 const char *alpn_chosen; /*!< negotiated protocol */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001248#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001249
Paul Bakker48916f92012-09-16 19:57:18 +00001250 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001251 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001252 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001253#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001254 unsigned char *cli_id; /*!< transport-level ID of the client */
1255 size_t cli_id_len; /*!< length of cli_id */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001256#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001257
1258 /*
Paul Bakker48916f92012-09-16 19:57:18 +00001259 * Secure renegotiation
1260 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +00001261 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +00001262 int secure_renegotiation; /*!< does peer support legacy or
1263 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001264#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001265 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
1267 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Hanno Beckerbc2498a2018-08-28 10:13:29 +01001268#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001269};
1270
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001271#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +01001272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001273#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
1274#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +01001275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001276extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +00001277 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001278 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +00001279 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +01001280 size_t ivlen,
1281 const unsigned char *mac_enc, const unsigned char *mac_dec,
1282 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001283extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
1284extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
1285extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
1286extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
1287extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
1288#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +00001289
Paul Bakker5121ce52009-01-03 21:22:43 +00001290/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001291 * \brief Return the name of the ciphersuite associated with the
1292 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +00001293 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001294 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +00001295 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001296 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +00001297 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001298const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +00001299
1300/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02001301 * \brief Return the ID of the ciphersuite associated with the
1302 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +00001303 *
1304 * \param ciphersuite_name SSL ciphersuite name
1305 *
1306 * \return the ID with the ciphersuite or 0 if not found
1307 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +00001309
1310/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001311 * \brief Initialize an SSL context
Tillmann Karras588ad502015-09-25 04:27:22 +02001312 * Just makes the context ready for mbedtls_ssl_setup() or
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +02001313 * mbedtls_ssl_free()
1314 *
1315 * \param ssl SSL context
1316 */
1317void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
1318
1319/**
1320 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +00001321 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001322 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +02001323 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001324 *
Gilles Peskine4ae7d5d2017-05-26 11:59:29 +02001325 * \warning The conf structure will be accessed during the session.
1326 * It must not be modified or freed as long as the session
1327 * is active.
1328 *
1329 * \warning This function must be called exactly once per context.
1330 * Calling mbedtls_ssl_setup again is not supported, even
1331 * if no session is active.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +02001332 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001333 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001334 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +00001335 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001336 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +00001337 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +00001338 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +02001339int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +02001340 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +00001341
1342/**
Paul Bakker7eb013f2011-10-06 12:37:39 +00001343 * \brief Reset an already initialized SSL context for re-use
1344 * while retaining application-set variables, function
1345 * pointers and data.
1346 *
1347 * \param ssl SSL context
Attila Molnar0b98d2f2016-05-02 11:06:47 +02001348 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001349 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
1350 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +00001351 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001352int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +00001353
1354/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001355 * \brief Set the current endpoint type
1356 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001357 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001358 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +00001359 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001360void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +00001361
1362/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001363 * \brief Set the transport type (TLS or DTLS).
1364 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001365 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001366 * \note For DTLS, you must either provide a recv callback that
1367 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001368 * \c mbedtls_ssl_set_bio(). You also need to provide timer
1369 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001370 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001371 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001372 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001373 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
1374 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001375 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001376void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +01001377
1378/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001379 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001380 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +00001381 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001382 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +00001383 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +00001384 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001385 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +01001386 * (default on server)
1387 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +00001388 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001389 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +00001390 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001391 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +00001392 * handshake is complete.
1393 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001394 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +00001395 * handshake is aborted if verification failed.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001396 * (default on client)
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +01001397 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001398 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
1399 * 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 +01001400 * the right time(s), which may not be obvious, while REQUIRED always perform
1401 * the verification as soon as possible. For example, REQUIRED was protecting
1402 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +00001403 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001404void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +00001405
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001406#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001407/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001408 * \brief Set the verification callback (Optional).
1409 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001410 * If set, the provided verify callback is called for each
1411 * certificate in the peer's CRT chain, including the trusted
1412 * root. For more information, please see the documentation of
1413 * \c mbedtls_x509_crt_verify().
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001414 *
Hanno Becker7b58fb12019-04-03 12:52:21 +01001415 * \note For per context callbacks and contexts, please use
1416 * mbedtls_ssl_set_verify() instead.
1417 *
1418 * \param conf The SSL configuration to use.
1419 * \param f_vrfy The verification callback to use during CRT verification.
1420 * \param p_vrfy The opaque context to be passed to the callback.
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001421 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001422void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001423 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001424 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001425#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +00001426
1427/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001428 * \brief Set the random number generator callback
1429 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +01001430 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001431 * \param f_rng RNG function
1432 * \param p_rng RNG parameter
1433 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001434void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +00001435 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +00001436 void *p_rng );
1437
1438/**
1439 * \brief Set the debug callback
1440 *
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001441 * The callback has the following argument:
1442 * void * opaque context for the callback
1443 * int debug level
1444 * const char * file name
1445 * int line number
1446 * const char * message
1447 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001448 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001449 * \param f_dbg debug function
1450 * \param p_dbg debug parameter
1451 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001452void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardfd474232015-06-23 16:34:24 +02001453 void (*f_dbg)(void *, int, const char *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +00001454 void *p_dbg );
1455
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001456/**
1457 * \brief Set the underlying BIO callbacks for write, read and
1458 * read-with-timeout.
1459 *
1460 * \param ssl SSL context
1461 * \param p_bio parameter (context) shared by BIO callbacks
1462 * \param f_send write callback
1463 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001464 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001465 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001466 * \note One of f_recv or f_recv_timeout can be NULL, in which case
1467 * the other is used. If both are non-NULL, f_recv_timeout is
1468 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001469 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001470 * \note The two most common use cases are:
1471 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
1472 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
1473 *
1474 * \note For DTLS, you need to provide either a non-NULL
1475 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001476 *
1477 * \note See the documentations of \c mbedtls_ssl_sent_t,
1478 * \c mbedtls_ssl_recv_t and \c mbedtls_ssl_recv_timeout_t for
Simon Butcherd567a232016-03-09 20:19:21 +00001479 * the conventions those callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001480 *
Andres AG3616f6f2016-09-14 14:32:09 +01001481 * \note On some platforms, net_sockets.c provides
1482 * \c mbedtls_net_send(), \c mbedtls_net_recv() and
1483 * \c mbedtls_net_recv_timeout() that are suitable to be used
1484 * here.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001485 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001486void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001487 void *p_bio,
1488 mbedtls_ssl_send_t *f_send,
1489 mbedtls_ssl_recv_t *f_recv,
1490 mbedtls_ssl_recv_timeout_t *f_recv_timeout );
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001491
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001492#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker019f4b52019-04-09 15:12:56 +01001493
1494#if defined(MBEDTLS_SSL_CID)
1495
1496
1497/**
1498 * \brief Configure the use of the Connection ID (CID) extension
1499 * in the next handshake.
1500 *
1501 * Reference:
1502 * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-04
1503 *
1504 * The DTLS CID extension allows to reliably associate
1505 * DTLS records to DTLS connections across changes in the
1506 * underlying transport (changed IP+Port metadata) by adding
1507 * explicit connection identifiers (CIDs) to the headers of
1508 * encrypted DTLS records. The desired CIDs are configured
1509 * by the application layer and are exchanged in new
1510 * `ClientHello` / `ServerHello` extensions during the
1511 * handshake, where each side indicates the CID it wants the
1512 * peer to use when writing encrypted messages. The CIDs are
1513 * put to use once records get encrypted: the stack discards
1514 * any incoming records that don't include the configured CID
1515 * in their header, and adds the peer's requested CID to the
1516 * headers of outgoing messages.
1517 *
1518 * This API allows to enable/disable the use of the CID
1519 * extension in the next handshake and to set the value of
1520 * the CID to be used for incoming messages.
1521 *
1522 * \param ssl The SSL context to configure. This must be initialized.
1523 * \param enable This value determines whether the CID extension should
1524 * be used or not. Possible values are:
1525 * - MBEDTLS_SSL_CID_ENABLED to enable the use of the CID.
Hanno Becker318a87b2019-04-23 11:37:38 +01001526 * - MBEDTLS_SSL_CID_DISABLED (default) to disable the use
1527 * of the CID.
Hanno Becker019f4b52019-04-09 15:12:56 +01001528 * \param own_cid The address of the readable buffer holding the CID we want
1529 * the peer to use when sending encrypted messages to us.
1530 * This may be \c NULL if \p own_cid_len is \c 0.
1531 * This parameter is unused if \p enabled is set to
1532 * MBEDTLS_SSL_CID_DISABLED.
1533 * \param own_cid_len The length of \p own_cid.
1534 * This parameter is unused if \p enabled is set to
1535 * MBEDTLS_SSL_CID_DISABLED.
1536 *
Hanno Becker4f664cb2019-04-23 11:38:47 +01001537 * \note This CID configuration applies to subsequent handshakes
Hanno Becker019f4b52019-04-09 15:12:56 +01001538 * performed on the SSL context \p ssl, but does not trigger
1539 * one. You still have to call `mbedtls_ssl_handshake()`
1540 * (for the initial handshake) or `mbedtls_ssl_renegotiate()`
1541 * (for a renegotiation handshake) explicitly after a
1542 * successful call to this function to run the handshake.
1543 *
1544 * \note This call cannot guarantee that the use of the CID
1545 * will be successfully negotiated in the next handshake,
1546 * because the peer might not support it. Specifically:
1547 * - On the Client, enabling the use of the CID through
1548 * this call implies that the `ClientHello` in the next
1549 * handshake will include the CID extension, thereby
1550 * offering the use of the CID to the server. Only if
1551 * the `ServerHello` contains the CID extension, too,
1552 * the CID extension will actually be put to use.
1553 * - On the Server, enabling the use of the CID through
1554 * this call implies that that the server will look for
1555 * the CID extension in a `ClientHello` from the client,
1556 * and, if present, reply with a CID extension in its
1557 * `ServerHello`.
1558 *
1559 * \note To check whether the use of the CID was negotiated
1560 * after the subsequent handshake has completed, please
1561 * use the API mbedtls_ssl_get_peer_cid().
1562 *
1563 * \warning If the use of the CID extension is enabled in this call
1564 * and the subsequent handshake negotiates its use, Mbed TLS
1565 * will silently drop every packet whose CID does not match
1566 * the CID configured in \p own_cid. It is the responsibility
1567 * of the user to adapt the underlying transport to take care
1568 * of CID-based demultiplexing before handing datagrams to
1569 * Mbed TLS.
1570 *
1571 * \return \c 0 on success. In this case, the CID configuration
1572 * applies to the next handshake.
1573 * \return A negative error code on failure.
1574 */
1575int mbedtls_ssl_set_cid( mbedtls_ssl_context *ssl,
1576 int enable,
1577 unsigned char const *own_cid,
1578 size_t own_cid_len );
1579
1580/**
1581 * \brief Get information about the current use of the
1582 * CID extension.
1583 *
1584 * \param ssl The SSL context to query.
1585 * \param enabled The address at which to store whether the CID extension
1586 * is currently in use or not. If the CID is in use,
1587 * `*enabled` is set to MBEDTLS_SSL_CID_ENABLED;
1588 * otherwise, it is set to MBEDTLS_SSL_CID_DISABLED.
1589 * \param peer_cid The address of the buffer in which to store the CID
1590 * chosen by the peer (if the CID extension is used).
1591 * \param peer_cid_len The address at which to store the size of the CID
1592 * chosen by the peer (if the CID extension is used).
1593 * This is also the number of Bytes in \p peer_cid that
1594 * have been written.
1595 *
1596 * \note This applies to the state of the CID negotiated in
1597 * the last complete handshake. If a handshake is in
1598 * progress, this function will attempt to complete
1599 * the handshake first.
1600 *
1601 * \return \c 0 on success.
1602 * \return A negative error code on failure.
1603 */
1604int mbedtls_ssl_get_peer_cid( mbedtls_ssl_context *ssl,
1605 int *enabled,
1606 unsigned char peer_cid[ MBEDTLS_SSL_CID_OUT_LEN_MAX ],
1607 size_t *peer_cid_len );
1608
1609#endif /* MBEDTLS_SSL_CID */
1610
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001611/**
1612 * \brief Set the Maximum Tranport Unit (MTU).
1613 * Special value: 0 means unset (no limit).
1614 * This represents the maximum size of a datagram payload
1615 * handled by the transport layer (usually UDP) as determined
1616 * by the network link and stack. In practice, this controls
1617 * the maximum size datagram the DTLS layer will pass to the
1618 * \c f_send() callback set using \c mbedtls_ssl_set_bio().
1619 *
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001620 * \note The limit on datagram size is converted to a limit on
1621 * record payload by subtracting the current overhead of
1622 * encapsulation and encryption/authentication if any.
1623 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001624 * \note This can be called at any point during the connection, for
Hanno Beckereefe0842018-08-28 10:29:17 +01001625 * example when a Path Maximum Transfer Unit (PMTU)
1626 * estimate becomes available from other sources,
1627 * such as lower (or higher) protocol layers.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001628 *
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001629 * \note This setting only controls the size of the packets we send,
1630 * and does not restrict the size of the datagrams we're
Manuel Pégourié-Gonnard68ae3512018-08-22 10:24:31 +02001631 * willing to receive. Client-side, you can request the
Manuel Pégourié-Gonnardf2f1d402018-08-21 09:53:22 +02001632 * server to use smaller records with \c
1633 * mbedtls_ssl_conf_max_frag_len().
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001634 *
1635 * \note If both a MTU and a maximum fragment length have been
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001636 * configured (or negotiated with the peer), the resulting
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001637 * lower limit on record payload (see first note) is used.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001638 *
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001639 * \note This can only be used to decrease the maximum size
Manuel Pégourié-Gonnard66110352018-08-21 11:55:40 +02001640 * of datagrams (hence records, see first note) sent. It
1641 * cannot be used to increase the maximum size of records over
1642 * the limit set by #MBEDTLS_SSL_OUT_CONTENT_LEN.
Manuel Pégourié-Gonnard050dd6a2018-08-20 11:16:40 +02001643 *
1644 * \note Values lower than the current record layer expansion will
1645 * result in an error when trying to send data.
1646 *
1647 * \note Using record compression together with a non-zero MTU value
1648 * will result in an error when trying to send data.
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02001649 *
1650 * \param ssl SSL context
1651 * \param mtu Value of the path MTU in bytes
1652 */
1653void mbedtls_ssl_set_mtu( mbedtls_ssl_context *ssl, uint16_t mtu );
1654#endif /* MBEDTLS_SSL_PROTO_DTLS */
1655
Hanno Becker726c97a2019-04-03 12:52:35 +01001656#if defined(MBEDTLS_X509_CRT_PARSE_C)
1657/**
1658 * \brief Set a connection-specific verification callback (optional).
1659 *
1660 * If set, the provided verify callback is called for each
1661 * certificate in the peer's CRT chain, including the trusted
1662 * root. For more information, please see the documentation of
1663 * \c mbedtls_x509_crt_verify().
1664 *
1665 * \note This call is analogous to mbedtls_ssl_conf_verify() but
1666 * binds the verification callback and context to an SSL context
1667 * as opposed to an SSL configuration.
1668 * If mbedtls_ssl_conf_verify() and mbedtls_ssl_set_verify()
1669 * are both used, mbedtls_ssl_set_verify() takes precedence.
1670 *
Hanno Beckerf345baf2019-04-03 13:43:15 +01001671 * \param ssl The SSL context to use.
Hanno Becker726c97a2019-04-03 12:52:35 +01001672 * \param f_vrfy The verification callback to use during CRT verification.
1673 * \param p_vrfy The opaque context to be passed to the callback.
1674 */
1675void mbedtls_ssl_set_verify( mbedtls_ssl_context *ssl,
1676 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
1677 void *p_vrfy );
1678#endif /* MBEDTLS_X509_CRT_PARSE_C */
1679
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001680/**
1681 * \brief Set the timeout period for mbedtls_ssl_read()
1682 * (Default: no timeout.)
1683 *
1684 * \param conf SSL configuration context
1685 * \param timeout Timeout value in milliseconds.
1686 * Use 0 for no timeout (default).
1687 *
1688 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +01001689 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +02001690 * With non-blocking I/O, this will only work if timer
1691 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
1692 *
1693 * \note With non-blocking I/O, you may also skip this function
1694 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +01001695 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001696void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001697
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001698/**
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001699 * \brief Set the timer callbacks (Mandatory for DTLS.)
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001700 *
1701 * \param ssl SSL context
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001702 * \param p_timer parameter (context) shared by timer callbacks
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001703 * \param f_set_timer set timer callback
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001704 * \param f_get_timer get timer callback. Must return:
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001705 *
1706 * \note See the documentation of \c mbedtls_ssl_set_timer_t and
1707 * \c mbedtls_ssl_get_timer_t for the conventions this pair of
Jaakko Korhonen14918fb2017-01-09 11:07:46 +02001708 * callbacks must follow.
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001709 *
1710 * \note On some platforms, timing.c provides
1711 * \c mbedtls_timing_set_delay() and
1712 * \c mbedtls_timing_get_delay() that are suitable for using
1713 * here, except if using an event-driven style.
1714 *
1715 * \note See also the "DTLS tutorial" article in our knowledge base.
Manuel Pégourié-Gonnard02049dc2016-02-22 16:42:51 +00001716 * https://tls.mbed.org/kb/how-to/dtls-tutorial
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001717 */
1718void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1719 void *p_timer,
Manuel Pégourié-Gonnardd13b9502016-02-22 09:33:52 +01001720 mbedtls_ssl_set_timer_t *f_set_timer,
1721 mbedtls_ssl_get_timer_t *f_get_timer );
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001722
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001723/**
1724 * \brief Callback type: generate and write session ticket
1725 *
1726 * \note This describes what a callback implementation should do.
Aaron Jonesd96e5262016-06-17 14:40:41 +00001727 * This callback should generate an encrypted and
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001728 * authenticated ticket for the session and write it to the
1729 * output buffer. Here, ticket means the opaque ticket part
1730 * of the NewSessionTicket structure of RFC 5077.
1731 *
1732 * \param p_ticket Context for the callback
Aaron Jonesd96e5262016-06-17 14:40:41 +00001733 * \param session SSL session to be written in the ticket
1734 * \param start Start of the output buffer
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001735 * \param end End of the output buffer
1736 * \param tlen On exit, holds the length written
1737 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1738 *
1739 * \return 0 if successful, or
1740 * a specific MBEDTLS_ERR_XXX code.
1741 */
1742typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1743 const mbedtls_ssl_session *session,
1744 unsigned char *start,
1745 const unsigned char *end,
1746 size_t *tlen,
1747 uint32_t *lifetime );
1748
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001749#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1750/**
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001751 * \brief Callback type: Export key block and master secret
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001752 *
1753 * \note This is required for certain uses of TLS, e.g. EAP-TLS
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001754 * (RFC 5216) and Thread. The key pointers are ephemeral and
1755 * therefore must not be stored. The master secret and keys
1756 * should not be used directly except as an input to a key
1757 * derivation function.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001758 *
1759 * \param p_expkey Context for the callback
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001760 * \param ms Pointer to master secret (fixed length: 48 bytes)
1761 * \param kb Pointer to key block, see RFC 5246 section 6.3
1762 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001763 * \param maclen MAC length
1764 * \param keylen Key length
1765 * \param ivlen IV length
1766 *
1767 * \return 0 if successful, or
1768 * a specific MBEDTLS_ERR_XXX code.
1769 */
1770typedef int mbedtls_ssl_export_keys_t( void *p_expkey,
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001771 const unsigned char *ms,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001772 const unsigned char *kb,
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001773 size_t maclen,
1774 size_t keylen,
1775 size_t ivlen );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001776
1777/**
1778 * \brief Callback type: Export key block, master secret,
1779 * handshake randbytes and the tls_prf function
1780 * used to derive keys.
1781 *
1782 * \note This is required for certain uses of TLS, e.g. EAP-TLS
1783 * (RFC 5216) and Thread. The key pointers are ephemeral and
1784 * therefore must not be stored. The master secret and keys
1785 * should not be used directly except as an input to a key
1786 * derivation function.
1787 *
1788 * \param p_expkey Context for the callback.
1789 * \param ms Pointer to master secret (fixed length: 48 bytes).
1790 * \param kb Pointer to key block, see RFC 5246 section 6.3.
1791 * (variable length: 2 * maclen + 2 * keylen + 2 * ivlen).
1792 * \param maclen MAC length.
1793 * \param keylen Key length.
1794 * \param ivlen IV length.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001795 * \param client_random The client random bytes.
1796 * \param server_random The server random bytes.
Ron Eldor51d3ab52019-05-12 14:54:30 +03001797 * \param tls_prf_type The tls_prf enum type.
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001798 *
1799 * \return 0 if successful, or
1800 * a specific MBEDTLS_ERR_XXX code.
1801 */
1802typedef int mbedtls_ssl_export_keys_ext_t( void *p_expkey,
1803 const unsigned char *ms,
1804 const unsigned char *kb,
1805 size_t maclen,
1806 size_t keylen,
1807 size_t ivlen,
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001808 unsigned char client_random[32],
Ron Eldor51d3ab52019-05-12 14:54:30 +03001809 unsigned char server_random[32],
1810 mbedtls_tls_prf_types tls_prf_type );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001811#endif /* MBEDTLS_SSL_EXPORT_KEYS */
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001812
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001813/**
1814 * \brief Callback type: parse and load session ticket
1815 *
1816 * \note This describes what a callback implementation should do.
1817 * This callback should parse a session ticket as generated
1818 * by the corresponding mbedtls_ssl_ticket_write_t function,
1819 * and, if the ticket is authentic and valid, load the
1820 * session.
1821 *
1822 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001823 * bytes of the input buffer, eg to use it as a temporary
1824 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001825 *
1826 * \param p_ticket Context for the callback
1827 * \param session SSL session to be loaded
1828 * \param buf Start of the buffer containing the ticket
1829 * \param len Length of the ticket.
1830 *
1831 * \return 0 if successful, or
1832 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1833 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1834 * any other non-zero code for other failures.
1835 */
1836typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1837 mbedtls_ssl_session *session,
1838 unsigned char *buf,
1839 size_t len );
1840
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001841#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001842/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001843 * \brief Configure SSL session ticket callbacks (server only).
1844 * (Default: none.)
1845 *
1846 * \note On server, session tickets are enabled by providing
1847 * non-NULL callbacks.
1848 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001849 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001850 *
1851 * \param conf SSL configuration context
1852 * \param f_ticket_write Callback for writing a ticket
1853 * \param f_ticket_parse Callback for parsing a ticket
1854 * \param p_ticket Context shared by the two callbacks
1855 */
1856void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1857 mbedtls_ssl_ticket_write_t *f_ticket_write,
1858 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1859 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001860#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001861
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001862#if defined(MBEDTLS_SSL_EXPORT_KEYS)
1863/**
1864 * \brief Configure key export callback.
1865 * (Default: none.)
1866 *
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001867 * \note See \c mbedtls_ssl_export_keys_t.
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001868 *
1869 * \param conf SSL configuration context
1870 * \param f_export_keys Callback for exporting keys
Manuel Pégourié-Gonnard024b6df2015-10-19 13:52:53 +02001871 * \param p_export_keys Context for the callback
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001872 */
1873void mbedtls_ssl_conf_export_keys_cb( mbedtls_ssl_config *conf,
1874 mbedtls_ssl_export_keys_t *f_export_keys,
1875 void *p_export_keys );
Ron Eldorf5cc10d2019-05-07 18:33:40 +03001876
1877/**
1878 * \brief Configure extended key export callback.
1879 * (Default: none.)
1880 *
1881 * \note See \c mbedtls_ssl_export_keys_ext_t.
1882 *
1883 * \param conf SSL configuration context
1884 * \param f_export_keys_ext Callback for exporting keys
1885 * \param p_export_keys Context for the callback
1886 */
1887void mbedtls_ssl_conf_export_keys_ext_cb( mbedtls_ssl_config *conf,
1888 mbedtls_ssl_export_keys_ext_t *f_export_keys_ext,
1889 void *p_export_keys );
Robert Cragie4feb7ae2015-10-02 13:33:37 +01001890#endif /* MBEDTLS_SSL_EXPORT_KEYS */
1891
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001892#if defined(MBEDTLS_SSL_ASYNC_PRIVATE)
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001893/**
1894 * \brief Configure asynchronous private key operation callbacks.
1895 *
1896 * \param conf SSL configuration context
1897 * \param f_async_sign Callback to start a signature operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001898 * the description of ::mbedtls_ssl_async_sign_t
1899 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001900 * external processor does not support any signature
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001901 * operation; in this case the private key object
1902 * associated with the certificate will be used.
1903 * \param f_async_decrypt Callback to start a decryption operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001904 * the description of ::mbedtls_ssl_async_decrypt_t
1905 * for more information. This may be \c NULL if the
Gilles Peskinef1127252018-04-24 13:05:39 +02001906 * external processor does not support any decryption
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001907 * operation; in this case the private key object
1908 * associated with the certificate will be used.
1909 * \param f_async_resume Callback to resume an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001910 * the description of ::mbedtls_ssl_async_resume_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001911 * for more information. This may not be \c NULL unless
1912 * \p f_async_sign and \p f_async_decrypt are both
1913 * \c NULL.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001914 * \param f_async_cancel Callback to cancel an asynchronous operation. See
Gilles Peskine2481a712018-04-26 07:28:44 +02001915 * the description of ::mbedtls_ssl_async_cancel_t
Gilles Peskinead28bf02018-04-26 00:19:16 +02001916 * for more information. This may be \c NULL if
1917 * no cleanup is needed.
Gilles Peskine8f97af72018-04-26 11:46:10 +02001918 * \param config_data A pointer to configuration data which can be
1919 * retrieved with
1920 * mbedtls_ssl_conf_get_async_config_data(). The
1921 * library stores this value without dereferencing it.
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001922 */
1923void mbedtls_ssl_conf_async_private_cb( mbedtls_ssl_config *conf,
1924 mbedtls_ssl_async_sign_t *f_async_sign,
1925 mbedtls_ssl_async_decrypt_t *f_async_decrypt,
1926 mbedtls_ssl_async_resume_t *f_async_resume,
1927 mbedtls_ssl_async_cancel_t *f_async_cancel,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001928 void *config_data );
1929
1930/**
Gilles Peskine8f97af72018-04-26 11:46:10 +02001931 * \brief Retrieve the configuration data set by
1932 * mbedtls_ssl_conf_async_private_cb().
1933 *
1934 * \param conf SSL configuration context
1935 * \return The configuration data set by
1936 * mbedtls_ssl_conf_async_private_cb().
1937 */
1938void *mbedtls_ssl_conf_get_async_config_data( const mbedtls_ssl_config *conf );
1939
1940/**
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001941 * \brief Retrieve the asynchronous operation user context.
1942 *
1943 * \note This function may only be called while a handshake
1944 * is in progress.
1945 *
1946 * \param ssl The SSL context to access.
1947 *
1948 * \return The asynchronous operation user context that was last
Gilles Peskine1febfef2018-04-30 11:54:39 +02001949 * set during the current handshake. If
1950 * mbedtls_ssl_set_async_operation_data() has not yet been
1951 * called during the current handshake, this function returns
1952 * \c NULL.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001953 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001954void *mbedtls_ssl_get_async_operation_data( const mbedtls_ssl_context *ssl );
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001955
1956/**
1957 * \brief Retrieve the asynchronous operation user context.
1958 *
1959 * \note This function may only be called while a handshake
1960 * is in progress.
1961 *
1962 * \param ssl The SSL context to access.
1963 * \param ctx The new value of the asynchronous operation user context.
Gilles Peskine1febfef2018-04-30 11:54:39 +02001964 * Call mbedtls_ssl_get_async_operation_data() later during the
1965 * same handshake to retrieve this value.
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001966 */
Gilles Peskine1febfef2018-04-30 11:54:39 +02001967void mbedtls_ssl_set_async_operation_data( mbedtls_ssl_context *ssl,
Gilles Peskinedf13d5c2018-04-25 20:39:48 +02001968 void *ctx );
Gilles Peskineb74a1c72018-04-24 13:09:22 +02001969#endif /* MBEDTLS_SSL_ASYNC_PRIVATE */
Gilles Peskine8bf79f62018-01-05 21:11:53 +01001970
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001971/**
1972 * \brief Callback type: generate a cookie
1973 *
1974 * \param ctx Context for the callback
1975 * \param p Buffer to write to,
1976 * must be updated to point right after the cookie
1977 * \param end Pointer to one past the end of the output buffer
1978 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001979 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001980 * \param ilen Length of info in bytes
1981 *
1982 * \return The callback must return 0 on success,
1983 * or a negative error code.
1984 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001985typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001986 unsigned char **p, unsigned char *end,
1987 const unsigned char *info, size_t ilen );
1988
1989/**
1990 * \brief Callback type: verify a cookie
1991 *
1992 * \param ctx Context for the callback
1993 * \param cookie Cookie to verify
1994 * \param clen Length of cookie
1995 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001996 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001997 * \param ilen Length of info in bytes
1998 *
1999 * \return The callback must return 0 if cookie is valid,
2000 * or a negative error code.
2001 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002002typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002003 const unsigned char *cookie, size_t clen,
2004 const unsigned char *info, size_t ilen );
2005
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002006#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002007/**
2008 * \brief Register callbacks for DTLS cookies
2009 * (Server only. DTLS only.)
2010 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002011 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02002012 * register working callbacks (and initialize their context).
2013 *
2014 * To disable HelloVerifyRequest, register NULL callbacks.
2015 *
2016 * \warning Disabling hello verification allows your server to be used
2017 * for amplification in DoS attacks against other hosts.
2018 * Only disable if you known this can't happen in your
2019 * particular environment.
2020 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002021 * \note See comments on \c mbedtls_ssl_handshake() about handling
2022 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
2023 * on the first handshake attempt when this is enabled.
2024 *
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02002025 * \note This is also necessary to handle client reconnection from
2026 * the same port as described in RFC 6347 section 4.2.8 (only
2027 * the variant with cookies is supported currently). See
2028 * comments on \c mbedtls_ssl_read() for details.
2029 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002030 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002031 * \param f_cookie_write Cookie write callback
2032 * \param f_cookie_check Cookie check callback
2033 * \param p_cookie Context for both callbacks
2034 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002035void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036 mbedtls_ssl_cookie_write_t *f_cookie_write,
2037 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02002038 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002039
2040/**
2041 * \brief Set client's transport-level identification info.
2042 * (Server only. DTLS only.)
2043 *
2044 * This is usually the IP address (and port), but could be
2045 * anything identify the client depending on the underlying
2046 * network stack. Used for HelloVerifyRequest with DTLS.
2047 * This is *not* used to route the actual packets.
2048 *
2049 * \param ssl SSL context
2050 * \param info Transport-level info identifying the client (eg IP + port)
2051 * \param ilen Length of info in bytes
2052 *
2053 * \note An internal copy is made, so the info buffer can be reused.
2054 *
2055 * \return 0 on success,
2056 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002057 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02002058 */
2059int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
2060 const unsigned char *info,
2061 size_t ilen );
2062
2063#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02002064
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002065#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002066/**
2067 * \brief Enable or disable anti-replay protection for DTLS.
2068 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002069 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002070 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002071 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02002073 *
2074 * \warning Disabling this is a security risk unless the application
2075 * protocol handles duplicated packets in a safe way. You
2076 * should not disable this without careful consideration.
2077 * However, if your application already detects duplicated
2078 * packets and needs information about them to adjust its
2079 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002080 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002081void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002082#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002083
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002084#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002085/**
2086 * \brief Set a limit on the number of records with a bad MAC
2087 * before terminating the connection.
2088 * (DTLS only, no effect on TLS.)
2089 * Default: 0 (disabled).
2090 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002091 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002092 * \param limit Limit, or 0 to disable.
2093 *
2094 * \note If the limit is N, then the connection is terminated when
2095 * the Nth non-authentic record is seen.
2096 *
2097 * \note Records with an invalid header are not counted, only the
2098 * ones going through the authentication-decryption phase.
2099 *
2100 * \note This is a security trade-off related to the fact that it's
2101 * often relatively easy for an active attacker ot inject UDP
2102 * datagrams. On one hand, setting a low limit here makes it
2103 * easier for such an attacker to forcibly terminated a
2104 * connection. On the other hand, a high limit or no limit
2105 * might make us waste resources checking authentication on
2106 * many bogus packets.
2107 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002108void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002109#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02002110
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002111#if defined(MBEDTLS_SSL_PROTO_DTLS)
Hanno Becker04da1892018-08-14 13:22:10 +01002112
2113/**
2114 * \brief Allow or disallow packing of multiple handshake records
2115 * within a single datagram.
2116 *
2117 * \param ssl The SSL context to configure.
2118 * \param allow_packing This determines whether datagram packing may
2119 * be used or not. A value of \c 0 means that every
2120 * record will be sent in a separate datagram; a
2121 * value of \c 1 means that, if space permits,
2122 * multiple handshake messages (including CCS) belonging to
2123 * a single flight may be packed within a single datagram.
2124 *
2125 * \note This is enabled by default and should only be disabled
2126 * for test purposes, or if datagram packing causes
2127 * interoperability issues with peers that don't support it.
2128 *
2129 * \note Allowing datagram packing reduces the network load since
2130 * there's less overhead if multiple messages share the same
2131 * datagram. Also, it increases the handshake efficiency
2132 * since messages belonging to a single datagram will not
2133 * be reordered in transit, and so future message buffering
2134 * or flight retransmission (if no buffering is used) as
2135 * means to deal with reordering are needed less frequently.
2136 *
Hanno Beckereb570082018-08-24 11:28:35 +01002137 * \note Application records are not affected by this option and
Hanno Becker04da1892018-08-14 13:22:10 +01002138 * are currently always sent in separate datagrams.
2139 *
2140 */
Hanno Becker1841b0a2018-08-24 11:13:57 +01002141void mbedtls_ssl_set_datagram_packing( mbedtls_ssl_context *ssl,
2142 unsigned allow_packing );
Hanno Becker04da1892018-08-14 13:22:10 +01002143
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002144/**
Aaron Jonesd96e5262016-06-17 14:40:41 +00002145 * \brief Set retransmit timeout values for the DTLS handshake.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002146 * (DTLS only, no effect on TLS.)
2147 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002148 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002149 * \param min Initial timeout value in milliseconds.
2150 * Default: 1000 (1 second).
2151 * \param max Maximum timeout value in milliseconds.
2152 * Default: 60000 (60 seconds).
2153 *
2154 * \note Default values are from RFC 6347 section 4.2.4.1.
2155 *
Manuel Pégourié-Gonnardedb1a482016-01-29 16:05:55 +01002156 * \note The 'min' value should typically be slightly above the
2157 * expected round-trip time to your peer, plus whatever time
2158 * it takes for the peer to process the message. For example,
2159 * if your RTT is about 600ms and you peer needs up to 1s to
2160 * do the cryptographic operations in the handshake, then you
2161 * should set 'min' slightly above 1600. Lower values of 'min'
2162 * might cause spurious resends which waste network resources,
2163 * while larger value of 'min' will increase overall latency
2164 * on unreliable network links.
2165 *
2166 * \note The more unreliable your network connection is, the larger
2167 * your max / min ratio needs to be in order to achieve
2168 * reliable handshakes.
2169 *
2170 * \note Messages are retransmitted up to log2(ceil(max/min)) times.
2171 * For example, if min = 1s and max = 5s, the retransmit plan
2172 * goes: send ... 1s -> resend ... 2s -> resend ... 4s ->
2173 * resend ... 5s -> give up and return a timeout error.
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02002174 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002175void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002176#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02002177
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01002178#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002179/**
Paul Bakker0a597072012-09-25 21:55:46 +00002180 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01002181 * If not set, no session resuming is done (except if session
2182 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00002183 *
Paul Bakker0a597072012-09-25 21:55:46 +00002184 * The session cache has the responsibility to check for stale
2185 * entries based on timeout. See RFC 5246 for recommendations.
2186 *
2187 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
2188 * connection shutdown, so do not cache the pointer! Either set
2189 * it to NULL or make a full copy of the certificate.
2190 *
2191 * The get callback is called once during the initial handshake
2192 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002193 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00002194 * If a valid entry is found, it should fill the master of
2195 * the session object with the cached values and return 0,
2196 * return 1 otherwise. Optionally peer_cert can be set as well
2197 * if it is properly present in cache entry.
2198 *
2199 * The set callback is called once during the initial handshake
2200 * to enable session resuming after the entire handshake has
2201 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002202 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00002203 * should create a cache entry for future retrieval based on
2204 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002205 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00002206 * data) is cleared by the SSL/TLS layer when the connection is
2207 * terminated. It is recommended to add metadata to determine if
2208 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00002209 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00002210 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002211 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002212 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00002213 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00002214 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00002215 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002216void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01002217 void *p_cache,
2218 int (*f_get_cache)(void *, mbedtls_ssl_session *),
2219 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002220#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002221
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002222#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00002223/**
Paul Bakker0a597072012-09-25 21:55:46 +00002224 * \brief Request resumption of session (client-side only)
2225 * Session data is copied from presented session structure.
2226 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002227 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002228 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02002229 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002230 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002231 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002232 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02002233 * arguments are otherwise invalid
2234 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002235 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00002236 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002237int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
2238#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002239
2240/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002241 * \brief Set the list of allowed ciphersuites and the preference
2242 * order. First in the list has the highest preference.
Aaron Jonesd96e5262016-06-17 14:40:41 +00002243 * (Overrides all version-specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00002244 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002245 * The ciphersuites array is not copied, and must remain
2246 * valid for the lifetime of the ssl_config.
2247 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00002248 * Note: The server uses its own preferences
2249 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002250 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002251 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002252 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00002253 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00002254 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002255void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002256 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00002257
2258/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01002259 * \brief Set the list of allowed ciphersuites and the
2260 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002261 * (Only useful on the server side)
2262 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002263 * The ciphersuites array is not copied, and must remain
2264 * valid for the lifetime of the ssl_config.
2265 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002266 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002267 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002268 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002269 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002270 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2271 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2272 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01002273 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002274 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
2275 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002276 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002277void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002278 const int *ciphersuites,
2279 int major, int minor );
2280
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002281#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02002282/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002283 * \brief Set the X.509 security profile used for verification
2284 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002285 * \note The restrictions are enforced for all certificates in the
2286 * chain. However, signatures in the handshake are not covered
2287 * by this setting but by \b mbedtls_ssl_conf_sig_hashes().
2288 *
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002289 * \param conf SSL configuration
2290 * \param profile Profile to use
2291 */
2292void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
Nicholas Wilson2088e2e2015-09-08 16:53:18 +01002293 const mbedtls_x509_crt_profile *profile );
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02002294
2295/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002296 * \brief Set the data required to verify peer certificate
2297 *
Manuel Pégourié-Gonnard7766a2c2017-08-21 10:57:57 +02002298 * \note See \c mbedtls_x509_crt_verify() for notes regarding the
Manuel Pégourié-Gonnarda4a206e2017-06-21 09:35:44 +02002299 * parameters ca_chain (maps to trust_ca for that function)
2300 * and ca_crl.
2301 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002302 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002303 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00002304 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00002305 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002306void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002307 mbedtls_x509_crt *ca_chain,
2308 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002309
Hanno Becker8bf74f32019-03-27 11:01:30 +00002310#if defined(MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK)
2311/**
2312 * \brief Set the trusted certificate callback.
2313 *
2314 * This API allows to register the set of trusted certificates
2315 * through a callback, instead of a linked list as configured
2316 * by mbedtls_ssl_conf_ca_chain().
2317 *
2318 * This is useful for example in contexts where a large number
2319 * of CAs are used, and the inefficiency of maintaining them
2320 * in a linked list cannot be tolerated. It is also useful when
2321 * the set of trusted CAs needs to be modified frequently.
2322 *
2323 * See the documentation of `mbedtls_x509_crt_ca_cb_t` for
2324 * more information.
2325 *
2326 * \param conf The SSL configuration to register the callback with.
2327 * \param f_ca_cb The trusted certificate callback to use when verifying
2328 * certificate chains.
2329 * \param p_ca_cb The context to be passed to \p f_ca_cb (for example,
2330 * a reference to a trusted CA database).
2331 *
2332 * \note This API is incompatible with mbedtls_ssl_conf_ca_chain():
2333 * Any call to this function overwrites the values set through
2334 * earlier calls to mbedtls_ssl_conf_ca_chain() or
2335 * mbedtls_ssl_conf_ca_cb().
2336 *
2337 * \note This API is incompatible with CA indication in
2338 * CertificateRequest messages: A server-side SSL context which
2339 * is bound to an SSL configuration that uses a CA callback
2340 * configured via mbedtls_ssl_conf_ca_cb(), and which requires
2341 * client authentication, will send an empty CA list in the
2342 * corresponding CertificateRequest message.
2343 *
2344 * \note This API is incompatible with mbedtls_ssl_set_hs_ca_chain():
2345 * If an SSL context is bound to an SSL configuration which uses
2346 * CA callbacks configured via mbedtls_ssl_conf_ca_cb(), then
2347 * calls to mbedtls_ssl_set_hs_ca_chain() have no effect.
2348 *
2349 * \note The use of this API disables the use of restartable ECC
2350 * during X.509 CRT signature verification (but doesn't affect
2351 * other uses).
2352 *
2353 * \warning This API is incompatible with the use of CRLs. Any call to
2354 * mbedtls_ssl_conf_ca_cb() unsets CRLs configured through
2355 * earlier calls to mbedtls_ssl_conf_ca_chain().
2356 *
2357 * \warning In multi-threaded environments, the callback \p f_ca_cb
2358 * must be thread-safe, and it is the user's responsibility
Janos Follathd7ecbd62019-04-05 14:52:17 +01002359 * to guarantee this (for example through a mutex
Hanno Becker8bf74f32019-03-27 11:01:30 +00002360 * contained in the callback context pointed to by \p p_ca_cb).
2361 */
2362void mbedtls_ssl_conf_ca_cb( mbedtls_ssl_config *conf,
2363 mbedtls_x509_crt_ca_cb_t f_ca_cb,
2364 void *p_ca_cb );
2365#endif /* MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK */
2366
Paul Bakker5121ce52009-01-03 21:22:43 +00002367/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002368 * \brief Set own certificate chain and private key
2369 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002370 * \note own_cert should contain in order from the bottom up your
2371 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002372 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00002373 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002374 * \note On server, this function can be called multiple times to
2375 * provision more than one cert/key pair (eg one ECDSA, one
2376 * RSA with SHA-256, one RSA with SHA-1). An adequate
2377 * certificate will be selected according to the client's
Antonin Décimo36e89b52019-01-23 15:24:37 +01002378 * advertised capabilities. In case multiple certificates are
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002379 * adequate, preference is given to the one set by the first
2380 * call to this function, then second, etc.
2381 *
Manuel Pégourié-Gonnardd1b7f2b2016-02-24 14:13:22 +00002382 * \note On client, only the first call has any effect. That is,
2383 * only one client certificate can be provisioned. The
2384 * server's preferences in its CertficateRequest message will
2385 * be ignored and our only cert will be sent regardless of
2386 * whether it matches those preferences - the server can then
2387 * decide what it wants to do with it.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002388 *
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05002389 * \note The provided \p pk_key needs to match the public key in the
2390 * first certificate in \p own_cert, or all handshakes using
2391 * that certificate will fail. It is your responsibility
2392 * to ensure that; this function will not perform any check.
2393 * You may use mbedtls_pk_check_pair() in order to perform
2394 * this check yourself, but be aware that this function can
2395 * be computationally expensive on some key types.
2396 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02002397 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01002398 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02002399 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02002400 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002401 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00002402 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002403int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02002404 mbedtls_x509_crt *own_cert,
2405 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002406#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00002407
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002408#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002409/**
Hanno Becker02283042018-10-22 15:28:02 +01002410 * \brief Configure a pre-shared key (PSK) and identity
2411 * to be used in PSK-based ciphersuites.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002412 *
2413 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002414 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002415 *
Hanno Becker02283042018-10-22 15:28:02 +01002416 * \warning Currently, clients can only register a single pre-shared key.
Hanno Beckerf9a32872018-11-15 13:18:25 +00002417 * Calling this function or mbedtls_ssl_conf_psk_opaque() more
Hanno Becker02283042018-10-22 15:28:02 +01002418 * than once will overwrite values configured in previous calls.
Simon Butcherc0957bd2016-03-01 13:16:57 +00002419 * Support for setting multiple PSKs on clients and selecting
Hanno Becker02283042018-10-22 15:28:02 +01002420 * one based on the identity hint is not a planned feature,
2421 * but feedback is welcomed.
Manuel Pégourié-Gonnard9d624122016-02-22 11:10:14 +01002422 *
Hanno Becker02283042018-10-22 15:28:02 +01002423 * \param conf The SSL configuration to register the PSK with.
2424 * \param psk The pointer to the pre-shared key to use.
2425 * \param psk_len The length of the pre-shared key in bytes.
2426 * \param psk_identity The pointer to the pre-shared key identity.
2427 * \param psk_identity_len The length of the pre-shared key identity
2428 * in bytes.
Paul Bakker6db455e2013-09-18 17:29:31 +02002429 *
Hanno Becker02283042018-10-22 15:28:02 +01002430 * \note The PSK and its identity are copied internally and
2431 * hence need not be preserved by the caller for the lifetime
2432 * of the SSL configuration.
2433 *
2434 * \return \c 0 if successful.
2435 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002436 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002437int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002438 const unsigned char *psk, size_t psk_len,
2439 const unsigned char *psk_identity, size_t psk_identity_len );
2440
Hanno Becker02283042018-10-22 15:28:02 +01002441#if defined(MBEDTLS_USE_PSA_CRYPTO)
2442/**
2443 * \brief Configure an opaque pre-shared key (PSK) and identity
2444 * to be used in PSK-based ciphersuites.
2445 *
2446 * \note This is mainly useful for clients. Servers will usually
2447 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
2448 *
2449 * \warning Currently, clients can only register a single pre-shared key.
2450 * Calling this function or mbedtls_ssl_conf_psk() more than
2451 * once will overwrite values configured in previous calls.
2452 * Support for setting multiple PSKs on clients and selecting
2453 * one based on the identity hint is not a planned feature,
2454 * but feedback is welcomed.
2455 *
2456 * \param conf The SSL configuration to register the PSK with.
2457 * \param psk The identifier of the key slot holding the PSK.
2458 * Until \p conf is destroyed or this function is successfully
Hanno Becker463194d2018-11-05 12:44:15 +00002459 * called again, the key slot \p psk must be populated with a
Andrzej Kurek7deba182019-01-22 06:29:45 -05002460 * key of type PSA_ALG_CATEGORY_KEY_DERIVATION whose policy
Hanno Becker463194d2018-11-05 12:44:15 +00002461 * allows its use for the key derivation algorithm applied
2462 * in the handshake.
Hanno Becker02283042018-10-22 15:28:02 +01002463 * \param psk_identity The pointer to the pre-shared key identity.
2464 * \param psk_identity_len The length of the pre-shared key identity
2465 * in bytes.
2466 *
2467 * \note The PSK identity hint is copied internally and hence need
2468 * not be preserved by the caller for the lifetime of the
2469 * SSL configuration.
2470 *
2471 * \return \c 0 if successful.
2472 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2473 */
2474int mbedtls_ssl_conf_psk_opaque( mbedtls_ssl_config *conf,
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05002475 psa_key_handle_t psk,
Hanno Becker02283042018-10-22 15:28:02 +01002476 const unsigned char *psk_identity,
2477 size_t psk_identity_len );
2478#endif /* MBEDTLS_USE_PSA_CRYPTO */
Paul Bakker6db455e2013-09-18 17:29:31 +02002479
2480/**
Hanno Becker02283042018-10-22 15:28:02 +01002481 * \brief Set the pre-shared Key (PSK) for the current handshake.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002482 *
2483 * \note This should only be called inside the PSK callback,
Hanno Becker02283042018-10-22 15:28:02 +01002484 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002485 *
Hanno Becker02283042018-10-22 15:28:02 +01002486 * \param ssl The SSL context to configure a PSK for.
2487 * \param psk The pointer to the pre-shared key.
2488 * \param psk_len The length of the pre-shared key in bytes.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002489 *
Hanno Becker02283042018-10-22 15:28:02 +01002490 * \return \c 0 if successful.
2491 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002492 */
2493int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
2494 const unsigned char *psk, size_t psk_len );
2495
Hanno Becker02283042018-10-22 15:28:02 +01002496#if defined(MBEDTLS_USE_PSA_CRYPTO)
2497/**
2498 * \brief Set an opaque pre-shared Key (PSK) for the current handshake.
2499 *
2500 * \note This should only be called inside the PSK callback,
2501 * i.e. the function passed to \c mbedtls_ssl_conf_psk_cb().
2502 *
2503 * \param ssl The SSL context to configure a PSK for.
2504 * \param psk The identifier of the key slot holding the PSK.
2505 * For the duration of the current handshake, the key slot
2506 * must be populated with a key of type
Andrzej Kurek7deba182019-01-22 06:29:45 -05002507 * PSA_ALG_CATEGORY_KEY_DERIVATION whose policy allows its
Hanno Becker02283042018-10-22 15:28:02 +01002508 * use for the key derivation algorithm
2509 * applied in the handshake.
2510 *
2511 * \return \c 0 if successful.
2512 * \return An \c MBEDTLS_ERR_SSL_XXX error code on failure.
2513 */
2514int mbedtls_ssl_set_hs_psk_opaque( mbedtls_ssl_context *ssl,
Andrzej Kurek2349c4d2019-01-08 09:36:01 -05002515 psa_key_handle_t psk );
Hanno Becker02283042018-10-22 15:28:02 +01002516#endif /* MBEDTLS_USE_PSA_CRYPTO */
2517
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002518/**
2519 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02002520 *
2521 * If set, the PSK callback is called for each
Hanno Becker02283042018-10-22 15:28:02 +01002522 * handshake where a PSK-based ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01002523 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02002524 * receive the actual PSK data and length.
2525 *
Hanno Becker02283042018-10-22 15:28:02 +01002526 * The callback has the following parameters:
2527 * - \c void*: The opaque pointer \p p_psk.
2528 * - \c mbedtls_ssl_context*: The SSL context to which
2529 * the operation applies.
2530 * - \c const unsigned char*: The PSK identity
2531 * selected by the client.
2532 * - \c size_t: The length of the PSK identity
2533 * selected by the client.
2534 *
Paul Bakker6db455e2013-09-18 17:29:31 +02002535 * If a valid PSK identity is found, the callback should use
Hanno Becker02283042018-10-22 15:28:02 +01002536 * \c mbedtls_ssl_set_hs_psk() or
2537 * \c mbedtls_ssl_set_hs_psk_opaque()
2538 * on the SSL context to set the correct PSK and return \c 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02002539 * Any other return value will result in a denied PSK identity.
2540 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002541 * \note If you set a PSK callback using this function, then you
2542 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002543 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01002544 *
Hanno Becker02283042018-10-22 15:28:02 +01002545 * \param conf The SSL configuration to register the callback with.
2546 * \param f_psk The callback for selecting and setting the PSK based
2547 * in the PSK identity chosen by the client.
2548 * \param p_psk A pointer to an opaque structure to be passed to
2549 * the callback, for example a PSK store.
Paul Bakker6db455e2013-09-18 17:29:31 +02002550 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002551void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002552 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02002553 size_t),
2554 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002555#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02002556
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01002557#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Hanno Becker470a8c42017-10-04 15:28:46 +01002558
2559#if !defined(MBEDTLS_DEPRECATED_REMOVED)
2560
2561#if defined(MBEDTLS_DEPRECATED_WARNING)
2562#define MBEDTLS_DEPRECATED __attribute__((deprecated))
2563#else
2564#define MBEDTLS_DEPRECATED
2565#endif
2566
Paul Bakker5121ce52009-01-03 21:22:43 +00002567/**
2568 * \brief Set the Diffie-Hellman public P and G values,
2569 * read as hexadecimal strings (server-side only)
Hanno Becker5a7c35d2017-10-04 13:32:12 +01002570 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00002571 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002572 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00002573 * \param dhm_P Diffie-Hellman-Merkle modulus
2574 * \param dhm_G Diffie-Hellman-Merkle generator
2575 *
Hanno Becker470a8c42017-10-04 15:28:46 +01002576 * \deprecated Superseded by \c mbedtls_ssl_conf_dh_param_bin.
2577 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002578 * \return 0 if successful
2579 */
Hanno Becker470a8c42017-10-04 15:28:46 +01002580MBEDTLS_DEPRECATED int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf,
2581 const char *dhm_P,
2582 const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00002583
Hanno Becker470a8c42017-10-04 15:28:46 +01002584#endif /* MBEDTLS_DEPRECATED_REMOVED */
Hanno Beckera90658f2017-10-04 15:29:08 +01002585
2586/**
2587 * \brief Set the Diffie-Hellman public P and G values
2588 * from big-endian binary presentations.
2589 * (Default values: MBEDTLS_DHM_RFC3526_MODP_2048_[PG]_BIN)
2590 *
2591 * \param conf SSL configuration
2592 * \param dhm_P Diffie-Hellman-Merkle modulus in big-endian binary form
2593 * \param P_len Length of DHM modulus
2594 * \param dhm_G Diffie-Hellman-Merkle generator in big-endian binary form
2595 * \param G_len Length of DHM generator
2596 *
2597 * \return 0 if successful
2598 */
2599int mbedtls_ssl_conf_dh_param_bin( mbedtls_ssl_config *conf,
2600 const unsigned char *dhm_P, size_t P_len,
2601 const unsigned char *dhm_G, size_t G_len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002602
2603/**
Paul Bakker1b57b062011-01-06 15:48:19 +00002604 * \brief Set the Diffie-Hellman public P and G values,
2605 * read from existing context (server-side only)
2606 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002607 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00002608 * \param dhm_ctx Diffie-Hellman-Merkle context
2609 *
2610 * \return 0 if successful
2611 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002612int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02002613#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00002614
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02002615#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
2616/**
2617 * \brief Set the minimum length for Diffie-Hellman parameters.
2618 * (Client-side only.)
2619 * (Default: 1024 bits.)
2620 *
2621 * \param conf SSL configuration
2622 * \param bitlen Minimum bit length of the DHM prime
2623 */
2624void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
2625 unsigned int bitlen );
2626#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
2627
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002628#if defined(MBEDTLS_ECP_C)
Gergely Budai987bfb52014-01-19 21:48:42 +01002629/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002630 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01002631 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01002632 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002633 * On server: this only affects selection of the ECDHE curve;
2634 * the curves used for ECDH and ECDSA are determined by the
2635 * list of available certificates instead.
2636 *
2637 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01002638 * use. The server can override our preference order.
2639 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002640 * Both sides: limits the set of curves accepted for use in
2641 * ECDHE and in the peer's end-entity certificate.
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002642 *
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002643 * \note This has no influence on which curves are allowed inside the
Manuel Pégourié-Gonnard27716cc2015-06-17 11:49:39 +02002644 * certificate chains, see \c mbedtls_ssl_conf_cert_profile()
Manuel Pégourié-Gonnard65eefc82015-10-23 14:08:48 +02002645 * for that. For the end-entity certificate however, the key
2646 * will be accepted only if it is allowed both by this list
2647 * and by the cert profile.
Gergely Budai987bfb52014-01-19 21:48:42 +01002648 *
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002649 * \note This list should be ordered by decreasing preference
2650 * (preferred curve first).
2651 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002652 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01002653 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002654 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01002655 */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002656void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf,
2657 const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnardb541da62015-06-17 11:43:30 +02002658#endif /* MBEDTLS_ECP_C */
Gergely Budai987bfb52014-01-19 21:48:42 +01002659
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002660#if defined(MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002661/**
2662 * \brief Set the allowed hashes for signatures during the handshake.
Manuel Pégourié-Gonnard47229c72015-12-04 15:02:56 +01002663 * (Default: all available hashes except MD5.)
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002664 *
2665 * \note This only affects which hashes are offered and can be used
2666 * for signatures during the handshake. Hashes for message
2667 * authentication and the TLS PRF are controlled by the
2668 * ciphersuite, see \c mbedtls_ssl_conf_ciphersuites(). Hashes
2669 * used for certificate signature are controlled by the
2670 * verification profile, see \c mbedtls_ssl_conf_cert_profile().
2671 *
2672 * \note This list should be ordered by decreasing preference
2673 * (preferred hash first).
2674 *
2675 * \param conf SSL configuration
2676 * \param hashes Ordered list of allowed signature hashes,
2677 * terminated by \c MBEDTLS_MD_NONE.
2678 */
2679void mbedtls_ssl_conf_sig_hashes( mbedtls_ssl_config *conf,
2680 const int *hashes );
Manuel Pégourié-Gonnarde5f30722015-10-22 17:01:15 +02002681#endif /* MBEDTLS_KEY_EXCHANGE__WITH_CERT__ENABLED */
Manuel Pégourié-Gonnard36a8b572015-06-17 12:43:26 +02002682
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002683#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00002684/**
Darryl Green11999bb2018-03-13 15:22:58 +00002685 * \brief Set or reset the hostname to check against the received
2686 * server certificate. It sets the ServerName TLS extension,
Hanno Becker0446a392017-04-07 12:59:32 +01002687 * too, if that extension is enabled. (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02002688 *
Paul Bakker5121ce52009-01-03 21:22:43 +00002689 * \param ssl SSL context
Hanno Becker0446a392017-04-07 12:59:32 +01002690 * \param hostname the server hostname, may be NULL to clear hostname
Darryl Green11999bb2018-03-13 15:22:58 +00002691
Hanno Becker0446a392017-04-07 12:59:32 +01002692 * \note Maximum hostname length MBEDTLS_SSL_MAX_HOST_NAME_LEN.
Paul Bakker5121ce52009-01-03 21:22:43 +00002693 *
Darryl Green11999bb2018-03-13 15:22:58 +00002694 * \return 0 if successful, MBEDTLS_ERR_SSL_ALLOC_FAILED on
2695 * allocation failure, MBEDTLS_ERR_SSL_BAD_INPUT_DATA on
Hanno Becker0446a392017-04-07 12:59:32 +01002696 * too long input hostname.
2697 *
Hanno Becker1a9a51c2017-04-07 13:02:16 +01002698 * Hostname set to the one provided on success (cleared
Darryl Green11999bb2018-03-13 15:22:58 +00002699 * when NULL). On allocation failure hostname is cleared.
Hanno Becker0446a392017-04-07 12:59:32 +01002700 * On too long input failure, old hostname is unchanged.
Paul Bakker5121ce52009-01-03 21:22:43 +00002701 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002702int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002703#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00002704
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01002705#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00002706/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002707 * \brief Set own certificate and key for the current handshake
2708 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002709 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002710 * the SNI callback.
2711 *
2712 * \param ssl SSL context
2713 * \param own_cert own public certificate chain
2714 * \param pk_key own private key
2715 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02002716 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02002717 */
2718int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
2719 mbedtls_x509_crt *own_cert,
2720 mbedtls_pk_context *pk_key );
2721
2722/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002723 * \brief Set the data required to verify peer certificate for the
2724 * current handshake
2725 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002726 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002727 * the SNI callback.
2728 *
2729 * \param ssl SSL context
2730 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
2731 * \param ca_crl trusted CA CRLs
2732 */
2733void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
2734 mbedtls_x509_crt *ca_chain,
2735 mbedtls_x509_crl *ca_crl );
2736
2737/**
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002738 * \brief Set authmode for the current handshake.
2739 *
2740 * \note Same as \c mbedtls_ssl_conf_authmode() but for use within
2741 * the SNI callback.
2742 *
2743 * \param ssl SSL context
2744 * \param authmode MBEDTLS_SSL_VERIFY_NONE, MBEDTLS_SSL_VERIFY_OPTIONAL or
2745 * MBEDTLS_SSL_VERIFY_REQUIRED
2746 */
2747void mbedtls_ssl_set_hs_authmode( mbedtls_ssl_context *ssl,
2748 int authmode );
2749
2750/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00002751 * \brief Set server side ServerName TLS extension callback
2752 * (optional, server-side only).
2753 *
2754 * If set, the ServerName callback is called whenever the
2755 * server receives a ServerName TLS extension from the client
2756 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002757 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002758 * const unsigned char *hostname, size_t len). If a suitable
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002759 * certificate is found, the callback must set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02002760 * certificate(s) and key(s) to use with \c
2761 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
Manuel Pégourié-Gonnardcdc26ae2015-06-19 12:16:31 +02002762 * and may optionally adjust the CA and associated CRL with \c
2763 * mbedtls_ssl_set_hs_ca_chain() as well as the client
2764 * authentication mode with \c mbedtls_ssl_set_hs_authmode(),
2765 * then must return 0. If no matching name is found, the
2766 * callback must either set a default cert, or
2767 * return non-zero to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00002768 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002769 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00002770 * \param f_sni verification function
2771 * \param p_sni verification parameter
2772 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002773void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002774 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00002775 size_t),
2776 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002777#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00002778
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002779#if defined(MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED)
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002780/**
2781 * \brief Set the EC J-PAKE password for current handshake.
2782 *
2783 * \note An internal copy is made, and destroyed as soon as the
2784 * handshake is completed, or when the SSL context is reset or
2785 * freed.
2786 *
2787 * \note The SSL context needs to be already set up. The right place
2788 * to call this function is between \c mbedtls_ssl_setup() or
2789 * \c mbedtls_ssl_reset() and \c mbedtls_ssl_handshake().
2790 *
2791 * \param ssl SSL context
2792 * \param pw EC J-PAKE password (pre-shared secret)
2793 * \param pw_len length of pw in bytes
2794 *
2795 * \return 0 on success, or a negative error code.
2796 */
2797int mbedtls_ssl_set_hs_ecjpake_password( mbedtls_ssl_context *ssl,
2798 const unsigned char *pw,
2799 size_t pw_len );
Manuel Pégourié-Gonnardeef142d2015-09-16 10:05:04 +02002800#endif /*MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED */
Manuel Pégourié-Gonnard7002f4a2015-09-15 12:43:43 +02002801
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002802#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002803/**
2804 * \brief Set the supported Application Layer Protocols.
2805 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002806 * \param conf SSL configuration
Simon Butcher157cb652016-02-13 23:19:04 +00002807 * \param protos Pointer to a NULL-terminated list of supported protocols,
2808 * in decreasing preference order. The pointer to the list is
2809 * recorded by the library for later reference as required, so
Aaron Jonesd96e5262016-06-17 14:40:41 +00002810 * the lifetime of the table must be atleast as long as the
2811 * lifetime of the SSL configuration structure.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02002812 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002813 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002814 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002815int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002816
2817/**
2818 * \brief Get the name of the negotiated Application Layer Protocol.
2819 * This function should be called after the handshake is
2820 * completed.
2821 *
2822 * \param ssl SSL context
2823 *
2824 * \return Protcol name, or NULL if no protocol was negotiated.
2825 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002826const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
2827#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02002828
Paul Bakker5701cdc2012-09-27 21:49:42 +00002829/**
Paul Bakker490ecc82011-10-06 13:04:09 +00002830 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02002831 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002832 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02002833 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002834 * \note This ignores ciphersuites from higher versions.
2835 *
2836 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2837 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002838 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002839 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002840 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2841 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2842 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2843 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00002844 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002845void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00002846
Paul Bakker1d29fb52012-09-28 13:28:45 +00002847/**
2848 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02002849 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02002850 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01002851 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
2852 * SSL_MIN_XXXXX_VERSION range is ignored.
2853 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002854 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00002855 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002856 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
2857 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
2858 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002859 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002860 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
2861 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
2862 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
2863 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00002864 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02002865void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00002866
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002867#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002868/**
2869 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002870 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002871 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002872 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002873 * connection, that is a connection with max_version set to a
2874 * lower value than the value you're willing to use. Such
2875 * fallback connections are not recommended but are sometimes
2876 * necessary to interoperate with buggy (version-intolerant)
2877 * servers.
2878 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002879 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002880 * non-fallback connections! This would appear to work for a
2881 * while, then cause failures when the server is upgraded to
2882 * support a newer TLS version.
2883 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01002884 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002885 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002886 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002887void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002888#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02002889
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002890#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002891/**
2892 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002893 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002894 *
2895 * \note This should always be enabled, it is a security
2896 * improvement, and should not cause any interoperability
2897 * issue (used only if the peer supports it too).
2898 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002899 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002900 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002901 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002902void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002903#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01002904
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002905#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002906/**
2907 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002908 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002909 *
2910 * \note This should always be enabled, it is a security fix to the
2911 * protocol, and should not cause any interoperability issue
2912 * (used only if the peer supports it too).
2913 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002914 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002915 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002916 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002917void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002918#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02002919
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002920#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002921/**
2922 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002923 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002924 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00002925 * \warning Use of RC4 in DTLS/TLS has been prohibited by RFC 7465
Simon Butcher68c0bd72016-02-13 22:44:49 +00002926 * for security reasons. Use at your own risk.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002927 *
Simon Butcher68c0bd72016-02-13 22:44:49 +00002928 * \note This function is deprecated and will likely be removed in
2929 * a future version of the library.
2930 * RC4 is disabled by default at compile time and needs to be
2931 * actively enabled for use with legacy systems.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002932 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002933 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002934 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002935 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002936void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02002937#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01002938
Janos Follath088ce432017-04-10 12:42:31 +01002939#if defined(MBEDTLS_SSL_SRV_C)
2940/**
2941 * \brief Whether to send a list of acceptable CAs in
2942 * CertificateRequest messages.
2943 * (Default: do send)
2944 *
2945 * \param conf SSL configuration
2946 * \param cert_req_ca_list MBEDTLS_SSL_CERT_REQ_CA_LIST_ENABLED or
2947 * MBEDTLS_SSL_CERT_REQ_CA_LIST_DISABLED
2948 */
2949void mbedtls_ssl_conf_cert_req_ca_list( mbedtls_ssl_config *conf,
2950 char cert_req_ca_list );
2951#endif /* MBEDTLS_SSL_SRV_C */
2952
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002953#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00002954/**
k-stachowiak6d722122019-02-08 17:03:33 +01002955 * \brief Set the maximum fragment length to emit and/or negotiate.
2956 * (Typical: the smaller of #MBEDTLS_SSL_IN_CONTENT_LEN and
2957 * #MBEDTLS_SSL_OUT_CONTENT_LEN, usually `2^14` bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002958 * (Server: set maximum fragment length to emit,
k-stachowiakeb1bb3d2019-02-04 10:43:40 +01002959 * usually negotiated by the client during handshake)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002960 * (Client: set maximum fragment length to emit *and*
2961 * negotiate with the server during handshake)
Krzysztof Stachowiakabdf1c62019-04-25 16:07:37 +02002962 * (Default: #MBEDTLS_SSL_MAX_FRAG_LEN_NONE)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002963 *
k-stachowiak6d722122019-02-08 17:03:33 +01002964 * \note On the client side, the maximum fragment length extension
2965 * *will not* be used, unless the maximum fragment length has
2966 * been set via this function to a value different than
2967 * #MBEDTLS_SSL_MAX_FRAG_LEN_NONE.
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002968 *
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002969 * \note With TLS, this currently only affects ApplicationData (sent
2970 * with \c mbedtls_ssl_read()), not handshake messages.
2971 * With DTLS, this affects both ApplicationData and handshake.
2972 *
Manuel Pégourié-Gonnard7e89c172018-08-13 12:45:26 +02002973 * \note This sets the maximum length for a record's payload,
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002974 * excluding record overhead that will be added to it, see
2975 * \c mbedtls_ssl_get_record_expansion().
2976 *
2977 * \note For DTLS, it is also possible to set a limit for the total
2978 * size of daragrams passed to the transport layer, including
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02002979 * record overhead, see \c mbedtls_ssl_set_mtu().
Manuel Pégourié-Gonnard0b1d9b22017-09-21 13:15:27 +02002980 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01002981 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02002982 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002983 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
2984 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002985 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02002986 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002987 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002988int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002989#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002990
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002991#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02002992/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01002993 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01002994 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002995 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02002996 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002997 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
2998 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02002999 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02003000void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003001#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003002
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003003#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003004/**
3005 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003006 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003007 *
3008 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
3009 * Does not affect non-CBC ciphersuites in any version.
3010 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01003011 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003012 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
3013 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003014 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003015void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003016#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01003017
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003018#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02003019/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003020 * \brief Enable / Disable session tickets (client only).
3021 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003022 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003023 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003024 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01003025 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003026 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
3027 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003028 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02003029void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
3030#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003032#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02003033/**
Paul Bakker09f097d2012-10-23 11:54:56 +00003034 * \brief Enable / Disable renegotiation support for connection when
3035 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003036 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00003037 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003038 * \warning It is recommended to always disable renegotation unless you
3039 * know you need it and you know what you're doing. In the
Aaron Jonesd96e5262016-06-17 14:40:41 +00003040 * past, there have been several issues associated with
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02003041 * renegotiation or a poor understanding of its properties.
3042 *
3043 * \note Server-side, enabling renegotiation also makes the server
3044 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00003045 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003046 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003047 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
3048 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00003049 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003050void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003051#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003052
3053/**
3054 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003055 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02003056 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003057 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003058 * be established even if the peer does not support
3059 * secure renegotiation, but does not allow renegotiation
3060 * to take place if not secure.
3061 * (Interoperable and secure option)
3062 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003063 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003064 * with non-upgraded peers. Allowing legacy renegotiation
3065 * makes the connection vulnerable to specific man in the
3066 * middle attacks. (See RFC 5746)
3067 * (Most interoperable and least secure option)
3068 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003069 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00003070 * if peer does not support secure renegotiation. Results
3071 * in interoperability issues with non-upgraded peers
3072 * that do not support renegotiation altogether.
3073 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00003074 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003075 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00003076 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
3077 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003078 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00003079 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003080void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00003081
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003082#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00003083/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003084 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003085 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003086 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003087 * When we request a renegotiation, the peer can comply or
3088 * ignore the request. This function allows us to decide
3089 * whether to enforce our renegotiation requests by closing
3090 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003091 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003092 * However, records could already be in transit from the peer
3093 * when the request is emitted. In order to increase
3094 * reliability, we can accept a number of records before the
3095 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003096 *
3097 * The optimal value is highly dependent on the specific usage
3098 * scenario.
3099 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003100 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003101 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02003102 * out or receives Application Data, until:
3103 * - max_records records have beens seen, if it is >= 0, or
3104 * - the number of retransmits that would happen during an
3105 * actual handshake has been reached.
3106 * Please remember the request might be lost a few times
3107 * if you consider setting max_records to a really low value.
3108 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003109 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003110 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003111 * which always behave as if max_record was 0. The reason is,
3112 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003113 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02003114 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003115 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003116 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003117 * enforce renegotiation, or a non-negative value to enforce
3118 * it but allow for a grace period of max_records records.
3119 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003120void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02003121
3122/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003123 * \brief Set record counter threshold for periodic renegotiation.
Andres AG18c5c592016-12-15 17:01:16 +00003124 * (Default: 2^48 - 1)
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003125 *
3126 * Renegotiation is automatically triggered when a record
3127 * counter (outgoing or ingoing) crosses the defined
3128 * threshold. The default value is meant to prevent the
3129 * connection from being closed when the counter is about to
3130 * reached its maximal value (it is not allowed to wrap).
3131 *
3132 * Lower values can be used to enforce policies such as "keys
3133 * must be refreshed every N packets with cipher X".
3134 *
Simon Butcheree75b9b2017-02-03 00:21:28 +00003135 * The renegotiation period can be disabled by setting
3136 * conf->disable_renegotiation to
3137 * MBEDTLS_SSL_RENEGOTIATION_DISABLED.
3138 *
3139 * \note When the configured transport is
3140 * MBEDTLS_SSL_TRANSPORT_DATAGRAM the maximum renegotiation
3141 * period is 2^48 - 1, and for MBEDTLS_SSL_TRANSPORT_STREAM,
3142 * the maximum renegotiation period is 2^64 - 1.
Andres AG18c5c592016-12-15 17:01:16 +00003143 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02003144 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003145 * \param period The threshold value: a big-endian 64-bit number.
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003146 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003147void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01003148 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003149#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00003150
Paul Bakker43ca69c2011-01-15 17:35:19 +00003151/**
Hanno Becker8b170a02017-10-10 11:51:19 +01003152 * \brief Check if there is data already read from the
3153 * underlying transport but not yet processed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003154 *
3155 * \param ssl SSL context
3156 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003157 * \return 0 if nothing's pending, 1 otherwise.
3158 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003159 * \note This is different in purpose and behaviour from
3160 * \c mbedtls_ssl_get_bytes_avail in that it considers
3161 * any kind of unprocessed data, not only unread
3162 * application data. If \c mbedtls_ssl_get_bytes
3163 * returns a non-zero value, this function will
3164 * also signal pending data, but the converse does
3165 * not hold. For example, in DTLS there might be
3166 * further records waiting to be processed from
3167 * the current underlying transport's datagram.
3168 *
Hanno Becker9b19a122017-10-31 13:00:14 +00003169 * \note If this function returns 1 (data pending), this
Hanno Becker8b170a02017-10-10 11:51:19 +01003170 * does not imply that a subsequent call to
3171 * \c mbedtls_ssl_read will provide any data;
3172 * e.g., the unprocessed data might turn out
3173 * to be an alert or a handshake message.
Hanno Becker9b19a122017-10-31 13:00:14 +00003174 *
3175 * \note This function is useful in the following situation:
3176 * If the SSL/TLS module successfully returns from an
3177 * operation - e.g. a handshake or an application record
3178 * read - and you're awaiting incoming data next, you
3179 * must not immediately idle on the underlying transport
3180 * to have data ready, but you need to check the value
3181 * of this function first. The reason is that the desired
3182 * data might already be read but not yet processed.
3183 * If, in contrast, a previous call to the SSL/TLS module
3184 * returned MBEDTLS_ERR_SSL_WANT_READ, it is not necessary
3185 * to call this function, as the latter error code entails
3186 * that all internal data has been processed.
3187 *
Hanno Becker8b170a02017-10-10 11:51:19 +01003188 */
3189int mbedtls_ssl_check_pending( const mbedtls_ssl_context *ssl );
3190
3191/**
3192 * \brief Return the number of application data bytes
3193 * remaining to be read from the current record.
3194 *
3195 * \param ssl SSL context
3196 *
3197 * \return How many bytes are available in the application
3198 * data record read buffer.
3199 *
3200 * \note When working over a datagram transport, this is
3201 * useful to detect the current datagram's boundary
3202 * in case \c mbedtls_ssl_read has written the maximal
3203 * amount of data fitting into the input buffer.
3204 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003205 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003206size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003207
3208/**
3209 * \brief Return the result of the certificate verification
3210 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003211 * \param ssl The SSL context to use.
Paul Bakker5121ce52009-01-03 21:22:43 +00003212 *
Hanno Beckercc40d862018-10-23 10:28:01 +01003213 * \return \c 0 if the certificate verification was successful.
3214 * \return \c -1u if the result is not available. This may happen
3215 * e.g. if the handshake aborts early, or a verification
3216 * callback returned a fatal error.
3217 * \return A bitwise combination of \c MBEDTLS_X509_BADCERT_XXX
3218 * and \c MBEDTLS_X509_BADCRL_XXX failure flags; see x509.h.
Paul Bakker5121ce52009-01-03 21:22:43 +00003219 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02003220uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003221
3222/**
3223 * \brief Return the name of the current ciphersuite
3224 *
3225 * \param ssl SSL context
3226 *
3227 * \return a string containing the ciphersuite name
3228 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003229const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003230
3231/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00003232 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
3233 *
3234 * \param ssl SSL context
3235 *
3236 * \return a string containing the SSL version
3237 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003238const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00003239
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003240/**
3241 * \brief Return the (maximum) number of bytes added by the record
3242 * layer: header + encryption/MAC overhead (inc. padding)
3243 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003244 * \note This function is not available (always returns an error)
3245 * when record compression is enabled.
3246 *
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003247 * \param ssl SSL context
3248 *
3249 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003250 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02003251 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003252 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003253int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02003254
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003255#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
3256/**
3257 * \brief Return the maximum fragment length (payload, in bytes).
3258 * This is the value negotiated with peer if any,
3259 * or the locally configured value.
3260 *
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003261 * \sa mbedtls_ssl_conf_max_frag_len()
3262 * \sa mbedtls_ssl_get_max_record_payload()
Manuel Pégourié-Gonnarda2cda6b2015-08-31 18:30:52 +02003263 *
3264 * \param ssl SSL context
3265 *
3266 * \return Current maximum fragment length.
3267 */
3268size_t mbedtls_ssl_get_max_frag_len( const mbedtls_ssl_context *ssl );
3269#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
3270
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003271/**
3272 * \brief Return the current maximum outgoing record payload in bytes.
3273 * This takes into account the config.h setting \c
3274 * MBEDTLS_SSL_OUT_CONTENT_LEN, the configured and negotiated
3275 * max fragment length extension if used, and for DTLS the
3276 * path MTU as configured and current record expansion.
3277 *
3278 * \note With DTLS, \c mbedtls_ssl_write() will return an error if
3279 * called with a larger length value.
3280 * With TLS, \c mbedtls_ssl_write() will fragment the input if
3281 * necessary and return the number of bytes written; it is up
3282 * to the caller to call \c mbedtls_ssl_write() again in
3283 * order to send the remaining bytes if any.
3284 *
3285 * \note This function is not available (always returns an error)
3286 * when record compression is enabled.
3287 *
Manuel Pégourié-Gonnard6e7aaca2018-08-20 10:37:23 +02003288 * \sa mbedtls_ssl_set_mtu()
Manuel Pégourié-Gonnard9468ff12017-09-21 13:49:50 +02003289 * \sa mbedtls_ssl_get_max_frag_len()
3290 * \sa mbedtls_ssl_get_record_expansion()
3291 *
3292 * \param ssl SSL context
3293 *
3294 * \return Current maximum payload for an outgoing record,
3295 * or a negative error code.
3296 */
3297int mbedtls_ssl_get_max_out_record_payload( const mbedtls_ssl_context *ssl );
3298
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003299#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00003300/**
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003301 * \brief Return the peer certificate from the current connection.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003302 *
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003303 * \param ssl The SSL context to use. This must be initialized and setup.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003304 *
Hanno Becker958efeb2019-02-25 10:13:43 +00003305 * \return The current peer certificate, if available.
3306 * The returned certificate is owned by the SSL context and
3307 * is valid only until the next call to the SSL API.
3308 * \return \c NULL if no peer certificate is available. This might
3309 * be because the chosen ciphersuite doesn't use CRTs
3310 * (PSK-based ciphersuites, for example), or because
3311 * #MBEDTLS_SSL_KEEP_PEER_CERTIFICATE has been disabled,
3312 * allowing the stack to free the peer's CRT to save memory.
Hanno Becker4a82c1c2019-02-05 11:33:12 +00003313 *
3314 * \note For one-time inspection of the peer's certificate during
3315 * the handshake, consider registering an X.509 CRT verification
3316 * callback through mbedtls_ssl_conf_verify() instead of calling
3317 * this function. Using mbedtls_ssl_conf_verify() also comes at
3318 * the benefit of allowing you to influence the verification
3319 * process, for example by masking expected and tolerated
3320 * verification failures.
3321 *
3322 * \warning You must not use the pointer returned by this function
3323 * after any further call to the SSL API, including
3324 * mbedtls_ssl_read() and mbedtls_ssl_write(); this is
3325 * because the pointer might change during renegotiation,
3326 * which happens transparently to the user.
3327 * If you want to use the certificate across API calls,
3328 * you must make a copy.
Paul Bakkerb0550d92012-10-30 07:51:03 +00003329 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003330const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
3331#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00003332
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003333#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00003334/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003335 * \brief Save session in order to resume it later (client-side only)
3336 * Session data is copied to presented session structure.
3337 *
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003338 *
3339 * \param ssl SSL context
3340 * \param session session context
3341 *
3342 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02003343 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003344 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Ron Eldor382c1db2018-07-04 17:42:47 +03003345 * arguments are otherwise invalid.
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003346 *
Ron Eldor00115032018-07-17 11:21:50 +03003347 * \note Only the server certificate is copied, and not the full chain,
3348 * so you should not attempt to validate the certificate again
3349 * by calling \c mbedtls_x509_crt_verify() on it.
3350 * Instead, you should use the results from the verification
3351 * in the original handshake by calling \c mbedtls_ssl_get_verify_result()
3352 * after loading the session again into a new SSL context
3353 * using \c mbedtls_ssl_set_session().
3354 *
3355 * \note Once the session object is not needed anymore, you should
3356 * free it by calling \c mbedtls_ssl_session_free().
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003357 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003358 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003359 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003360int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
3361#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02003362
3363/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003364 * \brief Perform the SSL handshake
3365 *
3366 * \param ssl SSL context
3367 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003368 * \return \c 0 if successful.
3369 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003370 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003371 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003372 * transport - in this case you must call this function again
3373 * when the underlying transport is ready for the operation.
3374 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3375 * operation is in progress (see
3376 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3377 * must call this function again when the operation is ready.
3378 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3379 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3380 * in this case you must call this function again to complete
3381 * the handshake when you're done attending other tasks.
3382 * \return #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED if DTLS is in use
3383 * and the client did not demonstrate reachability yet - in
3384 * this case you must stop using the context (see below).
3385 * \return Another SSL error code - in this case you must stop using
3386 * the context (see below).
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02003387 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003388 * \warning If this function returns something other than
3389 * \c 0,
3390 * #MBEDTLS_ERR_SSL_WANT_READ,
3391 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3392 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3393 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3394 * you must stop using the SSL context for reading or writing,
3395 * and either free it or call \c mbedtls_ssl_session_reset()
3396 * on it before re-using it for a new connection; the current
3397 * connection must be closed.
3398 *
3399 * \note If DTLS is in use, then you may choose to handle
3400 * #MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
3401 * purposes, as it is an expected return value rather than an
3402 * actual error, but you still need to reset/free the context.
Hanno Becker8ec81022017-10-10 10:35:08 +01003403 *
3404 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003405 * If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003406 * from the underlying transport layer is currently being processed,
3407 * and it is safe to idle until the timer or the underlying transport
3408 * signal a new event. This is not true for a successful handshake,
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003409 * in which case the datagram of the underlying transport that is
3410 * currently being processed might or might not contain further
3411 * DTLS records.
Paul Bakker5121ce52009-01-03 21:22:43 +00003412 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003413int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003414
3415/**
Paul Bakker1961b702013-01-25 14:49:24 +01003416 * \brief Perform a single step of the SSL handshake
3417 *
Manuel Pégourié-Gonnard222cb8d2015-09-08 15:43:59 +02003418 * \note The state of the context (ssl->state) will be at
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003419 * the next state after this function returns \c 0. Do not
Aaron Jonesd96e5262016-06-17 14:40:41 +00003420 * call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01003421 *
3422 * \param ssl SSL context
3423 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003424 * \return See mbedtls_ssl_handshake().
3425 *
3426 * \warning If this function returns something other than \c 0,
3427 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3428 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3429 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3430 * the SSL context for reading or writing, and either free it
3431 * or call \c mbedtls_ssl_session_reset() on it before
3432 * re-using it for a new connection; the current connection
3433 * must be closed.
Paul Bakker1961b702013-01-25 14:49:24 +01003434 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003435int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01003436
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003437#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01003438/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01003439 * \brief Initiate an SSL renegotiation on the running connection.
3440 * Client: perform the renegotiation right now.
3441 * Server: request renegotiation, which will be performed
Aaron Jonesd96e5262016-06-17 14:40:41 +00003442 * during the next call to mbedtls_ssl_read() if honored by
3443 * client.
Paul Bakker48916f92012-09-16 19:57:18 +00003444 *
3445 * \param ssl SSL context
3446 *
Aaron Jonesd96e5262016-06-17 14:40:41 +00003447 * \return 0 if successful, or any mbedtls_ssl_handshake() return
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003448 * value except #MBEDTLS_ERR_SSL_CLIENT_RECONNECT that can't
3449 * happen during a renegotiation.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003450 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003451 * \warning If this function returns something other than \c 0,
3452 * #MBEDTLS_ERR_SSL_WANT_READ, #MBEDTLS_ERR_SSL_WANT_WRITE,
3453 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3454 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS, you must stop using
3455 * the SSL context for reading or writing, and either free it
3456 * or call \c mbedtls_ssl_session_reset() on it before
3457 * re-using it for a new connection; the current connection
3458 * must be closed.
3459 *
Paul Bakker48916f92012-09-16 19:57:18 +00003460 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003461int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
3462#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00003463
3464/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003465 * \brief Read at most 'len' application data bytes
3466 *
3467 * \param ssl SSL context
3468 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02003469 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00003470 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003471 * \return The (positive) number of bytes read if successful.
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003472 * \return \c 0 if the read end of the underlying transport was closed
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003473 * - in this case you must stop using the context (see below).
3474 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003475 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003476 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003477 * transport - in this case you must call this function again
3478 * when the underlying transport is ready for the operation.
3479 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3480 * operation is in progress (see
3481 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3482 * must call this function again when the operation is ready.
3483 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3484 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3485 * in this case you must call this function again to complete
3486 * the handshake when you're done attending other tasks.
3487 * \return #MBEDTLS_ERR_SSL_CLIENT_RECONNECT if we're at the server
3488 * side of a DTLS connection and the client is initiating a
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003489 * new connection using the same source port. See below.
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003490 * \return Another SSL error code - in this case you must stop using
3491 * the context (see below).
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003492 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003493 * \warning If this function returns something other than
3494 * a positive value,
3495 * #MBEDTLS_ERR_SSL_WANT_READ,
3496 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3497 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS,
3498 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS or
3499 * #MBEDTLS_ERR_SSL_CLIENT_RECONNECT,
3500 * you must stop using the SSL context for reading or writing,
3501 * and either free it or call \c mbedtls_ssl_session_reset()
3502 * on it before re-using it for a new connection; the current
3503 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003504 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003505 * \note When this function returns #MBEDTLS_ERR_SSL_CLIENT_RECONNECT
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003506 * (which can only happen server-side), it means that a client
3507 * is initiating a new connection using the same source port.
3508 * You can either treat that as a connection close and wait
3509 * for the client to resend a ClientHello, or directly
3510 * continue with \c mbedtls_ssl_handshake() with the same
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003511 * context (as it has been reset internally). Either way, you
3512 * must make sure this is seen by the application as a new
Manuel Pégourié-Gonnard3a2a4482015-09-08 15:36:09 +02003513 * connection: application state, if any, should be reset, and
3514 * most importantly the identity of the client must be checked
3515 * again. WARNING: not validating the identity of the client
3516 * again, or not transmitting the new identity to the
3517 * application layer, would allow authentication bypass!
Hanno Becker8ec81022017-10-10 10:35:08 +01003518 *
Hanno Becker8ec81022017-10-10 10:35:08 +01003519 * \note Remarks regarding event-driven DTLS:
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003520 * - If the function returns #MBEDTLS_ERR_SSL_WANT_READ, no datagram
Hanno Becker8ec81022017-10-10 10:35:08 +01003521 * from the underlying transport layer is currently being processed,
3522 * and it is safe to idle until the timer or the underlying transport
3523 * signal a new event.
Hanno Beckerffb1e1a2017-10-23 13:17:42 +01003524 * - This function may return MBEDTLS_ERR_SSL_WANT_READ even if data was
3525 * initially available on the underlying transport, as this data may have
3526 * been only e.g. duplicated messages or a renegotiation request.
3527 * Therefore, you must be prepared to receive MBEDTLS_ERR_SSL_WANT_READ even
3528 * when reacting to an incoming-data event from the underlying transport.
3529 * - On success, the datagram of the underlying transport that is currently
3530 * being processed may contain further DTLS records. You should call
3531 * \c mbedtls_ssl_check_pending to check for remaining records.
Hanno Becker8ec81022017-10-10 10:35:08 +01003532 *
Paul Bakker5121ce52009-01-03 21:22:43 +00003533 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003534int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003535
3536/**
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003537 * \brief Try to write exactly 'len' application data bytes
3538 *
3539 * \warning This function will do partial writes in some cases. If the
3540 * return value is non-negative but less than length, the
3541 * function must be called again with updated arguments:
3542 * buf + ret, len - ret (if ret is the return value) until
3543 * it returns a value equal to the last 'len' argument.
Paul Bakker5121ce52009-01-03 21:22:43 +00003544 *
3545 * \param ssl SSL context
3546 * \param buf buffer holding the data
3547 * \param len how many bytes must be written
3548 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003549 * \return The (non-negative) number of bytes actually written if
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003550 * successful (may be less than \p len).
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003551 * \return #MBEDTLS_ERR_SSL_WANT_READ or #MBEDTLS_ERR_SSL_WANT_WRITE
Manuel Pégourié-Gonnarda966fde2018-10-23 10:41:11 +02003552 * if the handshake is incomplete and waiting for data to
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003553 * be available for reading from or writing to the underlying
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003554 * transport - in this case you must call this function again
3555 * when the underlying transport is ready for the operation.
3556 * \return #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS if an asynchronous
3557 * operation is in progress (see
3558 * mbedtls_ssl_conf_async_private_cb()) - in this case you
3559 * must call this function again when the operation is ready.
3560 * \return #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS if a cryptographic
3561 * operation is in progress (see mbedtls_ecp_set_max_ops()) -
3562 * in this case you must call this function again to complete
3563 * the handshake when you're done attending other tasks.
3564 * \return Another SSL error code - in this case you must stop using
3565 * the context (see below).
Paul Bakker5121ce52009-01-03 21:22:43 +00003566 *
Manuel Pégourié-Gonnard32df9112018-10-15 13:29:21 +02003567 * \warning If this function returns something other than
3568 * a non-negative value,
3569 * #MBEDTLS_ERR_SSL_WANT_READ,
3570 * #MBEDTLS_ERR_SSL_WANT_WRITE,
3571 * #MBEDTLS_ERR_SSL_ASYNC_IN_PROGRESS or
3572 * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS,
3573 * you must stop using the SSL context for reading or writing,
3574 * and either free it or call \c mbedtls_ssl_session_reset()
3575 * on it before re-using it for a new connection; the current
3576 * connection must be closed.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003577 *
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003578 * \note When this function returns #MBEDTLS_ERR_SSL_WANT_WRITE/READ,
Paul Bakker5121ce52009-01-03 21:22:43 +00003579 * it must be called later with the *same* arguments,
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003580 * until it returns a value greater that or equal to 0. When
Manuel Pégourié-Gonnardca29fdf2018-10-22 09:56:53 +02003581 * the function returns #MBEDTLS_ERR_SSL_WANT_WRITE there may be
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003582 * some partial data in the output buffer, however this is not
3583 * yet sent.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02003584 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00003585 * \note If the requested length is greater than the maximum
3586 * fragment length (either the built-in limit or the one set
3587 * or negotiated with the peer), then:
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003588 * - with TLS, less bytes than requested are written.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003589 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Manuel Pégourié-Gonnard5f5e0ec2015-08-31 20:44:12 +02003590 * \c mbedtls_ssl_get_max_frag_len() may be used to query the
3591 * active maximum fragment length.
Andres Amaya Garcia7ee25d72017-07-11 16:15:54 +01003592 *
3593 * \note Attempting to write 0 bytes will result in an empty TLS
3594 * application record being sent.
Paul Bakker5121ce52009-01-03 21:22:43 +00003595 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003596int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00003597
3598/**
Paul Bakker0a925182012-04-16 06:46:41 +00003599 * \brief Send an alert message
3600 *
3601 * \param ssl SSL context
3602 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003603 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00003604 * \param message The alert message (SSL_ALERT_MSG_*)
3605 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00003606 * \return 0 if successful, or a specific SSL error code.
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003607 *
3608 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003609 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3610 * the SSL context for reading or writing, and either free it or
3611 * call \c mbedtls_ssl_session_reset() on it before re-using it
3612 * for a new connection; the current connection must be closed.
Paul Bakker0a925182012-04-16 06:46:41 +00003613 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003614int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00003615 unsigned char level,
3616 unsigned char message );
3617/**
Paul Bakker5121ce52009-01-03 21:22:43 +00003618 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003619 *
3620 * \param ssl SSL context
Manuel Pégourié-Gonnardacbb0502015-12-10 13:57:27 +01003621 *
3622 * \return 0 if successful, or a specific SSL error code.
3623 *
3624 * \note If this function returns something other than 0 or
Hanno Becker298a7b22017-11-06 10:45:26 +00003625 * MBEDTLS_ERR_SSL_WANT_READ/WRITE, you must stop using
3626 * the SSL context for reading or writing, and either free it or
3627 * call \c mbedtls_ssl_session_reset() on it before re-using it
3628 * for a new connection; the current connection must be closed.
Paul Bakker5121ce52009-01-03 21:22:43 +00003629 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003630int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003631
3632/**
Paul Bakker48916f92012-09-16 19:57:18 +00003633 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00003634 *
3635 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00003636 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003637void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00003638
Paul Bakker48916f92012-09-16 19:57:18 +00003639/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003640 * \brief Initialize an SSL configuration context
3641 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003642 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003643 *
3644 * \note You need to call mbedtls_ssl_config_defaults() unless you
Antonin Décimo36e89b52019-01-23 15:24:37 +01003645 * manually set all of the relevant fields yourself.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003646 *
3647 * \param conf SSL configuration context
3648 */
3649void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
3650
3651/**
3652 * \brief Load reasonnable default SSL configuration values.
3653 * (You need to call mbedtls_ssl_config_init() first.)
3654 *
3655 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003656 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
3657 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
3658 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003659 * \param preset a MBEDTLS_SSL_PRESET_XXX value
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003660 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02003661 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01003662 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003663 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02003664 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003665 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02003666int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardb31c5f62015-06-17 13:53:47 +02003667 int endpoint, int transport, int preset );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02003668
3669/**
3670 * \brief Free an SSL configuration context
3671 *
3672 * \param conf SSL configuration context
3673 */
3674void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
3675
3676/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003677 * \brief Initialize SSL session structure
3678 *
3679 * \param session SSL session
3680 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003681void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02003682
3683/**
Paul Bakker0a597072012-09-25 21:55:46 +00003684 * \brief Free referenced items in an SSL session including the
3685 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00003686 *
Ron Eldor00115032018-07-17 11:21:50 +03003687 * \note A session object can be freed even if the SSL context
3688 * that was used to retrieve the session is still in use.
3689 *
Paul Bakker48916f92012-09-16 19:57:18 +00003690 * \param session SSL session
3691 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02003692void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00003693
Ron Eldor51d3ab52019-05-12 14:54:30 +03003694/**
3695 * \brief TLS-PRF function for key derivation.
3696 *
3697 * \param prf The tls_prf type funtion type to be used.
3698 * \param secret Secret for the key derivation function.
3699 * \param slen Length of the secret.
3700 * \param label String label for the key derivation function,
3701 * terminated with null character.
3702 * \param random Random bytes.
3703 * \param rlen Length of the random bytes buffer.
3704 * \param dstbuf The buffer holding the derived key.
3705 * \param dlen Length of the output buffer.
3706 *
3707 * \return 0 on sucess. An SSL specific error on failure.
3708 */
3709int mbedtls_ssl_tls_prf( const mbedtls_tls_prf_types prf,
3710 const unsigned char *secret, size_t slen,
3711 const char *label,
3712 const unsigned char *random, size_t rlen,
3713 unsigned char *dstbuf, size_t dlen );
3714
Paul Bakker5121ce52009-01-03 21:22:43 +00003715#ifdef __cplusplus
3716}
3717#endif
3718
3719#endif /* ssl.h */