Nie możesz wybrać więcej, niż 25 tematów Tematy muszą się zaczynać od litery lub cyfry, mogą zawierać myślniki ('-') i mogą mieć do 35 znaków.
 
 
 
 
 
 

3068 wiersze
136 KiB

  1. /* ssl/ssl.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-2007 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. /* ====================================================================
  117. * Copyright 2005 Nokia. All rights reserved.
  118. *
  119. * The portions of the attached software ("Contribution") is developed by
  120. * Nokia Corporation and is licensed pursuant to the OpenSSL open source
  121. * license.
  122. *
  123. * The Contribution, originally written by Mika Kousa and Pasi Eronen of
  124. * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
  125. * support (see RFC 4279) to OpenSSL.
  126. *
  127. * No patent licenses or other rights except those expressly stated in
  128. * the OpenSSL open source license shall be deemed granted or received
  129. * expressly, by implication, estoppel, or otherwise.
  130. *
  131. * No assurances are provided by Nokia that the Contribution does not
  132. * infringe the patent or other intellectual property rights of any third
  133. * party or that the license provides you with all the necessary rights
  134. * to make use of the Contribution.
  135. *
  136. * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
  137. * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
  138. * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
  139. * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
  140. * OTHERWISE.
  141. */
  142. #ifndef OPENSSL_HEADER_SSL_H
  143. #define OPENSSL_HEADER_SSL_H
  144. #include <openssl/base.h>
  145. #include <openssl/bio.h>
  146. #include <openssl/buf.h>
  147. #include <openssl/hmac.h>
  148. #include <openssl/lhash.h>
  149. #include <openssl/pem.h>
  150. #include <openssl/thread.h>
  151. #include <openssl/x509.h>
  152. #if !defined(OPENSSL_WINDOWS)
  153. #include <sys/time.h>
  154. #endif
  155. /* wpa_supplicant expects to get the version functions from ssl.h */
  156. #include <openssl/crypto.h>
  157. /* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
  158. * Windows headers define too many macros to be included in public headers.
  159. * However, only a forward declaration is needed. */
  160. struct timeval;
  161. #if defined(__cplusplus)
  162. extern "C" {
  163. #endif
  164. /* SSL implementation. */
  165. /* Initialization. */
  166. /* SSL_library_init initializes the crypto and SSL libraries and returns one. */
  167. OPENSSL_EXPORT int SSL_library_init(void);
  168. /* Cipher suites. */
  169. /* An SSL_CIPHER represents a cipher suite. */
  170. typedef struct ssl_cipher_st {
  171. /* name is the OpenSSL name for the cipher. */
  172. const char *name;
  173. /* id is the cipher suite value bitwise OR-d with 0x03000000. */
  174. uint32_t id;
  175. /* The following are internal fields. See ssl/internal.h for their values. */
  176. uint32_t algorithm_mkey;
  177. uint32_t algorithm_auth;
  178. uint32_t algorithm_enc;
  179. uint32_t algorithm_mac;
  180. uint32_t algorithm_ssl;
  181. uint32_t algo_strength;
  182. /* algorithm2 contains extra flags. See ssl/internal.h. */
  183. uint32_t algorithm2;
  184. /* strength_bits is the strength of the cipher in bits. */
  185. int strength_bits;
  186. /* alg_bits is the number of bits of key material used by the algorithm. */
  187. int alg_bits;
  188. } SSL_CIPHER;
  189. DECLARE_STACK_OF(SSL_CIPHER)
  190. /* SSL_get_cipher_by_value returns the structure representing a TLS cipher
  191. * suite based on its assigned number, or NULL if unknown. See
  192. * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
  193. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
  194. /* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
  195. * get the cipher suite value. */
  196. OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
  197. /* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
  198. * mode). */
  199. OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
  200. /* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
  201. OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
  202. /* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
  203. OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
  204. /* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
  205. * CHACHA20_POLY1305. */
  206. OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
  207. /* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
  208. OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
  209. /* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
  210. * method used by |cipher|. For example, "ECDHE_ECDSA". */
  211. OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
  212. /* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
  213. * name for |cipher| or NULL on error. For example,
  214. * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
  215. * calling |OPENSSL_free| on the result. */
  216. OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
  217. /* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
  218. * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
  219. * symmetric algorithm to |*out_alg_bits|. */
  220. OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
  221. int *out_alg_bits);
  222. /* SSL contexts. */
  223. /* An SSL_METHOD selects whether to use TLS or DTLS. */
  224. typedef struct ssl_method_st SSL_METHOD;
  225. /* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
  226. OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
  227. /* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
  228. OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
  229. /* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
  230. * on error. An |SSL_CTX| manages shared state and configuration between
  231. * multiple TLS or DTLS connections. */
  232. OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
  233. /* SSL_CTX_free releases memory associated with |ctx|. */
  234. OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
  235. /* SSL connections. */
  236. /* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
  237. * |SSL| object represents a single TLS or DTLS connection. It inherits settings
  238. * from |ctx| at the time of creation. Settings may also be individually
  239. * configured on the connection.
  240. *
  241. * On creation, an |SSL| is not configured to be either a client or server. Call
  242. * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
  243. OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
  244. /* SSL_free releases memory associated with |ssl|. */
  245. OPENSSL_EXPORT void SSL_free(SSL *ssl);
  246. /* SSL_set_connect_state configures |ssl| to be a client. */
  247. OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
  248. /* SSL_set_accept_state configures |ssl| to be a server. */
  249. OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
  250. /* Protocol versions. */
  251. #define SSL3_VERSION_MAJOR 0x03
  252. #define SSL3_VERSION 0x0300
  253. #define TLS1_VERSION 0x0301
  254. #define TLS1_1_VERSION 0x0302
  255. #define TLS1_2_VERSION 0x0303
  256. #define DTLS1_VERSION 0xfeff
  257. #define DTLS1_2_VERSION 0xfefd
  258. /* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
  259. * |version|. */
  260. OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
  261. /* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
  262. * |version|. */
  263. OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
  264. /* SSL_set_min_version sets the minimum protocol version for |ssl| to
  265. * |version|. */
  266. OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
  267. /* SSL_set_max_version sets the maximum protocol version for |ssl| to
  268. * |version|. */
  269. OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
  270. /* Options.
  271. *
  272. * Options configure protocol behavior. */
  273. /* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
  274. * support the renegotiation_info extension (RFC 5746). It is on by default. */
  275. #define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
  276. /* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
  277. * bytes above the maximum record size. */
  278. #define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
  279. /* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
  280. * (i.e. without a length prefix). */
  281. #define SSL_OP_TLS_D5_BUG 0x00000100L
  282. /* SSL_OP_ALL enables the above bug workarounds that are enabled by many
  283. * consumers.
  284. * TODO(davidben): Determine which of the remaining may be removed now. */
  285. #define SSL_OP_ALL 0x00000BFFL
  286. /* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
  287. * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
  288. #define SSL_OP_NO_QUERY_MTU 0x00001000L
  289. /* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
  290. #define SSL_OP_NO_TICKET 0x00004000L
  291. /* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
  292. * ECDHE curves according to the server's preferences instead of the
  293. * client's. */
  294. #define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
  295. /* The following flags toggle individual protocol versions. This is deprecated.
  296. * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
  297. #define SSL_OP_NO_SSLv3 0x02000000L
  298. #define SSL_OP_NO_TLSv1 0x04000000L
  299. #define SSL_OP_NO_TLSv1_2 0x08000000L
  300. #define SSL_OP_NO_TLSv1_1 0x10000000L
  301. #define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
  302. #define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
  303. /* The following flags do nothing and are included only to make it easier to
  304. * compile code with BoringSSL. */
  305. #define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
  306. #define SSL_OP_MICROSOFT_SESS_ID_BUG 0
  307. #define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
  308. #define SSL_OP_NO_COMPRESSION 0
  309. #define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
  310. #define SSL_OP_NO_SSLv2 0
  311. #define SSL_OP_SINGLE_DH_USE 0
  312. #define SSL_OP_SINGLE_ECDH_USE 0
  313. #define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
  314. #define SSL_OP_TLS_BLOCK_PADDING_BUG 0
  315. #define SSL_OP_TLS_ROLLBACK_BUG 0
  316. #define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
  317. /* SSL_CTX_set_options enables all options set in |options| (which should be one
  318. * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
  319. * bitmask representing the resulting enabled options. */
  320. OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
  321. /* SSL_CTX_clear_options disables all options set in |options| (which should be
  322. * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
  323. * bitmask representing the resulting enabled options. */
  324. OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
  325. /* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
  326. * the options enabled for |ctx|. */
  327. OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
  328. /* SSL_set_options enables all options set in |options| (which should be one or
  329. * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
  330. * representing the resulting enabled options. */
  331. OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
  332. /* SSL_clear_options disables all options set in |options| (which should be one
  333. * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
  334. * bitmask representing the resulting enabled options. */
  335. OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
  336. /* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
  337. * options enabled for |ssl|. */
  338. OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
  339. /* Modes.
  340. *
  341. * Modes configure API behavior. */
  342. /* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
  343. * result when the only part of the input was written in a single record. */
  344. #define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
  345. /* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
  346. * with a different buffer. However, |SSL_write| still assumes the buffer
  347. * contents are unchanged. This is not the default to avoid the misconception
  348. * that non-blocking |SSL_write| behaves like non-blocking |write|. */
  349. #define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
  350. /* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
  351. * before sending certificates to the peer.
  352. * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
  353. #define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
  354. /* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
  355. * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
  356. * in one RTT. See draft-bmoeller-tls-falsestart-01. */
  357. #define SSL_MODE_ENABLE_FALSE_START 0x00000080L
  358. /* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
  359. * SSL_MODE_ENABLE_FALSE_START. */
  360. #define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
  361. /* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
  362. * TLS 1.0 to be split in two: the first record will contain a single byte and
  363. * the second will contain the remainder. This effectively randomises the IV and
  364. * prevents BEAST attacks. */
  365. #define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
  366. /* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
  367. * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
  368. * session resumption is used for a given SSL*. */
  369. #define SSL_MODE_NO_SESSION_CREATION 0x00000200L
  370. /* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
  371. * To be set only by applications that reconnect with a downgraded protocol
  372. * version; see https://tools.ietf.org/html/draft-ietf-tls-downgrade-scsv-05
  373. * for details.
  374. *
  375. * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
  376. * this in explicit fallback retries, following the guidance in
  377. * draft-ietf-tls-downgrade-scsv-05. */
  378. #define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
  379. /* The following flags do nothing and are included only to make it easier to
  380. * compile code with BoringSSL. */
  381. #define SSL_MODE_AUTO_RETRY 0
  382. #define SSL_MODE_RELEASE_BUFFERS 0
  383. #define SSL_MODE_SEND_CLIENTHELLO_TIME 0
  384. #define SSL_MODE_SEND_SERVERHELLO_TIME 0
  385. /* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
  386. * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
  387. * representing the resulting enabled modes. */
  388. OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
  389. /* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
  390. * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
  391. * bitmask representing the resulting enabled modes. */
  392. OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
  393. /* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
  394. * the modes enabled for |ssl|. */
  395. OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
  396. /* SSL_set_mode enables all modes set in |mode| (which should be one or more of
  397. * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
  398. * representing the resulting enabled modes. */
  399. OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
  400. /* SSL_clear_mode disables all modes set in |mode| (which should be one or more
  401. * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
  402. * representing the resulting enabled modes. */
  403. OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
  404. /* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
  405. * modes enabled for |ssl|. */
  406. OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
  407. /* Configuring certificates and private keys.
  408. *
  409. * These functions configure the connection's leaf certificate, private key, and
  410. * certificate chain. The certificate chain is ordered leaf to root (as sent on
  411. * the wire) but does not include the leaf. Both client and server certificates
  412. * use these functions.
  413. *
  414. * Certificates and keys may be configured before the handshake or dynamically
  415. * in the early callback and certificate callback. */
  416. /* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
  417. * one on success and zero on failure. */
  418. OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
  419. /* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
  420. * on success and zero on failure. */
  421. OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
  422. /* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
  423. * success and zero on failure. */
  424. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
  425. /* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
  426. * success and zero on failure. */
  427. OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
  428. /* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
  429. * |chain|. On success, it returns one and takes ownership of |chain|.
  430. * Otherwise, it returns zero. */
  431. OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
  432. /* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
  433. * |chain|. It returns one on success and zero on failure. The caller retains
  434. * ownership of |chain| and may release it freely. */
  435. OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
  436. /* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
  437. * |chain|. On success, it returns one and takes ownership of |chain|.
  438. * Otherwise, it returns zero. */
  439. OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
  440. /* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
  441. * |chain|. It returns one on success and zero on failure. The caller retains
  442. * ownership of |chain| and may release it freely. */
  443. OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
  444. /* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
  445. * success, it returns one and takes ownership of |x509|. Otherwise, it returns
  446. * zero. */
  447. OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
  448. /* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
  449. * returns one on success and zero on failure. The caller retains ownership of
  450. * |x509| and may release it freely. */
  451. OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
  452. /* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
  453. * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
  454. OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
  455. /* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
  456. OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
  457. /* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
  458. * one on success and zero on failure. The caller retains ownership of |x509|
  459. * and may release it freely. */
  460. OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
  461. /* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
  462. * one. */
  463. OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
  464. /* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
  465. OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
  466. /* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
  467. OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
  468. /* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
  469. * The callback returns one on success, zero on internal error, and a negative
  470. * number on failure or to pause the handshake. If the handshake is paused,
  471. * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
  472. OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
  473. int (*cb)(SSL *ssl, void *arg),
  474. void *arg);
  475. /* SSL_set_cert_cb sets a callback that is called to select a certificate. The
  476. * callback returns one on success, zero on internal error, and a negative
  477. * number on failure or to pause the handshake. If the handshake is paused,
  478. * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
  479. OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
  480. void *arg);
  481. /* SSL_certs_clear resets the private key, leaf certificate, and certificate
  482. * chain of |ssl|. */
  483. OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
  484. /* SSL_CTX_check_private_key returns one if the certificate and private key
  485. * configured in |ctx| are consistent and zero otherwise. */
  486. OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
  487. /* SSL_check_private_key returns one if the certificate and private key
  488. * configured in |ssl| are consistent and zero otherwise. */
  489. OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
  490. /* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
  491. OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
  492. /* SSL_get_certificate returns |ssl|'s leaf certificate. */
  493. OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
  494. /* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
  495. OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
  496. /* SSL_get_privatekey returns |ssl|'s private key. */
  497. OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
  498. /* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
  499. * returns one. */
  500. OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
  501. STACK_OF(X509) **out_chain);
  502. /* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
  503. OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
  504. STACK_OF(X509) **out_chain);
  505. /* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
  506. * returns one. */
  507. OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
  508. STACK_OF(X509) **out_chain);
  509. /* Certificate and private key convenience functions. */
  510. /* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
  511. * on success and zero on failure. */
  512. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
  513. /* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
  514. * success and zero on failure. */
  515. OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
  516. /* The following functions configure certificates or private keys but take as
  517. * input DER-encoded structures. They return one on success and zero on
  518. * failure. */
  519. OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
  520. const uint8_t *d);
  521. OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
  522. int len);
  523. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
  524. const uint8_t *d, long len);
  525. OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
  526. const uint8_t *d, long len);
  527. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
  528. const uint8_t *der,
  529. size_t der_len);
  530. OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
  531. size_t der_len);
  532. /* The following functions configure certificates or private keys but take as
  533. * input files to read from. They return one on success and zero on failure. The
  534. * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
  535. * the file's contents are read as PEM or DER. */
  536. #define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
  537. #define SSL_FILETYPE_PEM X509_FILETYPE_PEM
  538. OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
  539. const char *file,
  540. int type);
  541. OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
  542. int type);
  543. OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
  544. int type);
  545. OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
  546. int type);
  547. OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
  548. int type);
  549. OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
  550. int type);
  551. /* SSL_CTX_use_certificate_file configures certificates for |ctx|. It reads the
  552. * contents of |file| as a PEM-encoded leaf certificate followed optionally by
  553. * the certificate chain to send to the peer. It returns one on success and zero
  554. * on failure. */
  555. OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
  556. const char *file);
  557. /* Custom private keys. */
  558. enum ssl_private_key_result_t {
  559. ssl_private_key_success,
  560. ssl_private_key_retry,
  561. ssl_private_key_failure,
  562. };
  563. /* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
  564. * signing operations to a custom, potentially asynchronous, backend. */
  565. typedef struct ssl_private_key_method_st {
  566. /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
  567. * key used by |ssl|. */
  568. int (*type)(SSL *ssl);
  569. /* supports_digest returns one if the key used by |ssl| supports signing
  570. * digests of type |md| and zero otherwise. */
  571. int (*supports_digest)(SSL *ssl, const EVP_MD *md);
  572. /* max_signature_len returns the maximum length of a signature signed by the
  573. * key used by |ssl|. This must be a constant value for a given |ssl|. */
  574. size_t (*max_signature_len)(SSL *ssl);
  575. /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
  576. * used to calculate |in|. On success, it returns |ssl_private_key_success|
  577. * and writes at most |max_out| bytes of signature data to |out|. On failure,
  578. * it returns |ssl_private_key_failure|. If the operation has not completed,
  579. * it returns |ssl_private_key_retry|. |sign| should arrange for the
  580. * high-level operation on |ssl| to be retried when the operation is
  581. * completed. This will result in a call to |sign_complete|.
  582. *
  583. * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
  584. * the digest itself, so the DigestInfo prefix, if any, must be prepended by
  585. * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
  586. *
  587. * It is an error to call |sign| while another private key operation is in
  588. * progress on |ssl|. */
  589. enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
  590. size_t max_out, const EVP_MD *md,
  591. const uint8_t *in, size_t in_len);
  592. /* sign_complete completes a pending |sign| operation. If the operation has
  593. * completed, it returns |ssl_private_key_success| and writes the result to
  594. * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
  595. * failure and |ssl_private_key_retry| if the operation is still in progress.
  596. *
  597. * |sign_complete| may be called arbitrarily many times before completion, but
  598. * it is an error to call |sign_complete| if there is no pending |sign|
  599. * operation in progress on |ssl|. */
  600. enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
  601. size_t *out_len, size_t max_out);
  602. } SSL_PRIVATE_KEY_METHOD;
  603. /* SSL_use_private_key_method configures a custom private key on |ssl|.
  604. * |key_method| must remain valid for the lifetime of |ssl|. */
  605. OPENSSL_EXPORT void SSL_set_private_key_method(
  606. SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
  607. /* Connection information. */
  608. /* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
  609. * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
  610. * returns one on success or zero on error. In general |max_out| should be at
  611. * least 12.
  612. *
  613. * This function will always fail if the initial handshake has not completed.
  614. * The tls-unique value will change after a renegotiation but, since
  615. * renegotiations can be initiated by the server at any point, the higher-level
  616. * protocol must either leave them disabled or define states in which the
  617. * tls-unique value can be read.
  618. *
  619. * The tls-unique value is defined by
  620. * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
  621. * TLS protocol, tls-unique is broken for resumed connections unless the
  622. * Extended Master Secret extension is negotiated. Thus this function will
  623. * return zero if |ssl| performed session resumption unless EMS was used when
  624. * negotiating the original session. */
  625. OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
  626. size_t *out_len, size_t max_out);
  627. /* Custom extensions.
  628. *
  629. * The custom extension functions allow TLS extensions to be added to
  630. * ClientHello and ServerHello messages. */
  631. /* SSL_custom_ext_add_cb is a callback function that is called when the
  632. * ClientHello (for clients) or ServerHello (for servers) is constructed. In
  633. * the case of a server, this callback will only be called for a given
  634. * extension if the ClientHello contained that extension – it's not possible to
  635. * inject extensions into a ServerHello that the client didn't request.
  636. *
  637. * When called, |extension_value| will contain the extension number that is
  638. * being considered for addition (so that a single callback can handle multiple
  639. * extensions). If the callback wishes to include the extension, it must set
  640. * |*out| to point to |*out_len| bytes of extension contents and return one. In
  641. * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
  642. * called with the value of |*out| once that data has been copied.
  643. *
  644. * If the callback does not wish to add an extension it must return zero.
  645. *
  646. * Alternatively, the callback can abort the connection by setting
  647. * |*out_alert_value| to a TLS alert number and returning -1. */
  648. typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
  649. const uint8_t **out, size_t *out_len,
  650. int *out_alert_value, void *add_arg);
  651. /* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
  652. * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
  653. * this callback is called and passed the |out| pointer that was returned by
  654. * the add callback. This is to free any dynamically allocated data created by
  655. * the add callback. */
  656. typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
  657. const uint8_t *out, void *add_arg);
  658. /* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
  659. * parse an extension from the peer: that is from the ServerHello for a client
  660. * and from the ClientHello for a server.
  661. *
  662. * When called, |extension_value| will contain the extension number and the
  663. * contents of the extension are |contents_len| bytes at |contents|.
  664. *
  665. * The callback must return one to continue the handshake. Otherwise, if it
  666. * returns zero, a fatal alert with value |*out_alert_value| is sent and the
  667. * handshake is aborted. */
  668. typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
  669. const uint8_t *contents,
  670. size_t contents_len,
  671. int *out_alert_value, void *parse_arg);
  672. /* SSL_extension_supported returns one iff OpenSSL internally handles
  673. * extensions of type |extension_value|. This can be used to avoid registering
  674. * custom extension handlers for extensions that a future version of OpenSSL
  675. * may handle internally. */
  676. OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
  677. /* SSL_CTX_add_client_custom_ext registers callback functions for handling
  678. * custom TLS extensions for client connections.
  679. *
  680. * If |add_cb| is NULL then an empty extension will be added in each
  681. * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
  682. * this callback.
  683. *
  684. * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
  685. * needs to be freed.
  686. *
  687. * It returns one on success or zero on error. It's always an error to register
  688. * callbacks for the same extension twice, or to register callbacks for an
  689. * extension that OpenSSL handles internally. See |SSL_extension_supported| to
  690. * discover, at runtime, which extensions OpenSSL handles internally. */
  691. OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
  692. SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
  693. SSL_custom_ext_free_cb free_cb, void *add_arg,
  694. SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
  695. /* SSL_CTX_add_server_custom_ext is the same as
  696. * |SSL_CTX_add_client_custom_ext|, but for server connections.
  697. *
  698. * Unlike on the client side, if |add_cb| is NULL no extension will be added.
  699. * The |add_cb|, if any, will only be called if the ClientHello contained a
  700. * matching extension. */
  701. OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
  702. SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
  703. SSL_custom_ext_free_cb free_cb, void *add_arg,
  704. SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
  705. /* Session tickets. */
  706. /* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
  707. * |len| bytes of |out|. It returns one on success and zero if |len| is not
  708. * 48. If |out| is NULL, it returns 48 instead. */
  709. OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
  710. size_t len);
  711. /* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
  712. * |len| bytes of |in|. It returns one on success and zero if |len| is not
  713. * 48. If |in| is NULL, it returns 48 instead. */
  714. OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
  715. size_t len);
  716. /* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
  717. * ticket. */
  718. #define SSL_TICKET_KEY_NAME_LEN 16
  719. /* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
  720. * returns one. |callback| will be called when encrypting a new ticket and when
  721. * decrypting a ticket from the client.
  722. *
  723. * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
  724. * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
  725. * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
  726. * for encryption or decryption, based on the mode.
  727. *
  728. * When encrypting a new ticket, |encrypt| will be one. It writes a public
  729. * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
  730. * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
  731. * |callback| returns 1 on success and -1 on error.
  732. *
  733. * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
  734. * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
  735. * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
  736. * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
  737. * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
  738. * This may be used to re-key the ticket.
  739. *
  740. * WARNING: |callback| wildly breaks the usual return value convention and is
  741. * called in two different modes. */
  742. OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
  743. SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
  744. EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
  745. int encrypt));
  746. /* Underdocumented functions.
  747. *
  748. * Functions below here haven't been touched up and may be underdocumented. */
  749. /* SSLeay version number for ASN.1 encoding of the session information */
  750. /* Version 0 - initial version
  751. * Version 1 - added the optional peer certificate. */
  752. #define SSL_SESSION_ASN1_VERSION 0x0001
  753. #define SSL_MAX_SSL_SESSION_ID_LENGTH 32
  754. #define SSL_MAX_SID_CTX_LENGTH 32
  755. #define SSL_MAX_MASTER_KEY_LENGTH 48
  756. /* These are used to specify which ciphers to use and not to use */
  757. #define SSL_TXT_MEDIUM "MEDIUM"
  758. #define SSL_TXT_HIGH "HIGH"
  759. #define SSL_TXT_FIPS "FIPS"
  760. #define SSL_TXT_kRSA "kRSA"
  761. #define SSL_TXT_kDHE "kDHE"
  762. #define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
  763. #define SSL_TXT_kECDHE "kECDHE"
  764. #define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
  765. #define SSL_TXT_kPSK "kPSK"
  766. #define SSL_TXT_aRSA "aRSA"
  767. #define SSL_TXT_aECDSA "aECDSA"
  768. #define SSL_TXT_aPSK "aPSK"
  769. #define SSL_TXT_DH "DH"
  770. #define SSL_TXT_DHE "DHE" /* same as "kDHE" */
  771. #define SSL_TXT_EDH "EDH" /* same as "DHE" */
  772. #define SSL_TXT_RSA "RSA"
  773. #define SSL_TXT_ECDH "ECDH"
  774. #define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
  775. #define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
  776. #define SSL_TXT_ECDSA "ECDSA"
  777. #define SSL_TXT_PSK "PSK"
  778. #define SSL_TXT_3DES "3DES"
  779. #define SSL_TXT_RC4 "RC4"
  780. #define SSL_TXT_AES128 "AES128"
  781. #define SSL_TXT_AES256 "AES256"
  782. #define SSL_TXT_AES "AES"
  783. #define SSL_TXT_AES_GCM "AESGCM"
  784. #define SSL_TXT_CHACHA20 "CHACHA20"
  785. #define SSL_TXT_MD5 "MD5"
  786. #define SSL_TXT_SHA1 "SHA1"
  787. #define SSL_TXT_SHA "SHA" /* same as "SHA1" */
  788. #define SSL_TXT_SHA256 "SHA256"
  789. #define SSL_TXT_SHA384 "SHA384"
  790. #define SSL_TXT_SSLV3 "SSLv3"
  791. #define SSL_TXT_TLSV1 "TLSv1"
  792. #define SSL_TXT_TLSV1_1 "TLSv1.1"
  793. #define SSL_TXT_TLSV1_2 "TLSv1.2"
  794. #define SSL_TXT_ALL "ALL"
  795. /* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
  796. * normally not being used.
  797. *
  798. * Example: "RC4" will activate all ciphers using RC4 including ciphers without
  799. * authentication, which would normally disabled by DEFAULT (due the "!ADH"
  800. * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
  801. * that it is also disabled in the specific selection. COMPLEMENTOF*
  802. * identifiers are portable between version, as adjustments to the default
  803. * cipher setup will also be included here.
  804. *
  805. * COMPLEMENTOFDEFAULT does not experience the same special treatment that
  806. * DEFAULT gets, as only selection is being done and no sorting as needed for
  807. * DEFAULT. */
  808. #define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
  809. /* The following cipher list is used by default. It also is substituted when an
  810. * application-defined cipher list string starts with 'DEFAULT'. */
  811. #define SSL_DEFAULT_CIPHER_LIST "ALL"
  812. /* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
  813. * starts with a reasonable order, and all we have to do for DEFAULT is
  814. * throwing out anonymous and unencrypted ciphersuites! (The latter are not
  815. * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
  816. /* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
  817. #define SSL_SENT_SHUTDOWN 1
  818. #define SSL_RECEIVED_SHUTDOWN 2
  819. typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
  820. typedef struct ssl_session_st SSL_SESSION;
  821. typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
  822. typedef struct ssl3_enc_method SSL3_ENC_METHOD;
  823. /* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
  824. typedef struct srtp_protection_profile_st {
  825. const char *name;
  826. unsigned long id;
  827. } SRTP_PROTECTION_PROFILE;
  828. DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
  829. /* An SSL_SESSION represents an SSL session that may be resumed in an
  830. * abbreviated handshake. */
  831. struct ssl_session_st {
  832. int ssl_version; /* what ssl version session info is being kept in here? */
  833. int master_key_length;
  834. uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
  835. /* session_id - valid? */
  836. unsigned int session_id_length;
  837. uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
  838. /* this is used to determine whether the session is being reused in
  839. * the appropriate context. It is up to the application to set this,
  840. * via SSL_new */
  841. unsigned int sid_ctx_length;
  842. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  843. char *psk_identity;
  844. /* Used to indicate that session resumption is not allowed. Applications can
  845. * also set this bit for a new session via not_resumable_session_cb to
  846. * disable session caching and tickets. */
  847. int not_resumable;
  848. /* The cert is the certificate used to establish this connection
  849. *
  850. * TODO(davidben): Remove this field. It is not serialized as part of the
  851. * session, but some APIs access it. Certificate-related fields, where not
  852. * redundant with |peer|, should be added to the session. Others should
  853. * probably not be retained across resumptions. */
  854. struct sess_cert_st /* SESS_CERT */ *sess_cert;
  855. /* This is the cert for the other end. On clients, it will be the same as
  856. * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is not
  857. * retained in the external representation of sessions, see ssl_asn1.c). */
  858. X509 *peer;
  859. /* when app_verify_callback accepts a session where the peer's certificate is
  860. * not ok, we must remember the error for session reuse: */
  861. long verify_result; /* only for servers */
  862. CRYPTO_refcount_t references;
  863. long timeout;
  864. long time;
  865. const SSL_CIPHER *cipher;
  866. CRYPTO_EX_DATA ex_data; /* application specific data */
  867. /* These are used to make removal of session-ids more efficient and to
  868. * implement a maximum cache size. */
  869. SSL_SESSION *prev, *next;
  870. char *tlsext_hostname;
  871. /* RFC4507 info */
  872. uint8_t *tlsext_tick; /* Session ticket */
  873. size_t tlsext_ticklen; /* Session ticket length */
  874. uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
  875. size_t tlsext_signed_cert_timestamp_list_length;
  876. uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
  877. /* The OCSP response that came with the session. */
  878. size_t ocsp_response_length;
  879. uint8_t *ocsp_response;
  880. char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
  881. uint8_t
  882. peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
  883. /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
  884. * SHA-2, depending on TLS version) for the original, full handshake that
  885. * created a session. This is used by Channel IDs during resumption. */
  886. uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
  887. unsigned int original_handshake_hash_len;
  888. /* extended_master_secret is true if the master secret in this session was
  889. * generated using EMS and thus isn't vulnerable to the Triple Handshake
  890. * attack. */
  891. char extended_master_secret;
  892. };
  893. /* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
  894. * and zero on failure. */
  895. OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
  896. /* SSL_get_secure_renegotiation_support returns one if the peer supports secure
  897. * renegotiation (RFC 5746) and zero otherwise. */
  898. OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
  899. /* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
  900. * This callback will be called when sending or receiving low-level record
  901. * headers, complete handshake messages, ChangeCipherSpec, and alerts.
  902. * |write_p| is one for outgoing messages and zero for incoming messages.
  903. *
  904. * For each record header, |cb| is called with |version| = 0 and |content_type|
  905. * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
  906. * this does not include the record body. If the record is sealed, the length
  907. * in the header is the length of the ciphertext.
  908. *
  909. * For each handshake message, ChangeCipherSpec, and alert, |version| is the
  910. * protocol version and |content_type| is the corresponding record type. The
  911. * |len| bytes from |buf| contain the handshake message, one-byte
  912. * ChangeCipherSpec body, and two-byte alert, respectively. */
  913. OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
  914. SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
  915. const void *buf, size_t len, SSL *ssl, void *arg));
  916. /* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
  917. * callback. */
  918. OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
  919. /* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
  920. * |SSL_CTX_set_msg_callback| for when this callback is called. */
  921. OPENSSL_EXPORT void SSL_set_msg_callback(
  922. SSL *ssl, void (*cb)(int write_p, int version, int content_type,
  923. const void *buf, size_t len, SSL *ssl, void *arg));
  924. /* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
  925. OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
  926. /* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
  927. * log session material to |keylog_bio|. This is intended for debugging use
  928. * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
  929. *
  930. * The format is described in
  931. * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
  932. OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
  933. struct ssl_aead_ctx_st;
  934. typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
  935. #define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
  936. #define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
  937. #define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
  938. /* This callback type is used inside SSL_CTX, SSL, and in the functions that
  939. * set them. It is used to override the generation of SSL/TLS session IDs in a
  940. * server. Return value should be zero on an error, non-zero to proceed. Also,
  941. * callbacks should themselves check if the id they generate is unique
  942. * otherwise the SSL handshake will fail with an error - callbacks can do this
  943. * using the 'ssl' value they're passed by;
  944. * SSL_has_matching_session_id(ssl, id, *id_len)
  945. * The length value passed in is set at the maximum size the session ID can be.
  946. * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
  947. * can alter this length to be less if desired, but under SSLv2 session IDs are
  948. * supposed to be fixed at 16 bytes so the id will be padded after the callback
  949. * returns in this case. It is also an error for the callback to set the size
  950. * to zero. */
  951. typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
  952. unsigned int *id_len);
  953. /* ssl_early_callback_ctx is passed to certain callbacks that are called very
  954. * early on during the server handshake. At this point, much of the SSL* hasn't
  955. * been filled out and only the ClientHello can be depended on. */
  956. struct ssl_early_callback_ctx {
  957. SSL *ssl;
  958. const uint8_t *client_hello;
  959. size_t client_hello_len;
  960. const uint8_t *session_id;
  961. size_t session_id_len;
  962. const uint8_t *cipher_suites;
  963. size_t cipher_suites_len;
  964. const uint8_t *compression_methods;
  965. size_t compression_methods_len;
  966. const uint8_t *extensions;
  967. size_t extensions_len;
  968. };
  969. /* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
  970. * extension of the given type. If not found, it returns zero. Otherwise it
  971. * sets |out_data| to point to the extension contents (not including the type
  972. * and length bytes), sets |out_len| to the length of the extension contents
  973. * and returns one. */
  974. OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
  975. const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
  976. const uint8_t **out_data, size_t *out_len);
  977. typedef struct ssl_comp_st SSL_COMP;
  978. struct ssl_comp_st {
  979. int id;
  980. const char *name;
  981. char *method;
  982. };
  983. DECLARE_STACK_OF(SSL_COMP)
  984. DECLARE_LHASH_OF(SSL_SESSION)
  985. /* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
  986. * equal-preference groups. For TLS clients, the groups are moot because the
  987. * server picks the cipher and groups cannot be expressed on the wire. However,
  988. * for servers, the equal-preference groups allow the client's preferences to
  989. * be partially respected. (This only has an effect with
  990. * SSL_OP_CIPHER_SERVER_PREFERENCE).
  991. *
  992. * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
  993. * All elements of a group have the same priority: no ordering is expressed
  994. * within a group.
  995. *
  996. * The values in |ciphers| are in one-to-one correspondence with
  997. * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
  998. * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
  999. * indicate that the corresponding SSL_CIPHER is not the last element of a
  1000. * group, or 0 to indicate that it is.
  1001. *
  1002. * For example, if |in_group_flags| contains all zeros then that indicates a
  1003. * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
  1004. * of the group (i.e. they are all in a one-element group).
  1005. *
  1006. * For a more complex example, consider:
  1007. * ciphers: A B C D E F
  1008. * in_group_flags: 1 1 0 0 1 0
  1009. *
  1010. * That would express the following, order:
  1011. *
  1012. * A E
  1013. * B -> D -> F
  1014. * C
  1015. */
  1016. struct ssl_cipher_preference_list_st {
  1017. STACK_OF(SSL_CIPHER) *ciphers;
  1018. uint8_t *in_group_flags;
  1019. };
  1020. struct ssl_ctx_st {
  1021. const SSL_PROTOCOL_METHOD *method;
  1022. /* lock is used to protect various operations on this object. */
  1023. CRYPTO_MUTEX lock;
  1024. /* max_version is the maximum acceptable protocol version. If zero, the
  1025. * maximum supported version, currently (D)TLS 1.2, is used. */
  1026. uint16_t max_version;
  1027. /* min_version is the minimum acceptable protocl version. If zero, the
  1028. * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
  1029. uint16_t min_version;
  1030. struct ssl_cipher_preference_list_st *cipher_list;
  1031. /* same as above but sorted for lookup */
  1032. STACK_OF(SSL_CIPHER) *cipher_list_by_id;
  1033. /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
  1034. * use. This only applies to server connections as, for clients, the version
  1035. * number is known at connect time and so the cipher list can be set then. */
  1036. struct ssl_cipher_preference_list_st *cipher_list_tls11;
  1037. X509_STORE *cert_store;
  1038. LHASH_OF(SSL_SESSION) *sessions;
  1039. /* Most session-ids that will be cached, default is
  1040. * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
  1041. unsigned long session_cache_size;
  1042. SSL_SESSION *session_cache_head;
  1043. SSL_SESSION *session_cache_tail;
  1044. /* handshakes_since_cache_flush is the number of successful handshakes since
  1045. * the last cache flush. */
  1046. int handshakes_since_cache_flush;
  1047. /* This can have one of 2 values, ored together,
  1048. * SSL_SESS_CACHE_CLIENT,
  1049. * SSL_SESS_CACHE_SERVER,
  1050. * Default is SSL_SESSION_CACHE_SERVER, which means only
  1051. * SSL_accept which cache SSL_SESSIONS. */
  1052. int session_cache_mode;
  1053. /* If timeout is not 0, it is the default timeout value set when SSL_new() is
  1054. * called. This has been put in to make life easier to set things up */
  1055. long session_timeout;
  1056. /* If this callback is not null, it will be called each time a session id is
  1057. * added to the cache. If this function returns 1, it means that the
  1058. * callback will do a SSL_SESSION_free() when it has finished using it.
  1059. * Otherwise, on 0, it means the callback has finished with it. If
  1060. * remove_session_cb is not null, it will be called when a session-id is
  1061. * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
  1062. * it. */
  1063. int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
  1064. void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
  1065. SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
  1066. int *copy);
  1067. CRYPTO_refcount_t references;
  1068. /* if defined, these override the X509_verify_cert() calls */
  1069. int (*app_verify_callback)(X509_STORE_CTX *, void *);
  1070. void *app_verify_arg;
  1071. /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
  1072. * was called with just one argument) */
  1073. /* Default password callback. */
  1074. pem_password_cb *default_passwd_callback;
  1075. /* Default password callback user data. */
  1076. void *default_passwd_callback_userdata;
  1077. /* get client cert callback */
  1078. int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
  1079. /* get channel id callback */
  1080. void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
  1081. CRYPTO_EX_DATA ex_data;
  1082. /* custom_*_extensions stores any callback sets for custom extensions. Note
  1083. * that these pointers will be NULL if the stack would otherwise be empty. */
  1084. STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
  1085. STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
  1086. /* Default values used when no per-SSL value is defined follow */
  1087. void (*info_callback)(const SSL *ssl, int type,
  1088. int val); /* used if SSL's info_callback is NULL */
  1089. /* what we put in client cert requests */
  1090. STACK_OF(X509_NAME) *client_CA;
  1091. /* Default values to use in SSL structures follow (these are copied by
  1092. * SSL_new) */
  1093. uint32_t options;
  1094. uint32_t mode;
  1095. uint32_t max_cert_list;
  1096. struct cert_st /* CERT */ *cert;
  1097. /* callback that allows applications to peek at protocol messages */
  1098. void (*msg_callback)(int write_p, int version, int content_type,
  1099. const void *buf, size_t len, SSL *ssl, void *arg);
  1100. void *msg_callback_arg;
  1101. int verify_mode;
  1102. unsigned int sid_ctx_length;
  1103. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  1104. int (*default_verify_callback)(
  1105. int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
  1106. /* Default generate session ID callback. */
  1107. GEN_SESSION_CB generate_session_id;
  1108. X509_VERIFY_PARAM *param;
  1109. /* select_certificate_cb is called before most ClientHello processing and
  1110. * before the decision whether to resume a session is made. It may return one
  1111. * to continue the handshake or zero to cause the handshake loop to return
  1112. * with an error and cause SSL_get_error to return
  1113. * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
  1114. * will not call the callback a second time. */
  1115. int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
  1116. /* dos_protection_cb is called once the resumption decision for a ClientHello
  1117. * has been made. It returns one to continue the handshake or zero to
  1118. * abort. */
  1119. int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
  1120. /* quiet_shutdown is true if the connection should not send a close_notify on
  1121. * shutdown. */
  1122. int quiet_shutdown;
  1123. /* Maximum amount of data to send in one fragment. actual record size can be
  1124. * more than this due to padding and MAC overheads. */
  1125. uint16_t max_send_fragment;
  1126. /* TLS extensions servername callback */
  1127. int (*tlsext_servername_callback)(SSL *, int *, void *);
  1128. void *tlsext_servername_arg;
  1129. /* RFC 4507 session ticket keys */
  1130. uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
  1131. uint8_t tlsext_tick_hmac_key[16];
  1132. uint8_t tlsext_tick_aes_key[16];
  1133. /* Callback to support customisation of ticket key setting */
  1134. int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
  1135. EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
  1136. /* Server-only: psk_identity_hint is the default identity hint to send in
  1137. * PSK-based key exchanges. */
  1138. char *psk_identity_hint;
  1139. unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  1140. char *identity,
  1141. unsigned int max_identity_len,
  1142. uint8_t *psk, unsigned int max_psk_len);
  1143. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1144. uint8_t *psk, unsigned int max_psk_len);
  1145. /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
  1146. * hash of the peer's certifiate and then discard it to save memory and
  1147. * session space. Only effective on the server side. */
  1148. char retain_only_sha256_of_client_certs;
  1149. /* Next protocol negotiation information */
  1150. /* (for experimental NPN extension). */
  1151. /* For a server, this contains a callback function by which the set of
  1152. * advertised protocols can be provided. */
  1153. int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
  1154. unsigned int *len, void *arg);
  1155. void *next_protos_advertised_cb_arg;
  1156. /* For a client, this contains a callback function that selects the
  1157. * next protocol from the list provided by the server. */
  1158. int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
  1159. const uint8_t *in, unsigned int inlen, void *arg);
  1160. void *next_proto_select_cb_arg;
  1161. /* ALPN information
  1162. * (we are in the process of transitioning from NPN to ALPN.) */
  1163. /* For a server, this contains a callback function that allows the
  1164. * server to select the protocol for the connection.
  1165. * out: on successful return, this must point to the raw protocol
  1166. * name (without the length prefix).
  1167. * outlen: on successful return, this contains the length of |*out|.
  1168. * in: points to the client's list of supported protocols in
  1169. * wire-format.
  1170. * inlen: the length of |in|. */
  1171. int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
  1172. const uint8_t *in, unsigned int inlen, void *arg);
  1173. void *alpn_select_cb_arg;
  1174. /* For a client, this contains the list of supported protocols in wire
  1175. * format. */
  1176. uint8_t *alpn_client_proto_list;
  1177. unsigned alpn_client_proto_list_len;
  1178. /* SRTP profiles we are willing to do from RFC 5764 */
  1179. STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
  1180. /* EC extension values inherited by SSL structure */
  1181. size_t tlsext_ecpointformatlist_length;
  1182. uint8_t *tlsext_ecpointformatlist;
  1183. size_t tlsext_ellipticcurvelist_length;
  1184. uint16_t *tlsext_ellipticcurvelist;
  1185. /* If true, a client will advertise the Channel ID extension and a server
  1186. * will echo it. */
  1187. char tlsext_channel_id_enabled;
  1188. /* The client's Channel ID private key. */
  1189. EVP_PKEY *tlsext_channel_id_private;
  1190. /* If true, a client will request certificate timestamps. */
  1191. char signed_cert_timestamps_enabled;
  1192. /* If true, a client will request a stapled OCSP response. */
  1193. char ocsp_stapling_enabled;
  1194. /* If not NULL, session key material will be logged to this BIO for debugging
  1195. * purposes. The format matches NSS's and is readable by Wireshark. */
  1196. BIO *keylog_bio;
  1197. /* current_time_cb, if not NULL, is the function to use to get the current
  1198. * time. It sets |*out_clock| to the current time. */
  1199. void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
  1200. };
  1201. OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
  1202. /* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
  1203. * session cache. */
  1204. OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
  1205. OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
  1206. SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
  1207. OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
  1208. SSL_SESSION *sess);
  1209. OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
  1210. SSL_CTX *ctx,
  1211. void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
  1212. OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
  1213. SSL_CTX *ctx, SSL_SESSION *sess);
  1214. OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
  1215. SSL_CTX *ctx,
  1216. SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
  1217. int *copy));
  1218. OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
  1219. SSL *ssl, uint8_t *data, int len, int *copy);
  1220. /* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
  1221. * that the session isn't currently unavailable. SSL_get_error will then return
  1222. * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
  1223. * lookup has completed. */
  1224. OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
  1225. OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
  1226. void (*cb)(const SSL *ssl,
  1227. int type, int val));
  1228. OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
  1229. int type,
  1230. int val);
  1231. OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
  1232. SSL_CTX *ctx,
  1233. int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
  1234. OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
  1235. X509 **x509,
  1236. EVP_PKEY **pkey);
  1237. OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
  1238. SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
  1239. OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
  1240. EVP_PKEY **pkey);
  1241. /* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
  1242. * of a connection) to request SCTs from the server. See
  1243. * https://tools.ietf.org/html/rfc6962. It returns one. */
  1244. OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
  1245. /* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
  1246. * objects created from |ctx|. */
  1247. OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
  1248. /* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
  1249. * connection) to request a stapled OCSP response from the server. It returns
  1250. * one. */
  1251. OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
  1252. /* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
  1253. * created from |ctx|. */
  1254. OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
  1255. /* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
  1256. * |*out_len| bytes of SCT information from the server. This is only valid if
  1257. * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
  1258. * (including the two leading length bytes).
  1259. * See https://tools.ietf.org/html/rfc6962#section-3.3
  1260. * If no SCT was received then |*out_len| will be zero on return.
  1261. *
  1262. * WARNING: the returned data is not guaranteed to be well formed. */
  1263. OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
  1264. const uint8_t **out,
  1265. size_t *out_len);
  1266. /* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
  1267. * bytes of an OCSP response from the server. This is the DER encoding of an
  1268. * OCSPResponse type as defined in RFC 2560.
  1269. *
  1270. * WARNING: the returned data is not guaranteed to be well formed. */
  1271. OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
  1272. size_t *out_len);
  1273. OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
  1274. SSL_CTX *s,
  1275. int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
  1276. void *arg);
  1277. OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
  1278. SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
  1279. const uint8_t *in, unsigned int inlen, void *arg),
  1280. void *arg);
  1281. OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
  1282. const uint8_t **data,
  1283. unsigned *len);
  1284. OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
  1285. const uint8_t *in, unsigned int inlen,
  1286. const uint8_t *client,
  1287. unsigned int client_len);
  1288. #define OPENSSL_NPN_UNSUPPORTED 0
  1289. #define OPENSSL_NPN_NEGOTIATED 1
  1290. #define OPENSSL_NPN_NO_OVERLAP 2
  1291. /* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
  1292. * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
  1293. * length-prefixed strings). It returns zero on success and one on failure.
  1294. *
  1295. * WARNING: this function is dangerous because it breaks the usual return value
  1296. * convention. */
  1297. OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
  1298. unsigned protos_len);
  1299. /* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
  1300. * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
  1301. * length-prefixed strings). It returns zero on success and one on failure.
  1302. *
  1303. * WARNING: this function is dangerous because it breaks the usual return value
  1304. * convention. */
  1305. OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
  1306. unsigned protos_len);
  1307. OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
  1308. SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
  1309. const uint8_t *in, unsigned int inlen, void *arg),
  1310. void *arg);
  1311. OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
  1312. unsigned *len);
  1313. /* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
  1314. * the peer are rejected. It may be set at any point in a connection's lifetime
  1315. * to control future renegotiations programmatically. By default, renegotiations
  1316. * are rejected. (Renegotiations requested by a client are always rejected.) */
  1317. OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
  1318. /* the maximum length of the buffer given to callbacks containing the resulting
  1319. * identity/psk */
  1320. #define PSK_MAX_IDENTITY_LEN 128
  1321. #define PSK_MAX_PSK_LEN 256
  1322. OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
  1323. SSL_CTX *ctx,
  1324. unsigned int (*psk_client_callback)(
  1325. SSL *ssl, const char *hint, char *identity,
  1326. unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
  1327. OPENSSL_EXPORT void SSL_set_psk_client_callback(
  1328. SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  1329. char *identity,
  1330. unsigned int max_identity_len,
  1331. uint8_t *psk,
  1332. unsigned int max_psk_len));
  1333. OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
  1334. SSL_CTX *ctx,
  1335. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1336. uint8_t *psk,
  1337. unsigned int max_psk_len));
  1338. OPENSSL_EXPORT void SSL_set_psk_server_callback(
  1339. SSL *ssl,
  1340. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1341. uint8_t *psk,
  1342. unsigned int max_psk_len));
  1343. OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
  1344. const char *identity_hint);
  1345. OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
  1346. OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
  1347. OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
  1348. #define SSL_NOTHING 1
  1349. #define SSL_WRITING 2
  1350. #define SSL_READING 3
  1351. #define SSL_X509_LOOKUP 4
  1352. #define SSL_CHANNEL_ID_LOOKUP 5
  1353. #define SSL_PENDING_SESSION 7
  1354. #define SSL_CERTIFICATE_SELECTION_PENDING 8
  1355. #define SSL_PRIVATE_KEY_OPERATION 9
  1356. /* These will only be used when doing non-blocking IO */
  1357. #define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
  1358. #define SSL_want_read(s) (SSL_want(s) == SSL_READING)
  1359. #define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
  1360. #define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
  1361. #define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
  1362. #define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
  1363. #define SSL_want_certificate(s) \
  1364. (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
  1365. #define SSL_want_private_key_operation(s) \
  1366. (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
  1367. struct ssl_st {
  1368. /* version is the protocol version. */
  1369. int version;
  1370. /* method is the method table corresponding to the current protocol (DTLS or
  1371. * TLS). */
  1372. const SSL_PROTOCOL_METHOD *method;
  1373. /* enc_method is the method table corresponding to the current protocol
  1374. * version. */
  1375. const SSL3_ENC_METHOD *enc_method;
  1376. /* max_version is the maximum acceptable protocol version. If zero, the
  1377. * maximum supported version, currently (D)TLS 1.2, is used. */
  1378. uint16_t max_version;
  1379. /* min_version is the minimum acceptable protocl version. If zero, the
  1380. * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
  1381. uint16_t min_version;
  1382. /* There are 2 BIO's even though they are normally both the same. This is so
  1383. * data can be read and written to different handlers */
  1384. BIO *rbio; /* used by SSL_read */
  1385. BIO *wbio; /* used by SSL_write */
  1386. BIO *bbio; /* used during session-id reuse to concatenate
  1387. * messages */
  1388. /* This holds a variable that indicates what we were doing when a 0 or -1 is
  1389. * returned. This is needed for non-blocking IO so we know what request
  1390. * needs re-doing when in SSL_accept or SSL_connect */
  1391. int rwstate;
  1392. /* true when we are actually in SSL_accept() or SSL_connect() */
  1393. int in_handshake;
  1394. int (*handshake_func)(SSL *);
  1395. /* Imagine that here's a boolean member "init" that is switched as soon as
  1396. * SSL_set_{accept/connect}_state is called for the first time, so that
  1397. * "state" and "handshake_func" are properly initialized. But as
  1398. * handshake_func is == 0 until then, we use this test instead of an "init"
  1399. * member. */
  1400. /* server is true iff the this SSL* is the server half. Note: before the SSL*
  1401. * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
  1402. * the side is not determined. In this state, server is always false. */
  1403. int server;
  1404. /* quiet_shutdown is true if the connection should not send a close_notify on
  1405. * shutdown. */
  1406. int quiet_shutdown;
  1407. int shutdown; /* we have shut things down, 0x01 sent, 0x02
  1408. * for received */
  1409. int state; /* where we are */
  1410. int rstate; /* where we are when reading */
  1411. BUF_MEM *init_buf; /* buffer used during init */
  1412. uint8_t *init_msg; /* pointer to handshake message body, set by
  1413. ssl3_get_message() */
  1414. int init_num; /* amount read/written */
  1415. int init_off; /* amount read/written */
  1416. /* used internally to point at a raw packet */
  1417. uint8_t *packet;
  1418. unsigned int packet_length;
  1419. struct ssl3_state_st *s3; /* SSLv3 variables */
  1420. struct dtls1_state_st *d1; /* DTLSv1 variables */
  1421. /* callback that allows applications to peek at protocol messages */
  1422. void (*msg_callback)(int write_p, int version, int content_type,
  1423. const void *buf, size_t len, SSL *ssl, void *arg);
  1424. void *msg_callback_arg;
  1425. int hit; /* reusing a previous session */
  1426. X509_VERIFY_PARAM *param;
  1427. /* crypto */
  1428. struct ssl_cipher_preference_list_st *cipher_list;
  1429. STACK_OF(SSL_CIPHER) *cipher_list_by_id;
  1430. SSL_AEAD_CTX *aead_read_ctx;
  1431. SSL_AEAD_CTX *aead_write_ctx;
  1432. /* session info */
  1433. /* client cert? */
  1434. /* This is used to hold the server certificate used */
  1435. struct cert_st /* CERT */ *cert;
  1436. /* the session_id_context is used to ensure sessions are only reused
  1437. * in the appropriate context */
  1438. unsigned int sid_ctx_length;
  1439. uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
  1440. /* This can also be in the session once a session is established */
  1441. SSL_SESSION *session;
  1442. /* Default generate session ID callback. */
  1443. GEN_SESSION_CB generate_session_id;
  1444. /* Used in SSL2 and SSL3 */
  1445. int verify_mode; /* 0 don't care about verify failure.
  1446. * 1 fail if verify fails */
  1447. int (*verify_callback)(int ok,
  1448. X509_STORE_CTX *ctx); /* fail if callback returns 0 */
  1449. void (*info_callback)(const SSL *ssl, int type,
  1450. int val); /* optional informational callback */
  1451. /* Server-only: psk_identity_hint is the identity hint to send in
  1452. * PSK-based key exchanges. */
  1453. char *psk_identity_hint;
  1454. unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
  1455. char *identity,
  1456. unsigned int max_identity_len,
  1457. uint8_t *psk, unsigned int max_psk_len);
  1458. unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
  1459. uint8_t *psk, unsigned int max_psk_len);
  1460. SSL_CTX *ctx;
  1461. /* extra application data */
  1462. long verify_result;
  1463. CRYPTO_EX_DATA ex_data;
  1464. /* for server side, keep the list of CA_dn we can use */
  1465. STACK_OF(X509_NAME) *client_CA;
  1466. uint32_t options; /* protocol behaviour */
  1467. uint32_t mode; /* API behaviour */
  1468. uint32_t max_cert_list;
  1469. int client_version; /* what was passed, used for
  1470. * SSLv3/TLS rollback check */
  1471. uint16_t max_send_fragment;
  1472. char *tlsext_hostname;
  1473. /* RFC4507 session ticket expected to be received or sent */
  1474. int tlsext_ticket_expected;
  1475. size_t tlsext_ecpointformatlist_length;
  1476. uint8_t *tlsext_ecpointformatlist; /* our list */
  1477. size_t tlsext_ellipticcurvelist_length;
  1478. uint16_t *tlsext_ellipticcurvelist; /* our list */
  1479. SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
  1480. /* Next protocol negotiation. For the client, this is the protocol that we
  1481. * sent in NextProtocol and is set when handling ServerHello extensions.
  1482. *
  1483. * For a server, this is the client's selected_protocol from NextProtocol and
  1484. * is set when handling the NextProtocol message, before the Finished
  1485. * message. */
  1486. uint8_t *next_proto_negotiated;
  1487. size_t next_proto_negotiated_len;
  1488. /* srtp_profiles is the list of configured SRTP protection profiles for
  1489. * DTLS-SRTP. */
  1490. STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
  1491. /* srtp_profile is the selected SRTP protection profile for
  1492. * DTLS-SRTP. */
  1493. const SRTP_PROTECTION_PROFILE *srtp_profile;
  1494. /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
  1495. * from clients. For a client, means that we'll advertise support. */
  1496. char tlsext_channel_id_enabled;
  1497. /* The client's Channel ID private key. */
  1498. EVP_PKEY *tlsext_channel_id_private;
  1499. /* Enable signed certificate time stamps. Currently client only. */
  1500. char signed_cert_timestamps_enabled;
  1501. /* Enable OCSP stapling. Currently client only.
  1502. * TODO(davidben): Add a server-side implementation when it becomes
  1503. * necesary. */
  1504. char ocsp_stapling_enabled;
  1505. /* For a client, this contains the list of supported protocols in wire
  1506. * format. */
  1507. uint8_t *alpn_client_proto_list;
  1508. unsigned alpn_client_proto_list_len;
  1509. /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
  1510. * peer. Otherwise, they will be rejected with a fatal error. */
  1511. char accept_peer_renegotiations;
  1512. /* These fields are always NULL and exist only to keep wpa_supplicant happy
  1513. * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
  1514. * don't support. */
  1515. EVP_CIPHER_CTX *enc_read_ctx;
  1516. EVP_MD_CTX *read_hash;
  1517. };
  1518. /* compatibility */
  1519. #define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
  1520. #define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
  1521. #define SSL_SESSION_set_app_data(s, a) \
  1522. (SSL_SESSION_set_ex_data(s, 0, (char *)a))
  1523. #define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
  1524. #define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
  1525. #define SSL_CTX_set_app_data(ctx, arg) \
  1526. (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
  1527. /* The following are the possible values for ssl->state are are used to
  1528. * indicate where we are up to in the SSL connection establishment. The macros
  1529. * that follow are about the only things you should need to use and even then,
  1530. * only when using non-blocking IO. It can also be useful to work out where you
  1531. * were when the connection failed */
  1532. #define SSL_ST_CONNECT 0x1000
  1533. #define SSL_ST_ACCEPT 0x2000
  1534. #define SSL_ST_MASK 0x0FFF
  1535. #define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
  1536. #define SSL_ST_OK 0x03
  1537. #define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
  1538. #define SSL_CB_LOOP 0x01
  1539. #define SSL_CB_EXIT 0x02
  1540. #define SSL_CB_READ 0x04
  1541. #define SSL_CB_WRITE 0x08
  1542. #define SSL_CB_ALERT 0x4000 /* used in callback */
  1543. #define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
  1544. #define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
  1545. #define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
  1546. #define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
  1547. #define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
  1548. #define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
  1549. #define SSL_CB_HANDSHAKE_START 0x10
  1550. #define SSL_CB_HANDSHAKE_DONE 0x20
  1551. /* Is the SSL_connection established? */
  1552. #define SSL_get_state(a) SSL_state(a)
  1553. #define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
  1554. #define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
  1555. #define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
  1556. #define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
  1557. /* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
  1558. * is in False Start. |SSL_write| may be called at this point without waiting
  1559. * for the peer, but |SSL_read| will require the handshake to be completed. */
  1560. OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
  1561. /* The following 2 states are kept in ssl->rstate when reads fail,
  1562. * you should not need these */
  1563. #define SSL_ST_READ_HEADER 0xF0
  1564. #define SSL_ST_READ_BODY 0xF1
  1565. #define SSL_ST_READ_DONE 0xF2
  1566. /* Obtain latest Finished message
  1567. * -- that we sent (SSL_get_finished)
  1568. * -- that we expected from peer (SSL_get_peer_finished).
  1569. * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
  1570. OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
  1571. OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
  1572. /* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
  1573. * are 'ored' with SSL_VERIFY_PEER if they are desired */
  1574. #define SSL_VERIFY_NONE 0x00
  1575. #define SSL_VERIFY_PEER 0x01
  1576. #define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
  1577. /* SSL_VERIFY_CLIENT_ONCE does nothing. */
  1578. #define SSL_VERIFY_CLIENT_ONCE 0x04
  1579. #define SSL_VERIFY_PEER_IF_NO_OBC 0x08
  1580. #define OpenSSL_add_ssl_algorithms() SSL_library_init()
  1581. #define SSLeay_add_ssl_algorithms() SSL_library_init()
  1582. /* For backward compatibility */
  1583. #define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
  1584. #define SSL_get_cipher_bits(s, np) \
  1585. SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
  1586. #define SSL_get_cipher_version(s) \
  1587. SSL_CIPHER_get_version(SSL_get_current_cipher(s))
  1588. #define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
  1589. #define SSL_get_time(a) SSL_SESSION_get_time(a)
  1590. #define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
  1591. #define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
  1592. #define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
  1593. #define d2i_SSL_SESSION_bio(bp, s_id) \
  1594. ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
  1595. #define i2d_SSL_SESSION_bio(bp, s_id) \
  1596. ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
  1597. DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
  1598. /* make_errors.go reserves error codes above 1000 for manually-assigned errors.
  1599. * This value must be kept in sync with reservedReasonCode in make_errors.h */
  1600. #define SSL_AD_REASON_OFFSET \
  1601. 1000 /* offset to get SSL_R_... value from SSL_AD_... */
  1602. /* These alert types are for SSLv3 and TLSv1 */
  1603. #define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
  1604. #define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
  1605. #define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
  1606. #define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
  1607. #define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
  1608. #define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
  1609. #define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
  1610. #define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
  1611. #define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
  1612. #define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
  1613. #define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
  1614. #define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
  1615. #define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
  1616. #define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
  1617. #define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
  1618. #define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
  1619. #define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
  1620. #define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
  1621. #define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
  1622. #define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
  1623. #define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
  1624. #define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
  1625. #define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
  1626. #define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
  1627. #define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
  1628. #define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
  1629. #define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
  1630. #define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
  1631. TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
  1632. #define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
  1633. #define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
  1634. #define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
  1635. #define SSL_ERROR_NONE 0
  1636. #define SSL_ERROR_SSL 1
  1637. #define SSL_ERROR_WANT_READ 2
  1638. #define SSL_ERROR_WANT_WRITE 3
  1639. #define SSL_ERROR_WANT_X509_LOOKUP 4
  1640. #define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
  1641. #define SSL_ERROR_ZERO_RETURN 6
  1642. #define SSL_ERROR_WANT_CONNECT 7
  1643. #define SSL_ERROR_WANT_ACCEPT 8
  1644. #define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
  1645. #define SSL_ERROR_PENDING_SESSION 11
  1646. #define SSL_ERROR_PENDING_CERTIFICATE 12
  1647. #define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
  1648. #define SSL_CTRL_GET_CURVES 90
  1649. #define SSL_CTRL_SET_CURVES 91
  1650. #define SSL_CTRL_SET_CURVES_LIST 92
  1651. #define SSL_CTRL_SET_SIGALGS 97
  1652. #define SSL_CTRL_SET_SIGALGS_LIST 98
  1653. #define SSL_CTRL_SET_CLIENT_SIGALGS 101
  1654. #define SSL_CTRL_SET_CLIENT_SIGALGS_LIST 102
  1655. #define SSL_CTRL_GET_CLIENT_CERT_TYPES 103
  1656. #define SSL_CTRL_SET_CLIENT_CERT_TYPES 104
  1657. #define SSL_CTRL_SET_VERIFY_CERT_STORE 106
  1658. #define SSL_CTRL_SET_CHAIN_CERT_STORE 107
  1659. /* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
  1660. * timeout in progress, it sets |*out| to the time remaining and returns one.
  1661. * Otherwise, it returns zero.
  1662. *
  1663. * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
  1664. * retransmit behavior.
  1665. *
  1666. * NOTE: This function must be queried again whenever the handshake state
  1667. * machine changes, including when |DTLSv1_handle_timeout| is called. */
  1668. OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
  1669. /* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
  1670. * timeout had expired, it returns 0. Otherwise, it retransmits the previous
  1671. * flight of handshake messages and returns 1. If too many timeouts had expired
  1672. * without progress or an error occurs, it returns -1.
  1673. *
  1674. * NOTE: The caller's external timer should be compatible with the one |ssl|
  1675. * queries within some fudge factor. Otherwise, the call will be a no-op, but
  1676. * |DTLSv1_get_timeout| will return an updated timeout.
  1677. *
  1678. * WARNING: This function breaks the usual return value convention. */
  1679. OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
  1680. /* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
  1681. * and zero otherwise.
  1682. *
  1683. * TODO(davidben): Hammer down the semantics of this API while a handshake,
  1684. * initial or renego, is in progress. */
  1685. OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
  1686. /* SSL_total_renegotiations returns the total number of renegotiation handshakes
  1687. * peformed by |ssl|. This includes the pending renegotiation, if any. */
  1688. OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
  1689. /* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
  1690. * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
  1691. * one on success and zero on error. */
  1692. OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
  1693. /* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
  1694. * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
  1695. * on success and zero on error. */
  1696. OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
  1697. /* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
  1698. * curve for ephemeral ECDH keys. For historical reasons, this API expects an
  1699. * |EC_KEY|, but only the curve is used. It returns one on success and zero on
  1700. * error. If unset, an appropriate curve will be chosen automatically. (This is
  1701. * recommended.) */
  1702. OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
  1703. /* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
  1704. * for ephemeral ECDH keys. For historical reasons, this API expects an
  1705. * |EC_KEY|, but only the curve is used. It returns one on success and zero on
  1706. * error. If unset, an appropriate curve will be chosen automatically. (This is
  1707. * recommended.) */
  1708. OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
  1709. /* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
  1710. * client IDs from clients, or configures a client to send TLS client IDs to
  1711. * a server. It returns one. */
  1712. OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
  1713. /* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
  1714. * client IDs from clients, or configure a client to send TLS client IDs to
  1715. * server. It returns one. */
  1716. OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
  1717. /* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
  1718. * to compatible servers. |private_key| must be a P-256 EC key. It returns one
  1719. * on success and zero on error. */
  1720. OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
  1721. EVP_PKEY *private_key);
  1722. /* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
  1723. * compatible servers. |private_key| must be a P-256 EC key. It returns one on
  1724. * success and zero on error. */
  1725. OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
  1726. /* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
  1727. * and copies up to the first |max_out| bytes into |out|. The Channel ID
  1728. * consists of the client's P-256 public key as an (x,y) pair where each is a
  1729. * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
  1730. * Channel ID and the length of the complete Channel ID otherwise. */
  1731. OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
  1732. size_t max_out);
  1733. #define SSL_CTX_set0_verify_cert_store(ctx, st) \
  1734. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
  1735. #define SSL_CTX_set1_verify_cert_store(ctx, st) \
  1736. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
  1737. #define SSL_CTX_set0_chain_cert_store(ctx, st) \
  1738. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
  1739. #define SSL_CTX_set1_chain_cert_store(ctx, st) \
  1740. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
  1741. #define SSL_set0_verify_cert_store(s, st) \
  1742. SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
  1743. #define SSL_set1_verify_cert_store(s, st) \
  1744. SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
  1745. #define SSL_set0_chain_cert_store(s, st) \
  1746. SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
  1747. #define SSL_set1_chain_cert_store(s, st) \
  1748. SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
  1749. #define SSL_get1_curves(ctx, s) SSL_ctrl(ctx, SSL_CTRL_GET_CURVES, 0, (char *)s)
  1750. #define SSL_CTX_set1_curves(ctx, clist, clistlen) \
  1751. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
  1752. #define SSL_CTX_set1_curves_list(ctx, s) \
  1753. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
  1754. #define SSL_set1_curves(ctx, clist, clistlen) \
  1755. SSL_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
  1756. #define SSL_set1_curves_list(ctx, s) \
  1757. SSL_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
  1758. #define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
  1759. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS, slistlen, (int *)slist)
  1760. #define SSL_CTX_set1_sigalgs_list(ctx, s) \
  1761. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
  1762. #define SSL_set1_sigalgs(ctx, slist, slistlen) \
  1763. SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS, clistlen, (int *)slist)
  1764. #define SSL_set1_sigalgs_list(ctx, s) \
  1765. SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
  1766. #define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
  1767. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, slistlen, (int *)slist)
  1768. #define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
  1769. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
  1770. #define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
  1771. SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, clistlen, (int *)slist)
  1772. #define SSL_set1_client_sigalgs_list(ctx, s) \
  1773. SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
  1774. #define SSL_get0_certificate_types(s, clist) \
  1775. SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)clist)
  1776. #define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
  1777. SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
  1778. #define SSL_set1_client_certificate_types(s, clist, clistlen) \
  1779. SSL_ctrl(s, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
  1780. OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
  1781. OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
  1782. OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
  1783. OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
  1784. OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
  1785. OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
  1786. OPENSSL_EXPORT int SSL_want(const SSL *s);
  1787. OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
  1788. /* SSL_get_current_cipher returns the cipher used in the current outgoing
  1789. * connection state, or NULL if the null cipher is active. */
  1790. OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
  1791. OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
  1792. OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
  1793. OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
  1794. OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
  1795. OPENSSL_EXPORT int SSL_pending(const SSL *s);
  1796. OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
  1797. OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
  1798. OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
  1799. OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
  1800. OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
  1801. OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
  1802. OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
  1803. OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
  1804. OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
  1805. OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
  1806. X509_STORE_CTX *);
  1807. OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
  1808. int (*callback)(int ok,
  1809. X509_STORE_CTX *ctx));
  1810. OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
  1811. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
  1812. OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
  1813. stackCAs,
  1814. const char *file);
  1815. OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
  1816. stackCAs,
  1817. const char *dir);
  1818. /* SSL_load_error_strings does nothing. */
  1819. OPENSSL_EXPORT void SSL_load_error_strings(void);
  1820. OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
  1821. OPENSSL_EXPORT const char *SSL_rstate_string(const SSL *s);
  1822. OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
  1823. OPENSSL_EXPORT const char *SSL_rstate_string_long(const SSL *s);
  1824. OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
  1825. OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
  1826. OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
  1827. OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
  1828. OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
  1829. OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
  1830. const uint8_t *sid_ctx,
  1831. unsigned int sid_ctx_len);
  1832. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
  1833. OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
  1834. unsigned int *len);
  1835. OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
  1836. OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
  1837. /* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
  1838. * of |session|. It then returns |session|. */
  1839. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
  1840. /* SSL_SESSION_free decrements the reference count of |session|. If it reaches
  1841. * zero, all data referenced by |session| and |session| itself are released. */
  1842. OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
  1843. OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
  1844. OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
  1845. OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
  1846. OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
  1847. OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
  1848. OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
  1849. const uint8_t *id,
  1850. unsigned int id_len);
  1851. /* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
  1852. * |*out_data| to that buffer and |*out_len| to its length. The caller takes
  1853. * ownership of the buffer and must call |OPENSSL_free| when done. It returns
  1854. * one on success and zero on error. */
  1855. OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
  1856. size_t *out_len);
  1857. /* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
  1858. * identification information, namely the session ID and ticket. */
  1859. OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
  1860. uint8_t **out_data,
  1861. size_t *out_len);
  1862. /* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
  1863. * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
  1864. OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
  1865. size_t in_len);
  1866. /* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
  1867. * |*pp|. On success, it returns the number of bytes written and advances |*pp|
  1868. * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
  1869. * written and only the length is returned.
  1870. *
  1871. * Use |SSL_SESSION_to_bytes| instead. */
  1872. OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
  1873. /* Deprecated: d2i_SSL_SESSION parses a serialized session from the |length|
  1874. * bytes pointed to by |*pp|. It returns the new |SSL_SESSION| and advances
  1875. * |*pp| by the number of bytes consumed on success and NULL on failure. The
  1876. * caller takes ownership of the new session and must call |SSL_SESSION_free|
  1877. * when done.
  1878. *
  1879. * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
  1880. *
  1881. * Use |SSL_SESSION_from_bytes| instead. */
  1882. OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
  1883. long length);
  1884. OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *s);
  1885. OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
  1886. OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
  1887. OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
  1888. OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
  1889. int, X509_STORE_CTX *);
  1890. OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
  1891. int (*callback)(int, X509_STORE_CTX *));
  1892. OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
  1893. OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
  1894. SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
  1895. OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
  1896. pem_password_cb *cb);
  1897. OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
  1898. void *u);
  1899. OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
  1900. const uint8_t *sid_ctx,
  1901. unsigned int sid_ctx_len);
  1902. OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
  1903. unsigned int sid_ctx_len);
  1904. OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
  1905. OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
  1906. OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
  1907. OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
  1908. OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
  1909. OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
  1910. OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
  1911. OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
  1912. OPENSSL_EXPORT int SSL_accept(SSL *ssl);
  1913. OPENSSL_EXPORT int SSL_connect(SSL *ssl);
  1914. OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
  1915. OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
  1916. OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
  1917. OPENSSL_EXPORT long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
  1918. OPENSSL_EXPORT long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
  1919. OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
  1920. /* SSL_get_version returns a string describing the TLS version used by |s|. For
  1921. * example, "TLSv1.2" or "SSLv3". */
  1922. OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
  1923. /* SSL_SESSION_get_version returns a string describing the TLS version used by
  1924. * |sess|. For example, "TLSv1.2" or "SSLv3". */
  1925. OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
  1926. OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
  1927. OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
  1928. /* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
  1929. * renegotiation. */
  1930. OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
  1931. OPENSSL_EXPORT int SSL_shutdown(SSL *s);
  1932. OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
  1933. OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
  1934. OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
  1935. OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
  1936. OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
  1937. STACK_OF(X509_NAME) *name_list);
  1938. OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
  1939. STACK_OF(X509_NAME) *name_list);
  1940. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
  1941. OPENSSL_EXPORT STACK_OF(X509_NAME) *
  1942. SSL_CTX_get_client_CA_list(const SSL_CTX *s);
  1943. OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
  1944. OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
  1945. OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
  1946. OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
  1947. OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
  1948. OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
  1949. OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
  1950. OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
  1951. OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
  1952. OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
  1953. OPENSSL_EXPORT int SSL_version(const SSL *ssl);
  1954. OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
  1955. OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
  1956. const char *CAfile,
  1957. const char *CApath);
  1958. #define SSL_get0_session SSL_get_session /* just peek at pointer */
  1959. OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
  1960. OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
  1961. SSL *ssl); /* obtain a reference count */
  1962. OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
  1963. OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
  1964. OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
  1965. void (*cb)(const SSL *ssl, int type,
  1966. int val));
  1967. OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
  1968. int type, int val);
  1969. OPENSSL_EXPORT int SSL_state(const SSL *ssl);
  1970. OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
  1971. OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
  1972. OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
  1973. OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
  1974. OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
  1975. CRYPTO_EX_new *new_func,
  1976. CRYPTO_EX_dup *dup_func,
  1977. CRYPTO_EX_free *free_func);
  1978. OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
  1979. void *data);
  1980. OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
  1981. OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
  1982. CRYPTO_EX_new *new_func,
  1983. CRYPTO_EX_dup *dup_func,
  1984. CRYPTO_EX_free *free_func);
  1985. OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
  1986. OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
  1987. OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
  1988. CRYPTO_EX_new *new_func,
  1989. CRYPTO_EX_dup *dup_func,
  1990. CRYPTO_EX_free *free_func);
  1991. OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
  1992. /* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
  1993. * |size|. It returns the previous value. */
  1994. OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
  1995. unsigned long size);
  1996. /* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
  1997. * cache. */
  1998. OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
  1999. /* SSL_SESS_CACHE_* are the possible session cache mode bits.
  2000. * TODO(davidben): Document. */
  2001. #define SSL_SESS_CACHE_OFF 0x0000
  2002. #define SSL_SESS_CACHE_CLIENT 0x0001
  2003. #define SSL_SESS_CACHE_SERVER 0x0002
  2004. #define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
  2005. #define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
  2006. #define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
  2007. #define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
  2008. #define SSL_SESS_CACHE_NO_INTERNAL \
  2009. (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
  2010. /* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
  2011. * |mode|. It returns the previous value. */
  2012. OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
  2013. /* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
  2014. * |ctx| */
  2015. OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
  2016. /* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
  2017. * certificate chain accepted by |ctx|. */
  2018. OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
  2019. /* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
  2020. * certificate chain to |max_cert_list|. This affects how much memory may be
  2021. * consumed during the handshake. */
  2022. OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
  2023. size_t max_cert_list);
  2024. /* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
  2025. * certificate chain accepted by |ssl|. */
  2026. OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
  2027. /* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
  2028. * certificate chain to |max_cert_list|. This affects how much memory may be
  2029. * consumed during the handshake. */
  2030. OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
  2031. /* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
  2032. * sent by |ctx|. Beyond this length, handshake messages and application data
  2033. * will be split into multiple records. */
  2034. OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
  2035. size_t max_send_fragment);
  2036. /* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
  2037. * sent by |ssl|. Beyond this length, handshake messages and application data
  2038. * will be split into multiple records. */
  2039. OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
  2040. size_t max_send_fragment);
  2041. /* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
  2042. * the group for DHE ciphers. |callback| should ignore |is_export| and
  2043. * |keylength| and return a |DH| of the selected group or NULL on error. Only
  2044. * the parameters are used, so the |DH| needn't have a generated keypair.
  2045. *
  2046. * WARNING: The caller does not take ownership of the resulting |DH|, so
  2047. * |callback| must save and release the object elsewhere. */
  2048. OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
  2049. SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
  2050. /* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
  2051. * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
  2052. * and return a |DH| of the selected group or NULL on error. Only the
  2053. * parameters are used, so the |DH| needn't have a generated keypair.
  2054. *
  2055. * WARNING: The caller does not take ownership of the resulting |DH|, so
  2056. * |callback| must save and release the object elsewhere. */
  2057. OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
  2058. DH *(*dh)(SSL *ssl, int is_export,
  2059. int keylength));
  2060. /* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
  2061. * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
  2062. * |keylength| and return an |EC_KEY| of the selected curve or NULL on
  2063. * error. Only the curve is used, so the |EC_KEY| needn't have a generated
  2064. * keypair.
  2065. *
  2066. * If the callback is unset, an appropriate curve will be chosen automatically.
  2067. * (This is recommended.)
  2068. *
  2069. * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
  2070. * |callback| must save and release the object elsewhere. */
  2071. OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
  2072. SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
  2073. /* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
  2074. * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
  2075. * |keylength| and return an |EC_KEY| of the selected curve or NULL on
  2076. * error. Only the curve is used, so the |EC_KEY| needn't have a generated
  2077. * keypair.
  2078. *
  2079. * If the callback is unset, an appropriate curve will be chosen automatically.
  2080. * (This is recommended.)
  2081. *
  2082. * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
  2083. * |callback| must save and release the object elsewhere. */
  2084. OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
  2085. SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
  2086. typedef void COMP_METHOD;
  2087. /* SSL_get_current_compression returns NULL. */
  2088. OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
  2089. /* SSL_get_current_expansion returns NULL. */
  2090. OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
  2091. OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
  2092. OPENSSL_EXPORT int SSL_is_server(SSL *s);
  2093. /* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
  2094. * resumption decision for a ClientHello has been made. It can return 1 to
  2095. * allow the handshake to continue or zero to cause the handshake to abort. */
  2096. OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
  2097. SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
  2098. /* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
  2099. * SSL_SESSION structures so that a test can ensure that outside code agrees on
  2100. * these values. */
  2101. OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
  2102. size_t *ssl_ctx_size,
  2103. size_t *ssl_session_size);
  2104. OPENSSL_EXPORT void ERR_load_SSL_strings(void);
  2105. /* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
  2106. * the read and write directions. It returns one on success or zero if |ssl|
  2107. * isn't using an RC4-based cipher suite. */
  2108. OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
  2109. const RC4_KEY **write_key);
  2110. /* Deprecated functions. */
  2111. /* SSL_CIPHER_description writes a description of |cipher| into |buf| and
  2112. * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
  2113. * freed with |OPENSSL_free|, or NULL on error.
  2114. *
  2115. * The description includes a trailing newline and has the form:
  2116. * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
  2117. *
  2118. * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
  2119. OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
  2120. char *buf, int len);
  2121. /* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
  2122. OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
  2123. /* SSL_COMP_get_compression_methods returns NULL. */
  2124. OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
  2125. /* SSL_COMP_add_compression_method returns one. */
  2126. OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
  2127. /* SSL_COMP_get_name returns NULL. */
  2128. OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
  2129. /* SSLv23_method calls |TLS_method|. */
  2130. OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
  2131. /* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
  2132. * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
  2133. * to lock connections to that protocol version. */
  2134. OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
  2135. OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
  2136. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
  2137. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
  2138. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
  2139. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
  2140. /* Client- and server-specific methods call their corresponding generic
  2141. * methods. */
  2142. OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
  2143. OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
  2144. OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
  2145. OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
  2146. OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
  2147. OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
  2148. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
  2149. OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
  2150. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
  2151. OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
  2152. OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
  2153. OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
  2154. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
  2155. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
  2156. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
  2157. OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
  2158. /* SSL_clear resets |ssl| to allow another connection and returns one on success
  2159. * or zero on failure. It returns most configuration state but releases memory
  2160. * associated with the current connection.
  2161. *
  2162. * Free |ssl| and create a new one instead. */
  2163. OPENSSL_EXPORT int SSL_clear(SSL *ssl);
  2164. /* SSL_CTX_set_tmp_rsa_callback does nothing. */
  2165. OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
  2166. SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
  2167. /* SSL_set_tmp_rsa_callback does nothing. */
  2168. OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
  2169. RSA *(*cb)(SSL *ssl, int is_export,
  2170. int keylength));
  2171. /* SSL_CTX_sess_connect returns zero. */
  2172. OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
  2173. /* SSL_CTX_sess_connect_good returns zero. */
  2174. OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
  2175. /* SSL_CTX_sess_connect_renegotiate returns zero. */
  2176. OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
  2177. /* SSL_CTX_sess_accept returns zero. */
  2178. OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
  2179. /* SSL_CTX_sess_accept_renegotiate returns zero. */
  2180. OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
  2181. /* SSL_CTX_sess_accept_good returns zero. */
  2182. OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
  2183. /* SSL_CTX_sess_hits returns zero. */
  2184. OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
  2185. /* SSL_CTX_sess_cb_hits returns zero. */
  2186. OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
  2187. /* SSL_CTX_sess_misses returns zero. */
  2188. OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
  2189. /* SSL_CTX_sess_timeouts returns zero. */
  2190. OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
  2191. /* SSL_CTX_sess_cache_full returns zero. */
  2192. OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
  2193. /* SSL_cutthrough_complete calls |SSL_in_false_start|. */
  2194. OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
  2195. /* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
  2196. OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
  2197. /* SSL_CTX_need_tmp_RSA returns zero. */
  2198. OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
  2199. /* SSL_need_tmp_RSA returns zero. */
  2200. OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
  2201. /* SSL_CTX_set_tmp_rsa returns one. */
  2202. OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
  2203. /* SSL_set_tmp_rsa returns one. */
  2204. OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
  2205. /* SSL_CTX_get_read_ahead returns zero. */
  2206. OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
  2207. /* SSL_CTX_set_read_ahead does nothing. */
  2208. OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
  2209. /* SSL_get_read_ahead returns zero. */
  2210. OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
  2211. /* SSL_set_read_ahead does nothing. */
  2212. OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
  2213. /* SSL_renegotiate put an error on the error queue and returns zero. */
  2214. OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
  2215. /* SSL_set_state does nothing. */
  2216. OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
  2217. /* Android compatibility section.
  2218. *
  2219. * These functions are declared, temporarily, for Android because
  2220. * wpa_supplicant will take a little time to sync with upstream. Outside of
  2221. * Android they'll have no definition. */
  2222. #define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
  2223. OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
  2224. int ext_len);
  2225. OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
  2226. OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
  2227. OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
  2228. #define OPENSSL_VERSION_TEXT "BoringSSL"
  2229. #define SSLEAY_VERSION 0
  2230. /* SSLeay_version is a compatibility function that returns the string
  2231. * "BoringSSL". */
  2232. OPENSSL_EXPORT const char *SSLeay_version(int unused);
  2233. /* Preprocessor compatibility section.
  2234. *
  2235. * Historically, a number of APIs were implemented in OpenSSL as macros and
  2236. * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
  2237. * section defines a number of legacy macros.
  2238. *
  2239. * Although using either the CTRL values or their wrapper macros in #ifdefs is
  2240. * still supported, the CTRL values may not be passed to |SSL_ctrl| and
  2241. * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
  2242. #define DTLS_CTRL_GET_TIMEOUT doesnt_exist
  2243. #define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
  2244. #define SSL_CTRL_CHAIN doesnt_exist
  2245. #define SSL_CTRL_CHAIN_CERT doesnt_exist
  2246. #define SSL_CTRL_CHANNEL_ID doesnt_exist
  2247. #define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
  2248. #define SSL_CTRL_CLEAR_MODE doesnt_exist
  2249. #define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
  2250. #define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
  2251. #define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
  2252. #define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
  2253. #define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
  2254. #define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
  2255. #define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
  2256. #define SSL_CTRL_GET_READ_AHEAD doesnt_exist
  2257. #define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
  2258. #define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
  2259. #define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
  2260. #define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
  2261. #define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
  2262. #define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
  2263. #define SSL_CTRL_MODE doesnt_exist
  2264. #define SSL_CTRL_NEED_TMP_RSA doesnt_exist
  2265. #define SSL_CTRL_OPTIONS doesnt_exist
  2266. #define SSL_CTRL_SESS_NUMBER doesnt_exist
  2267. #define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
  2268. #define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
  2269. #define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
  2270. #define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
  2271. #define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
  2272. #define SSL_CTRL_SET_MTU doesnt_exist
  2273. #define SSL_CTRL_SET_READ_AHEAD doesnt_exist
  2274. #define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
  2275. #define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
  2276. #define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
  2277. #define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
  2278. #define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
  2279. #define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
  2280. #define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
  2281. #define SSL_CTRL_SET_TMP_DH doesnt_exist
  2282. #define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
  2283. #define SSL_CTRL_SET_TMP_ECDH doesnt_exist
  2284. #define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
  2285. #define SSL_CTRL_SET_TMP_RSA doesnt_exist
  2286. #define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
  2287. #define DTLSv1_get_timeout DTLSv1_get_timeout
  2288. #define DTLSv1_handle_timeout DTLSv1_handle_timeout
  2289. #define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
  2290. #define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
  2291. #define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
  2292. #define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
  2293. #define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
  2294. #define SSL_CTX_clear_mode SSL_CTX_clear_mode
  2295. #define SSL_CTX_clear_options SSL_CTX_clear_options
  2296. #define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
  2297. #define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
  2298. #define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
  2299. #define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
  2300. #define SSL_CTX_get_mode SSL_CTX_get_mode
  2301. #define SSL_CTX_get_options SSL_CTX_get_options
  2302. #define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
  2303. #define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
  2304. #define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
  2305. #define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
  2306. #define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
  2307. #define SSL_CTX_sess_number SSL_CTX_sess_number
  2308. #define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
  2309. #define SSL_CTX_set0_chain SSL_CTX_set0_chain
  2310. #define SSL_CTX_set1_chain SSL_CTX_set1_chain
  2311. #define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
  2312. #define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
  2313. #define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
  2314. #define SSL_CTX_set_mode SSL_CTX_set_mode
  2315. #define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
  2316. #define SSL_CTX_set_options SSL_CTX_set_options
  2317. #define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
  2318. #define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
  2319. #define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
  2320. #define SSL_CTX_set_tlsext_servername_callback \
  2321. SSL_CTX_set_tlsext_servername_callback
  2322. #define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
  2323. #define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
  2324. #define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
  2325. #define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
  2326. #define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
  2327. #define SSL_add0_chain_cert SSL_add0_chain_cert
  2328. #define SSL_add1_chain_cert SSL_add1_chain_cert
  2329. #define SSL_clear_chain_certs SSL_clear_chain_certs
  2330. #define SSL_clear_mode SSL_clear_mode
  2331. #define SSL_clear_options SSL_clear_options
  2332. #define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
  2333. #define SSL_get0_chain_certs SSL_get0_chain_certs
  2334. #define SSL_get_max_cert_list SSL_get_max_cert_list
  2335. #define SSL_get_mode SSL_get_mode
  2336. #define SSL_get_options SSL_get_options
  2337. #define SSL_get_secure_renegotiation_support \
  2338. SSL_get_secure_renegotiation_support
  2339. #define SSL_get_tls_channel_id SSL_get_tls_channel_id
  2340. #define SSL_need_tmp_RSA SSL_need_tmp_RSA
  2341. #define SSL_num_renegotiations SSL_num_renegotiations
  2342. #define SSL_session_reused SSL_session_reused
  2343. #define SSL_set0_chain SSL_set0_chain
  2344. #define SSL_set1_chain SSL_set1_chain
  2345. #define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
  2346. #define SSL_set_max_cert_list SSL_set_max_cert_list
  2347. #define SSL_set_max_send_fragment SSL_set_max_send_fragment
  2348. #define SSL_set_mode SSL_set_mode
  2349. #define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
  2350. #define SSL_set_mtu SSL_set_mtu
  2351. #define SSL_set_options SSL_set_options
  2352. #define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
  2353. #define SSL_set_tmp_dh SSL_set_tmp_dh
  2354. #define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
  2355. #define SSL_set_tmp_rsa SSL_set_tmp_rsa
  2356. #define SSL_total_renegotiations SSL_total_renegotiations
  2357. #if defined(__cplusplus)
  2358. } /* extern C */
  2359. #endif
  2360. /* Library consumers assume these headers are included by ssl.h, but they depend
  2361. * on ssl.h, so include them after all declarations.
  2362. *
  2363. * TODO(davidben): The separation between ssl.h and these version-specific
  2364. * headers introduces circular dependencies and is inconsistent. The function
  2365. * declarations should move to ssl.h. Many of the constants can probably be
  2366. * pruned or unexported. */
  2367. #include <openssl/ssl3.h>
  2368. #include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
  2369. #include <openssl/srtp.h> /* Support for the use_srtp extension */
  2370. /* BEGIN ERROR CODES */
  2371. /* The following lines are auto generated by the script make_errors.go. Any
  2372. * changes made after this point may be overwritten when the script is next run.
  2373. */
  2374. #define SSL_R_APP_DATA_IN_HANDSHAKE 100
  2375. #define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
  2376. #define SSL_R_BAD_ALERT 102
  2377. #define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
  2378. #define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
  2379. #define SSL_R_BAD_DH_P_LENGTH 105
  2380. #define SSL_R_BAD_DIGEST_LENGTH 106
  2381. #define SSL_R_BAD_ECC_CERT 107
  2382. #define SSL_R_BAD_ECPOINT 108
  2383. #define SSL_R_BAD_HANDSHAKE_LENGTH 109
  2384. #define SSL_R_BAD_HANDSHAKE_RECORD 110
  2385. #define SSL_R_BAD_HELLO_REQUEST 111
  2386. #define SSL_R_BAD_LENGTH 112
  2387. #define SSL_R_BAD_PACKET_LENGTH 113
  2388. #define SSL_R_BAD_RSA_ENCRYPT 114
  2389. #define SSL_R_BAD_SIGNATURE 115
  2390. #define SSL_R_BAD_SRTP_MKI_VALUE 116
  2391. #define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
  2392. #define SSL_R_BAD_SSL_FILETYPE 118
  2393. #define SSL_R_BAD_WRITE_RETRY 119
  2394. #define SSL_R_BIO_NOT_SET 120
  2395. #define SSL_R_BN_LIB 121
  2396. #define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
  2397. #define SSL_R_CA_DN_LENGTH_MISMATCH 123
  2398. #define SSL_R_CA_DN_TOO_LONG 124
  2399. #define SSL_R_CCS_RECEIVED_EARLY 125
  2400. #define SSL_R_CERTIFICATE_VERIFY_FAILED 126
  2401. #define SSL_R_CERT_CB_ERROR 127
  2402. #define SSL_R_CERT_LENGTH_MISMATCH 128
  2403. #define SSL_R_CHANNEL_ID_NOT_P256 129
  2404. #define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
  2405. #define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
  2406. #define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
  2407. #define SSL_R_CLIENTHELLO_PARSE_FAILED 133
  2408. #define SSL_R_CLIENTHELLO_TLSEXT 134
  2409. #define SSL_R_CONNECTION_REJECTED 135
  2410. #define SSL_R_CONNECTION_TYPE_NOT_SET 136
  2411. #define SSL_R_COOKIE_MISMATCH 137
  2412. #define SSL_R_D2I_ECDSA_SIG 138
  2413. #define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
  2414. #define SSL_R_DATA_LENGTH_TOO_LONG 140
  2415. #define SSL_R_DECODE_ERROR 141
  2416. #define SSL_R_DECRYPTION_FAILED 142
  2417. #define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
  2418. #define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
  2419. #define SSL_R_DIGEST_CHECK_FAILED 145
  2420. #define SSL_R_DTLS_MESSAGE_TOO_BIG 146
  2421. #define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
  2422. #define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
  2423. #define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
  2424. #define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
  2425. #define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
  2426. #define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
  2427. #define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
  2428. #define SSL_R_EXTRA_DATA_IN_MESSAGE 154
  2429. #define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
  2430. #define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
  2431. #define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
  2432. #define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
  2433. #define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
  2434. #define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
  2435. #define SSL_R_HTTPS_PROXY_REQUEST 161
  2436. #define SSL_R_HTTP_REQUEST 162
  2437. #define SSL_R_INAPPROPRIATE_FALLBACK 163
  2438. #define SSL_R_INVALID_COMMAND 164
  2439. #define SSL_R_INVALID_MESSAGE 165
  2440. #define SSL_R_INVALID_SSL_SESSION 166
  2441. #define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
  2442. #define SSL_R_LENGTH_MISMATCH 168
  2443. #define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
  2444. #define SSL_R_MISSING_DH_KEY 170
  2445. #define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
  2446. #define SSL_R_MISSING_RSA_CERTIFICATE 172
  2447. #define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
  2448. #define SSL_R_MISSING_RSA_SIGNING_CERT 174
  2449. #define SSL_R_MISSING_TMP_DH_KEY 175
  2450. #define SSL_R_MISSING_TMP_ECDH_KEY 176
  2451. #define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
  2452. #define SSL_R_MTU_TOO_SMALL 178
  2453. #define SSL_R_NESTED_GROUP 179
  2454. #define SSL_R_NO_CERTIFICATES_RETURNED 180
  2455. #define SSL_R_NO_CERTIFICATE_ASSIGNED 181
  2456. #define SSL_R_NO_CERTIFICATE_SET 182
  2457. #define SSL_R_NO_CIPHERS_AVAILABLE 183
  2458. #define SSL_R_NO_CIPHERS_PASSED 184
  2459. #define SSL_R_NO_CIPHERS_SPECIFIED 185
  2460. #define SSL_R_NO_CIPHER_MATCH 186
  2461. #define SSL_R_NO_COMPRESSION_SPECIFIED 187
  2462. #define SSL_R_NO_METHOD_SPECIFIED 188
  2463. #define SSL_R_NO_P256_SUPPORT 189
  2464. #define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
  2465. #define SSL_R_NO_RENEGOTIATION 191
  2466. #define SSL_R_NO_REQUIRED_DIGEST 192
  2467. #define SSL_R_NO_SHARED_CIPHER 193
  2468. #define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
  2469. #define SSL_R_NO_SRTP_PROFILES 195
  2470. #define SSL_R_NULL_SSL_CTX 196
  2471. #define SSL_R_NULL_SSL_METHOD_PASSED 197
  2472. #define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
  2473. #define SSL_R_PACKET_LENGTH_TOO_LONG 199
  2474. #define SSL_R_PARSE_TLSEXT 200
  2475. #define SSL_R_PATH_TOO_LONG 201
  2476. #define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
  2477. #define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
  2478. #define SSL_R_PROTOCOL_IS_SHUTDOWN 204
  2479. #define SSL_R_PSK_IDENTITY_NOT_FOUND 205
  2480. #define SSL_R_PSK_NO_CLIENT_CB 206
  2481. #define SSL_R_PSK_NO_SERVER_CB 207
  2482. #define SSL_R_READ_BIO_NOT_SET 208
  2483. #define SSL_R_READ_TIMEOUT_EXPIRED 209
  2484. #define SSL_R_RECORD_LENGTH_MISMATCH 210
  2485. #define SSL_R_RECORD_TOO_LARGE 211
  2486. #define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
  2487. #define SSL_R_RENEGOTIATION_ENCODING_ERR 213
  2488. #define SSL_R_RENEGOTIATION_MISMATCH 214
  2489. #define SSL_R_REQUIRED_CIPHER_MISSING 215
  2490. #define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
  2491. #define SSL_R_SERVERHELLO_TLSEXT 217
  2492. #define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
  2493. #define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
  2494. #define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
  2495. #define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
  2496. #define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
  2497. #define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
  2498. #define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
  2499. #define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
  2500. #define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
  2501. #define SSL_R_SSL_HANDSHAKE_FAILURE 227
  2502. #define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
  2503. #define SSL_R_SSL_SESSION_ID_CONFLICT 229
  2504. #define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
  2505. #define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
  2506. #define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
  2507. #define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
  2508. #define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
  2509. #define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
  2510. #define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
  2511. #define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
  2512. #define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
  2513. #define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
  2514. #define SSL_R_UNEXPECTED_GROUP_CLOSE 240
  2515. #define SSL_R_UNEXPECTED_MESSAGE 241
  2516. #define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
  2517. #define SSL_R_UNEXPECTED_RECORD 243
  2518. #define SSL_R_UNINITIALIZED 244
  2519. #define SSL_R_UNKNOWN_ALERT_TYPE 245
  2520. #define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
  2521. #define SSL_R_UNKNOWN_CIPHER_RETURNED 247
  2522. #define SSL_R_UNKNOWN_CIPHER_TYPE 248
  2523. #define SSL_R_UNKNOWN_DIGEST 249
  2524. #define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
  2525. #define SSL_R_UNKNOWN_PROTOCOL 251
  2526. #define SSL_R_UNKNOWN_SSL_VERSION 252
  2527. #define SSL_R_UNKNOWN_STATE 253
  2528. #define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
  2529. #define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
  2530. #define SSL_R_UNSUPPORTED_CIPHER 256
  2531. #define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
  2532. #define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
  2533. #define SSL_R_UNSUPPORTED_PROTOCOL 259
  2534. #define SSL_R_UNSUPPORTED_SSL_VERSION 260
  2535. #define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
  2536. #define SSL_R_WRONG_CERTIFICATE_TYPE 262
  2537. #define SSL_R_WRONG_CIPHER_RETURNED 263
  2538. #define SSL_R_WRONG_CURVE 264
  2539. #define SSL_R_WRONG_MESSAGE_TYPE 265
  2540. #define SSL_R_WRONG_SIGNATURE_TYPE 266
  2541. #define SSL_R_WRONG_SSL_VERSION 267
  2542. #define SSL_R_WRONG_VERSION_NUMBER 268
  2543. #define SSL_R_X509_LIB 269
  2544. #define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
  2545. #define SSL_R_FRAGMENT_MISMATCH 271
  2546. #define SSL_R_BUFFER_TOO_SMALL 272
  2547. #define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
  2548. #define SSL_R_OUTPUT_ALIASES_INPUT 274
  2549. #define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
  2550. #define SSL_R_EMS_STATE_INCONSISTENT 276
  2551. #define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
  2552. #define SSL_R_TOO_MANY_WARNING_ALERTS 278
  2553. #define SSL_R_UNEXPECTED_EXTENSION 279
  2554. #define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
  2555. #define SSL_R_ERROR_ADDING_EXTENSION 281
  2556. #define SSL_R_ERROR_PARSING_EXTENSION 282
  2557. #define SSL_R_MISSING_EXTENSION 283
  2558. #define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
  2559. #define SSL_R_CUSTOM_EXTENSION_ERROR 285
  2560. #define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
  2561. #define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
  2562. #define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
  2563. #define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
  2564. #define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
  2565. #define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
  2566. #define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
  2567. #define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
  2568. #define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
  2569. #define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
  2570. #define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
  2571. #define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
  2572. #define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
  2573. #define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
  2574. #define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
  2575. #define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
  2576. #define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
  2577. #define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
  2578. #define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
  2579. #define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
  2580. #define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
  2581. #define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
  2582. #define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
  2583. #define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
  2584. #define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
  2585. #define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
  2586. #define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
  2587. #define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
  2588. #define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
  2589. #define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
  2590. #endif /* OPENSSL_HEADER_SSL_H */