blob: 0af45996db45d0025e66ec7d5ca6e84e6f2afe04 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* ssl/ssl.h */
2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
Adam Langleyb4a494c2015-01-23 15:10:10 -08008 *
Adam Langley95c29f32014-06-20 12:00:00 -07009 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
Adam Langleyb4a494c2015-01-23 15:10:10 -080015 *
Adam Langley95c29f32014-06-20 12:00:00 -070016 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
Adam Langleyb4a494c2015-01-23 15:10:10 -080022 *
Adam Langley95c29f32014-06-20 12:00:00 -070023 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
Adam Langleyb4a494c2015-01-23 15:10:10 -080037 * 4. If you include any Windows specific code (or a derivative thereof) from
Adam Langley95c29f32014-06-20 12:00:00 -070038 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
Adam Langleyb4a494c2015-01-23 15:10:10 -080040 *
Adam Langley95c29f32014-06-20 12:00:00 -070041 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
Adam Langleyb4a494c2015-01-23 15:10:10 -080052 *
Adam Langley95c29f32014-06-20 12:00:00 -070053 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58/* ====================================================================
59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
60 *
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
63 * are met:
64 *
65 * 1. Redistributions of source code must retain the above copyright
Adam Langleyb4a494c2015-01-23 15:10:10 -080066 * notice, this list of conditions and the following disclaimer.
Adam Langley95c29f32014-06-20 12:00:00 -070067 *
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 *
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
82 *
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
86 *
87 * 6. Redistributions of any form whatsoever must retain the following
88 * acknowledgment:
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 *
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
105 *
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
109 *
110 */
111/* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
Adam Langleyb4a494c2015-01-23 15:10:10 -0800113 * ECC cipher suite support in OpenSSL originally developed by
Adam Langley95c29f32014-06-20 12:00:00 -0700114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 */
116/* ====================================================================
117 * Copyright 2005 Nokia. All rights reserved.
118 *
119 * The portions of the attached software ("Contribution") is developed by
120 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
121 * license.
122 *
123 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
124 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
125 * support (see RFC 4279) to OpenSSL.
126 *
127 * No patent licenses or other rights except those expressly stated in
128 * the OpenSSL open source license shall be deemed granted or received
129 * expressly, by implication, estoppel, or otherwise.
130 *
131 * No assurances are provided by Nokia that the Contribution does not
132 * infringe the patent or other intellectual property rights of any third
133 * party or that the license provides you with all the necessary rights
134 * to make use of the Contribution.
135 *
136 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
137 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
138 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
139 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
140 * OTHERWISE.
141 */
142
David Benjamin087e4fa2015-04-08 23:46:10 -0400143#ifndef OPENSSL_HEADER_SSL_H
144#define OPENSSL_HEADER_SSL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146#include <openssl/base.h>
147
148#include <openssl/bio.h>
149#include <openssl/buf.h>
150#include <openssl/hmac.h>
151#include <openssl/lhash.h>
152#include <openssl/pem.h>
Adam Langley0b5e3902015-05-15 13:08:38 -0700153#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700154#include <openssl/x509.h>
155
David Benjamin2e749e82015-04-07 23:20:51 -0400156#if !defined(OPENSSL_WINDOWS)
157#include <sys/time.h>
158#endif
159
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700160/* wpa_supplicant expects to get the version functions from ssl.h */
161#include <openssl/crypto.h>
162
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400163/* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
164 * Windows headers define too many macros to be included in public headers.
165 * However, only a forward declaration is needed. */
166struct timeval;
167
David Benjamin087e4fa2015-04-08 23:46:10 -0400168#if defined(__cplusplus)
Adam Langley95c29f32014-06-20 12:00:00 -0700169extern "C" {
170#endif
171
172
David Benjamin0d8a7582015-04-08 23:55:15 -0400173/* SSL implementation. */
174
175
David Benjamin71f07942015-04-08 02:36:59 -0400176/* Initialization. */
177
178/* SSL_library_init initializes the crypto and SSL libraries and returns one. */
179OPENSSL_EXPORT int SSL_library_init(void);
180
181
182/* Cipher suites. */
183
184/* An SSL_CIPHER represents a cipher suite. */
185typedef struct ssl_cipher_st {
186 /* name is the OpenSSL name for the cipher. */
187 const char *name;
188 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
189 uint32_t id;
190
191 /* The following are internal fields. See ssl/internal.h for their values. */
192
193 uint32_t algorithm_mkey;
194 uint32_t algorithm_auth;
195 uint32_t algorithm_enc;
196 uint32_t algorithm_mac;
197 uint32_t algorithm_ssl;
198 uint32_t algo_strength;
199
200 /* algorithm2 contains extra flags. See ssl/internal.h. */
201 uint32_t algorithm2;
202
203 /* strength_bits is the strength of the cipher in bits. */
204 int strength_bits;
205 /* alg_bits is the number of bits of key material used by the algorithm. */
206 int alg_bits;
207} SSL_CIPHER;
208
209DECLARE_STACK_OF(SSL_CIPHER)
210
211/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
212 * suite based on its assigned number, or NULL if unknown. See
213 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
214OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
215
216/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
217 * get the cipher suite value. */
218OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
219
220/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
221 * mode). */
222OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
223
224/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
225OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
226
227/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
228OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
229
230/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
231 * CHACHA20_POLY1305. */
232OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
233
234/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
235OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
236
237/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
238 * method used by |cipher|. For example, "ECDHE_ECDSA". */
239OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
240
241/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
David Benjamin3fa65f02015-05-15 19:11:57 -0400242 * name for |cipher| or NULL on error. For example,
243 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
244 * calling |OPENSSL_free| on the result. */
David Benjamin71f07942015-04-08 02:36:59 -0400245OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
246
247/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
248 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
249 * symmetric algorithm to |*out_alg_bits|. */
250OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
251 int *out_alg_bits);
252
253
David Benjamin4831c332015-05-16 11:43:13 -0400254/* SSL contexts. */
255
256/* An SSL_METHOD selects whether to use TLS or DTLS. */
257typedef struct ssl_method_st SSL_METHOD;
258
259/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
260OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
261
262/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
263OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
264
265/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
266 * on error. An |SSL_CTX| manages shared state and configuration between
267 * multiple TLS or DTLS connections. */
268OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
269
270/* SSL_CTX_free releases memory associated with |ctx|. */
271OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
272
273
274/* SSL connections. */
275
276/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
277 * |SSL| object represents a single TLS or DTLS connection. It inherits settings
278 * from |ctx| at the time of creation. Settings may also be individually
279 * configured on the connection.
280 *
281 * On creation, an |SSL| is not configured to be either a client or server. Call
282 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
283OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
284
285/* SSL_free releases memory associated with |ssl|. */
286OPENSSL_EXPORT void SSL_free(SSL *ssl);
287
288/* SSL_set_connect_state configures |ssl| to be a client. */
289OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
290
291/* SSL_set_accept_state configures |ssl| to be a server. */
292OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
293
294
David Benjaminb487df62015-05-16 15:31:07 -0400295/* Protocol versions. */
296
297#define SSL3_VERSION_MAJOR 0x03
298
299#define SSL3_VERSION 0x0300
300#define TLS1_VERSION 0x0301
301#define TLS1_1_VERSION 0x0302
302#define TLS1_2_VERSION 0x0303
303
304#define DTLS1_VERSION 0xfeff
305#define DTLS1_2_VERSION 0xfefd
306
307/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
308 * |version|. */
309OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
310
311/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
312 * |version|. */
313OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
314
315/* SSL_set_min_version sets the minimum protocol version for |ssl| to
316 * |version|. */
317OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
318
319/* SSL_set_max_version sets the maximum protocol version for |ssl| to
320 * |version|. */
321OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
322
323
324/* Options.
325 *
326 * Options configure protocol behavior. */
327
328/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
329 * support the renegotiation_info extension (RFC 5746). It is on by default. */
330#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
331
332/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
333 * bytes above the maximum record size. */
334#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
335
336/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
337 * (i.e. without a length prefix). */
338#define SSL_OP_TLS_D5_BUG 0x00000100L
339
340/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
341 * consumers.
342 * TODO(davidben): Determine which of the remaining may be removed now. */
343#define SSL_OP_ALL 0x00000BFFL
344
345/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
346 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
347#define SSL_OP_NO_QUERY_MTU 0x00001000L
348
349/* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
350#define SSL_OP_NO_TICKET 0x00004000L
351
352/* SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION permits unsafe legacy renegotiation
353 * without renegotiation_info (RFC 5746) support. */
354#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0x00040000L
355
356/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
357 * ECDHE curves according to the server's preferences instead of the
358 * client's. */
359#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
360
361/* The following flags toggle individual protocol versions. This is deprecated.
362 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
363#define SSL_OP_NO_SSLv3 0x02000000L
364#define SSL_OP_NO_TLSv1 0x04000000L
365#define SSL_OP_NO_TLSv1_2 0x08000000L
366#define SSL_OP_NO_TLSv1_1 0x10000000L
367#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
368#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
369
370/* The following flags do nothing and are included only to make it easier to
371 * compile code with BoringSSL. */
372#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
373#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
374#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
375#define SSL_OP_NO_COMPRESSION 0
376#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
377#define SSL_OP_NO_SSLv2 0
378#define SSL_OP_SINGLE_DH_USE 0
379#define SSL_OP_SINGLE_ECDH_USE 0
380#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
381#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
382#define SSL_OP_TLS_ROLLBACK_BUG 0
383
384/* SSL_CTX_set_options enables all options set in |options| (which should be one
385 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
386 * bitmask representing the resulting enabled options. */
387OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
388
389/* SSL_CTX_clear_options disables all options set in |options| (which should be
390 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
391 * bitmask representing the resulting enabled options. */
392OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
393
394/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
395 * the options enabled for |ctx|. */
396OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
397
398/* SSL_set_options enables all options set in |options| (which should be one or
399 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
400 * representing the resulting enabled options. */
401OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
402
403/* SSL_clear_options disables all options set in |options| (which should be one
404 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
405 * bitmask representing the resulting enabled options. */
406OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
407
408/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
409 * options enabled for |ssl|. */
410OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
411
412
413/* Modes.
414 *
415 * Modes configure API behavior. */
416
417/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
418 * result when the only part of the input was written in a single record. */
419#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
420
421/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
422 * with a different buffer. However, |SSL_write| still assumes the buffer
423 * contents are unchanged. This is not the default to avoid the misconception
424 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
425#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
426
427/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
428 * before sending certificates to the peer.
429 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
430#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
431
432/* SSL_MODE_SEND_CLIENTHELLO_TIME and SSL_MODE_SEND_SERVERHELLO_TIME send the
433 * current time in the random fields of the ClientHello and ServerHello records,
434 * respectively, for compatibility with hypothetical implementations that
435 * require it. */
436#define SSL_MODE_SEND_CLIENTHELLO_TIME 0x00000020L
437#define SSL_MODE_SEND_SERVERHELLO_TIME 0x00000040L
438
439/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
440 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
441 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
442#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
443
444/* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
445 * SSL_MODE_ENABLE_FALSE_START. */
446#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
447
448/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
449 * TLS 1.0 to be split in two: the first record will contain a single byte and
450 * the second will contain the remainder. This effectively randomises the IV and
451 * prevents BEAST attacks. */
452#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
453
454/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
455 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
456 * session resumption is used for a given SSL*. */
457#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
458
459/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
460 * To be set only by applications that reconnect with a downgraded protocol
461 * version; see https://tools.ietf.org/html/draft-ietf-tls-downgrade-scsv-05
462 * for details.
463 *
464 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
465 * this in explicit fallback retries, following the guidance in
466 * draft-ietf-tls-downgrade-scsv-05. */
467#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
468
469/* The following flags do nothing and are included only to make it easier to
470 * compile code with BoringSSL. */
471#define SSL_MODE_AUTO_RETRY 0
472#define SSL_MODE_RELEASE_BUFFERS 0
473
474/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
475 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
476 * representing the resulting enabled modes. */
477OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
478
479/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
480 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
481 * bitmask representing the resulting enabled modes. */
482OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
483
484/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
485 * the modes enabled for |ssl|. */
486OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
487
488/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
489 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
490 * representing the resulting enabled modes. */
491OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
492
493/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
494 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
495 * representing the resulting enabled modes. */
496OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
497
498/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
499 * modes enabled for |ssl|. */
500OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
501
502
David Benjamin71f07942015-04-08 02:36:59 -0400503/* Underdocumented functions.
504 *
505 * Functions below here haven't been touched up and may be underdocumented. */
506
Adam Langley95c29f32014-06-20 12:00:00 -0700507/* SSLeay version number for ASN.1 encoding of the session information */
508/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -0800509 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -0700510#define SSL_SESSION_ASN1_VERSION 0x0001
511
Adam Langleyb4a494c2015-01-23 15:10:10 -0800512#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
513#define SSL_MAX_SID_CTX_LENGTH 32
514#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -0700515
516/* These are used to specify which ciphers to use and not to use */
517
Adam Langleyb4a494c2015-01-23 15:10:10 -0800518#define SSL_TXT_MEDIUM "MEDIUM"
519#define SSL_TXT_HIGH "HIGH"
520#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -0700521
Adam Langleyb4a494c2015-01-23 15:10:10 -0800522#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -0400523#define SSL_TXT_kDHE "kDHE"
524#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
525#define SSL_TXT_kECDHE "kECDHE"
526#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800527#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700528
Adam Langleyb4a494c2015-01-23 15:10:10 -0800529#define SSL_TXT_aRSA "aRSA"
530#define SSL_TXT_aECDSA "aECDSA"
531#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700532
Adam Langleyb4a494c2015-01-23 15:10:10 -0800533#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400534#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400535#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800536#define SSL_TXT_RSA "RSA"
537#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400538#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400539#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800540#define SSL_TXT_ECDSA "ECDSA"
541#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700542
Adam Langleyb4a494c2015-01-23 15:10:10 -0800543#define SSL_TXT_3DES "3DES"
544#define SSL_TXT_RC4 "RC4"
545#define SSL_TXT_AES128 "AES128"
546#define SSL_TXT_AES256 "AES256"
547#define SSL_TXT_AES "AES"
548#define SSL_TXT_AES_GCM "AESGCM"
549#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -0700550
Adam Langleyb4a494c2015-01-23 15:10:10 -0800551#define SSL_TXT_MD5 "MD5"
552#define SSL_TXT_SHA1 "SHA1"
553#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
554#define SSL_TXT_SHA256 "SHA256"
555#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -0700556
Adam Langleyb4a494c2015-01-23 15:10:10 -0800557#define SSL_TXT_SSLV3 "SSLv3"
558#define SSL_TXT_TLSV1 "TLSv1"
559#define SSL_TXT_TLSV1_1 "TLSv1.1"
560#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -0700561
Adam Langleyb4a494c2015-01-23 15:10:10 -0800562#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -0700563
Adam Langleyb4a494c2015-01-23 15:10:10 -0800564/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
565 * normally not being used.
566 *
567 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
568 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
569 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
570 * that it is also disabled in the specific selection. COMPLEMENTOF*
571 * identifiers are portable between version, as adjustments to the default
572 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -0700573 *
574 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -0800575 * DEFAULT gets, as only selection is being done and no sorting as needed for
576 * DEFAULT. */
577#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -0700578
Adam Langleyb4a494c2015-01-23 15:10:10 -0800579/* The following cipher list is used by default. It also is substituted when an
580 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -0400581#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -0800582
Adam Langley95c29f32014-06-20 12:00:00 -0700583/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
584 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -0800585 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
586 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -0700587
588/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800589#define SSL_SENT_SHUTDOWN 1
590#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -0700591
Adam Langleyb4a494c2015-01-23 15:10:10 -0800592#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
593#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
Adam Langley95c29f32014-06-20 12:00:00 -0700594
David Benjamin82c9e902014-12-12 15:55:27 -0500595typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700596typedef struct ssl_session_st SSL_SESSION;
597typedef struct tls_sigalgs_st TLS_SIGALGS;
598typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -0500599typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700600
Adam Langleyb4a494c2015-01-23 15:10:10 -0800601/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
602typedef struct srtp_protection_profile_st {
603 const char *name;
604 unsigned long id;
605} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -0700606
607DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
608
David Benjamin83fd6b62014-10-19 04:33:38 -0400609/* An SSL_SESSION represents an SSL session that may be resumed in an
610 * abbreviated handshake. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800611struct ssl_session_st {
612 int ssl_version; /* what ssl version session info is being kept in here? */
Adam Langley95c29f32014-06-20 12:00:00 -0700613
Adam Langleyb4a494c2015-01-23 15:10:10 -0800614 int master_key_length;
615 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
616 /* session_id - valid? */
617 unsigned int session_id_length;
618 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
619 /* this is used to determine whether the session is being reused in
620 * the appropriate context. It is up to the application to set this,
621 * via SSL_new */
622 unsigned int sid_ctx_length;
623 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -0700624
Adam Langleyb4a494c2015-01-23 15:10:10 -0800625 char *psk_identity;
626 /* Used to indicate that session resumption is not allowed. Applications can
627 * also set this bit for a new session via not_resumable_session_cb to
628 * disable session caching and tickets. */
629 int not_resumable;
Adam Langley95c29f32014-06-20 12:00:00 -0700630
Adam Langleyb4a494c2015-01-23 15:10:10 -0800631 /* The cert is the certificate used to establish this connection */
632 struct sess_cert_st /* SESS_CERT */ *sess_cert;
Adam Langley95c29f32014-06-20 12:00:00 -0700633
Adam Langleyb4a494c2015-01-23 15:10:10 -0800634 /* This is the cert for the other end. On clients, it will be the same as
635 * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is not
636 * retained in the external representation of sessions, see ssl_asn1.c). */
637 X509 *peer;
638 /* when app_verify_callback accepts a session where the peer's certificate is
639 * not ok, we must remember the error for session reuse: */
640 long verify_result; /* only for servers */
Adam Langley95c29f32014-06-20 12:00:00 -0700641
Adam Langley0b5e3902015-05-15 13:08:38 -0700642 CRYPTO_refcount_t references;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800643 long timeout;
644 long time;
Adam Langley95c29f32014-06-20 12:00:00 -0700645
Adam Langleyb4a494c2015-01-23 15:10:10 -0800646 const SSL_CIPHER *cipher;
Adam Langley95c29f32014-06-20 12:00:00 -0700647
Adam Langleyb4a494c2015-01-23 15:10:10 -0800648 CRYPTO_EX_DATA ex_data; /* application specific data */
Adam Langley95c29f32014-06-20 12:00:00 -0700649
Adam Langleyb4a494c2015-01-23 15:10:10 -0800650 /* These are used to make removal of session-ids more efficient and to
651 * implement a maximum cache size. */
David Benjamin4dab2972015-05-16 02:56:06 -0400652 SSL_SESSION *prev, *next;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800653 char *tlsext_hostname;
654 /* RFC4507 info */
655 uint8_t *tlsext_tick; /* Session ticket */
656 size_t tlsext_ticklen; /* Session ticket length */
657 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
David Benjamin6c7aed02014-08-27 16:42:38 -0400658
Adam Langleyb4a494c2015-01-23 15:10:10 -0800659 size_t tlsext_signed_cert_timestamp_list_length;
660 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
David Benjamin6c7aed02014-08-27 16:42:38 -0400661
Adam Langleyb4a494c2015-01-23 15:10:10 -0800662 /* The OCSP response that came with the session. */
663 size_t ocsp_response_length;
664 uint8_t *ocsp_response;
David Benjamin6c7aed02014-08-27 16:42:38 -0400665
Adam Langleyb4a494c2015-01-23 15:10:10 -0800666 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
667 uint8_t
668 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
Adam Langley1258b6a2014-06-20 12:00:00 -0700669
Adam Langleyb4a494c2015-01-23 15:10:10 -0800670 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
671 * SHA-2, depending on TLS version) for the original, full handshake that
672 * created a session. This is used by Channel IDs during resumption. */
673 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
674 unsigned int original_handshake_hash_len;
Adam Langley75712922014-10-10 16:23:43 -0700675
Adam Langleyb4a494c2015-01-23 15:10:10 -0800676 /* extended_master_secret is true if the master secret in this session was
677 * generated using EMS and thus isn't vulnerable to the Triple Handshake
678 * attack. */
679 char extended_master_secret;
680};
Adam Langley95c29f32014-06-20 12:00:00 -0700681
Adam Langley95c29f32014-06-20 12:00:00 -0700682
683/* Cert related flags */
684/* Many implementations ignore some aspects of the TLS standards such as
Adam Langleyb4a494c2015-01-23 15:10:10 -0800685 * enforcing certifcate chain algorithms. When this is set we enforce them. */
686#define SSL_CERT_FLAG_TLS_STRICT 0x00000001L
Adam Langley95c29f32014-06-20 12:00:00 -0700687
Adam Langley95c29f32014-06-20 12:00:00 -0700688/* Flags for building certificate chains */
689/* Treat any existing certificates as untrusted CAs */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800690#define SSL_BUILD_CHAIN_FLAG_UNTRUSTED 0x1
Adam Langley95c29f32014-06-20 12:00:00 -0700691/* Don't include root CA in chain */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800692#define SSL_BUILD_CHAIN_FLAG_NO_ROOT 0x2
Adam Langleyf669c2d2014-06-20 12:00:00 -0700693/* Just check certificates already there */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800694#define SSL_BUILD_CHAIN_FLAG_CHECK 0x4
Adam Langleyf669c2d2014-06-20 12:00:00 -0700695/* Ignore verification errors */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800696#define SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR 0x8
Adam Langley64c22232014-06-20 12:00:00 -0700697/* Clear verification errors from queue */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800698#define SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR 0x10
Adam Langley95c29f32014-06-20 12:00:00 -0700699
David Benjamincb9cf792015-05-05 09:46:14 -0400700/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
701 * and zero on failure. */
702OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -0700703
David Benjamincb9cf792015-05-05 09:46:14 -0400704/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
705 * renegotiation (RFC 5746) and zero otherwise. */
706OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -0700707
David Benjamin59015c32015-04-26 13:13:55 -0400708/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
709 * This callback will be called when sending or receiving low-level record
710 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
711 * |write_p| is one for outgoing messages and zero for incoming messages.
712 *
713 * For each record header, |cb| is called with |version| = 0 and |content_type|
714 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
715 * this does not include the record body. If the record is sealed, the length
716 * in the header is the length of the ciphertext.
717 *
718 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
719 * protocol version and |content_type| is the corresponding record type. The
720 * |len| bytes from |buf| contain the handshake message, one-byte
721 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800722OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
723 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
724 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -0400725
David Benjamin61ecccf2015-05-05 09:44:51 -0400726/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
727 * callback. */
728OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
729
David Benjamin59015c32015-04-26 13:13:55 -0400730/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
731 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800732OPENSSL_EXPORT void SSL_set_msg_callback(
733 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
734 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -0400735
David Benjamin3b7456e2015-05-16 12:29:32 -0400736/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -0400737OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -0700738
David Benjamin859ec3c2014-09-02 16:29:36 -0400739/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -0800740 * log session material to |keylog_bio|. This is intended for debugging use
741 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -0400742 *
743 * The format is described in
744 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -0400745OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -0400746
Adam Langley95c29f32014-06-20 12:00:00 -0700747
Adam Langleyc9fb3752014-06-20 12:00:00 -0700748struct ssl_aead_ctx_st;
749typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
750
Adam Langleyb4a494c2015-01-23 15:10:10 -0800751#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -0700752
Adam Langleyb4a494c2015-01-23 15:10:10 -0800753#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -0700754
David Benjaminf4501342014-08-14 17:24:37 -0400755#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
756
Adam Langleyb4a494c2015-01-23 15:10:10 -0800757/* This callback type is used inside SSL_CTX, SSL, and in the functions that
758 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -0700759 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -0800760 * callbacks should themselves check if the id they generate is unique
761 * otherwise the SSL handshake will fail with an error - callbacks can do this
762 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -0700763 * SSL_has_matching_session_id(ssl, id, *id_len)
764 * The length value passed in is set at the maximum size the session ID can be.
765 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
766 * can alter this length to be less if desired, but under SSLv2 session IDs are
767 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -0800768 * returns in this case. It is also an error for the callback to set the size
769 * to zero. */
770typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
771 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -0700772
Adam Langleydc9b1412014-06-20 12:00:00 -0700773/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -0800774 * early on during the server handshake. At this point, much of the SSL* hasn't
775 * been filled out and only the ClientHello can be depended on. */
776struct ssl_early_callback_ctx {
777 SSL *ssl;
778 const uint8_t *client_hello;
779 size_t client_hello_len;
780 const uint8_t *session_id;
781 size_t session_id_len;
782 const uint8_t *cipher_suites;
783 size_t cipher_suites_len;
784 const uint8_t *compression_methods;
785 size_t compression_methods_len;
786 const uint8_t *extensions;
787 size_t extensions_len;
788};
Adam Langleydc9b1412014-06-20 12:00:00 -0700789
Adam Langleyb4a494c2015-01-23 15:10:10 -0800790/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
791 * extension of the given type. If not found, it returns zero. Otherwise it
792 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -0700793 * and length bytes), sets |out_len| to the length of the extension contents
794 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800795OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
796 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
797 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -0700798
Adam Langley95c29f32014-06-20 12:00:00 -0700799typedef struct ssl_comp_st SSL_COMP;
800
Adam Langleyb4a494c2015-01-23 15:10:10 -0800801struct ssl_comp_st {
802 int id;
803 const char *name;
804 char *method;
805};
Adam Langley95c29f32014-06-20 12:00:00 -0700806
807DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -0700808DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -0700809
Adam Langley858a88d2014-06-20 12:00:00 -0700810/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
811 * equal-preference groups. For TLS clients, the groups are moot because the
812 * server picks the cipher and groups cannot be expressed on the wire. However,
813 * for servers, the equal-preference groups allow the client's preferences to
814 * be partially respected. (This only has an effect with
815 * SSL_OP_CIPHER_SERVER_PREFERENCE).
816 *
817 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
818 * All elements of a group have the same priority: no ordering is expressed
819 * within a group.
820 *
821 * The values in |ciphers| are in one-to-one correspondence with
822 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
823 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
824 * indicate that the corresponding SSL_CIPHER is not the last element of a
825 * group, or 0 to indicate that it is.
826 *
827 * For example, if |in_group_flags| contains all zeros then that indicates a
828 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
829 * of the group (i.e. they are all in a one-element group).
830 *
831 * For a more complex example, consider:
832 * ciphers: A B C D E F
833 * in_group_flags: 1 1 0 0 1 0
834 *
835 * That would express the following, order:
836 *
837 * A E
838 * B -> D -> F
839 * C
840 */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800841struct ssl_cipher_preference_list_st {
842 STACK_OF(SSL_CIPHER) *ciphers;
843 uint8_t *in_group_flags;
844};
Adam Langley858a88d2014-06-20 12:00:00 -0700845
Adam Langleyb4a494c2015-01-23 15:10:10 -0800846struct ssl_ctx_st {
847 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -0700848
Adam Langley4bdb6e42015-05-15 15:29:21 -0700849 /* lock is used to protect various operations on this object. */
850 CRYPTO_MUTEX lock;
851
Adam Langleyb4a494c2015-01-23 15:10:10 -0800852 /* max_version is the maximum acceptable protocol version. If zero, the
853 * maximum supported version, currently (D)TLS 1.2, is used. */
854 uint16_t max_version;
David Benjamin1eb367c2014-12-12 18:17:51 -0500855
Adam Langleyb4a494c2015-01-23 15:10:10 -0800856 /* min_version is the minimum acceptable protocl version. If zero, the
857 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
858 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -0500859
Adam Langleyb4a494c2015-01-23 15:10:10 -0800860 struct ssl_cipher_preference_list_st *cipher_list;
861 /* same as above but sorted for lookup */
862 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
863 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
864 * use. This only applies to server connections as, for clients, the version
865 * number is known at connect time and so the cipher list can be set then. */
866 struct ssl_cipher_preference_list_st *cipher_list_tls11;
Adam Langley95c29f32014-06-20 12:00:00 -0700867
David Benjamin4dab2972015-05-16 02:56:06 -0400868 X509_STORE *cert_store;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800869 LHASH_OF(SSL_SESSION) *sessions;
870 /* Most session-ids that will be cached, default is
871 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
872 unsigned long session_cache_size;
David Benjamin4dab2972015-05-16 02:56:06 -0400873 SSL_SESSION *session_cache_head;
874 SSL_SESSION *session_cache_tail;
Adam Langley95c29f32014-06-20 12:00:00 -0700875
David Benjaminb6d0c6d2015-03-19 19:07:26 -0400876 /* handshakes_since_cache_flush is the number of successful handshakes since
877 * the last cache flush. */
878 int handshakes_since_cache_flush;
879
Adam Langleyb4a494c2015-01-23 15:10:10 -0800880 /* This can have one of 2 values, ored together,
881 * SSL_SESS_CACHE_CLIENT,
882 * SSL_SESS_CACHE_SERVER,
883 * Default is SSL_SESSION_CACHE_SERVER, which means only
884 * SSL_accept which cache SSL_SESSIONS. */
885 int session_cache_mode;
Adam Langley95c29f32014-06-20 12:00:00 -0700886
Adam Langleyb4a494c2015-01-23 15:10:10 -0800887 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
888 * called. This has been put in to make life easier to set things up */
889 long session_timeout;
Adam Langley95c29f32014-06-20 12:00:00 -0700890
Adam Langleyb4a494c2015-01-23 15:10:10 -0800891 /* If this callback is not null, it will be called each time a session id is
892 * added to the cache. If this function returns 1, it means that the
893 * callback will do a SSL_SESSION_free() when it has finished using it.
894 * Otherwise, on 0, it means the callback has finished with it. If
895 * remove_session_cb is not null, it will be called when a session-id is
896 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
897 * it. */
David Benjamin4dab2972015-05-16 02:56:06 -0400898 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
899 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
900 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -0800901 int *copy);
Adam Langley95c29f32014-06-20 12:00:00 -0700902
Adam Langley0b5e3902015-05-15 13:08:38 -0700903 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -0700904
Adam Langleyb4a494c2015-01-23 15:10:10 -0800905 /* if defined, these override the X509_verify_cert() calls */
906 int (*app_verify_callback)(X509_STORE_CTX *, void *);
907 void *app_verify_arg;
908 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
909 * was called with just one argument) */
Adam Langley95c29f32014-06-20 12:00:00 -0700910
Adam Langleyb4a494c2015-01-23 15:10:10 -0800911 /* Default password callback. */
912 pem_password_cb *default_passwd_callback;
Adam Langley95c29f32014-06-20 12:00:00 -0700913
Adam Langleyb4a494c2015-01-23 15:10:10 -0800914 /* Default password callback user data. */
915 void *default_passwd_callback_userdata;
Adam Langley95c29f32014-06-20 12:00:00 -0700916
Adam Langleyb4a494c2015-01-23 15:10:10 -0800917 /* get client cert callback */
918 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
Adam Langley95c29f32014-06-20 12:00:00 -0700919
Adam Langleyb4a494c2015-01-23 15:10:10 -0800920 /* get channel id callback */
921 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
Adam Langley1258b6a2014-06-20 12:00:00 -0700922
Adam Langleyb4a494c2015-01-23 15:10:10 -0800923 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -0700924
Adam Langleyb4a494c2015-01-23 15:10:10 -0800925 STACK_OF(X509) *extra_certs;
Adam Langley95c29f32014-06-20 12:00:00 -0700926
927
Adam Langleyb4a494c2015-01-23 15:10:10 -0800928 /* Default values used when no per-SSL value is defined follow */
Adam Langley95c29f32014-06-20 12:00:00 -0700929
Adam Langleyb4a494c2015-01-23 15:10:10 -0800930 void (*info_callback)(const SSL *ssl, int type,
931 int val); /* used if SSL's info_callback is NULL */
Adam Langley95c29f32014-06-20 12:00:00 -0700932
Adam Langleyb4a494c2015-01-23 15:10:10 -0800933 /* what we put in client cert requests */
934 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -0700935
936
Adam Langleyb4a494c2015-01-23 15:10:10 -0800937 /* Default values to use in SSL structures follow (these are copied by
938 * SSL_new) */
Adam Langley95c29f32014-06-20 12:00:00 -0700939
David Benjamin123a8fd2015-04-26 14:16:41 -0400940 uint32_t options;
941 uint32_t mode;
David Benjamin1d0a1942015-04-26 15:35:35 -0400942 uint32_t max_cert_list;
Adam Langley95c29f32014-06-20 12:00:00 -0700943
Adam Langleyb4a494c2015-01-23 15:10:10 -0800944 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -0700945
Adam Langleyb4a494c2015-01-23 15:10:10 -0800946 /* callback that allows applications to peek at protocol messages */
947 void (*msg_callback)(int write_p, int version, int content_type,
948 const void *buf, size_t len, SSL *ssl, void *arg);
949 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -0700950
Adam Langleyb4a494c2015-01-23 15:10:10 -0800951 int verify_mode;
952 unsigned int sid_ctx_length;
953 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
954 int (*default_verify_callback)(
955 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
Adam Langley95c29f32014-06-20 12:00:00 -0700956
Adam Langleyb4a494c2015-01-23 15:10:10 -0800957 /* Default generate session ID callback. */
958 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -0700959
Adam Langleyb4a494c2015-01-23 15:10:10 -0800960 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -0700961
Adam Langleyb4a494c2015-01-23 15:10:10 -0800962 /* select_certificate_cb is called before most ClientHello processing and
963 * before the decision whether to resume a session is made. It may return one
964 * to continue the handshake or zero to cause the handshake loop to return
965 * with an error and cause SSL_get_error to return
David Benjamin6f5c0f42015-02-24 01:23:21 -0500966 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
967 * will not call the callback a second time. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800968 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
Adam Langleydc9b1412014-06-20 12:00:00 -0700969
Adam Langley524e7172015-02-20 16:04:00 -0800970 /* dos_protection_cb is called once the resumption decision for a ClientHello
971 * has been made. It returns one to continue the handshake or zero to
972 * abort. */
973 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
974
Adam Langleyb4a494c2015-01-23 15:10:10 -0800975 /* quiet_shutdown is true if the connection should not send a close_notify on
976 * shutdown. */
977 int quiet_shutdown;
Adam Langley95c29f32014-06-20 12:00:00 -0700978
Adam Langleyb4a494c2015-01-23 15:10:10 -0800979 /* Maximum amount of data to send in one fragment. actual record size can be
980 * more than this due to padding and MAC overheads. */
David Benjamin1d0a1942015-04-26 15:35:35 -0400981 uint16_t max_send_fragment;
Adam Langley95c29f32014-06-20 12:00:00 -0700982
Adam Langleyb4a494c2015-01-23 15:10:10 -0800983 /* TLS extensions servername callback */
984 int (*tlsext_servername_callback)(SSL *, int *, void *);
985 void *tlsext_servername_arg;
986 /* RFC 4507 session ticket keys */
987 uint8_t tlsext_tick_key_name[16];
988 uint8_t tlsext_tick_hmac_key[16];
989 uint8_t tlsext_tick_aes_key[16];
990 /* Callback to support customisation of ticket key setting */
991 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
992 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
Adam Langley95c29f32014-06-20 12:00:00 -0700993
Adam Langleyb4a494c2015-01-23 15:10:10 -0800994 /* Server-only: psk_identity_hint is the default identity hint to send in
995 * PSK-based key exchanges. */
996 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -0700997
Adam Langleyb4a494c2015-01-23 15:10:10 -0800998 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
999 char *identity,
1000 unsigned int max_identity_len,
1001 uint8_t *psk, unsigned int max_psk_len);
1002 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1003 uint8_t *psk, unsigned int max_psk_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001004
Alex Chernyakhovskya40c8622014-08-03 15:46:36 -04001005
Adam Langleyb4a494c2015-01-23 15:10:10 -08001006 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
1007 * hash of the peer's certifiate and then discard it to save memory and
1008 * session space. Only effective on the server side. */
1009 char retain_only_sha256_of_client_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001010
Adam Langleyb4a494c2015-01-23 15:10:10 -08001011 /* Next protocol negotiation information */
1012 /* (for experimental NPN extension). */
Adam Langley95c29f32014-06-20 12:00:00 -07001013
Adam Langleyb4a494c2015-01-23 15:10:10 -08001014 /* For a server, this contains a callback function by which the set of
1015 * advertised protocols can be provided. */
1016 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
1017 unsigned int *len, void *arg);
1018 void *next_protos_advertised_cb_arg;
1019 /* For a client, this contains a callback function that selects the
1020 * next protocol from the list provided by the server. */
1021 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
1022 const uint8_t *in, unsigned int inlen, void *arg);
1023 void *next_proto_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001024
Adam Langleyb4a494c2015-01-23 15:10:10 -08001025 /* ALPN information
1026 * (we are in the process of transitioning from NPN to ALPN.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001027
Adam Langleyb4a494c2015-01-23 15:10:10 -08001028 /* For a server, this contains a callback function that allows the
1029 * server to select the protocol for the connection.
1030 * out: on successful return, this must point to the raw protocol
1031 * name (without the length prefix).
1032 * outlen: on successful return, this contains the length of |*out|.
1033 * in: points to the client's list of supported protocols in
1034 * wire-format.
1035 * inlen: the length of |in|. */
1036 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
1037 const uint8_t *in, unsigned int inlen, void *arg);
1038 void *alpn_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001039
Adam Langleyb4a494c2015-01-23 15:10:10 -08001040 /* For a client, this contains the list of supported protocols in wire
1041 * format. */
1042 uint8_t *alpn_client_proto_list;
1043 unsigned alpn_client_proto_list_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001044
Adam Langleyb4a494c2015-01-23 15:10:10 -08001045 /* SRTP profiles we are willing to do from RFC 5764 */
1046 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001047
Adam Langleyb4a494c2015-01-23 15:10:10 -08001048 /* EC extension values inherited by SSL structure */
1049 size_t tlsext_ecpointformatlist_length;
1050 uint8_t *tlsext_ecpointformatlist;
1051 size_t tlsext_ellipticcurvelist_length;
1052 uint16_t *tlsext_ellipticcurvelist;
Adam Langley1258b6a2014-06-20 12:00:00 -07001053
Adam Langleyb4a494c2015-01-23 15:10:10 -08001054 /* If true, a client will advertise the Channel ID extension and a server
1055 * will echo it. */
1056 char tlsext_channel_id_enabled;
1057 /* tlsext_channel_id_enabled_new is a hack to support both old and new
1058 * ChannelID signatures. It indicates that a client should advertise the new
1059 * ChannelID extension number. */
1060 char tlsext_channel_id_enabled_new;
1061 /* The client's Channel ID private key. */
1062 EVP_PKEY *tlsext_channel_id_private;
David Benjamin6c7aed02014-08-27 16:42:38 -04001063
Adam Langleyb4a494c2015-01-23 15:10:10 -08001064 /* If true, a client will request certificate timestamps. */
1065 char signed_cert_timestamps_enabled;
David Benjamin859ec3c2014-09-02 16:29:36 -04001066
Adam Langleyb4a494c2015-01-23 15:10:10 -08001067 /* If true, a client will request a stapled OCSP response. */
1068 char ocsp_stapling_enabled;
Adam Langley95c29f32014-06-20 12:00:00 -07001069
Adam Langleyb4a494c2015-01-23 15:10:10 -08001070 /* If not NULL, session key material will be logged to this BIO for debugging
1071 * purposes. The format matches NSS's and is readable by Wireshark. */
1072 BIO *keylog_bio;
David Benjamin377fc312015-01-26 00:22:12 -05001073
1074 /* current_time_cb, if not NULL, is the function to use to get the current
1075 * time. It sets |*out_clock| to the current time. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001076 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001077};
Adam Langley95c29f32014-06-20 12:00:00 -07001078
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001079OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001080
1081/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1082 * session cache. */
1083OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001084
Adam Langleyb4a494c2015-01-23 15:10:10 -08001085OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001086 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1087OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001088 SSL_SESSION *sess);
1089OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1090 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001091 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001092OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001093 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001094OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1095 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001096 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001097 int *copy));
1098OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001099 SSL *ssl, uint8_t *data, int len, int *copy);
Adam Langleyb2ce0582014-06-20 12:00:00 -07001100/* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
1101 * that the session isn't currently unavailable. SSL_get_error will then return
1102 * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
1103 * lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001104OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001105OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1106 void (*cb)(const SSL *ssl,
1107 int type, int val));
1108OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1109 int type,
1110 int val);
1111OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1112 SSL_CTX *ctx,
1113 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1114OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1115 X509 **x509,
1116 EVP_PKEY **pkey);
1117OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1118 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1119OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1120 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001121
Adam Langleyb4a494c2015-01-23 15:10:10 -08001122/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1123 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001124 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001125OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1126
Adam Langleyb4a494c2015-01-23 15:10:10 -08001127/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1128 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001129OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1130
David Benjamin3b7456e2015-05-16 12:29:32 -04001131/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1132 * connection) to request a stapled OCSP response from the server. It returns
1133 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001134OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1135
1136/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1137 * created from |ctx|. */
1138OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1139
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001140/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1141 * |*out_len| bytes of SCT information from the server. This is only valid if
1142 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1143 * (including the two leading length bytes).
1144 * See https://tools.ietf.org/html/rfc6962#section-3.3
1145 * If no SCT was received then |*out_len| will be zero on return.
1146 *
1147 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001148OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001149 const uint8_t **out,
1150 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001151
David Benjamin6c7aed02014-08-27 16:42:38 -04001152/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1153 * bytes of an OCSP response from the server. This is the DER encoding of an
1154 * OCSPResponse type as defined in RFC 2560.
1155 *
1156 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001157OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1158 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001159
Adam Langleyb4a494c2015-01-23 15:10:10 -08001160OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1161 SSL_CTX *s,
1162 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1163 void *arg);
1164OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1165 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1166 const uint8_t *in, unsigned int inlen, void *arg),
1167 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001168OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001169 const uint8_t **data,
1170 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001171
Adam Langleyb4a494c2015-01-23 15:10:10 -08001172OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1173 const uint8_t *in, unsigned int inlen,
1174 const uint8_t *client,
1175 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001176
Adam Langleyb4a494c2015-01-23 15:10:10 -08001177#define OPENSSL_NPN_UNSUPPORTED 0
1178#define OPENSSL_NPN_NEGOTIATED 1
1179#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001180
David Benjamin9d0847a2015-02-16 03:57:55 -05001181/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1182 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1183 * length-prefixed strings). It returns zero on success and one on failure.
1184 *
1185 * WARNING: this function is dangerous because it breaks the usual return value
1186 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001187OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1188 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001189
1190/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1191 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1192 * length-prefixed strings). It returns zero on success and one on failure.
1193 *
1194 * WARNING: this function is dangerous because it breaks the usual return value
1195 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001196OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1197 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001198
Adam Langleyb4a494c2015-01-23 15:10:10 -08001199OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1200 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1201 const uint8_t *in, unsigned int inlen, void *arg),
1202 void *arg);
1203OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1204 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001205
1206/* SSL_enable_fastradio_padding controls whether fastradio padding is enabled
1207 * on |ssl|. If it is, ClientHello messages are padded to 1024 bytes. This
1208 * causes 3G radios to switch to DCH mode (high data rate). */
1209OPENSSL_EXPORT void SSL_enable_fastradio_padding(SSL *ssl, char on_off);
1210
David Benjaminb16346b2015-04-08 19:16:58 -04001211/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1212 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001213 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001214 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001215OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1216
Adam Langleyb4a494c2015-01-23 15:10:10 -08001217/* the maximum length of the buffer given to callbacks containing the resulting
1218 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001219#define PSK_MAX_IDENTITY_LEN 128
1220#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001221OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1222 SSL_CTX *ctx,
1223 unsigned int (*psk_client_callback)(
1224 SSL *ssl, const char *hint, char *identity,
1225 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1226OPENSSL_EXPORT void SSL_set_psk_client_callback(
1227 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1228 char *identity,
1229 unsigned int max_identity_len,
1230 uint8_t *psk,
1231 unsigned int max_psk_len));
1232OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1233 SSL_CTX *ctx,
1234 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1235 uint8_t *psk,
1236 unsigned int max_psk_len));
1237OPENSSL_EXPORT void SSL_set_psk_server_callback(
1238 SSL *ssl,
1239 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1240 uint8_t *psk,
1241 unsigned int max_psk_len));
1242OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1243 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001244OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1245OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1246OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001247
Adam Langleyb4a494c2015-01-23 15:10:10 -08001248#define SSL_NOTHING 1
1249#define SSL_WRITING 2
1250#define SSL_READING 3
1251#define SSL_X509_LOOKUP 4
1252#define SSL_CHANNEL_ID_LOOKUP 5
1253#define SSL_PENDING_SESSION 7
1254#define SSL_CERTIFICATE_SELECTION_PENDING 8
Adam Langley95c29f32014-06-20 12:00:00 -07001255
1256/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001257#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1258#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1259#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1260#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1261#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1262#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1263#define SSL_want_certificate(s) \
1264 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
Adam Langley95c29f32014-06-20 12:00:00 -07001265
Adam Langleyb4a494c2015-01-23 15:10:10 -08001266struct ssl_st {
1267 /* version is the protocol version. */
1268 int version;
Adam Langley95c29f32014-06-20 12:00:00 -07001269
Adam Langleyb4a494c2015-01-23 15:10:10 -08001270 /* method is the method table corresponding to the current protocol (DTLS or
1271 * TLS). */
1272 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001273
Adam Langleyb4a494c2015-01-23 15:10:10 -08001274 /* enc_method is the method table corresponding to the current protocol
1275 * version. */
1276 const SSL3_ENC_METHOD *enc_method;
David Benjamine99e9122014-12-11 01:46:01 -05001277
Adam Langleyb4a494c2015-01-23 15:10:10 -08001278 /* max_version is the maximum acceptable protocol version. If zero, the
1279 * maximum supported version, currently (D)TLS 1.2, is used. */
1280 uint16_t max_version;
Adam Langley95c29f32014-06-20 12:00:00 -07001281
Adam Langleyb4a494c2015-01-23 15:10:10 -08001282 /* min_version is the minimum acceptable protocl version. If zero, the
1283 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1284 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001285
Adam Langleyb4a494c2015-01-23 15:10:10 -08001286 /* There are 2 BIO's even though they are normally both the same. This is so
1287 * data can be read and written to different handlers */
David Benjamin1eb367c2014-12-12 18:17:51 -05001288
Adam Langleyb4a494c2015-01-23 15:10:10 -08001289 BIO *rbio; /* used by SSL_read */
1290 BIO *wbio; /* used by SSL_write */
1291 BIO *bbio; /* used during session-id reuse to concatenate
1292 * messages */
Adam Langley95c29f32014-06-20 12:00:00 -07001293
Adam Langleyb4a494c2015-01-23 15:10:10 -08001294 /* This holds a variable that indicates what we were doing when a 0 or -1 is
1295 * returned. This is needed for non-blocking IO so we know what request
1296 * needs re-doing when in SSL_accept or SSL_connect */
1297 int rwstate;
David Benjamin95f9cfc2014-11-23 00:19:49 -05001298
Adam Langleyb4a494c2015-01-23 15:10:10 -08001299 /* true when we are actually in SSL_accept() or SSL_connect() */
1300 int in_handshake;
1301 int (*handshake_func)(SSL *);
Adam Langley95c29f32014-06-20 12:00:00 -07001302
Adam Langleyb4a494c2015-01-23 15:10:10 -08001303 /* Imagine that here's a boolean member "init" that is switched as soon as
1304 * SSL_set_{accept/connect}_state is called for the first time, so that
1305 * "state" and "handshake_func" are properly initialized. But as
1306 * handshake_func is == 0 until then, we use this test instead of an "init"
1307 * member. */
Adam Langley95c29f32014-06-20 12:00:00 -07001308
Adam Langleyb4a494c2015-01-23 15:10:10 -08001309 /* server is true iff the this SSL* is the server half. Note: before the SSL*
1310 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
1311 * the side is not determined. In this state, server is always false. */
1312 int server;
Adam Langley95c29f32014-06-20 12:00:00 -07001313
Adam Langleyb4a494c2015-01-23 15:10:10 -08001314 /* quiet_shutdown is true if the connection should not send a close_notify on
1315 * shutdown. */
1316 int quiet_shutdown;
David Benjamin7e237462014-12-11 18:13:28 -05001317
Adam Langleyb4a494c2015-01-23 15:10:10 -08001318 int shutdown; /* we have shut things down, 0x01 sent, 0x02
1319 * for received */
1320 int state; /* where we are */
1321 int rstate; /* where we are when reading */
Adam Langley95c29f32014-06-20 12:00:00 -07001322
Adam Langleyb4a494c2015-01-23 15:10:10 -08001323 BUF_MEM *init_buf; /* buffer used during init */
1324 uint8_t *init_msg; /* pointer to handshake message body, set by
1325 ssl3_get_message() */
1326 int init_num; /* amount read/written */
1327 int init_off; /* amount read/written */
Adam Langley95c29f32014-06-20 12:00:00 -07001328
Adam Langleyb4a494c2015-01-23 15:10:10 -08001329 /* used internally to point at a raw packet */
1330 uint8_t *packet;
1331 unsigned int packet_length;
Adam Langley95c29f32014-06-20 12:00:00 -07001332
Adam Langleyb4a494c2015-01-23 15:10:10 -08001333 struct ssl3_state_st *s3; /* SSLv3 variables */
1334 struct dtls1_state_st *d1; /* DTLSv1 variables */
Adam Langley95c29f32014-06-20 12:00:00 -07001335
Adam Langleyb4a494c2015-01-23 15:10:10 -08001336 /* callback that allows applications to peek at protocol messages */
1337 void (*msg_callback)(int write_p, int version, int content_type,
1338 const void *buf, size_t len, SSL *ssl, void *arg);
1339 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001340
Adam Langleyb4a494c2015-01-23 15:10:10 -08001341 int hit; /* reusing a previous session */
Adam Langley95c29f32014-06-20 12:00:00 -07001342
Adam Langleyb4a494c2015-01-23 15:10:10 -08001343 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001344
Adam Langleyb4a494c2015-01-23 15:10:10 -08001345 /* crypto */
1346 struct ssl_cipher_preference_list_st *cipher_list;
1347 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001348
Adam Langleyb4a494c2015-01-23 15:10:10 -08001349 SSL_AEAD_CTX *aead_read_ctx;
1350 SSL_AEAD_CTX *aead_write_ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001351
Adam Langleyb4a494c2015-01-23 15:10:10 -08001352 /* session info */
Adam Langley95c29f32014-06-20 12:00:00 -07001353
Adam Langleyb4a494c2015-01-23 15:10:10 -08001354 /* client cert? */
1355 /* This is used to hold the server certificate used */
1356 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001357
Adam Langleyb4a494c2015-01-23 15:10:10 -08001358 /* the session_id_context is used to ensure sessions are only reused
1359 * in the appropriate context */
1360 unsigned int sid_ctx_length;
1361 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001362
Adam Langleyb4a494c2015-01-23 15:10:10 -08001363 /* This can also be in the session once a session is established */
1364 SSL_SESSION *session;
Adam Langley95c29f32014-06-20 12:00:00 -07001365
Adam Langleyb4a494c2015-01-23 15:10:10 -08001366 /* Default generate session ID callback. */
1367 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001368
Adam Langleyb4a494c2015-01-23 15:10:10 -08001369 /* Used in SSL2 and SSL3 */
1370 int verify_mode; /* 0 don't care about verify failure.
1371 * 1 fail if verify fails */
1372 int (*verify_callback)(int ok,
1373 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
Adam Langley95c29f32014-06-20 12:00:00 -07001374
Adam Langleyb4a494c2015-01-23 15:10:10 -08001375 void (*info_callback)(const SSL *ssl, int type,
1376 int val); /* optional informational callback */
Adam Langley95c29f32014-06-20 12:00:00 -07001377
Adam Langleyb4a494c2015-01-23 15:10:10 -08001378 /* Server-only: psk_identity_hint is the identity hint to send in
1379 * PSK-based key exchanges. */
1380 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001381
Adam Langleyb4a494c2015-01-23 15:10:10 -08001382 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1383 char *identity,
1384 unsigned int max_identity_len,
1385 uint8_t *psk, unsigned int max_psk_len);
1386 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1387 uint8_t *psk, unsigned int max_psk_len);
David Benjamin688d8df2014-11-02 23:06:42 -05001388
Adam Langleyb4a494c2015-01-23 15:10:10 -08001389 SSL_CTX *ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001390
Adam Langleyb4a494c2015-01-23 15:10:10 -08001391 /* extra application data */
1392 long verify_result;
1393 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001394
Adam Langleyb4a494c2015-01-23 15:10:10 -08001395 /* for server side, keep the list of CA_dn we can use */
1396 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001397
David Benjamin123a8fd2015-04-26 14:16:41 -04001398 uint32_t options; /* protocol behaviour */
1399 uint32_t mode; /* API behaviour */
David Benjamin1d0a1942015-04-26 15:35:35 -04001400 uint32_t max_cert_list;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001401 int client_version; /* what was passed, used for
1402 * SSLv3/TLS rollback check */
David Benjamin1d0a1942015-04-26 15:35:35 -04001403 uint16_t max_send_fragment;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001404 char *tlsext_hostname;
1405 /* should_ack_sni is true if the SNI extension should be acked. This is
1406 * only used by a server. */
1407 char should_ack_sni;
1408 /* RFC4507 session ticket expected to be received or sent */
1409 int tlsext_ticket_expected;
1410 size_t tlsext_ecpointformatlist_length;
1411 uint8_t *tlsext_ecpointformatlist; /* our list */
1412 size_t tlsext_ellipticcurvelist_length;
1413 uint16_t *tlsext_ellipticcurvelist; /* our list */
Adam Langley95c29f32014-06-20 12:00:00 -07001414
Adam Langleyb4a494c2015-01-23 15:10:10 -08001415 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
Adam Langley95c29f32014-06-20 12:00:00 -07001416
Adam Langleyb4a494c2015-01-23 15:10:10 -08001417 /* Next protocol negotiation. For the client, this is the protocol that we
1418 * sent in NextProtocol and is set when handling ServerHello extensions.
1419 *
1420 * For a server, this is the client's selected_protocol from NextProtocol and
1421 * is set when handling the NextProtocol message, before the Finished
1422 * message. */
1423 uint8_t *next_proto_negotiated;
1424 size_t next_proto_negotiated_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001425
Adam Langleyb4a494c2015-01-23 15:10:10 -08001426 /* srtp_profiles is the list of configured SRTP protection profiles for
1427 * DTLS-SRTP. */
1428 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001429
Adam Langleyb4a494c2015-01-23 15:10:10 -08001430 /* srtp_profile is the selected SRTP protection profile for
1431 * DTLS-SRTP. */
1432 const SRTP_PROTECTION_PROFILE *srtp_profile;
David Benjaminbc44c082015-01-01 15:02:11 -05001433
Adam Langleyb4a494c2015-01-23 15:10:10 -08001434 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
1435 * from clients. For a client, means that we'll advertise support. */
1436 char tlsext_channel_id_enabled;
1437 /* The client's Channel ID private key. */
1438 EVP_PKEY *tlsext_channel_id_private;
Adam Langley95c29f32014-06-20 12:00:00 -07001439
Adam Langleyb4a494c2015-01-23 15:10:10 -08001440 /* Enable signed certificate time stamps. Currently client only. */
1441 char signed_cert_timestamps_enabled;
Adam Langley1258b6a2014-06-20 12:00:00 -07001442
Adam Langleyb4a494c2015-01-23 15:10:10 -08001443 /* Enable OCSP stapling. Currently client only.
1444 * TODO(davidben): Add a server-side implementation when it becomes
1445 * necesary. */
1446 char ocsp_stapling_enabled;
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001447
Adam Langleyb4a494c2015-01-23 15:10:10 -08001448 /* For a client, this contains the list of supported protocols in wire
1449 * format. */
1450 uint8_t *alpn_client_proto_list;
1451 unsigned alpn_client_proto_list_len;
David Benjamin6c7aed02014-08-27 16:42:38 -04001452
Adam Langleyb4a494c2015-01-23 15:10:10 -08001453 /* fastradio_padding, if true, causes ClientHellos to be padded to 1024
1454 * bytes. This ensures that the cellular radio is fast forwarded to DCH (high
1455 * data rate) state in 3G networks. */
1456 char fastradio_padding;
Feng Lu41aa3252014-11-21 22:47:56 -08001457
David Benjamin897e5e02015-05-12 17:03:54 -04001458 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
1459 * peer. Otherwise, they will be rejected with a fatal error. */
1460 char accept_peer_renegotiations;
David Benjaminb16346b2015-04-08 19:16:58 -04001461
Adam Langleyb4a494c2015-01-23 15:10:10 -08001462 /* These fields are always NULL and exist only to keep wpa_supplicant happy
1463 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
1464 * don't support. */
1465 EVP_CIPHER_CTX *enc_read_ctx;
1466 EVP_MD_CTX *read_hash;
1467};
Adam Langley95c29f32014-06-20 12:00:00 -07001468
Adam Langley95c29f32014-06-20 12:00:00 -07001469/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001470#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
1471#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
1472#define SSL_SESSION_set_app_data(s, a) \
1473 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
1474#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
1475#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
1476#define SSL_CTX_set_app_data(ctx, arg) \
1477 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07001478
Adam Langleyb4a494c2015-01-23 15:10:10 -08001479/* The following are the possible values for ssl->state are are used to
1480 * indicate where we are up to in the SSL connection establishment. The macros
1481 * that follow are about the only things you should need to use and even then,
1482 * only when using non-blocking IO. It can also be useful to work out where you
1483 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07001484
Adam Langleyb4a494c2015-01-23 15:10:10 -08001485#define SSL_ST_CONNECT 0x1000
1486#define SSL_ST_ACCEPT 0x2000
1487#define SSL_ST_MASK 0x0FFF
1488#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001489#define SSL_ST_OK 0x03
1490#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07001491
Adam Langleyb4a494c2015-01-23 15:10:10 -08001492#define SSL_CB_LOOP 0x01
1493#define SSL_CB_EXIT 0x02
1494#define SSL_CB_READ 0x04
1495#define SSL_CB_WRITE 0x08
1496#define SSL_CB_ALERT 0x4000 /* used in callback */
1497#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
1498#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
1499#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
1500#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
1501#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
1502#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
1503#define SSL_CB_HANDSHAKE_START 0x10
1504#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07001505
1506/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001507#define SSL_get_state(a) SSL_state(a)
1508#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05001509#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001510#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
1511#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05001512
David Benjamined7c4752015-02-16 19:16:46 -05001513/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
1514 * is in False Start. |SSL_write| may be called at this point without waiting
1515 * for the peer, but |SSL_read| will require the handshake to be completed. */
1516OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
1517
Adam Langley95c29f32014-06-20 12:00:00 -07001518/* The following 2 states are kept in ssl->rstate when reads fail,
1519 * you should not need these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001520#define SSL_ST_READ_HEADER 0xF0
1521#define SSL_ST_READ_BODY 0xF1
1522#define SSL_ST_READ_DONE 0xF2
Adam Langley95c29f32014-06-20 12:00:00 -07001523
1524/* Obtain latest Finished message
1525 * -- that we sent (SSL_get_finished)
1526 * -- that we expected from peer (SSL_get_peer_finished).
1527 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001528OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1529OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07001530
Adam Langley509e5ed2014-06-20 12:00:00 -07001531/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07001532 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001533#define SSL_VERIFY_NONE 0x00
1534#define SSL_VERIFY_PEER 0x01
1535#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
1536#define SSL_VERIFY_CLIENT_ONCE 0x04
1537#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07001538
Adam Langleyb4a494c2015-01-23 15:10:10 -08001539#define OpenSSL_add_ssl_algorithms() SSL_library_init()
1540#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07001541
Adam Langleyb4a494c2015-01-23 15:10:10 -08001542/* For backward compatibility */
1543#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1544#define SSL_get_cipher_bits(s, np) \
1545 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07001546#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001547 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1548#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1549#define SSL_get_time(a) SSL_SESSION_get_time(a)
1550#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
1551#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
1552#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07001553
Adam Langleyb4a494c2015-01-23 15:10:10 -08001554#define d2i_SSL_SESSION_bio(bp, s_id) \
1555 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
1556#define i2d_SSL_SESSION_bio(bp, s_id) \
1557 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07001558
1559DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1560
Adam Langleyb4a494c2015-01-23 15:10:10 -08001561/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
1562 * This value must be kept in sync with reservedReasonCode in make_errors.h */
1563#define SSL_AD_REASON_OFFSET \
1564 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07001565
1566/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001567#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
1568#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
1569#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
1570#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
1571#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
1572#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
1573#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
1574#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
1575#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
1576#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
1577#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
1578#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
1579#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
1580#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
1581#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
1582#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
1583#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
1584#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
1585#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
1586#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
1587#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
1588#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
1589#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
1590#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
1591#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07001592#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001593#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
1594#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
1595 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07001596#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001597#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
1598#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07001599
Adam Langleyb4a494c2015-01-23 15:10:10 -08001600#define SSL_ERROR_NONE 0
1601#define SSL_ERROR_SSL 1
1602#define SSL_ERROR_WANT_READ 2
1603#define SSL_ERROR_WANT_WRITE 3
1604#define SSL_ERROR_WANT_X509_LOOKUP 4
1605#define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
1606#define SSL_ERROR_ZERO_RETURN 6
1607#define SSL_ERROR_WANT_CONNECT 7
1608#define SSL_ERROR_WANT_ACCEPT 8
1609#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
1610#define SSL_ERROR_PENDING_SESSION 11
1611#define SSL_ERROR_PENDING_CERTIFICATE 12
Adam Langley95c29f32014-06-20 12:00:00 -07001612
Adam Langleyb4a494c2015-01-23 15:10:10 -08001613#define SSL_CTRL_EXTRA_CHAIN_CERT 14
Adam Langley95c29f32014-06-20 12:00:00 -07001614
Adam Langley95c29f32014-06-20 12:00:00 -07001615/* see tls1.h for macros based on these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001616#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS 58
1617#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS 59
Adam Langley95c29f32014-06-20 12:00:00 -07001618
Adam Langleyb4a494c2015-01-23 15:10:10 -08001619#define SSL_CTRL_SET_SRP_ARG 78
1620#define SSL_CTRL_SET_TLS_EXT_SRP_USERNAME 79
1621#define SSL_CTRL_SET_TLS_EXT_SRP_STRENGTH 80
1622#define SSL_CTRL_SET_TLS_EXT_SRP_PASSWORD 81
Adam Langley95c29f32014-06-20 12:00:00 -07001623
Adam Langleyb4a494c2015-01-23 15:10:10 -08001624#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS 82
1625#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS 83
Adam Langley95c29f32014-06-20 12:00:00 -07001626
Adam Langleyb4a494c2015-01-23 15:10:10 -08001627#define SSL_CTRL_CHAIN 88
1628#define SSL_CTRL_CHAIN_CERT 89
Adam Langley95c29f32014-06-20 12:00:00 -07001629
Adam Langleyb4a494c2015-01-23 15:10:10 -08001630#define SSL_CTRL_GET_CURVES 90
1631#define SSL_CTRL_SET_CURVES 91
1632#define SSL_CTRL_SET_CURVES_LIST 92
Adam Langleyb4a494c2015-01-23 15:10:10 -08001633#define SSL_CTRL_SET_SIGALGS 97
1634#define SSL_CTRL_SET_SIGALGS_LIST 98
Adam Langleyb4a494c2015-01-23 15:10:10 -08001635#define SSL_CTRL_SET_CLIENT_SIGALGS 101
1636#define SSL_CTRL_SET_CLIENT_SIGALGS_LIST 102
1637#define SSL_CTRL_GET_CLIENT_CERT_TYPES 103
1638#define SSL_CTRL_SET_CLIENT_CERT_TYPES 104
1639#define SSL_CTRL_BUILD_CERT_CHAIN 105
1640#define SSL_CTRL_SET_VERIFY_CERT_STORE 106
1641#define SSL_CTRL_SET_CHAIN_CERT_STORE 107
1642#define SSL_CTRL_GET_SERVER_TMP_KEY 109
Adam Langleyb4a494c2015-01-23 15:10:10 -08001643#define SSL_CTRL_GET_EC_POINT_FORMATS 111
Adam Langley95c29f32014-06-20 12:00:00 -07001644
Adam Langleyb4a494c2015-01-23 15:10:10 -08001645#define SSL_CTRL_GET_CHAIN_CERTS 115
1646#define SSL_CTRL_SELECT_CURRENT_CERT 116
Adam Langley95c29f32014-06-20 12:00:00 -07001647
David Benjamin377fc312015-01-26 00:22:12 -05001648/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04001649 * timeout in progress, it sets |*out| to the time remaining and returns one.
1650 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05001651 *
1652 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
1653 * retransmit behavior.
1654 *
1655 * NOTE: This function must be queried again whenever the handshake state
1656 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001657OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05001658
1659/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
1660 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
1661 * flight of handshake messages and returns 1. If too many timeouts had expired
1662 * without progress or an error occurs, it returns -1.
1663 *
1664 * NOTE: The caller's external timer should be compatible with the one |ssl|
1665 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04001666 * |DTLSv1_get_timeout| will return an updated timeout.
1667 *
1668 * WARNING: This function breaks the usual return value convention. */
1669OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001670
David Benjaminc0454692015-04-27 00:28:56 -04001671/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1672 * and zero otherwise.
1673 *
1674 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1675 * initial or renego, is in progress. */
1676OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001677
David Benjaminc0454692015-04-27 00:28:56 -04001678/* SSL_total_renegotiations returns the total number of renegotiation handshakes
1679 * peformed by |ssl|. This includes the pending renegotiation, if any. */
1680OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
1681
David Benjamin15a3b002015-04-28 00:05:35 -04001682/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1683 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1684 * one on success and zero on error. */
1685OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04001686
David Benjamin15a3b002015-04-28 00:05:35 -04001687/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1688 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1689 * on success and zero on error. */
1690OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07001691
David Benjamin15a3b002015-04-28 00:05:35 -04001692/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1693 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1694 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1695 * error. If unset, an appropriate curve will be chosen automatically. (This is
1696 * recommended.) */
1697OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04001698
David Benjamin15a3b002015-04-28 00:05:35 -04001699/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1700 * for ephemeral ECDH keys. For historical reasons, this API expects an
1701 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1702 * error. If unset, an appropriate curve will be chosen automatically. (This is
1703 * recommended.) */
1704OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07001705
David Benjaminc2807582015-04-28 00:19:50 -04001706/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
1707 * client IDs from clients, or configures a client to send TLS client IDs to
1708 * a server. It returns one. */
1709OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
1710
Adam Langleyb4a494c2015-01-23 15:10:10 -08001711/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
1712 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04001713 * server. It returns one. */
1714OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
1715
1716/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
1717 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
1718 * on success and zero on error. */
1719OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
1720 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001721
Adam Langley1258b6a2014-06-20 12:00:00 -07001722/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04001723 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
1724 * success and zero on error. */
1725OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001726
Adam Langley1258b6a2014-06-20 12:00:00 -07001727/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04001728 * and copies up to the first |max_out| bytes into |out|. The Channel ID
1729 * consists of the client's P-256 public key as an (x,y) pair where each is a
1730 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
1731 * Channel ID and the length of the complete Channel ID otherwise. */
1732OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
1733 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07001734
Adam Langleyb4a494c2015-01-23 15:10:10 -08001735#define SSL_CTX_add_extra_chain_cert(ctx, x509) \
1736 SSL_CTX_ctrl(ctx, SSL_CTRL_EXTRA_CHAIN_CERT, 0, (char *)x509)
1737#define SSL_CTX_get_extra_chain_certs(ctx, px509) \
1738 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_EXTRA_CHAIN_CERTS, 0, px509)
1739#define SSL_CTX_get_extra_chain_certs_only(ctx, px509) \
1740 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_EXTRA_CHAIN_CERTS, 1, px509)
Adam Langley95c29f32014-06-20 12:00:00 -07001741#define SSL_CTX_clear_extra_chain_certs(ctx) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001742 SSL_CTX_ctrl(ctx, SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS, 0, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001743
Adam Langleyb4a494c2015-01-23 15:10:10 -08001744#define SSL_CTX_set0_chain(ctx, sk) \
1745 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN, 0, (char *)sk)
1746#define SSL_CTX_set1_chain(ctx, sk) \
1747 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN, 1, (char *)sk)
1748#define SSL_CTX_add0_chain_cert(ctx, x509) \
1749 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 0, (char *)x509)
1750#define SSL_CTX_add1_chain_cert(ctx, x509) \
1751 SSL_CTX_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 1, (char *)x509)
1752#define SSL_CTX_get0_chain_certs(ctx, px509) \
1753 SSL_CTX_ctrl(ctx, SSL_CTRL_GET_CHAIN_CERTS, 0, px509)
1754#define SSL_CTX_clear_chain_certs(ctx) SSL_CTX_set0_chain(ctx, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001755#define SSL_CTX_build_cert_chain(ctx, flags) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001756 SSL_CTX_ctrl(ctx, SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1757#define SSL_CTX_select_current_cert(ctx, x509) \
1758 SSL_CTX_ctrl(ctx, SSL_CTRL_SELECT_CURRENT_CERT, 0, (char *)x509)
Adam Langley95c29f32014-06-20 12:00:00 -07001759
Adam Langleyb4a494c2015-01-23 15:10:10 -08001760#define SSL_CTX_set0_verify_cert_store(ctx, st) \
1761 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
1762#define SSL_CTX_set1_verify_cert_store(ctx, st) \
1763 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
1764#define SSL_CTX_set0_chain_cert_store(ctx, st) \
1765 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
1766#define SSL_CTX_set1_chain_cert_store(ctx, st) \
1767 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07001768
Adam Langleyb4a494c2015-01-23 15:10:10 -08001769#define SSL_set0_chain(ctx, sk) SSL_ctrl(ctx, SSL_CTRL_CHAIN, 0, (char *)sk)
1770#define SSL_set1_chain(ctx, sk) SSL_ctrl(ctx, SSL_CTRL_CHAIN, 1, (char *)sk)
1771#define SSL_add0_chain_cert(ctx, x509) \
1772 SSL_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 0, (char *)x509)
1773#define SSL_add1_chain_cert(ctx, x509) \
1774 SSL_ctrl(ctx, SSL_CTRL_CHAIN_CERT, 1, (char *)x509)
1775#define SSL_get0_chain_certs(ctx, px509) \
1776 SSL_ctrl(ctx, SSL_CTRL_GET_CHAIN_CERTS, 0, px509)
1777#define SSL_clear_chain_certs(ctx) SSL_set0_chain(ctx, NULL)
Adam Langley95c29f32014-06-20 12:00:00 -07001778#define SSL_build_cert_chain(s, flags) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001779 SSL_ctrl(s, SSL_CTRL_BUILD_CERT_CHAIN, flags, NULL)
1780#define SSL_select_current_cert(ctx, x509) \
1781 SSL_ctrl(ctx, SSL_CTRL_SELECT_CURRENT_CERT, 0, (char *)x509)
Adam Langley95c29f32014-06-20 12:00:00 -07001782
Adam Langleyb4a494c2015-01-23 15:10:10 -08001783#define SSL_set0_verify_cert_store(s, st) \
1784 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
1785#define SSL_set1_verify_cert_store(s, st) \
1786 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
1787#define SSL_set0_chain_cert_store(s, st) \
1788 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
1789#define SSL_set1_chain_cert_store(s, st) \
1790 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07001791
Adam Langleyb4a494c2015-01-23 15:10:10 -08001792#define SSL_get1_curves(ctx, s) SSL_ctrl(ctx, SSL_CTRL_GET_CURVES, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001793#define SSL_CTX_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001794 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001795#define SSL_CTX_set1_curves_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001796 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001797#define SSL_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001798 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001799#define SSL_set1_curves_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001800 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001801
1802#define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001803 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001804#define SSL_CTX_set1_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001805 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001806#define SSL_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001807 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001808#define SSL_set1_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001809 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001810
1811#define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001812 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001813#define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001814 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001815#define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001816 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07001817#define SSL_set1_client_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001818 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07001819
1820#define SSL_get0_certificate_types(s, clist) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001821 SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001822
1823#define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001824 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001825#define SSL_set1_client_certificate_types(s, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001826 SSL_ctrl(s, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07001827
Adam Langley95c29f32014-06-20 12:00:00 -07001828#define SSL_get_server_tmp_key(s, pk) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001829 SSL_ctrl(s, SSL_CTRL_GET_SERVER_TMP_KEY, 0, pk)
Adam Langley95c29f32014-06-20 12:00:00 -07001830
Adam Langley95c29f32014-06-20 12:00:00 -07001831#define SSL_get0_ec_point_formats(s, plst) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001832 SSL_ctrl(s, SSL_CTRL_GET_EC_POINT_FORMATS, 0, (char *)plst)
Adam Langley95c29f32014-06-20 12:00:00 -07001833
Adam Langleyb4a494c2015-01-23 15:10:10 -08001834OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
1835OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001836OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001837OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1838OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001839OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001840OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001841
Adam Langleyb4a494c2015-01-23 15:10:10 -08001842OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07001843
David Benjamina07c0fc2015-05-13 13:19:42 -04001844/* SSL_get_current_cipher returns the cipher used in the current outgoing
1845 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001846OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001847
Adam Langleyb4a494c2015-01-23 15:10:10 -08001848OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
1849OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
1850OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
1851OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001852OPENSSL_EXPORT int SSL_pending(const SSL *s);
1853OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
1854OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
1855OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
1856OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
1857OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
1858OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
1859OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001860OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
1861OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
1862OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
1863 X509_STORE_CTX *);
1864OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
1865 int (*callback)(int ok,
1866 X509_STORE_CTX *ctx));
1867OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
1868OPENSSL_EXPORT void SSL_set_cert_cb(SSL *s, int (*cb)(SSL *ssl, void *arg),
1869 void *arg);
1870OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
1871OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, uint8_t *d, long len);
1872OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
1873OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int pk, SSL *ssl, const uint8_t *d,
1874 long len);
1875OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x);
1876OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *d,
1877 int len);
Adam Langley95c29f32014-06-20 12:00:00 -07001878
Adam Langleyb4a494c2015-01-23 15:10:10 -08001879OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
1880 int type);
1881OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
1882 int type);
1883OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
1884 int type);
1885OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
1886 const char *file, int type);
1887OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
1888 int type);
1889OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
1890 int type);
1891OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(
1892 SSL_CTX *ctx, const char *file); /* PEM type */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001893OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001894OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1895 stackCAs,
1896 const char *file);
1897OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1898 stackCAs,
1899 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07001900
David Benjamin7ce1c0c2015-01-09 13:21:21 -05001901/* SSL_load_error_strings does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001902OPENSSL_EXPORT void SSL_load_error_strings(void);
David Benjamin7ce1c0c2015-01-09 13:21:21 -05001903
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001904OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
1905OPENSSL_EXPORT const char *SSL_rstate_string(const SSL *s);
1906OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
1907OPENSSL_EXPORT const char *SSL_rstate_string_long(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001908OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
1909OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
1910OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
1911OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001912OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001913OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
1914 const uint8_t *sid_ctx,
1915 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001916
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001917OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001918OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
1919 unsigned int *len);
1920OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
1921OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05001922
1923/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
1924 * of |session|. It then returns |session|. */
1925OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
1926
1927/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
1928 * zero, all data referenced by |session| and |session| itself are released. */
1929OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
1930
Adam Langleyb4a494c2015-01-23 15:10:10 -08001931OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
1932OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
1933OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
1934OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
1935OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
1936OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
1937 const uint8_t *id,
1938 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04001939
Adam Langleyb4a494c2015-01-23 15:10:10 -08001940/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
1941 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
1942 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
1943 * one on success and zero on error. */
David Benjamin3cac4502014-10-21 01:46:30 -04001944OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
1945 size_t *out_len);
1946
Adam Langleyb4a494c2015-01-23 15:10:10 -08001947/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session ID
1948 * which is not necessary in a session ticket. */
David Benjamin3cac4502014-10-21 01:46:30 -04001949OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
1950 uint8_t **out_data,
1951 size_t *out_len);
1952
Adam Langleyb4a494c2015-01-23 15:10:10 -08001953/* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
1954 * |*pp|. On success, it returns the number of bytes written and advances |*pp|
1955 * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
1956 * written and only the length is returned.
David Benjamin3cac4502014-10-21 01:46:30 -04001957 *
1958 * Use SSL_SESSION_to_bytes instead. */
1959OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
1960
Adam Langleyb4a494c2015-01-23 15:10:10 -08001961/* d2i_SSL_SESSION deserializes a serialized buffer contained in the |length|
1962 * bytes pointed to by |*pp|. It returns the new SSL_SESSION and advances |*pp|
1963 * by the number of bytes consumed on success and NULL on failure. If |a| is
1964 * NULL, the caller takes ownership of the new session and must call
1965 * |SSL_SESSION_free| when done.
David Benjamin3cac4502014-10-21 01:46:30 -04001966 *
Adam Langleyb4a494c2015-01-23 15:10:10 -08001967 * If |a| and |*a| are not NULL, the SSL_SESSION at |*a| is overridden with the
1968 * deserialized session rather than allocating a new one. In addition, |a| is
1969 * not NULL, but |*a| is, |*a| is set to the new SSL_SESSION.
David Benjamin3cac4502014-10-21 01:46:30 -04001970 *
1971 * Passing a value other than NULL to |a| is deprecated. */
1972OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
1973 long length);
Adam Langley95c29f32014-06-20 12:00:00 -07001974
Adam Langleyb4a494c2015-01-23 15:10:10 -08001975OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001976
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001977OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001978
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001979OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1980OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001981OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
1982 int, X509_STORE_CTX *);
1983OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
1984 int (*callback)(int, X509_STORE_CTX *));
1985OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1986OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
1987 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
1988OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *c,
1989 int (*cb)(SSL *ssl, void *arg),
1990 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001991OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001992OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
1993 const uint8_t *d, long len);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001994OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001995OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
1996 const uint8_t *d, long len);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001997OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001998OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
1999 const uint8_t *d);
Adam Langley95c29f32014-06-20 12:00:00 -07002000
Adam Langleyb4a494c2015-01-23 15:10:10 -08002001OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
2002 pem_password_cb *cb);
2003OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
2004 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07002005
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002006OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
2007OPENSSL_EXPORT int SSL_check_private_key(const SSL *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002008
Adam Langleyb4a494c2015-01-23 15:10:10 -08002009OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
2010 const uint8_t *sid_ctx,
2011 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002012
Adam Langleyb4a494c2015-01-23 15:10:10 -08002013OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
2014 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002015
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002016OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
2017OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
2018OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
2019OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07002020
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002021OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
2022OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07002023
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002024OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
2025OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002026
Adam Langleyb4a494c2015-01-23 15:10:10 -08002027OPENSSL_EXPORT void SSL_certs_clear(SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002028OPENSSL_EXPORT int SSL_accept(SSL *ssl);
2029OPENSSL_EXPORT int SSL_connect(SSL *ssl);
2030OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
2031OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
2032OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
2033OPENSSL_EXPORT long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002034OPENSSL_EXPORT long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
Adam Langley95c29f32014-06-20 12:00:00 -07002035
Adam Langleyb4a494c2015-01-23 15:10:10 -08002036OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
Adam Langley0f4746e2014-08-13 12:26:32 -07002037/* SSL_get_version returns a string describing the TLS version used by |s|. For
2038 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002039OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley0f4746e2014-08-13 12:26:32 -07002040/* SSL_SESSION_get_version returns a string describing the TLS version used by
2041 * |sess|. For example, "TLSv1.2" or "SSLv3". */
2042OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
Adam Langley95c29f32014-06-20 12:00:00 -07002043
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002044OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002045
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002046OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
David Benjamin44d3eed2015-05-21 01:29:55 -04002047
2048/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2049 * renegotiation. */
2050OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2051
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002052OPENSSL_EXPORT int SSL_shutdown(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002053
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002054OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2055OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2056OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2057OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002058
Adam Langleyb4a494c2015-01-23 15:10:10 -08002059OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
2060 STACK_OF(X509_NAME) *name_list);
2061OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2062 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002063OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002064OPENSSL_EXPORT STACK_OF(X509_NAME) *
2065 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2066OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
2067OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07002068
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002069OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002070
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002071OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07002072
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002073OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
David Benjamin4dab2972015-05-16 02:56:06 -04002074OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002075
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002076OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
2077OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002078
Adam Langleyb4a494c2015-01-23 15:10:10 -08002079OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002080OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002081OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002082OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002083OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002084OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
2085OPENSSL_EXPORT int SSL_version(const SSL *ssl);
2086OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002087OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2088 const char *CAfile,
2089 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07002090#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002091OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002092OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
2093 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002094OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002095OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002096OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002097 void (*cb)(const SSL *ssl, int type,
2098 int val));
2099OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2100 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002101OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002102
Adam Langleyb4a494c2015-01-23 15:10:10 -08002103OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002104OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002105
Adam Langleyb4a494c2015-01-23 15:10:10 -08002106OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2107OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2108OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2109 CRYPTO_EX_new *new_func,
2110 CRYPTO_EX_dup *dup_func,
2111 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002112
Adam Langleyb4a494c2015-01-23 15:10:10 -08002113OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
2114 void *data);
2115OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2116OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2117 CRYPTO_EX_new *new_func,
2118 CRYPTO_EX_dup *dup_func,
2119 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002120
Adam Langleyb4a494c2015-01-23 15:10:10 -08002121OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2122OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2123OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2124 CRYPTO_EX_new *new_func,
2125 CRYPTO_EX_dup *dup_func,
2126 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002127
Adam Langleyb4a494c2015-01-23 15:10:10 -08002128OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002129
David Benjamin71f7d3d2015-05-05 09:46:38 -04002130/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
2131 * |size|. It returns the previous value. */
2132OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
2133 unsigned long size);
2134
David Benjamin3b7456e2015-05-16 12:29:32 -04002135/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04002136 * cache. */
2137OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
2138
2139/* SSL_SESS_CACHE_* are the possible session cache mode bits.
2140 * TODO(davidben): Document. */
2141#define SSL_SESS_CACHE_OFF 0x0000
2142#define SSL_SESS_CACHE_CLIENT 0x0001
2143#define SSL_SESS_CACHE_SERVER 0x0002
2144#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2145#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2146#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2147#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2148#define SSL_SESS_CACHE_NO_INTERNAL \
2149 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2150
2151/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2152 * |mode|. It returns the previous value. */
2153OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2154
2155/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2156 * |ctx| */
2157OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002158
David Benjamin1d0a1942015-04-26 15:35:35 -04002159/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2160 * certificate chain accepted by |ctx|. */
2161OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2162
2163/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2164 * certificate chain to |max_cert_list|. This affects how much memory may be
2165 * consumed during the handshake. */
2166OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2167 size_t max_cert_list);
2168
2169/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2170 * certificate chain accepted by |ssl|. */
2171OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2172
2173/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2174 * certificate chain to |max_cert_list|. This affects how much memory may be
2175 * consumed during the handshake. */
2176OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2177
2178/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2179 * sent by |ctx|. Beyond this length, handshake messages and application data
2180 * will be split into multiple records. */
2181OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2182 size_t max_send_fragment);
2183
2184/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2185 * sent by |ssl|. Beyond this length, handshake messages and application data
2186 * will be split into multiple records. */
2187OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2188 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002189
David Benjamin59015c32015-04-26 13:13:55 -04002190/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2191 * the group for DHE ciphers. |callback| should ignore |is_export| and
2192 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2193 * the parameters are used, so the |DH| needn't have a generated keypair.
2194 *
2195 * WARNING: The caller does not take ownership of the resulting |DH|, so
2196 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002197OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002198 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2199
2200/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2201 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2202 * and return a |DH| of the selected group or NULL on error. Only the
2203 * parameters are used, so the |DH| needn't have a generated keypair.
2204 *
2205 * WARNING: The caller does not take ownership of the resulting |DH|, so
2206 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002207OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002208 DH *(*dh)(SSL *ssl, int is_export,
2209 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002210
2211/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2212 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2213 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2214 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2215 * keypair.
2216 *
2217 * If the callback is unset, an appropriate curve will be chosen automatically.
2218 * (This is recommended.)
2219 *
2220 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2221 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002222OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002223 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2224
2225/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2226 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2227 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2228 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2229 * keypair.
2230 *
2231 * If the callback is unset, an appropriate curve will be chosen automatically.
2232 * (This is recommended.)
2233 *
2234 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2235 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002236OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002237 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002238
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002239OPENSSL_EXPORT const void *SSL_get_current_compression(SSL *s);
2240OPENSSL_EXPORT const void *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002241
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002242OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2243OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002244
Adam Langley524e7172015-02-20 16:04:00 -08002245/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2246 * resumption decision for a ClientHello has been made. It can return 1 to
2247 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002248OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002249 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2250
Adam Langley95f22882014-06-20 12:00:00 -07002251/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2252 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2253 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002254OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2255 size_t *ssl_ctx_size,
2256 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002257
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002258OPENSSL_EXPORT void ERR_load_SSL_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002259
Adam Langley3f92d212015-02-20 15:32:52 -08002260/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2261 * the read and write directions. It returns one on success or zero if |ssl|
2262 * isn't using an RC4-based cipher suite. */
2263OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2264 const RC4_KEY **write_key);
2265
Adam Langley95c29f32014-06-20 12:00:00 -07002266
David Benjamin71f07942015-04-08 02:36:59 -04002267/* Deprecated functions. */
2268
2269/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2270 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2271 * freed with |OPENSSL_free|, or NULL on error.
2272 *
2273 * The description includes a trailing newline and has the form:
2274 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2275 *
2276 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2277OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2278 char *buf, int len);
2279
2280/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2281OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2282
2283/* SSL_COMP_get_compression_methods returns NULL. */
2284OPENSSL_EXPORT void *SSL_COMP_get_compression_methods(void);
2285
2286/* SSL_COMP_add_compression_method returns one. */
2287OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, void *cm);
2288
2289/* SSL_COMP_get_name returns NULL. */
2290OPENSSL_EXPORT const char *SSL_COMP_get_name(const void *comp);
2291
David Benjamin0d8a7582015-04-08 23:55:15 -04002292/* SSLv23_method calls |TLS_method|. */
2293OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2294
2295/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2296 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2297 * to lock connections to that protocol version. */
2298OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2299OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2300OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2301OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2302OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2303OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2304
2305/* Client- and server-specific methods call their corresponding generic
2306 * methods. */
2307OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2308OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2309OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2310OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2311OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2312OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2313OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2314OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2315OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2316OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2317OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2318OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2319OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2320OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2321OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2322OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2323
David Benjamin4831c332015-05-16 11:43:13 -04002324/* SSL_clear resets |ssl| to allow another connection and returns one on success
2325 * or zero on failure. It returns most configuration state but releases memory
2326 * associated with the current connection.
2327 *
2328 * Free |ssl| and create a new one instead. */
2329OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2330
David Benjamin59015c32015-04-26 13:13:55 -04002331/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2332OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2333 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002334
David Benjamin59015c32015-04-26 13:13:55 -04002335/* SSL_set_tmp_rsa_callback does nothing. */
2336OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2337 RSA *(*cb)(SSL *ssl, int is_export,
2338 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002339
David Benjaminda881e92015-04-26 14:45:04 -04002340/* SSL_CTX_sess_connect returns zero. */
2341OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2342
2343/* SSL_CTX_sess_connect_good returns zero. */
2344OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2345
2346/* SSL_CTX_sess_connect_renegotiate returns zero. */
2347OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2348
2349/* SSL_CTX_sess_accept returns zero. */
2350OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2351
2352/* SSL_CTX_sess_accept_renegotiate returns zero. */
2353OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2354
2355/* SSL_CTX_sess_accept_good returns zero. */
2356OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2357
2358/* SSL_CTX_sess_hits returns zero. */
2359OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2360
2361/* SSL_CTX_sess_cb_hits returns zero. */
2362OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2363
2364/* SSL_CTX_sess_misses returns zero. */
2365OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2366
2367/* SSL_CTX_sess_timeouts returns zero. */
2368OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2369
2370/* SSL_CTX_sess_cache_full returns zero. */
2371OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2372
David Benjamin101ead22015-04-26 18:36:23 -04002373/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2374OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2375
David Benjaminc0454692015-04-27 00:28:56 -04002376/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2377OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2378
2379/* SSL_CTX_need_tmp_RSA returns zero. */
2380OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2381
2382/* SSL_need_tmp_RSA returns zero. */
2383OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2384
2385/* SSL_CTX_set_tmp_rsa returns one. */
2386OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2387
2388/* SSL_set_tmp_rsa returns one. */
2389OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2390
David Benjamin9a41d1b2015-05-16 01:30:09 -04002391/* SSL_CTX_get_read_head returns zero. */
2392OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2393
2394/* SSL_CTX_set_read_ahead does nothing. */
2395OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2396
2397/* SSL_get_read_head returns zero. */
2398OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2399
2400/* SSL_set_read_ahead does nothing. */
2401OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2402
David Benjamin44d3eed2015-05-21 01:29:55 -04002403/* SSL_renegotiate put an error on the error queue and returns zero. */
2404OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2405
David Benjaminece089c2015-05-15 23:52:42 -04002406/* SSL_set_state does nothing. */
2407OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2408
David Benjamin71f07942015-04-08 02:36:59 -04002409
Adam Langley7cc3f992015-01-07 15:06:31 -08002410/* Android compatibility section.
2411 *
2412 * These functions are declared, temporarily, for Android because
2413 * wpa_supplicant will take a little time to sync with upstream. Outside of
2414 * Android they'll have no definition. */
2415
2416#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2417
Adam Langleyb4a494c2015-01-23 15:10:10 -08002418OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2419 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002420OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2421OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002422OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2423
2424#define OPENSSL_VERSION_TEXT "BoringSSL"
2425
2426#define SSLEAY_VERSION 0
2427
2428/* SSLeay_version is a compatibility function that returns the string
2429 * "BoringSSL". */
2430OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002431
2432
David Benjamin59015c32015-04-26 13:13:55 -04002433/* Preprocessor compatibility section.
2434 *
2435 * Historically, a number of APIs were implemented in OpenSSL as macros and
2436 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
2437 * section defines a number of legacy macros. */
2438
David Benjaminc0454692015-04-27 00:28:56 -04002439#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2440#define SSL_CTRL_SET_TMP_RSA doesnt_exist
David Benjamin15a3b002015-04-28 00:05:35 -04002441#define SSL_CTRL_SET_TMP_DH doesnt_exist
2442#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002443#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
2444#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2445#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002446#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2447#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
2448#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002449#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002450#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002451#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002452#define SSL_CTRL_SESS_NUMBER doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002453#define SSL_CTRL_OPTIONS doesnt_exist
2454#define SSL_CTRL_MODE doesnt_exist
2455#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2456#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002457#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
2458#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
2459#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
2460#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
David Benjamin1d0a1942015-04-26 15:35:35 -04002461#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
2462#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2463#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002464#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002465#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2466#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002467#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamin8c249802015-05-05 09:44:18 -04002468#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2469#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002470#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002471#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
2472#define SSL_CTRL_CLEAR_MODE doesnt_exist
David Benjaminc2807582015-04-28 00:19:50 -04002473#define SSL_CTRL_CHANNEL_ID doesnt_exist
2474#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
2475#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002476
David Benjaminc0454692015-04-27 00:28:56 -04002477#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2478#define SSL_need_tmp_RSA SSL_need_tmp_RSA
2479#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
2480#define SSL_set_tmp_rsa SSL_set_tmp_rsa
David Benjamin15a3b002015-04-28 00:05:35 -04002481#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
2482#define SSL_set_tmp_dh SSL_set_tmp_dh
2483#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
2484#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
David Benjaminc0454692015-04-27 00:28:56 -04002485#define SSL_session_reused SSL_session_reused
2486#define SSL_num_renegotiations SSL_num_renegotiations
2487#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin61ecccf2015-05-05 09:44:51 -04002488#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2489#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
David Benjamincb9cf792015-05-05 09:46:14 -04002490#define SSL_set_mtu SSL_set_mtu
David Benjamin71f7d3d2015-05-05 09:46:38 -04002491#define SSL_CTX_sess_number SSL_CTX_sess_number
David Benjamin61ecccf2015-05-05 09:44:51 -04002492#define SSL_CTX_get_options SSL_CTX_get_options
2493#define SSL_CTX_set_options SSL_CTX_set_options
2494#define SSL_get_options SSL_get_options
2495#define SSL_set_options SSL_set_options
2496#define SSL_CTX_get_mode SSL_CTX_get_mode
2497#define SSL_CTX_set_mode SSL_CTX_set_mode
2498#define SSL_get_mode SSL_get_mode
2499#define SSL_set_mode SSL_set_mode
2500#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2501#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
David Benjamin71f7d3d2015-05-05 09:46:38 -04002502#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
2503#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2504#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2505#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin1d0a1942015-04-26 15:35:35 -04002506#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2507#define SSL_get_max_cert_list SSL_get_max_cert_list
2508#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2509#define SSL_set_max_cert_list SSL_set_max_cert_list
2510#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2511#define SSL_set_max_send_fragment SSL_set_max_send_fragment
David Benjamin59015c32015-04-26 13:13:55 -04002512#define SSL_CTX_set_tlsext_servername_callback \
2513 SSL_CTX_set_tlsext_servername_callback
David Benjamin7133d422015-04-28 00:43:39 -04002514#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2515#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
David Benjamin59015c32015-04-26 13:13:55 -04002516#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin8c249802015-05-05 09:44:18 -04002517#define DTLSv1_get_timeout DTLSv1_get_timeout
2518#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamincb9cf792015-05-05 09:46:14 -04002519#define SSL_get_secure_renegotiation_support \
2520 SSL_get_secure_renegotiation_support
David Benjamin61ecccf2015-05-05 09:44:51 -04002521#define SSL_CTX_clear_options SSL_CTX_clear_options
2522#define SSL_clear_options SSL_clear_options
2523#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2524#define SSL_clear_mode SSL_clear_mode
David Benjaminc2807582015-04-28 00:19:50 -04002525#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
2526#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
2527#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
2528#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2529#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamin59015c32015-04-26 13:13:55 -04002530
2531
David Benjamin087e4fa2015-04-08 23:46:10 -04002532#if defined(__cplusplus)
2533} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07002534#endif
David Benjamin2e521212014-07-16 14:37:51 -04002535
David Benjamin087e4fa2015-04-08 23:46:10 -04002536
2537/* Library consumers assume these headers are included by ssl.h, but they depend
2538 * on ssl.h, so include them after all declarations.
2539 *
2540 * TODO(davidben): The separation between ssl.h and these version-specific
2541 * headers introduces circular dependencies and is inconsistent. The function
2542 * declarations should move to ssl.h. Many of the constants can probably be
2543 * pruned or unexported. */
2544#include <openssl/ssl2.h>
2545#include <openssl/ssl3.h>
2546#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04002547#include <openssl/ssl23.h>
2548#include <openssl/srtp.h> /* Support for the use_srtp extension */
2549
2550
David Benjamin2e521212014-07-16 14:37:51 -04002551/* BEGIN ERROR CODES */
2552/* The following lines are auto generated by the script make_errors.go. Any
2553 * changes made after this point may be overwritten when the script is next run.
2554 */
David Benjamin689be0f2015-02-11 15:55:26 -05002555#define SSL_F_SSL_CTX_check_private_key 100
2556#define SSL_F_SSL_CTX_new 101
2557#define SSL_F_SSL_CTX_set_cipher_list 102
2558#define SSL_F_SSL_CTX_set_cipher_list_tls11 103
2559#define SSL_F_SSL_CTX_set_session_id_context 104
2560#define SSL_F_SSL_CTX_use_PrivateKey 105
2561#define SSL_F_SSL_CTX_use_PrivateKey_ASN1 106
2562#define SSL_F_SSL_CTX_use_PrivateKey_file 107
2563#define SSL_F_SSL_CTX_use_RSAPrivateKey 108
2564#define SSL_F_SSL_CTX_use_RSAPrivateKey_ASN1 109
2565#define SSL_F_SSL_CTX_use_RSAPrivateKey_file 110
Adam Langley95c29f32014-06-20 12:00:00 -07002566#define SSL_F_SSL_CTX_use_certificate 111
David Benjamin689be0f2015-02-11 15:55:26 -05002567#define SSL_F_SSL_CTX_use_certificate_ASN1 112
2568#define SSL_F_SSL_CTX_use_certificate_chain_file 113
2569#define SSL_F_SSL_CTX_use_certificate_file 114
2570#define SSL_F_SSL_CTX_use_psk_identity_hint 115
2571#define SSL_F_SSL_SESSION_new 116
2572#define SSL_F_SSL_SESSION_print_fp 117
2573#define SSL_F_SSL_SESSION_set1_id_context 118
2574#define SSL_F_SSL_SESSION_to_bytes_full 119
2575#define SSL_F_SSL_accept 120
2576#define SSL_F_SSL_add_dir_cert_subjects_to_stack 121
2577#define SSL_F_SSL_add_file_cert_subjects_to_stack 122
2578#define SSL_F_SSL_check_private_key 123
2579#define SSL_F_SSL_clear 124
2580#define SSL_F_SSL_connect 125
2581#define SSL_F_SSL_do_handshake 126
2582#define SSL_F_SSL_load_client_CA_file 127
2583#define SSL_F_SSL_new 128
2584#define SSL_F_SSL_peek 129
2585#define SSL_F_SSL_read 130
2586#define SSL_F_SSL_renegotiate 131
2587#define SSL_F_SSL_set_cipher_list 132
2588#define SSL_F_SSL_set_fd 133
2589#define SSL_F_SSL_set_rfd 134
2590#define SSL_F_SSL_set_session_id_context 135
2591#define SSL_F_SSL_set_wfd 136
2592#define SSL_F_SSL_shutdown 137
2593#define SSL_F_SSL_use_PrivateKey 138
2594#define SSL_F_SSL_use_PrivateKey_ASN1 139
2595#define SSL_F_SSL_use_PrivateKey_file 140
2596#define SSL_F_SSL_use_RSAPrivateKey 141
2597#define SSL_F_SSL_use_RSAPrivateKey_ASN1 142
2598#define SSL_F_SSL_use_RSAPrivateKey_file 143
2599#define SSL_F_SSL_use_certificate 144
2600#define SSL_F_SSL_use_certificate_ASN1 145
2601#define SSL_F_SSL_use_certificate_file 146
2602#define SSL_F_SSL_use_psk_identity_hint 147
2603#define SSL_F_SSL_write 148
2604#define SSL_F_d2i_SSL_SESSION 149
2605#define SSL_F_d2i_SSL_SESSION_get_octet_string 150
2606#define SSL_F_d2i_SSL_SESSION_get_string 151
2607#define SSL_F_do_ssl3_write 152
2608#define SSL_F_dtls1_accept 153
2609#define SSL_F_dtls1_buffer_record 154
2610#define SSL_F_dtls1_check_timeout_num 155
2611#define SSL_F_dtls1_connect 156
2612#define SSL_F_dtls1_do_write 157
2613#define SSL_F_dtls1_get_hello_verify 158
2614#define SSL_F_dtls1_get_message 159
2615#define SSL_F_dtls1_get_message_fragment 160
2616#define SSL_F_dtls1_preprocess_fragment 161
2617#define SSL_F_dtls1_process_record 162
2618#define SSL_F_dtls1_read_bytes 163
2619#define SSL_F_dtls1_send_hello_verify_request 164
2620#define SSL_F_dtls1_write_app_data_bytes 165
2621#define SSL_F_i2d_SSL_SESSION 166
2622#define SSL_F_ssl3_accept 167
David Benjamin689be0f2015-02-11 15:55:26 -05002623#define SSL_F_ssl3_cert_verify_hash 169
2624#define SSL_F_ssl3_check_cert_and_algorithm 170
2625#define SSL_F_ssl3_connect 171
2626#define SSL_F_ssl3_ctrl 172
2627#define SSL_F_ssl3_ctx_ctrl 173
2628#define SSL_F_ssl3_digest_cached_records 174
2629#define SSL_F_ssl3_do_change_cipher_spec 175
2630#define SSL_F_ssl3_expect_change_cipher_spec 176
2631#define SSL_F_ssl3_get_cert_status 177
2632#define SSL_F_ssl3_get_cert_verify 178
2633#define SSL_F_ssl3_get_certificate_request 179
2634#define SSL_F_ssl3_get_channel_id 180
2635#define SSL_F_ssl3_get_client_certificate 181
2636#define SSL_F_ssl3_get_client_hello 182
2637#define SSL_F_ssl3_get_client_key_exchange 183
2638#define SSL_F_ssl3_get_finished 184
2639#define SSL_F_ssl3_get_initial_bytes 185
2640#define SSL_F_ssl3_get_message 186
2641#define SSL_F_ssl3_get_new_session_ticket 187
2642#define SSL_F_ssl3_get_next_proto 188
2643#define SSL_F_ssl3_get_record 189
2644#define SSL_F_ssl3_get_server_certificate 190
2645#define SSL_F_ssl3_get_server_done 191
2646#define SSL_F_ssl3_get_server_hello 192
2647#define SSL_F_ssl3_get_server_key_exchange 193
2648#define SSL_F_ssl3_get_v2_client_hello 194
2649#define SSL_F_ssl3_handshake_mac 195
2650#define SSL_F_ssl3_prf 196
2651#define SSL_F_ssl3_read_bytes 197
2652#define SSL_F_ssl3_read_n 198
2653#define SSL_F_ssl3_send_cert_verify 199
2654#define SSL_F_ssl3_send_certificate_request 200
2655#define SSL_F_ssl3_send_channel_id 201
2656#define SSL_F_ssl3_send_client_certificate 202
2657#define SSL_F_ssl3_send_client_hello 203
2658#define SSL_F_ssl3_send_client_key_exchange 204
2659#define SSL_F_ssl3_send_server_certificate 205
2660#define SSL_F_ssl3_send_server_hello 206
2661#define SSL_F_ssl3_send_server_key_exchange 207
2662#define SSL_F_ssl3_setup_read_buffer 208
2663#define SSL_F_ssl3_setup_write_buffer 209
2664#define SSL_F_ssl3_write_bytes 210
2665#define SSL_F_ssl3_write_pending 211
2666#define SSL_F_ssl_add_cert_chain 212
2667#define SSL_F_ssl_add_cert_to_buf 213
2668#define SSL_F_ssl_add_clienthello_renegotiate_ext 214
2669#define SSL_F_ssl_add_clienthello_tlsext 215
2670#define SSL_F_ssl_add_clienthello_use_srtp_ext 216
2671#define SSL_F_ssl_add_serverhello_renegotiate_ext 217
2672#define SSL_F_ssl_add_serverhello_tlsext 218
2673#define SSL_F_ssl_add_serverhello_use_srtp_ext 219
2674#define SSL_F_ssl_build_cert_chain 220
2675#define SSL_F_ssl_bytes_to_cipher_list 221
2676#define SSL_F_ssl_cert_dup 222
2677#define SSL_F_ssl_cert_inst 223
2678#define SSL_F_ssl_cert_new 224
2679#define SSL_F_ssl_check_serverhello_tlsext 225
2680#define SSL_F_ssl_check_srvr_ecc_cert_and_alg 226
2681#define SSL_F_ssl_cipher_process_rulestr 227
2682#define SSL_F_ssl_cipher_strength_sort 228
2683#define SSL_F_ssl_create_cipher_list 229
2684#define SSL_F_ssl_ctx_log_master_secret 230
2685#define SSL_F_ssl_ctx_log_rsa_client_key_exchange 231
2686#define SSL_F_ssl_ctx_make_profiles 232
2687#define SSL_F_ssl_get_new_session 233
2688#define SSL_F_ssl_get_prev_session 234
2689#define SSL_F_ssl_get_server_cert_index 235
2690#define SSL_F_ssl_get_sign_pkey 236
2691#define SSL_F_ssl_init_wbio_buffer 237
2692#define SSL_F_ssl_parse_clienthello_renegotiate_ext 238
2693#define SSL_F_ssl_parse_clienthello_tlsext 239
2694#define SSL_F_ssl_parse_clienthello_use_srtp_ext 240
2695#define SSL_F_ssl_parse_serverhello_renegotiate_ext 241
2696#define SSL_F_ssl_parse_serverhello_tlsext 242
2697#define SSL_F_ssl_parse_serverhello_use_srtp_ext 243
2698#define SSL_F_ssl_scan_clienthello_tlsext 244
2699#define SSL_F_ssl_scan_serverhello_tlsext 245
2700#define SSL_F_ssl_sess_cert_new 246
2701#define SSL_F_ssl_set_cert 247
2702#define SSL_F_ssl_set_pkey 248
David Benjamin689be0f2015-02-11 15:55:26 -05002703#define SSL_F_ssl_verify_cert_chain 252
2704#define SSL_F_tls12_check_peer_sigalg 253
2705#define SSL_F_tls1_aead_ctx_init 254
2706#define SSL_F_tls1_cert_verify_mac 255
2707#define SSL_F_tls1_change_cipher_state 256
2708#define SSL_F_tls1_change_cipher_state_aead 257
2709#define SSL_F_tls1_check_duplicate_extensions 258
2710#define SSL_F_tls1_enc 259
2711#define SSL_F_tls1_export_keying_material 260
2712#define SSL_F_tls1_prf 261
2713#define SSL_F_tls1_setup_key_block 262
David Benjamin75381222015-03-02 19:30:30 -05002714#define SSL_F_dtls1_get_buffered_message 263
2715#define SSL_F_dtls1_process_fragment 264
David Benjaminee562b92015-03-02 20:52:52 -05002716#define SSL_F_dtls1_hm_fragment_new 265
David Benjamin9faafda2015-04-04 19:23:10 -04002717#define SSL_F_ssl3_seal_record 266
David Benjamind81e73d2015-04-05 00:21:39 -04002718#define SSL_F_ssl3_record_sequence_update 267
David Benjamin15a3b002015-04-28 00:05:35 -04002719#define SSL_F_SSL_CTX_set_tmp_dh 268
2720#define SSL_F_SSL_CTX_set_tmp_ecdh 269
2721#define SSL_F_SSL_set_tmp_dh 270
2722#define SSL_F_SSL_set_tmp_ecdh 271
David Benjaminc2807582015-04-28 00:19:50 -04002723#define SSL_F_SSL_CTX_set1_tls_channel_id 272
2724#define SSL_F_SSL_set1_tls_channel_id 273
David Benjamin7133d422015-04-28 00:43:39 -04002725#define SSL_F_SSL_set_tlsext_host_name 274
David Benjamin605641e2015-05-03 15:14:04 -04002726#define SSL_F_ssl3_output_cert_chain 275
David Benjamin31a07792015-03-03 14:20:26 -05002727#define SSL_F_SSL_AEAD_CTX_new 276
2728#define SSL_F_SSL_AEAD_CTX_open 277
2729#define SSL_F_SSL_AEAD_CTX_seal 278
2730#define SSL_F_dtls1_seal_record 279
David Benjamin689be0f2015-02-11 15:55:26 -05002731#define SSL_R_APP_DATA_IN_HANDSHAKE 100
2732#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
2733#define SSL_R_BAD_ALERT 102
2734#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
2735#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
2736#define SSL_R_BAD_DH_P_LENGTH 105
2737#define SSL_R_BAD_DIGEST_LENGTH 106
2738#define SSL_R_BAD_ECC_CERT 107
2739#define SSL_R_BAD_ECPOINT 108
2740#define SSL_R_BAD_HANDSHAKE_LENGTH 109
2741#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07002742#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05002743#define SSL_R_BAD_LENGTH 112
2744#define SSL_R_BAD_PACKET_LENGTH 113
2745#define SSL_R_BAD_RSA_ENCRYPT 114
2746#define SSL_R_BAD_SIGNATURE 115
2747#define SSL_R_BAD_SRTP_MKI_VALUE 116
2748#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
2749#define SSL_R_BAD_SSL_FILETYPE 118
2750#define SSL_R_BAD_WRITE_RETRY 119
2751#define SSL_R_BIO_NOT_SET 120
2752#define SSL_R_BN_LIB 121
2753#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
2754#define SSL_R_CA_DN_LENGTH_MISMATCH 123
2755#define SSL_R_CA_DN_TOO_LONG 124
2756#define SSL_R_CCS_RECEIVED_EARLY 125
2757#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
2758#define SSL_R_CERT_CB_ERROR 127
2759#define SSL_R_CERT_LENGTH_MISMATCH 128
2760#define SSL_R_CHANNEL_ID_NOT_P256 129
2761#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
2762#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
2763#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
2764#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
2765#define SSL_R_CLIENTHELLO_TLSEXT 134
2766#define SSL_R_CONNECTION_REJECTED 135
2767#define SSL_R_CONNECTION_TYPE_NOT_SET 136
2768#define SSL_R_COOKIE_MISMATCH 137
2769#define SSL_R_D2I_ECDSA_SIG 138
2770#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
2771#define SSL_R_DATA_LENGTH_TOO_LONG 140
2772#define SSL_R_DECODE_ERROR 141
2773#define SSL_R_DECRYPTION_FAILED 142
2774#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
2775#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
2776#define SSL_R_DIGEST_CHECK_FAILED 145
2777#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
2778#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
2779#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
2780#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
2781#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
2782#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
2783#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
2784#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
2785#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
2786#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
2787#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
2788#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
2789#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
2790#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
2791#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
2792#define SSL_R_HTTPS_PROXY_REQUEST 161
2793#define SSL_R_HTTP_REQUEST 162
2794#define SSL_R_INAPPROPRIATE_FALLBACK 163
2795#define SSL_R_INVALID_COMMAND 164
2796#define SSL_R_INVALID_MESSAGE 165
2797#define SSL_R_INVALID_SSL_SESSION 166
2798#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
2799#define SSL_R_LENGTH_MISMATCH 168
2800#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
2801#define SSL_R_MISSING_DH_KEY 170
2802#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
2803#define SSL_R_MISSING_RSA_CERTIFICATE 172
2804#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
2805#define SSL_R_MISSING_RSA_SIGNING_CERT 174
2806#define SSL_R_MISSING_TMP_DH_KEY 175
2807#define SSL_R_MISSING_TMP_ECDH_KEY 176
2808#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
2809#define SSL_R_MTU_TOO_SMALL 178
2810#define SSL_R_NESTED_GROUP 179
2811#define SSL_R_NO_CERTIFICATES_RETURNED 180
2812#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
2813#define SSL_R_NO_CERTIFICATE_SET 182
2814#define SSL_R_NO_CIPHERS_AVAILABLE 183
2815#define SSL_R_NO_CIPHERS_PASSED 184
2816#define SSL_R_NO_CIPHERS_SPECIFIED 185
2817#define SSL_R_NO_CIPHER_MATCH 186
2818#define SSL_R_NO_COMPRESSION_SPECIFIED 187
2819#define SSL_R_NO_METHOD_SPECIFIED 188
2820#define SSL_R_NO_P256_SUPPORT 189
2821#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
2822#define SSL_R_NO_RENEGOTIATION 191
2823#define SSL_R_NO_REQUIRED_DIGEST 192
2824#define SSL_R_NO_SHARED_CIPHER 193
2825#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
2826#define SSL_R_NO_SRTP_PROFILES 195
2827#define SSL_R_NULL_SSL_CTX 196
2828#define SSL_R_NULL_SSL_METHOD_PASSED 197
2829#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
2830#define SSL_R_PACKET_LENGTH_TOO_LONG 199
2831#define SSL_R_PARSE_TLSEXT 200
2832#define SSL_R_PATH_TOO_LONG 201
2833#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
2834#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
2835#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
2836#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
2837#define SSL_R_PSK_NO_CLIENT_CB 206
2838#define SSL_R_PSK_NO_SERVER_CB 207
2839#define SSL_R_READ_BIO_NOT_SET 208
2840#define SSL_R_READ_TIMEOUT_EXPIRED 209
2841#define SSL_R_RECORD_LENGTH_MISMATCH 210
2842#define SSL_R_RECORD_TOO_LARGE 211
2843#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
2844#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
2845#define SSL_R_RENEGOTIATION_MISMATCH 214
2846#define SSL_R_REQUIRED_CIPHER_MISSING 215
2847#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
2848#define SSL_R_SERVERHELLO_TLSEXT 217
2849#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
2850#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
2851#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
2852#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
2853#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
2854#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
2855#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
2856#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
2857#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
2858#define SSL_R_SSL_HANDSHAKE_FAILURE 227
2859#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
2860#define SSL_R_SSL_SESSION_ID_CONFLICT 229
2861#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
2862#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
2863#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
2864#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
2865#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
2866#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
2867#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
2868#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
2869#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
2870#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
2871#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
2872#define SSL_R_UNEXPECTED_MESSAGE 241
2873#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
2874#define SSL_R_UNEXPECTED_RECORD 243
2875#define SSL_R_UNINITIALIZED 244
2876#define SSL_R_UNKNOWN_ALERT_TYPE 245
2877#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
2878#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
2879#define SSL_R_UNKNOWN_CIPHER_TYPE 248
2880#define SSL_R_UNKNOWN_DIGEST 249
2881#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
2882#define SSL_R_UNKNOWN_PROTOCOL 251
2883#define SSL_R_UNKNOWN_SSL_VERSION 252
2884#define SSL_R_UNKNOWN_STATE 253
2885#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
2886#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
2887#define SSL_R_UNSUPPORTED_CIPHER 256
2888#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
2889#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
2890#define SSL_R_UNSUPPORTED_PROTOCOL 259
2891#define SSL_R_UNSUPPORTED_SSL_VERSION 260
2892#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07002893#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05002894#define SSL_R_WRONG_CIPHER_RETURNED 263
2895#define SSL_R_WRONG_CURVE 264
2896#define SSL_R_WRONG_MESSAGE_TYPE 265
2897#define SSL_R_WRONG_SIGNATURE_TYPE 266
2898#define SSL_R_WRONG_SSL_VERSION 267
2899#define SSL_R_WRONG_VERSION_NUMBER 268
2900#define SSL_R_X509_LIB 269
2901#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05002902#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04002903#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04002904#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05002905#define SSL_R_OUTPUT_ALIASES_INPUT 274
David Benjamind7c53682014-09-17 12:08:13 -04002906#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04002907#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
2908#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
2909#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
2910#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
2911#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
2912#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
2913#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
2914#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
2915#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
2916#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
2917#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
2918#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
2919#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
2920#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
2921#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
2922#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
2923#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
2924#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
2925#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
2926#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
2927#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04002928#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04002929#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
2930#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
2931#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
2932#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
2933#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
2934#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
2935#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07002936
David Benjamin087e4fa2015-04-08 23:46:10 -04002937#endif /* OPENSSL_HEADER_SSL_H */