blob: 5b4e36f2ff4fbcea43ecf64466632a26df5dbdda [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é-Gonnard581e6b62013-07-18 12:32:27 +0200120/* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c
121 * NONE must be zero so that memset()ing session to zero works */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200122#define SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */
123#define SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */
124#define SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */
125#define SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */
126#define SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */
127
Paul Bakker5121ce52009-01-03 21:22:43 +0000128#define SSL_IS_CLIENT 0
129#define SSL_IS_SERVER 1
130#define SSL_COMPRESS_NULL 0
Paul Bakker2770fbd2012-07-03 13:30:23 +0000131#define SSL_COMPRESS_DEFLATE 1
Paul Bakker5121ce52009-01-03 21:22:43 +0000132
133#define SSL_VERIFY_NONE 0
134#define SSL_VERIFY_OPTIONAL 1
135#define SSL_VERIFY_REQUIRED 2
136
Paul Bakker48916f92012-09-16 19:57:18 +0000137#define SSL_INITIAL_HANDSHAKE 0
138#define SSL_RENEGOTIATION 1
139
140#define SSL_LEGACY_RENEGOTIATION 0
141#define SSL_SECURE_RENEGOTIATION 1
142
Paul Bakker7c900782012-11-04 16:29:08 +0000143#define SSL_RENEGOTIATION_DISABLED 0
144#define SSL_RENEGOTIATION_ENABLED 1
Paul Bakker48916f92012-09-16 19:57:18 +0000145
Paul Bakkerd0f6fa72012-09-17 09:18:12 +0000146#define SSL_LEGACY_NO_RENEGOTIATION 0
147#define SSL_LEGACY_ALLOW_RENEGOTIATION 1
148#define SSL_LEGACY_BREAK_HANDSHAKE 2
Paul Bakker48916f92012-09-16 19:57:18 +0000149
Paul Bakker9bcf16c2013-06-24 19:31:17 +0200150/*
151 * Size of the input / output buffer.
152 * Note: the RFC defines the default size of SSL / TLS messages. If you
153 * change the value here, other clients / servers may not be able to
154 * communicate with you anymore. Only change this value if you control
155 * both sides of the connection and have it reduced at both sides!
156 */
157#if !defined(POLARSSL_CONFIG_OPTIONS)
158#define SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */
159#endif /* !POLARSSL_CONFIG_OPTIONS */
Paul Bakker5121ce52009-01-03 21:22:43 +0000160
161/*
162 * Allow an extra 512 bytes for the record header
Paul Bakker2770fbd2012-07-03 13:30:23 +0000163 * and encryption overhead (counter + MAC + padding)
164 * and allow for a maximum of 1024 of compression expansion if
165 * enabled.
Paul Bakker5121ce52009-01-03 21:22:43 +0000166 */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000167#if defined(POLARSSL_ZLIB_SUPPORT)
168#define SSL_COMPRESSION_ADD 1024
169#else
170#define SSL_COMPRESSION_ADD 0
171#endif
172
173#define SSL_BUFFER_LEN (SSL_MAX_CONTENT_LEN + SSL_COMPRESSION_ADD + 512)
Paul Bakker5121ce52009-01-03 21:22:43 +0000174
Paul Bakker48916f92012-09-16 19:57:18 +0000175#define SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */
176
Paul Bakker5121ce52009-01-03 21:22:43 +0000177/*
Paul Bakker1ef83d62012-04-11 12:09:53 +0000178 * Supported Signature and Hash algorithms (For TLS 1.2)
179 */
180#define SSL_HASH_NONE 0
181#define SSL_HASH_MD5 1
182#define SSL_HASH_SHA1 2
183#define SSL_HASH_SHA224 3
184#define SSL_HASH_SHA256 4
185#define SSL_HASH_SHA384 5
186#define SSL_HASH_SHA512 6
187
188#define SSL_SIG_RSA 1
189
190/*
Paul Bakker926af752012-11-23 13:38:07 +0100191 * Client Certificate Types
192 */
193#define SSL_CERT_TYPE_RSA_SIGN 1
194
195/*
Paul Bakker5121ce52009-01-03 21:22:43 +0000196 * Message, alert and handshake types
197 */
198#define SSL_MSG_CHANGE_CIPHER_SPEC 20
199#define SSL_MSG_ALERT 21
200#define SSL_MSG_HANDSHAKE 22
201#define SSL_MSG_APPLICATION_DATA 23
202
Paul Bakker2e11f7d2010-07-25 14:24:53 +0000203#define SSL_ALERT_LEVEL_WARNING 1
204#define SSL_ALERT_LEVEL_FATAL 2
205
Paul Bakkere93dfa72012-04-10 08:03:03 +0000206#define SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */
207#define SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */
208#define SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */
209#define SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */
210#define SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */
211#define SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */
Paul Bakkerca4ab492012-04-18 14:23:57 +0000212#define SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */
Paul Bakkere93dfa72012-04-10 08:03:03 +0000213#define SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */
214#define SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */
215#define SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */
216#define SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */
217#define SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */
218#define SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */
219#define SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */
220#define SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */
221#define SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */
222#define SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */
223#define SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */
224#define SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */
225#define SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */
226#define SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */
227#define SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */
228#define SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */
229#define SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000230#define SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */
Paul Bakker5701cdc2012-09-27 21:49:42 +0000231#define SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200232#define SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000233
234#define SSL_HS_HELLO_REQUEST 0
235#define SSL_HS_CLIENT_HELLO 1
236#define SSL_HS_SERVER_HELLO 2
237#define SSL_HS_CERTIFICATE 11
238#define SSL_HS_SERVER_KEY_EXCHANGE 12
239#define SSL_HS_CERTIFICATE_REQUEST 13
240#define SSL_HS_SERVER_HELLO_DONE 14
241#define SSL_HS_CERTIFICATE_VERIFY 15
242#define SSL_HS_CLIENT_KEY_EXCHANGE 16
243#define SSL_HS_FINISHED 20
244
245/*
246 * TLS extensions
247 */
Paul Bakker41c83d32013-03-20 14:39:14 +0100248#define TLS_EXT_SERVERNAME 0
249#define TLS_EXT_SERVERNAME_HOSTNAME 0
Paul Bakker5121ce52009-01-03 21:22:43 +0000250
Manuel Pégourié-Gonnard48f8d0d2013-07-17 10:25:37 +0200251#define TLS_EXT_MAX_FRAGMENT_LENGTH 1
252
Paul Bakker41c83d32013-03-20 14:39:14 +0100253#define TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10
254#define TLS_EXT_SUPPORTED_POINT_FORMATS 11
Paul Bakkerc3f177a2012-04-11 16:11:49 +0000255
Paul Bakker41c83d32013-03-20 14:39:14 +0100256#define TLS_EXT_SIG_ALG 13
257
258#define TLS_EXT_RENEGOTIATION_INFO 0xFF01
Paul Bakker48916f92012-09-16 19:57:18 +0000259
Paul Bakkereb2c6582012-09-27 19:15:01 +0000260/*
Paul Bakkered27a042013-04-18 22:46:23 +0200261 * Size defines
262 */
263#if !defined(POLARSSL_MPI_MAX_SIZE)
264#define POLARSSL_PREMASTER_SIZE 512
265#else
266#define POLARSSL_PREMASTER_SIZE POLARSSL_MPI_MAX_SIZE
267#endif
268
Paul Bakker407a0da2013-06-27 14:29:21 +0200269#ifdef __cplusplus
270extern "C" {
271#endif
272
Paul Bakkered27a042013-04-18 22:46:23 +0200273/*
Paul Bakkereb2c6582012-09-27 19:15:01 +0000274 * Generic function pointers for allowing external RSA private key
275 * implementations.
276 */
277typedef int (*rsa_decrypt_func)( void *ctx, int mode, size_t *olen,
278 const unsigned char *input, unsigned char *output,
279 size_t output_max_len );
280typedef int (*rsa_sign_func)( void *ctx,
281 int (*f_rng)(void *, unsigned char *, size_t), void *p_rng,
282 int mode, int hash_id, unsigned int hashlen,
283 const unsigned char *hash, unsigned char *sig );
284typedef size_t (*rsa_key_len_func)( void *ctx );
285
Paul Bakker5121ce52009-01-03 21:22:43 +0000286/*
287 * SSL state machine
288 */
289typedef enum
290{
291 SSL_HELLO_REQUEST,
292 SSL_CLIENT_HELLO,
293 SSL_SERVER_HELLO,
294 SSL_SERVER_CERTIFICATE,
295 SSL_SERVER_KEY_EXCHANGE,
296 SSL_CERTIFICATE_REQUEST,
297 SSL_SERVER_HELLO_DONE,
298 SSL_CLIENT_CERTIFICATE,
299 SSL_CLIENT_KEY_EXCHANGE,
300 SSL_CERTIFICATE_VERIFY,
301 SSL_CLIENT_CHANGE_CIPHER_SPEC,
302 SSL_CLIENT_FINISHED,
303 SSL_SERVER_CHANGE_CIPHER_SPEC,
304 SSL_SERVER_FINISHED,
305 SSL_FLUSH_BUFFERS,
Paul Bakker48916f92012-09-16 19:57:18 +0000306 SSL_HANDSHAKE_WRAPUP,
Paul Bakker5121ce52009-01-03 21:22:43 +0000307 SSL_HANDSHAKE_OVER
308}
309ssl_states;
310
311typedef struct _ssl_session ssl_session;
312typedef struct _ssl_context ssl_context;
Paul Bakker48916f92012-09-16 19:57:18 +0000313typedef struct _ssl_transform ssl_transform;
314typedef struct _ssl_handshake_params ssl_handshake_params;
Paul Bakker5121ce52009-01-03 21:22:43 +0000315
316/*
Paul Bakker0a597072012-09-25 21:55:46 +0000317 * This structure is used for storing current session data.
Paul Bakker5121ce52009-01-03 21:22:43 +0000318 */
319struct _ssl_session
320{
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200321#if defined(POLARSSL_HAVE_TIME)
Paul Bakker5121ce52009-01-03 21:22:43 +0000322 time_t start; /*!< starting time */
Paul Bakkerfa9b1002013-07-03 15:31:03 +0200323#endif
Paul Bakkere3166ce2011-01-27 17:40:50 +0000324 int ciphersuite; /*!< chosen ciphersuite */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000325 int compression; /*!< chosen compression */
Paul Bakker23986e52011-04-24 08:57:21 +0000326 size_t length; /*!< session id length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000327 unsigned char id[32]; /*!< session identifier */
328 unsigned char master[48]; /*!< the master secret */
Paul Bakkered27a042013-04-18 22:46:23 +0200329
330#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker48916f92012-09-16 19:57:18 +0000331 x509_cert *peer_cert; /*!< peer X.509 cert chain */
Paul Bakkered27a042013-04-18 22:46:23 +0200332#endif /* POLARSSL_X509_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +0000333};
334
Paul Bakker48916f92012-09-16 19:57:18 +0000335/*
336 * This structure contains a full set of runtime transform parameters
337 * either in negotiation or active.
338 */
339struct _ssl_transform
340{
341 /*
342 * Session specific crypto layer
343 */
Paul Bakker68884e32013-01-07 18:20:04 +0100344 const ssl_ciphersuite_t *ciphersuite_info;
345 /*!< Chosen cipersuite_info */
Paul Bakker48916f92012-09-16 19:57:18 +0000346 unsigned int keylen; /*!< symmetric key length */
347 size_t minlen; /*!< min. ciphertext length */
348 size_t ivlen; /*!< IV length */
349 size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */
350 size_t maclen; /*!< MAC length */
351
352 unsigned char iv_enc[16]; /*!< IV (encryption) */
353 unsigned char iv_dec[16]; /*!< IV (decryption) */
354
Paul Bakker68884e32013-01-07 18:20:04 +0100355 /* Needed only for SSL v3.0 secret */
356 unsigned char mac_enc[32]; /*!< SSL v3.0 secret (enc) */
357 unsigned char mac_dec[32]; /*!< SSL v3.0 secret (dec) */
358
359 md_context_t md_ctx_enc; /*!< MAC (encryption) */
360 md_context_t md_ctx_dec; /*!< MAC (decryption) */
Paul Bakker48916f92012-09-16 19:57:18 +0000361
Paul Bakker0f5281a2012-10-23 11:06:25 +0000362 uint32_t ctx_enc[136]; /*!< encryption context */
363 uint32_t ctx_dec[136]; /*!< decryption context */
Paul Bakker48916f92012-09-16 19:57:18 +0000364
365 /*
366 * Session specific compression layer
367 */
368#if defined(POLARSSL_ZLIB_SUPPORT)
369 z_stream ctx_deflate; /*!< compression context */
370 z_stream ctx_inflate; /*!< decompression context */
371#endif
372};
373
374/*
375 * This structure contains the parameters only needed during handshake.
376 */
377struct _ssl_handshake_params
378{
379 /*
380 * Handshake specific crypto variables
381 */
Paul Bakker23f36802012-09-28 14:15:14 +0000382 int sig_alg; /*!< Signature algorithm */
Paul Bakker926af752012-11-23 13:38:07 +0100383 int cert_type; /*!< Requested cert type */
384 int verify_sig_alg; /*!< Signature algorithm for verify */
Paul Bakker48916f92012-09-16 19:57:18 +0000385#if defined(POLARSSL_DHM_C)
386 dhm_context dhm_ctx; /*!< DHM key exchange */
387#endif
Paul Bakker41c83d32013-03-20 14:39:14 +0100388#if defined(POLARSSL_ECDH_C)
389 ecdh_context ecdh_ctx; /*!< ECDH key exchange */
390#endif
Paul Bakker41c83d32013-03-20 14:39:14 +0100391 int ec_curve; /*!< Selected elliptic curve */
Paul Bakkered27a042013-04-18 22:46:23 +0200392#if defined(POLARSSL_ECP_C)
Paul Bakker41c83d32013-03-20 14:39:14 +0100393 int ec_point_format; /*!< Client supported format */
394#endif
Paul Bakker48916f92012-09-16 19:57:18 +0000395
396 /*
397 * Checksum contexts
398 */
Paul Bakker9e36f042013-06-30 14:34:05 +0200399 md5_context fin_md5;
400 sha1_context fin_sha1;
401 sha256_context fin_sha256;
402 sha512_context fin_sha512;
Paul Bakker48916f92012-09-16 19:57:18 +0000403
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200404 void (*update_checksum)(ssl_context *, const unsigned char *, size_t);
Paul Bakker48916f92012-09-16 19:57:18 +0000405 void (*calc_verify)(ssl_context *, unsigned char *);
406 void (*calc_finished)(ssl_context *, unsigned char *, int);
Paul Bakkerb6c5d2e2013-06-25 16:25:17 +0200407 int (*tls_prf)(const unsigned char *, size_t, const char *,
408 const unsigned char *, size_t,
Paul Bakker48916f92012-09-16 19:57:18 +0000409 unsigned char *, size_t);
410
411 size_t pmslen; /*!< premaster length */
412
413 unsigned char randbytes[64]; /*!< random bytes */
Paul Bakkered27a042013-04-18 22:46:23 +0200414 unsigned char premaster[POLARSSL_PREMASTER_SIZE];
Paul Bakkerdf2bb752012-10-24 14:30:00 +0000415 /*!< premaster secret */
Paul Bakker0a597072012-09-25 21:55:46 +0000416
417 int resume; /*!< session resume indicator*/
Paul Bakker2fbefde2013-06-29 16:01:15 +0200418 int max_major_ver; /*!< max. major version client*/
419 int max_minor_ver; /*!< max. minor version client*/
Paul Bakker48916f92012-09-16 19:57:18 +0000420};
421
Paul Bakker5121ce52009-01-03 21:22:43 +0000422struct _ssl_context
423{
424 /*
425 * Miscellaneous
426 */
427 int state; /*!< SSL handshake: current state */
Paul Bakker48916f92012-09-16 19:57:18 +0000428 int renegotiation; /*!< Initial or renegotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000429
430 int major_ver; /*!< equal to SSL_MAJOR_VERSION_3 */
431 int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */
432
Paul Bakker2fbefde2013-06-29 16:01:15 +0200433 int max_major_ver; /*!< max. major version used */
434 int max_minor_ver; /*!< max. minor version used */
435 int min_major_ver; /*!< min. major version used */
436 int min_minor_ver; /*!< min. minor version used */
Paul Bakker5121ce52009-01-03 21:22:43 +0000437
438 /*
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000439 * Callbacks (RNG, debug, I/O, verification)
Paul Bakker5121ce52009-01-03 21:22:43 +0000440 */
Paul Bakkera3d195c2011-11-27 21:07:34 +0000441 int (*f_rng)(void *, unsigned char *, size_t);
Paul Bakkerff60ee62010-03-16 21:09:09 +0000442 void (*f_dbg)(void *, int, const char *);
Paul Bakker23986e52011-04-24 08:57:21 +0000443 int (*f_recv)(void *, unsigned char *, size_t);
Paul Bakker39bb4182011-06-21 07:36:43 +0000444 int (*f_send)(void *, const unsigned char *, size_t);
Paul Bakker0a597072012-09-25 21:55:46 +0000445 int (*f_get_cache)(void *, ssl_session *);
446 int (*f_set_cache)(void *, const ssl_session *);
Paul Bakker5701cdc2012-09-27 21:49:42 +0000447 int (*f_sni)(void *, ssl_context *, const unsigned char *, size_t);
Paul Bakker5121ce52009-01-03 21:22:43 +0000448
449 void *p_rng; /*!< context for the RNG function */
450 void *p_dbg; /*!< context for the debug function */
451 void *p_recv; /*!< context for reading operations */
452 void *p_send; /*!< context for writing operations */
Paul Bakker0a597072012-09-25 21:55:46 +0000453 void *p_get_cache; /*!< context for cache retrieval */
454 void *p_set_cache; /*!< context for cache store */
Paul Bakker5701cdc2012-09-27 21:49:42 +0000455 void *p_sni; /*!< context for SNI extension */
Paul Bakkere667c982012-11-20 13:50:22 +0100456 void *p_hw_data; /*!< context for HW acceleration */
Paul Bakker5121ce52009-01-03 21:22:43 +0000457
Paul Bakkered27a042013-04-18 22:46:23 +0200458#if defined(POLARSSL_X509_PARSE_C)
459 int (*f_vrfy)(void *, x509_cert *, int, int *);
460 void *p_vrfy; /*!< context for verification */
461#endif
462
Paul Bakker5121ce52009-01-03 21:22:43 +0000463 /*
464 * Session layer
465 */
Paul Bakker48916f92012-09-16 19:57:18 +0000466 ssl_session *session_in; /*!< current session data (in) */
467 ssl_session *session_out; /*!< current session data (out) */
468 ssl_session *session; /*!< negotiated session data */
469 ssl_session *session_negotiate; /*!< session data in negotiation */
Paul Bakker5121ce52009-01-03 21:22:43 +0000470
Paul Bakker48916f92012-09-16 19:57:18 +0000471 ssl_handshake_params *handshake; /*!< params required only during
472 the handshake process */
473
474 /*
475 * Record layer transformations
476 */
477 ssl_transform *transform_in; /*!< current transform params (in) */
478 ssl_transform *transform_out; /*!< current transform params (in) */
479 ssl_transform *transform; /*!< negotiated transform params */
480 ssl_transform *transform_negotiate; /*!< transform params in negotiation */
481
Paul Bakker5121ce52009-01-03 21:22:43 +0000482 /*
483 * Record layer (incoming data)
484 */
485 unsigned char *in_ctr; /*!< 64-bit incoming message counter */
486 unsigned char *in_hdr; /*!< 5-byte record header (in_ctr+8) */
Paul Bakker92be97b2013-01-02 17:30:03 +0100487 unsigned char *in_iv; /*!< ivlen-byte IV (in_hdr+5) */
488 unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000489 unsigned char *in_offt; /*!< read offset in application data */
490
491 int in_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000492 size_t in_msglen; /*!< record header: message length */
493 size_t in_left; /*!< amount of data read so far */
Paul Bakker5121ce52009-01-03 21:22:43 +0000494
Paul Bakker23986e52011-04-24 08:57:21 +0000495 size_t in_hslen; /*!< current handshake message length */
Paul Bakker5121ce52009-01-03 21:22:43 +0000496 int nb_zero; /*!< # of 0-length encrypted messages */
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200497 int record_read; /*!< record is already present */
Paul Bakker5121ce52009-01-03 21:22:43 +0000498
499 /*
500 * Record layer (outgoing data)
501 */
502 unsigned char *out_ctr; /*!< 64-bit outgoing message counter */
503 unsigned char *out_hdr; /*!< 5-byte record header (out_ctr+8) */
Paul Bakker92be97b2013-01-02 17:30:03 +0100504 unsigned char *out_iv; /*!< ivlen-byte IV (out_hdr+5) */
505 unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */
Paul Bakker5121ce52009-01-03 21:22:43 +0000506
507 int out_msgtype; /*!< record header: message type */
Paul Bakker23986e52011-04-24 08:57:21 +0000508 size_t out_msglen; /*!< record header: message length */
509 size_t out_left; /*!< amount of data not yet written */
Paul Bakker5121ce52009-01-03 21:22:43 +0000510
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200511 /* Maximum fragment length extension (RFC 6066 section 4) */
512 unsigned char mfl_code; /*!< numerical code for MaxFragmentLength */
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200513
Paul Bakker5121ce52009-01-03 21:22:43 +0000514 /*
515 * PKI layer
516 */
Paul Bakkered27a042013-04-18 22:46:23 +0200517#if defined(POLARSSL_RSA_C)
Paul Bakkereb2c6582012-09-27 19:15:01 +0000518 void *rsa_key; /*!< own RSA private key */
519 rsa_decrypt_func rsa_decrypt; /*!< function for RSA decrypt*/
520 rsa_sign_func rsa_sign; /*!< function for RSA sign */
521 rsa_key_len_func rsa_key_len; /*!< function for RSA key len*/
Paul Bakkered27a042013-04-18 22:46:23 +0200522#endif /* POLARSSL_RSA_C */
Paul Bakkereb2c6582012-09-27 19:15:01 +0000523
Paul Bakkered27a042013-04-18 22:46:23 +0200524#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000525 x509_cert *own_cert; /*!< own X.509 certificate */
526 x509_cert *ca_chain; /*!< own trusted CA chain */
Paul Bakker40ea7de2009-05-03 10:18:48 +0000527 x509_crl *ca_crl; /*!< trusted CA CRLs */
Paul Bakker57b79142010-03-24 06:51:15 +0000528 const char *peer_cn; /*!< expected peer CN */
Paul Bakkered27a042013-04-18 22:46:23 +0200529#endif /* POLARSSL_X509_PARSE_C */
Paul Bakker5121ce52009-01-03 21:22:43 +0000530
Paul Bakker48916f92012-09-16 19:57:18 +0000531 /*
532 * User settings
533 */
Paul Bakker5121ce52009-01-03 21:22:43 +0000534 int endpoint; /*!< 0: client, 1: server */
535 int authmode; /*!< verification mode */
536 int client_auth; /*!< flag for client auth. */
537 int verify_result; /*!< verification result */
Paul Bakker48916f92012-09-16 19:57:18 +0000538 int disable_renegotiation; /*!< enable/disable renegotiation */
539 int allow_legacy_renegotiation; /*!< allow legacy renegotiation */
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200540 const int *ciphersuite_list[4]; /*!< allowed ciphersuites / version */
Paul Bakker5121ce52009-01-03 21:22:43 +0000541
Paul Bakker48916f92012-09-16 19:57:18 +0000542#if defined(POLARSSL_DHM_C)
543 mpi dhm_P; /*!< prime modulus for DHM */
544 mpi dhm_G; /*!< generator for DHM */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000545#endif
546
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200547#if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED)
548 /*
549 * PSK values
550 */
551 const unsigned char *psk;
552 size_t psk_len;
553 const unsigned char *psk_identity;
554 size_t psk_identity_len;
555#endif
556
Paul Bakker5121ce52009-01-03 21:22:43 +0000557 /*
558 * TLS extensions
559 */
560 unsigned char *hostname;
Paul Bakker23986e52011-04-24 08:57:21 +0000561 size_t hostname_len;
Paul Bakker48916f92012-09-16 19:57:18 +0000562
563 /*
564 * Secure renegotiation
565 */
566 int secure_renegotiation; /*!< does peer support legacy or
567 secure renegotiation */
568 size_t verify_data_len; /*!< length of verify data stored */
569 char own_verify_data[36]; /*!< previous handshake verify data */
570 char peer_verify_data[36]; /*!< previous handshake verify data */
Paul Bakker5121ce52009-01-03 21:22:43 +0000571};
572
Paul Bakker05ef8352012-05-08 09:17:57 +0000573#if defined(POLARSSL_SSL_HW_RECORD_ACCEL)
Paul Bakker07eb38b2012-12-19 14:42:06 +0100574
575#define SSL_CHANNEL_OUTBOUND 0
576#define SSL_CHANNEL_INBOUND 1
577
Paul Bakker05ef8352012-05-08 09:17:57 +0000578extern int (*ssl_hw_record_init)(ssl_context *ssl,
579 const unsigned char *key_enc, const unsigned char *key_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100580 size_t keylen,
Paul Bakker05ef8352012-05-08 09:17:57 +0000581 const unsigned char *iv_enc, const unsigned char *iv_dec,
Paul Bakker07eb38b2012-12-19 14:42:06 +0100582 size_t ivlen,
583 const unsigned char *mac_enc, const unsigned char *mac_dec,
584 size_t maclen);
585extern int (*ssl_hw_record_activate)(ssl_context *ssl, int direction);
Paul Bakker05ef8352012-05-08 09:17:57 +0000586extern int (*ssl_hw_record_reset)(ssl_context *ssl);
587extern int (*ssl_hw_record_write)(ssl_context *ssl);
588extern int (*ssl_hw_record_read)(ssl_context *ssl);
589extern int (*ssl_hw_record_finish)(ssl_context *ssl);
590#endif
591
Paul Bakker5121ce52009-01-03 21:22:43 +0000592/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000593 * \brief Returns the list of ciphersuites supported by the SSL/TLS module.
Paul Bakker72f62662011-01-16 21:27:44 +0000594 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000595 * \return a statically allocated array of ciphersuites, the last
596 * entry is 0.
Paul Bakker72f62662011-01-16 21:27:44 +0000597 */
Paul Bakker68884e32013-01-07 18:20:04 +0100598const int *ssl_list_ciphersuites( void );
Paul Bakker72f62662011-01-16 21:27:44 +0000599
600/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000601 * \brief Return the name of the ciphersuite associated with the given
602 * ID
Paul Bakker72f62662011-01-16 21:27:44 +0000603 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000604 * \param ciphersuite_id SSL ciphersuite ID
Paul Bakker72f62662011-01-16 21:27:44 +0000605 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000606 * \return a string containing the ciphersuite name
Paul Bakker72f62662011-01-16 21:27:44 +0000607 */
Paul Bakkere3166ce2011-01-27 17:40:50 +0000608const char *ssl_get_ciphersuite_name( const int ciphersuite_id );
609
610/**
611 * \brief Return the ID of the ciphersuite associated with the given
612 * name
613 *
614 * \param ciphersuite_name SSL ciphersuite name
615 *
616 * \return the ID with the ciphersuite or 0 if not found
617 */
618int ssl_get_ciphersuite_id( const char *ciphersuite_name );
Paul Bakker72f62662011-01-16 21:27:44 +0000619
620/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000621 * \brief Initialize an SSL context
622 *
623 * \param ssl SSL context
624 *
Paul Bakker69e095c2011-12-10 21:55:01 +0000625 * \return 0 if successful, or POLARSSL_ERR_SSL_MALLOC_FAILED if
626 * memory allocation failed
Paul Bakker5121ce52009-01-03 21:22:43 +0000627 */
628int ssl_init( ssl_context *ssl );
629
630/**
Paul Bakker7eb013f2011-10-06 12:37:39 +0000631 * \brief Reset an already initialized SSL context for re-use
632 * while retaining application-set variables, function
633 * pointers and data.
634 *
635 * \param ssl SSL context
Paul Bakker48916f92012-09-16 19:57:18 +0000636 * \return 0 if successful, or POLASSL_ERR_SSL_MALLOC_FAILED,
637 POLARSSL_ERR_SSL_HW_ACCEL_FAILED or
Paul Bakker2770fbd2012-07-03 13:30:23 +0000638 * POLARSSL_ERR_SSL_COMPRESSION_FAILED
Paul Bakker7eb013f2011-10-06 12:37:39 +0000639 */
Paul Bakker2770fbd2012-07-03 13:30:23 +0000640int ssl_session_reset( ssl_context *ssl );
Paul Bakker7eb013f2011-10-06 12:37:39 +0000641
642/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000643 * \brief Set the current endpoint type
644 *
645 * \param ssl SSL context
646 * \param endpoint must be SSL_IS_CLIENT or SSL_IS_SERVER
647 */
648void ssl_set_endpoint( ssl_context *ssl, int endpoint );
649
650/**
651 * \brief Set the certificate verification mode
652 *
653 * \param ssl SSL context
Paul Bakker37ca75d2011-01-06 12:28:03 +0000654 * \param authmode can be:
Paul Bakker5121ce52009-01-03 21:22:43 +0000655 *
656 * SSL_VERIFY_NONE: peer certificate is not checked (default),
657 * this is insecure and SHOULD be avoided.
658 *
659 * SSL_VERIFY_OPTIONAL: peer certificate is checked, however the
660 * handshake continues even if verification failed;
661 * ssl_get_verify_result() can be called after the
662 * handshake is complete.
663 *
664 * SSL_VERIFY_REQUIRED: peer *must* present a valid certificate,
665 * handshake is aborted if verification failed.
666 */
667void ssl_set_authmode( ssl_context *ssl, int authmode );
668
Paul Bakkered27a042013-04-18 22:46:23 +0200669#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000670/**
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000671 * \brief Set the verification callback (Optional).
672 *
Paul Bakker915275b2012-09-28 07:10:55 +0000673 * If set, the verify callback is called for each
674 * certificate in the chain. For implementation
675 * information, please see \c x509parse_verify()
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000676 *
677 * \param ssl SSL context
678 * \param f_vrfy verification function
679 * \param p_vrfy verification parameter
680 */
681void ssl_set_verify( ssl_context *ssl,
Paul Bakker915275b2012-09-28 07:10:55 +0000682 int (*f_vrfy)(void *, x509_cert *, int, int *),
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000683 void *p_vrfy );
Paul Bakkered27a042013-04-18 22:46:23 +0200684#endif /* POLARSSL_X509_PARSE_C */
Paul Bakkerb63b0af2011-01-13 17:54:59 +0000685
686/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000687 * \brief Set the random number generator callback
688 *
689 * \param ssl SSL context
690 * \param f_rng RNG function
691 * \param p_rng RNG parameter
692 */
693void ssl_set_rng( ssl_context *ssl,
Paul Bakkera3d195c2011-11-27 21:07:34 +0000694 int (*f_rng)(void *, unsigned char *, size_t),
Paul Bakker5121ce52009-01-03 21:22:43 +0000695 void *p_rng );
696
697/**
698 * \brief Set the debug callback
699 *
700 * \param ssl SSL context
701 * \param f_dbg debug function
702 * \param p_dbg debug parameter
703 */
704void ssl_set_dbg( ssl_context *ssl,
Paul Bakkerff60ee62010-03-16 21:09:09 +0000705 void (*f_dbg)(void *, int, const char *),
Paul Bakker5121ce52009-01-03 21:22:43 +0000706 void *p_dbg );
707
708/**
709 * \brief Set the underlying BIO read and write callbacks
710 *
711 * \param ssl SSL context
712 * \param f_recv read callback
713 * \param p_recv read parameter
714 * \param f_send write callback
715 * \param p_send write parameter
716 */
717void ssl_set_bio( ssl_context *ssl,
Paul Bakker23986e52011-04-24 08:57:21 +0000718 int (*f_recv)(void *, unsigned char *, size_t), void *p_recv,
Paul Bakker39bb4182011-06-21 07:36:43 +0000719 int (*f_send)(void *, const unsigned char *, size_t), void *p_send );
Paul Bakker5121ce52009-01-03 21:22:43 +0000720
721/**
Paul Bakker0a597072012-09-25 21:55:46 +0000722 * \brief Set the session cache callbacks (server-side only)
723 * If not set, no session resuming is done.
Paul Bakker5121ce52009-01-03 21:22:43 +0000724 *
Paul Bakker0a597072012-09-25 21:55:46 +0000725 * The session cache has the responsibility to check for stale
726 * entries based on timeout. See RFC 5246 for recommendations.
727 *
728 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
729 * connection shutdown, so do not cache the pointer! Either set
730 * it to NULL or make a full copy of the certificate.
731 *
732 * The get callback is called once during the initial handshake
733 * to enable session resuming. The get function has the
734 * following parameters: (void *parameter, ssl_session *session)
735 * If a valid entry is found, it should fill the master of
736 * the session object with the cached values and return 0,
737 * return 1 otherwise. Optionally peer_cert can be set as well
738 * if it is properly present in cache entry.
739 *
740 * The set callback is called once during the initial handshake
741 * to enable session resuming after the entire handshake has
742 * been finished. The set function has the following parameters:
743 * (void *parameter, const ssl_session *session). The function
744 * should create a cache entry for future retrieval based on
745 * the data in the session structure and should keep in mind
746 * that the ssl_session object presented (and all its referenced
747 * data) is cleared by the SSL/TLS layer when the connection is
748 * terminated. It is recommended to add metadata to determine if
749 * an entry is still valid in the future. Return 0 if
Paul Bakker7a2538e2012-11-02 10:59:36 +0000750 * successfully cached, return 1 otherwise.
Paul Bakker0a597072012-09-25 21:55:46 +0000751 *
752 * \param ssl SSL context
753 * \param f_get_cache session get callback
754 * \param p_get_cache session get parameter
755 * \param f_set_cache session set callback
756 * \param p_set_cache session set parameter
Paul Bakker5121ce52009-01-03 21:22:43 +0000757 */
Paul Bakker0a597072012-09-25 21:55:46 +0000758void ssl_set_session_cache( ssl_context *ssl,
759 int (*f_get_cache)(void *, ssl_session *), void *p_get_cache,
760 int (*f_set_cache)(void *, const ssl_session *), void *p_set_cache );
Paul Bakker5121ce52009-01-03 21:22:43 +0000761
762/**
Paul Bakker0a597072012-09-25 21:55:46 +0000763 * \brief Request resumption of session (client-side only)
764 * Session data is copied from presented session structure.
765 *
766 * Warning: session.peer_cert is cleared by the SSL/TLS layer on
767 * connection shutdown, so do not cache the pointer! Either set
768 * it to NULL or make a full copy of the certificate when
769 * storing the session for use in this function.
Paul Bakker5121ce52009-01-03 21:22:43 +0000770 *
771 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +0000772 * \param session session context
773 */
Paul Bakker0a597072012-09-25 21:55:46 +0000774void ssl_set_session( ssl_context *ssl, const ssl_session *session );
Paul Bakker5121ce52009-01-03 21:22:43 +0000775
776/**
Paul Bakkere3166ce2011-01-27 17:40:50 +0000777 * \brief Set the list of allowed ciphersuites
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200778 * (Overrides all version specific lists)
Paul Bakker5121ce52009-01-03 21:22:43 +0000779 *
Paul Bakkere3166ce2011-01-27 17:40:50 +0000780 * \param ssl SSL context
781 * \param ciphersuites 0-terminated list of allowed ciphersuites
Paul Bakker5121ce52009-01-03 21:22:43 +0000782 */
Paul Bakkerb68cad62012-08-23 08:34:18 +0000783void ssl_set_ciphersuites( ssl_context *ssl, const int *ciphersuites );
Paul Bakker5121ce52009-01-03 21:22:43 +0000784
785/**
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200786 * \brief Set the list of allowed ciphersuites for a specific
787 * version of the protocol.
788 * (Only useful on the server side)
789 *
790 * \param ssl SSL context
791 * \param ciphersuites 0-terminated list of allowed ciphersuites
792 * \param major Major version number (only SSL_MAJOR_VERSION_3
793 * supported)
794 * \param minor Minor version number (SSL_MINOR_VERSION_0,
795 * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2,
796 * SSL_MINOR_VERSION_3 supported)
797 */
798void ssl_set_ciphersuites_for_version( ssl_context *ssl,
799 const int *ciphersuites,
800 int major, int minor );
801
Paul Bakkered27a042013-04-18 22:46:23 +0200802#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker8f4ddae2013-04-15 15:09:54 +0200803/**
Paul Bakker5121ce52009-01-03 21:22:43 +0000804 * \brief Set the data required to verify peer certificate
805 *
806 * \param ssl SSL context
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100807 * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs)
Paul Bakker40ea7de2009-05-03 10:18:48 +0000808 * \param ca_crl trusted CA CRLs
Paul Bakker5121ce52009-01-03 21:22:43 +0000809 * \param peer_cn expected peer CommonName (or NULL)
Paul Bakker5121ce52009-01-03 21:22:43 +0000810 */
811void ssl_set_ca_chain( ssl_context *ssl, x509_cert *ca_chain,
Paul Bakker57b79142010-03-24 06:51:15 +0000812 x509_crl *ca_crl, const char *peer_cn );
Paul Bakker5121ce52009-01-03 21:22:43 +0000813
814/**
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100815 * \brief Set own certificate chain and private key
816 *
817 * Note: own_cert should contain IN order from the bottom
818 * up your certificate chain. The top certificate (self-signed)
819 * can be omitted.
Paul Bakker5121ce52009-01-03 21:22:43 +0000820 *
821 * \param ssl SSL context
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100822 * \param own_cert own public certificate chain
Paul Bakker5121ce52009-01-03 21:22:43 +0000823 * \param rsa_key own private RSA key
824 */
825void ssl_set_own_cert( ssl_context *ssl, x509_cert *own_cert,
826 rsa_context *rsa_key );
827
Paul Bakker43b7e352011-01-18 15:27:19 +0000828/**
Paul Bakkereb2c6582012-09-27 19:15:01 +0000829 * \brief Set own certificate and alternate non-PolarSSL private
830 * key and handling callbacks, such as the PKCS#11 wrappers
831 * or any other external private key handler.
832 * (see the respective RSA functions in rsa.h for documentation
833 * of the callback parameters, with the only change being
834 * that the rsa_context * is a void * in the callbacks)
Paul Bakker43b7e352011-01-18 15:27:19 +0000835 *
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100836 * Note: own_cert should contain IN order from the bottom
837 * up your certificate chain. The top certificate (self-signed)
838 * can be omitted.
839 *
Paul Bakker43b7e352011-01-18 15:27:19 +0000840 * \param ssl SSL context
Paul Bakker1f9d02d2012-11-20 10:30:55 +0100841 * \param own_cert own public certificate chain
Paul Bakkereb2c6582012-09-27 19:15:01 +0000842 * \param rsa_key alternate implementation private RSA key
843 * \param rsa_decrypt_func alternate implementation of \c rsa_pkcs1_decrypt()
844 * \param rsa_sign_func alternate implementation of \c rsa_pkcs1_sign()
845 * \param rsa_key_len_func function returning length of RSA key in bytes
Paul Bakker43b7e352011-01-18 15:27:19 +0000846 */
Paul Bakkereb2c6582012-09-27 19:15:01 +0000847void ssl_set_own_cert_alt( ssl_context *ssl, x509_cert *own_cert,
848 void *rsa_key,
849 rsa_decrypt_func rsa_decrypt,
850 rsa_sign_func rsa_sign,
851 rsa_key_len_func rsa_key_len );
Paul Bakkered27a042013-04-18 22:46:23 +0200852#endif /* POLARSSL_X509_PARSE_C */
Paul Bakker43b7e352011-01-18 15:27:19 +0000853
Paul Bakkerd4a56ec2013-04-16 18:05:29 +0200854#if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED)
855/**
856 * \brief Set the Pre Shared Key (PSK) and the identity name connected
857 * to it. The PSK is used in all PSK-based ciphersuites.
858 *
859 * \param ssl SSL context
860 * \param psk pointer to the pre-shared key
861 * \param psk_len pre-shared key length
862 * \param psk_identity pointer to the pre-shared key identity
863 * \param psk_identity_len identity key length
864 */
865void ssl_set_psk( ssl_context *ssl, const unsigned char *psk, size_t psk_len,
866 const unsigned char *psk_identity, size_t psk_identity_len );
867#endif /* POLARSSL_KEY_EXCHANGE_PSK_ENABLED */
868
Paul Bakker48916f92012-09-16 19:57:18 +0000869#if defined(POLARSSL_DHM_C)
Paul Bakker5121ce52009-01-03 21:22:43 +0000870/**
871 * \brief Set the Diffie-Hellman public P and G values,
872 * read as hexadecimal strings (server-side only)
Paul Bakker62f2dee2012-09-28 07:31:51 +0000873 * (Default: POLARSSL_DHM_RFC5114_MODP_1024_[PG])
Paul Bakker5121ce52009-01-03 21:22:43 +0000874 *
875 * \param ssl SSL context
876 * \param dhm_P Diffie-Hellman-Merkle modulus
877 * \param dhm_G Diffie-Hellman-Merkle generator
878 *
879 * \return 0 if successful
880 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000881int ssl_set_dh_param( ssl_context *ssl, const char *dhm_P, const char *dhm_G );
Paul Bakker5121ce52009-01-03 21:22:43 +0000882
883/**
Paul Bakker1b57b062011-01-06 15:48:19 +0000884 * \brief Set the Diffie-Hellman public P and G values,
885 * read from existing context (server-side only)
886 *
887 * \param ssl SSL context
888 * \param dhm_ctx Diffie-Hellman-Merkle context
889 *
890 * \return 0 if successful
891 */
892int ssl_set_dh_param_ctx( ssl_context *ssl, dhm_context *dhm_ctx );
Paul Bakker48916f92012-09-16 19:57:18 +0000893#endif
Paul Bakker1b57b062011-01-06 15:48:19 +0000894
895/**
Paul Bakker5701cdc2012-09-27 21:49:42 +0000896 * \brief Set hostname for ServerName TLS extension
897 * (client-side only)
Paul Bakker5121ce52009-01-03 21:22:43 +0000898 *
899 *
900 * \param ssl SSL context
901 * \param hostname the server hostname
902 *
Paul Bakkerb15b8512012-01-13 13:44:06 +0000903 * \return 0 if successful or POLARSSL_ERR_SSL_MALLOC_FAILED
Paul Bakker5121ce52009-01-03 21:22:43 +0000904 */
Paul Bakkerff60ee62010-03-16 21:09:09 +0000905int ssl_set_hostname( ssl_context *ssl, const char *hostname );
Paul Bakker5121ce52009-01-03 21:22:43 +0000906
907/**
Paul Bakker5701cdc2012-09-27 21:49:42 +0000908 * \brief Set server side ServerName TLS extension callback
909 * (optional, server-side only).
910 *
911 * If set, the ServerName callback is called whenever the
912 * server receives a ServerName TLS extension from the client
913 * during a handshake. The ServerName callback has the
914 * following parameters: (void *parameter, ssl_context *ssl,
915 * const unsigned char *hostname, size_t len). If a suitable
916 * certificate is found, the callback should set the
917 * certificate and key to use with ssl_set_own_cert() (and
918 * possibly adjust the CA chain as well) and return 0. The
919 * callback should return -1 to abort the handshake at this
920 * point.
921 *
922 * \param ssl SSL context
923 * \param f_sni verification function
924 * \param p_sni verification parameter
925 */
926void ssl_set_sni( ssl_context *ssl,
927 int (*f_sni)(void *, ssl_context *, const unsigned char *,
928 size_t),
929 void *p_sni );
930
931/**
Paul Bakker490ecc82011-10-06 13:04:09 +0000932 * \brief Set the maximum supported version sent from the client side
Paul Bakker2fbefde2013-06-29 16:01:15 +0200933 * and/or accepted at the server side
934 * (Default: SSL_MAJOR_VERSION_3, SSL_MINOR_VERSION_3)
935 *
936 * Note: This prevents ciphersuites from 'higher' versions to
937 * be ignored.
Paul Bakker490ecc82011-10-06 13:04:09 +0000938 *
939 * \param ssl SSL context
940 * \param major Major version number (only SSL_MAJOR_VERSION_3 supported)
941 * \param minor Minor version number (SSL_MINOR_VERSION_0,
Paul Bakker1ef83d62012-04-11 12:09:53 +0000942 * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2,
943 * SSL_MINOR_VERSION_3 supported)
Paul Bakker490ecc82011-10-06 13:04:09 +0000944 */
945void ssl_set_max_version( ssl_context *ssl, int major, int minor );
946
Paul Bakker1d29fb52012-09-28 13:28:45 +0000947
948/**
949 * \brief Set the minimum accepted SSL/TLS protocol version
950 * (Default: SSL_MAJOR_VERSION_3, SSL_MINOR_VERSION_0)
951 *
952 * \param ssl SSL context
953 * \param major Major version number (only SSL_MAJOR_VERSION_3 supported)
954 * \param minor Minor version number (SSL_MINOR_VERSION_0,
955 * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2,
956 * SSL_MINOR_VERSION_3 supported)
957 */
958void ssl_set_min_version( ssl_context *ssl, int major, int minor );
959
Paul Bakker490ecc82011-10-06 13:04:09 +0000960/**
Manuel Pégourié-Gonnard8b464592013-07-16 12:45:26 +0200961 * \brief Set the maximum fragment length to emit and/or negotiate
962 * (Default: SSL_MAX_CONTENT_LEN, usually 2^14 bytes)
963 * (Server: set maximum fragment length to emit,
964 * usually negotiated by the client during handshake
965 * (Client: set maximum fragment length to emit *and*
966 * negotiate with the server during handshake)
967 *
968 * \param ssl SSL context
969 * \param mfl Code for maximum fragment length (allowed values:
970 * SSL_MAX_FRAG_LEN_512, SSL_MAX_FRAG_LEN_1024,
971 * SSL_MAX_FRAG_LEN_2048, SSL_MAX_FRAG_LEN_4096)
972 *
973 * \return O if successful or POLARSSL_ERR_SSL_BAD_INPUT_DATA
974 */
975int ssl_set_max_frag_len( ssl_context *ssl, unsigned char mfl_code );
976
977/**
Paul Bakker09f097d2012-10-23 11:54:56 +0000978 * \brief Enable / Disable renegotiation support for connection when
979 * initiated by peer
980 * (Default: SSL_RENEGOTIATION_DISABLED)
981 *
982 * Note: A server with support enabled is more vulnerable for a
Paul Bakker7c900782012-11-04 16:29:08 +0000983 * resource DoS by a malicious client. You should enable this on
984 * a client to enable server-initiated renegotiation.
Paul Bakker48916f92012-09-16 19:57:18 +0000985 *
986 * \param ssl SSL context
987 * \param renegotiation Enable or disable (SSL_RENEGOTIATION_ENABLED or
988 * SSL_RENEGOTIATION_DISABLED)
989 */
990void ssl_set_renegotiation( ssl_context *ssl, int renegotiation );
991
992/**
993 * \brief Prevent or allow legacy renegotiation.
Paul Bakkerd0f6fa72012-09-17 09:18:12 +0000994 * (Default: SSL_LEGACY_NO_RENEGOTIATION)
995 *
996 * SSL_LEGACY_NO_RENEGOTIATION allows connections to
997 * be established even if the peer does not support
998 * secure renegotiation, but does not allow renegotiation
999 * to take place if not secure.
1000 * (Interoperable and secure option)
1001 *
1002 * SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations
1003 * with non-upgraded peers. Allowing legacy renegotiation
1004 * makes the connection vulnerable to specific man in the
1005 * middle attacks. (See RFC 5746)
1006 * (Most interoperable and least secure option)
1007 *
1008 * SSL_LEGACY_BREAK_HANDSHAKE breaks off connections
1009 * if peer does not support secure renegotiation. Results
1010 * in interoperability issues with non-upgraded peers
1011 * that do not support renegotiation altogether.
1012 * (Most secure option, interoperability issues)
Paul Bakker48916f92012-09-16 19:57:18 +00001013 *
1014 * \param ssl SSL context
Paul Bakker6831c4a2012-11-07 19:46:27 +00001015 * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION,
1016 * SSL_ALLOW_LEGACY_RENEGOTIATION or
1017 * SSL_LEGACY_BREAK_HANDSHAKE)
Paul Bakker48916f92012-09-16 19:57:18 +00001018 */
1019void ssl_legacy_renegotiation( ssl_context *ssl, int allow_legacy );
1020
1021/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001022 * \brief Return the number of data bytes available to read
1023 *
1024 * \param ssl SSL context
1025 *
1026 * \return how many bytes are available in the read buffer
1027 */
Paul Bakker23986e52011-04-24 08:57:21 +00001028size_t ssl_get_bytes_avail( const ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001029
1030/**
1031 * \brief Return the result of the certificate verification
1032 *
1033 * \param ssl SSL context
1034 *
1035 * \return 0 if successful, or a combination of:
1036 * BADCERT_EXPIRED
1037 * BADCERT_REVOKED
1038 * BADCERT_CN_MISMATCH
1039 * BADCERT_NOT_TRUSTED
1040 */
Paul Bakkerff60ee62010-03-16 21:09:09 +00001041int ssl_get_verify_result( const ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001042
1043/**
Paul Bakkere3166ce2011-01-27 17:40:50 +00001044 * \brief Return the name of the current ciphersuite
Paul Bakker5121ce52009-01-03 21:22:43 +00001045 *
1046 * \param ssl SSL context
1047 *
Paul Bakkere3166ce2011-01-27 17:40:50 +00001048 * \return a string containing the ciphersuite name
Paul Bakker5121ce52009-01-03 21:22:43 +00001049 */
Paul Bakkere3166ce2011-01-27 17:40:50 +00001050const char *ssl_get_ciphersuite( const ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001051
1052/**
Paul Bakker43ca69c2011-01-15 17:35:19 +00001053 * \brief Return the current SSL version (SSLv3/TLSv1/etc)
1054 *
1055 * \param ssl SSL context
1056 *
1057 * \return a string containing the SSL version
1058 */
1059const char *ssl_get_version( const ssl_context *ssl );
1060
Paul Bakkered27a042013-04-18 22:46:23 +02001061#if defined(POLARSSL_X509_PARSE_C)
Paul Bakker43ca69c2011-01-15 17:35:19 +00001062/**
Paul Bakkerb0550d92012-10-30 07:51:03 +00001063 * \brief Return the peer certificate from the current connection
1064 *
1065 * Note: Can be NULL in case no certificate was sent during
1066 * the handshake. Different calls for the same connection can
1067 * return the same or different pointers for the same
1068 * certificate and even a different certificate altogether.
1069 * The peer cert CAN change in a single connection if
1070 * renegotiation is performed.
1071 *
1072 * \param ssl SSL context
1073 *
1074 * \return the current peer certificate
1075 */
1076const x509_cert *ssl_get_peer_cert( const ssl_context *ssl );
Paul Bakkered27a042013-04-18 22:46:23 +02001077#endif /* POLARSSL_X509_PARSE_C */
Paul Bakkerb0550d92012-10-30 07:51:03 +00001078
1079/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001080 * \brief Perform the SSL handshake
1081 *
1082 * \param ssl SSL context
1083 *
Paul Bakker831a7552011-05-18 13:32:51 +00001084 * \return 0 if successful, POLARSSL_ERR_NET_WANT_READ,
1085 * POLARSSL_ERR_NET_WANT_WRITE, or a specific SSL error code.
Paul Bakker5121ce52009-01-03 21:22:43 +00001086 */
1087int ssl_handshake( ssl_context *ssl );
1088
1089/**
Paul Bakker1961b702013-01-25 14:49:24 +01001090 * \brief Perform a single step of the SSL handshake
1091 *
1092 * Note: the state of the context (ssl->state) will be at
1093 * the following state after execution of this function.
1094 * Do not call this function if state is SSL_HANDSHAKE_OVER.
1095 *
1096 * \param ssl SSL context
1097 *
1098 * \return 0 if successful, POLARSSL_ERR_NET_WANT_READ,
1099 * POLARSSL_ERR_NET_WANT_WRITE, or a specific SSL error code.
1100 */
1101int ssl_handshake_step( ssl_context *ssl );
1102
1103/**
Paul Bakker48916f92012-09-16 19:57:18 +00001104 * \brief Perform an SSL renegotiation on the running connection
1105 *
1106 * \param ssl SSL context
1107 *
1108 * \return 0 if succesful, or any ssl_handshake() return value.
1109 */
1110int ssl_renegotiate( ssl_context *ssl );
1111
1112/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001113 * \brief Read at most 'len' application data bytes
1114 *
1115 * \param ssl SSL context
1116 * \param buf buffer that will hold the data
1117 * \param len how many bytes must be read
1118 *
Paul Bakker831a7552011-05-18 13:32:51 +00001119 * \return This function returns the number of bytes read, 0 for EOF,
Paul Bakker5121ce52009-01-03 21:22:43 +00001120 * or a negative error code.
1121 */
Paul Bakker23986e52011-04-24 08:57:21 +00001122int ssl_read( ssl_context *ssl, unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00001123
1124/**
1125 * \brief Write exactly 'len' application data bytes
1126 *
1127 * \param ssl SSL context
1128 * \param buf buffer holding the data
1129 * \param len how many bytes must be written
1130 *
1131 * \return This function returns the number of bytes written,
1132 * or a negative error code.
1133 *
Paul Bakker831a7552011-05-18 13:32:51 +00001134 * \note When this function returns POLARSSL_ERR_NET_WANT_WRITE,
Paul Bakker5121ce52009-01-03 21:22:43 +00001135 * it must be called later with the *same* arguments,
1136 * until it returns a positive value.
1137 */
Paul Bakker23986e52011-04-24 08:57:21 +00001138int ssl_write( ssl_context *ssl, const unsigned char *buf, size_t len );
Paul Bakker5121ce52009-01-03 21:22:43 +00001139
1140/**
Paul Bakker0a925182012-04-16 06:46:41 +00001141 * \brief Send an alert message
1142 *
1143 * \param ssl SSL context
1144 * \param level The alert level of the message
1145 * (SSL_ALERT_LEVEL_WARNING or SSL_ALERT_LEVEL_FATAL)
1146 * \param message The alert message (SSL_ALERT_MSG_*)
1147 *
Paul Bakker6831c4a2012-11-07 19:46:27 +00001148 * \return 0 if successful, or a specific SSL error code.
Paul Bakker0a925182012-04-16 06:46:41 +00001149 */
1150int ssl_send_alert_message( ssl_context *ssl,
1151 unsigned char level,
1152 unsigned char message );
1153/**
Paul Bakker5121ce52009-01-03 21:22:43 +00001154 * \brief Notify the peer that the connection is being closed
Paul Bakker13e2dfe2009-07-28 07:18:38 +00001155 *
1156 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001157 */
1158int ssl_close_notify( ssl_context *ssl );
1159
1160/**
Paul Bakker48916f92012-09-16 19:57:18 +00001161 * \brief Free referenced items in an SSL context and clear memory
Paul Bakker13e2dfe2009-07-28 07:18:38 +00001162 *
1163 * \param ssl SSL context
Paul Bakker5121ce52009-01-03 21:22:43 +00001164 */
1165void ssl_free( ssl_context *ssl );
1166
Paul Bakker48916f92012-09-16 19:57:18 +00001167/**
Paul Bakker0a597072012-09-25 21:55:46 +00001168 * \brief Free referenced items in an SSL session including the
1169 * peer certificate and clear memory
Paul Bakker48916f92012-09-16 19:57:18 +00001170 *
1171 * \param session SSL session
1172 */
1173void ssl_session_free( ssl_session *session );
1174
1175/**
1176 * \brief Free referenced items in an SSL transform context and clear
1177 * memory
1178 *
1179 * \param transform SSL transform context
1180 */
1181void ssl_transform_free( ssl_transform *transform );
1182
1183/**
1184 * \brief Free referenced items in an SSL handshake context and clear
1185 * memory
1186 *
1187 * \param handshake SSL handshake context
1188 */
1189void ssl_handshake_free( ssl_handshake_params *handshake );
1190
Paul Bakker5121ce52009-01-03 21:22:43 +00001191/*
1192 * Internal functions (do not call directly)
1193 */
Paul Bakker1961b702013-01-25 14:49:24 +01001194int ssl_handshake_client_step( ssl_context *ssl );
1195int ssl_handshake_server_step( ssl_context *ssl );
Paul Bakker48916f92012-09-16 19:57:18 +00001196void ssl_handshake_wrapup( ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001197
Paul Bakkerd0f6fa72012-09-17 09:18:12 +00001198int ssl_send_fatal_handshake_failure( ssl_context *ssl );
1199
Paul Bakker5121ce52009-01-03 21:22:43 +00001200int ssl_derive_keys( ssl_context *ssl );
Paul Bakker5121ce52009-01-03 21:22:43 +00001201
1202int ssl_read_record( ssl_context *ssl );
Paul Bakker831a7552011-05-18 13:32:51 +00001203/**
1204 * \return 0 if successful, POLARSSL_ERR_SSL_CONN_EOF on EOF or
1205 * another negative error code.
1206 */
Paul Bakker23986e52011-04-24 08:57:21 +00001207int ssl_fetch_input( ssl_context *ssl, size_t nb_want );
Paul Bakker5121ce52009-01-03 21:22:43 +00001208
1209int ssl_write_record( ssl_context *ssl );
1210int ssl_flush_output( ssl_context *ssl );
1211
1212int ssl_parse_certificate( ssl_context *ssl );
1213int ssl_write_certificate( ssl_context *ssl );
1214
1215int ssl_parse_change_cipher_spec( ssl_context *ssl );
1216int ssl_write_change_cipher_spec( ssl_context *ssl );
1217
1218int ssl_parse_finished( ssl_context *ssl );
1219int ssl_write_finished( ssl_context *ssl );
1220
Paul Bakker41c83d32013-03-20 14:39:14 +01001221void ssl_optimize_checksum( ssl_context *ssl, const ssl_ciphersuite_t *ciphersuite_info );
Paul Bakker380da532012-04-18 16:10:25 +00001222
Paul Bakker5121ce52009-01-03 21:22:43 +00001223#ifdef __cplusplus
1224}
1225#endif
1226
1227#endif /* ssl.h */