You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

673 regels
27 KiB

  1. /* ssl/ssl3.h */
  2. /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
  3. * All rights reserved.
  4. *
  5. * This package is an SSL implementation written
  6. * by Eric Young (eay@cryptsoft.com).
  7. * The implementation was written so as to conform with Netscapes SSL.
  8. *
  9. * This library is free for commercial and non-commercial use as long as
  10. * the following conditions are aheared to. The following conditions
  11. * apply to all code found in this distribution, be it the RC4, RSA,
  12. * lhash, DES, etc., code; not just the SSL code. The SSL documentation
  13. * included with this distribution is covered by the same copyright terms
  14. * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15. *
  16. * Copyright remains Eric Young's, and as such any Copyright notices in
  17. * the code are not to be removed.
  18. * If this package is used in a product, Eric Young should be given attribution
  19. * as the author of the parts of the library used.
  20. * This can be in the form of a textual message at program startup or
  21. * in documentation (online or textual) provided with the package.
  22. *
  23. * Redistribution and use in source and binary forms, with or without
  24. * modification, are permitted provided that the following conditions
  25. * are met:
  26. * 1. Redistributions of source code must retain the copyright
  27. * notice, this list of conditions and the following disclaimer.
  28. * 2. Redistributions in binary form must reproduce the above copyright
  29. * notice, this list of conditions and the following disclaimer in the
  30. * documentation and/or other materials provided with the distribution.
  31. * 3. All advertising materials mentioning features or use of this software
  32. * must display the following acknowledgement:
  33. * "This product includes cryptographic software written by
  34. * Eric Young (eay@cryptsoft.com)"
  35. * The word 'cryptographic' can be left out if the rouines from the library
  36. * being used are not cryptographic related :-).
  37. * 4. If you include any Windows specific code (or a derivative thereof) from
  38. * the apps directory (application code) you must include an acknowledgement:
  39. * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40. *
  41. * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42. * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44. * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51. * SUCH DAMAGE.
  52. *
  53. * The licence and distribution terms for any publically available version or
  54. * derivative of this code cannot be changed. i.e. this code cannot simply be
  55. * copied and put under another distribution licence
  56. * [including the GNU Public Licence.]
  57. */
  58. /* ====================================================================
  59. * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved.
  60. *
  61. * Redistribution and use in source and binary forms, with or without
  62. * modification, are permitted provided that the following conditions
  63. * are met:
  64. *
  65. * 1. Redistributions of source code must retain the above copyright
  66. * notice, this list of conditions and the following disclaimer.
  67. *
  68. * 2. Redistributions in binary form must reproduce the above copyright
  69. * notice, this list of conditions and the following disclaimer in
  70. * the documentation and/or other materials provided with the
  71. * distribution.
  72. *
  73. * 3. All advertising materials mentioning features or use of this
  74. * software must display the following acknowledgment:
  75. * "This product includes software developed by the OpenSSL Project
  76. * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77. *
  78. * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79. * endorse or promote products derived from this software without
  80. * prior written permission. For written permission, please contact
  81. * openssl-core@openssl.org.
  82. *
  83. * 5. Products derived from this software may not be called "OpenSSL"
  84. * nor may "OpenSSL" appear in their names without prior written
  85. * permission of the OpenSSL Project.
  86. *
  87. * 6. Redistributions of any form whatsoever must retain the following
  88. * acknowledgment:
  89. * "This product includes software developed by the OpenSSL Project
  90. * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91. *
  92. * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93. * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95. * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96. * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97. * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98. * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  100. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  101. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  102. * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  103. * OF THE POSSIBILITY OF SUCH DAMAGE.
  104. * ====================================================================
  105. *
  106. * This product includes cryptographic software written by Eric Young
  107. * (eay@cryptsoft.com). This product includes software written by Tim
  108. * Hudson (tjh@cryptsoft.com).
  109. *
  110. */
  111. /* ====================================================================
  112. * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
  113. * ECC cipher suite support in OpenSSL originally developed by
  114. * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
  115. */
  116. #ifndef HEADER_SSL3_H
  117. #define HEADER_SSL3_H
  118. #include <openssl/aead.h>
  119. #include <openssl/buf.h>
  120. #include <openssl/evp.h>
  121. #include <openssl/ssl.h>
  122. #include <openssl/type_check.h>
  123. #ifdef __cplusplus
  124. extern "C" {
  125. #endif
  126. /* Signalling cipher suite value: from RFC5746 */
  127. #define SSL3_CK_SCSV 0x030000FF
  128. /* Fallback signalling cipher suite value: not IANA assigned.
  129. * See https://tools.ietf.org/html/draft-bmoeller-tls-downgrade-scsv-01 */
  130. #define SSL3_CK_FALLBACK_SCSV 0x03005600
  131. #define SSL3_CK_RSA_NULL_MD5 0x03000001
  132. #define SSL3_CK_RSA_NULL_SHA 0x03000002
  133. #define SSL3_CK_RSA_RC4_40_MD5 0x03000003
  134. #define SSL3_CK_RSA_RC4_128_MD5 0x03000004
  135. #define SSL3_CK_RSA_RC4_128_SHA 0x03000005
  136. #define SSL3_CK_RSA_RC2_40_MD5 0x03000006
  137. #define SSL3_CK_RSA_IDEA_128_SHA 0x03000007
  138. #define SSL3_CK_RSA_DES_40_CBC_SHA 0x03000008
  139. #define SSL3_CK_RSA_DES_64_CBC_SHA 0x03000009
  140. #define SSL3_CK_RSA_DES_192_CBC3_SHA 0x0300000A
  141. #define SSL3_CK_DH_DSS_DES_40_CBC_SHA 0x0300000B
  142. #define SSL3_CK_DH_DSS_DES_64_CBC_SHA 0x0300000C
  143. #define SSL3_CK_DH_DSS_DES_192_CBC3_SHA 0x0300000D
  144. #define SSL3_CK_DH_RSA_DES_40_CBC_SHA 0x0300000E
  145. #define SSL3_CK_DH_RSA_DES_64_CBC_SHA 0x0300000F
  146. #define SSL3_CK_DH_RSA_DES_192_CBC3_SHA 0x03000010
  147. #define SSL3_CK_EDH_DSS_DES_40_CBC_SHA 0x03000011
  148. #define SSL3_CK_EDH_DSS_DES_64_CBC_SHA 0x03000012
  149. #define SSL3_CK_EDH_DSS_DES_192_CBC3_SHA 0x03000013
  150. #define SSL3_CK_EDH_RSA_DES_40_CBC_SHA 0x03000014
  151. #define SSL3_CK_EDH_RSA_DES_64_CBC_SHA 0x03000015
  152. #define SSL3_CK_EDH_RSA_DES_192_CBC3_SHA 0x03000016
  153. #define SSL3_CK_ADH_RC4_40_MD5 0x03000017
  154. #define SSL3_CK_ADH_RC4_128_MD5 0x03000018
  155. #define SSL3_CK_ADH_DES_40_CBC_SHA 0x03000019
  156. #define SSL3_CK_ADH_DES_64_CBC_SHA 0x0300001A
  157. #define SSL3_CK_ADH_DES_192_CBC_SHA 0x0300001B
  158. #define SSL3_TXT_RSA_NULL_MD5 "NULL-MD5"
  159. #define SSL3_TXT_RSA_NULL_SHA "NULL-SHA"
  160. #define SSL3_TXT_RSA_RC4_40_MD5 "EXP-RC4-MD5"
  161. #define SSL3_TXT_RSA_RC4_128_MD5 "RC4-MD5"
  162. #define SSL3_TXT_RSA_RC4_128_SHA "RC4-SHA"
  163. #define SSL3_TXT_RSA_RC2_40_MD5 "EXP-RC2-CBC-MD5"
  164. #define SSL3_TXT_RSA_IDEA_128_SHA "IDEA-CBC-SHA"
  165. #define SSL3_TXT_RSA_DES_40_CBC_SHA "EXP-DES-CBC-SHA"
  166. #define SSL3_TXT_RSA_DES_64_CBC_SHA "DES-CBC-SHA"
  167. #define SSL3_TXT_RSA_DES_192_CBC3_SHA "DES-CBC3-SHA"
  168. #define SSL3_TXT_DH_DSS_DES_40_CBC_SHA "EXP-DH-DSS-DES-CBC-SHA"
  169. #define SSL3_TXT_DH_DSS_DES_64_CBC_SHA "DH-DSS-DES-CBC-SHA"
  170. #define SSL3_TXT_DH_DSS_DES_192_CBC3_SHA "DH-DSS-DES-CBC3-SHA"
  171. #define SSL3_TXT_DH_RSA_DES_40_CBC_SHA "EXP-DH-RSA-DES-CBC-SHA"
  172. #define SSL3_TXT_DH_RSA_DES_64_CBC_SHA "DH-RSA-DES-CBC-SHA"
  173. #define SSL3_TXT_DH_RSA_DES_192_CBC3_SHA "DH-RSA-DES-CBC3-SHA"
  174. #define SSL3_TXT_EDH_DSS_DES_40_CBC_SHA "EXP-EDH-DSS-DES-CBC-SHA"
  175. #define SSL3_TXT_EDH_DSS_DES_64_CBC_SHA "EDH-DSS-DES-CBC-SHA"
  176. #define SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA "EDH-DSS-DES-CBC3-SHA"
  177. #define SSL3_TXT_EDH_RSA_DES_40_CBC_SHA "EXP-EDH-RSA-DES-CBC-SHA"
  178. #define SSL3_TXT_EDH_RSA_DES_64_CBC_SHA "EDH-RSA-DES-CBC-SHA"
  179. #define SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA "EDH-RSA-DES-CBC3-SHA"
  180. #define SSL3_TXT_ADH_RC4_40_MD5 "EXP-ADH-RC4-MD5"
  181. #define SSL3_TXT_ADH_RC4_128_MD5 "ADH-RC4-MD5"
  182. #define SSL3_TXT_ADH_DES_40_CBC_SHA "EXP-ADH-DES-CBC-SHA"
  183. #define SSL3_TXT_ADH_DES_64_CBC_SHA "ADH-DES-CBC-SHA"
  184. #define SSL3_TXT_ADH_DES_192_CBC_SHA "ADH-DES-CBC3-SHA"
  185. #define SSL3_SSL_SESSION_ID_LENGTH 32
  186. #define SSL3_MAX_SSL_SESSION_ID_LENGTH 32
  187. #define SSL3_MASTER_SECRET_SIZE 48
  188. #define SSL3_RANDOM_SIZE 32
  189. #define SSL3_SESSION_ID_SIZE 32
  190. #define SSL3_RT_HEADER_LENGTH 5
  191. #define SSL3_HM_HEADER_LENGTH 4
  192. #ifndef SSL3_ALIGN_PAYLOAD
  193. /* Some will argue that this increases memory footprint, but it's not actually
  194. * true. Point is that malloc has to return at least 64-bit aligned pointers,
  195. * meaning that allocating 5 bytes wastes 3 bytes in either case. Suggested
  196. * pre-gaping simply moves these wasted bytes from the end of allocated region
  197. * to its front, but makes data payload aligned, which improves performance. */
  198. #define SSL3_ALIGN_PAYLOAD 8
  199. #else
  200. #if (SSL3_ALIGN_PAYLOAD & (SSL3_ALIGN_PAYLOAD - 1)) != 0
  201. #error "insane SSL3_ALIGN_PAYLOAD"
  202. #undef SSL3_ALIGN_PAYLOAD
  203. #endif
  204. #endif
  205. /* This is the maximum MAC (digest) size used by the SSL library. Currently
  206. * maximum of 20 is used by SHA1, but we reserve for future extension for
  207. * 512-bit hashes. */
  208. #define SSL3_RT_MAX_MD_SIZE 64
  209. /* Maximum block size used in all ciphersuites. Currently 16 for AES. */
  210. #define SSL_RT_MAX_CIPHER_BLOCK_SIZE 16
  211. #define SSL3_RT_MAX_EXTRA (16384)
  212. /* Maximum plaintext length: defined by SSL/TLS standards */
  213. #define SSL3_RT_MAX_PLAIN_LENGTH 16384
  214. /* Maximum compression overhead: defined by SSL/TLS standards */
  215. #define SSL3_RT_MAX_COMPRESSED_OVERHEAD 1024
  216. /* The standards give a maximum encryption overhead of 1024 bytes. In practice
  217. * the value is lower than this. The overhead is the maximum number of padding
  218. * bytes (256) plus the mac size.
  219. *
  220. * TODO(davidben): This derivation doesn't take AEADs into account, or TLS 1.1
  221. * explicit nonces. It happens to work because |SSL3_RT_MAX_MD_SIZE| is larger
  222. * than necessary and no true AEAD has variable overhead in TLS 1.2. */
  223. #define SSL3_RT_MAX_ENCRYPTED_OVERHEAD (256 + SSL3_RT_MAX_MD_SIZE)
  224. /* SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD is the maximum overhead in encrypting a
  225. * record. This does not include the record header. Some ciphers use explicit
  226. * nonces, so it includes both the AEAD overhead as well as the nonce. */
  227. #define SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD \
  228. (EVP_AEAD_MAX_OVERHEAD + EVP_AEAD_MAX_NONCE_LENGTH)
  229. OPENSSL_COMPILE_ASSERT(
  230. SSL3_RT_MAX_ENCRYPTED_OVERHEAD >= SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD,
  231. max_overheads_are_consistent);
  232. /* SSL3_RT_MAX_COMPRESSED_LENGTH is an alias for
  233. * |SSL3_RT_MAX_PLAIN_LENGTH|. Compression is gone, so don't include the
  234. * compression overhead. */
  235. #define SSL3_RT_MAX_COMPRESSED_LENGTH SSL3_RT_MAX_PLAIN_LENGTH
  236. #define SSL3_RT_MAX_ENCRYPTED_LENGTH \
  237. (SSL3_RT_MAX_ENCRYPTED_OVERHEAD + SSL3_RT_MAX_COMPRESSED_LENGTH)
  238. #define SSL3_RT_MAX_PACKET_SIZE \
  239. (SSL3_RT_MAX_ENCRYPTED_LENGTH + SSL3_RT_HEADER_LENGTH)
  240. #define SSL3_MD_CLIENT_FINISHED_CONST "\x43\x4C\x4E\x54"
  241. #define SSL3_MD_SERVER_FINISHED_CONST "\x53\x52\x56\x52"
  242. #define SSL3_VERSION 0x0300
  243. #define SSL3_VERSION_MAJOR 0x03
  244. #define SSL3_VERSION_MINOR 0x00
  245. #define SSL3_RT_CHANGE_CIPHER_SPEC 20
  246. #define SSL3_RT_ALERT 21
  247. #define SSL3_RT_HANDSHAKE 22
  248. #define SSL3_RT_APPLICATION_DATA 23
  249. /* Pseudo content types to indicate additional parameters */
  250. #define TLS1_RT_CRYPTO 0x1000
  251. #define TLS1_RT_CRYPTO_PREMASTER (TLS1_RT_CRYPTO | 0x1)
  252. #define TLS1_RT_CRYPTO_CLIENT_RANDOM (TLS1_RT_CRYPTO | 0x2)
  253. #define TLS1_RT_CRYPTO_SERVER_RANDOM (TLS1_RT_CRYPTO | 0x3)
  254. #define TLS1_RT_CRYPTO_MASTER (TLS1_RT_CRYPTO | 0x4)
  255. #define TLS1_RT_CRYPTO_READ 0x0000
  256. #define TLS1_RT_CRYPTO_WRITE 0x0100
  257. #define TLS1_RT_CRYPTO_MAC (TLS1_RT_CRYPTO | 0x5)
  258. #define TLS1_RT_CRYPTO_KEY (TLS1_RT_CRYPTO | 0x6)
  259. #define TLS1_RT_CRYPTO_IV (TLS1_RT_CRYPTO | 0x7)
  260. #define TLS1_RT_CRYPTO_FIXED_IV (TLS1_RT_CRYPTO | 0x8)
  261. /* Pseudo content type for SSL/TLS header info */
  262. #define SSL3_RT_HEADER 0x100
  263. #define SSL3_AL_WARNING 1
  264. #define SSL3_AL_FATAL 2
  265. #define SSL3_AD_CLOSE_NOTIFY 0
  266. #define SSL3_AD_UNEXPECTED_MESSAGE 10 /* fatal */
  267. #define SSL3_AD_BAD_RECORD_MAC 20 /* fatal */
  268. #define SSL3_AD_DECOMPRESSION_FAILURE 30 /* fatal */
  269. #define SSL3_AD_HANDSHAKE_FAILURE 40 /* fatal */
  270. #define SSL3_AD_NO_CERTIFICATE 41
  271. #define SSL3_AD_BAD_CERTIFICATE 42
  272. #define SSL3_AD_UNSUPPORTED_CERTIFICATE 43
  273. #define SSL3_AD_CERTIFICATE_REVOKED 44
  274. #define SSL3_AD_CERTIFICATE_EXPIRED 45
  275. #define SSL3_AD_CERTIFICATE_UNKNOWN 46
  276. #define SSL3_AD_ILLEGAL_PARAMETER 47 /* fatal */
  277. #define SSL3_AD_INAPPROPRIATE_FALLBACK 86 /* fatal */
  278. typedef struct ssl3_record_st {
  279. /*r */ int type; /* type of record */
  280. /*rw*/ unsigned int length; /* How many bytes available */
  281. /*r */ unsigned int off; /* read/write offset into 'buf' */
  282. /*rw*/ uint8_t *data; /* pointer to the record data */
  283. /*rw*/ uint8_t *input; /* where the decode bytes are */
  284. /*r */ unsigned long epoch; /* epoch number, needed by DTLS1 */
  285. /*r */ uint8_t seq_num[8]; /* sequence number, needed by DTLS1 */
  286. } SSL3_RECORD;
  287. typedef struct ssl3_buffer_st {
  288. uint8_t *buf; /* at least SSL3_RT_MAX_PACKET_SIZE bytes, see
  289. ssl3_setup_buffers() */
  290. size_t len; /* buffer size */
  291. int offset; /* where to 'copy from' */
  292. int left; /* how many bytes left */
  293. } SSL3_BUFFER;
  294. #define SSL3_CT_RSA_SIGN 1
  295. #define SSL3_CT_DSS_SIGN 2
  296. #define SSL3_CT_RSA_FIXED_DH 3
  297. #define SSL3_CT_DSS_FIXED_DH 4
  298. #define SSL3_CT_RSA_EPHEMERAL_DH 5
  299. #define SSL3_CT_DSS_EPHEMERAL_DH 6
  300. #define SSL3_CT_FORTEZZA_DMS 20
  301. /* TODO(davidben): This flag can probably be merged into s3->change_cipher_spec
  302. * to something tri-state. (Normal / Expect CCS / Between CCS and Finished). */
  303. #define SSL3_FLAGS_EXPECT_CCS 0x0080
  304. typedef struct ssl3_state_st {
  305. long flags;
  306. uint8_t read_sequence[8];
  307. int read_mac_secret_size;
  308. uint8_t read_mac_secret[EVP_MAX_MD_SIZE];
  309. uint8_t write_sequence[8];
  310. int write_mac_secret_size;
  311. uint8_t write_mac_secret[EVP_MAX_MD_SIZE];
  312. uint8_t server_random[SSL3_RANDOM_SIZE];
  313. uint8_t client_random[SSL3_RANDOM_SIZE];
  314. /* flags for countermeasure against known-IV weakness */
  315. int need_record_splitting;
  316. /* The value of 'extra' when the buffers were initialized */
  317. int init_extra;
  318. /* have_version is true if the connection's final version is known. Otherwise
  319. * the version has not been negotiated yet. */
  320. char have_version;
  321. /* sniff_buffer is used by the server in the initial handshake to read a
  322. * V2ClientHello before the record layer is initialized. */
  323. BUF_MEM *sniff_buffer;
  324. size_t sniff_buffer_len;
  325. SSL3_BUFFER rbuf; /* read IO goes into here */
  326. SSL3_BUFFER wbuf; /* write IO goes into here */
  327. SSL3_RECORD rrec; /* each decoded record goes in here */
  328. SSL3_RECORD wrec; /* goes out from here */
  329. /* storage for Handshake protocol data received but not yet processed by
  330. * ssl3_read_bytes: */
  331. uint8_t handshake_fragment[4];
  332. unsigned int handshake_fragment_len;
  333. /* partial write - check the numbers match */
  334. unsigned int wnum; /* number of bytes sent so far */
  335. int wpend_tot; /* number bytes written */
  336. int wpend_type;
  337. int wpend_ret; /* number of bytes submitted */
  338. const uint8_t *wpend_buf;
  339. /* used during startup, digest all incoming/outgoing packets */
  340. BIO *handshake_buffer;
  341. /* When set of handshake digests is determined, buffer is hashed and freed
  342. * and MD_CTX-es for all required digests are stored in this array */
  343. EVP_MD_CTX **handshake_dgst;
  344. /* this is set whenerver we see a change_cipher_spec message come in when we
  345. * are not looking for one */
  346. int change_cipher_spec;
  347. int warn_alert;
  348. int fatal_alert;
  349. /* we allow one fatal and one warning alert to be outstanding, send close
  350. * alert via the warning alert */
  351. int alert_dispatch;
  352. uint8_t send_alert[2];
  353. /* This flag is set when we should renegotiate ASAP, basically when there is
  354. * no more data in the read or write buffers */
  355. int renegotiate;
  356. int total_renegotiations;
  357. int num_renegotiations;
  358. /* State pertaining to the pending handshake.
  359. *
  360. * TODO(davidben): State is current spread all over the place. Move
  361. * pending handshake state here so it can be managed separately from
  362. * established connection state in case of renegotiations. */
  363. struct {
  364. /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
  365. uint8_t finish_md[EVP_MAX_MD_SIZE * 2];
  366. int finish_md_len;
  367. uint8_t peer_finish_md[EVP_MAX_MD_SIZE * 2];
  368. int peer_finish_md_len;
  369. unsigned long message_size;
  370. int message_type;
  371. /* used to hold the new cipher we are going to use */
  372. const SSL_CIPHER *new_cipher;
  373. DH *dh;
  374. EC_KEY *ecdh; /* holds short lived ECDH key */
  375. /* used when SSL_ST_FLUSH_DATA is entered */
  376. int next_state;
  377. int reuse_message;
  378. /* Client-only: cert_req determines if a client certificate is to be sent.
  379. * This is 0 if no client Certificate message is to be sent, 1 if there is
  380. * a client certificate, and 2 to send an empty client Certificate
  381. * message. */
  382. int cert_req;
  383. /* Client-only: ca_names contains the list of CAs received in a
  384. * CertificateRequest message. */
  385. STACK_OF(X509_NAME) *ca_names;
  386. /* Client-only: certificate_types contains the set of certificate types
  387. * received in a CertificateRequest message. */
  388. uint8_t *certificate_types;
  389. size_t num_certificate_types;
  390. int key_block_length;
  391. uint8_t *key_block;
  392. const EVP_AEAD *new_aead;
  393. uint8_t new_mac_secret_len;
  394. uint8_t new_fixed_iv_len;
  395. uint8_t new_variable_iv_len;
  396. /* Server-only: cert_request is true if a client certificate was
  397. * requested. */
  398. int cert_request;
  399. /* certificate_status_expected is true if OCSP stapling was negotiated and
  400. * the server is expected to send a CertificateStatus message. */
  401. char certificate_status_expected;
  402. /* peer_ecpointformatlist contains the EC point formats advertised by the
  403. * peer. */
  404. uint8_t *peer_ecpointformatlist;
  405. size_t peer_ecpointformatlist_length;
  406. /* Server-only: peer_ellipticcurvelist contains the EC curve IDs advertised
  407. * by the peer. This is only set on the server's end. The server does not
  408. * advertise this extension to the client. */
  409. uint16_t *peer_ellipticcurvelist;
  410. size_t peer_ellipticcurvelist_length;
  411. /* extended_master_secret indicates whether the extended master secret
  412. * computation is used in this handshake. Note that this is different from
  413. * whether it was used for the current session. If this is a resumption
  414. * handshake then EMS might be negotiated in the client and server hello
  415. * messages, but it doesn't matter if the session that's being resumed
  416. * didn't use it to create the master secret initially. */
  417. char extended_master_secret;
  418. /* Client-only: peer_psk_identity_hint is the psk_identity_hint sent by the
  419. * server when using a PSK key exchange. */
  420. char *peer_psk_identity_hint;
  421. /* new_mac_secret_size is unused and exists only until wpa_supplicant can
  422. * be updated. It is only needed for EAP-FAST, which we don't support. */
  423. uint8_t new_mac_secret_size;
  424. /* Client-only: in_false_start is one if there is a pending handshake in
  425. * False Start. The client may write data at this point. */
  426. char in_false_start;
  427. } tmp;
  428. /* Connection binding to prevent renegotiation attacks */
  429. uint8_t previous_client_finished[EVP_MAX_MD_SIZE];
  430. uint8_t previous_client_finished_len;
  431. uint8_t previous_server_finished[EVP_MAX_MD_SIZE];
  432. uint8_t previous_server_finished_len;
  433. int send_connection_binding; /* TODOEKR */
  434. /* Set if we saw the Next Protocol Negotiation extension from our peer. */
  435. int next_proto_neg_seen;
  436. /* ALPN information
  437. * (we are in the process of transitioning from NPN to ALPN.) */
  438. /* In a server these point to the selected ALPN protocol after the
  439. * ClientHello has been processed. In a client these contain the protocol
  440. * that the server selected once the ServerHello has been processed. */
  441. uint8_t *alpn_selected;
  442. size_t alpn_selected_len;
  443. /* In a client, this means that the server supported Channel ID and that a
  444. * Channel ID was sent. In a server it means that we echoed support for
  445. * Channel IDs and that tlsext_channel_id will be valid after the
  446. * handshake. */
  447. char tlsext_channel_id_valid;
  448. /* tlsext_channel_id_new means that the updated Channel ID extension was
  449. * negotiated. This is a temporary hack in the code to support both forms of
  450. * Channel ID extension while we transition to the new format, which fixed a
  451. * security issue. */
  452. char tlsext_channel_id_new;
  453. /* For a server:
  454. * If |tlsext_channel_id_valid| is true, then this contains the
  455. * verified Channel ID from the client: a P256 point, (x,y), where
  456. * each are big-endian values. */
  457. uint8_t tlsext_channel_id[64];
  458. } SSL3_STATE;
  459. /* SSLv3 */
  460. /* client */
  461. /* extra state */
  462. #define SSL3_ST_CW_FLUSH (0x100 | SSL_ST_CONNECT)
  463. #define SSL3_ST_FALSE_START (0x101 | SSL_ST_CONNECT)
  464. /* write to server */
  465. #define SSL3_ST_CW_CLNT_HELLO_A (0x110 | SSL_ST_CONNECT)
  466. #define SSL3_ST_CW_CLNT_HELLO_B (0x111 | SSL_ST_CONNECT)
  467. /* read from server */
  468. #define SSL3_ST_CR_SRVR_HELLO_A (0x120 | SSL_ST_CONNECT)
  469. #define SSL3_ST_CR_SRVR_HELLO_B (0x121 | SSL_ST_CONNECT)
  470. #define DTLS1_ST_CR_HELLO_VERIFY_REQUEST_A (0x126 | SSL_ST_CONNECT)
  471. #define DTLS1_ST_CR_HELLO_VERIFY_REQUEST_B (0x127 | SSL_ST_CONNECT)
  472. #define SSL3_ST_CR_CERT_A (0x130 | SSL_ST_CONNECT)
  473. #define SSL3_ST_CR_CERT_B (0x131 | SSL_ST_CONNECT)
  474. #define SSL3_ST_CR_KEY_EXCH_A (0x140 | SSL_ST_CONNECT)
  475. #define SSL3_ST_CR_KEY_EXCH_B (0x141 | SSL_ST_CONNECT)
  476. #define SSL3_ST_CR_CERT_REQ_A (0x150 | SSL_ST_CONNECT)
  477. #define SSL3_ST_CR_CERT_REQ_B (0x151 | SSL_ST_CONNECT)
  478. #define SSL3_ST_CR_SRVR_DONE_A (0x160 | SSL_ST_CONNECT)
  479. #define SSL3_ST_CR_SRVR_DONE_B (0x161 | SSL_ST_CONNECT)
  480. /* write to server */
  481. #define SSL3_ST_CW_CERT_A (0x170 | SSL_ST_CONNECT)
  482. #define SSL3_ST_CW_CERT_B (0x171 | SSL_ST_CONNECT)
  483. #define SSL3_ST_CW_CERT_C (0x172 | SSL_ST_CONNECT)
  484. #define SSL3_ST_CW_CERT_D (0x173 | SSL_ST_CONNECT)
  485. #define SSL3_ST_CW_KEY_EXCH_A (0x180 | SSL_ST_CONNECT)
  486. #define SSL3_ST_CW_KEY_EXCH_B (0x181 | SSL_ST_CONNECT)
  487. #define SSL3_ST_CW_CERT_VRFY_A (0x190 | SSL_ST_CONNECT)
  488. #define SSL3_ST_CW_CERT_VRFY_B (0x191 | SSL_ST_CONNECT)
  489. #define SSL3_ST_CW_CHANGE_A (0x1A0 | SSL_ST_CONNECT)
  490. #define SSL3_ST_CW_CHANGE_B (0x1A1 | SSL_ST_CONNECT)
  491. #define SSL3_ST_CW_NEXT_PROTO_A (0x200 | SSL_ST_CONNECT)
  492. #define SSL3_ST_CW_NEXT_PROTO_B (0x201 | SSL_ST_CONNECT)
  493. #define SSL3_ST_CW_CHANNEL_ID_A (0x220 | SSL_ST_CONNECT)
  494. #define SSL3_ST_CW_CHANNEL_ID_B (0x221 | SSL_ST_CONNECT)
  495. #define SSL3_ST_CW_FINISHED_A (0x1B0 | SSL_ST_CONNECT)
  496. #define SSL3_ST_CW_FINISHED_B (0x1B1 | SSL_ST_CONNECT)
  497. /* read from server */
  498. #define SSL3_ST_CR_CHANGE (0x1C0 | SSL_ST_CONNECT)
  499. #define SSL3_ST_CR_FINISHED_A (0x1D0 | SSL_ST_CONNECT)
  500. #define SSL3_ST_CR_FINISHED_B (0x1D1 | SSL_ST_CONNECT)
  501. #define SSL3_ST_CR_SESSION_TICKET_A (0x1E0 | SSL_ST_CONNECT)
  502. #define SSL3_ST_CR_SESSION_TICKET_B (0x1E1 | SSL_ST_CONNECT)
  503. #define SSL3_ST_CR_CERT_STATUS_A (0x1F0 | SSL_ST_CONNECT)
  504. #define SSL3_ST_CR_CERT_STATUS_B (0x1F1 | SSL_ST_CONNECT)
  505. /* server */
  506. /* extra state */
  507. #define SSL3_ST_SW_FLUSH (0x100 | SSL_ST_ACCEPT)
  508. /* read from client */
  509. #define SSL3_ST_SR_INITIAL_BYTES (0x240 | SSL_ST_ACCEPT)
  510. #define SSL3_ST_SR_V2_CLIENT_HELLO (0x241 | SSL_ST_ACCEPT)
  511. /* Do not change the number values, they do matter */
  512. #define SSL3_ST_SR_CLNT_HELLO_A (0x110 | SSL_ST_ACCEPT)
  513. #define SSL3_ST_SR_CLNT_HELLO_B (0x111 | SSL_ST_ACCEPT)
  514. #define SSL3_ST_SR_CLNT_HELLO_C (0x112 | SSL_ST_ACCEPT)
  515. #define SSL3_ST_SR_CLNT_HELLO_D (0x115 | SSL_ST_ACCEPT)
  516. /* write to client */
  517. #define SSL3_ST_SW_HELLO_REQ_A (0x120 | SSL_ST_ACCEPT)
  518. #define SSL3_ST_SW_HELLO_REQ_B (0x121 | SSL_ST_ACCEPT)
  519. #define SSL3_ST_SW_HELLO_REQ_C (0x122 | SSL_ST_ACCEPT)
  520. #define SSL3_ST_SW_SRVR_HELLO_A (0x130 | SSL_ST_ACCEPT)
  521. #define SSL3_ST_SW_SRVR_HELLO_B (0x131 | SSL_ST_ACCEPT)
  522. #define SSL3_ST_SW_CERT_A (0x140 | SSL_ST_ACCEPT)
  523. #define SSL3_ST_SW_CERT_B (0x141 | SSL_ST_ACCEPT)
  524. #define SSL3_ST_SW_KEY_EXCH_A (0x150 | SSL_ST_ACCEPT)
  525. #define SSL3_ST_SW_KEY_EXCH_B (0x151 | SSL_ST_ACCEPT)
  526. #define SSL3_ST_SW_CERT_REQ_A (0x160 | SSL_ST_ACCEPT)
  527. #define SSL3_ST_SW_CERT_REQ_B (0x161 | SSL_ST_ACCEPT)
  528. #define SSL3_ST_SW_SRVR_DONE_A (0x170 | SSL_ST_ACCEPT)
  529. #define SSL3_ST_SW_SRVR_DONE_B (0x171 | SSL_ST_ACCEPT)
  530. /* read from client */
  531. #define SSL3_ST_SR_CERT_A (0x180 | SSL_ST_ACCEPT)
  532. #define SSL3_ST_SR_CERT_B (0x181 | SSL_ST_ACCEPT)
  533. #define SSL3_ST_SR_KEY_EXCH_A (0x190 | SSL_ST_ACCEPT)
  534. #define SSL3_ST_SR_KEY_EXCH_B (0x191 | SSL_ST_ACCEPT)
  535. #define SSL3_ST_SR_CERT_VRFY_A (0x1A0 | SSL_ST_ACCEPT)
  536. #define SSL3_ST_SR_CERT_VRFY_B (0x1A1 | SSL_ST_ACCEPT)
  537. #define SSL3_ST_SR_CHANGE (0x1B0 | SSL_ST_ACCEPT)
  538. #define SSL3_ST_SR_NEXT_PROTO_A (0x210 | SSL_ST_ACCEPT)
  539. #define SSL3_ST_SR_NEXT_PROTO_B (0x211 | SSL_ST_ACCEPT)
  540. #define SSL3_ST_SR_CHANNEL_ID_A (0x230 | SSL_ST_ACCEPT)
  541. #define SSL3_ST_SR_CHANNEL_ID_B (0x231 | SSL_ST_ACCEPT)
  542. #define SSL3_ST_SR_FINISHED_A (0x1C0 | SSL_ST_ACCEPT)
  543. #define SSL3_ST_SR_FINISHED_B (0x1C1 | SSL_ST_ACCEPT)
  544. /* write to client */
  545. #define SSL3_ST_SW_CHANGE_A (0x1D0 | SSL_ST_ACCEPT)
  546. #define SSL3_ST_SW_CHANGE_B (0x1D1 | SSL_ST_ACCEPT)
  547. #define SSL3_ST_SW_FINISHED_A (0x1E0 | SSL_ST_ACCEPT)
  548. #define SSL3_ST_SW_FINISHED_B (0x1E1 | SSL_ST_ACCEPT)
  549. #define SSL3_ST_SW_SESSION_TICKET_A (0x1F0 | SSL_ST_ACCEPT)
  550. #define SSL3_ST_SW_SESSION_TICKET_B (0x1F1 | SSL_ST_ACCEPT)
  551. #define SSL3_ST_SW_CERT_STATUS_A (0x200 | SSL_ST_ACCEPT)
  552. #define SSL3_ST_SW_CERT_STATUS_B (0x201 | SSL_ST_ACCEPT)
  553. #define SSL3_ST_SW_SUPPLEMENTAL_DATA_A (0x220 | SSL_ST_ACCEPT)
  554. #define SSL3_ST_SW_SUPPLEMENTAL_DATA_B (0x221 | SSL_ST_ACCEPT)
  555. #define SSL3_MT_HELLO_REQUEST 0
  556. #define SSL3_MT_CLIENT_HELLO 1
  557. #define SSL3_MT_SERVER_HELLO 2
  558. #define SSL3_MT_NEWSESSION_TICKET 4
  559. #define SSL3_MT_CERTIFICATE 11
  560. #define SSL3_MT_SERVER_KEY_EXCHANGE 12
  561. #define SSL3_MT_CERTIFICATE_REQUEST 13
  562. #define SSL3_MT_SERVER_DONE 14
  563. #define SSL3_MT_CERTIFICATE_VERIFY 15
  564. #define SSL3_MT_CLIENT_KEY_EXCHANGE 16
  565. #define SSL3_MT_FINISHED 20
  566. #define SSL3_MT_CERTIFICATE_STATUS 22
  567. #define SSL3_MT_SUPPLEMENTAL_DATA 23
  568. #define SSL3_MT_NEXT_PROTO 67
  569. #define SSL3_MT_ENCRYPTED_EXTENSIONS 203
  570. #define DTLS1_MT_HELLO_VERIFY_REQUEST 3
  571. #define SSL3_MT_CCS 1
  572. /* These are used when changing over to a new cipher */
  573. #define SSL3_CC_READ 0x01
  574. #define SSL3_CC_WRITE 0x02
  575. #define SSL3_CC_CLIENT 0x10
  576. #define SSL3_CC_SERVER 0x20
  577. #define SSL3_CHANGE_CIPHER_CLIENT_WRITE (SSL3_CC_CLIENT | SSL3_CC_WRITE)
  578. #define SSL3_CHANGE_CIPHER_SERVER_READ (SSL3_CC_SERVER | SSL3_CC_READ)
  579. #define SSL3_CHANGE_CIPHER_CLIENT_READ (SSL3_CC_CLIENT | SSL3_CC_READ)
  580. #define SSL3_CHANGE_CIPHER_SERVER_WRITE (SSL3_CC_SERVER | SSL3_CC_WRITE)
  581. #ifdef __cplusplus
  582. }
  583. #endif
  584. #endif