blob: ec901f517ec07bb08f92f310aea3b98204c89a3f [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;
199
200 /* algorithm2 contains extra flags. See ssl/internal.h. */
201 uint32_t algorithm2;
202
203 /* strength_bits is the strength of the cipher in bits. */
204 int strength_bits;
205 /* alg_bits is the number of bits of key material used by the algorithm. */
206 int alg_bits;
207} SSL_CIPHER;
208
209DECLARE_STACK_OF(SSL_CIPHER)
210
211/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
212 * suite based on its assigned number, or NULL if unknown. See
213 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
214OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
215
216/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
217 * get the cipher suite value. */
218OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
219
220/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
221 * mode). */
222OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
223
224/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
225OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
226
227/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
228OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
229
230/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
231 * CHACHA20_POLY1305. */
232OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
233
234/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
235OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
236
237/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
238 * method used by |cipher|. For example, "ECDHE_ECDSA". */
239OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
240
241/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
David Benjamin3fa65f02015-05-15 19:11:57 -0400242 * name for |cipher| or NULL on error. For example,
243 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
244 * calling |OPENSSL_free| on the result. */
David Benjamin71f07942015-04-08 02:36:59 -0400245OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
246
247/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
248 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
249 * symmetric algorithm to |*out_alg_bits|. */
250OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
251 int *out_alg_bits);
252
253
David Benjamin4831c332015-05-16 11:43:13 -0400254/* SSL contexts. */
255
256/* An SSL_METHOD selects whether to use TLS or DTLS. */
257typedef struct ssl_method_st SSL_METHOD;
258
259/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
260OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
261
262/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
263OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
264
265/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
266 * on error. An |SSL_CTX| manages shared state and configuration between
267 * multiple TLS or DTLS connections. */
268OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
269
270/* SSL_CTX_free releases memory associated with |ctx|. */
271OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
272
273
274/* SSL connections. */
275
276/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
277 * |SSL| object represents a single TLS or DTLS connection. It inherits settings
278 * from |ctx| at the time of creation. Settings may also be individually
279 * configured on the connection.
280 *
281 * On creation, an |SSL| is not configured to be either a client or server. Call
282 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
283OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
284
285/* SSL_free releases memory associated with |ssl|. */
286OPENSSL_EXPORT void SSL_free(SSL *ssl);
287
288/* SSL_set_connect_state configures |ssl| to be a client. */
289OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
290
291/* SSL_set_accept_state configures |ssl| to be a server. */
292OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
293
294
David Benjaminb487df62015-05-16 15:31:07 -0400295/* Protocol versions. */
296
297#define SSL3_VERSION_MAJOR 0x03
298
299#define SSL3_VERSION 0x0300
300#define TLS1_VERSION 0x0301
301#define TLS1_1_VERSION 0x0302
302#define TLS1_2_VERSION 0x0303
303
304#define DTLS1_VERSION 0xfeff
305#define DTLS1_2_VERSION 0xfefd
306
307/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
308 * |version|. */
309OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
310
311/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
312 * |version|. */
313OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
314
315/* SSL_set_min_version sets the minimum protocol version for |ssl| to
316 * |version|. */
317OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
318
319/* SSL_set_max_version sets the maximum protocol version for |ssl| to
320 * |version|. */
321OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
322
323
324/* Options.
325 *
326 * Options configure protocol behavior. */
327
328/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
329 * support the renegotiation_info extension (RFC 5746). It is on by default. */
330#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
331
332/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
333 * bytes above the maximum record size. */
334#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
335
336/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
337 * (i.e. without a length prefix). */
338#define SSL_OP_TLS_D5_BUG 0x00000100L
339
340/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
341 * consumers.
342 * TODO(davidben): Determine which of the remaining may be removed now. */
343#define SSL_OP_ALL 0x00000BFFL
344
345/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
346 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
347#define SSL_OP_NO_QUERY_MTU 0x00001000L
348
349/* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
350#define SSL_OP_NO_TICKET 0x00004000L
351
352/* SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION permits unsafe legacy renegotiation
353 * without renegotiation_info (RFC 5746) support. */
354#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0x00040000L
355
356/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
357 * ECDHE curves according to the server's preferences instead of the
358 * client's. */
359#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
360
361/* The following flags toggle individual protocol versions. This is deprecated.
362 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
363#define SSL_OP_NO_SSLv3 0x02000000L
364#define SSL_OP_NO_TLSv1 0x04000000L
365#define SSL_OP_NO_TLSv1_2 0x08000000L
366#define SSL_OP_NO_TLSv1_1 0x10000000L
367#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
368#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
369
370/* The following flags do nothing and are included only to make it easier to
371 * compile code with BoringSSL. */
372#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
373#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
374#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
375#define SSL_OP_NO_COMPRESSION 0
376#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
377#define SSL_OP_NO_SSLv2 0
378#define SSL_OP_SINGLE_DH_USE 0
379#define SSL_OP_SINGLE_ECDH_USE 0
380#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
381#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
382#define SSL_OP_TLS_ROLLBACK_BUG 0
383
384/* SSL_CTX_set_options enables all options set in |options| (which should be one
385 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
386 * bitmask representing the resulting enabled options. */
387OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
388
389/* SSL_CTX_clear_options disables all options set in |options| (which should be
390 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
391 * bitmask representing the resulting enabled options. */
392OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
393
394/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
395 * the options enabled for |ctx|. */
396OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
397
398/* SSL_set_options enables all options set in |options| (which should be one or
399 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
400 * representing the resulting enabled options. */
401OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
402
403/* SSL_clear_options disables all options set in |options| (which should be one
404 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
405 * bitmask representing the resulting enabled options. */
406OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
407
408/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
409 * options enabled for |ssl|. */
410OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
411
412
413/* Modes.
414 *
415 * Modes configure API behavior. */
416
417/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
418 * result when the only part of the input was written in a single record. */
419#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
420
421/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
422 * with a different buffer. However, |SSL_write| still assumes the buffer
423 * contents are unchanged. This is not the default to avoid the misconception
424 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
425#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
426
427/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
428 * before sending certificates to the peer.
429 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
430#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
431
David Benjaminb487df62015-05-16 15:31:07 -0400432/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
433 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
434 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
435#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
436
437/* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
438 * SSL_MODE_ENABLE_FALSE_START. */
439#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
440
441/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
442 * TLS 1.0 to be split in two: the first record will contain a single byte and
443 * the second will contain the remainder. This effectively randomises the IV and
444 * prevents BEAST attacks. */
445#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
446
447/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
448 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
449 * session resumption is used for a given SSL*. */
450#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
451
452/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
453 * To be set only by applications that reconnect with a downgraded protocol
454 * version; see https://tools.ietf.org/html/draft-ietf-tls-downgrade-scsv-05
455 * for details.
456 *
457 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
458 * this in explicit fallback retries, following the guidance in
459 * draft-ietf-tls-downgrade-scsv-05. */
460#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
461
462/* The following flags do nothing and are included only to make it easier to
463 * compile code with BoringSSL. */
464#define SSL_MODE_AUTO_RETRY 0
465#define SSL_MODE_RELEASE_BUFFERS 0
David Benjamin74d8bc22015-05-21 02:16:53 -0400466#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
467#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjaminb487df62015-05-16 15:31:07 -0400468
469/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
470 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
471 * representing the resulting enabled modes. */
472OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
473
474/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
475 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
476 * bitmask representing the resulting enabled modes. */
477OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
478
479/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
480 * the modes enabled for |ssl|. */
481OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
482
483/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
484 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
485 * representing the resulting enabled modes. */
486OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
487
488/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
489 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
490 * representing the resulting enabled modes. */
491OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
492
493/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
494 * modes enabled for |ssl|. */
495OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
496
497
David Benjaminb4d65fd2015-05-29 17:11:21 -0400498/* Configuring certificates and private keys.
499 *
500 * TODO(davidben): Move the other, more conventional, certificate and key
501 * configuration functions here, possibly after simplifying the multiple slots
502 * machinery first. https://crbug.com/486295. */
503
504enum ssl_private_key_result_t {
505 ssl_private_key_success,
506 ssl_private_key_retry,
507 ssl_private_key_failure,
508};
509
510/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
511 * signing operations to a custom, potentially asynchronous, backend. */
512typedef struct ssl_private_key_method_st {
513 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
514 * key used by |ssl|. */
515 int (*type)(SSL *ssl);
516
517 /* supports_digest returns one if the key used by |ssl| supports signing
518 * digests of type |md| and zero otherwise. */
519 int (*supports_digest)(SSL *ssl, const EVP_MD *md);
520
521 /* max_signature_len returns the maximum length of a signature signed by the
522 * key used by |ssl|. This must be a constant value for a given |ssl|. */
523 size_t (*max_signature_len)(SSL *ssl);
524
525 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
526 * used to calculate |in|. On success, it returns |ssl_private_key_success|
527 * and writes at most |max_out| bytes of signature data to |out|. On failure,
528 * it returns |ssl_private_key_failure|. If the operation has not completed,
529 * it returns |ssl_private_key_retry|. |sign| should arrange for the
530 * high-level operation on |ssl| to be retried when the operation is
531 * completed. This will result in a call to |sign_complete|.
532 *
533 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
534 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
535 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
536 *
537 * It is an error to call |sign| while another private key operation is in
538 * progress on |ssl|. */
539 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
540 size_t max_out, const EVP_MD *md,
541 const uint8_t *in, size_t in_len);
542
543 /* sign_complete completes a pending |sign| operation. If the operation has
544 * completed, it returns |ssl_private_key_success| and writes the result to
545 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
546 * failure and |ssl_private_key_retry| if the operation is still in progress.
547 *
548 * |sign_complete| may be called arbitrarily many times before completion, but
549 * it is an error to call |sign_complete| if there is no pending |sign|
550 * operation in progress on |ssl|. */
551 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
552 size_t *out_len, size_t max_out);
553} SSL_PRIVATE_KEY_METHOD;
554
555/* SSL_use_private_key_method configures a custom private key on
556 * |ssl|. |key_method| must remain valid for the lifetime of |ssl|. Using custom
557 * keys with the multiple certificate slots feature is not supported.
558 *
559 * TODO(davidben): Remove the multiple certificate slots feature. */
560OPENSSL_EXPORT void SSL_set_private_key_method(
561 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
562
563
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700564/* Connection information. */
565
566/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
567 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
568 * returns one on success or zero on error. In general |max_out| should be at
569 * least 12.
570 *
571 * This function will always fail if the initial handshake has not completed.
572 * The tls-unique value will change after a renegotiation but, since
573 * renegotiations can be initiated by the server at any point, the higher-level
574 * protocol must either leave them disabled or define states in which the
575 * tls-unique value can be read.
576 *
577 * The tls-unique value is defined by
578 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
579 * TLS protocol, tls-unique is broken for resumed connections unless the
580 * Extended Master Secret extension is negotiated. Thus this function will
581 * return zero if |ssl| performed session resumption unless EMS was used when
582 * negotiating the original session. */
583OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
584 size_t *out_len, size_t max_out);
585
586
David Benjamin71f07942015-04-08 02:36:59 -0400587/* Underdocumented functions.
588 *
589 * Functions below here haven't been touched up and may be underdocumented. */
590
Adam Langley95c29f32014-06-20 12:00:00 -0700591/* SSLeay version number for ASN.1 encoding of the session information */
592/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -0800593 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -0700594#define SSL_SESSION_ASN1_VERSION 0x0001
595
Adam Langleyb4a494c2015-01-23 15:10:10 -0800596#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
597#define SSL_MAX_SID_CTX_LENGTH 32
598#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -0700599
600/* These are used to specify which ciphers to use and not to use */
601
Adam Langleyb4a494c2015-01-23 15:10:10 -0800602#define SSL_TXT_MEDIUM "MEDIUM"
603#define SSL_TXT_HIGH "HIGH"
604#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -0700605
Adam Langleyb4a494c2015-01-23 15:10:10 -0800606#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -0400607#define SSL_TXT_kDHE "kDHE"
608#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
609#define SSL_TXT_kECDHE "kECDHE"
610#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800611#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700612
Adam Langleyb4a494c2015-01-23 15:10:10 -0800613#define SSL_TXT_aRSA "aRSA"
614#define SSL_TXT_aECDSA "aECDSA"
615#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700616
Adam Langleyb4a494c2015-01-23 15:10:10 -0800617#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400618#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400619#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800620#define SSL_TXT_RSA "RSA"
621#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400622#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400623#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800624#define SSL_TXT_ECDSA "ECDSA"
625#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700626
Adam Langleyb4a494c2015-01-23 15:10:10 -0800627#define SSL_TXT_3DES "3DES"
628#define SSL_TXT_RC4 "RC4"
629#define SSL_TXT_AES128 "AES128"
630#define SSL_TXT_AES256 "AES256"
631#define SSL_TXT_AES "AES"
632#define SSL_TXT_AES_GCM "AESGCM"
633#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -0700634
Adam Langleyb4a494c2015-01-23 15:10:10 -0800635#define SSL_TXT_MD5 "MD5"
636#define SSL_TXT_SHA1 "SHA1"
637#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
638#define SSL_TXT_SHA256 "SHA256"
639#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -0700640
Adam Langleyb4a494c2015-01-23 15:10:10 -0800641#define SSL_TXT_SSLV3 "SSLv3"
642#define SSL_TXT_TLSV1 "TLSv1"
643#define SSL_TXT_TLSV1_1 "TLSv1.1"
644#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -0700645
Adam Langleyb4a494c2015-01-23 15:10:10 -0800646#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -0700647
Adam Langleyb4a494c2015-01-23 15:10:10 -0800648/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
649 * normally not being used.
650 *
651 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
652 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
653 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
654 * that it is also disabled in the specific selection. COMPLEMENTOF*
655 * identifiers are portable between version, as adjustments to the default
656 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -0700657 *
658 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -0800659 * DEFAULT gets, as only selection is being done and no sorting as needed for
660 * DEFAULT. */
661#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -0700662
Adam Langleyb4a494c2015-01-23 15:10:10 -0800663/* The following cipher list is used by default. It also is substituted when an
664 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -0400665#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -0800666
Adam Langley95c29f32014-06-20 12:00:00 -0700667/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
668 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -0800669 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
670 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -0700671
672/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800673#define SSL_SENT_SHUTDOWN 1
674#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -0700675
Adam Langleyb4a494c2015-01-23 15:10:10 -0800676#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
677#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
Adam Langley95c29f32014-06-20 12:00:00 -0700678
David Benjamin82c9e902014-12-12 15:55:27 -0500679typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700680typedef struct ssl_session_st SSL_SESSION;
681typedef struct tls_sigalgs_st TLS_SIGALGS;
682typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -0500683typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700684
Adam Langleyb4a494c2015-01-23 15:10:10 -0800685/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
686typedef struct srtp_protection_profile_st {
687 const char *name;
688 unsigned long id;
689} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -0700690
691DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
692
David Benjamin83fd6b62014-10-19 04:33:38 -0400693/* An SSL_SESSION represents an SSL session that may be resumed in an
694 * abbreviated handshake. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800695struct ssl_session_st {
696 int ssl_version; /* what ssl version session info is being kept in here? */
Adam Langley95c29f32014-06-20 12:00:00 -0700697
Adam Langleyb4a494c2015-01-23 15:10:10 -0800698 int master_key_length;
699 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
700 /* session_id - valid? */
701 unsigned int session_id_length;
702 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
703 /* this is used to determine whether the session is being reused in
704 * the appropriate context. It is up to the application to set this,
705 * via SSL_new */
706 unsigned int sid_ctx_length;
707 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -0700708
Adam Langleyb4a494c2015-01-23 15:10:10 -0800709 char *psk_identity;
710 /* Used to indicate that session resumption is not allowed. Applications can
711 * also set this bit for a new session via not_resumable_session_cb to
712 * disable session caching and tickets. */
713 int not_resumable;
Adam Langley95c29f32014-06-20 12:00:00 -0700714
David Benjamin680ca962015-06-18 12:37:23 -0400715 /* The cert is the certificate used to establish this connection
716 *
717 * TODO(davidben): Remove this field. It is not serialized as part of the
718 * session, but some APIs access it. Certificate-related fields, where not
719 * redundant with |peer|, should be added to the session. Others should
720 * probably not be retained across resumptions. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800721 struct sess_cert_st /* SESS_CERT */ *sess_cert;
Adam Langley95c29f32014-06-20 12:00:00 -0700722
Adam Langleyb4a494c2015-01-23 15:10:10 -0800723 /* This is the cert for the other end. On clients, it will be the same as
724 * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is not
725 * retained in the external representation of sessions, see ssl_asn1.c). */
726 X509 *peer;
727 /* when app_verify_callback accepts a session where the peer's certificate is
728 * not ok, we must remember the error for session reuse: */
729 long verify_result; /* only for servers */
Adam Langley95c29f32014-06-20 12:00:00 -0700730
Adam Langley0b5e3902015-05-15 13:08:38 -0700731 CRYPTO_refcount_t references;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800732 long timeout;
733 long time;
Adam Langley95c29f32014-06-20 12:00:00 -0700734
Adam Langleyb4a494c2015-01-23 15:10:10 -0800735 const SSL_CIPHER *cipher;
Adam Langley95c29f32014-06-20 12:00:00 -0700736
Adam Langleyb4a494c2015-01-23 15:10:10 -0800737 CRYPTO_EX_DATA ex_data; /* application specific data */
Adam Langley95c29f32014-06-20 12:00:00 -0700738
Adam Langleyb4a494c2015-01-23 15:10:10 -0800739 /* These are used to make removal of session-ids more efficient and to
740 * implement a maximum cache size. */
David Benjamin4dab2972015-05-16 02:56:06 -0400741 SSL_SESSION *prev, *next;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800742 char *tlsext_hostname;
743 /* RFC4507 info */
744 uint8_t *tlsext_tick; /* Session ticket */
745 size_t tlsext_ticklen; /* Session ticket length */
746 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
David Benjamin6c7aed02014-08-27 16:42:38 -0400747
Adam Langleyb4a494c2015-01-23 15:10:10 -0800748 size_t tlsext_signed_cert_timestamp_list_length;
749 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
David Benjamin6c7aed02014-08-27 16:42:38 -0400750
Adam Langleyb4a494c2015-01-23 15:10:10 -0800751 /* The OCSP response that came with the session. */
752 size_t ocsp_response_length;
753 uint8_t *ocsp_response;
David Benjamin6c7aed02014-08-27 16:42:38 -0400754
Adam Langleyb4a494c2015-01-23 15:10:10 -0800755 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
756 uint8_t
757 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
Adam Langley1258b6a2014-06-20 12:00:00 -0700758
Adam Langleyb4a494c2015-01-23 15:10:10 -0800759 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
760 * SHA-2, depending on TLS version) for the original, full handshake that
761 * created a session. This is used by Channel IDs during resumption. */
762 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
763 unsigned int original_handshake_hash_len;
Adam Langley75712922014-10-10 16:23:43 -0700764
Adam Langleyb4a494c2015-01-23 15:10:10 -0800765 /* extended_master_secret is true if the master secret in this session was
766 * generated using EMS and thus isn't vulnerable to the Triple Handshake
767 * attack. */
768 char extended_master_secret;
769};
Adam Langley95c29f32014-06-20 12:00:00 -0700770
Adam Langley95c29f32014-06-20 12:00:00 -0700771
772/* Cert related flags */
773/* Many implementations ignore some aspects of the TLS standards such as
Adam Langleyb4a494c2015-01-23 15:10:10 -0800774 * enforcing certifcate chain algorithms. When this is set we enforce them. */
775#define SSL_CERT_FLAG_TLS_STRICT 0x00000001L
Adam Langley95c29f32014-06-20 12:00:00 -0700776
Adam Langley95c29f32014-06-20 12:00:00 -0700777/* Flags for building certificate chains */
778/* Treat any existing certificates as untrusted CAs */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800779#define SSL_BUILD_CHAIN_FLAG_UNTRUSTED 0x1
Adam Langley95c29f32014-06-20 12:00:00 -0700780/* Don't include root CA in chain */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800781#define SSL_BUILD_CHAIN_FLAG_NO_ROOT 0x2
Adam Langleyf669c2d2014-06-20 12:00:00 -0700782/* Just check certificates already there */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800783#define SSL_BUILD_CHAIN_FLAG_CHECK 0x4
Adam Langleyf669c2d2014-06-20 12:00:00 -0700784/* Ignore verification errors */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800785#define SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR 0x8
Adam Langley64c22232014-06-20 12:00:00 -0700786/* Clear verification errors from queue */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800787#define SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR 0x10
Adam Langley95c29f32014-06-20 12:00:00 -0700788
David Benjamincb9cf792015-05-05 09:46:14 -0400789/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
790 * and zero on failure. */
791OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -0700792
David Benjamincb9cf792015-05-05 09:46:14 -0400793/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
794 * renegotiation (RFC 5746) and zero otherwise. */
795OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -0700796
David Benjamin59015c32015-04-26 13:13:55 -0400797/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
798 * This callback will be called when sending or receiving low-level record
799 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
800 * |write_p| is one for outgoing messages and zero for incoming messages.
801 *
802 * For each record header, |cb| is called with |version| = 0 and |content_type|
803 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
804 * this does not include the record body. If the record is sealed, the length
805 * in the header is the length of the ciphertext.
806 *
807 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
808 * protocol version and |content_type| is the corresponding record type. The
809 * |len| bytes from |buf| contain the handshake message, one-byte
810 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800811OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
812 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
813 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -0400814
David Benjamin61ecccf2015-05-05 09:44:51 -0400815/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
816 * callback. */
817OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
818
David Benjamin59015c32015-04-26 13:13:55 -0400819/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
820 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800821OPENSSL_EXPORT void SSL_set_msg_callback(
822 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
823 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -0400824
David Benjamin3b7456e2015-05-16 12:29:32 -0400825/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -0400826OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -0700827
David Benjamin859ec3c2014-09-02 16:29:36 -0400828/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -0800829 * log session material to |keylog_bio|. This is intended for debugging use
830 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -0400831 *
832 * The format is described in
833 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -0400834OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -0400835
Adam Langley95c29f32014-06-20 12:00:00 -0700836
Adam Langleyc9fb3752014-06-20 12:00:00 -0700837struct ssl_aead_ctx_st;
838typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
839
Adam Langleyb4a494c2015-01-23 15:10:10 -0800840#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -0700841
Adam Langleyb4a494c2015-01-23 15:10:10 -0800842#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -0700843
David Benjaminf4501342014-08-14 17:24:37 -0400844#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
845
Adam Langleyb4a494c2015-01-23 15:10:10 -0800846/* This callback type is used inside SSL_CTX, SSL, and in the functions that
847 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -0700848 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -0800849 * callbacks should themselves check if the id they generate is unique
850 * otherwise the SSL handshake will fail with an error - callbacks can do this
851 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -0700852 * SSL_has_matching_session_id(ssl, id, *id_len)
853 * The length value passed in is set at the maximum size the session ID can be.
854 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
855 * can alter this length to be less if desired, but under SSLv2 session IDs are
856 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -0800857 * returns in this case. It is also an error for the callback to set the size
858 * to zero. */
859typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
860 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700861
Adam Langleydc9b1412014-06-20 12:00:00 -0700862/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -0800863 * early on during the server handshake. At this point, much of the SSL* hasn't
864 * been filled out and only the ClientHello can be depended on. */
865struct ssl_early_callback_ctx {
866 SSL *ssl;
867 const uint8_t *client_hello;
868 size_t client_hello_len;
869 const uint8_t *session_id;
870 size_t session_id_len;
871 const uint8_t *cipher_suites;
872 size_t cipher_suites_len;
873 const uint8_t *compression_methods;
874 size_t compression_methods_len;
875 const uint8_t *extensions;
876 size_t extensions_len;
877};
Adam Langleydc9b1412014-06-20 12:00:00 -0700878
Adam Langleyb4a494c2015-01-23 15:10:10 -0800879/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
880 * extension of the given type. If not found, it returns zero. Otherwise it
881 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -0700882 * and length bytes), sets |out_len| to the length of the extension contents
883 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800884OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
885 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
886 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -0700887
Adam Langley95c29f32014-06-20 12:00:00 -0700888typedef struct ssl_comp_st SSL_COMP;
889
Adam Langleyb4a494c2015-01-23 15:10:10 -0800890struct ssl_comp_st {
891 int id;
892 const char *name;
893 char *method;
894};
Adam Langley95c29f32014-06-20 12:00:00 -0700895
896DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -0700897DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -0700898
Adam Langley858a88d2014-06-20 12:00:00 -0700899/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
900 * equal-preference groups. For TLS clients, the groups are moot because the
901 * server picks the cipher and groups cannot be expressed on the wire. However,
902 * for servers, the equal-preference groups allow the client's preferences to
903 * be partially respected. (This only has an effect with
904 * SSL_OP_CIPHER_SERVER_PREFERENCE).
905 *
906 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
907 * All elements of a group have the same priority: no ordering is expressed
908 * within a group.
909 *
910 * The values in |ciphers| are in one-to-one correspondence with
911 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
912 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
913 * indicate that the corresponding SSL_CIPHER is not the last element of a
914 * group, or 0 to indicate that it is.
915 *
916 * For example, if |in_group_flags| contains all zeros then that indicates a
917 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
918 * of the group (i.e. they are all in a one-element group).
919 *
920 * For a more complex example, consider:
921 * ciphers: A B C D E F
922 * in_group_flags: 1 1 0 0 1 0
923 *
924 * That would express the following, order:
925 *
926 * A E
927 * B -> D -> F
928 * C
929 */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800930struct ssl_cipher_preference_list_st {
931 STACK_OF(SSL_CIPHER) *ciphers;
932 uint8_t *in_group_flags;
933};
Adam Langley858a88d2014-06-20 12:00:00 -0700934
Adam Langleyb4a494c2015-01-23 15:10:10 -0800935struct ssl_ctx_st {
936 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -0700937
Adam Langley4bdb6e42015-05-15 15:29:21 -0700938 /* lock is used to protect various operations on this object. */
939 CRYPTO_MUTEX lock;
940
Adam Langleyb4a494c2015-01-23 15:10:10 -0800941 /* max_version is the maximum acceptable protocol version. If zero, the
942 * maximum supported version, currently (D)TLS 1.2, is used. */
943 uint16_t max_version;
David Benjamin1eb367c2014-12-12 18:17:51 -0500944
Adam Langleyb4a494c2015-01-23 15:10:10 -0800945 /* min_version is the minimum acceptable protocl version. If zero, the
946 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
947 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -0500948
Adam Langleyb4a494c2015-01-23 15:10:10 -0800949 struct ssl_cipher_preference_list_st *cipher_list;
950 /* same as above but sorted for lookup */
951 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
952 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
953 * use. This only applies to server connections as, for clients, the version
954 * number is known at connect time and so the cipher list can be set then. */
955 struct ssl_cipher_preference_list_st *cipher_list_tls11;
Adam Langley95c29f32014-06-20 12:00:00 -0700956
David Benjamin4dab2972015-05-16 02:56:06 -0400957 X509_STORE *cert_store;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800958 LHASH_OF(SSL_SESSION) *sessions;
959 /* Most session-ids that will be cached, default is
960 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
961 unsigned long session_cache_size;
David Benjamin4dab2972015-05-16 02:56:06 -0400962 SSL_SESSION *session_cache_head;
963 SSL_SESSION *session_cache_tail;
Adam Langley95c29f32014-06-20 12:00:00 -0700964
David Benjaminb6d0c6d2015-03-19 19:07:26 -0400965 /* handshakes_since_cache_flush is the number of successful handshakes since
966 * the last cache flush. */
967 int handshakes_since_cache_flush;
968
Adam Langleyb4a494c2015-01-23 15:10:10 -0800969 /* This can have one of 2 values, ored together,
970 * SSL_SESS_CACHE_CLIENT,
971 * SSL_SESS_CACHE_SERVER,
972 * Default is SSL_SESSION_CACHE_SERVER, which means only
973 * SSL_accept which cache SSL_SESSIONS. */
974 int session_cache_mode;
Adam Langley95c29f32014-06-20 12:00:00 -0700975
Adam Langleyb4a494c2015-01-23 15:10:10 -0800976 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
977 * called. This has been put in to make life easier to set things up */
978 long session_timeout;
Adam Langley95c29f32014-06-20 12:00:00 -0700979
Adam Langleyb4a494c2015-01-23 15:10:10 -0800980 /* If this callback is not null, it will be called each time a session id is
981 * added to the cache. If this function returns 1, it means that the
982 * callback will do a SSL_SESSION_free() when it has finished using it.
983 * Otherwise, on 0, it means the callback has finished with it. If
984 * remove_session_cb is not null, it will be called when a session-id is
985 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
986 * it. */
David Benjamin4dab2972015-05-16 02:56:06 -0400987 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
988 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
989 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -0800990 int *copy);
Adam Langley95c29f32014-06-20 12:00:00 -0700991
Adam Langley0b5e3902015-05-15 13:08:38 -0700992 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -0700993
Adam Langleyb4a494c2015-01-23 15:10:10 -0800994 /* if defined, these override the X509_verify_cert() calls */
995 int (*app_verify_callback)(X509_STORE_CTX *, void *);
996 void *app_verify_arg;
997 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
998 * was called with just one argument) */
Adam Langley95c29f32014-06-20 12:00:00 -0700999
Adam Langleyb4a494c2015-01-23 15:10:10 -08001000 /* Default password callback. */
1001 pem_password_cb *default_passwd_callback;
Adam Langley95c29f32014-06-20 12:00:00 -07001002
Adam Langleyb4a494c2015-01-23 15:10:10 -08001003 /* Default password callback user data. */
1004 void *default_passwd_callback_userdata;
Adam Langley95c29f32014-06-20 12:00:00 -07001005
Adam Langleyb4a494c2015-01-23 15:10:10 -08001006 /* get client cert callback */
1007 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
Adam Langley95c29f32014-06-20 12:00:00 -07001008
Adam Langleyb4a494c2015-01-23 15:10:10 -08001009 /* get channel id callback */
1010 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
Adam Langley1258b6a2014-06-20 12:00:00 -07001011
Adam Langleyb4a494c2015-01-23 15:10:10 -08001012 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001013
Adam Langleyb4a494c2015-01-23 15:10:10 -08001014 STACK_OF(X509) *extra_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001015
1016
Adam Langleyb4a494c2015-01-23 15:10:10 -08001017 /* Default values used when no per-SSL value is defined follow */
Adam Langley95c29f32014-06-20 12:00:00 -07001018
Adam Langleyb4a494c2015-01-23 15:10:10 -08001019 void (*info_callback)(const SSL *ssl, int type,
1020 int val); /* used if SSL's info_callback is NULL */
Adam Langley95c29f32014-06-20 12:00:00 -07001021
Adam Langleyb4a494c2015-01-23 15:10:10 -08001022 /* what we put in client cert requests */
1023 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001024
1025
Adam Langleyb4a494c2015-01-23 15:10:10 -08001026 /* Default values to use in SSL structures follow (these are copied by
1027 * SSL_new) */
Adam Langley95c29f32014-06-20 12:00:00 -07001028
David Benjamin123a8fd2015-04-26 14:16:41 -04001029 uint32_t options;
1030 uint32_t mode;
David Benjamin1d0a1942015-04-26 15:35:35 -04001031 uint32_t max_cert_list;
Adam Langley95c29f32014-06-20 12:00:00 -07001032
Adam Langleyb4a494c2015-01-23 15:10:10 -08001033 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001034
Adam Langleyb4a494c2015-01-23 15:10:10 -08001035 /* callback that allows applications to peek at protocol messages */
1036 void (*msg_callback)(int write_p, int version, int content_type,
1037 const void *buf, size_t len, SSL *ssl, void *arg);
1038 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001039
Adam Langleyb4a494c2015-01-23 15:10:10 -08001040 int verify_mode;
1041 unsigned int sid_ctx_length;
1042 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1043 int (*default_verify_callback)(
1044 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
Adam Langley95c29f32014-06-20 12:00:00 -07001045
Adam Langleyb4a494c2015-01-23 15:10:10 -08001046 /* Default generate session ID callback. */
1047 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001048
Adam Langleyb4a494c2015-01-23 15:10:10 -08001049 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001050
Adam Langleyb4a494c2015-01-23 15:10:10 -08001051 /* select_certificate_cb is called before most ClientHello processing and
1052 * before the decision whether to resume a session is made. It may return one
1053 * to continue the handshake or zero to cause the handshake loop to return
1054 * with an error and cause SSL_get_error to return
David Benjamin6f5c0f42015-02-24 01:23:21 -05001055 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
1056 * will not call the callback a second time. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001057 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
Adam Langleydc9b1412014-06-20 12:00:00 -07001058
Adam Langley524e7172015-02-20 16:04:00 -08001059 /* dos_protection_cb is called once the resumption decision for a ClientHello
1060 * has been made. It returns one to continue the handshake or zero to
1061 * abort. */
1062 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
1063
Adam Langleyb4a494c2015-01-23 15:10:10 -08001064 /* quiet_shutdown is true if the connection should not send a close_notify on
1065 * shutdown. */
1066 int quiet_shutdown;
Adam Langley95c29f32014-06-20 12:00:00 -07001067
Adam Langleyb4a494c2015-01-23 15:10:10 -08001068 /* Maximum amount of data to send in one fragment. actual record size can be
1069 * more than this due to padding and MAC overheads. */
David Benjamin1d0a1942015-04-26 15:35:35 -04001070 uint16_t max_send_fragment;
Adam Langley95c29f32014-06-20 12:00:00 -07001071
Adam Langleyb4a494c2015-01-23 15:10:10 -08001072 /* TLS extensions servername callback */
1073 int (*tlsext_servername_callback)(SSL *, int *, void *);
1074 void *tlsext_servername_arg;
1075 /* RFC 4507 session ticket keys */
1076 uint8_t tlsext_tick_key_name[16];
1077 uint8_t tlsext_tick_hmac_key[16];
1078 uint8_t tlsext_tick_aes_key[16];
1079 /* Callback to support customisation of ticket key setting */
1080 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
1081 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
Adam Langley95c29f32014-06-20 12:00:00 -07001082
Adam Langleyb4a494c2015-01-23 15:10:10 -08001083 /* Server-only: psk_identity_hint is the default identity hint to send in
1084 * PSK-based key exchanges. */
1085 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001086
Adam Langleyb4a494c2015-01-23 15:10:10 -08001087 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1088 char *identity,
1089 unsigned int max_identity_len,
1090 uint8_t *psk, unsigned int max_psk_len);
1091 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1092 uint8_t *psk, unsigned int max_psk_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001093
Alex Chernyakhovskya40c8622014-08-03 15:46:36 -04001094
Adam Langleyb4a494c2015-01-23 15:10:10 -08001095 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
1096 * hash of the peer's certifiate and then discard it to save memory and
1097 * session space. Only effective on the server side. */
1098 char retain_only_sha256_of_client_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001099
Adam Langleyb4a494c2015-01-23 15:10:10 -08001100 /* Next protocol negotiation information */
1101 /* (for experimental NPN extension). */
Adam Langley95c29f32014-06-20 12:00:00 -07001102
Adam Langleyb4a494c2015-01-23 15:10:10 -08001103 /* For a server, this contains a callback function by which the set of
1104 * advertised protocols can be provided. */
1105 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
1106 unsigned int *len, void *arg);
1107 void *next_protos_advertised_cb_arg;
1108 /* For a client, this contains a callback function that selects the
1109 * next protocol from the list provided by the server. */
1110 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
1111 const uint8_t *in, unsigned int inlen, void *arg);
1112 void *next_proto_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001113
Adam Langleyb4a494c2015-01-23 15:10:10 -08001114 /* ALPN information
1115 * (we are in the process of transitioning from NPN to ALPN.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001116
Adam Langleyb4a494c2015-01-23 15:10:10 -08001117 /* For a server, this contains a callback function that allows the
1118 * server to select the protocol for the connection.
1119 * out: on successful return, this must point to the raw protocol
1120 * name (without the length prefix).
1121 * outlen: on successful return, this contains the length of |*out|.
1122 * in: points to the client's list of supported protocols in
1123 * wire-format.
1124 * inlen: the length of |in|. */
1125 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
1126 const uint8_t *in, unsigned int inlen, void *arg);
1127 void *alpn_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001128
Adam Langleyb4a494c2015-01-23 15:10:10 -08001129 /* For a client, this contains the list of supported protocols in wire
1130 * format. */
1131 uint8_t *alpn_client_proto_list;
1132 unsigned alpn_client_proto_list_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001133
Adam Langleyb4a494c2015-01-23 15:10:10 -08001134 /* SRTP profiles we are willing to do from RFC 5764 */
1135 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001136
Adam Langleyb4a494c2015-01-23 15:10:10 -08001137 /* EC extension values inherited by SSL structure */
1138 size_t tlsext_ecpointformatlist_length;
1139 uint8_t *tlsext_ecpointformatlist;
1140 size_t tlsext_ellipticcurvelist_length;
1141 uint16_t *tlsext_ellipticcurvelist;
Adam Langley1258b6a2014-06-20 12:00:00 -07001142
Adam Langleyb4a494c2015-01-23 15:10:10 -08001143 /* If true, a client will advertise the Channel ID extension and a server
1144 * will echo it. */
1145 char tlsext_channel_id_enabled;
1146 /* tlsext_channel_id_enabled_new is a hack to support both old and new
1147 * ChannelID signatures. It indicates that a client should advertise the new
1148 * ChannelID extension number. */
1149 char tlsext_channel_id_enabled_new;
1150 /* The client's Channel ID private key. */
1151 EVP_PKEY *tlsext_channel_id_private;
David Benjamin6c7aed02014-08-27 16:42:38 -04001152
Adam Langleyb4a494c2015-01-23 15:10:10 -08001153 /* If true, a client will request certificate timestamps. */
1154 char signed_cert_timestamps_enabled;
David Benjamin859ec3c2014-09-02 16:29:36 -04001155
Adam Langleyb4a494c2015-01-23 15:10:10 -08001156 /* If true, a client will request a stapled OCSP response. */
1157 char ocsp_stapling_enabled;
Adam Langley95c29f32014-06-20 12:00:00 -07001158
Adam Langleyb4a494c2015-01-23 15:10:10 -08001159 /* If not NULL, session key material will be logged to this BIO for debugging
1160 * purposes. The format matches NSS's and is readable by Wireshark. */
1161 BIO *keylog_bio;
David Benjamin377fc312015-01-26 00:22:12 -05001162
1163 /* current_time_cb, if not NULL, is the function to use to get the current
1164 * time. It sets |*out_clock| to the current time. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001165 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001166};
Adam Langley95c29f32014-06-20 12:00:00 -07001167
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001168OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001169
1170/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1171 * session cache. */
1172OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001173
Adam Langleyb4a494c2015-01-23 15:10:10 -08001174OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001175 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1176OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001177 SSL_SESSION *sess);
1178OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1179 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001180 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001181OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001182 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001183OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1184 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001185 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001186 int *copy));
1187OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001188 SSL *ssl, uint8_t *data, int len, int *copy);
Adam Langleyb2ce0582014-06-20 12:00:00 -07001189/* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
1190 * that the session isn't currently unavailable. SSL_get_error will then return
1191 * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
1192 * lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001193OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001194OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1195 void (*cb)(const SSL *ssl,
1196 int type, int val));
1197OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1198 int type,
1199 int val);
1200OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1201 SSL_CTX *ctx,
1202 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1203OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1204 X509 **x509,
1205 EVP_PKEY **pkey);
1206OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1207 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1208OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1209 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001210
Adam Langleyb4a494c2015-01-23 15:10:10 -08001211/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1212 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001213 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001214OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1215
Adam Langleyb4a494c2015-01-23 15:10:10 -08001216/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1217 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001218OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1219
David Benjamin3b7456e2015-05-16 12:29:32 -04001220/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1221 * connection) to request a stapled OCSP response from the server. It returns
1222 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001223OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1224
1225/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1226 * created from |ctx|. */
1227OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1228
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001229/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1230 * |*out_len| bytes of SCT information from the server. This is only valid if
1231 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1232 * (including the two leading length bytes).
1233 * See https://tools.ietf.org/html/rfc6962#section-3.3
1234 * If no SCT was received then |*out_len| will be zero on return.
1235 *
1236 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001237OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001238 const uint8_t **out,
1239 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001240
David Benjamin6c7aed02014-08-27 16:42:38 -04001241/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1242 * bytes of an OCSP response from the server. This is the DER encoding of an
1243 * OCSPResponse type as defined in RFC 2560.
1244 *
1245 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001246OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1247 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001248
Adam Langleyb4a494c2015-01-23 15:10:10 -08001249OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1250 SSL_CTX *s,
1251 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1252 void *arg);
1253OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1254 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1255 const uint8_t *in, unsigned int inlen, void *arg),
1256 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001257OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001258 const uint8_t **data,
1259 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001260
Adam Langleyb4a494c2015-01-23 15:10:10 -08001261OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1262 const uint8_t *in, unsigned int inlen,
1263 const uint8_t *client,
1264 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001265
Adam Langleyb4a494c2015-01-23 15:10:10 -08001266#define OPENSSL_NPN_UNSUPPORTED 0
1267#define OPENSSL_NPN_NEGOTIATED 1
1268#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001269
David Benjamin9d0847a2015-02-16 03:57:55 -05001270/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1271 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1272 * length-prefixed strings). It returns zero on success and one on failure.
1273 *
1274 * WARNING: this function is dangerous because it breaks the usual return value
1275 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001276OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1277 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001278
1279/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1280 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1281 * length-prefixed strings). It returns zero on success and one on failure.
1282 *
1283 * WARNING: this function is dangerous because it breaks the usual return value
1284 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001285OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1286 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001287
Adam Langleyb4a494c2015-01-23 15:10:10 -08001288OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1289 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1290 const uint8_t *in, unsigned int inlen, void *arg),
1291 void *arg);
1292OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1293 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001294
1295/* SSL_enable_fastradio_padding controls whether fastradio padding is enabled
1296 * on |ssl|. If it is, ClientHello messages are padded to 1024 bytes. This
1297 * causes 3G radios to switch to DCH mode (high data rate). */
1298OPENSSL_EXPORT void SSL_enable_fastradio_padding(SSL *ssl, char on_off);
1299
David Benjaminb16346b2015-04-08 19:16:58 -04001300/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1301 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001302 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001303 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001304OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1305
Adam Langleyb4a494c2015-01-23 15:10:10 -08001306/* the maximum length of the buffer given to callbacks containing the resulting
1307 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001308#define PSK_MAX_IDENTITY_LEN 128
1309#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001310OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1311 SSL_CTX *ctx,
1312 unsigned int (*psk_client_callback)(
1313 SSL *ssl, const char *hint, char *identity,
1314 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1315OPENSSL_EXPORT void SSL_set_psk_client_callback(
1316 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1317 char *identity,
1318 unsigned int max_identity_len,
1319 uint8_t *psk,
1320 unsigned int max_psk_len));
1321OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1322 SSL_CTX *ctx,
1323 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1324 uint8_t *psk,
1325 unsigned int max_psk_len));
1326OPENSSL_EXPORT void SSL_set_psk_server_callback(
1327 SSL *ssl,
1328 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1329 uint8_t *psk,
1330 unsigned int max_psk_len));
1331OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1332 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001333OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1334OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1335OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001336
Adam Langleyb4a494c2015-01-23 15:10:10 -08001337#define SSL_NOTHING 1
1338#define SSL_WRITING 2
1339#define SSL_READING 3
1340#define SSL_X509_LOOKUP 4
1341#define SSL_CHANNEL_ID_LOOKUP 5
1342#define SSL_PENDING_SESSION 7
1343#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04001344#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07001345
1346/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001347#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1348#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1349#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1350#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1351#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1352#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1353#define SSL_want_certificate(s) \
1354 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04001355#define SSL_want_private_key_operation(s) \
1356 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07001357
Adam Langleyb4a494c2015-01-23 15:10:10 -08001358struct ssl_st {
1359 /* version is the protocol version. */
1360 int version;
Adam Langley95c29f32014-06-20 12:00:00 -07001361
Adam Langleyb4a494c2015-01-23 15:10:10 -08001362 /* method is the method table corresponding to the current protocol (DTLS or
1363 * TLS). */
1364 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001365
Adam Langleyb4a494c2015-01-23 15:10:10 -08001366 /* enc_method is the method table corresponding to the current protocol
1367 * version. */
1368 const SSL3_ENC_METHOD *enc_method;
David Benjamine99e9122014-12-11 01:46:01 -05001369
Adam Langleyb4a494c2015-01-23 15:10:10 -08001370 /* max_version is the maximum acceptable protocol version. If zero, the
1371 * maximum supported version, currently (D)TLS 1.2, is used. */
1372 uint16_t max_version;
Adam Langley95c29f32014-06-20 12:00:00 -07001373
Adam Langleyb4a494c2015-01-23 15:10:10 -08001374 /* min_version is the minimum acceptable protocl version. If zero, the
1375 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1376 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001377
Adam Langleyb4a494c2015-01-23 15:10:10 -08001378 /* There are 2 BIO's even though they are normally both the same. This is so
1379 * data can be read and written to different handlers */
David Benjamin1eb367c2014-12-12 18:17:51 -05001380
Adam Langleyb4a494c2015-01-23 15:10:10 -08001381 BIO *rbio; /* used by SSL_read */
1382 BIO *wbio; /* used by SSL_write */
1383 BIO *bbio; /* used during session-id reuse to concatenate
1384 * messages */
Adam Langley95c29f32014-06-20 12:00:00 -07001385
Adam Langleyb4a494c2015-01-23 15:10:10 -08001386 /* This holds a variable that indicates what we were doing when a 0 or -1 is
1387 * returned. This is needed for non-blocking IO so we know what request
1388 * needs re-doing when in SSL_accept or SSL_connect */
1389 int rwstate;
David Benjamin95f9cfc2014-11-23 00:19:49 -05001390
Adam Langleyb4a494c2015-01-23 15:10:10 -08001391 /* true when we are actually in SSL_accept() or SSL_connect() */
1392 int in_handshake;
1393 int (*handshake_func)(SSL *);
Adam Langley95c29f32014-06-20 12:00:00 -07001394
Adam Langleyb4a494c2015-01-23 15:10:10 -08001395 /* Imagine that here's a boolean member "init" that is switched as soon as
1396 * SSL_set_{accept/connect}_state is called for the first time, so that
1397 * "state" and "handshake_func" are properly initialized. But as
1398 * handshake_func is == 0 until then, we use this test instead of an "init"
1399 * member. */
Adam Langley95c29f32014-06-20 12:00:00 -07001400
Adam Langleyb4a494c2015-01-23 15:10:10 -08001401 /* server is true iff the this SSL* is the server half. Note: before the SSL*
1402 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
1403 * the side is not determined. In this state, server is always false. */
1404 int server;
Adam Langley95c29f32014-06-20 12:00:00 -07001405
Adam Langleyb4a494c2015-01-23 15:10:10 -08001406 /* quiet_shutdown is true if the connection should not send a close_notify on
1407 * shutdown. */
1408 int quiet_shutdown;
David Benjamin7e237462014-12-11 18:13:28 -05001409
Adam Langleyb4a494c2015-01-23 15:10:10 -08001410 int shutdown; /* we have shut things down, 0x01 sent, 0x02
1411 * for received */
1412 int state; /* where we are */
1413 int rstate; /* where we are when reading */
Adam Langley95c29f32014-06-20 12:00:00 -07001414
Adam Langleyb4a494c2015-01-23 15:10:10 -08001415 BUF_MEM *init_buf; /* buffer used during init */
1416 uint8_t *init_msg; /* pointer to handshake message body, set by
1417 ssl3_get_message() */
1418 int init_num; /* amount read/written */
1419 int init_off; /* amount read/written */
Adam Langley95c29f32014-06-20 12:00:00 -07001420
Adam Langleyb4a494c2015-01-23 15:10:10 -08001421 /* used internally to point at a raw packet */
1422 uint8_t *packet;
1423 unsigned int packet_length;
Adam Langley95c29f32014-06-20 12:00:00 -07001424
Adam Langleyb4a494c2015-01-23 15:10:10 -08001425 struct ssl3_state_st *s3; /* SSLv3 variables */
1426 struct dtls1_state_st *d1; /* DTLSv1 variables */
Adam Langley95c29f32014-06-20 12:00:00 -07001427
Adam Langleyb4a494c2015-01-23 15:10:10 -08001428 /* callback that allows applications to peek at protocol messages */
1429 void (*msg_callback)(int write_p, int version, int content_type,
1430 const void *buf, size_t len, SSL *ssl, void *arg);
1431 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001432
Adam Langleyb4a494c2015-01-23 15:10:10 -08001433 int hit; /* reusing a previous session */
Adam Langley95c29f32014-06-20 12:00:00 -07001434
Adam Langleyb4a494c2015-01-23 15:10:10 -08001435 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001436
Adam Langleyb4a494c2015-01-23 15:10:10 -08001437 /* crypto */
1438 struct ssl_cipher_preference_list_st *cipher_list;
1439 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001440
Adam Langleyb4a494c2015-01-23 15:10:10 -08001441 SSL_AEAD_CTX *aead_read_ctx;
1442 SSL_AEAD_CTX *aead_write_ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001443
Adam Langleyb4a494c2015-01-23 15:10:10 -08001444 /* session info */
Adam Langley95c29f32014-06-20 12:00:00 -07001445
Adam Langleyb4a494c2015-01-23 15:10:10 -08001446 /* client cert? */
1447 /* This is used to hold the server certificate used */
1448 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001449
Adam Langleyb4a494c2015-01-23 15:10:10 -08001450 /* the session_id_context is used to ensure sessions are only reused
1451 * in the appropriate context */
1452 unsigned int sid_ctx_length;
1453 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001454
Adam Langleyb4a494c2015-01-23 15:10:10 -08001455 /* This can also be in the session once a session is established */
1456 SSL_SESSION *session;
Adam Langley95c29f32014-06-20 12:00:00 -07001457
Adam Langleyb4a494c2015-01-23 15:10:10 -08001458 /* Default generate session ID callback. */
1459 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001460
Adam Langleyb4a494c2015-01-23 15:10:10 -08001461 /* Used in SSL2 and SSL3 */
1462 int verify_mode; /* 0 don't care about verify failure.
1463 * 1 fail if verify fails */
1464 int (*verify_callback)(int ok,
1465 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
Adam Langley95c29f32014-06-20 12:00:00 -07001466
Adam Langleyb4a494c2015-01-23 15:10:10 -08001467 void (*info_callback)(const SSL *ssl, int type,
1468 int val); /* optional informational callback */
Adam Langley95c29f32014-06-20 12:00:00 -07001469
Adam Langleyb4a494c2015-01-23 15:10:10 -08001470 /* Server-only: psk_identity_hint is the identity hint to send in
1471 * PSK-based key exchanges. */
1472 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001473
Adam Langleyb4a494c2015-01-23 15:10:10 -08001474 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1475 char *identity,
1476 unsigned int max_identity_len,
1477 uint8_t *psk, unsigned int max_psk_len);
1478 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1479 uint8_t *psk, unsigned int max_psk_len);
David Benjamin688d8df2014-11-02 23:06:42 -05001480
Adam Langleyb4a494c2015-01-23 15:10:10 -08001481 SSL_CTX *ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001482
Adam Langleyb4a494c2015-01-23 15:10:10 -08001483 /* extra application data */
1484 long verify_result;
1485 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001486
Adam Langleyb4a494c2015-01-23 15:10:10 -08001487 /* for server side, keep the list of CA_dn we can use */
1488 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001489
David Benjamin123a8fd2015-04-26 14:16:41 -04001490 uint32_t options; /* protocol behaviour */
1491 uint32_t mode; /* API behaviour */
David Benjamin1d0a1942015-04-26 15:35:35 -04001492 uint32_t max_cert_list;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001493 int client_version; /* what was passed, used for
1494 * SSLv3/TLS rollback check */
David Benjamin1d0a1942015-04-26 15:35:35 -04001495 uint16_t max_send_fragment;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001496 char *tlsext_hostname;
1497 /* should_ack_sni is true if the SNI extension should be acked. This is
1498 * only used by a server. */
1499 char should_ack_sni;
1500 /* RFC4507 session ticket expected to be received or sent */
1501 int tlsext_ticket_expected;
1502 size_t tlsext_ecpointformatlist_length;
1503 uint8_t *tlsext_ecpointformatlist; /* our list */
1504 size_t tlsext_ellipticcurvelist_length;
1505 uint16_t *tlsext_ellipticcurvelist; /* our list */
Adam Langley95c29f32014-06-20 12:00:00 -07001506
Adam Langleyb4a494c2015-01-23 15:10:10 -08001507 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
Adam Langley95c29f32014-06-20 12:00:00 -07001508
Adam Langleyb4a494c2015-01-23 15:10:10 -08001509 /* Next protocol negotiation. For the client, this is the protocol that we
1510 * sent in NextProtocol and is set when handling ServerHello extensions.
1511 *
1512 * For a server, this is the client's selected_protocol from NextProtocol and
1513 * is set when handling the NextProtocol message, before the Finished
1514 * message. */
1515 uint8_t *next_proto_negotiated;
1516 size_t next_proto_negotiated_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001517
Adam Langleyb4a494c2015-01-23 15:10:10 -08001518 /* srtp_profiles is the list of configured SRTP protection profiles for
1519 * DTLS-SRTP. */
1520 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001521
Adam Langleyb4a494c2015-01-23 15:10:10 -08001522 /* srtp_profile is the selected SRTP protection profile for
1523 * DTLS-SRTP. */
1524 const SRTP_PROTECTION_PROFILE *srtp_profile;
David Benjaminbc44c082015-01-01 15:02:11 -05001525
Adam Langleyb4a494c2015-01-23 15:10:10 -08001526 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
1527 * from clients. For a client, means that we'll advertise support. */
1528 char tlsext_channel_id_enabled;
1529 /* The client's Channel ID private key. */
1530 EVP_PKEY *tlsext_channel_id_private;
Adam Langley95c29f32014-06-20 12:00:00 -07001531
Adam Langleyb4a494c2015-01-23 15:10:10 -08001532 /* Enable signed certificate time stamps. Currently client only. */
1533 char signed_cert_timestamps_enabled;
Adam Langley1258b6a2014-06-20 12:00:00 -07001534
Adam Langleyb4a494c2015-01-23 15:10:10 -08001535 /* Enable OCSP stapling. Currently client only.
1536 * TODO(davidben): Add a server-side implementation when it becomes
1537 * necesary. */
1538 char ocsp_stapling_enabled;
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001539
Adam Langleyb4a494c2015-01-23 15:10:10 -08001540 /* For a client, this contains the list of supported protocols in wire
1541 * format. */
1542 uint8_t *alpn_client_proto_list;
1543 unsigned alpn_client_proto_list_len;
David Benjamin6c7aed02014-08-27 16:42:38 -04001544
Adam Langleyb4a494c2015-01-23 15:10:10 -08001545 /* fastradio_padding, if true, causes ClientHellos to be padded to 1024
1546 * bytes. This ensures that the cellular radio is fast forwarded to DCH (high
1547 * data rate) state in 3G networks. */
1548 char fastradio_padding;
Feng Lu41aa3252014-11-21 22:47:56 -08001549
David Benjamin897e5e02015-05-12 17:03:54 -04001550 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
1551 * peer. Otherwise, they will be rejected with a fatal error. */
1552 char accept_peer_renegotiations;
David Benjaminb16346b2015-04-08 19:16:58 -04001553
Adam Langleyb4a494c2015-01-23 15:10:10 -08001554 /* These fields are always NULL and exist only to keep wpa_supplicant happy
1555 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
1556 * don't support. */
1557 EVP_CIPHER_CTX *enc_read_ctx;
1558 EVP_MD_CTX *read_hash;
1559};
Adam Langley95c29f32014-06-20 12:00:00 -07001560
Adam Langley95c29f32014-06-20 12:00:00 -07001561/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001562#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
1563#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
1564#define SSL_SESSION_set_app_data(s, a) \
1565 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
1566#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
1567#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
1568#define SSL_CTX_set_app_data(ctx, arg) \
1569 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07001570
Adam Langleyb4a494c2015-01-23 15:10:10 -08001571/* The following are the possible values for ssl->state are are used to
1572 * indicate where we are up to in the SSL connection establishment. The macros
1573 * that follow are about the only things you should need to use and even then,
1574 * only when using non-blocking IO. It can also be useful to work out where you
1575 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07001576
Adam Langleyb4a494c2015-01-23 15:10:10 -08001577#define SSL_ST_CONNECT 0x1000
1578#define SSL_ST_ACCEPT 0x2000
1579#define SSL_ST_MASK 0x0FFF
1580#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001581#define SSL_ST_OK 0x03
1582#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07001583
Adam Langleyb4a494c2015-01-23 15:10:10 -08001584#define SSL_CB_LOOP 0x01
1585#define SSL_CB_EXIT 0x02
1586#define SSL_CB_READ 0x04
1587#define SSL_CB_WRITE 0x08
1588#define SSL_CB_ALERT 0x4000 /* used in callback */
1589#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
1590#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
1591#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
1592#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
1593#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
1594#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
1595#define SSL_CB_HANDSHAKE_START 0x10
1596#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07001597
1598/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001599#define SSL_get_state(a) SSL_state(a)
1600#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05001601#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001602#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
1603#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05001604
David Benjamined7c4752015-02-16 19:16:46 -05001605/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
1606 * is in False Start. |SSL_write| may be called at this point without waiting
1607 * for the peer, but |SSL_read| will require the handshake to be completed. */
1608OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
1609
Adam Langley95c29f32014-06-20 12:00:00 -07001610/* The following 2 states are kept in ssl->rstate when reads fail,
1611 * you should not need these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001612#define SSL_ST_READ_HEADER 0xF0
1613#define SSL_ST_READ_BODY 0xF1
1614#define SSL_ST_READ_DONE 0xF2
Adam Langley95c29f32014-06-20 12:00:00 -07001615
1616/* Obtain latest Finished message
1617 * -- that we sent (SSL_get_finished)
1618 * -- that we expected from peer (SSL_get_peer_finished).
1619 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001620OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1621OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07001622
Adam Langley509e5ed2014-06-20 12:00:00 -07001623/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07001624 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001625#define SSL_VERIFY_NONE 0x00
1626#define SSL_VERIFY_PEER 0x01
1627#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
David Benjamin5aea93e2015-05-26 16:33:02 -04001628/* SSL_VERIFY_CLIENT_ONCE does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001629#define SSL_VERIFY_CLIENT_ONCE 0x04
1630#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07001631
Adam Langleyb4a494c2015-01-23 15:10:10 -08001632#define OpenSSL_add_ssl_algorithms() SSL_library_init()
1633#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07001634
Adam Langleyb4a494c2015-01-23 15:10:10 -08001635/* For backward compatibility */
1636#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1637#define SSL_get_cipher_bits(s, np) \
1638 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07001639#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001640 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1641#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1642#define SSL_get_time(a) SSL_SESSION_get_time(a)
1643#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
1644#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
1645#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07001646
Adam Langleyb4a494c2015-01-23 15:10:10 -08001647#define d2i_SSL_SESSION_bio(bp, s_id) \
1648 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
1649#define i2d_SSL_SESSION_bio(bp, s_id) \
1650 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07001651
1652DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1653
Adam Langleyb4a494c2015-01-23 15:10:10 -08001654/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
1655 * This value must be kept in sync with reservedReasonCode in make_errors.h */
1656#define SSL_AD_REASON_OFFSET \
1657 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07001658
1659/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001660#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
1661#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
1662#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
1663#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
1664#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
1665#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
1666#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
1667#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
1668#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
1669#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
1670#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
1671#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
1672#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
1673#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
1674#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
1675#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
1676#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
1677#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
1678#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
1679#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
1680#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
1681#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
1682#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
1683#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
1684#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07001685#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001686#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
1687#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
1688 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07001689#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001690#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
1691#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07001692
Adam Langleyb4a494c2015-01-23 15:10:10 -08001693#define SSL_ERROR_NONE 0
1694#define SSL_ERROR_SSL 1
1695#define SSL_ERROR_WANT_READ 2
1696#define SSL_ERROR_WANT_WRITE 3
1697#define SSL_ERROR_WANT_X509_LOOKUP 4
1698#define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
1699#define SSL_ERROR_ZERO_RETURN 6
1700#define SSL_ERROR_WANT_CONNECT 7
1701#define SSL_ERROR_WANT_ACCEPT 8
1702#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
1703#define SSL_ERROR_PENDING_SESSION 11
1704#define SSL_ERROR_PENDING_CERTIFICATE 12
David Benjaminb4d65fd2015-05-29 17:11:21 -04001705#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
Adam Langley95c29f32014-06-20 12:00:00 -07001706
Adam Langleyb4a494c2015-01-23 15:10:10 -08001707#define SSL_CTRL_EXTRA_CHAIN_CERT 14
Adam Langley95c29f32014-06-20 12:00:00 -07001708
Adam Langley95c29f32014-06-20 12:00:00 -07001709/* see tls1.h for macros based on these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001710#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS 58
1711#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS 59
Adam Langley95c29f32014-06-20 12:00:00 -07001712
Adam Langleyb4a494c2015-01-23 15:10:10 -08001713#define SSL_CTRL_SET_SRP_ARG 78
1714#define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME 79
1715#define SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH 80
1716#define SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD 81
Adam Langley95c29f32014-06-20 12:00:00 -07001717
Adam Langleyb4a494c2015-01-23 15:10:10 -08001718#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS 82
1719#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS 83
Adam Langley95c29f32014-06-20 12:00:00 -07001720
Adam Langleyb4a494c2015-01-23 15:10:10 -08001721#define SSL_CTRL_CHAIN 88
1722#define SSL_CTRL_CHAIN_CERT 89
Adam Langley95c29f32014-06-20 12:00:00 -07001723
Adam Langleyb4a494c2015-01-23 15:10:10 -08001724#define SSL_CTRL_GET_CURVES 90
1725#define SSL_CTRL_SET_CURVES 91
1726#define SSL_CTRL_SET_CURVES_LIST 92
Adam Langleyb4a494c2015-01-23 15:10:10 -08001727#define SSL_CTRL_SET_SIGALGS 97
1728#define SSL_CTRL_SET_SIGALGS_LIST 98
Adam Langleyb4a494c2015-01-23 15:10:10 -08001729#define SSL_CTRL_SET_CLIENT_SIGALGS 101
1730#define SSL_CTRL_SET_CLIENT_SIGALGS_LIST 102
1731#define SSL_CTRL_GET_CLIENT_CERT_TYPES 103
1732#define SSL_CTRL_SET_CLIENT_CERT_TYPES 104
1733#define SSL_CTRL_BUILD_CERT_CHAIN 105
1734#define SSL_CTRL_SET_VERIFY_CERT_STORE 106
1735#define SSL_CTRL_SET_CHAIN_CERT_STORE 107
1736#define SSL_CTRL_GET_SERVER_TMP_KEY 109
Adam Langleyb4a494c2015-01-23 15:10:10 -08001737#define SSL_CTRL_GET_EC_POINT_FORMATS 111
Adam Langley95c29f32014-06-20 12:00:00 -07001738
Adam Langleyb4a494c2015-01-23 15:10:10 -08001739#define SSL_CTRL_GET_CHAIN_CERTS 115
1740#define SSL_CTRL_SELECT_CURRENT_CERT 116
Adam Langley95c29f32014-06-20 12:00:00 -07001741
David Benjamin377fc312015-01-26 00:22:12 -05001742/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04001743 * timeout in progress, it sets |*out| to the time remaining and returns one.
1744 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05001745 *
1746 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
1747 * retransmit behavior.
1748 *
1749 * NOTE: This function must be queried again whenever the handshake state
1750 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001751OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05001752
1753/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
1754 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
1755 * flight of handshake messages and returns 1. If too many timeouts had expired
1756 * without progress or an error occurs, it returns -1.
1757 *
1758 * NOTE: The caller's external timer should be compatible with the one |ssl|
1759 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04001760 * |DTLSv1_get_timeout| will return an updated timeout.
1761 *
1762 * WARNING: This function breaks the usual return value convention. */
1763OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001764
David Benjaminc0454692015-04-27 00:28:56 -04001765/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1766 * and zero otherwise.
1767 *
1768 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1769 * initial or renego, is in progress. */
1770OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001771
David Benjaminc0454692015-04-27 00:28:56 -04001772/* SSL_total_renegotiations returns the total number of renegotiation handshakes
1773 * peformed by |ssl|. This includes the pending renegotiation, if any. */
1774OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
1775
David Benjamin15a3b002015-04-28 00:05:35 -04001776/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1777 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1778 * one on success and zero on error. */
1779OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04001780
David Benjamin15a3b002015-04-28 00:05:35 -04001781/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1782 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1783 * on success and zero on error. */
1784OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07001785
David Benjamin15a3b002015-04-28 00:05:35 -04001786/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1787 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1788 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1789 * error. If unset, an appropriate curve will be chosen automatically. (This is
1790 * recommended.) */
1791OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04001792
David Benjamin15a3b002015-04-28 00:05:35 -04001793/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1794 * for ephemeral ECDH keys. For historical reasons, this API expects an
1795 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1796 * error. If unset, an appropriate curve will be chosen automatically. (This is
1797 * recommended.) */
1798OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07001799
David Benjaminc2807582015-04-28 00:19:50 -04001800/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
1801 * client IDs from clients, or configures a client to send TLS client IDs to
1802 * a server. It returns one. */
1803OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
1804
Adam Langleyb4a494c2015-01-23 15:10:10 -08001805/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
1806 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04001807 * server. It returns one. */
1808OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
1809
1810/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
1811 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
1812 * on success and zero on error. */
1813OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
1814 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001815
Adam Langley1258b6a2014-06-20 12:00:00 -07001816/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04001817 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
1818 * success and zero on error. */
1819OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001820
Adam Langley1258b6a2014-06-20 12:00:00 -07001821/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04001822 * and copies up to the first |max_out| bytes into |out|. The Channel ID
1823 * consists of the client's P-256 public key as an (x,y) pair where each is a
1824 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
1825 * Channel ID and the length of the complete Channel ID otherwise. */
1826OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
1827 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07001828
Adam Langleyb4a494c2015-01-23 15:10:10 -08001829#define SSL_CTX_add_extra_chain_cert(ctx, x509) \
1830 SSL_CTX_ctrl(ctx, SSL_CTRL_EXTRA_CHAIN_CERT, 0, (char *)x509)
1831#define SSL_CTX_get_extra_chain_certs(ctx, px509) \
1832 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_EXTRA_CHAIN_CERTS, 0, px509)
1833#define SSL_CTX_get_extra_chain_certs_only(ctx, px509) \
1834 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_EXTRA_CHAIN_CERTS, 1, px509)
Adam Langley95c29f32014-06-20 12:00:00 -07001835#define SSL_CTX_clear_extra_chain_certs(ctx) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001836 SSL_CTX_ctrl(ctx, SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS, 0, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001837
Adam Langleyb4a494c2015-01-23 15:10:10 -08001838#define SSL_CTX_set0_chain(ctx, sk) \
1839 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN, 0, (char *)sk)
1840#define SSL_CTX_set1_chain(ctx, sk) \
1841 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN, 1, (char *)sk)
1842#define SSL_CTX_add0_chain_cert(ctx, x509) \
1843 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 0, (char *)x509)
1844#define SSL_CTX_add1_chain_cert(ctx, x509) \
1845 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 1, (char *)x509)
1846#define SSL_CTX_get0_chain_certs(ctx, px509) \
1847 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_CHAIN_CERTS, 0, px509)
1848#define SSL_CTX_clear_chain_certs(ctx) SSL_CTX_set0_chain(ctx, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001849#define SSL_CTX_build_cert_chain(ctx, flags) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001850 SSL_CTX_ctrl(ctx, SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1851#define SSL_CTX_select_current_cert(ctx, x509) \
1852 SSL_CTX_ctrl(ctx, SSL_CTRL_SELECT_CURRENT_CERT, 0, (char *)x509)
Adam Langley95c29f32014-06-20 12:00:00 -07001853
Adam Langleyb4a494c2015-01-23 15:10:10 -08001854#define SSL_CTX_set0_verify_cert_store(ctx, st) \
1855 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
1856#define SSL_CTX_set1_verify_cert_store(ctx, st) \
1857 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
1858#define SSL_CTX_set0_chain_cert_store(ctx, st) \
1859 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
1860#define SSL_CTX_set1_chain_cert_store(ctx, st) \
1861 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07001862
Adam Langleyb4a494c2015-01-23 15:10:10 -08001863#define SSL_set0_chain(ctx, sk) SSL_ctrl(ctx, SSL_CTRL_CHAIN, 0, (char *)sk)
1864#define SSL_set1_chain(ctx, sk) SSL_ctrl(ctx, SSL_CTRL_CHAIN, 1, (char *)sk)
1865#define SSL_add0_chain_cert(ctx, x509) \
1866 SSL_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 0, (char *)x509)
1867#define SSL_add1_chain_cert(ctx, x509) \
1868 SSL_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 1, (char *)x509)
1869#define SSL_get0_chain_certs(ctx, px509) \
1870 SSL_ctrl(ctx, SSL_CTRL_GET_CHAIN_CERTS, 0, px509)
1871#define SSL_clear_chain_certs(ctx) SSL_set0_chain(ctx, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001872#define SSL_build_cert_chain(s, flags) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001873 SSL_ctrl(s, SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1874#define SSL_select_current_cert(ctx, x509) \
1875 SSL_ctrl(ctx, SSL_CTRL_SELECT_CURRENT_CERT, 0, (char *)x509)
Adam Langley95c29f32014-06-20 12:00:00 -07001876
Adam Langleyb4a494c2015-01-23 15:10:10 -08001877#define SSL_set0_verify_cert_store(s, st) \
1878 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
1879#define SSL_set1_verify_cert_store(s, st) \
1880 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
1881#define SSL_set0_chain_cert_store(s, st) \
1882 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
1883#define SSL_set1_chain_cert_store(s, st) \
1884 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07001885
Adam Langleyb4a494c2015-01-23 15:10:10 -08001886#define SSL_get1_curves(ctx, s) SSL_ctrl(ctx, SSL_CTRL_GET_CURVES, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001887#define SSL_CTX_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001888 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001889#define SSL_CTX_set1_curves_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001890 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001891#define SSL_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001892 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001893#define SSL_set1_curves_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001894 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001895
1896#define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001897 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001898#define SSL_CTX_set1_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001899 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001900#define SSL_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001901 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001902#define SSL_set1_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001903 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001904
1905#define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001906 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001907#define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001908 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001909#define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001910 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001911#define SSL_set1_client_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001912 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001913
1914#define SSL_get0_certificate_types(s, clist) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001915 SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001916
1917#define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001918 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001919#define SSL_set1_client_certificate_types(s, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001920 SSL_ctrl(s, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001921
Adam Langley95c29f32014-06-20 12:00:00 -07001922#define SSL_get_server_tmp_key(s, pk) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001923 SSL_ctrl(s, SSL_CTRL_GET_SERVER_TMP_KEY, 0, pk)
Adam Langley95c29f32014-06-20 12:00:00 -07001924
Adam Langley95c29f32014-06-20 12:00:00 -07001925#define SSL_get0_ec_point_formats(s, plst) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001926 SSL_ctrl(s, SSL_CTRL_GET_EC_POINT_FORMATS, 0, (char *)plst)
Adam Langley95c29f32014-06-20 12:00:00 -07001927
Adam Langleyb4a494c2015-01-23 15:10:10 -08001928OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
1929OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001930OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001931OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1932OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001933OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001934OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001935
Adam Langleyb4a494c2015-01-23 15:10:10 -08001936OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07001937
David Benjamina07c0fc2015-05-13 13:19:42 -04001938/* SSL_get_current_cipher returns the cipher used in the current outgoing
1939 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001940OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001941
Adam Langleyb4a494c2015-01-23 15:10:10 -08001942OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
1943OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
1944OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
1945OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001946OPENSSL_EXPORT int SSL_pending(const SSL *s);
1947OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
1948OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
1949OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
1950OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
1951OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
1952OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
1953OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001954OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
1955OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
1956OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
1957 X509_STORE_CTX *);
1958OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
1959 int (*callback)(int ok,
1960 X509_STORE_CTX *ctx));
1961OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
1962OPENSSL_EXPORT void SSL_set_cert_cb(SSL *s, int (*cb)(SSL *ssl, void *arg),
1963 void *arg);
1964OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
1965OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, uint8_t *d, long len);
1966OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
1967OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const uint8_t *d,
1968 long len);
1969OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x);
1970OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *d,
1971 int len);
Adam Langley95c29f32014-06-20 12:00:00 -07001972
Adam Langleyb4a494c2015-01-23 15:10:10 -08001973OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
1974 int type);
1975OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
1976 int type);
1977OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
1978 int type);
1979OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
1980 const char *file, int type);
1981OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
1982 int type);
1983OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
1984 int type);
1985OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(
1986 SSL_CTX *ctx, const char *file); /* PEM type */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001987OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001988OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1989 stackCAs,
1990 const char *file);
1991OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1992 stackCAs,
1993 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07001994
David Benjamin7ce1c0c2015-01-09 13:21:21 -05001995/* SSL_load_error_strings does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001996OPENSSL_EXPORT void SSL_load_error_strings(void);
David Benjamin7ce1c0c2015-01-09 13:21:21 -05001997
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001998OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
1999OPENSSL_EXPORT const char *SSL_rstate_string(const SSL *s);
2000OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
2001OPENSSL_EXPORT const char *SSL_rstate_string_long(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002002OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
2003OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
2004OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
2005OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002006OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002007OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
2008 const uint8_t *sid_ctx,
2009 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002010
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002011OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002012OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
2013 unsigned int *len);
2014OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
2015OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05002016
2017/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
2018 * of |session|. It then returns |session|. */
2019OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
2020
2021/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
2022 * zero, all data referenced by |session| and |session| itself are released. */
2023OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
2024
Adam Langleyb4a494c2015-01-23 15:10:10 -08002025OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
2026OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
2027OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
2028OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
2029OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
2030OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
2031 const uint8_t *id,
2032 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04002033
Adam Langleyb4a494c2015-01-23 15:10:10 -08002034/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
2035 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
2036 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
2037 * one on success and zero on error. */
David Benjamin3cac4502014-10-21 01:46:30 -04002038OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
2039 size_t *out_len);
2040
David Benjamin95d31822015-06-15 19:53:32 -04002041/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
2042 * identification information, namely the session ID and ticket. */
David Benjamin3cac4502014-10-21 01:46:30 -04002043OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
2044 uint8_t **out_data,
2045 size_t *out_len);
2046
David Benjaminfd67aa82015-06-15 19:41:48 -04002047/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
2048 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
2049OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
2050 size_t in_len);
2051
Adam Langleyb4a494c2015-01-23 15:10:10 -08002052/* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
2053 * |*pp|. On success, it returns the number of bytes written and advances |*pp|
2054 * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
2055 * written and only the length is returned.
David Benjamin3cac4502014-10-21 01:46:30 -04002056 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002057 * Use |SSL_SESSION_to_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002058OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2059
David Benjaminfd67aa82015-06-15 19:41:48 -04002060/* Deprecated: d2i_SSL_SESSION parses a serialized session from the |length|
2061 * bytes pointed to by |*pp|. It returns the new |SSL_SESSION| and advances
2062 * |*pp| by the number of bytes consumed on success and NULL on failure. The
2063 * caller takes ownership of the new session and must call |SSL_SESSION_free|
2064 * when done.
David Benjamin3cac4502014-10-21 01:46:30 -04002065 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002066 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
David Benjamin3cac4502014-10-21 01:46:30 -04002067 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002068 * Use |SSL_SESSION_from_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002069OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2070 long length);
Adam Langley95c29f32014-06-20 12:00:00 -07002071
Adam Langleyb4a494c2015-01-23 15:10:10 -08002072OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002073
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002074OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002075
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002076OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
2077OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002078OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
2079 int, X509_STORE_CTX *);
2080OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2081 int (*callback)(int, X509_STORE_CTX *));
2082OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
2083OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
2084 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
2085OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *c,
2086 int (*cb)(SSL *ssl, void *arg),
2087 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002088OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002089OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
2090 const uint8_t *d, long len);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002091OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002092OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
2093 const uint8_t *d, long len);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002094OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002095OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
2096 const uint8_t *d);
Adam Langley95c29f32014-06-20 12:00:00 -07002097
Adam Langleyb4a494c2015-01-23 15:10:10 -08002098OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
2099 pem_password_cb *cb);
2100OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
2101 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07002102
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002103OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
2104OPENSSL_EXPORT int SSL_check_private_key(const SSL *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002105
Adam Langleyb4a494c2015-01-23 15:10:10 -08002106OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
2107 const uint8_t *sid_ctx,
2108 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002109
Adam Langleyb4a494c2015-01-23 15:10:10 -08002110OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
2111 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002112
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002113OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
2114OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
2115OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
2116OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07002117
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002118OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
2119OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07002120
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002121OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
2122OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002123
Adam Langleyb4a494c2015-01-23 15:10:10 -08002124OPENSSL_EXPORT void SSL_certs_clear(SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002125OPENSSL_EXPORT int SSL_accept(SSL *ssl);
2126OPENSSL_EXPORT int SSL_connect(SSL *ssl);
2127OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
2128OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
2129OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
2130OPENSSL_EXPORT long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002131OPENSSL_EXPORT long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
Adam Langley95c29f32014-06-20 12:00:00 -07002132
Adam Langleyb4a494c2015-01-23 15:10:10 -08002133OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
Adam Langley0f4746e2014-08-13 12:26:32 -07002134/* SSL_get_version returns a string describing the TLS version used by |s|. For
2135 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002136OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley0f4746e2014-08-13 12:26:32 -07002137/* SSL_SESSION_get_version returns a string describing the TLS version used by
2138 * |sess|. For example, "TLSv1.2" or "SSLv3". */
2139OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
Adam Langley95c29f32014-06-20 12:00:00 -07002140
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002141OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002142
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002143OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
David Benjamin44d3eed2015-05-21 01:29:55 -04002144
2145/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2146 * renegotiation. */
2147OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2148
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002149OPENSSL_EXPORT int SSL_shutdown(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002150
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002151OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2152OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2153OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2154OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002155
Adam Langleyb4a494c2015-01-23 15:10:10 -08002156OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
2157 STACK_OF(X509_NAME) *name_list);
2158OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2159 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002160OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002161OPENSSL_EXPORT STACK_OF(X509_NAME) *
2162 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2163OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
2164OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07002165
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002166OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002167
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002168OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07002169
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002170OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
David Benjamin4dab2972015-05-16 02:56:06 -04002171OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002172
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002173OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
2174OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002175
Adam Langleyb4a494c2015-01-23 15:10:10 -08002176OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002177OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002178OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002179OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002180OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002181OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
2182OPENSSL_EXPORT int SSL_version(const SSL *ssl);
2183OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002184OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2185 const char *CAfile,
2186 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07002187#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002188OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002189OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
2190 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002191OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002192OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002193OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002194 void (*cb)(const SSL *ssl, int type,
2195 int val));
2196OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2197 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002198OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002199
Adam Langleyb4a494c2015-01-23 15:10:10 -08002200OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002201OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002202
Adam Langleyb4a494c2015-01-23 15:10:10 -08002203OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2204OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2205OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2206 CRYPTO_EX_new *new_func,
2207 CRYPTO_EX_dup *dup_func,
2208 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002209
Adam Langleyb4a494c2015-01-23 15:10:10 -08002210OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
2211 void *data);
2212OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2213OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2214 CRYPTO_EX_new *new_func,
2215 CRYPTO_EX_dup *dup_func,
2216 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002217
Adam Langleyb4a494c2015-01-23 15:10:10 -08002218OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2219OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2220OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2221 CRYPTO_EX_new *new_func,
2222 CRYPTO_EX_dup *dup_func,
2223 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002224
Adam Langleyb4a494c2015-01-23 15:10:10 -08002225OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002226
David Benjamin71f7d3d2015-05-05 09:46:38 -04002227/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
2228 * |size|. It returns the previous value. */
2229OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
2230 unsigned long size);
2231
David Benjamin3b7456e2015-05-16 12:29:32 -04002232/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04002233 * cache. */
2234OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
2235
2236/* SSL_SESS_CACHE_* are the possible session cache mode bits.
2237 * TODO(davidben): Document. */
2238#define SSL_SESS_CACHE_OFF 0x0000
2239#define SSL_SESS_CACHE_CLIENT 0x0001
2240#define SSL_SESS_CACHE_SERVER 0x0002
2241#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2242#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2243#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2244#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2245#define SSL_SESS_CACHE_NO_INTERNAL \
2246 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2247
2248/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2249 * |mode|. It returns the previous value. */
2250OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2251
2252/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2253 * |ctx| */
2254OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002255
David Benjamin1d0a1942015-04-26 15:35:35 -04002256/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2257 * certificate chain accepted by |ctx|. */
2258OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2259
2260/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2261 * certificate chain to |max_cert_list|. This affects how much memory may be
2262 * consumed during the handshake. */
2263OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2264 size_t max_cert_list);
2265
2266/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2267 * certificate chain accepted by |ssl|. */
2268OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2269
2270/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2271 * certificate chain to |max_cert_list|. This affects how much memory may be
2272 * consumed during the handshake. */
2273OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2274
2275/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2276 * sent by |ctx|. Beyond this length, handshake messages and application data
2277 * will be split into multiple records. */
2278OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2279 size_t max_send_fragment);
2280
2281/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2282 * sent by |ssl|. Beyond this length, handshake messages and application data
2283 * will be split into multiple records. */
2284OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2285 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002286
David Benjamin59015c32015-04-26 13:13:55 -04002287/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2288 * the group for DHE ciphers. |callback| should ignore |is_export| and
2289 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2290 * the parameters are used, so the |DH| needn't have a generated keypair.
2291 *
2292 * WARNING: The caller does not take ownership of the resulting |DH|, so
2293 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002294OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002295 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2296
2297/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2298 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2299 * and return a |DH| of the selected group or NULL on error. Only the
2300 * parameters are used, so the |DH| needn't have a generated keypair.
2301 *
2302 * WARNING: The caller does not take ownership of the resulting |DH|, so
2303 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002304OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002305 DH *(*dh)(SSL *ssl, int is_export,
2306 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002307
2308/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2309 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2310 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2311 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2312 * keypair.
2313 *
2314 * If the callback is unset, an appropriate curve will be chosen automatically.
2315 * (This is recommended.)
2316 *
2317 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2318 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002319OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002320 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2321
2322/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2323 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2324 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2325 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2326 * keypair.
2327 *
2328 * If the callback is unset, an appropriate curve will be chosen automatically.
2329 * (This is recommended.)
2330 *
2331 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2332 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002333OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002334 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002335
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002336OPENSSL_EXPORT const void *SSL_get_current_compression(SSL *s);
2337OPENSSL_EXPORT const void *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002338
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002339OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2340OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002341
Adam Langley524e7172015-02-20 16:04:00 -08002342/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2343 * resumption decision for a ClientHello has been made. It can return 1 to
2344 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002345OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002346 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2347
Adam Langley95f22882014-06-20 12:00:00 -07002348/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2349 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2350 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002351OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2352 size_t *ssl_ctx_size,
2353 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002354
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002355OPENSSL_EXPORT void ERR_load_SSL_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002356
Adam Langley3f92d212015-02-20 15:32:52 -08002357/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2358 * the read and write directions. It returns one on success or zero if |ssl|
2359 * isn't using an RC4-based cipher suite. */
2360OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2361 const RC4_KEY **write_key);
2362
Adam Langley95c29f32014-06-20 12:00:00 -07002363
David Benjamin71f07942015-04-08 02:36:59 -04002364/* Deprecated functions. */
2365
2366/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2367 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2368 * freed with |OPENSSL_free|, or NULL on error.
2369 *
2370 * The description includes a trailing newline and has the form:
2371 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2372 *
2373 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2374OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2375 char *buf, int len);
2376
2377/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2378OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2379
2380/* SSL_COMP_get_compression_methods returns NULL. */
2381OPENSSL_EXPORT void *SSL_COMP_get_compression_methods(void);
2382
2383/* SSL_COMP_add_compression_method returns one. */
2384OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, void *cm);
2385
2386/* SSL_COMP_get_name returns NULL. */
2387OPENSSL_EXPORT const char *SSL_COMP_get_name(const void *comp);
2388
David Benjamin0d8a7582015-04-08 23:55:15 -04002389/* SSLv23_method calls |TLS_method|. */
2390OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2391
2392/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2393 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2394 * to lock connections to that protocol version. */
2395OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2396OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2397OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2398OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2399OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2400OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2401
2402/* Client- and server-specific methods call their corresponding generic
2403 * methods. */
2404OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2405OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2406OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2407OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2408OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2409OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2410OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2411OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2412OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2413OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2414OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2415OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2416OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2417OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2418OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2419OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2420
David Benjamin4831c332015-05-16 11:43:13 -04002421/* SSL_clear resets |ssl| to allow another connection and returns one on success
2422 * or zero on failure. It returns most configuration state but releases memory
2423 * associated with the current connection.
2424 *
2425 * Free |ssl| and create a new one instead. */
2426OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2427
David Benjamin59015c32015-04-26 13:13:55 -04002428/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2429OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2430 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002431
David Benjamin59015c32015-04-26 13:13:55 -04002432/* SSL_set_tmp_rsa_callback does nothing. */
2433OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2434 RSA *(*cb)(SSL *ssl, int is_export,
2435 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002436
David Benjaminda881e92015-04-26 14:45:04 -04002437/* SSL_CTX_sess_connect returns zero. */
2438OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2439
2440/* SSL_CTX_sess_connect_good returns zero. */
2441OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2442
2443/* SSL_CTX_sess_connect_renegotiate returns zero. */
2444OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2445
2446/* SSL_CTX_sess_accept returns zero. */
2447OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2448
2449/* SSL_CTX_sess_accept_renegotiate returns zero. */
2450OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2451
2452/* SSL_CTX_sess_accept_good returns zero. */
2453OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2454
2455/* SSL_CTX_sess_hits returns zero. */
2456OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2457
2458/* SSL_CTX_sess_cb_hits returns zero. */
2459OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2460
2461/* SSL_CTX_sess_misses returns zero. */
2462OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2463
2464/* SSL_CTX_sess_timeouts returns zero. */
2465OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2466
2467/* SSL_CTX_sess_cache_full returns zero. */
2468OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2469
David Benjamin101ead22015-04-26 18:36:23 -04002470/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2471OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2472
David Benjaminc0454692015-04-27 00:28:56 -04002473/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2474OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2475
2476/* SSL_CTX_need_tmp_RSA returns zero. */
2477OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2478
2479/* SSL_need_tmp_RSA returns zero. */
2480OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2481
2482/* SSL_CTX_set_tmp_rsa returns one. */
2483OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2484
2485/* SSL_set_tmp_rsa returns one. */
2486OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2487
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002488/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002489OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2490
2491/* SSL_CTX_set_read_ahead does nothing. */
2492OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2493
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002494/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002495OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2496
2497/* SSL_set_read_ahead does nothing. */
2498OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2499
David Benjamin44d3eed2015-05-21 01:29:55 -04002500/* SSL_renegotiate put an error on the error queue and returns zero. */
2501OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2502
David Benjaminece089c2015-05-15 23:52:42 -04002503/* SSL_set_state does nothing. */
2504OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2505
David Benjamin71f07942015-04-08 02:36:59 -04002506
Adam Langley7cc3f992015-01-07 15:06:31 -08002507/* Android compatibility section.
2508 *
2509 * These functions are declared, temporarily, for Android because
2510 * wpa_supplicant will take a little time to sync with upstream. Outside of
2511 * Android they'll have no definition. */
2512
2513#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2514
Adam Langleyb4a494c2015-01-23 15:10:10 -08002515OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2516 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002517OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2518OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002519OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2520
2521#define OPENSSL_VERSION_TEXT "BoringSSL"
2522
2523#define SSLEAY_VERSION 0
2524
2525/* SSLeay_version is a compatibility function that returns the string
2526 * "BoringSSL". */
2527OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002528
2529
David Benjamin59015c32015-04-26 13:13:55 -04002530/* Preprocessor compatibility section.
2531 *
2532 * Historically, a number of APIs were implemented in OpenSSL as macros and
2533 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04002534 * section defines a number of legacy macros.
2535 *
2536 * Although using either the CTRL values or their wrapper macros in #ifdefs is
2537 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
2538 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04002539
David Benjamincb3872f2015-06-16 13:20:36 -04002540#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2541#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
2542#define SSL_CTRL_CHANNEL_ID doesnt_exist
2543#define SSL_CTRL_CLEAR_MODE doesnt_exist
2544#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
2545#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
2546#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002547#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002548#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2549#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
2550#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2551#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
2552#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002553#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002554#define SSL_CTRL_MODE doesnt_exist
2555#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2556#define SSL_CTRL_OPTIONS doesnt_exist
2557#define SSL_CTRL_SESS_NUMBER doesnt_exist
2558#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
2559#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2560#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002561#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002562#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002563#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002564#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002565#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002566#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002567#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002568#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2569#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002570#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002571#define SSL_CTRL_SET_TMP_DH doesnt_exist
2572#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2573#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
2574#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
2575#define SSL_CTRL_SET_TMP_RSA doesnt_exist
2576#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002577
David Benjamin8c249802015-05-05 09:44:18 -04002578#define DTLSv1_get_timeout DTLSv1_get_timeout
2579#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamincb3872f2015-06-16 13:20:36 -04002580#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2581#define SSL_CTX_clear_options SSL_CTX_clear_options
2582#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
2583#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2584#define SSL_CTX_get_mode SSL_CTX_get_mode
2585#define SSL_CTX_get_options SSL_CTX_get_options
2586#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2587#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
2588#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2589#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2590#define SSL_CTX_sess_number SSL_CTX_sess_number
2591#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
2592#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2593#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2594#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2595#define SSL_CTX_set_mode SSL_CTX_set_mode
2596#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2597#define SSL_CTX_set_options SSL_CTX_set_options
2598#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
2599#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2600#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2601#define SSL_CTX_set_tlsext_servername_callback \
2602 SSL_CTX_set_tlsext_servername_callback
2603#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
2604#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
2605#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
2606#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
2607#define SSL_clear_mode SSL_clear_mode
2608#define SSL_clear_options SSL_clear_options
2609#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
2610#define SSL_get_max_cert_list SSL_get_max_cert_list
2611#define SSL_get_mode SSL_get_mode
2612#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04002613#define SSL_get_secure_renegotiation_support \
2614 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04002615#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04002616#define SSL_need_tmp_RSA SSL_need_tmp_RSA
2617#define SSL_num_renegotiations SSL_num_renegotiations
2618#define SSL_session_reused SSL_session_reused
2619#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
2620#define SSL_set_max_cert_list SSL_set_max_cert_list
2621#define SSL_set_max_send_fragment SSL_set_max_send_fragment
2622#define SSL_set_mode SSL_set_mode
2623#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
2624#define SSL_set_mtu SSL_set_mtu
2625#define SSL_set_options SSL_set_options
2626#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
2627#define SSL_set_tmp_dh SSL_set_tmp_dh
2628#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
2629#define SSL_set_tmp_rsa SSL_set_tmp_rsa
2630#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04002631
2632
David Benjamin087e4fa2015-04-08 23:46:10 -04002633#if defined(__cplusplus)
2634} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07002635#endif
David Benjamin2e521212014-07-16 14:37:51 -04002636
David Benjamin087e4fa2015-04-08 23:46:10 -04002637
2638/* Library consumers assume these headers are included by ssl.h, but they depend
2639 * on ssl.h, so include them after all declarations.
2640 *
2641 * TODO(davidben): The separation between ssl.h and these version-specific
2642 * headers introduces circular dependencies and is inconsistent. The function
2643 * declarations should move to ssl.h. Many of the constants can probably be
2644 * pruned or unexported. */
2645#include <openssl/ssl2.h>
2646#include <openssl/ssl3.h>
2647#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04002648#include <openssl/ssl23.h>
2649#include <openssl/srtp.h> /* Support for the use_srtp extension */
2650
2651
David Benjamin2e521212014-07-16 14:37:51 -04002652/* BEGIN ERROR CODES */
2653/* The following lines are auto generated by the script make_errors.go. Any
2654 * changes made after this point may be overwritten when the script is next run.
2655 */
David Benjamin689be0f2015-02-11 15:55:26 -05002656#define SSL_F_SSL_CTX_check_private_key 100
2657#define SSL_F_SSL_CTX_new 101
2658#define SSL_F_SSL_CTX_set_cipher_list 102
2659#define SSL_F_SSL_CTX_set_cipher_list_tls11 103
2660#define SSL_F_SSL_CTX_set_session_id_context 104
2661#define SSL_F_SSL_CTX_use_PrivateKey 105
2662#define SSL_F_SSL_CTX_use_PrivateKey_ASN1 106
2663#define SSL_F_SSL_CTX_use_PrivateKey_file 107
2664#define SSL_F_SSL_CTX_use_RSAPrivateKey 108
2665#define SSL_F_SSL_CTX_use_RSAPrivateKey_ASN1 109
2666#define SSL_F_SSL_CTX_use_RSAPrivateKey_file 110
Adam Langley95c29f32014-06-20 12:00:00 -07002667#define SSL_F_SSL_CTX_use_certificate 111
David Benjamin689be0f2015-02-11 15:55:26 -05002668#define SSL_F_SSL_CTX_use_certificate_ASN1 112
2669#define SSL_F_SSL_CTX_use_certificate_chain_file 113
2670#define SSL_F_SSL_CTX_use_certificate_file 114
2671#define SSL_F_SSL_CTX_use_psk_identity_hint 115
2672#define SSL_F_SSL_SESSION_new 116
2673#define SSL_F_SSL_SESSION_print_fp 117
2674#define SSL_F_SSL_SESSION_set1_id_context 118
2675#define SSL_F_SSL_SESSION_to_bytes_full 119
2676#define SSL_F_SSL_accept 120
2677#define SSL_F_SSL_add_dir_cert_subjects_to_stack 121
2678#define SSL_F_SSL_add_file_cert_subjects_to_stack 122
2679#define SSL_F_SSL_check_private_key 123
2680#define SSL_F_SSL_clear 124
2681#define SSL_F_SSL_connect 125
2682#define SSL_F_SSL_do_handshake 126
2683#define SSL_F_SSL_load_client_CA_file 127
2684#define SSL_F_SSL_new 128
2685#define SSL_F_SSL_peek 129
2686#define SSL_F_SSL_read 130
2687#define SSL_F_SSL_renegotiate 131
2688#define SSL_F_SSL_set_cipher_list 132
2689#define SSL_F_SSL_set_fd 133
2690#define SSL_F_SSL_set_rfd 134
2691#define SSL_F_SSL_set_session_id_context 135
2692#define SSL_F_SSL_set_wfd 136
2693#define SSL_F_SSL_shutdown 137
2694#define SSL_F_SSL_use_PrivateKey 138
2695#define SSL_F_SSL_use_PrivateKey_ASN1 139
2696#define SSL_F_SSL_use_PrivateKey_file 140
2697#define SSL_F_SSL_use_RSAPrivateKey 141
2698#define SSL_F_SSL_use_RSAPrivateKey_ASN1 142
2699#define SSL_F_SSL_use_RSAPrivateKey_file 143
2700#define SSL_F_SSL_use_certificate 144
2701#define SSL_F_SSL_use_certificate_ASN1 145
2702#define SSL_F_SSL_use_certificate_file 146
2703#define SSL_F_SSL_use_psk_identity_hint 147
2704#define SSL_F_SSL_write 148
2705#define SSL_F_d2i_SSL_SESSION 149
David Benjaminfd67aa82015-06-15 19:41:48 -04002706#define SSL_F_SSL_SESSION_parse_octet_string 150
2707#define SSL_F_SSL_SESSION_parse_string 151
David Benjamin689be0f2015-02-11 15:55:26 -05002708#define SSL_F_do_ssl3_write 152
2709#define SSL_F_dtls1_accept 153
2710#define SSL_F_dtls1_buffer_record 154
2711#define SSL_F_dtls1_check_timeout_num 155
2712#define SSL_F_dtls1_connect 156
2713#define SSL_F_dtls1_do_write 157
2714#define SSL_F_dtls1_get_hello_verify 158
2715#define SSL_F_dtls1_get_message 159
2716#define SSL_F_dtls1_get_message_fragment 160
2717#define SSL_F_dtls1_preprocess_fragment 161
2718#define SSL_F_dtls1_process_record 162
2719#define SSL_F_dtls1_read_bytes 163
2720#define SSL_F_dtls1_send_hello_verify_request 164
David Benjaminc933a472015-05-30 16:14:58 -04002721#define SSL_F_dtls1_write_app_data 165
David Benjamin689be0f2015-02-11 15:55:26 -05002722#define SSL_F_i2d_SSL_SESSION 166
2723#define SSL_F_ssl3_accept 167
David Benjamin689be0f2015-02-11 15:55:26 -05002724#define SSL_F_ssl3_cert_verify_hash 169
2725#define SSL_F_ssl3_check_cert_and_algorithm 170
2726#define SSL_F_ssl3_connect 171
2727#define SSL_F_ssl3_ctrl 172
2728#define SSL_F_ssl3_ctx_ctrl 173
2729#define SSL_F_ssl3_digest_cached_records 174
2730#define SSL_F_ssl3_do_change_cipher_spec 175
2731#define SSL_F_ssl3_expect_change_cipher_spec 176
2732#define SSL_F_ssl3_get_cert_status 177
2733#define SSL_F_ssl3_get_cert_verify 178
2734#define SSL_F_ssl3_get_certificate_request 179
2735#define SSL_F_ssl3_get_channel_id 180
2736#define SSL_F_ssl3_get_client_certificate 181
2737#define SSL_F_ssl3_get_client_hello 182
2738#define SSL_F_ssl3_get_client_key_exchange 183
2739#define SSL_F_ssl3_get_finished 184
2740#define SSL_F_ssl3_get_initial_bytes 185
2741#define SSL_F_ssl3_get_message 186
2742#define SSL_F_ssl3_get_new_session_ticket 187
2743#define SSL_F_ssl3_get_next_proto 188
2744#define SSL_F_ssl3_get_record 189
2745#define SSL_F_ssl3_get_server_certificate 190
2746#define SSL_F_ssl3_get_server_done 191
2747#define SSL_F_ssl3_get_server_hello 192
2748#define SSL_F_ssl3_get_server_key_exchange 193
2749#define SSL_F_ssl3_get_v2_client_hello 194
2750#define SSL_F_ssl3_handshake_mac 195
2751#define SSL_F_ssl3_prf 196
2752#define SSL_F_ssl3_read_bytes 197
2753#define SSL_F_ssl3_read_n 198
2754#define SSL_F_ssl3_send_cert_verify 199
2755#define SSL_F_ssl3_send_certificate_request 200
2756#define SSL_F_ssl3_send_channel_id 201
2757#define SSL_F_ssl3_send_client_certificate 202
2758#define SSL_F_ssl3_send_client_hello 203
2759#define SSL_F_ssl3_send_client_key_exchange 204
2760#define SSL_F_ssl3_send_server_certificate 205
2761#define SSL_F_ssl3_send_server_hello 206
2762#define SSL_F_ssl3_send_server_key_exchange 207
2763#define SSL_F_ssl3_setup_read_buffer 208
2764#define SSL_F_ssl3_setup_write_buffer 209
2765#define SSL_F_ssl3_write_bytes 210
2766#define SSL_F_ssl3_write_pending 211
2767#define SSL_F_ssl_add_cert_chain 212
2768#define SSL_F_ssl_add_cert_to_buf 213
2769#define SSL_F_ssl_add_clienthello_renegotiate_ext 214
2770#define SSL_F_ssl_add_clienthello_tlsext 215
2771#define SSL_F_ssl_add_clienthello_use_srtp_ext 216
2772#define SSL_F_ssl_add_serverhello_renegotiate_ext 217
2773#define SSL_F_ssl_add_serverhello_tlsext 218
2774#define SSL_F_ssl_add_serverhello_use_srtp_ext 219
2775#define SSL_F_ssl_build_cert_chain 220
2776#define SSL_F_ssl_bytes_to_cipher_list 221
2777#define SSL_F_ssl_cert_dup 222
2778#define SSL_F_ssl_cert_inst 223
2779#define SSL_F_ssl_cert_new 224
2780#define SSL_F_ssl_check_serverhello_tlsext 225
2781#define SSL_F_ssl_check_srvr_ecc_cert_and_alg 226
2782#define SSL_F_ssl_cipher_process_rulestr 227
2783#define SSL_F_ssl_cipher_strength_sort 228
2784#define SSL_F_ssl_create_cipher_list 229
2785#define SSL_F_ssl_ctx_log_master_secret 230
2786#define SSL_F_ssl_ctx_log_rsa_client_key_exchange 231
2787#define SSL_F_ssl_ctx_make_profiles 232
2788#define SSL_F_ssl_get_new_session 233
2789#define SSL_F_ssl_get_prev_session 234
2790#define SSL_F_ssl_get_server_cert_index 235
2791#define SSL_F_ssl_get_sign_pkey 236
2792#define SSL_F_ssl_init_wbio_buffer 237
2793#define SSL_F_ssl_parse_clienthello_renegotiate_ext 238
2794#define SSL_F_ssl_parse_clienthello_tlsext 239
2795#define SSL_F_ssl_parse_clienthello_use_srtp_ext 240
2796#define SSL_F_ssl_parse_serverhello_renegotiate_ext 241
2797#define SSL_F_ssl_parse_serverhello_tlsext 242
2798#define SSL_F_ssl_parse_serverhello_use_srtp_ext 243
2799#define SSL_F_ssl_scan_clienthello_tlsext 244
2800#define SSL_F_ssl_scan_serverhello_tlsext 245
2801#define SSL_F_ssl_sess_cert_new 246
2802#define SSL_F_ssl_set_cert 247
2803#define SSL_F_ssl_set_pkey 248
David Benjamin689be0f2015-02-11 15:55:26 -05002804#define SSL_F_ssl_verify_cert_chain 252
2805#define SSL_F_tls12_check_peer_sigalg 253
2806#define SSL_F_tls1_aead_ctx_init 254
2807#define SSL_F_tls1_cert_verify_mac 255
2808#define SSL_F_tls1_change_cipher_state 256
2809#define SSL_F_tls1_change_cipher_state_aead 257
2810#define SSL_F_tls1_check_duplicate_extensions 258
2811#define SSL_F_tls1_enc 259
2812#define SSL_F_tls1_export_keying_material 260
2813#define SSL_F_tls1_prf 261
2814#define SSL_F_tls1_setup_key_block 262
David Benjamin75381222015-03-02 19:30:30 -05002815#define SSL_F_dtls1_get_buffered_message 263
2816#define SSL_F_dtls1_process_fragment 264
David Benjaminee562b92015-03-02 20:52:52 -05002817#define SSL_F_dtls1_hm_fragment_new 265
David Benjamin9faafda2015-04-04 19:23:10 -04002818#define SSL_F_ssl3_seal_record 266
David Benjamind81e73d2015-04-05 00:21:39 -04002819#define SSL_F_ssl3_record_sequence_update 267
David Benjamin15a3b002015-04-28 00:05:35 -04002820#define SSL_F_SSL_CTX_set_tmp_dh 268
2821#define SSL_F_SSL_CTX_set_tmp_ecdh 269
2822#define SSL_F_SSL_set_tmp_dh 270
2823#define SSL_F_SSL_set_tmp_ecdh 271
David Benjaminc2807582015-04-28 00:19:50 -04002824#define SSL_F_SSL_CTX_set1_tls_channel_id 272
2825#define SSL_F_SSL_set1_tls_channel_id 273
David Benjamin7133d422015-04-28 00:43:39 -04002826#define SSL_F_SSL_set_tlsext_host_name 274
David Benjamin605641e2015-05-03 15:14:04 -04002827#define SSL_F_ssl3_output_cert_chain 275
David Benjamin31a07792015-03-03 14:20:26 -05002828#define SSL_F_SSL_AEAD_CTX_new 276
2829#define SSL_F_SSL_AEAD_CTX_open 277
2830#define SSL_F_SSL_AEAD_CTX_seal 278
2831#define SSL_F_dtls1_seal_record 279
David Benjaminfd67aa82015-06-15 19:41:48 -04002832#define SSL_F_SSL_SESSION_from_bytes 280
2833#define SSL_F_SSL_SESSION_parse 281
2834#define SSL_F_ssl3_check_certificate_for_cipher 282
David Benjamin689be0f2015-02-11 15:55:26 -05002835#define SSL_R_APP_DATA_IN_HANDSHAKE 100
2836#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
2837#define SSL_R_BAD_ALERT 102
2838#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
2839#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
2840#define SSL_R_BAD_DH_P_LENGTH 105
2841#define SSL_R_BAD_DIGEST_LENGTH 106
2842#define SSL_R_BAD_ECC_CERT 107
2843#define SSL_R_BAD_ECPOINT 108
2844#define SSL_R_BAD_HANDSHAKE_LENGTH 109
2845#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07002846#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05002847#define SSL_R_BAD_LENGTH 112
2848#define SSL_R_BAD_PACKET_LENGTH 113
2849#define SSL_R_BAD_RSA_ENCRYPT 114
2850#define SSL_R_BAD_SIGNATURE 115
2851#define SSL_R_BAD_SRTP_MKI_VALUE 116
2852#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
2853#define SSL_R_BAD_SSL_FILETYPE 118
2854#define SSL_R_BAD_WRITE_RETRY 119
2855#define SSL_R_BIO_NOT_SET 120
2856#define SSL_R_BN_LIB 121
2857#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
2858#define SSL_R_CA_DN_LENGTH_MISMATCH 123
2859#define SSL_R_CA_DN_TOO_LONG 124
2860#define SSL_R_CCS_RECEIVED_EARLY 125
2861#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
2862#define SSL_R_CERT_CB_ERROR 127
2863#define SSL_R_CERT_LENGTH_MISMATCH 128
2864#define SSL_R_CHANNEL_ID_NOT_P256 129
2865#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
2866#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
2867#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
2868#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
2869#define SSL_R_CLIENTHELLO_TLSEXT 134
2870#define SSL_R_CONNECTION_REJECTED 135
2871#define SSL_R_CONNECTION_TYPE_NOT_SET 136
2872#define SSL_R_COOKIE_MISMATCH 137
2873#define SSL_R_D2I_ECDSA_SIG 138
2874#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
2875#define SSL_R_DATA_LENGTH_TOO_LONG 140
2876#define SSL_R_DECODE_ERROR 141
2877#define SSL_R_DECRYPTION_FAILED 142
2878#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
2879#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
2880#define SSL_R_DIGEST_CHECK_FAILED 145
2881#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
2882#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
2883#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
2884#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
2885#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
2886#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
2887#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
2888#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
2889#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
2890#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
2891#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
2892#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
2893#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
2894#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
2895#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
2896#define SSL_R_HTTPS_PROXY_REQUEST 161
2897#define SSL_R_HTTP_REQUEST 162
2898#define SSL_R_INAPPROPRIATE_FALLBACK 163
2899#define SSL_R_INVALID_COMMAND 164
2900#define SSL_R_INVALID_MESSAGE 165
2901#define SSL_R_INVALID_SSL_SESSION 166
2902#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
2903#define SSL_R_LENGTH_MISMATCH 168
2904#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
2905#define SSL_R_MISSING_DH_KEY 170
2906#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
2907#define SSL_R_MISSING_RSA_CERTIFICATE 172
2908#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
2909#define SSL_R_MISSING_RSA_SIGNING_CERT 174
2910#define SSL_R_MISSING_TMP_DH_KEY 175
2911#define SSL_R_MISSING_TMP_ECDH_KEY 176
2912#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
2913#define SSL_R_MTU_TOO_SMALL 178
2914#define SSL_R_NESTED_GROUP 179
2915#define SSL_R_NO_CERTIFICATES_RETURNED 180
2916#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
2917#define SSL_R_NO_CERTIFICATE_SET 182
2918#define SSL_R_NO_CIPHERS_AVAILABLE 183
2919#define SSL_R_NO_CIPHERS_PASSED 184
2920#define SSL_R_NO_CIPHERS_SPECIFIED 185
2921#define SSL_R_NO_CIPHER_MATCH 186
2922#define SSL_R_NO_COMPRESSION_SPECIFIED 187
2923#define SSL_R_NO_METHOD_SPECIFIED 188
2924#define SSL_R_NO_P256_SUPPORT 189
2925#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
2926#define SSL_R_NO_RENEGOTIATION 191
2927#define SSL_R_NO_REQUIRED_DIGEST 192
2928#define SSL_R_NO_SHARED_CIPHER 193
2929#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
2930#define SSL_R_NO_SRTP_PROFILES 195
2931#define SSL_R_NULL_SSL_CTX 196
2932#define SSL_R_NULL_SSL_METHOD_PASSED 197
2933#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
2934#define SSL_R_PACKET_LENGTH_TOO_LONG 199
2935#define SSL_R_PARSE_TLSEXT 200
2936#define SSL_R_PATH_TOO_LONG 201
2937#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
2938#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
2939#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
2940#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
2941#define SSL_R_PSK_NO_CLIENT_CB 206
2942#define SSL_R_PSK_NO_SERVER_CB 207
2943#define SSL_R_READ_BIO_NOT_SET 208
2944#define SSL_R_READ_TIMEOUT_EXPIRED 209
2945#define SSL_R_RECORD_LENGTH_MISMATCH 210
2946#define SSL_R_RECORD_TOO_LARGE 211
2947#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
2948#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
2949#define SSL_R_RENEGOTIATION_MISMATCH 214
2950#define SSL_R_REQUIRED_CIPHER_MISSING 215
2951#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
2952#define SSL_R_SERVERHELLO_TLSEXT 217
2953#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
2954#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
2955#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
2956#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
2957#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
2958#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
2959#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
2960#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
2961#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
2962#define SSL_R_SSL_HANDSHAKE_FAILURE 227
2963#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
2964#define SSL_R_SSL_SESSION_ID_CONFLICT 229
2965#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
2966#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
2967#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
2968#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
2969#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
2970#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
2971#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
2972#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
2973#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
2974#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
2975#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
2976#define SSL_R_UNEXPECTED_MESSAGE 241
2977#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
2978#define SSL_R_UNEXPECTED_RECORD 243
2979#define SSL_R_UNINITIALIZED 244
2980#define SSL_R_UNKNOWN_ALERT_TYPE 245
2981#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
2982#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
2983#define SSL_R_UNKNOWN_CIPHER_TYPE 248
2984#define SSL_R_UNKNOWN_DIGEST 249
2985#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
2986#define SSL_R_UNKNOWN_PROTOCOL 251
2987#define SSL_R_UNKNOWN_SSL_VERSION 252
2988#define SSL_R_UNKNOWN_STATE 253
2989#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
2990#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
2991#define SSL_R_UNSUPPORTED_CIPHER 256
2992#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
2993#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
2994#define SSL_R_UNSUPPORTED_PROTOCOL 259
2995#define SSL_R_UNSUPPORTED_SSL_VERSION 260
2996#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07002997#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05002998#define SSL_R_WRONG_CIPHER_RETURNED 263
2999#define SSL_R_WRONG_CURVE 264
3000#define SSL_R_WRONG_MESSAGE_TYPE 265
3001#define SSL_R_WRONG_SIGNATURE_TYPE 266
3002#define SSL_R_WRONG_SSL_VERSION 267
3003#define SSL_R_WRONG_VERSION_NUMBER 268
3004#define SSL_R_X509_LIB 269
3005#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05003006#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04003007#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04003008#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05003009#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07003010#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
3011#define SSL_R_EMS_STATE_INCONSISTENT 276
3012#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04003013#define SSL_R_TOO_MANY_WARNING_ALERTS 278
David Benjamind7c53682014-09-17 12:08:13 -04003014#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04003015#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
3016#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
3017#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
3018#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
3019#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
3020#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
3021#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
3022#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
3023#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
3024#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
3025#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
3026#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
3027#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
3028#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
3029#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
3030#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
3031#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
3032#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
3033#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
3034#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
3035#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04003036#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04003037#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
3038#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
3039#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
3040#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
3041#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
3042#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
3043#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07003044
David Benjamin087e4fa2015-04-08 23:46:10 -04003045#endif /* OPENSSL_HEADER_SSL_H */