blob: 7071accf3e3ace76a8921107245305cfae0bb0f2 [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
David Benjaminb487df62015-05-16 15:31:07 -0400352/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
353 * ECDHE curves according to the server's preferences instead of the
354 * client's. */
355#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
356
357/* The following flags toggle individual protocol versions. This is deprecated.
358 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
359#define SSL_OP_NO_SSLv3 0x02000000L
360#define SSL_OP_NO_TLSv1 0x04000000L
361#define SSL_OP_NO_TLSv1_2 0x08000000L
362#define SSL_OP_NO_TLSv1_1 0x10000000L
363#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
364#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
365
366/* The following flags do nothing and are included only to make it easier to
367 * compile code with BoringSSL. */
368#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
369#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
370#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
371#define SSL_OP_NO_COMPRESSION 0
372#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
373#define SSL_OP_NO_SSLv2 0
374#define SSL_OP_SINGLE_DH_USE 0
375#define SSL_OP_SINGLE_ECDH_USE 0
376#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
377#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
378#define SSL_OP_TLS_ROLLBACK_BUG 0
Adam Langley5021b222015-06-12 18:27:58 -0700379#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
David Benjaminb487df62015-05-16 15:31:07 -0400380
381/* SSL_CTX_set_options enables all options set in |options| (which should be one
382 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
383 * bitmask representing the resulting enabled options. */
384OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
385
386/* SSL_CTX_clear_options disables all options set in |options| (which should be
387 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
388 * bitmask representing the resulting enabled options. */
389OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
390
391/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
392 * the options enabled for |ctx|. */
393OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
394
395/* SSL_set_options enables all options set in |options| (which should be one or
396 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
397 * representing the resulting enabled options. */
398OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
399
400/* SSL_clear_options disables all options set in |options| (which should be one
401 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
402 * bitmask representing the resulting enabled options. */
403OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
404
405/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
406 * options enabled for |ssl|. */
407OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
408
409
410/* Modes.
411 *
412 * Modes configure API behavior. */
413
414/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
415 * result when the only part of the input was written in a single record. */
416#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
417
418/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
419 * with a different buffer. However, |SSL_write| still assumes the buffer
420 * contents are unchanged. This is not the default to avoid the misconception
421 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
422#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
423
424/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
425 * before sending certificates to the peer.
426 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
427#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
428
David Benjaminb487df62015-05-16 15:31:07 -0400429/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
430 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
431 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
432#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
433
434/* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
435 * SSL_MODE_ENABLE_FALSE_START. */
436#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
437
438/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
439 * TLS 1.0 to be split in two: the first record will contain a single byte and
440 * the second will contain the remainder. This effectively randomises the IV and
441 * prevents BEAST attacks. */
442#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
443
444/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
445 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
446 * session resumption is used for a given SSL*. */
447#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
448
449/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
450 * To be set only by applications that reconnect with a downgraded protocol
451 * version; see https://tools.ietf.org/html/draft-ietf-tls-downgrade-scsv-05
452 * for details.
453 *
454 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
455 * this in explicit fallback retries, following the guidance in
456 * draft-ietf-tls-downgrade-scsv-05. */
457#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
458
459/* The following flags do nothing and are included only to make it easier to
460 * compile code with BoringSSL. */
461#define SSL_MODE_AUTO_RETRY 0
462#define SSL_MODE_RELEASE_BUFFERS 0
David Benjamin74d8bc22015-05-21 02:16:53 -0400463#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
464#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjaminb487df62015-05-16 15:31:07 -0400465
466/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
467 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
468 * representing the resulting enabled modes. */
469OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
470
471/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
472 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
473 * bitmask representing the resulting enabled modes. */
474OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
475
476/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
477 * the modes enabled for |ssl|. */
478OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
479
480/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
481 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
482 * representing the resulting enabled modes. */
483OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
484
485/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
486 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
487 * representing the resulting enabled modes. */
488OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
489
490/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
491 * modes enabled for |ssl|. */
492OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
493
494
David Benjaminb4d65fd2015-05-29 17:11:21 -0400495/* Configuring certificates and private keys.
496 *
497 * TODO(davidben): Move the other, more conventional, certificate and key
David Benjamind1d80782015-07-05 11:54:09 -0400498 * configuration functions here. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400499
500enum ssl_private_key_result_t {
501 ssl_private_key_success,
502 ssl_private_key_retry,
503 ssl_private_key_failure,
504};
505
506/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
507 * signing operations to a custom, potentially asynchronous, backend. */
508typedef struct ssl_private_key_method_st {
509 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
510 * key used by |ssl|. */
511 int (*type)(SSL *ssl);
512
513 /* supports_digest returns one if the key used by |ssl| supports signing
514 * digests of type |md| and zero otherwise. */
515 int (*supports_digest)(SSL *ssl, const EVP_MD *md);
516
517 /* max_signature_len returns the maximum length of a signature signed by the
518 * key used by |ssl|. This must be a constant value for a given |ssl|. */
519 size_t (*max_signature_len)(SSL *ssl);
520
521 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
522 * used to calculate |in|. On success, it returns |ssl_private_key_success|
523 * and writes at most |max_out| bytes of signature data to |out|. On failure,
524 * it returns |ssl_private_key_failure|. If the operation has not completed,
525 * it returns |ssl_private_key_retry|. |sign| should arrange for the
526 * high-level operation on |ssl| to be retried when the operation is
527 * completed. This will result in a call to |sign_complete|.
528 *
529 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
530 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
531 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
532 *
533 * It is an error to call |sign| while another private key operation is in
534 * progress on |ssl|. */
535 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
536 size_t max_out, const EVP_MD *md,
537 const uint8_t *in, size_t in_len);
538
539 /* sign_complete completes a pending |sign| operation. If the operation has
540 * completed, it returns |ssl_private_key_success| and writes the result to
541 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
542 * failure and |ssl_private_key_retry| if the operation is still in progress.
543 *
544 * |sign_complete| may be called arbitrarily many times before completion, but
545 * it is an error to call |sign_complete| if there is no pending |sign|
546 * operation in progress on |ssl|. */
547 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
548 size_t *out_len, size_t max_out);
549} SSL_PRIVATE_KEY_METHOD;
550
David Benjamind1d80782015-07-05 11:54:09 -0400551/* SSL_use_private_key_method configures a custom private key on |ssl|.
552 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400553OPENSSL_EXPORT void SSL_set_private_key_method(
554 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
555
556
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700557/* Connection information. */
558
559/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
560 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
561 * returns one on success or zero on error. In general |max_out| should be at
562 * least 12.
563 *
564 * This function will always fail if the initial handshake has not completed.
565 * The tls-unique value will change after a renegotiation but, since
566 * renegotiations can be initiated by the server at any point, the higher-level
567 * protocol must either leave them disabled or define states in which the
568 * tls-unique value can be read.
569 *
570 * The tls-unique value is defined by
571 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
572 * TLS protocol, tls-unique is broken for resumed connections unless the
573 * Extended Master Secret extension is negotiated. Thus this function will
574 * return zero if |ssl| performed session resumption unless EMS was used when
575 * negotiating the original session. */
576OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
577 size_t *out_len, size_t max_out);
578
579
David Benjamindaeafc22015-06-25 17:35:11 -0400580/* Session tickets. */
581
582/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
583 * |len| bytes of |out|. It returns one on success and zero if |len| is not
584 * 48. If |out| is NULL, it returns 48 instead. */
585OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
586 size_t len);
587
588/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
589 * |len| bytes of |in|. It returns one on success and zero if |len| is not
590 * 48. If |in| is NULL, it returns 48 instead. */
591OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
592 size_t len);
593
David Benjamine3aa1d92015-06-16 15:34:50 -0400594/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
595 * ticket. */
596#define SSL_TICKET_KEY_NAME_LEN 16
597
David Benjamindaeafc22015-06-25 17:35:11 -0400598/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
599 * returns one. |callback| will be called when encrypting a new ticket and when
600 * decrypting a ticket from the client.
601 *
602 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
603 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
604 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
605 * for encryption or decryption, based on the mode.
606 *
607 * When encrypting a new ticket, |encrypt| will be one. It writes a public
608 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
609 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
610 * |callback| returns 1 on success and -1 on error.
611 *
612 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
613 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
614 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
615 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
616 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
617 * This may be used to re-key the ticket.
618 *
619 * WARNING: |callback| wildly breaks the usual return value convention and is
620 * called in two different modes. */
621OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
622 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
623 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
624 int encrypt));
625
626
David Benjamin71f07942015-04-08 02:36:59 -0400627/* Underdocumented functions.
628 *
629 * Functions below here haven't been touched up and may be underdocumented. */
630
Adam Langley95c29f32014-06-20 12:00:00 -0700631/* SSLeay version number for ASN.1 encoding of the session information */
632/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -0800633 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -0700634#define SSL_SESSION_ASN1_VERSION 0x0001
635
Adam Langleyb4a494c2015-01-23 15:10:10 -0800636#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
637#define SSL_MAX_SID_CTX_LENGTH 32
638#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -0700639
640/* These are used to specify which ciphers to use and not to use */
641
Adam Langleyb4a494c2015-01-23 15:10:10 -0800642#define SSL_TXT_MEDIUM "MEDIUM"
643#define SSL_TXT_HIGH "HIGH"
644#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -0700645
Adam Langleyb4a494c2015-01-23 15:10:10 -0800646#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -0400647#define SSL_TXT_kDHE "kDHE"
648#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
649#define SSL_TXT_kECDHE "kECDHE"
650#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800651#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700652
Adam Langleyb4a494c2015-01-23 15:10:10 -0800653#define SSL_TXT_aRSA "aRSA"
654#define SSL_TXT_aECDSA "aECDSA"
655#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700656
Adam Langleyb4a494c2015-01-23 15:10:10 -0800657#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400658#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400659#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800660#define SSL_TXT_RSA "RSA"
661#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400662#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400663#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800664#define SSL_TXT_ECDSA "ECDSA"
665#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700666
Adam Langleyb4a494c2015-01-23 15:10:10 -0800667#define SSL_TXT_3DES "3DES"
668#define SSL_TXT_RC4 "RC4"
669#define SSL_TXT_AES128 "AES128"
670#define SSL_TXT_AES256 "AES256"
671#define SSL_TXT_AES "AES"
672#define SSL_TXT_AES_GCM "AESGCM"
673#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -0700674
Adam Langleyb4a494c2015-01-23 15:10:10 -0800675#define SSL_TXT_MD5 "MD5"
676#define SSL_TXT_SHA1 "SHA1"
677#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
678#define SSL_TXT_SHA256 "SHA256"
679#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -0700680
Adam Langleyb4a494c2015-01-23 15:10:10 -0800681#define SSL_TXT_SSLV3 "SSLv3"
682#define SSL_TXT_TLSV1 "TLSv1"
683#define SSL_TXT_TLSV1_1 "TLSv1.1"
684#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -0700685
Adam Langleyb4a494c2015-01-23 15:10:10 -0800686#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -0700687
Adam Langleyb4a494c2015-01-23 15:10:10 -0800688/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
689 * normally not being used.
690 *
691 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
692 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
693 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
694 * that it is also disabled in the specific selection. COMPLEMENTOF*
695 * identifiers are portable between version, as adjustments to the default
696 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -0700697 *
698 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -0800699 * DEFAULT gets, as only selection is being done and no sorting as needed for
700 * DEFAULT. */
701#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -0700702
Adam Langleyb4a494c2015-01-23 15:10:10 -0800703/* The following cipher list is used by default. It also is substituted when an
704 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -0400705#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -0800706
Adam Langley95c29f32014-06-20 12:00:00 -0700707/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
708 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -0800709 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
710 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -0700711
712/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800713#define SSL_SENT_SHUTDOWN 1
714#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -0700715
Adam Langleyb4a494c2015-01-23 15:10:10 -0800716#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
717#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
Adam Langley95c29f32014-06-20 12:00:00 -0700718
David Benjamin82c9e902014-12-12 15:55:27 -0500719typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700720typedef struct ssl_session_st SSL_SESSION;
Adam Langley95c29f32014-06-20 12:00:00 -0700721typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -0500722typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700723
Adam Langleyb4a494c2015-01-23 15:10:10 -0800724/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
725typedef struct srtp_protection_profile_st {
726 const char *name;
727 unsigned long id;
728} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -0700729
730DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
731
David Benjamin83fd6b62014-10-19 04:33:38 -0400732/* An SSL_SESSION represents an SSL session that may be resumed in an
733 * abbreviated handshake. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800734struct ssl_session_st {
735 int ssl_version; /* what ssl version session info is being kept in here? */
Adam Langley95c29f32014-06-20 12:00:00 -0700736
Adam Langleyb4a494c2015-01-23 15:10:10 -0800737 int master_key_length;
738 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
739 /* session_id - valid? */
740 unsigned int session_id_length;
741 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
742 /* this is used to determine whether the session is being reused in
743 * the appropriate context. It is up to the application to set this,
744 * via SSL_new */
745 unsigned int sid_ctx_length;
746 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -0700747
Adam Langleyb4a494c2015-01-23 15:10:10 -0800748 char *psk_identity;
749 /* Used to indicate that session resumption is not allowed. Applications can
750 * also set this bit for a new session via not_resumable_session_cb to
751 * disable session caching and tickets. */
752 int not_resumable;
Adam Langley95c29f32014-06-20 12:00:00 -0700753
David Benjamin680ca962015-06-18 12:37:23 -0400754 /* The cert is the certificate used to establish this connection
755 *
756 * TODO(davidben): Remove this field. It is not serialized as part of the
757 * session, but some APIs access it. Certificate-related fields, where not
758 * redundant with |peer|, should be added to the session. Others should
759 * probably not be retained across resumptions. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800760 struct sess_cert_st /* SESS_CERT */ *sess_cert;
Adam Langley95c29f32014-06-20 12:00:00 -0700761
Adam Langleyb4a494c2015-01-23 15:10:10 -0800762 /* This is the cert for the other end. On clients, it will be the same as
763 * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is not
764 * retained in the external representation of sessions, see ssl_asn1.c). */
765 X509 *peer;
766 /* when app_verify_callback accepts a session where the peer's certificate is
767 * not ok, we must remember the error for session reuse: */
768 long verify_result; /* only for servers */
Adam Langley95c29f32014-06-20 12:00:00 -0700769
Adam Langley0b5e3902015-05-15 13:08:38 -0700770 CRYPTO_refcount_t references;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800771 long timeout;
772 long time;
Adam Langley95c29f32014-06-20 12:00:00 -0700773
Adam Langleyb4a494c2015-01-23 15:10:10 -0800774 const SSL_CIPHER *cipher;
Adam Langley95c29f32014-06-20 12:00:00 -0700775
Adam Langleyb4a494c2015-01-23 15:10:10 -0800776 CRYPTO_EX_DATA ex_data; /* application specific data */
Adam Langley95c29f32014-06-20 12:00:00 -0700777
Adam Langleyb4a494c2015-01-23 15:10:10 -0800778 /* These are used to make removal of session-ids more efficient and to
779 * implement a maximum cache size. */
David Benjamin4dab2972015-05-16 02:56:06 -0400780 SSL_SESSION *prev, *next;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800781 char *tlsext_hostname;
782 /* RFC4507 info */
783 uint8_t *tlsext_tick; /* Session ticket */
784 size_t tlsext_ticklen; /* Session ticket length */
785 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
David Benjamin6c7aed02014-08-27 16:42:38 -0400786
Adam Langleyb4a494c2015-01-23 15:10:10 -0800787 size_t tlsext_signed_cert_timestamp_list_length;
788 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
David Benjamin6c7aed02014-08-27 16:42:38 -0400789
Adam Langleyb4a494c2015-01-23 15:10:10 -0800790 /* The OCSP response that came with the session. */
791 size_t ocsp_response_length;
792 uint8_t *ocsp_response;
David Benjamin6c7aed02014-08-27 16:42:38 -0400793
Adam Langleyb4a494c2015-01-23 15:10:10 -0800794 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
795 uint8_t
796 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
Adam Langley1258b6a2014-06-20 12:00:00 -0700797
Adam Langleyb4a494c2015-01-23 15:10:10 -0800798 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
799 * SHA-2, depending on TLS version) for the original, full handshake that
800 * created a session. This is used by Channel IDs during resumption. */
801 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
802 unsigned int original_handshake_hash_len;
Adam Langley75712922014-10-10 16:23:43 -0700803
Adam Langleyb4a494c2015-01-23 15:10:10 -0800804 /* extended_master_secret is true if the master secret in this session was
805 * generated using EMS and thus isn't vulnerable to the Triple Handshake
806 * attack. */
807 char extended_master_secret;
808};
Adam Langley95c29f32014-06-20 12:00:00 -0700809
Adam Langley95c29f32014-06-20 12:00:00 -0700810
811/* Cert related flags */
812/* Many implementations ignore some aspects of the TLS standards such as
Adam Langleyb4a494c2015-01-23 15:10:10 -0800813 * enforcing certifcate chain algorithms. When this is set we enforce them. */
814#define SSL_CERT_FLAG_TLS_STRICT 0x00000001L
Adam Langley95c29f32014-06-20 12:00:00 -0700815
David Benjamincb9cf792015-05-05 09:46:14 -0400816/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
817 * and zero on failure. */
818OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -0700819
David Benjamincb9cf792015-05-05 09:46:14 -0400820/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
821 * renegotiation (RFC 5746) and zero otherwise. */
822OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -0700823
David Benjamin59015c32015-04-26 13:13:55 -0400824/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
825 * This callback will be called when sending or receiving low-level record
826 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
827 * |write_p| is one for outgoing messages and zero for incoming messages.
828 *
829 * For each record header, |cb| is called with |version| = 0 and |content_type|
830 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
831 * this does not include the record body. If the record is sealed, the length
832 * in the header is the length of the ciphertext.
833 *
834 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
835 * protocol version and |content_type| is the corresponding record type. The
836 * |len| bytes from |buf| contain the handshake message, one-byte
837 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800838OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
839 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
840 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -0400841
David Benjamin61ecccf2015-05-05 09:44:51 -0400842/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
843 * callback. */
844OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
845
David Benjamin59015c32015-04-26 13:13:55 -0400846/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
847 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800848OPENSSL_EXPORT void SSL_set_msg_callback(
849 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
850 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -0400851
David Benjamin3b7456e2015-05-16 12:29:32 -0400852/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -0400853OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -0700854
David Benjamin859ec3c2014-09-02 16:29:36 -0400855/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -0800856 * log session material to |keylog_bio|. This is intended for debugging use
857 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -0400858 *
859 * The format is described in
860 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -0400861OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -0400862
Adam Langley95c29f32014-06-20 12:00:00 -0700863
Adam Langleyc9fb3752014-06-20 12:00:00 -0700864struct ssl_aead_ctx_st;
865typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
866
Adam Langleyb4a494c2015-01-23 15:10:10 -0800867#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -0700868
Adam Langleyb4a494c2015-01-23 15:10:10 -0800869#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -0700870
David Benjaminf4501342014-08-14 17:24:37 -0400871#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
872
Adam Langleyb4a494c2015-01-23 15:10:10 -0800873/* This callback type is used inside SSL_CTX, SSL, and in the functions that
874 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -0700875 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -0800876 * callbacks should themselves check if the id they generate is unique
877 * otherwise the SSL handshake will fail with an error - callbacks can do this
878 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -0700879 * SSL_has_matching_session_id(ssl, id, *id_len)
880 * The length value passed in is set at the maximum size the session ID can be.
881 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
882 * can alter this length to be less if desired, but under SSLv2 session IDs are
883 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -0800884 * returns in this case. It is also an error for the callback to set the size
885 * to zero. */
886typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
887 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700888
Adam Langleydc9b1412014-06-20 12:00:00 -0700889/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -0800890 * early on during the server handshake. At this point, much of the SSL* hasn't
891 * been filled out and only the ClientHello can be depended on. */
892struct ssl_early_callback_ctx {
893 SSL *ssl;
894 const uint8_t *client_hello;
895 size_t client_hello_len;
896 const uint8_t *session_id;
897 size_t session_id_len;
898 const uint8_t *cipher_suites;
899 size_t cipher_suites_len;
900 const uint8_t *compression_methods;
901 size_t compression_methods_len;
902 const uint8_t *extensions;
903 size_t extensions_len;
904};
Adam Langleydc9b1412014-06-20 12:00:00 -0700905
Adam Langleyb4a494c2015-01-23 15:10:10 -0800906/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
907 * extension of the given type. If not found, it returns zero. Otherwise it
908 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -0700909 * and length bytes), sets |out_len| to the length of the extension contents
910 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800911OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
912 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
913 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -0700914
Adam Langley95c29f32014-06-20 12:00:00 -0700915typedef struct ssl_comp_st SSL_COMP;
916
Adam Langleyb4a494c2015-01-23 15:10:10 -0800917struct ssl_comp_st {
918 int id;
919 const char *name;
920 char *method;
921};
Adam Langley95c29f32014-06-20 12:00:00 -0700922
923DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -0700924DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -0700925
Adam Langley858a88d2014-06-20 12:00:00 -0700926/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
927 * equal-preference groups. For TLS clients, the groups are moot because the
928 * server picks the cipher and groups cannot be expressed on the wire. However,
929 * for servers, the equal-preference groups allow the client's preferences to
930 * be partially respected. (This only has an effect with
931 * SSL_OP_CIPHER_SERVER_PREFERENCE).
932 *
933 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
934 * All elements of a group have the same priority: no ordering is expressed
935 * within a group.
936 *
937 * The values in |ciphers| are in one-to-one correspondence with
938 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
939 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
940 * indicate that the corresponding SSL_CIPHER is not the last element of a
941 * group, or 0 to indicate that it is.
942 *
943 * For example, if |in_group_flags| contains all zeros then that indicates a
944 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
945 * of the group (i.e. they are all in a one-element group).
946 *
947 * For a more complex example, consider:
948 * ciphers: A B C D E F
949 * in_group_flags: 1 1 0 0 1 0
950 *
951 * That would express the following, order:
952 *
953 * A E
954 * B -> D -> F
955 * C
956 */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800957struct ssl_cipher_preference_list_st {
958 STACK_OF(SSL_CIPHER) *ciphers;
959 uint8_t *in_group_flags;
960};
Adam Langley858a88d2014-06-20 12:00:00 -0700961
Adam Langleyb4a494c2015-01-23 15:10:10 -0800962struct ssl_ctx_st {
963 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -0700964
Adam Langley4bdb6e42015-05-15 15:29:21 -0700965 /* lock is used to protect various operations on this object. */
966 CRYPTO_MUTEX lock;
967
Adam Langleyb4a494c2015-01-23 15:10:10 -0800968 /* max_version is the maximum acceptable protocol version. If zero, the
969 * maximum supported version, currently (D)TLS 1.2, is used. */
970 uint16_t max_version;
David Benjamin1eb367c2014-12-12 18:17:51 -0500971
Adam Langleyb4a494c2015-01-23 15:10:10 -0800972 /* min_version is the minimum acceptable protocl version. If zero, the
973 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
974 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -0500975
Adam Langleyb4a494c2015-01-23 15:10:10 -0800976 struct ssl_cipher_preference_list_st *cipher_list;
977 /* same as above but sorted for lookup */
978 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
979 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
980 * use. This only applies to server connections as, for clients, the version
981 * number is known at connect time and so the cipher list can be set then. */
982 struct ssl_cipher_preference_list_st *cipher_list_tls11;
Adam Langley95c29f32014-06-20 12:00:00 -0700983
David Benjamin4dab2972015-05-16 02:56:06 -0400984 X509_STORE *cert_store;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800985 LHASH_OF(SSL_SESSION) *sessions;
986 /* Most session-ids that will be cached, default is
987 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
988 unsigned long session_cache_size;
David Benjamin4dab2972015-05-16 02:56:06 -0400989 SSL_SESSION *session_cache_head;
990 SSL_SESSION *session_cache_tail;
Adam Langley95c29f32014-06-20 12:00:00 -0700991
David Benjaminb6d0c6d2015-03-19 19:07:26 -0400992 /* handshakes_since_cache_flush is the number of successful handshakes since
993 * the last cache flush. */
994 int handshakes_since_cache_flush;
995
Adam Langleyb4a494c2015-01-23 15:10:10 -0800996 /* This can have one of 2 values, ored together,
997 * SSL_SESS_CACHE_CLIENT,
998 * SSL_SESS_CACHE_SERVER,
999 * Default is SSL_SESSION_CACHE_SERVER, which means only
1000 * SSL_accept which cache SSL_SESSIONS. */
1001 int session_cache_mode;
Adam Langley95c29f32014-06-20 12:00:00 -07001002
Adam Langleyb4a494c2015-01-23 15:10:10 -08001003 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
1004 * called. This has been put in to make life easier to set things up */
1005 long session_timeout;
Adam Langley95c29f32014-06-20 12:00:00 -07001006
Adam Langleyb4a494c2015-01-23 15:10:10 -08001007 /* If this callback is not null, it will be called each time a session id is
1008 * added to the cache. If this function returns 1, it means that the
1009 * callback will do a SSL_SESSION_free() when it has finished using it.
1010 * Otherwise, on 0, it means the callback has finished with it. If
1011 * remove_session_cb is not null, it will be called when a session-id is
1012 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
1013 * it. */
David Benjamin4dab2972015-05-16 02:56:06 -04001014 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
1015 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
1016 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001017 int *copy);
Adam Langley95c29f32014-06-20 12:00:00 -07001018
Adam Langley0b5e3902015-05-15 13:08:38 -07001019 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -07001020
Adam Langleyb4a494c2015-01-23 15:10:10 -08001021 /* if defined, these override the X509_verify_cert() calls */
1022 int (*app_verify_callback)(X509_STORE_CTX *, void *);
1023 void *app_verify_arg;
1024 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
1025 * was called with just one argument) */
Adam Langley95c29f32014-06-20 12:00:00 -07001026
Adam Langleyb4a494c2015-01-23 15:10:10 -08001027 /* Default password callback. */
1028 pem_password_cb *default_passwd_callback;
Adam Langley95c29f32014-06-20 12:00:00 -07001029
Adam Langleyb4a494c2015-01-23 15:10:10 -08001030 /* Default password callback user data. */
1031 void *default_passwd_callback_userdata;
Adam Langley95c29f32014-06-20 12:00:00 -07001032
Adam Langleyb4a494c2015-01-23 15:10:10 -08001033 /* get client cert callback */
1034 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
Adam Langley95c29f32014-06-20 12:00:00 -07001035
Adam Langleyb4a494c2015-01-23 15:10:10 -08001036 /* get channel id callback */
1037 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
Adam Langley1258b6a2014-06-20 12:00:00 -07001038
Adam Langleyb4a494c2015-01-23 15:10:10 -08001039 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001040
Adam Langley95c29f32014-06-20 12:00:00 -07001041
Adam Langleyb4a494c2015-01-23 15:10:10 -08001042 /* Default values used when no per-SSL value is defined follow */
Adam Langley95c29f32014-06-20 12:00:00 -07001043
Adam Langleyb4a494c2015-01-23 15:10:10 -08001044 void (*info_callback)(const SSL *ssl, int type,
1045 int val); /* used if SSL's info_callback is NULL */
Adam Langley95c29f32014-06-20 12:00:00 -07001046
Adam Langleyb4a494c2015-01-23 15:10:10 -08001047 /* what we put in client cert requests */
1048 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001049
1050
Adam Langleyb4a494c2015-01-23 15:10:10 -08001051 /* Default values to use in SSL structures follow (these are copied by
1052 * SSL_new) */
Adam Langley95c29f32014-06-20 12:00:00 -07001053
David Benjamin123a8fd2015-04-26 14:16:41 -04001054 uint32_t options;
1055 uint32_t mode;
David Benjamin1d0a1942015-04-26 15:35:35 -04001056 uint32_t max_cert_list;
Adam Langley95c29f32014-06-20 12:00:00 -07001057
Adam Langleyb4a494c2015-01-23 15:10:10 -08001058 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001059
Adam Langleyb4a494c2015-01-23 15:10:10 -08001060 /* callback that allows applications to peek at protocol messages */
1061 void (*msg_callback)(int write_p, int version, int content_type,
1062 const void *buf, size_t len, SSL *ssl, void *arg);
1063 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001064
Adam Langleyb4a494c2015-01-23 15:10:10 -08001065 int verify_mode;
1066 unsigned int sid_ctx_length;
1067 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1068 int (*default_verify_callback)(
1069 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
Adam Langley95c29f32014-06-20 12:00:00 -07001070
Adam Langleyb4a494c2015-01-23 15:10:10 -08001071 /* Default generate session ID callback. */
1072 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001073
Adam Langleyb4a494c2015-01-23 15:10:10 -08001074 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001075
Adam Langleyb4a494c2015-01-23 15:10:10 -08001076 /* select_certificate_cb is called before most ClientHello processing and
1077 * before the decision whether to resume a session is made. It may return one
1078 * to continue the handshake or zero to cause the handshake loop to return
1079 * with an error and cause SSL_get_error to return
David Benjamin6f5c0f42015-02-24 01:23:21 -05001080 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
1081 * will not call the callback a second time. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001082 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
Adam Langleydc9b1412014-06-20 12:00:00 -07001083
Adam Langley524e7172015-02-20 16:04:00 -08001084 /* dos_protection_cb is called once the resumption decision for a ClientHello
1085 * has been made. It returns one to continue the handshake or zero to
1086 * abort. */
1087 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
1088
Adam Langleyb4a494c2015-01-23 15:10:10 -08001089 /* quiet_shutdown is true if the connection should not send a close_notify on
1090 * shutdown. */
1091 int quiet_shutdown;
Adam Langley95c29f32014-06-20 12:00:00 -07001092
Adam Langleyb4a494c2015-01-23 15:10:10 -08001093 /* Maximum amount of data to send in one fragment. actual record size can be
1094 * more than this due to padding and MAC overheads. */
David Benjamin1d0a1942015-04-26 15:35:35 -04001095 uint16_t max_send_fragment;
Adam Langley95c29f32014-06-20 12:00:00 -07001096
Adam Langleyb4a494c2015-01-23 15:10:10 -08001097 /* TLS extensions servername callback */
1098 int (*tlsext_servername_callback)(SSL *, int *, void *);
1099 void *tlsext_servername_arg;
1100 /* RFC 4507 session ticket keys */
David Benjamine3aa1d92015-06-16 15:34:50 -04001101 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
Adam Langleyb4a494c2015-01-23 15:10:10 -08001102 uint8_t tlsext_tick_hmac_key[16];
1103 uint8_t tlsext_tick_aes_key[16];
1104 /* Callback to support customisation of ticket key setting */
1105 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
1106 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
Adam Langley95c29f32014-06-20 12:00:00 -07001107
Adam Langleyb4a494c2015-01-23 15:10:10 -08001108 /* Server-only: psk_identity_hint is the default identity hint to send in
1109 * PSK-based key exchanges. */
1110 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001111
Adam Langleyb4a494c2015-01-23 15:10:10 -08001112 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1113 char *identity,
1114 unsigned int max_identity_len,
1115 uint8_t *psk, unsigned int max_psk_len);
1116 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1117 uint8_t *psk, unsigned int max_psk_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001118
Alex Chernyakhovskya40c8622014-08-03 15:46:36 -04001119
Adam Langleyb4a494c2015-01-23 15:10:10 -08001120 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
1121 * hash of the peer's certifiate and then discard it to save memory and
1122 * session space. Only effective on the server side. */
1123 char retain_only_sha256_of_client_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001124
Adam Langleyb4a494c2015-01-23 15:10:10 -08001125 /* Next protocol negotiation information */
1126 /* (for experimental NPN extension). */
Adam Langley95c29f32014-06-20 12:00:00 -07001127
Adam Langleyb4a494c2015-01-23 15:10:10 -08001128 /* For a server, this contains a callback function by which the set of
1129 * advertised protocols can be provided. */
1130 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
1131 unsigned int *len, void *arg);
1132 void *next_protos_advertised_cb_arg;
1133 /* For a client, this contains a callback function that selects the
1134 * next protocol from the list provided by the server. */
1135 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
1136 const uint8_t *in, unsigned int inlen, void *arg);
1137 void *next_proto_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001138
Adam Langleyb4a494c2015-01-23 15:10:10 -08001139 /* ALPN information
1140 * (we are in the process of transitioning from NPN to ALPN.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001141
Adam Langleyb4a494c2015-01-23 15:10:10 -08001142 /* For a server, this contains a callback function that allows the
1143 * server to select the protocol for the connection.
1144 * out: on successful return, this must point to the raw protocol
1145 * name (without the length prefix).
1146 * outlen: on successful return, this contains the length of |*out|.
1147 * in: points to the client's list of supported protocols in
1148 * wire-format.
1149 * inlen: the length of |in|. */
1150 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
1151 const uint8_t *in, unsigned int inlen, void *arg);
1152 void *alpn_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001153
Adam Langleyb4a494c2015-01-23 15:10:10 -08001154 /* For a client, this contains the list of supported protocols in wire
1155 * format. */
1156 uint8_t *alpn_client_proto_list;
1157 unsigned alpn_client_proto_list_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001158
Adam Langleyb4a494c2015-01-23 15:10:10 -08001159 /* SRTP profiles we are willing to do from RFC 5764 */
1160 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001161
Adam Langleyb4a494c2015-01-23 15:10:10 -08001162 /* EC extension values inherited by SSL structure */
1163 size_t tlsext_ecpointformatlist_length;
1164 uint8_t *tlsext_ecpointformatlist;
1165 size_t tlsext_ellipticcurvelist_length;
1166 uint16_t *tlsext_ellipticcurvelist;
Adam Langley1258b6a2014-06-20 12:00:00 -07001167
Adam Langleyb4a494c2015-01-23 15:10:10 -08001168 /* If true, a client will advertise the Channel ID extension and a server
1169 * will echo it. */
1170 char tlsext_channel_id_enabled;
1171 /* tlsext_channel_id_enabled_new is a hack to support both old and new
1172 * ChannelID signatures. It indicates that a client should advertise the new
1173 * ChannelID extension number. */
1174 char tlsext_channel_id_enabled_new;
1175 /* The client's Channel ID private key. */
1176 EVP_PKEY *tlsext_channel_id_private;
David Benjamin6c7aed02014-08-27 16:42:38 -04001177
Adam Langleyb4a494c2015-01-23 15:10:10 -08001178 /* If true, a client will request certificate timestamps. */
1179 char signed_cert_timestamps_enabled;
David Benjamin859ec3c2014-09-02 16:29:36 -04001180
Adam Langleyb4a494c2015-01-23 15:10:10 -08001181 /* If true, a client will request a stapled OCSP response. */
1182 char ocsp_stapling_enabled;
Adam Langley95c29f32014-06-20 12:00:00 -07001183
Adam Langleyb4a494c2015-01-23 15:10:10 -08001184 /* If not NULL, session key material will be logged to this BIO for debugging
1185 * purposes. The format matches NSS's and is readable by Wireshark. */
1186 BIO *keylog_bio;
David Benjamin377fc312015-01-26 00:22:12 -05001187
1188 /* current_time_cb, if not NULL, is the function to use to get the current
1189 * time. It sets |*out_clock| to the current time. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001190 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001191};
Adam Langley95c29f32014-06-20 12:00:00 -07001192
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001193OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001194
1195/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1196 * session cache. */
1197OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001198
Adam Langleyb4a494c2015-01-23 15:10:10 -08001199OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001200 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1201OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001202 SSL_SESSION *sess);
1203OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1204 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001205 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001206OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001207 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001208OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1209 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001210 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001211 int *copy));
1212OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001213 SSL *ssl, uint8_t *data, int len, int *copy);
Adam Langleyb2ce0582014-06-20 12:00:00 -07001214/* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
1215 * that the session isn't currently unavailable. SSL_get_error will then return
1216 * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
1217 * lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001218OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001219OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1220 void (*cb)(const SSL *ssl,
1221 int type, int val));
1222OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1223 int type,
1224 int val);
1225OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1226 SSL_CTX *ctx,
1227 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1228OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1229 X509 **x509,
1230 EVP_PKEY **pkey);
1231OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1232 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1233OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1234 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001235
Adam Langleyb4a494c2015-01-23 15:10:10 -08001236/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1237 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001238 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001239OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1240
Adam Langleyb4a494c2015-01-23 15:10:10 -08001241/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1242 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001243OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1244
David Benjamin3b7456e2015-05-16 12:29:32 -04001245/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1246 * connection) to request a stapled OCSP response from the server. It returns
1247 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001248OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1249
1250/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1251 * created from |ctx|. */
1252OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1253
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001254/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1255 * |*out_len| bytes of SCT information from the server. This is only valid if
1256 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1257 * (including the two leading length bytes).
1258 * See https://tools.ietf.org/html/rfc6962#section-3.3
1259 * If no SCT was received then |*out_len| will be zero on return.
1260 *
1261 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001262OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001263 const uint8_t **out,
1264 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001265
David Benjamin6c7aed02014-08-27 16:42:38 -04001266/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1267 * bytes of an OCSP response from the server. This is the DER encoding of an
1268 * OCSPResponse type as defined in RFC 2560.
1269 *
1270 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001271OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1272 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001273
Adam Langleyb4a494c2015-01-23 15:10:10 -08001274OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1275 SSL_CTX *s,
1276 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1277 void *arg);
1278OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1279 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1280 const uint8_t *in, unsigned int inlen, void *arg),
1281 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001282OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001283 const uint8_t **data,
1284 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001285
Adam Langleyb4a494c2015-01-23 15:10:10 -08001286OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1287 const uint8_t *in, unsigned int inlen,
1288 const uint8_t *client,
1289 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001290
Adam Langleyb4a494c2015-01-23 15:10:10 -08001291#define OPENSSL_NPN_UNSUPPORTED 0
1292#define OPENSSL_NPN_NEGOTIATED 1
1293#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001294
David Benjamin9d0847a2015-02-16 03:57:55 -05001295/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1296 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1297 * length-prefixed strings). It returns zero on success and one on failure.
1298 *
1299 * WARNING: this function is dangerous because it breaks the usual return value
1300 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001301OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1302 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001303
1304/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1305 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1306 * length-prefixed strings). It returns zero on success and one on failure.
1307 *
1308 * WARNING: this function is dangerous because it breaks the usual return value
1309 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001310OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1311 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001312
Adam Langleyb4a494c2015-01-23 15:10:10 -08001313OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1314 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1315 const uint8_t *in, unsigned int inlen, void *arg),
1316 void *arg);
1317OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1318 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001319
1320/* SSL_enable_fastradio_padding controls whether fastradio padding is enabled
1321 * on |ssl|. If it is, ClientHello messages are padded to 1024 bytes. This
1322 * causes 3G radios to switch to DCH mode (high data rate). */
1323OPENSSL_EXPORT void SSL_enable_fastradio_padding(SSL *ssl, char on_off);
1324
David Benjaminb16346b2015-04-08 19:16:58 -04001325/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1326 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001327 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001328 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001329OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1330
Adam Langleyb4a494c2015-01-23 15:10:10 -08001331/* the maximum length of the buffer given to callbacks containing the resulting
1332 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001333#define PSK_MAX_IDENTITY_LEN 128
1334#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001335OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1336 SSL_CTX *ctx,
1337 unsigned int (*psk_client_callback)(
1338 SSL *ssl, const char *hint, char *identity,
1339 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1340OPENSSL_EXPORT void SSL_set_psk_client_callback(
1341 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1342 char *identity,
1343 unsigned int max_identity_len,
1344 uint8_t *psk,
1345 unsigned int max_psk_len));
1346OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1347 SSL_CTX *ctx,
1348 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1349 uint8_t *psk,
1350 unsigned int max_psk_len));
1351OPENSSL_EXPORT void SSL_set_psk_server_callback(
1352 SSL *ssl,
1353 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1354 uint8_t *psk,
1355 unsigned int max_psk_len));
1356OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1357 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001358OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1359OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1360OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001361
Adam Langleyb4a494c2015-01-23 15:10:10 -08001362#define SSL_NOTHING 1
1363#define SSL_WRITING 2
1364#define SSL_READING 3
1365#define SSL_X509_LOOKUP 4
1366#define SSL_CHANNEL_ID_LOOKUP 5
1367#define SSL_PENDING_SESSION 7
1368#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04001369#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07001370
1371/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001372#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1373#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1374#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1375#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1376#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1377#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1378#define SSL_want_certificate(s) \
1379 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04001380#define SSL_want_private_key_operation(s) \
1381 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07001382
Adam Langleyb4a494c2015-01-23 15:10:10 -08001383struct ssl_st {
1384 /* version is the protocol version. */
1385 int version;
Adam Langley95c29f32014-06-20 12:00:00 -07001386
Adam Langleyb4a494c2015-01-23 15:10:10 -08001387 /* method is the method table corresponding to the current protocol (DTLS or
1388 * TLS). */
1389 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001390
Adam Langleyb4a494c2015-01-23 15:10:10 -08001391 /* enc_method is the method table corresponding to the current protocol
1392 * version. */
1393 const SSL3_ENC_METHOD *enc_method;
David Benjamine99e9122014-12-11 01:46:01 -05001394
Adam Langleyb4a494c2015-01-23 15:10:10 -08001395 /* max_version is the maximum acceptable protocol version. If zero, the
1396 * maximum supported version, currently (D)TLS 1.2, is used. */
1397 uint16_t max_version;
Adam Langley95c29f32014-06-20 12:00:00 -07001398
Adam Langleyb4a494c2015-01-23 15:10:10 -08001399 /* min_version is the minimum acceptable protocl version. If zero, the
1400 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1401 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001402
Adam Langleyb4a494c2015-01-23 15:10:10 -08001403 /* There are 2 BIO's even though they are normally both the same. This is so
1404 * data can be read and written to different handlers */
David Benjamin1eb367c2014-12-12 18:17:51 -05001405
Adam Langleyb4a494c2015-01-23 15:10:10 -08001406 BIO *rbio; /* used by SSL_read */
1407 BIO *wbio; /* used by SSL_write */
1408 BIO *bbio; /* used during session-id reuse to concatenate
1409 * messages */
Adam Langley95c29f32014-06-20 12:00:00 -07001410
Adam Langleyb4a494c2015-01-23 15:10:10 -08001411 /* This holds a variable that indicates what we were doing when a 0 or -1 is
1412 * returned. This is needed for non-blocking IO so we know what request
1413 * needs re-doing when in SSL_accept or SSL_connect */
1414 int rwstate;
David Benjamin95f9cfc2014-11-23 00:19:49 -05001415
Adam Langleyb4a494c2015-01-23 15:10:10 -08001416 /* true when we are actually in SSL_accept() or SSL_connect() */
1417 int in_handshake;
1418 int (*handshake_func)(SSL *);
Adam Langley95c29f32014-06-20 12:00:00 -07001419
Adam Langleyb4a494c2015-01-23 15:10:10 -08001420 /* Imagine that here's a boolean member "init" that is switched as soon as
1421 * SSL_set_{accept/connect}_state is called for the first time, so that
1422 * "state" and "handshake_func" are properly initialized. But as
1423 * handshake_func is == 0 until then, we use this test instead of an "init"
1424 * member. */
Adam Langley95c29f32014-06-20 12:00:00 -07001425
Adam Langleyb4a494c2015-01-23 15:10:10 -08001426 /* server is true iff the this SSL* is the server half. Note: before the SSL*
1427 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
1428 * the side is not determined. In this state, server is always false. */
1429 int server;
Adam Langley95c29f32014-06-20 12:00:00 -07001430
Adam Langleyb4a494c2015-01-23 15:10:10 -08001431 /* quiet_shutdown is true if the connection should not send a close_notify on
1432 * shutdown. */
1433 int quiet_shutdown;
David Benjamin7e237462014-12-11 18:13:28 -05001434
Adam Langleyb4a494c2015-01-23 15:10:10 -08001435 int shutdown; /* we have shut things down, 0x01 sent, 0x02
1436 * for received */
1437 int state; /* where we are */
1438 int rstate; /* where we are when reading */
Adam Langley95c29f32014-06-20 12:00:00 -07001439
Adam Langleyb4a494c2015-01-23 15:10:10 -08001440 BUF_MEM *init_buf; /* buffer used during init */
1441 uint8_t *init_msg; /* pointer to handshake message body, set by
1442 ssl3_get_message() */
1443 int init_num; /* amount read/written */
1444 int init_off; /* amount read/written */
Adam Langley95c29f32014-06-20 12:00:00 -07001445
Adam Langleyb4a494c2015-01-23 15:10:10 -08001446 /* used internally to point at a raw packet */
1447 uint8_t *packet;
1448 unsigned int packet_length;
Adam Langley95c29f32014-06-20 12:00:00 -07001449
Adam Langleyb4a494c2015-01-23 15:10:10 -08001450 struct ssl3_state_st *s3; /* SSLv3 variables */
1451 struct dtls1_state_st *d1; /* DTLSv1 variables */
Adam Langley95c29f32014-06-20 12:00:00 -07001452
Adam Langleyb4a494c2015-01-23 15:10:10 -08001453 /* callback that allows applications to peek at protocol messages */
1454 void (*msg_callback)(int write_p, int version, int content_type,
1455 const void *buf, size_t len, SSL *ssl, void *arg);
1456 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001457
Adam Langleyb4a494c2015-01-23 15:10:10 -08001458 int hit; /* reusing a previous session */
Adam Langley95c29f32014-06-20 12:00:00 -07001459
Adam Langleyb4a494c2015-01-23 15:10:10 -08001460 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001461
Adam Langleyb4a494c2015-01-23 15:10:10 -08001462 /* crypto */
1463 struct ssl_cipher_preference_list_st *cipher_list;
1464 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001465
Adam Langleyb4a494c2015-01-23 15:10:10 -08001466 SSL_AEAD_CTX *aead_read_ctx;
1467 SSL_AEAD_CTX *aead_write_ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001468
Adam Langleyb4a494c2015-01-23 15:10:10 -08001469 /* session info */
Adam Langley95c29f32014-06-20 12:00:00 -07001470
Adam Langleyb4a494c2015-01-23 15:10:10 -08001471 /* client cert? */
1472 /* This is used to hold the server certificate used */
1473 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001474
Adam Langleyb4a494c2015-01-23 15:10:10 -08001475 /* the session_id_context is used to ensure sessions are only reused
1476 * in the appropriate context */
1477 unsigned int sid_ctx_length;
1478 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001479
Adam Langleyb4a494c2015-01-23 15:10:10 -08001480 /* This can also be in the session once a session is established */
1481 SSL_SESSION *session;
Adam Langley95c29f32014-06-20 12:00:00 -07001482
Adam Langleyb4a494c2015-01-23 15:10:10 -08001483 /* Default generate session ID callback. */
1484 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001485
Adam Langleyb4a494c2015-01-23 15:10:10 -08001486 /* Used in SSL2 and SSL3 */
1487 int verify_mode; /* 0 don't care about verify failure.
1488 * 1 fail if verify fails */
1489 int (*verify_callback)(int ok,
1490 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
Adam Langley95c29f32014-06-20 12:00:00 -07001491
Adam Langleyb4a494c2015-01-23 15:10:10 -08001492 void (*info_callback)(const SSL *ssl, int type,
1493 int val); /* optional informational callback */
Adam Langley95c29f32014-06-20 12:00:00 -07001494
Adam Langleyb4a494c2015-01-23 15:10:10 -08001495 /* Server-only: psk_identity_hint is the identity hint to send in
1496 * PSK-based key exchanges. */
1497 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001498
Adam Langleyb4a494c2015-01-23 15:10:10 -08001499 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1500 char *identity,
1501 unsigned int max_identity_len,
1502 uint8_t *psk, unsigned int max_psk_len);
1503 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1504 uint8_t *psk, unsigned int max_psk_len);
David Benjamin688d8df2014-11-02 23:06:42 -05001505
Adam Langleyb4a494c2015-01-23 15:10:10 -08001506 SSL_CTX *ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001507
Adam Langleyb4a494c2015-01-23 15:10:10 -08001508 /* extra application data */
1509 long verify_result;
1510 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001511
Adam Langleyb4a494c2015-01-23 15:10:10 -08001512 /* for server side, keep the list of CA_dn we can use */
1513 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001514
David Benjamin123a8fd2015-04-26 14:16:41 -04001515 uint32_t options; /* protocol behaviour */
1516 uint32_t mode; /* API behaviour */
David Benjamin1d0a1942015-04-26 15:35:35 -04001517 uint32_t max_cert_list;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001518 int client_version; /* what was passed, used for
1519 * SSLv3/TLS rollback check */
David Benjamin1d0a1942015-04-26 15:35:35 -04001520 uint16_t max_send_fragment;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001521 char *tlsext_hostname;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001522 /* RFC4507 session ticket expected to be received or sent */
1523 int tlsext_ticket_expected;
1524 size_t tlsext_ecpointformatlist_length;
1525 uint8_t *tlsext_ecpointformatlist; /* our list */
1526 size_t tlsext_ellipticcurvelist_length;
1527 uint16_t *tlsext_ellipticcurvelist; /* our list */
Adam Langley95c29f32014-06-20 12:00:00 -07001528
Adam Langleyb4a494c2015-01-23 15:10:10 -08001529 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
Adam Langley95c29f32014-06-20 12:00:00 -07001530
Adam Langleyb4a494c2015-01-23 15:10:10 -08001531 /* Next protocol negotiation. For the client, this is the protocol that we
1532 * sent in NextProtocol and is set when handling ServerHello extensions.
1533 *
1534 * For a server, this is the client's selected_protocol from NextProtocol and
1535 * is set when handling the NextProtocol message, before the Finished
1536 * message. */
1537 uint8_t *next_proto_negotiated;
1538 size_t next_proto_negotiated_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001539
Adam Langleyb4a494c2015-01-23 15:10:10 -08001540 /* srtp_profiles is the list of configured SRTP protection profiles for
1541 * DTLS-SRTP. */
1542 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001543
Adam Langleyb4a494c2015-01-23 15:10:10 -08001544 /* srtp_profile is the selected SRTP protection profile for
1545 * DTLS-SRTP. */
1546 const SRTP_PROTECTION_PROFILE *srtp_profile;
David Benjaminbc44c082015-01-01 15:02:11 -05001547
Adam Langleyb4a494c2015-01-23 15:10:10 -08001548 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
1549 * from clients. For a client, means that we'll advertise support. */
1550 char tlsext_channel_id_enabled;
1551 /* The client's Channel ID private key. */
1552 EVP_PKEY *tlsext_channel_id_private;
Adam Langley95c29f32014-06-20 12:00:00 -07001553
Adam Langleyb4a494c2015-01-23 15:10:10 -08001554 /* Enable signed certificate time stamps. Currently client only. */
1555 char signed_cert_timestamps_enabled;
Adam Langley1258b6a2014-06-20 12:00:00 -07001556
Adam Langleyb4a494c2015-01-23 15:10:10 -08001557 /* Enable OCSP stapling. Currently client only.
1558 * TODO(davidben): Add a server-side implementation when it becomes
1559 * necesary. */
1560 char ocsp_stapling_enabled;
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001561
Adam Langleyb4a494c2015-01-23 15:10:10 -08001562 /* For a client, this contains the list of supported protocols in wire
1563 * format. */
1564 uint8_t *alpn_client_proto_list;
1565 unsigned alpn_client_proto_list_len;
David Benjamin6c7aed02014-08-27 16:42:38 -04001566
Adam Langleyb4a494c2015-01-23 15:10:10 -08001567 /* fastradio_padding, if true, causes ClientHellos to be padded to 1024
1568 * bytes. This ensures that the cellular radio is fast forwarded to DCH (high
1569 * data rate) state in 3G networks. */
1570 char fastradio_padding;
Feng Lu41aa3252014-11-21 22:47:56 -08001571
David Benjamin897e5e02015-05-12 17:03:54 -04001572 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
1573 * peer. Otherwise, they will be rejected with a fatal error. */
1574 char accept_peer_renegotiations;
David Benjaminb16346b2015-04-08 19:16:58 -04001575
Adam Langleyb4a494c2015-01-23 15:10:10 -08001576 /* These fields are always NULL and exist only to keep wpa_supplicant happy
1577 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
1578 * don't support. */
1579 EVP_CIPHER_CTX *enc_read_ctx;
1580 EVP_MD_CTX *read_hash;
1581};
Adam Langley95c29f32014-06-20 12:00:00 -07001582
Adam Langley95c29f32014-06-20 12:00:00 -07001583/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001584#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
1585#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
1586#define SSL_SESSION_set_app_data(s, a) \
1587 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
1588#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
1589#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
1590#define SSL_CTX_set_app_data(ctx, arg) \
1591 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07001592
Adam Langleyb4a494c2015-01-23 15:10:10 -08001593/* The following are the possible values for ssl->state are are used to
1594 * indicate where we are up to in the SSL connection establishment. The macros
1595 * that follow are about the only things you should need to use and even then,
1596 * only when using non-blocking IO. It can also be useful to work out where you
1597 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07001598
Adam Langleyb4a494c2015-01-23 15:10:10 -08001599#define SSL_ST_CONNECT 0x1000
1600#define SSL_ST_ACCEPT 0x2000
1601#define SSL_ST_MASK 0x0FFF
1602#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001603#define SSL_ST_OK 0x03
1604#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07001605
Adam Langleyb4a494c2015-01-23 15:10:10 -08001606#define SSL_CB_LOOP 0x01
1607#define SSL_CB_EXIT 0x02
1608#define SSL_CB_READ 0x04
1609#define SSL_CB_WRITE 0x08
1610#define SSL_CB_ALERT 0x4000 /* used in callback */
1611#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
1612#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
1613#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
1614#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
1615#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
1616#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
1617#define SSL_CB_HANDSHAKE_START 0x10
1618#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07001619
1620/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001621#define SSL_get_state(a) SSL_state(a)
1622#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05001623#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001624#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
1625#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05001626
David Benjamined7c4752015-02-16 19:16:46 -05001627/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
1628 * is in False Start. |SSL_write| may be called at this point without waiting
1629 * for the peer, but |SSL_read| will require the handshake to be completed. */
1630OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
1631
Adam Langley95c29f32014-06-20 12:00:00 -07001632/* The following 2 states are kept in ssl->rstate when reads fail,
1633 * you should not need these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001634#define SSL_ST_READ_HEADER 0xF0
1635#define SSL_ST_READ_BODY 0xF1
1636#define SSL_ST_READ_DONE 0xF2
Adam Langley95c29f32014-06-20 12:00:00 -07001637
1638/* Obtain latest Finished message
1639 * -- that we sent (SSL_get_finished)
1640 * -- that we expected from peer (SSL_get_peer_finished).
1641 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001642OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1643OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07001644
Adam Langley509e5ed2014-06-20 12:00:00 -07001645/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07001646 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001647#define SSL_VERIFY_NONE 0x00
1648#define SSL_VERIFY_PEER 0x01
1649#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
David Benjamin5aea93e2015-05-26 16:33:02 -04001650/* SSL_VERIFY_CLIENT_ONCE does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001651#define SSL_VERIFY_CLIENT_ONCE 0x04
1652#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07001653
Adam Langleyb4a494c2015-01-23 15:10:10 -08001654#define OpenSSL_add_ssl_algorithms() SSL_library_init()
1655#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07001656
Adam Langleyb4a494c2015-01-23 15:10:10 -08001657/* For backward compatibility */
1658#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1659#define SSL_get_cipher_bits(s, np) \
1660 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07001661#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001662 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1663#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1664#define SSL_get_time(a) SSL_SESSION_get_time(a)
1665#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
1666#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
1667#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07001668
Adam Langleyb4a494c2015-01-23 15:10:10 -08001669#define d2i_SSL_SESSION_bio(bp, s_id) \
1670 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
1671#define i2d_SSL_SESSION_bio(bp, s_id) \
1672 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07001673
1674DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1675
Adam Langleyb4a494c2015-01-23 15:10:10 -08001676/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
1677 * This value must be kept in sync with reservedReasonCode in make_errors.h */
1678#define SSL_AD_REASON_OFFSET \
1679 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07001680
1681/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001682#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
1683#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
1684#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
1685#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
1686#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
1687#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
1688#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
1689#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
1690#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
1691#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
1692#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
1693#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
1694#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
1695#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
1696#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
1697#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
1698#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
1699#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
1700#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
1701#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
1702#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
1703#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
1704#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
1705#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
1706#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07001707#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001708#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
1709#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
1710 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07001711#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001712#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
1713#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07001714
Adam Langleyb4a494c2015-01-23 15:10:10 -08001715#define SSL_ERROR_NONE 0
1716#define SSL_ERROR_SSL 1
1717#define SSL_ERROR_WANT_READ 2
1718#define SSL_ERROR_WANT_WRITE 3
1719#define SSL_ERROR_WANT_X509_LOOKUP 4
1720#define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
1721#define SSL_ERROR_ZERO_RETURN 6
1722#define SSL_ERROR_WANT_CONNECT 7
1723#define SSL_ERROR_WANT_ACCEPT 8
1724#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
1725#define SSL_ERROR_PENDING_SESSION 11
1726#define SSL_ERROR_PENDING_CERTIFICATE 12
David Benjaminb4d65fd2015-05-29 17:11:21 -04001727#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
Adam Langley95c29f32014-06-20 12:00:00 -07001728
Adam Langleyb4a494c2015-01-23 15:10:10 -08001729#define SSL_CTRL_EXTRA_CHAIN_CERT 14
Adam Langley95c29f32014-06-20 12:00:00 -07001730
Adam Langleyb4a494c2015-01-23 15:10:10 -08001731#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS 82
1732#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS 83
Adam Langley95c29f32014-06-20 12:00:00 -07001733
Adam Langleyb4a494c2015-01-23 15:10:10 -08001734#define SSL_CTRL_CHAIN 88
1735#define SSL_CTRL_CHAIN_CERT 89
Adam Langley95c29f32014-06-20 12:00:00 -07001736
Adam Langleyb4a494c2015-01-23 15:10:10 -08001737#define SSL_CTRL_GET_CURVES 90
1738#define SSL_CTRL_SET_CURVES 91
1739#define SSL_CTRL_SET_CURVES_LIST 92
Adam Langleyb4a494c2015-01-23 15:10:10 -08001740#define SSL_CTRL_SET_SIGALGS 97
1741#define SSL_CTRL_SET_SIGALGS_LIST 98
Adam Langleyb4a494c2015-01-23 15:10:10 -08001742#define SSL_CTRL_SET_CLIENT_SIGALGS 101
1743#define SSL_CTRL_SET_CLIENT_SIGALGS_LIST 102
1744#define SSL_CTRL_GET_CLIENT_CERT_TYPES 103
1745#define SSL_CTRL_SET_CLIENT_CERT_TYPES 104
Adam Langleyb4a494c2015-01-23 15:10:10 -08001746#define SSL_CTRL_SET_VERIFY_CERT_STORE 106
1747#define SSL_CTRL_SET_CHAIN_CERT_STORE 107
Adam Langleyb4a494c2015-01-23 15:10:10 -08001748#define SSL_CTRL_GET_EC_POINT_FORMATS 111
Adam Langley95c29f32014-06-20 12:00:00 -07001749
Adam Langleyb4a494c2015-01-23 15:10:10 -08001750#define SSL_CTRL_GET_CHAIN_CERTS 115
Adam Langley95c29f32014-06-20 12:00:00 -07001751
David Benjamin377fc312015-01-26 00:22:12 -05001752/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04001753 * timeout in progress, it sets |*out| to the time remaining and returns one.
1754 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05001755 *
1756 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
1757 * retransmit behavior.
1758 *
1759 * NOTE: This function must be queried again whenever the handshake state
1760 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001761OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05001762
1763/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
1764 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
1765 * flight of handshake messages and returns 1. If too many timeouts had expired
1766 * without progress or an error occurs, it returns -1.
1767 *
1768 * NOTE: The caller's external timer should be compatible with the one |ssl|
1769 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04001770 * |DTLSv1_get_timeout| will return an updated timeout.
1771 *
1772 * WARNING: This function breaks the usual return value convention. */
1773OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001774
David Benjaminc0454692015-04-27 00:28:56 -04001775/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1776 * and zero otherwise.
1777 *
1778 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1779 * initial or renego, is in progress. */
1780OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001781
David Benjaminc0454692015-04-27 00:28:56 -04001782/* SSL_total_renegotiations returns the total number of renegotiation handshakes
1783 * peformed by |ssl|. This includes the pending renegotiation, if any. */
1784OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
1785
David Benjamin15a3b002015-04-28 00:05:35 -04001786/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1787 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1788 * one on success and zero on error. */
1789OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04001790
David Benjamin15a3b002015-04-28 00:05:35 -04001791/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1792 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1793 * on success and zero on error. */
1794OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07001795
David Benjamin15a3b002015-04-28 00:05:35 -04001796/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1797 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1798 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1799 * error. If unset, an appropriate curve will be chosen automatically. (This is
1800 * recommended.) */
1801OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04001802
David Benjamin15a3b002015-04-28 00:05:35 -04001803/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1804 * for ephemeral ECDH keys. For historical reasons, this API expects an
1805 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1806 * error. If unset, an appropriate curve will be chosen automatically. (This is
1807 * recommended.) */
1808OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07001809
David Benjaminc2807582015-04-28 00:19:50 -04001810/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
1811 * client IDs from clients, or configures a client to send TLS client IDs to
1812 * a server. It returns one. */
1813OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
1814
Adam Langleyb4a494c2015-01-23 15:10:10 -08001815/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
1816 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04001817 * server. It returns one. */
1818OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
1819
1820/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
1821 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
1822 * on success and zero on error. */
1823OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
1824 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001825
Adam Langley1258b6a2014-06-20 12:00:00 -07001826/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04001827 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
1828 * success and zero on error. */
1829OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001830
Adam Langley1258b6a2014-06-20 12:00:00 -07001831/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04001832 * and copies up to the first |max_out| bytes into |out|. The Channel ID
1833 * consists of the client's P-256 public key as an (x,y) pair where each is a
1834 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
1835 * Channel ID and the length of the complete Channel ID otherwise. */
1836OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
1837 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07001838
Adam Langleyb4a494c2015-01-23 15:10:10 -08001839#define SSL_CTX_add_extra_chain_cert(ctx, x509) \
1840 SSL_CTX_ctrl(ctx, SSL_CTRL_EXTRA_CHAIN_CERT, 0, (char *)x509)
1841#define SSL_CTX_get_extra_chain_certs(ctx, px509) \
1842 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_EXTRA_CHAIN_CERTS, 0, px509)
Adam Langley95c29f32014-06-20 12:00:00 -07001843#define SSL_CTX_clear_extra_chain_certs(ctx) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001844 SSL_CTX_ctrl(ctx, SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS, 0, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001845
Adam Langleyb4a494c2015-01-23 15:10:10 -08001846#define SSL_CTX_set0_chain(ctx, sk) \
1847 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN, 0, (char *)sk)
1848#define SSL_CTX_set1_chain(ctx, sk) \
1849 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN, 1, (char *)sk)
1850#define SSL_CTX_add0_chain_cert(ctx, x509) \
1851 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 0, (char *)x509)
1852#define SSL_CTX_add1_chain_cert(ctx, x509) \
1853 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 1, (char *)x509)
1854#define SSL_CTX_get0_chain_certs(ctx, px509) \
1855 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_CHAIN_CERTS, 0, px509)
1856#define SSL_CTX_clear_chain_certs(ctx) SSL_CTX_set0_chain(ctx, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001857
Adam Langleyb4a494c2015-01-23 15:10:10 -08001858#define SSL_CTX_set0_verify_cert_store(ctx, st) \
1859 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
1860#define SSL_CTX_set1_verify_cert_store(ctx, st) \
1861 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
1862#define SSL_CTX_set0_chain_cert_store(ctx, st) \
1863 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
1864#define SSL_CTX_set1_chain_cert_store(ctx, st) \
1865 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07001866
Adam Langleyb4a494c2015-01-23 15:10:10 -08001867#define SSL_set0_chain(ctx, sk) SSL_ctrl(ctx, SSL_CTRL_CHAIN, 0, (char *)sk)
1868#define SSL_set1_chain(ctx, sk) SSL_ctrl(ctx, SSL_CTRL_CHAIN, 1, (char *)sk)
1869#define SSL_add0_chain_cert(ctx, x509) \
1870 SSL_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 0, (char *)x509)
1871#define SSL_add1_chain_cert(ctx, x509) \
1872 SSL_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 1, (char *)x509)
1873#define SSL_get0_chain_certs(ctx, px509) \
1874 SSL_ctrl(ctx, SSL_CTRL_GET_CHAIN_CERTS, 0, px509)
1875#define SSL_clear_chain_certs(ctx) SSL_set0_chain(ctx, NULL)
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_get0_ec_point_formats(s, plst) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001923 SSL_ctrl(s, SSL_CTRL_GET_EC_POINT_FORMATS, 0, (char *)plst)
Adam Langley95c29f32014-06-20 12:00:00 -07001924
Adam Langleyb4a494c2015-01-23 15:10:10 -08001925OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
1926OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001927OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001928OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1929OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001930OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001931OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001932
Adam Langleyb4a494c2015-01-23 15:10:10 -08001933OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07001934
David Benjamina07c0fc2015-05-13 13:19:42 -04001935/* SSL_get_current_cipher returns the cipher used in the current outgoing
1936 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001937OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001938
Adam Langleyb4a494c2015-01-23 15:10:10 -08001939OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
1940OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
1941OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
1942OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001943OPENSSL_EXPORT int SSL_pending(const SSL *s);
1944OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
1945OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
1946OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
1947OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
1948OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
1949OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
1950OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001951OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
1952OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
1953OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
1954 X509_STORE_CTX *);
1955OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
1956 int (*callback)(int ok,
1957 X509_STORE_CTX *ctx));
1958OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
1959OPENSSL_EXPORT void SSL_set_cert_cb(SSL *s, int (*cb)(SSL *ssl, void *arg),
1960 void *arg);
1961OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
1962OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, uint8_t *d, long len);
1963OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
1964OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const uint8_t *d,
1965 long len);
1966OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x);
1967OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *d,
1968 int len);
Adam Langley95c29f32014-06-20 12:00:00 -07001969
Adam Langleyb4a494c2015-01-23 15:10:10 -08001970OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
1971 int type);
1972OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
1973 int type);
1974OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
1975 int type);
1976OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
1977 const char *file, int type);
1978OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
1979 int type);
1980OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
1981 int type);
1982OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(
1983 SSL_CTX *ctx, const char *file); /* PEM type */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001984OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001985OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1986 stackCAs,
1987 const char *file);
1988OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1989 stackCAs,
1990 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07001991
David Benjamin7ce1c0c2015-01-09 13:21:21 -05001992/* SSL_load_error_strings does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001993OPENSSL_EXPORT void SSL_load_error_strings(void);
David Benjamin7ce1c0c2015-01-09 13:21:21 -05001994
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001995OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
1996OPENSSL_EXPORT const char *SSL_rstate_string(const SSL *s);
1997OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
1998OPENSSL_EXPORT const char *SSL_rstate_string_long(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001999OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
2000OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
2001OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
2002OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002003OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002004OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
2005 const uint8_t *sid_ctx,
2006 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002007
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002008OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002009OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
2010 unsigned int *len);
2011OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
2012OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05002013
2014/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
2015 * of |session|. It then returns |session|. */
2016OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
2017
2018/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
2019 * zero, all data referenced by |session| and |session| itself are released. */
2020OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
2021
Adam Langleyb4a494c2015-01-23 15:10:10 -08002022OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
2023OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
2024OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
2025OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
2026OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
2027OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
2028 const uint8_t *id,
2029 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04002030
Adam Langleyb4a494c2015-01-23 15:10:10 -08002031/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
2032 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
2033 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
2034 * one on success and zero on error. */
David Benjamin3cac4502014-10-21 01:46:30 -04002035OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
2036 size_t *out_len);
2037
David Benjamin95d31822015-06-15 19:53:32 -04002038/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
2039 * identification information, namely the session ID and ticket. */
David Benjamin3cac4502014-10-21 01:46:30 -04002040OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
2041 uint8_t **out_data,
2042 size_t *out_len);
2043
David Benjaminfd67aa82015-06-15 19:41:48 -04002044/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
2045 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
2046OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
2047 size_t in_len);
2048
Adam Langleyb4a494c2015-01-23 15:10:10 -08002049/* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
2050 * |*pp|. On success, it returns the number of bytes written and advances |*pp|
2051 * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
2052 * written and only the length is returned.
David Benjamin3cac4502014-10-21 01:46:30 -04002053 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002054 * Use |SSL_SESSION_to_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002055OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2056
David Benjaminfd67aa82015-06-15 19:41:48 -04002057/* Deprecated: d2i_SSL_SESSION parses a serialized session from the |length|
2058 * bytes pointed to by |*pp|. It returns the new |SSL_SESSION| and advances
2059 * |*pp| by the number of bytes consumed on success and NULL on failure. The
2060 * caller takes ownership of the new session and must call |SSL_SESSION_free|
2061 * when done.
David Benjamin3cac4502014-10-21 01:46:30 -04002062 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002063 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
David Benjamin3cac4502014-10-21 01:46:30 -04002064 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002065 * Use |SSL_SESSION_from_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002066OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2067 long length);
Adam Langley95c29f32014-06-20 12:00:00 -07002068
Adam Langleyb4a494c2015-01-23 15:10:10 -08002069OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002070
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002071OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002072
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002073OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
2074OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002075OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
2076 int, X509_STORE_CTX *);
2077OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2078 int (*callback)(int, X509_STORE_CTX *));
2079OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
2080OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
2081 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
2082OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *c,
2083 int (*cb)(SSL *ssl, void *arg),
2084 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002085OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002086OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
2087 const uint8_t *d, long len);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002088OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002089OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
2090 const uint8_t *d, long len);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002091OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002092OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
2093 const uint8_t *d);
Adam Langley95c29f32014-06-20 12:00:00 -07002094
Adam Langleyb4a494c2015-01-23 15:10:10 -08002095OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
2096 pem_password_cb *cb);
2097OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
2098 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07002099
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002100OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
2101OPENSSL_EXPORT int SSL_check_private_key(const SSL *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002102
Adam Langleyb4a494c2015-01-23 15:10:10 -08002103OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
2104 const uint8_t *sid_ctx,
2105 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002106
Adam Langleyb4a494c2015-01-23 15:10:10 -08002107OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
2108 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002109
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002110OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
2111OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
2112OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
2113OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07002114
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002115OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
2116OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07002117
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002118OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
2119OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002120
Adam Langleyb4a494c2015-01-23 15:10:10 -08002121OPENSSL_EXPORT void SSL_certs_clear(SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002122OPENSSL_EXPORT int SSL_accept(SSL *ssl);
2123OPENSSL_EXPORT int SSL_connect(SSL *ssl);
2124OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
2125OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
2126OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
2127OPENSSL_EXPORT long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002128OPENSSL_EXPORT long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
Adam Langley95c29f32014-06-20 12:00:00 -07002129
Adam Langleyb4a494c2015-01-23 15:10:10 -08002130OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
Adam Langley0f4746e2014-08-13 12:26:32 -07002131/* SSL_get_version returns a string describing the TLS version used by |s|. For
2132 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002133OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley0f4746e2014-08-13 12:26:32 -07002134/* SSL_SESSION_get_version returns a string describing the TLS version used by
2135 * |sess|. For example, "TLSv1.2" or "SSLv3". */
2136OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
Adam Langley95c29f32014-06-20 12:00:00 -07002137
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002138OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002139
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002140OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
David Benjamin44d3eed2015-05-21 01:29:55 -04002141
2142/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2143 * renegotiation. */
2144OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2145
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002146OPENSSL_EXPORT int SSL_shutdown(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002147
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002148OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2149OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2150OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2151OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002152
Adam Langleyb4a494c2015-01-23 15:10:10 -08002153OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
2154 STACK_OF(X509_NAME) *name_list);
2155OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2156 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002157OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002158OPENSSL_EXPORT STACK_OF(X509_NAME) *
2159 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2160OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
2161OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07002162
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002163OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002164
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002165OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07002166
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002167OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
David Benjamin4dab2972015-05-16 02:56:06 -04002168OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002169
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002170OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
2171OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002172
Adam Langleyb4a494c2015-01-23 15:10:10 -08002173OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002174OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002175OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002176OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002177OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002178OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
2179OPENSSL_EXPORT int SSL_version(const SSL *ssl);
2180OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002181OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2182 const char *CAfile,
2183 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07002184#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002185OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002186OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
2187 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002188OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002189OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002190OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002191 void (*cb)(const SSL *ssl, int type,
2192 int val));
2193OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2194 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002195OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002196
Adam Langleyb4a494c2015-01-23 15:10:10 -08002197OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002198OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002199
Adam Langleyb4a494c2015-01-23 15:10:10 -08002200OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2201OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2202OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2203 CRYPTO_EX_new *new_func,
2204 CRYPTO_EX_dup *dup_func,
2205 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002206
Adam Langleyb4a494c2015-01-23 15:10:10 -08002207OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
2208 void *data);
2209OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2210OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2211 CRYPTO_EX_new *new_func,
2212 CRYPTO_EX_dup *dup_func,
2213 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002214
Adam Langleyb4a494c2015-01-23 15:10:10 -08002215OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2216OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2217OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2218 CRYPTO_EX_new *new_func,
2219 CRYPTO_EX_dup *dup_func,
2220 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002221
Adam Langleyb4a494c2015-01-23 15:10:10 -08002222OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002223
David Benjamin71f7d3d2015-05-05 09:46:38 -04002224/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
2225 * |size|. It returns the previous value. */
2226OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
2227 unsigned long size);
2228
David Benjamin3b7456e2015-05-16 12:29:32 -04002229/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04002230 * cache. */
2231OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
2232
2233/* SSL_SESS_CACHE_* are the possible session cache mode bits.
2234 * TODO(davidben): Document. */
2235#define SSL_SESS_CACHE_OFF 0x0000
2236#define SSL_SESS_CACHE_CLIENT 0x0001
2237#define SSL_SESS_CACHE_SERVER 0x0002
2238#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2239#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2240#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2241#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2242#define SSL_SESS_CACHE_NO_INTERNAL \
2243 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2244
2245/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2246 * |mode|. It returns the previous value. */
2247OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2248
2249/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2250 * |ctx| */
2251OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002252
David Benjamin1d0a1942015-04-26 15:35:35 -04002253/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2254 * certificate chain accepted by |ctx|. */
2255OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2256
2257/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2258 * certificate chain to |max_cert_list|. This affects how much memory may be
2259 * consumed during the handshake. */
2260OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2261 size_t max_cert_list);
2262
2263/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2264 * certificate chain accepted by |ssl|. */
2265OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2266
2267/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2268 * certificate chain to |max_cert_list|. This affects how much memory may be
2269 * consumed during the handshake. */
2270OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2271
2272/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2273 * sent by |ctx|. Beyond this length, handshake messages and application data
2274 * will be split into multiple records. */
2275OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2276 size_t max_send_fragment);
2277
2278/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2279 * sent by |ssl|. Beyond this length, handshake messages and application data
2280 * will be split into multiple records. */
2281OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2282 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002283
David Benjamin59015c32015-04-26 13:13:55 -04002284/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2285 * the group for DHE ciphers. |callback| should ignore |is_export| and
2286 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2287 * the parameters are used, so the |DH| needn't have a generated keypair.
2288 *
2289 * WARNING: The caller does not take ownership of the resulting |DH|, so
2290 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002291OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002292 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2293
2294/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2295 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2296 * and return a |DH| of the selected group or NULL on error. Only the
2297 * parameters are used, so the |DH| needn't have a generated keypair.
2298 *
2299 * WARNING: The caller does not take ownership of the resulting |DH|, so
2300 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002301OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002302 DH *(*dh)(SSL *ssl, int is_export,
2303 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002304
2305/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2306 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2307 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2308 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2309 * keypair.
2310 *
2311 * If the callback is unset, an appropriate curve will be chosen automatically.
2312 * (This is recommended.)
2313 *
2314 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2315 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002316OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002317 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2318
2319/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2320 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2321 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2322 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2323 * keypair.
2324 *
2325 * If the callback is unset, an appropriate curve will be chosen automatically.
2326 * (This is recommended.)
2327 *
2328 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2329 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002330OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002331 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002332
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002333typedef void COMP_METHOD;
2334
2335/* SSL_get_current_compression returns NULL. */
2336OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
2337
2338/* SSL_get_current_expansion returns NULL. */
2339OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002340
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002341OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2342OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002343
Adam Langley524e7172015-02-20 16:04:00 -08002344/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2345 * resumption decision for a ClientHello has been made. It can return 1 to
2346 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002347OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002348 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2349
Adam Langley95f22882014-06-20 12:00:00 -07002350/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2351 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2352 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002353OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2354 size_t *ssl_ctx_size,
2355 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002356
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002357OPENSSL_EXPORT void ERR_load_SSL_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002358
Adam Langley3f92d212015-02-20 15:32:52 -08002359/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2360 * the read and write directions. It returns one on success or zero if |ssl|
2361 * isn't using an RC4-based cipher suite. */
2362OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2363 const RC4_KEY **write_key);
2364
Adam Langley95c29f32014-06-20 12:00:00 -07002365
David Benjamin71f07942015-04-08 02:36:59 -04002366/* Deprecated functions. */
2367
2368/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2369 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2370 * freed with |OPENSSL_free|, or NULL on error.
2371 *
2372 * The description includes a trailing newline and has the form:
2373 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2374 *
2375 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2376OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2377 char *buf, int len);
2378
2379/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2380OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2381
2382/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002383OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002384
2385/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002386OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002387
2388/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002389OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002390
David Benjamin0d8a7582015-04-08 23:55:15 -04002391/* SSLv23_method calls |TLS_method|. */
2392OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2393
2394/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2395 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2396 * to lock connections to that protocol version. */
2397OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2398OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2399OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2400OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2401OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2402OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2403
2404/* Client- and server-specific methods call their corresponding generic
2405 * methods. */
2406OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2407OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2408OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2409OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2410OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2411OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2412OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2413OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2414OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2415OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2416OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2417OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2418OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2419OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2420OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2421OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2422
David Benjamin4831c332015-05-16 11:43:13 -04002423/* SSL_clear resets |ssl| to allow another connection and returns one on success
2424 * or zero on failure. It returns most configuration state but releases memory
2425 * associated with the current connection.
2426 *
2427 * Free |ssl| and create a new one instead. */
2428OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2429
David Benjamin59015c32015-04-26 13:13:55 -04002430/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2431OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2432 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002433
David Benjamin59015c32015-04-26 13:13:55 -04002434/* SSL_set_tmp_rsa_callback does nothing. */
2435OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2436 RSA *(*cb)(SSL *ssl, int is_export,
2437 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002438
David Benjaminda881e92015-04-26 14:45:04 -04002439/* SSL_CTX_sess_connect returns zero. */
2440OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2441
2442/* SSL_CTX_sess_connect_good returns zero. */
2443OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2444
2445/* SSL_CTX_sess_connect_renegotiate returns zero. */
2446OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2447
2448/* SSL_CTX_sess_accept returns zero. */
2449OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2450
2451/* SSL_CTX_sess_accept_renegotiate returns zero. */
2452OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2453
2454/* SSL_CTX_sess_accept_good returns zero. */
2455OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2456
2457/* SSL_CTX_sess_hits returns zero. */
2458OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2459
2460/* SSL_CTX_sess_cb_hits returns zero. */
2461OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2462
2463/* SSL_CTX_sess_misses returns zero. */
2464OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2465
2466/* SSL_CTX_sess_timeouts returns zero. */
2467OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2468
2469/* SSL_CTX_sess_cache_full returns zero. */
2470OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2471
David Benjamin101ead22015-04-26 18:36:23 -04002472/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2473OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2474
David Benjaminc0454692015-04-27 00:28:56 -04002475/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2476OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2477
2478/* SSL_CTX_need_tmp_RSA returns zero. */
2479OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2480
2481/* SSL_need_tmp_RSA returns zero. */
2482OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2483
2484/* SSL_CTX_set_tmp_rsa returns one. */
2485OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2486
2487/* SSL_set_tmp_rsa returns one. */
2488OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2489
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002490/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002491OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2492
2493/* SSL_CTX_set_read_ahead does nothing. */
2494OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2495
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002496/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002497OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2498
2499/* SSL_set_read_ahead does nothing. */
2500OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2501
David Benjamin44d3eed2015-05-21 01:29:55 -04002502/* SSL_renegotiate put an error on the error queue and returns zero. */
2503OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2504
David Benjaminece089c2015-05-15 23:52:42 -04002505/* SSL_set_state does nothing. */
2506OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2507
David Benjamin71f07942015-04-08 02:36:59 -04002508
Adam Langley7cc3f992015-01-07 15:06:31 -08002509/* Android compatibility section.
2510 *
2511 * These functions are declared, temporarily, for Android because
2512 * wpa_supplicant will take a little time to sync with upstream. Outside of
2513 * Android they'll have no definition. */
2514
2515#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2516
Adam Langleyb4a494c2015-01-23 15:10:10 -08002517OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2518 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002519OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2520OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002521OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2522
2523#define OPENSSL_VERSION_TEXT "BoringSSL"
2524
2525#define SSLEAY_VERSION 0
2526
2527/* SSLeay_version is a compatibility function that returns the string
2528 * "BoringSSL". */
2529OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002530
2531
David Benjamin59015c32015-04-26 13:13:55 -04002532/* Preprocessor compatibility section.
2533 *
2534 * Historically, a number of APIs were implemented in OpenSSL as macros and
2535 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04002536 * section defines a number of legacy macros.
2537 *
2538 * Although using either the CTRL values or their wrapper macros in #ifdefs is
2539 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
2540 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04002541
David Benjamincb3872f2015-06-16 13:20:36 -04002542#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2543#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
2544#define SSL_CTRL_CHANNEL_ID doesnt_exist
2545#define SSL_CTRL_CLEAR_MODE doesnt_exist
2546#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
2547#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
2548#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002549#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002550#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2551#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
2552#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2553#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
2554#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002555#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002556#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002557#define SSL_CTRL_MODE doesnt_exist
2558#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2559#define SSL_CTRL_OPTIONS doesnt_exist
2560#define SSL_CTRL_SESS_NUMBER doesnt_exist
2561#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
2562#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2563#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002564#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002565#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002566#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002567#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002568#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002569#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002570#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002571#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2572#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002573#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002574#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002575#define SSL_CTRL_SET_TMP_DH doesnt_exist
2576#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2577#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
2578#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
2579#define SSL_CTRL_SET_TMP_RSA doesnt_exist
2580#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002581
David Benjamin8c249802015-05-05 09:44:18 -04002582#define DTLSv1_get_timeout DTLSv1_get_timeout
2583#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamincb3872f2015-06-16 13:20:36 -04002584#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2585#define SSL_CTX_clear_options SSL_CTX_clear_options
2586#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
2587#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2588#define SSL_CTX_get_mode SSL_CTX_get_mode
2589#define SSL_CTX_get_options SSL_CTX_get_options
2590#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2591#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04002592#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002593#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2594#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2595#define SSL_CTX_sess_number SSL_CTX_sess_number
2596#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
2597#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2598#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2599#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2600#define SSL_CTX_set_mode SSL_CTX_set_mode
2601#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2602#define SSL_CTX_set_options SSL_CTX_set_options
2603#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
2604#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2605#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2606#define SSL_CTX_set_tlsext_servername_callback \
2607 SSL_CTX_set_tlsext_servername_callback
2608#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04002609#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002610#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
2611#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
2612#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
2613#define SSL_clear_mode SSL_clear_mode
2614#define SSL_clear_options SSL_clear_options
2615#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
2616#define SSL_get_max_cert_list SSL_get_max_cert_list
2617#define SSL_get_mode SSL_get_mode
2618#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04002619#define SSL_get_secure_renegotiation_support \
2620 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04002621#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04002622#define SSL_need_tmp_RSA SSL_need_tmp_RSA
2623#define SSL_num_renegotiations SSL_num_renegotiations
2624#define SSL_session_reused SSL_session_reused
2625#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
2626#define SSL_set_max_cert_list SSL_set_max_cert_list
2627#define SSL_set_max_send_fragment SSL_set_max_send_fragment
2628#define SSL_set_mode SSL_set_mode
2629#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
2630#define SSL_set_mtu SSL_set_mtu
2631#define SSL_set_options SSL_set_options
2632#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
2633#define SSL_set_tmp_dh SSL_set_tmp_dh
2634#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
2635#define SSL_set_tmp_rsa SSL_set_tmp_rsa
2636#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04002637
2638
David Benjamin087e4fa2015-04-08 23:46:10 -04002639#if defined(__cplusplus)
2640} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07002641#endif
David Benjamin2e521212014-07-16 14:37:51 -04002642
David Benjamin087e4fa2015-04-08 23:46:10 -04002643
2644/* Library consumers assume these headers are included by ssl.h, but they depend
2645 * on ssl.h, so include them after all declarations.
2646 *
2647 * TODO(davidben): The separation between ssl.h and these version-specific
2648 * headers introduces circular dependencies and is inconsistent. The function
2649 * declarations should move to ssl.h. Many of the constants can probably be
2650 * pruned or unexported. */
David Benjamin087e4fa2015-04-08 23:46:10 -04002651#include <openssl/ssl3.h>
2652#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04002653#include <openssl/srtp.h> /* Support for the use_srtp extension */
2654
2655
David Benjamin2e521212014-07-16 14:37:51 -04002656/* BEGIN ERROR CODES */
2657/* The following lines are auto generated by the script make_errors.go. Any
2658 * changes made after this point may be overwritten when the script is next run.
2659 */
David Benjamin689be0f2015-02-11 15:55:26 -05002660#define SSL_F_SSL_CTX_check_private_key 100
2661#define SSL_F_SSL_CTX_new 101
2662#define SSL_F_SSL_CTX_set_cipher_list 102
2663#define SSL_F_SSL_CTX_set_cipher_list_tls11 103
2664#define SSL_F_SSL_CTX_set_session_id_context 104
2665#define SSL_F_SSL_CTX_use_PrivateKey 105
2666#define SSL_F_SSL_CTX_use_PrivateKey_ASN1 106
2667#define SSL_F_SSL_CTX_use_PrivateKey_file 107
2668#define SSL_F_SSL_CTX_use_RSAPrivateKey 108
2669#define SSL_F_SSL_CTX_use_RSAPrivateKey_ASN1 109
2670#define SSL_F_SSL_CTX_use_RSAPrivateKey_file 110
Adam Langley95c29f32014-06-20 12:00:00 -07002671#define SSL_F_SSL_CTX_use_certificate 111
David Benjamin689be0f2015-02-11 15:55:26 -05002672#define SSL_F_SSL_CTX_use_certificate_ASN1 112
2673#define SSL_F_SSL_CTX_use_certificate_chain_file 113
2674#define SSL_F_SSL_CTX_use_certificate_file 114
2675#define SSL_F_SSL_CTX_use_psk_identity_hint 115
2676#define SSL_F_SSL_SESSION_new 116
2677#define SSL_F_SSL_SESSION_print_fp 117
2678#define SSL_F_SSL_SESSION_set1_id_context 118
2679#define SSL_F_SSL_SESSION_to_bytes_full 119
2680#define SSL_F_SSL_accept 120
2681#define SSL_F_SSL_add_dir_cert_subjects_to_stack 121
2682#define SSL_F_SSL_add_file_cert_subjects_to_stack 122
2683#define SSL_F_SSL_check_private_key 123
2684#define SSL_F_SSL_clear 124
2685#define SSL_F_SSL_connect 125
2686#define SSL_F_SSL_do_handshake 126
2687#define SSL_F_SSL_load_client_CA_file 127
2688#define SSL_F_SSL_new 128
2689#define SSL_F_SSL_peek 129
2690#define SSL_F_SSL_read 130
2691#define SSL_F_SSL_renegotiate 131
2692#define SSL_F_SSL_set_cipher_list 132
2693#define SSL_F_SSL_set_fd 133
2694#define SSL_F_SSL_set_rfd 134
2695#define SSL_F_SSL_set_session_id_context 135
2696#define SSL_F_SSL_set_wfd 136
2697#define SSL_F_SSL_shutdown 137
2698#define SSL_F_SSL_use_PrivateKey 138
2699#define SSL_F_SSL_use_PrivateKey_ASN1 139
2700#define SSL_F_SSL_use_PrivateKey_file 140
2701#define SSL_F_SSL_use_RSAPrivateKey 141
2702#define SSL_F_SSL_use_RSAPrivateKey_ASN1 142
2703#define SSL_F_SSL_use_RSAPrivateKey_file 143
2704#define SSL_F_SSL_use_certificate 144
2705#define SSL_F_SSL_use_certificate_ASN1 145
2706#define SSL_F_SSL_use_certificate_file 146
2707#define SSL_F_SSL_use_psk_identity_hint 147
2708#define SSL_F_SSL_write 148
2709#define SSL_F_d2i_SSL_SESSION 149
David Benjaminfd67aa82015-06-15 19:41:48 -04002710#define SSL_F_SSL_SESSION_parse_octet_string 150
2711#define SSL_F_SSL_SESSION_parse_string 151
David Benjamin689be0f2015-02-11 15:55:26 -05002712#define SSL_F_do_ssl3_write 152
2713#define SSL_F_dtls1_accept 153
2714#define SSL_F_dtls1_buffer_record 154
2715#define SSL_F_dtls1_check_timeout_num 155
2716#define SSL_F_dtls1_connect 156
2717#define SSL_F_dtls1_do_write 157
2718#define SSL_F_dtls1_get_hello_verify 158
2719#define SSL_F_dtls1_get_message 159
2720#define SSL_F_dtls1_get_message_fragment 160
2721#define SSL_F_dtls1_preprocess_fragment 161
2722#define SSL_F_dtls1_process_record 162
2723#define SSL_F_dtls1_read_bytes 163
2724#define SSL_F_dtls1_send_hello_verify_request 164
David Benjaminc933a472015-05-30 16:14:58 -04002725#define SSL_F_dtls1_write_app_data 165
David Benjamin689be0f2015-02-11 15:55:26 -05002726#define SSL_F_i2d_SSL_SESSION 166
2727#define SSL_F_ssl3_accept 167
David Benjamin689be0f2015-02-11 15:55:26 -05002728#define SSL_F_ssl3_cert_verify_hash 169
2729#define SSL_F_ssl3_check_cert_and_algorithm 170
2730#define SSL_F_ssl3_connect 171
2731#define SSL_F_ssl3_ctrl 172
2732#define SSL_F_ssl3_ctx_ctrl 173
2733#define SSL_F_ssl3_digest_cached_records 174
2734#define SSL_F_ssl3_do_change_cipher_spec 175
2735#define SSL_F_ssl3_expect_change_cipher_spec 176
2736#define SSL_F_ssl3_get_cert_status 177
2737#define SSL_F_ssl3_get_cert_verify 178
2738#define SSL_F_ssl3_get_certificate_request 179
2739#define SSL_F_ssl3_get_channel_id 180
2740#define SSL_F_ssl3_get_client_certificate 181
2741#define SSL_F_ssl3_get_client_hello 182
2742#define SSL_F_ssl3_get_client_key_exchange 183
2743#define SSL_F_ssl3_get_finished 184
2744#define SSL_F_ssl3_get_initial_bytes 185
2745#define SSL_F_ssl3_get_message 186
2746#define SSL_F_ssl3_get_new_session_ticket 187
2747#define SSL_F_ssl3_get_next_proto 188
2748#define SSL_F_ssl3_get_record 189
2749#define SSL_F_ssl3_get_server_certificate 190
2750#define SSL_F_ssl3_get_server_done 191
2751#define SSL_F_ssl3_get_server_hello 192
2752#define SSL_F_ssl3_get_server_key_exchange 193
2753#define SSL_F_ssl3_get_v2_client_hello 194
2754#define SSL_F_ssl3_handshake_mac 195
2755#define SSL_F_ssl3_prf 196
2756#define SSL_F_ssl3_read_bytes 197
2757#define SSL_F_ssl3_read_n 198
2758#define SSL_F_ssl3_send_cert_verify 199
2759#define SSL_F_ssl3_send_certificate_request 200
2760#define SSL_F_ssl3_send_channel_id 201
2761#define SSL_F_ssl3_send_client_certificate 202
2762#define SSL_F_ssl3_send_client_hello 203
2763#define SSL_F_ssl3_send_client_key_exchange 204
2764#define SSL_F_ssl3_send_server_certificate 205
2765#define SSL_F_ssl3_send_server_hello 206
2766#define SSL_F_ssl3_send_server_key_exchange 207
2767#define SSL_F_ssl3_setup_read_buffer 208
2768#define SSL_F_ssl3_setup_write_buffer 209
2769#define SSL_F_ssl3_write_bytes 210
2770#define SSL_F_ssl3_write_pending 211
2771#define SSL_F_ssl_add_cert_chain 212
2772#define SSL_F_ssl_add_cert_to_buf 213
2773#define SSL_F_ssl_add_clienthello_renegotiate_ext 214
2774#define SSL_F_ssl_add_clienthello_tlsext 215
2775#define SSL_F_ssl_add_clienthello_use_srtp_ext 216
2776#define SSL_F_ssl_add_serverhello_renegotiate_ext 217
2777#define SSL_F_ssl_add_serverhello_tlsext 218
2778#define SSL_F_ssl_add_serverhello_use_srtp_ext 219
2779#define SSL_F_ssl_build_cert_chain 220
2780#define SSL_F_ssl_bytes_to_cipher_list 221
2781#define SSL_F_ssl_cert_dup 222
2782#define SSL_F_ssl_cert_inst 223
2783#define SSL_F_ssl_cert_new 224
2784#define SSL_F_ssl_check_serverhello_tlsext 225
2785#define SSL_F_ssl_check_srvr_ecc_cert_and_alg 226
2786#define SSL_F_ssl_cipher_process_rulestr 227
2787#define SSL_F_ssl_cipher_strength_sort 228
2788#define SSL_F_ssl_create_cipher_list 229
2789#define SSL_F_ssl_ctx_log_master_secret 230
2790#define SSL_F_ssl_ctx_log_rsa_client_key_exchange 231
2791#define SSL_F_ssl_ctx_make_profiles 232
2792#define SSL_F_ssl_get_new_session 233
2793#define SSL_F_ssl_get_prev_session 234
2794#define SSL_F_ssl_get_server_cert_index 235
2795#define SSL_F_ssl_get_sign_pkey 236
2796#define SSL_F_ssl_init_wbio_buffer 237
2797#define SSL_F_ssl_parse_clienthello_renegotiate_ext 238
2798#define SSL_F_ssl_parse_clienthello_tlsext 239
2799#define SSL_F_ssl_parse_clienthello_use_srtp_ext 240
2800#define SSL_F_ssl_parse_serverhello_renegotiate_ext 241
2801#define SSL_F_ssl_parse_serverhello_tlsext 242
2802#define SSL_F_ssl_parse_serverhello_use_srtp_ext 243
2803#define SSL_F_ssl_scan_clienthello_tlsext 244
2804#define SSL_F_ssl_scan_serverhello_tlsext 245
2805#define SSL_F_ssl_sess_cert_new 246
2806#define SSL_F_ssl_set_cert 247
2807#define SSL_F_ssl_set_pkey 248
David Benjamin689be0f2015-02-11 15:55:26 -05002808#define SSL_F_ssl_verify_cert_chain 252
2809#define SSL_F_tls12_check_peer_sigalg 253
2810#define SSL_F_tls1_aead_ctx_init 254
2811#define SSL_F_tls1_cert_verify_mac 255
2812#define SSL_F_tls1_change_cipher_state 256
2813#define SSL_F_tls1_change_cipher_state_aead 257
2814#define SSL_F_tls1_check_duplicate_extensions 258
2815#define SSL_F_tls1_enc 259
2816#define SSL_F_tls1_export_keying_material 260
2817#define SSL_F_tls1_prf 261
2818#define SSL_F_tls1_setup_key_block 262
David Benjamin75381222015-03-02 19:30:30 -05002819#define SSL_F_dtls1_get_buffered_message 263
2820#define SSL_F_dtls1_process_fragment 264
David Benjaminee562b92015-03-02 20:52:52 -05002821#define SSL_F_dtls1_hm_fragment_new 265
David Benjamin9faafda2015-04-04 19:23:10 -04002822#define SSL_F_ssl3_seal_record 266
David Benjamind81e73d2015-04-05 00:21:39 -04002823#define SSL_F_ssl3_record_sequence_update 267
David Benjamin15a3b002015-04-28 00:05:35 -04002824#define SSL_F_SSL_CTX_set_tmp_dh 268
2825#define SSL_F_SSL_CTX_set_tmp_ecdh 269
2826#define SSL_F_SSL_set_tmp_dh 270
2827#define SSL_F_SSL_set_tmp_ecdh 271
David Benjaminc2807582015-04-28 00:19:50 -04002828#define SSL_F_SSL_CTX_set1_tls_channel_id 272
2829#define SSL_F_SSL_set1_tls_channel_id 273
David Benjamin7133d422015-04-28 00:43:39 -04002830#define SSL_F_SSL_set_tlsext_host_name 274
David Benjamin605641e2015-05-03 15:14:04 -04002831#define SSL_F_ssl3_output_cert_chain 275
David Benjamin31a07792015-03-03 14:20:26 -05002832#define SSL_F_SSL_AEAD_CTX_new 276
2833#define SSL_F_SSL_AEAD_CTX_open 277
2834#define SSL_F_SSL_AEAD_CTX_seal 278
2835#define SSL_F_dtls1_seal_record 279
David Benjaminfd67aa82015-06-15 19:41:48 -04002836#define SSL_F_SSL_SESSION_from_bytes 280
2837#define SSL_F_SSL_SESSION_parse 281
2838#define SSL_F_ssl3_check_certificate_for_cipher 282
David Benjamin6cacac02015-06-16 13:29:54 -04002839#define SSL_F_SSL_CTX_get_tlsext_ticket_keys 283
2840#define SSL_F_SSL_CTX_set_tlsext_ticket_keys 284
Adam Langley5021b222015-06-12 18:27:58 -07002841#define SSL_F_ext_ri_parse_clienthello 285
2842#define SSL_F_ext_ri_parse_serverhello 286
David Benjamin689be0f2015-02-11 15:55:26 -05002843#define SSL_R_APP_DATA_IN_HANDSHAKE 100
2844#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
2845#define SSL_R_BAD_ALERT 102
2846#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
2847#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
2848#define SSL_R_BAD_DH_P_LENGTH 105
2849#define SSL_R_BAD_DIGEST_LENGTH 106
2850#define SSL_R_BAD_ECC_CERT 107
2851#define SSL_R_BAD_ECPOINT 108
2852#define SSL_R_BAD_HANDSHAKE_LENGTH 109
2853#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07002854#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05002855#define SSL_R_BAD_LENGTH 112
2856#define SSL_R_BAD_PACKET_LENGTH 113
2857#define SSL_R_BAD_RSA_ENCRYPT 114
2858#define SSL_R_BAD_SIGNATURE 115
2859#define SSL_R_BAD_SRTP_MKI_VALUE 116
2860#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
2861#define SSL_R_BAD_SSL_FILETYPE 118
2862#define SSL_R_BAD_WRITE_RETRY 119
2863#define SSL_R_BIO_NOT_SET 120
2864#define SSL_R_BN_LIB 121
2865#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
2866#define SSL_R_CA_DN_LENGTH_MISMATCH 123
2867#define SSL_R_CA_DN_TOO_LONG 124
2868#define SSL_R_CCS_RECEIVED_EARLY 125
2869#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
2870#define SSL_R_CERT_CB_ERROR 127
2871#define SSL_R_CERT_LENGTH_MISMATCH 128
2872#define SSL_R_CHANNEL_ID_NOT_P256 129
2873#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
2874#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
2875#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
2876#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
2877#define SSL_R_CLIENTHELLO_TLSEXT 134
2878#define SSL_R_CONNECTION_REJECTED 135
2879#define SSL_R_CONNECTION_TYPE_NOT_SET 136
2880#define SSL_R_COOKIE_MISMATCH 137
2881#define SSL_R_D2I_ECDSA_SIG 138
2882#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
2883#define SSL_R_DATA_LENGTH_TOO_LONG 140
2884#define SSL_R_DECODE_ERROR 141
2885#define SSL_R_DECRYPTION_FAILED 142
2886#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
2887#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
2888#define SSL_R_DIGEST_CHECK_FAILED 145
2889#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
2890#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
2891#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
2892#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
2893#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
2894#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
2895#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
2896#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
2897#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
2898#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
2899#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
2900#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
2901#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
2902#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
2903#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
2904#define SSL_R_HTTPS_PROXY_REQUEST 161
2905#define SSL_R_HTTP_REQUEST 162
2906#define SSL_R_INAPPROPRIATE_FALLBACK 163
2907#define SSL_R_INVALID_COMMAND 164
2908#define SSL_R_INVALID_MESSAGE 165
2909#define SSL_R_INVALID_SSL_SESSION 166
2910#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
2911#define SSL_R_LENGTH_MISMATCH 168
2912#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
2913#define SSL_R_MISSING_DH_KEY 170
2914#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
2915#define SSL_R_MISSING_RSA_CERTIFICATE 172
2916#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
2917#define SSL_R_MISSING_RSA_SIGNING_CERT 174
2918#define SSL_R_MISSING_TMP_DH_KEY 175
2919#define SSL_R_MISSING_TMP_ECDH_KEY 176
2920#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
2921#define SSL_R_MTU_TOO_SMALL 178
2922#define SSL_R_NESTED_GROUP 179
2923#define SSL_R_NO_CERTIFICATES_RETURNED 180
2924#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
2925#define SSL_R_NO_CERTIFICATE_SET 182
2926#define SSL_R_NO_CIPHERS_AVAILABLE 183
2927#define SSL_R_NO_CIPHERS_PASSED 184
2928#define SSL_R_NO_CIPHERS_SPECIFIED 185
2929#define SSL_R_NO_CIPHER_MATCH 186
2930#define SSL_R_NO_COMPRESSION_SPECIFIED 187
2931#define SSL_R_NO_METHOD_SPECIFIED 188
2932#define SSL_R_NO_P256_SUPPORT 189
2933#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
2934#define SSL_R_NO_RENEGOTIATION 191
2935#define SSL_R_NO_REQUIRED_DIGEST 192
2936#define SSL_R_NO_SHARED_CIPHER 193
2937#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
2938#define SSL_R_NO_SRTP_PROFILES 195
2939#define SSL_R_NULL_SSL_CTX 196
2940#define SSL_R_NULL_SSL_METHOD_PASSED 197
2941#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
2942#define SSL_R_PACKET_LENGTH_TOO_LONG 199
2943#define SSL_R_PARSE_TLSEXT 200
2944#define SSL_R_PATH_TOO_LONG 201
2945#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
2946#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
2947#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
2948#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
2949#define SSL_R_PSK_NO_CLIENT_CB 206
2950#define SSL_R_PSK_NO_SERVER_CB 207
2951#define SSL_R_READ_BIO_NOT_SET 208
2952#define SSL_R_READ_TIMEOUT_EXPIRED 209
2953#define SSL_R_RECORD_LENGTH_MISMATCH 210
2954#define SSL_R_RECORD_TOO_LARGE 211
2955#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
2956#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
2957#define SSL_R_RENEGOTIATION_MISMATCH 214
2958#define SSL_R_REQUIRED_CIPHER_MISSING 215
2959#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
2960#define SSL_R_SERVERHELLO_TLSEXT 217
2961#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
2962#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
2963#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
2964#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
2965#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
2966#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
2967#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
2968#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
2969#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
2970#define SSL_R_SSL_HANDSHAKE_FAILURE 227
2971#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
2972#define SSL_R_SSL_SESSION_ID_CONFLICT 229
2973#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
2974#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
2975#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
2976#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
2977#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
2978#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
2979#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
2980#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
2981#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
2982#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
2983#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
2984#define SSL_R_UNEXPECTED_MESSAGE 241
2985#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
2986#define SSL_R_UNEXPECTED_RECORD 243
2987#define SSL_R_UNINITIALIZED 244
2988#define SSL_R_UNKNOWN_ALERT_TYPE 245
2989#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
2990#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
2991#define SSL_R_UNKNOWN_CIPHER_TYPE 248
2992#define SSL_R_UNKNOWN_DIGEST 249
2993#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
2994#define SSL_R_UNKNOWN_PROTOCOL 251
2995#define SSL_R_UNKNOWN_SSL_VERSION 252
2996#define SSL_R_UNKNOWN_STATE 253
2997#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
2998#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
2999#define SSL_R_UNSUPPORTED_CIPHER 256
3000#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
3001#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
3002#define SSL_R_UNSUPPORTED_PROTOCOL 259
3003#define SSL_R_UNSUPPORTED_SSL_VERSION 260
3004#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07003005#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05003006#define SSL_R_WRONG_CIPHER_RETURNED 263
3007#define SSL_R_WRONG_CURVE 264
3008#define SSL_R_WRONG_MESSAGE_TYPE 265
3009#define SSL_R_WRONG_SIGNATURE_TYPE 266
3010#define SSL_R_WRONG_SSL_VERSION 267
3011#define SSL_R_WRONG_VERSION_NUMBER 268
3012#define SSL_R_X509_LIB 269
3013#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05003014#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04003015#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04003016#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05003017#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07003018#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
3019#define SSL_R_EMS_STATE_INCONSISTENT 276
3020#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04003021#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07003022#define SSL_R_UNEXPECTED_EXTENSION 279
David Benjamind7c53682014-09-17 12:08:13 -04003023#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04003024#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
3025#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
3026#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
3027#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
3028#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
3029#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
3030#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
3031#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
3032#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
3033#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
3034#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
3035#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
3036#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
3037#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
3038#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
3039#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
3040#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
3041#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
3042#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
3043#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
3044#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04003045#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04003046#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
3047#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
3048#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
3049#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
3050#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
3051#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
3052#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07003053
David Benjamin087e4fa2015-04-08 23:46:10 -04003054#endif /* OPENSSL_HEADER_SSL_H */