blob: de158cb9ccd7678b504373ea66c2bf8790d330e2 [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* ssl/ssl.h */
2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3 * All rights reserved.
4 *
5 * This package is an SSL implementation written
6 * by Eric Young (eay@cryptsoft.com).
7 * The implementation was written so as to conform with Netscapes SSL.
Adam Langleyb4a494c2015-01-23 15:10:10 -08008 *
Adam Langley95c29f32014-06-20 12:00:00 -07009 * This library is free for commercial and non-commercial use as long as
10 * the following conditions are aheared to. The following conditions
11 * apply to all code found in this distribution, be it the RC4, RSA,
12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13 * included with this distribution is covered by the same copyright terms
14 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
Adam Langleyb4a494c2015-01-23 15:10:10 -080015 *
Adam Langley95c29f32014-06-20 12:00:00 -070016 * Copyright remains Eric Young's, and as such any Copyright notices in
17 * the code are not to be removed.
18 * If this package is used in a product, Eric Young should be given attribution
19 * as the author of the parts of the library used.
20 * This can be in the form of a textual message at program startup or
21 * in documentation (online or textual) provided with the package.
Adam Langleyb4a494c2015-01-23 15:10:10 -080022 *
Adam Langley95c29f32014-06-20 12:00:00 -070023 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
25 * are met:
26 * 1. Redistributions of source code must retain the copyright
27 * notice, this list of conditions and the following disclaimer.
28 * 2. Redistributions in binary form must reproduce the above copyright
29 * notice, this list of conditions and the following disclaimer in the
30 * documentation and/or other materials provided with the distribution.
31 * 3. All advertising materials mentioning features or use of this software
32 * must display the following acknowledgement:
33 * "This product includes cryptographic software written by
34 * Eric Young (eay@cryptsoft.com)"
35 * The word 'cryptographic' can be left out if the rouines from the library
36 * being used are not cryptographic related :-).
Adam Langleyb4a494c2015-01-23 15:10:10 -080037 * 4. If you include any Windows specific code (or a derivative thereof) from
Adam Langley95c29f32014-06-20 12:00:00 -070038 * the apps directory (application code) you must include an acknowledgement:
39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
Adam Langleyb4a494c2015-01-23 15:10:10 -080040 *
Adam Langley95c29f32014-06-20 12:00:00 -070041 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
Adam Langleyb4a494c2015-01-23 15:10:10 -080052 *
Adam Langley95c29f32014-06-20 12:00:00 -070053 * The licence and distribution terms for any publically available version or
54 * derivative of this code cannot be changed. i.e. this code cannot simply be
55 * copied and put under another distribution licence
56 * [including the GNU Public Licence.]
57 */
58/* ====================================================================
59 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
60 *
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
63 * are met:
64 *
65 * 1. Redistributions of source code must retain the above copyright
Adam Langleyb4a494c2015-01-23 15:10:10 -080066 * notice, this list of conditions and the following disclaimer.
Adam Langley95c29f32014-06-20 12:00:00 -070067 *
68 * 2. Redistributions in binary form must reproduce the above copyright
69 * notice, this list of conditions and the following disclaimer in
70 * the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3. All advertising materials mentioning features or use of this
74 * software must display the following acknowledgment:
75 * "This product includes software developed by the OpenSSL Project
76 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 *
78 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79 * endorse or promote products derived from this software without
80 * prior written permission. For written permission, please contact
81 * openssl-core@openssl.org.
82 *
83 * 5. Products derived from this software may not be called "OpenSSL"
84 * nor may "OpenSSL" appear in their names without prior written
85 * permission of the OpenSSL Project.
86 *
87 * 6. Redistributions of any form whatsoever must retain the following
88 * acknowledgment:
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 *
92 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103 * OF THE POSSIBILITY OF SUCH DAMAGE.
104 * ====================================================================
105 *
106 * This product includes cryptographic software written by Eric Young
107 * (eay@cryptsoft.com). This product includes software written by Tim
108 * Hudson (tjh@cryptsoft.com).
109 *
110 */
111/* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
Adam Langleyb4a494c2015-01-23 15:10:10 -0800113 * ECC cipher suite support in OpenSSL originally developed by
Adam Langley95c29f32014-06-20 12:00:00 -0700114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 */
116/* ====================================================================
117 * Copyright 2005 Nokia. All rights reserved.
118 *
119 * The portions of the attached software ("Contribution") is developed by
120 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
121 * license.
122 *
123 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
124 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
125 * support (see RFC 4279) to OpenSSL.
126 *
127 * No patent licenses or other rights except those expressly stated in
128 * the OpenSSL open source license shall be deemed granted or received
129 * expressly, by implication, estoppel, or otherwise.
130 *
131 * No assurances are provided by Nokia that the Contribution does not
132 * infringe the patent or other intellectual property rights of any third
133 * party or that the license provides you with all the necessary rights
134 * to make use of the Contribution.
135 *
136 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
137 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
138 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
139 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
140 * OTHERWISE.
141 */
142
David Benjamin087e4fa2015-04-08 23:46:10 -0400143#ifndef OPENSSL_HEADER_SSL_H
144#define OPENSSL_HEADER_SSL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700145
146#include <openssl/base.h>
147
148#include <openssl/bio.h>
149#include <openssl/buf.h>
150#include <openssl/hmac.h>
151#include <openssl/lhash.h>
152#include <openssl/pem.h>
Adam Langley0b5e3902015-05-15 13:08:38 -0700153#include <openssl/thread.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700154#include <openssl/x509.h>
155
David Benjamin2e749e82015-04-07 23:20:51 -0400156#if !defined(OPENSSL_WINDOWS)
157#include <sys/time.h>
158#endif
159
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700160/* wpa_supplicant expects to get the version functions from ssl.h */
161#include <openssl/crypto.h>
162
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400163/* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
164 * Windows headers define too many macros to be included in public headers.
165 * However, only a forward declaration is needed. */
166struct timeval;
167
David Benjamin087e4fa2015-04-08 23:46:10 -0400168#if defined(__cplusplus)
Adam Langley95c29f32014-06-20 12:00:00 -0700169extern "C" {
170#endif
171
172
David Benjamin0d8a7582015-04-08 23:55:15 -0400173/* SSL implementation. */
174
175
David Benjamin71f07942015-04-08 02:36:59 -0400176/* Initialization. */
177
178/* SSL_library_init initializes the crypto and SSL libraries and returns one. */
179OPENSSL_EXPORT int SSL_library_init(void);
180
181
David Benjamin79c117a2015-09-13 13:53:19 -0400182/* SSL contexts.
183 *
184 * |SSL_CTX| objects manage shared state and configuration between multiple TLS
185 * or DTLS connections. Whether the connections are TLS or DTLS is selected by
186 * an |SSL_METHOD| on creation.
187 *
188 * |SSL_CTX| are reference-counted and may be shared by connections across
189 * multiple threads. Once shared, functions which change the |SSL_CTX|'s
190 * configuration may not be used. */
David Benjamin4831c332015-05-16 11:43:13 -0400191
192/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
193OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
194
195/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
196OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
197
198/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
David Benjamin79c117a2015-09-13 13:53:19 -0400199 * on error. */
David Benjamin4831c332015-05-16 11:43:13 -0400200OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
201
202/* SSL_CTX_free releases memory associated with |ctx|. */
203OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
204
205
David Benjamin79c117a2015-09-13 13:53:19 -0400206/* SSL connections.
207 *
208 * An |SSL| object represents a single TLS or DTLS connection. Although the
209 * shared |SSL_CTX| is thread-safe, an |SSL| is not thread-safe and may only be
210 * used on one thread at a time. */
David Benjamin4831c332015-05-16 11:43:13 -0400211
David Benjamin79c117a2015-09-13 13:53:19 -0400212/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. The new
213 * connection inherits settings from |ctx| at the time of creation. Settings may
214 * also be individually configured on the connection.
David Benjamin4831c332015-05-16 11:43:13 -0400215 *
216 * On creation, an |SSL| is not configured to be either a client or server. Call
217 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
218OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
219
220/* SSL_free releases memory associated with |ssl|. */
221OPENSSL_EXPORT void SSL_free(SSL *ssl);
222
223/* SSL_set_connect_state configures |ssl| to be a client. */
224OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
225
226/* SSL_set_accept_state configures |ssl| to be a server. */
227OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
228
David Benjamin42fea372015-09-19 01:22:44 -0400229/* SSL_is_server returns one if |ssl| is configured as a server and zero
230 * otherwise. */
231OPENSSL_EXPORT int SSL_is_server(SSL *ssl);
232
David Benjamin3c1ccc02015-09-13 00:27:05 -0400233/* SSL_set_bio configures |ssl| to read from |rbio| and write to |wbio|. |ssl|
234 * takes ownership of the two |BIO|s. If |rbio| and |wbio| are the same, |ssl|
235 * only takes ownership of one reference.
236 *
David Benjamin8ac00ca2015-10-03 11:14:36 -0400237 * In DTLS, if |rbio| is blocking, it must handle
238 * |BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT| control requests to set read timeouts.
239 *
David Benjamin3c1ccc02015-09-13 00:27:05 -0400240 * Calling this function on an already-configured |ssl| is deprecated. */
241OPENSSL_EXPORT void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
242
243/* SSL_get_rbio returns the |BIO| that |ssl| reads from. */
244OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *ssl);
245
246/* SSL_get_wbio returns the |BIO| that |ssl| writes to. */
247OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *ssl);
248
249/* SSL_do_handshake continues the current handshake. If there is none or the
250 * handshake has completed or False Started, it returns one. Otherwise, it
251 * returns <= 0. The caller should pass the value into |SSL_get_error| to
252 * determine how to proceed.
253 *
David Benjamin8ac00ca2015-10-03 11:14:36 -0400254 * In DTLS, if the read |BIO| is non-blocking, the caller must drive
255 * retransmissions. Whenever |SSL_get_error| signals |SSL_ERROR_WANT_READ|, use
256 * |DTLSv1_get_timeout| to determine the current timeout. If it expires before
257 * the next retry, call |DTLSv1_handle_timeout|. Note that DTLS handshake
258 * retransmissions use fresh sequence numbers, so it is not sufficient to replay
259 * packets at the transport.
260 *
David Benjamin3c1ccc02015-09-13 00:27:05 -0400261 * TODO(davidben): Ensure 0 is only returned on transport EOF.
262 * https://crbug.com/466303. */
263OPENSSL_EXPORT int SSL_do_handshake(SSL *ssl);
264
265/* SSL_connect configures |ssl| as a client, if unconfigured, and calls
266 * |SSL_do_handshake|. */
267OPENSSL_EXPORT int SSL_connect(SSL *ssl);
268
269/* SSL_accept configures |ssl| as a server, if unconfigured, and calls
270 * |SSL_do_handshake|. */
271OPENSSL_EXPORT int SSL_accept(SSL *ssl);
272
273/* SSL_read reads up to |num| bytes from |ssl| into |buf|. It implicitly runs
274 * any pending handshakes, including renegotiations when enabled. On success, it
275 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
276 * should pass the value into |SSL_get_error| to determine how to proceed.
277 *
278 * TODO(davidben): Ensure 0 is only returned on transport EOF.
279 * https://crbug.com/466303. */
280OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
281
282/* SSL_peek behaves like |SSL_read| but does not consume any bytes returned. */
283OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
284
David Benjamin9f859492015-10-03 10:44:30 -0400285/* SSL_pending returns the number of bytes available in |ssl|. It does not read
286 * from the transport. */
287OPENSSL_EXPORT int SSL_pending(const SSL *ssl);
288
David Benjamin3c1ccc02015-09-13 00:27:05 -0400289/* SSL_write writes up to |num| bytes from |buf| into |ssl|. It implicitly runs
290 * any pending handshakes, including renegotiations when enabled. On success, it
291 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
292 * should pass the value into |SSL_get_error| to determine how to proceed.
293 *
294 * A non-blocking |SSL_write| differs from non-blocking |write| in that a failed
295 * |SSL_write| still commits to the data passed in. When retrying, the caller
296 * must supply the original write buffer (or a larger one containing the
297 * original as a prefix). By default, retries will fail if they also do not
298 * reuse the same |buf| pointer. This may be relaxed with
299 * |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER|, but the buffer contents still must be
300 * unchanged.
301 *
302 * By default, |SSL_write| will not return success until all |num| bytes are
303 * written. This may be relaxed with |SSL_MODE_ENABLE_PARTIAL_WRITE|. It allows
304 * |SSL_write| to complete with a partial result when only part of the input was
305 * written in a single record.
306 *
307 * TODO(davidben): Ensure 0 is only returned on transport EOF.
308 * https://crbug.com/466303. */
309OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
310
311/* SSL_shutdown shuts down |ssl|. On success, it completes in two stages. First,
312 * it returns 0 if |ssl| completed uni-directional shutdown; close_notify has
313 * been sent, but the peer's close_notify has not been received. Most callers
314 * may stop at this point. For bi-directional shutdown, call |SSL_shutdown|
315 * again. It returns 1 if close_notify has been both sent and received.
316 *
317 * If the peer's close_notify arrived first, the first stage is skipped.
318 * |SSL_shutdown| will return 1 once close_notify is sent and skip 0. Callers
319 * only interested in uni-directional shutdown must therefore allow for the
320 * first stage returning either 0 or 1.
321 *
322 * |SSL_shutdown| returns -1 on failure. The caller should pass the return value
323 * into |SSL_get_error| to determine how to proceed. If the underlying |BIO| is
324 * non-blocking, both stages may require retry.
325 *
326 * |SSL_shutdown| must be called to retain |ssl|'s session in the session
327 * cache. Use |SSL_CTX_set_quiet_shutdown| to configure |SSL_shutdown| to
328 * neither send nor wait for close_notify but still retain the session.
329 *
330 * TODO(davidben): Is there any point in the session cache interaction? Remove
331 * it? */
332OPENSSL_EXPORT int SSL_shutdown(SSL *ssl);
333
David Benjamin9f859492015-10-03 10:44:30 -0400334/* SSL_CTX_set_quiet_shutdown sets quiet shutdown on |ctx| to |mode|. If
335 * enabled, |SSL_shutdown| will not send a close_notify alert or wait for one
336 * from the peer. It will instead synchronously return one. */
337OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
338
339/* SSL_CTX_get_quiet_shutdown returns whether quiet shutdown is enabled for
340 * |ctx|. */
341OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
342
343/* SSL_set_quiet_shutdown sets quiet shutdown on |ssl| to |mode|. If enabled,
344 * |SSL_shutdown| will not send a close_notify alert or wait for one from the
345 * peer. It will instead synchronously return one. */
346OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
347
348/* SSL_get_quiet_shutdown returns whether quiet shutdown is enabled for
349 * |ssl|. */
350OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
351
David Benjamin3c1ccc02015-09-13 00:27:05 -0400352/* SSL_get_error returns a |SSL_ERROR_*| value for the most recent operation on
353 * |ssl|. It should be called after an operation failed to determine. */
354OPENSSL_EXPORT int SSL_get_error(const SSL *ssl, int ret_code);
355
356/* SSL_ERROR_NONE indicates the operation succeeded. */
357#define SSL_ERROR_NONE 0
358
359/* SSL_ERROR_SSL indicates the operation failed within the library. The caller
360 * may inspect the error queue for more information. */
361#define SSL_ERROR_SSL 1
362
363/* SSL_ERROR_WANT_READ indicates the operation failed attempting to read from
364 * the transport. The caller may retry the operation when the transport is ready
David Benjamin8ac00ca2015-10-03 11:14:36 -0400365 * for reading.
366 *
367 * If signaled by a DTLS handshake, the caller must also call
368 * |DTLSv1_get_timeout| and |DTLSv1_handle_timeout| as appropriate. See
369 * |SSL_do_handshake|. */
David Benjamin3c1ccc02015-09-13 00:27:05 -0400370#define SSL_ERROR_WANT_READ 2
371
372/* SSL_ERROR_WANT_READ indicates the operation failed attempting to write to
373 * the transport. The caller may retry the operation when the transport is ready
374 * for writing. */
375#define SSL_ERROR_WANT_WRITE 3
376
377/* SSL_ERROR_WANT_X509_LOOKUP indicates the operation failed in calling the
378 * |cert_cb| or |client_cert_cb|. The caller may retry the operation when the
379 * callback is ready to return a certificate or one has been configured
380 * externally.
381 *
382 * See also |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb|. */
383#define SSL_ERROR_WANT_X509_LOOKUP 4
384
385/* SSL_ERROR_WANT_SYSCALL indicates the operation failed externally to the
386 * library. The caller should consult the system-specific error mechanism. This
387 * is typically |errno| but may be something custom if using a custom |BIO|. It
388 * may also be signaled if the transport returned EOF, in which case the
389 * operation's return value will be zero. */
390#define SSL_ERROR_SYSCALL 5
391
392/* SSL_ERROR_ZERO_RETURN indicates the operation failed because the connection
393 * was cleanly shut down with a close_notify alert. */
394#define SSL_ERROR_ZERO_RETURN 6
395
396/* SSL_ERROR_WANT_CONNECT indicates the operation failed attempting to connect
397 * the transport (the |BIO| signaled |BIO_RR_CONNECT|). The caller may retry the
398 * operation when the transport is ready. */
399#define SSL_ERROR_WANT_CONNECT 7
400
401/* SSL_ERROR_WANT_ACCEPT indicates the operation failed attempting to accept a
402 * connection from the transport (the |BIO| signaled |BIO_RR_ACCEPT|). The
403 * caller may retry the operation when the transport is ready.
404 *
405 * TODO(davidben): Remove this. It's used by accept BIOs which are bizarre. */
406#define SSL_ERROR_WANT_ACCEPT 8
407
408/* SSL_ERROR_WANT_CHANNEL_ID_LOOKUP indicates the operation failed looking up
409 * the Channel ID key. The caller may retry the operation when |channel_id_cb|
David Benjamin42fea372015-09-19 01:22:44 -0400410 * is ready to return a key or one has been configured with
411 * |SSL_set1_tls_channel_id|.
David Benjamin3c1ccc02015-09-13 00:27:05 -0400412 *
413 * See also |SSL_CTX_set_channel_id_cb|. */
414#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
415
416/* SSL_ERROR_PENDING_SESSION indicates the operation failed because the session
417 * lookup callback indicated the session was unavailable. The caller may retry
418 * the operation when lookup has completed.
419 *
David Benjamindafbdd42015-09-14 01:40:10 -0400420 * See also |SSL_CTX_sess_set_get_cb| and |SSL_magic_pending_session_ptr|. */
David Benjamin3c1ccc02015-09-13 00:27:05 -0400421#define SSL_ERROR_PENDING_SESSION 11
422
423/* SSL_ERROR_PENDING_CERTIFICATE indicates the operation failed because the
424 * early callback indicated certificate lookup was incomplete. The caller may
425 * retry the operation when lookup has completed. Note: when the operation is
426 * retried, the early callback will not be called a second time.
427 *
428 * See also |select_certificate_cb| on |SSL_CTX|. */
429#define SSL_ERROR_PENDING_CERTIFICATE 12
430
431/* SSL_ERROR_WANT_PRIVATE_KEY_OPERATION indicates the operation failed because
432 * a private key operation was unfinished. The caller may retry the operation
433 * when the private key operation is complete.
434 *
435 * See also |SSL_set_private_key_method|. */
436#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
437
David Benjamin8ac00ca2015-10-03 11:14:36 -0400438/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
439 * and zero on failure. */
440OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
441
442/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
443 * timeout in progress, it sets |*out| to the time remaining and returns one.
444 * Otherwise, it returns zero.
445 *
446 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
447 * retransmit behavior.
448 *
449 * NOTE: This function must be queried again whenever the handshake state
450 * machine changes, including when |DTLSv1_handle_timeout| is called. */
451OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
452
453/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
454 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
455 * flight of handshake messages and returns 1. If too many timeouts had expired
456 * without progress or an error occurs, it returns -1.
457 *
458 * NOTE: The caller's external timer should be compatible with the one |ssl|
459 * queries within some fudge factor. Otherwise, the call will be a no-op, but
460 * |DTLSv1_get_timeout| will return an updated timeout.
461 *
462 * WARNING: This function breaks the usual return value convention. */
463OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
464
David Benjamin4831c332015-05-16 11:43:13 -0400465
David Benjaminb487df62015-05-16 15:31:07 -0400466/* Protocol versions. */
467
David Benjaminb8d28cf2015-07-28 21:34:45 -0400468#define DTLS1_VERSION_MAJOR 0xfe
David Benjaminb487df62015-05-16 15:31:07 -0400469#define SSL3_VERSION_MAJOR 0x03
470
471#define SSL3_VERSION 0x0300
472#define TLS1_VERSION 0x0301
473#define TLS1_1_VERSION 0x0302
474#define TLS1_2_VERSION 0x0303
475
476#define DTLS1_VERSION 0xfeff
477#define DTLS1_2_VERSION 0xfefd
478
479/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
480 * |version|. */
481OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
482
483/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
484 * |version|. */
485OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
486
487/* SSL_set_min_version sets the minimum protocol version for |ssl| to
488 * |version|. */
489OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
490
491/* SSL_set_max_version sets the maximum protocol version for |ssl| to
492 * |version|. */
493OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
494
David Benjamin42fea372015-09-19 01:22:44 -0400495/* SSL_version returns the TLS or DTLS protocol version used by |ssl|, which is
496 * one of the |*_VERSION| values. (E.g. |TLS1_2_VERSION|.) Before the version
497 * is negotiated, the result is undefined. */
498OPENSSL_EXPORT int SSL_version(const SSL *ssl);
499
David Benjaminb487df62015-05-16 15:31:07 -0400500
501/* Options.
502 *
503 * Options configure protocol behavior. */
504
505/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
506 * support the renegotiation_info extension (RFC 5746). It is on by default. */
507#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
508
509/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
510 * bytes above the maximum record size. */
511#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
512
513/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
514 * (i.e. without a length prefix). */
515#define SSL_OP_TLS_D5_BUG 0x00000100L
516
517/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
518 * consumers.
519 * TODO(davidben): Determine which of the remaining may be removed now. */
520#define SSL_OP_ALL 0x00000BFFL
521
522/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
523 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
524#define SSL_OP_NO_QUERY_MTU 0x00001000L
525
David Benjamindafbdd42015-09-14 01:40:10 -0400526/* SSL_OP_NO_TICKET disables session ticket support (RFC 5077). */
David Benjaminb487df62015-05-16 15:31:07 -0400527#define SSL_OP_NO_TICKET 0x00004000L
528
David Benjaminb487df62015-05-16 15:31:07 -0400529/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
530 * ECDHE curves according to the server's preferences instead of the
531 * client's. */
532#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
533
David Benjaminb487df62015-05-16 15:31:07 -0400534/* SSL_CTX_set_options enables all options set in |options| (which should be one
535 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
536 * bitmask representing the resulting enabled options. */
537OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
538
539/* SSL_CTX_clear_options disables all options set in |options| (which should be
540 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
541 * bitmask representing the resulting enabled options. */
542OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
543
544/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
545 * the options enabled for |ctx|. */
546OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
547
548/* SSL_set_options enables all options set in |options| (which should be one or
549 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
550 * representing the resulting enabled options. */
551OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
552
553/* SSL_clear_options disables all options set in |options| (which should be one
554 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
555 * bitmask representing the resulting enabled options. */
556OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
557
558/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
559 * options enabled for |ssl|. */
560OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
561
562
563/* Modes.
564 *
565 * Modes configure API behavior. */
566
567/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
568 * result when the only part of the input was written in a single record. */
569#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
570
571/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
572 * with a different buffer. However, |SSL_write| still assumes the buffer
573 * contents are unchanged. This is not the default to avoid the misconception
574 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
575#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
576
577/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
578 * before sending certificates to the peer.
579 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
580#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
581
David Benjaminb487df62015-05-16 15:31:07 -0400582/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
583 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
584 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
585#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
586
David Benjaminb487df62015-05-16 15:31:07 -0400587/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
588 * TLS 1.0 to be split in two: the first record will contain a single byte and
589 * the second will contain the remainder. This effectively randomises the IV and
590 * prevents BEAST attacks. */
591#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
592
593/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
594 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
595 * session resumption is used for a given SSL*. */
596#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
597
598/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
599 * To be set only by applications that reconnect with a downgraded protocol
David Benjamin229adfb2015-07-25 15:08:18 -0400600 * version; see RFC 7507 for details.
David Benjaminb487df62015-05-16 15:31:07 -0400601 *
602 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
David Benjamin229adfb2015-07-25 15:08:18 -0400603 * this in explicit fallback retries, following the guidance in RFC 7507. */
David Benjaminb487df62015-05-16 15:31:07 -0400604#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
605
David Benjaminb487df62015-05-16 15:31:07 -0400606/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
607 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
608 * representing the resulting enabled modes. */
609OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
610
611/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
612 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
613 * bitmask representing the resulting enabled modes. */
614OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
615
616/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
617 * the modes enabled for |ssl|. */
618OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
619
620/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
621 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
622 * representing the resulting enabled modes. */
623OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
624
625/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
626 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
627 * representing the resulting enabled modes. */
628OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
629
630/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
631 * modes enabled for |ssl|. */
632OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
633
634
David Benjaminb4d65fd2015-05-29 17:11:21 -0400635/* Configuring certificates and private keys.
636 *
David Benjamin11c0f8e2015-07-06 00:18:15 -0400637 * These functions configure the connection's leaf certificate, private key, and
638 * certificate chain. The certificate chain is ordered leaf to root (as sent on
639 * the wire) but does not include the leaf. Both client and server certificates
640 * use these functions.
641 *
642 * Certificates and keys may be configured before the handshake or dynamically
643 * in the early callback and certificate callback. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400644
David Benjamin7481d392015-07-05 19:38:46 -0400645/* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
646 * one on success and zero on failure. */
647OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
648
649/* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
650 * on success and zero on failure. */
651OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
652
653/* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
654 * success and zero on failure. */
655OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
656
657/* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
658 * success and zero on failure. */
659OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
660
David Benjamin11c0f8e2015-07-06 00:18:15 -0400661/* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
662 * |chain|. On success, it returns one and takes ownership of |chain|.
663 * Otherwise, it returns zero. */
664OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
665
666/* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
667 * |chain|. It returns one on success and zero on failure. The caller retains
668 * ownership of |chain| and may release it freely. */
669OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
670
671/* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
672 * |chain|. On success, it returns one and takes ownership of |chain|.
673 * Otherwise, it returns zero. */
674OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
675
676/* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
677 * |chain|. It returns one on success and zero on failure. The caller retains
678 * ownership of |chain| and may release it freely. */
679OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
680
681/* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
682 * success, it returns one and takes ownership of |x509|. Otherwise, it returns
683 * zero. */
684OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
685
686/* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
687 * returns one on success and zero on failure. The caller retains ownership of
688 * |x509| and may release it freely. */
689OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
690
691/* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
692 * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
693OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
694
695/* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
696OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
697
698/* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
699 * one on success and zero on failure. The caller retains ownership of |x509|
700 * and may release it freely. */
701OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
702
703/* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
704 * one. */
705OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
706
707/* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
708OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
709
710/* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
711OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
712
David Benjamin7481d392015-07-05 19:38:46 -0400713/* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
714 * The callback returns one on success, zero on internal error, and a negative
715 * number on failure or to pause the handshake. If the handshake is paused,
David Benjaminfd8e69f2015-10-03 10:49:20 -0400716 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|.
717 *
718 * On the client, the callback may call |SSL_get0_certificate_types| and
719 * |SSL_get_client_CA_list| for information on the server's certificate
720 * request. */
David Benjamin7481d392015-07-05 19:38:46 -0400721OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
722 int (*cb)(SSL *ssl, void *arg),
723 void *arg);
724
725/* SSL_set_cert_cb sets a callback that is called to select a certificate. The
726 * callback returns one on success, zero on internal error, and a negative
727 * number on failure or to pause the handshake. If the handshake is paused,
David Benjaminfd8e69f2015-10-03 10:49:20 -0400728 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|.
729 *
730 * On the client, the callback may call |SSL_get0_certificate_types| and
731 * |SSL_get_client_CA_list| for information on the server's certificate
732 * request. */
David Benjamin7481d392015-07-05 19:38:46 -0400733OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
734 void *arg);
735
David Benjaminfd8e69f2015-10-03 10:49:20 -0400736/* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
737 * containing the client certificate types requested by a server. It returns the
738 * length of the array.
739 *
740 * The behavior of this function is undefined except during the callbacks set by
741 * by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or when the
742 * handshake is paused because of them. */
743OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
744 const uint8_t **out_types);
745
David Benjamin7481d392015-07-05 19:38:46 -0400746/* SSL_certs_clear resets the private key, leaf certificate, and certificate
747 * chain of |ssl|. */
748OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
749
750/* SSL_CTX_check_private_key returns one if the certificate and private key
751 * configured in |ctx| are consistent and zero otherwise. */
752OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
753
754/* SSL_check_private_key returns one if the certificate and private key
755 * configured in |ssl| are consistent and zero otherwise. */
756OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
757
758/* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
759OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
760
761/* SSL_get_certificate returns |ssl|'s leaf certificate. */
762OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
763
David Benjamin11c0f8e2015-07-06 00:18:15 -0400764/* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
765OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
766
767/* SSL_get_privatekey returns |ssl|'s private key. */
768OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
769
770/* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
771 * returns one. */
772OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
773 STACK_OF(X509) **out_chain);
774
775/* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
776OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
777 STACK_OF(X509) **out_chain);
778
779/* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
780 * returns one. */
781OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
782 STACK_OF(X509) **out_chain);
783
Paul Lietar4fac72e2015-09-09 13:44:55 +0100784/* SSL_CTX_set_signed_cert_timestamp_list sets the list of signed certificate
785 * timestamps that is sent to clients that request it. The |list| argument must
786 * contain one or more SCT structures serialised as a SignedCertificateTimestamp
787 * List (see https://tools.ietf.org/html/rfc6962#section-3.3) – i.e. each SCT
788 * is prefixed by a big-endian, uint16 length and the concatenation of one or
789 * more such prefixed SCTs are themselves also prefixed by a uint16 length. It
790 * returns one on success and zero on error. The caller retains ownership of
791 * |list|. */
792OPENSSL_EXPORT int SSL_CTX_set_signed_cert_timestamp_list(SSL_CTX *ctx,
793 const uint8_t *list,
794 size_t list_len);
795
Paul Lietaraeeff2c2015-08-12 11:47:11 +0100796/* SSL_CTX_set_ocsp_response sets the OCSP reponse that is sent to clients
797 * which request it. It returns one on success and zero on error. The caller
798 * retains ownership of |response|. */
799OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx,
800 const uint8_t *response,
801 size_t response_len);
802
Steven Valdez0d62f262015-09-04 12:41:04 -0400803/* SSL_set_private_key_digest_prefs copies |num_digests| NIDs from |digest_nids|
804 * into |ssl|. These digests will be used, in decreasing order of preference,
805 * when signing with |ssl|'s private key. It returns one on success and zero on
806 * error. */
807OPENSSL_EXPORT int SSL_set_private_key_digest_prefs(SSL *ssl,
808 const int *digest_nids,
809 size_t num_digests);
810
David Benjamin7481d392015-07-05 19:38:46 -0400811
812/* Certificate and private key convenience functions. */
813
814/* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
815 * on success and zero on failure. */
816OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
817
818/* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
819 * success and zero on failure. */
820OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
821
822/* The following functions configure certificates or private keys but take as
823 * input DER-encoded structures. They return one on success and zero on
824 * failure. */
825
826OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
827 const uint8_t *d);
828OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
829 int len);
830
831OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
832 const uint8_t *d, long len);
833OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
834 const uint8_t *d, long len);
835
836OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
David Benjamin74f71102015-06-27 14:56:25 -0400837 const uint8_t *der,
838 size_t der_len);
839OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
840 size_t der_len);
David Benjamin7481d392015-07-05 19:38:46 -0400841
842/* The following functions configure certificates or private keys but take as
843 * input files to read from. They return one on success and zero on failure. The
844 * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
845 * the file's contents are read as PEM or DER. */
846
847#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
848#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
849
850OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
851 const char *file,
852 int type);
853OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
854 int type);
855
856OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
857 int type);
858OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
859 int type);
860
861OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
862 int type);
863OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
864 int type);
865
Adam Langleyc8e664b2015-09-24 14:48:32 -0700866/* SSL_CTX_use_certificate_chain_file configures certificates for |ctx|. It
867 * reads the contents of |file| as a PEM-encoded leaf certificate followed
868 * optionally by the certificate chain to send to the peer. It returns one on
869 * success and zero on failure. */
David Benjamin7481d392015-07-05 19:38:46 -0400870OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
871 const char *file);
872
David Benjamin42fea372015-09-19 01:22:44 -0400873/* SSL_CTX_set_default_passwd_cb sets the password callback for PEM-based
874 * convenience functions called on |ctx|. */
875OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
876 pem_password_cb *cb);
877
878/* SSL_CTX_set_default_passwd_cb_userdata sets the userdata parameter for
879 * |ctx|'s password callback. */
880OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
881 void *data);
882
David Benjamin7481d392015-07-05 19:38:46 -0400883
884/* Custom private keys. */
885
David Benjaminb4d65fd2015-05-29 17:11:21 -0400886enum ssl_private_key_result_t {
887 ssl_private_key_success,
888 ssl_private_key_retry,
889 ssl_private_key_failure,
890};
891
892/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
893 * signing operations to a custom, potentially asynchronous, backend. */
894typedef struct ssl_private_key_method_st {
895 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
896 * key used by |ssl|. */
897 int (*type)(SSL *ssl);
898
David Benjaminb4d65fd2015-05-29 17:11:21 -0400899 /* max_signature_len returns the maximum length of a signature signed by the
900 * key used by |ssl|. This must be a constant value for a given |ssl|. */
901 size_t (*max_signature_len)(SSL *ssl);
902
903 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
904 * used to calculate |in|. On success, it returns |ssl_private_key_success|
905 * and writes at most |max_out| bytes of signature data to |out|. On failure,
906 * it returns |ssl_private_key_failure|. If the operation has not completed,
907 * it returns |ssl_private_key_retry|. |sign| should arrange for the
908 * high-level operation on |ssl| to be retried when the operation is
909 * completed. This will result in a call to |sign_complete|.
910 *
911 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
912 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
913 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
914 *
915 * It is an error to call |sign| while another private key operation is in
916 * progress on |ssl|. */
917 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
918 size_t max_out, const EVP_MD *md,
919 const uint8_t *in, size_t in_len);
920
921 /* sign_complete completes a pending |sign| operation. If the operation has
922 * completed, it returns |ssl_private_key_success| and writes the result to
923 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
924 * failure and |ssl_private_key_retry| if the operation is still in progress.
925 *
926 * |sign_complete| may be called arbitrarily many times before completion, but
927 * it is an error to call |sign_complete| if there is no pending |sign|
928 * operation in progress on |ssl|. */
929 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
930 size_t *out_len, size_t max_out);
931} SSL_PRIVATE_KEY_METHOD;
932
Steven Valdez0d62f262015-09-04 12:41:04 -0400933/* SSL_set_private_key_method configures a custom private key on |ssl|.
David Benjamind1d80782015-07-05 11:54:09 -0400934 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400935OPENSSL_EXPORT void SSL_set_private_key_method(
936 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
937
938
David Benjamindf6a3f82015-09-20 12:18:11 -0400939/* Cipher suites.
940 *
941 * |SSL_CIPHER| objects represent cipher suites. */
942
943DECLARE_STACK_OF(SSL_CIPHER)
944
945/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
946 * suite based on its assigned number, or NULL if unknown. See
947 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
948OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
949
950/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
951 * get the cipher suite value. */
952OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
953
954/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
955 * mode). */
956OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
957
958/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
959OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
960
961/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
962OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
963
964/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
965 * CHACHA20_POLY1305. */
966OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
967
968/* SSL_CIPHER_is_NULL returns one if |cipher| does not encrypt. */
969OPENSSL_EXPORT int SSL_CIPHER_is_NULL(const SSL_CIPHER *cipher);
970
971/* SSL_CIPHER_is_RC4 returns one if |cipher| uses RC4. */
972OPENSSL_EXPORT int SSL_CIPHER_is_RC4(const SSL_CIPHER *cipher);
973
974/* SSL_CIPHER_is_block_cipher returns one if |cipher| is a block cipher. */
975OPENSSL_EXPORT int SSL_CIPHER_is_block_cipher(const SSL_CIPHER *cipher);
976
977/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
978OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
979
980/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
981 * method used by |cipher|. For example, "ECDHE_ECDSA". */
982OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
983
984/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
985 * name for |cipher| or NULL on error. For example,
986 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
987 * calling |OPENSSL_free| on the result. */
988OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
989
990/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
991 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
992 * symmetric algorithm to |*out_alg_bits|. */
993OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
994 int *out_alg_bits);
995
996
David Benjamin32876b32015-09-20 12:17:03 -0400997/* Cipher suite configuration.
998 *
999 * OpenSSL uses a mini-language to configure cipher suites. The language
1000 * maintains an ordered list of enabled ciphers, along with an ordered list of
1001 * disabled but available ciphers. Initially, all ciphers are disabled with a
1002 * default ordering. The cipher string is then interpreted as a sequence of
1003 * directives, separated by colons, each of which modifies this state.
1004 *
1005 * Most directives consist of a one character or empty opcode followed by a
1006 * selector which matches a subset of available ciphers.
1007 *
1008 * Available opcodes are:
1009 *
1010 * The empty opcode enables and appends all matching disabled ciphers to the
1011 * end of the enabled list. The newly appended ciphers are ordered relative to
1012 * each other matching their order in the disabled list.
1013 *
1014 * |-| disables all matching enabled ciphers and prepends them to the disabled
1015 * list, with relative order from the enabled list preserved. This means the
1016 * most recently disabled ciphers get highest preference relative to other
1017 * disabled ciphers if re-enabled.
1018 *
1019 * |+| moves all matching enabled ciphers to the end of the enabled list, with
1020 * relative order preserved.
1021 *
1022 * |!| deletes all matching ciphers, enabled or not, from either list. Deleted
1023 * ciphers will not matched by future operations.
1024 *
1025 * A selector may be a specific cipher (using the OpenSSL name for the cipher)
1026 * or one or more rules separated by |+|. The final selector matches the
1027 * intersection of each rule. For instance, |AESGCM+aECDSA| matches
1028 * ECDSA-authenticated AES-GCM ciphers.
1029 *
1030 * Available cipher rules are:
1031 *
1032 * |ALL| matches all ciphers.
1033 *
1034 * |kRSA|, |kDHE|, |kECDHE|, and |kPSK| match ciphers using plain RSA, DHE,
1035 * ECDHE, and plain PSK key exchanges, respectively. Note that ECDHE_PSK is
1036 * matched by |kECDHE| and not |kPSK|.
1037 *
1038 * |aRSA|, |aECDSA|, and |aPSK| match ciphers authenticated by RSA, ECDSA, and
1039 * a pre-shared key, respectively.
1040 *
1041 * |RSA|, |DHE|, |ECDHE|, |PSK|, |ECDSA|, and |PSK| are aliases for the
1042 * corresponding |k*| or |a*| cipher rule. |RSA| is an alias for |kRSA|, not
1043 * |aRSA|.
1044 *
1045 * |3DES|, |RC4|, |AES128|, |AES256|, |AES|, |AESGCM|, |CHACHA20| match
1046 * ciphers whose bulk cipher use the corresponding encryption scheme. Note
1047 * that |AES|, |AES128|, and |AES256| match both CBC and GCM ciphers.
1048 *
1049 * |MD5|, |SHA1|, |SHA256|, and |SHA384| match legacy cipher suites using the
1050 * corresponding hash function in their MAC. AEADs are matched by none of
1051 * these.
1052 *
1053 * |SHA| is an alias for |SHA1|.
1054 *
1055 * Although implemented, authentication-only ciphers match no rules and must be
1056 * explicitly selected by name.
1057 *
1058 * Deprecated cipher rules:
1059 *
1060 * |kEDH|, |EDH|, |kEECDH|, and |EECDH| are legacy aliases for |kDHE|, |DHE|,
1061 * |kECDHE|, and |ECDHE|, respectively.
1062 *
1063 * |MEDIUM| and |HIGH| match ciphers historically labeled by OpenSSL as
1064 * 'medium' and 'high', respectively.
1065 *
1066 * |FIPS| matches ciphers historically FIPS-approved in OpenSSL.
1067 *
1068 * |SSLv3| and |TLSv1| match ciphers available in TLS 1.1 or earlier.
1069 * |TLSv1_2| matches ciphers new in TLS 1.2. This is confusing and should not
1070 * be used.
1071 *
1072 * Unknown rules silently match nothing.
1073 *
1074 * The special |@STRENGTH| directive will sort all enabled ciphers by strength.
1075 *
1076 * The |DEFAULT| directive, when appearing at the front of the string, expands
1077 * to the default ordering of available ciphers.
1078 *
1079 * If configuring a server, one may also configure equal-preference groups to
1080 * partially respect the client's preferences when
1081 * |SSL_OP_CIPHER_SERVER_PREFERENCE| is enabled. Ciphers in an equal-preference
1082 * group have equal priority and use the client order. This may be used to
1083 * enforce that AEADs are preferred but select AES-GCM vs. ChaCha20-Poly1305
1084 * based on client preferences. An equal-preference is specified with square
1085 * brackets, combining multiple selectors separated by |. For example:
1086 *
1087 * [ECDHE-ECDSA-CHACHA20-POLY1305|ECDHE-ECDSA-AES128-GCM-SHA256]
1088 *
1089 * Once an equal-preference group is used, future directives must be
1090 * opcode-less. */
1091
1092/* SSL_DEFAULT_CIPHER_LIST is the default cipher suite configuration. It is
1093 * substituted when a cipher string starts with 'DEFAULT'. */
1094#define SSL_DEFAULT_CIPHER_LIST "ALL"
1095
1096/* SSL_CTX_set_cipher_list configures the cipher list for |ctx|, evaluating
1097 * |str| as a cipher string. It returns one on success and zero on failure. */
1098OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
1099
1100/* SSL_CTX_set_cipher_list configures the TLS 1.0+ cipher list for |ctx|,
1101 * evaluating |str| as a cipher string. It returns one on success and zero on
1102 * failure. If set, servers will use this cipher suite list for TLS 1.0 or
1103 * higher. */
1104OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls10(SSL_CTX *ctx, const char *str);
1105
1106/* SSL_CTX_set_cipher_list configures the TLS 1.1+ cipher list for |ctx|,
1107 * evaluating |str| as a cipher string. It returns one on success and zero on
1108 * failure. If set, servers will use this cipher suite list for TLS 1.1 or
1109 * higher. */
1110OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *ctx, const char *str);
1111
1112/* SSL_set_cipher_list configures the cipher list for |ssl|, evaluating |str| as
1113 * a cipher string. It returns one on success and zero on failure. */
1114OPENSSL_EXPORT int SSL_set_cipher_list(SSL *ssl, const char *str);
1115
1116/* SSL_get_ciphers returns the cipher list for |ssl|, in order of preference. If
1117 * |SSL_CTX_set_cipher_list_tls10| or |SSL_CTX_set_cipher_list_tls11| has been
1118 * used, the corresponding list for the current version is returned. */
1119OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
1120
1121
Adam Langleyaf0e32c2015-06-03 09:57:23 -07001122/* Connection information. */
1123
David Benjaminee0c8272015-09-13 01:03:54 -04001124/* SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the
1125 * peer did not use certificates. The caller must call |X509_free| on the
1126 * result to release it. */
1127OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl);
1128
1129/* SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if
1130 * unavailable or the peer did not use certificates. For historical reasons,
1131 * this may not be available if resuming a serialized |SSL_SESSION|. The caller
1132 * does not take ownership of the result.
1133 *
1134 * WARNING: This function behaves differently between client and server. If
1135 * |ssl| is a server, the returned chain does not include the leaf certificate.
1136 * If a client, it does. */
1137OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
1138
Adam Langleyaf0e32c2015-06-03 09:57:23 -07001139/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
1140 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
1141 * returns one on success or zero on error. In general |max_out| should be at
1142 * least 12.
1143 *
1144 * This function will always fail if the initial handshake has not completed.
1145 * The tls-unique value will change after a renegotiation but, since
1146 * renegotiations can be initiated by the server at any point, the higher-level
1147 * protocol must either leave them disabled or define states in which the
1148 * tls-unique value can be read.
1149 *
1150 * The tls-unique value is defined by
1151 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
1152 * TLS protocol, tls-unique is broken for resumed connections unless the
1153 * Extended Master Secret extension is negotiated. Thus this function will
1154 * return zero if |ssl| performed session resumption unless EMS was used when
1155 * negotiating the original session. */
1156OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
1157 size_t *out_len, size_t max_out);
1158
Matt Braithwaitecd6f54b2015-09-17 12:54:42 -07001159/* SSL_get_extms_support returns one if the Extended Master Secret
1160 * extension was negotiated. Otherwise, it returns zero. */
1161OPENSSL_EXPORT int SSL_get_extms_support(const SSL *ssl);
1162
David Benjamin42fea372015-09-19 01:22:44 -04001163/* SSL_get_current_cipher returns the cipher used in the current outgoing
1164 * connection state, or NULL if the null cipher is active. */
1165OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
1166
1167/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1168 * and zero otherwise.
1169 *
1170 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1171 * initial or renego, is in progress. */
1172OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
1173
1174/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
1175 * renegotiation (RFC 5746) and zero otherwise. */
1176OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
1177
Adam Langleyaf0e32c2015-06-03 09:57:23 -07001178
Adam Langley09505632015-07-30 18:10:13 -07001179/* Custom extensions.
1180 *
1181 * The custom extension functions allow TLS extensions to be added to
1182 * ClientHello and ServerHello messages. */
1183
1184/* SSL_custom_ext_add_cb is a callback function that is called when the
1185 * ClientHello (for clients) or ServerHello (for servers) is constructed. In
1186 * the case of a server, this callback will only be called for a given
1187 * extension if the ClientHello contained that extension – it's not possible to
1188 * inject extensions into a ServerHello that the client didn't request.
1189 *
1190 * When called, |extension_value| will contain the extension number that is
1191 * being considered for addition (so that a single callback can handle multiple
1192 * extensions). If the callback wishes to include the extension, it must set
1193 * |*out| to point to |*out_len| bytes of extension contents and return one. In
1194 * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
1195 * called with the value of |*out| once that data has been copied.
1196 *
1197 * If the callback does not wish to add an extension it must return zero.
1198 *
1199 * Alternatively, the callback can abort the connection by setting
1200 * |*out_alert_value| to a TLS alert number and returning -1. */
1201typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
1202 const uint8_t **out, size_t *out_len,
1203 int *out_alert_value, void *add_arg);
1204
1205/* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
1206 * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
1207 * this callback is called and passed the |out| pointer that was returned by
1208 * the add callback. This is to free any dynamically allocated data created by
1209 * the add callback. */
1210typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
1211 const uint8_t *out, void *add_arg);
1212
1213/* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
1214 * parse an extension from the peer: that is from the ServerHello for a client
1215 * and from the ClientHello for a server.
1216 *
1217 * When called, |extension_value| will contain the extension number and the
1218 * contents of the extension are |contents_len| bytes at |contents|.
1219 *
1220 * The callback must return one to continue the handshake. Otherwise, if it
1221 * returns zero, a fatal alert with value |*out_alert_value| is sent and the
1222 * handshake is aborted. */
1223typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
1224 const uint8_t *contents,
1225 size_t contents_len,
1226 int *out_alert_value, void *parse_arg);
1227
1228/* SSL_extension_supported returns one iff OpenSSL internally handles
1229 * extensions of type |extension_value|. This can be used to avoid registering
1230 * custom extension handlers for extensions that a future version of OpenSSL
1231 * may handle internally. */
1232OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
1233
1234/* SSL_CTX_add_client_custom_ext registers callback functions for handling
1235 * custom TLS extensions for client connections.
1236 *
1237 * If |add_cb| is NULL then an empty extension will be added in each
1238 * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
1239 * this callback.
1240 *
1241 * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
1242 * needs to be freed.
1243 *
1244 * It returns one on success or zero on error. It's always an error to register
1245 * callbacks for the same extension twice, or to register callbacks for an
1246 * extension that OpenSSL handles internally. See |SSL_extension_supported| to
1247 * discover, at runtime, which extensions OpenSSL handles internally. */
1248OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
1249 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1250 SSL_custom_ext_free_cb free_cb, void *add_arg,
1251 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1252
1253/* SSL_CTX_add_server_custom_ext is the same as
1254 * |SSL_CTX_add_client_custom_ext|, but for server connections.
1255 *
1256 * Unlike on the client side, if |add_cb| is NULL no extension will be added.
1257 * The |add_cb|, if any, will only be called if the ClientHello contained a
1258 * matching extension. */
1259OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
1260 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1261 SSL_custom_ext_free_cb free_cb, void *add_arg,
1262 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1263
1264
David Benjamina6b8cdf2015-09-13 14:07:33 -04001265/* Sessions.
1266 *
1267 * An |SSL_SESSION| represents an SSL session that may be resumed in an
1268 * abbreviated handshake. It is reference-counted and immutable. Once
1269 * established, an |SSL_SESSION| may be shared by multiple |SSL| objects on
1270 * different threads and must not be modified. */
1271
David Benjamin3fb1ebc2015-09-16 00:29:20 -04001272DECLARE_LHASH_OF(SSL_SESSION)
1273
David Benjamina6b8cdf2015-09-13 14:07:33 -04001274/* SSL_SESSION_new returns a newly-allocated blank |SSL_SESSION| or NULL on
1275 * error. This may be useful in writing tests but otherwise should not be
1276 * used outside the library. */
1277OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
1278
1279/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
1280 * of |session|. It then returns |session|. */
1281OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
1282
1283/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
1284 * zero, all data referenced by |session| and |session| itself are released. */
1285OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
1286
1287/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
1288 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
1289 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
1290 * one on success and zero on error. */
David Benjamin14e2b502015-09-13 14:48:12 -04001291OPENSSL_EXPORT int SSL_SESSION_to_bytes(const SSL_SESSION *in,
1292 uint8_t **out_data, size_t *out_len);
David Benjamina6b8cdf2015-09-13 14:07:33 -04001293
1294/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
1295 * identification information, namely the session ID and ticket. */
David Benjamin14e2b502015-09-13 14:48:12 -04001296OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(const SSL_SESSION *in,
David Benjamina6b8cdf2015-09-13 14:07:33 -04001297 uint8_t **out_data,
1298 size_t *out_len);
1299
1300/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
1301 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
1302OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
1303 size_t in_len);
1304
1305/* SSL_SESSION_get_version returns a string describing the TLS version |session|
1306 * was established at. For example, "TLSv1.2" or "SSLv3". */
1307OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *session);
1308
1309/* SSL_SESSION_get_id returns a pointer to a buffer containg |session|'s session
1310 * ID and sets |*out_len| to its length. */
1311OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *session,
1312 unsigned *out_len);
1313
1314/* SSL_SESSION_get_time returns the time at which |session| was established in
1315 * seconds since the UNIX epoch. */
1316OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *session);
1317
1318/* SSL_SESSION_get_timeout returns the lifetime of |session| in seconds. */
1319OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *session);
1320
1321/* SSL_SESSION_get_key_exchange_info returns a value that describes the
1322 * strength of the asymmetric operation that provides confidentiality to
1323 * |session|. Its interpretation depends on the operation used. See the
1324 * documentation for this value in the |SSL_SESSION| structure. */
David Benjamin14e2b502015-09-13 14:48:12 -04001325OPENSSL_EXPORT uint32_t SSL_SESSION_get_key_exchange_info(
1326 const SSL_SESSION *session);
David Benjamina6b8cdf2015-09-13 14:07:33 -04001327
1328/* SSL_SESSION_get0_peer return's the peer leaf certificate stored in
David Benjamin14e2b502015-09-13 14:48:12 -04001329 * |session|.
1330 *
1331 * TODO(davidben): This should return a const X509 *. */
1332OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(const SSL_SESSION *session);
David Benjamina6b8cdf2015-09-13 14:07:33 -04001333
1334/* SSL_SESSION_set_time sets |session|'s creation time to |time| and returns
1335 * |time|. This function may be useful in writing tests but otherwise should not
1336 * be used. */
1337OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *session, long time);
1338
Adam Langleyc8e664b2015-09-24 14:48:32 -07001339/* SSL_SESSION_set_timeout sets |session|'s timeout to |timeout| and returns
1340 * one. This function may be useful in writing tests but otherwise should not
1341 * be used. */
David Benjamina6b8cdf2015-09-13 14:07:33 -04001342OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *session, long timeout);
1343
1344/* SSL_SESSION_set1_id_context sets |session|'s session ID context (see
1345 * |SSL_CTX_set_session_id_context|) to |sid_ctx|. It returns one on success and
1346 * zero on error. This function may be useful in writing tests but otherwise
1347 * should not be used. */
1348OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *session,
1349 const uint8_t *sid_ctx,
1350 unsigned sid_ctx_len);
1351
1352
David Benjamindafbdd42015-09-14 01:40:10 -04001353/* Session caching.
1354 *
1355 * Session caching allows clients to reconnect to a server based on saved
1356 * parameters from a previous connection.
1357 *
1358 * For a server, the library implements a built-in internal session cache as an
1359 * in-memory hash table. One may also register callbacks to implement a custom
1360 * external session cache. An external cache may be used in addition to or
1361 * instead of the internal one. Use |SSL_CTX_set_session_cache_mode| to toggle
1362 * the internal cache.
1363 *
1364 * For a client, the only option is an external session cache. Prior to
1365 * handshaking, the consumer should look up a session externally (keyed, for
1366 * instance, by hostname) and use |SSL_set_session| to configure which session
1367 * to offer. The callbacks may be used to determine when new sessions are
1368 * available.
1369 *
1370 * Note that offering or accepting a session short-circuits most parameter
1371 * negotiation. Resuming sessions across different configurations may result in
1372 * surprising behavor. So, for instance, a client implementing a version
1373 * fallback should shard its session cache by maximum protocol version. */
1374
1375/* SSL_SESS_CACHE_OFF disables all session caching. */
1376#define SSL_SESS_CACHE_OFF 0x0000
1377
1378/* SSL_SESS_CACHE_CLIENT enables session caching for a client.
1379 *
1380 * TODO(davidben): The internal cache is useless on the client. Always act as if
1381 * SSL_SESS_CACHE_NO_INTERNAL is set. https://crbug.com/531194. Also see TODO
1382 * attached to |SSL_CTX_sess_set_new_cb|. */
1383#define SSL_SESS_CACHE_CLIENT 0x0001
1384
1385/* SSL_SESS_CACHE_SERVER enables session caching for a server. */
1386#define SSL_SESS_CACHE_SERVER 0x0002
1387
1388/* SSL_SESS_CACHE_SERVER enables session caching for both client and server. */
1389#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
1390
1391/* SSL_SESS_CACHE_NO_AUTO_CLEAR disables automatically calling
1392 * |SSL_CTX_flush_sessions| every 255 connections. */
1393#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
1394
1395/* SSL_SESS_CACHE_NO_INTERNAL_LOOKUP disables looking up a session from the
1396 * internal session cache. */
1397#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
1398
1399/* SSL_SESS_CACHE_NO_INTERNAL_STORE disables storing sessions in the internal
1400 * session cache. */
1401#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
1402
1403/* SSL_SESS_CACHE_NO_INTERNAL disables the internal session cache. */
1404#define SSL_SESS_CACHE_NO_INTERNAL \
1405 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
1406
1407/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
1408 * |mode|. It returns the previous value. */
1409OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
1410
1411/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
1412 * |ctx| */
1413OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
1414
David Benjamin43a58ad2015-09-24 23:56:37 -04001415/* SSL_set_session, for a client, configures |ssl| to offer to resume |session|
1416 * in the initial handshake and returns one. The caller retains ownership of
1417 * |session|. */
David Benjamindafbdd42015-09-14 01:40:10 -04001418OPENSSL_EXPORT int SSL_set_session(SSL *ssl, SSL_SESSION *session);
1419
1420/* SSL_get_session returns a non-owning pointer to |ssl|'s session. Prior to the
1421 * initial handshake beginning, this is the session to be offered, set by
1422 * |SSL_set_session|. After a handshake has finished, this is the currently
1423 * active session. Its behavior is undefined while a handshake is progress. */
1424OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
1425
1426/* SSL_get0_session is an alias for |SSL_get_session|. */
1427#define SSL_get0_session SSL_get_session
1428
1429/* SSL_get1_session acts like |SSL_get_session| but returns a new reference to
1430 * the session. */
1431OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(SSL *ssl);
1432
David Benjamin42fea372015-09-19 01:22:44 -04001433/* SSL_DEFAULT_SESSION_TIMEOUT is the default lifetime, in seconds, of a
1434 * session. */
1435#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
1436
1437/* SSL_CTX_set_timeout sets the lifetime, in seconds, of sessions created in
1438 * |ctx| to |timeout|. */
David Benjamindafbdd42015-09-14 01:40:10 -04001439OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long timeout);
1440
David Benjamin42fea372015-09-19 01:22:44 -04001441/* SSL_CTX_get_timeout returns the lifetime, in seconds, of sessions created in
1442 * |ctx|. */
David Benjamindafbdd42015-09-14 01:40:10 -04001443OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1444
1445/* SSL_CTX_set_session_id_context sets |ctx|'s session ID context to |sid_ctx|.
1446 * It returns one on success and zero on error. The session ID context is an
1447 * application-defined opaque byte string. A session will not be used in a
1448 * connection without a matching session ID context.
1449 *
1450 * For a server, if |SSL_VERIFY_PEER| is enabled, it is an error to not set a
1451 * session ID context.
1452 *
1453 * TODO(davidben): Is that check needed? That seems a special case of taking
1454 * care not to cross-resume across configuration changes, and this is only
1455 * relevant if a server requires client auth. */
1456OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
1457 const uint8_t *sid_ctx,
1458 unsigned sid_ctx_len);
1459
1460/* SSL_set_session_id_context sets |ssl|'s session ID context to |sid_ctx|. It
1461 * returns one on success and zero on error. See also
1462 * |SSL_CTX_set_session_id_context|. */
1463OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
1464 unsigned sid_ctx_len);
1465
David Benjamin42fea372015-09-19 01:22:44 -04001466/* SSL_SESSION_CACHE_MAX_SIZE_DEFAULT is the default maximum size of a session
1467 * cache. */
1468#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
1469
David Benjamindafbdd42015-09-14 01:40:10 -04001470/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s internal session
1471 * cache to |size|. It returns the previous value. */
1472OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
1473 unsigned long size);
1474
1475/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s internal
1476 * session cache. */
1477OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
1478
1479/* SSL_CTX_sessions returns |ctx|'s internal session cache. */
1480OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
1481
1482/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1483 * session cache. */
1484OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
1485
1486/* SSL_CTX_add_session inserts |session| into |ctx|'s internal session cache. It
1487 * returns one on success and zero on error or if |ctx| already included a
1488 * session with that session ID. The caller retains its reference to
1489 * |session|. */
1490OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *session);
1491
1492/* SSL_CTX_remove_session removes |session| from |ctx|'s internal session cache.
1493 * It returns one on success and zero on error or if no session with a matching
1494 * ID was found. */
1495OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *session);
1496
1497/* SSL_CTX_flush_sessions removes all sessions from |ctx| which have expired as
1498 * of time |time|. If |time| is zero, all sessions are removed. */
1499OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long time);
1500
1501/* SSL_CTX_sess_set_new_cb sets the callback to be called when a new session is
1502 * established and ready to be cached. If the session cache is disabled (the
1503 * appropriate one of |SSL_SESS_CACHE_CLIENT| or |SSL_SESS_CACHE_SERVER| is
1504 * unset), the callback is not called.
1505 *
1506 * The callback is passed a reference to |session|. It returns one if it takes
1507 * ownership and zero otherwise.
1508 *
1509 * Note: For a client, the callback may be called on abbreviated handshakes if a
1510 * ticket is renewed. Further, it may not be called until some time after
1511 * |SSL_do_handshake| or |SSL_connect| completes if False Start is enabled. Thus
1512 * it's recommended to use this callback over checking |SSL_session_reused| on
1513 * handshake completion.
1514 *
1515 * TODO(davidben): Conditioning callbacks on |SSL_SESS_CACHE_CLIENT| or
1516 * |SSL_SESS_CACHE_SERVER| doesn't make any sense when one could just as easily
1517 * not supply the callbacks. Removing that condition and the client internal
1518 * cache would simplify things. */
1519OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
1520 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *session));
1521
1522/* SSL_CTX_sess_get_new_cb returns the callback set by
1523 * |SSL_CTX_sess_set_new_cb|. */
1524OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(
1525 SSL *ssl, SSL_SESSION *session);
1526
1527/* SSL_CTX_sess_set_remove_cb sets a callback which is called when a session is
1528 * removed from the internal session cache.
1529 *
1530 * TODO(davidben): What is the point of this callback? It seems useless since it
1531 * only fires on sessions in the internal cache. */
1532OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1533 SSL_CTX *ctx,
1534 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *session));
1535
1536/* SSL_CTX_sess_get_remove_cb returns the callback set by
1537 * |SSL_CTX_sess_set_remove_cb|. */
1538OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
1539 SSL_CTX *ctx, SSL_SESSION *session);
1540
1541/* SSL_CTX_sess_set_get_cb sets a callback to look up a session by ID for a
1542 * server. The callback is passed the session ID and should return a matching
1543 * |SSL_SESSION| or NULL if not found. It should set |*out_copy| to zero and
1544 * return a new reference to the session. This callback is not used for a
1545 * client.
1546 *
1547 * For historical reasons, if |*out_copy| is set to one (default), the SSL
1548 * library will take a new reference to the returned |SSL_SESSION|, expecting
1549 * the callback to return a non-owning pointer. This is not recommended. If
1550 * |ctx| and thus the callback is used on multiple threads, the session may be
1551 * removed and invalidated before the SSL library calls |SSL_SESSION_up_ref|,
1552 * whereas the callback may synchronize internally.
1553 *
1554 * To look up a session asynchronously, the callback may return
1555 * |SSL_magic_pending_session_ptr|. See the documentation for that function and
1556 * |SSL_ERROR_PENDING_SESSION|.
1557 *
1558 * If the internal session cache is enabled, the callback is only consulted if
1559 * the internal cache does not return a match. */
1560OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1561 SSL_CTX *ctx,
1562 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *id, int id_len,
1563 int *out_copy));
1564
1565/* SSL_CTX_sess_get_get_cb returns the callback set by
1566 * |SSL_CTX_sess_set_get_cb|. */
1567OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
1568 SSL *ssl, uint8_t *id, int id_len, int *out_copy);
1569
1570/* SSL_magic_pending_session_ptr returns a magic |SSL_SESSION|* which indicates
1571 * that the session isn't currently unavailable. |SSL_get_error| will then
1572 * return |SSL_ERROR_PENDING_SESSION| and the handshake can be retried later
1573 * when the lookup has completed. */
1574OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
1575
1576/* GEN_SESSION_CB is a callback to generate session IDs for |ssl|. It returns
1577 * one on success and zero on error. On success, the generated ID is written to
1578 * |id| and |*id_len| set to the length. On entry, |*id_len| is the maximum
1579 * length of the ID, but the callback may shorten it if desired. It is an error
1580 * for the callback to set the size to zero.
1581 *
1582 * Callbacks may use |SSL_has_matching_session_id| to check that the generated
1583 * ID is unique. */
1584typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id, unsigned *id_len);
1585
1586/* SSL_CTX_set_generate_session_id sets the session ID callback of |ctx| to
1587 * |cb| and returns one. It will be called on the server when establishing a new
1588 * session. */
1589OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *ctx,
1590 GEN_SESSION_CB cb);
1591
1592/* SSL_set_generate_session_id sets the session ID callback of |ssl| to |cb| and
1593 * returns one. It will be called on the server when establishing a new
1594 * session. */
1595OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb);
1596
1597/* SSL_has_matching_session_id returns one if |ssl|'s session cache has a
1598 * session of value |id| and zero otherwise. */
1599OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
1600 const uint8_t *id,
1601 unsigned id_len);
1602
1603
1604/* Session tickets.
1605 *
1606 * Session tickets, from RFC 5077, allow session resumption without server-side
1607 * state. Session tickets are supported in by default but may be disabled with
1608 * |SSL_OP_NO_TICKET|.
1609 *
1610 * On the client, ticket-based sessions use the same APIs as ID-based tickets.
1611 * Callers do not need to handle them differently.
1612 *
1613 * On the server, tickets are encrypted and authenticated with a secret key. By
1614 * default, an |SSL_CTX| generates a key on creation. Tickets are minted and
1615 * processed transparently. The following functions may be used to configure a
1616 * persistent key or implement more custom behavior. */
David Benjamindaeafc22015-06-25 17:35:11 -04001617
1618/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
1619 * |len| bytes of |out|. It returns one on success and zero if |len| is not
1620 * 48. If |out| is NULL, it returns 48 instead. */
1621OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
1622 size_t len);
1623
1624/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
1625 * |len| bytes of |in|. It returns one on success and zero if |len| is not
1626 * 48. If |in| is NULL, it returns 48 instead. */
1627OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
1628 size_t len);
1629
David Benjamine3aa1d92015-06-16 15:34:50 -04001630/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
1631 * ticket. */
1632#define SSL_TICKET_KEY_NAME_LEN 16
1633
David Benjamindaeafc22015-06-25 17:35:11 -04001634/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
1635 * returns one. |callback| will be called when encrypting a new ticket and when
1636 * decrypting a ticket from the client.
1637 *
1638 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
1639 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
1640 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
1641 * for encryption or decryption, based on the mode.
1642 *
1643 * When encrypting a new ticket, |encrypt| will be one. It writes a public
1644 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
1645 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1646 * |callback| returns 1 on success and -1 on error.
1647 *
1648 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
1649 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
1650 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1651 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
1652 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
1653 * This may be used to re-key the ticket.
1654 *
1655 * WARNING: |callback| wildly breaks the usual return value convention and is
1656 * called in two different modes. */
1657OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
1658 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
1659 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
1660 int encrypt));
1661
1662
David Benjamin58fcfc12015-09-15 23:49:00 -04001663/* Elliptic curve Diffie-Hellman.
1664 *
1665 * Cipher suites using an ECDHE key exchange perform Diffie-Hellman over an
1666 * elliptic curve negotiated by both endpoints. See RFC 4492. Only named curves
1667 * are supported. ECDHE is always enabled, but the curve preferences may be
1668 * configured with these functions.
1669 *
1670 * A client may use |SSL_SESSION_get_key_exchange_info| to determine the curve
1671 * selected. */
1672
1673/* SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each
1674 * element of |curves| should be a curve nid. It returns one on success and
1675 * zero on failure. */
1676OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves,
1677 size_t curves_len);
1678
1679/* SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each
1680 * element of |curves| should be a curve nid. It returns one on success and
1681 * zero on failure. */
1682OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves,
1683 size_t curves_len);
1684
1685/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1686 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1687 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1688 * error. If unset, an appropriate curve will be chosen based on curve
1689 * preferences. (This is recommended.) */
1690OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
1691
1692/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1693 * for ephemeral ECDH keys. For historical reasons, this API expects an
1694 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1695 * error. If unset, an appropriate curve will be chosen based on curve
1696 * preferences. (This is recommended.) */
1697OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
1698
1699/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
1700 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
1701 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
1702 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
1703 * keypair.
1704 *
1705 * If the callback is unset, an appropriate curve will be chosen based on curve
1706 * preferences. (This is recommended.)
1707 *
1708 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
1709 * |callback| must save and release the object elsewhere. */
1710OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
1711 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
1712
1713/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
1714 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
1715 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
1716 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
1717 * keypair.
1718 *
1719 * If the callback is unset, an appropriate curve will be chosen based on curve
1720 * preferences. (This is recommended.)
1721 *
1722 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
1723 * |callback| must save and release the object elsewhere. */
1724OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
1725 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
1726
1727/* SSL_get_curve_name returns a human-readable name for the elliptic curve
1728 * specified by the given TLS curve id, or NULL if the curve if unknown. */
David Benjamin59937042015-09-19 13:04:22 -04001729OPENSSL_EXPORT const char *SSL_get_curve_name(uint16_t curve_id);
David Benjamin58fcfc12015-09-15 23:49:00 -04001730
1731
1732/* Multiplicative Diffie-Hellman.
1733 *
1734 * Cipher suites using a DHE key exchange perform Diffie-Hellman over a
1735 * multiplicative group selected by the server. These ciphers are disabled for a
1736 * server unless a group is chosen with one of these functions.
1737 *
1738 * A client may use |SSL_SESSION_get_key_exchange_info| to determine the size of
1739 * the selected group's prime, but note that servers may select degenerate
1740 * groups. */
1741
1742/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1743 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1744 * one on success and zero on error. */
1745OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
1746
1747/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1748 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1749 * on success and zero on error. */
1750OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
1751
1752/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
1753 * the group for DHE ciphers. |callback| should ignore |is_export| and
1754 * |keylength| and return a |DH| of the selected group or NULL on error. Only
1755 * the parameters are used, so the |DH| needn't have a generated keypair.
1756 *
1757 * WARNING: The caller does not take ownership of the resulting |DH|, so
1758 * |callback| must save and release the object elsewhere. */
1759OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
1760 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
1761
1762/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
1763 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
1764 * and return a |DH| of the selected group or NULL on error. Only the
1765 * parameters are used, so the |DH| needn't have a generated keypair.
1766 *
1767 * WARNING: The caller does not take ownership of the resulting |DH|, so
1768 * |callback| must save and release the object elsewhere. */
1769OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
1770 DH *(*dh)(SSL *ssl, int is_export,
1771 int keylength));
1772
1773
David Benjamin59937042015-09-19 13:04:22 -04001774/* Certificate verification.
1775 *
1776 * SSL may authenticate either endpoint with an X.509 certificate. Typically
1777 * this is used to authenticate the server to the client. These functions
1778 * configure certificate verification.
1779 *
1780 * WARNING: By default, certificate verification errors on a client are not
1781 * fatal. See |SSL_VERIFY_NONE| This may be configured with
1782 * |SSL_CTX_set_verify|.
1783 *
1784 * By default clients are anonymous but a server may request a certificate from
1785 * the client by setting |SSL_VERIFY_PEER|.
1786 *
1787 * Many of these functions use OpenSSL's legacy X.509 stack which is
1788 * underdocumented and deprecated, but the replacement isn't ready yet. For
1789 * now, consumers may use the existing stack or bypass it by performing
1790 * certificate verification externally. This may be done with
1791 * |SSL_CTX_set_cert_verify_callback| or by extracting the chain with
1792 * |SSL_get_peer_cert_chain| after the handshake. In the future, functions will
David Benjamind3a53c82015-09-20 00:00:28 -04001793 * be added to use the SSL stack without dependency on any part of the legacy
1794 * X.509 and ASN.1 stack.
1795 *
1796 * To augment certificate verification, a client may also enable OCSP stapling
1797 * (RFC 6066) and Certificate Transparency (RFC 6962) extensions. */
David Benjamin59937042015-09-19 13:04:22 -04001798
1799/* SSL_VERIFY_NONE, on a client, verifies the server certificate but does not
1800 * make errors fatal. The result may be checked with |SSL_get_verify_result|. On
1801 * a server it does not request a client certificate. This is the default. */
1802#define SSL_VERIFY_NONE 0x00
1803
1804/* SSL_VERIFY_PEER, on a client, makes server certificate errors fatal. On a
1805 * server it requests a client certificate and makes errors fatal. However,
1806 * anonymous clients are still allowed. See
1807 * |SSL_VERIFY_FAIL_IF_NO_PEER_CERT|. */
1808#define SSL_VERIFY_PEER 0x01
1809
1810/* SSL_VERIFY_FAIL_IF_NO_PEER_CERT configures a server to reject connections if
1811 * the client declines to send a certificate. Otherwise |SSL_VERIFY_PEER| still
1812 * allows anonymous clients. */
1813#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
1814
1815/* SSL_VERIFY_PEER_IF_NO_OBC configures a server to request a client certificate
1816 * if and only if Channel ID is not negotiated. */
1817#define SSL_VERIFY_PEER_IF_NO_OBC 0x04
1818
1819/* SSL_CTX_set_verify configures certificate verification behavior. |mode| is
1820 * one of the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is
1821 * used to customize certificate verification. See the behavior of
1822 * |X509_STORE_CTX_set_verify_cb|.
1823 *
1824 * The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with
1825 * |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. */
1826OPENSSL_EXPORT void SSL_CTX_set_verify(
1827 SSL_CTX *ctx, int mode, int (*callback)(int ok, X509_STORE_CTX *store_ctx));
1828
1829/* SSL_set_verify configures certificate verification behavior. |mode| is one of
1830 * the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is used to
1831 * customize certificate verification. See the behavior of
1832 * |X509_STORE_CTX_set_verify_cb|.
1833 *
1834 * The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with
1835 * |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. */
1836OPENSSL_EXPORT void SSL_set_verify(SSL *ssl, int mode,
1837 int (*callback)(int ok,
1838 X509_STORE_CTX *store_ctx));
1839
1840/* SSL_CTX_get_verify_mode returns |ctx|'s verify mode, set by
1841 * |SSL_CTX_set_verify|. */
1842OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1843
1844/* SSL_get_verify_mode returns |ssl|'s verify mode, set by |SSL_CTX_set_verify|
1845 * or |SSL_set_verify|. */
1846OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *ssl);
1847
1848/* SSL_CTX_get_verify_callback returns the callback set by
1849 * |SSL_CTX_set_verify|. */
1850OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
1851 int ok, X509_STORE_CTX *store_ctx);
1852
1853/* SSL_get_verify_callback returns the callback set by |SSL_CTX_set_verify| or
1854 * |SSL_set_verify|. */
1855OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *ssl))(
1856 int ok, X509_STORE_CTX *store_ctx);
1857
1858/* SSL_CTX_set_verify_depth sets the maximum depth of a certificate chain
1859 * accepted in verification. This number does not include the leaf, so a depth
1860 * of 1 allows the leaf and one CA certificate. */
1861OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1862
1863/* SSL_set_verify_depth sets the maximum depth of a certificate chain accepted
1864 * in verification. This number does not include the leaf, so a depth of 1
1865 * allows the leaf and one CA certificate. */
1866OPENSSL_EXPORT void SSL_set_verify_depth(SSL *ssl, int depth);
1867
1868/* SSL_CTX_get_verify_depth returns the maximum depth of a certificate accepted
1869 * in verification. */
1870OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
1871
1872/* SSL_get_verify_depth returns the maximum depth of a certificate accepted in
1873 * verification. */
1874OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *ssl);
1875
1876/* SSL_CTX_set1_param sets verification parameters from |param|. It returns one
1877 * on success and zero on failure. The caller retains ownership of |param|. */
1878OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx,
1879 const X509_VERIFY_PARAM *param);
1880
1881/* SSL_set1_param sets verification parameters from |param|. It returns one on
1882 * success and zero on failure. The caller retains ownership of |param|. */
1883OPENSSL_EXPORT int SSL_set1_param(SSL *ssl,
1884 const X509_VERIFY_PARAM *param);
1885
1886/* SSL_CTX_get0_param returns |ctx|'s |X509_VERIFY_PARAM| for certificate
1887 * verification. The caller must not release the returned pointer but may call
1888 * functions on it to configure it. */
1889OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
1890
1891/* SSL_get0_param returns |ssl|'s |X509_VERIFY_PARAM| for certificate
1892 * verification. The caller must not release the returned pointer but may call
1893 * functions on it to configure it. */
1894OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
1895
1896/* SSL_CTX_set_purpose sets |ctx|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to
1897 * |purpose|. It returns one on success and zero on error. */
1898OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *ctx, int purpose);
1899
1900/* SSL_set_purpose sets |ssl|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to
1901 * |purpose|. It returns one on success and zero on error. */
1902OPENSSL_EXPORT int SSL_set_purpose(SSL *ssl, int purpose);
1903
1904/* SSL_CTX_set_trust sets |ctx|'s |X509_VERIFY_PARAM|'s 'trust' parameter to
1905 * |trust|. It returns one on success and zero on error. */
1906OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *ctx, int trust);
1907
1908/* SSL_set_trust sets |ssl|'s |X509_VERIFY_PARAM|'s 'trust' parameter to
1909 * |trust|. It returns one on success and zero on error. */
1910OPENSSL_EXPORT int SSL_set_trust(SSL *ssl, int trust);
1911
1912/* SSL_CTX_set_cert_store sets |ctx|'s certificate store to |store|. It takes
1913 * ownership of |store|. The store is used for certificate verification.
1914 *
1915 * The store is also used for the auto-chaining feature, but this is deprecated.
1916 * See also |SSL_MODE_NO_AUTO_CHAIN|. */
1917OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store);
1918
1919/* SSL_CTX_get_cert_store returns |ctx|'s certificate store. */
1920OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx);
1921
1922/* SSL_CTX_set_default_verify_paths loads the OpenSSL system-default trust
1923 * anchors into |ctx|'s store. It returns one on success and zero on failure. */
1924OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
1925
1926/* SSL_CTX_load_verify_locations loads trust anchors into |ctx|'s store from
1927 * |ca_file| and |ca_dir|, either of which may be NULL. If |ca_file| is passed,
1928 * it is opened and PEM-encoded CA certificates are read. If |ca_dir| is passed,
1929 * it is treated as a directory in OpenSSL's hashed directory format. It returns
1930 * one on success and zero on failure.
1931 *
1932 * See
1933 * https://www.openssl.org/docs/manmaster/ssl/SSL_CTX_load_verify_locations.html
1934 * for documentation on the directory format. */
1935OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
1936 const char *ca_file,
1937 const char *ca_dir);
1938
1939/* SSL_get_verify_result returns the result of certificate verification. It is
1940 * either |X509_V_OK| or a |X509_V_ERR_*| value. */
1941OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
1942
1943/* SSL_set_verify_result overrides the result of certificate verification. */
1944OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long result);
1945
1946/* SSL_get_ex_data_X509_STORE_CTX_idx returns the ex_data index used to look up
1947 * the |SSL| associated with an |X509_STORE_CTX| in the verify callback. */
1948OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
1949
1950/* SSL_CTX_set_cert_verify_callback sets a custom callback to be called on
1951 * certificate verification rather than |X509_verify_cert|. |store_ctx| contains
1952 * the verification parameters. The callback should return one on success and
1953 * zero on fatal error. It may use |X509_STORE_CTX_set_error| to set a
1954 * verification result.
1955 *
1956 * The callback may use either the |arg| parameter or
1957 * |SSL_get_ex_data_X509_STORE_CTX_idx| to recover the associated |SSL|
1958 * object. */
1959OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
1960 SSL_CTX *ctx, int (*callback)(X509_STORE_CTX *store_ctx, void *arg),
1961 void *arg);
1962
David Benjamind3a53c82015-09-20 00:00:28 -04001963/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1964 * of a connection) to request SCTs from the server. See
1965 * https://tools.ietf.org/html/rfc6962. It returns one. */
1966OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
1967
1968/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
1969 * objects created from |ctx|. */
1970OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
1971
1972/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1973 * |*out_len| bytes of SCT information from the server. This is only valid if
1974 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1975 * (including the two leading length bytes).
1976 * See https://tools.ietf.org/html/rfc6962#section-3.3
1977 * If no SCT was received then |*out_len| will be zero on return.
1978 *
1979 * WARNING: the returned data is not guaranteed to be well formed. */
1980OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
1981 const uint8_t **out,
1982 size_t *out_len);
1983
1984/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
1985 * connection) to request a stapled OCSP response from the server. It returns
1986 * one. */
1987OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
1988
1989/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
1990 * created from |ctx|. */
1991OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
1992
1993/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1994 * bytes of an OCSP response from the server. This is the DER encoding of an
1995 * OCSPResponse type as defined in RFC 2560.
1996 *
1997 * WARNING: the returned data is not guaranteed to be well formed. */
1998OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1999 size_t *out_len);
2000
David Benjamin59937042015-09-19 13:04:22 -04002001
2002/* Client certificate CA list.
2003 *
2004 * When requesting a client certificate, a server may advertise a list of
2005 * certificate authorities which are accepted. These functions may be used to
2006 * configure this list. */
2007
2008/* SSL_set_client_CA_list sets |ssl|'s client certificate CA list to
2009 * |name_list|. It takes ownership of |name_list|. */
2010OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *ssl,
2011 STACK_OF(X509_NAME) *name_list);
2012
2013/* SSL_CTX_set_client_CA_list sets |ctx|'s client certificate CA list to
2014 * |name_list|. It takes ownership of |name_list|. */
2015OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2016 STACK_OF(X509_NAME) *name_list);
2017
David Benjaminfd8e69f2015-10-03 10:49:20 -04002018/* SSL_get_client_CA_list returns |ssl|'s client certificate CA list. If |ssl|
2019 * has not been configured as a client, this is the list configured by
2020 * |SSL_CTX_set_client_CA_list|.
2021 *
2022 * If configured as a client, it returns the client certificate CA list sent by
2023 * the server. In this mode, the behavior is undefined except during the
2024 * callbacks set by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or
2025 * when the handshake is paused because of them. */
David Benjamin59937042015-09-19 13:04:22 -04002026OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *ssl);
2027
2028/* SSL_CTX_get_client_CA_list returns |ctx|'s client certificate CA list. */
2029OPENSSL_EXPORT STACK_OF(X509_NAME) *
2030 SSL_CTX_get_client_CA_list(const SSL_CTX *ctx);
2031
2032/* SSL_add_client_CA appends |x509|'s subject to the client certificate CA list.
2033 * It returns one on success or zero on error. The caller retains ownership of
2034 * |x509|. */
2035OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x509);
2036
2037/* SSL_CTX_add_client_CA appends |x509|'s subject to the client certificate CA
2038 * list. It returns one on success or zero on error. The caller retains
2039 * ownership of |x509|. */
2040OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x509);
2041
2042/* SSL_load_client_CA_file opens |file| and reads PEM-encoded certificates from
2043 * it. It returns a newly-allocated stack of the certificate subjects or NULL
2044 * on error. */
2045OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
2046
2047/* SSL_dup_CA_list makes a deep copy of |list|. It returns the new list on
2048 * success or NULL on allocation error. */
2049OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *list);
2050
2051/* SSL_add_file_cert_subjects_to_stack behaves like |SSL_load_client_CA_file|
2052 * but appends the result to |out|. It returns one on success or zero on
2053 * error. */
2054OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *out,
2055 const char *file);
2056
2057/* SSL_add_dir_cert_subjects_to_stack lists files in directory |dir|. It calls
2058 * |SSL_add_file_cert_subjects_to_stack| on each file and returns one on success
2059 * or zero on error. */
2060OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *out,
2061 const char *dir);
2062
2063
David Benjamin8984f1f2015-09-16 00:10:19 -04002064/* Application-layer protocol negotation.
2065 *
2066 * The ALPN extension (RFC 7301) allows negotiating different application-layer
2067 * protocols over a single port. This is used, for example, to negotiate
2068 * HTTP/2. */
2069
2070/* SSL_CTX_set_alpn_protos sets the client ALPN protocol list on |ctx| to
2071 * |protos|. |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2072 * length-prefixed strings). It returns zero on success and one on failure.
2073 * Configuring this list enables ALPN on a client.
2074 *
2075 * WARNING: this function is dangerous because it breaks the usual return value
2076 * convention. */
2077OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
2078 unsigned protos_len);
2079
2080/* SSL_set_alpn_protos sets the client ALPN protocol list on |ssl| to |protos|.
2081 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2082 * length-prefixed strings). It returns zero on success and one on failure.
2083 * Configuring this list enables ALPN on a client.
2084 *
2085 * WARNING: this function is dangerous because it breaks the usual return value
2086 * convention. */
2087OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
2088 unsigned protos_len);
2089
2090/* SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is called
2091 * during ClientHello processing in order to select an ALPN protocol from the
2092 * client's list of offered protocols. Configuring this callback enables ALPN on
2093 * a server.
2094 *
2095 * The callback is passed a wire-format (i.e. a series of non-empty, 8-bit
2096 * length-prefixed strings) ALPN protocol list in |in|. It should set |*out| and
2097 * |*out_len| to the selected protocol and return |SSL_TLSEXT_ERR_OK| on
2098 * success. It does not pass ownership of the buffer. Otherwise, it should
2099 * return |SSL_TLSEXT_ERR_NOACK|. Other |SSL_TLSEXT_ERR_*| values are
2100 * unimplemented and will be treated as |SSL_TLSEXT_ERR_NOACK|. */
2101OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
2102 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *out_len,
2103 const uint8_t *in, unsigned in_len, void *arg),
2104 void *arg);
2105
2106/* SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2107 * On return it sets |*out_data| to point to |*out_len| bytes of protocol name
2108 * (not including the leading length-prefix byte). If the server didn't respond
2109 * with a negotiated protocol then |*out_len| will be zero. */
2110OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl,
2111 const uint8_t **out_data,
2112 unsigned *out_len);
2113
2114
David Benjamin977547b2015-09-16 00:25:52 -04002115/* Next protocol negotiation.
2116 *
2117 * The NPN extension (draft-agl-tls-nextprotoneg-03) is the predecessor to ALPN
2118 * and deprecated in favor of it. */
2119
2120/* SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when a
2121 * TLS server needs a list of supported protocols for Next Protocol
2122 * Negotiation. The returned list must be in wire format. The list is returned
2123 * by setting |*out| to point to it and |*out_len| to its length. This memory
2124 * will not be modified, but one should assume that |ssl| keeps a reference to
2125 * it.
2126 *
2127 * The callback should return |SSL_TLSEXT_ERR_OK| if it wishes to advertise.
2128 * Otherwise, no such extension will be included in the ServerHello. */
2129OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
2130 SSL_CTX *ctx,
2131 int (*cb)(SSL *ssl, const uint8_t **out, unsigned *out_len, void *arg),
2132 void *arg);
2133
2134/* SSL_CTX_set_next_proto_select_cb sets a callback that is called when a client
2135 * needs to select a protocol from the server's provided list. |*out| must be
2136 * set to point to the selected protocol (which may be within |in|). The length
2137 * of the protocol name must be written into |*out_len|. The server's advertised
2138 * protocols are provided in |in| and |in_len|. The callback can assume that
2139 * |in| is syntactically valid.
2140 *
2141 * The client must select a protocol. It is fatal to the connection if this
2142 * callback returns a value other than |SSL_TLSEXT_ERR_OK|.
2143 *
2144 * Configuring this callback enables NPN on a client. */
2145OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
2146 SSL_CTX *ctx, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *out_len,
2147 const uint8_t *in, unsigned in_len, void *arg),
2148 void *arg);
2149
2150/* SSL_get0_next_proto_negotiated sets |*out_data| and |*out_len| to point to
2151 * the client's requested protocol for this connection. If the client didn't
2152 * request any protocol, then |*out_data| is set to NULL.
2153 *
2154 * Note that the client can request any protocol it chooses. The value returned
2155 * from this function need not be a member of the list of supported protocols
2156 * provided by the server. */
2157OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *ssl,
2158 const uint8_t **out_data,
2159 unsigned *out_len);
2160
2161/* SSL_select_next_proto implements the standard protocol selection. It is
2162 * expected that this function is called from the callback set by
2163 * |SSL_CTX_set_next_proto_select_cb|.
2164 *
2165 * The protocol data is assumed to be a vector of 8-bit, length prefixed byte
2166 * strings. The length byte itself is not included in the length. A byte
2167 * string of length 0 is invalid. No byte string may be truncated.
2168 *
2169 * The current, but experimental algorithm for selecting the protocol is:
2170 *
2171 * 1) If the server doesn't support NPN then this is indicated to the
2172 * callback. In this case, the client application has to abort the connection
2173 * or have a default application level protocol.
2174 *
2175 * 2) If the server supports NPN, but advertises an empty list then the
2176 * client selects the first protcol in its list, but indicates via the
2177 * API that this fallback case was enacted.
2178 *
2179 * 3) Otherwise, the client finds the first protocol in the server's list
2180 * that it supports and selects this protocol. This is because it's
2181 * assumed that the server has better information about which protocol
2182 * a client should use.
2183 *
2184 * 4) If the client doesn't support any of the server's advertised
2185 * protocols, then this is treated the same as case 2.
2186 *
2187 * It returns either |OPENSSL_NPN_NEGOTIATED| if a common protocol was found, or
2188 * |OPENSSL_NPN_NO_OVERLAP| if the fallback case was reached. */
2189OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *out_len,
2190 const uint8_t *server,
2191 unsigned server_len,
2192 const uint8_t *client,
2193 unsigned client_len);
2194
2195#define OPENSSL_NPN_UNSUPPORTED 0
2196#define OPENSSL_NPN_NEGOTIATED 1
2197#define OPENSSL_NPN_NO_OVERLAP 2
2198
2199
David Benjamin42fea372015-09-19 01:22:44 -04002200/* Channel ID.
2201 *
2202 * See draft-balfanz-tls-channelid-01. */
2203
2204/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
2205 * Channel IDs from clients, or configures a client to send TLS Channel IDs to
2206 * a server. It returns one. */
2207OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
2208
2209/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
2210 * Channel IDs from clients, or configures a client to send TLS Channel IDs to
2211 * server. It returns one. */
2212OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
2213
2214/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
2215 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
2216 * on success and zero on error. */
2217OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
2218 EVP_PKEY *private_key);
2219
2220/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
2221 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
2222 * success and zero on error. */
2223OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
2224
2225/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server |SSL*|
2226 * and copies up to the first |max_out| bytes into |out|. The Channel ID
2227 * consists of the client's P-256 public key as an (x,y) pair where each is a
2228 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
2229 * Channel ID and the length of the complete Channel ID otherwise. */
2230OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
2231 size_t max_out);
2232
2233/* SSL_CTX_set_channel_id_cb sets a callback to be called when a TLS Channel ID
2234 * is requested. The callback may set |*out_pkey| to a key, passing a reference
2235 * to the caller. If none is returned, the handshake will pause and
2236 * |SSL_get_error| will return |SSL_ERROR_WANT_CHANNEL_ID_LOOKUP|.
2237 *
2238 * See also |SSL_ERROR_WANT_CHANNEL_ID_LOOKUP|. */
2239OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
2240 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **out_pkey));
2241
2242/* SSL_CTX_get_channel_id_cb returns the callback set by
2243 * |SSL_CTX_set_channel_id_cb|. */
2244OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(
2245 SSL *ssl, EVP_PKEY **out_pkey);
2246
2247
David Benjamincfd65b62015-09-14 01:54:44 -04002248/* DTLS-SRTP.
2249 *
2250 * See RFC 5764. */
2251
2252/* An SRTP_PROTECTION_PROFILE is an SRTP profile for use with the use_srtp
2253 * extension. */
2254struct srtp_protection_profile_st {
2255 const char *name;
2256 unsigned long id;
2257} /* SRTP_PROTECTION_PROFILE */;
2258
2259DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
2260
2261/* SRTP_* define constants for SRTP profiles. */
2262#define SRTP_AES128_CM_SHA1_80 0x0001
2263#define SRTP_AES128_CM_SHA1_32 0x0002
2264#define SRTP_AES128_F8_SHA1_80 0x0003
2265#define SRTP_AES128_F8_SHA1_32 0x0004
2266#define SRTP_NULL_SHA1_80 0x0005
2267#define SRTP_NULL_SHA1_32 0x0006
2268
2269/* SSL_CTX_set_srtp_profiles enables SRTP for all SSL objects created from
2270 * |ctx|. |profile| contains a colon-separated list of profile names. It returns
2271 * one on success and zero on failure. */
2272OPENSSL_EXPORT int SSL_CTX_set_srtp_profiles(SSL_CTX *ctx,
2273 const char *profiles);
2274
2275/* SSL_set_srtp_profiles enables SRTP for |ssl|. |profile| contains a
2276 * colon-separated list of profile names. It returns one on success and zero on
2277 * failure. */
2278OPENSSL_EXPORT int SSL_set_srtp_profiles(SSL *ssl, const char *profiles);
2279
2280/* SSL_get_srtp_profiles returns the SRTP profiles supported by |ssl|. */
2281OPENSSL_EXPORT STACK_OF(SRTP_PROTECTION_PROFILE) *SSL_get_srtp_profiles(
2282 SSL *ssl);
2283
2284/* SSL_get_selected_srtp_profile returns the selected SRTP profile, or NULL if
2285 * SRTP was not negotiated. */
2286OPENSSL_EXPORT const SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile(
2287 SSL *ssl);
2288
2289
David Benjamine8814df2015-09-15 08:05:54 -04002290/* Pre-shared keys.
2291 *
2292 * Connections may be configured with PSK (Pre-Shared Key) cipher suites. These
2293 * authenticate using out-of-band pre-shared keys rather than certificates. See
2294 * RFC 4279.
2295 *
2296 * This implementation uses NUL-terminated C strings for identities and identity
2297 * hints, so values with a NUL character are not supported. (RFC 4279 does not
2298 * specify the format of an identity.) */
2299
2300/* PSK_MAX_IDENTITY_LEN is the maximum supported length of a PSK identity,
2301 * excluding the NUL terminator. */
2302#define PSK_MAX_IDENTITY_LEN 128
2303
2304/* PSK_MAX_PSK_LEN is the maximum supported length of a pre-shared key. */
2305#define PSK_MAX_PSK_LEN 256
2306
2307/* SSL_CTX_set_psk_client_callback sets the callback to be called when PSK is
2308 * negotiated on the client. This callback must be set to enable PSK cipher
2309 * suites on the client.
2310 *
2311 * The callback is passed the identity hint in |hint| or NULL if none was
2312 * provided. It should select a PSK identity and write the identity and the
2313 * corresponding PSK to |identity| and |psk|, respectively. The identity is
2314 * written as a NUL-terminated C string of length (excluding the NUL terminator)
2315 * at most |max_identity_len|. The PSK's length must be at most |max_psk_len|.
2316 * The callback returns the length of the PSK or 0 if no suitable identity was
2317 * found. */
2318OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
2319 SSL_CTX *ctx,
2320 unsigned (*psk_client_callback)(
2321 SSL *ssl, const char *hint, char *identity,
2322 unsigned max_identity_len, uint8_t *psk, unsigned max_psk_len));
2323
2324/* SSL_set_psk_client_callback sets the callback to be called when PSK is
2325 * negotiated on the client. This callback must be set to enable PSK cipher
2326 * suites on the client. See also |SSL_CTX_set_psk_client_callback|. */
2327OPENSSL_EXPORT void SSL_set_psk_client_callback(
2328 SSL *ssl, unsigned (*psk_client_callback)(SSL *ssl, const char *hint,
2329 char *identity,
2330 unsigned max_identity_len,
2331 uint8_t *psk,
2332 unsigned max_psk_len));
2333
2334/* SSL_CTX_set_psk_server_callback sets the callback to be called when PSK is
2335 * negotiated on the server. This callback must be set to enable PSK cipher
2336 * suites on the server.
2337 *
2338 * The callback is passed the identity in |identity|. It should write a PSK of
2339 * length at most |max_psk_len| to |psk| and return the number of bytes written
2340 * or zero if the PSK identity is unknown. */
2341OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
2342 SSL_CTX *ctx,
2343 unsigned (*psk_server_callback)(SSL *ssl, const char *identity,
2344 uint8_t *psk,
2345 unsigned max_psk_len));
2346
2347/* SSL_set_psk_server_callback sets the callback to be called when PSK is
2348 * negotiated on the server. This callback must be set to enable PSK cipher
2349 * suites on the server. See also |SSL_CTX_set_psk_server_callback|. */
2350OPENSSL_EXPORT void SSL_set_psk_server_callback(
2351 SSL *ssl,
2352 unsigned (*psk_server_callback)(SSL *ssl, const char *identity,
2353 uint8_t *psk,
2354 unsigned max_psk_len));
2355
2356/* SSL_CTX_use_psk_identity_hint configures server connections to advertise an
2357 * identity hint of |identity_hint|. It returns one on success and zero on
2358 * error. */
2359OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
2360 const char *identity_hint);
2361
2362/* SSL_use_psk_identity_hint configures server connections to advertise an
2363 * identity hint of |identity_hint|. It returns one on success and zero on
2364 * error. */
2365OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *ssl,
2366 const char *identity_hint);
2367
2368/* SSL_get_psk_identity_hint returns the PSK identity hint advertised for |ssl|
2369 * or NULL if there is none. */
2370OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *ssl);
2371
2372/* SSL_get_psk_identity, after the handshake completes, returns the PSK identity
2373 * that was negotiated by |ssl| or NULL if PSK was not used. */
2374OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *ssl);
2375
2376
David Benjamin190ab7f2015-09-13 14:20:58 -04002377/* ex_data functions.
2378 *
2379 * See |ex_data.h| for details. */
2380
2381OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2382OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2383OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2384 CRYPTO_EX_new *new_func,
2385 CRYPTO_EX_dup *dup_func,
2386 CRYPTO_EX_free *free_func);
2387
2388OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *session, int idx,
2389 void *data);
2390OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *session,
2391 int idx);
2392OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2393 CRYPTO_EX_new *new_func,
2394 CRYPTO_EX_dup *dup_func,
2395 CRYPTO_EX_free *free_func);
2396
2397OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ctx, int idx, void *data);
2398OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ctx, int idx);
2399OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2400 CRYPTO_EX_new *new_func,
2401 CRYPTO_EX_dup *dup_func,
2402 CRYPTO_EX_free *free_func);
2403
2404
David Benjamin42fea372015-09-19 01:22:44 -04002405/* Obscure functions. */
2406
2407/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2408 * the read and write directions. It returns one on success or zero if |ssl|
2409 * isn't using an RC4-based cipher suite. */
2410OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2411 const RC4_KEY **write_key);
2412
2413/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2414 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2415 * these values. */
2416OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2417 size_t *ssl_ctx_size,
2418 size_t *ssl_session_size);
2419
David Benjamin0cfea342015-09-19 16:23:06 -04002420/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
2421 * This callback will be called when sending or receiving low-level record
2422 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
2423 * |write_p| is one for outgoing messages and zero for incoming messages.
2424 *
2425 * For each record header, |cb| is called with |version| = 0 and |content_type|
2426 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
2427 * this does not include the record body. If the record is sealed, the length
2428 * in the header is the length of the ciphertext.
2429 *
2430 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
2431 * protocol version and |content_type| is the corresponding record type. The
2432 * |len| bytes from |buf| contain the handshake message, one-byte
2433 * ChangeCipherSpec body, and two-byte alert, respectively. */
2434OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
2435 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
2436 const void *buf, size_t len, SSL *ssl, void *arg));
2437
2438/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
2439 * callback. */
2440OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
2441
2442/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
2443 * |SSL_CTX_set_msg_callback| for when this callback is called. */
2444OPENSSL_EXPORT void SSL_set_msg_callback(
2445 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
2446 const void *buf, size_t len, SSL *ssl, void *arg));
2447
2448/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
2449OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
2450
2451/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
2452 * log session material to |keylog_bio|. This is intended for debugging use
2453 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
2454 *
2455 * The format is described in
2456 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
2457OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
2458
David Benjamin1d5ef3b2015-10-12 19:54:18 -04002459enum ssl_renegotiate_mode_t {
2460 ssl_renegotiate_never = 0,
2461 ssl_renegotiate_once,
2462 ssl_renegotiate_freely,
2463};
2464
2465/* SSL_set_renegotiate_mode configures how |ssl|, a client, reacts to
2466 * renegotiation attempts by a server. If |ssl| is a server, peer-initiated
2467 * renegotiations are *always* rejected and this function does nothing.
2468 *
2469 * The renegotiation mode defaults to |ssl_renegotiate_never|, but may be set
2470 * at any point in a connection's lifetime. Set it to |ssl_renegotiate_once| to
2471 * allow one renegotiation and |ssl_renegotiate_freely| to allow all
2472 * renegotiations.
2473 *
2474 * There is no support in BoringSSL for initiating renegotiations as a client
2475 * or server. */
2476OPENSSL_EXPORT void SSL_set_renegotiate_mode(SSL *ssl,
2477 enum ssl_renegotiate_mode_t mode);
David Benjamin0cfea342015-09-19 16:23:06 -04002478
David Benjamin9f859492015-10-03 10:44:30 -04002479/* SSL_MAX_CERT_LIST_DEFAULT is the default maximum length, in bytes, of a peer
2480 * certificate chain. */
2481#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100
2482
2483/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2484 * certificate chain accepted by |ctx|. */
2485OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2486
2487/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2488 * certificate chain to |max_cert_list|. This affects how much memory may be
2489 * consumed during the handshake. */
2490OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2491 size_t max_cert_list);
2492
2493/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2494 * certificate chain accepted by |ssl|. */
2495OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2496
2497/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2498 * certificate chain to |max_cert_list|. This affects how much memory may be
2499 * consumed during the handshake. */
2500OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2501
2502/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2503 * sent by |ctx|. Beyond this length, handshake messages and application data
2504 * will be split into multiple records. */
2505OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2506 size_t max_send_fragment);
2507
2508/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2509 * sent by |ssl|. Beyond this length, handshake messages and application data
2510 * will be split into multiple records. */
2511OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2512 size_t max_send_fragment);
2513
David Benjamin42fea372015-09-19 01:22:44 -04002514
David Benjamin71f07942015-04-08 02:36:59 -04002515/* Underdocumented functions.
2516 *
2517 * Functions below here haven't been touched up and may be underdocumented. */
2518
Adam Langley95c29f32014-06-20 12:00:00 -07002519/* SSLeay version number for ASN.1 encoding of the session information */
2520/* Version 0 - initial version
Adam Langleyb4a494c2015-01-23 15:10:10 -08002521 * Version 1 - added the optional peer certificate. */
Adam Langley95c29f32014-06-20 12:00:00 -07002522#define SSL_SESSION_ASN1_VERSION 0x0001
2523
Adam Langleyb4a494c2015-01-23 15:10:10 -08002524#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
2525#define SSL_MAX_SID_CTX_LENGTH 32
2526#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -07002527
2528/* These are used to specify which ciphers to use and not to use */
2529
Adam Langleyb4a494c2015-01-23 15:10:10 -08002530#define SSL_TXT_MEDIUM "MEDIUM"
2531#define SSL_TXT_HIGH "HIGH"
2532#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -07002533
Adam Langleyb4a494c2015-01-23 15:10:10 -08002534#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -04002535#define SSL_TXT_kDHE "kDHE"
2536#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
2537#define SSL_TXT_kECDHE "kECDHE"
2538#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002539#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07002540
Adam Langleyb4a494c2015-01-23 15:10:10 -08002541#define SSL_TXT_aRSA "aRSA"
2542#define SSL_TXT_aECDSA "aECDSA"
2543#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07002544
Adam Langleyb4a494c2015-01-23 15:10:10 -08002545#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -04002546#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04002547#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002548#define SSL_TXT_RSA "RSA"
2549#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -04002550#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04002551#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002552#define SSL_TXT_ECDSA "ECDSA"
2553#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -07002554
Adam Langleyb4a494c2015-01-23 15:10:10 -08002555#define SSL_TXT_3DES "3DES"
2556#define SSL_TXT_RC4 "RC4"
2557#define SSL_TXT_AES128 "AES128"
2558#define SSL_TXT_AES256 "AES256"
2559#define SSL_TXT_AES "AES"
2560#define SSL_TXT_AES_GCM "AESGCM"
2561#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -07002562
Adam Langleyb4a494c2015-01-23 15:10:10 -08002563#define SSL_TXT_MD5 "MD5"
2564#define SSL_TXT_SHA1 "SHA1"
2565#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
2566#define SSL_TXT_SHA256 "SHA256"
2567#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -07002568
Adam Langleyb4a494c2015-01-23 15:10:10 -08002569#define SSL_TXT_SSLV3 "SSLv3"
2570#define SSL_TXT_TLSV1 "TLSv1"
2571#define SSL_TXT_TLSV1_1 "TLSv1.1"
2572#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -07002573
Adam Langleyb4a494c2015-01-23 15:10:10 -08002574#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -07002575
Adam Langleyb4a494c2015-01-23 15:10:10 -08002576#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -07002577
Adam Langley95c29f32014-06-20 12:00:00 -07002578/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002579#define SSL_SENT_SHUTDOWN 1
2580#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -07002581
David Benjamin82c9e902014-12-12 15:55:27 -05002582typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07002583typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -05002584typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07002585
Adam Langleyc9fb3752014-06-20 12:00:00 -07002586struct ssl_aead_ctx_st;
2587typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
2588
Adam Langleydc9b1412014-06-20 12:00:00 -07002589/* ssl_early_callback_ctx is passed to certain callbacks that are called very
Adam Langleyb4a494c2015-01-23 15:10:10 -08002590 * early on during the server handshake. At this point, much of the SSL* hasn't
2591 * been filled out and only the ClientHello can be depended on. */
2592struct ssl_early_callback_ctx {
2593 SSL *ssl;
2594 const uint8_t *client_hello;
2595 size_t client_hello_len;
2596 const uint8_t *session_id;
2597 size_t session_id_len;
2598 const uint8_t *cipher_suites;
2599 size_t cipher_suites_len;
2600 const uint8_t *compression_methods;
2601 size_t compression_methods_len;
2602 const uint8_t *extensions;
2603 size_t extensions_len;
2604};
Adam Langleydc9b1412014-06-20 12:00:00 -07002605
Adam Langleyb4a494c2015-01-23 15:10:10 -08002606/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
2607 * extension of the given type. If not found, it returns zero. Otherwise it
2608 * sets |out_data| to point to the extension contents (not including the type
Adam Langleydc9b1412014-06-20 12:00:00 -07002609 * and length bytes), sets |out_len| to the length of the extension contents
2610 * and returns one. */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002611OPENSSL_EXPORT char SSL_early_callback_ctx_extension_get(
2612 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
2613 const uint8_t **out_data, size_t *out_len);
Adam Langleydc9b1412014-06-20 12:00:00 -07002614
Adam Langleyb4a494c2015-01-23 15:10:10 -08002615OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
2616 void (*cb)(const SSL *ssl,
2617 int type, int val));
2618OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
2619 int type,
2620 int val);
David Benjamin6c7aed02014-08-27 16:42:38 -04002621
Adam Langleyb4a494c2015-01-23 15:10:10 -08002622#define SSL_NOTHING 1
2623#define SSL_WRITING 2
2624#define SSL_READING 3
2625#define SSL_X509_LOOKUP 4
2626#define SSL_CHANNEL_ID_LOOKUP 5
2627#define SSL_PENDING_SESSION 7
2628#define SSL_CERTIFICATE_SELECTION_PENDING 8
David Benjaminb4d65fd2015-05-29 17:11:21 -04002629#define SSL_PRIVATE_KEY_OPERATION 9
Adam Langley95c29f32014-06-20 12:00:00 -07002630
2631/* These will only be used when doing non-blocking IO */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002632#define SSL_want_nothing(s) (SSL_want(s) == SSL_NOTHING)
2633#define SSL_want_read(s) (SSL_want(s) == SSL_READING)
2634#define SSL_want_write(s) (SSL_want(s) == SSL_WRITING)
2635#define SSL_want_x509_lookup(s) (SSL_want(s) == SSL_X509_LOOKUP)
2636#define SSL_want_channel_id_lookup(s) (SSL_want(s) == SSL_CHANNEL_ID_LOOKUP)
2637#define SSL_want_session(s) (SSL_want(s) == SSL_PENDING_SESSION)
2638#define SSL_want_certificate(s) \
2639 (SSL_want(s) == SSL_CERTIFICATE_SELECTION_PENDING)
David Benjaminb4d65fd2015-05-29 17:11:21 -04002640#define SSL_want_private_key_operation(s) \
2641 (SSL_want(s) == SSL_PRIVATE_KEY_OPERATION)
Adam Langley95c29f32014-06-20 12:00:00 -07002642
Adam Langleyb4a494c2015-01-23 15:10:10 -08002643/* The following are the possible values for ssl->state are are used to
2644 * indicate where we are up to in the SSL connection establishment. The macros
2645 * that follow are about the only things you should need to use and even then,
2646 * only when using non-blocking IO. It can also be useful to work out where you
2647 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07002648
Adam Langleyb4a494c2015-01-23 15:10:10 -08002649#define SSL_ST_CONNECT 0x1000
2650#define SSL_ST_ACCEPT 0x2000
2651#define SSL_ST_MASK 0x0FFF
2652#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08002653#define SSL_ST_OK 0x03
2654#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07002655
Adam Langleyb4a494c2015-01-23 15:10:10 -08002656#define SSL_CB_LOOP 0x01
2657#define SSL_CB_EXIT 0x02
2658#define SSL_CB_READ 0x04
2659#define SSL_CB_WRITE 0x08
2660#define SSL_CB_ALERT 0x4000 /* used in callback */
2661#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
2662#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
2663#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
2664#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
2665#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
2666#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
2667#define SSL_CB_HANDSHAKE_START 0x10
2668#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07002669
2670/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002671#define SSL_get_state(a) SSL_state(a)
2672#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05002673#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08002674#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
2675#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05002676
David Benjamined7c4752015-02-16 19:16:46 -05002677/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
2678 * is in False Start. |SSL_write| may be called at this point without waiting
2679 * for the peer, but |SSL_read| will require the handshake to be completed. */
2680OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
2681
Adam Langley95c29f32014-06-20 12:00:00 -07002682/* Obtain latest Finished message
2683 * -- that we sent (SSL_get_finished)
2684 * -- that we expected from peer (SSL_get_peer_finished).
2685 * Returns length (0 == no Finished so far), copies up to 'count' bytes. */
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002686OPENSSL_EXPORT size_t SSL_get_finished(const SSL *s, void *buf, size_t count);
2687OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *s, void *buf, size_t count);
Adam Langley95c29f32014-06-20 12:00:00 -07002688
Adam Langleyb4a494c2015-01-23 15:10:10 -08002689#define d2i_SSL_SESSION_bio(bp, s_id) \
2690 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
2691#define i2d_SSL_SESSION_bio(bp, s_id) \
2692 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07002693
2694DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
2695
Adam Langleyb4a494c2015-01-23 15:10:10 -08002696/* make_errors.go reserves error codes above 1000 for manually-assigned errors.
2697 * This value must be kept in sync with reservedReasonCode in make_errors.h */
2698#define SSL_AD_REASON_OFFSET \
2699 1000 /* offset to get SSL_R_... value from SSL_AD_... */
Adam Langley95c29f32014-06-20 12:00:00 -07002700
2701/* These alert types are for SSLv3 and TLSv1 */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002702#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
2703#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE /* fatal */
2704#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC /* fatal */
2705#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
2706#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
2707#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE /* fatal */
2708#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE /* fatal */
2709#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not for TLS */
2710#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
2711#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
2712#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
2713#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
2714#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
2715#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER /* fatal */
2716#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA /* fatal */
2717#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED /* fatal */
2718#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR /* fatal */
2719#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
2720#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION /* fatal */
2721#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION /* fatal */
2722#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY /* fatal */
2723#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR /* fatal */
2724#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
2725#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
2726#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
Adam Langley95c29f32014-06-20 12:00:00 -07002727#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
Adam Langleyb4a494c2015-01-23 15:10:10 -08002728#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
2729#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
2730 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
Adam Langley95c29f32014-06-20 12:00:00 -07002731#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
Adam Langleyb4a494c2015-01-23 15:10:10 -08002732#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY /* fatal */
2733#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK /* fatal */
Adam Langley95c29f32014-06-20 12:00:00 -07002734
David Benjaminc0454692015-04-27 00:28:56 -04002735/* SSL_total_renegotiations returns the total number of renegotiation handshakes
2736 * peformed by |ssl|. This includes the pending renegotiation, if any. */
2737OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
2738
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002739OPENSSL_EXPORT int SSL_want(const SSL *s);
Adam Langley95c29f32014-06-20 12:00:00 -07002740
Adam Langleyb4a494c2015-01-23 15:10:10 -08002741OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
2742OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
2743OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002744OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
2745OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
2746OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
Adam Langley95c29f32014-06-20 12:00:00 -07002747
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002748OPENSSL_EXPORT const char *SSL_state_string(const SSL *s);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002749OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *s);
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02002750
Adam Langleyb4a494c2015-01-23 15:10:10 -08002751OPENSSL_EXPORT int SSL_SESSION_print_fp(FILE *fp, const SSL_SESSION *ses);
2752OPENSSL_EXPORT int SSL_SESSION_print(BIO *fp, const SSL_SESSION *ses);
David Benjamin33639842015-02-09 03:34:47 -05002753
David Benjamin44d3eed2015-05-21 01:29:55 -04002754/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2755 * renegotiation. */
2756OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2757
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002758OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2759OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
2760OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2761OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
Adam Langley95c29f32014-06-20 12:00:00 -07002762
Adam Langleyb4a494c2015-01-23 15:10:10 -08002763OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002764OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002765OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002766OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002767OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002768 void (*cb)(const SSL *ssl, int type,
2769 int val));
2770OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2771 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002772OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002773
Adam Langley524e7172015-02-20 16:04:00 -08002774/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2775 * resumption decision for a ClientHello has been made. It can return 1 to
2776 * allow the handshake to continue or zero to cause the handshake to abort. */
David Benjamin72f59112015-04-02 16:47:15 -04002777OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
Adam Langley524e7172015-02-20 16:04:00 -08002778 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2779
Adam Langley95c29f32014-06-20 12:00:00 -07002780
David Benjamin71f07942015-04-08 02:36:59 -04002781/* Deprecated functions. */
2782
David Benjamin1d5ef3b2015-10-12 19:54:18 -04002783/* SSL_set_reject_peer_renegotiations calls |SSL_set_renegotiate_mode| with
2784 * |ssl_never_renegotiate| if |reject| is one and |ssl_renegotiate_freely| if
2785 * zero. */
2786OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
2787
David Benjamin71f07942015-04-08 02:36:59 -04002788/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2789 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2790 * freed with |OPENSSL_free|, or NULL on error.
2791 *
2792 * The description includes a trailing newline and has the form:
2793 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2794 *
2795 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2796OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2797 char *buf, int len);
2798
2799/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2800OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2801
David Benjamin3fb1ebc2015-09-16 00:29:20 -04002802typedef void COMP_METHOD;
2803
David Benjamin71f07942015-04-08 02:36:59 -04002804/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002805OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002806
2807/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002808OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002809
2810/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002811OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002812
David Benjamin0d8a7582015-04-08 23:55:15 -04002813/* SSLv23_method calls |TLS_method|. */
2814OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2815
2816/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2817 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2818 * to lock connections to that protocol version. */
2819OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2820OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2821OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2822OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2823OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2824OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2825
2826/* Client- and server-specific methods call their corresponding generic
2827 * methods. */
2828OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2829OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2830OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2831OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2832OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2833OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2834OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2835OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2836OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2837OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2838OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2839OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2840OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2841OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2842OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2843OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2844
David Benjamin4831c332015-05-16 11:43:13 -04002845/* SSL_clear resets |ssl| to allow another connection and returns one on success
2846 * or zero on failure. It returns most configuration state but releases memory
2847 * associated with the current connection.
2848 *
2849 * Free |ssl| and create a new one instead. */
2850OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2851
David Benjamin59015c32015-04-26 13:13:55 -04002852/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2853OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2854 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002855
David Benjamin59015c32015-04-26 13:13:55 -04002856/* SSL_set_tmp_rsa_callback does nothing. */
2857OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2858 RSA *(*cb)(SSL *ssl, int is_export,
2859 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002860
David Benjaminda881e92015-04-26 14:45:04 -04002861/* SSL_CTX_sess_connect returns zero. */
2862OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2863
2864/* SSL_CTX_sess_connect_good returns zero. */
2865OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2866
2867/* SSL_CTX_sess_connect_renegotiate returns zero. */
2868OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2869
2870/* SSL_CTX_sess_accept returns zero. */
2871OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2872
2873/* SSL_CTX_sess_accept_renegotiate returns zero. */
2874OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2875
2876/* SSL_CTX_sess_accept_good returns zero. */
2877OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2878
2879/* SSL_CTX_sess_hits returns zero. */
2880OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2881
2882/* SSL_CTX_sess_cb_hits returns zero. */
2883OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2884
2885/* SSL_CTX_sess_misses returns zero. */
2886OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2887
2888/* SSL_CTX_sess_timeouts returns zero. */
2889OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2890
2891/* SSL_CTX_sess_cache_full returns zero. */
2892OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2893
David Benjamin101ead22015-04-26 18:36:23 -04002894/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2895OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2896
David Benjaminc0454692015-04-27 00:28:56 -04002897/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2898OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2899
2900/* SSL_CTX_need_tmp_RSA returns zero. */
2901OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2902
2903/* SSL_need_tmp_RSA returns zero. */
2904OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2905
2906/* SSL_CTX_set_tmp_rsa returns one. */
2907OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2908
2909/* SSL_set_tmp_rsa returns one. */
2910OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2911
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002912/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002913OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2914
2915/* SSL_CTX_set_read_ahead does nothing. */
2916OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2917
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002918/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002919OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2920
2921/* SSL_set_read_ahead does nothing. */
2922OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
2923
David Benjamin44d3eed2015-05-21 01:29:55 -04002924/* SSL_renegotiate put an error on the error queue and returns zero. */
2925OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
2926
David Benjaminece089c2015-05-15 23:52:42 -04002927/* SSL_set_state does nothing. */
2928OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
2929
David Benjamin7e40d4e2015-09-07 13:17:45 -04002930/* SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START. */
2931#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
2932
2933/* i2d_SSL_SESSION serializes |in| to the bytes pointed to by |*pp|. On success,
2934 * it returns the number of bytes written and advances |*pp| by that many bytes.
2935 * On failure, it returns -1. If |pp| is NULL, no bytes are written and only the
2936 * length is returned.
2937 *
2938 * Use |SSL_SESSION_to_bytes| instead. */
2939OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
2940
2941/* d2i_SSL_SESSION parses a serialized session from the |length| bytes pointed
2942 * to by |*pp|. It returns the new |SSL_SESSION| and advances |*pp| by the
2943 * number of bytes consumed on success and NULL on failure. The caller takes
2944 * ownership of the new session and must call |SSL_SESSION_free| when done.
2945 *
2946 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
2947 *
2948 * Use |SSL_SESSION_from_bytes| instead. */
2949OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
2950 long length);
2951
David Benjamin27bbae42015-09-13 00:54:37 -04002952/* ERR_load_SSL_strings does nothing. */
2953OPENSSL_EXPORT void ERR_load_SSL_strings(void);
2954
2955/* SSL_load_error_strings does nothing. */
2956OPENSSL_EXPORT void SSL_load_error_strings(void);
2957
David Benjamincfd65b62015-09-14 01:54:44 -04002958/* SSL_CTX_set_tlsext_use_srtp calls |SSL_CTX_set_srtp_profiles|. It returns
2959 * zero on success and one on failure.
2960 *
2961 * WARNING: this function is dangerous because it breaks the usual return value
2962 * convention. Use |SSL_CTX_set_srtp_profiles| instead. */
2963OPENSSL_EXPORT int SSL_CTX_set_tlsext_use_srtp(SSL_CTX *ctx,
2964 const char *profiles);
2965
2966/* SSL_set_tlsext_use_srtp calls |SSL_set_srtp_profiles|. It returns zero on
2967 * success and one on failure.
2968 *
2969 * WARNING: this function is dangerous because it breaks the usual return value
2970 * convention. Use |SSL_set_srtp_profiles| instead. */
2971OPENSSL_EXPORT int SSL_set_tlsext_use_srtp(SSL *ssl, const char *profiles);
2972
David Benjamin3fb1ebc2015-09-16 00:29:20 -04002973/* SSL_get_current_compression returns NULL. */
2974OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
2975
2976/* SSL_get_current_expansion returns NULL. */
2977OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
2978
2979#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
2980#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
2981#define SSL_SESSION_set_app_data(s, a) \
2982 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
2983#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
2984#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
2985#define SSL_CTX_set_app_data(ctx, arg) \
2986 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
2987
2988#define OpenSSL_add_ssl_algorithms() SSL_library_init()
2989#define SSLeay_add_ssl_algorithms() SSL_library_init()
2990
2991#define SSL_get_cipher(ssl) SSL_CIPHER_get_name(SSL_get_current_cipher(ssl))
2992#define SSL_get_cipher_bits(ssl, out_alg_bits) \
2993 SSL_CIPHER_get_bits(SSL_get_current_cipher(ssl), out_alg_bits)
2994#define SSL_get_cipher_version(ssl) \
2995 SSL_CIPHER_get_version(SSL_get_current_cipher(ssl))
2996#define SSL_get_cipher_name(ssl) \
2997 SSL_CIPHER_get_name(SSL_get_current_cipher(ssl))
2998#define SSL_get_time(session) SSL_SESSION_get_time(session)
2999#define SSL_set_time(session, time) SSL_SESSION_set_time((session), (time))
3000#define SSL_get_timeout(session) SSL_SESSION_get_timeout(session)
3001#define SSL_set_timeout(session, timeout) \
3002 SSL_SESSION_set_timeout((session), (timeout))
3003
3004typedef struct ssl_comp_st SSL_COMP;
3005
3006struct ssl_comp_st {
3007 int id;
3008 const char *name;
3009 char *method;
3010};
3011
3012DECLARE_STACK_OF(SSL_COMP)
3013
3014/* The following flags toggle individual protocol versions. This is deprecated.
3015 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
3016#define SSL_OP_NO_SSLv3 0x02000000L
3017#define SSL_OP_NO_TLSv1 0x04000000L
3018#define SSL_OP_NO_TLSv1_2 0x08000000L
3019#define SSL_OP_NO_TLSv1_1 0x10000000L
3020#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
3021#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
3022
3023/* The following flags do nothing and are included only to make it easier to
3024 * compile code with BoringSSL. */
David Benjamin907bd302015-09-19 13:29:36 -04003025#define SSL_MODE_AUTO_RETRY 0
3026#define SSL_MODE_RELEASE_BUFFERS 0
3027#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
3028#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjamin3fb1ebc2015-09-16 00:29:20 -04003029#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
3030#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
3031#define SSL_OP_EPHEMERAL_RSA 0
3032#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
3033#define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
3034#define SSL_OP_NETSCAPE_CA_DN_BUG 0
3035#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
3036#define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
3037#define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
3038#define SSL_OP_NO_COMPRESSION 0
3039#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
3040#define SSL_OP_NO_SSLv2 0
3041#define SSL_OP_PKCS1_CHECK_1 0
3042#define SSL_OP_PKCS1_CHECK_2 0
3043#define SSL_OP_SINGLE_DH_USE 0
3044#define SSL_OP_SINGLE_ECDH_USE 0
3045#define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
3046#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
3047#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
3048#define SSL_OP_TLS_ROLLBACK_BUG 0
David Benjamin59937042015-09-19 13:04:22 -04003049#define SSL_VERIFY_CLIENT_ONCE 0
3050
David Benjamin42fea372015-09-19 01:22:44 -04003051/* SSL_cache_hit calls |SSL_session_resumed|. */
3052OPENSSL_EXPORT int SSL_cache_hit(SSL *ssl);
3053
3054/* SSL_get_default_timeout returns |SSL_DEFAULT_SESSION_TIMEOUT|. */
3055OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *ssl);
3056
3057/* SSL_get_version returns a string describing the TLS version used by |ssl|.
3058 * For example, "TLSv1.2" or "SSLv3". */
3059OPENSSL_EXPORT const char *SSL_get_version(const SSL *ssl);
3060
David Benjamin32876b32015-09-20 12:17:03 -04003061/* SSL_get_cipher_list returns the name of the |n|th cipher in the output of
3062 * |SSL_get_ciphers| or NULL if out of range. Use |SSL_get_ciphers| insteads. */
3063OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *ssl, int n);
3064
David Benjaminfd8e69f2015-10-03 10:49:20 -04003065/* SSL_CTX_set_client_cert_cb sets a callback which is called on the client if
3066 * the server requests a client certificate and none is configured. On success,
3067 * the callback should return one and set |*out_x509| to |*out_pkey| to a leaf
3068 * certificate and private key, respectively, passing ownership. It should
3069 * return zero to send no certificate and -1 to fail or pause the handshake. If
3070 * the handshake is paused, |SSL_get_error| will return
3071 * |SSL_ERROR_WANT_X509_LOOKUP|.
3072 *
3073 * The callback may call |SSL_get0_certificate_types| and
3074 * |SSL_get_client_CA_list| for information on the server's certificate request.
3075 *
3076 * Use |SSL_CTX_set_cert_cb| instead. Configuring intermediate certificates with
3077 * this function is confusing. */
3078OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
3079 SSL_CTX *ctx,
3080 int (*client_cert_cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey));
3081
3082/* SSL_CTX_get_client_cert_cb returns the callback set by
3083 * |SSL_CTX_set_client_cert_cb|. */
3084OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(
3085 SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey);
3086
David Benjamin71f07942015-04-08 02:36:59 -04003087
David Benjamin79c117a2015-09-13 13:53:19 -04003088/* Private structures.
3089 *
3090 * This structures are exposed for historical reasons, but access to them is
3091 * deprecated. */
3092
3093struct ssl_cipher_st {
3094 /* name is the OpenSSL name for the cipher. */
3095 const char *name;
3096 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
3097 uint32_t id;
3098
3099 /* The following are internal fields. See ssl/internal.h for their values. */
3100
3101 uint32_t algorithm_mkey;
3102 uint32_t algorithm_auth;
3103 uint32_t algorithm_enc;
3104 uint32_t algorithm_mac;
3105 uint32_t algorithm_ssl;
3106 uint32_t algo_strength;
3107 uint32_t algorithm_prf;
3108
3109 /* strength_bits is the strength of the cipher in bits. */
3110 int strength_bits;
3111 /* alg_bits is the number of bits of key material used by the algorithm. */
3112 int alg_bits;
3113};
3114
3115struct ssl_session_st {
3116 int ssl_version; /* what ssl version session info is being kept in here? */
3117
3118 int master_key_length;
3119 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
3120 /* session_id - valid? */
3121 unsigned int session_id_length;
3122 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
3123 /* this is used to determine whether the session is being reused in
3124 * the appropriate context. It is up to the application to set this,
3125 * via SSL_new */
3126 unsigned int sid_ctx_length;
3127 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
3128
3129 char *psk_identity;
3130 /* Used to indicate that session resumption is not allowed. Applications can
3131 * also set this bit for a new session via not_resumable_session_cb to
3132 * disable session caching and tickets. */
3133 int not_resumable;
3134
3135 /* peer is the peer's certificate. */
3136 X509 *peer;
3137
3138 /* cert_chain is the certificate chain sent by the peer. NOTE: for historical
3139 * reasons, when a client (so the peer is a server), the chain includes
3140 * |peer|, but when a server it does not. */
3141 STACK_OF(X509) *cert_chain;
3142
3143 /* when app_verify_callback accepts a session where the peer's certificate is
3144 * not ok, we must remember the error for session reuse: */
3145 long verify_result; /* only for servers */
3146
3147 CRYPTO_refcount_t references;
3148 long timeout;
3149 long time;
3150
3151 const SSL_CIPHER *cipher;
3152
3153 /* key_exchange_info contains an indication of the size of the asymmetric
3154 * primitive used in the handshake that created this session. In the event
3155 * that two asymmetric operations are used, this value applies to the one
3156 * that controls the confidentiality of the connection. Its interpretation
3157 * depends on the primitive that was used; as specified by the cipher suite:
3158 * DHE: the size, in bits, of the multiplicative group.
3159 * RSA: the size, in bits, of the modulus.
3160 * ECDHE: the TLS id for the curve.
3161 *
3162 * A zero indicates that the value is unknown. */
3163 uint32_t key_exchange_info;
3164
3165 CRYPTO_EX_DATA ex_data; /* application specific data */
3166
3167 /* These are used to make removal of session-ids more efficient and to
3168 * implement a maximum cache size. */
3169 SSL_SESSION *prev, *next;
3170 char *tlsext_hostname;
3171 /* RFC4507 info */
3172 uint8_t *tlsext_tick; /* Session ticket */
3173 size_t tlsext_ticklen; /* Session ticket length */
3174 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
3175
3176 size_t tlsext_signed_cert_timestamp_list_length;
3177 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
3178
3179 /* The OCSP response that came with the session. */
3180 size_t ocsp_response_length;
3181 uint8_t *ocsp_response;
3182
3183 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
3184 uint8_t
3185 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
3186
3187 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
3188 * SHA-2, depending on TLS version) for the original, full handshake that
3189 * created a session. This is used by Channel IDs during resumption. */
3190 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
3191 unsigned int original_handshake_hash_len;
3192
3193 /* extended_master_secret is true if the master secret in this session was
3194 * generated using EMS and thus isn't vulnerable to the Triple Handshake
3195 * attack. */
3196 char extended_master_secret;
3197};
3198
3199/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
3200 * equal-preference groups. For TLS clients, the groups are moot because the
3201 * server picks the cipher and groups cannot be expressed on the wire. However,
3202 * for servers, the equal-preference groups allow the client's preferences to
3203 * be partially respected. (This only has an effect with
3204 * SSL_OP_CIPHER_SERVER_PREFERENCE).
3205 *
3206 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
3207 * All elements of a group have the same priority: no ordering is expressed
3208 * within a group.
3209 *
3210 * The values in |ciphers| are in one-to-one correspondence with
3211 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
3212 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
3213 * indicate that the corresponding SSL_CIPHER is not the last element of a
3214 * group, or 0 to indicate that it is.
3215 *
3216 * For example, if |in_group_flags| contains all zeros then that indicates a
3217 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
3218 * of the group (i.e. they are all in a one-element group).
3219 *
3220 * For a more complex example, consider:
3221 * ciphers: A B C D E F
3222 * in_group_flags: 1 1 0 0 1 0
3223 *
3224 * That would express the following, order:
3225 *
3226 * A E
3227 * B -> D -> F
3228 * C
3229 */
3230struct ssl_cipher_preference_list_st {
3231 STACK_OF(SSL_CIPHER) *ciphers;
3232 uint8_t *in_group_flags;
3233};
3234
3235struct ssl_ctx_st {
3236 const SSL_PROTOCOL_METHOD *method;
3237
3238 /* lock is used to protect various operations on this object. */
3239 CRYPTO_MUTEX lock;
3240
3241 /* max_version is the maximum acceptable protocol version. If zero, the
3242 * maximum supported version, currently (D)TLS 1.2, is used. */
3243 uint16_t max_version;
3244
3245 /* min_version is the minimum acceptable protocl version. If zero, the
3246 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
3247 uint16_t min_version;
3248
3249 struct ssl_cipher_preference_list_st *cipher_list;
3250 /* same as above but sorted for lookup */
3251 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
3252
3253 /* cipher_list_tls10 is the list of ciphers when TLS 1.0 or greater is in
3254 * use. This only applies to server connections as, for clients, the version
3255 * number is known at connect time and so the cipher list can be set then. If
3256 * |cipher_list_tls11| is non-NULL then this applies only to TLS 1.0
3257 * connections.
3258 *
3259 * TODO(agl): this exists to assist in the death of SSLv3. It can hopefully
3260 * be removed after that. */
3261 struct ssl_cipher_preference_list_st *cipher_list_tls10;
3262
3263 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
3264 * use. This only applies to server connections as, for clients, the version
3265 * number is known at connect time and so the cipher list can be set then. */
3266 struct ssl_cipher_preference_list_st *cipher_list_tls11;
3267
3268 X509_STORE *cert_store;
3269 LHASH_OF(SSL_SESSION) *sessions;
3270 /* Most session-ids that will be cached, default is
3271 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
3272 unsigned long session_cache_size;
3273 SSL_SESSION *session_cache_head;
3274 SSL_SESSION *session_cache_tail;
3275
3276 /* handshakes_since_cache_flush is the number of successful handshakes since
3277 * the last cache flush. */
3278 int handshakes_since_cache_flush;
3279
3280 /* This can have one of 2 values, ored together,
3281 * SSL_SESS_CACHE_CLIENT,
3282 * SSL_SESS_CACHE_SERVER,
3283 * Default is SSL_SESSION_CACHE_SERVER, which means only
3284 * SSL_accept which cache SSL_SESSIONS. */
3285 int session_cache_mode;
3286
3287 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
3288 * called. This has been put in to make life easier to set things up */
3289 long session_timeout;
3290
3291 /* If this callback is not null, it will be called each time a session id is
3292 * added to the cache. If this function returns 1, it means that the
3293 * callback will do a SSL_SESSION_free() when it has finished using it.
3294 * Otherwise, on 0, it means the callback has finished with it. If
3295 * remove_session_cb is not null, it will be called when a session-id is
3296 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
3297 * it. */
3298 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
3299 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
3300 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
3301 int *copy);
3302
3303 CRYPTO_refcount_t references;
3304
3305 /* if defined, these override the X509_verify_cert() calls */
David Benjamin59937042015-09-19 13:04:22 -04003306 int (*app_verify_callback)(X509_STORE_CTX *store_ctx, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003307 void *app_verify_arg;
David Benjamin79c117a2015-09-13 13:53:19 -04003308
3309 /* Default password callback. */
3310 pem_password_cb *default_passwd_callback;
3311
3312 /* Default password callback user data. */
3313 void *default_passwd_callback_userdata;
3314
3315 /* get client cert callback */
David Benjaminfd8e69f2015-10-03 10:49:20 -04003316 int (*client_cert_cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey);
David Benjamin79c117a2015-09-13 13:53:19 -04003317
3318 /* get channel id callback */
David Benjamin42fea372015-09-19 01:22:44 -04003319 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **out_pkey);
David Benjamin79c117a2015-09-13 13:53:19 -04003320
3321 CRYPTO_EX_DATA ex_data;
3322
3323 /* custom_*_extensions stores any callback sets for custom extensions. Note
3324 * that these pointers will be NULL if the stack would otherwise be empty. */
3325 STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
3326 STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
3327
3328 /* Default values used when no per-SSL value is defined follow */
3329
3330 void (*info_callback)(const SSL *ssl, int type,
3331 int val); /* used if SSL's info_callback is NULL */
3332
3333 /* what we put in client cert requests */
3334 STACK_OF(X509_NAME) *client_CA;
3335
3336
3337 /* Default values to use in SSL structures follow (these are copied by
3338 * SSL_new) */
3339
3340 uint32_t options;
3341 uint32_t mode;
3342 uint32_t max_cert_list;
3343
3344 struct cert_st /* CERT */ *cert;
3345
3346 /* callback that allows applications to peek at protocol messages */
3347 void (*msg_callback)(int write_p, int version, int content_type,
3348 const void *buf, size_t len, SSL *ssl, void *arg);
3349 void *msg_callback_arg;
3350
3351 int verify_mode;
3352 unsigned int sid_ctx_length;
3353 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
3354 int (*default_verify_callback)(
3355 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
3356
3357 /* Default generate session ID callback. */
3358 GEN_SESSION_CB generate_session_id;
3359
3360 X509_VERIFY_PARAM *param;
3361
3362 /* select_certificate_cb is called before most ClientHello processing and
3363 * before the decision whether to resume a session is made. It may return one
3364 * to continue the handshake or zero to cause the handshake loop to return
3365 * with an error and cause SSL_get_error to return
3366 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
3367 * will not call the callback a second time. */
3368 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
3369
3370 /* dos_protection_cb is called once the resumption decision for a ClientHello
3371 * has been made. It returns one to continue the handshake or zero to
3372 * abort. */
3373 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
3374
3375 /* quiet_shutdown is true if the connection should not send a close_notify on
3376 * shutdown. */
3377 int quiet_shutdown;
3378
3379 /* Maximum amount of data to send in one fragment. actual record size can be
3380 * more than this due to padding and MAC overheads. */
3381 uint16_t max_send_fragment;
3382
3383 /* TLS extensions servername callback */
3384 int (*tlsext_servername_callback)(SSL *, int *, void *);
3385 void *tlsext_servername_arg;
3386 /* RFC 4507 session ticket keys */
3387 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
3388 uint8_t tlsext_tick_hmac_key[16];
3389 uint8_t tlsext_tick_aes_key[16];
3390 /* Callback to support customisation of ticket key setting */
3391 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
3392 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
3393
3394 /* Server-only: psk_identity_hint is the default identity hint to send in
3395 * PSK-based key exchanges. */
3396 char *psk_identity_hint;
3397
3398 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
3399 char *identity,
3400 unsigned int max_identity_len,
3401 uint8_t *psk, unsigned int max_psk_len);
3402 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
3403 uint8_t *psk, unsigned int max_psk_len);
3404
3405
3406 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
3407 * hash of the peer's certifiate and then discard it to save memory and
3408 * session space. Only effective on the server side. */
3409 char retain_only_sha256_of_client_certs;
3410
3411 /* Next protocol negotiation information */
3412 /* (for experimental NPN extension). */
3413
3414 /* For a server, this contains a callback function by which the set of
3415 * advertised protocols can be provided. */
David Benjamin977547b2015-09-16 00:25:52 -04003416 int (*next_protos_advertised_cb)(SSL *ssl, const uint8_t **out,
3417 unsigned *out_len, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003418 void *next_protos_advertised_cb_arg;
3419 /* For a client, this contains a callback function that selects the
3420 * next protocol from the list provided by the server. */
David Benjamin977547b2015-09-16 00:25:52 -04003421 int (*next_proto_select_cb)(SSL *ssl, uint8_t **out, uint8_t *out_len,
3422 const uint8_t *in, unsigned in_len, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003423 void *next_proto_select_cb_arg;
3424
3425 /* ALPN information
3426 * (we are in the process of transitioning from NPN to ALPN.) */
3427
3428 /* For a server, this contains a callback function that allows the
3429 * server to select the protocol for the connection.
3430 * out: on successful return, this must point to the raw protocol
3431 * name (without the length prefix).
3432 * outlen: on successful return, this contains the length of |*out|.
3433 * in: points to the client's list of supported protocols in
3434 * wire-format.
3435 * inlen: the length of |in|. */
David Benjamin8984f1f2015-09-16 00:10:19 -04003436 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *out_len,
3437 const uint8_t *in, unsigned in_len, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003438 void *alpn_select_cb_arg;
3439
3440 /* For a client, this contains the list of supported protocols in wire
3441 * format. */
3442 uint8_t *alpn_client_proto_list;
3443 unsigned alpn_client_proto_list_len;
3444
3445 /* SRTP profiles we are willing to do from RFC 5764 */
3446 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
3447
3448 /* EC extension values inherited by SSL structure */
3449 size_t tlsext_ellipticcurvelist_length;
3450 uint16_t *tlsext_ellipticcurvelist;
3451
3452 /* If true, a client will advertise the Channel ID extension and a server
3453 * will echo it. */
3454 char tlsext_channel_id_enabled;
3455 /* The client's Channel ID private key. */
3456 EVP_PKEY *tlsext_channel_id_private;
3457
3458 /* If true, a client will request certificate timestamps. */
3459 char signed_cert_timestamps_enabled;
3460
3461 /* Signed certificate timestamp list to be sent to the client, if requested */
3462 uint8_t *signed_cert_timestamp_list;
3463 size_t signed_cert_timestamp_list_length;
3464
3465 /* If true, a client will request a stapled OCSP response. */
3466 char ocsp_stapling_enabled;
3467
3468 /* OCSP response to be sent to the client, if requested. */
3469 uint8_t *ocsp_response;
3470 size_t ocsp_response_length;
3471
3472 /* If not NULL, session key material will be logged to this BIO for debugging
3473 * purposes. The format matches NSS's and is readable by Wireshark. */
3474 BIO *keylog_bio;
3475
3476 /* current_time_cb, if not NULL, is the function to use to get the current
3477 * time. It sets |*out_clock| to the current time. */
3478 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
3479};
3480
3481struct ssl_st {
3482 /* version is the protocol version. */
3483 int version;
3484
3485 /* method is the method table corresponding to the current protocol (DTLS or
3486 * TLS). */
3487 const SSL_PROTOCOL_METHOD *method;
3488
3489 /* enc_method is the method table corresponding to the current protocol
3490 * version. */
3491 const SSL3_ENC_METHOD *enc_method;
3492
3493 /* max_version is the maximum acceptable protocol version. If zero, the
3494 * maximum supported version, currently (D)TLS 1.2, is used. */
3495 uint16_t max_version;
3496
3497 /* min_version is the minimum acceptable protocl version. If zero, the
3498 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
3499 uint16_t min_version;
3500
3501 /* There are 2 BIO's even though they are normally both the same. This is so
3502 * data can be read and written to different handlers */
3503
3504 BIO *rbio; /* used by SSL_read */
3505 BIO *wbio; /* used by SSL_write */
3506 BIO *bbio; /* used during session-id reuse to concatenate
3507 * messages */
3508
3509 /* This holds a variable that indicates what we were doing when a 0 or -1 is
3510 * returned. This is needed for non-blocking IO so we know what request
3511 * needs re-doing when in SSL_accept or SSL_connect */
3512 int rwstate;
3513
3514 /* true when we are actually in SSL_accept() or SSL_connect() */
3515 int in_handshake;
3516 int (*handshake_func)(SSL *);
3517
3518 /* Imagine that here's a boolean member "init" that is switched as soon as
3519 * SSL_set_{accept/connect}_state is called for the first time, so that
3520 * "state" and "handshake_func" are properly initialized. But as
3521 * handshake_func is == 0 until then, we use this test instead of an "init"
3522 * member. */
3523
3524 /* server is true iff the this SSL* is the server half. Note: before the SSL*
3525 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
3526 * the side is not determined. In this state, server is always false. */
3527 int server;
3528
3529 /* quiet_shutdown is true if the connection should not send a close_notify on
3530 * shutdown. */
3531 int quiet_shutdown;
3532
3533 int shutdown; /* we have shut things down, 0x01 sent, 0x02
3534 * for received */
3535 int state; /* where we are */
3536
3537 BUF_MEM *init_buf; /* buffer used during init */
3538 uint8_t *init_msg; /* pointer to handshake message body, set by
3539 ssl3_get_message() */
3540 int init_num; /* amount read/written */
3541 int init_off; /* amount read/written */
3542
3543 struct ssl3_state_st *s3; /* SSLv3 variables */
3544 struct dtls1_state_st *d1; /* DTLSv1 variables */
3545
3546 /* callback that allows applications to peek at protocol messages */
3547 void (*msg_callback)(int write_p, int version, int content_type,
3548 const void *buf, size_t len, SSL *ssl, void *arg);
3549 void *msg_callback_arg;
3550
3551 int hit; /* reusing a previous session */
3552
3553 X509_VERIFY_PARAM *param;
3554
3555 /* crypto */
3556 struct ssl_cipher_preference_list_st *cipher_list;
3557 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
3558
3559 SSL_AEAD_CTX *aead_read_ctx;
3560 SSL_AEAD_CTX *aead_write_ctx;
3561
3562 /* session info */
3563
3564 /* client cert? */
3565 /* This is used to hold the server certificate used */
3566 struct cert_st /* CERT */ *cert;
3567
3568 /* the session_id_context is used to ensure sessions are only reused
3569 * in the appropriate context */
3570 unsigned int sid_ctx_length;
3571 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
3572
3573 /* This can also be in the session once a session is established */
3574 SSL_SESSION *session;
3575
3576 /* Default generate session ID callback. */
3577 GEN_SESSION_CB generate_session_id;
3578
3579 /* Used in SSL2 and SSL3 */
3580 int verify_mode; /* 0 don't care about verify failure.
3581 * 1 fail if verify fails */
3582 int (*verify_callback)(int ok,
3583 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
3584
3585 void (*info_callback)(const SSL *ssl, int type,
3586 int val); /* optional informational callback */
3587
3588 /* Server-only: psk_identity_hint is the identity hint to send in
3589 * PSK-based key exchanges. */
3590 char *psk_identity_hint;
3591
3592 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
3593 char *identity,
3594 unsigned int max_identity_len,
3595 uint8_t *psk, unsigned int max_psk_len);
3596 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
3597 uint8_t *psk, unsigned int max_psk_len);
3598
3599 SSL_CTX *ctx;
3600
3601 /* extra application data */
3602 long verify_result;
3603 CRYPTO_EX_DATA ex_data;
3604
3605 /* for server side, keep the list of CA_dn we can use */
3606 STACK_OF(X509_NAME) *client_CA;
3607
3608 uint32_t options; /* protocol behaviour */
3609 uint32_t mode; /* API behaviour */
3610 uint32_t max_cert_list;
3611 int client_version; /* what was passed, used for
3612 * SSLv3/TLS rollback check */
3613 uint16_t max_send_fragment;
3614 char *tlsext_hostname;
3615 /* RFC4507 session ticket expected to be received or sent */
3616 int tlsext_ticket_expected;
3617 size_t tlsext_ellipticcurvelist_length;
3618 uint16_t *tlsext_ellipticcurvelist; /* our list */
3619
3620 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
3621
3622 /* Next protocol negotiation. For the client, this is the protocol that we
3623 * sent in NextProtocol and is set when handling ServerHello extensions.
3624 *
3625 * For a server, this is the client's selected_protocol from NextProtocol and
3626 * is set when handling the NextProtocol message, before the Finished
3627 * message. */
3628 uint8_t *next_proto_negotiated;
3629 size_t next_proto_negotiated_len;
3630
3631 /* srtp_profiles is the list of configured SRTP protection profiles for
3632 * DTLS-SRTP. */
3633 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
3634
3635 /* srtp_profile is the selected SRTP protection profile for
3636 * DTLS-SRTP. */
3637 const SRTP_PROTECTION_PROFILE *srtp_profile;
3638
3639 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
3640 * from clients. For a client, means that we'll advertise support. */
3641 char tlsext_channel_id_enabled;
3642 /* The client's Channel ID private key. */
3643 EVP_PKEY *tlsext_channel_id_private;
3644
3645 /* Enable signed certificate time stamps. Currently client only. */
3646 char signed_cert_timestamps_enabled;
3647
3648 /* ocsp_stapling_enabled is only used by client connections and indicates
3649 * whether OCSP stapling will be requested. */
3650 char ocsp_stapling_enabled;
3651
3652 /* For a client, this contains the list of supported protocols in wire
3653 * format. */
3654 uint8_t *alpn_client_proto_list;
3655 unsigned alpn_client_proto_list_len;
3656
David Benjamin1d5ef3b2015-10-12 19:54:18 -04003657 /* renegotiate_mode controls how peer renegotiation attempts are handled. */
3658 enum ssl_renegotiate_mode_t renegotiate_mode;
David Benjamin79c117a2015-09-13 13:53:19 -04003659
3660 /* These fields are always NULL and exist only to keep wpa_supplicant happy
3661 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
3662 * don't support. */
3663 EVP_CIPHER_CTX *enc_read_ctx;
3664 EVP_MD_CTX *read_hash;
3665};
3666
3667
Adam Langley7cc3f992015-01-07 15:06:31 -08003668/* Android compatibility section.
3669 *
3670 * These functions are declared, temporarily, for Android because
3671 * wpa_supplicant will take a little time to sync with upstream. Outside of
3672 * Android they'll have no definition. */
3673
3674#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
3675
Adam Langleyb4a494c2015-01-23 15:10:10 -08003676OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
3677 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08003678OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
3679OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07003680OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
3681
3682#define OPENSSL_VERSION_TEXT "BoringSSL"
3683
3684#define SSLEAY_VERSION 0
3685
3686/* SSLeay_version is a compatibility function that returns the string
3687 * "BoringSSL". */
3688OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08003689
3690
David Benjamin59015c32015-04-26 13:13:55 -04003691/* Preprocessor compatibility section.
3692 *
3693 * Historically, a number of APIs were implemented in OpenSSL as macros and
3694 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04003695 * section defines a number of legacy macros.
3696 *
3697 * Although using either the CTRL values or their wrapper macros in #ifdefs is
3698 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
3699 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04003700
David Benjamincb3872f2015-06-16 13:20:36 -04003701#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
3702#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04003703#define SSL_CTRL_CHAIN doesnt_exist
3704#define SSL_CTRL_CHAIN_CERT doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003705#define SSL_CTRL_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04003706#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003707#define SSL_CTRL_CLEAR_MODE doesnt_exist
3708#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04003709#define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
3710#define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003711#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
David Benjamin75910642015-08-09 10:42:33 -04003712#define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04003713#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003714#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04003715#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003716#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
3717#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
3718#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
3719#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
3720#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04003721#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04003722#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003723#define SSL_CTRL_MODE doesnt_exist
3724#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
3725#define SSL_CTRL_OPTIONS doesnt_exist
3726#define SSL_CTRL_SESS_NUMBER doesnt_exist
3727#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
David Benjaminfdb4cdd2015-08-09 11:13:23 -04003728#define SSL_CTRL_SET_CURVES doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003729#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
3730#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04003731#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04003732#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04003733#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04003734#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04003735#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003736#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04003737#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003738#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
3739#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04003740#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04003741#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04003742#define SSL_CTRL_SET_TMP_DH doesnt_exist
3743#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
3744#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
3745#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
3746#define SSL_CTRL_SET_TMP_RSA doesnt_exist
3747#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04003748
David Benjamin8c249802015-05-05 09:44:18 -04003749#define DTLSv1_get_timeout DTLSv1_get_timeout
3750#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamin11c0f8e2015-07-06 00:18:15 -04003751#define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
3752#define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
3753#define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
3754#define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
3755#define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04003756#define SSL_CTX_clear_mode SSL_CTX_clear_mode
3757#define SSL_CTX_clear_options SSL_CTX_clear_options
3758#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04003759#define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
3760#define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04003761#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
3762#define SSL_CTX_get_mode SSL_CTX_get_mode
3763#define SSL_CTX_get_options SSL_CTX_get_options
3764#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
3765#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04003766#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04003767#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
3768#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
3769#define SSL_CTX_sess_number SSL_CTX_sess_number
3770#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
David Benjamin11c0f8e2015-07-06 00:18:15 -04003771#define SSL_CTX_set0_chain SSL_CTX_set0_chain
3772#define SSL_CTX_set1_chain SSL_CTX_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04003773#define SSL_CTX_set1_curves SSL_CTX_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04003774#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
3775#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
3776#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
3777#define SSL_CTX_set_mode SSL_CTX_set_mode
3778#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
3779#define SSL_CTX_set_options SSL_CTX_set_options
3780#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
3781#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
3782#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
3783#define SSL_CTX_set_tlsext_servername_callback \
3784 SSL_CTX_set_tlsext_servername_callback
3785#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04003786#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04003787#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
3788#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
3789#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
David Benjamin11c0f8e2015-07-06 00:18:15 -04003790#define SSL_add0_chain_cert SSL_add0_chain_cert
3791#define SSL_add1_chain_cert SSL_add1_chain_cert
3792#define SSL_clear_chain_certs SSL_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04003793#define SSL_clear_mode SSL_clear_mode
3794#define SSL_clear_options SSL_clear_options
3795#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
David Benjamin75910642015-08-09 10:42:33 -04003796#define SSL_get0_certificate_types SSL_get0_certificate_types
David Benjamin11c0f8e2015-07-06 00:18:15 -04003797#define SSL_get0_chain_certs SSL_get0_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04003798#define SSL_get_max_cert_list SSL_get_max_cert_list
3799#define SSL_get_mode SSL_get_mode
3800#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04003801#define SSL_get_secure_renegotiation_support \
3802 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04003803#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04003804#define SSL_need_tmp_RSA SSL_need_tmp_RSA
3805#define SSL_num_renegotiations SSL_num_renegotiations
3806#define SSL_session_reused SSL_session_reused
David Benjamin11c0f8e2015-07-06 00:18:15 -04003807#define SSL_set0_chain SSL_set0_chain
3808#define SSL_set1_chain SSL_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04003809#define SSL_set1_curves SSL_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04003810#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
3811#define SSL_set_max_cert_list SSL_set_max_cert_list
3812#define SSL_set_max_send_fragment SSL_set_max_send_fragment
3813#define SSL_set_mode SSL_set_mode
3814#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
3815#define SSL_set_mtu SSL_set_mtu
3816#define SSL_set_options SSL_set_options
3817#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
3818#define SSL_set_tmp_dh SSL_set_tmp_dh
3819#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
3820#define SSL_set_tmp_rsa SSL_set_tmp_rsa
3821#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04003822
3823
David Benjamin087e4fa2015-04-08 23:46:10 -04003824#if defined(__cplusplus)
3825} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07003826#endif
David Benjamin2e521212014-07-16 14:37:51 -04003827
David Benjamin087e4fa2015-04-08 23:46:10 -04003828
3829/* Library consumers assume these headers are included by ssl.h, but they depend
3830 * on ssl.h, so include them after all declarations.
3831 *
3832 * TODO(davidben): The separation between ssl.h and these version-specific
3833 * headers introduces circular dependencies and is inconsistent. The function
3834 * declarations should move to ssl.h. Many of the constants can probably be
3835 * pruned or unexported. */
David Benjamin087e4fa2015-04-08 23:46:10 -04003836#include <openssl/ssl3.h>
3837#include <openssl/tls1.h> /* This is mostly sslv3 with a few tweaks */
David Benjamin087e4fa2015-04-08 23:46:10 -04003838
3839
David Benjamin2e521212014-07-16 14:37:51 -04003840/* BEGIN ERROR CODES */
3841/* The following lines are auto generated by the script make_errors.go. Any
3842 * changes made after this point may be overwritten when the script is next run.
3843 */
David Benjamin689be0f2015-02-11 15:55:26 -05003844#define SSL_R_APP_DATA_IN_HANDSHAKE 100
3845#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
3846#define SSL_R_BAD_ALERT 102
3847#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
3848#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
3849#define SSL_R_BAD_DH_P_LENGTH 105
3850#define SSL_R_BAD_DIGEST_LENGTH 106
3851#define SSL_R_BAD_ECC_CERT 107
3852#define SSL_R_BAD_ECPOINT 108
3853#define SSL_R_BAD_HANDSHAKE_LENGTH 109
3854#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07003855#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05003856#define SSL_R_BAD_LENGTH 112
3857#define SSL_R_BAD_PACKET_LENGTH 113
3858#define SSL_R_BAD_RSA_ENCRYPT 114
3859#define SSL_R_BAD_SIGNATURE 115
3860#define SSL_R_BAD_SRTP_MKI_VALUE 116
3861#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
3862#define SSL_R_BAD_SSL_FILETYPE 118
3863#define SSL_R_BAD_WRITE_RETRY 119
3864#define SSL_R_BIO_NOT_SET 120
3865#define SSL_R_BN_LIB 121
3866#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
3867#define SSL_R_CA_DN_LENGTH_MISMATCH 123
3868#define SSL_R_CA_DN_TOO_LONG 124
3869#define SSL_R_CCS_RECEIVED_EARLY 125
3870#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
3871#define SSL_R_CERT_CB_ERROR 127
3872#define SSL_R_CERT_LENGTH_MISMATCH 128
3873#define SSL_R_CHANNEL_ID_NOT_P256 129
3874#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
3875#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
3876#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
3877#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
3878#define SSL_R_CLIENTHELLO_TLSEXT 134
3879#define SSL_R_CONNECTION_REJECTED 135
3880#define SSL_R_CONNECTION_TYPE_NOT_SET 136
3881#define SSL_R_COOKIE_MISMATCH 137
3882#define SSL_R_D2I_ECDSA_SIG 138
3883#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
3884#define SSL_R_DATA_LENGTH_TOO_LONG 140
3885#define SSL_R_DECODE_ERROR 141
3886#define SSL_R_DECRYPTION_FAILED 142
3887#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
3888#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
3889#define SSL_R_DIGEST_CHECK_FAILED 145
3890#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
3891#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
3892#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
3893#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
3894#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
3895#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
3896#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
3897#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
3898#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
3899#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
3900#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
3901#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
3902#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
3903#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
3904#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
3905#define SSL_R_HTTPS_PROXY_REQUEST 161
3906#define SSL_R_HTTP_REQUEST 162
3907#define SSL_R_INAPPROPRIATE_FALLBACK 163
3908#define SSL_R_INVALID_COMMAND 164
3909#define SSL_R_INVALID_MESSAGE 165
3910#define SSL_R_INVALID_SSL_SESSION 166
3911#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
3912#define SSL_R_LENGTH_MISMATCH 168
3913#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
3914#define SSL_R_MISSING_DH_KEY 170
3915#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
3916#define SSL_R_MISSING_RSA_CERTIFICATE 172
3917#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
3918#define SSL_R_MISSING_RSA_SIGNING_CERT 174
3919#define SSL_R_MISSING_TMP_DH_KEY 175
3920#define SSL_R_MISSING_TMP_ECDH_KEY 176
3921#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
3922#define SSL_R_MTU_TOO_SMALL 178
3923#define SSL_R_NESTED_GROUP 179
3924#define SSL_R_NO_CERTIFICATES_RETURNED 180
3925#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
3926#define SSL_R_NO_CERTIFICATE_SET 182
3927#define SSL_R_NO_CIPHERS_AVAILABLE 183
3928#define SSL_R_NO_CIPHERS_PASSED 184
3929#define SSL_R_NO_CIPHERS_SPECIFIED 185
3930#define SSL_R_NO_CIPHER_MATCH 186
3931#define SSL_R_NO_COMPRESSION_SPECIFIED 187
3932#define SSL_R_NO_METHOD_SPECIFIED 188
3933#define SSL_R_NO_P256_SUPPORT 189
3934#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
3935#define SSL_R_NO_RENEGOTIATION 191
3936#define SSL_R_NO_REQUIRED_DIGEST 192
3937#define SSL_R_NO_SHARED_CIPHER 193
3938#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
3939#define SSL_R_NO_SRTP_PROFILES 195
3940#define SSL_R_NULL_SSL_CTX 196
3941#define SSL_R_NULL_SSL_METHOD_PASSED 197
3942#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
3943#define SSL_R_PACKET_LENGTH_TOO_LONG 199
3944#define SSL_R_PARSE_TLSEXT 200
3945#define SSL_R_PATH_TOO_LONG 201
3946#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
3947#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
3948#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
3949#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
3950#define SSL_R_PSK_NO_CLIENT_CB 206
3951#define SSL_R_PSK_NO_SERVER_CB 207
3952#define SSL_R_READ_BIO_NOT_SET 208
3953#define SSL_R_READ_TIMEOUT_EXPIRED 209
3954#define SSL_R_RECORD_LENGTH_MISMATCH 210
3955#define SSL_R_RECORD_TOO_LARGE 211
3956#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
3957#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
3958#define SSL_R_RENEGOTIATION_MISMATCH 214
3959#define SSL_R_REQUIRED_CIPHER_MISSING 215
3960#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
3961#define SSL_R_SERVERHELLO_TLSEXT 217
3962#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
3963#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
3964#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
3965#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
3966#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
3967#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
3968#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
3969#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
3970#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
3971#define SSL_R_SSL_HANDSHAKE_FAILURE 227
3972#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
3973#define SSL_R_SSL_SESSION_ID_CONFLICT 229
3974#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
3975#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
3976#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
3977#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
3978#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
3979#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
3980#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
3981#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
3982#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
3983#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
3984#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
3985#define SSL_R_UNEXPECTED_MESSAGE 241
3986#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
3987#define SSL_R_UNEXPECTED_RECORD 243
3988#define SSL_R_UNINITIALIZED 244
3989#define SSL_R_UNKNOWN_ALERT_TYPE 245
3990#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
3991#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
3992#define SSL_R_UNKNOWN_CIPHER_TYPE 248
3993#define SSL_R_UNKNOWN_DIGEST 249
3994#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
3995#define SSL_R_UNKNOWN_PROTOCOL 251
3996#define SSL_R_UNKNOWN_SSL_VERSION 252
3997#define SSL_R_UNKNOWN_STATE 253
3998#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
3999#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
4000#define SSL_R_UNSUPPORTED_CIPHER 256
4001#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
4002#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
4003#define SSL_R_UNSUPPORTED_PROTOCOL 259
4004#define SSL_R_UNSUPPORTED_SSL_VERSION 260
4005#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07004006#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05004007#define SSL_R_WRONG_CIPHER_RETURNED 263
4008#define SSL_R_WRONG_CURVE 264
4009#define SSL_R_WRONG_MESSAGE_TYPE 265
4010#define SSL_R_WRONG_SIGNATURE_TYPE 266
4011#define SSL_R_WRONG_SSL_VERSION 267
4012#define SSL_R_WRONG_VERSION_NUMBER 268
4013#define SSL_R_X509_LIB 269
4014#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05004015#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04004016#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04004017#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05004018#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07004019#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
4020#define SSL_R_EMS_STATE_INCONSISTENT 276
4021#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04004022#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07004023#define SSL_R_UNEXPECTED_EXTENSION 279
Adam Langley2e857bd2015-07-01 16:09:19 -07004024#define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
Adam Langley33ad2b52015-07-20 17:43:53 -07004025#define SSL_R_ERROR_ADDING_EXTENSION 281
4026#define SSL_R_ERROR_PARSING_EXTENSION 282
4027#define SSL_R_MISSING_EXTENSION 283
Adam Langley09505632015-07-30 18:10:13 -07004028#define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
4029#define SSL_R_CUSTOM_EXTENSION_ERROR 285
David Benjamin76c2efc2015-08-31 14:24:29 -04004030#define SSL_R_NEGOTIATED_BOTH_NPN_AND_ALPN 286
David Benjamind7c53682014-09-17 12:08:13 -04004031#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04004032#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
4033#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
4034#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
4035#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
4036#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
4037#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
4038#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
4039#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
4040#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
4041#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
4042#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
4043#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
4044#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
4045#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
4046#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
4047#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
4048#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
4049#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
4050#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
4051#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
4052#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04004053#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04004054#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
4055#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
4056#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
4057#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
4058#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
4059#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
4060#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07004061
David Benjamin087e4fa2015-04-08 23:46:10 -04004062#endif /* OPENSSL_HEADER_SSL_H */