blob: 4bca71c8cdc736a727b353c47803e3c0bf8c3dee [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.
5 *
Manuel Pégourié-Gonnarda658a402015-01-23 09:45:19 +00006 * Copyright (C) 2006-2014, ARM Limited, All Rights Reserved
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
Manuel Pégourié-Gonnardfe446432015-03-06 13:17:10 +00008 * This file is part of mbed TLS (https://tls.mbed.org)
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00009 *
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000010 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Paul Bakker5121ce52009-01-03 21:22:43 +000023 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020024#ifndef MBEDTLS_SSL_H
25#define MBEDTLS_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000026
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020027#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakkered27a042013-04-18 22:46:23 +020028#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020029#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020030#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#endif
Manuel Pégourié-Gonnard03717042014-11-04 19:52:10 +010032
Paul Bakkered27a042013-04-18 22:46:23 +020033#include "bignum.h"
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +020034#include "ecp.h"
Paul Bakkered27a042013-04-18 22:46:23 +020035
Paul Bakker68884e32013-01-07 18:20:04 +010036#include "ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000037
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020038#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker7c6b2c32013-09-16 13:49:26 +020039#include "x509_crt.h"
Paul Bakker7c6b2c32013-09-16 13:49:26 +020040#include "x509_crl.h"
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +020041#endif
Paul Bakkered27a042013-04-18 22:46:23 +020042
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020043#if defined(MBEDTLS_DHM_C)
Paul Bakker48916f92012-09-16 19:57:18 +000044#include "dhm.h"
45#endif
46
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020047#if defined(MBEDTLS_ECDH_C)
Paul Bakker41c83d32013-03-20 14:39:14 +010048#include "ecdh.h"
49#endif
50
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020051#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker2770fbd2012-07-03 13:30:23 +000052#include "zlib.h"
53#endif
54
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020055#if defined(MBEDTLS_HAVE_TIME)
Paul Bakkerfa9b1002013-07-03 15:31:03 +020056#include <time.h>
57#endif
58
Manuel Pégourié-Gonnard8a3c64d2013-10-14 19:54:10 +020059/* For convenience below and in programs */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020060#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED) || \
61 defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED) || \
62 defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED) || \
63 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
64#define MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED
Manuel Pégourié-Gonnard8a3c64d2013-10-14 19:54:10 +020065#endif
66
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020067#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
68 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
69 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
70#define MBEDTLS_KEY_EXCHANGE__SOME__ECDHE_ENABLED
Gergely Budai987bfb52014-01-19 21:48:42 +010071#endif
72
Paul Bakker13e2dfe2009-07-28 07:18:38 +000073/*
74 * SSL Error codes
75 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020076#define MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
77#define MBEDTLS_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
78#define MBEDTLS_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
79#define MBEDTLS_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
80#define MBEDTLS_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
81#define MBEDTLS_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
82#define MBEDTLS_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
83#define MBEDTLS_ERR_SSL_NO_RNG -0x7400 /**< No RNG was provided to the SSL module. */
84#define MBEDTLS_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
85#define MBEDTLS_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message. */
86#define MBEDTLS_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
87#define MBEDTLS_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
88#define MBEDTLS_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
89#define MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
90#define MBEDTLS_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
91#define MBEDTLS_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
92#define MBEDTLS_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
93#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
94#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
95#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
96#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
97#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
98#define MBEDTLS_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
99#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
100#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
101#define MBEDTLS_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
102#define MBEDTLS_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
103#define MBEDTLS_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
104#define MBEDTLS_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200105#define MBEDTLS_ERR_SSL_ALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106#define MBEDTLS_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
107#define MBEDTLS_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
108#define MBEDTLS_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
109#define MBEDTLS_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
110#define MBEDTLS_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */
111#define MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */
112#define MBEDTLS_ERR_SSL_PK_TYPE_MISMATCH -0x6D00 /**< Public key type mismatch (eg, asked for RSA key exchange and presented EC key) */
113#define MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY -0x6C80 /**< Unknown identity received (eg, PSK identity) */
114#define MBEDTLS_ERR_SSL_INTERNAL_ERROR -0x6C00 /**< Internal error (eg, unexpected failure in lower-level module) */
115#define MBEDTLS_ERR_SSL_COUNTER_WRAPPING -0x6B80 /**< A counter would wrap (eg, too many messages exchanged). */
116#define MBEDTLS_ERR_SSL_WAITING_SERVER_HELLO_RENEGO -0x6B00 /**< Unexpected message at ServerHello in renegotiation. */
117#define MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED -0x6A80 /**< DTLS client must retry for hello verification */
118#define MBEDTLS_ERR_SSL_BUFFER_TOO_SMALL -0x6A00 /**< A buffer is too small to receive or write a message */
119#define MBEDTLS_ERR_SSL_NO_USABLE_CIPHERSUITE -0x6980 /**< None of the common ciphersuites is usable (eg, no suitable certificate, see debug messages). */
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100120#define MBEDTLS_ERR_SSL_WANT_READ -0x6900 /**< Connection requires a read call. */
121#define MBEDTLS_ERR_SSL_WANT_WRITE -0x6880 /**< Connection requires a write call. */
122#define MBEDTLS_ERR_SSL_TIMEOUT -0x6800 /**< The operation timed out. */
Paul Bakker5121ce52009-01-03 21:22:43 +0000123
124/*
125 * Various constants
126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200127#define MBEDTLS_SSL_MAJOR_VERSION_3 3
128#define MBEDTLS_SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
129#define MBEDTLS_SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
130#define MBEDTLS_SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
131#define MBEDTLS_SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000132
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200133#define MBEDTLS_SSL_TRANSPORT_STREAM 0 /*!< TLS */
134#define MBEDTLS_SSL_TRANSPORT_DATAGRAM 1 /*!< DTLS */
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100135
Manuel Pégourié-Gonnard581e6b62013-07-18 12:32:27 +0200136/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
Manuel Pégourié-Gonnarde048b672013-07-19 12:47:00 +0200137 * NONE must be zero so that memset()ing structure to zero works */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200138#define MBEDTLS_SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
139#define MBEDTLS_SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
140#define MBEDTLS_SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
141#define MBEDTLS_SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
142#define MBEDTLS_SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
143#define MBEDTLS_SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200144
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200145#define MBEDTLS_SSL_IS_CLIENT 0
146#define MBEDTLS_SSL_IS_SERVER 1
Manuel Pégourié-Gonnard55e4ff22014-08-19 11:16:35 +0200147
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200148#define MBEDTLS_SSL_IS_NOT_FALLBACK 0
149#define MBEDTLS_SSL_IS_FALLBACK 1
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +0200150
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200151#define MBEDTLS_SSL_EXTENDED_MS_DISABLED 0
152#define MBEDTLS_SSL_EXTENDED_MS_ENABLED 1
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200153
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200154#define MBEDTLS_SSL_ETM_DISABLED 0
155#define MBEDTLS_SSL_ETM_ENABLED 1
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100156
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200157#define MBEDTLS_SSL_COMPRESS_NULL 0
158#define MBEDTLS_SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000159
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200160#define MBEDTLS_SSL_VERIFY_NONE 0
161#define MBEDTLS_SSL_VERIFY_OPTIONAL 1
162#define MBEDTLS_SSL_VERIFY_REQUIRED 2
Paul Bakker5121ce52009-01-03 21:22:43 +0000163
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200164#define MBEDTLS_SSL_LEGACY_RENEGOTIATION 0
165#define MBEDTLS_SSL_SECURE_RENEGOTIATION 1
Paul Bakker48916f92012-09-16 19:57:18 +0000166
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200167#define MBEDTLS_SSL_RENEGOTIATION_DISABLED 0
168#define MBEDTLS_SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000169
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200170#define MBEDTLS_SSL_ANTI_REPLAY_DISABLED 0
171#define MBEDTLS_SSL_ANTI_REPLAY_ENABLED 1
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +0200172
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200173#define MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED -1
174#define MBEDTLS_SSL_RENEGO_MAX_RECORDS_DEFAULT 16
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +0200175
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200176#define MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION 0
177#define MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION 1
178#define MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000179
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200180#define MBEDTLS_SSL_TRUNC_HMAC_DISABLED 0
181#define MBEDTLS_SSL_TRUNC_HMAC_ENABLED 1
182#define MBEDTLS_SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +0200183
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200184#define MBEDTLS_SSL_SESSION_TICKETS_DISABLED 0
185#define MBEDTLS_SSL_SESSION_TICKETS_ENABLED 1
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +0200186
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100187#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED 0
188#define MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED 1
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +0100189
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200190#define MBEDTLS_SSL_ARC4_ENABLED 0
191#define MBEDTLS_SSL_ARC4_DISABLED 1
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +0100192
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200193/*
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200194 * Default range for DTLS retransmission timer value, in milliseconds.
195 * RFC 6347 4.2.4.1 says from 1 second to 60 seconds.
196 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200197#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MIN 1000
198#define MBEDTLS_SSL_DTLS_TIMEOUT_DFL_MAX 60000
Manuel Pégourié-Gonnard0ac247f2014-09-30 22:21:31 +0200199
Paul Bakker088c5c52014-04-25 11:11:10 +0200200/**
201 * \name SECTION: Module settings
202 *
203 * The configuration options you can set for this module are in this section.
204 * Either change them in config.h or define them on the compiler command line.
205 * \{
206 */
207
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200208#if !defined(MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME)
209#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */
Paul Bakker088c5c52014-04-25 11:11:10 +0200210#endif
Paul Bakker606b4ba2013-08-14 16:52:14 +0200211
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200212/*
213 * Size of the input / output buffer.
214 * Note: the RFC defines the default size of SSL / TLS messages. If you
215 * change the value here, other clients / servers may not be able to
216 * communicate with you anymore. Only change this value if you control
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200217 * both sides of the connection and have it reduced at both sides, or
218 * if you're using the Max Fragment Length extension and you know all your
219 * peers are using it too!
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200220 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200221#if !defined(MBEDTLS_SSL_MAX_CONTENT_LEN)
222#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
Paul Bakker088c5c52014-04-25 11:11:10 +0200223#endif
224
225/* \} name SECTION: Module settings */
Paul Bakker5121ce52009-01-03 21:22:43 +0000226
227/*
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100228 * Length of the verify data for secure renegotiation
229 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200230#if defined(MBEDTLS_SSL_PROTO_SSL3)
231#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 36
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100232#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200233#define MBEDTLS_SSL_VERIFY_DATA_MAX_LEN 12
Manuel Pégourié-Gonnard61860192014-11-04 13:05:42 +0100234#endif
235
236/*
Manuel Pégourié-Gonnardc27807d2014-06-30 17:27:49 +0200237 * Signaling ciphersuite values (SCSV)
238 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200239#define MBEDTLS_SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
240#define MBEDTLS_SSL_FALLBACK_SCSV_VALUE 0x5600 /**< draft-ietf-tls-downgrade-scsv-00 */
Paul Bakker48916f92012-09-16 19:57:18 +0000241
Paul Bakker5121ce52009-01-03 21:22:43 +0000242/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000243 * Supported Signature and Hash algorithms (For TLS 1.2)
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200244 * RFC 5246 section 7.4.1.4.1
Paul Bakker1ef83d62012-04-11 12:09:53 +0000245 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200246#define MBEDTLS_SSL_HASH_NONE 0
247#define MBEDTLS_SSL_HASH_MD5 1
248#define MBEDTLS_SSL_HASH_SHA1 2
249#define MBEDTLS_SSL_HASH_SHA224 3
250#define MBEDTLS_SSL_HASH_SHA256 4
251#define MBEDTLS_SSL_HASH_SHA384 5
252#define MBEDTLS_SSL_HASH_SHA512 6
Paul Bakker1ef83d62012-04-11 12:09:53 +0000253
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200254#define MBEDTLS_SSL_SIG_ANON 0
255#define MBEDTLS_SSL_SIG_RSA 1
256#define MBEDTLS_SSL_SIG_ECDSA 3
Paul Bakker1ef83d62012-04-11 12:09:53 +0000257
258/*
Paul Bakker926af752012-11-23 13:38:07 +0100259 * Client Certificate Types
Manuel Pégourié-Gonnard0b032002013-08-17 13:01:41 +0200260 * RFC 5246 section 7.4.4 plus RFC 4492 section 5.5
Paul Bakker926af752012-11-23 13:38:07 +0100261 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200262#define MBEDTLS_SSL_CERT_TYPE_RSA_SIGN 1
263#define MBEDTLS_SSL_CERT_TYPE_ECDSA_SIGN 64
Paul Bakker926af752012-11-23 13:38:07 +0100264
265/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000266 * Message, alert and handshake types
267 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200268#define MBEDTLS_SSL_MSG_CHANGE_CIPHER_SPEC 20
269#define MBEDTLS_SSL_MSG_ALERT 21
270#define MBEDTLS_SSL_MSG_HANDSHAKE 22
271#define MBEDTLS_SSL_MSG_APPLICATION_DATA 23
Paul Bakker5121ce52009-01-03 21:22:43 +0000272
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200273#define MBEDTLS_SSL_ALERT_LEVEL_WARNING 1
274#define MBEDTLS_SSL_ALERT_LEVEL_FATAL 2
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000275
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200276#define MBEDTLS_SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
277#define MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
278#define MBEDTLS_SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
279#define MBEDTLS_SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
280#define MBEDTLS_SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
281#define MBEDTLS_SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
282#define MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
283#define MBEDTLS_SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
284#define MBEDTLS_SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
285#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
286#define MBEDTLS_SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
287#define MBEDTLS_SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
288#define MBEDTLS_SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
289#define MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
290#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
291#define MBEDTLS_SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
292#define MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
293#define MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
294#define MBEDTLS_SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
295#define MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
296#define MBEDTLS_SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
297#define MBEDTLS_SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
298#define MBEDTLS_SSL_ALERT_MSG_INAPROPRIATE_FALLBACK 86 /* 0x56 */
299#define MBEDTLS_SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
300#define MBEDTLS_SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
301#define MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
302#define MBEDTLS_SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
303#define MBEDTLS_SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
304#define MBEDTLS_SSL_ALERT_MSG_NO_APPLICATION_PROTOCOL 120 /* 0x78 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000305
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200306#define MBEDTLS_SSL_HS_HELLO_REQUEST 0
307#define MBEDTLS_SSL_HS_CLIENT_HELLO 1
308#define MBEDTLS_SSL_HS_SERVER_HELLO 2
309#define MBEDTLS_SSL_HS_HELLO_VERIFY_REQUEST 3
310#define MBEDTLS_SSL_HS_NEW_SESSION_TICKET 4
311#define MBEDTLS_SSL_HS_CERTIFICATE 11
312#define MBEDTLS_SSL_HS_SERVER_KEY_EXCHANGE 12
313#define MBEDTLS_SSL_HS_CERTIFICATE_REQUEST 13
314#define MBEDTLS_SSL_HS_SERVER_HELLO_DONE 14
315#define MBEDTLS_SSL_HS_CERTIFICATE_VERIFY 15
316#define MBEDTLS_SSL_HS_CLIENT_KEY_EXCHANGE 16
317#define MBEDTLS_SSL_HS_FINISHED 20
Paul Bakker5121ce52009-01-03 21:22:43 +0000318
319/*
320 * TLS extensions
321 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200322#define MBEDTLS_TLS_EXT_SERVERNAME 0
323#define MBEDTLS_TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000324
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200325#define MBEDTLS_TLS_EXT_MAX_FRAGMENT_LENGTH 1
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200326
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200327#define MBEDTLS_TLS_EXT_TRUNCATED_HMAC 4
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200328
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200329#define MBEDTLS_TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
330#define MBEDTLS_TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000331
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200332#define MBEDTLS_TLS_EXT_SIG_ALG 13
Paul Bakker41c83d32013-03-20 14:39:14 +0100333
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200334#define MBEDTLS_TLS_EXT_ALPN 16
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +0200335
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200336#define MBEDTLS_TLS_EXT_ENCRYPT_THEN_MAC 22 /* 0x16 */
337#define MBEDTLS_TLS_EXT_EXTENDED_MASTER_SECRET 0x0017 /* 23 */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +0200338
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200339#define MBEDTLS_TLS_EXT_SESSION_TICKET 35
Manuel Pégourié-Gonnard60182ef2013-08-02 14:44:54 +0200340
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200341#define MBEDTLS_TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000342
Paul Bakkereb2c6582012-09-27 19:15:01 +0000343/*
Paul Bakkered27a042013-04-18 22:46:23 +0200344 * Size defines
345 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200346#if !defined(MBEDTLS_PSK_MAX_LEN)
347#define MBEDTLS_PSK_MAX_LEN 32 /* 256 bits */
Paul Bakkered27a042013-04-18 22:46:23 +0200348#endif
349
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200350/* Dummy type used only for its size */
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200351union mbedtls_ssl_premaster_secret
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200352{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200353#if defined(MBEDTLS_KEY_EXCHANGE_RSA_ENABLED)
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200354 unsigned char _pms_rsa[48]; /* RFC 5246 8.1.1 */
355#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200356#if defined(MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED)
357 unsigned char _pms_dhm[MBEDTLS_MPI_MAX_SIZE]; /* RFC 5246 8.1.2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200358#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200359#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED) || \
360 defined(MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED) || \
361 defined(MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED) || \
362 defined(MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED)
363 unsigned char _pms_ecdh[MBEDTLS_ECP_MAX_BYTES]; /* RFC 4492 5.10 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200364#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200365#if defined(MBEDTLS_KEY_EXCHANGE_PSK_ENABLED)
366 unsigned char _pms_psk[4 + 2 * MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200367#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200368#if defined(MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED)
369 unsigned char _pms_dhe_psk[4 + MBEDTLS_MPI_MAX_SIZE
370 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 3 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200371#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200372#if defined(MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED)
373 unsigned char _pms_rsa_psk[52 + MBEDTLS_PSK_MAX_LEN]; /* RFC 4279 4 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200374#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200375#if defined(MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED)
376 unsigned char _pms_ecdhe_psk[4 + MBEDTLS_ECP_MAX_BYTES
377 + MBEDTLS_PSK_MAX_LEN]; /* RFC 5489 2 */
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200378#endif
379};
380
Manuel Pégourié-Gonnard160e3842015-05-27 20:27:06 +0200381#define MBEDTLS_PREMASTER_SIZE sizeof( union mbedtls_ssl_premaster_secret )
Manuel Pégourié-Gonnard481fcfd2014-07-03 16:12:50 +0200382
Paul Bakker407a0da2013-06-27 14:29:21 +0200383#ifdef __cplusplus
384extern "C" {
385#endif
386
Paul Bakkered27a042013-04-18 22:46:23 +0200387/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000388 * SSL state machine
389 */
390typedef enum
391{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200392 MBEDTLS_SSL_HELLO_REQUEST,
393 MBEDTLS_SSL_CLIENT_HELLO,
394 MBEDTLS_SSL_SERVER_HELLO,
395 MBEDTLS_SSL_SERVER_CERTIFICATE,
396 MBEDTLS_SSL_SERVER_KEY_EXCHANGE,
397 MBEDTLS_SSL_CERTIFICATE_REQUEST,
398 MBEDTLS_SSL_SERVER_HELLO_DONE,
399 MBEDTLS_SSL_CLIENT_CERTIFICATE,
400 MBEDTLS_SSL_CLIENT_KEY_EXCHANGE,
401 MBEDTLS_SSL_CERTIFICATE_VERIFY,
402 MBEDTLS_SSL_CLIENT_CHANGE_CIPHER_SPEC,
403 MBEDTLS_SSL_CLIENT_FINISHED,
404 MBEDTLS_SSL_SERVER_CHANGE_CIPHER_SPEC,
405 MBEDTLS_SSL_SERVER_FINISHED,
406 MBEDTLS_SSL_FLUSH_BUFFERS,
407 MBEDTLS_SSL_HANDSHAKE_WRAPUP,
408 MBEDTLS_SSL_HANDSHAKE_OVER,
409 MBEDTLS_SSL_SERVER_NEW_SESSION_TICKET,
410 MBEDTLS_SSL_SERVER_HELLO_VERIFY_REQUEST_SENT,
Paul Bakker5121ce52009-01-03 21:22:43 +0000411}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200412mbedtls_ssl_states;
Paul Bakker5121ce52009-01-03 21:22:43 +0000413
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200414/* Defined below */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200415typedef struct mbedtls_ssl_session mbedtls_ssl_session;
416typedef struct mbedtls_ssl_context mbedtls_ssl_context;
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200417typedef struct mbedtls_ssl_config mbedtls_ssl_config;
418
419/* Defined in ssl_internal.h */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200420typedef struct mbedtls_ssl_transform mbedtls_ssl_transform;
421typedef struct mbedtls_ssl_handshake_params mbedtls_ssl_handshake_params;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200422#if defined(MBEDTLS_X509_CRT_PARSE_C)
423typedef struct mbedtls_ssl_key_cert mbedtls_ssl_key_cert;
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +0200424#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200425#if defined(MBEDTLS_SSL_PROTO_DTLS)
426typedef struct mbedtls_ssl_flight_item mbedtls_ssl_flight_item;
Manuel Pégourié-Gonnardffa67be2014-09-19 11:18:57 +0200427#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000428
429/*
Paul Bakker0a597072012-09-25 21:55:46 +0000430 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000431 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200432struct mbedtls_ssl_session
Paul Bakker5121ce52009-01-03 21:22:43 +0000433{
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200434#if defined(MBEDTLS_HAVE_TIME)
Paul Bakker5121ce52009-01-03 21:22:43 +0000435 time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200436#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000437 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000438 int compression; /*!< chosen compression */
Paul Bakker23986e52011-04-24 08:57:21 +0000439 size_t length; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000440 unsigned char id[32]; /*!< session identifier */
441 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200442
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200443#if defined(MBEDTLS_X509_CRT_PARSE_C)
444 mbedtls_x509_crt *peer_cert; /*!< peer X.509 cert chain */
445#endif /* MBEDTLS_X509_CRT_PARSE_C */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200446 uint32_t verify_result; /*!< verification result */
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200447
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200448#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200449 unsigned char *ticket; /*!< RFC 5077 session ticket */
450 size_t ticket_len; /*!< session ticket length */
Manuel Pégourié-Gonnarda5cc6022013-07-31 12:58:16 +0200451 uint32_t ticket_lifetime; /*!< ticket lifetime hint */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200452#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard75d44012013-08-02 14:44:04 +0200453
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200454#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Manuel Pégourié-Gonnarded4af8b2013-07-18 14:07:09 +0200455 unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200456#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Paul Bakker05decb22013-08-15 13:33:48 +0200457
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200458#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard57c28522013-07-19 11:41:43 +0200459 int trunc_hmac; /*!< flag for truncated hmac activation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200460#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100461
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200462#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +0100463 int encrypt_then_mac; /*!< flag for EtM activation */
464#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000465};
466
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200467/**
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200468 * SSL/TLS configuration to be shared between mbedtls_ssl_context structures.
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200469 */
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200470struct mbedtls_ssl_config
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200471{
472 /* Group items by size (largest first) to minimize padding overhead */
473
474 /*
475 * Pointers
476 */
477
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100478 const int *ciphersuite_list[4]; /*!< allowed ciphersuites per version */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200479
480 /** Callback for printing debug output */
481 void (*f_dbg)(void *, int, const char *);
482 void *p_dbg; /*!< context for the debug function */
483
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100484 /** Callback for getting (pseudo-)random numbers */
485 int (*f_rng)(void *, unsigned char *, size_t);
486 void *p_rng; /*!< context for the RNG function */
487
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200488 /** Callback to retrieve a session from the cache */
489 int (*f_get_cache)(void *, mbedtls_ssl_session *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200490 /** Callback to store a session into the cache */
491 int (*f_set_cache)(void *, const mbedtls_ssl_session *);
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +0100492 void *p_cache; /*!< context for cache callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200493
494#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
495 /** Callback for setting cert according to SNI extension */
496 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
497 void *p_sni; /*!< context for SNI callback */
498#endif
499
500#if defined(MBEDTLS_X509_CRT_PARSE_C)
501 /** Callback to customize X.509 certificate chain verification */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200502 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *);
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200503 void *p_vrfy; /*!< context for X.509 verify calllback */
504#endif
505
506#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
507 /** Callback to retrieve PSK key from identity */
508 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *, size_t);
509 void *p_psk; /*!< context for PSK callback */
510#endif
511
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200512#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200513 /** Callback to create & write a cookie for ClientHello veirifcation */
514 int (*f_cookie_write)( void *, unsigned char **, unsigned char *,
515 const unsigned char *, size_t );
516 /** Callback to verify validity of a ClientHello cookie */
517 int (*f_cookie_check)( void *, const unsigned char *, size_t,
518 const unsigned char *, size_t );
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100519 void *p_cookie; /*!< context for the cookie callbacks */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200520#endif
521
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200522#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200523 /** Callback to create & write a session ticket */
524 int (*f_ticket_write)( void *, const mbedtls_ssl_session *,
525 unsigned char *, const unsigned char *, size_t *, uint32_t * );
526 /** Callback to parse a session ticket into a session structure */
527 int (*f_ticket_parse)( void *, mbedtls_ssl_session *, unsigned char *, size_t);
528 void *p_ticket; /*!< context for the ticket callbacks */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +0200529#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +0200530
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200531#if defined(MBEDTLS_X509_CRT_PARSE_C)
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +0200532 const mbedtls_x509_crt_profile *cert_profile; /*!< verification profile */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200533 mbedtls_ssl_key_cert *key_cert; /*!< own certificate/key pair(s) */
534 mbedtls_x509_crt *ca_chain; /*!< trusted CAs */
535 mbedtls_x509_crl *ca_crl; /*!< trusted CAs CRLs */
536#endif /* MBEDTLS_X509_CRT_PARSE_C */
537
538#if defined(MBEDTLS_SSL_SET_CURVES)
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100539 const mbedtls_ecp_group_id *curve_list; /*!< allowed curves */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200540#endif
541
542#if defined(MBEDTLS_DHM_C)
543 mbedtls_mpi dhm_P; /*!< prime modulus for DHM */
544 mbedtls_mpi dhm_G; /*!< generator for DHM */
545#endif
546
547#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
548 unsigned char *psk; /*!< pre-shared key */
549 size_t psk_len; /*!< length of the pre-shared key */
550 unsigned char *psk_identity; /*!< identity for PSK negotiation */
551 size_t psk_identity_len;/*!< length of identity */
552#endif
553
554#if defined(MBEDTLS_SSL_ALPN)
555 const char **alpn_list; /*!< ordered list of protocols */
556#endif
557
558 /*
559 * Numerical settings (int then char)
560 */
561
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200562 uint32_t read_timeout; /*!< timeout for mbedtls_ssl_read (ms) */
563
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200564#if defined(MBEDTLS_SSL_PROTO_DTLS)
565 uint32_t hs_timeout_min; /*!< initial value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200566 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200567 uint32_t hs_timeout_max; /*!< maximum value of the handshake
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200568 retransmission timeout (ms) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200569#endif
570
571#if defined(MBEDTLS_SSL_RENEGOTIATION)
572 int renego_max_records; /*!< grace period for renegotiation */
573 unsigned char renego_period[8]; /*!< value of the record counters
574 that triggers renegotiation */
575#endif
576
577#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
578 unsigned int badmac_limit; /*!< limit of records with a bad MAC */
579#endif
580
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +0200581#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
582 unsigned int dhm_min_bitlen; /*!< min. bit length of the DHM prime */
583#endif
584
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200585 unsigned char max_major_ver; /*!< max. major version used */
586 unsigned char max_minor_ver; /*!< max. minor version used */
587 unsigned char min_major_ver; /*!< min. major version used */
588 unsigned char min_minor_ver; /*!< min. minor version used */
589
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200590 /*
591 * Flags (bitfields)
592 */
593
594 unsigned int endpoint : 1; /*!< 0: client, 1: server */
595 unsigned int transport : 1; /*!< stream (TLS) or datagram (DTLS) */
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200596 unsigned int authmode : 2; /*!< MBEDTLS_SSL_VERIFY_XXX */
597 /* needed even with renego disabled for LEGACY_BREAK_HANDSHAKE */
598 unsigned int allow_legacy_renegotiation : 2 ; /*!< MBEDTLS_LEGACY_XXX */
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +0200599#if defined(MBEDTLS_ARC4_C)
600 unsigned int arc4_disabled : 1; /*!< blacklist RC4 ciphersuites? */
601#endif
Manuel Pégourié-Gonnarde51bba02015-05-06 09:33:13 +0100602#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
603 unsigned int mfl_code : 3; /*!< desired fragment length */
604#endif
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200605#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
606 unsigned int encrypt_then_mac : 1 ; /*!< negotiate encrypt-then-mac? */
607#endif
608#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
609 unsigned int extended_ms : 1; /*!< negotiate extended master secret? */
610#endif
611#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
612 unsigned int anti_replay : 1; /*!< detect and prevent replay? */
613#endif
614#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
615 unsigned int cbc_record_splitting : 1; /*!< do cbc record splitting */
616#endif
617#if defined(MBEDTLS_SSL_RENEGOTIATION)
618 unsigned int disable_renegotiation : 1; /*!< disable renegotiation? */
619#endif
620#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
621 unsigned int trunc_hmac : 1; /*!< negotiate truncated hmac? */
622#endif
623#if defined(MBEDTLS_SSL_SESSION_TICKETS)
624 unsigned int session_tickets : 1; /*!< use session tickets? */
625#endif
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +0100626#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
627 unsigned int fallback : 1; /*!< is this a fallback? */
628#endif
Manuel Pégourié-Gonnardcd4fcc62015-05-26 12:11:48 +0200629};
630
Manuel Pégourié-Gonnardfa6473d2015-04-30 18:03:08 +0200631
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200632struct mbedtls_ssl_context
Paul Bakker5121ce52009-01-03 21:22:43 +0000633{
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200634 const mbedtls_ssl_config *conf; /*!< configuration information */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200635
Paul Bakker5121ce52009-01-03 21:22:43 +0000636 /*
637 * Miscellaneous
638 */
639 int state; /*!< SSL handshake: current state */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200640#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnard852a6d32015-03-19 16:15:20 +0000641 int renego_status; /*!< Initial, in progress, pending? */
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +0200642 int renego_records_seen; /*!< Records since renego request, or with DTLS,
643 number of retransmissions of request if
644 renego_max_records is < 0 */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100645#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000646
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200647 int major_ver; /*!< equal to MBEDTLS_SSL_MAJOR_VERSION_3 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000648 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
649
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200650#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +0200651 unsigned badmac_seen; /*!< records with a bad MAC received */
652#endif
653
Paul Bakker5121ce52009-01-03 21:22:43 +0000654 /*
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200655 * Callbacks
Paul Bakker5121ce52009-01-03 21:22:43 +0000656 */
Paul Bakker39bb4182011-06-21 07:36:43 +0000657 int (*f_send)(void *, const unsigned char *, size_t);
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200658 int (*f_recv)(void *, unsigned char *, size_t);
Manuel Pégourié-Gonnardc8d8e972014-10-01 15:01:39 +0200659 int (*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t);
Manuel Pégourié-Gonnarde6bdc442014-09-17 11:34:57 +0200660 void *p_bio; /*!< context for I/O operations */
Paul Bakker6db455e2013-09-18 17:29:31 +0200661
Paul Bakker5121ce52009-01-03 21:22:43 +0000662 /*
663 * Session layer
664 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200665 mbedtls_ssl_session *session_in; /*!< current session data (in) */
666 mbedtls_ssl_session *session_out; /*!< current session data (out) */
667 mbedtls_ssl_session *session; /*!< negotiated session data */
668 mbedtls_ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000669
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200670 mbedtls_ssl_handshake_params *handshake; /*!< params required only during
Paul Bakker48916f92012-09-16 19:57:18 +0000671 the handshake process */
672
673 /*
674 * Record layer transformations
675 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200676 mbedtls_ssl_transform *transform_in; /*!< current transform params (in) */
677 mbedtls_ssl_transform *transform_out; /*!< current transform params (in) */
678 mbedtls_ssl_transform *transform; /*!< negotiated transform params */
679 mbedtls_ssl_transform *transform_negotiate; /*!< transform params in negotiation */
Paul Bakker48916f92012-09-16 19:57:18 +0000680
Paul Bakker5121ce52009-01-03 21:22:43 +0000681 /*
Manuel Pégourié-Gonnard8e704f02014-10-14 20:03:35 +0200682 * Timers
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200683 */
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +0200684 void *p_timer; /*!< context for the timer callbacks */
685 void (*f_set_timer)(void *, uint32_t, uint32_t); /*!< set timer callback */
686 int (*f_get_timer)(void *); /*!< get timer callback */
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +0200687
Manuel Pégourié-Gonnarddb2858c2014-09-29 14:04:42 +0200688 /*
Paul Bakker5121ce52009-01-03 21:22:43 +0000689 * Record layer (incoming data)
690 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100691 unsigned char *in_buf; /*!< input buffer */
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +0200692 unsigned char *in_ctr; /*!< 64-bit incoming message counter
693 TLS: maintained by us
694 DTLS: read from peer */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100695 unsigned char *in_hdr; /*!< start of record header */
696 unsigned char *in_len; /*!< two-bytes message length field */
697 unsigned char *in_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +0100698 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000699 unsigned char *in_offt; /*!< read offset in application data */
700
701 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000702 size_t in_msglen; /*!< record header: message length */
703 size_t in_left; /*!< amount of data read so far */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200704#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard246c13a2014-09-24 13:56:09 +0200705 uint16_t in_epoch; /*!< DTLS epoch for incoming records */
Manuel Pégourié-Gonnard64dffc52014-09-02 13:39:16 +0200706 size_t next_record_offset; /*!< offset of the next record in datagram
707 (equal to in_left if none) */
Manuel Pégourié-Gonnardb2f3be82014-07-10 17:54:52 +0200708#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200709#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard7a7e1402014-09-24 10:52:58 +0200710 uint64_t in_window_top; /*!< last validated record seq_num */
711 uint64_t in_window; /*!< bitmask for replay detection */
712#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000713
Manuel Pégourié-Gonnard9d1d7192014-09-03 11:01:14 +0200714 size_t in_hslen; /*!< current handshake message length,
715 including the handshake header */
Paul Bakker5121ce52009-01-03 21:22:43 +0000716 int nb_zero; /*!< # of 0-length encrypted messages */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200717 int record_read; /*!< record is already present */
Paul Bakker5121ce52009-01-03 21:22:43 +0000718
719 /*
720 * Record layer (outgoing data)
721 */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100722 unsigned char *out_buf; /*!< output buffer */
Paul Bakker5121ce52009-01-03 21:22:43 +0000723 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
Manuel Pégourié-Gonnard7ee6f0e2014-02-13 10:54:07 +0100724 unsigned char *out_hdr; /*!< start of record header */
725 unsigned char *out_len; /*!< two-bytes message length field */
726 unsigned char *out_iv; /*!< ivlen-byte IV */
Paul Bakker92be97b2013-01-02 17:30:03 +0100727 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000728
729 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000730 size_t out_msglen; /*!< record header: message length */
731 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +0000732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200733#if defined(MBEDTLS_ZLIB_SUPPORT)
Paul Bakker16770332013-10-11 09:59:44 +0200734 unsigned char *compress_buf; /*!< zlib data buffer */
735#endif
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200736#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +0100737 signed char split_done; /*!< current record already splitted? */
Manuel Pégourié-Gonnardd76314c2015-01-07 12:39:44 +0100738#endif
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200739
Paul Bakker5121ce52009-01-03 21:22:43 +0000740 /*
741 * PKI layer
742 */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200743 int client_auth; /*!< flag for client auth. */
Manuel Pégourié-Gonnard7ca4e4d2015-05-04 10:55:58 +0200744
Manuel Pégourié-Gonnard779e4292013-08-03 13:50:48 +0200745 /*
Paul Bakker48916f92012-09-16 19:57:18 +0000746 * User settings
747 */
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +0100748#if defined(MBEDTLS_X509_CRT_PARSE_C)
749 char *hostname; /*!< expected peer CN for verification
750 (and SNI if available) */
Paul Bakker0be444a2013-08-27 21:55:01 +0200751#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000752
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200753#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +0200754 const char *alpn_chosen; /*!< negotiated protocol */
755#endif
756
Paul Bakker48916f92012-09-16 19:57:18 +0000757 /*
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +0200758 * Information for DTLS hello verify
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +0200759 */
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +0200760#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +0200761 unsigned char *cli_id; /*!< transport-level ID of the client */
762 size_t cli_id_len; /*!< length of cli_id */
763#endif
764
765 /*
Paul Bakker48916f92012-09-16 19:57:18 +0000766 * Secure renegotiation
767 */
Manuel Pégourié-Gonnard3b2c0d62015-03-10 13:20:49 +0000768 /* needed to know when to send extension on server */
Paul Bakker48916f92012-09-16 19:57:18 +0000769 int secure_renegotiation; /*!< does peer support legacy or
770 secure renegotiation */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200771#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +0000772 size_t verify_data_len; /*!< length of verify data stored */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200773 char own_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
774 char peer_verify_data[MBEDTLS_SSL_VERIFY_DATA_MAX_LEN]; /*!< previous handshake verify data */
Manuel Pégourié-Gonnard615e6772014-11-03 08:23:14 +0100775#endif
Paul Bakker5121ce52009-01-03 21:22:43 +0000776};
777
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200778#if defined(MBEDTLS_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +0100779
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200780#define MBEDTLS_SSL_CHANNEL_OUTBOUND 0
781#define MBEDTLS_SSL_CHANNEL_INBOUND 1
Paul Bakker07eb38b2012-12-19 14:42:06 +0100782
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200783extern int (*mbedtls_ssl_hw_record_init)(mbedtls_ssl_context *ssl,
Paul Bakker05ef8352012-05-08 09:17:57 +0000784 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100785 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +0000786 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100787 size_t ivlen,
788 const unsigned char *mac_enc, const unsigned char *mac_dec,
789 size_t maclen);
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200790extern int (*mbedtls_ssl_hw_record_activate)(mbedtls_ssl_context *ssl, int direction);
791extern int (*mbedtls_ssl_hw_record_reset)(mbedtls_ssl_context *ssl);
792extern int (*mbedtls_ssl_hw_record_write)(mbedtls_ssl_context *ssl);
793extern int (*mbedtls_ssl_hw_record_read)(mbedtls_ssl_context *ssl);
794extern int (*mbedtls_ssl_hw_record_finish)(mbedtls_ssl_context *ssl);
795#endif /* MBEDTLS_SSL_HW_RECORD_ACCEL */
Paul Bakker05ef8352012-05-08 09:17:57 +0000796
Paul Bakker5121ce52009-01-03 21:22:43 +0000797/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000798 * \brief Returns the list of ciphersuites supported by the SSL/TLS module.
Paul Bakker72f62662011-01-16 21:27:44 +0000799 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000800 * \return a statically allocated array of ciphersuites, the last
801 * entry is 0.
Paul Bakker72f62662011-01-16 21:27:44 +0000802 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200803const int *mbedtls_ssl_list_ciphersuites( void );
Paul Bakker72f62662011-01-16 21:27:44 +0000804
805/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200806 * \brief Return the name of the ciphersuite associated with the
807 * given ID
Paul Bakker72f62662011-01-16 21:27:44 +0000808 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000809 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +0000810 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000811 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +0000812 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200813const char *mbedtls_ssl_get_ciphersuite_name( const int ciphersuite_id );
Paul Bakkere3166ce2011-01-27 17:40:50 +0000814
815/**
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +0200816 * \brief Return the ID of the ciphersuite associated with the
817 * given name
Paul Bakkere3166ce2011-01-27 17:40:50 +0000818 *
819 * \param ciphersuite_name SSL ciphersuite name
820 *
821 * \return the ID with the ciphersuite or 0 if not found
822 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200823int mbedtls_ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +0000824
825/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000826 * \brief Initialize an SSL context
Manuel Pégourié-Gonnard41d479e2015-04-29 00:48:22 +0200827 * Just makes the context ready for mbetls_ssl_setup() or
828 * mbedtls_ssl_free()
829 *
830 * \param ssl SSL context
831 */
832void mbedtls_ssl_init( mbedtls_ssl_context *ssl );
833
834/**
835 * \brief Set up an SSL context for use
Paul Bakker5121ce52009-01-03 21:22:43 +0000836 *
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200837 * \note No copy of the configuration context is made, it can be
Manuel Pégourié-Gonnard151dc772015-05-14 13:55:51 +0200838 * shared by many mbedtls_ssl_context structures.
Manuel Pégourié-Gonnard06939ce2015-05-11 11:25:46 +0200839 *
840 * \warning Modifying the conf structure after is has been used in this
841 * function is unsupported!
842 *
Paul Bakker5121ce52009-01-03 21:22:43 +0000843 * \param ssl SSL context
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200844 * \param conf SSL configuration to use
Paul Bakker5121ce52009-01-03 21:22:43 +0000845 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +0200846 * \return 0 if successful, or MBEDTLS_ERR_SSL_ALLOC_FAILED if
Paul Bakker69e095c2011-12-10 21:55:01 +0000847 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000848 */
Manuel Pégourié-Gonnarddef0bbe2015-05-04 14:56:36 +0200849int mbedtls_ssl_setup( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard1897af92015-05-10 23:27:38 +0200850 const mbedtls_ssl_config *conf );
Paul Bakker5121ce52009-01-03 21:22:43 +0000851
852/**
Paul Bakker7eb013f2011-10-06 12:37:39 +0000853 * \brief Reset an already initialized SSL context for re-use
854 * while retaining application-set variables, function
855 * pointers and data.
856 *
857 * \param ssl SSL context
Paul Bakker48916f92012-09-16 19:57:18 +0000858 * \return 0 if successful, or POLASSL_ERR_SSL_MALLOC_FAILED,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200859 MBEDTLS_ERR_SSL_HW_ACCEL_FAILED or
860 * MBEDTLS_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +0000861 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200862int mbedtls_ssl_session_reset( mbedtls_ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +0000863
864/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000865 * \brief Set the current endpoint type
866 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200867 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200868 * \param endpoint must be MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
Paul Bakker5121ce52009-01-03 21:22:43 +0000869 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200870void mbedtls_ssl_conf_endpoint( mbedtls_ssl_config *conf, int endpoint );
Paul Bakker5121ce52009-01-03 21:22:43 +0000871
872/**
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200873 * \brief Set the transport type (TLS or DTLS).
874 * Default: TLS
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100875 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +0200876 * \note For DTLS, you must either provide a recv callback that
877 * doesn't block, or one that handles timeouts, see
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +0200878 * \c mbedtls_ssl_set_bio(). You also need to provide timer
879 * callbacks with \c mbedtls_ssl_set_timer_cb().
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +0200880 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200881 * \param conf SSL configuration
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100882 * \param transport transport type:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200883 * MBEDTLS_SSL_TRANSPORT_STREAM for TLS,
884 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS.
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100885 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +0200886void mbedtls_ssl_conf_transport( mbedtls_ssl_config *conf, int transport );
Manuel Pégourié-Gonnard0b1ff292014-02-06 13:04:16 +0100887
888/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000889 * \brief Set the certificate verification mode
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200890 * Default: NONE on server, REQUIRED on client
Paul Bakker5121ce52009-01-03 21:22:43 +0000891 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200892 * \param conf SSL configuration
Paul Bakker37ca75d2011-01-06 12:28:03 +0000893 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +0000894 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200895 * MBEDTLS_SSL_VERIFY_NONE: peer certificate is not checked
Manuel Pégourié-Gonnardfa44f202015-03-27 17:52:25 +0100896 * (default on server)
897 * (insecure on client)
Paul Bakker5121ce52009-01-03 21:22:43 +0000898 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200899 * MBEDTLS_SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
Paul Bakker5121ce52009-01-03 21:22:43 +0000900 * handshake continues even if verification failed;
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200901 * mbedtls_ssl_get_verify_result() can be called after the
Paul Bakker5121ce52009-01-03 21:22:43 +0000902 * handshake is complete.
903 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200904 * MBEDTLS_SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
Paul Bakker5121ce52009-01-03 21:22:43 +0000905 * handshake is aborted if verification failed.
Manuel Pégourié-Gonnarde2ce2112014-03-11 10:50:48 +0100906 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200907 * \note On client, MBEDTLS_SSL_VERIFY_REQUIRED is the recommended mode.
908 * 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 +0100909 * the right time(s), which may not be obvious, while REQUIRED always perform
910 * the verification as soon as possible. For example, REQUIRED was protecting
911 * against the "triple handshake" attack even before it was found.
Paul Bakker5121ce52009-01-03 21:22:43 +0000912 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200913void mbedtls_ssl_conf_authmode( mbedtls_ssl_config *conf, int authmode );
Paul Bakker5121ce52009-01-03 21:22:43 +0000914
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200915#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000916/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000917 * \brief Set the verification callback (Optional).
918 *
Paul Bakker915275b2012-09-28 07:10:55 +0000919 * If set, the verify callback is called for each
920 * certificate in the chain. For implementation
921 * information, please see \c x509parse_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000922 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200923 * \param conf SSL configuration
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000924 * \param f_vrfy verification function
925 * \param p_vrfy verification parameter
926 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200927void mbedtls_ssl_conf_verify( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +0200928 int (*f_vrfy)(void *, mbedtls_x509_crt *, int, uint32_t *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000929 void *p_vrfy );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200930#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000931
932/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000933 * \brief Set the random number generator callback
934 *
Manuel Pégourié-Gonnard750e4d72015-05-07 12:35:38 +0100935 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +0000936 * \param f_rng RNG function
937 * \param p_rng RNG parameter
938 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200939void mbedtls_ssl_conf_rng( mbedtls_ssl_config *conf,
Paul Bakkera3d195c2011-11-27 21:07:34 +0000940 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +0000941 void *p_rng );
942
943/**
944 * \brief Set the debug callback
945 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +0200946 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +0000947 * \param f_dbg debug function
948 * \param p_dbg debug parameter
949 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200950void mbedtls_ssl_conf_dbg( mbedtls_ssl_config *conf,
Paul Bakkerff60ee62010-03-16 21:09:09 +0000951 void (*f_dbg)(void *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +0000952 void *p_dbg );
953
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200954/**
955 * \brief Set the underlying BIO callbacks for write, read and
956 * read-with-timeout.
957 *
958 * \param ssl SSL context
959 * \param p_bio parameter (context) shared by BIO callbacks
960 * \param f_send write callback
961 * \param f_recv read callback
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +0100962 * \param f_recv_timeout blocking read callback with timeout.
Manuel Pégourié-Gonnarde391c8d2015-05-13 20:34:24 +0200963 * The last argument is the timeout in milliseconds,
964 * 0 means no timeout
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200965 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +0200966 * \note One of f_recv or f_recv_timeout can be NULL, in which case
967 * the other is used. If both are non-NULL, f_recv_timeout is
968 * used and f_recv is ignored (as if it were NULL).
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200969 *
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +0200970 * \note The two most common use cases are:
971 * - non-blocking I/O, f_recv != NULL, f_recv_timeout == NULL
972 * - blocking I/O, f_recv == NULL, f_recv_timout != NULL
973 *
974 * \note For DTLS, you need to provide either a non-NULL
975 * f_recv_timeout callback, or a f_recv that doesn't block.
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200976 */
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +0100977void mbedtls_ssl_set_bio( mbedtls_ssl_context *ssl,
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +0200978 void *p_bio,
979 int (*f_send)(void *, const unsigned char *, size_t),
980 int (*f_recv)(void *, unsigned char *, size_t),
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +0100981 int (*f_recv_timeout)(void *, unsigned char *, size_t, uint32_t) );
982
983/**
984 * \brief Set the timeout period for mbedtls_ssl_read()
985 * (Default: no timeout.)
986 *
987 * \param conf SSL configuration context
988 * \param timeout Timeout value in milliseconds.
989 * Use 0 for no timeout (default).
990 *
991 * \note With blocking I/O, this will only work if a non-NULL
Manuel Pégourié-Gonnard1b511f92015-05-06 15:54:23 +0100992 * \c f_recv_timeout was set with \c mbedtls_ssl_set_bio().
Manuel Pégourié-Gonnardbbd28f72015-05-13 10:21:19 +0200993 * With non-blocking I/O, this will only work if timer
994 * callbacks were set with \c mbedtls_ssl_set_timer_cb().
995 *
996 * \note With non-blocking I/O, you may also skip this function
997 * altogether and handle timeouts at the application layer.
Manuel Pégourié-Gonnard97fd52c2015-05-06 15:38:52 +0100998 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +0200999void mbedtls_ssl_conf_read_timeout( mbedtls_ssl_config *conf, uint32_t timeout );
Manuel Pégourié-Gonnard8fa6dfd2014-09-17 10:47:43 +02001000
Manuel Pégourié-Gonnard2e012912015-05-12 20:55:41 +02001001/**
1002 * \brief Set the timer callbacks
1003 * (Mandatory for DTLS.)
1004 *
1005 * \param ssl SSL context
1006 * \param p_timer parameter (context) shared by timer callback
1007 * \param f_set_timer set timer callback
1008 * Accepts an intermediate and a final delay in milliseconcs
1009 * If the final delay is 0, cancels the running timer.
1010 * \param f_get_timer get timer callback. Must return:
1011 * -1 if cancelled
1012 * 0 if none of the delays is expired
1013 * 1 if the intermediate delay only is expired
1014 * 2 if the final delay is expired
1015 */
1016void mbedtls_ssl_set_timer_cb( mbedtls_ssl_context *ssl,
1017 void *p_timer,
1018 void (*f_set_timer)(void *, uint32_t int_ms, uint32_t fin_ms),
1019 int (*f_get_timer)(void *) );
1020
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001021/**
1022 * \brief Callback type: generate and write session ticket
1023 *
1024 * \note This describes what a callback implementation should do.
1025 * This callback should generate and encrypted and
1026 * authenticated ticket for the session and write it to the
1027 * output buffer. Here, ticket means the opaque ticket part
1028 * of the NewSessionTicket structure of RFC 5077.
1029 *
1030 * \param p_ticket Context for the callback
1031 * \param session SSL session to bo written in the ticket
1032 * \param start Start of the outpur buffer
1033 * \param end End of the output buffer
1034 * \param tlen On exit, holds the length written
1035 * \param lifetime On exit, holds the lifetime of the ticket in seconds
1036 *
1037 * \return 0 if successful, or
1038 * a specific MBEDTLS_ERR_XXX code.
1039 */
1040typedef int mbedtls_ssl_ticket_write_t( void *p_ticket,
1041 const mbedtls_ssl_session *session,
1042 unsigned char *start,
1043 const unsigned char *end,
1044 size_t *tlen,
1045 uint32_t *lifetime );
1046
1047/**
1048 * \brief Callback type: parse and load session ticket
1049 *
1050 * \note This describes what a callback implementation should do.
1051 * This callback should parse a session ticket as generated
1052 * by the corresponding mbedtls_ssl_ticket_write_t function,
1053 * and, if the ticket is authentic and valid, load the
1054 * session.
1055 *
1056 * \note The implementation is allowed to modify the first len
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001057 * bytes of the input buffer, eg to use it as a temporary
1058 * area for the decrypted ticket contents.
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001059 *
1060 * \param p_ticket Context for the callback
1061 * \param session SSL session to be loaded
1062 * \param buf Start of the buffer containing the ticket
1063 * \param len Length of the ticket.
1064 *
1065 * \return 0 if successful, or
1066 * MBEDTLS_ERR_SSL_INVALID_MAC if not authentic, or
1067 * MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED if expired, or
1068 * any other non-zero code for other failures.
1069 */
1070typedef int mbedtls_ssl_ticket_parse_t( void *p_ticket,
1071 mbedtls_ssl_session *session,
1072 unsigned char *buf,
1073 size_t len );
1074
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001075#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001076/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001077 * \brief Configure SSL session ticket callbacks (server only).
1078 * (Default: none.)
1079 *
1080 * \note On server, session tickets are enabled by providing
1081 * non-NULL callbacks.
1082 *
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02001083 * \note On client, use \c mbedtls_ssl_conf_session_tickets().
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001084 *
1085 * \param conf SSL configuration context
1086 * \param f_ticket_write Callback for writing a ticket
1087 * \param f_ticket_parse Callback for parsing a ticket
1088 * \param p_ticket Context shared by the two callbacks
1089 */
1090void mbedtls_ssl_conf_session_tickets_cb( mbedtls_ssl_config *conf,
1091 mbedtls_ssl_ticket_write_t *f_ticket_write,
1092 mbedtls_ssl_ticket_parse_t *f_ticket_parse,
1093 void *p_ticket );
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001094#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnardd59675d2015-05-19 15:28:00 +02001095
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001096/**
1097 * \brief Callback type: generate a cookie
1098 *
1099 * \param ctx Context for the callback
1100 * \param p Buffer to write to,
1101 * must be updated to point right after the cookie
1102 * \param end Pointer to one past the end of the output buffer
1103 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001104 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001105 * \param ilen Length of info in bytes
1106 *
1107 * \return The callback must return 0 on success,
1108 * or a negative error code.
1109 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001110typedef int mbedtls_ssl_cookie_write_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001111 unsigned char **p, unsigned char *end,
1112 const unsigned char *info, size_t ilen );
1113
1114/**
1115 * \brief Callback type: verify a cookie
1116 *
1117 * \param ctx Context for the callback
1118 * \param cookie Cookie to verify
1119 * \param clen Length of cookie
1120 * \param info Client ID info that was passed to
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001121 * \c mbedtls_ssl_set_client_transport_id()
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001122 * \param ilen Length of info in bytes
1123 *
1124 * \return The callback must return 0 if cookie is valid,
1125 * or a negative error code.
1126 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001127typedef int mbedtls_ssl_cookie_check_t( void *ctx,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001128 const unsigned char *cookie, size_t clen,
1129 const unsigned char *info, size_t ilen );
1130
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001131#if defined(MBEDTLS_SSL_DTLS_HELLO_VERIFY) && defined(MBEDTLS_SSL_SRV_C)
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001132/**
1133 * \brief Register callbacks for DTLS cookies
1134 * (Server only. DTLS only.)
1135 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001136 * Default: dummy callbacks that fail, in order to force you to
Manuel Pégourié-Gonnard7d38d212014-07-23 17:52:09 +02001137 * register working callbacks (and initialize their context).
1138 *
1139 * To disable HelloVerifyRequest, register NULL callbacks.
1140 *
1141 * \warning Disabling hello verification allows your server to be used
1142 * for amplification in DoS attacks against other hosts.
1143 * Only disable if you known this can't happen in your
1144 * particular environment.
1145 *
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02001146 * \note See comments on \c mbedtls_ssl_handshake() about handling
1147 * the MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED that is expected
1148 * on the first handshake attempt when this is enabled.
1149 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001150 * \param conf SSL configuration
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001151 * \param f_cookie_write Cookie write callback
1152 * \param f_cookie_check Cookie check callback
1153 * \param p_cookie Context for both callbacks
1154 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001155void mbedtls_ssl_conf_dtls_cookies( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001156 mbedtls_ssl_cookie_write_t *f_cookie_write,
1157 mbedtls_ssl_cookie_check_t *f_cookie_check,
Manuel Pégourié-Gonnardd485d192014-07-23 14:56:15 +02001158 void *p_cookie );
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001159
1160/**
1161 * \brief Set client's transport-level identification info.
1162 * (Server only. DTLS only.)
1163 *
1164 * This is usually the IP address (and port), but could be
1165 * anything identify the client depending on the underlying
1166 * network stack. Used for HelloVerifyRequest with DTLS.
1167 * This is *not* used to route the actual packets.
1168 *
1169 * \param ssl SSL context
1170 * \param info Transport-level info identifying the client (eg IP + port)
1171 * \param ilen Length of info in bytes
1172 *
1173 * \note An internal copy is made, so the info buffer can be reused.
1174 *
1175 * \return 0 on success,
1176 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used on client,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001177 * MBEDTLS_ERR_SSL_ALLOC_FAILED if out of memory.
Manuel Pégourié-Gonnarde057d3b2015-05-20 10:59:43 +02001178 */
1179int mbedtls_ssl_set_client_transport_id( mbedtls_ssl_context *ssl,
1180 const unsigned char *info,
1181 size_t ilen );
1182
1183#endif /* MBEDTLS_SSL_DTLS_HELLO_VERIFY && MBEDTLS_SSL_SRV_C */
Manuel Pégourié-Gonnard43c02182014-07-22 17:32:01 +02001184
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001185#if defined(MBEDTLS_SSL_DTLS_ANTI_REPLAY)
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001186/**
1187 * \brief Enable or disable anti-replay protection for DTLS.
1188 * (DTLS only, no effect on TLS.)
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001189 * Default: enabled.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001190 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001191 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001192 * \param mode MBEDTLS_SSL_ANTI_REPLAY_ENABLED or MBEDTLS_SSL_ANTI_REPLAY_DISABLED.
Manuel Pégourié-Gonnarda6fcffe2014-10-13 18:15:52 +02001193 *
1194 * \warning Disabling this is a security risk unless the application
1195 * protocol handles duplicated packets in a safe way. You
1196 * should not disable this without careful consideration.
1197 * However, if your application already detects duplicated
1198 * packets and needs information about them to adjust its
1199 * transmission strategy, then you'll want to disable this.
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001200 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001201void mbedtls_ssl_conf_dtls_anti_replay( mbedtls_ssl_config *conf, char mode );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001202#endif /* MBEDTLS_SSL_DTLS_ANTI_REPLAY */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001204#if defined(MBEDTLS_SSL_DTLS_BADMAC_LIMIT)
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001205/**
1206 * \brief Set a limit on the number of records with a bad MAC
1207 * before terminating the connection.
1208 * (DTLS only, no effect on TLS.)
1209 * Default: 0 (disabled).
1210 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001211 * \param conf SSL configuration
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001212 * \param limit Limit, or 0 to disable.
1213 *
1214 * \note If the limit is N, then the connection is terminated when
1215 * the Nth non-authentic record is seen.
1216 *
1217 * \note Records with an invalid header are not counted, only the
1218 * ones going through the authentication-decryption phase.
1219 *
1220 * \note This is a security trade-off related to the fact that it's
1221 * often relatively easy for an active attacker ot inject UDP
1222 * datagrams. On one hand, setting a low limit here makes it
1223 * easier for such an attacker to forcibly terminated a
1224 * connection. On the other hand, a high limit or no limit
1225 * might make us waste resources checking authentication on
1226 * many bogus packets.
1227 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001228void mbedtls_ssl_conf_dtls_badmac_limit( mbedtls_ssl_config *conf, unsigned limit );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001229#endif /* MBEDTLS_SSL_DTLS_BADMAC_LIMIT */
Manuel Pégourié-Gonnardb0643d12014-10-14 18:30:36 +02001230
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001231#if defined(MBEDTLS_SSL_PROTO_DTLS)
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001232/**
1233 * \brief Set retransmit timeout values for the DTLS handshale.
1234 * (DTLS only, no effect on TLS.)
1235 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001236 * \param conf SSL configuration
Manuel Pégourié-Gonnard905dd242014-10-01 12:03:55 +02001237 * \param min Initial timeout value in milliseconds.
1238 * Default: 1000 (1 second).
1239 * \param max Maximum timeout value in milliseconds.
1240 * Default: 60000 (60 seconds).
1241 *
1242 * \note Default values are from RFC 6347 section 4.2.4.1.
1243 *
1244 * \note Higher values for initial timeout may increase average
1245 * handshake latency. Lower values may increase the risk of
1246 * network congestion by causing more retransmissions.
1247 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001248void mbedtls_ssl_conf_handshake_timeout( mbedtls_ssl_config *conf, uint32_t min, uint32_t max );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001249#endif /* MBEDTLS_SSL_PROTO_DTLS */
Manuel Pégourié-Gonnard27393132014-09-24 14:41:11 +02001250
Manuel Pégourié-Gonnardcc3195e2015-05-06 14:53:09 +01001251#if defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001252/**
Paul Bakker0a597072012-09-25 21:55:46 +00001253 * \brief Set the session cache callbacks (server-side only)
Manuel Pégourié-Gonnard3e944932014-11-20 18:29:41 +01001254 * If not set, no session resuming is done (except if session
1255 * tickets are enabled too).
Paul Bakker5121ce52009-01-03 21:22:43 +00001256 *
Paul Bakker0a597072012-09-25 21:55:46 +00001257 * The session cache has the responsibility to check for stale
1258 * entries based on timeout. See RFC 5246 for recommendations.
1259 *
1260 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
1261 * connection shutdown, so do not cache the pointer! Either set
1262 * it to NULL or make a full copy of the certificate.
1263 *
1264 * The get callback is called once during the initial handshake
1265 * to enable session resuming. The get function has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001266 * following parameters: (void *parameter, mbedtls_ssl_session *session)
Paul Bakker0a597072012-09-25 21:55:46 +00001267 * If a valid entry is found, it should fill the master of
1268 * the session object with the cached values and return 0,
1269 * return 1 otherwise. Optionally peer_cert can be set as well
1270 * if it is properly present in cache entry.
1271 *
1272 * The set callback is called once during the initial handshake
1273 * to enable session resuming after the entire handshake has
1274 * been finished. The set function has the following parameters:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001275 * (void *parameter, const mbedtls_ssl_session *session). The function
Paul Bakker0a597072012-09-25 21:55:46 +00001276 * should create a cache entry for future retrieval based on
1277 * the data in the session structure and should keep in mind
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001278 * that the mbedtls_ssl_session object presented (and all its referenced
Paul Bakker0a597072012-09-25 21:55:46 +00001279 * data) is cleared by the SSL/TLS layer when the connection is
1280 * terminated. It is recommended to add metadata to determine if
1281 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +00001282 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +00001283 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001284 * \param conf SSL configuration
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001285 * \param p_cache parmater (context) for both callbacks
Paul Bakker0a597072012-09-25 21:55:46 +00001286 * \param f_get_cache session get callback
Paul Bakker0a597072012-09-25 21:55:46 +00001287 * \param f_set_cache session set callback
Paul Bakker5121ce52009-01-03 21:22:43 +00001288 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001289void mbedtls_ssl_conf_session_cache( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard5cb33082015-05-06 18:06:26 +01001290 void *p_cache,
1291 int (*f_get_cache)(void *, mbedtls_ssl_session *),
1292 int (*f_set_cache)(void *, const mbedtls_ssl_session *) );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001293#endif /* MBEDTLS_SSL_SRV_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001294
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001295#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001296/**
Paul Bakker0a597072012-09-25 21:55:46 +00001297 * \brief Request resumption of session (client-side only)
1298 * Session data is copied from presented session structure.
1299 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001300 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001301 * \param session session context
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001302 *
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001303 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001304 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001305 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard06650f62013-08-02 15:34:52 +02001306 * arguments are otherwise invalid
1307 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001308 * \sa mbedtls_ssl_get_session()
Paul Bakker5121ce52009-01-03 21:22:43 +00001309 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001310int mbedtls_ssl_set_session( mbedtls_ssl_context *ssl, const mbedtls_ssl_session *session );
1311#endif /* MBEDTLS_SSL_CLI_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001312
1313/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001314 * \brief Set the list of allowed ciphersuites and the preference
1315 * order. First in the list has the highest preference.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001316 * (Overrides all version specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +00001317 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001318 * The ciphersuites array is not copied, and must remain
1319 * valid for the lifetime of the ssl_config.
1320 *
Manuel Pégourié-Gonnardb4fe3cb2015-01-22 16:11:05 +00001321 * Note: The server uses its own preferences
1322 * over the preference of the client unless
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001323 * MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE is defined!
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001324 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001325 * \param conf SSL configuration
Paul Bakkere3166ce2011-01-27 17:40:50 +00001326 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +00001327 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001328void mbedtls_ssl_conf_ciphersuites( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001329 const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +00001330
1331/**
Paul Bakkercf1d73b2014-01-14 14:08:13 +01001332 * \brief Set the list of allowed ciphersuites and the
1333 * preference order for a specific version of the protocol.
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001334 * (Only useful on the server side)
1335 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001336 * The ciphersuites array is not copied, and must remain
1337 * valid for the lifetime of the ssl_config.
1338 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001339 * \param conf SSL configuration
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001340 * \param ciphersuites 0-terminated list of allowed ciphersuites
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001341 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001342 * supported)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001343 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1344 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1345 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Manuel Pégourié-Gonnardb21ca2a2014-02-10 13:43:33 +01001346 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001347 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0
1348 * and MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001349 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001350void mbedtls_ssl_conf_ciphersuites_for_version( mbedtls_ssl_config *conf,
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001351 const int *ciphersuites,
1352 int major, int minor );
1353
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001354#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +02001355/**
Manuel Pégourié-Gonnard6e3ee3a2015-06-17 10:58:20 +02001356 * \brief Set the X.509 security profile used for verification
1357 *
1358 * \param conf SSL configuration
1359 * \param profile Profile to use
1360 */
1361void mbedtls_ssl_conf_cert_profile( mbedtls_ssl_config *conf,
1362 mbedtls_x509_crt_profile *profile );
1363
1364/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001365 * \brief Set the data required to verify peer certificate
1366 *
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001367 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001368 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +00001369 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +00001370 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001371void mbedtls_ssl_conf_ca_chain( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001372 mbedtls_x509_crt *ca_chain,
1373 mbedtls_x509_crl *ca_crl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001374
1375/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001376 * \brief Set own certificate chain and private key
1377 *
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001378 * \note own_cert should contain in order from the bottom up your
1379 * certificate chain. The top certificate (self-signed)
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001380 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +00001381 *
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001382 * \note On server, this function can be called multiple times to
1383 * provision more than one cert/key pair (eg one ECDSA, one
1384 * RSA with SHA-256, one RSA with SHA-1). An adequate
1385 * certificate will be selected according to the client's
1386 * advertised capabilities. In case mutliple certificates are
1387 * adequate, preference is given to the one set by the first
1388 * call to this function, then second, etc.
1389 *
1390 * \note On client, only the first call has any effect.
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001391 *
Manuel Pégourié-Gonnard17a40cd2015-05-10 23:17:17 +02001392 * \param conf SSL configuration
Paul Bakker1f9d02d2012-11-20 10:30:55 +01001393 * \param own_cert own public certificate chain
Manuel Pégourié-Gonnardac755232013-08-19 14:10:16 +02001394 * \param pk_key own private key
Manuel Pégourié-Gonnard834ea852013-09-23 14:46:13 +02001395 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001396 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00001397 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001398int mbedtls_ssl_conf_own_cert( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard8f618a82015-05-10 21:13:36 +02001399 mbedtls_x509_crt *own_cert,
1400 mbedtls_pk_context *pk_key );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001401#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +00001402
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001403#if defined(MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED)
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001404/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001405 * \brief Set the Pre Shared Key (PSK) and the expected identity name
1406 *
1407 * \note This is mainly useful for clients. Servers will usually
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001408 * want to use \c mbedtls_ssl_conf_psk_cb() instead.
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001409 *
Manuel Pégourié-Gonnard120fdbd2015-05-07 17:07:50 +01001410 * \param conf SSL configuration
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001411 * \param psk pointer to the pre-shared key
1412 * \param psk_len pre-shared key length
1413 * \param psk_identity pointer to the pre-shared key identity
1414 * \param psk_identity_len identity key length
Paul Bakker6db455e2013-09-18 17:29:31 +02001415 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001416 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001417 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001418int mbedtls_ssl_conf_psk( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001419 const unsigned char *psk, size_t psk_len,
1420 const unsigned char *psk_identity, size_t psk_identity_len );
1421
Paul Bakker6db455e2013-09-18 17:29:31 +02001422
1423/**
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001424 * \brief Set the Pre Shared Key (PSK) for the current handshake
1425 *
1426 * \note This should only be called inside the PSK callback,
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001427 * ie the function passed to \c mbedtls_ssl_conf_psk_cb().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001428 *
1429 * \param ssl SSL context
1430 * \param psk pointer to the pre-shared key
1431 * \param psk_len pre-shared key length
1432 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001433 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001434 */
1435int mbedtls_ssl_set_hs_psk( mbedtls_ssl_context *ssl,
1436 const unsigned char *psk, size_t psk_len );
1437
1438/**
1439 * \brief Set the PSK callback (server-side only).
Paul Bakker6db455e2013-09-18 17:29:31 +02001440 *
1441 * If set, the PSK callback is called for each
1442 * handshake where a PSK ciphersuite was negotiated.
Manuel Pégourié-Gonnarda612b442014-02-25 13:08:08 +01001443 * The caller provides the identity received and wants to
Paul Bakker6db455e2013-09-18 17:29:31 +02001444 * receive the actual PSK data and length.
1445 *
1446 * The callback has the following parameters: (void *parameter,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001447 * mbedtls_ssl_context *ssl, const unsigned char *psk_identity,
Paul Bakker6db455e2013-09-18 17:29:31 +02001448 * size_t identity_len)
1449 * If a valid PSK identity is found, the callback should use
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001450 * \c mbedtls_ssl_set_hs_psk() on the ssl context to set the
1451 * correct PSK and return 0.
Paul Bakker6db455e2013-09-18 17:29:31 +02001452 * Any other return value will result in a denied PSK identity.
1453 *
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001454 * \note If you set a PSK callback using this function, then you
1455 * don't need to set a PSK key and identity using
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001456 * \c mbedtls_ssl_conf_psk().
Manuel Pégourié-Gonnard4b682962015-05-07 15:59:54 +01001457 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001458 * \param conf SSL configuration
Paul Bakker6db455e2013-09-18 17:29:31 +02001459 * \param f_psk PSK identity function
1460 * \param p_psk PSK identity parameter
1461 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001462void mbedtls_ssl_conf_psk_cb( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001463 int (*f_psk)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker6db455e2013-09-18 17:29:31 +02001464 size_t),
1465 void *p_psk );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001466#endif /* MBEDTLS_KEY_EXCHANGE__SOME__PSK_ENABLED */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +02001467
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001468#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_SRV_C)
Paul Bakker5121ce52009-01-03 21:22:43 +00001469/**
1470 * \brief Set the Diffie-Hellman public P and G values,
1471 * read as hexadecimal strings (server-side only)
Manuel Pégourié-Gonnard1028b742015-05-06 17:33:07 +01001472 * (Default: MBEDTLS_DHM_RFC5114_MODP_2048_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +00001473 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001474 * \param conf SSL configuration
Paul Bakker5121ce52009-01-03 21:22:43 +00001475 * \param dhm_P Diffie-Hellman-Merkle modulus
1476 * \param dhm_G Diffie-Hellman-Merkle generator
1477 *
1478 * \return 0 if successful
1479 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001480int mbedtls_ssl_conf_dh_param( mbedtls_ssl_config *conf, const char *dhm_P, const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +00001481
1482/**
Paul Bakker1b57b062011-01-06 15:48:19 +00001483 * \brief Set the Diffie-Hellman public P and G values,
1484 * read from existing context (server-side only)
1485 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001486 * \param conf SSL configuration
Paul Bakker1b57b062011-01-06 15:48:19 +00001487 * \param dhm_ctx Diffie-Hellman-Merkle context
1488 *
1489 * \return 0 if successful
1490 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001491int mbedtls_ssl_conf_dh_param_ctx( mbedtls_ssl_config *conf, mbedtls_dhm_context *dhm_ctx );
Manuel Pégourié-Gonnardcf141ca2015-05-20 10:35:51 +02001492#endif /* MBEDTLS_DHM_C && defined(MBEDTLS_SSL_SRV_C) */
Paul Bakker1b57b062011-01-06 15:48:19 +00001493
Manuel Pégourié-Gonnardbd990d62015-06-11 14:49:42 +02001494#if defined(MBEDTLS_DHM_C) && defined(MBEDTLS_SSL_CLI_C)
1495/**
1496 * \brief Set the minimum length for Diffie-Hellman parameters.
1497 * (Client-side only.)
1498 * (Default: 1024 bits.)
1499 *
1500 * \param conf SSL configuration
1501 * \param bitlen Minimum bit length of the DHM prime
1502 */
1503void mbedtls_ssl_conf_dhm_min_bitlen( mbedtls_ssl_config *conf,
1504 unsigned int bitlen );
1505#endif /* MBEDTLS_DHM_C && MBEDTLS_SSL_CLI_C */
1506
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001507#if defined(MBEDTLS_SSL_SET_CURVES)
Gergely Budai987bfb52014-01-19 21:48:42 +01001508/**
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001509 * \brief Set the allowed curves in order of preference.
Manuel Pégourié-Gonnard5de25802014-02-03 15:56:49 +01001510 * (Default: all defined curves.)
Gergely Budai987bfb52014-01-19 21:48:42 +01001511 *
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001512 * On server: this only affects selection of the ECDHE curve;
1513 * the curves used for ECDH and ECDSA are determined by the
1514 * list of available certificates instead.
1515 *
1516 * On client: this affects the list of curves offered for any
Manuel Pégourié-Gonnardab240102014-02-04 16:18:07 +01001517 * use. The server can override our preference order.
1518 *
1519 * Both sides: limits the set of curves used by peer to the
1520 * listed curves for any use (ECDH(E), certificates).
Gergely Budai987bfb52014-01-19 21:48:42 +01001521 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001522 * \param conf SSL configuration
Manuel Pégourié-Gonnardcd49f762014-02-04 15:14:13 +01001523 * \param curves Ordered list of allowed curves,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001524 * terminated by MBEDTLS_ECP_DP_NONE.
Gergely Budai987bfb52014-01-19 21:48:42 +01001525 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001526void mbedtls_ssl_conf_curves( mbedtls_ssl_config *conf, const mbedtls_ecp_group_id *curves );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001527#endif /* MBEDTLS_SSL_SET_CURVES */
Gergely Budai987bfb52014-01-19 21:48:42 +01001528
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001529#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker1b57b062011-01-06 15:48:19 +00001530/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00001531 * \brief Set hostname for ServerName TLS extension
1532 * (client-side only)
Paul Bakker6db455e2013-09-18 17:29:31 +02001533 *
Paul Bakker5121ce52009-01-03 21:22:43 +00001534 *
1535 * \param ssl SSL context
1536 * \param hostname the server hostname
1537 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001538 * \return 0 if successful or MBEDTLS_ERR_SSL_ALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +00001539 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001540int mbedtls_ssl_set_hostname( mbedtls_ssl_context *ssl, const char *hostname );
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001541#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +00001542
Manuel Pégourié-Gonnardbc2b7712015-05-06 11:14:19 +01001543#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Paul Bakker5121ce52009-01-03 21:22:43 +00001544/**
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001545 * \brief Set own certificate and key for the current handshake
1546 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001547 * \note Same as \c mbedtls_ssl_conf_own_cert() but for use within
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001548 * the SNI callback.
1549 *
1550 * \param ssl SSL context
1551 * \param own_cert own public certificate chain
1552 * \param pk_key own private key
1553 *
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001554 * \return 0 on success or MBEDTLS_ERR_SSL_ALLOC_FAILED
Manuel Pégourié-Gonnard1af6c852015-05-10 23:10:37 +02001555 */
1556int mbedtls_ssl_set_hs_own_cert( mbedtls_ssl_context *ssl,
1557 mbedtls_x509_crt *own_cert,
1558 mbedtls_pk_context *pk_key );
1559
1560/**
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001561 * \brief Set the data required to verify peer certificate for the
1562 * current handshake
1563 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001564 * \note Same as \c mbedtls_ssl_conf_ca_chain() but for use within
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001565 * the SNI callback.
1566 *
1567 * \param ssl SSL context
1568 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
1569 * \param ca_crl trusted CA CRLs
1570 */
1571void mbedtls_ssl_set_hs_ca_chain( mbedtls_ssl_context *ssl,
1572 mbedtls_x509_crt *ca_chain,
1573 mbedtls_x509_crl *ca_crl );
1574
1575/**
Paul Bakker5701cdc2012-09-27 21:49:42 +00001576 * \brief Set server side ServerName TLS extension callback
1577 * (optional, server-side only).
1578 *
1579 * If set, the ServerName callback is called whenever the
1580 * server receives a ServerName TLS extension from the client
1581 * during a handshake. The ServerName callback has the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001582 * following parameters: (void *parameter, mbedtls_ssl_context *ssl,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001583 * const unsigned char *hostname, size_t len). If a suitable
1584 * certificate is found, the callback should set the
Manuel Pégourié-Gonnard22bfa4b2015-05-11 08:46:37 +02001585 * certificate(s) and key(s) to use with \c
1586 * mbedtls_ssl_set_hs_own_cert() (can be called repeatedly),
1587 * and optionally adjust the CA with \c
1588 * mbedtls_ssl_set_hs_ca_chain() and return 0. The callback
1589 * should return -1 to abort the handshake at this point.
Paul Bakker5701cdc2012-09-27 21:49:42 +00001590 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001591 * \param conf SSL configuration
Paul Bakker5701cdc2012-09-27 21:49:42 +00001592 * \param f_sni verification function
1593 * \param p_sni verification parameter
1594 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001595void mbedtls_ssl_conf_sni( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001596 int (*f_sni)(void *, mbedtls_ssl_context *, const unsigned char *,
Paul Bakker5701cdc2012-09-27 21:49:42 +00001597 size_t),
1598 void *p_sni );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001599#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Paul Bakker5701cdc2012-09-27 21:49:42 +00001600
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001601#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001602/**
1603 * \brief Set the supported Application Layer Protocols.
1604 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001605 * \param conf SSL configuration
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001606 * \param protos NULL-terminated list of supported protocols,
1607 * in decreasing preference order.
Manuel Pégourié-Gonnard0b874dc2014-04-07 10:57:45 +02001608 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001609 * \return 0 on success, or MBEDTLS_ERR_SSL_BAD_INPUT_DATA.
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001610 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001611int mbedtls_ssl_conf_alpn_protocols( mbedtls_ssl_config *conf, const char **protos );
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001612
1613/**
1614 * \brief Get the name of the negotiated Application Layer Protocol.
1615 * This function should be called after the handshake is
1616 * completed.
1617 *
1618 * \param ssl SSL context
1619 *
1620 * \return Protcol name, or NULL if no protocol was negotiated.
1621 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001622const char *mbedtls_ssl_get_alpn_protocol( const mbedtls_ssl_context *ssl );
1623#endif /* MBEDTLS_SSL_ALPN */
Manuel Pégourié-Gonnard7e250d42014-04-04 16:08:41 +02001624
Paul Bakker5701cdc2012-09-27 21:49:42 +00001625/**
Paul Bakker490ecc82011-10-06 13:04:09 +00001626 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +02001627 * and/or accepted at the server side
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001628 * (Default: MBEDTLS_SSL_MAX_MAJOR_VERSION, MBEDTLS_SSL_MAX_MINOR_VERSION)
Paul Bakker2fbefde2013-06-29 16:01:15 +02001629 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001630 * \note This ignores ciphersuites from higher versions.
1631 *
1632 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1633 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001634 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001635 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001636 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1637 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1638 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1639 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +00001640 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001641void mbedtls_ssl_conf_max_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker490ecc82011-10-06 13:04:09 +00001642
Paul Bakker1d29fb52012-09-28 13:28:45 +00001643/**
1644 * \brief Set the minimum accepted SSL/TLS protocol version
Manuel Pégourié-Gonnard8c8be1e2015-03-31 14:21:11 +02001645 * (Default: TLS 1.0)
Paul Bakkerd2f068e2013-08-27 21:19:20 +02001646 *
Manuel Pégourié-Gonnard448ea502015-01-12 11:40:14 +01001647 * \note Input outside of the SSL_MAX_XXXXX_VERSION and
1648 * SSL_MIN_XXXXX_VERSION range is ignored.
1649 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001650 * \note MBEDTLS_SSL_MINOR_VERSION_0 (SSL v3) should be avoided.
Paul Bakker1d29fb52012-09-28 13:28:45 +00001651 *
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001652 * \note With DTLS, use MBEDTLS_SSL_MINOR_VERSION_2 for DTLS 1.0 and
1653 * MBEDTLS_SSL_MINOR_VERSION_3 for DTLS 1.2
1654 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001655 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001656 * \param major Major version number (only MBEDTLS_SSL_MAJOR_VERSION_3 supported)
1657 * \param minor Minor version number (MBEDTLS_SSL_MINOR_VERSION_0,
1658 * MBEDTLS_SSL_MINOR_VERSION_1 and MBEDTLS_SSL_MINOR_VERSION_2,
1659 * MBEDTLS_SSL_MINOR_VERSION_3 supported)
Paul Bakker1d29fb52012-09-28 13:28:45 +00001660 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001661void mbedtls_ssl_conf_min_version( mbedtls_ssl_config *conf, int major, int minor );
Paul Bakker1d29fb52012-09-28 13:28:45 +00001662
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001663#if defined(MBEDTLS_SSL_FALLBACK_SCSV) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001664/**
1665 * \brief Set the fallback flag (client-side only).
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001666 * (Default: MBEDTLS_SSL_IS_NOT_FALLBACK).
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001667 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001668 * \note Set to MBEDTLS_SSL_IS_FALLBACK when preparing a fallback
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001669 * connection, that is a connection with max_version set to a
1670 * lower value than the value you're willing to use. Such
1671 * fallback connections are not recommended but are sometimes
1672 * necessary to interoperate with buggy (version-intolerant)
1673 * servers.
1674 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001675 * \warning You should NOT set this to MBEDTLS_SSL_IS_FALLBACK for
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001676 * non-fallback connections! This would appear to work for a
1677 * while, then cause failures when the server is upgraded to
1678 * support a newer TLS version.
1679 *
Manuel Pégourié-Gonnard684b0592015-05-06 09:27:31 +01001680 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001681 * \param fallback MBEDTLS_SSL_IS_NOT_FALLBACK or MBEDTLS_SSL_IS_FALLBACK
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001682 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001683void mbedtls_ssl_conf_fallback( mbedtls_ssl_config *conf, char fallback );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001684#endif /* MBEDTLS_SSL_FALLBACK_SCSV && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard1cbd39d2014-10-20 13:34:59 +02001685
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001686#if defined(MBEDTLS_SSL_ENCRYPT_THEN_MAC)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001687/**
1688 * \brief Enable or disable Encrypt-then-MAC
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001689 * (Default: MBEDTLS_SSL_ETM_ENABLED)
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001690 *
1691 * \note This should always be enabled, it is a security
1692 * improvement, and should not cause any interoperability
1693 * issue (used only if the peer supports it too).
1694 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001695 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001696 * \param etm MBEDTLS_SSL_ETM_ENABLED or MBEDTLS_SSL_ETM_DISABLED
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001697 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001698void mbedtls_ssl_conf_encrypt_then_mac( mbedtls_ssl_config *conf, char etm );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001699#endif /* MBEDTLS_SSL_ENCRYPT_THEN_MAC */
Manuel Pégourié-Gonnard699cafa2014-10-27 13:57:03 +01001700
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001701#if defined(MBEDTLS_SSL_EXTENDED_MASTER_SECRET)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001702/**
1703 * \brief Enable or disable Extended Master Secret negotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001704 * (Default: MBEDTLS_SSL_EXTENDED_MS_ENABLED)
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001705 *
1706 * \note This should always be enabled, it is a security fix to the
1707 * protocol, and should not cause any interoperability issue
1708 * (used only if the peer supports it too).
1709 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001710 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001711 * \param ems MBEDTLS_SSL_EXTENDED_MS_ENABLED or MBEDTLS_SSL_EXTENDED_MS_DISABLED
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001712 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001713void mbedtls_ssl_conf_extended_master_secret( mbedtls_ssl_config *conf, char ems );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001714#endif /* MBEDTLS_SSL_EXTENDED_MASTER_SECRET */
Manuel Pégourié-Gonnard367381f2014-10-20 18:40:56 +02001715
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001716#if defined(MBEDTLS_ARC4_C)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01001717/**
1718 * \brief Disable or enable support for RC4
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001719 * (Default: MBEDTLS_SSL_ARC4_DISABLED)
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01001720 *
Manuel Pégourié-Gonnard849b1742015-03-20 19:13:22 +00001721 * \warning Use of RC4 in (D)TLS has been prohibited by RFC ????
1722 * for security reasons. Use at your own risks.
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01001723 *
1724 * \note This function will likely be removed in future versions as
1725 * RC4 will then be disabled by default at compile time.
1726 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001727 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001728 * \param arc4 MBEDTLS_SSL_ARC4_ENABLED or MBEDTLS_SSL_ARC4_DISABLED
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01001729 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001730void mbedtls_ssl_conf_arc4_support( mbedtls_ssl_config *conf, char arc4 );
Manuel Pégourié-Gonnard66dc5552015-05-14 12:28:21 +02001731#endif /* MBEDTLS_ARC4_C */
Manuel Pégourié-Gonnardbd47a582015-01-12 13:43:29 +01001732
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001733#if defined(MBEDTLS_SSL_MAX_FRAGMENT_LENGTH)
Paul Bakker490ecc82011-10-06 13:04:09 +00001734/**
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001735 * \brief Set the maximum fragment length to emit and/or negotiate
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001736 * (Default: MBEDTLS_SSL_MAX_CONTENT_LEN, usually 2^14 bytes)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001737 * (Server: set maximum fragment length to emit,
1738 * usually negotiated by the client during handshake
1739 * (Client: set maximum fragment length to emit *and*
1740 * negotiate with the server during handshake)
1741 *
Manuel Pégourié-Gonnard6bf89d62015-05-05 17:01:57 +01001742 * \param conf SSL configuration
Paul Bakkerdcbfdcc2013-09-10 16:16:50 +02001743 * \param mfl_code Code for maximum fragment length (allowed values:
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001744 * MBEDTLS_SSL_MAX_FRAG_LEN_512, MBEDTLS_SSL_MAX_FRAG_LEN_1024,
1745 * MBEDTLS_SSL_MAX_FRAG_LEN_2048, MBEDTLS_SSL_MAX_FRAG_LEN_4096)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001746 *
Manuel Pégourié-Gonnardeecb43c2015-05-12 12:56:41 +02001747 * \return 0 if successful or MBEDTLS_ERR_SSL_BAD_INPUT_DATA
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001748 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001749int mbedtls_ssl_conf_max_frag_len( mbedtls_ssl_config *conf, unsigned char mfl_code );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001750#endif /* MBEDTLS_SSL_MAX_FRAGMENT_LENGTH */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001751
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001752#if defined(MBEDTLS_SSL_TRUNCATED_HMAC)
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +02001753/**
Manuel Pégourié-Gonnarde117a8f2015-01-09 12:39:35 +01001754 * \brief Activate negotiation of truncated HMAC
Manuel Pégourié-Gonnard662c6e82015-05-06 17:39:23 +01001755 * (Default: MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02001756 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001757 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001758 * \param truncate Enable or disable (MBEDTLS_SSL_TRUNC_HMAC_ENABLED or
1759 * MBEDTLS_SSL_TRUNC_HMAC_DISABLED)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02001760 */
Manuel Pégourié-Gonnard01e5e8c2015-05-11 10:11:56 +02001761void mbedtls_ssl_conf_truncated_hmac( mbedtls_ssl_config *conf, int truncate );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001762#endif /* MBEDTLS_SSL_TRUNCATED_HMAC */
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02001763
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001764#if defined(MBEDTLS_SSL_CBC_RECORD_SPLITTING)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01001765/**
1766 * \brief Enable / Disable 1/n-1 record splitting
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001767 * (Default: MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED)
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01001768 *
1769 * \note Only affects SSLv3 and TLS 1.0, not higher versions.
1770 * Does not affect non-CBC ciphersuites in any version.
1771 *
Manuel Pégourié-Gonnard17eab2b2015-05-05 16:34:53 +01001772 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001773 * \param split MBEDTLS_SSL_CBC_RECORD_SPLITTING_ENABLED or
1774 * MBEDTLS_SSL_CBC_RECORD_SPLITTING_DISABLED
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01001775 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001776void mbedtls_ssl_conf_cbc_record_splitting( mbedtls_ssl_config *conf, char split );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001777#endif /* MBEDTLS_SSL_CBC_RECORD_SPLITTING */
Manuel Pégourié-Gonnardcfa477e2015-01-07 14:50:54 +01001778
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001779#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_SSL_CLI_C)
Manuel Pégourié-Gonnarde980a992013-07-19 11:08:52 +02001780/**
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001781 * \brief Enable / Disable session tickets (client only).
1782 * (Default: MBEDTLS_SSL_SESSION_TICKETS_ENABLED.)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02001783 *
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001784 * \note On server, use \c mbedtls_ssl_conf_session_tickets_cb().
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02001785 *
Manuel Pégourié-Gonnard2b494452015-05-06 10:05:11 +01001786 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001787 * \param use_tickets Enable or disable (MBEDTLS_SSL_SESSION_TICKETS_ENABLED or
1788 * MBEDTLS_SSL_SESSION_TICKETS_DISABLED)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02001789 */
Manuel Pégourié-Gonnardb596abf2015-05-20 10:45:29 +02001790void mbedtls_ssl_conf_session_tickets( mbedtls_ssl_config *conf, int use_tickets );
1791#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02001792
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001793#if defined(MBEDTLS_SSL_RENEGOTIATION)
Manuel Pégourié-Gonnardaa0d4d12013-08-03 13:02:31 +02001794/**
Paul Bakker09f097d2012-10-23 11:54:56 +00001795 * \brief Enable / Disable renegotiation support for connection when
1796 * initiated by peer
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001797 * (Default: MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker09f097d2012-10-23 11:54:56 +00001798 *
Manuel Pégourié-Gonnard398b2062015-05-28 15:13:30 +02001799 * \warning It is recommended to always disable renegotation unless you
1800 * know you need it and you know what you're doing. In the
1801 * past, there has been several issues associated with
1802 * renegotiation or a poor understanding of its properties.
1803 *
1804 * \note Server-side, enabling renegotiation also makes the server
1805 * susceptible to a resource DoS by a malicious client.
Paul Bakker48916f92012-09-16 19:57:18 +00001806 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001807 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001808 * \param renegotiation Enable or disable (MBEDTLS_SSL_RENEGOTIATION_ENABLED or
1809 * MBEDTLS_SSL_RENEGOTIATION_DISABLED)
Paul Bakker48916f92012-09-16 19:57:18 +00001810 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001811void mbedtls_ssl_conf_renegotiation( mbedtls_ssl_config *conf, int renegotiation );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001812#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00001813
1814/**
1815 * \brief Prevent or allow legacy renegotiation.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001816 * (Default: MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION)
Paul Bakker9af723c2014-05-01 13:03:14 +02001817 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001818 * MBEDTLS_SSL_LEGACY_NO_RENEGOTIATION allows connections to
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00001819 * be established even if the peer does not support
1820 * secure renegotiation, but does not allow renegotiation
1821 * to take place if not secure.
1822 * (Interoperable and secure option)
1823 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001824 * MBEDTLS_SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00001825 * with non-upgraded peers. Allowing legacy renegotiation
1826 * makes the connection vulnerable to specific man in the
1827 * middle attacks. (See RFC 5746)
1828 * (Most interoperable and least secure option)
1829 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001830 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00001831 * if peer does not support secure renegotiation. Results
1832 * in interoperability issues with non-upgraded peers
1833 * that do not support renegotiation altogether.
1834 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00001835 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001836 * \param conf SSL configuration
Paul Bakker6831c4a2012-11-07 19:46:27 +00001837 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
1838 * SSL_ALLOW_LEGACY_RENEGOTIATION or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001839 * MBEDTLS_SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00001840 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001841void mbedtls_ssl_conf_legacy_renegotiation( mbedtls_ssl_config *conf, int allow_legacy );
Paul Bakker48916f92012-09-16 19:57:18 +00001842
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001843#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker48916f92012-09-16 19:57:18 +00001844/**
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001845 * \brief Enforce renegotiation requests.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02001846 * (Default: enforced, max_records = 16)
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02001847 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02001848 * When we request a renegotiation, the peer can comply or
1849 * ignore the request. This function allows us to decide
1850 * whether to enforce our renegotiation requests by closing
1851 * the connection if the peer doesn't comply.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02001852 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02001853 * However, records could already be in transit from the peer
1854 * when the request is emitted. In order to increase
1855 * reliability, we can accept a number of records before the
1856 * expected handshake records.
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02001857 *
1858 * The optimal value is highly dependent on the specific usage
1859 * scenario.
1860 *
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001861 * \note With DTLS and server-initiated renegotiation, the
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001862 * HelloRequest is retransmited every time mbedtls_ssl_read() times
Manuel Pégourié-Gonnarddf3acd82014-10-15 15:07:45 +02001863 * out or receives Application Data, until:
1864 * - max_records records have beens seen, if it is >= 0, or
1865 * - the number of retransmits that would happen during an
1866 * actual handshake has been reached.
1867 * Please remember the request might be lost a few times
1868 * if you consider setting max_records to a really low value.
1869 *
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02001870 * \warning On client, the grace period can only happen during
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001871 * mbedtls_ssl_read(), as opposed to mbedtls_ssl_write() and mbedtls_ssl_renegotiate()
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02001872 * which always behave as if max_record was 0. The reason is,
1873 * if we receive application data from the server, we need a
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001874 * place to write it, which only happens during mbedtls_ssl_read().
Manuel Pégourié-Gonnard44ade652014-08-19 13:58:40 +02001875 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001876 * \param conf SSL configuration
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001877 * \param max_records Use MBEDTLS_SSL_RENEGOTIATION_NOT_ENFORCED if you don't want to
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02001878 * enforce renegotiation, or a non-negative value to enforce
1879 * it but allow for a grace period of max_records records.
1880 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001881void mbedtls_ssl_conf_renegotiation_enforced( mbedtls_ssl_config *conf, int max_records );
Manuel Pégourié-Gonnarda9964db2014-07-03 19:29:16 +02001882
1883/**
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01001884 * \brief Set record counter threshold for periodic renegotiation.
1885 * (Default: 2^64 - 256.)
1886 *
1887 * Renegotiation is automatically triggered when a record
1888 * counter (outgoing or ingoing) crosses the defined
1889 * threshold. The default value is meant to prevent the
1890 * connection from being closed when the counter is about to
1891 * reached its maximal value (it is not allowed to wrap).
1892 *
1893 * Lower values can be used to enforce policies such as "keys
1894 * must be refreshed every N packets with cipher X".
1895 *
Manuel Pégourié-Gonnardd36e33f2015-05-05 10:45:39 +02001896 * \param conf SSL configuration
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01001897 * \param period The threshold value: a big-endian 64-bit number.
1898 * Set to 2^64 - 1 to disable periodic renegotiation
1899 */
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02001900void mbedtls_ssl_conf_renegotiation_period( mbedtls_ssl_config *conf,
Manuel Pégourié-Gonnard837f0fe2014-11-05 13:58:53 +01001901 const unsigned char period[8] );
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001902#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker5121ce52009-01-03 21:22:43 +00001903
Paul Bakker43ca69c2011-01-15 17:35:19 +00001904/**
1905 * \brief Return the number of data bytes available to read
1906 *
1907 * \param ssl SSL context
1908 *
1909 * \return how many bytes are available in the read buffer
1910 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001911size_t mbedtls_ssl_get_bytes_avail( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001912
1913/**
1914 * \brief Return the result of the certificate verification
1915 *
1916 * \param ssl SSL context
1917 *
Manuel Pégourié-Gonnarde89163c2015-01-23 14:30:57 +00001918 * \return 0 if successful,
1919 * -1 if result is not available (eg because the handshake was
1920 * aborted too early), or
1921 * a combination of BADCERT_xxx and BADCRL_xxx flags, see
1922 * x509.h
Paul Bakker5121ce52009-01-03 21:22:43 +00001923 */
Manuel Pégourié-Gonnarde6ef16f2015-05-11 19:54:43 +02001924uint32_t mbedtls_ssl_get_verify_result( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00001925
1926/**
1927 * \brief Return the name of the current ciphersuite
1928 *
1929 * \param ssl SSL context
1930 *
1931 * \return a string containing the ciphersuite name
1932 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001933const char *mbedtls_ssl_get_ciphersuite( const mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001934
1935/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00001936 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
1937 *
1938 * \param ssl SSL context
1939 *
1940 * \return a string containing the SSL version
1941 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001942const char *mbedtls_ssl_get_version( const mbedtls_ssl_context *ssl );
Paul Bakker43ca69c2011-01-15 17:35:19 +00001943
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02001944/**
1945 * \brief Return the (maximum) number of bytes added by the record
1946 * layer: header + encryption/MAC overhead (inc. padding)
1947 *
1948 * \param ssl SSL context
1949 *
1950 * \return Current maximum record expansion in bytes, or
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001951 * MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE if compression is
Manuel Pégourié-Gonnard932e3932015-04-03 16:37:14 +02001952 * enabled, which makes expansion much less predictable
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02001953 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001954int mbedtls_ssl_get_record_expansion( const mbedtls_ssl_context *ssl );
Manuel Pégourié-Gonnard9b35f182014-10-14 17:47:31 +02001955
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001956#if defined(MBEDTLS_X509_CRT_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00001957/**
Paul Bakkerb0550d92012-10-30 07:51:03 +00001958 * \brief Return the peer certificate from the current connection
1959 *
1960 * Note: Can be NULL in case no certificate was sent during
1961 * the handshake. Different calls for the same connection can
1962 * return the same or different pointers for the same
1963 * certificate and even a different certificate altogether.
1964 * The peer cert CAN change in a single connection if
1965 * renegotiation is performed.
1966 *
1967 * \param ssl SSL context
1968 *
1969 * \return the current peer certificate
1970 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001971const mbedtls_x509_crt *mbedtls_ssl_get_peer_cert( const mbedtls_ssl_context *ssl );
1972#endif /* MBEDTLS_X509_CRT_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00001973
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001974#if defined(MBEDTLS_SSL_CLI_C)
Paul Bakkerb0550d92012-10-30 07:51:03 +00001975/**
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001976 * \brief Save session in order to resume it later (client-side only)
1977 * Session data is copied to presented session structure.
1978 *
1979 * \warning Currently, peer certificate is lost in the operation.
1980 *
1981 * \param ssl SSL context
1982 * \param session session context
1983 *
1984 * \return 0 if successful,
Manuel Pégourié-Gonnard6a8ca332015-05-28 09:33:39 +02001985 * MBEDTLS_ERR_SSL_ALLOC_FAILED if memory allocation failed,
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001986 * MBEDTLS_ERR_SSL_BAD_INPUT_DATA if used server-side or
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001987 * arguments are otherwise invalid
1988 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001989 * \sa mbedtls_ssl_set_session()
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001990 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02001991int mbedtls_ssl_get_session( const mbedtls_ssl_context *ssl, mbedtls_ssl_session *session );
1992#endif /* MBEDTLS_SSL_CLI_C */
Manuel Pégourié-Gonnard74718032013-07-30 12:41:56 +02001993
1994/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001995 * \brief Perform the SSL handshake
1996 *
1997 * \param ssl SSL context
1998 *
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01001999 * \return 0 if successful, MBEDTLS_ERR_SSL_WANT_READ,
2000 * MBEDTLS_ERR_SSL_WANT_WRITE, or a specific SSL error code.
Manuel Pégourié-Gonnardb48ef9c2015-05-28 15:24:25 +02002001 *
2002 * \note If this function returns non-zero, then the ssl context
2003 * becomes unusable, and you should either free it or call
2004 * \c mbedtls_ssl_session_reset() on it before re-using it.
2005 * If DTLS is in use, then you may choose to handle
2006 * MBEDTLS_ERR_SSL_HELLO_VERIFY_REQUIRED specially for logging
2007 * purposes, but you still need to reset/free the context.
Paul Bakker5121ce52009-01-03 21:22:43 +00002008 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002009int mbedtls_ssl_handshake( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002010
2011/**
Paul Bakker1961b702013-01-25 14:49:24 +01002012 * \brief Perform a single step of the SSL handshake
2013 *
2014 * Note: the state of the context (ssl->state) will be at
2015 * the following state after execution of this function.
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002016 * Do not call this function if state is MBEDTLS_SSL_HANDSHAKE_OVER.
Paul Bakker1961b702013-01-25 14:49:24 +01002017 *
2018 * \param ssl SSL context
2019 *
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002020 * \return 0 if successful, MBEDTLS_ERR_SSL_WANT_READ,
2021 * MBEDTLS_ERR_SSL_WANT_WRITE, or a specific SSL error code.
Paul Bakker1961b702013-01-25 14:49:24 +01002022 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002023int mbedtls_ssl_handshake_step( mbedtls_ssl_context *ssl );
Paul Bakker1961b702013-01-25 14:49:24 +01002024
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002025#if defined(MBEDTLS_SSL_RENEGOTIATION)
Paul Bakker1961b702013-01-25 14:49:24 +01002026/**
Manuel Pégourié-Gonnard9c1e1892013-10-30 16:41:21 +01002027 * \brief Initiate an SSL renegotiation on the running connection.
2028 * Client: perform the renegotiation right now.
2029 * Server: request renegotiation, which will be performed
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002030 * during the next call to mbedtls_ssl_read() if honored by client.
Paul Bakker48916f92012-09-16 19:57:18 +00002031 *
2032 * \param ssl SSL context
2033 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002034 * \return 0 if successful, or any mbedtls_ssl_handshake() return value.
Paul Bakker48916f92012-09-16 19:57:18 +00002035 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002036int mbedtls_ssl_renegotiate( mbedtls_ssl_context *ssl );
2037#endif /* MBEDTLS_SSL_RENEGOTIATION */
Paul Bakker48916f92012-09-16 19:57:18 +00002038
2039/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002040 * \brief Read at most 'len' application data bytes
2041 *
2042 * \param ssl SSL context
2043 * \param buf buffer that will hold the data
Paul Bakker9e4ff952014-09-24 11:13:11 +02002044 * \param len maximum number of bytes to read
Paul Bakker5121ce52009-01-03 21:22:43 +00002045 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02002046 * \return the number of bytes read, or
2047 * 0 for EOF, or
2048 * a negative error code.
Paul Bakker5121ce52009-01-03 21:22:43 +00002049 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002050int mbedtls_ssl_read( mbedtls_ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002051
2052/**
2053 * \brief Write exactly 'len' application data bytes
2054 *
2055 * \param ssl SSL context
2056 * \param buf buffer holding the data
2057 * \param len how many bytes must be written
2058 *
Manuel Pégourié-Gonnard81abefd2015-05-29 12:53:47 +02002059 * \return the number of bytes written,
Paul Bakker5121ce52009-01-03 21:22:43 +00002060 * or a negative error code.
2061 *
Manuel Pégourié-Gonnard88369942015-05-06 16:19:31 +01002062 * \note When this function returns MBEDTLS_ERR_SSL_WANT_WRITE,
Paul Bakker5121ce52009-01-03 21:22:43 +00002063 * it must be called later with the *same* arguments,
2064 * until it returns a positive value.
Manuel Pégourié-Gonnard37e08e12014-10-13 17:55:52 +02002065 *
Manuel Pégourié-Gonnard8fbb01e2015-01-21 13:37:08 +00002066 * \note If the requested length is greater than the maximum
2067 * fragment length (either the built-in limit or the one set
2068 * or negotiated with the peer), then:
2069 * - with TLS, less bytes than requested are written. (In
2070 * order to write larger messages, this function should be
2071 * called in a loop.)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002072 * - with DTLS, MBEDTLS_ERR_SSL_BAD_INPUT_DATA is returned.
Paul Bakker5121ce52009-01-03 21:22:43 +00002073 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002074int mbedtls_ssl_write( mbedtls_ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00002075
2076/**
Paul Bakker0a925182012-04-16 06:46:41 +00002077 * \brief Send an alert message
2078 *
2079 * \param ssl SSL context
2080 * \param level The alert level of the message
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002081 * (MBEDTLS_SSL_ALERT_LEVEL_WARNING or MBEDTLS_SSL_ALERT_LEVEL_FATAL)
Paul Bakker0a925182012-04-16 06:46:41 +00002082 * \param message The alert message (SSL_ALERT_MSG_*)
2083 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00002084 * \return 0 if successful, or a specific SSL error code.
Paul Bakker0a925182012-04-16 06:46:41 +00002085 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002086int mbedtls_ssl_send_alert_message( mbedtls_ssl_context *ssl,
Paul Bakker0a925182012-04-16 06:46:41 +00002087 unsigned char level,
2088 unsigned char message );
2089/**
Paul Bakker5121ce52009-01-03 21:22:43 +00002090 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00002091 *
2092 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002093 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002094int mbedtls_ssl_close_notify( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002095
2096/**
Paul Bakker48916f92012-09-16 19:57:18 +00002097 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00002098 *
2099 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00002100 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002101void mbedtls_ssl_free( mbedtls_ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00002102
Paul Bakker48916f92012-09-16 19:57:18 +00002103/**
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002104 * \brief Initialize an SSL configuration context
2105 * Just makes the context ready for
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002106 * mbedtls_ssl_config_defaults() or mbedtls_ssl_config_free().
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002107 *
2108 * \note You need to call mbedtls_ssl_config_defaults() unless you
2109 * manually set all of the relevent fields yourself.
2110 *
2111 * \param conf SSL configuration context
2112 */
2113void mbedtls_ssl_config_init( mbedtls_ssl_config *conf );
2114
2115/**
2116 * \brief Load reasonnable default SSL configuration values.
2117 * (You need to call mbedtls_ssl_config_init() first.)
2118 *
2119 * \param conf SSL configuration context
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002120 * \param endpoint MBEDTLS_SSL_IS_CLIENT or MBEDTLS_SSL_IS_SERVER
2121 * \param transport MBEDTLS_SSL_TRANSPORT_STREAM for TLS, or
2122 * MBEDTLS_SSL_TRANSPORT_DATAGRAM for DTLS
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002123 *
Manuel Pégourié-Gonnard6729e792015-05-11 09:50:24 +02002124 * \note See \c mbedtls_ssl_conf_transport() for notes on DTLS.
Manuel Pégourié-Gonnard8620f732015-05-06 14:42:06 +01002125 *
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002126 * \return 0 if successful, or
Manuel Pégourié-Gonnard1b1e65f2015-06-11 13:29:15 +02002127 * MBEDTLS_ERR_XXX_ALLOC_FAILED on memory allocation error.
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002128 */
Manuel Pégourié-Gonnard419d5ae2015-05-04 19:32:36 +02002129int mbedtls_ssl_config_defaults( mbedtls_ssl_config *conf,
2130 int endpoint, int transport );
Manuel Pégourié-Gonnardcd523e22015-05-04 13:35:39 +02002131
2132/**
2133 * \brief Free an SSL configuration context
2134 *
2135 * \param conf SSL configuration context
2136 */
2137void mbedtls_ssl_config_free( mbedtls_ssl_config *conf );
2138
2139/**
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002140 * \brief Initialize SSL session structure
2141 *
2142 * \param session SSL session
2143 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002144void mbedtls_ssl_session_init( mbedtls_ssl_session *session );
Paul Bakkeraccaffe2014-06-26 13:37:14 +02002145
2146/**
Paul Bakker0a597072012-09-25 21:55:46 +00002147 * \brief Free referenced items in an SSL session including the
2148 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00002149 *
2150 * \param session SSL session
2151 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +02002152void mbedtls_ssl_session_free( mbedtls_ssl_session *session );
Paul Bakker48916f92012-09-16 19:57:18 +00002153
Paul Bakker5121ce52009-01-03 21:22:43 +00002154#ifdef __cplusplus
2155}
2156#endif
2157
2158#endif /* ssl.h */