blob: 585268906024c7f9fb4de2a9ba57ace0c64cb4d7 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* ssl/ssl.h */
2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
Adam Langleyb4a494c2015-01-23 15:10:10 -08008 *
Adam Langley95c29f32014-06-20 12:00:00 -07009 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
Adam Langleyb4a494c2015-01-23 15:10:10 -080015 *
Adam Langley95c29f32014-06-20 12:00:00 -070016 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
Adam Langleyb4a494c2015-01-23 15:10:10 -080022 *
Adam Langley95c29f32014-06-20 12:00:00 -070023 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
Adam Langleyb4a494c2015-01-23 15:10:10 -080037 * 4. If you include any Windows specific code (or a derivative thereof) from
Adam Langley95c29f32014-06-20 12:00:00 -070038 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
Adam Langleyb4a494c2015-01-23 15:10:10 -080040 *
Adam Langley95c29f32014-06-20 12:00:00 -070041 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
Adam Langleyb4a494c2015-01-23 15:10:10 -080052 *
Adam Langley95c29f32014-06-20 12:00:00 -070053 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58/* ====================================================================
59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
60 *
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
63 * are met:
64 *
65 * 1. Redistributions of source code must retain the above copyright
Adam Langleyb4a494c2015-01-23 15:10:10 -080066 * notice, this list of conditions and the following disclaimer.
Adam Langley95c29f32014-06-20 12:00:00 -070067 *
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 *
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
82 *
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
86 *
87 * 6. Redistributions of any form whatsoever must retain the following
88 * acknowledgment:
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 *
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
105 *
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
109 *
110 */
111/* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
Adam Langleyb4a494c2015-01-23 15:10:10 -0800113 * ECC cipher suite support in OpenSSL originally developed by
Adam Langley95c29f32014-06-20 12:00:00 -0700114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 */
116/* ====================================================================
117 * Copyright 2005 Nokia. All rights reserved.
118 *
119 * The portions of the attached software ("Contribution") is developed by
120 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
121 * license.
122 *
123 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
124 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
125 * support (see RFC 4279) to OpenSSL.
126 *
127 * No patent licenses or other rights except those expressly stated in
128 * the OpenSSL open source license shall be deemed granted or received
129 * expressly, by implication, estoppel, or otherwise.
130 *
131 * No assurances are provided by Nokia that the Contribution does not
132 * infringe the patent or other intellectual property rights of any third
133 * party or that the license provides you with all the necessary rights
134 * to make use of the Contribution.
135 *
136 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
137 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
138 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
139 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
140 * OTHERWISE.
141 */
142
David Benjamin087e4fa2015-04-08 23:46:10 -0400143#ifndef OPENSSL_HEADER_SSL_H
144#define OPENSSL_HEADER_SSL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146#include <openssl/base.h>
147
148#include <openssl/bio.h>
149#include <openssl/buf.h>
150#include <openssl/hmac.h>
151#include <openssl/lhash.h>
152#include <openssl/pem.h>
Adam Langley0b5e3902015-05-15 13:08:38 -0700153#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700154#include <openssl/x509.h>
155
David Benjamin2e749e82015-04-07 23:20:51 -0400156#if !defined(OPENSSL_WINDOWS)
157#include <sys/time.h>
158#endif
159
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700160/* wpa_supplicant expects to get the version functions from ssl.h */
161#include <openssl/crypto.h>
162
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400163/* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
164 * Windows headers define too many macros to be included in public headers.
165 * However, only a forward declaration is needed. */
166struct timeval;
167
David Benjamin087e4fa2015-04-08 23:46:10 -0400168#if defined(__cplusplus)
Adam Langley95c29f32014-06-20 12:00:00 -0700169extern "C" {
170#endif
171
172
David Benjamin0d8a7582015-04-08 23:55:15 -0400173/* SSL implementation. */
174
175
David Benjamin71f07942015-04-08 02:36:59 -0400176/* Initialization. */
177
178/* SSL_library_init initializes the crypto and SSL libraries and returns one. */
179OPENSSL_EXPORT int SSL_library_init(void);
180
181
182/* Cipher suites. */
183
184/* An SSL_CIPHER represents a cipher suite. */
185typedef struct ssl_cipher_st {
186 /* name is the OpenSSL name for the cipher. */
187 const char *name;
188 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
189 uint32_t id;
190
191 /* The following are internal fields. See ssl/internal.h for their values. */
192
193 uint32_t algorithm_mkey;
194 uint32_t algorithm_auth;
195 uint32_t algorithm_enc;
196 uint32_t algorithm_mac;
197 uint32_t algorithm_ssl;
198 uint32_t algo_strength;
199
200 /* algorithm2 contains extra flags. See ssl/internal.h. */
201 uint32_t algorithm2;
202
203 /* strength_bits is the strength of the cipher in bits. */
204 int strength_bits;
205 /* alg_bits is the number of bits of key material used by the algorithm. */
206 int alg_bits;
207} SSL_CIPHER;
208
209DECLARE_STACK_OF(SSL_CIPHER)
210
211/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
212 * suite based on its assigned number, or NULL if unknown. See
213 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
214OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
215
216/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
217 * get the cipher suite value. */
218OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
219
220/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
221 * mode). */
222OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
223
224/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
225OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
226
227/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
228OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
229
230/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
231 * CHACHA20_POLY1305. */
232OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
233
234/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
235OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
236
237/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
238 * method used by |cipher|. For example, "ECDHE_ECDSA". */
239OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
240
241/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
David Benjamin3fa65f02015-05-15 19:11:57 -0400242 * name for |cipher| or NULL on error. For example,
243 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
244 * calling |OPENSSL_free| on the result. */
David Benjamin71f07942015-04-08 02:36:59 -0400245OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
246
247/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
248 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
249 * symmetric algorithm to |*out_alg_bits|. */
250OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
251 int *out_alg_bits);
252
253
David Benjamin4831c332015-05-16 11:43:13 -0400254/* SSL contexts. */
255
256/* An SSL_METHOD selects whether to use TLS or DTLS. */
257typedef struct ssl_method_st SSL_METHOD;
258
259/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
260OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
261
262/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
263OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
264
265/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
266 * on error. An |SSL_CTX| manages shared state and configuration between
267 * multiple TLS or DTLS connections. */
268OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
269
270/* SSL_CTX_free releases memory associated with |ctx|. */
271OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
272
273
274/* SSL connections. */
275
276/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
277 * |SSL| object represents a single TLS or DTLS connection. It inherits settings
278 * from |ctx| at the time of creation. Settings may also be individually
279 * configured on the connection.
280 *
281 * On creation, an |SSL| is not configured to be either a client or server. Call
282 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
283OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
284
285/* SSL_free releases memory associated with |ssl|. */
286OPENSSL_EXPORT void SSL_free(SSL *ssl);
287
288/* SSL_set_connect_state configures |ssl| to be a client. */
289OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
290
291/* SSL_set_accept_state configures |ssl| to be a server. */
292OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
293
294
David Benjaminb487df62015-05-16 15:31:07 -0400295/* Protocol versions. */
296
297#define SSL3_VERSION_MAJOR 0x03
298
299#define SSL3_VERSION 0x0300
300#define TLS1_VERSION 0x0301
301#define TLS1_1_VERSION 0x0302
302#define TLS1_2_VERSION 0x0303
303
304#define DTLS1_VERSION 0xfeff
305#define DTLS1_2_VERSION 0xfefd
306
307/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
308 * |version|. */
309OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
310
311/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
312 * |version|. */
313OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
314
315/* SSL_set_min_version sets the minimum protocol version for |ssl| to
316 * |version|. */
317OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
318
319/* SSL_set_max_version sets the maximum protocol version for |ssl| to
320 * |version|. */
321OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
322
323
324/* Options.
325 *
326 * Options configure protocol behavior. */
327
328/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
329 * support the renegotiation_info extension (RFC 5746). It is on by default. */
330#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
331
332/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
333 * bytes above the maximum record size. */
334#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
335
336/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
337 * (i.e. without a length prefix). */
338#define SSL_OP_TLS_D5_BUG 0x00000100L
339
340/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
341 * consumers.
342 * TODO(davidben): Determine which of the remaining may be removed now. */
343#define SSL_OP_ALL 0x00000BFFL
344
345/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
346 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
347#define SSL_OP_NO_QUERY_MTU 0x00001000L
348
349/* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
350#define SSL_OP_NO_TICKET 0x00004000L
351
David Benjaminb487df62015-05-16 15:31:07 -0400352/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
353 * ECDHE curves according to the server's preferences instead of the
354 * client's. */
355#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
356
357/* The following flags toggle individual protocol versions. This is deprecated.
358 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
359#define SSL_OP_NO_SSLv3 0x02000000L
360#define SSL_OP_NO_TLSv1 0x04000000L
361#define SSL_OP_NO_TLSv1_2 0x08000000L
362#define SSL_OP_NO_TLSv1_1 0x10000000L
363#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
364#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
365
366/* The following flags do nothing and are included only to make it easier to
367 * compile code with BoringSSL. */
368#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
369#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
370#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
371#define SSL_OP_NO_COMPRESSION 0
372#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
373#define SSL_OP_NO_SSLv2 0
374#define SSL_OP_SINGLE_DH_USE 0
375#define SSL_OP_SINGLE_ECDH_USE 0
376#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
377#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
378#define SSL_OP_TLS_ROLLBACK_BUG 0
Adam Langley5021b222015-06-12 18:27:58 -0700379#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
David Benjaminb487df62015-05-16 15:31:07 -0400380
381/* SSL_CTX_set_options enables all options set in |options| (which should be one
382 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
383 * bitmask representing the resulting enabled options. */
384OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
385
386/* SSL_CTX_clear_options disables all options set in |options| (which should be
387 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
388 * bitmask representing the resulting enabled options. */
389OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
390
391/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
392 * the options enabled for |ctx|. */
393OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
394
395/* SSL_set_options enables all options set in |options| (which should be one or
396 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
397 * representing the resulting enabled options. */
398OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
399
400/* SSL_clear_options disables all options set in |options| (which should be one
401 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
402 * bitmask representing the resulting enabled options. */
403OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
404
405/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
406 * options enabled for |ssl|. */
407OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
408
409
410/* Modes.
411 *
412 * Modes configure API behavior. */
413
414/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
415 * result when the only part of the input was written in a single record. */
416#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
417
418/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
419 * with a different buffer. However, |SSL_write| still assumes the buffer
420 * contents are unchanged. This is not the default to avoid the misconception
421 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
422#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
423
424/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
425 * before sending certificates to the peer.
426 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
427#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
428
David Benjaminb487df62015-05-16 15:31:07 -0400429/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
430 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
431 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
432#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
433
434/* Deprecated: SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as
435 * SSL_MODE_ENABLE_FALSE_START. */
436#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
437
438/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
439 * TLS 1.0 to be split in two: the first record will contain a single byte and
440 * the second will contain the remainder. This effectively randomises the IV and
441 * prevents BEAST attacks. */
442#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
443
444/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
445 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
446 * session resumption is used for a given SSL*. */
447#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
448
449/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
450 * To be set only by applications that reconnect with a downgraded protocol
451 * version; see https://tools.ietf.org/html/draft-ietf-tls-downgrade-scsv-05
452 * for details.
453 *
454 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
455 * this in explicit fallback retries, following the guidance in
456 * draft-ietf-tls-downgrade-scsv-05. */
457#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
458
459/* The following flags do nothing and are included only to make it easier to
460 * compile code with BoringSSL. */
461#define SSL_MODE_AUTO_RETRY 0
462#define SSL_MODE_RELEASE_BUFFERS 0
David Benjamin74d8bc22015-05-21 02:16:53 -0400463#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
464#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjaminb487df62015-05-16 15:31:07 -0400465
466/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
467 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
468 * representing the resulting enabled modes. */
469OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
470
471/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
472 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
473 * bitmask representing the resulting enabled modes. */
474OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
475
476/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
477 * the modes enabled for |ssl|. */
478OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
479
480/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
481 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
482 * representing the resulting enabled modes. */
483OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
484
485/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
486 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
487 * representing the resulting enabled modes. */
488OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
489
490/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
491 * modes enabled for |ssl|. */
492OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
493
494
David Benjaminb4d65fd2015-05-29 17:11:21 -0400495/* Configuring certificates and private keys.
496 *
David Benjamin11c0f8e2015-07-06 00:18:15 -0400497 * These functions configure the connection's leaf certificate, private key, and
498 * certificate chain. The certificate chain is ordered leaf to root (as sent on
499 * the wire) but does not include the leaf. Both client and server certificates
500 * use these functions.
501 *
502 * Certificates and keys may be configured before the handshake or dynamically
503 * in the early callback and certificate callback. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400504
David Benjamin7481d392015-07-05 19:38:46 -0400505/* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
506 * one on success and zero on failure. */
507OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
508
509/* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
510 * on success and zero on failure. */
511OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
512
513/* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
514 * success and zero on failure. */
515OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
516
517/* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
518 * success and zero on failure. */
519OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
520
David Benjamin11c0f8e2015-07-06 00:18:15 -0400521/* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
522 * |chain|. On success, it returns one and takes ownership of |chain|.
523 * Otherwise, it returns zero. */
524OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
525
526/* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
527 * |chain|. It returns one on success and zero on failure. The caller retains
528 * ownership of |chain| and may release it freely. */
529OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
530
531/* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
532 * |chain|. On success, it returns one and takes ownership of |chain|.
533 * Otherwise, it returns zero. */
534OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
535
536/* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
537 * |chain|. It returns one on success and zero on failure. The caller retains
538 * ownership of |chain| and may release it freely. */
539OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
540
541/* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
542 * success, it returns one and takes ownership of |x509|. Otherwise, it returns
543 * zero. */
544OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
545
546/* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
547 * returns one on success and zero on failure. The caller retains ownership of
548 * |x509| and may release it freely. */
549OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
550
551/* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
552 * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
553OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
554
555/* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
556OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
557
558/* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
559 * one on success and zero on failure. The caller retains ownership of |x509|
560 * and may release it freely. */
561OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
562
563/* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
564 * one. */
565OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
566
567/* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
568OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
569
570/* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
571OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
572
David Benjamin7481d392015-07-05 19:38:46 -0400573/* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
574 * The callback returns one on success, zero on internal error, and a negative
575 * number on failure or to pause the handshake. If the handshake is paused,
576 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
577OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
578 int (*cb)(SSL *ssl, void *arg),
579 void *arg);
580
581/* SSL_set_cert_cb sets a callback that is called to select a certificate. The
582 * callback returns one on success, zero on internal error, and a negative
583 * number on failure or to pause the handshake. If the handshake is paused,
584 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
585OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
586 void *arg);
587
588/* SSL_certs_clear resets the private key, leaf certificate, and certificate
589 * chain of |ssl|. */
590OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
591
592/* SSL_CTX_check_private_key returns one if the certificate and private key
593 * configured in |ctx| are consistent and zero otherwise. */
594OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
595
596/* SSL_check_private_key returns one if the certificate and private key
597 * configured in |ssl| are consistent and zero otherwise. */
598OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
599
600/* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
601OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
602
603/* SSL_get_certificate returns |ssl|'s leaf certificate. */
604OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
605
David Benjamin11c0f8e2015-07-06 00:18:15 -0400606/* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
607OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
608
609/* SSL_get_privatekey returns |ssl|'s private key. */
610OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
611
612/* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
613 * returns one. */
614OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
615 STACK_OF(X509) **out_chain);
616
617/* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
618OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
619 STACK_OF(X509) **out_chain);
620
621/* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
622 * returns one. */
623OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
624 STACK_OF(X509) **out_chain);
625
David Benjamin7481d392015-07-05 19:38:46 -0400626
627/* Certificate and private key convenience functions. */
628
629/* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
630 * on success and zero on failure. */
631OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
632
633/* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
634 * success and zero on failure. */
635OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
636
637/* The following functions configure certificates or private keys but take as
638 * input DER-encoded structures. They return one on success and zero on
639 * failure. */
640
641OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
642 const uint8_t *d);
643OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
644 int len);
645
646OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
647 const uint8_t *d, long len);
648OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
649 const uint8_t *d, long len);
650
651OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
652 const uint8_t *d,
653 long len);
654OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, uint8_t *d, long len);
655
656/* The following functions configure certificates or private keys but take as
657 * input files to read from. They return one on success and zero on failure. The
658 * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
659 * the file's contents are read as PEM or DER. */
660
661#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
662#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
663
664OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
665 const char *file,
666 int type);
667OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
668 int type);
669
670OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
671 int type);
672OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
673 int type);
674
675OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
676 int type);
677OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
678 int type);
679
680/* SSL_CTX_use_certificate_file configures certificates for |ctx|. It reads the
681 * contents of |file| as a PEM-encoded leaf certificate followed optionally by
682 * the certificate chain to send to the peer. It returns one on success and zero
683 * on failure. */
684OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
685 const char *file);
686
687
688/* Custom private keys. */
689
David Benjaminb4d65fd2015-05-29 17:11:21 -0400690enum ssl_private_key_result_t {
691 ssl_private_key_success,
692 ssl_private_key_retry,
693 ssl_private_key_failure,
694};
695
696/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
697 * signing operations to a custom, potentially asynchronous, backend. */
698typedef struct ssl_private_key_method_st {
699 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
700 * key used by |ssl|. */
701 int (*type)(SSL *ssl);
702
703 /* supports_digest returns one if the key used by |ssl| supports signing
704 * digests of type |md| and zero otherwise. */
705 int (*supports_digest)(SSL *ssl, const EVP_MD *md);
706
707 /* max_signature_len returns the maximum length of a signature signed by the
708 * key used by |ssl|. This must be a constant value for a given |ssl|. */
709 size_t (*max_signature_len)(SSL *ssl);
710
711 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
712 * used to calculate |in|. On success, it returns |ssl_private_key_success|
713 * and writes at most |max_out| bytes of signature data to |out|. On failure,
714 * it returns |ssl_private_key_failure|. If the operation has not completed,
715 * it returns |ssl_private_key_retry|. |sign| should arrange for the
716 * high-level operation on |ssl| to be retried when the operation is
717 * completed. This will result in a call to |sign_complete|.
718 *
719 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
720 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
721 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
722 *
723 * It is an error to call |sign| while another private key operation is in
724 * progress on |ssl|. */
725 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
726 size_t max_out, const EVP_MD *md,
727 const uint8_t *in, size_t in_len);
728
729 /* sign_complete completes a pending |sign| operation. If the operation has
730 * completed, it returns |ssl_private_key_success| and writes the result to
731 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
732 * failure and |ssl_private_key_retry| if the operation is still in progress.
733 *
734 * |sign_complete| may be called arbitrarily many times before completion, but
735 * it is an error to call |sign_complete| if there is no pending |sign|
736 * operation in progress on |ssl|. */
737 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
738 size_t *out_len, size_t max_out);
739} SSL_PRIVATE_KEY_METHOD;
740
David Benjamind1d80782015-07-05 11:54:09 -0400741/* SSL_use_private_key_method configures a custom private key on |ssl|.
742 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400743OPENSSL_EXPORT void SSL_set_private_key_method(
744 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
745
746
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700747/* Connection information. */
748
749/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
750 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
751 * returns one on success or zero on error. In general |max_out| should be at
752 * least 12.
753 *
754 * This function will always fail if the initial handshake has not completed.
755 * The tls-unique value will change after a renegotiation but, since
756 * renegotiations can be initiated by the server at any point, the higher-level
757 * protocol must either leave them disabled or define states in which the
758 * tls-unique value can be read.
759 *
760 * The tls-unique value is defined by
761 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
762 * TLS protocol, tls-unique is broken for resumed connections unless the
763 * Extended Master Secret extension is negotiated. Thus this function will
764 * return zero if |ssl| performed session resumption unless EMS was used when
765 * negotiating the original session. */
766OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
767 size_t *out_len, size_t max_out);
768
769
David Benjamindaeafc22015-06-25 17:35:11 -0400770/* Session tickets. */
771
772/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
773 * |len| bytes of |out|. It returns one on success and zero if |len| is not
774 * 48. If |out| is NULL, it returns 48 instead. */
775OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
776 size_t len);
777
778/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
779 * |len| bytes of |in|. It returns one on success and zero if |len| is not
780 * 48. If |in| is NULL, it returns 48 instead. */
781OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
782 size_t len);
783
David Benjamine3aa1d92015-06-16 15:34:50 -0400784/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
785 * ticket. */
786#define SSL_TICKET_KEY_NAME_LEN 16
787
David Benjamindaeafc22015-06-25 17:35:11 -0400788/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
789 * returns one. |callback| will be called when encrypting a new ticket and when
790 * decrypting a ticket from the client.
791 *
792 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
793 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
794 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
795 * for encryption or decryption, based on the mode.
796 *
797 * When encrypting a new ticket, |encrypt| will be one. It writes a public
798 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
799 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
800 * |callback| returns 1 on success and -1 on error.
801 *
802 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
803 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
804 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
805 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
806 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
807 * This may be used to re-key the ticket.
808 *
809 * WARNING: |callback| wildly breaks the usual return value convention and is
810 * called in two different modes. */
811OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
812 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
813 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
814 int encrypt));
815
816
David Benjamin71f07942015-04-08 02:36:59 -0400817/* Underdocumented functions.
818 *
819 * Functions below here haven't been touched up and may be underdocumented. */
820
Adam Langley95c29f32014-06-20 12:00:00 -0700821/* SSLeay version number for ASN.1 encoding of the session information */
822/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -0800823 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -0700824#define SSL_SESSION_ASN1_VERSION 0x0001
825
Adam Langleyb4a494c2015-01-23 15:10:10 -0800826#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
827#define SSL_MAX_SID_CTX_LENGTH 32
828#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -0700829
830/* These are used to specify which ciphers to use and not to use */
831
Adam Langleyb4a494c2015-01-23 15:10:10 -0800832#define SSL_TXT_MEDIUM "MEDIUM"
833#define SSL_TXT_HIGH "HIGH"
834#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -0700835
Adam Langleyb4a494c2015-01-23 15:10:10 -0800836#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -0400837#define SSL_TXT_kDHE "kDHE"
838#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
839#define SSL_TXT_kECDHE "kECDHE"
840#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800841#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700842
Adam Langleyb4a494c2015-01-23 15:10:10 -0800843#define SSL_TXT_aRSA "aRSA"
844#define SSL_TXT_aECDSA "aECDSA"
845#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700846
Adam Langleyb4a494c2015-01-23 15:10:10 -0800847#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400848#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400849#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800850#define SSL_TXT_RSA "RSA"
851#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -0400852#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -0400853#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800854#define SSL_TXT_ECDSA "ECDSA"
855#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -0700856
Adam Langleyb4a494c2015-01-23 15:10:10 -0800857#define SSL_TXT_3DES "3DES"
858#define SSL_TXT_RC4 "RC4"
859#define SSL_TXT_AES128 "AES128"
860#define SSL_TXT_AES256 "AES256"
861#define SSL_TXT_AES "AES"
862#define SSL_TXT_AES_GCM "AESGCM"
863#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -0700864
Adam Langleyb4a494c2015-01-23 15:10:10 -0800865#define SSL_TXT_MD5 "MD5"
866#define SSL_TXT_SHA1 "SHA1"
867#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
868#define SSL_TXT_SHA256 "SHA256"
869#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -0700870
Adam Langleyb4a494c2015-01-23 15:10:10 -0800871#define SSL_TXT_SSLV3 "SSLv3"
872#define SSL_TXT_TLSV1 "TLSv1"
873#define SSL_TXT_TLSV1_1 "TLSv1.1"
874#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -0700875
Adam Langleyb4a494c2015-01-23 15:10:10 -0800876#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -0700877
Adam Langleyb4a494c2015-01-23 15:10:10 -0800878/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
879 * normally not being used.
880 *
881 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
882 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
883 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
884 * that it is also disabled in the specific selection. COMPLEMENTOF*
885 * identifiers are portable between version, as adjustments to the default
886 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -0700887 *
888 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -0800889 * DEFAULT gets, as only selection is being done and no sorting as needed for
890 * DEFAULT. */
891#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -0700892
Adam Langleyb4a494c2015-01-23 15:10:10 -0800893/* The following cipher list is used by default. It also is substituted when an
894 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -0400895#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -0800896
Adam Langley95c29f32014-06-20 12:00:00 -0700897/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
898 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -0800899 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
900 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -0700901
902/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800903#define SSL_SENT_SHUTDOWN 1
904#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -0700905
David Benjamin82c9e902014-12-12 15:55:27 -0500906typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700907typedef struct ssl_session_st SSL_SESSION;
Adam Langley95c29f32014-06-20 12:00:00 -0700908typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -0500909typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -0700910
Adam Langleyb4a494c2015-01-23 15:10:10 -0800911/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
912typedef struct srtp_protection_profile_st {
913 const char *name;
914 unsigned long id;
915} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -0700916
917DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
918
David Benjamin83fd6b62014-10-19 04:33:38 -0400919/* An SSL_SESSION represents an SSL session that may be resumed in an
920 * abbreviated handshake. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800921struct ssl_session_st {
922 int ssl_version; /* what ssl version session info is being kept in here? */
Adam Langley95c29f32014-06-20 12:00:00 -0700923
Adam Langleyb4a494c2015-01-23 15:10:10 -0800924 int master_key_length;
925 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
926 /* session_id - valid? */
927 unsigned int session_id_length;
928 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
929 /* this is used to determine whether the session is being reused in
930 * the appropriate context. It is up to the application to set this,
931 * via SSL_new */
932 unsigned int sid_ctx_length;
933 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -0700934
Adam Langleyb4a494c2015-01-23 15:10:10 -0800935 char *psk_identity;
936 /* Used to indicate that session resumption is not allowed. Applications can
937 * also set this bit for a new session via not_resumable_session_cb to
938 * disable session caching and tickets. */
939 int not_resumable;
Adam Langley95c29f32014-06-20 12:00:00 -0700940
David Benjamin680ca962015-06-18 12:37:23 -0400941 /* The cert is the certificate used to establish this connection
942 *
943 * TODO(davidben): Remove this field. It is not serialized as part of the
944 * session, but some APIs access it. Certificate-related fields, where not
945 * redundant with |peer|, should be added to the session. Others should
946 * probably not be retained across resumptions. */
Adam Langleyb4a494c2015-01-23 15:10:10 -0800947 struct sess_cert_st /* SESS_CERT */ *sess_cert;
Adam Langley95c29f32014-06-20 12:00:00 -0700948
Adam Langleyb4a494c2015-01-23 15:10:10 -0800949 /* This is the cert for the other end. On clients, it will be the same as
950 * sess_cert->peer_key->x509 (the latter is not enough as sess_cert is not
951 * retained in the external representation of sessions, see ssl_asn1.c). */
952 X509 *peer;
953 /* when app_verify_callback accepts a session where the peer's certificate is
954 * not ok, we must remember the error for session reuse: */
955 long verify_result; /* only for servers */
Adam Langley95c29f32014-06-20 12:00:00 -0700956
Adam Langley0b5e3902015-05-15 13:08:38 -0700957 CRYPTO_refcount_t references;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800958 long timeout;
959 long time;
Adam Langley95c29f32014-06-20 12:00:00 -0700960
Adam Langleyb4a494c2015-01-23 15:10:10 -0800961 const SSL_CIPHER *cipher;
Adam Langley95c29f32014-06-20 12:00:00 -0700962
Adam Langleyb4a494c2015-01-23 15:10:10 -0800963 CRYPTO_EX_DATA ex_data; /* application specific data */
Adam Langley95c29f32014-06-20 12:00:00 -0700964
Adam Langleyb4a494c2015-01-23 15:10:10 -0800965 /* These are used to make removal of session-ids more efficient and to
966 * implement a maximum cache size. */
David Benjamin4dab2972015-05-16 02:56:06 -0400967 SSL_SESSION *prev, *next;
Adam Langleyb4a494c2015-01-23 15:10:10 -0800968 char *tlsext_hostname;
969 /* RFC4507 info */
970 uint8_t *tlsext_tick; /* Session ticket */
971 size_t tlsext_ticklen; /* Session ticket length */
972 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
David Benjamin6c7aed02014-08-27 16:42:38 -0400973
Adam Langleyb4a494c2015-01-23 15:10:10 -0800974 size_t tlsext_signed_cert_timestamp_list_length;
975 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
David Benjamin6c7aed02014-08-27 16:42:38 -0400976
Adam Langleyb4a494c2015-01-23 15:10:10 -0800977 /* The OCSP response that came with the session. */
978 size_t ocsp_response_length;
979 uint8_t *ocsp_response;
David Benjamin6c7aed02014-08-27 16:42:38 -0400980
Adam Langleyb4a494c2015-01-23 15:10:10 -0800981 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
982 uint8_t
983 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
Adam Langley1258b6a2014-06-20 12:00:00 -0700984
Adam Langleyb4a494c2015-01-23 15:10:10 -0800985 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
986 * SHA-2, depending on TLS version) for the original, full handshake that
987 * created a session. This is used by Channel IDs during resumption. */
988 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
989 unsigned int original_handshake_hash_len;
Adam Langley75712922014-10-10 16:23:43 -0700990
Adam Langleyb4a494c2015-01-23 15:10:10 -0800991 /* extended_master_secret is true if the master secret in this session was
992 * generated using EMS and thus isn't vulnerable to the Triple Handshake
993 * attack. */
994 char extended_master_secret;
995};
Adam Langley95c29f32014-06-20 12:00:00 -0700996
Adam Langley95c29f32014-06-20 12:00:00 -0700997
David Benjamincb9cf792015-05-05 09:46:14 -0400998/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
999 * and zero on failure. */
1000OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -07001001
David Benjamincb9cf792015-05-05 09:46:14 -04001002/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
1003 * renegotiation (RFC 5746) and zero otherwise. */
1004OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001005
David Benjamin59015c32015-04-26 13:13:55 -04001006/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
1007 * This callback will be called when sending or receiving low-level record
1008 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
1009 * |write_p| is one for outgoing messages and zero for incoming messages.
1010 *
1011 * For each record header, |cb| is called with |version| = 0 and |content_type|
1012 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
1013 * this does not include the record body. If the record is sealed, the length
1014 * in the header is the length of the ciphertext.
1015 *
1016 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
1017 * protocol version and |content_type| is the corresponding record type. The
1018 * |len| bytes from |buf| contain the handshake message, one-byte
1019 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001020OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
1021 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
1022 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001023
David Benjamin61ecccf2015-05-05 09:44:51 -04001024/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
1025 * callback. */
1026OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
1027
David Benjamin59015c32015-04-26 13:13:55 -04001028/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
1029 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001030OPENSSL_EXPORT void SSL_set_msg_callback(
1031 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
1032 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001033
David Benjamin3b7456e2015-05-16 12:29:32 -04001034/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -04001035OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07001036
David Benjamin859ec3c2014-09-02 16:29:36 -04001037/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -08001038 * log session material to |keylog_bio|. This is intended for debugging use
1039 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -04001040 *
1041 * The format is described in
1042 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -04001043OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -04001044
Adam Langley95c29f32014-06-20 12:00:00 -07001045
Adam Langleyc9fb3752014-06-20 12:00:00 -07001046struct ssl_aead_ctx_st;
1047typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
1048
Adam Langleyb4a494c2015-01-23 15:10:10 -08001049#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -07001050
Adam Langleyb4a494c2015-01-23 15:10:10 -08001051#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -07001052
David Benjaminf4501342014-08-14 17:24:37 -04001053#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
1054
Adam Langleyb4a494c2015-01-23 15:10:10 -08001055/* This callback type is used inside SSL_CTX, SSL, and in the functions that
1056 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -07001057 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001058 * callbacks should themselves check if the id they generate is unique
1059 * otherwise the SSL handshake will fail with an error - callbacks can do this
1060 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -07001061 * SSL_has_matching_session_id(ssl, id, *id_len)
1062 * The length value passed in is set at the maximum size the session ID can be.
1063 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
1064 * can alter this length to be less if desired, but under SSLv2 session IDs are
1065 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -08001066 * returns in this case. It is also an error for the callback to set the size
1067 * to zero. */
1068typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
1069 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001070
Adam Langleydc9b1412014-06-20 12:00:00 -07001071/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -08001072 * early on during the server handshake. At this point, much of the SSL* hasn't
1073 * been filled out and only the ClientHello can be depended on. */
1074struct ssl_early_callback_ctx {
1075 SSL *ssl;
1076 const uint8_t *client_hello;
1077 size_t client_hello_len;
1078 const uint8_t *session_id;
1079 size_t session_id_len;
1080 const uint8_t *cipher_suites;
1081 size_t cipher_suites_len;
1082 const uint8_t *compression_methods;
1083 size_t compression_methods_len;
1084 const uint8_t *extensions;
1085 size_t extensions_len;
1086};
Adam Langleydc9b1412014-06-20 12:00:00 -07001087
Adam Langleyb4a494c2015-01-23 15:10:10 -08001088/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
1089 * extension of the given type. If not found, it returns zero. Otherwise it
1090 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -07001091 * and length bytes), sets |out_len| to the length of the extension contents
1092 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001093OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
1094 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
1095 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -07001096
Adam Langley95c29f32014-06-20 12:00:00 -07001097typedef struct ssl_comp_st SSL_COMP;
1098
Adam Langleyb4a494c2015-01-23 15:10:10 -08001099struct ssl_comp_st {
1100 int id;
1101 const char *name;
1102 char *method;
1103};
Adam Langley95c29f32014-06-20 12:00:00 -07001104
1105DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -07001106DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -07001107
Adam Langley858a88d2014-06-20 12:00:00 -07001108/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
1109 * equal-preference groups. For TLS clients, the groups are moot because the
1110 * server picks the cipher and groups cannot be expressed on the wire. However,
1111 * for servers, the equal-preference groups allow the client's preferences to
1112 * be partially respected. (This only has an effect with
1113 * SSL_OP_CIPHER_SERVER_PREFERENCE).
1114 *
1115 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
1116 * All elements of a group have the same priority: no ordering is expressed
1117 * within a group.
1118 *
1119 * The values in |ciphers| are in one-to-one correspondence with
1120 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
1121 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
1122 * indicate that the corresponding SSL_CIPHER is not the last element of a
1123 * group, or 0 to indicate that it is.
1124 *
1125 * For example, if |in_group_flags| contains all zeros then that indicates a
1126 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
1127 * of the group (i.e. they are all in a one-element group).
1128 *
1129 * For a more complex example, consider:
1130 * ciphers: A B C D E F
1131 * in_group_flags: 1 1 0 0 1 0
1132 *
1133 * That would express the following, order:
1134 *
1135 * A E
1136 * B -> D -> F
1137 * C
1138 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001139struct ssl_cipher_preference_list_st {
1140 STACK_OF(SSL_CIPHER) *ciphers;
1141 uint8_t *in_group_flags;
1142};
Adam Langley858a88d2014-06-20 12:00:00 -07001143
Adam Langleyb4a494c2015-01-23 15:10:10 -08001144struct ssl_ctx_st {
1145 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001146
Adam Langley4bdb6e42015-05-15 15:29:21 -07001147 /* lock is used to protect various operations on this object. */
1148 CRYPTO_MUTEX lock;
1149
Adam Langleyb4a494c2015-01-23 15:10:10 -08001150 /* max_version is the maximum acceptable protocol version. If zero, the
1151 * maximum supported version, currently (D)TLS 1.2, is used. */
1152 uint16_t max_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001153
Adam Langleyb4a494c2015-01-23 15:10:10 -08001154 /* min_version is the minimum acceptable protocl version. If zero, the
1155 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1156 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001157
Adam Langleyb4a494c2015-01-23 15:10:10 -08001158 struct ssl_cipher_preference_list_st *cipher_list;
1159 /* same as above but sorted for lookup */
1160 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1161 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
1162 * use. This only applies to server connections as, for clients, the version
1163 * number is known at connect time and so the cipher list can be set then. */
1164 struct ssl_cipher_preference_list_st *cipher_list_tls11;
Adam Langley95c29f32014-06-20 12:00:00 -07001165
David Benjamin4dab2972015-05-16 02:56:06 -04001166 X509_STORE *cert_store;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001167 LHASH_OF(SSL_SESSION) *sessions;
1168 /* Most session-ids that will be cached, default is
1169 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
1170 unsigned long session_cache_size;
David Benjamin4dab2972015-05-16 02:56:06 -04001171 SSL_SESSION *session_cache_head;
1172 SSL_SESSION *session_cache_tail;
Adam Langley95c29f32014-06-20 12:00:00 -07001173
David Benjaminb6d0c6d2015-03-19 19:07:26 -04001174 /* handshakes_since_cache_flush is the number of successful handshakes since
1175 * the last cache flush. */
1176 int handshakes_since_cache_flush;
1177
Adam Langleyb4a494c2015-01-23 15:10:10 -08001178 /* This can have one of 2 values, ored together,
1179 * SSL_SESS_CACHE_CLIENT,
1180 * SSL_SESS_CACHE_SERVER,
1181 * Default is SSL_SESSION_CACHE_SERVER, which means only
1182 * SSL_accept which cache SSL_SESSIONS. */
1183 int session_cache_mode;
Adam Langley95c29f32014-06-20 12:00:00 -07001184
Adam Langleyb4a494c2015-01-23 15:10:10 -08001185 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
1186 * called. This has been put in to make life easier to set things up */
1187 long session_timeout;
Adam Langley95c29f32014-06-20 12:00:00 -07001188
Adam Langleyb4a494c2015-01-23 15:10:10 -08001189 /* If this callback is not null, it will be called each time a session id is
1190 * added to the cache. If this function returns 1, it means that the
1191 * callback will do a SSL_SESSION_free() when it has finished using it.
1192 * Otherwise, on 0, it means the callback has finished with it. If
1193 * remove_session_cb is not null, it will be called when a session-id is
1194 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
1195 * it. */
David Benjamin4dab2972015-05-16 02:56:06 -04001196 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
1197 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
1198 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001199 int *copy);
Adam Langley95c29f32014-06-20 12:00:00 -07001200
Adam Langley0b5e3902015-05-15 13:08:38 -07001201 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -07001202
Adam Langleyb4a494c2015-01-23 15:10:10 -08001203 /* if defined, these override the X509_verify_cert() calls */
1204 int (*app_verify_callback)(X509_STORE_CTX *, void *);
1205 void *app_verify_arg;
1206 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
1207 * was called with just one argument) */
Adam Langley95c29f32014-06-20 12:00:00 -07001208
Adam Langleyb4a494c2015-01-23 15:10:10 -08001209 /* Default password callback. */
1210 pem_password_cb *default_passwd_callback;
Adam Langley95c29f32014-06-20 12:00:00 -07001211
Adam Langleyb4a494c2015-01-23 15:10:10 -08001212 /* Default password callback user data. */
1213 void *default_passwd_callback_userdata;
Adam Langley95c29f32014-06-20 12:00:00 -07001214
Adam Langleyb4a494c2015-01-23 15:10:10 -08001215 /* get client cert callback */
1216 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
Adam Langley95c29f32014-06-20 12:00:00 -07001217
Adam Langleyb4a494c2015-01-23 15:10:10 -08001218 /* get channel id callback */
1219 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
Adam Langley1258b6a2014-06-20 12:00:00 -07001220
Adam Langleyb4a494c2015-01-23 15:10:10 -08001221 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001222
Adam Langley95c29f32014-06-20 12:00:00 -07001223
Adam Langleyb4a494c2015-01-23 15:10:10 -08001224 /* Default values used when no per-SSL value is defined follow */
Adam Langley95c29f32014-06-20 12:00:00 -07001225
Adam Langleyb4a494c2015-01-23 15:10:10 -08001226 void (*info_callback)(const SSL *ssl, int type,
1227 int val); /* used if SSL's info_callback is NULL */
Adam Langley95c29f32014-06-20 12:00:00 -07001228
Adam Langleyb4a494c2015-01-23 15:10:10 -08001229 /* what we put in client cert requests */
1230 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001231
1232
Adam Langleyb4a494c2015-01-23 15:10:10 -08001233 /* Default values to use in SSL structures follow (these are copied by
1234 * SSL_new) */
Adam Langley95c29f32014-06-20 12:00:00 -07001235
David Benjamin123a8fd2015-04-26 14:16:41 -04001236 uint32_t options;
1237 uint32_t mode;
David Benjamin1d0a1942015-04-26 15:35:35 -04001238 uint32_t max_cert_list;
Adam Langley95c29f32014-06-20 12:00:00 -07001239
Adam Langleyb4a494c2015-01-23 15:10:10 -08001240 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001241
Adam Langleyb4a494c2015-01-23 15:10:10 -08001242 /* callback that allows applications to peek at protocol messages */
1243 void (*msg_callback)(int write_p, int version, int content_type,
1244 const void *buf, size_t len, SSL *ssl, void *arg);
1245 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001246
Adam Langleyb4a494c2015-01-23 15:10:10 -08001247 int verify_mode;
1248 unsigned int sid_ctx_length;
1249 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1250 int (*default_verify_callback)(
1251 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
Adam Langley95c29f32014-06-20 12:00:00 -07001252
Adam Langleyb4a494c2015-01-23 15:10:10 -08001253 /* Default generate session ID callback. */
1254 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001255
Adam Langleyb4a494c2015-01-23 15:10:10 -08001256 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001257
Adam Langleyb4a494c2015-01-23 15:10:10 -08001258 /* select_certificate_cb is called before most ClientHello processing and
1259 * before the decision whether to resume a session is made. It may return one
1260 * to continue the handshake or zero to cause the handshake loop to return
1261 * with an error and cause SSL_get_error to return
David Benjamin6f5c0f42015-02-24 01:23:21 -05001262 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
1263 * will not call the callback a second time. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001264 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
Adam Langleydc9b1412014-06-20 12:00:00 -07001265
Adam Langley524e7172015-02-20 16:04:00 -08001266 /* dos_protection_cb is called once the resumption decision for a ClientHello
1267 * has been made. It returns one to continue the handshake or zero to
1268 * abort. */
1269 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
1270
Adam Langleyb4a494c2015-01-23 15:10:10 -08001271 /* quiet_shutdown is true if the connection should not send a close_notify on
1272 * shutdown. */
1273 int quiet_shutdown;
Adam Langley95c29f32014-06-20 12:00:00 -07001274
Adam Langleyb4a494c2015-01-23 15:10:10 -08001275 /* Maximum amount of data to send in one fragment. actual record size can be
1276 * more than this due to padding and MAC overheads. */
David Benjamin1d0a1942015-04-26 15:35:35 -04001277 uint16_t max_send_fragment;
Adam Langley95c29f32014-06-20 12:00:00 -07001278
Adam Langleyb4a494c2015-01-23 15:10:10 -08001279 /* TLS extensions servername callback */
1280 int (*tlsext_servername_callback)(SSL *, int *, void *);
1281 void *tlsext_servername_arg;
1282 /* RFC 4507 session ticket keys */
David Benjamine3aa1d92015-06-16 15:34:50 -04001283 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
Adam Langleyb4a494c2015-01-23 15:10:10 -08001284 uint8_t tlsext_tick_hmac_key[16];
1285 uint8_t tlsext_tick_aes_key[16];
1286 /* Callback to support customisation of ticket key setting */
1287 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
1288 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
Adam Langley95c29f32014-06-20 12:00:00 -07001289
Adam Langleyb4a494c2015-01-23 15:10:10 -08001290 /* Server-only: psk_identity_hint is the default identity hint to send in
1291 * PSK-based key exchanges. */
1292 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001293
Adam Langleyb4a494c2015-01-23 15:10:10 -08001294 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1295 char *identity,
1296 unsigned int max_identity_len,
1297 uint8_t *psk, unsigned int max_psk_len);
1298 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1299 uint8_t *psk, unsigned int max_psk_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001300
Alex Chernyakhovskya40c8622014-08-03 15:46:36 -04001301
Adam Langleyb4a494c2015-01-23 15:10:10 -08001302 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
1303 * hash of the peer's certifiate and then discard it to save memory and
1304 * session space. Only effective on the server side. */
1305 char retain_only_sha256_of_client_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001306
Adam Langleyb4a494c2015-01-23 15:10:10 -08001307 /* Next protocol negotiation information */
1308 /* (for experimental NPN extension). */
Adam Langley95c29f32014-06-20 12:00:00 -07001309
Adam Langleyb4a494c2015-01-23 15:10:10 -08001310 /* For a server, this contains a callback function by which the set of
1311 * advertised protocols can be provided. */
1312 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
1313 unsigned int *len, void *arg);
1314 void *next_protos_advertised_cb_arg;
1315 /* For a client, this contains a callback function that selects the
1316 * next protocol from the list provided by the server. */
1317 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
1318 const uint8_t *in, unsigned int inlen, void *arg);
1319 void *next_proto_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001320
Adam Langleyb4a494c2015-01-23 15:10:10 -08001321 /* ALPN information
1322 * (we are in the process of transitioning from NPN to ALPN.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001323
Adam Langleyb4a494c2015-01-23 15:10:10 -08001324 /* For a server, this contains a callback function that allows the
1325 * server to select the protocol for the connection.
1326 * out: on successful return, this must point to the raw protocol
1327 * name (without the length prefix).
1328 * outlen: on successful return, this contains the length of |*out|.
1329 * in: points to the client's list of supported protocols in
1330 * wire-format.
1331 * inlen: the length of |in|. */
1332 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
1333 const uint8_t *in, unsigned int inlen, void *arg);
1334 void *alpn_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001335
Adam Langleyb4a494c2015-01-23 15:10:10 -08001336 /* For a client, this contains the list of supported protocols in wire
1337 * format. */
1338 uint8_t *alpn_client_proto_list;
1339 unsigned alpn_client_proto_list_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001340
Adam Langleyb4a494c2015-01-23 15:10:10 -08001341 /* SRTP profiles we are willing to do from RFC 5764 */
1342 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001343
Adam Langleyb4a494c2015-01-23 15:10:10 -08001344 /* EC extension values inherited by SSL structure */
1345 size_t tlsext_ecpointformatlist_length;
1346 uint8_t *tlsext_ecpointformatlist;
1347 size_t tlsext_ellipticcurvelist_length;
1348 uint16_t *tlsext_ellipticcurvelist;
Adam Langley1258b6a2014-06-20 12:00:00 -07001349
Adam Langleyb4a494c2015-01-23 15:10:10 -08001350 /* If true, a client will advertise the Channel ID extension and a server
1351 * will echo it. */
1352 char tlsext_channel_id_enabled;
1353 /* tlsext_channel_id_enabled_new is a hack to support both old and new
1354 * ChannelID signatures. It indicates that a client should advertise the new
1355 * ChannelID extension number. */
1356 char tlsext_channel_id_enabled_new;
1357 /* The client's Channel ID private key. */
1358 EVP_PKEY *tlsext_channel_id_private;
David Benjamin6c7aed02014-08-27 16:42:38 -04001359
Adam Langleyb4a494c2015-01-23 15:10:10 -08001360 /* If true, a client will request certificate timestamps. */
1361 char signed_cert_timestamps_enabled;
David Benjamin859ec3c2014-09-02 16:29:36 -04001362
Adam Langleyb4a494c2015-01-23 15:10:10 -08001363 /* If true, a client will request a stapled OCSP response. */
1364 char ocsp_stapling_enabled;
Adam Langley95c29f32014-06-20 12:00:00 -07001365
Adam Langleyb4a494c2015-01-23 15:10:10 -08001366 /* If not NULL, session key material will be logged to this BIO for debugging
1367 * purposes. The format matches NSS's and is readable by Wireshark. */
1368 BIO *keylog_bio;
David Benjamin377fc312015-01-26 00:22:12 -05001369
1370 /* current_time_cb, if not NULL, is the function to use to get the current
1371 * time. It sets |*out_clock| to the current time. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001372 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001373};
Adam Langley95c29f32014-06-20 12:00:00 -07001374
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001375OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001376
1377/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1378 * session cache. */
1379OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001380
Adam Langleyb4a494c2015-01-23 15:10:10 -08001381OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001382 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1383OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001384 SSL_SESSION *sess);
1385OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1386 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001387 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001388OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001389 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001390OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1391 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001392 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001393 int *copy));
1394OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001395 SSL *ssl, uint8_t *data, int len, int *copy);
Adam Langleyb2ce0582014-06-20 12:00:00 -07001396/* SSL_magic_pending_session_ptr returns a magic SSL_SESSION* which indicates
1397 * that the session isn't currently unavailable. SSL_get_error will then return
1398 * SSL_ERROR_PENDING_SESSION and the handshake can be retried later when the
1399 * lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001400OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001401OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1402 void (*cb)(const SSL *ssl,
1403 int type, int val));
1404OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1405 int type,
1406 int val);
1407OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1408 SSL_CTX *ctx,
1409 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1410OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1411 X509 **x509,
1412 EVP_PKEY **pkey);
1413OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1414 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1415OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1416 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001417
Adam Langleyb4a494c2015-01-23 15:10:10 -08001418/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1419 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001420 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001421OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1422
Adam Langleyb4a494c2015-01-23 15:10:10 -08001423/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1424 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001425OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1426
David Benjamin3b7456e2015-05-16 12:29:32 -04001427/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1428 * connection) to request a stapled OCSP response from the server. It returns
1429 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001430OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1431
1432/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1433 * created from |ctx|. */
1434OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1435
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001436/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1437 * |*out_len| bytes of SCT information from the server. This is only valid if
1438 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1439 * (including the two leading length bytes).
1440 * See https://tools.ietf.org/html/rfc6962#section-3.3
1441 * If no SCT was received then |*out_len| will be zero on return.
1442 *
1443 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001444OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001445 const uint8_t **out,
1446 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001447
David Benjamin6c7aed02014-08-27 16:42:38 -04001448/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1449 * bytes of an OCSP response from the server. This is the DER encoding of an
1450 * OCSPResponse type as defined in RFC 2560.
1451 *
1452 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001453OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1454 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001455
Adam Langleyb4a494c2015-01-23 15:10:10 -08001456OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1457 SSL_CTX *s,
1458 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1459 void *arg);
1460OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1461 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1462 const uint8_t *in, unsigned int inlen, void *arg),
1463 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001464OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001465 const uint8_t **data,
1466 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001467
Adam Langleyb4a494c2015-01-23 15:10:10 -08001468OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1469 const uint8_t *in, unsigned int inlen,
1470 const uint8_t *client,
1471 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001472
Adam Langleyb4a494c2015-01-23 15:10:10 -08001473#define OPENSSL_NPN_UNSUPPORTED 0
1474#define OPENSSL_NPN_NEGOTIATED 1
1475#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001476
David Benjamin9d0847a2015-02-16 03:57:55 -05001477/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1478 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1479 * length-prefixed strings). It returns zero on success and one on failure.
1480 *
1481 * WARNING: this function is dangerous because it breaks the usual return value
1482 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001483OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1484 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001485
1486/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1487 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1488 * length-prefixed strings). It returns zero on success and one on failure.
1489 *
1490 * WARNING: this function is dangerous because it breaks the usual return value
1491 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001492OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1493 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001494
Adam Langleyb4a494c2015-01-23 15:10:10 -08001495OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1496 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1497 const uint8_t *in, unsigned int inlen, void *arg),
1498 void *arg);
1499OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1500 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001501
1502/* SSL_enable_fastradio_padding controls whether fastradio padding is enabled
1503 * on |ssl|. If it is, ClientHello messages are padded to 1024 bytes. This
1504 * causes 3G radios to switch to DCH mode (high data rate). */
1505OPENSSL_EXPORT void SSL_enable_fastradio_padding(SSL *ssl, char on_off);
1506
David Benjaminb16346b2015-04-08 19:16:58 -04001507/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1508 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001509 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001510 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001511OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1512
Adam Langleyb4a494c2015-01-23 15:10:10 -08001513/* the maximum length of the buffer given to callbacks containing the resulting
1514 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001515#define PSK_MAX_IDENTITY_LEN 128
1516#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001517OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1518 SSL_CTX *ctx,
1519 unsigned int (*psk_client_callback)(
1520 SSL *ssl, const char *hint, char *identity,
1521 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1522OPENSSL_EXPORT void SSL_set_psk_client_callback(
1523 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1524 char *identity,
1525 unsigned int max_identity_len,
1526 uint8_t *psk,
1527 unsigned int max_psk_len));
1528OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1529 SSL_CTX *ctx,
1530 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1531 uint8_t *psk,
1532 unsigned int max_psk_len));
1533OPENSSL_EXPORT void SSL_set_psk_server_callback(
1534 SSL *ssl,
1535 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1536 uint8_t *psk,
1537 unsigned int max_psk_len));
1538OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1539 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001540OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1541OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1542OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001543
Adam Langleyb4a494c2015-01-23 15:10:10 -08001544#define SSL_NOTHING 1
1545#define SSL_WRITING 2
1546#define SSL_READING 3
1547#define SSL_X509_LOOKUP 4
1548#define SSL_CHANNEL_ID_LOOKUP 5
1549#define SSL_PENDING_SESSION 7
1550#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04001551#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07001552
1553/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001554#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1555#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1556#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1557#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1558#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1559#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1560#define SSL_want_certificate(s) \
1561 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04001562#define SSL_want_private_key_operation(s) \
1563 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07001564
Adam Langleyb4a494c2015-01-23 15:10:10 -08001565struct ssl_st {
1566 /* version is the protocol version. */
1567 int version;
Adam Langley95c29f32014-06-20 12:00:00 -07001568
Adam Langleyb4a494c2015-01-23 15:10:10 -08001569 /* method is the method table corresponding to the current protocol (DTLS or
1570 * TLS). */
1571 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001572
Adam Langleyb4a494c2015-01-23 15:10:10 -08001573 /* enc_method is the method table corresponding to the current protocol
1574 * version. */
1575 const SSL3_ENC_METHOD *enc_method;
David Benjamine99e9122014-12-11 01:46:01 -05001576
Adam Langleyb4a494c2015-01-23 15:10:10 -08001577 /* max_version is the maximum acceptable protocol version. If zero, the
1578 * maximum supported version, currently (D)TLS 1.2, is used. */
1579 uint16_t max_version;
Adam Langley95c29f32014-06-20 12:00:00 -07001580
Adam Langleyb4a494c2015-01-23 15:10:10 -08001581 /* min_version is the minimum acceptable protocl version. If zero, the
1582 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1583 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001584
Adam Langleyb4a494c2015-01-23 15:10:10 -08001585 /* There are 2 BIO's even though they are normally both the same. This is so
1586 * data can be read and written to different handlers */
David Benjamin1eb367c2014-12-12 18:17:51 -05001587
Adam Langleyb4a494c2015-01-23 15:10:10 -08001588 BIO *rbio; /* used by SSL_read */
1589 BIO *wbio; /* used by SSL_write */
1590 BIO *bbio; /* used during session-id reuse to concatenate
1591 * messages */
Adam Langley95c29f32014-06-20 12:00:00 -07001592
Adam Langleyb4a494c2015-01-23 15:10:10 -08001593 /* This holds a variable that indicates what we were doing when a 0 or -1 is
1594 * returned. This is needed for non-blocking IO so we know what request
1595 * needs re-doing when in SSL_accept or SSL_connect */
1596 int rwstate;
David Benjamin95f9cfc2014-11-23 00:19:49 -05001597
Adam Langleyb4a494c2015-01-23 15:10:10 -08001598 /* true when we are actually in SSL_accept() or SSL_connect() */
1599 int in_handshake;
1600 int (*handshake_func)(SSL *);
Adam Langley95c29f32014-06-20 12:00:00 -07001601
Adam Langleyb4a494c2015-01-23 15:10:10 -08001602 /* Imagine that here's a boolean member "init" that is switched as soon as
1603 * SSL_set_{accept/connect}_state is called for the first time, so that
1604 * "state" and "handshake_func" are properly initialized. But as
1605 * handshake_func is == 0 until then, we use this test instead of an "init"
1606 * member. */
Adam Langley95c29f32014-06-20 12:00:00 -07001607
Adam Langleyb4a494c2015-01-23 15:10:10 -08001608 /* server is true iff the this SSL* is the server half. Note: before the SSL*
1609 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
1610 * the side is not determined. In this state, server is always false. */
1611 int server;
Adam Langley95c29f32014-06-20 12:00:00 -07001612
Adam Langleyb4a494c2015-01-23 15:10:10 -08001613 /* quiet_shutdown is true if the connection should not send a close_notify on
1614 * shutdown. */
1615 int quiet_shutdown;
David Benjamin7e237462014-12-11 18:13:28 -05001616
Adam Langleyb4a494c2015-01-23 15:10:10 -08001617 int shutdown; /* we have shut things down, 0x01 sent, 0x02
1618 * for received */
1619 int state; /* where we are */
1620 int rstate; /* where we are when reading */
Adam Langley95c29f32014-06-20 12:00:00 -07001621
Adam Langleyb4a494c2015-01-23 15:10:10 -08001622 BUF_MEM *init_buf; /* buffer used during init */
1623 uint8_t *init_msg; /* pointer to handshake message body, set by
1624 ssl3_get_message() */
1625 int init_num; /* amount read/written */
1626 int init_off; /* amount read/written */
Adam Langley95c29f32014-06-20 12:00:00 -07001627
Adam Langleyb4a494c2015-01-23 15:10:10 -08001628 /* used internally to point at a raw packet */
1629 uint8_t *packet;
1630 unsigned int packet_length;
Adam Langley95c29f32014-06-20 12:00:00 -07001631
Adam Langleyb4a494c2015-01-23 15:10:10 -08001632 struct ssl3_state_st *s3; /* SSLv3 variables */
1633 struct dtls1_state_st *d1; /* DTLSv1 variables */
Adam Langley95c29f32014-06-20 12:00:00 -07001634
Adam Langleyb4a494c2015-01-23 15:10:10 -08001635 /* callback that allows applications to peek at protocol messages */
1636 void (*msg_callback)(int write_p, int version, int content_type,
1637 const void *buf, size_t len, SSL *ssl, void *arg);
1638 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001639
Adam Langleyb4a494c2015-01-23 15:10:10 -08001640 int hit; /* reusing a previous session */
Adam Langley95c29f32014-06-20 12:00:00 -07001641
Adam Langleyb4a494c2015-01-23 15:10:10 -08001642 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001643
Adam Langleyb4a494c2015-01-23 15:10:10 -08001644 /* crypto */
1645 struct ssl_cipher_preference_list_st *cipher_list;
1646 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001647
Adam Langleyb4a494c2015-01-23 15:10:10 -08001648 SSL_AEAD_CTX *aead_read_ctx;
1649 SSL_AEAD_CTX *aead_write_ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001650
Adam Langleyb4a494c2015-01-23 15:10:10 -08001651 /* session info */
Adam Langley95c29f32014-06-20 12:00:00 -07001652
Adam Langleyb4a494c2015-01-23 15:10:10 -08001653 /* client cert? */
1654 /* This is used to hold the server certificate used */
1655 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001656
Adam Langleyb4a494c2015-01-23 15:10:10 -08001657 /* the session_id_context is used to ensure sessions are only reused
1658 * in the appropriate context */
1659 unsigned int sid_ctx_length;
1660 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001661
Adam Langleyb4a494c2015-01-23 15:10:10 -08001662 /* This can also be in the session once a session is established */
1663 SSL_SESSION *session;
Adam Langley95c29f32014-06-20 12:00:00 -07001664
Adam Langleyb4a494c2015-01-23 15:10:10 -08001665 /* Default generate session ID callback. */
1666 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001667
Adam Langleyb4a494c2015-01-23 15:10:10 -08001668 /* Used in SSL2 and SSL3 */
1669 int verify_mode; /* 0 don't care about verify failure.
1670 * 1 fail if verify fails */
1671 int (*verify_callback)(int ok,
1672 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
Adam Langley95c29f32014-06-20 12:00:00 -07001673
Adam Langleyb4a494c2015-01-23 15:10:10 -08001674 void (*info_callback)(const SSL *ssl, int type,
1675 int val); /* optional informational callback */
Adam Langley95c29f32014-06-20 12:00:00 -07001676
Adam Langleyb4a494c2015-01-23 15:10:10 -08001677 /* Server-only: psk_identity_hint is the identity hint to send in
1678 * PSK-based key exchanges. */
1679 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001680
Adam Langleyb4a494c2015-01-23 15:10:10 -08001681 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1682 char *identity,
1683 unsigned int max_identity_len,
1684 uint8_t *psk, unsigned int max_psk_len);
1685 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1686 uint8_t *psk, unsigned int max_psk_len);
David Benjamin688d8df2014-11-02 23:06:42 -05001687
Adam Langleyb4a494c2015-01-23 15:10:10 -08001688 SSL_CTX *ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001689
Adam Langleyb4a494c2015-01-23 15:10:10 -08001690 /* extra application data */
1691 long verify_result;
1692 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001693
Adam Langleyb4a494c2015-01-23 15:10:10 -08001694 /* for server side, keep the list of CA_dn we can use */
1695 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001696
David Benjamin123a8fd2015-04-26 14:16:41 -04001697 uint32_t options; /* protocol behaviour */
1698 uint32_t mode; /* API behaviour */
David Benjamin1d0a1942015-04-26 15:35:35 -04001699 uint32_t max_cert_list;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001700 int client_version; /* what was passed, used for
1701 * SSLv3/TLS rollback check */
David Benjamin1d0a1942015-04-26 15:35:35 -04001702 uint16_t max_send_fragment;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001703 char *tlsext_hostname;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001704 /* RFC4507 session ticket expected to be received or sent */
1705 int tlsext_ticket_expected;
1706 size_t tlsext_ecpointformatlist_length;
1707 uint8_t *tlsext_ecpointformatlist; /* our list */
1708 size_t tlsext_ellipticcurvelist_length;
1709 uint16_t *tlsext_ellipticcurvelist; /* our list */
Adam Langley95c29f32014-06-20 12:00:00 -07001710
Adam Langleyb4a494c2015-01-23 15:10:10 -08001711 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
Adam Langley95c29f32014-06-20 12:00:00 -07001712
Adam Langleyb4a494c2015-01-23 15:10:10 -08001713 /* Next protocol negotiation. For the client, this is the protocol that we
1714 * sent in NextProtocol and is set when handling ServerHello extensions.
1715 *
1716 * For a server, this is the client's selected_protocol from NextProtocol and
1717 * is set when handling the NextProtocol message, before the Finished
1718 * message. */
1719 uint8_t *next_proto_negotiated;
1720 size_t next_proto_negotiated_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001721
Adam Langleyb4a494c2015-01-23 15:10:10 -08001722 /* srtp_profiles is the list of configured SRTP protection profiles for
1723 * DTLS-SRTP. */
1724 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001725
Adam Langleyb4a494c2015-01-23 15:10:10 -08001726 /* srtp_profile is the selected SRTP protection profile for
1727 * DTLS-SRTP. */
1728 const SRTP_PROTECTION_PROFILE *srtp_profile;
David Benjaminbc44c082015-01-01 15:02:11 -05001729
Adam Langleyb4a494c2015-01-23 15:10:10 -08001730 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
1731 * from clients. For a client, means that we'll advertise support. */
1732 char tlsext_channel_id_enabled;
1733 /* The client's Channel ID private key. */
1734 EVP_PKEY *tlsext_channel_id_private;
Adam Langley95c29f32014-06-20 12:00:00 -07001735
Adam Langleyb4a494c2015-01-23 15:10:10 -08001736 /* Enable signed certificate time stamps. Currently client only. */
1737 char signed_cert_timestamps_enabled;
Adam Langley1258b6a2014-06-20 12:00:00 -07001738
Adam Langleyb4a494c2015-01-23 15:10:10 -08001739 /* Enable OCSP stapling. Currently client only.
1740 * TODO(davidben): Add a server-side implementation when it becomes
1741 * necesary. */
1742 char ocsp_stapling_enabled;
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001743
Adam Langleyb4a494c2015-01-23 15:10:10 -08001744 /* For a client, this contains the list of supported protocols in wire
1745 * format. */
1746 uint8_t *alpn_client_proto_list;
1747 unsigned alpn_client_proto_list_len;
David Benjamin6c7aed02014-08-27 16:42:38 -04001748
Adam Langleyb4a494c2015-01-23 15:10:10 -08001749 /* fastradio_padding, if true, causes ClientHellos to be padded to 1024
1750 * bytes. This ensures that the cellular radio is fast forwarded to DCH (high
1751 * data rate) state in 3G networks. */
1752 char fastradio_padding;
Feng Lu41aa3252014-11-21 22:47:56 -08001753
David Benjamin897e5e02015-05-12 17:03:54 -04001754 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
1755 * peer. Otherwise, they will be rejected with a fatal error. */
1756 char accept_peer_renegotiations;
David Benjaminb16346b2015-04-08 19:16:58 -04001757
Adam Langleyb4a494c2015-01-23 15:10:10 -08001758 /* These fields are always NULL and exist only to keep wpa_supplicant happy
1759 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
1760 * don't support. */
1761 EVP_CIPHER_CTX *enc_read_ctx;
1762 EVP_MD_CTX *read_hash;
1763};
Adam Langley95c29f32014-06-20 12:00:00 -07001764
Adam Langley95c29f32014-06-20 12:00:00 -07001765/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001766#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
1767#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
1768#define SSL_SESSION_set_app_data(s, a) \
1769 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
1770#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
1771#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
1772#define SSL_CTX_set_app_data(ctx, arg) \
1773 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07001774
Adam Langleyb4a494c2015-01-23 15:10:10 -08001775/* The following are the possible values for ssl->state are are used to
1776 * indicate where we are up to in the SSL connection establishment. The macros
1777 * that follow are about the only things you should need to use and even then,
1778 * only when using non-blocking IO. It can also be useful to work out where you
1779 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07001780
Adam Langleyb4a494c2015-01-23 15:10:10 -08001781#define SSL_ST_CONNECT 0x1000
1782#define SSL_ST_ACCEPT 0x2000
1783#define SSL_ST_MASK 0x0FFF
1784#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001785#define SSL_ST_OK 0x03
1786#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07001787
Adam Langleyb4a494c2015-01-23 15:10:10 -08001788#define SSL_CB_LOOP 0x01
1789#define SSL_CB_EXIT 0x02
1790#define SSL_CB_READ 0x04
1791#define SSL_CB_WRITE 0x08
1792#define SSL_CB_ALERT 0x4000 /* used in callback */
1793#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
1794#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
1795#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
1796#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
1797#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
1798#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
1799#define SSL_CB_HANDSHAKE_START 0x10
1800#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07001801
1802/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001803#define SSL_get_state(a) SSL_state(a)
1804#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05001805#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001806#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
1807#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05001808
David Benjamined7c4752015-02-16 19:16:46 -05001809/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
1810 * is in False Start. |SSL_write| may be called at this point without waiting
1811 * for the peer, but |SSL_read| will require the handshake to be completed. */
1812OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
1813
Adam Langley95c29f32014-06-20 12:00:00 -07001814/* The following 2 states are kept in ssl->rstate when reads fail,
1815 * you should not need these */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001816#define SSL_ST_READ_HEADER 0xF0
1817#define SSL_ST_READ_BODY 0xF1
1818#define SSL_ST_READ_DONE 0xF2
Adam Langley95c29f32014-06-20 12:00:00 -07001819
1820/* Obtain latest Finished message
1821 * -- that we sent (SSL_get_finished)
1822 * -- that we expected from peer (SSL_get_peer_finished).
1823 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001824OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1825OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07001826
Adam Langley509e5ed2014-06-20 12:00:00 -07001827/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07001828 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001829#define SSL_VERIFY_NONE 0x00
1830#define SSL_VERIFY_PEER 0x01
1831#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
David Benjamin5aea93e2015-05-26 16:33:02 -04001832/* SSL_VERIFY_CLIENT_ONCE does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001833#define SSL_VERIFY_CLIENT_ONCE 0x04
1834#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07001835
Adam Langleyb4a494c2015-01-23 15:10:10 -08001836#define OpenSSL_add_ssl_algorithms() SSL_library_init()
1837#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07001838
Adam Langleyb4a494c2015-01-23 15:10:10 -08001839/* For backward compatibility */
1840#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1841#define SSL_get_cipher_bits(s, np) \
1842 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07001843#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001844 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1845#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1846#define SSL_get_time(a) SSL_SESSION_get_time(a)
1847#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
1848#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
1849#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07001850
Adam Langleyb4a494c2015-01-23 15:10:10 -08001851#define d2i_SSL_SESSION_bio(bp, s_id) \
1852 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
1853#define i2d_SSL_SESSION_bio(bp, s_id) \
1854 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07001855
1856DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1857
Adam Langleyb4a494c2015-01-23 15:10:10 -08001858/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
1859 * This value must be kept in sync with reservedReasonCode in make_errors.h */
1860#define SSL_AD_REASON_OFFSET \
1861 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07001862
1863/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001864#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
1865#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
1866#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
1867#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
1868#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
1869#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
1870#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
1871#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
1872#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
1873#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
1874#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
1875#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
1876#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
1877#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
1878#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
1879#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
1880#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
1881#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
1882#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
1883#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
1884#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
1885#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
1886#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
1887#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
1888#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07001889#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001890#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
1891#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
1892 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07001893#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001894#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
1895#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07001896
Adam Langleyb4a494c2015-01-23 15:10:10 -08001897#define SSL_ERROR_NONE 0
1898#define SSL_ERROR_SSL 1
1899#define SSL_ERROR_WANT_READ 2
1900#define SSL_ERROR_WANT_WRITE 3
1901#define SSL_ERROR_WANT_X509_LOOKUP 4
1902#define SSL_ERROR_SYSCALL 5 /* look at error stack/return value/errno */
1903#define SSL_ERROR_ZERO_RETURN 6
1904#define SSL_ERROR_WANT_CONNECT 7
1905#define SSL_ERROR_WANT_ACCEPT 8
1906#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
1907#define SSL_ERROR_PENDING_SESSION 11
1908#define SSL_ERROR_PENDING_CERTIFICATE 12
David Benjaminb4d65fd2015-05-29 17:11:21 -04001909#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
Adam Langley95c29f32014-06-20 12:00:00 -07001910
Adam Langleyb4a494c2015-01-23 15:10:10 -08001911#define SSL_CTRL_GET_CURVES 90
1912#define SSL_CTRL_SET_CURVES 91
1913#define SSL_CTRL_SET_CURVES_LIST 92
Adam Langleyb4a494c2015-01-23 15:10:10 -08001914#define SSL_CTRL_SET_SIGALGS 97
1915#define SSL_CTRL_SET_SIGALGS_LIST 98
Adam Langleyb4a494c2015-01-23 15:10:10 -08001916#define SSL_CTRL_SET_CLIENT_SIGALGS 101
1917#define SSL_CTRL_SET_CLIENT_SIGALGS_LIST 102
1918#define SSL_CTRL_GET_CLIENT_CERT_TYPES 103
1919#define SSL_CTRL_SET_CLIENT_CERT_TYPES 104
Adam Langleyb4a494c2015-01-23 15:10:10 -08001920#define SSL_CTRL_SET_VERIFY_CERT_STORE 106
1921#define SSL_CTRL_SET_CHAIN_CERT_STORE 107
Adam Langleyb4a494c2015-01-23 15:10:10 -08001922#define SSL_CTRL_GET_EC_POINT_FORMATS 111
Adam Langley95c29f32014-06-20 12:00:00 -07001923
David Benjamin377fc312015-01-26 00:22:12 -05001924/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04001925 * timeout in progress, it sets |*out| to the time remaining and returns one.
1926 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05001927 *
1928 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
1929 * retransmit behavior.
1930 *
1931 * NOTE: This function must be queried again whenever the handshake state
1932 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001933OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05001934
1935/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
1936 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
1937 * flight of handshake messages and returns 1. If too many timeouts had expired
1938 * without progress or an error occurs, it returns -1.
1939 *
1940 * NOTE: The caller's external timer should be compatible with the one |ssl|
1941 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04001942 * |DTLSv1_get_timeout| will return an updated timeout.
1943 *
1944 * WARNING: This function breaks the usual return value convention. */
1945OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001946
David Benjaminc0454692015-04-27 00:28:56 -04001947/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1948 * and zero otherwise.
1949 *
1950 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1951 * initial or renego, is in progress. */
1952OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001953
David Benjaminc0454692015-04-27 00:28:56 -04001954/* SSL_total_renegotiations returns the total number of renegotiation handshakes
1955 * peformed by |ssl|. This includes the pending renegotiation, if any. */
1956OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
1957
David Benjamin15a3b002015-04-28 00:05:35 -04001958/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1959 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1960 * one on success and zero on error. */
1961OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04001962
David Benjamin15a3b002015-04-28 00:05:35 -04001963/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1964 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1965 * on success and zero on error. */
1966OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07001967
David Benjamin15a3b002015-04-28 00:05:35 -04001968/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1969 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1970 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1971 * error. If unset, an appropriate curve will be chosen automatically. (This is
1972 * recommended.) */
1973OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04001974
David Benjamin15a3b002015-04-28 00:05:35 -04001975/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1976 * for ephemeral ECDH keys. For historical reasons, this API expects an
1977 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1978 * error. If unset, an appropriate curve will be chosen automatically. (This is
1979 * recommended.) */
1980OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07001981
David Benjaminc2807582015-04-28 00:19:50 -04001982/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
1983 * client IDs from clients, or configures a client to send TLS client IDs to
1984 * a server. It returns one. */
1985OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
1986
Adam Langleyb4a494c2015-01-23 15:10:10 -08001987/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
1988 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04001989 * server. It returns one. */
1990OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
1991
1992/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
1993 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
1994 * on success and zero on error. */
1995OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
1996 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001997
Adam Langley1258b6a2014-06-20 12:00:00 -07001998/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04001999 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
2000 * success and zero on error. */
2001OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002002
Adam Langley1258b6a2014-06-20 12:00:00 -07002003/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04002004 * and copies up to the first |max_out| bytes into |out|. The Channel ID
2005 * consists of the client's P-256 public key as an (x,y) pair where each is a
2006 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
2007 * Channel ID and the length of the complete Channel ID otherwise. */
2008OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
2009 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07002010
Adam Langleyb4a494c2015-01-23 15:10:10 -08002011#define SSL_CTX_set0_verify_cert_store(ctx, st) \
2012 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
2013#define SSL_CTX_set1_verify_cert_store(ctx, st) \
2014 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
2015#define SSL_CTX_set0_chain_cert_store(ctx, st) \
2016 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
2017#define SSL_CTX_set1_chain_cert_store(ctx, st) \
2018 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07002019
Adam Langleyb4a494c2015-01-23 15:10:10 -08002020#define SSL_set0_verify_cert_store(s, st) \
2021 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 0, (char *)st)
2022#define SSL_set1_verify_cert_store(s, st) \
2023 SSL_ctrl(s, SSL_CTRL_SET_VERIFY_CERT_STORE, 1, (char *)st)
2024#define SSL_set0_chain_cert_store(s, st) \
2025 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 0, (char *)st)
2026#define SSL_set1_chain_cert_store(s, st) \
2027 SSL_ctrl(s, SSL_CTRL_SET_CHAIN_CERT_STORE, 1, (char *)st)
Adam Langley95c29f32014-06-20 12:00:00 -07002028
Adam Langleyb4a494c2015-01-23 15:10:10 -08002029#define SSL_get1_curves(ctx, s) SSL_ctrl(ctx, SSL_CTRL_GET_CURVES, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002030#define SSL_CTX_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002031 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002032#define SSL_CTX_set1_curves_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002033 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002034#define SSL_set1_curves(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002035 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002036#define SSL_set1_curves_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002037 SSL_ctrl(ctx, SSL_CTRL_SET_CURVES_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002038
2039#define SSL_CTX_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002040 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002041#define SSL_CTX_set1_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002042 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002043#define SSL_set1_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002044 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002045#define SSL_set1_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002046 SSL_ctrl(ctx, SSL_CTRL_SET_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002047
2048#define SSL_CTX_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002049 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, slistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002050#define SSL_CTX_set1_client_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002051 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002052#define SSL_set1_client_sigalgs(ctx, slist, slistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002053 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS, clistlen, (int *)slist)
Adam Langley95c29f32014-06-20 12:00:00 -07002054#define SSL_set1_client_sigalgs_list(ctx, s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002055 SSL_ctrl(ctx, SSL_CTRL_SET_CLIENT_SIGALGS_LIST, 0, (char *)s)
Adam Langley95c29f32014-06-20 12:00:00 -07002056
2057#define SSL_get0_certificate_types(s, clist) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002058 SSL_ctrl(s, SSL_CTRL_GET_CLIENT_CERT_TYPES, 0, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002059
2060#define SSL_CTX_set1_client_certificate_types(ctx, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002061 SSL_CTX_ctrl(ctx, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002062#define SSL_set1_client_certificate_types(s, clist, clistlen) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002063 SSL_ctrl(s, SSL_CTRL_SET_CLIENT_CERT_TYPES, clistlen, (char *)clist)
Adam Langley95c29f32014-06-20 12:00:00 -07002064
Adam Langley95c29f32014-06-20 12:00:00 -07002065#define SSL_get0_ec_point_formats(s, plst) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002066 SSL_ctrl(s, SSL_CTRL_GET_EC_POINT_FORMATS, 0, (char *)plst)
Adam Langley95c29f32014-06-20 12:00:00 -07002067
Adam Langleyb4a494c2015-01-23 15:10:10 -08002068OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
2069OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002070OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002071OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
2072OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002073OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002074OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002075
Adam Langleyb4a494c2015-01-23 15:10:10 -08002076OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07002077
David Benjamina07c0fc2015-05-13 13:19:42 -04002078/* SSL_get_current_cipher returns the cipher used in the current outgoing
2079 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002080OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002081
Adam Langleyb4a494c2015-01-23 15:10:10 -08002082OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
2083OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
2084OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
2085OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002086OPENSSL_EXPORT int SSL_pending(const SSL *s);
2087OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
2088OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
2089OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
2090OPENSSL_EXPORT void SSL_set_bio(SSL *s, BIO *rbio, BIO *wbio);
2091OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *s);
2092OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *s);
2093OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002094OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
2095OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
2096OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
2097 X509_STORE_CTX *);
2098OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
2099 int (*callback)(int ok,
2100 X509_STORE_CTX *ctx));
2101OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002102OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002103OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
2104 stackCAs,
2105 const char *file);
2106OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
2107 stackCAs,
2108 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07002109
David Benjamin7ce1c0c2015-01-09 13:21:21 -05002110/* SSL_load_error_strings does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002111OPENSSL_EXPORT void SSL_load_error_strings(void);
David Benjamin7ce1c0c2015-01-09 13:21:21 -05002112
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002113OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
2114OPENSSL_EXPORT const char *SSL_rstate_string(const SSL *s);
2115OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
2116OPENSSL_EXPORT const char *SSL_rstate_string_long(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002117OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
2118OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
2119OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
2120OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002121OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002122OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
2123 const uint8_t *sid_ctx,
2124 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002125
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002126OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002127OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
2128 unsigned int *len);
2129OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
2130OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05002131
2132/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
2133 * of |session|. It then returns |session|. */
2134OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
2135
2136/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
2137 * zero, all data referenced by |session| and |session| itself are released. */
2138OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
2139
Adam Langleyb4a494c2015-01-23 15:10:10 -08002140OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
2141OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
2142OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
2143OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
2144OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
2145OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
2146 const uint8_t *id,
2147 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04002148
Adam Langleyb4a494c2015-01-23 15:10:10 -08002149/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
2150 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
2151 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
2152 * one on success and zero on error. */
David Benjamin3cac4502014-10-21 01:46:30 -04002153OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
2154 size_t *out_len);
2155
David Benjamin95d31822015-06-15 19:53:32 -04002156/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
2157 * identification information, namely the session ID and ticket. */
David Benjamin3cac4502014-10-21 01:46:30 -04002158OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
2159 uint8_t **out_data,
2160 size_t *out_len);
2161
David Benjaminfd67aa82015-06-15 19:41:48 -04002162/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
2163 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
2164OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
2165 size_t in_len);
2166
Adam Langleyb4a494c2015-01-23 15:10:10 -08002167/* Deprecated: i2d_SSL_SESSION serializes |in| to the bytes pointed to by
2168 * |*pp|. On success, it returns the number of bytes written and advances |*pp|
2169 * by that many bytes. On failure, it returns -1. If |pp| is NULL, no bytes are
2170 * written and only the length is returned.
David Benjamin3cac4502014-10-21 01:46:30 -04002171 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002172 * Use |SSL_SESSION_to_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002173OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2174
David Benjaminfd67aa82015-06-15 19:41:48 -04002175/* Deprecated: d2i_SSL_SESSION parses a serialized session from the |length|
2176 * bytes pointed to by |*pp|. It returns the new |SSL_SESSION| and advances
2177 * |*pp| by the number of bytes consumed on success and NULL on failure. The
2178 * caller takes ownership of the new session and must call |SSL_SESSION_free|
2179 * when done.
David Benjamin3cac4502014-10-21 01:46:30 -04002180 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002181 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
David Benjamin3cac4502014-10-21 01:46:30 -04002182 *
David Benjaminfd67aa82015-06-15 19:41:48 -04002183 * Use |SSL_SESSION_from_bytes| instead. */
David Benjamin3cac4502014-10-21 01:46:30 -04002184OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2185 long length);
Adam Langley95c29f32014-06-20 12:00:00 -07002186
Adam Langleyb4a494c2015-01-23 15:10:10 -08002187OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002188
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002189OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002190
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002191OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
2192OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002193OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
2194 int, X509_STORE_CTX *);
2195OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2196 int (*callback)(int, X509_STORE_CTX *));
2197OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
2198OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
2199 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07002200
Adam Langleyb4a494c2015-01-23 15:10:10 -08002201OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
2202 pem_password_cb *cb);
2203OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
2204 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07002205
Adam Langleyb4a494c2015-01-23 15:10:10 -08002206OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
2207 const uint8_t *sid_ctx,
2208 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002209
Adam Langleyb4a494c2015-01-23 15:10:10 -08002210OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
2211 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002212
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002213OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
2214OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
2215OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
2216OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07002217
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002218OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
2219OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07002220
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002221OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
2222OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002223
Adam Langleyb4a494c2015-01-23 15:10:10 -08002224OPENSSL_EXPORT int SSL_accept(SSL *ssl);
2225OPENSSL_EXPORT int SSL_connect(SSL *ssl);
2226OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
2227OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
2228OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
2229OPENSSL_EXPORT long SSL_ctrl(SSL *ssl, int cmd, long larg, void *parg);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002230OPENSSL_EXPORT long SSL_CTX_ctrl(SSL_CTX *ctx, int cmd, long larg, void *parg);
Adam Langley95c29f32014-06-20 12:00:00 -07002231
Adam Langleyb4a494c2015-01-23 15:10:10 -08002232OPENSSL_EXPORT int SSL_get_error(const SSL *s, int ret_code);
Adam Langley0f4746e2014-08-13 12:26:32 -07002233/* SSL_get_version returns a string describing the TLS version used by |s|. For
2234 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002235OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley0f4746e2014-08-13 12:26:32 -07002236/* SSL_SESSION_get_version returns a string describing the TLS version used by
2237 * |sess|. For example, "TLSv1.2" or "SSLv3". */
2238OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
Adam Langley95c29f32014-06-20 12:00:00 -07002239
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002240OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002241
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002242OPENSSL_EXPORT int SSL_do_handshake(SSL *s);
David Benjamin44d3eed2015-05-21 01:29:55 -04002243
2244/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2245 * renegotiation. */
2246OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2247
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002248OPENSSL_EXPORT int SSL_shutdown(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002249
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002250OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2251OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2252OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2253OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002254
Adam Langleyb4a494c2015-01-23 15:10:10 -08002255OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
2256 STACK_OF(X509_NAME) *name_list);
2257OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2258 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002259OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002260OPENSSL_EXPORT STACK_OF(X509_NAME) *
2261 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2262OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
2263OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07002264
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002265OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002266
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002267OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07002268
Adam Langleyb4a494c2015-01-23 15:10:10 -08002269OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002270OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002271OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002272OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002273OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002274OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
2275OPENSSL_EXPORT int SSL_version(const SSL *ssl);
2276OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002277OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2278 const char *CAfile,
2279 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07002280#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002281OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002282OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
2283 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002284OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002285OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002286OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002287 void (*cb)(const SSL *ssl, int type,
2288 int val));
2289OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2290 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002291OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002292
Adam Langleyb4a494c2015-01-23 15:10:10 -08002293OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002294OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002295
Adam Langleyb4a494c2015-01-23 15:10:10 -08002296OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2297OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2298OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2299 CRYPTO_EX_new *new_func,
2300 CRYPTO_EX_dup *dup_func,
2301 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002302
Adam Langleyb4a494c2015-01-23 15:10:10 -08002303OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
2304 void *data);
2305OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2306OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2307 CRYPTO_EX_new *new_func,
2308 CRYPTO_EX_dup *dup_func,
2309 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002310
Adam Langleyb4a494c2015-01-23 15:10:10 -08002311OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2312OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2313OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2314 CRYPTO_EX_new *new_func,
2315 CRYPTO_EX_dup *dup_func,
2316 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002317
Adam Langleyb4a494c2015-01-23 15:10:10 -08002318OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002319
David Benjamin71f7d3d2015-05-05 09:46:38 -04002320/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
2321 * |size|. It returns the previous value. */
2322OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
2323 unsigned long size);
2324
David Benjamin3b7456e2015-05-16 12:29:32 -04002325/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04002326 * cache. */
2327OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
2328
2329/* SSL_SESS_CACHE_* are the possible session cache mode bits.
2330 * TODO(davidben): Document. */
2331#define SSL_SESS_CACHE_OFF 0x0000
2332#define SSL_SESS_CACHE_CLIENT 0x0001
2333#define SSL_SESS_CACHE_SERVER 0x0002
2334#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2335#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2336#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2337#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2338#define SSL_SESS_CACHE_NO_INTERNAL \
2339 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2340
2341/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2342 * |mode|. It returns the previous value. */
2343OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2344
2345/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2346 * |ctx| */
2347OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002348
David Benjamin1d0a1942015-04-26 15:35:35 -04002349/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2350 * certificate chain accepted by |ctx|. */
2351OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2352
2353/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2354 * certificate chain to |max_cert_list|. This affects how much memory may be
2355 * consumed during the handshake. */
2356OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2357 size_t max_cert_list);
2358
2359/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2360 * certificate chain accepted by |ssl|. */
2361OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2362
2363/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2364 * certificate chain to |max_cert_list|. This affects how much memory may be
2365 * consumed during the handshake. */
2366OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2367
2368/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2369 * sent by |ctx|. Beyond this length, handshake messages and application data
2370 * will be split into multiple records. */
2371OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2372 size_t max_send_fragment);
2373
2374/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2375 * sent by |ssl|. Beyond this length, handshake messages and application data
2376 * will be split into multiple records. */
2377OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2378 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002379
David Benjamin59015c32015-04-26 13:13:55 -04002380/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2381 * the group for DHE ciphers. |callback| should ignore |is_export| and
2382 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2383 * the parameters are used, so the |DH| needn't have a generated keypair.
2384 *
2385 * WARNING: The caller does not take ownership of the resulting |DH|, so
2386 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002387OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002388 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2389
2390/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2391 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2392 * and return a |DH| of the selected group or NULL on error. Only the
2393 * parameters are used, so the |DH| needn't have a generated keypair.
2394 *
2395 * WARNING: The caller does not take ownership of the resulting |DH|, so
2396 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002397OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002398 DH *(*dh)(SSL *ssl, int is_export,
2399 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002400
2401/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2402 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2403 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2404 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2405 * keypair.
2406 *
2407 * If the callback is unset, an appropriate curve will be chosen automatically.
2408 * (This is recommended.)
2409 *
2410 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2411 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002412OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002413 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2414
2415/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2416 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2417 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2418 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2419 * keypair.
2420 *
2421 * If the callback is unset, an appropriate curve will be chosen automatically.
2422 * (This is recommended.)
2423 *
2424 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2425 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002426OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002427 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002428
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002429typedef void COMP_METHOD;
2430
2431/* SSL_get_current_compression returns NULL. */
2432OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
2433
2434/* SSL_get_current_expansion returns NULL. */
2435OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002436
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002437OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2438OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002439
Adam Langley524e7172015-02-20 16:04:00 -08002440/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2441 * resumption decision for a ClientHello has been made. It can return 1 to
2442 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002443OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002444 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2445
Adam Langley95f22882014-06-20 12:00:00 -07002446/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2447 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2448 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002449OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2450 size_t *ssl_ctx_size,
2451 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002452
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002453OPENSSL_EXPORT void ERR_load_SSL_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002454
Adam Langley3f92d212015-02-20 15:32:52 -08002455/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2456 * the read and write directions. It returns one on success or zero if |ssl|
2457 * isn't using an RC4-based cipher suite. */
2458OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2459 const RC4_KEY **write_key);
2460
Adam Langley95c29f32014-06-20 12:00:00 -07002461
David Benjamin71f07942015-04-08 02:36:59 -04002462/* Deprecated functions. */
2463
2464/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2465 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2466 * freed with |OPENSSL_free|, or NULL on error.
2467 *
2468 * The description includes a trailing newline and has the form:
2469 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2470 *
2471 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2472OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2473 char *buf, int len);
2474
2475/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2476OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2477
2478/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002479OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002480
2481/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002482OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002483
2484/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002485OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002486
David Benjamin0d8a7582015-04-08 23:55:15 -04002487/* SSLv23_method calls |TLS_method|. */
2488OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2489
2490/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2491 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2492 * to lock connections to that protocol version. */
2493OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2494OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2495OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2496OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2497OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2498OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2499
2500/* Client- and server-specific methods call their corresponding generic
2501 * methods. */
2502OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2503OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2504OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2505OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2506OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2507OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2508OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2509OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2510OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2511OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2512OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2513OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2514OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2515OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2516OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2517OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2518
David Benjamin4831c332015-05-16 11:43:13 -04002519/* SSL_clear resets |ssl| to allow another connection and returns one on success
2520 * or zero on failure. It returns most configuration state but releases memory
2521 * associated with the current connection.
2522 *
2523 * Free |ssl| and create a new one instead. */
2524OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2525
David Benjamin59015c32015-04-26 13:13:55 -04002526/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2527OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2528 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002529
David Benjamin59015c32015-04-26 13:13:55 -04002530/* SSL_set_tmp_rsa_callback does nothing. */
2531OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2532 RSA *(*cb)(SSL *ssl, int is_export,
2533 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002534
David Benjaminda881e92015-04-26 14:45:04 -04002535/* SSL_CTX_sess_connect returns zero. */
2536OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2537
2538/* SSL_CTX_sess_connect_good returns zero. */
2539OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2540
2541/* SSL_CTX_sess_connect_renegotiate returns zero. */
2542OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2543
2544/* SSL_CTX_sess_accept returns zero. */
2545OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2546
2547/* SSL_CTX_sess_accept_renegotiate returns zero. */
2548OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2549
2550/* SSL_CTX_sess_accept_good returns zero. */
2551OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2552
2553/* SSL_CTX_sess_hits returns zero. */
2554OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2555
2556/* SSL_CTX_sess_cb_hits returns zero. */
2557OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2558
2559/* SSL_CTX_sess_misses returns zero. */
2560OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2561
2562/* SSL_CTX_sess_timeouts returns zero. */
2563OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2564
2565/* SSL_CTX_sess_cache_full returns zero. */
2566OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2567
David Benjamin101ead22015-04-26 18:36:23 -04002568/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2569OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2570
David Benjaminc0454692015-04-27 00:28:56 -04002571/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2572OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2573
2574/* SSL_CTX_need_tmp_RSA returns zero. */
2575OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2576
2577/* SSL_need_tmp_RSA returns zero. */
2578OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2579
2580/* SSL_CTX_set_tmp_rsa returns one. */
2581OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2582
2583/* SSL_set_tmp_rsa returns one. */
2584OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2585
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002586/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002587OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2588
2589/* SSL_CTX_set_read_ahead does nothing. */
2590OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2591
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002592/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002593OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2594
2595/* SSL_set_read_ahead does nothing. */
2596OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2597
David Benjamin44d3eed2015-05-21 01:29:55 -04002598/* SSL_renegotiate put an error on the error queue and returns zero. */
2599OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2600
David Benjaminece089c2015-05-15 23:52:42 -04002601/* SSL_set_state does nothing. */
2602OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2603
David Benjamin71f07942015-04-08 02:36:59 -04002604
Adam Langley7cc3f992015-01-07 15:06:31 -08002605/* Android compatibility section.
2606 *
2607 * These functions are declared, temporarily, for Android because
2608 * wpa_supplicant will take a little time to sync with upstream. Outside of
2609 * Android they'll have no definition. */
2610
2611#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2612
Adam Langleyb4a494c2015-01-23 15:10:10 -08002613OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2614 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002615OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2616OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002617OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2618
2619#define OPENSSL_VERSION_TEXT "BoringSSL"
2620
2621#define SSLEAY_VERSION 0
2622
2623/* SSLeay_version is a compatibility function that returns the string
2624 * "BoringSSL". */
2625OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002626
2627
David Benjamin59015c32015-04-26 13:13:55 -04002628/* Preprocessor compatibility section.
2629 *
2630 * Historically, a number of APIs were implemented in OpenSSL as macros and
2631 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04002632 * section defines a number of legacy macros.
2633 *
2634 * Although using either the CTRL values or their wrapper macros in #ifdefs is
2635 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
2636 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04002637
David Benjamincb3872f2015-06-16 13:20:36 -04002638#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2639#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002640#define SSL_CTRL_CHAIN doesnt_exist
2641#define SSL_CTRL_CHAIN_CERT doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002642#define SSL_CTRL_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002643#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002644#define SSL_CTRL_CLEAR_MODE doesnt_exist
2645#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002646#define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
2647#define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002648#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002649#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002650#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002651#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002652#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2653#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
2654#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2655#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
2656#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002657#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002658#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002659#define SSL_CTRL_MODE doesnt_exist
2660#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2661#define SSL_CTRL_OPTIONS doesnt_exist
2662#define SSL_CTRL_SESS_NUMBER doesnt_exist
2663#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
2664#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2665#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002666#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002667#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002668#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002669#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002670#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002671#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002672#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002673#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2674#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002675#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002676#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002677#define SSL_CTRL_SET_TMP_DH doesnt_exist
2678#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2679#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
2680#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
2681#define SSL_CTRL_SET_TMP_RSA doesnt_exist
2682#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002683
David Benjamin8c249802015-05-05 09:44:18 -04002684#define DTLSv1_get_timeout DTLSv1_get_timeout
2685#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamin11c0f8e2015-07-06 00:18:15 -04002686#define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
2687#define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
2688#define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
2689#define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
2690#define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002691#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2692#define SSL_CTX_clear_options SSL_CTX_clear_options
2693#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04002694#define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
2695#define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002696#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2697#define SSL_CTX_get_mode SSL_CTX_get_mode
2698#define SSL_CTX_get_options SSL_CTX_get_options
2699#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2700#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04002701#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002702#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2703#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2704#define SSL_CTX_sess_number SSL_CTX_sess_number
2705#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
David Benjamin11c0f8e2015-07-06 00:18:15 -04002706#define SSL_CTX_set0_chain SSL_CTX_set0_chain
2707#define SSL_CTX_set1_chain SSL_CTX_set1_chain
David Benjamincb3872f2015-06-16 13:20:36 -04002708#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2709#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2710#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2711#define SSL_CTX_set_mode SSL_CTX_set_mode
2712#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2713#define SSL_CTX_set_options SSL_CTX_set_options
2714#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
2715#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2716#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2717#define SSL_CTX_set_tlsext_servername_callback \
2718 SSL_CTX_set_tlsext_servername_callback
2719#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04002720#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002721#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
2722#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
2723#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
David Benjamin11c0f8e2015-07-06 00:18:15 -04002724#define SSL_add0_chain_cert SSL_add0_chain_cert
2725#define SSL_add1_chain_cert SSL_add1_chain_cert
2726#define SSL_clear_chain_certs SSL_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002727#define SSL_clear_mode SSL_clear_mode
2728#define SSL_clear_options SSL_clear_options
2729#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04002730#define SSL_get0_chain_certs SSL_get0_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002731#define SSL_get_max_cert_list SSL_get_max_cert_list
2732#define SSL_get_mode SSL_get_mode
2733#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04002734#define SSL_get_secure_renegotiation_support \
2735 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04002736#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04002737#define SSL_need_tmp_RSA SSL_need_tmp_RSA
2738#define SSL_num_renegotiations SSL_num_renegotiations
2739#define SSL_session_reused SSL_session_reused
David Benjamin11c0f8e2015-07-06 00:18:15 -04002740#define SSL_set0_chain SSL_set0_chain
2741#define SSL_set1_chain SSL_set1_chain
David Benjamincb3872f2015-06-16 13:20:36 -04002742#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
2743#define SSL_set_max_cert_list SSL_set_max_cert_list
2744#define SSL_set_max_send_fragment SSL_set_max_send_fragment
2745#define SSL_set_mode SSL_set_mode
2746#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
2747#define SSL_set_mtu SSL_set_mtu
2748#define SSL_set_options SSL_set_options
2749#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
2750#define SSL_set_tmp_dh SSL_set_tmp_dh
2751#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
2752#define SSL_set_tmp_rsa SSL_set_tmp_rsa
2753#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04002754
2755
David Benjamin087e4fa2015-04-08 23:46:10 -04002756#if defined(__cplusplus)
2757} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07002758#endif
David Benjamin2e521212014-07-16 14:37:51 -04002759
David Benjamin087e4fa2015-04-08 23:46:10 -04002760
2761/* Library consumers assume these headers are included by ssl.h, but they depend
2762 * on ssl.h, so include them after all declarations.
2763 *
2764 * TODO(davidben): The separation between ssl.h and these version-specific
2765 * headers introduces circular dependencies and is inconsistent. The function
2766 * declarations should move to ssl.h. Many of the constants can probably be
2767 * pruned or unexported. */
David Benjamin087e4fa2015-04-08 23:46:10 -04002768#include <openssl/ssl3.h>
2769#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04002770#include <openssl/srtp.h> /* Support for the use_srtp extension */
2771
2772
David Benjamin2e521212014-07-16 14:37:51 -04002773/* BEGIN ERROR CODES */
2774/* The following lines are auto generated by the script make_errors.go. Any
2775 * changes made after this point may be overwritten when the script is next run.
2776 */
David Benjamin689be0f2015-02-11 15:55:26 -05002777#define SSL_F_SSL_CTX_check_private_key 100
2778#define SSL_F_SSL_CTX_new 101
2779#define SSL_F_SSL_CTX_set_cipher_list 102
2780#define SSL_F_SSL_CTX_set_cipher_list_tls11 103
2781#define SSL_F_SSL_CTX_set_session_id_context 104
2782#define SSL_F_SSL_CTX_use_PrivateKey 105
2783#define SSL_F_SSL_CTX_use_PrivateKey_ASN1 106
2784#define SSL_F_SSL_CTX_use_PrivateKey_file 107
2785#define SSL_F_SSL_CTX_use_RSAPrivateKey 108
2786#define SSL_F_SSL_CTX_use_RSAPrivateKey_ASN1 109
2787#define SSL_F_SSL_CTX_use_RSAPrivateKey_file 110
Adam Langley95c29f32014-06-20 12:00:00 -07002788#define SSL_F_SSL_CTX_use_certificate 111
David Benjamin689be0f2015-02-11 15:55:26 -05002789#define SSL_F_SSL_CTX_use_certificate_ASN1 112
2790#define SSL_F_SSL_CTX_use_certificate_chain_file 113
2791#define SSL_F_SSL_CTX_use_certificate_file 114
2792#define SSL_F_SSL_CTX_use_psk_identity_hint 115
2793#define SSL_F_SSL_SESSION_new 116
2794#define SSL_F_SSL_SESSION_print_fp 117
2795#define SSL_F_SSL_SESSION_set1_id_context 118
2796#define SSL_F_SSL_SESSION_to_bytes_full 119
2797#define SSL_F_SSL_accept 120
2798#define SSL_F_SSL_add_dir_cert_subjects_to_stack 121
2799#define SSL_F_SSL_add_file_cert_subjects_to_stack 122
2800#define SSL_F_SSL_check_private_key 123
2801#define SSL_F_SSL_clear 124
2802#define SSL_F_SSL_connect 125
2803#define SSL_F_SSL_do_handshake 126
2804#define SSL_F_SSL_load_client_CA_file 127
2805#define SSL_F_SSL_new 128
2806#define SSL_F_SSL_peek 129
2807#define SSL_F_SSL_read 130
2808#define SSL_F_SSL_renegotiate 131
2809#define SSL_F_SSL_set_cipher_list 132
2810#define SSL_F_SSL_set_fd 133
2811#define SSL_F_SSL_set_rfd 134
2812#define SSL_F_SSL_set_session_id_context 135
2813#define SSL_F_SSL_set_wfd 136
2814#define SSL_F_SSL_shutdown 137
2815#define SSL_F_SSL_use_PrivateKey 138
2816#define SSL_F_SSL_use_PrivateKey_ASN1 139
2817#define SSL_F_SSL_use_PrivateKey_file 140
2818#define SSL_F_SSL_use_RSAPrivateKey 141
2819#define SSL_F_SSL_use_RSAPrivateKey_ASN1 142
2820#define SSL_F_SSL_use_RSAPrivateKey_file 143
2821#define SSL_F_SSL_use_certificate 144
2822#define SSL_F_SSL_use_certificate_ASN1 145
2823#define SSL_F_SSL_use_certificate_file 146
2824#define SSL_F_SSL_use_psk_identity_hint 147
2825#define SSL_F_SSL_write 148
2826#define SSL_F_d2i_SSL_SESSION 149
David Benjaminfd67aa82015-06-15 19:41:48 -04002827#define SSL_F_SSL_SESSION_parse_octet_string 150
2828#define SSL_F_SSL_SESSION_parse_string 151
David Benjamin689be0f2015-02-11 15:55:26 -05002829#define SSL_F_do_ssl3_write 152
2830#define SSL_F_dtls1_accept 153
2831#define SSL_F_dtls1_buffer_record 154
2832#define SSL_F_dtls1_check_timeout_num 155
2833#define SSL_F_dtls1_connect 156
2834#define SSL_F_dtls1_do_write 157
2835#define SSL_F_dtls1_get_hello_verify 158
2836#define SSL_F_dtls1_get_message 159
2837#define SSL_F_dtls1_get_message_fragment 160
2838#define SSL_F_dtls1_preprocess_fragment 161
2839#define SSL_F_dtls1_process_record 162
2840#define SSL_F_dtls1_read_bytes 163
2841#define SSL_F_dtls1_send_hello_verify_request 164
David Benjaminc933a472015-05-30 16:14:58 -04002842#define SSL_F_dtls1_write_app_data 165
David Benjamin689be0f2015-02-11 15:55:26 -05002843#define SSL_F_i2d_SSL_SESSION 166
2844#define SSL_F_ssl3_accept 167
David Benjamin689be0f2015-02-11 15:55:26 -05002845#define SSL_F_ssl3_cert_verify_hash 169
2846#define SSL_F_ssl3_check_cert_and_algorithm 170
2847#define SSL_F_ssl3_connect 171
2848#define SSL_F_ssl3_ctrl 172
2849#define SSL_F_ssl3_ctx_ctrl 173
2850#define SSL_F_ssl3_digest_cached_records 174
2851#define SSL_F_ssl3_do_change_cipher_spec 175
2852#define SSL_F_ssl3_expect_change_cipher_spec 176
2853#define SSL_F_ssl3_get_cert_status 177
2854#define SSL_F_ssl3_get_cert_verify 178
2855#define SSL_F_ssl3_get_certificate_request 179
2856#define SSL_F_ssl3_get_channel_id 180
2857#define SSL_F_ssl3_get_client_certificate 181
2858#define SSL_F_ssl3_get_client_hello 182
2859#define SSL_F_ssl3_get_client_key_exchange 183
2860#define SSL_F_ssl3_get_finished 184
2861#define SSL_F_ssl3_get_initial_bytes 185
2862#define SSL_F_ssl3_get_message 186
2863#define SSL_F_ssl3_get_new_session_ticket 187
2864#define SSL_F_ssl3_get_next_proto 188
2865#define SSL_F_ssl3_get_record 189
2866#define SSL_F_ssl3_get_server_certificate 190
2867#define SSL_F_ssl3_get_server_done 191
2868#define SSL_F_ssl3_get_server_hello 192
2869#define SSL_F_ssl3_get_server_key_exchange 193
2870#define SSL_F_ssl3_get_v2_client_hello 194
2871#define SSL_F_ssl3_handshake_mac 195
2872#define SSL_F_ssl3_prf 196
2873#define SSL_F_ssl3_read_bytes 197
2874#define SSL_F_ssl3_read_n 198
2875#define SSL_F_ssl3_send_cert_verify 199
2876#define SSL_F_ssl3_send_certificate_request 200
2877#define SSL_F_ssl3_send_channel_id 201
2878#define SSL_F_ssl3_send_client_certificate 202
2879#define SSL_F_ssl3_send_client_hello 203
2880#define SSL_F_ssl3_send_client_key_exchange 204
2881#define SSL_F_ssl3_send_server_certificate 205
2882#define SSL_F_ssl3_send_server_hello 206
2883#define SSL_F_ssl3_send_server_key_exchange 207
2884#define SSL_F_ssl3_setup_read_buffer 208
2885#define SSL_F_ssl3_setup_write_buffer 209
2886#define SSL_F_ssl3_write_bytes 210
2887#define SSL_F_ssl3_write_pending 211
2888#define SSL_F_ssl_add_cert_chain 212
2889#define SSL_F_ssl_add_cert_to_buf 213
2890#define SSL_F_ssl_add_clienthello_renegotiate_ext 214
2891#define SSL_F_ssl_add_clienthello_tlsext 215
2892#define SSL_F_ssl_add_clienthello_use_srtp_ext 216
2893#define SSL_F_ssl_add_serverhello_renegotiate_ext 217
2894#define SSL_F_ssl_add_serverhello_tlsext 218
2895#define SSL_F_ssl_add_serverhello_use_srtp_ext 219
2896#define SSL_F_ssl_build_cert_chain 220
2897#define SSL_F_ssl_bytes_to_cipher_list 221
2898#define SSL_F_ssl_cert_dup 222
2899#define SSL_F_ssl_cert_inst 223
2900#define SSL_F_ssl_cert_new 224
2901#define SSL_F_ssl_check_serverhello_tlsext 225
2902#define SSL_F_ssl_check_srvr_ecc_cert_and_alg 226
2903#define SSL_F_ssl_cipher_process_rulestr 227
2904#define SSL_F_ssl_cipher_strength_sort 228
2905#define SSL_F_ssl_create_cipher_list 229
2906#define SSL_F_ssl_ctx_log_master_secret 230
2907#define SSL_F_ssl_ctx_log_rsa_client_key_exchange 231
2908#define SSL_F_ssl_ctx_make_profiles 232
2909#define SSL_F_ssl_get_new_session 233
2910#define SSL_F_ssl_get_prev_session 234
2911#define SSL_F_ssl_get_server_cert_index 235
2912#define SSL_F_ssl_get_sign_pkey 236
2913#define SSL_F_ssl_init_wbio_buffer 237
2914#define SSL_F_ssl_parse_clienthello_renegotiate_ext 238
2915#define SSL_F_ssl_parse_clienthello_tlsext 239
2916#define SSL_F_ssl_parse_clienthello_use_srtp_ext 240
2917#define SSL_F_ssl_parse_serverhello_renegotiate_ext 241
2918#define SSL_F_ssl_parse_serverhello_tlsext 242
2919#define SSL_F_ssl_parse_serverhello_use_srtp_ext 243
2920#define SSL_F_ssl_scan_clienthello_tlsext 244
2921#define SSL_F_ssl_scan_serverhello_tlsext 245
2922#define SSL_F_ssl_sess_cert_new 246
2923#define SSL_F_ssl_set_cert 247
2924#define SSL_F_ssl_set_pkey 248
David Benjamin689be0f2015-02-11 15:55:26 -05002925#define SSL_F_ssl_verify_cert_chain 252
2926#define SSL_F_tls12_check_peer_sigalg 253
2927#define SSL_F_tls1_aead_ctx_init 254
2928#define SSL_F_tls1_cert_verify_mac 255
2929#define SSL_F_tls1_change_cipher_state 256
2930#define SSL_F_tls1_change_cipher_state_aead 257
2931#define SSL_F_tls1_check_duplicate_extensions 258
2932#define SSL_F_tls1_enc 259
2933#define SSL_F_tls1_export_keying_material 260
2934#define SSL_F_tls1_prf 261
2935#define SSL_F_tls1_setup_key_block 262
David Benjamin75381222015-03-02 19:30:30 -05002936#define SSL_F_dtls1_get_buffered_message 263
2937#define SSL_F_dtls1_process_fragment 264
David Benjaminee562b92015-03-02 20:52:52 -05002938#define SSL_F_dtls1_hm_fragment_new 265
David Benjamin9faafda2015-04-04 19:23:10 -04002939#define SSL_F_ssl3_seal_record 266
David Benjamind81e73d2015-04-05 00:21:39 -04002940#define SSL_F_ssl3_record_sequence_update 267
David Benjamin15a3b002015-04-28 00:05:35 -04002941#define SSL_F_SSL_CTX_set_tmp_dh 268
2942#define SSL_F_SSL_CTX_set_tmp_ecdh 269
2943#define SSL_F_SSL_set_tmp_dh 270
2944#define SSL_F_SSL_set_tmp_ecdh 271
David Benjaminc2807582015-04-28 00:19:50 -04002945#define SSL_F_SSL_CTX_set1_tls_channel_id 272
2946#define SSL_F_SSL_set1_tls_channel_id 273
David Benjamin7133d422015-04-28 00:43:39 -04002947#define SSL_F_SSL_set_tlsext_host_name 274
David Benjamin605641e2015-05-03 15:14:04 -04002948#define SSL_F_ssl3_output_cert_chain 275
David Benjamin31a07792015-03-03 14:20:26 -05002949#define SSL_F_SSL_AEAD_CTX_new 276
2950#define SSL_F_SSL_AEAD_CTX_open 277
2951#define SSL_F_SSL_AEAD_CTX_seal 278
2952#define SSL_F_dtls1_seal_record 279
David Benjaminfd67aa82015-06-15 19:41:48 -04002953#define SSL_F_SSL_SESSION_from_bytes 280
2954#define SSL_F_SSL_SESSION_parse 281
2955#define SSL_F_ssl3_check_certificate_for_cipher 282
David Benjamin6cacac02015-06-16 13:29:54 -04002956#define SSL_F_SSL_CTX_get_tlsext_ticket_keys 283
2957#define SSL_F_SSL_CTX_set_tlsext_ticket_keys 284
Adam Langley5021b222015-06-12 18:27:58 -07002958#define SSL_F_ext_ri_parse_clienthello 285
2959#define SSL_F_ext_ri_parse_serverhello 286
David Benjamin689be0f2015-02-11 15:55:26 -05002960#define SSL_R_APP_DATA_IN_HANDSHAKE 100
2961#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
2962#define SSL_R_BAD_ALERT 102
2963#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
2964#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
2965#define SSL_R_BAD_DH_P_LENGTH 105
2966#define SSL_R_BAD_DIGEST_LENGTH 106
2967#define SSL_R_BAD_ECC_CERT 107
2968#define SSL_R_BAD_ECPOINT 108
2969#define SSL_R_BAD_HANDSHAKE_LENGTH 109
2970#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07002971#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05002972#define SSL_R_BAD_LENGTH 112
2973#define SSL_R_BAD_PACKET_LENGTH 113
2974#define SSL_R_BAD_RSA_ENCRYPT 114
2975#define SSL_R_BAD_SIGNATURE 115
2976#define SSL_R_BAD_SRTP_MKI_VALUE 116
2977#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
2978#define SSL_R_BAD_SSL_FILETYPE 118
2979#define SSL_R_BAD_WRITE_RETRY 119
2980#define SSL_R_BIO_NOT_SET 120
2981#define SSL_R_BN_LIB 121
2982#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
2983#define SSL_R_CA_DN_LENGTH_MISMATCH 123
2984#define SSL_R_CA_DN_TOO_LONG 124
2985#define SSL_R_CCS_RECEIVED_EARLY 125
2986#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
2987#define SSL_R_CERT_CB_ERROR 127
2988#define SSL_R_CERT_LENGTH_MISMATCH 128
2989#define SSL_R_CHANNEL_ID_NOT_P256 129
2990#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
2991#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
2992#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
2993#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
2994#define SSL_R_CLIENTHELLO_TLSEXT 134
2995#define SSL_R_CONNECTION_REJECTED 135
2996#define SSL_R_CONNECTION_TYPE_NOT_SET 136
2997#define SSL_R_COOKIE_MISMATCH 137
2998#define SSL_R_D2I_ECDSA_SIG 138
2999#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
3000#define SSL_R_DATA_LENGTH_TOO_LONG 140
3001#define SSL_R_DECODE_ERROR 141
3002#define SSL_R_DECRYPTION_FAILED 142
3003#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
3004#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
3005#define SSL_R_DIGEST_CHECK_FAILED 145
3006#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
3007#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
3008#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
3009#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
3010#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
3011#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
3012#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
3013#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
3014#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
3015#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
3016#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
3017#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
3018#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
3019#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
3020#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
3021#define SSL_R_HTTPS_PROXY_REQUEST 161
3022#define SSL_R_HTTP_REQUEST 162
3023#define SSL_R_INAPPROPRIATE_FALLBACK 163
3024#define SSL_R_INVALID_COMMAND 164
3025#define SSL_R_INVALID_MESSAGE 165
3026#define SSL_R_INVALID_SSL_SESSION 166
3027#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
3028#define SSL_R_LENGTH_MISMATCH 168
3029#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
3030#define SSL_R_MISSING_DH_KEY 170
3031#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
3032#define SSL_R_MISSING_RSA_CERTIFICATE 172
3033#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
3034#define SSL_R_MISSING_RSA_SIGNING_CERT 174
3035#define SSL_R_MISSING_TMP_DH_KEY 175
3036#define SSL_R_MISSING_TMP_ECDH_KEY 176
3037#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
3038#define SSL_R_MTU_TOO_SMALL 178
3039#define SSL_R_NESTED_GROUP 179
3040#define SSL_R_NO_CERTIFICATES_RETURNED 180
3041#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
3042#define SSL_R_NO_CERTIFICATE_SET 182
3043#define SSL_R_NO_CIPHERS_AVAILABLE 183
3044#define SSL_R_NO_CIPHERS_PASSED 184
3045#define SSL_R_NO_CIPHERS_SPECIFIED 185
3046#define SSL_R_NO_CIPHER_MATCH 186
3047#define SSL_R_NO_COMPRESSION_SPECIFIED 187
3048#define SSL_R_NO_METHOD_SPECIFIED 188
3049#define SSL_R_NO_P256_SUPPORT 189
3050#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
3051#define SSL_R_NO_RENEGOTIATION 191
3052#define SSL_R_NO_REQUIRED_DIGEST 192
3053#define SSL_R_NO_SHARED_CIPHER 193
3054#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
3055#define SSL_R_NO_SRTP_PROFILES 195
3056#define SSL_R_NULL_SSL_CTX 196
3057#define SSL_R_NULL_SSL_METHOD_PASSED 197
3058#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
3059#define SSL_R_PACKET_LENGTH_TOO_LONG 199
3060#define SSL_R_PARSE_TLSEXT 200
3061#define SSL_R_PATH_TOO_LONG 201
3062#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
3063#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
3064#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
3065#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
3066#define SSL_R_PSK_NO_CLIENT_CB 206
3067#define SSL_R_PSK_NO_SERVER_CB 207
3068#define SSL_R_READ_BIO_NOT_SET 208
3069#define SSL_R_READ_TIMEOUT_EXPIRED 209
3070#define SSL_R_RECORD_LENGTH_MISMATCH 210
3071#define SSL_R_RECORD_TOO_LARGE 211
3072#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
3073#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
3074#define SSL_R_RENEGOTIATION_MISMATCH 214
3075#define SSL_R_REQUIRED_CIPHER_MISSING 215
3076#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
3077#define SSL_R_SERVERHELLO_TLSEXT 217
3078#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
3079#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
3080#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
3081#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
3082#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
3083#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
3084#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
3085#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
3086#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
3087#define SSL_R_SSL_HANDSHAKE_FAILURE 227
3088#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
3089#define SSL_R_SSL_SESSION_ID_CONFLICT 229
3090#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
3091#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
3092#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
3093#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
3094#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
3095#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
3096#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
3097#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
3098#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
3099#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
3100#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
3101#define SSL_R_UNEXPECTED_MESSAGE 241
3102#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
3103#define SSL_R_UNEXPECTED_RECORD 243
3104#define SSL_R_UNINITIALIZED 244
3105#define SSL_R_UNKNOWN_ALERT_TYPE 245
3106#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
3107#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
3108#define SSL_R_UNKNOWN_CIPHER_TYPE 248
3109#define SSL_R_UNKNOWN_DIGEST 249
3110#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
3111#define SSL_R_UNKNOWN_PROTOCOL 251
3112#define SSL_R_UNKNOWN_SSL_VERSION 252
3113#define SSL_R_UNKNOWN_STATE 253
3114#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
3115#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
3116#define SSL_R_UNSUPPORTED_CIPHER 256
3117#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
3118#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
3119#define SSL_R_UNSUPPORTED_PROTOCOL 259
3120#define SSL_R_UNSUPPORTED_SSL_VERSION 260
3121#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07003122#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05003123#define SSL_R_WRONG_CIPHER_RETURNED 263
3124#define SSL_R_WRONG_CURVE 264
3125#define SSL_R_WRONG_MESSAGE_TYPE 265
3126#define SSL_R_WRONG_SIGNATURE_TYPE 266
3127#define SSL_R_WRONG_SSL_VERSION 267
3128#define SSL_R_WRONG_VERSION_NUMBER 268
3129#define SSL_R_X509_LIB 269
3130#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05003131#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04003132#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04003133#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05003134#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07003135#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
3136#define SSL_R_EMS_STATE_INCONSISTENT 276
3137#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04003138#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07003139#define SSL_R_UNEXPECTED_EXTENSION 279
David Benjamind7c53682014-09-17 12:08:13 -04003140#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04003141#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
3142#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
3143#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
3144#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
3145#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
3146#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
3147#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
3148#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
3149#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
3150#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
3151#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
3152#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
3153#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
3154#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
3155#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
3156#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
3157#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
3158#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
3159#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
3160#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
3161#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04003162#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04003163#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
3164#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
3165#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
3166#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
3167#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
3168#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
3169#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07003170
David Benjamin087e4fa2015-04-08 23:46:10 -04003171#endif /* OPENSSL_HEADER_SSL_H */