blob: f0e22575c31294e2b42ad28fb19f8a862f315392 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* ssl/ssl.h */
2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
Adam Langleyb4a494c2015-01-23 15:10:10 -08008 *
Adam Langley95c29f32014-06-20 12:00:00 -07009 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
Adam Langleyb4a494c2015-01-23 15:10:10 -080015 *
Adam Langley95c29f32014-06-20 12:00:00 -070016 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
Adam Langleyb4a494c2015-01-23 15:10:10 -080022 *
Adam Langley95c29f32014-06-20 12:00:00 -070023 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
Adam Langleyb4a494c2015-01-23 15:10:10 -080037 * 4. If you include any Windows specific code (or a derivative thereof) from
Adam Langley95c29f32014-06-20 12:00:00 -070038 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
Adam Langleyb4a494c2015-01-23 15:10:10 -080040 *
Adam Langley95c29f32014-06-20 12:00:00 -070041 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
Adam Langleyb4a494c2015-01-23 15:10:10 -080052 *
Adam Langley95c29f32014-06-20 12:00:00 -070053 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58/* ====================================================================
59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
60 *
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
63 * are met:
64 *
65 * 1. Redistributions of source code must retain the above copyright
Adam Langleyb4a494c2015-01-23 15:10:10 -080066 * notice, this list of conditions and the following disclaimer.
Adam Langley95c29f32014-06-20 12:00:00 -070067 *
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 *
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
82 *
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
86 *
87 * 6. Redistributions of any form whatsoever must retain the following
88 * acknowledgment:
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 *
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
105 *
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
109 *
110 */
111/* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
Adam Langleyb4a494c2015-01-23 15:10:10 -0800113 * ECC cipher suite support in OpenSSL originally developed by
Adam Langley95c29f32014-06-20 12:00:00 -0700114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 */
116/* ====================================================================
117 * Copyright 2005 Nokia. All rights reserved.
118 *
119 * The portions of the attached software ("Contribution") is developed by
120 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
121 * license.
122 *
123 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
124 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
125 * support (see RFC 4279) to OpenSSL.
126 *
127 * No patent licenses or other rights except those expressly stated in
128 * the OpenSSL open source license shall be deemed granted or received
129 * expressly, by implication, estoppel, or otherwise.
130 *
131 * No assurances are provided by Nokia that the Contribution does not
132 * infringe the patent or other intellectual property rights of any third
133 * party or that the license provides you with all the necessary rights
134 * to make use of the Contribution.
135 *
136 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
137 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
138 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
139 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
140 * OTHERWISE.
141 */
142
David Benjamin087e4fa2015-04-08 23:46:10 -0400143#ifndef OPENSSL_HEADER_SSL_H
144#define OPENSSL_HEADER_SSL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146#include <openssl/base.h>
147
148#include <openssl/bio.h>
149#include <openssl/buf.h>
150#include <openssl/hmac.h>
151#include <openssl/lhash.h>
152#include <openssl/pem.h>
Adam Langley0b5e3902015-05-15 13:08:38 -0700153#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700154#include <openssl/x509.h>
155
David Benjamin2e749e82015-04-07 23:20:51 -0400156#if !defined(OPENSSL_WINDOWS)
157#include <sys/time.h>
158#endif
159
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700160/* wpa_supplicant expects to get the version functions from ssl.h */
161#include <openssl/crypto.h>
162
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400163/* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
164 * Windows headers define too many macros to be included in public headers.
165 * However, only a forward declaration is needed. */
166struct timeval;
167
David Benjamin087e4fa2015-04-08 23:46:10 -0400168#if defined(__cplusplus)
Adam Langley95c29f32014-06-20 12:00:00 -0700169extern "C" {
170#endif
171
172
David Benjamin0d8a7582015-04-08 23:55:15 -0400173/* SSL implementation. */
174
175
David Benjamin71f07942015-04-08 02:36:59 -0400176/* Initialization. */
177
178/* SSL_library_init initializes the crypto and SSL libraries and returns one. */
179OPENSSL_EXPORT int SSL_library_init(void);
180
181
182/* Cipher suites. */
183
184/* An SSL_CIPHER represents a cipher suite. */
185typedef struct ssl_cipher_st {
186 /* name is the OpenSSL name for the cipher. */
187 const char *name;
188 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
189 uint32_t id;
190
191 /* The following are internal fields. See ssl/internal.h for their values. */
192
193 uint32_t algorithm_mkey;
194 uint32_t algorithm_auth;
195 uint32_t algorithm_enc;
196 uint32_t algorithm_mac;
197 uint32_t algorithm_ssl;
198 uint32_t algo_strength;
David Benjamin5055c762015-08-04 09:24:14 -0400199 uint32_t algorithm_prf;
David Benjamin71f07942015-04-08 02:36:59 -0400200
201 /* strength_bits is the strength of the cipher in bits. */
202 int strength_bits;
203 /* alg_bits is the number of bits of key material used by the algorithm. */
204 int alg_bits;
205} SSL_CIPHER;
206
207DECLARE_STACK_OF(SSL_CIPHER)
208
209/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
210 * suite based on its assigned number, or NULL if unknown. See
211 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
212OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
213
214/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
215 * get the cipher suite value. */
216OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
217
218/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
219 * mode). */
220OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
221
222/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
223OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
224
225/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
226OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
227
228/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
229 * CHACHA20_POLY1305. */
230OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
231
Matt Braithwaiteaf096752015-09-02 19:48:16 -0700232/* SSL_CIPHER_is_NULL returns one if |cipher| does not encrypt. */
233OPENSSL_EXPORT int SSL_CIPHER_is_NULL(const SSL_CIPHER *cipher);
234
235/* SSL_CIPHER_is_block_cipher returns one if |cipher| is a block cipher. */
236OPENSSL_EXPORT int SSL_CIPHER_is_block_cipher(const SSL_CIPHER *cipher);
237
David Benjamin71f07942015-04-08 02:36:59 -0400238/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
239OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
240
241/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
242 * method used by |cipher|. For example, "ECDHE_ECDSA". */
243OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
244
245/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
David Benjamin3fa65f02015-05-15 19:11:57 -0400246 * name for |cipher| or NULL on error. For example,
247 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
248 * calling |OPENSSL_free| on the result. */
David Benjamin71f07942015-04-08 02:36:59 -0400249OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
250
251/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
252 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
253 * symmetric algorithm to |*out_alg_bits|. */
254OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
255 int *out_alg_bits);
256
257
David Benjamin4831c332015-05-16 11:43:13 -0400258/* SSL contexts. */
259
260/* An SSL_METHOD selects whether to use TLS or DTLS. */
261typedef struct ssl_method_st SSL_METHOD;
262
263/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
264OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
265
266/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
267OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
268
269/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
270 * on error. An |SSL_CTX| manages shared state and configuration between
271 * multiple TLS or DTLS connections. */
272OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
273
274/* SSL_CTX_free releases memory associated with |ctx|. */
275OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
276
277
278/* SSL connections. */
279
280/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. An
281 * |SSL| object represents a single TLS or DTLS connection. It inherits settings
282 * from |ctx| at the time of creation. Settings may also be individually
283 * configured on the connection.
284 *
285 * On creation, an |SSL| is not configured to be either a client or server. Call
286 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
287OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
288
289/* SSL_free releases memory associated with |ssl|. */
290OPENSSL_EXPORT void SSL_free(SSL *ssl);
291
292/* SSL_set_connect_state configures |ssl| to be a client. */
293OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
294
295/* SSL_set_accept_state configures |ssl| to be a server. */
296OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
297
David Benjamin3c1ccc02015-09-13 00:27:05 -0400298/* SSL_set_bio configures |ssl| to read from |rbio| and write to |wbio|. |ssl|
299 * takes ownership of the two |BIO|s. If |rbio| and |wbio| are the same, |ssl|
300 * only takes ownership of one reference.
301 *
302 * Calling this function on an already-configured |ssl| is deprecated. */
303OPENSSL_EXPORT void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
304
305/* SSL_get_rbio returns the |BIO| that |ssl| reads from. */
306OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *ssl);
307
308/* SSL_get_wbio returns the |BIO| that |ssl| writes to. */
309OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *ssl);
310
311/* SSL_do_handshake continues the current handshake. If there is none or the
312 * handshake has completed or False Started, it returns one. Otherwise, it
313 * returns <= 0. The caller should pass the value into |SSL_get_error| to
314 * determine how to proceed.
315 *
316 * TODO(davidben): Ensure 0 is only returned on transport EOF.
317 * https://crbug.com/466303. */
318OPENSSL_EXPORT int SSL_do_handshake(SSL *ssl);
319
320/* SSL_connect configures |ssl| as a client, if unconfigured, and calls
321 * |SSL_do_handshake|. */
322OPENSSL_EXPORT int SSL_connect(SSL *ssl);
323
324/* SSL_accept configures |ssl| as a server, if unconfigured, and calls
325 * |SSL_do_handshake|. */
326OPENSSL_EXPORT int SSL_accept(SSL *ssl);
327
328/* SSL_read reads up to |num| bytes from |ssl| into |buf|. It implicitly runs
329 * any pending handshakes, including renegotiations when enabled. On success, it
330 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
331 * should pass the value into |SSL_get_error| to determine how to proceed.
332 *
333 * TODO(davidben): Ensure 0 is only returned on transport EOF.
334 * https://crbug.com/466303. */
335OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
336
337/* SSL_peek behaves like |SSL_read| but does not consume any bytes returned. */
338OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
339
340/* SSL_write writes up to |num| bytes from |buf| into |ssl|. It implicitly runs
341 * any pending handshakes, including renegotiations when enabled. On success, it
342 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
343 * should pass the value into |SSL_get_error| to determine how to proceed.
344 *
345 * A non-blocking |SSL_write| differs from non-blocking |write| in that a failed
346 * |SSL_write| still commits to the data passed in. When retrying, the caller
347 * must supply the original write buffer (or a larger one containing the
348 * original as a prefix). By default, retries will fail if they also do not
349 * reuse the same |buf| pointer. This may be relaxed with
350 * |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER|, but the buffer contents still must be
351 * unchanged.
352 *
353 * By default, |SSL_write| will not return success until all |num| bytes are
354 * written. This may be relaxed with |SSL_MODE_ENABLE_PARTIAL_WRITE|. It allows
355 * |SSL_write| to complete with a partial result when only part of the input was
356 * written in a single record.
357 *
358 * TODO(davidben): Ensure 0 is only returned on transport EOF.
359 * https://crbug.com/466303. */
360OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
361
362/* SSL_shutdown shuts down |ssl|. On success, it completes in two stages. First,
363 * it returns 0 if |ssl| completed uni-directional shutdown; close_notify has
364 * been sent, but the peer's close_notify has not been received. Most callers
365 * may stop at this point. For bi-directional shutdown, call |SSL_shutdown|
366 * again. It returns 1 if close_notify has been both sent and received.
367 *
368 * If the peer's close_notify arrived first, the first stage is skipped.
369 * |SSL_shutdown| will return 1 once close_notify is sent and skip 0. Callers
370 * only interested in uni-directional shutdown must therefore allow for the
371 * first stage returning either 0 or 1.
372 *
373 * |SSL_shutdown| returns -1 on failure. The caller should pass the return value
374 * into |SSL_get_error| to determine how to proceed. If the underlying |BIO| is
375 * non-blocking, both stages may require retry.
376 *
377 * |SSL_shutdown| must be called to retain |ssl|'s session in the session
378 * cache. Use |SSL_CTX_set_quiet_shutdown| to configure |SSL_shutdown| to
379 * neither send nor wait for close_notify but still retain the session.
380 *
381 * TODO(davidben): Is there any point in the session cache interaction? Remove
382 * it? */
383OPENSSL_EXPORT int SSL_shutdown(SSL *ssl);
384
385/* SSL_get_error returns a |SSL_ERROR_*| value for the most recent operation on
386 * |ssl|. It should be called after an operation failed to determine. */
387OPENSSL_EXPORT int SSL_get_error(const SSL *ssl, int ret_code);
388
389/* SSL_ERROR_NONE indicates the operation succeeded. */
390#define SSL_ERROR_NONE 0
391
392/* SSL_ERROR_SSL indicates the operation failed within the library. The caller
393 * may inspect the error queue for more information. */
394#define SSL_ERROR_SSL 1
395
396/* SSL_ERROR_WANT_READ indicates the operation failed attempting to read from
397 * the transport. The caller may retry the operation when the transport is ready
398 * for reading. */
399#define SSL_ERROR_WANT_READ 2
400
401/* SSL_ERROR_WANT_READ indicates the operation failed attempting to write to
402 * the transport. The caller may retry the operation when the transport is ready
403 * for writing. */
404#define SSL_ERROR_WANT_WRITE 3
405
406/* SSL_ERROR_WANT_X509_LOOKUP indicates the operation failed in calling the
407 * |cert_cb| or |client_cert_cb|. The caller may retry the operation when the
408 * callback is ready to return a certificate or one has been configured
409 * externally.
410 *
411 * See also |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb|. */
412#define SSL_ERROR_WANT_X509_LOOKUP 4
413
414/* SSL_ERROR_WANT_SYSCALL indicates the operation failed externally to the
415 * library. The caller should consult the system-specific error mechanism. This
416 * is typically |errno| but may be something custom if using a custom |BIO|. It
417 * may also be signaled if the transport returned EOF, in which case the
418 * operation's return value will be zero. */
419#define SSL_ERROR_SYSCALL 5
420
421/* SSL_ERROR_ZERO_RETURN indicates the operation failed because the connection
422 * was cleanly shut down with a close_notify alert. */
423#define SSL_ERROR_ZERO_RETURN 6
424
425/* SSL_ERROR_WANT_CONNECT indicates the operation failed attempting to connect
426 * the transport (the |BIO| signaled |BIO_RR_CONNECT|). The caller may retry the
427 * operation when the transport is ready. */
428#define SSL_ERROR_WANT_CONNECT 7
429
430/* SSL_ERROR_WANT_ACCEPT indicates the operation failed attempting to accept a
431 * connection from the transport (the |BIO| signaled |BIO_RR_ACCEPT|). The
432 * caller may retry the operation when the transport is ready.
433 *
434 * TODO(davidben): Remove this. It's used by accept BIOs which are bizarre. */
435#define SSL_ERROR_WANT_ACCEPT 8
436
437/* SSL_ERROR_WANT_CHANNEL_ID_LOOKUP indicates the operation failed looking up
438 * the Channel ID key. The caller may retry the operation when |channel_id_cb|
439 * is ready to return a key or one has been configured externally.
440 *
441 * See also |SSL_CTX_set_channel_id_cb|. */
442#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
443
444/* SSL_ERROR_PENDING_SESSION indicates the operation failed because the session
445 * lookup callback indicated the session was unavailable. The caller may retry
446 * the operation when lookup has completed.
447 *
448 * See also |SSL_CTX_sess_set_get_cb|. */
449#define SSL_ERROR_PENDING_SESSION 11
450
451/* SSL_ERROR_PENDING_CERTIFICATE indicates the operation failed because the
452 * early callback indicated certificate lookup was incomplete. The caller may
453 * retry the operation when lookup has completed. Note: when the operation is
454 * retried, the early callback will not be called a second time.
455 *
456 * See also |select_certificate_cb| on |SSL_CTX|. */
457#define SSL_ERROR_PENDING_CERTIFICATE 12
458
459/* SSL_ERROR_WANT_PRIVATE_KEY_OPERATION indicates the operation failed because
460 * a private key operation was unfinished. The caller may retry the operation
461 * when the private key operation is complete.
462 *
463 * See also |SSL_set_private_key_method|. */
464#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
465
David Benjamin4831c332015-05-16 11:43:13 -0400466
David Benjaminb487df62015-05-16 15:31:07 -0400467/* Protocol versions. */
468
David Benjaminb8d28cf2015-07-28 21:34:45 -0400469#define DTLS1_VERSION_MAJOR 0xfe
David Benjaminb487df62015-05-16 15:31:07 -0400470#define SSL3_VERSION_MAJOR 0x03
471
472#define SSL3_VERSION 0x0300
473#define TLS1_VERSION 0x0301
474#define TLS1_1_VERSION 0x0302
475#define TLS1_2_VERSION 0x0303
476
477#define DTLS1_VERSION 0xfeff
478#define DTLS1_2_VERSION 0xfefd
479
480/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
481 * |version|. */
482OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
483
484/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
485 * |version|. */
486OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
487
488/* SSL_set_min_version sets the minimum protocol version for |ssl| to
489 * |version|. */
490OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
491
492/* SSL_set_max_version sets the maximum protocol version for |ssl| to
493 * |version|. */
494OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
495
496
497/* Options.
498 *
499 * Options configure protocol behavior. */
500
501/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
502 * support the renegotiation_info extension (RFC 5746). It is on by default. */
503#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
504
505/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
506 * bytes above the maximum record size. */
507#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
508
509/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
510 * (i.e. without a length prefix). */
511#define SSL_OP_TLS_D5_BUG 0x00000100L
512
513/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
514 * consumers.
515 * TODO(davidben): Determine which of the remaining may be removed now. */
516#define SSL_OP_ALL 0x00000BFFL
517
518/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
519 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
520#define SSL_OP_NO_QUERY_MTU 0x00001000L
521
522/* SSL_OP_NO_TICKET disables session ticket support (RFC 4507). */
523#define SSL_OP_NO_TICKET 0x00004000L
524
David Benjaminb487df62015-05-16 15:31:07 -0400525/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
526 * ECDHE curves according to the server's preferences instead of the
527 * client's. */
528#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
529
530/* The following flags toggle individual protocol versions. This is deprecated.
531 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
532#define SSL_OP_NO_SSLv3 0x02000000L
533#define SSL_OP_NO_TLSv1 0x04000000L
534#define SSL_OP_NO_TLSv1_2 0x08000000L
535#define SSL_OP_NO_TLSv1_1 0x10000000L
536#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
537#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
538
539/* The following flags do nothing and are included only to make it easier to
540 * compile code with BoringSSL. */
Matt Braithwaite45b03022015-08-05 17:17:57 -0700541#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
David Benjaminb487df62015-05-16 15:31:07 -0400542#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700543#define SSL_OP_EPHEMERAL_RSA 0
David Benjaminb487df62015-05-16 15:31:07 -0400544#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700545#define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
546#define SSL_OP_NETSCAPE_CA_DN_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400547#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700548#define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
549#define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400550#define SSL_OP_NO_COMPRESSION 0
551#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
552#define SSL_OP_NO_SSLv2 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700553#define SSL_OP_PKCS1_CHECK_1 0
554#define SSL_OP_PKCS1_CHECK_2 0
David Benjaminb487df62015-05-16 15:31:07 -0400555#define SSL_OP_SINGLE_DH_USE 0
556#define SSL_OP_SINGLE_ECDH_USE 0
Matt Braithwaite45b03022015-08-05 17:17:57 -0700557#define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
David Benjaminb487df62015-05-16 15:31:07 -0400558#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
559#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
560#define SSL_OP_TLS_ROLLBACK_BUG 0
561
562/* SSL_CTX_set_options enables all options set in |options| (which should be one
563 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
564 * bitmask representing the resulting enabled options. */
565OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
566
567/* SSL_CTX_clear_options disables all options set in |options| (which should be
568 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
569 * bitmask representing the resulting enabled options. */
570OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
571
572/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
573 * the options enabled for |ctx|. */
574OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
575
576/* SSL_set_options enables all options set in |options| (which should be one or
577 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
578 * representing the resulting enabled options. */
579OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
580
581/* SSL_clear_options disables all options set in |options| (which should be one
582 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
583 * bitmask representing the resulting enabled options. */
584OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
585
586/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
587 * options enabled for |ssl|. */
588OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
589
590
591/* Modes.
592 *
593 * Modes configure API behavior. */
594
595/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
596 * result when the only part of the input was written in a single record. */
597#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
598
599/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
600 * with a different buffer. However, |SSL_write| still assumes the buffer
601 * contents are unchanged. This is not the default to avoid the misconception
602 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
603#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
604
605/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
606 * before sending certificates to the peer.
607 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
608#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
609
David Benjaminb487df62015-05-16 15:31:07 -0400610/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
611 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
612 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
613#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
614
David Benjaminb487df62015-05-16 15:31:07 -0400615/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
616 * TLS 1.0 to be split in two: the first record will contain a single byte and
617 * the second will contain the remainder. This effectively randomises the IV and
618 * prevents BEAST attacks. */
619#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
620
621/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
622 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
623 * session resumption is used for a given SSL*. */
624#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
625
626/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
627 * To be set only by applications that reconnect with a downgraded protocol
David Benjamin229adfb2015-07-25 15:08:18 -0400628 * version; see RFC 7507 for details.
David Benjaminb487df62015-05-16 15:31:07 -0400629 *
630 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
David Benjamin229adfb2015-07-25 15:08:18 -0400631 * this in explicit fallback retries, following the guidance in RFC 7507. */
David Benjaminb487df62015-05-16 15:31:07 -0400632#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
633
634/* The following flags do nothing and are included only to make it easier to
635 * compile code with BoringSSL. */
636#define SSL_MODE_AUTO_RETRY 0
637#define SSL_MODE_RELEASE_BUFFERS 0
David Benjamin74d8bc22015-05-21 02:16:53 -0400638#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
639#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjaminb487df62015-05-16 15:31:07 -0400640
641/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
642 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
643 * representing the resulting enabled modes. */
644OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
645
646/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
647 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
648 * bitmask representing the resulting enabled modes. */
649OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
650
651/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
652 * the modes enabled for |ssl|. */
653OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
654
655/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
656 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
657 * representing the resulting enabled modes. */
658OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
659
660/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
661 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
662 * representing the resulting enabled modes. */
663OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
664
665/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
666 * modes enabled for |ssl|. */
667OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
668
669
David Benjaminb4d65fd2015-05-29 17:11:21 -0400670/* Configuring certificates and private keys.
671 *
David Benjamin11c0f8e2015-07-06 00:18:15 -0400672 * These functions configure the connection's leaf certificate, private key, and
673 * certificate chain. The certificate chain is ordered leaf to root (as sent on
674 * the wire) but does not include the leaf. Both client and server certificates
675 * use these functions.
676 *
677 * Certificates and keys may be configured before the handshake or dynamically
678 * in the early callback and certificate callback. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400679
David Benjamin7481d392015-07-05 19:38:46 -0400680/* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
681 * one on success and zero on failure. */
682OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
683
684/* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
685 * on success and zero on failure. */
686OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
687
688/* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
689 * success and zero on failure. */
690OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
691
692/* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
693 * success and zero on failure. */
694OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
695
David Benjamin11c0f8e2015-07-06 00:18:15 -0400696/* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
697 * |chain|. On success, it returns one and takes ownership of |chain|.
698 * Otherwise, it returns zero. */
699OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
700
701/* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
702 * |chain|. It returns one on success and zero on failure. The caller retains
703 * ownership of |chain| and may release it freely. */
704OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
705
706/* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
707 * |chain|. On success, it returns one and takes ownership of |chain|.
708 * Otherwise, it returns zero. */
709OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
710
711/* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
712 * |chain|. It returns one on success and zero on failure. The caller retains
713 * ownership of |chain| and may release it freely. */
714OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
715
716/* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
717 * success, it returns one and takes ownership of |x509|. Otherwise, it returns
718 * zero. */
719OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
720
721/* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
722 * returns one on success and zero on failure. The caller retains ownership of
723 * |x509| and may release it freely. */
724OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
725
726/* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
727 * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
728OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
729
730/* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
731OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
732
733/* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
734 * one on success and zero on failure. The caller retains ownership of |x509|
735 * and may release it freely. */
736OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
737
738/* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
739 * one. */
740OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
741
742/* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
743OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
744
745/* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
746OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
747
David Benjamin7481d392015-07-05 19:38:46 -0400748/* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
749 * The callback returns one on success, zero on internal error, and a negative
750 * number on failure or to pause the handshake. If the handshake is paused,
751 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
752OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
753 int (*cb)(SSL *ssl, void *arg),
754 void *arg);
755
756/* SSL_set_cert_cb sets a callback that is called to select a certificate. The
757 * callback returns one on success, zero on internal error, and a negative
758 * number on failure or to pause the handshake. If the handshake is paused,
759 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. */
760OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
761 void *arg);
762
763/* SSL_certs_clear resets the private key, leaf certificate, and certificate
764 * chain of |ssl|. */
765OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
766
767/* SSL_CTX_check_private_key returns one if the certificate and private key
768 * configured in |ctx| are consistent and zero otherwise. */
769OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
770
771/* SSL_check_private_key returns one if the certificate and private key
772 * configured in |ssl| are consistent and zero otherwise. */
773OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
774
775/* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
776OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
777
778/* SSL_get_certificate returns |ssl|'s leaf certificate. */
779OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
780
David Benjamin11c0f8e2015-07-06 00:18:15 -0400781/* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
782OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
783
784/* SSL_get_privatekey returns |ssl|'s private key. */
785OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
786
787/* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
788 * returns one. */
789OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
790 STACK_OF(X509) **out_chain);
791
792/* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
793OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
794 STACK_OF(X509) **out_chain);
795
796/* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
797 * returns one. */
798OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
799 STACK_OF(X509) **out_chain);
800
Paul Lietar4fac72e2015-09-09 13:44:55 +0100801/* SSL_CTX_set_signed_cert_timestamp_list sets the list of signed certificate
802 * timestamps that is sent to clients that request it. The |list| argument must
803 * contain one or more SCT structures serialised as a SignedCertificateTimestamp
804 * List (see https://tools.ietf.org/html/rfc6962#section-3.3) – i.e. each SCT
805 * is prefixed by a big-endian, uint16 length and the concatenation of one or
806 * more such prefixed SCTs are themselves also prefixed by a uint16 length. It
807 * returns one on success and zero on error. The caller retains ownership of
808 * |list|. */
809OPENSSL_EXPORT int SSL_CTX_set_signed_cert_timestamp_list(SSL_CTX *ctx,
810 const uint8_t *list,
811 size_t list_len);
812
Paul Lietaraeeff2c2015-08-12 11:47:11 +0100813/* SSL_CTX_set_ocsp_response sets the OCSP reponse that is sent to clients
814 * which request it. It returns one on success and zero on error. The caller
815 * retains ownership of |response|. */
816OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx,
817 const uint8_t *response,
818 size_t response_len);
819
David Benjamin7481d392015-07-05 19:38:46 -0400820
821/* Certificate and private key convenience functions. */
822
823/* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
824 * on success and zero on failure. */
825OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
826
827/* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
828 * success and zero on failure. */
829OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
830
831/* The following functions configure certificates or private keys but take as
832 * input DER-encoded structures. They return one on success and zero on
833 * failure. */
834
835OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
836 const uint8_t *d);
837OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
838 int len);
839
840OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
841 const uint8_t *d, long len);
842OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
843 const uint8_t *d, long len);
844
845OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
David Benjamin74f71102015-06-27 14:56:25 -0400846 const uint8_t *der,
847 size_t der_len);
848OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
849 size_t der_len);
David Benjamin7481d392015-07-05 19:38:46 -0400850
851/* The following functions configure certificates or private keys but take as
852 * input files to read from. They return one on success and zero on failure. The
853 * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
854 * the file's contents are read as PEM or DER. */
855
856#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
857#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
858
859OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
860 const char *file,
861 int type);
862OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
863 int type);
864
865OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
866 int type);
867OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
868 int type);
869
870OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
871 int type);
872OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
873 int type);
874
875/* SSL_CTX_use_certificate_file configures certificates for |ctx|. It reads the
876 * contents of |file| as a PEM-encoded leaf certificate followed optionally by
877 * the certificate chain to send to the peer. It returns one on success and zero
878 * on failure. */
879OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
880 const char *file);
881
882
883/* Custom private keys. */
884
David Benjaminb4d65fd2015-05-29 17:11:21 -0400885enum ssl_private_key_result_t {
886 ssl_private_key_success,
887 ssl_private_key_retry,
888 ssl_private_key_failure,
889};
890
891/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
892 * signing operations to a custom, potentially asynchronous, backend. */
893typedef struct ssl_private_key_method_st {
894 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
895 * key used by |ssl|. */
896 int (*type)(SSL *ssl);
897
898 /* supports_digest returns one if the key used by |ssl| supports signing
899 * digests of type |md| and zero otherwise. */
900 int (*supports_digest)(SSL *ssl, const EVP_MD *md);
901
902 /* max_signature_len returns the maximum length of a signature signed by the
903 * key used by |ssl|. This must be a constant value for a given |ssl|. */
904 size_t (*max_signature_len)(SSL *ssl);
905
906 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
907 * used to calculate |in|. On success, it returns |ssl_private_key_success|
908 * and writes at most |max_out| bytes of signature data to |out|. On failure,
909 * it returns |ssl_private_key_failure|. If the operation has not completed,
910 * it returns |ssl_private_key_retry|. |sign| should arrange for the
911 * high-level operation on |ssl| to be retried when the operation is
912 * completed. This will result in a call to |sign_complete|.
913 *
914 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
915 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
916 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
917 *
918 * It is an error to call |sign| while another private key operation is in
919 * progress on |ssl|. */
920 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
921 size_t max_out, const EVP_MD *md,
922 const uint8_t *in, size_t in_len);
923
924 /* sign_complete completes a pending |sign| operation. If the operation has
925 * completed, it returns |ssl_private_key_success| and writes the result to
926 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
927 * failure and |ssl_private_key_retry| if the operation is still in progress.
928 *
929 * |sign_complete| may be called arbitrarily many times before completion, but
930 * it is an error to call |sign_complete| if there is no pending |sign|
931 * operation in progress on |ssl|. */
932 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
933 size_t *out_len, size_t max_out);
934} SSL_PRIVATE_KEY_METHOD;
935
David Benjamind1d80782015-07-05 11:54:09 -0400936/* SSL_use_private_key_method configures a custom private key on |ssl|.
937 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400938OPENSSL_EXPORT void SSL_set_private_key_method(
939 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
940
941
Adam Langleyaf0e32c2015-06-03 09:57:23 -0700942/* Connection information. */
943
944/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
945 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
946 * returns one on success or zero on error. In general |max_out| should be at
947 * least 12.
948 *
949 * This function will always fail if the initial handshake has not completed.
950 * The tls-unique value will change after a renegotiation but, since
951 * renegotiations can be initiated by the server at any point, the higher-level
952 * protocol must either leave them disabled or define states in which the
953 * tls-unique value can be read.
954 *
955 * The tls-unique value is defined by
956 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
957 * TLS protocol, tls-unique is broken for resumed connections unless the
958 * Extended Master Secret extension is negotiated. Thus this function will
959 * return zero if |ssl| performed session resumption unless EMS was used when
960 * negotiating the original session. */
961OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
962 size_t *out_len, size_t max_out);
963
964
Adam Langley09505632015-07-30 18:10:13 -0700965/* Custom extensions.
966 *
967 * The custom extension functions allow TLS extensions to be added to
968 * ClientHello and ServerHello messages. */
969
970/* SSL_custom_ext_add_cb is a callback function that is called when the
971 * ClientHello (for clients) or ServerHello (for servers) is constructed. In
972 * the case of a server, this callback will only be called for a given
973 * extension if the ClientHello contained that extension – it's not possible to
974 * inject extensions into a ServerHello that the client didn't request.
975 *
976 * When called, |extension_value| will contain the extension number that is
977 * being considered for addition (so that a single callback can handle multiple
978 * extensions). If the callback wishes to include the extension, it must set
979 * |*out| to point to |*out_len| bytes of extension contents and return one. In
980 * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
981 * called with the value of |*out| once that data has been copied.
982 *
983 * If the callback does not wish to add an extension it must return zero.
984 *
985 * Alternatively, the callback can abort the connection by setting
986 * |*out_alert_value| to a TLS alert number and returning -1. */
987typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
988 const uint8_t **out, size_t *out_len,
989 int *out_alert_value, void *add_arg);
990
991/* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
992 * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
993 * this callback is called and passed the |out| pointer that was returned by
994 * the add callback. This is to free any dynamically allocated data created by
995 * the add callback. */
996typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
997 const uint8_t *out, void *add_arg);
998
999/* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
1000 * parse an extension from the peer: that is from the ServerHello for a client
1001 * and from the ClientHello for a server.
1002 *
1003 * When called, |extension_value| will contain the extension number and the
1004 * contents of the extension are |contents_len| bytes at |contents|.
1005 *
1006 * The callback must return one to continue the handshake. Otherwise, if it
1007 * returns zero, a fatal alert with value |*out_alert_value| is sent and the
1008 * handshake is aborted. */
1009typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
1010 const uint8_t *contents,
1011 size_t contents_len,
1012 int *out_alert_value, void *parse_arg);
1013
1014/* SSL_extension_supported returns one iff OpenSSL internally handles
1015 * extensions of type |extension_value|. This can be used to avoid registering
1016 * custom extension handlers for extensions that a future version of OpenSSL
1017 * may handle internally. */
1018OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
1019
1020/* SSL_CTX_add_client_custom_ext registers callback functions for handling
1021 * custom TLS extensions for client connections.
1022 *
1023 * If |add_cb| is NULL then an empty extension will be added in each
1024 * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
1025 * this callback.
1026 *
1027 * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
1028 * needs to be freed.
1029 *
1030 * It returns one on success or zero on error. It's always an error to register
1031 * callbacks for the same extension twice, or to register callbacks for an
1032 * extension that OpenSSL handles internally. See |SSL_extension_supported| to
1033 * discover, at runtime, which extensions OpenSSL handles internally. */
1034OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
1035 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1036 SSL_custom_ext_free_cb free_cb, void *add_arg,
1037 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1038
1039/* SSL_CTX_add_server_custom_ext is the same as
1040 * |SSL_CTX_add_client_custom_ext|, but for server connections.
1041 *
1042 * Unlike on the client side, if |add_cb| is NULL no extension will be added.
1043 * The |add_cb|, if any, will only be called if the ClientHello contained a
1044 * matching extension. */
1045OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
1046 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1047 SSL_custom_ext_free_cb free_cb, void *add_arg,
1048 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1049
1050
David Benjamindaeafc22015-06-25 17:35:11 -04001051/* Session tickets. */
1052
1053/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
1054 * |len| bytes of |out|. It returns one on success and zero if |len| is not
1055 * 48. If |out| is NULL, it returns 48 instead. */
1056OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
1057 size_t len);
1058
1059/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
1060 * |len| bytes of |in|. It returns one on success and zero if |len| is not
1061 * 48. If |in| is NULL, it returns 48 instead. */
1062OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
1063 size_t len);
1064
David Benjamine3aa1d92015-06-16 15:34:50 -04001065/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
1066 * ticket. */
1067#define SSL_TICKET_KEY_NAME_LEN 16
1068
David Benjamindaeafc22015-06-25 17:35:11 -04001069/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
1070 * returns one. |callback| will be called when encrypting a new ticket and when
1071 * decrypting a ticket from the client.
1072 *
1073 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
1074 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
1075 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
1076 * for encryption or decryption, based on the mode.
1077 *
1078 * When encrypting a new ticket, |encrypt| will be one. It writes a public
1079 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
1080 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1081 * |callback| returns 1 on success and -1 on error.
1082 *
1083 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
1084 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
1085 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1086 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
1087 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
1088 * This may be used to re-key the ticket.
1089 *
1090 * WARNING: |callback| wildly breaks the usual return value convention and is
1091 * called in two different modes. */
1092OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
1093 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
1094 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
1095 int encrypt));
1096
1097
David Benjamin71f07942015-04-08 02:36:59 -04001098/* Underdocumented functions.
1099 *
1100 * Functions below here haven't been touched up and may be underdocumented. */
1101
Adam Langley95c29f32014-06-20 12:00:00 -07001102/* SSLeay version number for ASN.1 encoding of the session information */
1103/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -08001104 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -07001105#define SSL_SESSION_ASN1_VERSION 0x0001
1106
Adam Langleyb4a494c2015-01-23 15:10:10 -08001107#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
1108#define SSL_MAX_SID_CTX_LENGTH 32
1109#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -07001110
1111/* These are used to specify which ciphers to use and not to use */
1112
Adam Langleyb4a494c2015-01-23 15:10:10 -08001113#define SSL_TXT_MEDIUM "MEDIUM"
1114#define SSL_TXT_HIGH "HIGH"
1115#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -07001116
Adam Langleyb4a494c2015-01-23 15:10:10 -08001117#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -04001118#define SSL_TXT_kDHE "kDHE"
1119#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
1120#define SSL_TXT_kECDHE "kECDHE"
1121#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001122#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07001123
Adam Langleyb4a494c2015-01-23 15:10:10 -08001124#define SSL_TXT_aRSA "aRSA"
1125#define SSL_TXT_aECDSA "aECDSA"
1126#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07001127
Adam Langleyb4a494c2015-01-23 15:10:10 -08001128#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -04001129#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04001130#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001131#define SSL_TXT_RSA "RSA"
1132#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -04001133#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04001134#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001135#define SSL_TXT_ECDSA "ECDSA"
1136#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -07001137
Adam Langleyb4a494c2015-01-23 15:10:10 -08001138#define SSL_TXT_3DES "3DES"
1139#define SSL_TXT_RC4 "RC4"
1140#define SSL_TXT_AES128 "AES128"
1141#define SSL_TXT_AES256 "AES256"
1142#define SSL_TXT_AES "AES"
1143#define SSL_TXT_AES_GCM "AESGCM"
1144#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -07001145
Adam Langleyb4a494c2015-01-23 15:10:10 -08001146#define SSL_TXT_MD5 "MD5"
1147#define SSL_TXT_SHA1 "SHA1"
1148#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
1149#define SSL_TXT_SHA256 "SHA256"
1150#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -07001151
Adam Langleyb4a494c2015-01-23 15:10:10 -08001152#define SSL_TXT_SSLV3 "SSLv3"
1153#define SSL_TXT_TLSV1 "TLSv1"
1154#define SSL_TXT_TLSV1_1 "TLSv1.1"
1155#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -07001156
Adam Langleyb4a494c2015-01-23 15:10:10 -08001157#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -07001158
Adam Langleyb4a494c2015-01-23 15:10:10 -08001159/* COMPLEMENTOF* definitions. These identifiers are used to (de-select) ciphers
1160 * normally not being used.
1161 *
1162 * Example: "RC4" will activate all ciphers using RC4 including ciphers without
1163 * authentication, which would normally disabled by DEFAULT (due the "!ADH"
1164 * being part of default). Therefore "RC4:!COMPLEMENTOFDEFAULT" will make sure
1165 * that it is also disabled in the specific selection. COMPLEMENTOF*
1166 * identifiers are portable between version, as adjustments to the default
1167 * cipher setup will also be included here.
Adam Langley95c29f32014-06-20 12:00:00 -07001168 *
1169 * COMPLEMENTOFDEFAULT does not experience the same special treatment that
Adam Langleyb4a494c2015-01-23 15:10:10 -08001170 * DEFAULT gets, as only selection is being done and no sorting as needed for
1171 * DEFAULT. */
1172#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -07001173
Adam Langleyb4a494c2015-01-23 15:10:10 -08001174/* The following cipher list is used by default. It also is substituted when an
1175 * application-defined cipher list string starts with 'DEFAULT'. */
David Benjamin32fbdf22015-04-07 01:14:06 -04001176#define SSL_DEFAULT_CIPHER_LIST "ALL"
Adam Langleyb4a494c2015-01-23 15:10:10 -08001177
Adam Langley95c29f32014-06-20 12:00:00 -07001178/* As of OpenSSL 1.0.0, ssl_create_cipher_list() in ssl/ssl_ciph.c always
1179 * starts with a reasonable order, and all we have to do for DEFAULT is
Adam Langleyb4a494c2015-01-23 15:10:10 -08001180 * throwing out anonymous and unencrypted ciphersuites! (The latter are not
1181 * actually enabled by ALL, but "ALL:RSA" would enable some of them.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001182
1183/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001184#define SSL_SENT_SHUTDOWN 1
1185#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -07001186
David Benjamin82c9e902014-12-12 15:55:27 -05001187typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07001188typedef struct ssl_session_st SSL_SESSION;
Adam Langley95c29f32014-06-20 12:00:00 -07001189typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -05001190typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07001191
Adam Langleyb4a494c2015-01-23 15:10:10 -08001192/* SRTP protection profiles for use with the use_srtp extension (RFC 5764). */
1193typedef struct srtp_protection_profile_st {
1194 const char *name;
1195 unsigned long id;
1196} SRTP_PROTECTION_PROFILE;
Adam Langley95c29f32014-06-20 12:00:00 -07001197
1198DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
1199
David Benjamin83fd6b62014-10-19 04:33:38 -04001200/* An SSL_SESSION represents an SSL session that may be resumed in an
1201 * abbreviated handshake. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001202struct ssl_session_st {
1203 int ssl_version; /* what ssl version session info is being kept in here? */
Adam Langley95c29f32014-06-20 12:00:00 -07001204
Adam Langleyb4a494c2015-01-23 15:10:10 -08001205 int master_key_length;
1206 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
1207 /* session_id - valid? */
1208 unsigned int session_id_length;
1209 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
1210 /* this is used to determine whether the session is being reused in
1211 * the appropriate context. It is up to the application to set this,
1212 * via SSL_new */
1213 unsigned int sid_ctx_length;
1214 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001215
Adam Langleyb4a494c2015-01-23 15:10:10 -08001216 char *psk_identity;
1217 /* Used to indicate that session resumption is not allowed. Applications can
1218 * also set this bit for a new session via not_resumable_session_cb to
1219 * disable session caching and tickets. */
1220 int not_resumable;
Adam Langley95c29f32014-06-20 12:00:00 -07001221
David Benjaminb1bdc5b2015-08-22 12:56:34 -04001222 /* peer is the peer's certificate. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001223 X509 *peer;
David Benjaminb1bdc5b2015-08-22 12:56:34 -04001224
David Benjamin26416e92015-08-22 16:04:17 -04001225 /* cert_chain is the certificate chain sent by the peer. NOTE: for historical
1226 * reasons, when a client (so the peer is a server), the chain includes
1227 * |peer|, but when a server it does not. */
1228 STACK_OF(X509) *cert_chain;
1229
Adam Langleyb4a494c2015-01-23 15:10:10 -08001230 /* when app_verify_callback accepts a session where the peer's certificate is
1231 * not ok, we must remember the error for session reuse: */
1232 long verify_result; /* only for servers */
Adam Langley95c29f32014-06-20 12:00:00 -07001233
Adam Langley0b5e3902015-05-15 13:08:38 -07001234 CRYPTO_refcount_t references;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001235 long timeout;
1236 long time;
Adam Langley95c29f32014-06-20 12:00:00 -07001237
Adam Langleyb4a494c2015-01-23 15:10:10 -08001238 const SSL_CIPHER *cipher;
Adam Langley95c29f32014-06-20 12:00:00 -07001239
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02001240 /* key_exchange_info contains an indication of the size of the asymmetric
1241 * primitive used in the handshake that created this session. In the event
1242 * that two asymmetric operations are used, this value applies to the one
1243 * that controls the confidentiality of the connection. Its interpretation
1244 * depends on the primitive that was used; as specified by the cipher suite:
1245 * DHE: the size, in bits, of the multiplicative group.
1246 * RSA: the size, in bits, of the modulus.
1247 * ECDHE: the TLS id for the curve.
1248 *
1249 * A zero indicates that the value is unknown. */
1250 uint32_t key_exchange_info;
1251
Adam Langleyb4a494c2015-01-23 15:10:10 -08001252 CRYPTO_EX_DATA ex_data; /* application specific data */
Adam Langley95c29f32014-06-20 12:00:00 -07001253
Adam Langleyb4a494c2015-01-23 15:10:10 -08001254 /* These are used to make removal of session-ids more efficient and to
1255 * implement a maximum cache size. */
David Benjamin4dab2972015-05-16 02:56:06 -04001256 SSL_SESSION *prev, *next;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001257 char *tlsext_hostname;
1258 /* RFC4507 info */
1259 uint8_t *tlsext_tick; /* Session ticket */
1260 size_t tlsext_ticklen; /* Session ticket length */
1261 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
David Benjamin6c7aed02014-08-27 16:42:38 -04001262
Adam Langleyb4a494c2015-01-23 15:10:10 -08001263 size_t tlsext_signed_cert_timestamp_list_length;
1264 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001265
Adam Langleyb4a494c2015-01-23 15:10:10 -08001266 /* The OCSP response that came with the session. */
1267 size_t ocsp_response_length;
1268 uint8_t *ocsp_response;
David Benjamin6c7aed02014-08-27 16:42:38 -04001269
Adam Langleyb4a494c2015-01-23 15:10:10 -08001270 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
1271 uint8_t
1272 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
Adam Langley1258b6a2014-06-20 12:00:00 -07001273
Adam Langleyb4a494c2015-01-23 15:10:10 -08001274 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
1275 * SHA-2, depending on TLS version) for the original, full handshake that
1276 * created a session. This is used by Channel IDs during resumption. */
1277 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
1278 unsigned int original_handshake_hash_len;
Adam Langley75712922014-10-10 16:23:43 -07001279
Adam Langleyb4a494c2015-01-23 15:10:10 -08001280 /* extended_master_secret is true if the master secret in this session was
1281 * generated using EMS and thus isn't vulnerable to the Triple Handshake
1282 * attack. */
1283 char extended_master_secret;
1284};
Adam Langley95c29f32014-06-20 12:00:00 -07001285
Adam Langley95c29f32014-06-20 12:00:00 -07001286
David Benjamincb9cf792015-05-05 09:46:14 -04001287/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
1288 * and zero on failure. */
1289OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
Adam Langley95c29f32014-06-20 12:00:00 -07001290
David Benjamincb9cf792015-05-05 09:46:14 -04001291/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
1292 * renegotiation (RFC 5746) and zero otherwise. */
1293OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001294
David Benjamin59015c32015-04-26 13:13:55 -04001295/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
1296 * This callback will be called when sending or receiving low-level record
1297 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
1298 * |write_p| is one for outgoing messages and zero for incoming messages.
1299 *
1300 * For each record header, |cb| is called with |version| = 0 and |content_type|
1301 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
1302 * this does not include the record body. If the record is sealed, the length
1303 * in the header is the length of the ciphertext.
1304 *
1305 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
1306 * protocol version and |content_type| is the corresponding record type. The
1307 * |len| bytes from |buf| contain the handshake message, one-byte
1308 * ChangeCipherSpec body, and two-byte alert, respectively. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001309OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
1310 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
1311 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001312
David Benjamin61ecccf2015-05-05 09:44:51 -04001313/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
1314 * callback. */
1315OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
1316
David Benjamin59015c32015-04-26 13:13:55 -04001317/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
1318 * |SSL_CTX_set_msg_callback| for when this callback is called. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001319OPENSSL_EXPORT void SSL_set_msg_callback(
1320 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
1321 const void *buf, size_t len, SSL *ssl, void *arg));
David Benjamin59015c32015-04-26 13:13:55 -04001322
David Benjamin3b7456e2015-05-16 12:29:32 -04001323/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
David Benjamin61ecccf2015-05-05 09:44:51 -04001324OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07001325
David Benjamin859ec3c2014-09-02 16:29:36 -04001326/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
Adam Langleyb4a494c2015-01-23 15:10:10 -08001327 * log session material to |keylog_bio|. This is intended for debugging use
1328 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
David Benjamin859ec3c2014-09-02 16:29:36 -04001329 *
1330 * The format is described in
1331 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
David Benjamin71dad682014-09-04 10:08:27 -04001332OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
David Benjamin859ec3c2014-09-02 16:29:36 -04001333
Adam Langley95c29f32014-06-20 12:00:00 -07001334
Adam Langleyc9fb3752014-06-20 12:00:00 -07001335struct ssl_aead_ctx_st;
1336typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
1337
Adam Langleyb4a494c2015-01-23 15:10:10 -08001338#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100 /* 100k max cert list */
Adam Langley95c29f32014-06-20 12:00:00 -07001339
Adam Langleyb4a494c2015-01-23 15:10:10 -08001340#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
Adam Langley95c29f32014-06-20 12:00:00 -07001341
David Benjaminf4501342014-08-14 17:24:37 -04001342#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
1343
Adam Langleyb4a494c2015-01-23 15:10:10 -08001344/* This callback type is used inside SSL_CTX, SSL, and in the functions that
1345 * set them. It is used to override the generation of SSL/TLS session IDs in a
Adam Langley95c29f32014-06-20 12:00:00 -07001346 * server. Return value should be zero on an error, non-zero to proceed. Also,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001347 * callbacks should themselves check if the id they generate is unique
1348 * otherwise the SSL handshake will fail with an error - callbacks can do this
1349 * using the 'ssl' value they're passed by;
Adam Langley95c29f32014-06-20 12:00:00 -07001350 * SSL_has_matching_session_id(ssl, id, *id_len)
1351 * The length value passed in is set at the maximum size the session ID can be.
1352 * In SSLv2 this is 16 bytes, whereas SSLv3/TLSv1 it is 32 bytes. The callback
1353 * can alter this length to be less if desired, but under SSLv2 session IDs are
1354 * supposed to be fixed at 16 bytes so the id will be padded after the callback
Adam Langleyb4a494c2015-01-23 15:10:10 -08001355 * returns in this case. It is also an error for the callback to set the size
1356 * to zero. */
1357typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id,
1358 unsigned int *id_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001359
Adam Langleydc9b1412014-06-20 12:00:00 -07001360/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -08001361 * early on during the server handshake. At this point, much of the SSL* hasn't
1362 * been filled out and only the ClientHello can be depended on. */
1363struct ssl_early_callback_ctx {
1364 SSL *ssl;
1365 const uint8_t *client_hello;
1366 size_t client_hello_len;
1367 const uint8_t *session_id;
1368 size_t session_id_len;
1369 const uint8_t *cipher_suites;
1370 size_t cipher_suites_len;
1371 const uint8_t *compression_methods;
1372 size_t compression_methods_len;
1373 const uint8_t *extensions;
1374 size_t extensions_len;
1375};
Adam Langleydc9b1412014-06-20 12:00:00 -07001376
Adam Langleyb4a494c2015-01-23 15:10:10 -08001377/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
1378 * extension of the given type. If not found, it returns zero. Otherwise it
1379 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -07001380 * and length bytes), sets |out_len| to the length of the extension contents
1381 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001382OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
1383 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
1384 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -07001385
Adam Langley95c29f32014-06-20 12:00:00 -07001386typedef struct ssl_comp_st SSL_COMP;
1387
Adam Langleyb4a494c2015-01-23 15:10:10 -08001388struct ssl_comp_st {
1389 int id;
1390 const char *name;
1391 char *method;
1392};
Adam Langley95c29f32014-06-20 12:00:00 -07001393
1394DECLARE_STACK_OF(SSL_COMP)
Matt Braithwaite58e95fc2015-05-08 13:19:16 -07001395DECLARE_LHASH_OF(SSL_SESSION)
Adam Langley95c29f32014-06-20 12:00:00 -07001396
Adam Langley858a88d2014-06-20 12:00:00 -07001397/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
1398 * equal-preference groups. For TLS clients, the groups are moot because the
1399 * server picks the cipher and groups cannot be expressed on the wire. However,
1400 * for servers, the equal-preference groups allow the client's preferences to
1401 * be partially respected. (This only has an effect with
1402 * SSL_OP_CIPHER_SERVER_PREFERENCE).
1403 *
1404 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
1405 * All elements of a group have the same priority: no ordering is expressed
1406 * within a group.
1407 *
1408 * The values in |ciphers| are in one-to-one correspondence with
1409 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
1410 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
1411 * indicate that the corresponding SSL_CIPHER is not the last element of a
1412 * group, or 0 to indicate that it is.
1413 *
1414 * For example, if |in_group_flags| contains all zeros then that indicates a
1415 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
1416 * of the group (i.e. they are all in a one-element group).
1417 *
1418 * For a more complex example, consider:
1419 * ciphers: A B C D E F
1420 * in_group_flags: 1 1 0 0 1 0
1421 *
1422 * That would express the following, order:
1423 *
1424 * A E
1425 * B -> D -> F
1426 * C
1427 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001428struct ssl_cipher_preference_list_st {
1429 STACK_OF(SSL_CIPHER) *ciphers;
1430 uint8_t *in_group_flags;
1431};
Adam Langley858a88d2014-06-20 12:00:00 -07001432
Adam Langleyb4a494c2015-01-23 15:10:10 -08001433struct ssl_ctx_st {
1434 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001435
Adam Langley4bdb6e42015-05-15 15:29:21 -07001436 /* lock is used to protect various operations on this object. */
1437 CRYPTO_MUTEX lock;
1438
Adam Langleyb4a494c2015-01-23 15:10:10 -08001439 /* max_version is the maximum acceptable protocol version. If zero, the
1440 * maximum supported version, currently (D)TLS 1.2, is used. */
1441 uint16_t max_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001442
Adam Langleyb4a494c2015-01-23 15:10:10 -08001443 /* min_version is the minimum acceptable protocl version. If zero, the
1444 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1445 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001446
Adam Langleyb4a494c2015-01-23 15:10:10 -08001447 struct ssl_cipher_preference_list_st *cipher_list;
1448 /* same as above but sorted for lookup */
1449 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langleycef75832015-09-03 14:51:12 -07001450
1451 /* cipher_list_tls10 is the list of ciphers when TLS 1.0 or greater is in
1452 * use. This only applies to server connections as, for clients, the version
1453 * number is known at connect time and so the cipher list can be set then. If
1454 * |cipher_list_tls11| is non-NULL then this applies only to TLS 1.0
1455 * connections.
1456 *
1457 * TODO(agl): this exists to assist in the death of SSLv3. It can hopefully
1458 * be removed after that. */
1459 struct ssl_cipher_preference_list_st *cipher_list_tls10;
1460
Adam Langleyb4a494c2015-01-23 15:10:10 -08001461 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
1462 * use. This only applies to server connections as, for clients, the version
1463 * number is known at connect time and so the cipher list can be set then. */
1464 struct ssl_cipher_preference_list_st *cipher_list_tls11;
Adam Langley95c29f32014-06-20 12:00:00 -07001465
David Benjamin4dab2972015-05-16 02:56:06 -04001466 X509_STORE *cert_store;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001467 LHASH_OF(SSL_SESSION) *sessions;
1468 /* Most session-ids that will be cached, default is
1469 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
1470 unsigned long session_cache_size;
David Benjamin4dab2972015-05-16 02:56:06 -04001471 SSL_SESSION *session_cache_head;
1472 SSL_SESSION *session_cache_tail;
Adam Langley95c29f32014-06-20 12:00:00 -07001473
David Benjaminb6d0c6d2015-03-19 19:07:26 -04001474 /* handshakes_since_cache_flush is the number of successful handshakes since
1475 * the last cache flush. */
1476 int handshakes_since_cache_flush;
1477
Adam Langleyb4a494c2015-01-23 15:10:10 -08001478 /* This can have one of 2 values, ored together,
1479 * SSL_SESS_CACHE_CLIENT,
1480 * SSL_SESS_CACHE_SERVER,
1481 * Default is SSL_SESSION_CACHE_SERVER, which means only
1482 * SSL_accept which cache SSL_SESSIONS. */
1483 int session_cache_mode;
Adam Langley95c29f32014-06-20 12:00:00 -07001484
Adam Langleyb4a494c2015-01-23 15:10:10 -08001485 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
1486 * called. This has been put in to make life easier to set things up */
1487 long session_timeout;
Adam Langley95c29f32014-06-20 12:00:00 -07001488
Adam Langleyb4a494c2015-01-23 15:10:10 -08001489 /* If this callback is not null, it will be called each time a session id is
1490 * added to the cache. If this function returns 1, it means that the
1491 * callback will do a SSL_SESSION_free() when it has finished using it.
1492 * Otherwise, on 0, it means the callback has finished with it. If
1493 * remove_session_cb is not null, it will be called when a session-id is
1494 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
1495 * it. */
David Benjamin4dab2972015-05-16 02:56:06 -04001496 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
1497 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
1498 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001499 int *copy);
Adam Langley95c29f32014-06-20 12:00:00 -07001500
Adam Langley0b5e3902015-05-15 13:08:38 -07001501 CRYPTO_refcount_t references;
Adam Langley95c29f32014-06-20 12:00:00 -07001502
Adam Langleyb4a494c2015-01-23 15:10:10 -08001503 /* if defined, these override the X509_verify_cert() calls */
1504 int (*app_verify_callback)(X509_STORE_CTX *, void *);
1505 void *app_verify_arg;
1506 /* before OpenSSL 0.9.7, 'app_verify_arg' was ignored ('app_verify_callback'
1507 * was called with just one argument) */
Adam Langley95c29f32014-06-20 12:00:00 -07001508
Adam Langleyb4a494c2015-01-23 15:10:10 -08001509 /* Default password callback. */
1510 pem_password_cb *default_passwd_callback;
Adam Langley95c29f32014-06-20 12:00:00 -07001511
Adam Langleyb4a494c2015-01-23 15:10:10 -08001512 /* Default password callback user data. */
1513 void *default_passwd_callback_userdata;
Adam Langley95c29f32014-06-20 12:00:00 -07001514
Adam Langleyb4a494c2015-01-23 15:10:10 -08001515 /* get client cert callback */
1516 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey);
Adam Langley95c29f32014-06-20 12:00:00 -07001517
Adam Langleyb4a494c2015-01-23 15:10:10 -08001518 /* get channel id callback */
1519 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey);
Adam Langley1258b6a2014-06-20 12:00:00 -07001520
Adam Langleyb4a494c2015-01-23 15:10:10 -08001521 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001522
Adam Langley09505632015-07-30 18:10:13 -07001523 /* custom_*_extensions stores any callback sets for custom extensions. Note
1524 * that these pointers will be NULL if the stack would otherwise be empty. */
1525 STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
1526 STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
Adam Langley95c29f32014-06-20 12:00:00 -07001527
Adam Langleyb4a494c2015-01-23 15:10:10 -08001528 /* Default values used when no per-SSL value is defined follow */
Adam Langley95c29f32014-06-20 12:00:00 -07001529
Adam Langleyb4a494c2015-01-23 15:10:10 -08001530 void (*info_callback)(const SSL *ssl, int type,
1531 int val); /* used if SSL's info_callback is NULL */
Adam Langley95c29f32014-06-20 12:00:00 -07001532
Adam Langleyb4a494c2015-01-23 15:10:10 -08001533 /* what we put in client cert requests */
1534 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001535
1536
Adam Langleyb4a494c2015-01-23 15:10:10 -08001537 /* Default values to use in SSL structures follow (these are copied by
1538 * SSL_new) */
Adam Langley95c29f32014-06-20 12:00:00 -07001539
David Benjamin123a8fd2015-04-26 14:16:41 -04001540 uint32_t options;
1541 uint32_t mode;
David Benjamin1d0a1942015-04-26 15:35:35 -04001542 uint32_t max_cert_list;
Adam Langley95c29f32014-06-20 12:00:00 -07001543
Adam Langleyb4a494c2015-01-23 15:10:10 -08001544 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001545
Adam Langleyb4a494c2015-01-23 15:10:10 -08001546 /* callback that allows applications to peek at protocol messages */
1547 void (*msg_callback)(int write_p, int version, int content_type,
1548 const void *buf, size_t len, SSL *ssl, void *arg);
1549 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001550
Adam Langleyb4a494c2015-01-23 15:10:10 -08001551 int verify_mode;
1552 unsigned int sid_ctx_length;
1553 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1554 int (*default_verify_callback)(
1555 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
Adam Langley95c29f32014-06-20 12:00:00 -07001556
Adam Langleyb4a494c2015-01-23 15:10:10 -08001557 /* Default generate session ID callback. */
1558 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001559
Adam Langleyb4a494c2015-01-23 15:10:10 -08001560 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001561
Adam Langleyb4a494c2015-01-23 15:10:10 -08001562 /* select_certificate_cb is called before most ClientHello processing and
1563 * before the decision whether to resume a session is made. It may return one
1564 * to continue the handshake or zero to cause the handshake loop to return
1565 * with an error and cause SSL_get_error to return
David Benjamin6f5c0f42015-02-24 01:23:21 -05001566 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
1567 * will not call the callback a second time. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001568 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
Adam Langleydc9b1412014-06-20 12:00:00 -07001569
Adam Langley524e7172015-02-20 16:04:00 -08001570 /* dos_protection_cb is called once the resumption decision for a ClientHello
1571 * has been made. It returns one to continue the handshake or zero to
1572 * abort. */
1573 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
1574
Adam Langleyb4a494c2015-01-23 15:10:10 -08001575 /* quiet_shutdown is true if the connection should not send a close_notify on
1576 * shutdown. */
1577 int quiet_shutdown;
Adam Langley95c29f32014-06-20 12:00:00 -07001578
Adam Langleyb4a494c2015-01-23 15:10:10 -08001579 /* Maximum amount of data to send in one fragment. actual record size can be
1580 * more than this due to padding and MAC overheads. */
David Benjamin1d0a1942015-04-26 15:35:35 -04001581 uint16_t max_send_fragment;
Adam Langley95c29f32014-06-20 12:00:00 -07001582
Adam Langleyb4a494c2015-01-23 15:10:10 -08001583 /* TLS extensions servername callback */
1584 int (*tlsext_servername_callback)(SSL *, int *, void *);
1585 void *tlsext_servername_arg;
1586 /* RFC 4507 session ticket keys */
David Benjamine3aa1d92015-06-16 15:34:50 -04001587 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
Adam Langleyb4a494c2015-01-23 15:10:10 -08001588 uint8_t tlsext_tick_hmac_key[16];
1589 uint8_t tlsext_tick_aes_key[16];
1590 /* Callback to support customisation of ticket key setting */
1591 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
1592 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
Adam Langley95c29f32014-06-20 12:00:00 -07001593
Adam Langleyb4a494c2015-01-23 15:10:10 -08001594 /* Server-only: psk_identity_hint is the default identity hint to send in
1595 * PSK-based key exchanges. */
1596 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001597
Adam Langleyb4a494c2015-01-23 15:10:10 -08001598 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1599 char *identity,
1600 unsigned int max_identity_len,
1601 uint8_t *psk, unsigned int max_psk_len);
1602 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1603 uint8_t *psk, unsigned int max_psk_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001604
Alex Chernyakhovskya40c8622014-08-03 15:46:36 -04001605
Adam Langleyb4a494c2015-01-23 15:10:10 -08001606 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
1607 * hash of the peer's certifiate and then discard it to save memory and
1608 * session space. Only effective on the server side. */
1609 char retain_only_sha256_of_client_certs;
Adam Langley95c29f32014-06-20 12:00:00 -07001610
Adam Langleyb4a494c2015-01-23 15:10:10 -08001611 /* Next protocol negotiation information */
1612 /* (for experimental NPN extension). */
Adam Langley95c29f32014-06-20 12:00:00 -07001613
Adam Langleyb4a494c2015-01-23 15:10:10 -08001614 /* For a server, this contains a callback function by which the set of
1615 * advertised protocols can be provided. */
1616 int (*next_protos_advertised_cb)(SSL *s, const uint8_t **buf,
1617 unsigned int *len, void *arg);
1618 void *next_protos_advertised_cb_arg;
1619 /* For a client, this contains a callback function that selects the
1620 * next protocol from the list provided by the server. */
1621 int (*next_proto_select_cb)(SSL *s, uint8_t **out, uint8_t *outlen,
1622 const uint8_t *in, unsigned int inlen, void *arg);
1623 void *next_proto_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001624
Adam Langleyb4a494c2015-01-23 15:10:10 -08001625 /* ALPN information
1626 * (we are in the process of transitioning from NPN to ALPN.) */
Adam Langley95c29f32014-06-20 12:00:00 -07001627
Adam Langleyb4a494c2015-01-23 15:10:10 -08001628 /* For a server, this contains a callback function that allows the
1629 * server to select the protocol for the connection.
1630 * out: on successful return, this must point to the raw protocol
1631 * name (without the length prefix).
1632 * outlen: on successful return, this contains the length of |*out|.
1633 * in: points to the client's list of supported protocols in
1634 * wire-format.
1635 * inlen: the length of |in|. */
1636 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *outlen,
1637 const uint8_t *in, unsigned int inlen, void *arg);
1638 void *alpn_select_cb_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001639
Adam Langleyb4a494c2015-01-23 15:10:10 -08001640 /* For a client, this contains the list of supported protocols in wire
1641 * format. */
1642 uint8_t *alpn_client_proto_list;
1643 unsigned alpn_client_proto_list_len;
Adam Langley95c29f32014-06-20 12:00:00 -07001644
Adam Langleyb4a494c2015-01-23 15:10:10 -08001645 /* SRTP profiles we are willing to do from RFC 5764 */
1646 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07001647
Adam Langleyb4a494c2015-01-23 15:10:10 -08001648 /* EC extension values inherited by SSL structure */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001649 size_t tlsext_ellipticcurvelist_length;
1650 uint16_t *tlsext_ellipticcurvelist;
Adam Langley1258b6a2014-06-20 12:00:00 -07001651
Adam Langleyb4a494c2015-01-23 15:10:10 -08001652 /* If true, a client will advertise the Channel ID extension and a server
1653 * will echo it. */
1654 char tlsext_channel_id_enabled;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001655 /* The client's Channel ID private key. */
1656 EVP_PKEY *tlsext_channel_id_private;
David Benjamin6c7aed02014-08-27 16:42:38 -04001657
Adam Langleyb4a494c2015-01-23 15:10:10 -08001658 /* If true, a client will request certificate timestamps. */
1659 char signed_cert_timestamps_enabled;
David Benjamin859ec3c2014-09-02 16:29:36 -04001660
Paul Lietar4fac72e2015-09-09 13:44:55 +01001661 /* Signed certificate timestamp list to be sent to the client, if requested */
1662 uint8_t *signed_cert_timestamp_list;
1663 size_t signed_cert_timestamp_list_length;
1664
Adam Langleyb4a494c2015-01-23 15:10:10 -08001665 /* If true, a client will request a stapled OCSP response. */
1666 char ocsp_stapling_enabled;
Adam Langley95c29f32014-06-20 12:00:00 -07001667
Paul Lietaraeeff2c2015-08-12 11:47:11 +01001668 /* OCSP response to be sent to the client, if requested. */
1669 uint8_t *ocsp_response;
1670 size_t ocsp_response_length;
1671
Adam Langleyb4a494c2015-01-23 15:10:10 -08001672 /* If not NULL, session key material will be logged to this BIO for debugging
1673 * purposes. The format matches NSS's and is readable by Wireshark. */
1674 BIO *keylog_bio;
David Benjamin377fc312015-01-26 00:22:12 -05001675
1676 /* current_time_cb, if not NULL, is the function to use to get the current
1677 * time. It sets |*out_clock| to the current time. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04001678 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001679};
Adam Langley95c29f32014-06-20 12:00:00 -07001680
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001681OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
David Benjamin71f7d3d2015-05-05 09:46:38 -04001682
1683/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1684 * session cache. */
1685OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
David Benjaminda881e92015-04-26 14:45:04 -04001686
Adam Langleyb4a494c2015-01-23 15:10:10 -08001687OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
David Benjamin4dab2972015-05-16 02:56:06 -04001688 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess));
1689OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001690 SSL_SESSION *sess);
1691OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1692 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001693 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess));
Adam Langleyb4a494c2015-01-23 15:10:10 -08001694OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001695 SSL_CTX *ctx, SSL_SESSION *sess);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001696OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1697 SSL_CTX *ctx,
David Benjamin4dab2972015-05-16 02:56:06 -04001698 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001699 int *copy));
1700OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
David Benjamin4dab2972015-05-16 02:56:06 -04001701 SSL *ssl, uint8_t *data, int len, int *copy);
David Benjamin3c1ccc02015-09-13 00:27:05 -04001702/* SSL_magic_pending_session_ptr returns a magic |SSL_SESSION|* which indicates
1703 * that the session isn't currently unavailable. |SSL_get_error| will then
1704 * return |SSL_ERROR_PENDING_SESSION| and the handshake can be retried later
1705 * when the lookup has completed. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001706OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08001707OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
1708 void (*cb)(const SSL *ssl,
1709 int type, int val));
1710OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
1711 int type,
1712 int val);
1713OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
1714 SSL_CTX *ctx,
1715 int (*client_cert_cb)(SSL *ssl, X509 **x509, EVP_PKEY **pkey));
1716OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(SSL *ssl,
1717 X509 **x509,
1718 EVP_PKEY **pkey);
1719OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
1720 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **pkey));
1721OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(SSL *ssl,
1722 EVP_PKEY **pkey);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001723
Adam Langleyb4a494c2015-01-23 15:10:10 -08001724/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1725 * of a connection) to request SCTs from the server. See
David Benjamin3b7456e2015-05-16 12:29:32 -04001726 * https://tools.ietf.org/html/rfc6962. It returns one. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001727OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1728
Adam Langleyb4a494c2015-01-23 15:10:10 -08001729/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1730 * objects created from |ctx|. */
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001731OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1732
David Benjamin3b7456e2015-05-16 12:29:32 -04001733/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1734 * connection) to request a stapled OCSP response from the server. It returns
1735 * one. */
David Benjamin6c7aed02014-08-27 16:42:38 -04001736OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1737
1738/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1739 * created from |ctx|. */
1740OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1741
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001742/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1743 * |*out_len| bytes of SCT information from the server. This is only valid if
1744 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1745 * (including the two leading length bytes).
1746 * See https://tools.ietf.org/html/rfc6962#section-3.3
1747 * If no SCT was received then |*out_len| will be zero on return.
1748 *
1749 * WARNING: the returned data is not guaranteed to be well formed. */
David Benjamin52d699f2014-11-25 01:35:18 -05001750OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001751 const uint8_t **out,
1752 size_t *out_len);
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02001753
David Benjamin6c7aed02014-08-27 16:42:38 -04001754/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1755 * bytes of an OCSP response from the server. This is the DER encoding of an
1756 * OCSPResponse type as defined in RFC 2560.
1757 *
1758 * WARNING: the returned data is not guaranteed to be well formed. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001759OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1760 size_t *out_len);
David Benjamin6c7aed02014-08-27 16:42:38 -04001761
Adam Langleyb4a494c2015-01-23 15:10:10 -08001762OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
1763 SSL_CTX *s,
1764 int (*cb)(SSL *ssl, const uint8_t **out, unsigned int *outlen, void *arg),
1765 void *arg);
1766OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
1767 SSL_CTX *s, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *outlen,
1768 const uint8_t *in, unsigned int inlen, void *arg),
1769 void *arg);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001770OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *s,
Adam Langleyb4a494c2015-01-23 15:10:10 -08001771 const uint8_t **data,
1772 unsigned *len);
Adam Langley95c29f32014-06-20 12:00:00 -07001773
Adam Langleyb4a494c2015-01-23 15:10:10 -08001774OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *outlen,
1775 const uint8_t *in, unsigned int inlen,
1776 const uint8_t *client,
1777 unsigned int client_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001778
Adam Langleyb4a494c2015-01-23 15:10:10 -08001779#define OPENSSL_NPN_UNSUPPORTED 0
1780#define OPENSSL_NPN_NEGOTIATED 1
1781#define OPENSSL_NPN_NO_OVERLAP 2
Adam Langley95c29f32014-06-20 12:00:00 -07001782
David Benjamin9d0847a2015-02-16 03:57:55 -05001783/* SSL_CTX_set_alpn_protos sets the ALPN protocol list on |ctx| to |protos|.
1784 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1785 * length-prefixed strings). It returns zero on success and one on failure.
1786 *
1787 * WARNING: this function is dangerous because it breaks the usual return value
1788 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001789OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
1790 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001791
1792/* SSL_set_alpn_protos sets the ALPN protocol list on |ssl| to |protos|.
1793 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
1794 * length-prefixed strings). It returns zero on success and one on failure.
1795 *
1796 * WARNING: this function is dangerous because it breaks the usual return value
1797 * convention. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001798OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
1799 unsigned protos_len);
David Benjamin9d0847a2015-02-16 03:57:55 -05001800
Adam Langleyb4a494c2015-01-23 15:10:10 -08001801OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
1802 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *outlen,
1803 const uint8_t *in, unsigned int inlen, void *arg),
1804 void *arg);
1805OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, const uint8_t **data,
1806 unsigned *len);
Feng Lu41aa3252014-11-21 22:47:56 -08001807
David Benjaminb16346b2015-04-08 19:16:58 -04001808/* SSL_set_reject_peer_renegotiations controls whether renegotiation attempts by
1809 * the peer are rejected. It may be set at any point in a connection's lifetime
David Benjamin897e5e02015-05-12 17:03:54 -04001810 * to control future renegotiations programmatically. By default, renegotiations
David Benjamin44d3eed2015-05-21 01:29:55 -04001811 * are rejected. (Renegotiations requested by a client are always rejected.) */
David Benjaminb16346b2015-04-08 19:16:58 -04001812OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
1813
Adam Langleyb4a494c2015-01-23 15:10:10 -08001814/* the maximum length of the buffer given to callbacks containing the resulting
1815 * identity/psk */
Adam Langley95c29f32014-06-20 12:00:00 -07001816#define PSK_MAX_IDENTITY_LEN 128
1817#define PSK_MAX_PSK_LEN 256
Adam Langleyb4a494c2015-01-23 15:10:10 -08001818OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
1819 SSL_CTX *ctx,
1820 unsigned int (*psk_client_callback)(
1821 SSL *ssl, const char *hint, char *identity,
1822 unsigned int max_identity_len, uint8_t *psk, unsigned int max_psk_len));
1823OPENSSL_EXPORT void SSL_set_psk_client_callback(
1824 SSL *ssl, unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1825 char *identity,
1826 unsigned int max_identity_len,
1827 uint8_t *psk,
1828 unsigned int max_psk_len));
1829OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
1830 SSL_CTX *ctx,
1831 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1832 uint8_t *psk,
1833 unsigned int max_psk_len));
1834OPENSSL_EXPORT void SSL_set_psk_server_callback(
1835 SSL *ssl,
1836 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1837 uint8_t *psk,
1838 unsigned int max_psk_len));
1839OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
1840 const char *identity_hint);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07001841OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *s, const char *identity_hint);
1842OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *s);
1843OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07001844
Adam Langleyb4a494c2015-01-23 15:10:10 -08001845#define SSL_NOTHING 1
1846#define SSL_WRITING 2
1847#define SSL_READING 3
1848#define SSL_X509_LOOKUP 4
1849#define SSL_CHANNEL_ID_LOOKUP 5
1850#define SSL_PENDING_SESSION 7
1851#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04001852#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07001853
1854/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08001855#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
1856#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
1857#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
1858#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
1859#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
1860#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
1861#define SSL_want_certificate(s) \
1862 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04001863#define SSL_want_private_key_operation(s) \
1864 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07001865
Adam Langleyb4a494c2015-01-23 15:10:10 -08001866struct ssl_st {
1867 /* version is the protocol version. */
1868 int version;
Adam Langley95c29f32014-06-20 12:00:00 -07001869
Adam Langleyb4a494c2015-01-23 15:10:10 -08001870 /* method is the method table corresponding to the current protocol (DTLS or
1871 * TLS). */
1872 const SSL_PROTOCOL_METHOD *method;
Adam Langley95c29f32014-06-20 12:00:00 -07001873
Adam Langleyb4a494c2015-01-23 15:10:10 -08001874 /* enc_method is the method table corresponding to the current protocol
1875 * version. */
1876 const SSL3_ENC_METHOD *enc_method;
David Benjamine99e9122014-12-11 01:46:01 -05001877
Adam Langleyb4a494c2015-01-23 15:10:10 -08001878 /* max_version is the maximum acceptable protocol version. If zero, the
1879 * maximum supported version, currently (D)TLS 1.2, is used. */
1880 uint16_t max_version;
Adam Langley95c29f32014-06-20 12:00:00 -07001881
Adam Langleyb4a494c2015-01-23 15:10:10 -08001882 /* min_version is the minimum acceptable protocl version. If zero, the
1883 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
1884 uint16_t min_version;
David Benjamin1eb367c2014-12-12 18:17:51 -05001885
Adam Langleyb4a494c2015-01-23 15:10:10 -08001886 /* There are 2 BIO's even though they are normally both the same. This is so
1887 * data can be read and written to different handlers */
David Benjamin1eb367c2014-12-12 18:17:51 -05001888
Adam Langleyb4a494c2015-01-23 15:10:10 -08001889 BIO *rbio; /* used by SSL_read */
1890 BIO *wbio; /* used by SSL_write */
1891 BIO *bbio; /* used during session-id reuse to concatenate
1892 * messages */
Adam Langley95c29f32014-06-20 12:00:00 -07001893
Adam Langleyb4a494c2015-01-23 15:10:10 -08001894 /* This holds a variable that indicates what we were doing when a 0 or -1 is
1895 * returned. This is needed for non-blocking IO so we know what request
1896 * needs re-doing when in SSL_accept or SSL_connect */
1897 int rwstate;
David Benjamin95f9cfc2014-11-23 00:19:49 -05001898
Adam Langleyb4a494c2015-01-23 15:10:10 -08001899 /* true when we are actually in SSL_accept() or SSL_connect() */
1900 int in_handshake;
1901 int (*handshake_func)(SSL *);
Adam Langley95c29f32014-06-20 12:00:00 -07001902
Adam Langleyb4a494c2015-01-23 15:10:10 -08001903 /* Imagine that here's a boolean member "init" that is switched as soon as
1904 * SSL_set_{accept/connect}_state is called for the first time, so that
1905 * "state" and "handshake_func" are properly initialized. But as
1906 * handshake_func is == 0 until then, we use this test instead of an "init"
1907 * member. */
Adam Langley95c29f32014-06-20 12:00:00 -07001908
Adam Langleyb4a494c2015-01-23 15:10:10 -08001909 /* server is true iff the this SSL* is the server half. Note: before the SSL*
1910 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
1911 * the side is not determined. In this state, server is always false. */
1912 int server;
Adam Langley95c29f32014-06-20 12:00:00 -07001913
Adam Langleyb4a494c2015-01-23 15:10:10 -08001914 /* quiet_shutdown is true if the connection should not send a close_notify on
1915 * shutdown. */
1916 int quiet_shutdown;
David Benjamin7e237462014-12-11 18:13:28 -05001917
Adam Langleyb4a494c2015-01-23 15:10:10 -08001918 int shutdown; /* we have shut things down, 0x01 sent, 0x02
1919 * for received */
1920 int state; /* where we are */
Adam Langley95c29f32014-06-20 12:00:00 -07001921
Adam Langleyb4a494c2015-01-23 15:10:10 -08001922 BUF_MEM *init_buf; /* buffer used during init */
1923 uint8_t *init_msg; /* pointer to handshake message body, set by
1924 ssl3_get_message() */
1925 int init_num; /* amount read/written */
1926 int init_off; /* amount read/written */
Adam Langley95c29f32014-06-20 12:00:00 -07001927
Adam Langleyb4a494c2015-01-23 15:10:10 -08001928 struct ssl3_state_st *s3; /* SSLv3 variables */
1929 struct dtls1_state_st *d1; /* DTLSv1 variables */
Adam Langley95c29f32014-06-20 12:00:00 -07001930
Adam Langleyb4a494c2015-01-23 15:10:10 -08001931 /* callback that allows applications to peek at protocol messages */
1932 void (*msg_callback)(int write_p, int version, int content_type,
1933 const void *buf, size_t len, SSL *ssl, void *arg);
1934 void *msg_callback_arg;
Adam Langley95c29f32014-06-20 12:00:00 -07001935
Adam Langleyb4a494c2015-01-23 15:10:10 -08001936 int hit; /* reusing a previous session */
Adam Langley95c29f32014-06-20 12:00:00 -07001937
Adam Langleyb4a494c2015-01-23 15:10:10 -08001938 X509_VERIFY_PARAM *param;
Adam Langley95c29f32014-06-20 12:00:00 -07001939
Adam Langleyb4a494c2015-01-23 15:10:10 -08001940 /* crypto */
1941 struct ssl_cipher_preference_list_st *cipher_list;
1942 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001943
Adam Langleyb4a494c2015-01-23 15:10:10 -08001944 SSL_AEAD_CTX *aead_read_ctx;
1945 SSL_AEAD_CTX *aead_write_ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001946
Adam Langleyb4a494c2015-01-23 15:10:10 -08001947 /* session info */
Adam Langley95c29f32014-06-20 12:00:00 -07001948
Adam Langleyb4a494c2015-01-23 15:10:10 -08001949 /* client cert? */
1950 /* This is used to hold the server certificate used */
1951 struct cert_st /* CERT */ *cert;
Adam Langley95c29f32014-06-20 12:00:00 -07001952
Adam Langleyb4a494c2015-01-23 15:10:10 -08001953 /* the session_id_context is used to ensure sessions are only reused
1954 * in the appropriate context */
1955 unsigned int sid_ctx_length;
1956 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
Adam Langley95c29f32014-06-20 12:00:00 -07001957
Adam Langleyb4a494c2015-01-23 15:10:10 -08001958 /* This can also be in the session once a session is established */
1959 SSL_SESSION *session;
Adam Langley95c29f32014-06-20 12:00:00 -07001960
Adam Langleyb4a494c2015-01-23 15:10:10 -08001961 /* Default generate session ID callback. */
1962 GEN_SESSION_CB generate_session_id;
Adam Langley95c29f32014-06-20 12:00:00 -07001963
Adam Langleyb4a494c2015-01-23 15:10:10 -08001964 /* Used in SSL2 and SSL3 */
1965 int verify_mode; /* 0 don't care about verify failure.
1966 * 1 fail if verify fails */
1967 int (*verify_callback)(int ok,
1968 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
Adam Langley95c29f32014-06-20 12:00:00 -07001969
Adam Langleyb4a494c2015-01-23 15:10:10 -08001970 void (*info_callback)(const SSL *ssl, int type,
1971 int val); /* optional informational callback */
Adam Langley95c29f32014-06-20 12:00:00 -07001972
Adam Langleyb4a494c2015-01-23 15:10:10 -08001973 /* Server-only: psk_identity_hint is the identity hint to send in
1974 * PSK-based key exchanges. */
1975 char *psk_identity_hint;
Adam Langley95c29f32014-06-20 12:00:00 -07001976
Adam Langleyb4a494c2015-01-23 15:10:10 -08001977 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
1978 char *identity,
1979 unsigned int max_identity_len,
1980 uint8_t *psk, unsigned int max_psk_len);
1981 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
1982 uint8_t *psk, unsigned int max_psk_len);
David Benjamin688d8df2014-11-02 23:06:42 -05001983
Adam Langleyb4a494c2015-01-23 15:10:10 -08001984 SSL_CTX *ctx;
Adam Langley95c29f32014-06-20 12:00:00 -07001985
Adam Langleyb4a494c2015-01-23 15:10:10 -08001986 /* extra application data */
1987 long verify_result;
1988 CRYPTO_EX_DATA ex_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001989
Adam Langleyb4a494c2015-01-23 15:10:10 -08001990 /* for server side, keep the list of CA_dn we can use */
1991 STACK_OF(X509_NAME) *client_CA;
Adam Langley95c29f32014-06-20 12:00:00 -07001992
David Benjamin123a8fd2015-04-26 14:16:41 -04001993 uint32_t options; /* protocol behaviour */
1994 uint32_t mode; /* API behaviour */
David Benjamin1d0a1942015-04-26 15:35:35 -04001995 uint32_t max_cert_list;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001996 int client_version; /* what was passed, used for
1997 * SSLv3/TLS rollback check */
David Benjamin1d0a1942015-04-26 15:35:35 -04001998 uint16_t max_send_fragment;
Adam Langleyb4a494c2015-01-23 15:10:10 -08001999 char *tlsext_hostname;
Adam Langleyb4a494c2015-01-23 15:10:10 -08002000 /* RFC4507 session ticket expected to be received or sent */
2001 int tlsext_ticket_expected;
Adam Langleyb4a494c2015-01-23 15:10:10 -08002002 size_t tlsext_ellipticcurvelist_length;
2003 uint16_t *tlsext_ellipticcurvelist; /* our list */
Adam Langley95c29f32014-06-20 12:00:00 -07002004
Adam Langleyb4a494c2015-01-23 15:10:10 -08002005 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
Adam Langley95c29f32014-06-20 12:00:00 -07002006
Adam Langleyb4a494c2015-01-23 15:10:10 -08002007 /* Next protocol negotiation. For the client, this is the protocol that we
2008 * sent in NextProtocol and is set when handling ServerHello extensions.
2009 *
2010 * For a server, this is the client's selected_protocol from NextProtocol and
2011 * is set when handling the NextProtocol message, before the Finished
2012 * message. */
2013 uint8_t *next_proto_negotiated;
2014 size_t next_proto_negotiated_len;
Adam Langley95c29f32014-06-20 12:00:00 -07002015
Adam Langleyb4a494c2015-01-23 15:10:10 -08002016 /* srtp_profiles is the list of configured SRTP protection profiles for
2017 * DTLS-SRTP. */
2018 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
Adam Langley95c29f32014-06-20 12:00:00 -07002019
Adam Langleyb4a494c2015-01-23 15:10:10 -08002020 /* srtp_profile is the selected SRTP protection profile for
2021 * DTLS-SRTP. */
2022 const SRTP_PROTECTION_PROFILE *srtp_profile;
David Benjaminbc44c082015-01-01 15:02:11 -05002023
Adam Langleyb4a494c2015-01-23 15:10:10 -08002024 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
2025 * from clients. For a client, means that we'll advertise support. */
2026 char tlsext_channel_id_enabled;
2027 /* The client's Channel ID private key. */
2028 EVP_PKEY *tlsext_channel_id_private;
Adam Langley95c29f32014-06-20 12:00:00 -07002029
Adam Langleyb4a494c2015-01-23 15:10:10 -08002030 /* Enable signed certificate time stamps. Currently client only. */
2031 char signed_cert_timestamps_enabled;
Adam Langley1258b6a2014-06-20 12:00:00 -07002032
Paul Lietaraeeff2c2015-08-12 11:47:11 +01002033 /* ocsp_stapling_enabled is only used by client connections and indicates
2034 * whether OCSP stapling will be requested. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002035 char ocsp_stapling_enabled;
HÃ¥vard Molland9169c962014-08-14 14:42:37 +02002036
Adam Langleyb4a494c2015-01-23 15:10:10 -08002037 /* For a client, this contains the list of supported protocols in wire
2038 * format. */
2039 uint8_t *alpn_client_proto_list;
2040 unsigned alpn_client_proto_list_len;
David Benjamin6c7aed02014-08-27 16:42:38 -04002041
David Benjamin897e5e02015-05-12 17:03:54 -04002042 /* accept_peer_renegotiations, if one, accepts renegotiation attempts from the
2043 * peer. Otherwise, they will be rejected with a fatal error. */
2044 char accept_peer_renegotiations;
David Benjaminb16346b2015-04-08 19:16:58 -04002045
Adam Langleyb4a494c2015-01-23 15:10:10 -08002046 /* These fields are always NULL and exist only to keep wpa_supplicant happy
2047 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
2048 * don't support. */
2049 EVP_CIPHER_CTX *enc_read_ctx;
2050 EVP_MD_CTX *read_hash;
2051};
Adam Langley95c29f32014-06-20 12:00:00 -07002052
Adam Langley95c29f32014-06-20 12:00:00 -07002053/* compatibility */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002054#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
2055#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
2056#define SSL_SESSION_set_app_data(s, a) \
2057 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
2058#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
2059#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
2060#define SSL_CTX_set_app_data(ctx, arg) \
2061 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
Adam Langley95c29f32014-06-20 12:00:00 -07002062
Adam Langleyb4a494c2015-01-23 15:10:10 -08002063/* The following are the possible values for ssl->state are are used to
2064 * indicate where we are up to in the SSL connection establishment. The macros
2065 * that follow are about the only things you should need to use and even then,
2066 * only when using non-blocking IO. It can also be useful to work out where you
2067 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07002068
Adam Langleyb4a494c2015-01-23 15:10:10 -08002069#define SSL_ST_CONNECT 0x1000
2070#define SSL_ST_ACCEPT 0x2000
2071#define SSL_ST_MASK 0x0FFF
2072#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08002073#define SSL_ST_OK 0x03
2074#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07002075
Adam Langleyb4a494c2015-01-23 15:10:10 -08002076#define SSL_CB_LOOP 0x01
2077#define SSL_CB_EXIT 0x02
2078#define SSL_CB_READ 0x04
2079#define SSL_CB_WRITE 0x08
2080#define SSL_CB_ALERT 0x4000 /* used in callback */
2081#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
2082#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
2083#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
2084#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
2085#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
2086#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
2087#define SSL_CB_HANDSHAKE_START 0x10
2088#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07002089
2090/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002091#define SSL_get_state(a) SSL_state(a)
2092#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05002093#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08002094#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
2095#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05002096
David Benjamined7c4752015-02-16 19:16:46 -05002097/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
2098 * is in False Start. |SSL_write| may be called at this point without waiting
2099 * for the peer, but |SSL_read| will require the handshake to be completed. */
2100OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
2101
Adam Langley95c29f32014-06-20 12:00:00 -07002102/* Obtain latest Finished message
2103 * -- that we sent (SSL_get_finished)
2104 * -- that we expected from peer (SSL_get_peer_finished).
2105 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002106OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
2107OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07002108
Adam Langley509e5ed2014-06-20 12:00:00 -07002109/* use either SSL_VERIFY_NONE or SSL_VERIFY_PEER, the last 3 options
Adam Langley95c29f32014-06-20 12:00:00 -07002110 * are 'ored' with SSL_VERIFY_PEER if they are desired */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002111#define SSL_VERIFY_NONE 0x00
2112#define SSL_VERIFY_PEER 0x01
2113#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
David Benjamin5aea93e2015-05-26 16:33:02 -04002114/* SSL_VERIFY_CLIENT_ONCE does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002115#define SSL_VERIFY_CLIENT_ONCE 0x04
2116#define SSL_VERIFY_PEER_IF_NO_OBC 0x08
Adam Langley95c29f32014-06-20 12:00:00 -07002117
Adam Langleyb4a494c2015-01-23 15:10:10 -08002118#define OpenSSL_add_ssl_algorithms() SSL_library_init()
2119#define SSLeay_add_ssl_algorithms() SSL_library_init()
Adam Langley95c29f32014-06-20 12:00:00 -07002120
Adam Langleyb4a494c2015-01-23 15:10:10 -08002121/* For backward compatibility */
2122#define SSL_get_cipher(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
2123#define SSL_get_cipher_bits(s, np) \
2124 SSL_CIPHER_get_bits(SSL_get_current_cipher(s), np)
Adam Langley95c29f32014-06-20 12:00:00 -07002125#define SSL_get_cipher_version(s) \
Adam Langleyb4a494c2015-01-23 15:10:10 -08002126 SSL_CIPHER_get_version(SSL_get_current_cipher(s))
2127#define SSL_get_cipher_name(s) SSL_CIPHER_get_name(SSL_get_current_cipher(s))
2128#define SSL_get_time(a) SSL_SESSION_get_time(a)
2129#define SSL_set_time(a, b) SSL_SESSION_set_time((a), (b))
2130#define SSL_get_timeout(a) SSL_SESSION_get_timeout(a)
2131#define SSL_set_timeout(a, b) SSL_SESSION_set_timeout((a), (b))
Adam Langley95c29f32014-06-20 12:00:00 -07002132
Adam Langleyb4a494c2015-01-23 15:10:10 -08002133#define d2i_SSL_SESSION_bio(bp, s_id) \
2134 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
2135#define i2d_SSL_SESSION_bio(bp, s_id) \
2136 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07002137
2138DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
2139
Adam Langleyb4a494c2015-01-23 15:10:10 -08002140/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
2141 * This value must be kept in sync with reservedReasonCode in make_errors.h */
2142#define SSL_AD_REASON_OFFSET \
2143 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07002144
2145/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002146#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
2147#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
2148#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
2149#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
2150#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
2151#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
2152#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
2153#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
2154#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
2155#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
2156#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
2157#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
2158#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
2159#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
2160#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
2161#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
2162#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
2163#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
2164#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
2165#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
2166#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
2167#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
2168#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
2169#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
2170#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07002171#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08002172#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
2173#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
2174 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07002175#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08002176#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
2177#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07002178
David Benjamin377fc312015-01-26 00:22:12 -05002179/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
David Benjamin8c249802015-05-05 09:44:18 -04002180 * timeout in progress, it sets |*out| to the time remaining and returns one.
2181 * Otherwise, it returns zero.
David Benjamin377fc312015-01-26 00:22:12 -05002182 *
2183 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
2184 * retransmit behavior.
2185 *
2186 * NOTE: This function must be queried again whenever the handshake state
2187 * machine changes, including when |DTLSv1_handle_timeout| is called. */
David Benjamin4d2e7ce2015-05-08 13:29:45 -04002188OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
David Benjamin377fc312015-01-26 00:22:12 -05002189
2190/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
2191 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
2192 * flight of handshake messages and returns 1. If too many timeouts had expired
2193 * without progress or an error occurs, it returns -1.
2194 *
2195 * NOTE: The caller's external timer should be compatible with the one |ssl|
2196 * queries within some fudge factor. Otherwise, the call will be a no-op, but
David Benjamin8c249802015-05-05 09:44:18 -04002197 * |DTLSv1_get_timeout| will return an updated timeout.
2198 *
2199 * WARNING: This function breaks the usual return value convention. */
2200OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002201
David Benjaminc0454692015-04-27 00:28:56 -04002202/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
2203 * and zero otherwise.
2204 *
2205 * TODO(davidben): Hammer down the semantics of this API while a handshake,
2206 * initial or renego, is in progress. */
2207OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002208
David Benjaminc0454692015-04-27 00:28:56 -04002209/* SSL_total_renegotiations returns the total number of renegotiation handshakes
2210 * peformed by |ssl|. This includes the pending renegotiation, if any. */
2211OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
2212
David Benjamin15a3b002015-04-28 00:05:35 -04002213/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
2214 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
2215 * one on success and zero on error. */
2216OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
David Benjamindd978782015-04-24 15:20:13 -04002217
David Benjamin15a3b002015-04-28 00:05:35 -04002218/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
2219 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
2220 * on success and zero on error. */
2221OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
Adam Langley95c29f32014-06-20 12:00:00 -07002222
David Benjamin15a3b002015-04-28 00:05:35 -04002223/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
2224 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
2225 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
2226 * error. If unset, an appropriate curve will be chosen automatically. (This is
2227 * recommended.) */
2228OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
David Benjamindd978782015-04-24 15:20:13 -04002229
David Benjamin15a3b002015-04-28 00:05:35 -04002230/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
2231 * for ephemeral ECDH keys. For historical reasons, this API expects an
2232 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
2233 * error. If unset, an appropriate curve will be chosen automatically. (This is
2234 * recommended.) */
2235OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
Adam Langley95c29f32014-06-20 12:00:00 -07002236
David Benjaminc2807582015-04-28 00:19:50 -04002237/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
2238 * client IDs from clients, or configures a client to send TLS client IDs to
2239 * a server. It returns one. */
2240OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
2241
Adam Langleyb4a494c2015-01-23 15:10:10 -08002242/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
2243 * client IDs from clients, or configure a client to send TLS client IDs to
David Benjaminc2807582015-04-28 00:19:50 -04002244 * server. It returns one. */
2245OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
2246
2247/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
2248 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
2249 * on success and zero on error. */
2250OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
2251 EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002252
Adam Langley1258b6a2014-06-20 12:00:00 -07002253/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
David Benjaminc2807582015-04-28 00:19:50 -04002254 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
2255 * success and zero on error. */
2256OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002257
Adam Langley1258b6a2014-06-20 12:00:00 -07002258/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server SSL*
David Benjaminc2807582015-04-28 00:19:50 -04002259 * and copies up to the first |max_out| bytes into |out|. The Channel ID
2260 * consists of the client's P-256 public key as an (x,y) pair where each is a
2261 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
2262 * Channel ID and the length of the complete Channel ID otherwise. */
2263OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
2264 size_t max_out);
Adam Langley1258b6a2014-06-20 12:00:00 -07002265
David Benjamin75910642015-08-09 10:42:33 -04002266/* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
2267 * containing the client certificate types requested by a server. It returns the
2268 * length of the array. */
2269OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
2270 const uint8_t **out_types);
2271
David Benjaminfdb4cdd2015-08-09 11:13:23 -04002272/* SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each
2273 * element of |curves| should be a curve nid. It returns one on success and
2274 * zero on failure. */
2275OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves,
2276 size_t curves_len);
2277
2278/* SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each
2279 * element of |curves| should be a curve nid. It returns one on success and
2280 * zero on failure. */
2281OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves,
2282 size_t curves_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002283
Adam Langleyb4a494c2015-01-23 15:10:10 -08002284OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *, const char *str);
Adam Langleycef75832015-09-03 14:51:12 -07002285OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls10(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002286OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002287OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long t);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002288OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
2289OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002290OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *, X509_STORE *);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002291OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002292
Adam Langleyb4a494c2015-01-23 15:10:10 -08002293OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long tm);
Adam Langley95c29f32014-06-20 12:00:00 -07002294
David Benjamina07c0fc2015-05-13 13:19:42 -04002295/* SSL_get_current_cipher returns the cipher used in the current outgoing
2296 * connection state, or NULL if the null cipher is active. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002297OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002298
Adam Langleyb4a494c2015-01-23 15:10:10 -08002299OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
2300OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
2301OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
2302OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *s, int n);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002303OPENSSL_EXPORT int SSL_pending(const SSL *s);
2304OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
2305OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
2306OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002307OPENSSL_EXPORT int SSL_set_cipher_list(SSL *s, const char *str);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002308OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *s);
2309OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *s);
2310OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *s))(int,
2311 X509_STORE_CTX *);
2312OPENSSL_EXPORT void SSL_set_verify(SSL *s, int mode,
2313 int (*callback)(int ok,
2314 X509_STORE_CTX *ctx));
2315OPENSSL_EXPORT void SSL_set_verify_depth(SSL *s, int depth);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002316OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002317OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *
2318 stackCAs,
2319 const char *file);
2320OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *
2321 stackCAs,
2322 const char *dir);
Adam Langley95c29f32014-06-20 12:00:00 -07002323
David Benjamin7ce1c0c2015-01-09 13:21:21 -05002324/* SSL_load_error_strings does nothing. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002325OPENSSL_EXPORT void SSL_load_error_strings(void);
David Benjamin7ce1c0c2015-01-09 13:21:21 -05002326
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002327OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002328OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002329OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *s);
2330OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *s, long t);
2331OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *s);
2332OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *s, long t);
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02002333
2334/* SSL_SESSION_get_key_exchange_info returns a value that describes the
2335 * strength of the asymmetric operation that provides confidentiality to
2336 * |session|. Its interpretation depends on the operation used. See the
2337 * documentation for this value in the |SSL_SESSION| structure. */
2338OPENSSL_EXPORT uint32_t SSL_SESSION_get_key_exchange_info(SSL_SESSION *session);
2339
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002340OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(SSL_SESSION *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002341OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *s,
2342 const uint8_t *sid_ctx,
2343 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002344
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002345OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002346OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *s,
2347 unsigned int *len);
2348OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
2349OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05002350
2351/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
2352 * of |session|. It then returns |session|. */
2353OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
2354
2355/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
2356 * zero, all data referenced by |session| and |session| itself are released. */
2357OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
2358
Adam Langleyb4a494c2015-01-23 15:10:10 -08002359OPENSSL_EXPORT int SSL_set_session(SSL *to, SSL_SESSION *session);
2360OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *s, SSL_SESSION *c);
2361OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *, SSL_SESSION *c);
2362OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *, GEN_SESSION_CB);
2363OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *, GEN_SESSION_CB);
2364OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
2365 const uint8_t *id,
2366 unsigned int id_len);
David Benjamin3cac4502014-10-21 01:46:30 -04002367
Adam Langleyb4a494c2015-01-23 15:10:10 -08002368/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
2369 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
2370 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
2371 * one on success and zero on error. */
David Benjamin3cac4502014-10-21 01:46:30 -04002372OPENSSL_EXPORT int SSL_SESSION_to_bytes(SSL_SESSION *in, uint8_t **out_data,
2373 size_t *out_len);
2374
David Benjamin95d31822015-06-15 19:53:32 -04002375/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
2376 * identification information, namely the session ID and ticket. */
David Benjamin3cac4502014-10-21 01:46:30 -04002377OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(SSL_SESSION *in,
2378 uint8_t **out_data,
2379 size_t *out_len);
2380
David Benjaminfd67aa82015-06-15 19:41:48 -04002381/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
2382 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
2383OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
2384 size_t in_len);
2385
David Benjamin26416e92015-08-22 16:04:17 -04002386/* SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the
2387 * peer did not use certificates. The caller must call |X509_free| on the
2388 * result to release it. */
2389OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002390
David Benjamin26416e92015-08-22 16:04:17 -04002391/* SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if
2392 * unavailable or the peer did not use certificates. For historical reasons,
2393 * this may not be available if resuming a serialized |SSL_SESSION|. The caller
2394 * does not take ownership of the result.
2395 *
2396 * WARNING: This function behaves differently between client and server. If
2397 * |ssl| is a server, the returned chain does not include the leaf certificate.
2398 * If a client, it does. */
2399OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002400
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002401OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
2402OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002403OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
2404 int, X509_STORE_CTX *);
2405OPENSSL_EXPORT void SSL_CTX_set_verify(SSL_CTX *ctx, int mode,
2406 int (*callback)(int, X509_STORE_CTX *));
2407OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
2408OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
2409 SSL_CTX *ctx, int (*cb)(X509_STORE_CTX *, void *), void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07002410
Adam Langleyb4a494c2015-01-23 15:10:10 -08002411OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
2412 pem_password_cb *cb);
2413OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
2414 void *u);
Adam Langley95c29f32014-06-20 12:00:00 -07002415
Adam Langleyb4a494c2015-01-23 15:10:10 -08002416OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
2417 const uint8_t *sid_ctx,
2418 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002419
Adam Langleyb4a494c2015-01-23 15:10:10 -08002420OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
2421 unsigned int sid_ctx_len);
Adam Langley95c29f32014-06-20 12:00:00 -07002422
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002423OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *s, int purpose);
2424OPENSSL_EXPORT int SSL_set_purpose(SSL *s, int purpose);
2425OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *s, int trust);
2426OPENSSL_EXPORT int SSL_set_trust(SSL *s, int trust);
Adam Langley95c29f32014-06-20 12:00:00 -07002427
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002428OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, X509_VERIFY_PARAM *vpm);
2429OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, X509_VERIFY_PARAM *vpm);
Adam Langley95c29f32014-06-20 12:00:00 -07002430
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002431OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
2432OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002433
Adam Langley0f4746e2014-08-13 12:26:32 -07002434/* SSL_get_version returns a string describing the TLS version used by |s|. For
2435 * example, "TLSv1.2" or "SSLv3". */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002436OPENSSL_EXPORT const char *SSL_get_version(const SSL *s);
Adam Langley0f4746e2014-08-13 12:26:32 -07002437/* SSL_SESSION_get_version returns a string describing the TLS version used by
2438 * |sess|. For example, "TLSv1.2" or "SSLv3". */
2439OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *sess);
Adam Langley95c29f32014-06-20 12:00:00 -07002440
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02002441/* SSL_get_curve_name returns a human-readable name for the elliptic curve
2442 * specified by the given TLS curve id, or NULL if the curve if unknown. */
2443OPENSSL_EXPORT const char* SSL_get_curve_name(uint16_t curve_id);
2444
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002445OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002446
David Benjamin44d3eed2015-05-21 01:29:55 -04002447/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2448 * renegotiation. */
2449OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2450
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002451OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2452OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2453OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2454OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002455
Adam Langleyb4a494c2015-01-23 15:10:10 -08002456OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *s,
2457 STACK_OF(X509_NAME) *name_list);
2458OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2459 STACK_OF(X509_NAME) *name_list);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002460OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002461OPENSSL_EXPORT STACK_OF(X509_NAME) *
2462 SSL_CTX_get_client_CA_list(const SSL_CTX *s);
2463OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x);
2464OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x);
Adam Langley95c29f32014-06-20 12:00:00 -07002465
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002466OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002467
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002468OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *sk);
Adam Langley95c29f32014-06-20 12:00:00 -07002469
Adam Langleyb4a494c2015-01-23 15:10:10 -08002470OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002471OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002472OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002473OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002474OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002475OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
2476OPENSSL_EXPORT int SSL_version(const SSL *ssl);
2477OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002478OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
2479 const char *CAfile,
2480 const char *CApath);
Adam Langley95c29f32014-06-20 12:00:00 -07002481#define SSL_get0_session SSL_get_session /* just peek at pointer */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002482OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002483OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(
2484 SSL *ssl); /* obtain a reference count */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002485OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002486OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002487OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002488 void (*cb)(const SSL *ssl, int type,
2489 int val));
2490OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2491 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002492OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002493
Adam Langleyb4a494c2015-01-23 15:10:10 -08002494OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long v);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002495OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002496
Adam Langleyb4a494c2015-01-23 15:10:10 -08002497OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2498OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2499OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2500 CRYPTO_EX_new *new_func,
2501 CRYPTO_EX_dup *dup_func,
2502 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002503
Adam Langleyb4a494c2015-01-23 15:10:10 -08002504OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *ss, int idx,
2505 void *data);
2506OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *ss, int idx);
2507OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2508 CRYPTO_EX_new *new_func,
2509 CRYPTO_EX_dup *dup_func,
2510 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002511
Adam Langleyb4a494c2015-01-23 15:10:10 -08002512OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ssl, int idx, void *data);
2513OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ssl, int idx);
2514OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2515 CRYPTO_EX_new *new_func,
2516 CRYPTO_EX_dup *dup_func,
2517 CRYPTO_EX_free *free_func);
Adam Langley95c29f32014-06-20 12:00:00 -07002518
Adam Langleyb4a494c2015-01-23 15:10:10 -08002519OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002520
David Benjamin71f7d3d2015-05-05 09:46:38 -04002521/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s session cache to
2522 * |size|. It returns the previous value. */
2523OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
2524 unsigned long size);
2525
David Benjamin3b7456e2015-05-16 12:29:32 -04002526/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s session
David Benjamin71f7d3d2015-05-05 09:46:38 -04002527 * cache. */
2528OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
2529
2530/* SSL_SESS_CACHE_* are the possible session cache mode bits.
2531 * TODO(davidben): Document. */
2532#define SSL_SESS_CACHE_OFF 0x0000
2533#define SSL_SESS_CACHE_CLIENT 0x0001
2534#define SSL_SESS_CACHE_SERVER 0x0002
2535#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
2536#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
2537#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
2538#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
2539#define SSL_SESS_CACHE_NO_INTERNAL \
2540 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
2541
2542/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
2543 * |mode|. It returns the previous value. */
2544OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
2545
2546/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
2547 * |ctx| */
2548OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
Adam Langley95c29f32014-06-20 12:00:00 -07002549
David Benjamin1d0a1942015-04-26 15:35:35 -04002550/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2551 * certificate chain accepted by |ctx|. */
2552OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2553
2554/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2555 * certificate chain to |max_cert_list|. This affects how much memory may be
2556 * consumed during the handshake. */
2557OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2558 size_t max_cert_list);
2559
2560/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2561 * certificate chain accepted by |ssl|. */
2562OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2563
2564/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2565 * certificate chain to |max_cert_list|. This affects how much memory may be
2566 * consumed during the handshake. */
2567OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2568
2569/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2570 * sent by |ctx|. Beyond this length, handshake messages and application data
2571 * will be split into multiple records. */
2572OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2573 size_t max_send_fragment);
2574
2575/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2576 * sent by |ssl|. Beyond this length, handshake messages and application data
2577 * will be split into multiple records. */
2578OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2579 size_t max_send_fragment);
Adam Langley95c29f32014-06-20 12:00:00 -07002580
David Benjamin59015c32015-04-26 13:13:55 -04002581/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
2582 * the group for DHE ciphers. |callback| should ignore |is_export| and
2583 * |keylength| and return a |DH| of the selected group or NULL on error. Only
2584 * the parameters are used, so the |DH| needn't have a generated keypair.
2585 *
2586 * WARNING: The caller does not take ownership of the resulting |DH|, so
2587 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002588OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
David Benjamin59015c32015-04-26 13:13:55 -04002589 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
2590
2591/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
2592 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
2593 * and return a |DH| of the selected group or NULL on error. Only the
2594 * parameters are used, so the |DH| needn't have a generated keypair.
2595 *
2596 * WARNING: The caller does not take ownership of the resulting |DH|, so
2597 * |callback| must save and release the object elsewhere. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002598OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002599 DH *(*dh)(SSL *ssl, int is_export,
2600 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002601
2602/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
2603 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2604 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2605 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2606 * keypair.
2607 *
2608 * If the callback is unset, an appropriate curve will be chosen automatically.
2609 * (This is recommended.)
2610 *
2611 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2612 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002613OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002614 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
2615
2616/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
2617 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
2618 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
2619 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
2620 * keypair.
2621 *
2622 * If the callback is unset, an appropriate curve will be chosen automatically.
2623 * (This is recommended.)
2624 *
2625 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
2626 * |callback| must save and release the object elsewhere. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002627OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
David Benjamindd978782015-04-24 15:20:13 -04002628 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
Adam Langley95c29f32014-06-20 12:00:00 -07002629
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002630typedef void COMP_METHOD;
2631
2632/* SSL_get_current_compression returns NULL. */
2633OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
2634
2635/* SSL_get_current_expansion returns NULL. */
2636OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002637
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002638OPENSSL_EXPORT int SSL_cache_hit(SSL *s);
2639OPENSSL_EXPORT int SSL_is_server(SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002640
Adam Langley524e7172015-02-20 16:04:00 -08002641/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2642 * resumption decision for a ClientHello has been made. It can return 1 to
2643 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002644OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002645 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2646
Adam Langley95f22882014-06-20 12:00:00 -07002647/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2648 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2649 * these values. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002650OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2651 size_t *ssl_ctx_size,
2652 size_t *ssl_session_size);
Adam Langley95f22882014-06-20 12:00:00 -07002653
Matt Braithwaite4838d8a2015-08-20 13:20:03 -07002654/* ERR_load_SSL_strings does nothing. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002655OPENSSL_EXPORT void ERR_load_SSL_strings(void);
Adam Langley95c29f32014-06-20 12:00:00 -07002656
Adam Langley3f92d212015-02-20 15:32:52 -08002657/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2658 * the read and write directions. It returns one on success or zero if |ssl|
2659 * isn't using an RC4-based cipher suite. */
2660OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2661 const RC4_KEY **write_key);
2662
Adam Langley95c29f32014-06-20 12:00:00 -07002663
David Benjamin71f07942015-04-08 02:36:59 -04002664/* Deprecated functions. */
2665
2666/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2667 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2668 * freed with |OPENSSL_free|, or NULL on error.
2669 *
2670 * The description includes a trailing newline and has the form:
2671 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2672 *
2673 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2674OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2675 char *buf, int len);
2676
2677/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2678OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2679
2680/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002681OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002682
2683/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002684OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002685
2686/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002687OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002688
David Benjamin0d8a7582015-04-08 23:55:15 -04002689/* SSLv23_method calls |TLS_method|. */
2690OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2691
2692/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2693 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2694 * to lock connections to that protocol version. */
2695OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2696OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2697OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2698OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2699OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2700OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2701
2702/* Client- and server-specific methods call their corresponding generic
2703 * methods. */
2704OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2705OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2706OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2707OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2708OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2709OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2710OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2711OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2712OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2713OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2714OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2715OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2716OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2717OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2718OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2719OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2720
David Benjamin4831c332015-05-16 11:43:13 -04002721/* SSL_clear resets |ssl| to allow another connection and returns one on success
2722 * or zero on failure. It returns most configuration state but releases memory
2723 * associated with the current connection.
2724 *
2725 * Free |ssl| and create a new one instead. */
2726OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2727
David Benjamin59015c32015-04-26 13:13:55 -04002728/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2729OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2730 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002731
David Benjamin59015c32015-04-26 13:13:55 -04002732/* SSL_set_tmp_rsa_callback does nothing. */
2733OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2734 RSA *(*cb)(SSL *ssl, int is_export,
2735 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002736
David Benjaminda881e92015-04-26 14:45:04 -04002737/* SSL_CTX_sess_connect returns zero. */
2738OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2739
2740/* SSL_CTX_sess_connect_good returns zero. */
2741OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2742
2743/* SSL_CTX_sess_connect_renegotiate returns zero. */
2744OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2745
2746/* SSL_CTX_sess_accept returns zero. */
2747OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2748
2749/* SSL_CTX_sess_accept_renegotiate returns zero. */
2750OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2751
2752/* SSL_CTX_sess_accept_good returns zero. */
2753OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2754
2755/* SSL_CTX_sess_hits returns zero. */
2756OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2757
2758/* SSL_CTX_sess_cb_hits returns zero. */
2759OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2760
2761/* SSL_CTX_sess_misses returns zero. */
2762OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2763
2764/* SSL_CTX_sess_timeouts returns zero. */
2765OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2766
2767/* SSL_CTX_sess_cache_full returns zero. */
2768OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2769
David Benjamin101ead22015-04-26 18:36:23 -04002770/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2771OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2772
David Benjaminc0454692015-04-27 00:28:56 -04002773/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2774OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2775
2776/* SSL_CTX_need_tmp_RSA returns zero. */
2777OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2778
2779/* SSL_need_tmp_RSA returns zero. */
2780OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2781
2782/* SSL_CTX_set_tmp_rsa returns one. */
2783OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2784
2785/* SSL_set_tmp_rsa returns one. */
2786OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2787
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002788/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002789OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2790
2791/* SSL_CTX_set_read_ahead does nothing. */
2792OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2793
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002794/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002795OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2796
2797/* SSL_set_read_ahead does nothing. */
2798OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2799
David Benjamin44d3eed2015-05-21 01:29:55 -04002800/* SSL_renegotiate put an error on the error queue and returns zero. */
2801OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2802
David Benjaminece089c2015-05-15 23:52:42 -04002803/* SSL_set_state does nothing. */
2804OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2805
David Benjamin7e40d4e2015-09-07 13:17:45 -04002806/* SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START. */
2807#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
2808
2809/* i2d_SSL_SESSION serializes |in| to the bytes pointed to by |*pp|. On success,
2810 * it returns the number of bytes written and advances |*pp| by that many bytes.
2811 * On failure, it returns -1. If |pp| is NULL, no bytes are written and only the
2812 * length is returned.
2813 *
2814 * Use |SSL_SESSION_to_bytes| instead. */
2815OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2816
2817/* d2i_SSL_SESSION parses a serialized session from the |length| bytes pointed
2818 * to by |*pp|. It returns the new |SSL_SESSION| and advances |*pp| by the
2819 * number of bytes consumed on success and NULL on failure. The caller takes
2820 * ownership of the new session and must call |SSL_SESSION_free| when done.
2821 *
2822 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
2823 *
2824 * Use |SSL_SESSION_from_bytes| instead. */
2825OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2826 long length);
2827
David Benjamin71f07942015-04-08 02:36:59 -04002828
Adam Langley7cc3f992015-01-07 15:06:31 -08002829/* Android compatibility section.
2830 *
2831 * These functions are declared, temporarily, for Android because
2832 * wpa_supplicant will take a little time to sync with upstream. Outside of
2833 * Android they'll have no definition. */
2834
2835#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
2836
Adam Langleyb4a494c2015-01-23 15:10:10 -08002837OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
2838 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08002839OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
2840OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07002841OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
2842
2843#define OPENSSL_VERSION_TEXT "BoringSSL"
2844
2845#define SSLEAY_VERSION 0
2846
2847/* SSLeay_version is a compatibility function that returns the string
2848 * "BoringSSL". */
2849OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08002850
2851
David Benjamin59015c32015-04-26 13:13:55 -04002852/* Preprocessor compatibility section.
2853 *
2854 * Historically, a number of APIs were implemented in OpenSSL as macros and
2855 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04002856 * section defines a number of legacy macros.
2857 *
2858 * Although using either the CTRL values or their wrapper macros in #ifdefs is
2859 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
2860 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04002861
David Benjamincb3872f2015-06-16 13:20:36 -04002862#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
2863#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002864#define SSL_CTRL_CHAIN doesnt_exist
2865#define SSL_CTRL_CHAIN_CERT doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002866#define SSL_CTRL_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002867#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002868#define SSL_CTRL_CLEAR_MODE doesnt_exist
2869#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002870#define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
2871#define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002872#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
David Benjamin75910642015-08-09 10:42:33 -04002873#define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04002874#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002875#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002876#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002877#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
2878#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
2879#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
2880#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
2881#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002882#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04002883#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002884#define SSL_CTRL_MODE doesnt_exist
2885#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
2886#define SSL_CTRL_OPTIONS doesnt_exist
2887#define SSL_CTRL_SESS_NUMBER doesnt_exist
2888#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
David Benjaminfdb4cdd2015-08-09 11:13:23 -04002889#define SSL_CTRL_SET_CURVES doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002890#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
2891#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002892#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002893#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04002894#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04002895#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04002896#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002897#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04002898#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002899#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
2900#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04002901#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002902#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04002903#define SSL_CTRL_SET_TMP_DH doesnt_exist
2904#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
2905#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
2906#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
2907#define SSL_CTRL_SET_TMP_RSA doesnt_exist
2908#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04002909
David Benjamin8c249802015-05-05 09:44:18 -04002910#define DTLSv1_get_timeout DTLSv1_get_timeout
2911#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamin11c0f8e2015-07-06 00:18:15 -04002912#define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
2913#define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
2914#define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
2915#define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
2916#define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002917#define SSL_CTX_clear_mode SSL_CTX_clear_mode
2918#define SSL_CTX_clear_options SSL_CTX_clear_options
2919#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04002920#define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
2921#define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002922#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
2923#define SSL_CTX_get_mode SSL_CTX_get_mode
2924#define SSL_CTX_get_options SSL_CTX_get_options
2925#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
2926#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04002927#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002928#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
2929#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
2930#define SSL_CTX_sess_number SSL_CTX_sess_number
2931#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
David Benjamin11c0f8e2015-07-06 00:18:15 -04002932#define SSL_CTX_set0_chain SSL_CTX_set0_chain
2933#define SSL_CTX_set1_chain SSL_CTX_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04002934#define SSL_CTX_set1_curves SSL_CTX_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04002935#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
2936#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
2937#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
2938#define SSL_CTX_set_mode SSL_CTX_set_mode
2939#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
2940#define SSL_CTX_set_options SSL_CTX_set_options
2941#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
2942#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
2943#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
2944#define SSL_CTX_set_tlsext_servername_callback \
2945 SSL_CTX_set_tlsext_servername_callback
2946#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04002947#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04002948#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
2949#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
2950#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
David Benjamin11c0f8e2015-07-06 00:18:15 -04002951#define SSL_add0_chain_cert SSL_add0_chain_cert
2952#define SSL_add1_chain_cert SSL_add1_chain_cert
2953#define SSL_clear_chain_certs SSL_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002954#define SSL_clear_mode SSL_clear_mode
2955#define SSL_clear_options SSL_clear_options
2956#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
David Benjamin75910642015-08-09 10:42:33 -04002957#define SSL_get0_certificate_types SSL_get0_certificate_types
David Benjamin11c0f8e2015-07-06 00:18:15 -04002958#define SSL_get0_chain_certs SSL_get0_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04002959#define SSL_get_max_cert_list SSL_get_max_cert_list
2960#define SSL_get_mode SSL_get_mode
2961#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04002962#define SSL_get_secure_renegotiation_support \
2963 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04002964#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04002965#define SSL_need_tmp_RSA SSL_need_tmp_RSA
2966#define SSL_num_renegotiations SSL_num_renegotiations
2967#define SSL_session_reused SSL_session_reused
David Benjamin11c0f8e2015-07-06 00:18:15 -04002968#define SSL_set0_chain SSL_set0_chain
2969#define SSL_set1_chain SSL_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04002970#define SSL_set1_curves SSL_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04002971#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
2972#define SSL_set_max_cert_list SSL_set_max_cert_list
2973#define SSL_set_max_send_fragment SSL_set_max_send_fragment
2974#define SSL_set_mode SSL_set_mode
2975#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
2976#define SSL_set_mtu SSL_set_mtu
2977#define SSL_set_options SSL_set_options
2978#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
2979#define SSL_set_tmp_dh SSL_set_tmp_dh
2980#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
2981#define SSL_set_tmp_rsa SSL_set_tmp_rsa
2982#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04002983
2984
David Benjamin087e4fa2015-04-08 23:46:10 -04002985#if defined(__cplusplus)
2986} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07002987#endif
David Benjamin2e521212014-07-16 14:37:51 -04002988
David Benjamin087e4fa2015-04-08 23:46:10 -04002989
2990/* Library consumers assume these headers are included by ssl.h, but they depend
2991 * on ssl.h, so include them after all declarations.
2992 *
2993 * TODO(davidben): The separation between ssl.h and these version-specific
2994 * headers introduces circular dependencies and is inconsistent. The function
2995 * declarations should move to ssl.h. Many of the constants can probably be
2996 * pruned or unexported. */
David Benjamin087e4fa2015-04-08 23:46:10 -04002997#include <openssl/ssl3.h>
2998#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04002999#include <openssl/srtp.h> /* Support for the use_srtp extension */
3000
3001
David Benjamin2e521212014-07-16 14:37:51 -04003002/* BEGIN ERROR CODES */
3003/* The following lines are auto generated by the script make_errors.go. Any
3004 * changes made after this point may be overwritten when the script is next run.
3005 */
David Benjamin689be0f2015-02-11 15:55:26 -05003006#define SSL_R_APP_DATA_IN_HANDSHAKE 100
3007#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
3008#define SSL_R_BAD_ALERT 102
3009#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
3010#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
3011#define SSL_R_BAD_DH_P_LENGTH 105
3012#define SSL_R_BAD_DIGEST_LENGTH 106
3013#define SSL_R_BAD_ECC_CERT 107
3014#define SSL_R_BAD_ECPOINT 108
3015#define SSL_R_BAD_HANDSHAKE_LENGTH 109
3016#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07003017#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05003018#define SSL_R_BAD_LENGTH 112
3019#define SSL_R_BAD_PACKET_LENGTH 113
3020#define SSL_R_BAD_RSA_ENCRYPT 114
3021#define SSL_R_BAD_SIGNATURE 115
3022#define SSL_R_BAD_SRTP_MKI_VALUE 116
3023#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
3024#define SSL_R_BAD_SSL_FILETYPE 118
3025#define SSL_R_BAD_WRITE_RETRY 119
3026#define SSL_R_BIO_NOT_SET 120
3027#define SSL_R_BN_LIB 121
3028#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
3029#define SSL_R_CA_DN_LENGTH_MISMATCH 123
3030#define SSL_R_CA_DN_TOO_LONG 124
3031#define SSL_R_CCS_RECEIVED_EARLY 125
3032#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
3033#define SSL_R_CERT_CB_ERROR 127
3034#define SSL_R_CERT_LENGTH_MISMATCH 128
3035#define SSL_R_CHANNEL_ID_NOT_P256 129
3036#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
3037#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
3038#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
3039#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
3040#define SSL_R_CLIENTHELLO_TLSEXT 134
3041#define SSL_R_CONNECTION_REJECTED 135
3042#define SSL_R_CONNECTION_TYPE_NOT_SET 136
3043#define SSL_R_COOKIE_MISMATCH 137
3044#define SSL_R_D2I_ECDSA_SIG 138
3045#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
3046#define SSL_R_DATA_LENGTH_TOO_LONG 140
3047#define SSL_R_DECODE_ERROR 141
3048#define SSL_R_DECRYPTION_FAILED 142
3049#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
3050#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
3051#define SSL_R_DIGEST_CHECK_FAILED 145
3052#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
3053#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
3054#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
3055#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
3056#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
3057#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
3058#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
3059#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
3060#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
3061#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
3062#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
3063#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
3064#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
3065#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
3066#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
3067#define SSL_R_HTTPS_PROXY_REQUEST 161
3068#define SSL_R_HTTP_REQUEST 162
3069#define SSL_R_INAPPROPRIATE_FALLBACK 163
3070#define SSL_R_INVALID_COMMAND 164
3071#define SSL_R_INVALID_MESSAGE 165
3072#define SSL_R_INVALID_SSL_SESSION 166
3073#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
3074#define SSL_R_LENGTH_MISMATCH 168
3075#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
3076#define SSL_R_MISSING_DH_KEY 170
3077#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
3078#define SSL_R_MISSING_RSA_CERTIFICATE 172
3079#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
3080#define SSL_R_MISSING_RSA_SIGNING_CERT 174
3081#define SSL_R_MISSING_TMP_DH_KEY 175
3082#define SSL_R_MISSING_TMP_ECDH_KEY 176
3083#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
3084#define SSL_R_MTU_TOO_SMALL 178
3085#define SSL_R_NESTED_GROUP 179
3086#define SSL_R_NO_CERTIFICATES_RETURNED 180
3087#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
3088#define SSL_R_NO_CERTIFICATE_SET 182
3089#define SSL_R_NO_CIPHERS_AVAILABLE 183
3090#define SSL_R_NO_CIPHERS_PASSED 184
3091#define SSL_R_NO_CIPHERS_SPECIFIED 185
3092#define SSL_R_NO_CIPHER_MATCH 186
3093#define SSL_R_NO_COMPRESSION_SPECIFIED 187
3094#define SSL_R_NO_METHOD_SPECIFIED 188
3095#define SSL_R_NO_P256_SUPPORT 189
3096#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
3097#define SSL_R_NO_RENEGOTIATION 191
3098#define SSL_R_NO_REQUIRED_DIGEST 192
3099#define SSL_R_NO_SHARED_CIPHER 193
3100#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
3101#define SSL_R_NO_SRTP_PROFILES 195
3102#define SSL_R_NULL_SSL_CTX 196
3103#define SSL_R_NULL_SSL_METHOD_PASSED 197
3104#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
3105#define SSL_R_PACKET_LENGTH_TOO_LONG 199
3106#define SSL_R_PARSE_TLSEXT 200
3107#define SSL_R_PATH_TOO_LONG 201
3108#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
3109#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
3110#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
3111#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
3112#define SSL_R_PSK_NO_CLIENT_CB 206
3113#define SSL_R_PSK_NO_SERVER_CB 207
3114#define SSL_R_READ_BIO_NOT_SET 208
3115#define SSL_R_READ_TIMEOUT_EXPIRED 209
3116#define SSL_R_RECORD_LENGTH_MISMATCH 210
3117#define SSL_R_RECORD_TOO_LARGE 211
3118#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
3119#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
3120#define SSL_R_RENEGOTIATION_MISMATCH 214
3121#define SSL_R_REQUIRED_CIPHER_MISSING 215
3122#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
3123#define SSL_R_SERVERHELLO_TLSEXT 217
3124#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
3125#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
3126#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
3127#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
3128#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
3129#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
3130#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
3131#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
3132#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
3133#define SSL_R_SSL_HANDSHAKE_FAILURE 227
3134#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
3135#define SSL_R_SSL_SESSION_ID_CONFLICT 229
3136#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
3137#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
3138#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
3139#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
3140#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
3141#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
3142#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
3143#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
3144#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
3145#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
3146#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
3147#define SSL_R_UNEXPECTED_MESSAGE 241
3148#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
3149#define SSL_R_UNEXPECTED_RECORD 243
3150#define SSL_R_UNINITIALIZED 244
3151#define SSL_R_UNKNOWN_ALERT_TYPE 245
3152#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
3153#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
3154#define SSL_R_UNKNOWN_CIPHER_TYPE 248
3155#define SSL_R_UNKNOWN_DIGEST 249
3156#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
3157#define SSL_R_UNKNOWN_PROTOCOL 251
3158#define SSL_R_UNKNOWN_SSL_VERSION 252
3159#define SSL_R_UNKNOWN_STATE 253
3160#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
3161#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
3162#define SSL_R_UNSUPPORTED_CIPHER 256
3163#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
3164#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
3165#define SSL_R_UNSUPPORTED_PROTOCOL 259
3166#define SSL_R_UNSUPPORTED_SSL_VERSION 260
3167#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07003168#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05003169#define SSL_R_WRONG_CIPHER_RETURNED 263
3170#define SSL_R_WRONG_CURVE 264
3171#define SSL_R_WRONG_MESSAGE_TYPE 265
3172#define SSL_R_WRONG_SIGNATURE_TYPE 266
3173#define SSL_R_WRONG_SSL_VERSION 267
3174#define SSL_R_WRONG_VERSION_NUMBER 268
3175#define SSL_R_X509_LIB 269
3176#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05003177#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04003178#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04003179#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05003180#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07003181#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
3182#define SSL_R_EMS_STATE_INCONSISTENT 276
3183#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04003184#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07003185#define SSL_R_UNEXPECTED_EXTENSION 279
Adam Langley2e857bd2015-07-01 16:09:19 -07003186#define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
Adam Langley33ad2b52015-07-20 17:43:53 -07003187#define SSL_R_ERROR_ADDING_EXTENSION 281
3188#define SSL_R_ERROR_PARSING_EXTENSION 282
3189#define SSL_R_MISSING_EXTENSION 283
Adam Langley09505632015-07-30 18:10:13 -07003190#define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
3191#define SSL_R_CUSTOM_EXTENSION_ERROR 285
David Benjamin76c2efc2015-08-31 14:24:29 -04003192#define SSL_R_NEGOTIATED_BOTH_NPN_AND_ALPN 286
David Benjamind7c53682014-09-17 12:08:13 -04003193#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04003194#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
3195#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
3196#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
3197#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
3198#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
3199#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
3200#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
3201#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
3202#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
3203#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
3204#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
3205#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
3206#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
3207#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
3208#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
3209#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
3210#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
3211#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
3212#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
3213#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
3214#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04003215#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04003216#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
3217#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
3218#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
3219#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
3220#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
3221#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
3222#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07003223
David Benjamin087e4fa2015-04-08 23:46:10 -04003224#endif /* OPENSSL_HEADER_SSL_H */