blob: 76bb5fe9607d7acea3ddb3a9f17c815f3d7c8687 [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
David Benjamin79c117a2015-09-13 13:53:19 -0400182/* Cipher suites.
183 *
184 * |SSL_CIPHER| objects represent cipher suites. */
David Benjamin71f07942015-04-08 02:36:59 -0400185
186DECLARE_STACK_OF(SSL_CIPHER)
187
188/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
189 * suite based on its assigned number, or NULL if unknown. See
190 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
191OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
192
193/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
194 * get the cipher suite value. */
195OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
196
197/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
198 * mode). */
199OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
200
201/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
202OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
203
204/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
205OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
206
207/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
208 * CHACHA20_POLY1305. */
209OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
210
Matt Braithwaiteaf096752015-09-02 19:48:16 -0700211/* SSL_CIPHER_is_NULL returns one if |cipher| does not encrypt. */
212OPENSSL_EXPORT int SSL_CIPHER_is_NULL(const SSL_CIPHER *cipher);
213
214/* SSL_CIPHER_is_block_cipher returns one if |cipher| is a block cipher. */
215OPENSSL_EXPORT int SSL_CIPHER_is_block_cipher(const SSL_CIPHER *cipher);
216
David Benjamin71f07942015-04-08 02:36:59 -0400217/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
218OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
219
220/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
221 * method used by |cipher|. For example, "ECDHE_ECDSA". */
222OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
223
224/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
David Benjamin3fa65f02015-05-15 19:11:57 -0400225 * name for |cipher| or NULL on error. For example,
226 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
227 * calling |OPENSSL_free| on the result. */
David Benjamin71f07942015-04-08 02:36:59 -0400228OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
229
230/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
231 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
232 * symmetric algorithm to |*out_alg_bits|. */
233OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
234 int *out_alg_bits);
235
236
David Benjamin79c117a2015-09-13 13:53:19 -0400237/* SSL contexts.
238 *
239 * |SSL_CTX| objects manage shared state and configuration between multiple TLS
240 * or DTLS connections. Whether the connections are TLS or DTLS is selected by
241 * an |SSL_METHOD| on creation.
242 *
243 * |SSL_CTX| are reference-counted and may be shared by connections across
244 * multiple threads. Once shared, functions which change the |SSL_CTX|'s
245 * configuration may not be used. */
David Benjamin4831c332015-05-16 11:43:13 -0400246
247/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
248OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
249
250/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
251OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
252
253/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
David Benjamin79c117a2015-09-13 13:53:19 -0400254 * on error. */
David Benjamin4831c332015-05-16 11:43:13 -0400255OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
256
257/* SSL_CTX_free releases memory associated with |ctx|. */
258OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
259
260
David Benjamin79c117a2015-09-13 13:53:19 -0400261/* SSL connections.
262 *
263 * An |SSL| object represents a single TLS or DTLS connection. Although the
264 * shared |SSL_CTX| is thread-safe, an |SSL| is not thread-safe and may only be
265 * used on one thread at a time. */
David Benjamin4831c332015-05-16 11:43:13 -0400266
David Benjamin79c117a2015-09-13 13:53:19 -0400267/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. The new
268 * connection inherits settings from |ctx| at the time of creation. Settings may
269 * also be individually configured on the connection.
David Benjamin4831c332015-05-16 11:43:13 -0400270 *
271 * On creation, an |SSL| is not configured to be either a client or server. Call
272 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
273OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
274
275/* SSL_free releases memory associated with |ssl|. */
276OPENSSL_EXPORT void SSL_free(SSL *ssl);
277
278/* SSL_set_connect_state configures |ssl| to be a client. */
279OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
280
281/* SSL_set_accept_state configures |ssl| to be a server. */
282OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
283
David Benjamin3c1ccc02015-09-13 00:27:05 -0400284/* SSL_set_bio configures |ssl| to read from |rbio| and write to |wbio|. |ssl|
285 * takes ownership of the two |BIO|s. If |rbio| and |wbio| are the same, |ssl|
286 * only takes ownership of one reference.
287 *
288 * Calling this function on an already-configured |ssl| is deprecated. */
289OPENSSL_EXPORT void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
290
291/* SSL_get_rbio returns the |BIO| that |ssl| reads from. */
292OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *ssl);
293
294/* SSL_get_wbio returns the |BIO| that |ssl| writes to. */
295OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *ssl);
296
297/* SSL_do_handshake continues the current handshake. If there is none or the
298 * handshake has completed or False Started, it returns one. Otherwise, it
299 * returns <= 0. The caller should pass the value into |SSL_get_error| to
300 * determine how to proceed.
301 *
302 * TODO(davidben): Ensure 0 is only returned on transport EOF.
303 * https://crbug.com/466303. */
304OPENSSL_EXPORT int SSL_do_handshake(SSL *ssl);
305
306/* SSL_connect configures |ssl| as a client, if unconfigured, and calls
307 * |SSL_do_handshake|. */
308OPENSSL_EXPORT int SSL_connect(SSL *ssl);
309
310/* SSL_accept configures |ssl| as a server, if unconfigured, and calls
311 * |SSL_do_handshake|. */
312OPENSSL_EXPORT int SSL_accept(SSL *ssl);
313
314/* SSL_read reads up to |num| bytes from |ssl| into |buf|. It implicitly runs
315 * any pending handshakes, including renegotiations when enabled. On success, it
316 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
317 * should pass the value into |SSL_get_error| to determine how to proceed.
318 *
319 * TODO(davidben): Ensure 0 is only returned on transport EOF.
320 * https://crbug.com/466303. */
321OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
322
323/* SSL_peek behaves like |SSL_read| but does not consume any bytes returned. */
324OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
325
326/* SSL_write writes up to |num| bytes from |buf| into |ssl|. It implicitly runs
327 * any pending handshakes, including renegotiations when enabled. On success, it
328 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
329 * should pass the value into |SSL_get_error| to determine how to proceed.
330 *
331 * A non-blocking |SSL_write| differs from non-blocking |write| in that a failed
332 * |SSL_write| still commits to the data passed in. When retrying, the caller
333 * must supply the original write buffer (or a larger one containing the
334 * original as a prefix). By default, retries will fail if they also do not
335 * reuse the same |buf| pointer. This may be relaxed with
336 * |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER|, but the buffer contents still must be
337 * unchanged.
338 *
339 * By default, |SSL_write| will not return success until all |num| bytes are
340 * written. This may be relaxed with |SSL_MODE_ENABLE_PARTIAL_WRITE|. It allows
341 * |SSL_write| to complete with a partial result when only part of the input was
342 * written in a single record.
343 *
344 * TODO(davidben): Ensure 0 is only returned on transport EOF.
345 * https://crbug.com/466303. */
346OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
347
348/* SSL_shutdown shuts down |ssl|. On success, it completes in two stages. First,
349 * it returns 0 if |ssl| completed uni-directional shutdown; close_notify has
350 * been sent, but the peer's close_notify has not been received. Most callers
351 * may stop at this point. For bi-directional shutdown, call |SSL_shutdown|
352 * again. It returns 1 if close_notify has been both sent and received.
353 *
354 * If the peer's close_notify arrived first, the first stage is skipped.
355 * |SSL_shutdown| will return 1 once close_notify is sent and skip 0. Callers
356 * only interested in uni-directional shutdown must therefore allow for the
357 * first stage returning either 0 or 1.
358 *
359 * |SSL_shutdown| returns -1 on failure. The caller should pass the return value
360 * into |SSL_get_error| to determine how to proceed. If the underlying |BIO| is
361 * non-blocking, both stages may require retry.
362 *
363 * |SSL_shutdown| must be called to retain |ssl|'s session in the session
364 * cache. Use |SSL_CTX_set_quiet_shutdown| to configure |SSL_shutdown| to
365 * neither send nor wait for close_notify but still retain the session.
366 *
367 * TODO(davidben): Is there any point in the session cache interaction? Remove
368 * it? */
369OPENSSL_EXPORT int SSL_shutdown(SSL *ssl);
370
371/* SSL_get_error returns a |SSL_ERROR_*| value for the most recent operation on
372 * |ssl|. It should be called after an operation failed to determine. */
373OPENSSL_EXPORT int SSL_get_error(const SSL *ssl, int ret_code);
374
375/* SSL_ERROR_NONE indicates the operation succeeded. */
376#define SSL_ERROR_NONE 0
377
378/* SSL_ERROR_SSL indicates the operation failed within the library. The caller
379 * may inspect the error queue for more information. */
380#define SSL_ERROR_SSL 1
381
382/* SSL_ERROR_WANT_READ indicates the operation failed attempting to read from
383 * the transport. The caller may retry the operation when the transport is ready
384 * for reading. */
385#define SSL_ERROR_WANT_READ 2
386
387/* SSL_ERROR_WANT_READ indicates the operation failed attempting to write to
388 * the transport. The caller may retry the operation when the transport is ready
389 * for writing. */
390#define SSL_ERROR_WANT_WRITE 3
391
392/* SSL_ERROR_WANT_X509_LOOKUP indicates the operation failed in calling the
393 * |cert_cb| or |client_cert_cb|. The caller may retry the operation when the
394 * callback is ready to return a certificate or one has been configured
395 * externally.
396 *
397 * See also |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb|. */
398#define SSL_ERROR_WANT_X509_LOOKUP 4
399
400/* SSL_ERROR_WANT_SYSCALL indicates the operation failed externally to the
401 * library. The caller should consult the system-specific error mechanism. This
402 * is typically |errno| but may be something custom if using a custom |BIO|. It
403 * may also be signaled if the transport returned EOF, in which case the
404 * operation's return value will be zero. */
405#define SSL_ERROR_SYSCALL 5
406
407/* SSL_ERROR_ZERO_RETURN indicates the operation failed because the connection
408 * was cleanly shut down with a close_notify alert. */
409#define SSL_ERROR_ZERO_RETURN 6
410
411/* SSL_ERROR_WANT_CONNECT indicates the operation failed attempting to connect
412 * the transport (the |BIO| signaled |BIO_RR_CONNECT|). The caller may retry the
413 * operation when the transport is ready. */
414#define SSL_ERROR_WANT_CONNECT 7
415
416/* SSL_ERROR_WANT_ACCEPT indicates the operation failed attempting to accept a
417 * connection from the transport (the |BIO| signaled |BIO_RR_ACCEPT|). The
418 * caller may retry the operation when the transport is ready.
419 *
420 * TODO(davidben): Remove this. It's used by accept BIOs which are bizarre. */
421#define SSL_ERROR_WANT_ACCEPT 8
422
423/* SSL_ERROR_WANT_CHANNEL_ID_LOOKUP indicates the operation failed looking up
424 * the Channel ID key. The caller may retry the operation when |channel_id_cb|
425 * is ready to return a key or one has been configured externally.
426 *
427 * See also |SSL_CTX_set_channel_id_cb|. */
428#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
429
430/* SSL_ERROR_PENDING_SESSION indicates the operation failed because the session
431 * lookup callback indicated the session was unavailable. The caller may retry
432 * the operation when lookup has completed.
433 *
434 * See also |SSL_CTX_sess_set_get_cb|. */
435#define SSL_ERROR_PENDING_SESSION 11
436
437/* SSL_ERROR_PENDING_CERTIFICATE indicates the operation failed because the
438 * early callback indicated certificate lookup was incomplete. The caller may
439 * retry the operation when lookup has completed. Note: when the operation is
440 * retried, the early callback will not be called a second time.
441 *
442 * See also |select_certificate_cb| on |SSL_CTX|. */
443#define SSL_ERROR_PENDING_CERTIFICATE 12
444
445/* SSL_ERROR_WANT_PRIVATE_KEY_OPERATION indicates the operation failed because
446 * a private key operation was unfinished. The caller may retry the operation
447 * when the private key operation is complete.
448 *
449 * See also |SSL_set_private_key_method|. */
450#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
451
David Benjamin4831c332015-05-16 11:43:13 -0400452
David Benjaminb487df62015-05-16 15:31:07 -0400453/* Protocol versions. */
454
David Benjaminb8d28cf2015-07-28 21:34:45 -0400455#define DTLS1_VERSION_MAJOR 0xfe
David Benjaminb487df62015-05-16 15:31:07 -0400456#define SSL3_VERSION_MAJOR 0x03
457
458#define SSL3_VERSION 0x0300
459#define TLS1_VERSION 0x0301
460#define TLS1_1_VERSION 0x0302
461#define TLS1_2_VERSION 0x0303
462
463#define DTLS1_VERSION 0xfeff
464#define DTLS1_2_VERSION 0xfefd
465
466/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
467 * |version|. */
468OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
469
470/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
471 * |version|. */
472OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
473
474/* SSL_set_min_version sets the minimum protocol version for |ssl| to
475 * |version|. */
476OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
477
478/* SSL_set_max_version sets the maximum protocol version for |ssl| to
479 * |version|. */
480OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
481
482
483/* Options.
484 *
485 * Options configure protocol behavior. */
486
487/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
488 * support the renegotiation_info extension (RFC 5746). It is on by default. */
489#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
490
491/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
492 * bytes above the maximum record size. */
493#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
494
495/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
496 * (i.e. without a length prefix). */
497#define SSL_OP_TLS_D5_BUG 0x00000100L
498
499/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
500 * consumers.
501 * TODO(davidben): Determine which of the remaining may be removed now. */
502#define SSL_OP_ALL 0x00000BFFL
503
504/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
505 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
506#define SSL_OP_NO_QUERY_MTU 0x00001000L
507
508/* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
509#define SSL_OP_NO_TICKET 0x00004000L
510
David Benjaminb487df62015-05-16 15:31:07 -0400511/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
512 * ECDHE curves according to the server's preferences instead of the
513 * client's. */
514#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
515
516/* The following flags toggle individual protocol versions. This is deprecated.
517 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
518#define SSL_OP_NO_SSLv3 0x02000000L
519#define SSL_OP_NO_TLSv1 0x04000000L
520#define SSL_OP_NO_TLSv1_2 0x08000000L
521#define SSL_OP_NO_TLSv1_1 0x10000000L
522#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
523#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
524
525/* The following flags do nothing and are included only to make it easier to
526 * compile code with BoringSSL. */
Matt Braithwaite45b03022015-08-05 17:17:57 -0700527#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
David Benjaminb487df62015-05-16 15:31:07 -0400528#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700529#define SSL_OP_EPHEMERAL_RSA 0
David Benjaminb487df62015-05-16 15:31:07 -0400530#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700531#define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
532#define SSL_OP_NETSCAPE_CA_DN_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400533#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700534#define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
535#define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400536#define SSL_OP_NO_COMPRESSION 0
537#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
538#define SSL_OP_NO_SSLv2 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700539#define SSL_OP_PKCS1_CHECK_1 0
540#define SSL_OP_PKCS1_CHECK_2 0
David Benjaminb487df62015-05-16 15:31:07 -0400541#define SSL_OP_SINGLE_DH_USE 0
542#define SSL_OP_SINGLE_ECDH_USE 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700543#define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400544#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
545#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
546#define SSL_OP_TLS_ROLLBACK_BUG 0
547
548/* SSL_CTX_set_options enables all options set in |options| (which should be one
549 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
550 * bitmask representing the resulting enabled options. */
551OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
552
553/* SSL_CTX_clear_options disables all options set in |options| (which should be
554 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
555 * bitmask representing the resulting enabled options. */
556OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
557
558/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
559 * the options enabled for |ctx|. */
560OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
561
562/* SSL_set_options enables all options set in |options| (which should be one or
563 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
564 * representing the resulting enabled options. */
565OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
566
567/* SSL_clear_options disables all options set in |options| (which should be one
568 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
569 * bitmask representing the resulting enabled options. */
570OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
571
572/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
573 * options enabled for |ssl|. */
574OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
575
576
577/* Modes.
578 *
579 * Modes configure API behavior. */
580
581/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
582 * result when the only part of the input was written in a single record. */
583#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
584
585/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
586 * with a different buffer. However, |SSL_write| still assumes the buffer
587 * contents are unchanged. This is not the default to avoid the misconception
588 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
589#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
590
591/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
592 * before sending certificates to the peer.
593 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
594#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
595
David Benjaminb487df62015-05-16 15:31:07 -0400596/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
597 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
598 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
599#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
600
David Benjaminb487df62015-05-16 15:31:07 -0400601/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
602 * TLS 1.0 to be split in two: the first record will contain a single byte and
603 * the second will contain the remainder. This effectively randomises the IV and
604 * prevents BEAST attacks. */
605#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
606
607/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
608 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
609 * session resumption is used for a given SSL*. */
610#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
611
612/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
613 * To be set only by applications that reconnect with a downgraded protocol
David Benjamin229adfb2015-07-25 15:08:18 -0400614 * version; see RFC 7507 for details.
David Benjaminb487df62015-05-16 15:31:07 -0400615 *
616 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
David Benjamin229adfb2015-07-25 15:08:18 -0400617 * this in explicit fallback retries, following the guidance in RFC 7507. */
David Benjaminb487df62015-05-16 15:31:07 -0400618#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
619
620/* The following flags do nothing and are included only to make it easier to
621 * compile code with BoringSSL. */
622#define SSL_MODE_AUTO_RETRY 0
623#define SSL_MODE_RELEASE_BUFFERS 0
David Benjamin74d8bc22015-05-21 02:16:53 -0400624#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
625#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjaminb487df62015-05-16 15:31:07 -0400626
627/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
628 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
629 * representing the resulting enabled modes. */
630OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
631
632/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
633 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
634 * bitmask representing the resulting enabled modes. */
635OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
636
637/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
638 * the modes enabled for |ssl|. */
639OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
640
641/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
642 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
643 * representing the resulting enabled modes. */
644OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
645
646/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
647 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
648 * representing the resulting enabled modes. */
649OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
650
651/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
652 * modes enabled for |ssl|. */
653OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
654
655
David Benjaminb4d65fd2015-05-29 17:11:21 -0400656/* Configuring certificates and private keys.
657 *
David Benjamin11c0f8e2015-07-06 00:18:15 -0400658 * These functions configure the connection's leaf certificate, private key, and
659 * certificate chain. The certificate chain is ordered leaf to root (as sent on
660 * the wire) but does not include the leaf. Both client and server certificates
661 * use these functions.
662 *
663 * Certificates and keys may be configured before the handshake or dynamically
664 * in the early callback and certificate callback. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400665
David Benjamin7481d392015-07-05 19:38:46 -0400666/* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
667 * one on success and zero on failure. */
668OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
669
670/* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
671 * on success and zero on failure. */
672OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
673
674/* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
675 * success and zero on failure. */
676OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
677
678/* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
679 * success and zero on failure. */
680OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
681
David Benjamin11c0f8e2015-07-06 00:18:15 -0400682/* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
683 * |chain|. On success, it returns one and takes ownership of |chain|.
684 * Otherwise, it returns zero. */
685OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
686
687/* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
688 * |chain|. It returns one on success and zero on failure. The caller retains
689 * ownership of |chain| and may release it freely. */
690OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
691
692/* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
693 * |chain|. On success, it returns one and takes ownership of |chain|.
694 * Otherwise, it returns zero. */
695OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
696
697/* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
698 * |chain|. It returns one on success and zero on failure. The caller retains
699 * ownership of |chain| and may release it freely. */
700OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
701
702/* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
703 * success, it returns one and takes ownership of |x509|. Otherwise, it returns
704 * zero. */
705OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
706
707/* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
708 * returns one on success and zero on failure. The caller retains ownership of
709 * |x509| and may release it freely. */
710OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
711
712/* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
713 * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
714OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
715
716/* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
717OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
718
719/* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
720 * one on success and zero on failure. The caller retains ownership of |x509|
721 * and may release it freely. */
722OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
723
724/* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
725 * one. */
726OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
727
728/* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
729OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
730
731/* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
732OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
733
David Benjamin7481d392015-07-05 19:38:46 -0400734/* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
735 * The callback returns one on success, zero on internal error, and a negative
736 * number on failure or to pause the handshake. If the handshake is paused,
737 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
738OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
739 int (*cb)(SSL *ssl, void *arg),
740 void *arg);
741
742/* SSL_set_cert_cb sets a callback that is called to select a certificate. The
743 * callback returns one on success, zero on internal error, and a negative
744 * number on failure or to pause the handshake. If the handshake is paused,
745 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
746OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
747 void *arg);
748
749/* SSL_certs_clear resets the private key, leaf certificate, and certificate
750 * chain of |ssl|. */
751OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
752
753/* SSL_CTX_check_private_key returns one if the certificate and private key
754 * configured in |ctx| are consistent and zero otherwise. */
755OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
756
757/* SSL_check_private_key returns one if the certificate and private key
758 * configured in |ssl| are consistent and zero otherwise. */
759OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
760
761/* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
762OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
763
764/* SSL_get_certificate returns |ssl|'s leaf certificate. */
765OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
766
David Benjamin11c0f8e2015-07-06 00:18:15 -0400767/* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
768OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
769
770/* SSL_get_privatekey returns |ssl|'s private key. */
771OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
772
773/* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
774 * returns one. */
775OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
776 STACK_OF(X509) **out_chain);
777
778/* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
779OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
780 STACK_OF(X509) **out_chain);
781
782/* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
783 * returns one. */
784OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
785 STACK_OF(X509) **out_chain);
786
Paul Lietar4fac72e2015-09-09 13:44:55 +0100787/* SSL_CTX_set_signed_cert_timestamp_list sets the list of signed certificate
788 * timestamps that is sent to clients that request it. The |list| argument must
789 * contain one or more SCT structures serialised as a SignedCertificateTimestamp
790 * List (see https://tools.ietf.org/html/rfc6962#section-3.3) – i.e. each SCT
791 * is prefixed by a big-endian, uint16 length and the concatenation of one or
792 * more such prefixed SCTs are themselves also prefixed by a uint16 length. It
793 * returns one on success and zero on error. The caller retains ownership of
794 * |list|. */
795OPENSSL_EXPORT int SSL_CTX_set_signed_cert_timestamp_list(SSL_CTX *ctx,
796 const uint8_t *list,
797 size_t list_len);
798
Paul Lietaraeeff2c2015-08-12 11:47:11 +0100799/* SSL_CTX_set_ocsp_response sets the OCSP reponse that is sent to clients
800 * which request it. It returns one on success and zero on error. The caller
801 * retains ownership of |response|. */
802OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx,
803 const uint8_t *response,
804 size_t response_len);
805
David Benjamin7481d392015-07-05 19:38:46 -0400806
807/* Certificate and private key convenience functions. */
808
809/* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
810 * on success and zero on failure. */
811OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
812
813/* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
814 * success and zero on failure. */
815OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
816
817/* The following functions configure certificates or private keys but take as
818 * input DER-encoded structures. They return one on success and zero on
819 * failure. */
820
821OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
822 const uint8_t *d);
823OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
824 int len);
825
826OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
827 const uint8_t *d, long len);
828OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
829 const uint8_t *d, long len);
830
831OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
David Benjamin74f71102015-06-27 14:56:25 -0400832 const uint8_t *der,
833 size_t der_len);
834OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
835 size_t der_len);
David Benjamin7481d392015-07-05 19:38:46 -0400836
837/* The following functions configure certificates or private keys but take as
838 * input files to read from. They return one on success and zero on failure. The
839 * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
840 * the file's contents are read as PEM or DER. */
841
842#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
843#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
844
845OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
846 const char *file,
847 int type);
848OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
849 int type);
850
851OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
852 int type);
853OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
854 int type);
855
856OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
857 int type);
858OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
859 int type);
860
861/* SSL_CTX_use_certificate_file configures certificates for |ctx|. It reads the
862 * contents of |file| as a PEM-encoded leaf certificate followed optionally by
863 * the certificate chain to send to the peer. It returns one on success and zero
864 * on failure. */
865OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
866 const char *file);
867
868
869/* Custom private keys. */
870
David Benjaminb4d65fd2015-05-29 17:11:21 -0400871enum ssl_private_key_result_t {
872 ssl_private_key_success,
873 ssl_private_key_retry,
874 ssl_private_key_failure,
875};
876
877/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
878 * signing operations to a custom, potentially asynchronous, backend. */
879typedef struct ssl_private_key_method_st {
880 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
881 * key used by |ssl|. */
882 int (*type)(SSL *ssl);
883
884 /* supports_digest returns one if the key used by |ssl| supports signing
885 * digests of type |md| and zero otherwise. */
886 int (*supports_digest)(SSL *ssl, const EVP_MD *md);
887
888 /* max_signature_len returns the maximum length of a signature signed by the
889 * key used by |ssl|. This must be a constant value for a given |ssl|. */
890 size_t (*max_signature_len)(SSL *ssl);
891
892 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
893 * used to calculate |in|. On success, it returns |ssl_private_key_success|
894 * and writes at most |max_out| bytes of signature data to |out|. On failure,
895 * it returns |ssl_private_key_failure|. If the operation has not completed,
896 * it returns |ssl_private_key_retry|. |sign| should arrange for the
897 * high-level operation on |ssl| to be retried when the operation is
898 * completed. This will result in a call to |sign_complete|.
899 *
900 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
901 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
902 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
903 *
904 * It is an error to call |sign| while another private key operation is in
905 * progress on |ssl|. */
906 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
907 size_t max_out, const EVP_MD *md,
908 const uint8_t *in, size_t in_len);
909
910 /* sign_complete completes a pending |sign| operation. If the operation has
911 * completed, it returns |ssl_private_key_success| and writes the result to
912 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
913 * failure and |ssl_private_key_retry| if the operation is still in progress.
914 *
915 * |sign_complete| may be called arbitrarily many times before completion, but
916 * it is an error to call |sign_complete| if there is no pending |sign|
917 * operation in progress on |ssl|. */
918 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
919 size_t *out_len, size_t max_out);
920} SSL_PRIVATE_KEY_METHOD;
921
David Benjamind1d80782015-07-05 11:54:09 -0400922/* SSL_use_private_key_method configures a custom private key on |ssl|.
923 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400924OPENSSL_EXPORT void SSL_set_private_key_method(
925 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
926
927
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700928/* Connection information. */
929
David Benjaminee0c8272015-09-13 01:03:54 -0400930/* SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the
931 * peer did not use certificates. The caller must call |X509_free| on the
932 * result to release it. */
933OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl);
934
935/* SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if
936 * unavailable or the peer did not use certificates. For historical reasons,
937 * this may not be available if resuming a serialized |SSL_SESSION|. The caller
938 * does not take ownership of the result.
939 *
940 * WARNING: This function behaves differently between client and server. If
941 * |ssl| is a server, the returned chain does not include the leaf certificate.
942 * If a client, it does. */
943OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
944
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700945/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
946 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
947 * returns one on success or zero on error. In general |max_out| should be at
948 * least 12.
949 *
950 * This function will always fail if the initial handshake has not completed.
951 * The tls-unique value will change after a renegotiation but, since
952 * renegotiations can be initiated by the server at any point, the higher-level
953 * protocol must either leave them disabled or define states in which the
954 * tls-unique value can be read.
955 *
956 * The tls-unique value is defined by
957 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
958 * TLS protocol, tls-unique is broken for resumed connections unless the
959 * Extended Master Secret extension is negotiated. Thus this function will
960 * return zero if |ssl| performed session resumption unless EMS was used when
961 * negotiating the original session. */
962OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
963 size_t *out_len, size_t max_out);
964
965
Adam Langley09505632015-07-30 18:10:13 -0700966/* Custom extensions.
967 *
968 * The custom extension functions allow TLS extensions to be added to
969 * ClientHello and ServerHello messages. */
970
971/* SSL_custom_ext_add_cb is a callback function that is called when the
972 * ClientHello (for clients) or ServerHello (for servers) is constructed. In
973 * the case of a server, this callback will only be called for a given
974 * extension if the ClientHello contained that extension – it's not possible to
975 * inject extensions into a ServerHello that the client didn't request.
976 *
977 * When called, |extension_value| will contain the extension number that is
978 * being considered for addition (so that a single callback can handle multiple
979 * extensions). If the callback wishes to include the extension, it must set
980 * |*out| to point to |*out_len| bytes of extension contents and return one. In
981 * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
982 * called with the value of |*out| once that data has been copied.
983 *
984 * If the callback does not wish to add an extension it must return zero.
985 *
986 * Alternatively, the callback can abort the connection by setting
987 * |*out_alert_value| to a TLS alert number and returning -1. */
988typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
989 const uint8_t **out, size_t *out_len,
990 int *out_alert_value, void *add_arg);
991
992/* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
993 * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
994 * this callback is called and passed the |out| pointer that was returned by
995 * the add callback. This is to free any dynamically allocated data created by
996 * the add callback. */
997typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
998 const uint8_t *out, void *add_arg);
999
1000/* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
1001 * parse an extension from the peer: that is from the ServerHello for a client
1002 * and from the ClientHello for a server.
1003 *
1004 * When called, |extension_value| will contain the extension number and the
1005 * contents of the extension are |contents_len| bytes at |contents|.
1006 *
1007 * The callback must return one to continue the handshake. Otherwise, if it
1008 * returns zero, a fatal alert with value |*out_alert_value| is sent and the
1009 * handshake is aborted. */
1010typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
1011 const uint8_t *contents,
1012 size_t contents_len,
1013 int *out_alert_value, void *parse_arg);
1014
1015/* SSL_extension_supported returns one iff OpenSSL internally handles
1016 * extensions of type |extension_value|. This can be used to avoid registering
1017 * custom extension handlers for extensions that a future version of OpenSSL
1018 * may handle internally. */
1019OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
1020
1021/* SSL_CTX_add_client_custom_ext registers callback functions for handling
1022 * custom TLS extensions for client connections.
1023 *
1024 * If |add_cb| is NULL then an empty extension will be added in each
1025 * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
1026 * this callback.
1027 *
1028 * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
1029 * needs to be freed.
1030 *
1031 * It returns one on success or zero on error. It's always an error to register
1032 * callbacks for the same extension twice, or to register callbacks for an
1033 * extension that OpenSSL handles internally. See |SSL_extension_supported| to
1034 * discover, at runtime, which extensions OpenSSL handles internally. */
1035OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
1036 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1037 SSL_custom_ext_free_cb free_cb, void *add_arg,
1038 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1039
1040/* SSL_CTX_add_server_custom_ext is the same as
1041 * |SSL_CTX_add_client_custom_ext|, but for server connections.
1042 *
1043 * Unlike on the client side, if |add_cb| is NULL no extension will be added.
1044 * The |add_cb|, if any, will only be called if the ClientHello contained a
1045 * matching extension. */
1046OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
1047 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1048 SSL_custom_ext_free_cb free_cb, void *add_arg,
1049 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1050
1051
David Benjamina6b8cdf2015-09-13 14:07:33 -04001052/* Sessions.
1053 *
1054 * An |SSL_SESSION| represents an SSL session that may be resumed in an
1055 * abbreviated handshake. It is reference-counted and immutable. Once
1056 * established, an |SSL_SESSION| may be shared by multiple |SSL| objects on
1057 * different threads and must not be modified. */
1058
1059/* SSL_SESSION_new returns a newly-allocated blank |SSL_SESSION| or NULL on
1060 * error. This may be useful in writing tests but otherwise should not be
1061 * used outside the library. */
1062OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
1063
1064/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
1065 * of |session|. It then returns |session|. */
1066OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
1067
1068/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
1069 * zero, all data referenced by |session| and |session| itself are released. */
1070OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
1071
1072/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
1073 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
1074 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
1075 * one on success and zero on error. */
1076OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
1077 size_t *out_len);
1078
1079/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
1080 * identification information, namely the session ID and ticket. */
1081OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
1082 uint8_t **out_data,
1083 size_t *out_len);
1084
1085/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
1086 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
1087OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
1088 size_t in_len);
1089
1090/* SSL_SESSION_get_version returns a string describing the TLS version |session|
1091 * was established at. For example, "TLSv1.2" or "SSLv3". */
1092OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *session);
1093
1094/* SSL_SESSION_get_id returns a pointer to a buffer containg |session|'s session
1095 * ID and sets |*out_len| to its length. */
1096OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *session,
1097 unsigned *out_len);
1098
1099/* SSL_SESSION_get_time returns the time at which |session| was established in
1100 * seconds since the UNIX epoch. */
1101OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *session);
1102
1103/* SSL_SESSION_get_timeout returns the lifetime of |session| in seconds. */
1104OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *session);
1105
1106/* SSL_SESSION_get_key_exchange_info returns a value that describes the
1107 * strength of the asymmetric operation that provides confidentiality to
1108 * |session|. Its interpretation depends on the operation used. See the
1109 * documentation for this value in the |SSL_SESSION| structure. */
1110OPENSSL_EXPORT uint32_t SSL_SESSION_get_key_exchange_info(SSL_SESSION *session);
1111
1112/* SSL_SESSION_get0_peer return's the peer leaf certificate stored in
1113 * |session|. */
1114OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *session);
1115
1116/* SSL_SESSION_set_time sets |session|'s creation time to |time| and returns
1117 * |time|. This function may be useful in writing tests but otherwise should not
1118 * be used. */
1119OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *session, long time);
1120
1121/* SSL_SESSION_set_time sets |session|'s timeout to |timeout| and returns one.
1122 * This function may be useful in writing tests but otherwise should not be
1123 * used. */
1124OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *session, long timeout);
1125
1126/* SSL_SESSION_set1_id_context sets |session|'s session ID context (see
1127 * |SSL_CTX_set_session_id_context|) to |sid_ctx|. It returns one on success and
1128 * zero on error. This function may be useful in writing tests but otherwise
1129 * should not be used. */
1130OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *session,
1131 const uint8_t *sid_ctx,
1132 unsigned sid_ctx_len);
1133
1134
David Benjamindaeafc22015-06-25 17:35:11 -04001135/* Session tickets. */
1136
1137/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
1138 * |len| bytes of |out|. It returns one on success and zero if |len| is not
1139 * 48. If |out| is NULL, it returns 48 instead. */
1140OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
1141 size_t len);
1142
1143/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
1144 * |len| bytes of |in|. It returns one on success and zero if |len| is not
1145 * 48. If |in| is NULL, it returns 48 instead. */
1146OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
1147 size_t len);
1148
David Benjamine3aa1d92015-06-16 15:34:50 -04001149/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
1150 * ticket. */
1151#define SSL_TICKET_KEY_NAME_LEN 16
1152
David Benjamindaeafc22015-06-25 17:35:11 -04001153/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
1154 * returns one. |callback| will be called when encrypting a new ticket and when
1155 * decrypting a ticket from the client.
1156 *
1157 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
1158 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
1159 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
1160 * for encryption or decryption, based on the mode.
1161 *
1162 * When encrypting a new ticket, |encrypt| will be one. It writes a public
1163 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
1164 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1165 * |callback| returns 1 on success and -1 on error.
1166 *
1167 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
1168 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
1169 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1170 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
1171 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
1172 * This may be used to re-key the ticket.
1173 *
1174 * WARNING: |callback| wildly breaks the usual return value convention and is
1175 * called in two different modes. */
1176OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
1177 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
1178 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
1179 int encrypt));
1180
1181
David Benjamin190ab7f2015-09-13 14:20:58 -04001182/* ex_data functions.
1183 *
1184 * See |ex_data.h| for details. */
1185
1186OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
1187OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
1188OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
1189 CRYPTO_EX_new *new_func,
1190 CRYPTO_EX_dup *dup_func,
1191 CRYPTO_EX_free *free_func);
1192
1193OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *session, int idx,
1194 void *data);
1195OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *session,
1196 int idx);
1197OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
1198 CRYPTO_EX_new *new_func,
1199 CRYPTO_EX_dup *dup_func,
1200 CRYPTO_EX_free *free_func);
1201
1202OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ctx, int idx, void *data);
1203OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ctx, int idx);
1204OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
1205 CRYPTO_EX_new *new_func,
1206 CRYPTO_EX_dup *dup_func,
1207 CRYPTO_EX_free *free_func);
1208
1209
David Benjamin71f07942015-04-08 02:36:59 -04001210/* Underdocumented functions.
1211 *
1212 * Functions below here haven't been touched up and may be underdocumented. */
1213
Adam Langley95c29f32014-06-20 12:00:00 -07001214/* SSLeay version number for ASN.1 encoding of the session information */
1215/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -08001216 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -07001217#define SSL_SESSION_ASN1_VERSION 0x0001
1218
Adam Langleyb4a494c2015-01-23 15:10:10 -08001219#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
1220#define SSL_MAX_SID_CTX_LENGTH 32
1221#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -07001222
1223/* These are used to specify which ciphers to use and not to use */
1224
Adam Langleyb4a494c2015-01-23 15:10:10 -08001225#define SSL_TXT_MEDIUM "MEDIUM"
1226#define SSL_TXT_HIGH "HIGH"
1227#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -07001228
Adam Langleyb4a494c2015-01-23 15:10:10 -08001229#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -04001230#define SSL_TXT_kDHE "kDHE"
1231#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
1232#define SSL_TXT_kECDHE "kECDHE"
1233#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001234#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07001235
Adam Langleyb4a494c2015-01-23 15:10:10 -08001236#define SSL_TXT_aRSA "aRSA"
1237#define SSL_TXT_aECDSA "aECDSA"
1238#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07001239
Adam Langleyb4a494c2015-01-23 15:10:10 -08001240#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -04001241#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04001242#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001243#define SSL_TXT_RSA "RSA"
1244#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -04001245#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04001246#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001247#define SSL_TXT_ECDSA "ECDSA"
1248#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -07001249
Adam Langleyb4a494c2015-01-23 15:10:10 -08001250#define SSL_TXT_3DES "3DES"
1251#define SSL_TXT_RC4 "RC4"
1252#define SSL_TXT_AES128 "AES128"
1253#define SSL_TXT_AES256 "AES256"
1254#define SSL_TXT_AES "AES"
1255#define SSL_TXT_AES_GCM "AESGCM"
1256#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -07001257
Adam Langleyb4a494c2015-01-23 15:10:10 -08001258#define SSL_TXT_MD5 "MD5"
1259#define SSL_TXT_SHA1 "SHA1"
1260#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
1261#define SSL_TXT_SHA256 "SHA256"
1262#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -07001263
Adam Langleyb4a494c2015-01-23 15:10:10 -08001264#define SSL_TXT_SSLV3 "SSLv3"
1265#define SSL_TXT_TLSV1 "TLSv1"
1266#define SSL_TXT_TLSV1_1 "TLSv1.1"
1267#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -07001268
Adam Langleyb4a494c2015-01-23 15:10:10 -08001269#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -07001270
Adam Langleyb4a494c2015-01-23 15:10:10 -08001271/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
1272 * normally not being used.
1273 *
1274 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
1275 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
1276 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
1277 * that it is also disabled in the specific selection. COMPLEMENTOF*
1278 * identifiers are portable between version, as adjustments to the default
1279 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -07001280 *
1281 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -08001282 * DEFAULT gets, as only selection is being done and no sorting as needed for
1283 * DEFAULT. */
1284#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -07001285
Adam Langleyb4a494c2015-01-23 15:10:10 -08001286/* The following cipher list is used by default. It also is substituted when an
1287 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -04001288#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -08001289
Adam Langley95c29f32014-06-20 12:00:00 -07001290/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
1291 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -08001292 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
1293 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001294
1295/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001296#define SSL_SENT_SHUTDOWN 1
1297#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -07001298
David Benjamin82c9e902014-12-12 15:55:27 -05001299typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07001300typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -05001301typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07001302
Adam Langleyb4a494c2015-01-23 15:10:10 -08001303/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
1304typedef struct srtp_protection_profile_st {
1305 const char *name;
1306 unsigned long id;
1307} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -07001308
1309DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
1310
David Benjamincb9cf792015-05-05 09:46:14 -04001311/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
1312 * and zero on failure. */
1313OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -07001314
David Benjamincb9cf792015-05-05 09:46:14 -04001315/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
1316 * renegotiation (RFC 5746) and zero otherwise. */
1317OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001318
David Benjamin59015c32015-04-26 13:13:55 -04001319/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
1320 * This callback will be called when sending or receiving low-level record
1321 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
1322 * |write_p| is one for outgoing messages and zero for incoming messages.
1323 *
1324 * For each record header, |cb| is called with |version| = 0 and |content_type|
1325 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
1326 * this does not include the record body. If the record is sealed, the length
1327 * in the header is the length of the ciphertext.
1328 *
1329 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
1330 * protocol version and |content_type| is the corresponding record type. The
1331 * |len| bytes from |buf| contain the handshake message, one-byte
1332 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001333OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
1334 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
1335 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001336
David Benjamin61ecccf2015-05-05 09:44:51 -04001337/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
1338 * callback. */
1339OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
1340
David Benjamin59015c32015-04-26 13:13:55 -04001341/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
1342 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001343OPENSSL_EXPORT void SSL_set_msg_callback(
1344 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
1345 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001346
David Benjamin3b7456e2015-05-16 12:29:32 -04001347/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -04001348OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07001349
David Benjamin859ec3c2014-09-02 16:29:36 -04001350/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -08001351 * log session material to |keylog_bio|. This is intended for debugging use
1352 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -04001353 *
1354 * The format is described in
1355 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -04001356OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -04001357
Adam Langley95c29f32014-06-20 12:00:00 -07001358
Adam Langleyc9fb3752014-06-20 12:00:00 -07001359struct ssl_aead_ctx_st;
1360typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
1361
Adam Langleyb4a494c2015-01-23 15:10:10 -08001362#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -07001363
Adam Langleyb4a494c2015-01-23 15:10:10 -08001364#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -07001365
David Benjaminf4501342014-08-14 17:24:37 -04001366#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
1367
Adam Langleyb4a494c2015-01-23 15:10:10 -08001368/* This callback type is used inside SSL_CTX, SSL, and in the functions that
1369 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -07001370 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001371 * callbacks should themselves check if the id they generate is unique
1372 * otherwise the SSL handshake will fail with an error - callbacks can do this
1373 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -07001374 * SSL_has_matching_session_id(ssl, id, *id_len)
1375 * The length value passed in is set at the maximum size the session ID can be.
1376 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
1377 * can alter this length to be less if desired, but under SSLv2 session IDs are
1378 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -08001379 * returns in this case. It is also an error for the callback to set the size
1380 * to zero. */
1381typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
1382 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001383
Adam Langleydc9b1412014-06-20 12:00:00 -07001384/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -08001385 * early on during the server handshake. At this point, much of the SSL* hasn't
1386 * been filled out and only the ClientHello can be depended on. */
1387struct ssl_early_callback_ctx {
1388 SSL *ssl;
1389 const uint8_t *client_hello;
1390 size_t client_hello_len;
1391 const uint8_t *session_id;
1392 size_t session_id_len;
1393 const uint8_t *cipher_suites;
1394 size_t cipher_suites_len;
1395 const uint8_t *compression_methods;
1396 size_t compression_methods_len;
1397 const uint8_t *extensions;
1398 size_t extensions_len;
1399};
Adam Langleydc9b1412014-06-20 12:00:00 -07001400
Adam Langleyb4a494c2015-01-23 15:10:10 -08001401/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
1402 * extension of the given type. If not found, it returns zero. Otherwise it
1403 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -07001404 * and length bytes), sets |out_len| to the length of the extension contents
1405 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001406OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
1407 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
1408 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -07001409
Adam Langley95c29f32014-06-20 12:00:00 -07001410typedef struct ssl_comp_st SSL_COMP;
1411
Adam Langleyb4a494c2015-01-23 15:10:10 -08001412struct ssl_comp_st {
1413 int id;
1414 const char *name;
1415 char *method;
1416};
Adam Langley95c29f32014-06-20 12:00:00 -07001417
1418DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -07001419DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -07001420
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001421OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001422
1423/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1424 * session cache. */
1425OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001426
Adam Langleyb4a494c2015-01-23 15:10:10 -08001427OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001428 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1429OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001430 SSL_SESSION *sess);
1431OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1432 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001433 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001434OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001435 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001436OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1437 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001438 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001439 int *copy));
1440OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001441 SSL *ssl, uint8_t *data, int len, int *copy);
David Benjamin3c1ccc02015-09-13 00:27:05 -04001442/* SSL_magic_pending_session_ptr returns a magic |SSL_SESSION|* which indicates
1443 * that the session isn't currently unavailable. |SSL_get_error| will then
1444 * return |SSL_ERROR_PENDING_SESSION| and the handshake can be retried later
1445 * when the lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001446OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001447OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1448 void (*cb)(const SSL *ssl,
1449 int type, int val));
1450OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1451 int type,
1452 int val);
1453OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1454 SSL_CTX *ctx,
1455 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1456OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1457 X509 **x509,
1458 EVP_PKEY **pkey);
1459OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1460 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1461OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1462 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001463
Adam Langleyb4a494c2015-01-23 15:10:10 -08001464/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1465 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001466 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001467OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1468
Adam Langleyb4a494c2015-01-23 15:10:10 -08001469/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1470 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001471OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1472
David Benjamin3b7456e2015-05-16 12:29:32 -04001473/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1474 * connection) to request a stapled OCSP response from the server. It returns
1475 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001476OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1477
1478/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1479 * created from |ctx|. */
1480OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1481
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001482/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1483 * |*out_len| bytes of SCT information from the server. This is only valid if
1484 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1485 * (including the two leading length bytes).
1486 * See https://tools.ietf.org/html/rfc6962#section-3.3
1487 * If no SCT was received then |*out_len| will be zero on return.
1488 *
1489 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001490OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001491 const uint8_t **out,
1492 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001493
David Benjamin6c7aed02014-08-27 16:42:38 -04001494/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1495 * bytes of an OCSP response from the server. This is the DER encoding of an
1496 * OCSPResponse type as defined in RFC 2560.
1497 *
1498 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001499OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1500 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001501
Adam Langleyb4a494c2015-01-23 15:10:10 -08001502OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1503 SSL_CTX *s,
1504 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1505 void *arg);
1506OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1507 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1508 const uint8_t *in, unsigned int inlen, void *arg),
1509 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001510OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001511 const uint8_t **data,
1512 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001513
Adam Langleyb4a494c2015-01-23 15:10:10 -08001514OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1515 const uint8_t *in, unsigned int inlen,
1516 const uint8_t *client,
1517 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001518
Adam Langleyb4a494c2015-01-23 15:10:10 -08001519#define OPENSSL_NPN_UNSUPPORTED 0
1520#define OPENSSL_NPN_NEGOTIATED 1
1521#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001522
David Benjamin9d0847a2015-02-16 03:57:55 -05001523/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1524 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1525 * length-prefixed strings). It returns zero on success and one on failure.
1526 *
1527 * WARNING: this function is dangerous because it breaks the usual return value
1528 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001529OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1530 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001531
1532/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1533 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1534 * length-prefixed strings). It returns zero on success and one on failure.
1535 *
1536 * WARNING: this function is dangerous because it breaks the usual return value
1537 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001538OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1539 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001540
Adam Langleyb4a494c2015-01-23 15:10:10 -08001541OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1542 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1543 const uint8_t *in, unsigned int inlen, void *arg),
1544 void *arg);
1545OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1546 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001547
David Benjaminb16346b2015-04-08 19:16:58 -04001548/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1549 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001550 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001551 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001552OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1553
Adam Langleyb4a494c2015-01-23 15:10:10 -08001554/* the maximum length of the buffer given to callbacks containing the resulting
1555 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001556#define PSK_MAX_IDENTITY_LEN 128
1557#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001558OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1559 SSL_CTX *ctx,
1560 unsigned int (*psk_client_callback)(
1561 SSL *ssl, const char *hint, char *identity,
1562 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1563OPENSSL_EXPORT void SSL_set_psk_client_callback(
1564 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1565 char *identity,
1566 unsigned int max_identity_len,
1567 uint8_t *psk,
1568 unsigned int max_psk_len));
1569OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1570 SSL_CTX *ctx,
1571 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1572 uint8_t *psk,
1573 unsigned int max_psk_len));
1574OPENSSL_EXPORT void SSL_set_psk_server_callback(
1575 SSL *ssl,
1576 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1577 uint8_t *psk,
1578 unsigned int max_psk_len));
1579OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1580 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001581OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1582OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1583OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001584
Adam Langleyb4a494c2015-01-23 15:10:10 -08001585#define SSL_NOTHING 1
1586#define SSL_WRITING 2
1587#define SSL_READING 3
1588#define SSL_X509_LOOKUP 4
1589#define SSL_CHANNEL_ID_LOOKUP 5
1590#define SSL_PENDING_SESSION 7
1591#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04001592#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07001593
1594/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001595#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1596#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1597#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1598#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1599#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1600#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1601#define SSL_want_certificate(s) \
1602 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04001603#define SSL_want_private_key_operation(s) \
1604 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07001605
Adam Langley95c29f32014-06-20 12:00:00 -07001606/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001607#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
1608#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
1609#define SSL_SESSION_set_app_data(s, a) \
1610 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
1611#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
1612#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
1613#define SSL_CTX_set_app_data(ctx, arg) \
1614 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07001615
Adam Langleyb4a494c2015-01-23 15:10:10 -08001616/* The following are the possible values for ssl->state are are used to
1617 * indicate where we are up to in the SSL connection establishment. The macros
1618 * that follow are about the only things you should need to use and even then,
1619 * only when using non-blocking IO. It can also be useful to work out where you
1620 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07001621
Adam Langleyb4a494c2015-01-23 15:10:10 -08001622#define SSL_ST_CONNECT 0x1000
1623#define SSL_ST_ACCEPT 0x2000
1624#define SSL_ST_MASK 0x0FFF
1625#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001626#define SSL_ST_OK 0x03
1627#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07001628
Adam Langleyb4a494c2015-01-23 15:10:10 -08001629#define SSL_CB_LOOP 0x01
1630#define SSL_CB_EXIT 0x02
1631#define SSL_CB_READ 0x04
1632#define SSL_CB_WRITE 0x08
1633#define SSL_CB_ALERT 0x4000 /* used in callback */
1634#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
1635#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
1636#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
1637#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
1638#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
1639#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
1640#define SSL_CB_HANDSHAKE_START 0x10
1641#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07001642
1643/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001644#define SSL_get_state(a) SSL_state(a)
1645#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05001646#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08001647#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
1648#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05001649
David Benjamined7c4752015-02-16 19:16:46 -05001650/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
1651 * is in False Start. |SSL_write| may be called at this point without waiting
1652 * for the peer, but |SSL_read| will require the handshake to be completed. */
1653OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
1654
Adam Langley95c29f32014-06-20 12:00:00 -07001655/* Obtain latest Finished message
1656 * -- that we sent (SSL_get_finished)
1657 * -- that we expected from peer (SSL_get_peer_finished).
1658 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001659OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
1660OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07001661
Adam Langley509e5ed2014-06-20 12:00:00 -07001662/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07001663 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001664#define SSL_VERIFY_NONE 0x00
1665#define SSL_VERIFY_PEER 0x01
1666#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
David Benjamin5aea93e2015-05-26 16:33:02 -04001667/* SSL_VERIFY_CLIENT_ONCE does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001668#define SSL_VERIFY_CLIENT_ONCE 0x04
1669#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07001670
Adam Langleyb4a494c2015-01-23 15:10:10 -08001671#define OpenSSL_add_ssl_algorithms() SSL_library_init()
1672#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07001673
Adam Langleyb4a494c2015-01-23 15:10:10 -08001674/* For backward compatibility */
1675#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1676#define SSL_get_cipher_bits(s, np) \
1677 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07001678#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08001679 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
1680#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
1681#define SSL_get_time(a) SSL_SESSION_get_time(a)
1682#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
1683#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
1684#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07001685
Adam Langleyb4a494c2015-01-23 15:10:10 -08001686#define d2i_SSL_SESSION_bio(bp, s_id) \
1687 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
1688#define i2d_SSL_SESSION_bio(bp, s_id) \
1689 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07001690
1691DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
1692
Adam Langleyb4a494c2015-01-23 15:10:10 -08001693/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
1694 * This value must be kept in sync with reservedReasonCode in make_errors.h */
1695#define SSL_AD_REASON_OFFSET \
1696 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07001697
1698/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001699#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
1700#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
1701#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
1702#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
1703#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
1704#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
1705#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
1706#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
1707#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
1708#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
1709#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
1710#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
1711#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
1712#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
1713#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
1714#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
1715#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
1716#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
1717#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
1718#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
1719#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
1720#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
1721#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
1722#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
1723#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07001724#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001725#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
1726#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
1727 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07001728#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08001729#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
1730#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07001731
David Benjamin377fc312015-01-26 00:22:12 -05001732/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04001733 * timeout in progress, it sets |*out| to the time remaining and returns one.
1734 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05001735 *
1736 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
1737 * retransmit behavior.
1738 *
1739 * NOTE: This function must be queried again whenever the handshake state
1740 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001741OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05001742
1743/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
1744 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
1745 * flight of handshake messages and returns 1. If too many timeouts had expired
1746 * without progress or an error occurs, it returns -1.
1747 *
1748 * NOTE: The caller's external timer should be compatible with the one |ssl|
1749 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04001750 * |DTLSv1_get_timeout| will return an updated timeout.
1751 *
1752 * WARNING: This function breaks the usual return value convention. */
1753OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001754
David Benjaminc0454692015-04-27 00:28:56 -04001755/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1756 * and zero otherwise.
1757 *
1758 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1759 * initial or renego, is in progress. */
1760OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001761
David Benjaminc0454692015-04-27 00:28:56 -04001762/* SSL_total_renegotiations returns the total number of renegotiation handshakes
1763 * peformed by |ssl|. This includes the pending renegotiation, if any. */
1764OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
1765
David Benjamin15a3b002015-04-28 00:05:35 -04001766/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1767 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1768 * one on success and zero on error. */
1769OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04001770
David Benjamin15a3b002015-04-28 00:05:35 -04001771/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1772 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1773 * on success and zero on error. */
1774OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07001775
David Benjamin15a3b002015-04-28 00:05:35 -04001776/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1777 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1778 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1779 * error. If unset, an appropriate curve will be chosen automatically. (This is
1780 * recommended.) */
1781OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04001782
David Benjamin15a3b002015-04-28 00:05:35 -04001783/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1784 * for ephemeral ECDH keys. For historical reasons, this API expects an
1785 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1786 * error. If unset, an appropriate curve will be chosen automatically. (This is
1787 * recommended.) */
1788OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07001789
David Benjaminc2807582015-04-28 00:19:50 -04001790/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
1791 * client IDs from clients, or configures a client to send TLS client IDs to
1792 * a server. It returns one. */
1793OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
1794
Adam Langleyb4a494c2015-01-23 15:10:10 -08001795/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
1796 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04001797 * server. It returns one. */
1798OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
1799
1800/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
1801 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
1802 * on success and zero on error. */
1803OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
1804 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001805
Adam Langley1258b6a2014-06-20 12:00:00 -07001806/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04001807 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
1808 * success and zero on error. */
1809OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001810
Adam Langley1258b6a2014-06-20 12:00:00 -07001811/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04001812 * and copies up to the first |max_out| bytes into |out|. The Channel ID
1813 * consists of the client's P-256 public key as an (x,y) pair where each is a
1814 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
1815 * Channel ID and the length of the complete Channel ID otherwise. */
1816OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
1817 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07001818
David Benjamin75910642015-08-09 10:42:33 -04001819/* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
1820 * containing the client certificate types requested by a server. It returns the
1821 * length of the array. */
1822OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
1823 const uint8_t **out_types);
1824
David Benjaminfdb4cdd2015-08-09 11:13:23 -04001825/* SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each
1826 * element of |curves| should be a curve nid. It returns one on success and
1827 * zero on failure. */
1828OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves,
1829 size_t curves_len);
1830
1831/* SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each
1832 * element of |curves| should be a curve nid. It returns one on success and
1833 * zero on failure. */
1834OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves,
1835 size_t curves_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001836
Adam Langleyb4a494c2015-01-23 15:10:10 -08001837OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
Adam Langleycef75832015-09-03 14:51:12 -07001838OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls10(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001839OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001840OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001841OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1842OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001843OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001844OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001845
Adam Langleyb4a494c2015-01-23 15:10:10 -08001846OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07001847
David Benjamina07c0fc2015-05-13 13:19:42 -04001848/* SSL_get_current_cipher returns the cipher used in the current outgoing
1849 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001850OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001851
Adam Langleyb4a494c2015-01-23 15:10:10 -08001852OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
1853OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
1854OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
1855OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001856OPENSSL_EXPORT int SSL_pending(const SSL *s);
1857OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
1858OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
1859OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001860OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001861OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
1862OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
1863OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
1864 X509_STORE_CTX *);
1865OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
1866 int (*callback)(int ok,
1867 X509_STORE_CTX *ctx));
1868OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001869OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001870OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1871 stackCAs,
1872 const char *file);
1873OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
1874 stackCAs,
1875 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07001876
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001877OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001878OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02001879
Adam Langleyb4a494c2015-01-23 15:10:10 -08001880OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
1881OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05001882
Adam Langleyb4a494c2015-01-23 15:10:10 -08001883OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
1884OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
1885OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
1886OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
1887OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
1888OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
1889 const uint8_t *id,
1890 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04001891
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001892OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1893OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001894OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
1895 int, X509_STORE_CTX *);
1896OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
1897 int (*callback)(int, X509_STORE_CTX *));
1898OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1899OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
1900 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07001901
Adam Langleyb4a494c2015-01-23 15:10:10 -08001902OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
1903 pem_password_cb *cb);
1904OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
1905 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07001906
Adam Langleyb4a494c2015-01-23 15:10:10 -08001907OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
1908 const uint8_t *sid_ctx,
1909 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001910
Adam Langleyb4a494c2015-01-23 15:10:10 -08001911OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
1912 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001913
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001914OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
1915OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
1916OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
1917OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07001918
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001919OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
1920OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07001921
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001922OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
1923OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001924
Adam Langley0f4746e2014-08-13 12:26:32 -07001925/* SSL_get_version returns a string describing the TLS version used by |s|. For
1926 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001927OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001928
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02001929/* SSL_get_curve_name returns a human-readable name for the elliptic curve
1930 * specified by the given TLS curve id, or NULL if the curve if unknown. */
1931OPENSSL_EXPORT const char* SSL_get_curve_name(uint16_t curve_id);
1932
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001933OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001934
David Benjamin44d3eed2015-05-21 01:29:55 -04001935/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
1936 * renegotiation. */
1937OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
1938
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001939OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
1940OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
1941OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
1942OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07001943
Adam Langleyb4a494c2015-01-23 15:10:10 -08001944OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
1945 STACK_OF(X509_NAME) *name_list);
1946OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
1947 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001948OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001949OPENSSL_EXPORT STACK_OF(X509_NAME) *
1950 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
1951OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
1952OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07001953
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001954OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001955
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001956OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07001957
Adam Langleyb4a494c2015-01-23 15:10:10 -08001958OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001959OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001960OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001961OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001962OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001963OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
1964OPENSSL_EXPORT int SSL_version(const SSL *ssl);
1965OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001966OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
1967 const char *CAfile,
1968 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07001969#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001970OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001971OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
1972 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001973OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001974OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001975OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001976 void (*cb)(const SSL *ssl, int type,
1977 int val));
1978OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
1979 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001980OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001981
Adam Langleyb4a494c2015-01-23 15:10:10 -08001982OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001983OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001984
Adam Langleyb4a494c2015-01-23 15:10:10 -08001985OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07001986
David Benjamin71f7d3d2015-05-05 09:46:38 -04001987/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
1988 * |size|. It returns the previous value. */
1989OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
1990 unsigned long size);
1991
David Benjamin3b7456e2015-05-16 12:29:32 -04001992/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04001993 * cache. */
1994OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
1995
1996/* SSL_SESS_CACHE_* are the possible session cache mode bits.
1997 * TODO(davidben): Document. */
1998#define SSL_SESS_CACHE_OFF 0x0000
1999#define SSL_SESS_CACHE_CLIENT 0x0001
2000#define SSL_SESS_CACHE_SERVER 0x0002
2001#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2002#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2003#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2004#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2005#define SSL_SESS_CACHE_NO_INTERNAL \
2006 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2007
2008/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2009 * |mode|. It returns the previous value. */
2010OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2011
2012/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2013 * |ctx| */
2014OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002015
David Benjamin1d0a1942015-04-26 15:35:35 -04002016/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2017 * certificate chain accepted by |ctx|. */
2018OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2019
2020/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2021 * certificate chain to |max_cert_list|. This affects how much memory may be
2022 * consumed during the handshake. */
2023OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2024 size_t max_cert_list);
2025
2026/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2027 * certificate chain accepted by |ssl|. */
2028OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2029
2030/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2031 * certificate chain to |max_cert_list|. This affects how much memory may be
2032 * consumed during the handshake. */
2033OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2034
2035/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2036 * sent by |ctx|. Beyond this length, handshake messages and application data
2037 * will be split into multiple records. */
2038OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2039 size_t max_send_fragment);
2040
2041/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2042 * sent by |ssl|. Beyond this length, handshake messages and application data
2043 * will be split into multiple records. */
2044OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2045 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002046
David Benjamin59015c32015-04-26 13:13:55 -04002047/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2048 * the group for DHE ciphers. |callback| should ignore |is_export| and
2049 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2050 * the parameters are used, so the |DH| needn't have a generated keypair.
2051 *
2052 * WARNING: The caller does not take ownership of the resulting |DH|, so
2053 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002054OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002055 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2056
2057/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2058 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2059 * and return a |DH| of the selected group or NULL on error. Only the
2060 * parameters are used, so the |DH| needn't have a generated keypair.
2061 *
2062 * WARNING: The caller does not take ownership of the resulting |DH|, so
2063 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002064OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002065 DH *(*dh)(SSL *ssl, int is_export,
2066 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002067
2068/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2069 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2070 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2071 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2072 * keypair.
2073 *
2074 * If the callback is unset, an appropriate curve will be chosen automatically.
2075 * (This is recommended.)
2076 *
2077 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2078 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002079OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002080 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2081
2082/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2083 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2084 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2085 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2086 * keypair.
2087 *
2088 * If the callback is unset, an appropriate curve will be chosen automatically.
2089 * (This is recommended.)
2090 *
2091 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2092 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002093OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002094 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002095
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002096typedef void COMP_METHOD;
2097
2098/* SSL_get_current_compression returns NULL. */
2099OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
2100
2101/* SSL_get_current_expansion returns NULL. */
2102OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002103
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002104OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2105OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002106
Adam Langley524e7172015-02-20 16:04:00 -08002107/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2108 * resumption decision for a ClientHello has been made. It can return 1 to
2109 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002110OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002111 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2112
Adam Langley95f22882014-06-20 12:00:00 -07002113/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2114 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2115 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002116OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2117 size_t *ssl_ctx_size,
2118 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002119
Adam Langley3f92d212015-02-20 15:32:52 -08002120/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2121 * the read and write directions. It returns one on success or zero if |ssl|
2122 * isn't using an RC4-based cipher suite. */
2123OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2124 const RC4_KEY **write_key);
2125
Adam Langley95c29f32014-06-20 12:00:00 -07002126
David Benjamin71f07942015-04-08 02:36:59 -04002127/* Deprecated functions. */
2128
2129/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2130 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2131 * freed with |OPENSSL_free|, or NULL on error.
2132 *
2133 * The description includes a trailing newline and has the form:
2134 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2135 *
2136 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2137OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2138 char *buf, int len);
2139
2140/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2141OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2142
2143/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002144OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002145
2146/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002147OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002148
2149/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002150OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002151
David Benjamin0d8a7582015-04-08 23:55:15 -04002152/* SSLv23_method calls |TLS_method|. */
2153OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2154
2155/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2156 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2157 * to lock connections to that protocol version. */
2158OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2159OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2160OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2161OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2162OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2163OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2164
2165/* Client- and server-specific methods call their corresponding generic
2166 * methods. */
2167OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2168OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2169OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2170OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2171OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2172OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2173OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2174OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2175OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2176OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2177OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2178OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2179OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2180OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2181OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2182OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2183
David Benjamin4831c332015-05-16 11:43:13 -04002184/* SSL_clear resets |ssl| to allow another connection and returns one on success
2185 * or zero on failure. It returns most configuration state but releases memory
2186 * associated with the current connection.
2187 *
2188 * Free |ssl| and create a new one instead. */
2189OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2190
David Benjamin59015c32015-04-26 13:13:55 -04002191/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2192OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2193 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002194
David Benjamin59015c32015-04-26 13:13:55 -04002195/* SSL_set_tmp_rsa_callback does nothing. */
2196OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2197 RSA *(*cb)(SSL *ssl, int is_export,
2198 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002199
David Benjaminda881e92015-04-26 14:45:04 -04002200/* SSL_CTX_sess_connect returns zero. */
2201OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2202
2203/* SSL_CTX_sess_connect_good returns zero. */
2204OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2205
2206/* SSL_CTX_sess_connect_renegotiate returns zero. */
2207OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2208
2209/* SSL_CTX_sess_accept returns zero. */
2210OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2211
2212/* SSL_CTX_sess_accept_renegotiate returns zero. */
2213OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2214
2215/* SSL_CTX_sess_accept_good returns zero. */
2216OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2217
2218/* SSL_CTX_sess_hits returns zero. */
2219OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2220
2221/* SSL_CTX_sess_cb_hits returns zero. */
2222OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2223
2224/* SSL_CTX_sess_misses returns zero. */
2225OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2226
2227/* SSL_CTX_sess_timeouts returns zero. */
2228OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2229
2230/* SSL_CTX_sess_cache_full returns zero. */
2231OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2232
David Benjamin101ead22015-04-26 18:36:23 -04002233/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2234OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2235
David Benjaminc0454692015-04-27 00:28:56 -04002236/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2237OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2238
2239/* SSL_CTX_need_tmp_RSA returns zero. */
2240OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2241
2242/* SSL_need_tmp_RSA returns zero. */
2243OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2244
2245/* SSL_CTX_set_tmp_rsa returns one. */
2246OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2247
2248/* SSL_set_tmp_rsa returns one. */
2249OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2250
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002251/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002252OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2253
2254/* SSL_CTX_set_read_ahead does nothing. */
2255OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2256
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002257/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002258OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2259
2260/* SSL_set_read_ahead does nothing. */
2261OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2262
David Benjamin44d3eed2015-05-21 01:29:55 -04002263/* SSL_renegotiate put an error on the error queue and returns zero. */
2264OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2265
David Benjaminece089c2015-05-15 23:52:42 -04002266/* SSL_set_state does nothing. */
2267OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2268
David Benjamin7e40d4e2015-09-07 13:17:45 -04002269/* SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START. */
2270#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
2271
2272/* i2d_SSL_SESSION serializes |in| to the bytes pointed to by |*pp|. On success,
2273 * it returns the number of bytes written and advances |*pp| by that many bytes.
2274 * On failure, it returns -1. If |pp| is NULL, no bytes are written and only the
2275 * length is returned.
2276 *
2277 * Use |SSL_SESSION_to_bytes| instead. */
2278OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2279
2280/* d2i_SSL_SESSION parses a serialized session from the |length| bytes pointed
2281 * to by |*pp|. It returns the new |SSL_SESSION| and advances |*pp| by the
2282 * number of bytes consumed on success and NULL on failure. The caller takes
2283 * ownership of the new session and must call |SSL_SESSION_free| when done.
2284 *
2285 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
2286 *
2287 * Use |SSL_SESSION_from_bytes| instead. */
2288OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2289 long length);
2290
David Benjamin27bbae42015-09-13 00:54:37 -04002291/* ERR_load_SSL_strings does nothing. */
2292OPENSSL_EXPORT void ERR_load_SSL_strings(void);
2293
2294/* SSL_load_error_strings does nothing. */
2295OPENSSL_EXPORT void SSL_load_error_strings(void);
2296
David Benjamin71f07942015-04-08 02:36:59 -04002297
David Benjamin79c117a2015-09-13 13:53:19 -04002298/* Private structures.
2299 *
2300 * This structures are exposed for historical reasons, but access to them is
2301 * deprecated. */
2302
2303struct ssl_cipher_st {
2304 /* name is the OpenSSL name for the cipher. */
2305 const char *name;
2306 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
2307 uint32_t id;
2308
2309 /* The following are internal fields. See ssl/internal.h for their values. */
2310
2311 uint32_t algorithm_mkey;
2312 uint32_t algorithm_auth;
2313 uint32_t algorithm_enc;
2314 uint32_t algorithm_mac;
2315 uint32_t algorithm_ssl;
2316 uint32_t algo_strength;
2317 uint32_t algorithm_prf;
2318
2319 /* strength_bits is the strength of the cipher in bits. */
2320 int strength_bits;
2321 /* alg_bits is the number of bits of key material used by the algorithm. */
2322 int alg_bits;
2323};
2324
2325struct ssl_session_st {
2326 int ssl_version; /* what ssl version session info is being kept in here? */
2327
2328 int master_key_length;
2329 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
2330 /* session_id - valid? */
2331 unsigned int session_id_length;
2332 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
2333 /* this is used to determine whether the session is being reused in
2334 * the appropriate context. It is up to the application to set this,
2335 * via SSL_new */
2336 unsigned int sid_ctx_length;
2337 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
2338
2339 char *psk_identity;
2340 /* Used to indicate that session resumption is not allowed. Applications can
2341 * also set this bit for a new session via not_resumable_session_cb to
2342 * disable session caching and tickets. */
2343 int not_resumable;
2344
2345 /* peer is the peer's certificate. */
2346 X509 *peer;
2347
2348 /* cert_chain is the certificate chain sent by the peer. NOTE: for historical
2349 * reasons, when a client (so the peer is a server), the chain includes
2350 * |peer|, but when a server it does not. */
2351 STACK_OF(X509) *cert_chain;
2352
2353 /* when app_verify_callback accepts a session where the peer's certificate is
2354 * not ok, we must remember the error for session reuse: */
2355 long verify_result; /* only for servers */
2356
2357 CRYPTO_refcount_t references;
2358 long timeout;
2359 long time;
2360
2361 const SSL_CIPHER *cipher;
2362
2363 /* key_exchange_info contains an indication of the size of the asymmetric
2364 * primitive used in the handshake that created this session. In the event
2365 * that two asymmetric operations are used, this value applies to the one
2366 * that controls the confidentiality of the connection. Its interpretation
2367 * depends on the primitive that was used; as specified by the cipher suite:
2368 * DHE: the size, in bits, of the multiplicative group.
2369 * RSA: the size, in bits, of the modulus.
2370 * ECDHE: the TLS id for the curve.
2371 *
2372 * A zero indicates that the value is unknown. */
2373 uint32_t key_exchange_info;
2374
2375 CRYPTO_EX_DATA ex_data; /* application specific data */
2376
2377 /* These are used to make removal of session-ids more efficient and to
2378 * implement a maximum cache size. */
2379 SSL_SESSION *prev, *next;
2380 char *tlsext_hostname;
2381 /* RFC4507 info */
2382 uint8_t *tlsext_tick; /* Session ticket */
2383 size_t tlsext_ticklen; /* Session ticket length */
2384 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
2385
2386 size_t tlsext_signed_cert_timestamp_list_length;
2387 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
2388
2389 /* The OCSP response that came with the session. */
2390 size_t ocsp_response_length;
2391 uint8_t *ocsp_response;
2392
2393 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
2394 uint8_t
2395 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
2396
2397 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
2398 * SHA-2, depending on TLS version) for the original, full handshake that
2399 * created a session. This is used by Channel IDs during resumption. */
2400 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
2401 unsigned int original_handshake_hash_len;
2402
2403 /* extended_master_secret is true if the master secret in this session was
2404 * generated using EMS and thus isn't vulnerable to the Triple Handshake
2405 * attack. */
2406 char extended_master_secret;
2407};
2408
2409/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
2410 * equal-preference groups. For TLS clients, the groups are moot because the
2411 * server picks the cipher and groups cannot be expressed on the wire. However,
2412 * for servers, the equal-preference groups allow the client's preferences to
2413 * be partially respected. (This only has an effect with
2414 * SSL_OP_CIPHER_SERVER_PREFERENCE).
2415 *
2416 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
2417 * All elements of a group have the same priority: no ordering is expressed
2418 * within a group.
2419 *
2420 * The values in |ciphers| are in one-to-one correspondence with
2421 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
2422 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
2423 * indicate that the corresponding SSL_CIPHER is not the last element of a
2424 * group, or 0 to indicate that it is.
2425 *
2426 * For example, if |in_group_flags| contains all zeros then that indicates a
2427 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
2428 * of the group (i.e. they are all in a one-element group).
2429 *
2430 * For a more complex example, consider:
2431 * ciphers: A B C D E F
2432 * in_group_flags: 1 1 0 0 1 0
2433 *
2434 * That would express the following, order:
2435 *
2436 * A E
2437 * B -> D -> F
2438 * C
2439 */
2440struct ssl_cipher_preference_list_st {
2441 STACK_OF(SSL_CIPHER) *ciphers;
2442 uint8_t *in_group_flags;
2443};
2444
2445struct ssl_ctx_st {
2446 const SSL_PROTOCOL_METHOD *method;
2447
2448 /* lock is used to protect various operations on this object. */
2449 CRYPTO_MUTEX lock;
2450
2451 /* max_version is the maximum acceptable protocol version. If zero, the
2452 * maximum supported version, currently (D)TLS 1.2, is used. */
2453 uint16_t max_version;
2454
2455 /* min_version is the minimum acceptable protocl version. If zero, the
2456 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
2457 uint16_t min_version;
2458
2459 struct ssl_cipher_preference_list_st *cipher_list;
2460 /* same as above but sorted for lookup */
2461 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
2462
2463 /* cipher_list_tls10 is the list of ciphers when TLS 1.0 or greater is in
2464 * use. This only applies to server connections as, for clients, the version
2465 * number is known at connect time and so the cipher list can be set then. If
2466 * |cipher_list_tls11| is non-NULL then this applies only to TLS 1.0
2467 * connections.
2468 *
2469 * TODO(agl): this exists to assist in the death of SSLv3. It can hopefully
2470 * be removed after that. */
2471 struct ssl_cipher_preference_list_st *cipher_list_tls10;
2472
2473 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
2474 * use. This only applies to server connections as, for clients, the version
2475 * number is known at connect time and so the cipher list can be set then. */
2476 struct ssl_cipher_preference_list_st *cipher_list_tls11;
2477
2478 X509_STORE *cert_store;
2479 LHASH_OF(SSL_SESSION) *sessions;
2480 /* Most session-ids that will be cached, default is
2481 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
2482 unsigned long session_cache_size;
2483 SSL_SESSION *session_cache_head;
2484 SSL_SESSION *session_cache_tail;
2485
2486 /* handshakes_since_cache_flush is the number of successful handshakes since
2487 * the last cache flush. */
2488 int handshakes_since_cache_flush;
2489
2490 /* This can have one of 2 values, ored together,
2491 * SSL_SESS_CACHE_CLIENT,
2492 * SSL_SESS_CACHE_SERVER,
2493 * Default is SSL_SESSION_CACHE_SERVER, which means only
2494 * SSL_accept which cache SSL_SESSIONS. */
2495 int session_cache_mode;
2496
2497 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
2498 * called. This has been put in to make life easier to set things up */
2499 long session_timeout;
2500
2501 /* If this callback is not null, it will be called each time a session id is
2502 * added to the cache. If this function returns 1, it means that the
2503 * callback will do a SSL_SESSION_free() when it has finished using it.
2504 * Otherwise, on 0, it means the callback has finished with it. If
2505 * remove_session_cb is not null, it will be called when a session-id is
2506 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
2507 * it. */
2508 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
2509 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
2510 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
2511 int *copy);
2512
2513 CRYPTO_refcount_t references;
2514
2515 /* if defined, these override the X509_verify_cert() calls */
2516 int (*app_verify_callback)(X509_STORE_CTX *, void *);
2517 void *app_verify_arg;
2518 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
2519 * was called with just one argument) */
2520
2521 /* Default password callback. */
2522 pem_password_cb *default_passwd_callback;
2523
2524 /* Default password callback user data. */
2525 void *default_passwd_callback_userdata;
2526
2527 /* get client cert callback */
2528 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
2529
2530 /* get channel id callback */
2531 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
2532
2533 CRYPTO_EX_DATA ex_data;
2534
2535 /* custom_*_extensions stores any callback sets for custom extensions. Note
2536 * that these pointers will be NULL if the stack would otherwise be empty. */
2537 STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
2538 STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
2539
2540 /* Default values used when no per-SSL value is defined follow */
2541
2542 void (*info_callback)(const SSL *ssl, int type,
2543 int val); /* used if SSL's info_callback is NULL */
2544
2545 /* what we put in client cert requests */
2546 STACK_OF(X509_NAME) *client_CA;
2547
2548
2549 /* Default values to use in SSL structures follow (these are copied by
2550 * SSL_new) */
2551
2552 uint32_t options;
2553 uint32_t mode;
2554 uint32_t max_cert_list;
2555
2556 struct cert_st /* CERT */ *cert;
2557
2558 /* callback that allows applications to peek at protocol messages */
2559 void (*msg_callback)(int write_p, int version, int content_type,
2560 const void *buf, size_t len, SSL *ssl, void *arg);
2561 void *msg_callback_arg;
2562
2563 int verify_mode;
2564 unsigned int sid_ctx_length;
2565 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
2566 int (*default_verify_callback)(
2567 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
2568
2569 /* Default generate session ID callback. */
2570 GEN_SESSION_CB generate_session_id;
2571
2572 X509_VERIFY_PARAM *param;
2573
2574 /* select_certificate_cb is called before most ClientHello processing and
2575 * before the decision whether to resume a session is made. It may return one
2576 * to continue the handshake or zero to cause the handshake loop to return
2577 * with an error and cause SSL_get_error to return
2578 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
2579 * will not call the callback a second time. */
2580 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
2581
2582 /* dos_protection_cb is called once the resumption decision for a ClientHello
2583 * has been made. It returns one to continue the handshake or zero to
2584 * abort. */
2585 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
2586
2587 /* quiet_shutdown is true if the connection should not send a close_notify on
2588 * shutdown. */
2589 int quiet_shutdown;
2590
2591 /* Maximum amount of data to send in one fragment. actual record size can be
2592 * more than this due to padding and MAC overheads. */
2593 uint16_t max_send_fragment;
2594
2595 /* TLS extensions servername callback */
2596 int (*tlsext_servername_callback)(SSL *, int *, void *);
2597 void *tlsext_servername_arg;
2598 /* RFC 4507 session ticket keys */
2599 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
2600 uint8_t tlsext_tick_hmac_key[16];
2601 uint8_t tlsext_tick_aes_key[16];
2602 /* Callback to support customisation of ticket key setting */
2603 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
2604 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
2605
2606 /* Server-only: psk_identity_hint is the default identity hint to send in
2607 * PSK-based key exchanges. */
2608 char *psk_identity_hint;
2609
2610 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
2611 char *identity,
2612 unsigned int max_identity_len,
2613 uint8_t *psk, unsigned int max_psk_len);
2614 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
2615 uint8_t *psk, unsigned int max_psk_len);
2616
2617
2618 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
2619 * hash of the peer's certifiate and then discard it to save memory and
2620 * session space. Only effective on the server side. */
2621 char retain_only_sha256_of_client_certs;
2622
2623 /* Next protocol negotiation information */
2624 /* (for experimental NPN extension). */
2625
2626 /* For a server, this contains a callback function by which the set of
2627 * advertised protocols can be provided. */
2628 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
2629 unsigned int *len, void *arg);
2630 void *next_protos_advertised_cb_arg;
2631 /* For a client, this contains a callback function that selects the
2632 * next protocol from the list provided by the server. */
2633 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
2634 const uint8_t *in, unsigned int inlen, void *arg);
2635 void *next_proto_select_cb_arg;
2636
2637 /* ALPN information
2638 * (we are in the process of transitioning from NPN to ALPN.) */
2639
2640 /* For a server, this contains a callback function that allows the
2641 * server to select the protocol for the connection.
2642 * out: on successful return, this must point to the raw protocol
2643 * name (without the length prefix).
2644 * outlen: on successful return, this contains the length of |*out|.
2645 * in: points to the client's list of supported protocols in
2646 * wire-format.
2647 * inlen: the length of |in|. */
2648 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
2649 const uint8_t *in, unsigned int inlen, void *arg);
2650 void *alpn_select_cb_arg;
2651
2652 /* For a client, this contains the list of supported protocols in wire
2653 * format. */
2654 uint8_t *alpn_client_proto_list;
2655 unsigned alpn_client_proto_list_len;
2656
2657 /* SRTP profiles we are willing to do from RFC 5764 */
2658 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
2659
2660 /* EC extension values inherited by SSL structure */
2661 size_t tlsext_ellipticcurvelist_length;
2662 uint16_t *tlsext_ellipticcurvelist;
2663
2664 /* If true, a client will advertise the Channel ID extension and a server
2665 * will echo it. */
2666 char tlsext_channel_id_enabled;
2667 /* The client's Channel ID private key. */
2668 EVP_PKEY *tlsext_channel_id_private;
2669
2670 /* If true, a client will request certificate timestamps. */
2671 char signed_cert_timestamps_enabled;
2672
2673 /* Signed certificate timestamp list to be sent to the client, if requested */
2674 uint8_t *signed_cert_timestamp_list;
2675 size_t signed_cert_timestamp_list_length;
2676
2677 /* If true, a client will request a stapled OCSP response. */
2678 char ocsp_stapling_enabled;
2679
2680 /* OCSP response to be sent to the client, if requested. */
2681 uint8_t *ocsp_response;
2682 size_t ocsp_response_length;
2683
2684 /* If not NULL, session key material will be logged to this BIO for debugging
2685 * purposes. The format matches NSS's and is readable by Wireshark. */
2686 BIO *keylog_bio;
2687
2688 /* current_time_cb, if not NULL, is the function to use to get the current
2689 * time. It sets |*out_clock| to the current time. */
2690 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
2691};
2692
2693struct ssl_st {
2694 /* version is the protocol version. */
2695 int version;
2696
2697 /* method is the method table corresponding to the current protocol (DTLS or
2698 * TLS). */
2699 const SSL_PROTOCOL_METHOD *method;
2700
2701 /* enc_method is the method table corresponding to the current protocol
2702 * version. */
2703 const SSL3_ENC_METHOD *enc_method;
2704
2705 /* max_version is the maximum acceptable protocol version. If zero, the
2706 * maximum supported version, currently (D)TLS 1.2, is used. */
2707 uint16_t max_version;
2708
2709 /* min_version is the minimum acceptable protocl version. If zero, the
2710 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
2711 uint16_t min_version;
2712
2713 /* There are 2 BIO's even though they are normally both the same. This is so
2714 * data can be read and written to different handlers */
2715
2716 BIO *rbio; /* used by SSL_read */
2717 BIO *wbio; /* used by SSL_write */
2718 BIO *bbio; /* used during session-id reuse to concatenate
2719 * messages */
2720
2721 /* This holds a variable that indicates what we were doing when a 0 or -1 is
2722 * returned. This is needed for non-blocking IO so we know what request
2723 * needs re-doing when in SSL_accept or SSL_connect */
2724 int rwstate;
2725
2726 /* true when we are actually in SSL_accept() or SSL_connect() */
2727 int in_handshake;
2728 int (*handshake_func)(SSL *);
2729
2730 /* Imagine that here's a boolean member "init" that is switched as soon as
2731 * SSL_set_{accept/connect}_state is called for the first time, so that
2732 * "state" and "handshake_func" are properly initialized. But as
2733 * handshake_func is == 0 until then, we use this test instead of an "init"
2734 * member. */
2735
2736 /* server is true iff the this SSL* is the server half. Note: before the SSL*
2737 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
2738 * the side is not determined. In this state, server is always false. */
2739 int server;
2740
2741 /* quiet_shutdown is true if the connection should not send a close_notify on
2742 * shutdown. */
2743 int quiet_shutdown;
2744
2745 int shutdown; /* we have shut things down, 0x01 sent, 0x02
2746 * for received */
2747 int state; /* where we are */
2748
2749 BUF_MEM *init_buf; /* buffer used during init */
2750 uint8_t *init_msg; /* pointer to handshake message body, set by
2751 ssl3_get_message() */
2752 int init_num; /* amount read/written */
2753 int init_off; /* amount read/written */
2754
2755 struct ssl3_state_st *s3; /* SSLv3 variables */
2756 struct dtls1_state_st *d1; /* DTLSv1 variables */
2757
2758 /* callback that allows applications to peek at protocol messages */
2759 void (*msg_callback)(int write_p, int version, int content_type,
2760 const void *buf, size_t len, SSL *ssl, void *arg);
2761 void *msg_callback_arg;
2762
2763 int hit; /* reusing a previous session */
2764
2765 X509_VERIFY_PARAM *param;
2766
2767 /* crypto */
2768 struct ssl_cipher_preference_list_st *cipher_list;
2769 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
2770
2771 SSL_AEAD_CTX *aead_read_ctx;
2772 SSL_AEAD_CTX *aead_write_ctx;
2773
2774 /* session info */
2775
2776 /* client cert? */
2777 /* This is used to hold the server certificate used */
2778 struct cert_st /* CERT */ *cert;
2779
2780 /* the session_id_context is used to ensure sessions are only reused
2781 * in the appropriate context */
2782 unsigned int sid_ctx_length;
2783 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
2784
2785 /* This can also be in the session once a session is established */
2786 SSL_SESSION *session;
2787
2788 /* Default generate session ID callback. */
2789 GEN_SESSION_CB generate_session_id;
2790
2791 /* Used in SSL2 and SSL3 */
2792 int verify_mode; /* 0 don't care about verify failure.
2793 * 1 fail if verify fails */
2794 int (*verify_callback)(int ok,
2795 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
2796
2797 void (*info_callback)(const SSL *ssl, int type,
2798 int val); /* optional informational callback */
2799
2800 /* Server-only: psk_identity_hint is the identity hint to send in
2801 * PSK-based key exchanges. */
2802 char *psk_identity_hint;
2803
2804 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
2805 char *identity,
2806 unsigned int max_identity_len,
2807 uint8_t *psk, unsigned int max_psk_len);
2808 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
2809 uint8_t *psk, unsigned int max_psk_len);
2810
2811 SSL_CTX *ctx;
2812
2813 /* extra application data */
2814 long verify_result;
2815 CRYPTO_EX_DATA ex_data;
2816
2817 /* for server side, keep the list of CA_dn we can use */
2818 STACK_OF(X509_NAME) *client_CA;
2819
2820 uint32_t options; /* protocol behaviour */
2821 uint32_t mode; /* API behaviour */
2822 uint32_t max_cert_list;
2823 int client_version; /* what was passed, used for
2824 * SSLv3/TLS rollback check */
2825 uint16_t max_send_fragment;
2826 char *tlsext_hostname;
2827 /* RFC4507 session ticket expected to be received or sent */
2828 int tlsext_ticket_expected;
2829 size_t tlsext_ellipticcurvelist_length;
2830 uint16_t *tlsext_ellipticcurvelist; /* our list */
2831
2832 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
2833
2834 /* Next protocol negotiation. For the client, this is the protocol that we
2835 * sent in NextProtocol and is set when handling ServerHello extensions.
2836 *
2837 * For a server, this is the client's selected_protocol from NextProtocol and
2838 * is set when handling the NextProtocol message, before the Finished
2839 * message. */
2840 uint8_t *next_proto_negotiated;
2841 size_t next_proto_negotiated_len;
2842
2843 /* srtp_profiles is the list of configured SRTP protection profiles for
2844 * DTLS-SRTP. */
2845 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
2846
2847 /* srtp_profile is the selected SRTP protection profile for
2848 * DTLS-SRTP. */
2849 const SRTP_PROTECTION_PROFILE *srtp_profile;
2850
2851 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
2852 * from clients. For a client, means that we'll advertise support. */
2853 char tlsext_channel_id_enabled;
2854 /* The client's Channel ID private key. */
2855 EVP_PKEY *tlsext_channel_id_private;
2856
2857 /* Enable signed certificate time stamps. Currently client only. */
2858 char signed_cert_timestamps_enabled;
2859
2860 /* ocsp_stapling_enabled is only used by client connections and indicates
2861 * whether OCSP stapling will be requested. */
2862 char ocsp_stapling_enabled;
2863
2864 /* For a client, this contains the list of supported protocols in wire
2865 * format. */
2866 uint8_t *alpn_client_proto_list;
2867 unsigned alpn_client_proto_list_len;
2868
2869 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
2870 * peer. Otherwise, they will be rejected with a fatal error. */
2871 char accept_peer_renegotiations;
2872
2873 /* These fields are always NULL and exist only to keep wpa_supplicant happy
2874 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
2875 * don't support. */
2876 EVP_CIPHER_CTX *enc_read_ctx;
2877 EVP_MD_CTX *read_hash;
2878};
2879
2880
Adam Langley7cc3f992015-01-07 15:06:31 -08002881/* Android compatibility section.
2882 *
2883 * These functions are declared, temporarily, for Android because
2884 * wpa_supplicant will take a little time to sync with upstream. Outside of
2885 * Android they'll have no definition. */
2886
2887#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2888
Adam Langleyb4a494c2015-01-23 15:10:10 -08002889OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2890 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002891OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2892OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002893OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2894
2895#define OPENSSL_VERSION_TEXT "BoringSSL"
2896
2897#define SSLEAY_VERSION 0
2898
2899/* SSLeay_version is a compatibility function that returns the string
2900 * "BoringSSL". */
2901OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002902
2903
David Benjamin59015c32015-04-26 13:13:55 -04002904/* Preprocessor compatibility section.
2905 *
2906 * Historically, a number of APIs were implemented in OpenSSL as macros and
2907 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04002908 * section defines a number of legacy macros.
2909 *
2910 * Although using either the CTRL values or their wrapper macros in #ifdefs is
2911 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
2912 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04002913
David Benjamincb3872f2015-06-16 13:20:36 -04002914#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2915#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002916#define SSL_CTRL_CHAIN doesnt_exist
2917#define SSL_CTRL_CHAIN_CERT doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002918#define SSL_CTRL_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002919#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002920#define SSL_CTRL_CLEAR_MODE doesnt_exist
2921#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002922#define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
2923#define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002924#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
David Benjamin75910642015-08-09 10:42:33 -04002925#define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002926#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002927#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002928#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002929#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2930#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
2931#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2932#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
2933#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002934#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002935#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002936#define SSL_CTRL_MODE doesnt_exist
2937#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2938#define SSL_CTRL_OPTIONS doesnt_exist
2939#define SSL_CTRL_SESS_NUMBER doesnt_exist
2940#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
David Benjaminfdb4cdd2015-08-09 11:13:23 -04002941#define SSL_CTRL_SET_CURVES doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002942#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2943#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002944#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002945#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002946#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002947#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002948#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002949#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002950#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002951#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2952#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002953#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002954#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002955#define SSL_CTRL_SET_TMP_DH doesnt_exist
2956#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2957#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
2958#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
2959#define SSL_CTRL_SET_TMP_RSA doesnt_exist
2960#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002961
David Benjamin8c249802015-05-05 09:44:18 -04002962#define DTLSv1_get_timeout DTLSv1_get_timeout
2963#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamin11c0f8e2015-07-06 00:18:15 -04002964#define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
2965#define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
2966#define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
2967#define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
2968#define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002969#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2970#define SSL_CTX_clear_options SSL_CTX_clear_options
2971#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04002972#define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
2973#define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002974#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2975#define SSL_CTX_get_mode SSL_CTX_get_mode
2976#define SSL_CTX_get_options SSL_CTX_get_options
2977#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2978#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04002979#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002980#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2981#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2982#define SSL_CTX_sess_number SSL_CTX_sess_number
2983#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
David Benjamin11c0f8e2015-07-06 00:18:15 -04002984#define SSL_CTX_set0_chain SSL_CTX_set0_chain
2985#define SSL_CTX_set1_chain SSL_CTX_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04002986#define SSL_CTX_set1_curves SSL_CTX_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04002987#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2988#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2989#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2990#define SSL_CTX_set_mode SSL_CTX_set_mode
2991#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2992#define SSL_CTX_set_options SSL_CTX_set_options
2993#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
2994#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2995#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2996#define SSL_CTX_set_tlsext_servername_callback \
2997 SSL_CTX_set_tlsext_servername_callback
2998#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04002999#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04003000#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
3001#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
3002#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
David Benjamin11c0f8e2015-07-06 00:18:15 -04003003#define SSL_add0_chain_cert SSL_add0_chain_cert
3004#define SSL_add1_chain_cert SSL_add1_chain_cert
3005#define SSL_clear_chain_certs SSL_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04003006#define SSL_clear_mode SSL_clear_mode
3007#define SSL_clear_options SSL_clear_options
3008#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
David Benjamin75910642015-08-09 10:42:33 -04003009#define SSL_get0_certificate_types SSL_get0_certificate_types
David Benjamin11c0f8e2015-07-06 00:18:15 -04003010#define SSL_get0_chain_certs SSL_get0_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04003011#define SSL_get_max_cert_list SSL_get_max_cert_list
3012#define SSL_get_mode SSL_get_mode
3013#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04003014#define SSL_get_secure_renegotiation_support \
3015 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04003016#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04003017#define SSL_need_tmp_RSA SSL_need_tmp_RSA
3018#define SSL_num_renegotiations SSL_num_renegotiations
3019#define SSL_session_reused SSL_session_reused
David Benjamin11c0f8e2015-07-06 00:18:15 -04003020#define SSL_set0_chain SSL_set0_chain
3021#define SSL_set1_chain SSL_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04003022#define SSL_set1_curves SSL_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04003023#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
3024#define SSL_set_max_cert_list SSL_set_max_cert_list
3025#define SSL_set_max_send_fragment SSL_set_max_send_fragment
3026#define SSL_set_mode SSL_set_mode
3027#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
3028#define SSL_set_mtu SSL_set_mtu
3029#define SSL_set_options SSL_set_options
3030#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
3031#define SSL_set_tmp_dh SSL_set_tmp_dh
3032#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
3033#define SSL_set_tmp_rsa SSL_set_tmp_rsa
3034#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04003035
3036
David Benjamin087e4fa2015-04-08 23:46:10 -04003037#if defined(__cplusplus)
3038} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07003039#endif
David Benjamin2e521212014-07-16 14:37:51 -04003040
David Benjamin087e4fa2015-04-08 23:46:10 -04003041
3042/* Library consumers assume these headers are included by ssl.h, but they depend
3043 * on ssl.h, so include them after all declarations.
3044 *
3045 * TODO(davidben): The separation between ssl.h and these version-specific
3046 * headers introduces circular dependencies and is inconsistent. The function
3047 * declarations should move to ssl.h. Many of the constants can probably be
3048 * pruned or unexported. */
David Benjamin087e4fa2015-04-08 23:46:10 -04003049#include <openssl/ssl3.h>
3050#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04003051#include <openssl/srtp.h> /* Support for the use_srtp extension */
3052
3053
David Benjamin2e521212014-07-16 14:37:51 -04003054/* BEGIN ERROR CODES */
3055/* The following lines are auto generated by the script make_errors.go. Any
3056 * changes made after this point may be overwritten when the script is next run.
3057 */
David Benjamin689be0f2015-02-11 15:55:26 -05003058#define SSL_R_APP_DATA_IN_HANDSHAKE 100
3059#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
3060#define SSL_R_BAD_ALERT 102
3061#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
3062#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
3063#define SSL_R_BAD_DH_P_LENGTH 105
3064#define SSL_R_BAD_DIGEST_LENGTH 106
3065#define SSL_R_BAD_ECC_CERT 107
3066#define SSL_R_BAD_ECPOINT 108
3067#define SSL_R_BAD_HANDSHAKE_LENGTH 109
3068#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07003069#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05003070#define SSL_R_BAD_LENGTH 112
3071#define SSL_R_BAD_PACKET_LENGTH 113
3072#define SSL_R_BAD_RSA_ENCRYPT 114
3073#define SSL_R_BAD_SIGNATURE 115
3074#define SSL_R_BAD_SRTP_MKI_VALUE 116
3075#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
3076#define SSL_R_BAD_SSL_FILETYPE 118
3077#define SSL_R_BAD_WRITE_RETRY 119
3078#define SSL_R_BIO_NOT_SET 120
3079#define SSL_R_BN_LIB 121
3080#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
3081#define SSL_R_CA_DN_LENGTH_MISMATCH 123
3082#define SSL_R_CA_DN_TOO_LONG 124
3083#define SSL_R_CCS_RECEIVED_EARLY 125
3084#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
3085#define SSL_R_CERT_CB_ERROR 127
3086#define SSL_R_CERT_LENGTH_MISMATCH 128
3087#define SSL_R_CHANNEL_ID_NOT_P256 129
3088#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
3089#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
3090#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
3091#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
3092#define SSL_R_CLIENTHELLO_TLSEXT 134
3093#define SSL_R_CONNECTION_REJECTED 135
3094#define SSL_R_CONNECTION_TYPE_NOT_SET 136
3095#define SSL_R_COOKIE_MISMATCH 137
3096#define SSL_R_D2I_ECDSA_SIG 138
3097#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
3098#define SSL_R_DATA_LENGTH_TOO_LONG 140
3099#define SSL_R_DECODE_ERROR 141
3100#define SSL_R_DECRYPTION_FAILED 142
3101#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
3102#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
3103#define SSL_R_DIGEST_CHECK_FAILED 145
3104#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
3105#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
3106#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
3107#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
3108#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
3109#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
3110#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
3111#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
3112#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
3113#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
3114#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
3115#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
3116#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
3117#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
3118#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
3119#define SSL_R_HTTPS_PROXY_REQUEST 161
3120#define SSL_R_HTTP_REQUEST 162
3121#define SSL_R_INAPPROPRIATE_FALLBACK 163
3122#define SSL_R_INVALID_COMMAND 164
3123#define SSL_R_INVALID_MESSAGE 165
3124#define SSL_R_INVALID_SSL_SESSION 166
3125#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
3126#define SSL_R_LENGTH_MISMATCH 168
3127#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
3128#define SSL_R_MISSING_DH_KEY 170
3129#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
3130#define SSL_R_MISSING_RSA_CERTIFICATE 172
3131#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
3132#define SSL_R_MISSING_RSA_SIGNING_CERT 174
3133#define SSL_R_MISSING_TMP_DH_KEY 175
3134#define SSL_R_MISSING_TMP_ECDH_KEY 176
3135#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
3136#define SSL_R_MTU_TOO_SMALL 178
3137#define SSL_R_NESTED_GROUP 179
3138#define SSL_R_NO_CERTIFICATES_RETURNED 180
3139#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
3140#define SSL_R_NO_CERTIFICATE_SET 182
3141#define SSL_R_NO_CIPHERS_AVAILABLE 183
3142#define SSL_R_NO_CIPHERS_PASSED 184
3143#define SSL_R_NO_CIPHERS_SPECIFIED 185
3144#define SSL_R_NO_CIPHER_MATCH 186
3145#define SSL_R_NO_COMPRESSION_SPECIFIED 187
3146#define SSL_R_NO_METHOD_SPECIFIED 188
3147#define SSL_R_NO_P256_SUPPORT 189
3148#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
3149#define SSL_R_NO_RENEGOTIATION 191
3150#define SSL_R_NO_REQUIRED_DIGEST 192
3151#define SSL_R_NO_SHARED_CIPHER 193
3152#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
3153#define SSL_R_NO_SRTP_PROFILES 195
3154#define SSL_R_NULL_SSL_CTX 196
3155#define SSL_R_NULL_SSL_METHOD_PASSED 197
3156#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
3157#define SSL_R_PACKET_LENGTH_TOO_LONG 199
3158#define SSL_R_PARSE_TLSEXT 200
3159#define SSL_R_PATH_TOO_LONG 201
3160#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
3161#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
3162#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
3163#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
3164#define SSL_R_PSK_NO_CLIENT_CB 206
3165#define SSL_R_PSK_NO_SERVER_CB 207
3166#define SSL_R_READ_BIO_NOT_SET 208
3167#define SSL_R_READ_TIMEOUT_EXPIRED 209
3168#define SSL_R_RECORD_LENGTH_MISMATCH 210
3169#define SSL_R_RECORD_TOO_LARGE 211
3170#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
3171#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
3172#define SSL_R_RENEGOTIATION_MISMATCH 214
3173#define SSL_R_REQUIRED_CIPHER_MISSING 215
3174#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
3175#define SSL_R_SERVERHELLO_TLSEXT 217
3176#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
3177#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
3178#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
3179#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
3180#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
3181#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
3182#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
3183#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
3184#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
3185#define SSL_R_SSL_HANDSHAKE_FAILURE 227
3186#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
3187#define SSL_R_SSL_SESSION_ID_CONFLICT 229
3188#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
3189#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
3190#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
3191#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
3192#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
3193#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
3194#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
3195#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
3196#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
3197#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
3198#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
3199#define SSL_R_UNEXPECTED_MESSAGE 241
3200#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
3201#define SSL_R_UNEXPECTED_RECORD 243
3202#define SSL_R_UNINITIALIZED 244
3203#define SSL_R_UNKNOWN_ALERT_TYPE 245
3204#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
3205#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
3206#define SSL_R_UNKNOWN_CIPHER_TYPE 248
3207#define SSL_R_UNKNOWN_DIGEST 249
3208#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
3209#define SSL_R_UNKNOWN_PROTOCOL 251
3210#define SSL_R_UNKNOWN_SSL_VERSION 252
3211#define SSL_R_UNKNOWN_STATE 253
3212#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
3213#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
3214#define SSL_R_UNSUPPORTED_CIPHER 256
3215#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
3216#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
3217#define SSL_R_UNSUPPORTED_PROTOCOL 259
3218#define SSL_R_UNSUPPORTED_SSL_VERSION 260
3219#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07003220#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05003221#define SSL_R_WRONG_CIPHER_RETURNED 263
3222#define SSL_R_WRONG_CURVE 264
3223#define SSL_R_WRONG_MESSAGE_TYPE 265
3224#define SSL_R_WRONG_SIGNATURE_TYPE 266
3225#define SSL_R_WRONG_SSL_VERSION 267
3226#define SSL_R_WRONG_VERSION_NUMBER 268
3227#define SSL_R_X509_LIB 269
3228#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05003229#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04003230#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04003231#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05003232#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07003233#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
3234#define SSL_R_EMS_STATE_INCONSISTENT 276
3235#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04003236#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07003237#define SSL_R_UNEXPECTED_EXTENSION 279
Adam Langley2e857bd2015-07-01 16:09:19 -07003238#define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
Adam Langley33ad2b52015-07-20 17:43:53 -07003239#define SSL_R_ERROR_ADDING_EXTENSION 281
3240#define SSL_R_ERROR_PARSING_EXTENSION 282
3241#define SSL_R_MISSING_EXTENSION 283
Adam Langley09505632015-07-30 18:10:13 -07003242#define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
3243#define SSL_R_CUSTOM_EXTENSION_ERROR 285
David Benjamin76c2efc2015-08-31 14:24:29 -04003244#define SSL_R_NEGOTIATED_BOTH_NPN_AND_ALPN 286
David Benjamind7c53682014-09-17 12:08:13 -04003245#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04003246#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
3247#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
3248#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
3249#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
3250#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
3251#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
3252#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
3253#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
3254#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
3255#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
3256#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
3257#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
3258#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
3259#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
3260#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
3261#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
3262#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
3263#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
3264#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
3265#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
3266#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04003267#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04003268#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
3269#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
3270#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
3271#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
3272#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
3273#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
3274#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07003275
David Benjamin087e4fa2015-04-08 23:46:10 -04003276#endif /* OPENSSL_HEADER_SSL_H */