blob: 7a30d551b6aa1cfa8480de66c75654b459f55e13 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* 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.
Adam Langleyb4a494c2015-01-23 15:10:10 -08008 *
Adam Langley95c29f32014-06-20 12:00:00 -07009 * 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).
Adam Langleyb4a494c2015-01-23 15:10:10 -080015 *
Adam Langley95c29f32014-06-20 12:00:00 -070016 * 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.
Adam Langleyb4a494c2015-01-23 15:10:10 -080022 *
Adam Langley95c29f32014-06-20 12:00:00 -070023 * 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 :-).
Adam Langleyb4a494c2015-01-23 15:10:10 -080037 * 4. If you include any Windows specific code (or a derivative thereof) from
Adam Langley95c29f32014-06-20 12:00:00 -070038 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
Adam Langleyb4a494c2015-01-23 15:10:10 -080040 *
Adam Langley95c29f32014-06-20 12:00:00 -070041 * 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.
Adam Langleyb4a494c2015-01-23 15:10:10 -080052 *
Adam Langley95c29f32014-06-20 12:00:00 -070053 * 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
Adam Langleyb4a494c2015-01-23 15:10:10 -080066 * notice, this list of conditions and the following disclaimer.
Adam Langley95c29f32014-06-20 12:00:00 -070067 *
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.
Adam Langleyb4a494c2015-01-23 15:10:10 -0800113 * ECC cipher suite support in OpenSSL originally developed by
Adam Langley95c29f32014-06-20 12:00:00 -0700114 * 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
David Benjamin087e4fa2015-04-08 23:46:10 -0400143#ifndef OPENSSL_HEADER_SSL_H
144#define OPENSSL_HEADER_SSL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146#include <openssl/base.h>
147
148#include <openssl/bio.h>
149#include <openssl/buf.h>
150#include <openssl/hmac.h>
151#include <openssl/lhash.h>
152#include <openssl/pem.h>
Adam Langley0b5e3902015-05-15 13:08:38 -0700153#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700154#include <openssl/x509.h>
155
David Benjamin2e749e82015-04-07 23:20:51 -0400156#if !defined(OPENSSL_WINDOWS)
157#include <sys/time.h>
158#endif
159
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700160/* wpa_supplicant expects to get the version functions from ssl.h */
161#include <openssl/crypto.h>
162
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400163/* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
164 * Windows headers define too many macros to be included in public headers.
165 * However, only a forward declaration is needed. */
166struct timeval;
167
David Benjamin087e4fa2015-04-08 23:46:10 -0400168#if defined(__cplusplus)
Adam Langley95c29f32014-06-20 12:00:00 -0700169extern "C" {
170#endif
171
172
David Benjamin0d8a7582015-04-08 23:55:15 -0400173/* SSL implementation. */
174
175
David Benjamin71f07942015-04-08 02:36:59 -0400176/* Initialization. */
177
178/* SSL_library_init initializes the crypto and SSL libraries and returns one. */
179OPENSSL_EXPORT int SSL_library_init(void);
180
181
182/* Cipher suites. */
183
184/* An SSL_CIPHER represents a cipher suite. */
185typedef struct ssl_cipher_st {
186 /* name is the OpenSSL name for the cipher. */
187 const char *name;
188 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
189 uint32_t id;
190
191 /* The following are internal fields. See ssl/internal.h for their values. */
192
193 uint32_t algorithm_mkey;
194 uint32_t algorithm_auth;
195 uint32_t algorithm_enc;
196 uint32_t algorithm_mac;
197 uint32_t algorithm_ssl;
198 uint32_t algo_strength;
David Benjamin5055c762015-08-04 09:24:14 -0400199 uint32_t algorithm_prf;
David Benjamin71f07942015-04-08 02:36:59 -0400200
201 /* strength_bits is the strength of the cipher in bits. */
202 int strength_bits;
203 /* alg_bits is the number of bits of key material used by the algorithm. */
204 int alg_bits;
205} SSL_CIPHER;
206
207DECLARE_STACK_OF(SSL_CIPHER)
208
209/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
210 * suite based on its assigned number, or NULL if unknown. See
211 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
212OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
213
214/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
215 * get the cipher suite value. */
216OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
217
218/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
219 * mode). */
220OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
221
222/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
223OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
224
225/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
226OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
227
228/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
229 * CHACHA20_POLY1305. */
230OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
231
232/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
233OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
234
235/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
236 * method used by |cipher|. For example, "ECDHE_ECDSA". */
237OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
238
239/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
David Benjamin3fa65f02015-05-15 19:11:57 -0400240 * name for |cipher| or NULL on error. For example,
241 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
242 * calling |OPENSSL_free| on the result. */
David Benjamin71f07942015-04-08 02:36:59 -0400243OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
244
245/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
246 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
247 * symmetric algorithm to |*out_alg_bits|. */
248OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
249 int *out_alg_bits);
250
251
David Benjamin4831c332015-05-16 11:43:13 -0400252/* SSL contexts. */
253
254/* An SSL_METHOD selects whether to use TLS or DTLS. */
255typedef struct ssl_method_st SSL_METHOD;
256
257/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
258OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
259
260/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
261OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
262
263/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
264 * on error. An |SSL_CTX| manages shared state and configuration between
265 * multiple TLS or DTLS connections. */
266OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
267
268/* SSL_CTX_free releases memory associated with |ctx|. */
269OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
270
271
272/* SSL connections. */
273
274/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
275 * |SSL| object represents a single TLS or DTLS connection. It inherits settings
276 * from |ctx| at the time of creation. Settings may also be individually
277 * configured on the connection.
278 *
279 * On creation, an |SSL| is not configured to be either a client or server. Call
280 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
281OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
282
283/* SSL_free releases memory associated with |ssl|. */
284OPENSSL_EXPORT void SSL_free(SSL *ssl);
285
286/* SSL_set_connect_state configures |ssl| to be a client. */
287OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
288
289/* SSL_set_accept_state configures |ssl| to be a server. */
290OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
291
292
David Benjaminb487df62015-05-16 15:31:07 -0400293/* Protocol versions. */
294
295#define SSL3_VERSION_MAJOR 0x03
296
297#define SSL3_VERSION 0x0300
298#define TLS1_VERSION 0x0301
299#define TLS1_1_VERSION 0x0302
300#define TLS1_2_VERSION 0x0303
301
302#define DTLS1_VERSION 0xfeff
303#define DTLS1_2_VERSION 0xfefd
304
305/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
306 * |version|. */
307OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
308
309/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
310 * |version|. */
311OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
312
313/* SSL_set_min_version sets the minimum protocol version for |ssl| to
314 * |version|. */
315OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
316
317/* SSL_set_max_version sets the maximum protocol version for |ssl| to
318 * |version|. */
319OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
320
321
322/* Options.
323 *
324 * Options configure protocol behavior. */
325
326/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
327 * support the renegotiation_info extension (RFC 5746). It is on by default. */
328#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
329
330/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
331 * bytes above the maximum record size. */
332#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
333
334/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
335 * (i.e. without a length prefix). */
336#define SSL_OP_TLS_D5_BUG 0x00000100L
337
338/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
339 * consumers.
340 * TODO(davidben): Determine which of the remaining may be removed now. */
341#define SSL_OP_ALL 0x00000BFFL
342
343/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
344 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
345#define SSL_OP_NO_QUERY_MTU 0x00001000L
346
347/* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
348#define SSL_OP_NO_TICKET 0x00004000L
349
David Benjaminb487df62015-05-16 15:31:07 -0400350/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
351 * ECDHE curves according to the server's preferences instead of the
352 * client's. */
353#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
354
355/* The following flags toggle individual protocol versions. This is deprecated.
356 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
357#define SSL_OP_NO_SSLv3 0x02000000L
358#define SSL_OP_NO_TLSv1 0x04000000L
359#define SSL_OP_NO_TLSv1_2 0x08000000L
360#define SSL_OP_NO_TLSv1_1 0x10000000L
361#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
362#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
363
364/* The following flags do nothing and are included only to make it easier to
365 * compile code with BoringSSL. */
Matt Braithwaite45b03022015-08-05 17:17:57 -0700366#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
David Benjaminb487df62015-05-16 15:31:07 -0400367#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700368#define SSL_OP_EPHEMERAL_RSA 0
David Benjaminb487df62015-05-16 15:31:07 -0400369#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700370#define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
371#define SSL_OP_NETSCAPE_CA_DN_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400372#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700373#define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
374#define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400375#define SSL_OP_NO_COMPRESSION 0
376#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
377#define SSL_OP_NO_SSLv2 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700378#define SSL_OP_PKCS1_CHECK_1 0
379#define SSL_OP_PKCS1_CHECK_2 0
David Benjaminb487df62015-05-16 15:31:07 -0400380#define SSL_OP_SINGLE_DH_USE 0
381#define SSL_OP_SINGLE_ECDH_USE 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700382#define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400383#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
384#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
385#define SSL_OP_TLS_ROLLBACK_BUG 0
386
387/* SSL_CTX_set_options enables all options set in |options| (which should be one
388 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
389 * bitmask representing the resulting enabled options. */
390OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
391
392/* SSL_CTX_clear_options disables all options set in |options| (which should be
393 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
394 * bitmask representing the resulting enabled options. */
395OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
396
397/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
398 * the options enabled for |ctx|. */
399OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
400
401/* SSL_set_options enables all options set in |options| (which should be one or
402 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
403 * representing the resulting enabled options. */
404OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
405
406/* SSL_clear_options disables all options set in |options| (which should be one
407 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
408 * bitmask representing the resulting enabled options. */
409OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
410
411/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
412 * options enabled for |ssl|. */
413OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
414
415
416/* Modes.
417 *
418 * Modes configure API behavior. */
419
420/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
421 * result when the only part of the input was written in a single record. */
422#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
423
424/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
425 * with a different buffer. However, |SSL_write| still assumes the buffer
426 * contents are unchanged. This is not the default to avoid the misconception
427 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
428#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
429
430/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
431 * before sending certificates to the peer.
432 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
433#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
434
David Benjaminb487df62015-05-16 15:31:07 -0400435/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
436 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
437 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
438#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
439
440/* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
441 * SSL_MODE_ENABLE_FALSE_START. */
442#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
443
444/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
445 * TLS 1.0 to be split in two: the first record will contain a single byte and
446 * the second will contain the remainder. This effectively randomises the IV and
447 * prevents BEAST attacks. */
448#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
449
450/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
451 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
452 * session resumption is used for a given SSL*. */
453#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
454
455/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
456 * To be set only by applications that reconnect with a downgraded protocol
David Benjamin229adfb2015-07-25 15:08:18 -0400457 * version; see RFC 7507 for details.
David Benjaminb487df62015-05-16 15:31:07 -0400458 *
459 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
David Benjamin229adfb2015-07-25 15:08:18 -0400460 * this in explicit fallback retries, following the guidance in RFC 7507. */
David Benjaminb487df62015-05-16 15:31:07 -0400461#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
462
463/* The following flags do nothing and are included only to make it easier to
464 * compile code with BoringSSL. */
465#define SSL_MODE_AUTO_RETRY 0
466#define SSL_MODE_RELEASE_BUFFERS 0
David Benjamin74d8bc22015-05-21 02:16:53 -0400467#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
468#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjaminb487df62015-05-16 15:31:07 -0400469
470/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
471 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
472 * representing the resulting enabled modes. */
473OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
474
475/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
476 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
477 * bitmask representing the resulting enabled modes. */
478OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
479
480/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
481 * the modes enabled for |ssl|. */
482OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
483
484/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
485 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
486 * representing the resulting enabled modes. */
487OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
488
489/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
490 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
491 * representing the resulting enabled modes. */
492OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
493
494/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
495 * modes enabled for |ssl|. */
496OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
497
498
David Benjaminb4d65fd2015-05-29 17:11:21 -0400499/* Configuring certificates and private keys.
500 *
David Benjamin11c0f8e2015-07-06 00:18:15 -0400501 * These functions configure the connection's leaf certificate, private key, and
502 * certificate chain. The certificate chain is ordered leaf to root (as sent on
503 * the wire) but does not include the leaf. Both client and server certificates
504 * use these functions.
505 *
506 * Certificates and keys may be configured before the handshake or dynamically
507 * in the early callback and certificate callback. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400508
David Benjamin7481d392015-07-05 19:38:46 -0400509/* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
510 * one on success and zero on failure. */
511OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
512
513/* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
514 * on success and zero on failure. */
515OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
516
517/* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
518 * success and zero on failure. */
519OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
520
521/* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
522 * success and zero on failure. */
523OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
524
David Benjamin11c0f8e2015-07-06 00:18:15 -0400525/* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
526 * |chain|. On success, it returns one and takes ownership of |chain|.
527 * Otherwise, it returns zero. */
528OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
529
530/* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
531 * |chain|. It returns one on success and zero on failure. The caller retains
532 * ownership of |chain| and may release it freely. */
533OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
534
535/* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
536 * |chain|. On success, it returns one and takes ownership of |chain|.
537 * Otherwise, it returns zero. */
538OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
539
540/* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
541 * |chain|. It returns one on success and zero on failure. The caller retains
542 * ownership of |chain| and may release it freely. */
543OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
544
545/* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
546 * success, it returns one and takes ownership of |x509|. Otherwise, it returns
547 * zero. */
548OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
549
550/* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
551 * returns one on success and zero on failure. The caller retains ownership of
552 * |x509| and may release it freely. */
553OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
554
555/* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
556 * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
557OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
558
559/* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
560OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
561
562/* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
563 * one on success and zero on failure. The caller retains ownership of |x509|
564 * and may release it freely. */
565OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
566
567/* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
568 * one. */
569OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
570
571/* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
572OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
573
574/* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
575OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
576
David Benjamin7481d392015-07-05 19:38:46 -0400577/* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
578 * The callback returns one on success, zero on internal error, and a negative
579 * number on failure or to pause the handshake. If the handshake is paused,
580 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
581OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
582 int (*cb)(SSL *ssl, void *arg),
583 void *arg);
584
585/* SSL_set_cert_cb sets a callback that is called to select a certificate. The
586 * callback returns one on success, zero on internal error, and a negative
587 * number on failure or to pause the handshake. If the handshake is paused,
588 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
589OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
590 void *arg);
591
592/* SSL_certs_clear resets the private key, leaf certificate, and certificate
593 * chain of |ssl|. */
594OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
595
596/* SSL_CTX_check_private_key returns one if the certificate and private key
597 * configured in |ctx| are consistent and zero otherwise. */
598OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
599
600/* SSL_check_private_key returns one if the certificate and private key
601 * configured in |ssl| are consistent and zero otherwise. */
602OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
603
604/* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
605OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
606
607/* SSL_get_certificate returns |ssl|'s leaf certificate. */
608OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
609
David Benjamin11c0f8e2015-07-06 00:18:15 -0400610/* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
611OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
612
613/* SSL_get_privatekey returns |ssl|'s private key. */
614OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
615
616/* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
617 * returns one. */
618OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
619 STACK_OF(X509) **out_chain);
620
621/* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
622OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
623 STACK_OF(X509) **out_chain);
624
625/* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
626 * returns one. */
627OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
628 STACK_OF(X509) **out_chain);
629
David Benjamin7481d392015-07-05 19:38:46 -0400630
631/* Certificate and private key convenience functions. */
632
633/* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
634 * on success and zero on failure. */
635OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
636
637/* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
638 * success and zero on failure. */
639OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
640
641/* The following functions configure certificates or private keys but take as
642 * input DER-encoded structures. They return one on success and zero on
643 * failure. */
644
645OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
646 const uint8_t *d);
647OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
648 int len);
649
650OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
651 const uint8_t *d, long len);
652OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
653 const uint8_t *d, long len);
654
655OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
David Benjamin74f71102015-06-27 14:56:25 -0400656 const uint8_t *der,
657 size_t der_len);
658OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
659 size_t der_len);
David Benjamin7481d392015-07-05 19:38:46 -0400660
661/* The following functions configure certificates or private keys but take as
662 * input files to read from. They return one on success and zero on failure. The
663 * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
664 * the file's contents are read as PEM or DER. */
665
666#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
667#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
668
669OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
670 const char *file,
671 int type);
672OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
673 int type);
674
675OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
676 int type);
677OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
678 int type);
679
680OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
681 int type);
682OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
683 int type);
684
685/* SSL_CTX_use_certificate_file configures certificates for |ctx|. It reads the
686 * contents of |file| as a PEM-encoded leaf certificate followed optionally by
687 * the certificate chain to send to the peer. It returns one on success and zero
688 * on failure. */
689OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
690 const char *file);
691
692
693/* Custom private keys. */
694
David Benjaminb4d65fd2015-05-29 17:11:21 -0400695enum ssl_private_key_result_t {
696 ssl_private_key_success,
697 ssl_private_key_retry,
698 ssl_private_key_failure,
699};
700
701/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
702 * signing operations to a custom, potentially asynchronous, backend. */
703typedef struct ssl_private_key_method_st {
704 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
705 * key used by |ssl|. */
706 int (*type)(SSL *ssl);
707
708 /* supports_digest returns one if the key used by |ssl| supports signing
709 * digests of type |md| and zero otherwise. */
710 int (*supports_digest)(SSL *ssl, const EVP_MD *md);
711
712 /* max_signature_len returns the maximum length of a signature signed by the
713 * key used by |ssl|. This must be a constant value for a given |ssl|. */
714 size_t (*max_signature_len)(SSL *ssl);
715
716 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
717 * used to calculate |in|. On success, it returns |ssl_private_key_success|
718 * and writes at most |max_out| bytes of signature data to |out|. On failure,
719 * it returns |ssl_private_key_failure|. If the operation has not completed,
720 * it returns |ssl_private_key_retry|. |sign| should arrange for the
721 * high-level operation on |ssl| to be retried when the operation is
722 * completed. This will result in a call to |sign_complete|.
723 *
724 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
725 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
726 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
727 *
728 * It is an error to call |sign| while another private key operation is in
729 * progress on |ssl|. */
730 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
731 size_t max_out, const EVP_MD *md,
732 const uint8_t *in, size_t in_len);
733
734 /* sign_complete completes a pending |sign| operation. If the operation has
735 * completed, it returns |ssl_private_key_success| and writes the result to
736 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
737 * failure and |ssl_private_key_retry| if the operation is still in progress.
738 *
739 * |sign_complete| may be called arbitrarily many times before completion, but
740 * it is an error to call |sign_complete| if there is no pending |sign|
741 * operation in progress on |ssl|. */
742 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
743 size_t *out_len, size_t max_out);
744} SSL_PRIVATE_KEY_METHOD;
745
David Benjamind1d80782015-07-05 11:54:09 -0400746/* SSL_use_private_key_method configures a custom private key on |ssl|.
747 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400748OPENSSL_EXPORT void SSL_set_private_key_method(
749 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
750
751
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700752/* Connection information. */
753
754/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
755 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
756 * returns one on success or zero on error. In general |max_out| should be at
757 * least 12.
758 *
759 * This function will always fail if the initial handshake has not completed.
760 * The tls-unique value will change after a renegotiation but, since
761 * renegotiations can be initiated by the server at any point, the higher-level
762 * protocol must either leave them disabled or define states in which the
763 * tls-unique value can be read.
764 *
765 * The tls-unique value is defined by
766 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
767 * TLS protocol, tls-unique is broken for resumed connections unless the
768 * Extended Master Secret extension is negotiated. Thus this function will
769 * return zero if |ssl| performed session resumption unless EMS was used when
770 * negotiating the original session. */
771OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
772 size_t *out_len, size_t max_out);
773
774
Adam Langley09505632015-07-30 18:10:13 -0700775/* Custom extensions.
776 *
777 * The custom extension functions allow TLS extensions to be added to
778 * ClientHello and ServerHello messages. */
779
780/* SSL_custom_ext_add_cb is a callback function that is called when the
781 * ClientHello (for clients) or ServerHello (for servers) is constructed. In
782 * the case of a server, this callback will only be called for a given
783 * extension if the ClientHello contained that extension – it's not possible to
784 * inject extensions into a ServerHello that the client didn't request.
785 *
786 * When called, |extension_value| will contain the extension number that is
787 * being considered for addition (so that a single callback can handle multiple
788 * extensions). If the callback wishes to include the extension, it must set
789 * |*out| to point to |*out_len| bytes of extension contents and return one. In
790 * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
791 * called with the value of |*out| once that data has been copied.
792 *
793 * If the callback does not wish to add an extension it must return zero.
794 *
795 * Alternatively, the callback can abort the connection by setting
796 * |*out_alert_value| to a TLS alert number and returning -1. */
797typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
798 const uint8_t **out, size_t *out_len,
799 int *out_alert_value, void *add_arg);
800
801/* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
802 * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
803 * this callback is called and passed the |out| pointer that was returned by
804 * the add callback. This is to free any dynamically allocated data created by
805 * the add callback. */
806typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
807 const uint8_t *out, void *add_arg);
808
809/* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
810 * parse an extension from the peer: that is from the ServerHello for a client
811 * and from the ClientHello for a server.
812 *
813 * When called, |extension_value| will contain the extension number and the
814 * contents of the extension are |contents_len| bytes at |contents|.
815 *
816 * The callback must return one to continue the handshake. Otherwise, if it
817 * returns zero, a fatal alert with value |*out_alert_value| is sent and the
818 * handshake is aborted. */
819typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
820 const uint8_t *contents,
821 size_t contents_len,
822 int *out_alert_value, void *parse_arg);
823
824/* SSL_extension_supported returns one iff OpenSSL internally handles
825 * extensions of type |extension_value|. This can be used to avoid registering
826 * custom extension handlers for extensions that a future version of OpenSSL
827 * may handle internally. */
828OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
829
830/* SSL_CTX_add_client_custom_ext registers callback functions for handling
831 * custom TLS extensions for client connections.
832 *
833 * If |add_cb| is NULL then an empty extension will be added in each
834 * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
835 * this callback.
836 *
837 * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
838 * needs to be freed.
839 *
840 * It returns one on success or zero on error. It's always an error to register
841 * callbacks for the same extension twice, or to register callbacks for an
842 * extension that OpenSSL handles internally. See |SSL_extension_supported| to
843 * discover, at runtime, which extensions OpenSSL handles internally. */
844OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
845 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
846 SSL_custom_ext_free_cb free_cb, void *add_arg,
847 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
848
849/* SSL_CTX_add_server_custom_ext is the same as
850 * |SSL_CTX_add_client_custom_ext|, but for server connections.
851 *
852 * Unlike on the client side, if |add_cb| is NULL no extension will be added.
853 * The |add_cb|, if any, will only be called if the ClientHello contained a
854 * matching extension. */
855OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
856 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
857 SSL_custom_ext_free_cb free_cb, void *add_arg,
858 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
859
860
David Benjamindaeafc22015-06-25 17:35:11 -0400861/* Session tickets. */
862
863/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
864 * |len| bytes of |out|. It returns one on success and zero if |len| is not
865 * 48. If |out| is NULL, it returns 48 instead. */
866OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
867 size_t len);
868
869/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
870 * |len| bytes of |in|. It returns one on success and zero if |len| is not
871 * 48. If |in| is NULL, it returns 48 instead. */
872OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
873 size_t len);
874
David Benjamine3aa1d92015-06-16 15:34:50 -0400875/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
876 * ticket. */
877#define SSL_TICKET_KEY_NAME_LEN 16
878
David Benjamindaeafc22015-06-25 17:35:11 -0400879/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
880 * returns one. |callback| will be called when encrypting a new ticket and when
881 * decrypting a ticket from the client.
882 *
883 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
884 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
885 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
886 * for encryption or decryption, based on the mode.
887 *
888 * When encrypting a new ticket, |encrypt| will be one. It writes a public
889 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
890 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
891 * |callback| returns 1 on success and -1 on error.
892 *
893 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
894 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
895 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
896 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
897 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
898 * This may be used to re-key the ticket.
899 *
900 * WARNING: |callback| wildly breaks the usual return value convention and is
901 * called in two different modes. */
902OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
903 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
904 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
905 int encrypt));
906
907
David Benjamin71f07942015-04-08 02:36:59 -0400908/* Underdocumented functions.
909 *
910 * Functions below here haven't been touched up and may be underdocumented. */
911
Adam Langley95c29f32014-06-20 12:00:00 -0700912/* SSLeay version number for ASN.1 encoding of the session information */
913/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -0800914 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -0700915#define SSL_SESSION_ASN1_VERSION 0x0001
916
Adam Langleyb4a494c2015-01-23 15:10:10 -0800917#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
918#define SSL_MAX_SID_CTX_LENGTH 32
919#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -0700920
921/* These are used to specify which ciphers to use and not to use */
922
Adam Langleyb4a494c2015-01-23 15:10:10 -0800923#define SSL_TXT_MEDIUM "MEDIUM"
924#define SSL_TXT_HIGH "HIGH"
925#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -0700926
Adam Langleyb4a494c2015-01-23 15:10:10 -0800927#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -0400928#define SSL_TXT_kDHE "kDHE"
929#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
930#define SSL_TXT_kECDHE "kECDHE"
931#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800932#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700933
Adam Langleyb4a494c2015-01-23 15:10:10 -0800934#define SSL_TXT_aRSA "aRSA"
935#define SSL_TXT_aECDSA "aECDSA"
936#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700937
Adam Langleyb4a494c2015-01-23 15:10:10 -0800938#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400939#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400940#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800941#define SSL_TXT_RSA "RSA"
942#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400943#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400944#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800945#define SSL_TXT_ECDSA "ECDSA"
946#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700947
Adam Langleyb4a494c2015-01-23 15:10:10 -0800948#define SSL_TXT_3DES "3DES"
949#define SSL_TXT_RC4 "RC4"
950#define SSL_TXT_AES128 "AES128"
951#define SSL_TXT_AES256 "AES256"
952#define SSL_TXT_AES "AES"
953#define SSL_TXT_AES_GCM "AESGCM"
954#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -0700955
Adam Langleyb4a494c2015-01-23 15:10:10 -0800956#define SSL_TXT_MD5 "MD5"
957#define SSL_TXT_SHA1 "SHA1"
958#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
959#define SSL_TXT_SHA256 "SHA256"
960#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -0700961
Adam Langleyb4a494c2015-01-23 15:10:10 -0800962#define SSL_TXT_SSLV3 "SSLv3"
963#define SSL_TXT_TLSV1 "TLSv1"
964#define SSL_TXT_TLSV1_1 "TLSv1.1"
965#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -0700966
Adam Langleyb4a494c2015-01-23 15:10:10 -0800967#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -0700968
Adam Langleyb4a494c2015-01-23 15:10:10 -0800969/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
970 * normally not being used.
971 *
972 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
973 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
974 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
975 * that it is also disabled in the specific selection. COMPLEMENTOF*
976 * identifiers are portable between version, as adjustments to the default
977 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -0700978 *
979 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -0800980 * DEFAULT gets, as only selection is being done and no sorting as needed for
981 * DEFAULT. */
982#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -0700983
Adam Langleyb4a494c2015-01-23 15:10:10 -0800984/* The following cipher list is used by default. It also is substituted when an
985 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -0400986#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -0800987
Adam Langley95c29f32014-06-20 12:00:00 -0700988/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
989 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -0800990 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
991 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -0700992
993/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800994#define SSL_SENT_SHUTDOWN 1
995#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -0700996
David Benjamin82c9e902014-12-12 15:55:27 -0500997typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700998typedef struct ssl_session_st SSL_SESSION;
Adam Langley95c29f32014-06-20 12:00:00 -0700999typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -05001000typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07001001
Adam Langleyb4a494c2015-01-23 15:10:10 -08001002/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
1003typedef struct srtp_protection_profile_st {
1004 const char *name;
1005 unsigned long id;
1006} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -07001007
1008DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
1009
David Benjamin83fd6b62014-10-19 04:33:38 -04001010/* An SSL_SESSION represents an SSL session that may be resumed in an
1011 * abbreviated handshake. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001012struct ssl_session_st {
1013 int ssl_version; /* what ssl version session info is being kept in here? */
Adam Langley95c29f32014-06-20 12:00:00 -07001014
Adam Langleyb4a494c2015-01-23 15:10:10 -08001015 int master_key_length;
1016 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
1017 /* session_id - valid? */
1018 unsigned int session_id_length;
1019 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1020 /* this is used to determine whether the session is being reused in
1021 * the appropriate context. It is up to the application to set this,
1022 * via SSL_new */
1023 unsigned int sid_ctx_length;
1024 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001025
Adam Langleyb4a494c2015-01-23 15:10:10 -08001026 char *psk_identity;
1027 /* Used to indicate that session resumption is not allowed. Applications can
1028 * also set this bit for a new session via not_resumable_session_cb to
1029 * disable session caching and tickets. */
1030 int not_resumable;
Adam Langley95c29f32014-06-20 12:00:00 -07001031
David Benjamin680ca962015-06-18 12:37:23 -04001032 /* The cert is the certificate used to establish this connection
1033 *
1034 * TODO(davidben): Remove this field. It is not serialized as part of the
1035 * session, but some APIs access it. Certificate-related fields, where not
1036 * redundant with |peer|, should be added to the session. Others should
1037 * probably not be retained across resumptions. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001038 struct sess_cert_st /* SESS_CERT */ *sess_cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001039
Adam Langleyb4a494c2015-01-23 15:10:10 -08001040 /* This is the cert for the other end. On clients, it will be the same as
1041 * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is not
1042 * retained in the external representation of sessions, see ssl_asn1.c). */
1043 X509 *peer;
1044 /* when app_verify_callback accepts a session where the peer's certificate is
1045 * not ok, we must remember the error for session reuse: */
1046 long verify_result; /* only for servers */
Adam Langley95c29f32014-06-20 12:00:00 -07001047
Adam Langley0b5e3902015-05-15 13:08:38 -07001048 CRYPTO_refcount_t references;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001049 long timeout;
1050 long time;
Adam Langley95c29f32014-06-20 12:00:00 -07001051
Adam Langleyb4a494c2015-01-23 15:10:10 -08001052 const SSL_CIPHER *cipher;
Adam Langley95c29f32014-06-20 12:00:00 -07001053
Adam Langleyb4a494c2015-01-23 15:10:10 -08001054 CRYPTO_EX_DATA ex_data; /* application specific data */
Adam Langley95c29f32014-06-20 12:00:00 -07001055
Adam Langleyb4a494c2015-01-23 15:10:10 -08001056 /* These are used to make removal of session-ids more efficient and to
1057 * implement a maximum cache size. */
David Benjamin4dab2972015-05-16 02:56:06 -04001058 SSL_SESSION *prev, *next;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001059 char *tlsext_hostname;
1060 /* RFC4507 info */
1061 uint8_t *tlsext_tick; /* Session ticket */
1062 size_t tlsext_ticklen; /* Session ticket length */
1063 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
David Benjamin6c7aed02014-08-27 16:42:38 -04001064
Adam Langleyb4a494c2015-01-23 15:10:10 -08001065 size_t tlsext_signed_cert_timestamp_list_length;
1066 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001067
Adam Langleyb4a494c2015-01-23 15:10:10 -08001068 /* The OCSP response that came with the session. */
1069 size_t ocsp_response_length;
1070 uint8_t *ocsp_response;
David Benjamin6c7aed02014-08-27 16:42:38 -04001071
Adam Langleyb4a494c2015-01-23 15:10:10 -08001072 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
1073 uint8_t
1074 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
Adam Langley1258b6a2014-06-20 12:00:00 -07001075
Adam Langleyb4a494c2015-01-23 15:10:10 -08001076 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
1077 * SHA-2, depending on TLS version) for the original, full handshake that
1078 * created a session. This is used by Channel IDs during resumption. */
1079 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
1080 unsigned int original_handshake_hash_len;
Adam Langley75712922014-10-10 16:23:43 -07001081
Adam Langleyb4a494c2015-01-23 15:10:10 -08001082 /* extended_master_secret is true if the master secret in this session was
1083 * generated using EMS and thus isn't vulnerable to the Triple Handshake
1084 * attack. */
1085 char extended_master_secret;
1086};
Adam Langley95c29f32014-06-20 12:00:00 -07001087
Adam Langley95c29f32014-06-20 12:00:00 -07001088
David Benjamincb9cf792015-05-05 09:46:14 -04001089/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
1090 * and zero on failure. */
1091OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -07001092
David Benjamincb9cf792015-05-05 09:46:14 -04001093/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
1094 * renegotiation (RFC 5746) and zero otherwise. */
1095OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001096
David Benjamin59015c32015-04-26 13:13:55 -04001097/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
1098 * This callback will be called when sending or receiving low-level record
1099 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
1100 * |write_p| is one for outgoing messages and zero for incoming messages.
1101 *
1102 * For each record header, |cb| is called with |version| = 0 and |content_type|
1103 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
1104 * this does not include the record body. If the record is sealed, the length
1105 * in the header is the length of the ciphertext.
1106 *
1107 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
1108 * protocol version and |content_type| is the corresponding record type. The
1109 * |len| bytes from |buf| contain the handshake message, one-byte
1110 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001111OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
1112 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
1113 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001114
David Benjamin61ecccf2015-05-05 09:44:51 -04001115/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
1116 * callback. */
1117OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
1118
David Benjamin59015c32015-04-26 13:13:55 -04001119/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
1120 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001121OPENSSL_EXPORT void SSL_set_msg_callback(
1122 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
1123 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001124
David Benjamin3b7456e2015-05-16 12:29:32 -04001125/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -04001126OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07001127
David Benjamin859ec3c2014-09-02 16:29:36 -04001128/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -08001129 * log session material to |keylog_bio|. This is intended for debugging use
1130 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -04001131 *
1132 * The format is described in
1133 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -04001134OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -04001135
Adam Langley95c29f32014-06-20 12:00:00 -07001136
Adam Langleyc9fb3752014-06-20 12:00:00 -07001137struct ssl_aead_ctx_st;
1138typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
1139
Adam Langleyb4a494c2015-01-23 15:10:10 -08001140#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -07001141
Adam Langleyb4a494c2015-01-23 15:10:10 -08001142#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -07001143
David Benjaminf4501342014-08-14 17:24:37 -04001144#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
1145
Adam Langleyb4a494c2015-01-23 15:10:10 -08001146/* This callback type is used inside SSL_CTX, SSL, and in the functions that
1147 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -07001148 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001149 * callbacks should themselves check if the id they generate is unique
1150 * otherwise the SSL handshake will fail with an error - callbacks can do this
1151 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -07001152 * SSL_has_matching_session_id(ssl, id, *id_len)
1153 * The length value passed in is set at the maximum size the session ID can be.
1154 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
1155 * can alter this length to be less if desired, but under SSLv2 session IDs are
1156 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -08001157 * returns in this case. It is also an error for the callback to set the size
1158 * to zero. */
1159typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
1160 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001161
Adam Langleydc9b1412014-06-20 12:00:00 -07001162/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -08001163 * early on during the server handshake. At this point, much of the SSL* hasn't
1164 * been filled out and only the ClientHello can be depended on. */
1165struct ssl_early_callback_ctx {
1166 SSL *ssl;
1167 const uint8_t *client_hello;
1168 size_t client_hello_len;
1169 const uint8_t *session_id;
1170 size_t session_id_len;
1171 const uint8_t *cipher_suites;
1172 size_t cipher_suites_len;
1173 const uint8_t *compression_methods;
1174 size_t compression_methods_len;
1175 const uint8_t *extensions;
1176 size_t extensions_len;
1177};
Adam Langleydc9b1412014-06-20 12:00:00 -07001178
Adam Langleyb4a494c2015-01-23 15:10:10 -08001179/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
1180 * extension of the given type. If not found, it returns zero. Otherwise it
1181 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -07001182 * and length bytes), sets |out_len| to the length of the extension contents
1183 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001184OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
1185 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
1186 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -07001187
Adam Langley95c29f32014-06-20 12:00:00 -07001188typedef struct ssl_comp_st SSL_COMP;
1189
Adam Langleyb4a494c2015-01-23 15:10:10 -08001190struct ssl_comp_st {
1191 int id;
1192 const char *name;
1193 char *method;
1194};
Adam Langley95c29f32014-06-20 12:00:00 -07001195
1196DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -07001197DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -07001198
Adam Langley858a88d2014-06-20 12:00:00 -07001199/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
1200 * equal-preference groups. For TLS clients, the groups are moot because the
1201 * server picks the cipher and groups cannot be expressed on the wire. However,
1202 * for servers, the equal-preference groups allow the client's preferences to
1203 * be partially respected. (This only has an effect with
1204 * SSL_OP_CIPHER_SERVER_PREFERENCE).
1205 *
1206 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
1207 * All elements of a group have the same priority: no ordering is expressed
1208 * within a group.
1209 *
1210 * The values in |ciphers| are in one-to-one correspondence with
1211 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
1212 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
1213 * indicate that the corresponding SSL_CIPHER is not the last element of a
1214 * group, or 0 to indicate that it is.
1215 *
1216 * For example, if |in_group_flags| contains all zeros then that indicates a
1217 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
1218 * of the group (i.e. they are all in a one-element group).
1219 *
1220 * For a more complex example, consider:
1221 * ciphers: A B C D E F
1222 * in_group_flags: 1 1 0 0 1 0
1223 *
1224 * That would express the following, order:
1225 *
1226 * A E
1227 * B -> D -> F
1228 * C
1229 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001230struct ssl_cipher_preference_list_st {
1231 STACK_OF(SSL_CIPHER) *ciphers;
1232 uint8_t *in_group_flags;
1233};
Adam Langley858a88d2014-06-20 12:00:00 -07001234
Adam Langleyb4a494c2015-01-23 15:10:10 -08001235struct ssl_ctx_st {
1236 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001237
Adam Langley4bdb6e42015-05-15 15:29:21 -07001238 /* lock is used to protect various operations on this object. */
1239 CRYPTO_MUTEX lock;
1240
Adam Langleyb4a494c2015-01-23 15:10:10 -08001241 /* max_version is the maximum acceptable protocol version. If zero, the
1242 * maximum supported version, currently (D)TLS 1.2, is used. */
1243 uint16_t max_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001244
Adam Langleyb4a494c2015-01-23 15:10:10 -08001245 /* min_version is the minimum acceptable protocl version. If zero, the
1246 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1247 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001248
Adam Langleyb4a494c2015-01-23 15:10:10 -08001249 struct ssl_cipher_preference_list_st *cipher_list;
1250 /* same as above but sorted for lookup */
1251 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1252 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
1253 * use. This only applies to server connections as, for clients, the version
1254 * number is known at connect time and so the cipher list can be set then. */
1255 struct ssl_cipher_preference_list_st *cipher_list_tls11;
Adam Langley95c29f32014-06-20 12:00:00 -07001256
David Benjamin4dab2972015-05-16 02:56:06 -04001257 X509_STORE *cert_store;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001258 LHASH_OF(SSL_SESSION) *sessions;
1259 /* Most session-ids that will be cached, default is
1260 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
1261 unsigned long session_cache_size;
David Benjamin4dab2972015-05-16 02:56:06 -04001262 SSL_SESSION *session_cache_head;
1263 SSL_SESSION *session_cache_tail;
Adam Langley95c29f32014-06-20 12:00:00 -07001264
David Benjaminb6d0c6d2015-03-19 19:07:26 -04001265 /* handshakes_since_cache_flush is the number of successful handshakes since
1266 * the last cache flush. */
1267 int handshakes_since_cache_flush;
1268
Adam Langleyb4a494c2015-01-23 15:10:10 -08001269 /* This can have one of 2 values, ored together,
1270 * SSL_SESS_CACHE_CLIENT,
1271 * SSL_SESS_CACHE_SERVER,
1272 * Default is SSL_SESSION_CACHE_SERVER, which means only
1273 * SSL_accept which cache SSL_SESSIONS. */
1274 int session_cache_mode;
Adam Langley95c29f32014-06-20 12:00:00 -07001275
Adam Langleyb4a494c2015-01-23 15:10:10 -08001276 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
1277 * called. This has been put in to make life easier to set things up */
1278 long session_timeout;
Adam Langley95c29f32014-06-20 12:00:00 -07001279
Adam Langleyb4a494c2015-01-23 15:10:10 -08001280 /* If this callback is not null, it will be called each time a session id is
1281 * added to the cache. If this function returns 1, it means that the
1282 * callback will do a SSL_SESSION_free() when it has finished using it.
1283 * Otherwise, on 0, it means the callback has finished with it. If
1284 * remove_session_cb is not null, it will be called when a session-id is
1285 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
1286 * it. */
David Benjamin4dab2972015-05-16 02:56:06 -04001287 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
1288 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
1289 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001290 int *copy);
Adam Langley95c29f32014-06-20 12:00:00 -07001291
Adam Langley0b5e3902015-05-15 13:08:38 -07001292 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -07001293
Adam Langleyb4a494c2015-01-23 15:10:10 -08001294 /* if defined, these override the X509_verify_cert() calls */
1295 int (*app_verify_callback)(X509_STORE_CTX *, void *);
1296 void *app_verify_arg;
1297 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
1298 * was called with just one argument) */
Adam Langley95c29f32014-06-20 12:00:00 -07001299
Adam Langleyb4a494c2015-01-23 15:10:10 -08001300 /* Default password callback. */
1301 pem_password_cb *default_passwd_callback;
Adam Langley95c29f32014-06-20 12:00:00 -07001302
Adam Langleyb4a494c2015-01-23 15:10:10 -08001303 /* Default password callback user data. */
1304 void *default_passwd_callback_userdata;
Adam Langley95c29f32014-06-20 12:00:00 -07001305
Adam Langleyb4a494c2015-01-23 15:10:10 -08001306 /* get client cert callback */
1307 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
Adam Langley95c29f32014-06-20 12:00:00 -07001308
Adam Langleyb4a494c2015-01-23 15:10:10 -08001309 /* get channel id callback */
1310 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
Adam Langley1258b6a2014-06-20 12:00:00 -07001311
Adam Langleyb4a494c2015-01-23 15:10:10 -08001312 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001313
Adam Langley09505632015-07-30 18:10:13 -07001314 /* custom_*_extensions stores any callback sets for custom extensions. Note
1315 * that these pointers will be NULL if the stack would otherwise be empty. */
1316 STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
1317 STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
Adam Langley95c29f32014-06-20 12:00:00 -07001318
Adam Langleyb4a494c2015-01-23 15:10:10 -08001319 /* Default values used when no per-SSL value is defined follow */
Adam Langley95c29f32014-06-20 12:00:00 -07001320
Adam Langleyb4a494c2015-01-23 15:10:10 -08001321 void (*info_callback)(const SSL *ssl, int type,
1322 int val); /* used if SSL's info_callback is NULL */
Adam Langley95c29f32014-06-20 12:00:00 -07001323
Adam Langleyb4a494c2015-01-23 15:10:10 -08001324 /* what we put in client cert requests */
1325 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001326
1327
Adam Langleyb4a494c2015-01-23 15:10:10 -08001328 /* Default values to use in SSL structures follow (these are copied by
1329 * SSL_new) */
Adam Langley95c29f32014-06-20 12:00:00 -07001330
David Benjamin123a8fd2015-04-26 14:16:41 -04001331 uint32_t options;
1332 uint32_t mode;
David Benjamin1d0a1942015-04-26 15:35:35 -04001333 uint32_t max_cert_list;
Adam Langley95c29f32014-06-20 12:00:00 -07001334
Adam Langleyb4a494c2015-01-23 15:10:10 -08001335 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001336
Adam Langleyb4a494c2015-01-23 15:10:10 -08001337 /* callback that allows applications to peek at protocol messages */
1338 void (*msg_callback)(int write_p, int version, int content_type,
1339 const void *buf, size_t len, SSL *ssl, void *arg);
1340 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001341
Adam Langleyb4a494c2015-01-23 15:10:10 -08001342 int verify_mode;
1343 unsigned int sid_ctx_length;
1344 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1345 int (*default_verify_callback)(
1346 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
Adam Langley95c29f32014-06-20 12:00:00 -07001347
Adam Langleyb4a494c2015-01-23 15:10:10 -08001348 /* Default generate session ID callback. */
1349 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001350
Adam Langleyb4a494c2015-01-23 15:10:10 -08001351 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001352
Adam Langleyb4a494c2015-01-23 15:10:10 -08001353 /* select_certificate_cb is called before most ClientHello processing and
1354 * before the decision whether to resume a session is made. It may return one
1355 * to continue the handshake or zero to cause the handshake loop to return
1356 * with an error and cause SSL_get_error to return
David Benjamin6f5c0f42015-02-24 01:23:21 -05001357 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
1358 * will not call the callback a second time. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001359 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
Adam Langleydc9b1412014-06-20 12:00:00 -07001360
Adam Langley524e7172015-02-20 16:04:00 -08001361 /* dos_protection_cb is called once the resumption decision for a ClientHello
1362 * has been made. It returns one to continue the handshake or zero to
1363 * abort. */
1364 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
1365
Adam Langleyb4a494c2015-01-23 15:10:10 -08001366 /* quiet_shutdown is true if the connection should not send a close_notify on
1367 * shutdown. */
1368 int quiet_shutdown;
Adam Langley95c29f32014-06-20 12:00:00 -07001369
Adam Langleyb4a494c2015-01-23 15:10:10 -08001370 /* Maximum amount of data to send in one fragment. actual record size can be
1371 * more than this due to padding and MAC overheads. */
David Benjamin1d0a1942015-04-26 15:35:35 -04001372 uint16_t max_send_fragment;
Adam Langley95c29f32014-06-20 12:00:00 -07001373
Adam Langleyb4a494c2015-01-23 15:10:10 -08001374 /* TLS extensions servername callback */
1375 int (*tlsext_servername_callback)(SSL *, int *, void *);
1376 void *tlsext_servername_arg;
1377 /* RFC 4507 session ticket keys */
David Benjamine3aa1d92015-06-16 15:34:50 -04001378 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
Adam Langleyb4a494c2015-01-23 15:10:10 -08001379 uint8_t tlsext_tick_hmac_key[16];
1380 uint8_t tlsext_tick_aes_key[16];
1381 /* Callback to support customisation of ticket key setting */
1382 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
1383 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
Adam Langley95c29f32014-06-20 12:00:00 -07001384
Adam Langleyb4a494c2015-01-23 15:10:10 -08001385 /* Server-only: psk_identity_hint is the default identity hint to send in
1386 * PSK-based key exchanges. */
1387 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001388
Adam Langleyb4a494c2015-01-23 15:10:10 -08001389 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1390 char *identity,
1391 unsigned int max_identity_len,
1392 uint8_t *psk, unsigned int max_psk_len);
1393 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1394 uint8_t *psk, unsigned int max_psk_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001395
Alex Chernyakhovskya40c8622014-08-03 15:46:36 -04001396
Adam Langleyb4a494c2015-01-23 15:10:10 -08001397 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
1398 * hash of the peer's certifiate and then discard it to save memory and
1399 * session space. Only effective on the server side. */
1400 char retain_only_sha256_of_client_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001401
Adam Langleyb4a494c2015-01-23 15:10:10 -08001402 /* Next protocol negotiation information */
1403 /* (for experimental NPN extension). */
Adam Langley95c29f32014-06-20 12:00:00 -07001404
Adam Langleyb4a494c2015-01-23 15:10:10 -08001405 /* For a server, this contains a callback function by which the set of
1406 * advertised protocols can be provided. */
1407 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
1408 unsigned int *len, void *arg);
1409 void *next_protos_advertised_cb_arg;
1410 /* For a client, this contains a callback function that selects the
1411 * next protocol from the list provided by the server. */
1412 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
1413 const uint8_t *in, unsigned int inlen, void *arg);
1414 void *next_proto_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001415
Adam Langleyb4a494c2015-01-23 15:10:10 -08001416 /* ALPN information
1417 * (we are in the process of transitioning from NPN to ALPN.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001418
Adam Langleyb4a494c2015-01-23 15:10:10 -08001419 /* For a server, this contains a callback function that allows the
1420 * server to select the protocol for the connection.
1421 * out: on successful return, this must point to the raw protocol
1422 * name (without the length prefix).
1423 * outlen: on successful return, this contains the length of |*out|.
1424 * in: points to the client's list of supported protocols in
1425 * wire-format.
1426 * inlen: the length of |in|. */
1427 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
1428 const uint8_t *in, unsigned int inlen, void *arg);
1429 void *alpn_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001430
Adam Langleyb4a494c2015-01-23 15:10:10 -08001431 /* For a client, this contains the list of supported protocols in wire
1432 * format. */
1433 uint8_t *alpn_client_proto_list;
1434 unsigned alpn_client_proto_list_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001435
Adam Langleyb4a494c2015-01-23 15:10:10 -08001436 /* SRTP profiles we are willing to do from RFC 5764 */
1437 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001438
Adam Langleyb4a494c2015-01-23 15:10:10 -08001439 /* EC extension values inherited by SSL structure */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001440 size_t tlsext_ellipticcurvelist_length;
1441 uint16_t *tlsext_ellipticcurvelist;
Adam Langley1258b6a2014-06-20 12:00:00 -07001442
Adam Langleyb4a494c2015-01-23 15:10:10 -08001443 /* If true, a client will advertise the Channel ID extension and a server
1444 * will echo it. */
1445 char tlsext_channel_id_enabled;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001446 /* The client's Channel ID private key. */
1447 EVP_PKEY *tlsext_channel_id_private;
David Benjamin6c7aed02014-08-27 16:42:38 -04001448
Adam Langleyb4a494c2015-01-23 15:10:10 -08001449 /* If true, a client will request certificate timestamps. */
1450 char signed_cert_timestamps_enabled;
David Benjamin859ec3c2014-09-02 16:29:36 -04001451
Adam Langleyb4a494c2015-01-23 15:10:10 -08001452 /* If true, a client will request a stapled OCSP response. */
1453 char ocsp_stapling_enabled;
Adam Langley95c29f32014-06-20 12:00:00 -07001454
Adam Langleyb4a494c2015-01-23 15:10:10 -08001455 /* If not NULL, session key material will be logged to this BIO for debugging
1456 * purposes. The format matches NSS's and is readable by Wireshark. */
1457 BIO *keylog_bio;
David Benjamin377fc312015-01-26 00:22:12 -05001458
1459 /* current_time_cb, if not NULL, is the function to use to get the current
1460 * time. It sets |*out_clock| to the current time. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001461 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001462};
Adam Langley95c29f32014-06-20 12:00:00 -07001463
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001464OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001465
1466/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1467 * session cache. */
1468OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001469
Adam Langleyb4a494c2015-01-23 15:10:10 -08001470OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001471 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1472OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001473 SSL_SESSION *sess);
1474OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1475 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001476 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001477OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001478 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001479OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1480 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001481 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001482 int *copy));
1483OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001484 SSL *ssl, uint8_t *data, int len, int *copy);
Adam Langleyb2ce0582014-06-20 12:00:00 -07001485/* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
1486 * that the session isn't currently unavailable. SSL_get_error will then return
1487 * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
1488 * lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001489OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001490OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1491 void (*cb)(const SSL *ssl,
1492 int type, int val));
1493OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1494 int type,
1495 int val);
1496OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1497 SSL_CTX *ctx,
1498 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1499OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1500 X509 **x509,
1501 EVP_PKEY **pkey);
1502OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1503 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1504OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1505 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001506
Adam Langleyb4a494c2015-01-23 15:10:10 -08001507/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1508 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001509 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001510OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1511
Adam Langleyb4a494c2015-01-23 15:10:10 -08001512/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1513 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001514OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1515
David Benjamin3b7456e2015-05-16 12:29:32 -04001516/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1517 * connection) to request a stapled OCSP response from the server. It returns
1518 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001519OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1520
1521/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1522 * created from |ctx|. */
1523OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1524
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001525/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1526 * |*out_len| bytes of SCT information from the server. This is only valid if
1527 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1528 * (including the two leading length bytes).
1529 * See https://tools.ietf.org/html/rfc6962#section-3.3
1530 * If no SCT was received then |*out_len| will be zero on return.
1531 *
1532 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001533OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001534 const uint8_t **out,
1535 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001536
David Benjamin6c7aed02014-08-27 16:42:38 -04001537/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1538 * bytes of an OCSP response from the server. This is the DER encoding of an
1539 * OCSPResponse type as defined in RFC 2560.
1540 *
1541 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001542OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1543 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001544
Adam Langleyb4a494c2015-01-23 15:10:10 -08001545OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1546 SSL_CTX *s,
1547 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1548 void *arg);
1549OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1550 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1551 const uint8_t *in, unsigned int inlen, void *arg),
1552 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001553OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001554 const uint8_t **data,
1555 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001556
Adam Langleyb4a494c2015-01-23 15:10:10 -08001557OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1558 const uint8_t *in, unsigned int inlen,
1559 const uint8_t *client,
1560 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001561
Adam Langleyb4a494c2015-01-23 15:10:10 -08001562#define OPENSSL_NPN_UNSUPPORTED 0
1563#define OPENSSL_NPN_NEGOTIATED 1
1564#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001565
David Benjamin9d0847a2015-02-16 03:57:55 -05001566/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1567 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1568 * length-prefixed strings). It returns zero on success and one on failure.
1569 *
1570 * WARNING: this function is dangerous because it breaks the usual return value
1571 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001572OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1573 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001574
1575/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1576 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1577 * length-prefixed strings). It returns zero on success and one on failure.
1578 *
1579 * WARNING: this function is dangerous because it breaks the usual return value
1580 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001581OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1582 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001583
Adam Langleyb4a494c2015-01-23 15:10:10 -08001584OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1585 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1586 const uint8_t *in, unsigned int inlen, void *arg),
1587 void *arg);
1588OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1589 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001590
David Benjaminb16346b2015-04-08 19:16:58 -04001591/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1592 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001593 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001594 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001595OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1596
Adam Langleyb4a494c2015-01-23 15:10:10 -08001597/* the maximum length of the buffer given to callbacks containing the resulting
1598 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001599#define PSK_MAX_IDENTITY_LEN 128
1600#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001601OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1602 SSL_CTX *ctx,
1603 unsigned int (*psk_client_callback)(
1604 SSL *ssl, const char *hint, char *identity,
1605 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1606OPENSSL_EXPORT void SSL_set_psk_client_callback(
1607 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1608 char *identity,
1609 unsigned int max_identity_len,
1610 uint8_t *psk,
1611 unsigned int max_psk_len));
1612OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1613 SSL_CTX *ctx,
1614 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1615 uint8_t *psk,
1616 unsigned int max_psk_len));
1617OPENSSL_EXPORT void SSL_set_psk_server_callback(
1618 SSL *ssl,
1619 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1620 uint8_t *psk,
1621 unsigned int max_psk_len));
1622OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1623 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001624OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1625OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1626OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001627
Adam Langleyb4a494c2015-01-23 15:10:10 -08001628#define SSL_NOTHING 1
1629#define SSL_WRITING 2
1630#define SSL_READING 3
1631#define SSL_X509_LOOKUP 4
1632#define SSL_CHANNEL_ID_LOOKUP 5
1633#define SSL_PENDING_SESSION 7
1634#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04001635#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07001636
1637/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001638#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1639#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1640#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1641#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1642#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1643#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1644#define SSL_want_certificate(s) \
1645 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04001646#define SSL_want_private_key_operation(s) \
1647 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07001648
Adam Langleyb4a494c2015-01-23 15:10:10 -08001649struct ssl_st {
1650 /* version is the protocol version. */
1651 int version;
Adam Langley95c29f32014-06-20 12:00:00 -07001652
Adam Langleyb4a494c2015-01-23 15:10:10 -08001653 /* method is the method table corresponding to the current protocol (DTLS or
1654 * TLS). */
1655 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001656
Adam Langleyb4a494c2015-01-23 15:10:10 -08001657 /* enc_method is the method table corresponding to the current protocol
1658 * version. */
1659 const SSL3_ENC_METHOD *enc_method;
David Benjamine99e9122014-12-11 01:46:01 -05001660
Adam Langleyb4a494c2015-01-23 15:10:10 -08001661 /* max_version is the maximum acceptable protocol version. If zero, the
1662 * maximum supported version, currently (D)TLS 1.2, is used. */
1663 uint16_t max_version;
Adam Langley95c29f32014-06-20 12:00:00 -07001664
Adam Langleyb4a494c2015-01-23 15:10:10 -08001665 /* min_version is the minimum acceptable protocl version. If zero, the
1666 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1667 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001668
Adam Langleyb4a494c2015-01-23 15:10:10 -08001669 /* There are 2 BIO's even though they are normally both the same. This is so
1670 * data can be read and written to different handlers */
David Benjamin1eb367c2014-12-12 18:17:51 -05001671
Adam Langleyb4a494c2015-01-23 15:10:10 -08001672 BIO *rbio; /* used by SSL_read */
1673 BIO *wbio; /* used by SSL_write */
1674 BIO *bbio; /* used during session-id reuse to concatenate
1675 * messages */
Adam Langley95c29f32014-06-20 12:00:00 -07001676
Adam Langleyb4a494c2015-01-23 15:10:10 -08001677 /* This holds a variable that indicates what we were doing when a 0 or -1 is
1678 * returned. This is needed for non-blocking IO so we know what request
1679 * needs re-doing when in SSL_accept or SSL_connect */
1680 int rwstate;
David Benjamin95f9cfc2014-11-23 00:19:49 -05001681
Adam Langleyb4a494c2015-01-23 15:10:10 -08001682 /* true when we are actually in SSL_accept() or SSL_connect() */
1683 int in_handshake;
1684 int (*handshake_func)(SSL *);
Adam Langley95c29f32014-06-20 12:00:00 -07001685
Adam Langleyb4a494c2015-01-23 15:10:10 -08001686 /* Imagine that here's a boolean member "init" that is switched as soon as
1687 * SSL_set_{accept/connect}_state is called for the first time, so that
1688 * "state" and "handshake_func" are properly initialized. But as
1689 * handshake_func is == 0 until then, we use this test instead of an "init"
1690 * member. */
Adam Langley95c29f32014-06-20 12:00:00 -07001691
Adam Langleyb4a494c2015-01-23 15:10:10 -08001692 /* server is true iff the this SSL* is the server half. Note: before the SSL*
1693 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
1694 * the side is not determined. In this state, server is always false. */
1695 int server;
Adam Langley95c29f32014-06-20 12:00:00 -07001696
Adam Langleyb4a494c2015-01-23 15:10:10 -08001697 /* quiet_shutdown is true if the connection should not send a close_notify on
1698 * shutdown. */
1699 int quiet_shutdown;
David Benjamin7e237462014-12-11 18:13:28 -05001700
Adam Langleyb4a494c2015-01-23 15:10:10 -08001701 int shutdown; /* we have shut things down, 0x01 sent, 0x02
1702 * for received */
1703 int state; /* where we are */
1704 int rstate; /* where we are when reading */
Adam Langley95c29f32014-06-20 12:00:00 -07001705
Adam Langleyb4a494c2015-01-23 15:10:10 -08001706 BUF_MEM *init_buf; /* buffer used during init */
1707 uint8_t *init_msg; /* pointer to handshake message body, set by
1708 ssl3_get_message() */
1709 int init_num; /* amount read/written */
1710 int init_off; /* amount read/written */
Adam Langley95c29f32014-06-20 12:00:00 -07001711
Adam Langleyb4a494c2015-01-23 15:10:10 -08001712 /* used internally to point at a raw packet */
1713 uint8_t *packet;
1714 unsigned int packet_length;
Adam Langley95c29f32014-06-20 12:00:00 -07001715
Adam Langleyb4a494c2015-01-23 15:10:10 -08001716 struct ssl3_state_st *s3; /* SSLv3 variables */
1717 struct dtls1_state_st *d1; /* DTLSv1 variables */
Adam Langley95c29f32014-06-20 12:00:00 -07001718
Adam Langleyb4a494c2015-01-23 15:10:10 -08001719 /* callback that allows applications to peek at protocol messages */
1720 void (*msg_callback)(int write_p, int version, int content_type,
1721 const void *buf, size_t len, SSL *ssl, void *arg);
1722 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001723
Adam Langleyb4a494c2015-01-23 15:10:10 -08001724 int hit; /* reusing a previous session */
Adam Langley95c29f32014-06-20 12:00:00 -07001725
Adam Langleyb4a494c2015-01-23 15:10:10 -08001726 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001727
Adam Langleyb4a494c2015-01-23 15:10:10 -08001728 /* crypto */
1729 struct ssl_cipher_preference_list_st *cipher_list;
1730 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001731
Adam Langleyb4a494c2015-01-23 15:10:10 -08001732 SSL_AEAD_CTX *aead_read_ctx;
1733 SSL_AEAD_CTX *aead_write_ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001734
Adam Langleyb4a494c2015-01-23 15:10:10 -08001735 /* session info */
Adam Langley95c29f32014-06-20 12:00:00 -07001736
Adam Langleyb4a494c2015-01-23 15:10:10 -08001737 /* client cert? */
1738 /* This is used to hold the server certificate used */
1739 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001740
Adam Langleyb4a494c2015-01-23 15:10:10 -08001741 /* the session_id_context is used to ensure sessions are only reused
1742 * in the appropriate context */
1743 unsigned int sid_ctx_length;
1744 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001745
Adam Langleyb4a494c2015-01-23 15:10:10 -08001746 /* This can also be in the session once a session is established */
1747 SSL_SESSION *session;
Adam Langley95c29f32014-06-20 12:00:00 -07001748
Adam Langleyb4a494c2015-01-23 15:10:10 -08001749 /* Default generate session ID callback. */
1750 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001751
Adam Langleyb4a494c2015-01-23 15:10:10 -08001752 /* Used in SSL2 and SSL3 */
1753 int verify_mode; /* 0 don't care about verify failure.
1754 * 1 fail if verify fails */
1755 int (*verify_callback)(int ok,
1756 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
Adam Langley95c29f32014-06-20 12:00:00 -07001757
Adam Langleyb4a494c2015-01-23 15:10:10 -08001758 void (*info_callback)(const SSL *ssl, int type,
1759 int val); /* optional informational callback */
Adam Langley95c29f32014-06-20 12:00:00 -07001760
Adam Langleyb4a494c2015-01-23 15:10:10 -08001761 /* Server-only: psk_identity_hint is the identity hint to send in
1762 * PSK-based key exchanges. */
1763 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001764
Adam Langleyb4a494c2015-01-23 15:10:10 -08001765 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1766 char *identity,
1767 unsigned int max_identity_len,
1768 uint8_t *psk, unsigned int max_psk_len);
1769 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1770 uint8_t *psk, unsigned int max_psk_len);
David Benjamin688d8df2014-11-02 23:06:42 -05001771
Adam Langleyb4a494c2015-01-23 15:10:10 -08001772 SSL_CTX *ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001773
Adam Langleyb4a494c2015-01-23 15:10:10 -08001774 /* extra application data */
1775 long verify_result;
1776 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001777
Adam Langleyb4a494c2015-01-23 15:10:10 -08001778 /* for server side, keep the list of CA_dn we can use */
1779 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001780
David Benjamin123a8fd2015-04-26 14:16:41 -04001781 uint32_t options; /* protocol behaviour */
1782 uint32_t mode; /* API behaviour */
David Benjamin1d0a1942015-04-26 15:35:35 -04001783 uint32_t max_cert_list;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001784 int client_version; /* what was passed, used for
1785 * SSLv3/TLS rollback check */
David Benjamin1d0a1942015-04-26 15:35:35 -04001786 uint16_t max_send_fragment;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001787 char *tlsext_hostname;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001788 /* RFC4507 session ticket expected to be received or sent */
1789 int tlsext_ticket_expected;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001790 size_t tlsext_ellipticcurvelist_length;
1791 uint16_t *tlsext_ellipticcurvelist; /* our list */
Adam Langley95c29f32014-06-20 12:00:00 -07001792
Adam Langleyb4a494c2015-01-23 15:10:10 -08001793 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
Adam Langley95c29f32014-06-20 12:00:00 -07001794
Adam Langleyb4a494c2015-01-23 15:10:10 -08001795 /* Next protocol negotiation. For the client, this is the protocol that we
1796 * sent in NextProtocol and is set when handling ServerHello extensions.
1797 *
1798 * For a server, this is the client's selected_protocol from NextProtocol and
1799 * is set when handling the NextProtocol message, before the Finished
1800 * message. */
1801 uint8_t *next_proto_negotiated;
1802 size_t next_proto_negotiated_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001803
Adam Langleyb4a494c2015-01-23 15:10:10 -08001804 /* srtp_profiles is the list of configured SRTP protection profiles for
1805 * DTLS-SRTP. */
1806 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001807
Adam Langleyb4a494c2015-01-23 15:10:10 -08001808 /* srtp_profile is the selected SRTP protection profile for
1809 * DTLS-SRTP. */
1810 const SRTP_PROTECTION_PROFILE *srtp_profile;
David Benjaminbc44c082015-01-01 15:02:11 -05001811
Adam Langleyb4a494c2015-01-23 15:10:10 -08001812 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
1813 * from clients. For a client, means that we'll advertise support. */
1814 char tlsext_channel_id_enabled;
1815 /* The client's Channel ID private key. */
1816 EVP_PKEY *tlsext_channel_id_private;
Adam Langley95c29f32014-06-20 12:00:00 -07001817
Adam Langleyb4a494c2015-01-23 15:10:10 -08001818 /* Enable signed certificate time stamps. Currently client only. */
1819 char signed_cert_timestamps_enabled;
Adam Langley1258b6a2014-06-20 12:00:00 -07001820
Adam Langleyb4a494c2015-01-23 15:10:10 -08001821 /* Enable OCSP stapling. Currently client only.
1822 * TODO(davidben): Add a server-side implementation when it becomes
1823 * necesary. */
1824 char ocsp_stapling_enabled;
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001825
Adam Langleyb4a494c2015-01-23 15:10:10 -08001826 /* For a client, this contains the list of supported protocols in wire
1827 * format. */
1828 uint8_t *alpn_client_proto_list;
1829 unsigned alpn_client_proto_list_len;
David Benjamin6c7aed02014-08-27 16:42:38 -04001830
David Benjamin897e5e02015-05-12 17:03:54 -04001831 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
1832 * peer. Otherwise, they will be rejected with a fatal error. */
1833 char accept_peer_renegotiations;
David Benjaminb16346b2015-04-08 19:16:58 -04001834
Adam Langleyb4a494c2015-01-23 15:10:10 -08001835 /* These fields are always NULL and exist only to keep wpa_supplicant happy
1836 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
1837 * don't support. */
1838 EVP_CIPHER_CTX *enc_read_ctx;
1839 EVP_MD_CTX *read_hash;
1840};
Adam Langley95c29f32014-06-20 12:00:00 -07001841
Adam Langley95c29f32014-06-20 12:00:00 -07001842/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001843#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
1844#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
1845#define SSL_SESSION_set_app_data(s, a) \
1846 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
1847#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
1848#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
1849#define SSL_CTX_set_app_data(ctx, arg) \
1850 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07001851
Adam Langleyb4a494c2015-01-23 15:10:10 -08001852/* The following are the possible values for ssl->state are are used to
1853 * indicate where we are up to in the SSL connection establishment. The macros
1854 * that follow are about the only things you should need to use and even then,
1855 * only when using non-blocking IO. It can also be useful to work out where you
1856 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07001857
Adam Langleyb4a494c2015-01-23 15:10:10 -08001858#define SSL_ST_CONNECT 0x1000
1859#define SSL_ST_ACCEPT 0x2000
1860#define SSL_ST_MASK 0x0FFF
1861#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001862#define SSL_ST_OK 0x03
1863#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07001864
Adam Langleyb4a494c2015-01-23 15:10:10 -08001865#define SSL_CB_LOOP 0x01
1866#define SSL_CB_EXIT 0x02
1867#define SSL_CB_READ 0x04
1868#define SSL_CB_WRITE 0x08
1869#define SSL_CB_ALERT 0x4000 /* used in callback */
1870#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
1871#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
1872#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
1873#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
1874#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
1875#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
1876#define SSL_CB_HANDSHAKE_START 0x10
1877#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07001878
1879/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001880#define SSL_get_state(a) SSL_state(a)
1881#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05001882#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001883#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
1884#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05001885
David Benjamined7c4752015-02-16 19:16:46 -05001886/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
1887 * is in False Start. |SSL_write| may be called at this point without waiting
1888 * for the peer, but |SSL_read| will require the handshake to be completed. */
1889OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
1890
Adam Langley95c29f32014-06-20 12:00:00 -07001891/* The following 2 states are kept in ssl->rstate when reads fail,
1892 * you should not need these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001893#define SSL_ST_READ_HEADER 0xF0
1894#define SSL_ST_READ_BODY 0xF1
1895#define SSL_ST_READ_DONE 0xF2
Adam Langley95c29f32014-06-20 12:00:00 -07001896
1897/* Obtain latest Finished message
1898 * -- that we sent (SSL_get_finished)
1899 * -- that we expected from peer (SSL_get_peer_finished).
1900 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001901OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1902OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07001903
Adam Langley509e5ed2014-06-20 12:00:00 -07001904/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07001905 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001906#define SSL_VERIFY_NONE 0x00
1907#define SSL_VERIFY_PEER 0x01
1908#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
David Benjamin5aea93e2015-05-26 16:33:02 -04001909/* SSL_VERIFY_CLIENT_ONCE does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001910#define SSL_VERIFY_CLIENT_ONCE 0x04
1911#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07001912
Adam Langleyb4a494c2015-01-23 15:10:10 -08001913#define OpenSSL_add_ssl_algorithms() SSL_library_init()
1914#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07001915
Adam Langleyb4a494c2015-01-23 15:10:10 -08001916/* For backward compatibility */
1917#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1918#define SSL_get_cipher_bits(s, np) \
1919 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07001920#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001921 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1922#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1923#define SSL_get_time(a) SSL_SESSION_get_time(a)
1924#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
1925#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
1926#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07001927
Adam Langleyb4a494c2015-01-23 15:10:10 -08001928#define d2i_SSL_SESSION_bio(bp, s_id) \
1929 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
1930#define i2d_SSL_SESSION_bio(bp, s_id) \
1931 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07001932
1933DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1934
Adam Langleyb4a494c2015-01-23 15:10:10 -08001935/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
1936 * This value must be kept in sync with reservedReasonCode in make_errors.h */
1937#define SSL_AD_REASON_OFFSET \
1938 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07001939
1940/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001941#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
1942#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
1943#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
1944#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
1945#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
1946#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
1947#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
1948#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
1949#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
1950#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
1951#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
1952#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
1953#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
1954#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
1955#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
1956#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
1957#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
1958#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
1959#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
1960#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
1961#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
1962#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
1963#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
1964#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
1965#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07001966#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001967#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
1968#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
1969 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07001970#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001971#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
1972#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07001973
Adam Langleyb4a494c2015-01-23 15:10:10 -08001974#define SSL_ERROR_NONE 0
1975#define SSL_ERROR_SSL 1
1976#define SSL_ERROR_WANT_READ 2
1977#define SSL_ERROR_WANT_WRITE 3
1978#define SSL_ERROR_WANT_X509_LOOKUP 4
1979#define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
1980#define SSL_ERROR_ZERO_RETURN 6
1981#define SSL_ERROR_WANT_CONNECT 7
1982#define SSL_ERROR_WANT_ACCEPT 8
1983#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
1984#define SSL_ERROR_PENDING_SESSION 11
1985#define SSL_ERROR_PENDING_CERTIFICATE 12
David Benjaminb4d65fd2015-05-29 17:11:21 -04001986#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
Adam Langley95c29f32014-06-20 12:00:00 -07001987
Adam Langleyb4a494c2015-01-23 15:10:10 -08001988#define SSL_CTRL_GET_CURVES 90
1989#define SSL_CTRL_SET_CURVES 91
Adam Langleyb4a494c2015-01-23 15:10:10 -08001990#define SSL_CTRL_SET_SIGALGS 97
Adam Langleyb4a494c2015-01-23 15:10:10 -08001991#define SSL_CTRL_SET_CLIENT_SIGALGS 101
Adam Langleyb4a494c2015-01-23 15:10:10 -08001992#define SSL_CTRL_SET_CLIENT_CERT_TYPES 104
Adam Langleyb4a494c2015-01-23 15:10:10 -08001993#define SSL_CTRL_SET_VERIFY_CERT_STORE 106
1994#define SSL_CTRL_SET_CHAIN_CERT_STORE 107
Adam Langley95c29f32014-06-20 12:00:00 -07001995
David Benjamin377fc312015-01-26 00:22:12 -05001996/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04001997 * timeout in progress, it sets |*out| to the time remaining and returns one.
1998 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05001999 *
2000 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
2001 * retransmit behavior.
2002 *
2003 * NOTE: This function must be queried again whenever the handshake state
2004 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04002005OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05002006
2007/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
2008 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
2009 * flight of handshake messages and returns 1. If too many timeouts had expired
2010 * without progress or an error occurs, it returns -1.
2011 *
2012 * NOTE: The caller's external timer should be compatible with the one |ssl|
2013 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04002014 * |DTLSv1_get_timeout| will return an updated timeout.
2015 *
2016 * WARNING: This function breaks the usual return value convention. */
2017OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002018
David Benjaminc0454692015-04-27 00:28:56 -04002019/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
2020 * and zero otherwise.
2021 *
2022 * TODO(davidben): Hammer down the semantics of this API while a handshake,
2023 * initial or renego, is in progress. */
2024OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002025
David Benjaminc0454692015-04-27 00:28:56 -04002026/* SSL_total_renegotiations returns the total number of renegotiation handshakes
2027 * peformed by |ssl|. This includes the pending renegotiation, if any. */
2028OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
2029
David Benjamin15a3b002015-04-28 00:05:35 -04002030/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
2031 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
2032 * one on success and zero on error. */
2033OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04002034
David Benjamin15a3b002015-04-28 00:05:35 -04002035/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
2036 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
2037 * on success and zero on error. */
2038OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07002039
David Benjamin15a3b002015-04-28 00:05:35 -04002040/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
2041 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
2042 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
2043 * error. If unset, an appropriate curve will be chosen automatically. (This is
2044 * recommended.) */
2045OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04002046
David Benjamin15a3b002015-04-28 00:05:35 -04002047/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
2048 * for ephemeral ECDH keys. For historical reasons, this API expects an
2049 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
2050 * error. If unset, an appropriate curve will be chosen automatically. (This is
2051 * recommended.) */
2052OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07002053
David Benjaminc2807582015-04-28 00:19:50 -04002054/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
2055 * client IDs from clients, or configures a client to send TLS client IDs to
2056 * a server. It returns one. */
2057OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
2058
Adam Langleyb4a494c2015-01-23 15:10:10 -08002059/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
2060 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04002061 * server. It returns one. */
2062OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
2063
2064/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
2065 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
2066 * on success and zero on error. */
2067OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
2068 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002069
Adam Langley1258b6a2014-06-20 12:00:00 -07002070/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04002071 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
2072 * success and zero on error. */
2073OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002074
Adam Langley1258b6a2014-06-20 12:00:00 -07002075/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04002076 * and copies up to the first |max_out| bytes into |out|. The Channel ID
2077 * consists of the client's P-256 public key as an (x,y) pair where each is a
2078 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
2079 * Channel ID and the length of the complete Channel ID otherwise. */
2080OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
2081 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07002082
David Benjamin75910642015-08-09 10:42:33 -04002083/* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
2084 * containing the client certificate types requested by a server. It returns the
2085 * length of the array. */
2086OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
2087 const uint8_t **out_types);
2088
Adam Langleyb4a494c2015-01-23 15:10:10 -08002089#define SSL_CTX_set0_verify_cert_store(ctx, st) \
2090 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
2091#define SSL_CTX_set1_verify_cert_store(ctx, st) \
2092 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
2093#define SSL_CTX_set0_chain_cert_store(ctx, st) \
2094 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
2095#define SSL_CTX_set1_chain_cert_store(ctx, st) \
2096 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07002097
Adam Langleyb4a494c2015-01-23 15:10:10 -08002098#define SSL_set0_verify_cert_store(s, st) \
2099 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
2100#define SSL_set1_verify_cert_store(s, st) \
2101 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
2102#define SSL_set0_chain_cert_store(s, st) \
2103 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
2104#define SSL_set1_chain_cert_store(s, st) \
2105 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07002106
Adam Langleyb4a494c2015-01-23 15:10:10 -08002107#define SSL_get1_curves(ctx, s) SSL_ctrl(ctx, SSL_CTRL_GET_CURVES, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002108#define SSL_CTX_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002109 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002110#define SSL_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002111 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002112
2113#define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002114 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002115#define SSL_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002116 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002117
2118#define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002119 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002120#define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002121 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002122
Adam Langley95c29f32014-06-20 12:00:00 -07002123#define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002124 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002125#define SSL_set1_client_certificate_types(s, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002126 SSL_ctrl(s, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002127
Adam Langleyb4a494c2015-01-23 15:10:10 -08002128OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
2129OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002130OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002131OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
2132OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002133OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002134OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002135
Adam Langleyb4a494c2015-01-23 15:10:10 -08002136OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07002137
David Benjamina07c0fc2015-05-13 13:19:42 -04002138/* SSL_get_current_cipher returns the cipher used in the current outgoing
2139 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002140OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002141
Adam Langleyb4a494c2015-01-23 15:10:10 -08002142OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
2143OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
2144OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
2145OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002146OPENSSL_EXPORT int SSL_pending(const SSL *s);
2147OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
2148OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
2149OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
2150OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
2151OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
2152OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
2153OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002154OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
2155OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
2156OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
2157 X509_STORE_CTX *);
2158OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
2159 int (*callback)(int ok,
2160 X509_STORE_CTX *ctx));
2161OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002162OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002163OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
2164 stackCAs,
2165 const char *file);
2166OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
2167 stackCAs,
2168 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07002169
David Benjamin7ce1c0c2015-01-09 13:21:21 -05002170/* SSL_load_error_strings does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002171OPENSSL_EXPORT void SSL_load_error_strings(void);
David Benjamin7ce1c0c2015-01-09 13:21:21 -05002172
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002173OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
2174OPENSSL_EXPORT const char *SSL_rstate_string(const SSL *s);
2175OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
2176OPENSSL_EXPORT const char *SSL_rstate_string_long(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002177OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
2178OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
2179OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
2180OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002181OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002182OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
2183 const uint8_t *sid_ctx,
2184 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002185
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002186OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002187OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
2188 unsigned int *len);
2189OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
2190OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05002191
2192/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
2193 * of |session|. It then returns |session|. */
2194OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
2195
2196/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
2197 * zero, all data referenced by |session| and |session| itself are released. */
2198OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
2199
Adam Langleyb4a494c2015-01-23 15:10:10 -08002200OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
2201OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
2202OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
2203OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
2204OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
2205OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
2206 const uint8_t *id,
2207 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04002208
Adam Langleyb4a494c2015-01-23 15:10:10 -08002209/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
2210 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
2211 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
2212 * one on success and zero on error. */
David Benjamin3cac4502014-10-21 01:46:30 -04002213OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
2214 size_t *out_len);
2215
David Benjamin95d31822015-06-15 19:53:32 -04002216/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
2217 * identification information, namely the session ID and ticket. */
David Benjamin3cac4502014-10-21 01:46:30 -04002218OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
2219 uint8_t **out_data,
2220 size_t *out_len);
2221
David Benjaminfd67aa82015-06-15 19:41:48 -04002222/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
2223 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
2224OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
2225 size_t in_len);
2226
Adam Langleyb4a494c2015-01-23 15:10:10 -08002227/* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
2228 * |*pp|. On success, it returns the number of bytes written and advances |*pp|
2229 * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
2230 * written and only the length is returned.
David Benjamin3cac4502014-10-21 01:46:30 -04002231 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002232 * Use |SSL_SESSION_to_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002233OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2234
David Benjaminfd67aa82015-06-15 19:41:48 -04002235/* Deprecated: d2i_SSL_SESSION parses a serialized session from the |length|
2236 * bytes pointed to by |*pp|. It returns the new |SSL_SESSION| and advances
2237 * |*pp| by the number of bytes consumed on success and NULL on failure. The
2238 * caller takes ownership of the new session and must call |SSL_SESSION_free|
2239 * when done.
David Benjamin3cac4502014-10-21 01:46:30 -04002240 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002241 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
David Benjamin3cac4502014-10-21 01:46:30 -04002242 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002243 * Use |SSL_SESSION_from_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002244OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2245 long length);
Adam Langley95c29f32014-06-20 12:00:00 -07002246
Adam Langleyb4a494c2015-01-23 15:10:10 -08002247OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002248
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002249OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002250
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002251OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
2252OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002253OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
2254 int, X509_STORE_CTX *);
2255OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2256 int (*callback)(int, X509_STORE_CTX *));
2257OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
2258OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
2259 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07002260
Adam Langleyb4a494c2015-01-23 15:10:10 -08002261OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
2262 pem_password_cb *cb);
2263OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
2264 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07002265
Adam Langleyb4a494c2015-01-23 15:10:10 -08002266OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
2267 const uint8_t *sid_ctx,
2268 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002269
Adam Langleyb4a494c2015-01-23 15:10:10 -08002270OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
2271 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002272
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002273OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
2274OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
2275OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
2276OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07002277
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002278OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
2279OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07002280
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002281OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
2282OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002283
Adam Langleyb4a494c2015-01-23 15:10:10 -08002284OPENSSL_EXPORT int SSL_accept(SSL *ssl);
2285OPENSSL_EXPORT int SSL_connect(SSL *ssl);
2286OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
2287OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
2288OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
2289OPENSSL_EXPORT long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002290OPENSSL_EXPORT long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
Adam Langley95c29f32014-06-20 12:00:00 -07002291
Adam Langleyb4a494c2015-01-23 15:10:10 -08002292OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
Adam Langley0f4746e2014-08-13 12:26:32 -07002293/* SSL_get_version returns a string describing the TLS version used by |s|. For
2294 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002295OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley0f4746e2014-08-13 12:26:32 -07002296/* SSL_SESSION_get_version returns a string describing the TLS version used by
2297 * |sess|. For example, "TLSv1.2" or "SSLv3". */
2298OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
Adam Langley95c29f32014-06-20 12:00:00 -07002299
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002300OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002301
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002302OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
David Benjamin44d3eed2015-05-21 01:29:55 -04002303
2304/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2305 * renegotiation. */
2306OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2307
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002308OPENSSL_EXPORT int SSL_shutdown(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002309
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002310OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2311OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2312OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2313OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002314
Adam Langleyb4a494c2015-01-23 15:10:10 -08002315OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
2316 STACK_OF(X509_NAME) *name_list);
2317OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2318 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002319OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002320OPENSSL_EXPORT STACK_OF(X509_NAME) *
2321 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2322OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
2323OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07002324
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002325OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002326
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002327OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07002328
Adam Langleyb4a494c2015-01-23 15:10:10 -08002329OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002330OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002331OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002332OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002333OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002334OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
2335OPENSSL_EXPORT int SSL_version(const SSL *ssl);
2336OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002337OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2338 const char *CAfile,
2339 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07002340#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002341OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002342OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
2343 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002344OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002345OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002346OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002347 void (*cb)(const SSL *ssl, int type,
2348 int val));
2349OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2350 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002351OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002352
Adam Langleyb4a494c2015-01-23 15:10:10 -08002353OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002354OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002355
Adam Langleyb4a494c2015-01-23 15:10:10 -08002356OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2357OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2358OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2359 CRYPTO_EX_new *new_func,
2360 CRYPTO_EX_dup *dup_func,
2361 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002362
Adam Langleyb4a494c2015-01-23 15:10:10 -08002363OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
2364 void *data);
2365OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2366OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2367 CRYPTO_EX_new *new_func,
2368 CRYPTO_EX_dup *dup_func,
2369 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002370
Adam Langleyb4a494c2015-01-23 15:10:10 -08002371OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2372OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2373OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2374 CRYPTO_EX_new *new_func,
2375 CRYPTO_EX_dup *dup_func,
2376 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002377
Adam Langleyb4a494c2015-01-23 15:10:10 -08002378OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002379
David Benjamin71f7d3d2015-05-05 09:46:38 -04002380/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
2381 * |size|. It returns the previous value. */
2382OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
2383 unsigned long size);
2384
David Benjamin3b7456e2015-05-16 12:29:32 -04002385/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04002386 * cache. */
2387OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
2388
2389/* SSL_SESS_CACHE_* are the possible session cache mode bits.
2390 * TODO(davidben): Document. */
2391#define SSL_SESS_CACHE_OFF 0x0000
2392#define SSL_SESS_CACHE_CLIENT 0x0001
2393#define SSL_SESS_CACHE_SERVER 0x0002
2394#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2395#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2396#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2397#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2398#define SSL_SESS_CACHE_NO_INTERNAL \
2399 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2400
2401/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2402 * |mode|. It returns the previous value. */
2403OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2404
2405/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2406 * |ctx| */
2407OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002408
David Benjamin1d0a1942015-04-26 15:35:35 -04002409/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2410 * certificate chain accepted by |ctx|. */
2411OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2412
2413/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2414 * certificate chain to |max_cert_list|. This affects how much memory may be
2415 * consumed during the handshake. */
2416OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2417 size_t max_cert_list);
2418
2419/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2420 * certificate chain accepted by |ssl|. */
2421OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2422
2423/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2424 * certificate chain to |max_cert_list|. This affects how much memory may be
2425 * consumed during the handshake. */
2426OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2427
2428/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2429 * sent by |ctx|. Beyond this length, handshake messages and application data
2430 * will be split into multiple records. */
2431OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2432 size_t max_send_fragment);
2433
2434/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2435 * sent by |ssl|. Beyond this length, handshake messages and application data
2436 * will be split into multiple records. */
2437OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2438 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002439
David Benjamin59015c32015-04-26 13:13:55 -04002440/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2441 * the group for DHE ciphers. |callback| should ignore |is_export| and
2442 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2443 * the parameters are used, so the |DH| needn't have a generated keypair.
2444 *
2445 * WARNING: The caller does not take ownership of the resulting |DH|, so
2446 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002447OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002448 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2449
2450/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2451 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2452 * and return a |DH| of the selected group or NULL on error. Only the
2453 * parameters are used, so the |DH| needn't have a generated keypair.
2454 *
2455 * WARNING: The caller does not take ownership of the resulting |DH|, so
2456 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002457OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002458 DH *(*dh)(SSL *ssl, int is_export,
2459 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002460
2461/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2462 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2463 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2464 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2465 * keypair.
2466 *
2467 * If the callback is unset, an appropriate curve will be chosen automatically.
2468 * (This is recommended.)
2469 *
2470 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2471 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002472OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002473 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2474
2475/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2476 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2477 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2478 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2479 * keypair.
2480 *
2481 * If the callback is unset, an appropriate curve will be chosen automatically.
2482 * (This is recommended.)
2483 *
2484 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2485 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002486OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002487 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002488
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002489typedef void COMP_METHOD;
2490
2491/* SSL_get_current_compression returns NULL. */
2492OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
2493
2494/* SSL_get_current_expansion returns NULL. */
2495OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002496
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002497OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2498OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002499
Adam Langley524e7172015-02-20 16:04:00 -08002500/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2501 * resumption decision for a ClientHello has been made. It can return 1 to
2502 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002503OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002504 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2505
Adam Langley95f22882014-06-20 12:00:00 -07002506/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2507 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2508 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002509OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2510 size_t *ssl_ctx_size,
2511 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002512
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002513OPENSSL_EXPORT void ERR_load_SSL_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002514
Adam Langley3f92d212015-02-20 15:32:52 -08002515/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2516 * the read and write directions. It returns one on success or zero if |ssl|
2517 * isn't using an RC4-based cipher suite. */
2518OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2519 const RC4_KEY **write_key);
2520
Adam Langley95c29f32014-06-20 12:00:00 -07002521
David Benjamin71f07942015-04-08 02:36:59 -04002522/* Deprecated functions. */
2523
2524/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2525 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2526 * freed with |OPENSSL_free|, or NULL on error.
2527 *
2528 * The description includes a trailing newline and has the form:
2529 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2530 *
2531 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2532OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2533 char *buf, int len);
2534
2535/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2536OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2537
2538/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002539OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002540
2541/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002542OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002543
2544/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002545OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002546
David Benjamin0d8a7582015-04-08 23:55:15 -04002547/* SSLv23_method calls |TLS_method|. */
2548OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2549
2550/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2551 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2552 * to lock connections to that protocol version. */
2553OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2554OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2555OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2556OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2557OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2558OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2559
2560/* Client- and server-specific methods call their corresponding generic
2561 * methods. */
2562OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2563OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2564OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2565OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2566OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2567OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2568OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2569OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2570OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2571OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2572OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2573OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2574OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2575OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2576OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2577OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2578
David Benjamin4831c332015-05-16 11:43:13 -04002579/* SSL_clear resets |ssl| to allow another connection and returns one on success
2580 * or zero on failure. It returns most configuration state but releases memory
2581 * associated with the current connection.
2582 *
2583 * Free |ssl| and create a new one instead. */
2584OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2585
David Benjamin59015c32015-04-26 13:13:55 -04002586/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2587OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2588 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002589
David Benjamin59015c32015-04-26 13:13:55 -04002590/* SSL_set_tmp_rsa_callback does nothing. */
2591OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2592 RSA *(*cb)(SSL *ssl, int is_export,
2593 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002594
David Benjaminda881e92015-04-26 14:45:04 -04002595/* SSL_CTX_sess_connect returns zero. */
2596OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2597
2598/* SSL_CTX_sess_connect_good returns zero. */
2599OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2600
2601/* SSL_CTX_sess_connect_renegotiate returns zero. */
2602OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2603
2604/* SSL_CTX_sess_accept returns zero. */
2605OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2606
2607/* SSL_CTX_sess_accept_renegotiate returns zero. */
2608OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2609
2610/* SSL_CTX_sess_accept_good returns zero. */
2611OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2612
2613/* SSL_CTX_sess_hits returns zero. */
2614OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2615
2616/* SSL_CTX_sess_cb_hits returns zero. */
2617OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2618
2619/* SSL_CTX_sess_misses returns zero. */
2620OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2621
2622/* SSL_CTX_sess_timeouts returns zero. */
2623OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2624
2625/* SSL_CTX_sess_cache_full returns zero. */
2626OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2627
David Benjamin101ead22015-04-26 18:36:23 -04002628/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2629OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2630
David Benjaminc0454692015-04-27 00:28:56 -04002631/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2632OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2633
2634/* SSL_CTX_need_tmp_RSA returns zero. */
2635OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2636
2637/* SSL_need_tmp_RSA returns zero. */
2638OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2639
2640/* SSL_CTX_set_tmp_rsa returns one. */
2641OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2642
2643/* SSL_set_tmp_rsa returns one. */
2644OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2645
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002646/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002647OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2648
2649/* SSL_CTX_set_read_ahead does nothing. */
2650OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2651
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002652/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002653OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2654
2655/* SSL_set_read_ahead does nothing. */
2656OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2657
David Benjamin44d3eed2015-05-21 01:29:55 -04002658/* SSL_renegotiate put an error on the error queue and returns zero. */
2659OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2660
David Benjaminece089c2015-05-15 23:52:42 -04002661/* SSL_set_state does nothing. */
2662OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2663
David Benjamin71f07942015-04-08 02:36:59 -04002664
Adam Langley7cc3f992015-01-07 15:06:31 -08002665/* Android compatibility section.
2666 *
2667 * These functions are declared, temporarily, for Android because
2668 * wpa_supplicant will take a little time to sync with upstream. Outside of
2669 * Android they'll have no definition. */
2670
2671#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2672
Adam Langleyb4a494c2015-01-23 15:10:10 -08002673OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2674 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002675OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2676OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002677OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2678
2679#define OPENSSL_VERSION_TEXT "BoringSSL"
2680
2681#define SSLEAY_VERSION 0
2682
2683/* SSLeay_version is a compatibility function that returns the string
2684 * "BoringSSL". */
2685OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002686
2687
David Benjamin59015c32015-04-26 13:13:55 -04002688/* Preprocessor compatibility section.
2689 *
2690 * Historically, a number of APIs were implemented in OpenSSL as macros and
2691 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04002692 * section defines a number of legacy macros.
2693 *
2694 * Although using either the CTRL values or their wrapper macros in #ifdefs is
2695 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
2696 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04002697
David Benjamincb3872f2015-06-16 13:20:36 -04002698#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2699#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002700#define SSL_CTRL_CHAIN doesnt_exist
2701#define SSL_CTRL_CHAIN_CERT doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002702#define SSL_CTRL_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002703#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002704#define SSL_CTRL_CLEAR_MODE doesnt_exist
2705#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002706#define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
2707#define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002708#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
David Benjamin75910642015-08-09 10:42:33 -04002709#define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002710#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002711#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002712#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002713#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2714#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
2715#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2716#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
2717#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002718#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002719#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002720#define SSL_CTRL_MODE doesnt_exist
2721#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2722#define SSL_CTRL_OPTIONS doesnt_exist
2723#define SSL_CTRL_SESS_NUMBER doesnt_exist
2724#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
2725#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2726#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002727#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002728#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002729#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002730#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002731#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002732#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002733#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002734#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2735#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002736#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002737#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002738#define SSL_CTRL_SET_TMP_DH doesnt_exist
2739#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2740#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
2741#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
2742#define SSL_CTRL_SET_TMP_RSA doesnt_exist
2743#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002744
David Benjamin8c249802015-05-05 09:44:18 -04002745#define DTLSv1_get_timeout DTLSv1_get_timeout
2746#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamin11c0f8e2015-07-06 00:18:15 -04002747#define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
2748#define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
2749#define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
2750#define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
2751#define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002752#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2753#define SSL_CTX_clear_options SSL_CTX_clear_options
2754#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04002755#define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
2756#define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002757#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2758#define SSL_CTX_get_mode SSL_CTX_get_mode
2759#define SSL_CTX_get_options SSL_CTX_get_options
2760#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2761#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04002762#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002763#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2764#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2765#define SSL_CTX_sess_number SSL_CTX_sess_number
2766#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
David Benjamin11c0f8e2015-07-06 00:18:15 -04002767#define SSL_CTX_set0_chain SSL_CTX_set0_chain
2768#define SSL_CTX_set1_chain SSL_CTX_set1_chain
David Benjamincb3872f2015-06-16 13:20:36 -04002769#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2770#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2771#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2772#define SSL_CTX_set_mode SSL_CTX_set_mode
2773#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2774#define SSL_CTX_set_options SSL_CTX_set_options
2775#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
2776#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2777#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2778#define SSL_CTX_set_tlsext_servername_callback \
2779 SSL_CTX_set_tlsext_servername_callback
2780#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04002781#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002782#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
2783#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
2784#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
David Benjamin11c0f8e2015-07-06 00:18:15 -04002785#define SSL_add0_chain_cert SSL_add0_chain_cert
2786#define SSL_add1_chain_cert SSL_add1_chain_cert
2787#define SSL_clear_chain_certs SSL_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002788#define SSL_clear_mode SSL_clear_mode
2789#define SSL_clear_options SSL_clear_options
2790#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
David Benjamin75910642015-08-09 10:42:33 -04002791#define SSL_get0_certificate_types SSL_get0_certificate_types
David Benjamin11c0f8e2015-07-06 00:18:15 -04002792#define SSL_get0_chain_certs SSL_get0_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002793#define SSL_get_max_cert_list SSL_get_max_cert_list
2794#define SSL_get_mode SSL_get_mode
2795#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04002796#define SSL_get_secure_renegotiation_support \
2797 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04002798#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04002799#define SSL_need_tmp_RSA SSL_need_tmp_RSA
2800#define SSL_num_renegotiations SSL_num_renegotiations
2801#define SSL_session_reused SSL_session_reused
David Benjamin11c0f8e2015-07-06 00:18:15 -04002802#define SSL_set0_chain SSL_set0_chain
2803#define SSL_set1_chain SSL_set1_chain
David Benjamincb3872f2015-06-16 13:20:36 -04002804#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
2805#define SSL_set_max_cert_list SSL_set_max_cert_list
2806#define SSL_set_max_send_fragment SSL_set_max_send_fragment
2807#define SSL_set_mode SSL_set_mode
2808#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
2809#define SSL_set_mtu SSL_set_mtu
2810#define SSL_set_options SSL_set_options
2811#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
2812#define SSL_set_tmp_dh SSL_set_tmp_dh
2813#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
2814#define SSL_set_tmp_rsa SSL_set_tmp_rsa
2815#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04002816
2817
David Benjamin087e4fa2015-04-08 23:46:10 -04002818#if defined(__cplusplus)
2819} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07002820#endif
David Benjamin2e521212014-07-16 14:37:51 -04002821
David Benjamin087e4fa2015-04-08 23:46:10 -04002822
2823/* Library consumers assume these headers are included by ssl.h, but they depend
2824 * on ssl.h, so include them after all declarations.
2825 *
2826 * TODO(davidben): The separation between ssl.h and these version-specific
2827 * headers introduces circular dependencies and is inconsistent. The function
2828 * declarations should move to ssl.h. Many of the constants can probably be
2829 * pruned or unexported. */
David Benjamin087e4fa2015-04-08 23:46:10 -04002830#include <openssl/ssl3.h>
2831#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04002832#include <openssl/srtp.h> /* Support for the use_srtp extension */
2833
2834
David Benjamin2e521212014-07-16 14:37:51 -04002835/* BEGIN ERROR CODES */
2836/* The following lines are auto generated by the script make_errors.go. Any
2837 * changes made after this point may be overwritten when the script is next run.
2838 */
David Benjamin689be0f2015-02-11 15:55:26 -05002839#define SSL_R_APP_DATA_IN_HANDSHAKE 100
2840#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
2841#define SSL_R_BAD_ALERT 102
2842#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
2843#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
2844#define SSL_R_BAD_DH_P_LENGTH 105
2845#define SSL_R_BAD_DIGEST_LENGTH 106
2846#define SSL_R_BAD_ECC_CERT 107
2847#define SSL_R_BAD_ECPOINT 108
2848#define SSL_R_BAD_HANDSHAKE_LENGTH 109
2849#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07002850#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05002851#define SSL_R_BAD_LENGTH 112
2852#define SSL_R_BAD_PACKET_LENGTH 113
2853#define SSL_R_BAD_RSA_ENCRYPT 114
2854#define SSL_R_BAD_SIGNATURE 115
2855#define SSL_R_BAD_SRTP_MKI_VALUE 116
2856#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
2857#define SSL_R_BAD_SSL_FILETYPE 118
2858#define SSL_R_BAD_WRITE_RETRY 119
2859#define SSL_R_BIO_NOT_SET 120
2860#define SSL_R_BN_LIB 121
2861#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
2862#define SSL_R_CA_DN_LENGTH_MISMATCH 123
2863#define SSL_R_CA_DN_TOO_LONG 124
2864#define SSL_R_CCS_RECEIVED_EARLY 125
2865#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
2866#define SSL_R_CERT_CB_ERROR 127
2867#define SSL_R_CERT_LENGTH_MISMATCH 128
2868#define SSL_R_CHANNEL_ID_NOT_P256 129
2869#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
2870#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
2871#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
2872#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
2873#define SSL_R_CLIENTHELLO_TLSEXT 134
2874#define SSL_R_CONNECTION_REJECTED 135
2875#define SSL_R_CONNECTION_TYPE_NOT_SET 136
2876#define SSL_R_COOKIE_MISMATCH 137
2877#define SSL_R_D2I_ECDSA_SIG 138
2878#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
2879#define SSL_R_DATA_LENGTH_TOO_LONG 140
2880#define SSL_R_DECODE_ERROR 141
2881#define SSL_R_DECRYPTION_FAILED 142
2882#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
2883#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
2884#define SSL_R_DIGEST_CHECK_FAILED 145
2885#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
2886#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
2887#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
2888#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
2889#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
2890#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
2891#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
2892#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
2893#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
2894#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
2895#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
2896#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
2897#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
2898#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
2899#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
2900#define SSL_R_HTTPS_PROXY_REQUEST 161
2901#define SSL_R_HTTP_REQUEST 162
2902#define SSL_R_INAPPROPRIATE_FALLBACK 163
2903#define SSL_R_INVALID_COMMAND 164
2904#define SSL_R_INVALID_MESSAGE 165
2905#define SSL_R_INVALID_SSL_SESSION 166
2906#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
2907#define SSL_R_LENGTH_MISMATCH 168
2908#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
2909#define SSL_R_MISSING_DH_KEY 170
2910#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
2911#define SSL_R_MISSING_RSA_CERTIFICATE 172
2912#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
2913#define SSL_R_MISSING_RSA_SIGNING_CERT 174
2914#define SSL_R_MISSING_TMP_DH_KEY 175
2915#define SSL_R_MISSING_TMP_ECDH_KEY 176
2916#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
2917#define SSL_R_MTU_TOO_SMALL 178
2918#define SSL_R_NESTED_GROUP 179
2919#define SSL_R_NO_CERTIFICATES_RETURNED 180
2920#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
2921#define SSL_R_NO_CERTIFICATE_SET 182
2922#define SSL_R_NO_CIPHERS_AVAILABLE 183
2923#define SSL_R_NO_CIPHERS_PASSED 184
2924#define SSL_R_NO_CIPHERS_SPECIFIED 185
2925#define SSL_R_NO_CIPHER_MATCH 186
2926#define SSL_R_NO_COMPRESSION_SPECIFIED 187
2927#define SSL_R_NO_METHOD_SPECIFIED 188
2928#define SSL_R_NO_P256_SUPPORT 189
2929#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
2930#define SSL_R_NO_RENEGOTIATION 191
2931#define SSL_R_NO_REQUIRED_DIGEST 192
2932#define SSL_R_NO_SHARED_CIPHER 193
2933#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
2934#define SSL_R_NO_SRTP_PROFILES 195
2935#define SSL_R_NULL_SSL_CTX 196
2936#define SSL_R_NULL_SSL_METHOD_PASSED 197
2937#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
2938#define SSL_R_PACKET_LENGTH_TOO_LONG 199
2939#define SSL_R_PARSE_TLSEXT 200
2940#define SSL_R_PATH_TOO_LONG 201
2941#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
2942#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
2943#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
2944#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
2945#define SSL_R_PSK_NO_CLIENT_CB 206
2946#define SSL_R_PSK_NO_SERVER_CB 207
2947#define SSL_R_READ_BIO_NOT_SET 208
2948#define SSL_R_READ_TIMEOUT_EXPIRED 209
2949#define SSL_R_RECORD_LENGTH_MISMATCH 210
2950#define SSL_R_RECORD_TOO_LARGE 211
2951#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
2952#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
2953#define SSL_R_RENEGOTIATION_MISMATCH 214
2954#define SSL_R_REQUIRED_CIPHER_MISSING 215
2955#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
2956#define SSL_R_SERVERHELLO_TLSEXT 217
2957#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
2958#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
2959#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
2960#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
2961#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
2962#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
2963#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
2964#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
2965#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
2966#define SSL_R_SSL_HANDSHAKE_FAILURE 227
2967#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
2968#define SSL_R_SSL_SESSION_ID_CONFLICT 229
2969#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
2970#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
2971#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
2972#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
2973#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
2974#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
2975#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
2976#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
2977#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
2978#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
2979#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
2980#define SSL_R_UNEXPECTED_MESSAGE 241
2981#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
2982#define SSL_R_UNEXPECTED_RECORD 243
2983#define SSL_R_UNINITIALIZED 244
2984#define SSL_R_UNKNOWN_ALERT_TYPE 245
2985#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
2986#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
2987#define SSL_R_UNKNOWN_CIPHER_TYPE 248
2988#define SSL_R_UNKNOWN_DIGEST 249
2989#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
2990#define SSL_R_UNKNOWN_PROTOCOL 251
2991#define SSL_R_UNKNOWN_SSL_VERSION 252
2992#define SSL_R_UNKNOWN_STATE 253
2993#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
2994#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
2995#define SSL_R_UNSUPPORTED_CIPHER 256
2996#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
2997#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
2998#define SSL_R_UNSUPPORTED_PROTOCOL 259
2999#define SSL_R_UNSUPPORTED_SSL_VERSION 260
3000#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07003001#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05003002#define SSL_R_WRONG_CIPHER_RETURNED 263
3003#define SSL_R_WRONG_CURVE 264
3004#define SSL_R_WRONG_MESSAGE_TYPE 265
3005#define SSL_R_WRONG_SIGNATURE_TYPE 266
3006#define SSL_R_WRONG_SSL_VERSION 267
3007#define SSL_R_WRONG_VERSION_NUMBER 268
3008#define SSL_R_X509_LIB 269
3009#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05003010#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04003011#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04003012#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05003013#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07003014#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
3015#define SSL_R_EMS_STATE_INCONSISTENT 276
3016#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04003017#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07003018#define SSL_R_UNEXPECTED_EXTENSION 279
Adam Langley2e857bd2015-07-01 16:09:19 -07003019#define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
Adam Langley33ad2b52015-07-20 17:43:53 -07003020#define SSL_R_ERROR_ADDING_EXTENSION 281
3021#define SSL_R_ERROR_PARSING_EXTENSION 282
3022#define SSL_R_MISSING_EXTENSION 283
Adam Langley09505632015-07-30 18:10:13 -07003023#define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
3024#define SSL_R_CUSTOM_EXTENSION_ERROR 285
David Benjamind7c53682014-09-17 12:08:13 -04003025#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04003026#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
3027#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
3028#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
3029#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
3030#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
3031#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
3032#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
3033#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
3034#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
3035#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
3036#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
3037#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
3038#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
3039#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
3040#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
3041#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
3042#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
3043#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
3044#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
3045#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
3046#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04003047#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04003048#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
3049#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
3050#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
3051#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
3052#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
3053#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
3054#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07003055
David Benjamin087e4fa2015-04-08 23:46:10 -04003056#endif /* OPENSSL_HEADER_SSL_H */