Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1 | /** |
| 2 | * \file ssl.h |
Paul Bakker | e0ccd0a | 2009-01-04 16:27:10 +0000 | [diff] [blame] | 3 | * |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 4 | * \brief SSL/TLS functions. |
| 5 | * |
Paul Bakker | 68884e3 | 2013-01-07 18:20:04 +0100 | [diff] [blame] | 6 | * Copyright (C) 2006-2013, Brainspark B.V. |
Paul Bakker | b96f154 | 2010-07-18 20:36:00 +0000 | [diff] [blame] | 7 | * |
| 8 | * This file is part of PolarSSL (http://www.polarssl.org) |
Paul Bakker | 84f12b7 | 2010-07-18 10:13:04 +0000 | [diff] [blame] | 9 | * Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org> |
Paul Bakker | b96f154 | 2010-07-18 20:36:00 +0000 | [diff] [blame] | 10 | * |
Paul Bakker | 77b385e | 2009-07-28 17:23:11 +0000 | [diff] [blame] | 11 | * All rights reserved. |
Paul Bakker | e0ccd0a | 2009-01-04 16:27:10 +0000 | [diff] [blame] | 12 | * |
Paul Bakker | e0ccd0a | 2009-01-04 16:27:10 +0000 | [diff] [blame] | 13 | * 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 Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 26 | */ |
Paul Bakker | 40e4694 | 2009-01-03 21:51:57 +0000 | [diff] [blame] | 27 | #ifndef POLARSSL_SSL_H |
| 28 | #define POLARSSL_SSL_H |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 29 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 30 | #include "config.h" |
Paul Bakker | 314052f | 2011-08-15 09:07:52 +0000 | [diff] [blame] | 31 | #include "net.h" |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 32 | #include "bignum.h" |
| 33 | |
Paul Bakker | 314052f | 2011-08-15 09:07:52 +0000 | [diff] [blame] | 34 | #include "md5.h" |
| 35 | #include "sha1.h" |
Paul Bakker | d2681d8 | 2013-06-30 14:49:12 +0200 | [diff] [blame] | 36 | #include "sha256.h" |
| 37 | #include "sha512.h" |
Manuel Pégourié-Gonnard | 990c51a | 2013-08-03 15:37:58 +0200 | [diff] [blame] | 38 | #include "aes.h" |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 39 | |
Paul Bakker | 68884e3 | 2013-01-07 18:20:04 +0100 | [diff] [blame] | 40 | #include "ssl_ciphersuites.h" |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 41 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 42 | #if defined(POLARSSL_X509_PARSE_C) |
| 43 | #include "x509.h" |
| 44 | #endif |
| 45 | |
| 46 | #if defined(POLARSSL_RSA_C) |
| 47 | #include "rsa.h" |
| 48 | #endif |
| 49 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 50 | #if defined(POLARSSL_DHM_C) |
| 51 | #include "dhm.h" |
| 52 | #endif |
| 53 | |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 54 | #if defined(POLARSSL_ECDH_C) |
| 55 | #include "ecdh.h" |
| 56 | #endif |
| 57 | |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 58 | #if defined(POLARSSL_ZLIB_SUPPORT) |
| 59 | #include "zlib.h" |
| 60 | #endif |
| 61 | |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 62 | #if defined(POLARSSL_HAVE_TIME) |
| 63 | #include <time.h> |
| 64 | #endif |
| 65 | |
Paul Bakker | 09b1ec6 | 2011-07-27 16:28:54 +0000 | [diff] [blame] | 66 | #if defined(_MSC_VER) && !defined(inline) |
Paul Bakker | af5c85f | 2011-04-18 03:47:52 +0000 | [diff] [blame] | 67 | #define inline _inline |
Paul Bakker | 569df2c | 2011-06-21 07:48:07 +0000 | [diff] [blame] | 68 | #else |
Paul Bakker | 09b1ec6 | 2011-07-27 16:28:54 +0000 | [diff] [blame] | 69 | #if defined(__ARMCC_VERSION) && !defined(inline) |
Paul Bakker | 569df2c | 2011-06-21 07:48:07 +0000 | [diff] [blame] | 70 | #define inline __inline |
Paul Bakker | 74fb74e | 2011-06-21 13:36:18 +0000 | [diff] [blame] | 71 | #endif /* __ARMCC_VERSION */ |
Paul Bakker | 569df2c | 2011-06-21 07:48:07 +0000 | [diff] [blame] | 72 | #endif /*_MSC_VER */ |
Paul Bakker | af5c85f | 2011-04-18 03:47:52 +0000 | [diff] [blame] | 73 | |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 74 | /* |
| 75 | * SSL Error codes |
| 76 | */ |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 77 | #define POLARSSL_ERR_SSL_FEATURE_UNAVAILABLE -0x7080 /**< The requested feature is not available. */ |
| 78 | #define POLARSSL_ERR_SSL_BAD_INPUT_DATA -0x7100 /**< Bad input parameters to function. */ |
| 79 | #define POLARSSL_ERR_SSL_INVALID_MAC -0x7180 /**< Verification of the message MAC failed. */ |
| 80 | #define POLARSSL_ERR_SSL_INVALID_RECORD -0x7200 /**< An invalid SSL record was received. */ |
Paul Bakker | 831a755 | 2011-05-18 13:32:51 +0000 | [diff] [blame] | 81 | #define POLARSSL_ERR_SSL_CONN_EOF -0x7280 /**< The connection indicated an EOF. */ |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 82 | #define POLARSSL_ERR_SSL_UNKNOWN_CIPHER -0x7300 /**< An unknown cipher was received. */ |
| 83 | #define POLARSSL_ERR_SSL_NO_CIPHER_CHOSEN -0x7380 /**< The server has no ciphersuites in common with the client. */ |
| 84 | #define POLARSSL_ERR_SSL_NO_SESSION_FOUND -0x7400 /**< No session to recover was found. */ |
| 85 | #define POLARSSL_ERR_SSL_NO_CLIENT_CERTIFICATE -0x7480 /**< No client certification received from the client, but required by the authentication mode. */ |
| 86 | #define POLARSSL_ERR_SSL_CERTIFICATE_TOO_LARGE -0x7500 /**< Our own certificate(s) is/are too large to send in an SSL message.*/ |
| 87 | #define POLARSSL_ERR_SSL_CERTIFICATE_REQUIRED -0x7580 /**< The own certificate is not set, but needed by the server. */ |
Paul Bakker | 73a899a | 2013-04-17 19:11:36 +0200 | [diff] [blame] | 88 | #define POLARSSL_ERR_SSL_PRIVATE_KEY_REQUIRED -0x7600 /**< The own private key or pre-shared key is not set, but needed. */ |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 89 | #define POLARSSL_ERR_SSL_CA_CHAIN_REQUIRED -0x7680 /**< No CA Chain is set, but required to operate. */ |
| 90 | #define POLARSSL_ERR_SSL_UNEXPECTED_MESSAGE -0x7700 /**< An unexpected message was received from our peer. */ |
| 91 | #define POLARSSL_ERR_SSL_FATAL_ALERT_MESSAGE -0x7780 /**< A fatal alert message was received from our peer. */ |
| 92 | #define POLARSSL_ERR_SSL_PEER_VERIFY_FAILED -0x7800 /**< Verification of our peer failed. */ |
| 93 | #define POLARSSL_ERR_SSL_PEER_CLOSE_NOTIFY -0x7880 /**< The peer notified us that the connection is going to be closed. */ |
| 94 | #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_HELLO -0x7900 /**< Processing of the ClientHello handshake message failed. */ |
| 95 | #define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO -0x7980 /**< Processing of the ServerHello handshake message failed. */ |
| 96 | #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE -0x7A00 /**< Processing of the Certificate handshake message failed. */ |
| 97 | #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_REQUEST -0x7A80 /**< Processing of the CertificateRequest handshake message failed. */ |
| 98 | #define POLARSSL_ERR_SSL_BAD_HS_SERVER_KEY_EXCHANGE -0x7B00 /**< Processing of the ServerKeyExchange handshake message failed. */ |
| 99 | #define POLARSSL_ERR_SSL_BAD_HS_SERVER_HELLO_DONE -0x7B80 /**< Processing of the ServerHelloDone handshake message failed. */ |
| 100 | #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE -0x7C00 /**< Processing of the ClientKeyExchange handshake message failed. */ |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 101 | #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_RP -0x7C80 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Read Public. */ |
| 102 | #define POLARSSL_ERR_SSL_BAD_HS_CLIENT_KEY_EXCHANGE_CS -0x7D00 /**< Processing of the ClientKeyExchange handshake message failed in DHM / ECDH Calculate Secret. */ |
Paul Bakker | 9d78140 | 2011-05-09 16:17:09 +0000 | [diff] [blame] | 103 | #define POLARSSL_ERR_SSL_BAD_HS_CERTIFICATE_VERIFY -0x7D80 /**< Processing of the CertificateVerify handshake message failed. */ |
| 104 | #define POLARSSL_ERR_SSL_BAD_HS_CHANGE_CIPHER_SPEC -0x7E00 /**< Processing of the ChangeCipherSpec handshake message failed. */ |
| 105 | #define POLARSSL_ERR_SSL_BAD_HS_FINISHED -0x7E80 /**< Processing of the Finished handshake message failed. */ |
Paul Bakker | 69e095c | 2011-12-10 21:55:01 +0000 | [diff] [blame] | 106 | #define POLARSSL_ERR_SSL_MALLOC_FAILED -0x7F00 /**< Memory allocation failed */ |
Paul Bakker | 05ef835 | 2012-05-08 09:17:57 +0000 | [diff] [blame] | 107 | #define POLARSSL_ERR_SSL_HW_ACCEL_FAILED -0x7F80 /**< Hardware acceleration function returned with error */ |
| 108 | #define POLARSSL_ERR_SSL_HW_ACCEL_FALLTHROUGH -0x6F80 /**< Hardware acceleration function skipped / left alone data */ |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 109 | #define POLARSSL_ERR_SSL_COMPRESSION_FAILED -0x6F00 /**< Processing of the compression / decompression failed */ |
Paul Bakker | 1d29fb5 | 2012-09-28 13:28:45 +0000 | [diff] [blame] | 110 | #define POLARSSL_ERR_SSL_BAD_HS_PROTOCOL_VERSION -0x6E80 /**< Handshake protocol not within min/max boundaries */ |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 111 | #define POLARSSL_ERR_SSL_BAD_HS_NEW_SESSION_TICKET -0x6E00 /**< Processing of the NewSessionTicket handshake message failed. */ |
Paul Bakker | 606b4ba | 2013-08-14 16:52:14 +0200 | [diff] [blame] | 112 | #define POLARSSL_ERR_SSL_SESSION_TICKET_EXPIRED -0x6D80 /**< Session ticket has expired. */ |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 113 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 114 | |
| 115 | /* |
| 116 | * Various constants |
| 117 | */ |
| 118 | #define SSL_MAJOR_VERSION_3 3 |
| 119 | #define SSL_MINOR_VERSION_0 0 /*!< SSL v3.0 */ |
| 120 | #define SSL_MINOR_VERSION_1 1 /*!< TLS v1.0 */ |
| 121 | #define SSL_MINOR_VERSION_2 2 /*!< TLS v1.1 */ |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 122 | #define SSL_MINOR_VERSION_3 3 /*!< TLS v1.2 */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 123 | |
Manuel Pégourié-Gonnard | 581e6b6 | 2013-07-18 12:32:27 +0200 | [diff] [blame] | 124 | /* RFC 6066 section 4, see also mfl_code_to_length in ssl_tls.c |
Manuel Pégourié-Gonnard | e048b67 | 2013-07-19 12:47:00 +0200 | [diff] [blame] | 125 | * NONE must be zero so that memset()ing structure to zero works */ |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 126 | #define SSL_MAX_FRAG_LEN_NONE 0 /*!< don't use this extension */ |
| 127 | #define SSL_MAX_FRAG_LEN_512 1 /*!< MaxFragmentLength 2^9 */ |
| 128 | #define SSL_MAX_FRAG_LEN_1024 2 /*!< MaxFragmentLength 2^10 */ |
| 129 | #define SSL_MAX_FRAG_LEN_2048 3 /*!< MaxFragmentLength 2^11 */ |
| 130 | #define SSL_MAX_FRAG_LEN_4096 4 /*!< MaxFragmentLength 2^12 */ |
Manuel Pégourié-Gonnard | ed4af8b | 2013-07-18 14:07:09 +0200 | [diff] [blame] | 131 | #define SSL_MAX_FRAG_LEN_INVALID 5 /*!< first invalid value */ |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 132 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 133 | #define SSL_IS_CLIENT 0 |
| 134 | #define SSL_IS_SERVER 1 |
| 135 | #define SSL_COMPRESS_NULL 0 |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 136 | #define SSL_COMPRESS_DEFLATE 1 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 137 | |
| 138 | #define SSL_VERIFY_NONE 0 |
| 139 | #define SSL_VERIFY_OPTIONAL 1 |
| 140 | #define SSL_VERIFY_REQUIRED 2 |
| 141 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 142 | #define SSL_INITIAL_HANDSHAKE 0 |
| 143 | #define SSL_RENEGOTIATION 1 |
| 144 | |
| 145 | #define SSL_LEGACY_RENEGOTIATION 0 |
| 146 | #define SSL_SECURE_RENEGOTIATION 1 |
| 147 | |
Paul Bakker | 7c90078 | 2012-11-04 16:29:08 +0000 | [diff] [blame] | 148 | #define SSL_RENEGOTIATION_DISABLED 0 |
| 149 | #define SSL_RENEGOTIATION_ENABLED 1 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 150 | |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 151 | #define SSL_LEGACY_NO_RENEGOTIATION 0 |
| 152 | #define SSL_LEGACY_ALLOW_RENEGOTIATION 1 |
| 153 | #define SSL_LEGACY_BREAK_HANDSHAKE 2 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 154 | |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 155 | #define SSL_TRUNC_HMAC_DISABLED 0 |
| 156 | #define SSL_TRUNC_HMAC_ENABLED 1 |
Manuel Pégourié-Gonnard | 277f7f2 | 2013-07-19 12:19:21 +0200 | [diff] [blame] | 157 | #define SSL_TRUNCATED_HMAC_LEN 10 /* 80 bits, rfc 6066 section 7 */ |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 158 | |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 159 | #define SSL_SESSION_TICKETS_DISABLED 0 |
| 160 | #define SSL_SESSION_TICKETS_ENABLED 1 |
| 161 | |
Paul Bakker | 606b4ba | 2013-08-14 16:52:14 +0200 | [diff] [blame] | 162 | #if !defined(POLARSSL_CONFIG_OPTIONS) |
| 163 | #define SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */ |
| 164 | #endif /* !POLARSSL_CONFIG_OPTIONS */ |
| 165 | |
Paul Bakker | 9bcf16c | 2013-06-24 19:31:17 +0200 | [diff] [blame] | 166 | /* |
| 167 | * Size of the input / output buffer. |
| 168 | * Note: the RFC defines the default size of SSL / TLS messages. If you |
| 169 | * change the value here, other clients / servers may not be able to |
| 170 | * communicate with you anymore. Only change this value if you control |
| 171 | * both sides of the connection and have it reduced at both sides! |
| 172 | */ |
| 173 | #if !defined(POLARSSL_CONFIG_OPTIONS) |
| 174 | #define SSL_MAX_CONTENT_LEN 16384 /**< Size of the input / output buffer */ |
| 175 | #endif /* !POLARSSL_CONFIG_OPTIONS */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 176 | |
| 177 | /* |
| 178 | * Allow an extra 512 bytes for the record header |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 179 | * and encryption overhead (counter + MAC + padding) |
| 180 | * and allow for a maximum of 1024 of compression expansion if |
| 181 | * enabled. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 182 | */ |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 183 | #if defined(POLARSSL_ZLIB_SUPPORT) |
| 184 | #define SSL_COMPRESSION_ADD 1024 |
| 185 | #else |
| 186 | #define SSL_COMPRESSION_ADD 0 |
| 187 | #endif |
| 188 | |
| 189 | #define SSL_BUFFER_LEN (SSL_MAX_CONTENT_LEN + SSL_COMPRESSION_ADD + 512) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 190 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 191 | #define SSL_EMPTY_RENEGOTIATION_INFO 0xFF /**< renegotiation info ext */ |
| 192 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 193 | /* |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 194 | * Supported Signature and Hash algorithms (For TLS 1.2) |
| 195 | */ |
| 196 | #define SSL_HASH_NONE 0 |
| 197 | #define SSL_HASH_MD5 1 |
| 198 | #define SSL_HASH_SHA1 2 |
| 199 | #define SSL_HASH_SHA224 3 |
| 200 | #define SSL_HASH_SHA256 4 |
| 201 | #define SSL_HASH_SHA384 5 |
| 202 | #define SSL_HASH_SHA512 6 |
| 203 | |
| 204 | #define SSL_SIG_RSA 1 |
| 205 | |
| 206 | /* |
Paul Bakker | 926af75 | 2012-11-23 13:38:07 +0100 | [diff] [blame] | 207 | * Client Certificate Types |
| 208 | */ |
| 209 | #define SSL_CERT_TYPE_RSA_SIGN 1 |
| 210 | |
| 211 | /* |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 212 | * Message, alert and handshake types |
| 213 | */ |
| 214 | #define SSL_MSG_CHANGE_CIPHER_SPEC 20 |
| 215 | #define SSL_MSG_ALERT 21 |
| 216 | #define SSL_MSG_HANDSHAKE 22 |
| 217 | #define SSL_MSG_APPLICATION_DATA 23 |
| 218 | |
Paul Bakker | 2e11f7d | 2010-07-25 14:24:53 +0000 | [diff] [blame] | 219 | #define SSL_ALERT_LEVEL_WARNING 1 |
| 220 | #define SSL_ALERT_LEVEL_FATAL 2 |
| 221 | |
Paul Bakker | e93dfa7 | 2012-04-10 08:03:03 +0000 | [diff] [blame] | 222 | #define SSL_ALERT_MSG_CLOSE_NOTIFY 0 /* 0x00 */ |
| 223 | #define SSL_ALERT_MSG_UNEXPECTED_MESSAGE 10 /* 0x0A */ |
| 224 | #define SSL_ALERT_MSG_BAD_RECORD_MAC 20 /* 0x14 */ |
| 225 | #define SSL_ALERT_MSG_DECRYPTION_FAILED 21 /* 0x15 */ |
| 226 | #define SSL_ALERT_MSG_RECORD_OVERFLOW 22 /* 0x16 */ |
| 227 | #define SSL_ALERT_MSG_DECOMPRESSION_FAILURE 30 /* 0x1E */ |
Paul Bakker | ca4ab49 | 2012-04-18 14:23:57 +0000 | [diff] [blame] | 228 | #define SSL_ALERT_MSG_HANDSHAKE_FAILURE 40 /* 0x28 */ |
Paul Bakker | e93dfa7 | 2012-04-10 08:03:03 +0000 | [diff] [blame] | 229 | #define SSL_ALERT_MSG_NO_CERT 41 /* 0x29 */ |
| 230 | #define SSL_ALERT_MSG_BAD_CERT 42 /* 0x2A */ |
| 231 | #define SSL_ALERT_MSG_UNSUPPORTED_CERT 43 /* 0x2B */ |
| 232 | #define SSL_ALERT_MSG_CERT_REVOKED 44 /* 0x2C */ |
| 233 | #define SSL_ALERT_MSG_CERT_EXPIRED 45 /* 0x2D */ |
| 234 | #define SSL_ALERT_MSG_CERT_UNKNOWN 46 /* 0x2E */ |
| 235 | #define SSL_ALERT_MSG_ILLEGAL_PARAMETER 47 /* 0x2F */ |
| 236 | #define SSL_ALERT_MSG_UNKNOWN_CA 48 /* 0x30 */ |
| 237 | #define SSL_ALERT_MSG_ACCESS_DENIED 49 /* 0x31 */ |
| 238 | #define SSL_ALERT_MSG_DECODE_ERROR 50 /* 0x32 */ |
| 239 | #define SSL_ALERT_MSG_DECRYPT_ERROR 51 /* 0x33 */ |
| 240 | #define SSL_ALERT_MSG_EXPORT_RESTRICTION 60 /* 0x3C */ |
| 241 | #define SSL_ALERT_MSG_PROTOCOL_VERSION 70 /* 0x46 */ |
| 242 | #define SSL_ALERT_MSG_INSUFFICIENT_SECURITY 71 /* 0x47 */ |
| 243 | #define SSL_ALERT_MSG_INTERNAL_ERROR 80 /* 0x50 */ |
| 244 | #define SSL_ALERT_MSG_USER_CANCELED 90 /* 0x5A */ |
| 245 | #define SSL_ALERT_MSG_NO_RENEGOTIATION 100 /* 0x64 */ |
Paul Bakker | c3f177a | 2012-04-11 16:11:49 +0000 | [diff] [blame] | 246 | #define SSL_ALERT_MSG_UNSUPPORTED_EXT 110 /* 0x6E */ |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 247 | #define SSL_ALERT_MSG_UNRECOGNIZED_NAME 112 /* 0x70 */ |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 248 | #define SSL_ALERT_MSG_UNKNOWN_PSK_IDENTITY 115 /* 0x73 */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 249 | |
| 250 | #define SSL_HS_HELLO_REQUEST 0 |
| 251 | #define SSL_HS_CLIENT_HELLO 1 |
| 252 | #define SSL_HS_SERVER_HELLO 2 |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 253 | #define SSL_HS_NEW_SESSION_TICKET 4 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 254 | #define SSL_HS_CERTIFICATE 11 |
| 255 | #define SSL_HS_SERVER_KEY_EXCHANGE 12 |
| 256 | #define SSL_HS_CERTIFICATE_REQUEST 13 |
| 257 | #define SSL_HS_SERVER_HELLO_DONE 14 |
| 258 | #define SSL_HS_CERTIFICATE_VERIFY 15 |
| 259 | #define SSL_HS_CLIENT_KEY_EXCHANGE 16 |
| 260 | #define SSL_HS_FINISHED 20 |
| 261 | |
| 262 | /* |
| 263 | * TLS extensions |
| 264 | */ |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 265 | #define TLS_EXT_SERVERNAME 0 |
| 266 | #define TLS_EXT_SERVERNAME_HOSTNAME 0 |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 267 | |
Manuel Pégourié-Gonnard | 48f8d0d | 2013-07-17 10:25:37 +0200 | [diff] [blame] | 268 | #define TLS_EXT_MAX_FRAGMENT_LENGTH 1 |
| 269 | |
Manuel Pégourié-Gonnard | 57c2852 | 2013-07-19 11:41:43 +0200 | [diff] [blame] | 270 | #define TLS_EXT_TRUNCATED_HMAC 4 |
| 271 | |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 272 | #define TLS_EXT_SUPPORTED_ELLIPTIC_CURVES 10 |
| 273 | #define TLS_EXT_SUPPORTED_POINT_FORMATS 11 |
Paul Bakker | c3f177a | 2012-04-11 16:11:49 +0000 | [diff] [blame] | 274 | |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 275 | #define TLS_EXT_SIG_ALG 13 |
| 276 | |
Manuel Pégourié-Gonnard | 60182ef | 2013-08-02 14:44:54 +0200 | [diff] [blame] | 277 | #define TLS_EXT_SESSION_TICKET 35 |
| 278 | |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 279 | #define TLS_EXT_RENEGOTIATION_INFO 0xFF01 |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 280 | |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 281 | /* |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 282 | * Size defines |
| 283 | */ |
| 284 | #if !defined(POLARSSL_MPI_MAX_SIZE) |
| 285 | #define POLARSSL_PREMASTER_SIZE 512 |
| 286 | #else |
| 287 | #define POLARSSL_PREMASTER_SIZE POLARSSL_MPI_MAX_SIZE |
| 288 | #endif |
| 289 | |
Paul Bakker | 407a0da | 2013-06-27 14:29:21 +0200 | [diff] [blame] | 290 | #ifdef __cplusplus |
| 291 | extern "C" { |
| 292 | #endif |
| 293 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 294 | /* |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 295 | * Generic function pointers for allowing external RSA private key |
| 296 | * implementations. |
| 297 | */ |
| 298 | typedef int (*rsa_decrypt_func)( void *ctx, int mode, size_t *olen, |
| 299 | const unsigned char *input, unsigned char *output, |
| 300 | size_t output_max_len ); |
| 301 | typedef int (*rsa_sign_func)( void *ctx, |
| 302 | int (*f_rng)(void *, unsigned char *, size_t), void *p_rng, |
| 303 | int mode, int hash_id, unsigned int hashlen, |
| 304 | const unsigned char *hash, unsigned char *sig ); |
| 305 | typedef size_t (*rsa_key_len_func)( void *ctx ); |
| 306 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 307 | /* |
| 308 | * SSL state machine |
| 309 | */ |
| 310 | typedef enum |
| 311 | { |
| 312 | SSL_HELLO_REQUEST, |
| 313 | SSL_CLIENT_HELLO, |
| 314 | SSL_SERVER_HELLO, |
| 315 | SSL_SERVER_CERTIFICATE, |
| 316 | SSL_SERVER_KEY_EXCHANGE, |
| 317 | SSL_CERTIFICATE_REQUEST, |
| 318 | SSL_SERVER_HELLO_DONE, |
| 319 | SSL_CLIENT_CERTIFICATE, |
| 320 | SSL_CLIENT_KEY_EXCHANGE, |
| 321 | SSL_CERTIFICATE_VERIFY, |
| 322 | SSL_CLIENT_CHANGE_CIPHER_SPEC, |
| 323 | SSL_CLIENT_FINISHED, |
| 324 | SSL_SERVER_CHANGE_CIPHER_SPEC, |
| 325 | SSL_SERVER_FINISHED, |
| 326 | SSL_FLUSH_BUFFERS, |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 327 | SSL_HANDSHAKE_WRAPUP, |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 328 | SSL_HANDSHAKE_OVER, |
| 329 | SSL_SERVER_NEW_SESSION_TICKET, |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 330 | } |
| 331 | ssl_states; |
| 332 | |
| 333 | typedef struct _ssl_session ssl_session; |
| 334 | typedef struct _ssl_context ssl_context; |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 335 | typedef struct _ssl_transform ssl_transform; |
| 336 | typedef struct _ssl_handshake_params ssl_handshake_params; |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 337 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Manuel Pégourié-Gonnard | 779e429 | 2013-08-03 13:50:48 +0200 | [diff] [blame] | 338 | typedef struct _ssl_ticket_keys ssl_ticket_keys; |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 339 | #endif |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 340 | |
| 341 | /* |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 342 | * This structure is used for storing current session data. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 343 | */ |
| 344 | struct _ssl_session |
| 345 | { |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 346 | #if defined(POLARSSL_HAVE_TIME) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 347 | time_t start; /*!< starting time */ |
Paul Bakker | fa9b100 | 2013-07-03 15:31:03 +0200 | [diff] [blame] | 348 | #endif |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 349 | int ciphersuite; /*!< chosen ciphersuite */ |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 350 | int compression; /*!< chosen compression */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 351 | size_t length; /*!< session id length */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 352 | unsigned char id[32]; /*!< session identifier */ |
| 353 | unsigned char master[48]; /*!< the master secret */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 354 | |
| 355 | #if defined(POLARSSL_X509_PARSE_C) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 356 | x509_cert *peer_cert; /*!< peer X.509 cert chain */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 357 | #endif /* POLARSSL_X509_PARSE_C */ |
Manuel Pégourié-Gonnard | ed4af8b | 2013-07-18 14:07:09 +0200 | [diff] [blame] | 358 | |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 359 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Manuel Pégourié-Gonnard | 75d4401 | 2013-08-02 14:44:04 +0200 | [diff] [blame] | 360 | unsigned char *ticket; /*!< RFC 5077 session ticket */ |
| 361 | size_t ticket_len; /*!< session ticket length */ |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 362 | uint32_t ticket_lifetime; /*!< ticket lifetime hint */ |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 363 | #endif /* POLARSSL_SSL_SESSION_TICKETS */ |
Manuel Pégourié-Gonnard | 75d4401 | 2013-08-02 14:44:04 +0200 | [diff] [blame] | 364 | |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 365 | #if defined(POLARSSL_SSL_MAX_FRAGMENT_LENGTH) |
Manuel Pégourié-Gonnard | ed4af8b | 2013-07-18 14:07:09 +0200 | [diff] [blame] | 366 | unsigned char mfl_code; /*!< MaxFragmentLength negotiated by peer */ |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 367 | #endif /* POLARSSL_SSL_MAX_FRAGMENT_LENGTH */ |
| 368 | |
Paul Bakker | 1f2bc62 | 2013-08-15 13:45:55 +0200 | [diff] [blame] | 369 | #if defined(POLARSSL_SSL_TRUNCATED_HMAC) |
Manuel Pégourié-Gonnard | 57c2852 | 2013-07-19 11:41:43 +0200 | [diff] [blame] | 370 | int trunc_hmac; /*!< flag for truncated hmac activation */ |
Paul Bakker | 1f2bc62 | 2013-08-15 13:45:55 +0200 | [diff] [blame] | 371 | #endif /* POLARSSL_SSL_TRUNCATED_HMAC */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 372 | }; |
| 373 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 374 | /* |
| 375 | * This structure contains a full set of runtime transform parameters |
| 376 | * either in negotiation or active. |
| 377 | */ |
| 378 | struct _ssl_transform |
| 379 | { |
| 380 | /* |
| 381 | * Session specific crypto layer |
| 382 | */ |
Paul Bakker | 68884e3 | 2013-01-07 18:20:04 +0100 | [diff] [blame] | 383 | const ssl_ciphersuite_t *ciphersuite_info; |
| 384 | /*!< Chosen cipersuite_info */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 385 | unsigned int keylen; /*!< symmetric key length */ |
| 386 | size_t minlen; /*!< min. ciphertext length */ |
| 387 | size_t ivlen; /*!< IV length */ |
| 388 | size_t fixed_ivlen; /*!< Fixed part of IV (AEAD) */ |
| 389 | size_t maclen; /*!< MAC length */ |
| 390 | |
| 391 | unsigned char iv_enc[16]; /*!< IV (encryption) */ |
| 392 | unsigned char iv_dec[16]; /*!< IV (decryption) */ |
| 393 | |
Paul Bakker | 68884e3 | 2013-01-07 18:20:04 +0100 | [diff] [blame] | 394 | /* Needed only for SSL v3.0 secret */ |
| 395 | unsigned char mac_enc[32]; /*!< SSL v3.0 secret (enc) */ |
| 396 | unsigned char mac_dec[32]; /*!< SSL v3.0 secret (dec) */ |
| 397 | |
| 398 | md_context_t md_ctx_enc; /*!< MAC (encryption) */ |
| 399 | md_context_t md_ctx_dec; /*!< MAC (decryption) */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 400 | |
Paul Bakker | d6f41c5 | 2013-07-25 17:01:54 +0200 | [diff] [blame] | 401 | /* 151 == 604 bytes is size of gcm_context (largest context in PolarSSL) */ |
| 402 | uint32_t ctx_enc[151]; /*!< encryption context */ |
| 403 | uint32_t ctx_dec[151]; /*!< decryption context */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 404 | |
| 405 | /* |
| 406 | * Session specific compression layer |
| 407 | */ |
| 408 | #if defined(POLARSSL_ZLIB_SUPPORT) |
| 409 | z_stream ctx_deflate; /*!< compression context */ |
| 410 | z_stream ctx_inflate; /*!< decompression context */ |
| 411 | #endif |
| 412 | }; |
| 413 | |
| 414 | /* |
| 415 | * This structure contains the parameters only needed during handshake. |
| 416 | */ |
| 417 | struct _ssl_handshake_params |
| 418 | { |
| 419 | /* |
| 420 | * Handshake specific crypto variables |
| 421 | */ |
Paul Bakker | 23f3680 | 2012-09-28 14:15:14 +0000 | [diff] [blame] | 422 | int sig_alg; /*!< Signature algorithm */ |
Paul Bakker | 926af75 | 2012-11-23 13:38:07 +0100 | [diff] [blame] | 423 | int cert_type; /*!< Requested cert type */ |
| 424 | int verify_sig_alg; /*!< Signature algorithm for verify */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 425 | #if defined(POLARSSL_DHM_C) |
| 426 | dhm_context dhm_ctx; /*!< DHM key exchange */ |
| 427 | #endif |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 428 | #if defined(POLARSSL_ECDH_C) |
| 429 | ecdh_context ecdh_ctx; /*!< ECDH key exchange */ |
| 430 | #endif |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 431 | int ec_curve; /*!< Selected elliptic curve */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 432 | |
| 433 | /* |
| 434 | * Checksum contexts |
| 435 | */ |
Paul Bakker | 9e36f04 | 2013-06-30 14:34:05 +0200 | [diff] [blame] | 436 | md5_context fin_md5; |
| 437 | sha1_context fin_sha1; |
| 438 | sha256_context fin_sha256; |
| 439 | sha512_context fin_sha512; |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 440 | |
Paul Bakker | b6c5d2e | 2013-06-25 16:25:17 +0200 | [diff] [blame] | 441 | void (*update_checksum)(ssl_context *, const unsigned char *, size_t); |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 442 | void (*calc_verify)(ssl_context *, unsigned char *); |
| 443 | void (*calc_finished)(ssl_context *, unsigned char *, int); |
Paul Bakker | b6c5d2e | 2013-06-25 16:25:17 +0200 | [diff] [blame] | 444 | int (*tls_prf)(const unsigned char *, size_t, const char *, |
| 445 | const unsigned char *, size_t, |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 446 | unsigned char *, size_t); |
| 447 | |
| 448 | size_t pmslen; /*!< premaster length */ |
| 449 | |
| 450 | unsigned char randbytes[64]; /*!< random bytes */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 451 | unsigned char premaster[POLARSSL_PREMASTER_SIZE]; |
Paul Bakker | df2bb75 | 2012-10-24 14:30:00 +0000 | [diff] [blame] | 452 | /*!< premaster secret */ |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 453 | |
| 454 | int resume; /*!< session resume indicator*/ |
Paul Bakker | 2fbefde | 2013-06-29 16:01:15 +0200 | [diff] [blame] | 455 | int max_major_ver; /*!< max. major version client*/ |
| 456 | int max_minor_ver; /*!< max. minor version client*/ |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 457 | |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 458 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Manuel Pégourié-Gonnard | a5cc602 | 2013-07-31 12:58:16 +0200 | [diff] [blame] | 459 | int new_session_ticket; /*!< use NewSessionTicket? */ |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 460 | #endif /* POLARSSL_SSL_SESSION_TICKETS */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 461 | }; |
| 462 | |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 463 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Manuel Pégourié-Gonnard | 779e429 | 2013-08-03 13:50:48 +0200 | [diff] [blame] | 464 | /* |
| 465 | * Parameters needed to secure session tickets |
| 466 | */ |
| 467 | struct _ssl_ticket_keys |
| 468 | { |
| 469 | unsigned char key_name[16]; /*!< name to quickly discard bad tickets */ |
Manuel Pégourié-Gonnard | 990c51a | 2013-08-03 15:37:58 +0200 | [diff] [blame] | 470 | aes_context enc; /*!< encryption context */ |
| 471 | aes_context dec; /*!< decryption context */ |
Manuel Pégourié-Gonnard | 56dc9e8 | 2013-08-03 17:16:31 +0200 | [diff] [blame] | 472 | unsigned char mac_key[16]; /*!< authentication key */ |
Manuel Pégourié-Gonnard | 779e429 | 2013-08-03 13:50:48 +0200 | [diff] [blame] | 473 | }; |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 474 | #endif /* POLARSSL_SSL_SESSION_TICKETS */ |
Manuel Pégourié-Gonnard | 779e429 | 2013-08-03 13:50:48 +0200 | [diff] [blame] | 475 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 476 | struct _ssl_context |
| 477 | { |
| 478 | /* |
| 479 | * Miscellaneous |
| 480 | */ |
| 481 | int state; /*!< SSL handshake: current state */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 482 | int renegotiation; /*!< Initial or renegotiation */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 483 | |
| 484 | int major_ver; /*!< equal to SSL_MAJOR_VERSION_3 */ |
| 485 | int minor_ver; /*!< either 0 (SSL3) or 1 (TLS1.0) */ |
| 486 | |
Paul Bakker | 2fbefde | 2013-06-29 16:01:15 +0200 | [diff] [blame] | 487 | int max_major_ver; /*!< max. major version used */ |
| 488 | int max_minor_ver; /*!< max. minor version used */ |
| 489 | int min_major_ver; /*!< min. major version used */ |
| 490 | int min_minor_ver; /*!< min. minor version used */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 491 | |
| 492 | /* |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 493 | * Callbacks (RNG, debug, I/O, verification) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 494 | */ |
Paul Bakker | a3d195c | 2011-11-27 21:07:34 +0000 | [diff] [blame] | 495 | int (*f_rng)(void *, unsigned char *, size_t); |
Paul Bakker | ff60ee6 | 2010-03-16 21:09:09 +0000 | [diff] [blame] | 496 | void (*f_dbg)(void *, int, const char *); |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 497 | int (*f_recv)(void *, unsigned char *, size_t); |
Paul Bakker | 39bb418 | 2011-06-21 07:36:43 +0000 | [diff] [blame] | 498 | int (*f_send)(void *, const unsigned char *, size_t); |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 499 | int (*f_get_cache)(void *, ssl_session *); |
| 500 | int (*f_set_cache)(void *, const ssl_session *); |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 501 | int (*f_sni)(void *, ssl_context *, const unsigned char *, size_t); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 502 | |
| 503 | void *p_rng; /*!< context for the RNG function */ |
| 504 | void *p_dbg; /*!< context for the debug function */ |
| 505 | void *p_recv; /*!< context for reading operations */ |
| 506 | void *p_send; /*!< context for writing operations */ |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 507 | void *p_get_cache; /*!< context for cache retrieval */ |
| 508 | void *p_set_cache; /*!< context for cache store */ |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 509 | void *p_sni; /*!< context for SNI extension */ |
Paul Bakker | e667c98 | 2012-11-20 13:50:22 +0100 | [diff] [blame] | 510 | void *p_hw_data; /*!< context for HW acceleration */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 511 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 512 | #if defined(POLARSSL_X509_PARSE_C) |
| 513 | int (*f_vrfy)(void *, x509_cert *, int, int *); |
| 514 | void *p_vrfy; /*!< context for verification */ |
| 515 | #endif |
| 516 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 517 | /* |
| 518 | * Session layer |
| 519 | */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 520 | ssl_session *session_in; /*!< current session data (in) */ |
| 521 | ssl_session *session_out; /*!< current session data (out) */ |
| 522 | ssl_session *session; /*!< negotiated session data */ |
| 523 | ssl_session *session_negotiate; /*!< session data in negotiation */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 524 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 525 | ssl_handshake_params *handshake; /*!< params required only during |
| 526 | the handshake process */ |
| 527 | |
| 528 | /* |
| 529 | * Record layer transformations |
| 530 | */ |
| 531 | ssl_transform *transform_in; /*!< current transform params (in) */ |
| 532 | ssl_transform *transform_out; /*!< current transform params (in) */ |
| 533 | ssl_transform *transform; /*!< negotiated transform params */ |
| 534 | ssl_transform *transform_negotiate; /*!< transform params in negotiation */ |
| 535 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 536 | /* |
| 537 | * Record layer (incoming data) |
| 538 | */ |
| 539 | unsigned char *in_ctr; /*!< 64-bit incoming message counter */ |
| 540 | unsigned char *in_hdr; /*!< 5-byte record header (in_ctr+8) */ |
Paul Bakker | 92be97b | 2013-01-02 17:30:03 +0100 | [diff] [blame] | 541 | unsigned char *in_iv; /*!< ivlen-byte IV (in_hdr+5) */ |
| 542 | unsigned char *in_msg; /*!< message contents (in_iv+ivlen) */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 543 | unsigned char *in_offt; /*!< read offset in application data */ |
| 544 | |
| 545 | int in_msgtype; /*!< record header: message type */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 546 | size_t in_msglen; /*!< record header: message length */ |
| 547 | size_t in_left; /*!< amount of data read so far */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 548 | |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 549 | size_t in_hslen; /*!< current handshake message length */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 550 | int nb_zero; /*!< # of 0-length encrypted messages */ |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 551 | int record_read; /*!< record is already present */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 552 | |
| 553 | /* |
| 554 | * Record layer (outgoing data) |
| 555 | */ |
| 556 | unsigned char *out_ctr; /*!< 64-bit outgoing message counter */ |
| 557 | unsigned char *out_hdr; /*!< 5-byte record header (out_ctr+8) */ |
Paul Bakker | 92be97b | 2013-01-02 17:30:03 +0100 | [diff] [blame] | 558 | unsigned char *out_iv; /*!< ivlen-byte IV (out_hdr+5) */ |
| 559 | unsigned char *out_msg; /*!< message contents (out_iv+ivlen) */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 560 | |
| 561 | int out_msgtype; /*!< record header: message type */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 562 | size_t out_msglen; /*!< record header: message length */ |
| 563 | size_t out_left; /*!< amount of data not yet written */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 564 | |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 565 | #if defined(POLARSSL_SSL_MAX_FRAGMENT_LENGTH) |
Manuel Pégourié-Gonnard | ed4af8b | 2013-07-18 14:07:09 +0200 | [diff] [blame] | 566 | unsigned char mfl_code; /*!< MaxFragmentLength chosen by us */ |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 567 | #endif /* POLARSSL_SSL_MAX_FRAGMENT_LENGTH */ |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 568 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 569 | /* |
| 570 | * PKI layer |
| 571 | */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 572 | #if defined(POLARSSL_RSA_C) |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 573 | void *rsa_key; /*!< own RSA private key */ |
| 574 | rsa_decrypt_func rsa_decrypt; /*!< function for RSA decrypt*/ |
| 575 | rsa_sign_func rsa_sign; /*!< function for RSA sign */ |
| 576 | rsa_key_len_func rsa_key_len; /*!< function for RSA key len*/ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 577 | #endif /* POLARSSL_RSA_C */ |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 578 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 579 | #if defined(POLARSSL_X509_PARSE_C) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 580 | x509_cert *own_cert; /*!< own X.509 certificate */ |
| 581 | x509_cert *ca_chain; /*!< own trusted CA chain */ |
Paul Bakker | 40ea7de | 2009-05-03 10:18:48 +0000 | [diff] [blame] | 582 | x509_crl *ca_crl; /*!< trusted CA CRLs */ |
Paul Bakker | 57b7914 | 2010-03-24 06:51:15 +0000 | [diff] [blame] | 583 | const char *peer_cn; /*!< expected peer CN */ |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 584 | #endif /* POLARSSL_X509_PARSE_C */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 585 | |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 586 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 587 | /* |
Manuel Pégourié-Gonnard | 779e429 | 2013-08-03 13:50:48 +0200 | [diff] [blame] | 588 | * Support for generating and checking session tickets |
| 589 | */ |
| 590 | ssl_ticket_keys *ticket_keys; /*!< keys for ticket encryption */ |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 591 | #endif /* POLARSSL_SSL_SESSION_TICKETS */ |
Manuel Pégourié-Gonnard | 779e429 | 2013-08-03 13:50:48 +0200 | [diff] [blame] | 592 | |
| 593 | /* |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 594 | * User settings |
| 595 | */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 596 | int endpoint; /*!< 0: client, 1: server */ |
| 597 | int authmode; /*!< verification mode */ |
| 598 | int client_auth; /*!< flag for client auth. */ |
| 599 | int verify_result; /*!< verification result */ |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 600 | int disable_renegotiation; /*!< enable/disable renegotiation */ |
| 601 | int allow_legacy_renegotiation; /*!< allow legacy renegotiation */ |
Paul Bakker | 8f4ddae | 2013-04-15 15:09:54 +0200 | [diff] [blame] | 602 | const int *ciphersuite_list[4]; /*!< allowed ciphersuites / version */ |
Paul Bakker | 1f2bc62 | 2013-08-15 13:45:55 +0200 | [diff] [blame] | 603 | #if defined(POLARSSL_SSL_TRUNCATED_HMAC) |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 604 | int trunc_hmac; /*!< negotiate truncated hmac? */ |
Paul Bakker | 1f2bc62 | 2013-08-15 13:45:55 +0200 | [diff] [blame] | 605 | #endif |
Paul Bakker | 606b4ba | 2013-08-14 16:52:14 +0200 | [diff] [blame] | 606 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 607 | int session_tickets; /*!< use session tickets? */ |
Paul Bakker | 606b4ba | 2013-08-14 16:52:14 +0200 | [diff] [blame] | 608 | int ticket_lifetime; /*!< session ticket lifetime */ |
| 609 | #endif |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 610 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 611 | #if defined(POLARSSL_DHM_C) |
| 612 | mpi dhm_P; /*!< prime modulus for DHM */ |
| 613 | mpi dhm_G; /*!< generator for DHM */ |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 614 | #endif |
| 615 | |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 616 | #if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED) |
| 617 | /* |
| 618 | * PSK values |
| 619 | */ |
| 620 | const unsigned char *psk; |
| 621 | size_t psk_len; |
| 622 | const unsigned char *psk_identity; |
| 623 | size_t psk_identity_len; |
| 624 | #endif |
| 625 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 626 | /* |
| 627 | * TLS extensions |
| 628 | */ |
| 629 | unsigned char *hostname; |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 630 | size_t hostname_len; |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 631 | |
| 632 | /* |
| 633 | * Secure renegotiation |
| 634 | */ |
| 635 | int secure_renegotiation; /*!< does peer support legacy or |
| 636 | secure renegotiation */ |
| 637 | size_t verify_data_len; /*!< length of verify data stored */ |
| 638 | char own_verify_data[36]; /*!< previous handshake verify data */ |
| 639 | char peer_verify_data[36]; /*!< previous handshake verify data */ |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 640 | }; |
| 641 | |
Paul Bakker | 05ef835 | 2012-05-08 09:17:57 +0000 | [diff] [blame] | 642 | #if defined(POLARSSL_SSL_HW_RECORD_ACCEL) |
Paul Bakker | 07eb38b | 2012-12-19 14:42:06 +0100 | [diff] [blame] | 643 | |
| 644 | #define SSL_CHANNEL_OUTBOUND 0 |
| 645 | #define SSL_CHANNEL_INBOUND 1 |
| 646 | |
Paul Bakker | 05ef835 | 2012-05-08 09:17:57 +0000 | [diff] [blame] | 647 | extern int (*ssl_hw_record_init)(ssl_context *ssl, |
| 648 | const unsigned char *key_enc, const unsigned char *key_dec, |
Paul Bakker | 07eb38b | 2012-12-19 14:42:06 +0100 | [diff] [blame] | 649 | size_t keylen, |
Paul Bakker | 05ef835 | 2012-05-08 09:17:57 +0000 | [diff] [blame] | 650 | const unsigned char *iv_enc, const unsigned char *iv_dec, |
Paul Bakker | 07eb38b | 2012-12-19 14:42:06 +0100 | [diff] [blame] | 651 | size_t ivlen, |
| 652 | const unsigned char *mac_enc, const unsigned char *mac_dec, |
| 653 | size_t maclen); |
| 654 | extern int (*ssl_hw_record_activate)(ssl_context *ssl, int direction); |
Paul Bakker | 05ef835 | 2012-05-08 09:17:57 +0000 | [diff] [blame] | 655 | extern int (*ssl_hw_record_reset)(ssl_context *ssl); |
| 656 | extern int (*ssl_hw_record_write)(ssl_context *ssl); |
| 657 | extern int (*ssl_hw_record_read)(ssl_context *ssl); |
| 658 | extern int (*ssl_hw_record_finish)(ssl_context *ssl); |
| 659 | #endif |
| 660 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 661 | /** |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 662 | * \brief Returns the list of ciphersuites supported by the SSL/TLS module. |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 663 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 664 | * \return a statically allocated array of ciphersuites, the last |
| 665 | * entry is 0. |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 666 | */ |
Paul Bakker | 68884e3 | 2013-01-07 18:20:04 +0100 | [diff] [blame] | 667 | const int *ssl_list_ciphersuites( void ); |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 668 | |
| 669 | /** |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 670 | * \brief Return the name of the ciphersuite associated with the given |
| 671 | * ID |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 672 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 673 | * \param ciphersuite_id SSL ciphersuite ID |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 674 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 675 | * \return a string containing the ciphersuite name |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 676 | */ |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 677 | const char *ssl_get_ciphersuite_name( const int ciphersuite_id ); |
| 678 | |
| 679 | /** |
| 680 | * \brief Return the ID of the ciphersuite associated with the given |
| 681 | * name |
| 682 | * |
| 683 | * \param ciphersuite_name SSL ciphersuite name |
| 684 | * |
| 685 | * \return the ID with the ciphersuite or 0 if not found |
| 686 | */ |
| 687 | int ssl_get_ciphersuite_id( const char *ciphersuite_name ); |
Paul Bakker | 72f6266 | 2011-01-16 21:27:44 +0000 | [diff] [blame] | 688 | |
| 689 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 690 | * \brief Initialize an SSL context |
| 691 | * |
| 692 | * \param ssl SSL context |
| 693 | * |
Paul Bakker | 69e095c | 2011-12-10 21:55:01 +0000 | [diff] [blame] | 694 | * \return 0 if successful, or POLARSSL_ERR_SSL_MALLOC_FAILED if |
| 695 | * memory allocation failed |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 696 | */ |
| 697 | int ssl_init( ssl_context *ssl ); |
| 698 | |
| 699 | /** |
Paul Bakker | 7eb013f | 2011-10-06 12:37:39 +0000 | [diff] [blame] | 700 | * \brief Reset an already initialized SSL context for re-use |
| 701 | * while retaining application-set variables, function |
| 702 | * pointers and data. |
| 703 | * |
| 704 | * \param ssl SSL context |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 705 | * \return 0 if successful, or POLASSL_ERR_SSL_MALLOC_FAILED, |
| 706 | POLARSSL_ERR_SSL_HW_ACCEL_FAILED or |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 707 | * POLARSSL_ERR_SSL_COMPRESSION_FAILED |
Paul Bakker | 7eb013f | 2011-10-06 12:37:39 +0000 | [diff] [blame] | 708 | */ |
Paul Bakker | 2770fbd | 2012-07-03 13:30:23 +0000 | [diff] [blame] | 709 | int ssl_session_reset( ssl_context *ssl ); |
Paul Bakker | 7eb013f | 2011-10-06 12:37:39 +0000 | [diff] [blame] | 710 | |
| 711 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 712 | * \brief Set the current endpoint type |
| 713 | * |
| 714 | * \param ssl SSL context |
| 715 | * \param endpoint must be SSL_IS_CLIENT or SSL_IS_SERVER |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 716 | * |
| 717 | * \note This function should be called right after ssl_init() since |
| 718 | * some other ssl_set_foo() functions depend on it. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 719 | */ |
| 720 | void ssl_set_endpoint( ssl_context *ssl, int endpoint ); |
| 721 | |
| 722 | /** |
| 723 | * \brief Set the certificate verification mode |
| 724 | * |
| 725 | * \param ssl SSL context |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 726 | * \param authmode can be: |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 727 | * |
| 728 | * SSL_VERIFY_NONE: peer certificate is not checked (default), |
| 729 | * this is insecure and SHOULD be avoided. |
| 730 | * |
| 731 | * SSL_VERIFY_OPTIONAL: peer certificate is checked, however the |
| 732 | * handshake continues even if verification failed; |
| 733 | * ssl_get_verify_result() can be called after the |
| 734 | * handshake is complete. |
| 735 | * |
| 736 | * SSL_VERIFY_REQUIRED: peer *must* present a valid certificate, |
| 737 | * handshake is aborted if verification failed. |
| 738 | */ |
| 739 | void ssl_set_authmode( ssl_context *ssl, int authmode ); |
| 740 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 741 | #if defined(POLARSSL_X509_PARSE_C) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 742 | /** |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 743 | * \brief Set the verification callback (Optional). |
| 744 | * |
Paul Bakker | 915275b | 2012-09-28 07:10:55 +0000 | [diff] [blame] | 745 | * If set, the verify callback is called for each |
| 746 | * certificate in the chain. For implementation |
| 747 | * information, please see \c x509parse_verify() |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 748 | * |
| 749 | * \param ssl SSL context |
| 750 | * \param f_vrfy verification function |
| 751 | * \param p_vrfy verification parameter |
| 752 | */ |
| 753 | void ssl_set_verify( ssl_context *ssl, |
Paul Bakker | 915275b | 2012-09-28 07:10:55 +0000 | [diff] [blame] | 754 | int (*f_vrfy)(void *, x509_cert *, int, int *), |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 755 | void *p_vrfy ); |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 756 | #endif /* POLARSSL_X509_PARSE_C */ |
Paul Bakker | b63b0af | 2011-01-13 17:54:59 +0000 | [diff] [blame] | 757 | |
| 758 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 759 | * \brief Set the random number generator callback |
| 760 | * |
| 761 | * \param ssl SSL context |
| 762 | * \param f_rng RNG function |
| 763 | * \param p_rng RNG parameter |
| 764 | */ |
| 765 | void ssl_set_rng( ssl_context *ssl, |
Paul Bakker | a3d195c | 2011-11-27 21:07:34 +0000 | [diff] [blame] | 766 | int (*f_rng)(void *, unsigned char *, size_t), |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 767 | void *p_rng ); |
| 768 | |
| 769 | /** |
| 770 | * \brief Set the debug callback |
| 771 | * |
| 772 | * \param ssl SSL context |
| 773 | * \param f_dbg debug function |
| 774 | * \param p_dbg debug parameter |
| 775 | */ |
| 776 | void ssl_set_dbg( ssl_context *ssl, |
Paul Bakker | ff60ee6 | 2010-03-16 21:09:09 +0000 | [diff] [blame] | 777 | void (*f_dbg)(void *, int, const char *), |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 778 | void *p_dbg ); |
| 779 | |
| 780 | /** |
| 781 | * \brief Set the underlying BIO read and write callbacks |
| 782 | * |
| 783 | * \param ssl SSL context |
| 784 | * \param f_recv read callback |
| 785 | * \param p_recv read parameter |
| 786 | * \param f_send write callback |
| 787 | * \param p_send write parameter |
| 788 | */ |
| 789 | void ssl_set_bio( ssl_context *ssl, |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 790 | int (*f_recv)(void *, unsigned char *, size_t), void *p_recv, |
Paul Bakker | 39bb418 | 2011-06-21 07:36:43 +0000 | [diff] [blame] | 791 | int (*f_send)(void *, const unsigned char *, size_t), void *p_send ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 792 | |
| 793 | /** |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 794 | * \brief Set the session cache callbacks (server-side only) |
| 795 | * If not set, no session resuming is done. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 796 | * |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 797 | * The session cache has the responsibility to check for stale |
| 798 | * entries based on timeout. See RFC 5246 for recommendations. |
| 799 | * |
| 800 | * Warning: session.peer_cert is cleared by the SSL/TLS layer on |
| 801 | * connection shutdown, so do not cache the pointer! Either set |
| 802 | * it to NULL or make a full copy of the certificate. |
| 803 | * |
| 804 | * The get callback is called once during the initial handshake |
| 805 | * to enable session resuming. The get function has the |
| 806 | * following parameters: (void *parameter, ssl_session *session) |
| 807 | * If a valid entry is found, it should fill the master of |
| 808 | * the session object with the cached values and return 0, |
| 809 | * return 1 otherwise. Optionally peer_cert can be set as well |
| 810 | * if it is properly present in cache entry. |
| 811 | * |
| 812 | * The set callback is called once during the initial handshake |
| 813 | * to enable session resuming after the entire handshake has |
| 814 | * been finished. The set function has the following parameters: |
| 815 | * (void *parameter, const ssl_session *session). The function |
| 816 | * should create a cache entry for future retrieval based on |
| 817 | * the data in the session structure and should keep in mind |
| 818 | * that the ssl_session object presented (and all its referenced |
| 819 | * data) is cleared by the SSL/TLS layer when the connection is |
| 820 | * terminated. It is recommended to add metadata to determine if |
| 821 | * an entry is still valid in the future. Return 0 if |
Paul Bakker | 7a2538e | 2012-11-02 10:59:36 +0000 | [diff] [blame] | 822 | * successfully cached, return 1 otherwise. |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 823 | * |
| 824 | * \param ssl SSL context |
| 825 | * \param f_get_cache session get callback |
| 826 | * \param p_get_cache session get parameter |
| 827 | * \param f_set_cache session set callback |
| 828 | * \param p_set_cache session set parameter |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 829 | */ |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 830 | void ssl_set_session_cache( ssl_context *ssl, |
| 831 | int (*f_get_cache)(void *, ssl_session *), void *p_get_cache, |
| 832 | int (*f_set_cache)(void *, const ssl_session *), void *p_set_cache ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 833 | |
| 834 | /** |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 835 | * \brief Request resumption of session (client-side only) |
| 836 | * Session data is copied from presented session structure. |
| 837 | * |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 838 | * \param ssl SSL context |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 839 | * \param session session context |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 840 | * |
Manuel Pégourié-Gonnard | 06650f6 | 2013-08-02 15:34:52 +0200 | [diff] [blame] | 841 | * \return 0 if successful, |
| 842 | * POLARSSL_ERR_SSL_MALLOC_FAILED if memory allocation failed, |
| 843 | * POLARSSL_ERR_SSL_BAD_INPUT_DATA if used server-side or |
| 844 | * arguments are otherwise invalid |
| 845 | * |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 846 | * \sa ssl_get_session() |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 847 | */ |
Manuel Pégourié-Gonnard | 06650f6 | 2013-08-02 15:34:52 +0200 | [diff] [blame] | 848 | int ssl_set_session( ssl_context *ssl, const ssl_session *session ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 849 | |
| 850 | /** |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 851 | * \brief Set the list of allowed ciphersuites |
Paul Bakker | 8f4ddae | 2013-04-15 15:09:54 +0200 | [diff] [blame] | 852 | * (Overrides all version specific lists) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 853 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 854 | * \param ssl SSL context |
| 855 | * \param ciphersuites 0-terminated list of allowed ciphersuites |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 856 | */ |
Paul Bakker | b68cad6 | 2012-08-23 08:34:18 +0000 | [diff] [blame] | 857 | void ssl_set_ciphersuites( ssl_context *ssl, const int *ciphersuites ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 858 | |
| 859 | /** |
Paul Bakker | 8f4ddae | 2013-04-15 15:09:54 +0200 | [diff] [blame] | 860 | * \brief Set the list of allowed ciphersuites for a specific |
| 861 | * version of the protocol. |
| 862 | * (Only useful on the server side) |
| 863 | * |
| 864 | * \param ssl SSL context |
| 865 | * \param ciphersuites 0-terminated list of allowed ciphersuites |
| 866 | * \param major Major version number (only SSL_MAJOR_VERSION_3 |
| 867 | * supported) |
| 868 | * \param minor Minor version number (SSL_MINOR_VERSION_0, |
| 869 | * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2, |
| 870 | * SSL_MINOR_VERSION_3 supported) |
| 871 | */ |
| 872 | void ssl_set_ciphersuites_for_version( ssl_context *ssl, |
| 873 | const int *ciphersuites, |
| 874 | int major, int minor ); |
| 875 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 876 | #if defined(POLARSSL_X509_PARSE_C) |
Paul Bakker | 8f4ddae | 2013-04-15 15:09:54 +0200 | [diff] [blame] | 877 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 878 | * \brief Set the data required to verify peer certificate |
| 879 | * |
| 880 | * \param ssl SSL context |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 881 | * \param ca_chain trusted CA chain (meaning all fully trusted top-level CAs) |
Paul Bakker | 40ea7de | 2009-05-03 10:18:48 +0000 | [diff] [blame] | 882 | * \param ca_crl trusted CA CRLs |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 883 | * \param peer_cn expected peer CommonName (or NULL) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 884 | */ |
| 885 | void ssl_set_ca_chain( ssl_context *ssl, x509_cert *ca_chain, |
Paul Bakker | 57b7914 | 2010-03-24 06:51:15 +0000 | [diff] [blame] | 886 | x509_crl *ca_crl, const char *peer_cn ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 887 | |
| 888 | /** |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 889 | * \brief Set own certificate chain and private key |
| 890 | * |
| 891 | * Note: own_cert should contain IN order from the bottom |
| 892 | * up your certificate chain. The top certificate (self-signed) |
| 893 | * can be omitted. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 894 | * |
| 895 | * \param ssl SSL context |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 896 | * \param own_cert own public certificate chain |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 897 | * \param rsa_key own private RSA key |
| 898 | */ |
| 899 | void ssl_set_own_cert( ssl_context *ssl, x509_cert *own_cert, |
| 900 | rsa_context *rsa_key ); |
| 901 | |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 902 | /** |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 903 | * \brief Set own certificate and alternate non-PolarSSL private |
| 904 | * key and handling callbacks, such as the PKCS#11 wrappers |
| 905 | * or any other external private key handler. |
| 906 | * (see the respective RSA functions in rsa.h for documentation |
| 907 | * of the callback parameters, with the only change being |
| 908 | * that the rsa_context * is a void * in the callbacks) |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 909 | * |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 910 | * Note: own_cert should contain IN order from the bottom |
| 911 | * up your certificate chain. The top certificate (self-signed) |
| 912 | * can be omitted. |
| 913 | * |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 914 | * \param ssl SSL context |
Paul Bakker | 1f9d02d | 2012-11-20 10:30:55 +0100 | [diff] [blame] | 915 | * \param own_cert own public certificate chain |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 916 | * \param rsa_key alternate implementation private RSA key |
| 917 | * \param rsa_decrypt_func alternate implementation of \c rsa_pkcs1_decrypt() |
| 918 | * \param rsa_sign_func alternate implementation of \c rsa_pkcs1_sign() |
| 919 | * \param rsa_key_len_func function returning length of RSA key in bytes |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 920 | */ |
Paul Bakker | eb2c658 | 2012-09-27 19:15:01 +0000 | [diff] [blame] | 921 | void ssl_set_own_cert_alt( ssl_context *ssl, x509_cert *own_cert, |
| 922 | void *rsa_key, |
| 923 | rsa_decrypt_func rsa_decrypt, |
| 924 | rsa_sign_func rsa_sign, |
| 925 | rsa_key_len_func rsa_key_len ); |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 926 | #endif /* POLARSSL_X509_PARSE_C */ |
Paul Bakker | 43b7e35 | 2011-01-18 15:27:19 +0000 | [diff] [blame] | 927 | |
Paul Bakker | d4a56ec | 2013-04-16 18:05:29 +0200 | [diff] [blame] | 928 | #if defined(POLARSSL_KEY_EXCHANGE_PSK_ENABLED) |
| 929 | /** |
| 930 | * \brief Set the Pre Shared Key (PSK) and the identity name connected |
| 931 | * to it. The PSK is used in all PSK-based ciphersuites. |
| 932 | * |
| 933 | * \param ssl SSL context |
| 934 | * \param psk pointer to the pre-shared key |
| 935 | * \param psk_len pre-shared key length |
| 936 | * \param psk_identity pointer to the pre-shared key identity |
| 937 | * \param psk_identity_len identity key length |
| 938 | */ |
| 939 | void ssl_set_psk( ssl_context *ssl, const unsigned char *psk, size_t psk_len, |
| 940 | const unsigned char *psk_identity, size_t psk_identity_len ); |
| 941 | #endif /* POLARSSL_KEY_EXCHANGE_PSK_ENABLED */ |
| 942 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 943 | #if defined(POLARSSL_DHM_C) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 944 | /** |
| 945 | * \brief Set the Diffie-Hellman public P and G values, |
| 946 | * read as hexadecimal strings (server-side only) |
Paul Bakker | 62f2dee | 2012-09-28 07:31:51 +0000 | [diff] [blame] | 947 | * (Default: POLARSSL_DHM_RFC5114_MODP_1024_[PG]) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 948 | * |
| 949 | * \param ssl SSL context |
| 950 | * \param dhm_P Diffie-Hellman-Merkle modulus |
| 951 | * \param dhm_G Diffie-Hellman-Merkle generator |
| 952 | * |
| 953 | * \return 0 if successful |
| 954 | */ |
Paul Bakker | ff60ee6 | 2010-03-16 21:09:09 +0000 | [diff] [blame] | 955 | int ssl_set_dh_param( ssl_context *ssl, const char *dhm_P, const char *dhm_G ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 956 | |
| 957 | /** |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 958 | * \brief Set the Diffie-Hellman public P and G values, |
| 959 | * read from existing context (server-side only) |
| 960 | * |
| 961 | * \param ssl SSL context |
| 962 | * \param dhm_ctx Diffie-Hellman-Merkle context |
| 963 | * |
| 964 | * \return 0 if successful |
| 965 | */ |
| 966 | int ssl_set_dh_param_ctx( ssl_context *ssl, dhm_context *dhm_ctx ); |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 967 | #endif |
Paul Bakker | 1b57b06 | 2011-01-06 15:48:19 +0000 | [diff] [blame] | 968 | |
| 969 | /** |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 970 | * \brief Set hostname for ServerName TLS extension |
| 971 | * (client-side only) |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 972 | * |
| 973 | * |
| 974 | * \param ssl SSL context |
| 975 | * \param hostname the server hostname |
| 976 | * |
Paul Bakker | b15b851 | 2012-01-13 13:44:06 +0000 | [diff] [blame] | 977 | * \return 0 if successful or POLARSSL_ERR_SSL_MALLOC_FAILED |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 978 | */ |
Paul Bakker | ff60ee6 | 2010-03-16 21:09:09 +0000 | [diff] [blame] | 979 | int ssl_set_hostname( ssl_context *ssl, const char *hostname ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 980 | |
| 981 | /** |
Paul Bakker | 5701cdc | 2012-09-27 21:49:42 +0000 | [diff] [blame] | 982 | * \brief Set server side ServerName TLS extension callback |
| 983 | * (optional, server-side only). |
| 984 | * |
| 985 | * If set, the ServerName callback is called whenever the |
| 986 | * server receives a ServerName TLS extension from the client |
| 987 | * during a handshake. The ServerName callback has the |
| 988 | * following parameters: (void *parameter, ssl_context *ssl, |
| 989 | * const unsigned char *hostname, size_t len). If a suitable |
| 990 | * certificate is found, the callback should set the |
| 991 | * certificate and key to use with ssl_set_own_cert() (and |
| 992 | * possibly adjust the CA chain as well) and return 0. The |
| 993 | * callback should return -1 to abort the handshake at this |
| 994 | * point. |
| 995 | * |
| 996 | * \param ssl SSL context |
| 997 | * \param f_sni verification function |
| 998 | * \param p_sni verification parameter |
| 999 | */ |
| 1000 | void ssl_set_sni( ssl_context *ssl, |
| 1001 | int (*f_sni)(void *, ssl_context *, const unsigned char *, |
| 1002 | size_t), |
| 1003 | void *p_sni ); |
| 1004 | |
| 1005 | /** |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 1006 | * \brief Set the maximum supported version sent from the client side |
Paul Bakker | 2fbefde | 2013-06-29 16:01:15 +0200 | [diff] [blame] | 1007 | * and/or accepted at the server side |
| 1008 | * (Default: SSL_MAJOR_VERSION_3, SSL_MINOR_VERSION_3) |
| 1009 | * |
| 1010 | * Note: This prevents ciphersuites from 'higher' versions to |
| 1011 | * be ignored. |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 1012 | * |
| 1013 | * \param ssl SSL context |
| 1014 | * \param major Major version number (only SSL_MAJOR_VERSION_3 supported) |
| 1015 | * \param minor Minor version number (SSL_MINOR_VERSION_0, |
Paul Bakker | 1ef83d6 | 2012-04-11 12:09:53 +0000 | [diff] [blame] | 1016 | * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2, |
| 1017 | * SSL_MINOR_VERSION_3 supported) |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 1018 | */ |
| 1019 | void ssl_set_max_version( ssl_context *ssl, int major, int minor ); |
| 1020 | |
Paul Bakker | 1d29fb5 | 2012-09-28 13:28:45 +0000 | [diff] [blame] | 1021 | |
| 1022 | /** |
| 1023 | * \brief Set the minimum accepted SSL/TLS protocol version |
| 1024 | * (Default: SSL_MAJOR_VERSION_3, SSL_MINOR_VERSION_0) |
| 1025 | * |
| 1026 | * \param ssl SSL context |
| 1027 | * \param major Major version number (only SSL_MAJOR_VERSION_3 supported) |
| 1028 | * \param minor Minor version number (SSL_MINOR_VERSION_0, |
| 1029 | * SSL_MINOR_VERSION_1 and SSL_MINOR_VERSION_2, |
| 1030 | * SSL_MINOR_VERSION_3 supported) |
| 1031 | */ |
| 1032 | void ssl_set_min_version( ssl_context *ssl, int major, int minor ); |
| 1033 | |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 1034 | #if defined(POLARSSL_SSL_MAX_FRAGMENT_LENGTH) |
Paul Bakker | 490ecc8 | 2011-10-06 13:04:09 +0000 | [diff] [blame] | 1035 | /** |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 1036 | * \brief Set the maximum fragment length to emit and/or negotiate |
| 1037 | * (Default: SSL_MAX_CONTENT_LEN, usually 2^14 bytes) |
| 1038 | * (Server: set maximum fragment length to emit, |
| 1039 | * usually negotiated by the client during handshake |
| 1040 | * (Client: set maximum fragment length to emit *and* |
| 1041 | * negotiate with the server during handshake) |
| 1042 | * |
| 1043 | * \param ssl SSL context |
| 1044 | * \param mfl Code for maximum fragment length (allowed values: |
| 1045 | * SSL_MAX_FRAG_LEN_512, SSL_MAX_FRAG_LEN_1024, |
| 1046 | * SSL_MAX_FRAG_LEN_2048, SSL_MAX_FRAG_LEN_4096) |
| 1047 | * |
| 1048 | * \return O if successful or POLARSSL_ERR_SSL_BAD_INPUT_DATA |
| 1049 | */ |
| 1050 | int ssl_set_max_frag_len( ssl_context *ssl, unsigned char mfl_code ); |
Paul Bakker | 05decb2 | 2013-08-15 13:33:48 +0200 | [diff] [blame] | 1051 | #endif /* POLARSSL_SSL_MAX_FRAGMENT_LENGTH */ |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 1052 | |
Paul Bakker | 1f2bc62 | 2013-08-15 13:45:55 +0200 | [diff] [blame] | 1053 | #if defined(POLARSSL_SSL_TRUNCATED_HMAC) |
Manuel Pégourié-Gonnard | 8b46459 | 2013-07-16 12:45:26 +0200 | [diff] [blame] | 1054 | /** |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 1055 | * \brief Activate negotiation of truncated HMAC (Client only) |
Paul Bakker | 8c1ede6 | 2013-07-19 14:14:37 +0200 | [diff] [blame] | 1056 | * (Default: SSL_TRUNC_HMAC_ENABLED) |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 1057 | * |
| 1058 | * \param ssl SSL context |
Paul Bakker | 8c1ede6 | 2013-07-19 14:14:37 +0200 | [diff] [blame] | 1059 | * \param truncate Enable or disable (SSL_TRUNC_HMAC_ENABLED or |
| 1060 | * SSL_TRUNC_HMAC_DISABLED) |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 1061 | * |
| 1062 | * \return O if successful, |
| 1063 | * POLARSSL_ERR_SSL_BAD_INPUT_DATA if used server-side |
| 1064 | */ |
Paul Bakker | 8c1ede6 | 2013-07-19 14:14:37 +0200 | [diff] [blame] | 1065 | int ssl_set_truncated_hmac( ssl_context *ssl, int truncate ); |
Paul Bakker | 1f2bc62 | 2013-08-15 13:45:55 +0200 | [diff] [blame] | 1066 | #endif /* POLARSSL_SSL_TRUNCATED_HMAC */ |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 1067 | |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 1068 | #if defined(POLARSSL_SSL_SESSION_TICKETS) |
Manuel Pégourié-Gonnard | e980a99 | 2013-07-19 11:08:52 +0200 | [diff] [blame] | 1069 | /** |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 1070 | * \brief Enable / Disable session tickets |
| 1071 | * (Default: SSL_SESSION_TICKETS_ENABLED on client, |
| 1072 | * SSL_SESSION_TICKETS_DISABLED on server) |
| 1073 | * |
| 1074 | * \note On server, ssl_set_rng() must be called before this function |
| 1075 | * to allow generating the ticket encryption and |
| 1076 | * authentication keys. |
| 1077 | * |
| 1078 | * \param ssl SSL context |
| 1079 | * \param use_tickets Enable or disable (SSL_SESSION_TICKETS_ENABLED or |
| 1080 | * SSL_SESSION_TICKETS_DISABLED) |
| 1081 | * |
| 1082 | * \return O if successful, |
| 1083 | * or a specific error code (server only). |
| 1084 | */ |
| 1085 | int ssl_set_session_tickets( ssl_context *ssl, int use_tickets ); |
Paul Bakker | 606b4ba | 2013-08-14 16:52:14 +0200 | [diff] [blame] | 1086 | |
| 1087 | /** |
| 1088 | * \brief Set session ticket lifetime (server only) |
| 1089 | * (Default: SSL_DEFAULT_TICKET_LIFETIME (86400 secs / 1 day)) |
| 1090 | * |
| 1091 | * \param ssl SSL context |
| 1092 | * \param lifetime session ticket lifetime |
| 1093 | */ |
| 1094 | void ssl_set_session_ticket_lifetime( ssl_context *ssl, int lifetime ); |
Paul Bakker | a503a63 | 2013-08-14 13:48:06 +0200 | [diff] [blame] | 1095 | #endif /* POLARSSL_SSL_SESSION_TICKETS */ |
Manuel Pégourié-Gonnard | aa0d4d1 | 2013-08-03 13:02:31 +0200 | [diff] [blame] | 1096 | |
| 1097 | /** |
Paul Bakker | 09f097d | 2012-10-23 11:54:56 +0000 | [diff] [blame] | 1098 | * \brief Enable / Disable renegotiation support for connection when |
| 1099 | * initiated by peer |
| 1100 | * (Default: SSL_RENEGOTIATION_DISABLED) |
| 1101 | * |
| 1102 | * Note: A server with support enabled is more vulnerable for a |
Paul Bakker | 7c90078 | 2012-11-04 16:29:08 +0000 | [diff] [blame] | 1103 | * resource DoS by a malicious client. You should enable this on |
| 1104 | * a client to enable server-initiated renegotiation. |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1105 | * |
| 1106 | * \param ssl SSL context |
| 1107 | * \param renegotiation Enable or disable (SSL_RENEGOTIATION_ENABLED or |
| 1108 | * SSL_RENEGOTIATION_DISABLED) |
| 1109 | */ |
| 1110 | void ssl_set_renegotiation( ssl_context *ssl, int renegotiation ); |
| 1111 | |
| 1112 | /** |
| 1113 | * \brief Prevent or allow legacy renegotiation. |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 1114 | * (Default: SSL_LEGACY_NO_RENEGOTIATION) |
| 1115 | * |
| 1116 | * SSL_LEGACY_NO_RENEGOTIATION allows connections to |
| 1117 | * be established even if the peer does not support |
| 1118 | * secure renegotiation, but does not allow renegotiation |
| 1119 | * to take place if not secure. |
| 1120 | * (Interoperable and secure option) |
| 1121 | * |
| 1122 | * SSL_LEGACY_ALLOW_RENEGOTIATION allows renegotiations |
| 1123 | * with non-upgraded peers. Allowing legacy renegotiation |
| 1124 | * makes the connection vulnerable to specific man in the |
| 1125 | * middle attacks. (See RFC 5746) |
| 1126 | * (Most interoperable and least secure option) |
| 1127 | * |
| 1128 | * SSL_LEGACY_BREAK_HANDSHAKE breaks off connections |
| 1129 | * if peer does not support secure renegotiation. Results |
| 1130 | * in interoperability issues with non-upgraded peers |
| 1131 | * that do not support renegotiation altogether. |
| 1132 | * (Most secure option, interoperability issues) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1133 | * |
| 1134 | * \param ssl SSL context |
Paul Bakker | 6831c4a | 2012-11-07 19:46:27 +0000 | [diff] [blame] | 1135 | * \param allow_legacy Prevent or allow (SSL_NO_LEGACY_RENEGOTIATION, |
| 1136 | * SSL_ALLOW_LEGACY_RENEGOTIATION or |
| 1137 | * SSL_LEGACY_BREAK_HANDSHAKE) |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1138 | */ |
| 1139 | void ssl_legacy_renegotiation( ssl_context *ssl, int allow_legacy ); |
| 1140 | |
| 1141 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1142 | * \brief Return the number of data bytes available to read |
| 1143 | * |
| 1144 | * \param ssl SSL context |
| 1145 | * |
| 1146 | * \return how many bytes are available in the read buffer |
| 1147 | */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 1148 | size_t ssl_get_bytes_avail( const ssl_context *ssl ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1149 | |
| 1150 | /** |
| 1151 | * \brief Return the result of the certificate verification |
| 1152 | * |
| 1153 | * \param ssl SSL context |
| 1154 | * |
| 1155 | * \return 0 if successful, or a combination of: |
| 1156 | * BADCERT_EXPIRED |
| 1157 | * BADCERT_REVOKED |
| 1158 | * BADCERT_CN_MISMATCH |
| 1159 | * BADCERT_NOT_TRUSTED |
| 1160 | */ |
Paul Bakker | ff60ee6 | 2010-03-16 21:09:09 +0000 | [diff] [blame] | 1161 | int ssl_get_verify_result( const ssl_context *ssl ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1162 | |
| 1163 | /** |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1164 | * \brief Return the name of the current ciphersuite |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1165 | * |
| 1166 | * \param ssl SSL context |
| 1167 | * |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1168 | * \return a string containing the ciphersuite name |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1169 | */ |
Paul Bakker | e3166ce | 2011-01-27 17:40:50 +0000 | [diff] [blame] | 1170 | const char *ssl_get_ciphersuite( const ssl_context *ssl ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1171 | |
| 1172 | /** |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 1173 | * \brief Return the current SSL version (SSLv3/TLSv1/etc) |
| 1174 | * |
| 1175 | * \param ssl SSL context |
| 1176 | * |
| 1177 | * \return a string containing the SSL version |
| 1178 | */ |
| 1179 | const char *ssl_get_version( const ssl_context *ssl ); |
| 1180 | |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 1181 | #if defined(POLARSSL_X509_PARSE_C) |
Paul Bakker | 43ca69c | 2011-01-15 17:35:19 +0000 | [diff] [blame] | 1182 | /** |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 1183 | * \brief Return the peer certificate from the current connection |
| 1184 | * |
| 1185 | * Note: Can be NULL in case no certificate was sent during |
| 1186 | * the handshake. Different calls for the same connection can |
| 1187 | * return the same or different pointers for the same |
| 1188 | * certificate and even a different certificate altogether. |
| 1189 | * The peer cert CAN change in a single connection if |
| 1190 | * renegotiation is performed. |
| 1191 | * |
| 1192 | * \param ssl SSL context |
| 1193 | * |
| 1194 | * \return the current peer certificate |
| 1195 | */ |
| 1196 | const x509_cert *ssl_get_peer_cert( const ssl_context *ssl ); |
Paul Bakker | ed27a04 | 2013-04-18 22:46:23 +0200 | [diff] [blame] | 1197 | #endif /* POLARSSL_X509_PARSE_C */ |
Paul Bakker | b0550d9 | 2012-10-30 07:51:03 +0000 | [diff] [blame] | 1198 | |
| 1199 | /** |
Manuel Pégourié-Gonnard | 7471803 | 2013-07-30 12:41:56 +0200 | [diff] [blame] | 1200 | * \brief Save session in order to resume it later (client-side only) |
| 1201 | * Session data is copied to presented session structure. |
| 1202 | * |
| 1203 | * \warning Currently, peer certificate is lost in the operation. |
| 1204 | * |
| 1205 | * \param ssl SSL context |
| 1206 | * \param session session context |
| 1207 | * |
| 1208 | * \return 0 if successful, |
| 1209 | * POLARSSL_ERR_SSL_MALLOC_FAILED if memory allocation failed, |
| 1210 | * POLARSSL_ERR_SSL_BAD_INPUT_DATA if used server-side or |
| 1211 | * arguments are otherwise invalid |
| 1212 | * |
| 1213 | * \sa ssl_set_session() |
| 1214 | */ |
| 1215 | int ssl_get_session( const ssl_context *ssl, ssl_session *session ); |
| 1216 | |
| 1217 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1218 | * \brief Perform the SSL handshake |
| 1219 | * |
| 1220 | * \param ssl SSL context |
| 1221 | * |
Paul Bakker | 831a755 | 2011-05-18 13:32:51 +0000 | [diff] [blame] | 1222 | * \return 0 if successful, POLARSSL_ERR_NET_WANT_READ, |
| 1223 | * POLARSSL_ERR_NET_WANT_WRITE, or a specific SSL error code. |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1224 | */ |
| 1225 | int ssl_handshake( ssl_context *ssl ); |
| 1226 | |
| 1227 | /** |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 1228 | * \brief Perform a single step of the SSL handshake |
| 1229 | * |
| 1230 | * Note: the state of the context (ssl->state) will be at |
| 1231 | * the following state after execution of this function. |
| 1232 | * Do not call this function if state is SSL_HANDSHAKE_OVER. |
| 1233 | * |
| 1234 | * \param ssl SSL context |
| 1235 | * |
| 1236 | * \return 0 if successful, POLARSSL_ERR_NET_WANT_READ, |
| 1237 | * POLARSSL_ERR_NET_WANT_WRITE, or a specific SSL error code. |
| 1238 | */ |
| 1239 | int ssl_handshake_step( ssl_context *ssl ); |
| 1240 | |
| 1241 | /** |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1242 | * \brief Perform an SSL renegotiation on the running connection |
| 1243 | * |
| 1244 | * \param ssl SSL context |
| 1245 | * |
| 1246 | * \return 0 if succesful, or any ssl_handshake() return value. |
| 1247 | */ |
| 1248 | int ssl_renegotiate( ssl_context *ssl ); |
| 1249 | |
| 1250 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1251 | * \brief Read at most 'len' application data bytes |
| 1252 | * |
| 1253 | * \param ssl SSL context |
| 1254 | * \param buf buffer that will hold the data |
| 1255 | * \param len how many bytes must be read |
| 1256 | * |
Paul Bakker | 831a755 | 2011-05-18 13:32:51 +0000 | [diff] [blame] | 1257 | * \return This function returns the number of bytes read, 0 for EOF, |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1258 | * or a negative error code. |
| 1259 | */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 1260 | int ssl_read( ssl_context *ssl, unsigned char *buf, size_t len ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1261 | |
| 1262 | /** |
| 1263 | * \brief Write exactly 'len' application data bytes |
| 1264 | * |
| 1265 | * \param ssl SSL context |
| 1266 | * \param buf buffer holding the data |
| 1267 | * \param len how many bytes must be written |
| 1268 | * |
| 1269 | * \return This function returns the number of bytes written, |
| 1270 | * or a negative error code. |
| 1271 | * |
Paul Bakker | 831a755 | 2011-05-18 13:32:51 +0000 | [diff] [blame] | 1272 | * \note When this function returns POLARSSL_ERR_NET_WANT_WRITE, |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1273 | * it must be called later with the *same* arguments, |
| 1274 | * until it returns a positive value. |
| 1275 | */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 1276 | int ssl_write( ssl_context *ssl, const unsigned char *buf, size_t len ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1277 | |
| 1278 | /** |
Paul Bakker | 0a92518 | 2012-04-16 06:46:41 +0000 | [diff] [blame] | 1279 | * \brief Send an alert message |
| 1280 | * |
| 1281 | * \param ssl SSL context |
| 1282 | * \param level The alert level of the message |
| 1283 | * (SSL_ALERT_LEVEL_WARNING or SSL_ALERT_LEVEL_FATAL) |
| 1284 | * \param message The alert message (SSL_ALERT_MSG_*) |
| 1285 | * |
Paul Bakker | 6831c4a | 2012-11-07 19:46:27 +0000 | [diff] [blame] | 1286 | * \return 0 if successful, or a specific SSL error code. |
Paul Bakker | 0a92518 | 2012-04-16 06:46:41 +0000 | [diff] [blame] | 1287 | */ |
| 1288 | int ssl_send_alert_message( ssl_context *ssl, |
| 1289 | unsigned char level, |
| 1290 | unsigned char message ); |
| 1291 | /** |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1292 | * \brief Notify the peer that the connection is being closed |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 1293 | * |
| 1294 | * \param ssl SSL context |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1295 | */ |
| 1296 | int ssl_close_notify( ssl_context *ssl ); |
| 1297 | |
| 1298 | /** |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1299 | * \brief Free referenced items in an SSL context and clear memory |
Paul Bakker | 13e2dfe | 2009-07-28 07:18:38 +0000 | [diff] [blame] | 1300 | * |
| 1301 | * \param ssl SSL context |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1302 | */ |
| 1303 | void ssl_free( ssl_context *ssl ); |
| 1304 | |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1305 | /** |
Paul Bakker | 0a59707 | 2012-09-25 21:55:46 +0000 | [diff] [blame] | 1306 | * \brief Free referenced items in an SSL session including the |
| 1307 | * peer certificate and clear memory |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1308 | * |
| 1309 | * \param session SSL session |
| 1310 | */ |
| 1311 | void ssl_session_free( ssl_session *session ); |
| 1312 | |
| 1313 | /** |
| 1314 | * \brief Free referenced items in an SSL transform context and clear |
| 1315 | * memory |
| 1316 | * |
| 1317 | * \param transform SSL transform context |
| 1318 | */ |
| 1319 | void ssl_transform_free( ssl_transform *transform ); |
| 1320 | |
| 1321 | /** |
| 1322 | * \brief Free referenced items in an SSL handshake context and clear |
| 1323 | * memory |
| 1324 | * |
| 1325 | * \param handshake SSL handshake context |
| 1326 | */ |
| 1327 | void ssl_handshake_free( ssl_handshake_params *handshake ); |
| 1328 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1329 | /* |
| 1330 | * Internal functions (do not call directly) |
| 1331 | */ |
Paul Bakker | 1961b70 | 2013-01-25 14:49:24 +0100 | [diff] [blame] | 1332 | int ssl_handshake_client_step( ssl_context *ssl ); |
| 1333 | int ssl_handshake_server_step( ssl_context *ssl ); |
Paul Bakker | 48916f9 | 2012-09-16 19:57:18 +0000 | [diff] [blame] | 1334 | void ssl_handshake_wrapup( ssl_context *ssl ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1335 | |
Paul Bakker | d0f6fa7 | 2012-09-17 09:18:12 +0000 | [diff] [blame] | 1336 | int ssl_send_fatal_handshake_failure( ssl_context *ssl ); |
| 1337 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1338 | int ssl_derive_keys( ssl_context *ssl ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1339 | |
| 1340 | int ssl_read_record( ssl_context *ssl ); |
Paul Bakker | 831a755 | 2011-05-18 13:32:51 +0000 | [diff] [blame] | 1341 | /** |
| 1342 | * \return 0 if successful, POLARSSL_ERR_SSL_CONN_EOF on EOF or |
| 1343 | * another negative error code. |
| 1344 | */ |
Paul Bakker | 23986e5 | 2011-04-24 08:57:21 +0000 | [diff] [blame] | 1345 | int ssl_fetch_input( ssl_context *ssl, size_t nb_want ); |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1346 | |
| 1347 | int ssl_write_record( ssl_context *ssl ); |
| 1348 | int ssl_flush_output( ssl_context *ssl ); |
| 1349 | |
| 1350 | int ssl_parse_certificate( ssl_context *ssl ); |
| 1351 | int ssl_write_certificate( ssl_context *ssl ); |
| 1352 | |
| 1353 | int ssl_parse_change_cipher_spec( ssl_context *ssl ); |
| 1354 | int ssl_write_change_cipher_spec( ssl_context *ssl ); |
| 1355 | |
| 1356 | int ssl_parse_finished( ssl_context *ssl ); |
| 1357 | int ssl_write_finished( ssl_context *ssl ); |
| 1358 | |
Paul Bakker | 41c83d3 | 2013-03-20 14:39:14 +0100 | [diff] [blame] | 1359 | void ssl_optimize_checksum( ssl_context *ssl, const ssl_ciphersuite_t *ciphersuite_info ); |
Paul Bakker | 380da53 | 2012-04-18 16:10:25 +0000 | [diff] [blame] | 1360 | |
Paul Bakker | 5121ce5 | 2009-01-03 21:22:43 +0000 | [diff] [blame] | 1361 | #ifdef __cplusplus |
| 1362 | } |
| 1363 | #endif |
| 1364 | |
| 1365 | #endif /* ssl.h */ |