blob: 9bb0c4438033a097269143e87480ac7a16f12bb7 [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 *
Paul Bakker68884e32013-01-07 18:20:04 +01006 * Copyright (C) 2006-2013, Brainspark B.V.
Paul Bakkerb96f1542010-07-18 20:36:00 +00007 *
8 * This file is part of PolarSSL (http://www.polarssl.org)
Paul Bakker84f12b72010-07-18 10:13:04 +00009 * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
Paul Bakkerb96f1542010-07-18 20:36:00 +000010 *
Paul Bakker77b385e2009-07-28 17:23:11 +000011 * All rights reserved.
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000012 *
Paul Bakkere0ccd0a2009-01-04 16:27:10 +000013 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Paul Bakker5121ce52009-01-03 21:22:43 +000026 */
Paul Bakker40e46942009-01-03 21:51:57 +000027#ifndef POLARSSL_SSL_H
28#define POLARSSL_SSL_H
Paul Bakker5121ce52009-01-03 21:22:43 +000029
Paul Bakkered27a042013-04-18 22:46:23 +020030#include "config.h"
Paul Bakker314052f2011-08-15 09:07:52 +000031#include "net.h"
Paul Bakkered27a042013-04-18 22:46:23 +020032#include "bignum.h"
33
Paul Bakker314052f2011-08-15 09:07:52 +000034#include "md5.h"
35#include "sha1.h"
Paul Bakkerd2681d82013-06-30 14:49:12 +020036#include "sha256.h"
37#include "sha512.h"
Paul Bakkered27a042013-04-18 22:46:23 +020038
Paul Bakker68884e32013-01-07 18:20:04 +010039#include "ssl_ciphersuites.h"
Paul Bakker43b7e352011-01-18 15:27:19 +000040
Paul Bakkered27a042013-04-18 22:46:23 +020041#if defined(POLARSSL_X509_PARSE_C)
42#include "x509.h"
43#endif
44
45#if defined(POLARSSL_RSA_C)
46#include "rsa.h"
47#endif
48
Paul Bakker48916f92012-09-16 19:57:18 +000049#if defined(POLARSSL_DHM_C)
50#include "dhm.h"
51#endif
52
Paul Bakker41c83d32013-03-20 14:39:14 +010053#if defined(POLARSSL_ECDH_C)
54#include "ecdh.h"
55#endif
56
Paul Bakker2770fbd2012-07-03 13:30:23 +000057#if defined(POLARSSL_ZLIB_SUPPORT)
58#include "zlib.h"
59#endif
60
Paul Bakkerfa9b1002013-07-03 15:31:03 +020061#if defined(POLARSSL_HAVE_TIME)
62#include <time.h>
63#endif
64
Paul Bakker09b1ec62011-07-27 16:28:54 +000065#if defined(_MSC_VER) && !defined(inline)
Paul Bakkeraf5c85f2011-04-18 03:47:52 +000066#define inline _inline
Paul Bakker569df2c2011-06-21 07:48:07 +000067#else
Paul Bakker09b1ec62011-07-27 16:28:54 +000068#if defined(__ARMCC_VERSION) && !defined(inline)
Paul Bakker569df2c2011-06-21 07:48:07 +000069#define inline __inline
Paul Bakker74fb74e2011-06-21 13:36:18 +000070#endif /* __ARMCC_VERSION */
Paul Bakker569df2c2011-06-21 07:48:07 +000071#endif /*_MSC_VER */
Paul Bakkeraf5c85f2011-04-18 03:47:52 +000072
Paul Bakker13e2dfe2009-07-28 07:18:38 +000073/*
74 * SSL Error codes
75 */
Paul Bakker9d781402011-05-09 16:17:09 +000076#define POLARSSL_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */
77#define POLARSSL_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */
78#define POLARSSL_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */
79#define POLARSSL_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */
Paul Bakker831a7552011-05-18 13:32:51 +000080#define POLARSSL_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */
Paul Bakker9d781402011-05-09 16:17:09 +000081#define POLARSSL_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */
82#define POLARSSL_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */
83#define POLARSSL_ERR_SSL_NO_SESSION_FOUND -0x7400 /**< No session to recover was found. */
84#define POLARSSL_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */
85#define POLARSSL_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message.*/
86#define POLARSSL_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */
Paul Bakker73a899a2013-04-17 19:11:36 +020087#define POLARSSL_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */
Paul Bakker9d781402011-05-09 16:17:09 +000088#define POLARSSL_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */
89#define POLARSSL_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */
90#define POLARSSL_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */
91#define POLARSSL_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */
92#define POLARSSL_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */
93#define POLARSSL_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */
94#define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */
95#define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */
96#define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */
97#define POLARSSL_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */
98#define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */
99#define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */
Paul Bakker41c83d32013-03-20 14:39:14 +0100100#define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */
101#define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */
Paul Bakker9d781402011-05-09 16:17:09 +0000102#define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */
103#define POLARSSL_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */
104#define POLARSSL_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */
Paul Bakker69e095c2011-12-10 21:55:01 +0000105#define POLARSSL_ERR_SSL_MALLOC_FAILED -0x7F00 /**< Memory allocation failed */
Paul Bakker05ef8352012-05-08 09:17:57 +0000106#define POLARSSL_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */
107#define POLARSSL_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000108#define POLARSSL_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */
Paul Bakker1d29fb52012-09-28 13:28:45 +0000109#define POLARSSL_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */
Paul Bakker5121ce52009-01-03 21:22:43 +0000110
111/*
112 * Various constants
113 */
114#define SSL_MAJOR_VERSION_3 3
115#define SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */
116#define SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */
117#define SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */
Paul Bakker1ef83d62012-04-11 12:09:53 +0000118#define SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000119
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200120/* RFC 6066 section 4 */
121#define SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
122#define SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
123#define SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
124#define SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
125#define SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
126
Paul Bakker5121ce52009-01-03 21:22:43 +0000127#define SSL_IS_CLIENT 0
128#define SSL_IS_SERVER 1
129#define SSL_COMPRESS_NULL 0
Paul Bakker2770fbd2012-07-03 13:30:23 +0000130#define SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000131
132#define SSL_VERIFY_NONE 0
133#define SSL_VERIFY_OPTIONAL 1
134#define SSL_VERIFY_REQUIRED 2
135
Paul Bakker48916f92012-09-16 19:57:18 +0000136#define SSL_INITIAL_HANDSHAKE 0
137#define SSL_RENEGOTIATION 1
138
139#define SSL_LEGACY_RENEGOTIATION 0
140#define SSL_SECURE_RENEGOTIATION 1
141
Paul Bakker7c900782012-11-04 16:29:08 +0000142#define SSL_RENEGOTIATION_DISABLED 0
143#define SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000144
Paul Bakkerd0f6fa72012-09-17 09:18:12 +0000145#define SSL_LEGACY_NO_RENEGOTIATION 0
146#define SSL_LEGACY_ALLOW_RENEGOTIATION 1
147#define SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000148
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200149/*
150 * Size of the input / output buffer.
151 * Note: the RFC defines the default size of SSL / TLS messages. If you
152 * change the value here, other clients / servers may not be able to
153 * communicate with you anymore. Only change this value if you control
154 * both sides of the connection and have it reduced at both sides!
155 */
156#if !defined(POLARSSL_CONFIG_OPTIONS)
157#define SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
158#endif /* !POLARSSL_CONFIG_OPTIONS */
Paul Bakker5121ce52009-01-03 21:22:43 +0000159
160/*
161 * Allow an extra 512 bytes for the record header
Paul Bakker2770fbd2012-07-03 13:30:23 +0000162 * and encryption overhead (counter + MAC + padding)
163 * and allow for a maximum of 1024 of compression expansion if
164 * enabled.
Paul Bakker5121ce52009-01-03 21:22:43 +0000165 */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000166#if defined(POLARSSL_ZLIB_SUPPORT)
167#define SSL_COMPRESSION_ADD 1024
168#else
169#define SSL_COMPRESSION_ADD 0
170#endif
171
172#define SSL_BUFFER_LEN (SSL_MAX_CONTENT_LEN + SSL_COMPRESSION_ADD + 512)
Paul Bakker5121ce52009-01-03 21:22:43 +0000173
Paul Bakker48916f92012-09-16 19:57:18 +0000174#define SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
175
Paul Bakker5121ce52009-01-03 21:22:43 +0000176/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000177 * Supported Signature and Hash algorithms (For TLS 1.2)
178 */
179#define SSL_HASH_NONE 0
180#define SSL_HASH_MD5 1
181#define SSL_HASH_SHA1 2
182#define SSL_HASH_SHA224 3
183#define SSL_HASH_SHA256 4
184#define SSL_HASH_SHA384 5
185#define SSL_HASH_SHA512 6
186
187#define SSL_SIG_RSA 1
188
189/*
Paul Bakker926af752012-11-23 13:38:07 +0100190 * Client Certificate Types
191 */
192#define SSL_CERT_TYPE_RSA_SIGN 1
193
194/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000195 * Message, alert and handshake types
196 */
197#define SSL_MSG_CHANGE_CIPHER_SPEC 20
198#define SSL_MSG_ALERT 21
199#define SSL_MSG_HANDSHAKE 22
200#define SSL_MSG_APPLICATION_DATA 23
201
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000202#define SSL_ALERT_LEVEL_WARNING 1
203#define SSL_ALERT_LEVEL_FATAL 2
204
Paul Bakkere93dfa72012-04-10 08:03:03 +0000205#define SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
206#define SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
207#define SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
208#define SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
209#define SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
210#define SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000211#define SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
Paul Bakkere93dfa72012-04-10 08:03:03 +0000212#define SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
213#define SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
214#define SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
215#define SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
216#define SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
217#define SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
218#define SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
219#define SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
220#define SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
221#define SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
222#define SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
223#define SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
224#define SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
225#define SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
226#define SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
227#define SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
228#define SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000229#define SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
Paul Bakker5701cdc2012-09-27 21:49:42 +0000230#define SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200231#define SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000232
233#define SSL_HS_HELLO_REQUEST 0
234#define SSL_HS_CLIENT_HELLO 1
235#define SSL_HS_SERVER_HELLO 2
236#define SSL_HS_CERTIFICATE 11
237#define SSL_HS_SERVER_KEY_EXCHANGE 12
238#define SSL_HS_CERTIFICATE_REQUEST 13
239#define SSL_HS_SERVER_HELLO_DONE 14
240#define SSL_HS_CERTIFICATE_VERIFY 15
241#define SSL_HS_CLIENT_KEY_EXCHANGE 16
242#define SSL_HS_FINISHED 20
243
244/*
245 * TLS extensions
246 */
Paul Bakker41c83d32013-03-20 14:39:14 +0100247#define TLS_EXT_SERVERNAME 0
248#define TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000249
Paul Bakker41c83d32013-03-20 14:39:14 +0100250#define TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
251#define TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000252
Paul Bakker41c83d32013-03-20 14:39:14 +0100253#define TLS_EXT_SIG_ALG 13
254
255#define TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000256
Paul Bakkereb2c6582012-09-27 19:15:01 +0000257/*
Paul Bakkered27a042013-04-18 22:46:23 +0200258 * Size defines
259 */
260#if !defined(POLARSSL_MPI_MAX_SIZE)
261#define POLARSSL_PREMASTER_SIZE 512
262#else
263#define POLARSSL_PREMASTER_SIZE POLARSSL_MPI_MAX_SIZE
264#endif
265
Paul Bakker407a0da2013-06-27 14:29:21 +0200266#ifdef __cplusplus
267extern "C" {
268#endif
269
Paul Bakkered27a042013-04-18 22:46:23 +0200270/*
Paul Bakkereb2c6582012-09-27 19:15:01 +0000271 * Generic function pointers for allowing external RSA private key
272 * implementations.
273 */
274typedef int (*rsa_decrypt_func)( void *ctx, int mode, size_t *olen,
275 const unsigned char *input, unsigned char *output,
276 size_t output_max_len );
277typedef int (*rsa_sign_func)( void *ctx,
278 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
279 int mode, int hash_id, unsigned int hashlen,
280 const unsigned char *hash, unsigned char *sig );
281typedef size_t (*rsa_key_len_func)( void *ctx );
282
Paul Bakker5121ce52009-01-03 21:22:43 +0000283/*
284 * SSL state machine
285 */
286typedef enum
287{
288 SSL_HELLO_REQUEST,
289 SSL_CLIENT_HELLO,
290 SSL_SERVER_HELLO,
291 SSL_SERVER_CERTIFICATE,
292 SSL_SERVER_KEY_EXCHANGE,
293 SSL_CERTIFICATE_REQUEST,
294 SSL_SERVER_HELLO_DONE,
295 SSL_CLIENT_CERTIFICATE,
296 SSL_CLIENT_KEY_EXCHANGE,
297 SSL_CERTIFICATE_VERIFY,
298 SSL_CLIENT_CHANGE_CIPHER_SPEC,
299 SSL_CLIENT_FINISHED,
300 SSL_SERVER_CHANGE_CIPHER_SPEC,
301 SSL_SERVER_FINISHED,
302 SSL_FLUSH_BUFFERS,
Paul Bakker48916f92012-09-16 19:57:18 +0000303 SSL_HANDSHAKE_WRAPUP,
Paul Bakker5121ce52009-01-03 21:22:43 +0000304 SSL_HANDSHAKE_OVER
305}
306ssl_states;
307
308typedef struct _ssl_session ssl_session;
309typedef struct _ssl_context ssl_context;
Paul Bakker48916f92012-09-16 19:57:18 +0000310typedef struct _ssl_transform ssl_transform;
311typedef struct _ssl_handshake_params ssl_handshake_params;
Paul Bakker5121ce52009-01-03 21:22:43 +0000312
313/*
Paul Bakker0a597072012-09-25 21:55:46 +0000314 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000315 */
316struct _ssl_session
317{
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200318#if defined(POLARSSL_HAVE_TIME)
Paul Bakker5121ce52009-01-03 21:22:43 +0000319 time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200320#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000321 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000322 int compression; /*!< chosen compression */
Paul Bakker23986e52011-04-24 08:57:21 +0000323 size_t length; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000324 unsigned char id[32]; /*!< session identifier */
325 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200326
327#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker48916f92012-09-16 19:57:18 +0000328 x509_cert *peer_cert; /*!< peer X.509 cert chain */
Paul Bakkered27a042013-04-18 22:46:23 +0200329#endif /* POLARSSL_X509_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +0000330};
331
Paul Bakker48916f92012-09-16 19:57:18 +0000332/*
333 * This structure contains a full set of runtime transform parameters
334 * either in negotiation or active.
335 */
336struct _ssl_transform
337{
338 /*
339 * Session specific crypto layer
340 */
Paul Bakker68884e32013-01-07 18:20:04 +0100341 const ssl_ciphersuite_t *ciphersuite_info;
342 /*!< Chosen cipersuite_info */
Paul Bakker48916f92012-09-16 19:57:18 +0000343 unsigned int keylen; /*!< symmetric key length */
344 size_t minlen; /*!< min. ciphertext length */
345 size_t ivlen; /*!< IV length */
346 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
347 size_t maclen; /*!< MAC length */
348
349 unsigned char iv_enc[16]; /*!< IV (encryption) */
350 unsigned char iv_dec[16]; /*!< IV (decryption) */
351
Paul Bakker68884e32013-01-07 18:20:04 +0100352 /* Needed only for SSL v3.0 secret */
353 unsigned char mac_enc[32]; /*!< SSL v3.0 secret (enc) */
354 unsigned char mac_dec[32]; /*!< SSL v3.0 secret (dec) */
355
356 md_context_t md_ctx_enc; /*!< MAC (encryption) */
357 md_context_t md_ctx_dec; /*!< MAC (decryption) */
Paul Bakker48916f92012-09-16 19:57:18 +0000358
Paul Bakker0f5281a2012-10-23 11:06:25 +0000359 uint32_t ctx_enc[136]; /*!< encryption context */
360 uint32_t ctx_dec[136]; /*!< decryption context */
Paul Bakker48916f92012-09-16 19:57:18 +0000361
362 /*
363 * Session specific compression layer
364 */
365#if defined(POLARSSL_ZLIB_SUPPORT)
366 z_stream ctx_deflate; /*!< compression context */
367 z_stream ctx_inflate; /*!< decompression context */
368#endif
369};
370
371/*
372 * This structure contains the parameters only needed during handshake.
373 */
374struct _ssl_handshake_params
375{
376 /*
377 * Handshake specific crypto variables
378 */
Paul Bakker23f36802012-09-28 14:15:14 +0000379 int sig_alg; /*!< Signature algorithm */
Paul Bakker926af752012-11-23 13:38:07 +0100380 int cert_type; /*!< Requested cert type */
381 int verify_sig_alg; /*!< Signature algorithm for verify */
Paul Bakker48916f92012-09-16 19:57:18 +0000382#if defined(POLARSSL_DHM_C)
383 dhm_context dhm_ctx; /*!< DHM key exchange */
384#endif
Paul Bakker41c83d32013-03-20 14:39:14 +0100385#if defined(POLARSSL_ECDH_C)
386 ecdh_context ecdh_ctx; /*!< ECDH key exchange */
387#endif
Paul Bakker41c83d32013-03-20 14:39:14 +0100388 int ec_curve; /*!< Selected elliptic curve */
Paul Bakkered27a042013-04-18 22:46:23 +0200389#if defined(POLARSSL_ECP_C)
Paul Bakker41c83d32013-03-20 14:39:14 +0100390 int ec_point_format; /*!< Client supported format */
391#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000392
393 /*
394 * Checksum contexts
395 */
Paul Bakker9e36f042013-06-30 14:34:05 +0200396 md5_context fin_md5;
397 sha1_context fin_sha1;
398 sha256_context fin_sha256;
399 sha512_context fin_sha512;
Paul Bakker48916f92012-09-16 19:57:18 +0000400
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200401 void (*update_checksum)(ssl_context *, const unsigned char *, size_t);
Paul Bakker48916f92012-09-16 19:57:18 +0000402 void (*calc_verify)(ssl_context *, unsigned char *);
403 void (*calc_finished)(ssl_context *, unsigned char *, int);
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200404 int (*tls_prf)(const unsigned char *, size_t, const char *,
405 const unsigned char *, size_t,
Paul Bakker48916f92012-09-16 19:57:18 +0000406 unsigned char *, size_t);
407
408 size_t pmslen; /*!< premaster length */
409
410 unsigned char randbytes[64]; /*!< random bytes */
Paul Bakkered27a042013-04-18 22:46:23 +0200411 unsigned char premaster[POLARSSL_PREMASTER_SIZE];
Paul Bakkerdf2bb752012-10-24 14:30:00 +0000412 /*!< premaster secret */
Paul Bakker0a597072012-09-25 21:55:46 +0000413
414 int resume; /*!< session resume indicator*/
Paul Bakker2fbefde2013-06-29 16:01:15 +0200415 int max_major_ver; /*!< max. major version client*/
416 int max_minor_ver; /*!< max. minor version client*/
Paul Bakker48916f92012-09-16 19:57:18 +0000417};
418
Paul Bakker5121ce52009-01-03 21:22:43 +0000419struct _ssl_context
420{
421 /*
422 * Miscellaneous
423 */
424 int state; /*!< SSL handshake: current state */
Paul Bakker48916f92012-09-16 19:57:18 +0000425 int renegotiation; /*!< Initial or renegotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000426
427 int major_ver; /*!< equal to SSL_MAJOR_VERSION_3 */
428 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
429
Paul Bakker2fbefde2013-06-29 16:01:15 +0200430 int max_major_ver; /*!< max. major version used */
431 int max_minor_ver; /*!< max. minor version used */
432 int min_major_ver; /*!< min. major version used */
433 int min_minor_ver; /*!< min. minor version used */
Paul Bakker5121ce52009-01-03 21:22:43 +0000434
435 /*
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000436 * Callbacks (RNG, debug, I/O, verification)
Paul Bakker5121ce52009-01-03 21:22:43 +0000437 */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000438 int (*f_rng)(void *, unsigned char *, size_t);
Paul Bakkerff60ee62010-03-16 21:09:09 +0000439 void (*f_dbg)(void *, int, const char *);
Paul Bakker23986e52011-04-24 08:57:21 +0000440 int (*f_recv)(void *, unsigned char *, size_t);
Paul Bakker39bb4182011-06-21 07:36:43 +0000441 int (*f_send)(void *, const unsigned char *, size_t);
Paul Bakker0a597072012-09-25 21:55:46 +0000442 int (*f_get_cache)(void *, ssl_session *);
443 int (*f_set_cache)(void *, const ssl_session *);
Paul Bakker5701cdc2012-09-27 21:49:42 +0000444 int (*f_sni)(void *, ssl_context *, const unsigned char *, size_t);
Paul Bakker5121ce52009-01-03 21:22:43 +0000445
446 void *p_rng; /*!< context for the RNG function */
447 void *p_dbg; /*!< context for the debug function */
448 void *p_recv; /*!< context for reading operations */
449 void *p_send; /*!< context for writing operations */
Paul Bakker0a597072012-09-25 21:55:46 +0000450 void *p_get_cache; /*!< context for cache retrieval */
451 void *p_set_cache; /*!< context for cache store */
Paul Bakker5701cdc2012-09-27 21:49:42 +0000452 void *p_sni; /*!< context for SNI extension */
Paul Bakkere667c982012-11-20 13:50:22 +0100453 void *p_hw_data; /*!< context for HW acceleration */
Paul Bakker5121ce52009-01-03 21:22:43 +0000454
Paul Bakkered27a042013-04-18 22:46:23 +0200455#if defined(POLARSSL_X509_PARSE_C)
456 int (*f_vrfy)(void *, x509_cert *, int, int *);
457 void *p_vrfy; /*!< context for verification */
458#endif
459
Paul Bakker5121ce52009-01-03 21:22:43 +0000460 /*
461 * Session layer
462 */
Paul Bakker48916f92012-09-16 19:57:18 +0000463 ssl_session *session_in; /*!< current session data (in) */
464 ssl_session *session_out; /*!< current session data (out) */
465 ssl_session *session; /*!< negotiated session data */
466 ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000467
Paul Bakker48916f92012-09-16 19:57:18 +0000468 ssl_handshake_params *handshake; /*!< params required only during
469 the handshake process */
470
471 /*
472 * Record layer transformations
473 */
474 ssl_transform *transform_in; /*!< current transform params (in) */
475 ssl_transform *transform_out; /*!< current transform params (in) */
476 ssl_transform *transform; /*!< negotiated transform params */
477 ssl_transform *transform_negotiate; /*!< transform params in negotiation */
478
Paul Bakker5121ce52009-01-03 21:22:43 +0000479 /*
480 * Record layer (incoming data)
481 */
482 unsigned char *in_ctr; /*!< 64-bit incoming message counter */
483 unsigned char *in_hdr; /*!< 5-byte record header (in_ctr+8) */
Paul Bakker92be97b2013-01-02 17:30:03 +0100484 unsigned char *in_iv; /*!< ivlen-byte IV (in_hdr+5) */
485 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000486 unsigned char *in_offt; /*!< read offset in application data */
487
488 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000489 size_t in_msglen; /*!< record header: message length */
490 size_t in_left; /*!< amount of data read so far */
Paul Bakker5121ce52009-01-03 21:22:43 +0000491
Paul Bakker23986e52011-04-24 08:57:21 +0000492 size_t in_hslen; /*!< current handshake message length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000493 int nb_zero; /*!< # of 0-length encrypted messages */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200494 int record_read; /*!< record is already present */
Paul Bakker5121ce52009-01-03 21:22:43 +0000495
496 /*
497 * Record layer (outgoing data)
498 */
499 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
500 unsigned char *out_hdr; /*!< 5-byte record header (out_ctr+8) */
Paul Bakker92be97b2013-01-02 17:30:03 +0100501 unsigned char *out_iv; /*!< ivlen-byte IV (out_hdr+5) */
502 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000503
504 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000505 size_t out_msglen; /*!< record header: message length */
506 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +0000507
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200508 /* Maximum fragment length extension (RFC 6066 section 4) */
509 unsigned char mfl_code; /*!< numerical code for MaxFragmentLength */
510 uint16_t max_frag_len; /*!< value of MaxFragmentLength */
511
Paul Bakker5121ce52009-01-03 21:22:43 +0000512 /*
513 * PKI layer
514 */
Paul Bakkered27a042013-04-18 22:46:23 +0200515#if defined(POLARSSL_RSA_C)
Paul Bakkereb2c6582012-09-27 19:15:01 +0000516 void *rsa_key; /*!< own RSA private key */
517 rsa_decrypt_func rsa_decrypt; /*!< function for RSA decrypt*/
518 rsa_sign_func rsa_sign; /*!< function for RSA sign */
519 rsa_key_len_func rsa_key_len; /*!< function for RSA key len*/
Paul Bakkered27a042013-04-18 22:46:23 +0200520#endif /* POLARSSL_RSA_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +0000521
Paul Bakkered27a042013-04-18 22:46:23 +0200522#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000523 x509_cert *own_cert; /*!< own X.509 certificate */
524 x509_cert *ca_chain; /*!< own trusted CA chain */
Paul Bakker40ea7de2009-05-03 10:18:48 +0000525 x509_crl *ca_crl; /*!< trusted CA CRLs */
Paul Bakker57b79142010-03-24 06:51:15 +0000526 const char *peer_cn; /*!< expected peer CN */
Paul Bakkered27a042013-04-18 22:46:23 +0200527#endif /* POLARSSL_X509_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +0000528
Paul Bakker48916f92012-09-16 19:57:18 +0000529 /*
530 * User settings
531 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000532 int endpoint; /*!< 0: client, 1: server */
533 int authmode; /*!< verification mode */
534 int client_auth; /*!< flag for client auth. */
535 int verify_result; /*!< verification result */
Paul Bakker48916f92012-09-16 19:57:18 +0000536 int disable_renegotiation; /*!< enable/disable renegotiation */
537 int allow_legacy_renegotiation; /*!< allow legacy renegotiation */
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200538 const int *ciphersuite_list[4]; /*!< allowed ciphersuites / version */
Paul Bakker5121ce52009-01-03 21:22:43 +0000539
Paul Bakker48916f92012-09-16 19:57:18 +0000540#if defined(POLARSSL_DHM_C)
541 mpi dhm_P; /*!< prime modulus for DHM */
542 mpi dhm_G; /*!< generator for DHM */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000543#endif
544
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200545#if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED)
546 /*
547 * PSK values
548 */
549 const unsigned char *psk;
550 size_t psk_len;
551 const unsigned char *psk_identity;
552 size_t psk_identity_len;
553#endif
554
Paul Bakker5121ce52009-01-03 21:22:43 +0000555 /*
556 * TLS extensions
557 */
558 unsigned char *hostname;
Paul Bakker23986e52011-04-24 08:57:21 +0000559 size_t hostname_len;
Paul Bakker48916f92012-09-16 19:57:18 +0000560
561 /*
562 * Secure renegotiation
563 */
564 int secure_renegotiation; /*!< does peer support legacy or
565 secure renegotiation */
566 size_t verify_data_len; /*!< length of verify data stored */
567 char own_verify_data[36]; /*!< previous handshake verify data */
568 char peer_verify_data[36]; /*!< previous handshake verify data */
Paul Bakker5121ce52009-01-03 21:22:43 +0000569};
570
Paul Bakker05ef8352012-05-08 09:17:57 +0000571#if defined(POLARSSL_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +0100572
573#define SSL_CHANNEL_OUTBOUND 0
574#define SSL_CHANNEL_INBOUND 1
575
Paul Bakker05ef8352012-05-08 09:17:57 +0000576extern int (*ssl_hw_record_init)(ssl_context *ssl,
577 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100578 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +0000579 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100580 size_t ivlen,
581 const unsigned char *mac_enc, const unsigned char *mac_dec,
582 size_t maclen);
583extern int (*ssl_hw_record_activate)(ssl_context *ssl, int direction);
Paul Bakker05ef8352012-05-08 09:17:57 +0000584extern int (*ssl_hw_record_reset)(ssl_context *ssl);
585extern int (*ssl_hw_record_write)(ssl_context *ssl);
586extern int (*ssl_hw_record_read)(ssl_context *ssl);
587extern int (*ssl_hw_record_finish)(ssl_context *ssl);
588#endif
589
Paul Bakker5121ce52009-01-03 21:22:43 +0000590/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000591 * \brief Returns the list of ciphersuites supported by the SSL/TLS module.
Paul Bakker72f62662011-01-16 21:27:44 +0000592 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000593 * \return a statically allocated array of ciphersuites, the last
594 * entry is 0.
Paul Bakker72f62662011-01-16 21:27:44 +0000595 */
Paul Bakker68884e32013-01-07 18:20:04 +0100596const int *ssl_list_ciphersuites( void );
Paul Bakker72f62662011-01-16 21:27:44 +0000597
598/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000599 * \brief Return the name of the ciphersuite associated with the given
600 * ID
Paul Bakker72f62662011-01-16 21:27:44 +0000601 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000602 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +0000603 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000604 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +0000605 */
Paul Bakkere3166ce2011-01-27 17:40:50 +0000606const char *ssl_get_ciphersuite_name( const int ciphersuite_id );
607
608/**
609 * \brief Return the ID of the ciphersuite associated with the given
610 * name
611 *
612 * \param ciphersuite_name SSL ciphersuite name
613 *
614 * \return the ID with the ciphersuite or 0 if not found
615 */
616int ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +0000617
618/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000619 * \brief Initialize an SSL context
620 *
621 * \param ssl SSL context
622 *
Paul Bakker69e095c2011-12-10 21:55:01 +0000623 * \return 0 if successful, or POLARSSL_ERR_SSL_MALLOC_FAILED if
624 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000625 */
626int ssl_init( ssl_context *ssl );
627
628/**
Paul Bakker7eb013f2011-10-06 12:37:39 +0000629 * \brief Reset an already initialized SSL context for re-use
630 * while retaining application-set variables, function
631 * pointers and data.
632 *
633 * \param ssl SSL context
Paul Bakker48916f92012-09-16 19:57:18 +0000634 * \return 0 if successful, or POLASSL_ERR_SSL_MALLOC_FAILED,
635 POLARSSL_ERR_SSL_HW_ACCEL_FAILED or
Paul Bakker2770fbd2012-07-03 13:30:23 +0000636 * POLARSSL_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +0000637 */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000638int ssl_session_reset( ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +0000639
640/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000641 * \brief Set the current endpoint type
642 *
643 * \param ssl SSL context
644 * \param endpoint must be SSL_IS_CLIENT or SSL_IS_SERVER
645 */
646void ssl_set_endpoint( ssl_context *ssl, int endpoint );
647
648/**
649 * \brief Set the certificate verification mode
650 *
651 * \param ssl SSL context
Paul Bakker37ca75d2011-01-06 12:28:03 +0000652 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +0000653 *
654 * SSL_VERIFY_NONE: peer certificate is not checked (default),
655 * this is insecure and SHOULD be avoided.
656 *
657 * SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
658 * handshake continues even if verification failed;
659 * ssl_get_verify_result() can be called after the
660 * handshake is complete.
661 *
662 * SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
663 * handshake is aborted if verification failed.
664 */
665void ssl_set_authmode( ssl_context *ssl, int authmode );
666
Paul Bakkered27a042013-04-18 22:46:23 +0200667#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000668/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000669 * \brief Set the verification callback (Optional).
670 *
Paul Bakker915275b2012-09-28 07:10:55 +0000671 * If set, the verify callback is called for each
672 * certificate in the chain. For implementation
673 * information, please see \c x509parse_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000674 *
675 * \param ssl SSL context
676 * \param f_vrfy verification function
677 * \param p_vrfy verification parameter
678 */
679void ssl_set_verify( ssl_context *ssl,
Paul Bakker915275b2012-09-28 07:10:55 +0000680 int (*f_vrfy)(void *, x509_cert *, int, int *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000681 void *p_vrfy );
Paul Bakkered27a042013-04-18 22:46:23 +0200682#endif /* POLARSSL_X509_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000683
684/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000685 * \brief Set the random number generator callback
686 *
687 * \param ssl SSL context
688 * \param f_rng RNG function
689 * \param p_rng RNG parameter
690 */
691void ssl_set_rng( ssl_context *ssl,
Paul Bakkera3d195c2011-11-27 21:07:34 +0000692 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +0000693 void *p_rng );
694
695/**
696 * \brief Set the debug callback
697 *
698 * \param ssl SSL context
699 * \param f_dbg debug function
700 * \param p_dbg debug parameter
701 */
702void ssl_set_dbg( ssl_context *ssl,
Paul Bakkerff60ee62010-03-16 21:09:09 +0000703 void (*f_dbg)(void *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +0000704 void *p_dbg );
705
706/**
707 * \brief Set the underlying BIO read and write callbacks
708 *
709 * \param ssl SSL context
710 * \param f_recv read callback
711 * \param p_recv read parameter
712 * \param f_send write callback
713 * \param p_send write parameter
714 */
715void ssl_set_bio( ssl_context *ssl,
Paul Bakker23986e52011-04-24 08:57:21 +0000716 int (*f_recv)(void *, unsigned char *, size_t), void *p_recv,
Paul Bakker39bb4182011-06-21 07:36:43 +0000717 int (*f_send)(void *, const unsigned char *, size_t), void *p_send );
Paul Bakker5121ce52009-01-03 21:22:43 +0000718
719/**
Paul Bakker0a597072012-09-25 21:55:46 +0000720 * \brief Set the session cache callbacks (server-side only)
721 * If not set, no session resuming is done.
Paul Bakker5121ce52009-01-03 21:22:43 +0000722 *
Paul Bakker0a597072012-09-25 21:55:46 +0000723 * The session cache has the responsibility to check for stale
724 * entries based on timeout. See RFC 5246 for recommendations.
725 *
726 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
727 * connection shutdown, so do not cache the pointer! Either set
728 * it to NULL or make a full copy of the certificate.
729 *
730 * The get callback is called once during the initial handshake
731 * to enable session resuming. The get function has the
732 * following parameters: (void *parameter, ssl_session *session)
733 * If a valid entry is found, it should fill the master of
734 * the session object with the cached values and return 0,
735 * return 1 otherwise. Optionally peer_cert can be set as well
736 * if it is properly present in cache entry.
737 *
738 * The set callback is called once during the initial handshake
739 * to enable session resuming after the entire handshake has
740 * been finished. The set function has the following parameters:
741 * (void *parameter, const ssl_session *session). The function
742 * should create a cache entry for future retrieval based on
743 * the data in the session structure and should keep in mind
744 * that the ssl_session object presented (and all its referenced
745 * data) is cleared by the SSL/TLS layer when the connection is
746 * terminated. It is recommended to add metadata to determine if
747 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +0000748 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +0000749 *
750 * \param ssl SSL context
751 * \param f_get_cache session get callback
752 * \param p_get_cache session get parameter
753 * \param f_set_cache session set callback
754 * \param p_set_cache session set parameter
Paul Bakker5121ce52009-01-03 21:22:43 +0000755 */
Paul Bakker0a597072012-09-25 21:55:46 +0000756void ssl_set_session_cache( ssl_context *ssl,
757 int (*f_get_cache)(void *, ssl_session *), void *p_get_cache,
758 int (*f_set_cache)(void *, const ssl_session *), void *p_set_cache );
Paul Bakker5121ce52009-01-03 21:22:43 +0000759
760/**
Paul Bakker0a597072012-09-25 21:55:46 +0000761 * \brief Request resumption of session (client-side only)
762 * Session data is copied from presented session structure.
763 *
764 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
765 * connection shutdown, so do not cache the pointer! Either set
766 * it to NULL or make a full copy of the certificate when
767 * storing the session for use in this function.
Paul Bakker5121ce52009-01-03 21:22:43 +0000768 *
769 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +0000770 * \param session session context
771 */
Paul Bakker0a597072012-09-25 21:55:46 +0000772void ssl_set_session( ssl_context *ssl, const ssl_session *session );
Paul Bakker5121ce52009-01-03 21:22:43 +0000773
774/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000775 * \brief Set the list of allowed ciphersuites
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200776 * (Overrides all version specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +0000777 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000778 * \param ssl SSL context
779 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +0000780 */
Paul Bakkerb68cad62012-08-23 08:34:18 +0000781void ssl_set_ciphersuites( ssl_context *ssl, const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +0000782
783/**
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200784 * \brief Set the list of allowed ciphersuites for a specific
785 * version of the protocol.
786 * (Only useful on the server side)
787 *
788 * \param ssl SSL context
789 * \param ciphersuites 0-terminated list of allowed ciphersuites
790 * \param major Major version number (only SSL_MAJOR_VERSION_3
791 * supported)
792 * \param minor Minor version number (SSL_MINOR_VERSION_0,
793 * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2,
794 * SSL_MINOR_VERSION_3 supported)
795 */
796void ssl_set_ciphersuites_for_version( ssl_context *ssl,
797 const int *ciphersuites,
798 int major, int minor );
799
Paul Bakkered27a042013-04-18 22:46:23 +0200800#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200801/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000802 * \brief Set the data required to verify peer certificate
803 *
804 * \param ssl SSL context
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100805 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +0000806 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +0000807 * \param peer_cn expected peer CommonName (or NULL)
Paul Bakker5121ce52009-01-03 21:22:43 +0000808 */
809void ssl_set_ca_chain( ssl_context *ssl, x509_cert *ca_chain,
Paul Bakker57b79142010-03-24 06:51:15 +0000810 x509_crl *ca_crl, const char *peer_cn );
Paul Bakker5121ce52009-01-03 21:22:43 +0000811
812/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100813 * \brief Set own certificate chain and private key
814 *
815 * Note: own_cert should contain IN order from the bottom
816 * up your certificate chain. The top certificate (self-signed)
817 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +0000818 *
819 * \param ssl SSL context
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100820 * \param own_cert own public certificate chain
Paul Bakker5121ce52009-01-03 21:22:43 +0000821 * \param rsa_key own private RSA key
822 */
823void ssl_set_own_cert( ssl_context *ssl, x509_cert *own_cert,
824 rsa_context *rsa_key );
825
Paul Bakker43b7e352011-01-18 15:27:19 +0000826/**
Paul Bakkereb2c6582012-09-27 19:15:01 +0000827 * \brief Set own certificate and alternate non-PolarSSL private
828 * key and handling callbacks, such as the PKCS#11 wrappers
829 * or any other external private key handler.
830 * (see the respective RSA functions in rsa.h for documentation
831 * of the callback parameters, with the only change being
832 * that the rsa_context * is a void * in the callbacks)
Paul Bakker43b7e352011-01-18 15:27:19 +0000833 *
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100834 * Note: own_cert should contain IN order from the bottom
835 * up your certificate chain. The top certificate (self-signed)
836 * can be omitted.
837 *
Paul Bakker43b7e352011-01-18 15:27:19 +0000838 * \param ssl SSL context
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100839 * \param own_cert own public certificate chain
Paul Bakkereb2c6582012-09-27 19:15:01 +0000840 * \param rsa_key alternate implementation private RSA key
841 * \param rsa_decrypt_func alternate implementation of \c rsa_pkcs1_decrypt()
842 * \param rsa_sign_func alternate implementation of \c rsa_pkcs1_sign()
843 * \param rsa_key_len_func function returning length of RSA key in bytes
Paul Bakker43b7e352011-01-18 15:27:19 +0000844 */
Paul Bakkereb2c6582012-09-27 19:15:01 +0000845void ssl_set_own_cert_alt( ssl_context *ssl, x509_cert *own_cert,
846 void *rsa_key,
847 rsa_decrypt_func rsa_decrypt,
848 rsa_sign_func rsa_sign,
849 rsa_key_len_func rsa_key_len );
Paul Bakkered27a042013-04-18 22:46:23 +0200850#endif /* POLARSSL_X509_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +0000851
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200852#if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED)
853/**
854 * \brief Set the Pre Shared Key (PSK) and the identity name connected
855 * to it. The PSK is used in all PSK-based ciphersuites.
856 *
857 * \param ssl SSL context
858 * \param psk pointer to the pre-shared key
859 * \param psk_len pre-shared key length
860 * \param psk_identity pointer to the pre-shared key identity
861 * \param psk_identity_len identity key length
862 */
863void ssl_set_psk( ssl_context *ssl, const unsigned char *psk, size_t psk_len,
864 const unsigned char *psk_identity, size_t psk_identity_len );
865#endif /* POLARSSL_KEY_EXCHANGE_PSK_ENABLED */
866
Paul Bakker48916f92012-09-16 19:57:18 +0000867#if defined(POLARSSL_DHM_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000868/**
869 * \brief Set the Diffie-Hellman public P and G values,
870 * read as hexadecimal strings (server-side only)
Paul Bakker62f2dee2012-09-28 07:31:51 +0000871 * (Default: POLARSSL_DHM_RFC5114_MODP_1024_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +0000872 *
873 * \param ssl SSL context
874 * \param dhm_P Diffie-Hellman-Merkle modulus
875 * \param dhm_G Diffie-Hellman-Merkle generator
876 *
877 * \return 0 if successful
878 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000879int ssl_set_dh_param( ssl_context *ssl, const char *dhm_P, const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +0000880
881/**
Paul Bakker1b57b062011-01-06 15:48:19 +0000882 * \brief Set the Diffie-Hellman public P and G values,
883 * read from existing context (server-side only)
884 *
885 * \param ssl SSL context
886 * \param dhm_ctx Diffie-Hellman-Merkle context
887 *
888 * \return 0 if successful
889 */
890int ssl_set_dh_param_ctx( ssl_context *ssl, dhm_context *dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +0000891#endif
Paul Bakker1b57b062011-01-06 15:48:19 +0000892
893/**
Paul Bakker5701cdc2012-09-27 21:49:42 +0000894 * \brief Set hostname for ServerName TLS extension
895 * (client-side only)
Paul Bakker5121ce52009-01-03 21:22:43 +0000896 *
897 *
898 * \param ssl SSL context
899 * \param hostname the server hostname
900 *
Paul Bakkerb15b8512012-01-13 13:44:06 +0000901 * \return 0 if successful or POLARSSL_ERR_SSL_MALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +0000902 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000903int ssl_set_hostname( ssl_context *ssl, const char *hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +0000904
905/**
Paul Bakker5701cdc2012-09-27 21:49:42 +0000906 * \brief Set server side ServerName TLS extension callback
907 * (optional, server-side only).
908 *
909 * If set, the ServerName callback is called whenever the
910 * server receives a ServerName TLS extension from the client
911 * during a handshake. The ServerName callback has the
912 * following parameters: (void *parameter, ssl_context *ssl,
913 * const unsigned char *hostname, size_t len). If a suitable
914 * certificate is found, the callback should set the
915 * certificate and key to use with ssl_set_own_cert() (and
916 * possibly adjust the CA chain as well) and return 0. The
917 * callback should return -1 to abort the handshake at this
918 * point.
919 *
920 * \param ssl SSL context
921 * \param f_sni verification function
922 * \param p_sni verification parameter
923 */
924void ssl_set_sni( ssl_context *ssl,
925 int (*f_sni)(void *, ssl_context *, const unsigned char *,
926 size_t),
927 void *p_sni );
928
929/**
Paul Bakker490ecc82011-10-06 13:04:09 +0000930 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +0200931 * and/or accepted at the server side
932 * (Default: SSL_MAJOR_VERSION_3, SSL_MINOR_VERSION_3)
933 *
934 * Note: This prevents ciphersuites from 'higher' versions to
935 * be ignored.
Paul Bakker490ecc82011-10-06 13:04:09 +0000936 *
937 * \param ssl SSL context
938 * \param major Major version number (only SSL_MAJOR_VERSION_3 supported)
939 * \param minor Minor version number (SSL_MINOR_VERSION_0,
Paul Bakker1ef83d62012-04-11 12:09:53 +0000940 * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2,
941 * SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +0000942 */
943void ssl_set_max_version( ssl_context *ssl, int major, int minor );
944
Paul Bakker1d29fb52012-09-28 13:28:45 +0000945
946/**
947 * \brief Set the minimum accepted SSL/TLS protocol version
948 * (Default: SSL_MAJOR_VERSION_3, SSL_MINOR_VERSION_0)
949 *
950 * \param ssl SSL context
951 * \param major Major version number (only SSL_MAJOR_VERSION_3 supported)
952 * \param minor Minor version number (SSL_MINOR_VERSION_0,
953 * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2,
954 * SSL_MINOR_VERSION_3 supported)
955 */
956void ssl_set_min_version( ssl_context *ssl, int major, int minor );
957
Paul Bakker490ecc82011-10-06 13:04:09 +0000958/**
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200959 * \brief Set the maximum fragment length to emit and/or negotiate
960 * (Default: SSL_MAX_CONTENT_LEN, usually 2^14 bytes)
961 * (Server: set maximum fragment length to emit,
962 * usually negotiated by the client during handshake
963 * (Client: set maximum fragment length to emit *and*
964 * negotiate with the server during handshake)
965 *
966 * \param ssl SSL context
967 * \param mfl Code for maximum fragment length (allowed values:
968 * SSL_MAX_FRAG_LEN_512, SSL_MAX_FRAG_LEN_1024,
969 * SSL_MAX_FRAG_LEN_2048, SSL_MAX_FRAG_LEN_4096)
970 *
971 * \return O if successful or POLARSSL_ERR_SSL_BAD_INPUT_DATA
972 */
973int ssl_set_max_frag_len( ssl_context *ssl, unsigned char mfl_code );
974
975/**
Paul Bakker09f097d2012-10-23 11:54:56 +0000976 * \brief Enable / Disable renegotiation support for connection when
977 * initiated by peer
978 * (Default: SSL_RENEGOTIATION_DISABLED)
979 *
980 * Note: A server with support enabled is more vulnerable for a
Paul Bakker7c900782012-11-04 16:29:08 +0000981 * resource DoS by a malicious client. You should enable this on
982 * a client to enable server-initiated renegotiation.
Paul Bakker48916f92012-09-16 19:57:18 +0000983 *
984 * \param ssl SSL context
985 * \param renegotiation Enable or disable (SSL_RENEGOTIATION_ENABLED or
986 * SSL_RENEGOTIATION_DISABLED)
987 */
988void ssl_set_renegotiation( ssl_context *ssl, int renegotiation );
989
990/**
991 * \brief Prevent or allow legacy renegotiation.
Paul Bakkerd0f6fa72012-09-17 09:18:12 +0000992 * (Default: SSL_LEGACY_NO_RENEGOTIATION)
993 *
994 * SSL_LEGACY_NO_RENEGOTIATION allows connections to
995 * be established even if the peer does not support
996 * secure renegotiation, but does not allow renegotiation
997 * to take place if not secure.
998 * (Interoperable and secure option)
999 *
1000 * SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
1001 * with non-upgraded peers. Allowing legacy renegotiation
1002 * makes the connection vulnerable to specific man in the
1003 * middle attacks. (See RFC 5746)
1004 * (Most interoperable and least secure option)
1005 *
1006 * SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
1007 * if peer does not support secure renegotiation. Results
1008 * in interoperability issues with non-upgraded peers
1009 * that do not support renegotiation altogether.
1010 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00001011 *
1012 * \param ssl SSL context
Paul Bakker6831c4a2012-11-07 19:46:27 +00001013 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
1014 * SSL_ALLOW_LEGACY_RENEGOTIATION or
1015 * SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00001016 */
1017void ssl_legacy_renegotiation( ssl_context *ssl, int allow_legacy );
1018
1019/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001020 * \brief Return the number of data bytes available to read
1021 *
1022 * \param ssl SSL context
1023 *
1024 * \return how many bytes are available in the read buffer
1025 */
Paul Bakker23986e52011-04-24 08:57:21 +00001026size_t ssl_get_bytes_avail( const ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001027
1028/**
1029 * \brief Return the result of the certificate verification
1030 *
1031 * \param ssl SSL context
1032 *
1033 * \return 0 if successful, or a combination of:
1034 * BADCERT_EXPIRED
1035 * BADCERT_REVOKED
1036 * BADCERT_CN_MISMATCH
1037 * BADCERT_NOT_TRUSTED
1038 */
Paul Bakkerff60ee62010-03-16 21:09:09 +00001039int ssl_get_verify_result( const ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001040
1041/**
Paul Bakkere3166ce2011-01-27 17:40:50 +00001042 * \brief Return the name of the current ciphersuite
Paul Bakker5121ce52009-01-03 21:22:43 +00001043 *
1044 * \param ssl SSL context
1045 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001046 * \return a string containing the ciphersuite name
Paul Bakker5121ce52009-01-03 21:22:43 +00001047 */
Paul Bakkere3166ce2011-01-27 17:40:50 +00001048const char *ssl_get_ciphersuite( const ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001049
1050/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00001051 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
1052 *
1053 * \param ssl SSL context
1054 *
1055 * \return a string containing the SSL version
1056 */
1057const char *ssl_get_version( const ssl_context *ssl );
1058
Paul Bakkered27a042013-04-18 22:46:23 +02001059#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00001060/**
Paul Bakkerb0550d92012-10-30 07:51:03 +00001061 * \brief Return the peer certificate from the current connection
1062 *
1063 * Note: Can be NULL in case no certificate was sent during
1064 * the handshake. Different calls for the same connection can
1065 * return the same or different pointers for the same
1066 * certificate and even a different certificate altogether.
1067 * The peer cert CAN change in a single connection if
1068 * renegotiation is performed.
1069 *
1070 * \param ssl SSL context
1071 *
1072 * \return the current peer certificate
1073 */
1074const x509_cert *ssl_get_peer_cert( const ssl_context *ssl );
Paul Bakkered27a042013-04-18 22:46:23 +02001075#endif /* POLARSSL_X509_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00001076
1077/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001078 * \brief Perform the SSL handshake
1079 *
1080 * \param ssl SSL context
1081 *
Paul Bakker831a7552011-05-18 13:32:51 +00001082 * \return 0 if successful, POLARSSL_ERR_NET_WANT_READ,
1083 * POLARSSL_ERR_NET_WANT_WRITE, or a specific SSL error code.
Paul Bakker5121ce52009-01-03 21:22:43 +00001084 */
1085int ssl_handshake( ssl_context *ssl );
1086
1087/**
Paul Bakker1961b702013-01-25 14:49:24 +01001088 * \brief Perform a single step of the SSL handshake
1089 *
1090 * Note: the state of the context (ssl->state) will be at
1091 * the following state after execution of this function.
1092 * Do not call this function if state is SSL_HANDSHAKE_OVER.
1093 *
1094 * \param ssl SSL context
1095 *
1096 * \return 0 if successful, POLARSSL_ERR_NET_WANT_READ,
1097 * POLARSSL_ERR_NET_WANT_WRITE, or a specific SSL error code.
1098 */
1099int ssl_handshake_step( ssl_context *ssl );
1100
1101/**
Paul Bakker48916f92012-09-16 19:57:18 +00001102 * \brief Perform an SSL renegotiation on the running connection
1103 *
1104 * \param ssl SSL context
1105 *
1106 * \return 0 if succesful, or any ssl_handshake() return value.
1107 */
1108int ssl_renegotiate( ssl_context *ssl );
1109
1110/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001111 * \brief Read at most 'len' application data bytes
1112 *
1113 * \param ssl SSL context
1114 * \param buf buffer that will hold the data
1115 * \param len how many bytes must be read
1116 *
Paul Bakker831a7552011-05-18 13:32:51 +00001117 * \return This function returns the number of bytes read, 0 for EOF,
Paul Bakker5121ce52009-01-03 21:22:43 +00001118 * or a negative error code.
1119 */
Paul Bakker23986e52011-04-24 08:57:21 +00001120int ssl_read( ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00001121
1122/**
1123 * \brief Write exactly 'len' application data bytes
1124 *
1125 * \param ssl SSL context
1126 * \param buf buffer holding the data
1127 * \param len how many bytes must be written
1128 *
1129 * \return This function returns the number of bytes written,
1130 * or a negative error code.
1131 *
Paul Bakker831a7552011-05-18 13:32:51 +00001132 * \note When this function returns POLARSSL_ERR_NET_WANT_WRITE,
Paul Bakker5121ce52009-01-03 21:22:43 +00001133 * it must be called later with the *same* arguments,
1134 * until it returns a positive value.
1135 */
Paul Bakker23986e52011-04-24 08:57:21 +00001136int ssl_write( ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00001137
1138/**
Paul Bakker0a925182012-04-16 06:46:41 +00001139 * \brief Send an alert message
1140 *
1141 * \param ssl SSL context
1142 * \param level The alert level of the message
1143 * (SSL_ALERT_LEVEL_WARNING or SSL_ALERT_LEVEL_FATAL)
1144 * \param message The alert message (SSL_ALERT_MSG_*)
1145 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00001146 * \return 0 if successful, or a specific SSL error code.
Paul Bakker0a925182012-04-16 06:46:41 +00001147 */
1148int ssl_send_alert_message( ssl_context *ssl,
1149 unsigned char level,
1150 unsigned char message );
1151/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001152 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00001153 *
1154 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001155 */
1156int ssl_close_notify( ssl_context *ssl );
1157
1158/**
Paul Bakker48916f92012-09-16 19:57:18 +00001159 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00001160 *
1161 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001162 */
1163void ssl_free( ssl_context *ssl );
1164
Paul Bakker48916f92012-09-16 19:57:18 +00001165/**
Paul Bakker0a597072012-09-25 21:55:46 +00001166 * \brief Free referenced items in an SSL session including the
1167 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00001168 *
1169 * \param session SSL session
1170 */
1171void ssl_session_free( ssl_session *session );
1172
1173/**
1174 * \brief Free referenced items in an SSL transform context and clear
1175 * memory
1176 *
1177 * \param transform SSL transform context
1178 */
1179void ssl_transform_free( ssl_transform *transform );
1180
1181/**
1182 * \brief Free referenced items in an SSL handshake context and clear
1183 * memory
1184 *
1185 * \param handshake SSL handshake context
1186 */
1187void ssl_handshake_free( ssl_handshake_params *handshake );
1188
Paul Bakker5121ce52009-01-03 21:22:43 +00001189/*
1190 * Internal functions (do not call directly)
1191 */
Paul Bakker1961b702013-01-25 14:49:24 +01001192int ssl_handshake_client_step( ssl_context *ssl );
1193int ssl_handshake_server_step( ssl_context *ssl );
Paul Bakker48916f92012-09-16 19:57:18 +00001194void ssl_handshake_wrapup( ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001195
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00001196int ssl_send_fatal_handshake_failure( ssl_context *ssl );
1197
Paul Bakker5121ce52009-01-03 21:22:43 +00001198int ssl_derive_keys( ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001199
1200int ssl_read_record( ssl_context *ssl );
Paul Bakker831a7552011-05-18 13:32:51 +00001201/**
1202 * \return 0 if successful, POLARSSL_ERR_SSL_CONN_EOF on EOF or
1203 * another negative error code.
1204 */
Paul Bakker23986e52011-04-24 08:57:21 +00001205int ssl_fetch_input( ssl_context *ssl, size_t nb_want );
Paul Bakker5121ce52009-01-03 21:22:43 +00001206
1207int ssl_write_record( ssl_context *ssl );
1208int ssl_flush_output( ssl_context *ssl );
1209
1210int ssl_parse_certificate( ssl_context *ssl );
1211int ssl_write_certificate( ssl_context *ssl );
1212
1213int ssl_parse_change_cipher_spec( ssl_context *ssl );
1214int ssl_write_change_cipher_spec( ssl_context *ssl );
1215
1216int ssl_parse_finished( ssl_context *ssl );
1217int ssl_write_finished( ssl_context *ssl );
1218
Paul Bakker41c83d32013-03-20 14:39:14 +01001219void ssl_optimize_checksum( ssl_context *ssl, const ssl_ciphersuite_t *ciphersuite_info );
Paul Bakker380da532012-04-18 16:10:25 +00001220
Paul Bakker5121ce52009-01-03 21:22:43 +00001221#ifdef __cplusplus
1222}
1223#endif
1224
1225#endif /* ssl.h */