blob: bfea258f59be7738580109e3b0018662deb502ed [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
Adam Langleyb4a494c2015-01-23 15:10:10 -08007 *
Adam Langley95c29f32014-06-20 12:00:00 -07008 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
Adam Langleyb4a494c2015-01-23 15:10:10 -080014 *
Adam Langley95c29f32014-06-20 12:00:00 -070015 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
Adam Langleyb4a494c2015-01-23 15:10:10 -080021 *
Adam Langley95c29f32014-06-20 12:00:00 -070022 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
24 * are met:
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
Adam Langleyb4a494c2015-01-23 15:10:10 -080036 * 4. If you include any Windows specific code (or a derivative thereof) from
Adam Langley95c29f32014-06-20 12:00:00 -070037 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
Adam Langleyb4a494c2015-01-23 15:10:10 -080039 *
Adam Langley95c29f32014-06-20 12:00:00 -070040 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50 * SUCH DAMAGE.
Adam Langleyb4a494c2015-01-23 15:10:10 -080051 *
Adam Langley95c29f32014-06-20 12:00:00 -070052 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
56 */
57/* ====================================================================
58 * Copyright (c) 1998-2007 The OpenSSL Project. All rights reserved.
59 *
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
62 * are met:
63 *
64 * 1. Redistributions of source code must retain the above copyright
Adam Langleyb4a494c2015-01-23 15:10:10 -080065 * notice, this list of conditions and the following disclaimer.
Adam Langley95c29f32014-06-20 12:00:00 -070066 *
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
70 * distribution.
71 *
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
76 *
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
81 *
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
85 *
86 * 6. Redistributions of any form whatsoever must retain the following
87 * acknowledgment:
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
90 *
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
104 *
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
108 *
109 */
110/* ====================================================================
111 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
Adam Langleyb4a494c2015-01-23 15:10:10 -0800112 * ECC cipher suite support in OpenSSL originally developed by
Adam Langley95c29f32014-06-20 12:00:00 -0700113 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
114 */
115/* ====================================================================
116 * Copyright 2005 Nokia. All rights reserved.
117 *
118 * The portions of the attached software ("Contribution") is developed by
119 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
120 * license.
121 *
122 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
123 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
124 * support (see RFC 4279) to OpenSSL.
125 *
126 * No patent licenses or other rights except those expressly stated in
127 * the OpenSSL open source license shall be deemed granted or received
128 * expressly, by implication, estoppel, or otherwise.
129 *
130 * No assurances are provided by Nokia that the Contribution does not
131 * infringe the patent or other intellectual property rights of any third
132 * party or that the license provides you with all the necessary rights
133 * to make use of the Contribution.
134 *
135 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
136 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
137 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
138 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
139 * OTHERWISE.
140 */
141
David Benjamin087e4fa2015-04-08 23:46:10 -0400142#ifndef OPENSSL_HEADER_SSL_H
143#define OPENSSL_HEADER_SSL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700144
145#include <openssl/base.h>
146
147#include <openssl/bio.h>
148#include <openssl/buf.h>
149#include <openssl/hmac.h>
150#include <openssl/lhash.h>
151#include <openssl/pem.h>
David Benjamind5635d42015-10-17 19:45:00 -0400152#include <openssl/ssl3.h>
Adam Langley0b5e3902015-05-15 13:08:38 -0700153#include <openssl/thread.h>
David Benjamin07e13842015-10-17 13:48:04 -0400154#include <openssl/tls1.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700155#include <openssl/x509.h>
156
David Benjamin2e749e82015-04-07 23:20:51 -0400157#if !defined(OPENSSL_WINDOWS)
158#include <sys/time.h>
159#endif
160
Adam Langleyc3ef76f2015-04-13 14:34:17 -0700161/* wpa_supplicant expects to get the version functions from ssl.h */
162#include <openssl/crypto.h>
163
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400164/* Forward-declare struct timeval. On Windows, it is defined in winsock2.h and
165 * Windows headers define too many macros to be included in public headers.
166 * However, only a forward declaration is needed. */
167struct timeval;
168
David Benjamin087e4fa2015-04-08 23:46:10 -0400169#if defined(__cplusplus)
Adam Langley95c29f32014-06-20 12:00:00 -0700170extern "C" {
171#endif
172
173
David Benjamin0d8a7582015-04-08 23:55:15 -0400174/* SSL implementation. */
175
176
David Benjamin71f07942015-04-08 02:36:59 -0400177/* Initialization. */
178
179/* SSL_library_init initializes the crypto and SSL libraries and returns one. */
180OPENSSL_EXPORT int SSL_library_init(void);
181
182
David Benjamin79c117a2015-09-13 13:53:19 -0400183/* SSL contexts.
184 *
185 * |SSL_CTX| objects manage shared state and configuration between multiple TLS
186 * or DTLS connections. Whether the connections are TLS or DTLS is selected by
187 * an |SSL_METHOD| on creation.
188 *
189 * |SSL_CTX| are reference-counted and may be shared by connections across
190 * multiple threads. Once shared, functions which change the |SSL_CTX|'s
191 * configuration may not be used. */
David Benjamin4831c332015-05-16 11:43:13 -0400192
193/* TLS_method is the |SSL_METHOD| used for TLS (and SSLv3) connections. */
194OPENSSL_EXPORT const SSL_METHOD *TLS_method(void);
195
196/* DTLS_method is the |SSL_METHOD| used for DTLS connections. */
197OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void);
198
199/* SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL
David Benjamin79c117a2015-09-13 13:53:19 -0400200 * on error. */
David Benjamin4831c332015-05-16 11:43:13 -0400201OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method);
202
203/* SSL_CTX_free releases memory associated with |ctx|. */
204OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx);
205
206
David Benjamin79c117a2015-09-13 13:53:19 -0400207/* SSL connections.
208 *
209 * An |SSL| object represents a single TLS or DTLS connection. Although the
210 * shared |SSL_CTX| is thread-safe, an |SSL| is not thread-safe and may only be
211 * used on one thread at a time. */
David Benjamin4831c332015-05-16 11:43:13 -0400212
David Benjamin79c117a2015-09-13 13:53:19 -0400213/* SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. The new
214 * connection inherits settings from |ctx| at the time of creation. Settings may
215 * also be individually configured on the connection.
David Benjamin4831c332015-05-16 11:43:13 -0400216 *
217 * On creation, an |SSL| is not configured to be either a client or server. Call
218 * |SSL_set_connect_state| or |SSL_set_accept_state| to set this. */
219OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx);
220
221/* SSL_free releases memory associated with |ssl|. */
222OPENSSL_EXPORT void SSL_free(SSL *ssl);
223
224/* SSL_set_connect_state configures |ssl| to be a client. */
225OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl);
226
227/* SSL_set_accept_state configures |ssl| to be a server. */
228OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl);
229
David Benjamin42fea372015-09-19 01:22:44 -0400230/* SSL_is_server returns one if |ssl| is configured as a server and zero
231 * otherwise. */
232OPENSSL_EXPORT int SSL_is_server(SSL *ssl);
233
David Benjamin3c1ccc02015-09-13 00:27:05 -0400234/* SSL_set_bio configures |ssl| to read from |rbio| and write to |wbio|. |ssl|
235 * takes ownership of the two |BIO|s. If |rbio| and |wbio| are the same, |ssl|
236 * only takes ownership of one reference.
237 *
David Benjamin8ac00ca2015-10-03 11:14:36 -0400238 * In DTLS, if |rbio| is blocking, it must handle
239 * |BIO_CTRL_DGRAM_SET_NEXT_TIMEOUT| control requests to set read timeouts.
240 *
David Benjamin3c1ccc02015-09-13 00:27:05 -0400241 * Calling this function on an already-configured |ssl| is deprecated. */
242OPENSSL_EXPORT void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio);
243
244/* SSL_get_rbio returns the |BIO| that |ssl| reads from. */
245OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *ssl);
246
247/* SSL_get_wbio returns the |BIO| that |ssl| writes to. */
248OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *ssl);
249
250/* SSL_do_handshake continues the current handshake. If there is none or the
251 * handshake has completed or False Started, it returns one. Otherwise, it
252 * returns <= 0. The caller should pass the value into |SSL_get_error| to
253 * determine how to proceed.
254 *
David Benjamin8ac00ca2015-10-03 11:14:36 -0400255 * In DTLS, if the read |BIO| is non-blocking, the caller must drive
256 * retransmissions. Whenever |SSL_get_error| signals |SSL_ERROR_WANT_READ|, use
257 * |DTLSv1_get_timeout| to determine the current timeout. If it expires before
258 * the next retry, call |DTLSv1_handle_timeout|. Note that DTLS handshake
259 * retransmissions use fresh sequence numbers, so it is not sufficient to replay
260 * packets at the transport.
261 *
David Benjamin3c1ccc02015-09-13 00:27:05 -0400262 * TODO(davidben): Ensure 0 is only returned on transport EOF.
263 * https://crbug.com/466303. */
264OPENSSL_EXPORT int SSL_do_handshake(SSL *ssl);
265
266/* SSL_connect configures |ssl| as a client, if unconfigured, and calls
267 * |SSL_do_handshake|. */
268OPENSSL_EXPORT int SSL_connect(SSL *ssl);
269
270/* SSL_accept configures |ssl| as a server, if unconfigured, and calls
271 * |SSL_do_handshake|. */
272OPENSSL_EXPORT int SSL_accept(SSL *ssl);
273
274/* SSL_read reads up to |num| bytes from |ssl| into |buf|. It implicitly runs
275 * any pending handshakes, including renegotiations when enabled. On success, it
276 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
277 * should pass the value into |SSL_get_error| to determine how to proceed.
278 *
279 * TODO(davidben): Ensure 0 is only returned on transport EOF.
280 * https://crbug.com/466303. */
281OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num);
282
283/* SSL_peek behaves like |SSL_read| but does not consume any bytes returned. */
284OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num);
285
David Benjamin9f859492015-10-03 10:44:30 -0400286/* SSL_pending returns the number of bytes available in |ssl|. It does not read
287 * from the transport. */
288OPENSSL_EXPORT int SSL_pending(const SSL *ssl);
289
David Benjamin3c1ccc02015-09-13 00:27:05 -0400290/* SSL_write writes up to |num| bytes from |buf| into |ssl|. It implicitly runs
291 * any pending handshakes, including renegotiations when enabled. On success, it
292 * returns the number of bytes read. Otherwise, it returns <= 0. The caller
293 * should pass the value into |SSL_get_error| to determine how to proceed.
294 *
295 * A non-blocking |SSL_write| differs from non-blocking |write| in that a failed
296 * |SSL_write| still commits to the data passed in. When retrying, the caller
297 * must supply the original write buffer (or a larger one containing the
298 * original as a prefix). By default, retries will fail if they also do not
299 * reuse the same |buf| pointer. This may be relaxed with
300 * |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER|, but the buffer contents still must be
301 * unchanged.
302 *
303 * By default, |SSL_write| will not return success until all |num| bytes are
304 * written. This may be relaxed with |SSL_MODE_ENABLE_PARTIAL_WRITE|. It allows
305 * |SSL_write| to complete with a partial result when only part of the input was
306 * written in a single record.
307 *
308 * TODO(davidben): Ensure 0 is only returned on transport EOF.
309 * https://crbug.com/466303. */
310OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num);
311
312/* SSL_shutdown shuts down |ssl|. On success, it completes in two stages. First,
313 * it returns 0 if |ssl| completed uni-directional shutdown; close_notify has
314 * been sent, but the peer's close_notify has not been received. Most callers
315 * may stop at this point. For bi-directional shutdown, call |SSL_shutdown|
316 * again. It returns 1 if close_notify has been both sent and received.
317 *
318 * If the peer's close_notify arrived first, the first stage is skipped.
319 * |SSL_shutdown| will return 1 once close_notify is sent and skip 0. Callers
320 * only interested in uni-directional shutdown must therefore allow for the
321 * first stage returning either 0 or 1.
322 *
323 * |SSL_shutdown| returns -1 on failure. The caller should pass the return value
324 * into |SSL_get_error| to determine how to proceed. If the underlying |BIO| is
325 * non-blocking, both stages may require retry.
326 *
327 * |SSL_shutdown| must be called to retain |ssl|'s session in the session
328 * cache. Use |SSL_CTX_set_quiet_shutdown| to configure |SSL_shutdown| to
329 * neither send nor wait for close_notify but still retain the session.
330 *
331 * TODO(davidben): Is there any point in the session cache interaction? Remove
332 * it? */
333OPENSSL_EXPORT int SSL_shutdown(SSL *ssl);
334
David Benjamin9f859492015-10-03 10:44:30 -0400335/* SSL_CTX_set_quiet_shutdown sets quiet shutdown on |ctx| to |mode|. If
336 * enabled, |SSL_shutdown| will not send a close_notify alert or wait for one
337 * from the peer. It will instead synchronously return one. */
338OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode);
339
340/* SSL_CTX_get_quiet_shutdown returns whether quiet shutdown is enabled for
341 * |ctx|. */
342OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx);
343
344/* SSL_set_quiet_shutdown sets quiet shutdown on |ssl| to |mode|. If enabled,
345 * |SSL_shutdown| will not send a close_notify alert or wait for one from the
346 * peer. It will instead synchronously return one. */
347OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode);
348
349/* SSL_get_quiet_shutdown returns whether quiet shutdown is enabled for
350 * |ssl|. */
351OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl);
352
David Benjamin3c1ccc02015-09-13 00:27:05 -0400353/* SSL_get_error returns a |SSL_ERROR_*| value for the most recent operation on
354 * |ssl|. It should be called after an operation failed to determine. */
355OPENSSL_EXPORT int SSL_get_error(const SSL *ssl, int ret_code);
356
357/* SSL_ERROR_NONE indicates the operation succeeded. */
358#define SSL_ERROR_NONE 0
359
360/* SSL_ERROR_SSL indicates the operation failed within the library. The caller
361 * may inspect the error queue for more information. */
362#define SSL_ERROR_SSL 1
363
364/* SSL_ERROR_WANT_READ indicates the operation failed attempting to read from
365 * the transport. The caller may retry the operation when the transport is ready
David Benjamin8ac00ca2015-10-03 11:14:36 -0400366 * for reading.
367 *
368 * If signaled by a DTLS handshake, the caller must also call
369 * |DTLSv1_get_timeout| and |DTLSv1_handle_timeout| as appropriate. See
370 * |SSL_do_handshake|. */
David Benjamin3c1ccc02015-09-13 00:27:05 -0400371#define SSL_ERROR_WANT_READ 2
372
373/* SSL_ERROR_WANT_READ indicates the operation failed attempting to write to
374 * the transport. The caller may retry the operation when the transport is ready
375 * for writing. */
376#define SSL_ERROR_WANT_WRITE 3
377
378/* SSL_ERROR_WANT_X509_LOOKUP indicates the operation failed in calling the
379 * |cert_cb| or |client_cert_cb|. The caller may retry the operation when the
380 * callback is ready to return a certificate or one has been configured
381 * externally.
382 *
383 * See also |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb|. */
384#define SSL_ERROR_WANT_X509_LOOKUP 4
385
386/* SSL_ERROR_WANT_SYSCALL indicates the operation failed externally to the
387 * library. The caller should consult the system-specific error mechanism. This
388 * is typically |errno| but may be something custom if using a custom |BIO|. It
389 * may also be signaled if the transport returned EOF, in which case the
390 * operation's return value will be zero. */
391#define SSL_ERROR_SYSCALL 5
392
393/* SSL_ERROR_ZERO_RETURN indicates the operation failed because the connection
394 * was cleanly shut down with a close_notify alert. */
395#define SSL_ERROR_ZERO_RETURN 6
396
397/* SSL_ERROR_WANT_CONNECT indicates the operation failed attempting to connect
398 * the transport (the |BIO| signaled |BIO_RR_CONNECT|). The caller may retry the
399 * operation when the transport is ready. */
400#define SSL_ERROR_WANT_CONNECT 7
401
402/* SSL_ERROR_WANT_ACCEPT indicates the operation failed attempting to accept a
403 * connection from the transport (the |BIO| signaled |BIO_RR_ACCEPT|). The
404 * caller may retry the operation when the transport is ready.
405 *
406 * TODO(davidben): Remove this. It's used by accept BIOs which are bizarre. */
407#define SSL_ERROR_WANT_ACCEPT 8
408
409/* SSL_ERROR_WANT_CHANNEL_ID_LOOKUP indicates the operation failed looking up
410 * the Channel ID key. The caller may retry the operation when |channel_id_cb|
David Benjamin42fea372015-09-19 01:22:44 -0400411 * is ready to return a key or one has been configured with
412 * |SSL_set1_tls_channel_id|.
David Benjamin3c1ccc02015-09-13 00:27:05 -0400413 *
414 * See also |SSL_CTX_set_channel_id_cb|. */
415#define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9
416
417/* SSL_ERROR_PENDING_SESSION indicates the operation failed because the session
418 * lookup callback indicated the session was unavailable. The caller may retry
419 * the operation when lookup has completed.
420 *
David Benjamindafbdd42015-09-14 01:40:10 -0400421 * See also |SSL_CTX_sess_set_get_cb| and |SSL_magic_pending_session_ptr|. */
David Benjamin3c1ccc02015-09-13 00:27:05 -0400422#define SSL_ERROR_PENDING_SESSION 11
423
424/* SSL_ERROR_PENDING_CERTIFICATE indicates the operation failed because the
425 * early callback indicated certificate lookup was incomplete. The caller may
426 * retry the operation when lookup has completed. Note: when the operation is
427 * retried, the early callback will not be called a second time.
428 *
David Benjamind4c2bce2015-10-17 12:28:18 -0400429 * See also |SSL_CTX_set_select_certificate_cb|. */
David Benjamin3c1ccc02015-09-13 00:27:05 -0400430#define SSL_ERROR_PENDING_CERTIFICATE 12
431
432/* SSL_ERROR_WANT_PRIVATE_KEY_OPERATION indicates the operation failed because
433 * a private key operation was unfinished. The caller may retry the operation
434 * when the private key operation is complete.
435 *
436 * See also |SSL_set_private_key_method|. */
437#define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13
438
David Benjamin8ac00ca2015-10-03 11:14:36 -0400439/* SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success
440 * and zero on failure. */
441OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu);
442
443/* DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a
444 * timeout in progress, it sets |*out| to the time remaining and returns one.
445 * Otherwise, it returns zero.
446 *
447 * When the timeout expires, call |DTLSv1_handle_timeout| to handle the
448 * retransmit behavior.
449 *
450 * NOTE: This function must be queried again whenever the handshake state
451 * machine changes, including when |DTLSv1_handle_timeout| is called. */
452OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out);
453
454/* DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no
455 * timeout had expired, it returns 0. Otherwise, it retransmits the previous
456 * flight of handshake messages and returns 1. If too many timeouts had expired
457 * without progress or an error occurs, it returns -1.
458 *
459 * NOTE: The caller's external timer should be compatible with the one |ssl|
460 * queries within some fudge factor. Otherwise, the call will be a no-op, but
461 * |DTLSv1_get_timeout| will return an updated timeout.
462 *
463 * WARNING: This function breaks the usual return value convention. */
464OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl);
465
David Benjamin4831c332015-05-16 11:43:13 -0400466
David Benjaminb487df62015-05-16 15:31:07 -0400467/* Protocol versions. */
468
David Benjaminb8d28cf2015-07-28 21:34:45 -0400469#define DTLS1_VERSION_MAJOR 0xfe
David Benjaminb487df62015-05-16 15:31:07 -0400470#define SSL3_VERSION_MAJOR 0x03
471
472#define SSL3_VERSION 0x0300
473#define TLS1_VERSION 0x0301
474#define TLS1_1_VERSION 0x0302
475#define TLS1_2_VERSION 0x0303
476
477#define DTLS1_VERSION 0xfeff
478#define DTLS1_2_VERSION 0xfefd
479
480/* SSL_CTX_set_min_version sets the minimum protocol version for |ctx| to
481 * |version|. */
482OPENSSL_EXPORT void SSL_CTX_set_min_version(SSL_CTX *ctx, uint16_t version);
483
484/* SSL_CTX_set_max_version sets the maximum protocol version for |ctx| to
485 * |version|. */
486OPENSSL_EXPORT void SSL_CTX_set_max_version(SSL_CTX *ctx, uint16_t version);
487
488/* SSL_set_min_version sets the minimum protocol version for |ssl| to
489 * |version|. */
490OPENSSL_EXPORT void SSL_set_min_version(SSL *ssl, uint16_t version);
491
492/* SSL_set_max_version sets the maximum protocol version for |ssl| to
493 * |version|. */
494OPENSSL_EXPORT void SSL_set_max_version(SSL *ssl, uint16_t version);
495
David Benjamin42fea372015-09-19 01:22:44 -0400496/* SSL_version returns the TLS or DTLS protocol version used by |ssl|, which is
497 * one of the |*_VERSION| values. (E.g. |TLS1_2_VERSION|.) Before the version
498 * is negotiated, the result is undefined. */
499OPENSSL_EXPORT int SSL_version(const SSL *ssl);
500
David Benjaminb487df62015-05-16 15:31:07 -0400501
502/* Options.
503 *
504 * Options configure protocol behavior. */
505
506/* SSL_OP_LEGACY_SERVER_CONNECT allows initial connections to servers that don't
507 * support the renegotiation_info extension (RFC 5746). It is on by default. */
508#define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L
509
510/* SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER allows for record sizes |SSL3_RT_MAX_EXTRA|
511 * bytes above the maximum record size. */
512#define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L
513
514/* SSL_OP_TLS_D5_BUG accepts an RSAClientKeyExchange in TLS encoded as in SSL3
515 * (i.e. without a length prefix). */
516#define SSL_OP_TLS_D5_BUG 0x00000100L
517
518/* SSL_OP_ALL enables the above bug workarounds that are enabled by many
519 * consumers.
520 * TODO(davidben): Determine which of the remaining may be removed now. */
521#define SSL_OP_ALL 0x00000BFFL
522
523/* SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying
524 * |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. */
525#define SSL_OP_NO_QUERY_MTU 0x00001000L
526
David Benjamindafbdd42015-09-14 01:40:10 -0400527/* SSL_OP_NO_TICKET disables session ticket support (RFC 5077). */
David Benjaminb487df62015-05-16 15:31:07 -0400528#define SSL_OP_NO_TICKET 0x00004000L
529
David Benjaminb487df62015-05-16 15:31:07 -0400530/* SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and
531 * ECDHE curves according to the server's preferences instead of the
532 * client's. */
533#define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L
534
David Benjaminb487df62015-05-16 15:31:07 -0400535/* SSL_CTX_set_options enables all options set in |options| (which should be one
536 * or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
537 * bitmask representing the resulting enabled options. */
538OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options);
539
540/* SSL_CTX_clear_options disables all options set in |options| (which should be
541 * one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a
542 * bitmask representing the resulting enabled options. */
543OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options);
544
545/* SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all
546 * the options enabled for |ctx|. */
547OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx);
548
549/* SSL_set_options enables all options set in |options| (which should be one or
550 * more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask
551 * representing the resulting enabled options. */
552OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options);
553
554/* SSL_clear_options disables all options set in |options| (which should be one
555 * or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a
556 * bitmask representing the resulting enabled options. */
557OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options);
558
559/* SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the
560 * options enabled for |ssl|. */
561OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl);
562
563
564/* Modes.
565 *
566 * Modes configure API behavior. */
567
568/* SSL_MODE_ENABLE_PARTIAL_WRITE allows |SSL_write| to complete with a partial
569 * result when the only part of the input was written in a single record. */
570#define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L
571
572/* SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER allows retrying an incomplete |SSL_write|
573 * with a different buffer. However, |SSL_write| still assumes the buffer
574 * contents are unchanged. This is not the default to avoid the misconception
575 * that non-blocking |SSL_write| behaves like non-blocking |write|. */
576#define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L
577
578/* SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain
579 * before sending certificates to the peer.
580 * TODO(davidben): Remove this behavior. https://crbug.com/486295. */
581#define SSL_MODE_NO_AUTO_CHAIN 0x00000008L
582
David Benjaminb487df62015-05-16 15:31:07 -0400583/* SSL_MODE_ENABLE_FALSE_START allows clients to send application data before
584 * receipt of CCS and Finished. This mode enables full-handshakes to 'complete'
585 * in one RTT. See draft-bmoeller-tls-falsestart-01. */
586#define SSL_MODE_ENABLE_FALSE_START 0x00000080L
587
David Benjaminb487df62015-05-16 15:31:07 -0400588/* SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in SSL 3.0 and
589 * TLS 1.0 to be split in two: the first record will contain a single byte and
590 * the second will contain the remainder. This effectively randomises the IV and
591 * prevents BEAST attacks. */
592#define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L
593
594/* SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to
595 * fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that
596 * session resumption is used for a given SSL*. */
597#define SSL_MODE_NO_SESSION_CREATION 0x00000200L
598
599/* SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello.
600 * To be set only by applications that reconnect with a downgraded protocol
David Benjamin229adfb2015-07-25 15:08:18 -0400601 * version; see RFC 7507 for details.
David Benjaminb487df62015-05-16 15:31:07 -0400602 *
603 * DO NOT ENABLE THIS if your application attempts a normal handshake. Only use
David Benjamin229adfb2015-07-25 15:08:18 -0400604 * this in explicit fallback retries, following the guidance in RFC 7507. */
David Benjaminb487df62015-05-16 15:31:07 -0400605#define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L
606
David Benjaminb487df62015-05-16 15:31:07 -0400607/* SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more
608 * of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask
609 * representing the resulting enabled modes. */
610OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode);
611
612/* SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or
613 * more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a
614 * bitmask representing the resulting enabled modes. */
615OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode);
616
617/* SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all
618 * the modes enabled for |ssl|. */
619OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx);
620
621/* SSL_set_mode enables all modes set in |mode| (which should be one or more of
622 * the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
623 * representing the resulting enabled modes. */
624OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode);
625
626/* SSL_clear_mode disables all modes set in |mode| (which should be one or more
627 * of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask
628 * representing the resulting enabled modes. */
629OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode);
630
631/* SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the
632 * modes enabled for |ssl|. */
633OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl);
634
635
David Benjaminb4d65fd2015-05-29 17:11:21 -0400636/* Configuring certificates and private keys.
637 *
David Benjamin11c0f8e2015-07-06 00:18:15 -0400638 * These functions configure the connection's leaf certificate, private key, and
639 * certificate chain. The certificate chain is ordered leaf to root (as sent on
640 * the wire) but does not include the leaf. Both client and server certificates
641 * use these functions.
642 *
643 * Certificates and keys may be configured before the handshake or dynamically
644 * in the early callback and certificate callback. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400645
David Benjamin7481d392015-07-05 19:38:46 -0400646/* SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns
647 * one on success and zero on failure. */
648OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509);
649
650/* SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one
651 * on success and zero on failure. */
652OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509);
653
654/* SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on
655 * success and zero on failure. */
656OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey);
657
658/* SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on
659 * success and zero on failure. */
660OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey);
661
David Benjamin11c0f8e2015-07-06 00:18:15 -0400662/* SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to
663 * |chain|. On success, it returns one and takes ownership of |chain|.
664 * Otherwise, it returns zero. */
665OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
666
667/* SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to
668 * |chain|. It returns one on success and zero on failure. The caller retains
669 * ownership of |chain| and may release it freely. */
670OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain);
671
672/* SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to
673 * |chain|. On success, it returns one and takes ownership of |chain|.
674 * Otherwise, it returns zero. */
675OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain);
676
677/* SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to
678 * |chain|. It returns one on success and zero on failure. The caller retains
679 * ownership of |chain| and may release it freely. */
680OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain);
681
682/* SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On
683 * success, it returns one and takes ownership of |x509|. Otherwise, it returns
684 * zero. */
685OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
686
687/* SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It
688 * returns one on success and zero on failure. The caller retains ownership of
689 * |x509| and may release it freely. */
690OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
691
692/* SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success,
693 * it returns one and takes ownership of |x509|. Otherwise, it returns zero. */
694OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
695
696/* SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. */
697OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
698
699/* SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns
700 * one on success and zero on failure. The caller retains ownership of |x509|
701 * and may release it freely. */
702OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
703
704/* SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns
705 * one. */
706OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
707
708/* SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. */
709OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
710
711/* SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. */
712OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl);
713
David Benjamin7481d392015-07-05 19:38:46 -0400714/* SSL_CTX_set_cert_cb sets a callback that is called to select a certificate.
715 * The callback returns one on success, zero on internal error, and a negative
716 * number on failure or to pause the handshake. If the handshake is paused,
David Benjaminfd8e69f2015-10-03 10:49:20 -0400717 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|.
718 *
719 * On the client, the callback may call |SSL_get0_certificate_types| and
720 * |SSL_get_client_CA_list| for information on the server's certificate
721 * request. */
David Benjamin7481d392015-07-05 19:38:46 -0400722OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx,
723 int (*cb)(SSL *ssl, void *arg),
724 void *arg);
725
726/* SSL_set_cert_cb sets a callback that is called to select a certificate. The
727 * callback returns one on success, zero on internal error, and a negative
728 * number on failure or to pause the handshake. If the handshake is paused,
David Benjaminfd8e69f2015-10-03 10:49:20 -0400729 * |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|.
730 *
731 * On the client, the callback may call |SSL_get0_certificate_types| and
732 * |SSL_get_client_CA_list| for information on the server's certificate
733 * request. */
David Benjamin7481d392015-07-05 19:38:46 -0400734OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg),
735 void *arg);
736
David Benjaminfd8e69f2015-10-03 10:49:20 -0400737/* SSL_get0_certificate_types, for a client, sets |*out_types| to an array
738 * containing the client certificate types requested by a server. It returns the
739 * length of the array.
740 *
741 * The behavior of this function is undefined except during the callbacks set by
742 * by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or when the
743 * handshake is paused because of them. */
744OPENSSL_EXPORT size_t SSL_get0_certificate_types(SSL *ssl,
745 const uint8_t **out_types);
746
David Benjamin7481d392015-07-05 19:38:46 -0400747/* SSL_certs_clear resets the private key, leaf certificate, and certificate
748 * chain of |ssl|. */
749OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl);
750
751/* SSL_CTX_check_private_key returns one if the certificate and private key
752 * configured in |ctx| are consistent and zero otherwise. */
753OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx);
754
755/* SSL_check_private_key returns one if the certificate and private key
756 * configured in |ssl| are consistent and zero otherwise. */
757OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl);
758
759/* SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. */
760OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx);
761
762/* SSL_get_certificate returns |ssl|'s leaf certificate. */
763OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl);
764
David Benjamin11c0f8e2015-07-06 00:18:15 -0400765/* SSL_CTX_get0_privatekey returns |ctx|'s private key. */
766OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx);
767
768/* SSL_get_privatekey returns |ssl|'s private key. */
769OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl);
770
771/* SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and
772 * returns one. */
773OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx,
774 STACK_OF(X509) **out_chain);
775
776/* SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. */
777OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx,
778 STACK_OF(X509) **out_chain);
779
780/* SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and
781 * returns one. */
782OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl,
783 STACK_OF(X509) **out_chain);
784
Paul Lietar4fac72e2015-09-09 13:44:55 +0100785/* SSL_CTX_set_signed_cert_timestamp_list sets the list of signed certificate
786 * timestamps that is sent to clients that request it. The |list| argument must
787 * contain one or more SCT structures serialised as a SignedCertificateTimestamp
788 * List (see https://tools.ietf.org/html/rfc6962#section-3.3) – i.e. each SCT
789 * is prefixed by a big-endian, uint16 length and the concatenation of one or
790 * more such prefixed SCTs are themselves also prefixed by a uint16 length. It
791 * returns one on success and zero on error. The caller retains ownership of
792 * |list|. */
793OPENSSL_EXPORT int SSL_CTX_set_signed_cert_timestamp_list(SSL_CTX *ctx,
794 const uint8_t *list,
795 size_t list_len);
796
Paul Lietaraeeff2c2015-08-12 11:47:11 +0100797/* SSL_CTX_set_ocsp_response sets the OCSP reponse that is sent to clients
798 * which request it. It returns one on success and zero on error. The caller
799 * retains ownership of |response|. */
800OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx,
801 const uint8_t *response,
802 size_t response_len);
803
Steven Valdez0d62f262015-09-04 12:41:04 -0400804/* SSL_set_private_key_digest_prefs copies |num_digests| NIDs from |digest_nids|
805 * into |ssl|. These digests will be used, in decreasing order of preference,
806 * when signing with |ssl|'s private key. It returns one on success and zero on
807 * error. */
808OPENSSL_EXPORT int SSL_set_private_key_digest_prefs(SSL *ssl,
809 const int *digest_nids,
810 size_t num_digests);
811
David Benjamin7481d392015-07-05 19:38:46 -0400812
813/* Certificate and private key convenience functions. */
814
815/* SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one
816 * on success and zero on failure. */
817OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa);
818
819/* SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on
820 * success and zero on failure. */
821OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa);
822
823/* The following functions configure certificates or private keys but take as
824 * input DER-encoded structures. They return one on success and zero on
825 * failure. */
826
827OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, int len,
828 const uint8_t *d);
829OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der,
830 int len);
831
832OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx,
833 const uint8_t *d, long len);
834OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl,
835 const uint8_t *d, long len);
836
837OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx,
David Benjamin74f71102015-06-27 14:56:25 -0400838 const uint8_t *der,
839 size_t der_len);
840OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der,
841 size_t der_len);
David Benjamin7481d392015-07-05 19:38:46 -0400842
843/* The following functions configure certificates or private keys but take as
844 * input files to read from. They return one on success and zero on failure. The
845 * |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether
846 * the file's contents are read as PEM or DER. */
847
848#define SSL_FILETYPE_ASN1 X509_FILETYPE_ASN1
849#define SSL_FILETYPE_PEM X509_FILETYPE_PEM
850
851OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx,
852 const char *file,
853 int type);
854OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file,
855 int type);
856
857OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file,
858 int type);
859OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file,
860 int type);
861
862OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file,
863 int type);
864OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file,
865 int type);
866
Adam Langleyc8e664b2015-09-24 14:48:32 -0700867/* SSL_CTX_use_certificate_chain_file configures certificates for |ctx|. It
868 * reads the contents of |file| as a PEM-encoded leaf certificate followed
869 * optionally by the certificate chain to send to the peer. It returns one on
870 * success and zero on failure. */
David Benjamin7481d392015-07-05 19:38:46 -0400871OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx,
872 const char *file);
873
David Benjamin42fea372015-09-19 01:22:44 -0400874/* SSL_CTX_set_default_passwd_cb sets the password callback for PEM-based
875 * convenience functions called on |ctx|. */
876OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx,
877 pem_password_cb *cb);
878
879/* SSL_CTX_set_default_passwd_cb_userdata sets the userdata parameter for
880 * |ctx|'s password callback. */
881OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx,
882 void *data);
883
David Benjamin7481d392015-07-05 19:38:46 -0400884
885/* Custom private keys. */
886
David Benjaminb4d65fd2015-05-29 17:11:21 -0400887enum ssl_private_key_result_t {
888 ssl_private_key_success,
889 ssl_private_key_retry,
890 ssl_private_key_failure,
891};
892
893/* SSL_PRIVATE_KEY_METHOD describes private key hooks. This is used to off-load
894 * signing operations to a custom, potentially asynchronous, backend. */
895typedef struct ssl_private_key_method_st {
896 /* type returns either |EVP_PKEY_RSA| or |EVP_PKEY_EC| to denote the type of
897 * key used by |ssl|. */
898 int (*type)(SSL *ssl);
899
David Benjaminb4d65fd2015-05-29 17:11:21 -0400900 /* max_signature_len returns the maximum length of a signature signed by the
901 * key used by |ssl|. This must be a constant value for a given |ssl|. */
902 size_t (*max_signature_len)(SSL *ssl);
903
904 /* sign signs |in_len| bytes of digest from |in|. |md| is the hash function
905 * used to calculate |in|. On success, it returns |ssl_private_key_success|
906 * and writes at most |max_out| bytes of signature data to |out|. On failure,
907 * it returns |ssl_private_key_failure|. If the operation has not completed,
908 * it returns |ssl_private_key_retry|. |sign| should arrange for the
909 * high-level operation on |ssl| to be retried when the operation is
910 * completed. This will result in a call to |sign_complete|.
911 *
912 * If the key is an RSA key, implementations must use PKCS#1 padding. |in| is
913 * the digest itself, so the DigestInfo prefix, if any, must be prepended by
914 * |sign|. If |md| is |EVP_md5_sha1|, there is no prefix.
915 *
916 * It is an error to call |sign| while another private key operation is in
917 * progress on |ssl|. */
918 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len,
919 size_t max_out, const EVP_MD *md,
920 const uint8_t *in, size_t in_len);
921
922 /* sign_complete completes a pending |sign| operation. If the operation has
923 * completed, it returns |ssl_private_key_success| and writes the result to
924 * |out| as in |sign|. Otherwise, it returns |ssl_private_key_failure| on
925 * failure and |ssl_private_key_retry| if the operation is still in progress.
926 *
927 * |sign_complete| may be called arbitrarily many times before completion, but
928 * it is an error to call |sign_complete| if there is no pending |sign|
929 * operation in progress on |ssl|. */
930 enum ssl_private_key_result_t (*sign_complete)(SSL *ssl, uint8_t *out,
931 size_t *out_len, size_t max_out);
932} SSL_PRIVATE_KEY_METHOD;
933
Steven Valdez0d62f262015-09-04 12:41:04 -0400934/* SSL_set_private_key_method configures a custom private key on |ssl|.
David Benjamind1d80782015-07-05 11:54:09 -0400935 * |key_method| must remain valid for the lifetime of |ssl|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400936OPENSSL_EXPORT void SSL_set_private_key_method(
937 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method);
938
939
David Benjamindf6a3f82015-09-20 12:18:11 -0400940/* Cipher suites.
941 *
942 * |SSL_CIPHER| objects represent cipher suites. */
943
944DECLARE_STACK_OF(SSL_CIPHER)
945
946/* SSL_get_cipher_by_value returns the structure representing a TLS cipher
947 * suite based on its assigned number, or NULL if unknown. See
948 * https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. */
949OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value);
950
951/* SSL_CIPHER_get_id returns |cipher|'s id. It may be cast to a |uint16_t| to
952 * get the cipher suite value. */
953OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher);
954
955/* SSL_CIPHER_is_AES returns one if |cipher| uses AES (either GCM or CBC
956 * mode). */
957OPENSSL_EXPORT int SSL_CIPHER_is_AES(const SSL_CIPHER *cipher);
958
959/* SSL_CIPHER_has_MD5_HMAC returns one if |cipher| uses HMAC-MD5. */
960OPENSSL_EXPORT int SSL_CIPHER_has_MD5_HMAC(const SSL_CIPHER *cipher);
961
962/* SSL_CIPHER_is_AESGCM returns one if |cipher| uses AES-GCM. */
963OPENSSL_EXPORT int SSL_CIPHER_is_AESGCM(const SSL_CIPHER *cipher);
964
965/* SSL_CIPHER_is_CHACHA20POLY1305 returns one if |cipher| uses
966 * CHACHA20_POLY1305. */
967OPENSSL_EXPORT int SSL_CIPHER_is_CHACHA20POLY1305(const SSL_CIPHER *cipher);
968
969/* SSL_CIPHER_is_NULL returns one if |cipher| does not encrypt. */
970OPENSSL_EXPORT int SSL_CIPHER_is_NULL(const SSL_CIPHER *cipher);
971
972/* SSL_CIPHER_is_RC4 returns one if |cipher| uses RC4. */
973OPENSSL_EXPORT int SSL_CIPHER_is_RC4(const SSL_CIPHER *cipher);
974
975/* SSL_CIPHER_is_block_cipher returns one if |cipher| is a block cipher. */
976OPENSSL_EXPORT int SSL_CIPHER_is_block_cipher(const SSL_CIPHER *cipher);
977
978/* SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. */
979OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher);
980
981/* SSL_CIPHER_get_kx_name returns a string that describes the key-exchange
982 * method used by |cipher|. For example, "ECDHE_ECDSA". */
983OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher);
984
985/* SSL_CIPHER_get_rfc_name returns a newly-allocated string with the standard
986 * name for |cipher| or NULL on error. For example,
987 * "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". The caller is responsible for
988 * calling |OPENSSL_free| on the result. */
989OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher);
990
991/* SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If
992 * |out_alg_bits| is not NULL, it writes the number of bits consumed by the
993 * symmetric algorithm to |*out_alg_bits|. */
994OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher,
995 int *out_alg_bits);
996
997
David Benjamin32876b32015-09-20 12:17:03 -0400998/* Cipher suite configuration.
999 *
1000 * OpenSSL uses a mini-language to configure cipher suites. The language
1001 * maintains an ordered list of enabled ciphers, along with an ordered list of
1002 * disabled but available ciphers. Initially, all ciphers are disabled with a
1003 * default ordering. The cipher string is then interpreted as a sequence of
1004 * directives, separated by colons, each of which modifies this state.
1005 *
1006 * Most directives consist of a one character or empty opcode followed by a
1007 * selector which matches a subset of available ciphers.
1008 *
1009 * Available opcodes are:
1010 *
1011 * The empty opcode enables and appends all matching disabled ciphers to the
1012 * end of the enabled list. The newly appended ciphers are ordered relative to
1013 * each other matching their order in the disabled list.
1014 *
1015 * |-| disables all matching enabled ciphers and prepends them to the disabled
1016 * list, with relative order from the enabled list preserved. This means the
1017 * most recently disabled ciphers get highest preference relative to other
1018 * disabled ciphers if re-enabled.
1019 *
1020 * |+| moves all matching enabled ciphers to the end of the enabled list, with
1021 * relative order preserved.
1022 *
1023 * |!| deletes all matching ciphers, enabled or not, from either list. Deleted
1024 * ciphers will not matched by future operations.
1025 *
1026 * A selector may be a specific cipher (using the OpenSSL name for the cipher)
1027 * or one or more rules separated by |+|. The final selector matches the
1028 * intersection of each rule. For instance, |AESGCM+aECDSA| matches
1029 * ECDSA-authenticated AES-GCM ciphers.
1030 *
1031 * Available cipher rules are:
1032 *
1033 * |ALL| matches all ciphers.
1034 *
1035 * |kRSA|, |kDHE|, |kECDHE|, and |kPSK| match ciphers using plain RSA, DHE,
1036 * ECDHE, and plain PSK key exchanges, respectively. Note that ECDHE_PSK is
1037 * matched by |kECDHE| and not |kPSK|.
1038 *
1039 * |aRSA|, |aECDSA|, and |aPSK| match ciphers authenticated by RSA, ECDSA, and
1040 * a pre-shared key, respectively.
1041 *
1042 * |RSA|, |DHE|, |ECDHE|, |PSK|, |ECDSA|, and |PSK| are aliases for the
1043 * corresponding |k*| or |a*| cipher rule. |RSA| is an alias for |kRSA|, not
1044 * |aRSA|.
1045 *
1046 * |3DES|, |RC4|, |AES128|, |AES256|, |AES|, |AESGCM|, |CHACHA20| match
1047 * ciphers whose bulk cipher use the corresponding encryption scheme. Note
1048 * that |AES|, |AES128|, and |AES256| match both CBC and GCM ciphers.
1049 *
1050 * |MD5|, |SHA1|, |SHA256|, and |SHA384| match legacy cipher suites using the
1051 * corresponding hash function in their MAC. AEADs are matched by none of
1052 * these.
1053 *
1054 * |SHA| is an alias for |SHA1|.
1055 *
1056 * Although implemented, authentication-only ciphers match no rules and must be
1057 * explicitly selected by name.
1058 *
1059 * Deprecated cipher rules:
1060 *
1061 * |kEDH|, |EDH|, |kEECDH|, and |EECDH| are legacy aliases for |kDHE|, |DHE|,
1062 * |kECDHE|, and |ECDHE|, respectively.
1063 *
1064 * |MEDIUM| and |HIGH| match ciphers historically labeled by OpenSSL as
1065 * 'medium' and 'high', respectively.
1066 *
1067 * |FIPS| matches ciphers historically FIPS-approved in OpenSSL.
1068 *
1069 * |SSLv3| and |TLSv1| match ciphers available in TLS 1.1 or earlier.
1070 * |TLSv1_2| matches ciphers new in TLS 1.2. This is confusing and should not
1071 * be used.
1072 *
1073 * Unknown rules silently match nothing.
1074 *
1075 * The special |@STRENGTH| directive will sort all enabled ciphers by strength.
1076 *
1077 * The |DEFAULT| directive, when appearing at the front of the string, expands
1078 * to the default ordering of available ciphers.
1079 *
1080 * If configuring a server, one may also configure equal-preference groups to
1081 * partially respect the client's preferences when
1082 * |SSL_OP_CIPHER_SERVER_PREFERENCE| is enabled. Ciphers in an equal-preference
1083 * group have equal priority and use the client order. This may be used to
1084 * enforce that AEADs are preferred but select AES-GCM vs. ChaCha20-Poly1305
1085 * based on client preferences. An equal-preference is specified with square
1086 * brackets, combining multiple selectors separated by |. For example:
1087 *
1088 * [ECDHE-ECDSA-CHACHA20-POLY1305|ECDHE-ECDSA-AES128-GCM-SHA256]
1089 *
1090 * Once an equal-preference group is used, future directives must be
1091 * opcode-less. */
1092
1093/* SSL_DEFAULT_CIPHER_LIST is the default cipher suite configuration. It is
1094 * substituted when a cipher string starts with 'DEFAULT'. */
1095#define SSL_DEFAULT_CIPHER_LIST "ALL"
1096
1097/* SSL_CTX_set_cipher_list configures the cipher list for |ctx|, evaluating
1098 * |str| as a cipher string. It returns one on success and zero on failure. */
1099OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str);
1100
1101/* SSL_CTX_set_cipher_list configures the TLS 1.0+ cipher list for |ctx|,
1102 * evaluating |str| as a cipher string. It returns one on success and zero on
1103 * failure. If set, servers will use this cipher suite list for TLS 1.0 or
1104 * higher. */
1105OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls10(SSL_CTX *ctx, const char *str);
1106
1107/* SSL_CTX_set_cipher_list configures the TLS 1.1+ cipher list for |ctx|,
1108 * evaluating |str| as a cipher string. It returns one on success and zero on
1109 * failure. If set, servers will use this cipher suite list for TLS 1.1 or
1110 * higher. */
1111OPENSSL_EXPORT int SSL_CTX_set_cipher_list_tls11(SSL_CTX *ctx, const char *str);
1112
1113/* SSL_set_cipher_list configures the cipher list for |ssl|, evaluating |str| as
1114 * a cipher string. It returns one on success and zero on failure. */
1115OPENSSL_EXPORT int SSL_set_cipher_list(SSL *ssl, const char *str);
1116
1117/* SSL_get_ciphers returns the cipher list for |ssl|, in order of preference. If
1118 * |SSL_CTX_set_cipher_list_tls10| or |SSL_CTX_set_cipher_list_tls11| has been
1119 * used, the corresponding list for the current version is returned. */
1120OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl);
1121
1122
Adam Langleyaf0e32c2015-06-03 09:57:23 -07001123/* Connection information. */
1124
David Benjaminee0c8272015-09-13 01:03:54 -04001125/* SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the
1126 * peer did not use certificates. The caller must call |X509_free| on the
1127 * result to release it. */
1128OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl);
1129
1130/* SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if
1131 * unavailable or the peer did not use certificates. For historical reasons,
1132 * this may not be available if resuming a serialized |SSL_SESSION|. The caller
1133 * does not take ownership of the result.
1134 *
1135 * WARNING: This function behaves differently between client and server. If
1136 * |ssl| is a server, the returned chain does not include the leaf certificate.
1137 * If a client, it does. */
1138OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
1139
David Benjaminf88b81a2015-10-05 20:14:37 -04001140/* SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to
1141 * |*out_len| bytes of SCT information from the server. This is only valid if
1142 * |ssl| is a client. The SCT information is a SignedCertificateTimestampList
1143 * (including the two leading length bytes).
1144 * See https://tools.ietf.org/html/rfc6962#section-3.3
1145 * If no SCT was received then |*out_len| will be zero on return.
1146 *
1147 * WARNING: the returned data is not guaranteed to be well formed. */
1148OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl,
1149 const uint8_t **out,
1150 size_t *out_len);
1151
1152/* SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len|
1153 * bytes of an OCSP response from the server. This is the DER encoding of an
1154 * OCSPResponse type as defined in RFC 2560.
1155 *
1156 * WARNING: the returned data is not guaranteed to be well formed. */
1157OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out,
1158 size_t *out_len);
1159
Adam Langleyaf0e32c2015-06-03 09:57:23 -07001160/* SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value
1161 * for |ssl| to |out| and sets |*out_len| to the number of bytes written. It
1162 * returns one on success or zero on error. In general |max_out| should be at
1163 * least 12.
1164 *
1165 * This function will always fail if the initial handshake has not completed.
1166 * The tls-unique value will change after a renegotiation but, since
1167 * renegotiations can be initiated by the server at any point, the higher-level
1168 * protocol must either leave them disabled or define states in which the
1169 * tls-unique value can be read.
1170 *
1171 * The tls-unique value is defined by
1172 * https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the
1173 * TLS protocol, tls-unique is broken for resumed connections unless the
1174 * Extended Master Secret extension is negotiated. Thus this function will
1175 * return zero if |ssl| performed session resumption unless EMS was used when
1176 * negotiating the original session. */
1177OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out,
1178 size_t *out_len, size_t max_out);
1179
Matt Braithwaitecd6f54b2015-09-17 12:54:42 -07001180/* SSL_get_extms_support returns one if the Extended Master Secret
1181 * extension was negotiated. Otherwise, it returns zero. */
1182OPENSSL_EXPORT int SSL_get_extms_support(const SSL *ssl);
1183
David Benjamin42fea372015-09-19 01:22:44 -04001184/* SSL_get_current_cipher returns the cipher used in the current outgoing
1185 * connection state, or NULL if the null cipher is active. */
1186OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl);
1187
1188/* SSL_session_reused returns one if |ssl| performed an abbreviated handshake
1189 * and zero otherwise.
1190 *
1191 * TODO(davidben): Hammer down the semantics of this API while a handshake,
1192 * initial or renego, is in progress. */
1193OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl);
1194
1195/* SSL_get_secure_renegotiation_support returns one if the peer supports secure
1196 * renegotiation (RFC 5746) and zero otherwise. */
1197OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl);
1198
David Benjamin07e13842015-10-17 13:48:04 -04001199/* SSL_export_keying_material exports a value derived from the master secret, as
1200 * specified in RFC 5705. It writes |out_len| bytes to |out| given a label and
1201 * optional context. (Since a zero length context is allowed, the |use_context|
1202 * flag controls whether a context is included.)
1203 *
1204 * It returns one on success and zero otherwise. */
1205OPENSSL_EXPORT int SSL_export_keying_material(
1206 SSL *ssl, uint8_t *out, size_t out_len, const char *label, size_t label_len,
1207 const uint8_t *context, size_t context_len, int use_context);
1208
Adam Langleyaf0e32c2015-06-03 09:57:23 -07001209
Adam Langley09505632015-07-30 18:10:13 -07001210/* Custom extensions.
1211 *
1212 * The custom extension functions allow TLS extensions to be added to
1213 * ClientHello and ServerHello messages. */
1214
1215/* SSL_custom_ext_add_cb is a callback function that is called when the
1216 * ClientHello (for clients) or ServerHello (for servers) is constructed. In
1217 * the case of a server, this callback will only be called for a given
1218 * extension if the ClientHello contained that extension – it's not possible to
1219 * inject extensions into a ServerHello that the client didn't request.
1220 *
1221 * When called, |extension_value| will contain the extension number that is
1222 * being considered for addition (so that a single callback can handle multiple
1223 * extensions). If the callback wishes to include the extension, it must set
1224 * |*out| to point to |*out_len| bytes of extension contents and return one. In
1225 * this case, the corresponding |SSL_custom_ext_free_cb| callback will later be
1226 * called with the value of |*out| once that data has been copied.
1227 *
1228 * If the callback does not wish to add an extension it must return zero.
1229 *
1230 * Alternatively, the callback can abort the connection by setting
1231 * |*out_alert_value| to a TLS alert number and returning -1. */
1232typedef int (*SSL_custom_ext_add_cb)(SSL *ssl, unsigned extension_value,
1233 const uint8_t **out, size_t *out_len,
1234 int *out_alert_value, void *add_arg);
1235
1236/* SSL_custom_ext_free_cb is a callback function that is called by OpenSSL iff
1237 * an |SSL_custom_ext_add_cb| callback previously returned one. In that case,
1238 * this callback is called and passed the |out| pointer that was returned by
1239 * the add callback. This is to free any dynamically allocated data created by
1240 * the add callback. */
1241typedef void (*SSL_custom_ext_free_cb)(SSL *ssl, unsigned extension_value,
1242 const uint8_t *out, void *add_arg);
1243
1244/* SSL_custom_ext_parse_cb is a callback function that is called by OpenSSL to
1245 * parse an extension from the peer: that is from the ServerHello for a client
1246 * and from the ClientHello for a server.
1247 *
1248 * When called, |extension_value| will contain the extension number and the
1249 * contents of the extension are |contents_len| bytes at |contents|.
1250 *
1251 * The callback must return one to continue the handshake. Otherwise, if it
1252 * returns zero, a fatal alert with value |*out_alert_value| is sent and the
1253 * handshake is aborted. */
1254typedef int (*SSL_custom_ext_parse_cb)(SSL *ssl, unsigned extension_value,
1255 const uint8_t *contents,
1256 size_t contents_len,
1257 int *out_alert_value, void *parse_arg);
1258
1259/* SSL_extension_supported returns one iff OpenSSL internally handles
1260 * extensions of type |extension_value|. This can be used to avoid registering
1261 * custom extension handlers for extensions that a future version of OpenSSL
1262 * may handle internally. */
1263OPENSSL_EXPORT int SSL_extension_supported(unsigned extension_value);
1264
1265/* SSL_CTX_add_client_custom_ext registers callback functions for handling
1266 * custom TLS extensions for client connections.
1267 *
1268 * If |add_cb| is NULL then an empty extension will be added in each
1269 * ClientHello. Otherwise, see the comment for |SSL_custom_ext_add_cb| about
1270 * this callback.
1271 *
1272 * The |free_cb| may be NULL if |add_cb| doesn't dynamically allocate data that
1273 * needs to be freed.
1274 *
1275 * It returns one on success or zero on error. It's always an error to register
1276 * callbacks for the same extension twice, or to register callbacks for an
1277 * extension that OpenSSL handles internally. See |SSL_extension_supported| to
1278 * discover, at runtime, which extensions OpenSSL handles internally. */
1279OPENSSL_EXPORT int SSL_CTX_add_client_custom_ext(
1280 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1281 SSL_custom_ext_free_cb free_cb, void *add_arg,
1282 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1283
1284/* SSL_CTX_add_server_custom_ext is the same as
1285 * |SSL_CTX_add_client_custom_ext|, but for server connections.
1286 *
1287 * Unlike on the client side, if |add_cb| is NULL no extension will be added.
1288 * The |add_cb|, if any, will only be called if the ClientHello contained a
1289 * matching extension. */
1290OPENSSL_EXPORT int SSL_CTX_add_server_custom_ext(
1291 SSL_CTX *ctx, unsigned extension_value, SSL_custom_ext_add_cb add_cb,
1292 SSL_custom_ext_free_cb free_cb, void *add_arg,
1293 SSL_custom_ext_parse_cb parse_cb, void *parse_arg);
1294
1295
David Benjamina6b8cdf2015-09-13 14:07:33 -04001296/* Sessions.
1297 *
1298 * An |SSL_SESSION| represents an SSL session that may be resumed in an
1299 * abbreviated handshake. It is reference-counted and immutable. Once
1300 * established, an |SSL_SESSION| may be shared by multiple |SSL| objects on
1301 * different threads and must not be modified. */
1302
David Benjamin3fb1ebc2015-09-16 00:29:20 -04001303DECLARE_LHASH_OF(SSL_SESSION)
1304
David Benjamina6b8cdf2015-09-13 14:07:33 -04001305/* SSL_SESSION_new returns a newly-allocated blank |SSL_SESSION| or NULL on
1306 * error. This may be useful in writing tests but otherwise should not be
1307 * used outside the library. */
1308OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(void);
1309
1310/* SSL_SESSION_up_ref, if |session| is not NULL, increments the reference count
1311 * of |session|. It then returns |session|. */
1312OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_up_ref(SSL_SESSION *session);
1313
1314/* SSL_SESSION_free decrements the reference count of |session|. If it reaches
1315 * zero, all data referenced by |session| and |session| itself are released. */
1316OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session);
1317
1318/* SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets
1319 * |*out_data| to that buffer and |*out_len| to its length. The caller takes
1320 * ownership of the buffer and must call |OPENSSL_free| when done. It returns
1321 * one on success and zero on error. */
David Benjamin14e2b502015-09-13 14:48:12 -04001322OPENSSL_EXPORT int SSL_SESSION_to_bytes(const SSL_SESSION *in,
1323 uint8_t **out_data, size_t *out_len);
David Benjamina6b8cdf2015-09-13 14:07:33 -04001324
1325/* SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session
1326 * identification information, namely the session ID and ticket. */
David Benjamin14e2b502015-09-13 14:48:12 -04001327OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(const SSL_SESSION *in,
David Benjamina6b8cdf2015-09-13 14:07:33 -04001328 uint8_t **out_data,
1329 size_t *out_len);
1330
1331/* SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It
1332 * returns a newly-allocated |SSL_SESSION| on success or NULL on error. */
1333OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes(const uint8_t *in,
1334 size_t in_len);
1335
1336/* SSL_SESSION_get_version returns a string describing the TLS version |session|
1337 * was established at. For example, "TLSv1.2" or "SSLv3". */
1338OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *session);
1339
1340/* SSL_SESSION_get_id returns a pointer to a buffer containg |session|'s session
1341 * ID and sets |*out_len| to its length. */
1342OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *session,
1343 unsigned *out_len);
1344
1345/* SSL_SESSION_get_time returns the time at which |session| was established in
1346 * seconds since the UNIX epoch. */
1347OPENSSL_EXPORT long SSL_SESSION_get_time(const SSL_SESSION *session);
1348
1349/* SSL_SESSION_get_timeout returns the lifetime of |session| in seconds. */
1350OPENSSL_EXPORT long SSL_SESSION_get_timeout(const SSL_SESSION *session);
1351
1352/* SSL_SESSION_get_key_exchange_info returns a value that describes the
1353 * strength of the asymmetric operation that provides confidentiality to
1354 * |session|. Its interpretation depends on the operation used. See the
1355 * documentation for this value in the |SSL_SESSION| structure. */
David Benjamin14e2b502015-09-13 14:48:12 -04001356OPENSSL_EXPORT uint32_t SSL_SESSION_get_key_exchange_info(
1357 const SSL_SESSION *session);
David Benjamina6b8cdf2015-09-13 14:07:33 -04001358
1359/* SSL_SESSION_get0_peer return's the peer leaf certificate stored in
David Benjamin14e2b502015-09-13 14:48:12 -04001360 * |session|.
1361 *
1362 * TODO(davidben): This should return a const X509 *. */
1363OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(const SSL_SESSION *session);
David Benjamina6b8cdf2015-09-13 14:07:33 -04001364
1365/* SSL_SESSION_set_time sets |session|'s creation time to |time| and returns
1366 * |time|. This function may be useful in writing tests but otherwise should not
1367 * be used. */
1368OPENSSL_EXPORT long SSL_SESSION_set_time(SSL_SESSION *session, long time);
1369
Adam Langleyc8e664b2015-09-24 14:48:32 -07001370/* SSL_SESSION_set_timeout sets |session|'s timeout to |timeout| and returns
1371 * one. This function may be useful in writing tests but otherwise should not
1372 * be used. */
David Benjamina6b8cdf2015-09-13 14:07:33 -04001373OPENSSL_EXPORT long SSL_SESSION_set_timeout(SSL_SESSION *session, long timeout);
1374
1375/* SSL_SESSION_set1_id_context sets |session|'s session ID context (see
1376 * |SSL_CTX_set_session_id_context|) to |sid_ctx|. It returns one on success and
1377 * zero on error. This function may be useful in writing tests but otherwise
1378 * should not be used. */
1379OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *session,
1380 const uint8_t *sid_ctx,
1381 unsigned sid_ctx_len);
1382
1383
David Benjamindafbdd42015-09-14 01:40:10 -04001384/* Session caching.
1385 *
1386 * Session caching allows clients to reconnect to a server based on saved
1387 * parameters from a previous connection.
1388 *
1389 * For a server, the library implements a built-in internal session cache as an
1390 * in-memory hash table. One may also register callbacks to implement a custom
1391 * external session cache. An external cache may be used in addition to or
1392 * instead of the internal one. Use |SSL_CTX_set_session_cache_mode| to toggle
1393 * the internal cache.
1394 *
1395 * For a client, the only option is an external session cache. Prior to
1396 * handshaking, the consumer should look up a session externally (keyed, for
1397 * instance, by hostname) and use |SSL_set_session| to configure which session
1398 * to offer. The callbacks may be used to determine when new sessions are
1399 * available.
1400 *
1401 * Note that offering or accepting a session short-circuits most parameter
1402 * negotiation. Resuming sessions across different configurations may result in
1403 * surprising behavor. So, for instance, a client implementing a version
1404 * fallback should shard its session cache by maximum protocol version. */
1405
1406/* SSL_SESS_CACHE_OFF disables all session caching. */
1407#define SSL_SESS_CACHE_OFF 0x0000
1408
1409/* SSL_SESS_CACHE_CLIENT enables session caching for a client.
1410 *
1411 * TODO(davidben): The internal cache is useless on the client. Always act as if
1412 * SSL_SESS_CACHE_NO_INTERNAL is set. https://crbug.com/531194. Also see TODO
1413 * attached to |SSL_CTX_sess_set_new_cb|. */
1414#define SSL_SESS_CACHE_CLIENT 0x0001
1415
1416/* SSL_SESS_CACHE_SERVER enables session caching for a server. */
1417#define SSL_SESS_CACHE_SERVER 0x0002
1418
1419/* SSL_SESS_CACHE_SERVER enables session caching for both client and server. */
1420#define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER)
1421
1422/* SSL_SESS_CACHE_NO_AUTO_CLEAR disables automatically calling
1423 * |SSL_CTX_flush_sessions| every 255 connections. */
1424#define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080
1425
1426/* SSL_SESS_CACHE_NO_INTERNAL_LOOKUP disables looking up a session from the
1427 * internal session cache. */
1428#define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100
1429
1430/* SSL_SESS_CACHE_NO_INTERNAL_STORE disables storing sessions in the internal
1431 * session cache. */
1432#define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200
1433
1434/* SSL_SESS_CACHE_NO_INTERNAL disables the internal session cache. */
1435#define SSL_SESS_CACHE_NO_INTERNAL \
1436 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE)
1437
1438/* SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to
1439 * |mode|. It returns the previous value. */
1440OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode);
1441
1442/* SSL_CTX_get_session_cache_mode returns the session cache mode bits for
1443 * |ctx| */
1444OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx);
1445
David Benjamin43a58ad2015-09-24 23:56:37 -04001446/* SSL_set_session, for a client, configures |ssl| to offer to resume |session|
1447 * in the initial handshake and returns one. The caller retains ownership of
1448 * |session|. */
David Benjamindafbdd42015-09-14 01:40:10 -04001449OPENSSL_EXPORT int SSL_set_session(SSL *ssl, SSL_SESSION *session);
1450
1451/* SSL_get_session returns a non-owning pointer to |ssl|'s session. Prior to the
1452 * initial handshake beginning, this is the session to be offered, set by
1453 * |SSL_set_session|. After a handshake has finished, this is the currently
1454 * active session. Its behavior is undefined while a handshake is progress. */
1455OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl);
1456
1457/* SSL_get0_session is an alias for |SSL_get_session|. */
1458#define SSL_get0_session SSL_get_session
1459
1460/* SSL_get1_session acts like |SSL_get_session| but returns a new reference to
1461 * the session. */
1462OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(SSL *ssl);
1463
David Benjamin42fea372015-09-19 01:22:44 -04001464/* SSL_DEFAULT_SESSION_TIMEOUT is the default lifetime, in seconds, of a
1465 * session. */
1466#define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60)
1467
1468/* SSL_CTX_set_timeout sets the lifetime, in seconds, of sessions created in
1469 * |ctx| to |timeout|. */
David Benjamindafbdd42015-09-14 01:40:10 -04001470OPENSSL_EXPORT long SSL_CTX_set_timeout(SSL_CTX *ctx, long timeout);
1471
David Benjamin42fea372015-09-19 01:22:44 -04001472/* SSL_CTX_get_timeout returns the lifetime, in seconds, of sessions created in
1473 * |ctx|. */
David Benjamindafbdd42015-09-14 01:40:10 -04001474OPENSSL_EXPORT long SSL_CTX_get_timeout(const SSL_CTX *ctx);
1475
1476/* SSL_CTX_set_session_id_context sets |ctx|'s session ID context to |sid_ctx|.
1477 * It returns one on success and zero on error. The session ID context is an
1478 * application-defined opaque byte string. A session will not be used in a
1479 * connection without a matching session ID context.
1480 *
1481 * For a server, if |SSL_VERIFY_PEER| is enabled, it is an error to not set a
1482 * session ID context.
1483 *
1484 * TODO(davidben): Is that check needed? That seems a special case of taking
1485 * care not to cross-resume across configuration changes, and this is only
1486 * relevant if a server requires client auth. */
1487OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx,
1488 const uint8_t *sid_ctx,
1489 unsigned sid_ctx_len);
1490
1491/* SSL_set_session_id_context sets |ssl|'s session ID context to |sid_ctx|. It
1492 * returns one on success and zero on error. See also
1493 * |SSL_CTX_set_session_id_context|. */
1494OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx,
1495 unsigned sid_ctx_len);
1496
David Benjamin42fea372015-09-19 01:22:44 -04001497/* SSL_SESSION_CACHE_MAX_SIZE_DEFAULT is the default maximum size of a session
1498 * cache. */
1499#define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20)
1500
David Benjamindafbdd42015-09-14 01:40:10 -04001501/* SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s internal session
1502 * cache to |size|. It returns the previous value. */
1503OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx,
1504 unsigned long size);
1505
1506/* SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s internal
1507 * session cache. */
1508OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx);
1509
1510/* SSL_CTX_sessions returns |ctx|'s internal session cache. */
1511OPENSSL_EXPORT LHASH_OF(SSL_SESSION) *SSL_CTX_sessions(SSL_CTX *ctx);
1512
1513/* SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal
1514 * session cache. */
1515OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx);
1516
1517/* SSL_CTX_add_session inserts |session| into |ctx|'s internal session cache. It
1518 * returns one on success and zero on error or if |ctx| already included a
1519 * session with that session ID. The caller retains its reference to
1520 * |session|. */
1521OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *session);
1522
1523/* SSL_CTX_remove_session removes |session| from |ctx|'s internal session cache.
1524 * It returns one on success and zero on error or if no session with a matching
1525 * ID was found. */
1526OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *session);
1527
1528/* SSL_CTX_flush_sessions removes all sessions from |ctx| which have expired as
1529 * of time |time|. If |time| is zero, all sessions are removed. */
1530OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, long time);
1531
1532/* SSL_CTX_sess_set_new_cb sets the callback to be called when a new session is
1533 * established and ready to be cached. If the session cache is disabled (the
1534 * appropriate one of |SSL_SESS_CACHE_CLIENT| or |SSL_SESS_CACHE_SERVER| is
1535 * unset), the callback is not called.
1536 *
1537 * The callback is passed a reference to |session|. It returns one if it takes
1538 * ownership and zero otherwise.
1539 *
1540 * Note: For a client, the callback may be called on abbreviated handshakes if a
1541 * ticket is renewed. Further, it may not be called until some time after
1542 * |SSL_do_handshake| or |SSL_connect| completes if False Start is enabled. Thus
1543 * it's recommended to use this callback over checking |SSL_session_reused| on
1544 * handshake completion.
1545 *
1546 * TODO(davidben): Conditioning callbacks on |SSL_SESS_CACHE_CLIENT| or
1547 * |SSL_SESS_CACHE_SERVER| doesn't make any sense when one could just as easily
1548 * not supply the callbacks. Removing that condition and the client internal
1549 * cache would simplify things. */
1550OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb(
1551 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *session));
1552
1553/* SSL_CTX_sess_get_new_cb returns the callback set by
1554 * |SSL_CTX_sess_set_new_cb|. */
1555OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(
1556 SSL *ssl, SSL_SESSION *session);
1557
1558/* SSL_CTX_sess_set_remove_cb sets a callback which is called when a session is
1559 * removed from the internal session cache.
1560 *
1561 * TODO(davidben): What is the point of this callback? It seems useless since it
1562 * only fires on sessions in the internal cache. */
1563OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb(
1564 SSL_CTX *ctx,
1565 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *session));
1566
1567/* SSL_CTX_sess_get_remove_cb returns the callback set by
1568 * |SSL_CTX_sess_set_remove_cb|. */
1569OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(
1570 SSL_CTX *ctx, SSL_SESSION *session);
1571
1572/* SSL_CTX_sess_set_get_cb sets a callback to look up a session by ID for a
1573 * server. The callback is passed the session ID and should return a matching
1574 * |SSL_SESSION| or NULL if not found. It should set |*out_copy| to zero and
1575 * return a new reference to the session. This callback is not used for a
1576 * client.
1577 *
1578 * For historical reasons, if |*out_copy| is set to one (default), the SSL
1579 * library will take a new reference to the returned |SSL_SESSION|, expecting
1580 * the callback to return a non-owning pointer. This is not recommended. If
1581 * |ctx| and thus the callback is used on multiple threads, the session may be
1582 * removed and invalidated before the SSL library calls |SSL_SESSION_up_ref|,
1583 * whereas the callback may synchronize internally.
1584 *
1585 * To look up a session asynchronously, the callback may return
1586 * |SSL_magic_pending_session_ptr|. See the documentation for that function and
1587 * |SSL_ERROR_PENDING_SESSION|.
1588 *
1589 * If the internal session cache is enabled, the callback is only consulted if
David Benjaminb735b1b2015-10-07 09:36:23 -04001590 * the internal cache does not return a match.
1591 *
1592 * The callback's |id| parameter is not const for historical reasons, but the
1593 * contents may not be modified. */
David Benjamindafbdd42015-09-14 01:40:10 -04001594OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb(
1595 SSL_CTX *ctx,
1596 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *id, int id_len,
1597 int *out_copy));
1598
1599/* SSL_CTX_sess_get_get_cb returns the callback set by
1600 * |SSL_CTX_sess_set_get_cb|. */
1601OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(
1602 SSL *ssl, uint8_t *id, int id_len, int *out_copy);
1603
1604/* SSL_magic_pending_session_ptr returns a magic |SSL_SESSION|* which indicates
1605 * that the session isn't currently unavailable. |SSL_get_error| will then
1606 * return |SSL_ERROR_PENDING_SESSION| and the handshake can be retried later
1607 * when the lookup has completed. */
1608OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void);
1609
1610/* GEN_SESSION_CB is a callback to generate session IDs for |ssl|. It returns
1611 * one on success and zero on error. On success, the generated ID is written to
1612 * |id| and |*id_len| set to the length. On entry, |*id_len| is the maximum
1613 * length of the ID, but the callback may shorten it if desired. It is an error
1614 * for the callback to set the size to zero.
1615 *
1616 * Callbacks may use |SSL_has_matching_session_id| to check that the generated
1617 * ID is unique. */
1618typedef int (*GEN_SESSION_CB)(const SSL *ssl, uint8_t *id, unsigned *id_len);
1619
1620/* SSL_CTX_set_generate_session_id sets the session ID callback of |ctx| to
1621 * |cb| and returns one. It will be called on the server when establishing a new
1622 * session. */
1623OPENSSL_EXPORT int SSL_CTX_set_generate_session_id(SSL_CTX *ctx,
1624 GEN_SESSION_CB cb);
1625
1626/* SSL_set_generate_session_id sets the session ID callback of |ssl| to |cb| and
1627 * returns one. It will be called on the server when establishing a new
1628 * session. */
1629OPENSSL_EXPORT int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB cb);
1630
1631/* SSL_has_matching_session_id returns one if |ssl|'s session cache has a
1632 * session of value |id| and zero otherwise. */
1633OPENSSL_EXPORT int SSL_has_matching_session_id(const SSL *ssl,
1634 const uint8_t *id,
1635 unsigned id_len);
1636
1637
1638/* Session tickets.
1639 *
1640 * Session tickets, from RFC 5077, allow session resumption without server-side
1641 * state. Session tickets are supported in by default but may be disabled with
1642 * |SSL_OP_NO_TICKET|.
1643 *
1644 * On the client, ticket-based sessions use the same APIs as ID-based tickets.
1645 * Callers do not need to handle them differently.
1646 *
1647 * On the server, tickets are encrypted and authenticated with a secret key. By
1648 * default, an |SSL_CTX| generates a key on creation. Tickets are minted and
1649 * processed transparently. The following functions may be used to configure a
1650 * persistent key or implement more custom behavior. */
David Benjamindaeafc22015-06-25 17:35:11 -04001651
1652/* SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to
1653 * |len| bytes of |out|. It returns one on success and zero if |len| is not
1654 * 48. If |out| is NULL, it returns 48 instead. */
1655OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out,
1656 size_t len);
1657
1658/* SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to
1659 * |len| bytes of |in|. It returns one on success and zero if |len| is not
1660 * 48. If |in| is NULL, it returns 48 instead. */
1661OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in,
1662 size_t len);
1663
David Benjamine3aa1d92015-06-16 15:34:50 -04001664/* SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session
1665 * ticket. */
1666#define SSL_TICKET_KEY_NAME_LEN 16
1667
David Benjamindaeafc22015-06-25 17:35:11 -04001668/* SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and
1669 * returns one. |callback| will be called when encrypting a new ticket and when
1670 * decrypting a ticket from the client.
1671 *
1672 * In both modes, |ctx| and |hmac_ctx| will already have been initialized with
1673 * |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback|
1674 * configures |hmac_ctx| with an HMAC digest and key, and configures |ctx|
1675 * for encryption or decryption, based on the mode.
1676 *
1677 * When encrypting a new ticket, |encrypt| will be one. It writes a public
1678 * 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length
1679 * must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1680 * |callback| returns 1 on success and -1 on error.
1681 *
1682 * When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a
1683 * 16-byte key name and |iv| points to an IV. The length of the IV consumed must
1684 * match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode,
1685 * |callback| returns -1 to abort the handshake, 0 if decrypting the ticket
1686 * failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed.
1687 * This may be used to re-key the ticket.
1688 *
1689 * WARNING: |callback| wildly breaks the usual return value convention and is
1690 * called in two different modes. */
1691OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb(
1692 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv,
1693 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx,
1694 int encrypt));
1695
1696
David Benjamin58fcfc12015-09-15 23:49:00 -04001697/* Elliptic curve Diffie-Hellman.
1698 *
1699 * Cipher suites using an ECDHE key exchange perform Diffie-Hellman over an
1700 * elliptic curve negotiated by both endpoints. See RFC 4492. Only named curves
1701 * are supported. ECDHE is always enabled, but the curve preferences may be
1702 * configured with these functions.
1703 *
1704 * A client may use |SSL_SESSION_get_key_exchange_info| to determine the curve
1705 * selected. */
1706
1707/* SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each
1708 * element of |curves| should be a curve nid. It returns one on success and
1709 * zero on failure. */
1710OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves,
1711 size_t curves_len);
1712
1713/* SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each
1714 * element of |curves| should be a curve nid. It returns one on success and
1715 * zero on failure. */
1716OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves,
1717 size_t curves_len);
1718
1719/* SSL_CTX_set_tmp_ecdh configures |ctx| to use the curve from |ecdh| as the
1720 * curve for ephemeral ECDH keys. For historical reasons, this API expects an
1721 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1722 * error. If unset, an appropriate curve will be chosen based on curve
1723 * preferences. (This is recommended.) */
1724OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key);
1725
1726/* SSL_set_tmp_ecdh configures |ssl| to use the curve from |ecdh| as the curve
1727 * for ephemeral ECDH keys. For historical reasons, this API expects an
1728 * |EC_KEY|, but only the curve is used. It returns one on success and zero on
1729 * error. If unset, an appropriate curve will be chosen based on curve
1730 * preferences. (This is recommended.) */
1731OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key);
1732
1733/* SSL_CTX_set_tmp_ecdh_callback configures |ctx| to use |callback| to determine
1734 * the curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
1735 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
1736 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
1737 * keypair.
1738 *
1739 * If the callback is unset, an appropriate curve will be chosen based on curve
1740 * preferences. (This is recommended.)
1741 *
1742 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
1743 * |callback| must save and release the object elsewhere. */
1744OPENSSL_EXPORT void SSL_CTX_set_tmp_ecdh_callback(
1745 SSL_CTX *ctx, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
1746
1747/* SSL_set_tmp_ecdh_callback configures |ssl| to use |callback| to determine the
1748 * curve for ephemeral ECDH keys. |callback| should ignore |is_export| and
1749 * |keylength| and return an |EC_KEY| of the selected curve or NULL on
1750 * error. Only the curve is used, so the |EC_KEY| needn't have a generated
1751 * keypair.
1752 *
1753 * If the callback is unset, an appropriate curve will be chosen based on curve
1754 * preferences. (This is recommended.)
1755 *
1756 * WARNING: The caller does not take ownership of the resulting |EC_KEY|, so
1757 * |callback| must save and release the object elsewhere. */
1758OPENSSL_EXPORT void SSL_set_tmp_ecdh_callback(
1759 SSL *ssl, EC_KEY *(*callback)(SSL *ssl, int is_export, int keylength));
1760
1761/* SSL_get_curve_name returns a human-readable name for the elliptic curve
1762 * specified by the given TLS curve id, or NULL if the curve if unknown. */
David Benjamin59937042015-09-19 13:04:22 -04001763OPENSSL_EXPORT const char *SSL_get_curve_name(uint16_t curve_id);
David Benjamin58fcfc12015-09-15 23:49:00 -04001764
1765
1766/* Multiplicative Diffie-Hellman.
1767 *
1768 * Cipher suites using a DHE key exchange perform Diffie-Hellman over a
1769 * multiplicative group selected by the server. These ciphers are disabled for a
1770 * server unless a group is chosen with one of these functions.
1771 *
1772 * A client may use |SSL_SESSION_get_key_exchange_info| to determine the size of
1773 * the selected group's prime, but note that servers may select degenerate
1774 * groups. */
1775
1776/* SSL_CTX_set_tmp_dh configures |ctx| to use the group from |dh| as the group
1777 * for DHE. Only the group is used, so |dh| needn't have a keypair. It returns
1778 * one on success and zero on error. */
1779OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh);
1780
1781/* SSL_set_tmp_dh configures |ssl| to use the group from |dh| as the group for
1782 * DHE. Only the group is used, so |dh| needn't have a keypair. It returns one
1783 * on success and zero on error. */
1784OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh);
1785
1786/* SSL_CTX_set_tmp_dh_callback configures |ctx| to use |callback| to determine
1787 * the group for DHE ciphers. |callback| should ignore |is_export| and
1788 * |keylength| and return a |DH| of the selected group or NULL on error. Only
1789 * the parameters are used, so the |DH| needn't have a generated keypair.
1790 *
1791 * WARNING: The caller does not take ownership of the resulting |DH|, so
1792 * |callback| must save and release the object elsewhere. */
1793OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback(
1794 SSL_CTX *ctx, DH *(*callback)(SSL *ssl, int is_export, int keylength));
1795
1796/* SSL_set_tmp_dh_callback configures |ssl| to use |callback| to determine the
1797 * group for DHE ciphers. |callback| should ignore |is_export| and |keylength|
1798 * and return a |DH| of the selected group or NULL on error. Only the
1799 * parameters are used, so the |DH| needn't have a generated keypair.
1800 *
1801 * WARNING: The caller does not take ownership of the resulting |DH|, so
1802 * |callback| must save and release the object elsewhere. */
1803OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl,
1804 DH *(*dh)(SSL *ssl, int is_export,
1805 int keylength));
1806
1807
David Benjamin59937042015-09-19 13:04:22 -04001808/* Certificate verification.
1809 *
1810 * SSL may authenticate either endpoint with an X.509 certificate. Typically
1811 * this is used to authenticate the server to the client. These functions
1812 * configure certificate verification.
1813 *
1814 * WARNING: By default, certificate verification errors on a client are not
1815 * fatal. See |SSL_VERIFY_NONE| This may be configured with
1816 * |SSL_CTX_set_verify|.
1817 *
1818 * By default clients are anonymous but a server may request a certificate from
1819 * the client by setting |SSL_VERIFY_PEER|.
1820 *
1821 * Many of these functions use OpenSSL's legacy X.509 stack which is
1822 * underdocumented and deprecated, but the replacement isn't ready yet. For
1823 * now, consumers may use the existing stack or bypass it by performing
1824 * certificate verification externally. This may be done with
1825 * |SSL_CTX_set_cert_verify_callback| or by extracting the chain with
1826 * |SSL_get_peer_cert_chain| after the handshake. In the future, functions will
David Benjamind3a53c82015-09-20 00:00:28 -04001827 * be added to use the SSL stack without dependency on any part of the legacy
1828 * X.509 and ASN.1 stack.
1829 *
1830 * To augment certificate verification, a client may also enable OCSP stapling
1831 * (RFC 6066) and Certificate Transparency (RFC 6962) extensions. */
David Benjamin59937042015-09-19 13:04:22 -04001832
1833/* SSL_VERIFY_NONE, on a client, verifies the server certificate but does not
1834 * make errors fatal. The result may be checked with |SSL_get_verify_result|. On
1835 * a server it does not request a client certificate. This is the default. */
1836#define SSL_VERIFY_NONE 0x00
1837
1838/* SSL_VERIFY_PEER, on a client, makes server certificate errors fatal. On a
1839 * server it requests a client certificate and makes errors fatal. However,
1840 * anonymous clients are still allowed. See
1841 * |SSL_VERIFY_FAIL_IF_NO_PEER_CERT|. */
1842#define SSL_VERIFY_PEER 0x01
1843
1844/* SSL_VERIFY_FAIL_IF_NO_PEER_CERT configures a server to reject connections if
1845 * the client declines to send a certificate. Otherwise |SSL_VERIFY_PEER| still
1846 * allows anonymous clients. */
1847#define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02
1848
1849/* SSL_VERIFY_PEER_IF_NO_OBC configures a server to request a client certificate
1850 * if and only if Channel ID is not negotiated. */
1851#define SSL_VERIFY_PEER_IF_NO_OBC 0x04
1852
1853/* SSL_CTX_set_verify configures certificate verification behavior. |mode| is
1854 * one of the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is
1855 * used to customize certificate verification. See the behavior of
1856 * |X509_STORE_CTX_set_verify_cb|.
1857 *
1858 * The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with
1859 * |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. */
1860OPENSSL_EXPORT void SSL_CTX_set_verify(
1861 SSL_CTX *ctx, int mode, int (*callback)(int ok, X509_STORE_CTX *store_ctx));
1862
1863/* SSL_set_verify configures certificate verification behavior. |mode| is one of
1864 * the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is used to
1865 * customize certificate verification. See the behavior of
1866 * |X509_STORE_CTX_set_verify_cb|.
1867 *
1868 * The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with
1869 * |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. */
1870OPENSSL_EXPORT void SSL_set_verify(SSL *ssl, int mode,
1871 int (*callback)(int ok,
1872 X509_STORE_CTX *store_ctx));
1873
1874/* SSL_CTX_get_verify_mode returns |ctx|'s verify mode, set by
1875 * |SSL_CTX_set_verify|. */
1876OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx);
1877
1878/* SSL_get_verify_mode returns |ssl|'s verify mode, set by |SSL_CTX_set_verify|
1879 * or |SSL_set_verify|. */
1880OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *ssl);
1881
1882/* SSL_CTX_get_verify_callback returns the callback set by
1883 * |SSL_CTX_set_verify|. */
1884OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))(
1885 int ok, X509_STORE_CTX *store_ctx);
1886
1887/* SSL_get_verify_callback returns the callback set by |SSL_CTX_set_verify| or
1888 * |SSL_set_verify|. */
1889OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *ssl))(
1890 int ok, X509_STORE_CTX *store_ctx);
1891
1892/* SSL_CTX_set_verify_depth sets the maximum depth of a certificate chain
1893 * accepted in verification. This number does not include the leaf, so a depth
1894 * of 1 allows the leaf and one CA certificate. */
1895OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth);
1896
1897/* SSL_set_verify_depth sets the maximum depth of a certificate chain accepted
1898 * in verification. This number does not include the leaf, so a depth of 1
1899 * allows the leaf and one CA certificate. */
1900OPENSSL_EXPORT void SSL_set_verify_depth(SSL *ssl, int depth);
1901
1902/* SSL_CTX_get_verify_depth returns the maximum depth of a certificate accepted
1903 * in verification. */
1904OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx);
1905
1906/* SSL_get_verify_depth returns the maximum depth of a certificate accepted in
1907 * verification. */
1908OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *ssl);
1909
1910/* SSL_CTX_set1_param sets verification parameters from |param|. It returns one
1911 * on success and zero on failure. The caller retains ownership of |param|. */
1912OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx,
1913 const X509_VERIFY_PARAM *param);
1914
1915/* SSL_set1_param sets verification parameters from |param|. It returns one on
1916 * success and zero on failure. The caller retains ownership of |param|. */
1917OPENSSL_EXPORT int SSL_set1_param(SSL *ssl,
1918 const X509_VERIFY_PARAM *param);
1919
1920/* SSL_CTX_get0_param returns |ctx|'s |X509_VERIFY_PARAM| for certificate
1921 * verification. The caller must not release the returned pointer but may call
1922 * functions on it to configure it. */
1923OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx);
1924
1925/* SSL_get0_param returns |ssl|'s |X509_VERIFY_PARAM| for certificate
1926 * verification. The caller must not release the returned pointer but may call
1927 * functions on it to configure it. */
1928OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl);
1929
1930/* SSL_CTX_set_purpose sets |ctx|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to
1931 * |purpose|. It returns one on success and zero on error. */
1932OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *ctx, int purpose);
1933
1934/* SSL_set_purpose sets |ssl|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to
1935 * |purpose|. It returns one on success and zero on error. */
1936OPENSSL_EXPORT int SSL_set_purpose(SSL *ssl, int purpose);
1937
1938/* SSL_CTX_set_trust sets |ctx|'s |X509_VERIFY_PARAM|'s 'trust' parameter to
1939 * |trust|. It returns one on success and zero on error. */
1940OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *ctx, int trust);
1941
1942/* SSL_set_trust sets |ssl|'s |X509_VERIFY_PARAM|'s 'trust' parameter to
1943 * |trust|. It returns one on success and zero on error. */
1944OPENSSL_EXPORT int SSL_set_trust(SSL *ssl, int trust);
1945
1946/* SSL_CTX_set_cert_store sets |ctx|'s certificate store to |store|. It takes
1947 * ownership of |store|. The store is used for certificate verification.
1948 *
1949 * The store is also used for the auto-chaining feature, but this is deprecated.
1950 * See also |SSL_MODE_NO_AUTO_CHAIN|. */
1951OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store);
1952
1953/* SSL_CTX_get_cert_store returns |ctx|'s certificate store. */
1954OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx);
1955
1956/* SSL_CTX_set_default_verify_paths loads the OpenSSL system-default trust
1957 * anchors into |ctx|'s store. It returns one on success and zero on failure. */
1958OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx);
1959
1960/* SSL_CTX_load_verify_locations loads trust anchors into |ctx|'s store from
1961 * |ca_file| and |ca_dir|, either of which may be NULL. If |ca_file| is passed,
1962 * it is opened and PEM-encoded CA certificates are read. If |ca_dir| is passed,
1963 * it is treated as a directory in OpenSSL's hashed directory format. It returns
1964 * one on success and zero on failure.
1965 *
1966 * See
1967 * https://www.openssl.org/docs/manmaster/ssl/SSL_CTX_load_verify_locations.html
1968 * for documentation on the directory format. */
1969OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx,
1970 const char *ca_file,
1971 const char *ca_dir);
1972
1973/* SSL_get_verify_result returns the result of certificate verification. It is
1974 * either |X509_V_OK| or a |X509_V_ERR_*| value. */
1975OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl);
1976
1977/* SSL_set_verify_result overrides the result of certificate verification. */
1978OPENSSL_EXPORT void SSL_set_verify_result(SSL *ssl, long result);
1979
1980/* SSL_get_ex_data_X509_STORE_CTX_idx returns the ex_data index used to look up
1981 * the |SSL| associated with an |X509_STORE_CTX| in the verify callback. */
1982OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void);
1983
1984/* SSL_CTX_set_cert_verify_callback sets a custom callback to be called on
1985 * certificate verification rather than |X509_verify_cert|. |store_ctx| contains
1986 * the verification parameters. The callback should return one on success and
1987 * zero on fatal error. It may use |X509_STORE_CTX_set_error| to set a
1988 * verification result.
1989 *
1990 * The callback may use either the |arg| parameter or
1991 * |SSL_get_ex_data_X509_STORE_CTX_idx| to recover the associated |SSL|
1992 * object. */
1993OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback(
1994 SSL_CTX *ctx, int (*callback)(X509_STORE_CTX *store_ctx, void *arg),
1995 void *arg);
1996
David Benjamind3a53c82015-09-20 00:00:28 -04001997/* SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end
1998 * of a connection) to request SCTs from the server. See
David Benjaminf88b81a2015-10-05 20:14:37 -04001999 * https://tools.ietf.org/html/rfc6962. It returns one.
2000 *
2001 * Call |SSL_get0_signed_cert_timestamp_list| to recover the SCT after the
2002 * handshake. */
David Benjamind3a53c82015-09-20 00:00:28 -04002003OPENSSL_EXPORT int SSL_enable_signed_cert_timestamps(SSL *ssl);
2004
2005/* SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL
David Benjaminf88b81a2015-10-05 20:14:37 -04002006 * objects created from |ctx|.
David Benjamind3a53c82015-09-20 00:00:28 -04002007 *
David Benjaminf88b81a2015-10-05 20:14:37 -04002008 * Call |SSL_get0_signed_cert_timestamp_list| to recover the SCT after the
2009 * handshake. */
2010OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx);
David Benjamind3a53c82015-09-20 00:00:28 -04002011
2012/* SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a
2013 * connection) to request a stapled OCSP response from the server. It returns
David Benjaminf88b81a2015-10-05 20:14:37 -04002014 * one.
2015 *
2016 * Call |SSL_get0_ocsp_response| to recover the OCSP response after the
2017 * handshake. */
David Benjamind3a53c82015-09-20 00:00:28 -04002018OPENSSL_EXPORT int SSL_enable_ocsp_stapling(SSL *ssl);
2019
2020/* SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects
David Benjaminf88b81a2015-10-05 20:14:37 -04002021 * created from |ctx|.
David Benjamind3a53c82015-09-20 00:00:28 -04002022 *
David Benjaminf88b81a2015-10-05 20:14:37 -04002023 * Call |SSL_get0_ocsp_response| to recover the OCSP response after the
2024 * handshake. */
2025OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx);
David Benjamind3a53c82015-09-20 00:00:28 -04002026
David Benjamin59937042015-09-19 13:04:22 -04002027
2028/* Client certificate CA list.
2029 *
2030 * When requesting a client certificate, a server may advertise a list of
2031 * certificate authorities which are accepted. These functions may be used to
2032 * configure this list. */
2033
2034/* SSL_set_client_CA_list sets |ssl|'s client certificate CA list to
2035 * |name_list|. It takes ownership of |name_list|. */
2036OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *ssl,
2037 STACK_OF(X509_NAME) *name_list);
2038
2039/* SSL_CTX_set_client_CA_list sets |ctx|'s client certificate CA list to
2040 * |name_list|. It takes ownership of |name_list|. */
2041OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx,
2042 STACK_OF(X509_NAME) *name_list);
2043
David Benjaminfd8e69f2015-10-03 10:49:20 -04002044/* SSL_get_client_CA_list returns |ssl|'s client certificate CA list. If |ssl|
2045 * has not been configured as a client, this is the list configured by
2046 * |SSL_CTX_set_client_CA_list|.
2047 *
2048 * If configured as a client, it returns the client certificate CA list sent by
2049 * the server. In this mode, the behavior is undefined except during the
2050 * callbacks set by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or
2051 * when the handshake is paused because of them. */
David Benjamin59937042015-09-19 13:04:22 -04002052OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *ssl);
2053
2054/* SSL_CTX_get_client_CA_list returns |ctx|'s client certificate CA list. */
2055OPENSSL_EXPORT STACK_OF(X509_NAME) *
2056 SSL_CTX_get_client_CA_list(const SSL_CTX *ctx);
2057
2058/* SSL_add_client_CA appends |x509|'s subject to the client certificate CA list.
2059 * It returns one on success or zero on error. The caller retains ownership of
2060 * |x509|. */
2061OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x509);
2062
2063/* SSL_CTX_add_client_CA appends |x509|'s subject to the client certificate CA
2064 * list. It returns one on success or zero on error. The caller retains
2065 * ownership of |x509|. */
2066OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x509);
2067
2068/* SSL_load_client_CA_file opens |file| and reads PEM-encoded certificates from
2069 * it. It returns a newly-allocated stack of the certificate subjects or NULL
2070 * on error. */
2071OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file);
2072
2073/* SSL_dup_CA_list makes a deep copy of |list|. It returns the new list on
2074 * success or NULL on allocation error. */
2075OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *list);
2076
2077/* SSL_add_file_cert_subjects_to_stack behaves like |SSL_load_client_CA_file|
2078 * but appends the result to |out|. It returns one on success or zero on
2079 * error. */
2080OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *out,
2081 const char *file);
2082
2083/* SSL_add_dir_cert_subjects_to_stack lists files in directory |dir|. It calls
2084 * |SSL_add_file_cert_subjects_to_stack| on each file and returns one on success
2085 * or zero on error. */
2086OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *out,
2087 const char *dir);
2088
2089
David Benjamin07e13842015-10-17 13:48:04 -04002090/* Server name indication.
2091 *
2092 * The server_name extension (RFC 3546) allows the client to advertise the name
2093 * of the server it is connecting to. This is used in virtual hosting
2094 * deployments to select one of a several certificates on a single IP. Only the
2095 * host_name name type is supported. */
2096
2097#define TLSEXT_NAMETYPE_host_name 0
2098
2099/* SSL_set_tlsext_host_name, for a client, configures |ssl| to advertise |name|
2100 * in the server_name extension. It returns one on success and zero on error. */
2101OPENSSL_EXPORT int SSL_set_tlsext_host_name(SSL *ssl, const char *name);
2102
2103/* SSL_get_servername, for a server, returns the hostname supplied by the
2104 * client or NULL if there was none. The |type| argument must be
2105 * |TLSEXT_NAMETYPE_host_name|. */
2106OPENSSL_EXPORT const char *SSL_get_servername(const SSL *ssl, const int type);
2107
2108/* SSL_get_servername_type, for a server, returns |TLSEXT_NAMETYPE_host_name|
2109 * if the client sent a hostname and -1 otherwise. */
2110OPENSSL_EXPORT int SSL_get_servername_type(const SSL *ssl);
2111
2112/* SSL_CTX_set_tlsext_servername_callback configures |callback| to be called on
2113 * the server after ClientHello extensions have been parsed and returns one.
2114 * The callback may use |SSL_get_servername| to examine the server_name extension
2115 * and returns a |SSL_TLSEXT_ERR_*| value. The value of |arg| may be set by
2116 * calling |SSL_CTX_set_tlsext_servername_arg|.
2117 *
2118 * If the callback returns |SSL_TLSEXT_ERR_NOACK|, the server_name extension is
2119 * not acknowledged in the ServerHello. If the return value is
2120 * |SSL_TLSEXT_ERR_ALERT_FATAL| or |SSL_TLSEXT_ERR_ALERT_WARNING| then
2121 * |*out_alert| must be set to the alert value to send. */
2122OPENSSL_EXPORT int SSL_CTX_set_tlsext_servername_callback(
2123 SSL_CTX *ctx, int (*callback)(SSL *ssl, int *out_alert, void *arg));
2124
2125/* SSL_CTX_set_tlsext_servername_arg sets the argument to the servername
2126 * callback and returns one. See |SSL_CTX_set_tlsext_servername_callback|. */
2127OPENSSL_EXPORT int SSL_CTX_set_tlsext_servername_arg(SSL_CTX *ctx, void *arg);
2128
2129/* SSL_TLSEXT_ERR_* are values returned by some extension-related callbacks. */
2130#define SSL_TLSEXT_ERR_OK 0
2131#define SSL_TLSEXT_ERR_ALERT_WARNING 1
2132#define SSL_TLSEXT_ERR_ALERT_FATAL 2
2133#define SSL_TLSEXT_ERR_NOACK 3
2134
2135
David Benjamin8984f1f2015-09-16 00:10:19 -04002136/* Application-layer protocol negotation.
2137 *
2138 * The ALPN extension (RFC 7301) allows negotiating different application-layer
2139 * protocols over a single port. This is used, for example, to negotiate
2140 * HTTP/2. */
2141
2142/* SSL_CTX_set_alpn_protos sets the client ALPN protocol list on |ctx| to
2143 * |protos|. |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2144 * length-prefixed strings). It returns zero on success and one on failure.
2145 * Configuring this list enables ALPN on a client.
2146 *
2147 * WARNING: this function is dangerous because it breaks the usual return value
2148 * convention. */
2149OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos,
2150 unsigned protos_len);
2151
2152/* SSL_set_alpn_protos sets the client ALPN protocol list on |ssl| to |protos|.
2153 * |protos| must be in wire-format (i.e. a series of non-empty, 8-bit
2154 * length-prefixed strings). It returns zero on success and one on failure.
2155 * Configuring this list enables ALPN on a client.
2156 *
2157 * WARNING: this function is dangerous because it breaks the usual return value
2158 * convention. */
2159OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos,
2160 unsigned protos_len);
2161
2162/* SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is called
2163 * during ClientHello processing in order to select an ALPN protocol from the
2164 * client's list of offered protocols. Configuring this callback enables ALPN on
2165 * a server.
2166 *
2167 * The callback is passed a wire-format (i.e. a series of non-empty, 8-bit
2168 * length-prefixed strings) ALPN protocol list in |in|. It should set |*out| and
2169 * |*out_len| to the selected protocol and return |SSL_TLSEXT_ERR_OK| on
2170 * success. It does not pass ownership of the buffer. Otherwise, it should
2171 * return |SSL_TLSEXT_ERR_NOACK|. Other |SSL_TLSEXT_ERR_*| values are
2172 * unimplemented and will be treated as |SSL_TLSEXT_ERR_NOACK|. */
2173OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb(
2174 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *out_len,
2175 const uint8_t *in, unsigned in_len, void *arg),
2176 void *arg);
2177
2178/* SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|.
2179 * On return it sets |*out_data| to point to |*out_len| bytes of protocol name
2180 * (not including the leading length-prefix byte). If the server didn't respond
2181 * with a negotiated protocol then |*out_len| will be zero. */
2182OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl,
2183 const uint8_t **out_data,
2184 unsigned *out_len);
2185
2186
David Benjamin977547b2015-09-16 00:25:52 -04002187/* Next protocol negotiation.
2188 *
2189 * The NPN extension (draft-agl-tls-nextprotoneg-03) is the predecessor to ALPN
2190 * and deprecated in favor of it. */
2191
2192/* SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when a
2193 * TLS server needs a list of supported protocols for Next Protocol
2194 * Negotiation. The returned list must be in wire format. The list is returned
2195 * by setting |*out| to point to it and |*out_len| to its length. This memory
2196 * will not be modified, but one should assume that |ssl| keeps a reference to
2197 * it.
2198 *
2199 * The callback should return |SSL_TLSEXT_ERR_OK| if it wishes to advertise.
2200 * Otherwise, no such extension will be included in the ServerHello. */
2201OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb(
2202 SSL_CTX *ctx,
2203 int (*cb)(SSL *ssl, const uint8_t **out, unsigned *out_len, void *arg),
2204 void *arg);
2205
2206/* SSL_CTX_set_next_proto_select_cb sets a callback that is called when a client
2207 * needs to select a protocol from the server's provided list. |*out| must be
2208 * set to point to the selected protocol (which may be within |in|). The length
2209 * of the protocol name must be written into |*out_len|. The server's advertised
2210 * protocols are provided in |in| and |in_len|. The callback can assume that
2211 * |in| is syntactically valid.
2212 *
2213 * The client must select a protocol. It is fatal to the connection if this
2214 * callback returns a value other than |SSL_TLSEXT_ERR_OK|.
2215 *
2216 * Configuring this callback enables NPN on a client. */
2217OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb(
2218 SSL_CTX *ctx, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *out_len,
2219 const uint8_t *in, unsigned in_len, void *arg),
2220 void *arg);
2221
2222/* SSL_get0_next_proto_negotiated sets |*out_data| and |*out_len| to point to
2223 * the client's requested protocol for this connection. If the client didn't
2224 * request any protocol, then |*out_data| is set to NULL.
2225 *
2226 * Note that the client can request any protocol it chooses. The value returned
2227 * from this function need not be a member of the list of supported protocols
2228 * provided by the server. */
2229OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *ssl,
2230 const uint8_t **out_data,
2231 unsigned *out_len);
2232
2233/* SSL_select_next_proto implements the standard protocol selection. It is
2234 * expected that this function is called from the callback set by
2235 * |SSL_CTX_set_next_proto_select_cb|.
2236 *
2237 * The protocol data is assumed to be a vector of 8-bit, length prefixed byte
2238 * strings. The length byte itself is not included in the length. A byte
2239 * string of length 0 is invalid. No byte string may be truncated.
2240 *
2241 * The current, but experimental algorithm for selecting the protocol is:
2242 *
2243 * 1) If the server doesn't support NPN then this is indicated to the
2244 * callback. In this case, the client application has to abort the connection
2245 * or have a default application level protocol.
2246 *
2247 * 2) If the server supports NPN, but advertises an empty list then the
2248 * client selects the first protcol in its list, but indicates via the
2249 * API that this fallback case was enacted.
2250 *
2251 * 3) Otherwise, the client finds the first protocol in the server's list
2252 * that it supports and selects this protocol. This is because it's
2253 * assumed that the server has better information about which protocol
2254 * a client should use.
2255 *
2256 * 4) If the client doesn't support any of the server's advertised
2257 * protocols, then this is treated the same as case 2.
2258 *
2259 * It returns either |OPENSSL_NPN_NEGOTIATED| if a common protocol was found, or
2260 * |OPENSSL_NPN_NO_OVERLAP| if the fallback case was reached. */
2261OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *out_len,
2262 const uint8_t *server,
2263 unsigned server_len,
2264 const uint8_t *client,
2265 unsigned client_len);
2266
2267#define OPENSSL_NPN_UNSUPPORTED 0
2268#define OPENSSL_NPN_NEGOTIATED 1
2269#define OPENSSL_NPN_NO_OVERLAP 2
2270
2271
David Benjamin42fea372015-09-19 01:22:44 -04002272/* Channel ID.
2273 *
2274 * See draft-balfanz-tls-channelid-01. */
2275
2276/* SSL_CTX_enable_tls_channel_id either configures a TLS server to accept TLS
2277 * Channel IDs from clients, or configures a client to send TLS Channel IDs to
2278 * a server. It returns one. */
2279OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx);
2280
2281/* SSL_enable_tls_channel_id either configures a TLS server to accept TLS
2282 * Channel IDs from clients, or configures a client to send TLS Channel IDs to
2283 * server. It returns one. */
2284OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl);
2285
2286/* SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID
2287 * to compatible servers. |private_key| must be a P-256 EC key. It returns one
2288 * on success and zero on error. */
2289OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx,
2290 EVP_PKEY *private_key);
2291
2292/* SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to
2293 * compatible servers. |private_key| must be a P-256 EC key. It returns one on
2294 * success and zero on error. */
2295OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key);
2296
2297/* SSL_get_tls_channel_id gets the client's TLS Channel ID from a server |SSL*|
2298 * and copies up to the first |max_out| bytes into |out|. The Channel ID
2299 * consists of the client's P-256 public key as an (x,y) pair where each is a
2300 * 32-byte, big-endian field element. It returns 0 if the client didn't offer a
2301 * Channel ID and the length of the complete Channel ID otherwise. */
2302OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out,
2303 size_t max_out);
2304
2305/* SSL_CTX_set_channel_id_cb sets a callback to be called when a TLS Channel ID
2306 * is requested. The callback may set |*out_pkey| to a key, passing a reference
2307 * to the caller. If none is returned, the handshake will pause and
2308 * |SSL_get_error| will return |SSL_ERROR_WANT_CHANNEL_ID_LOOKUP|.
2309 *
2310 * See also |SSL_ERROR_WANT_CHANNEL_ID_LOOKUP|. */
2311OPENSSL_EXPORT void SSL_CTX_set_channel_id_cb(
2312 SSL_CTX *ctx, void (*channel_id_cb)(SSL *ssl, EVP_PKEY **out_pkey));
2313
2314/* SSL_CTX_get_channel_id_cb returns the callback set by
2315 * |SSL_CTX_set_channel_id_cb|. */
2316OPENSSL_EXPORT void (*SSL_CTX_get_channel_id_cb(SSL_CTX *ctx))(
2317 SSL *ssl, EVP_PKEY **out_pkey);
2318
2319
David Benjamincfd65b62015-09-14 01:54:44 -04002320/* DTLS-SRTP.
2321 *
2322 * See RFC 5764. */
2323
2324/* An SRTP_PROTECTION_PROFILE is an SRTP profile for use with the use_srtp
2325 * extension. */
2326struct srtp_protection_profile_st {
2327 const char *name;
2328 unsigned long id;
2329} /* SRTP_PROTECTION_PROFILE */;
2330
2331DECLARE_STACK_OF(SRTP_PROTECTION_PROFILE)
2332
2333/* SRTP_* define constants for SRTP profiles. */
2334#define SRTP_AES128_CM_SHA1_80 0x0001
2335#define SRTP_AES128_CM_SHA1_32 0x0002
2336#define SRTP_AES128_F8_SHA1_80 0x0003
2337#define SRTP_AES128_F8_SHA1_32 0x0004
2338#define SRTP_NULL_SHA1_80 0x0005
2339#define SRTP_NULL_SHA1_32 0x0006
2340
2341/* SSL_CTX_set_srtp_profiles enables SRTP for all SSL objects created from
2342 * |ctx|. |profile| contains a colon-separated list of profile names. It returns
2343 * one on success and zero on failure. */
2344OPENSSL_EXPORT int SSL_CTX_set_srtp_profiles(SSL_CTX *ctx,
2345 const char *profiles);
2346
2347/* SSL_set_srtp_profiles enables SRTP for |ssl|. |profile| contains a
2348 * colon-separated list of profile names. It returns one on success and zero on
2349 * failure. */
2350OPENSSL_EXPORT int SSL_set_srtp_profiles(SSL *ssl, const char *profiles);
2351
2352/* SSL_get_srtp_profiles returns the SRTP profiles supported by |ssl|. */
2353OPENSSL_EXPORT STACK_OF(SRTP_PROTECTION_PROFILE) *SSL_get_srtp_profiles(
2354 SSL *ssl);
2355
2356/* SSL_get_selected_srtp_profile returns the selected SRTP profile, or NULL if
2357 * SRTP was not negotiated. */
2358OPENSSL_EXPORT const SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile(
2359 SSL *ssl);
2360
2361
David Benjamine8814df2015-09-15 08:05:54 -04002362/* Pre-shared keys.
2363 *
2364 * Connections may be configured with PSK (Pre-Shared Key) cipher suites. These
2365 * authenticate using out-of-band pre-shared keys rather than certificates. See
2366 * RFC 4279.
2367 *
2368 * This implementation uses NUL-terminated C strings for identities and identity
2369 * hints, so values with a NUL character are not supported. (RFC 4279 does not
2370 * specify the format of an identity.) */
2371
2372/* PSK_MAX_IDENTITY_LEN is the maximum supported length of a PSK identity,
2373 * excluding the NUL terminator. */
2374#define PSK_MAX_IDENTITY_LEN 128
2375
2376/* PSK_MAX_PSK_LEN is the maximum supported length of a pre-shared key. */
2377#define PSK_MAX_PSK_LEN 256
2378
2379/* SSL_CTX_set_psk_client_callback sets the callback to be called when PSK is
2380 * negotiated on the client. This callback must be set to enable PSK cipher
2381 * suites on the client.
2382 *
2383 * The callback is passed the identity hint in |hint| or NULL if none was
2384 * provided. It should select a PSK identity and write the identity and the
2385 * corresponding PSK to |identity| and |psk|, respectively. The identity is
2386 * written as a NUL-terminated C string of length (excluding the NUL terminator)
2387 * at most |max_identity_len|. The PSK's length must be at most |max_psk_len|.
2388 * The callback returns the length of the PSK or 0 if no suitable identity was
2389 * found. */
2390OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback(
2391 SSL_CTX *ctx,
2392 unsigned (*psk_client_callback)(
2393 SSL *ssl, const char *hint, char *identity,
2394 unsigned max_identity_len, uint8_t *psk, unsigned max_psk_len));
2395
2396/* SSL_set_psk_client_callback sets the callback to be called when PSK is
2397 * negotiated on the client. This callback must be set to enable PSK cipher
2398 * suites on the client. See also |SSL_CTX_set_psk_client_callback|. */
2399OPENSSL_EXPORT void SSL_set_psk_client_callback(
2400 SSL *ssl, unsigned (*psk_client_callback)(SSL *ssl, const char *hint,
2401 char *identity,
2402 unsigned max_identity_len,
2403 uint8_t *psk,
2404 unsigned max_psk_len));
2405
2406/* SSL_CTX_set_psk_server_callback sets the callback to be called when PSK is
2407 * negotiated on the server. This callback must be set to enable PSK cipher
2408 * suites on the server.
2409 *
2410 * The callback is passed the identity in |identity|. It should write a PSK of
2411 * length at most |max_psk_len| to |psk| and return the number of bytes written
2412 * or zero if the PSK identity is unknown. */
2413OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback(
2414 SSL_CTX *ctx,
2415 unsigned (*psk_server_callback)(SSL *ssl, const char *identity,
2416 uint8_t *psk,
2417 unsigned max_psk_len));
2418
2419/* SSL_set_psk_server_callback sets the callback to be called when PSK is
2420 * negotiated on the server. This callback must be set to enable PSK cipher
2421 * suites on the server. See also |SSL_CTX_set_psk_server_callback|. */
2422OPENSSL_EXPORT void SSL_set_psk_server_callback(
2423 SSL *ssl,
2424 unsigned (*psk_server_callback)(SSL *ssl, const char *identity,
2425 uint8_t *psk,
2426 unsigned max_psk_len));
2427
2428/* SSL_CTX_use_psk_identity_hint configures server connections to advertise an
2429 * identity hint of |identity_hint|. It returns one on success and zero on
2430 * error. */
2431OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx,
2432 const char *identity_hint);
2433
2434/* SSL_use_psk_identity_hint configures server connections to advertise an
2435 * identity hint of |identity_hint|. It returns one on success and zero on
2436 * error. */
2437OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *ssl,
2438 const char *identity_hint);
2439
2440/* SSL_get_psk_identity_hint returns the PSK identity hint advertised for |ssl|
2441 * or NULL if there is none. */
2442OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *ssl);
2443
2444/* SSL_get_psk_identity, after the handshake completes, returns the PSK identity
2445 * that was negotiated by |ssl| or NULL if PSK was not used. */
2446OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *ssl);
2447
2448
David Benjaminc2ae53d2015-10-17 13:26:57 -04002449/* Alerts.
2450 *
2451 * TLS and SSL 3.0 use alerts to signal error conditions. Alerts have a type
2452 * (warning or fatal) and description. OpenSSL internally handles fatal alerts
2453 * with dedicated error codes (see |SSL_AD_REASON_OFFSET|). Except for
2454 * close_notify, warning alerts are silently ignored and may only be surfaced
2455 * with |SSL_CTX_set_info_callback|. */
2456
2457/* SSL_AD_REASON_OFFSET is the offset between error reasons and |SSL_AD_*|
2458 * values. Any error code under |ERR_LIB_SSL| with an error reason above this
2459 * value corresponds to an alert description. Consumers may add or subtract
2460 * |SSL_AD_REASON_OFFSET| to convert between them.
2461 *
2462 * make_errors.go reserves error codes above 1000 for manually-assigned errors.
2463 * This value must be kept in sync with reservedReasonCode in make_errors.h */
2464#define SSL_AD_REASON_OFFSET 1000
2465
2466/* SSL_AD_* are alert descriptions for SSL 3.0 and TLS. */
2467#define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY
2468#define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE
2469#define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC
2470#define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED
2471#define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW
2472#define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE
2473#define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE
2474#define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE /* Not used in TLS */
2475#define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE
2476#define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE
2477#define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED
2478#define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED
2479#define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN
2480#define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER
2481#define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA
2482#define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED
2483#define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR
2484#define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR
2485#define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION
2486#define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION
2487#define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY
2488#define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR
2489#define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED
2490#define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION
2491#define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION
2492#define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE
2493#define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME
2494#define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \
2495 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE
2496#define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE
2497#define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY
2498#define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK
2499
2500/* SSL_alert_type_string_long returns a string description of |value| as an
2501 * alert type (warning or fatal). */
2502OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value);
2503
2504/* SSL_alert_desc_string_long returns a string description of |value| as an
2505 * alert description or "unknown" if unknown. */
2506OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value);
2507
2508
David Benjamin190ab7f2015-09-13 14:20:58 -04002509/* ex_data functions.
2510 *
2511 * See |ex_data.h| for details. */
2512
2513OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data);
2514OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx);
2515OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp,
2516 CRYPTO_EX_new *new_func,
2517 CRYPTO_EX_dup *dup_func,
2518 CRYPTO_EX_free *free_func);
2519
2520OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *session, int idx,
2521 void *data);
2522OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *session,
2523 int idx);
2524OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp,
2525 CRYPTO_EX_new *new_func,
2526 CRYPTO_EX_dup *dup_func,
2527 CRYPTO_EX_free *free_func);
2528
2529OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ctx, int idx, void *data);
2530OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ctx, int idx);
2531OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp,
2532 CRYPTO_EX_new *new_func,
2533 CRYPTO_EX_dup *dup_func,
2534 CRYPTO_EX_free *free_func);
2535
2536
David Benjamin42fea372015-09-19 01:22:44 -04002537/* Obscure functions. */
2538
2539/* SSL_get_rc4_state sets |*read_key| and |*write_key| to the RC4 states for
2540 * the read and write directions. It returns one on success or zero if |ssl|
2541 * isn't using an RC4-based cipher suite. */
2542OPENSSL_EXPORT int SSL_get_rc4_state(const SSL *ssl, const RC4_KEY **read_key,
2543 const RC4_KEY **write_key);
2544
2545/* SSL_get_structure_sizes returns the sizes of the SSL, SSL_CTX and
2546 * SSL_SESSION structures so that a test can ensure that outside code agrees on
2547 * these values. */
2548OPENSSL_EXPORT void SSL_get_structure_sizes(size_t *ssl_size,
2549 size_t *ssl_ctx_size,
2550 size_t *ssl_session_size);
2551
David Benjamin0cfea342015-09-19 16:23:06 -04002552/* SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|.
2553 * This callback will be called when sending or receiving low-level record
2554 * headers, complete handshake messages, ChangeCipherSpec, and alerts.
2555 * |write_p| is one for outgoing messages and zero for incoming messages.
2556 *
2557 * For each record header, |cb| is called with |version| = 0 and |content_type|
2558 * = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that
2559 * this does not include the record body. If the record is sealed, the length
2560 * in the header is the length of the ciphertext.
2561 *
2562 * For each handshake message, ChangeCipherSpec, and alert, |version| is the
2563 * protocol version and |content_type| is the corresponding record type. The
2564 * |len| bytes from |buf| contain the handshake message, one-byte
2565 * ChangeCipherSpec body, and two-byte alert, respectively. */
2566OPENSSL_EXPORT void SSL_CTX_set_msg_callback(
2567 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type,
2568 const void *buf, size_t len, SSL *ssl, void *arg));
2569
2570/* SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message
2571 * callback. */
2572OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
2573
2574/* SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See
2575 * |SSL_CTX_set_msg_callback| for when this callback is called. */
2576OPENSSL_EXPORT void SSL_set_msg_callback(
2577 SSL *ssl, void (*cb)(int write_p, int version, int content_type,
2578 const void *buf, size_t len, SSL *ssl, void *arg));
2579
2580/* SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. */
2581OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
2582
2583/* SSL_CTX_set_keylog_bio sets configures all SSL objects attached to |ctx| to
2584 * log session material to |keylog_bio|. This is intended for debugging use
2585 * with tools like Wireshark. |ctx| takes ownership of |keylog_bio|.
2586 *
2587 * The format is described in
2588 * https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. */
2589OPENSSL_EXPORT void SSL_CTX_set_keylog_bio(SSL_CTX *ctx, BIO *keylog_bio);
2590
David Benjamin1d5ef3b2015-10-12 19:54:18 -04002591enum ssl_renegotiate_mode_t {
2592 ssl_renegotiate_never = 0,
2593 ssl_renegotiate_once,
2594 ssl_renegotiate_freely,
2595};
2596
2597/* SSL_set_renegotiate_mode configures how |ssl|, a client, reacts to
2598 * renegotiation attempts by a server. If |ssl| is a server, peer-initiated
2599 * renegotiations are *always* rejected and this function does nothing.
2600 *
2601 * The renegotiation mode defaults to |ssl_renegotiate_never|, but may be set
2602 * at any point in a connection's lifetime. Set it to |ssl_renegotiate_once| to
2603 * allow one renegotiation and |ssl_renegotiate_freely| to allow all
2604 * renegotiations.
2605 *
2606 * There is no support in BoringSSL for initiating renegotiations as a client
2607 * or server. */
2608OPENSSL_EXPORT void SSL_set_renegotiate_mode(SSL *ssl,
2609 enum ssl_renegotiate_mode_t mode);
David Benjamin0cfea342015-09-19 16:23:06 -04002610
David Benjamincef1eb42015-10-17 19:47:13 -04002611/* SSL_renegotiate_pending returns one if |ssl| is in the middle of a
2612 * renegotiation. */
2613OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl);
2614
2615/* SSL_total_renegotiations returns the total number of renegotiation handshakes
2616 * peformed by |ssl|. This includes the pending renegotiation, if any. */
2617OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl);
2618
David Benjamin9f859492015-10-03 10:44:30 -04002619/* SSL_MAX_CERT_LIST_DEFAULT is the default maximum length, in bytes, of a peer
2620 * certificate chain. */
2621#define SSL_MAX_CERT_LIST_DEFAULT 1024 * 100
2622
2623/* SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer
2624 * certificate chain accepted by |ctx|. */
2625OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx);
2626
2627/* SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer
2628 * certificate chain to |max_cert_list|. This affects how much memory may be
2629 * consumed during the handshake. */
2630OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx,
2631 size_t max_cert_list);
2632
2633/* SSL_get_max_cert_list returns the maximum length, in bytes, of a peer
2634 * certificate chain accepted by |ssl|. */
2635OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl);
2636
2637/* SSL_set_max_cert_list sets the maximum length, in bytes, of a peer
2638 * certificate chain to |max_cert_list|. This affects how much memory may be
2639 * consumed during the handshake. */
2640OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list);
2641
2642/* SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records
2643 * sent by |ctx|. Beyond this length, handshake messages and application data
2644 * will be split into multiple records. */
2645OPENSSL_EXPORT void SSL_CTX_set_max_send_fragment(SSL_CTX *ctx,
2646 size_t max_send_fragment);
2647
2648/* SSL_set_max_send_fragment sets the maximum length, in bytes, of records
2649 * sent by |ssl|. Beyond this length, handshake messages and application data
2650 * will be split into multiple records. */
2651OPENSSL_EXPORT void SSL_set_max_send_fragment(SSL *ssl,
2652 size_t max_send_fragment);
2653
David Benjamincfdee212015-10-16 22:45:17 -04002654/* OPENSSL_get_big_buffer_use_count returns the total number of invalid TLS
2655 * records that were accepted because of |SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER|.
2656 *
2657 * TODO(davidben): Remove this when (hopefully!) the quirk is demonstrated to be
2658 * unnecessary. */
2659OPENSSL_EXPORT uint64_t OPENSSL_get_big_buffer_use_count(void);
2660
2661/* OPENSSL_get_d5_bug_use_count returns the total number of invalid RSA
2662 * ClientKeyExchanges that were accepted because of |SSL_OP_TLS_D5_BUG|.
2663 *
2664 * TODO(davidben): Remove this when (hopefully!) the quirk is demonstrated to be
2665 * unnecessary. */
2666OPENSSL_EXPORT uint64_t OPENSSL_get_d5_bug_use_count(void);
2667
David Benjamind4c2bce2015-10-17 12:28:18 -04002668/* ssl_early_callback_ctx is passed to certain callbacks that are called very
2669 * early on during the server handshake. At this point, much of the SSL* hasn't
2670 * been filled out and only the ClientHello can be depended on. */
2671struct ssl_early_callback_ctx {
2672 SSL *ssl;
2673 const uint8_t *client_hello;
2674 size_t client_hello_len;
2675 const uint8_t *session_id;
2676 size_t session_id_len;
2677 const uint8_t *cipher_suites;
2678 size_t cipher_suites_len;
2679 const uint8_t *compression_methods;
2680 size_t compression_methods_len;
2681 const uint8_t *extensions;
2682 size_t extensions_len;
2683};
2684
2685/* SSL_early_callback_ctx_extension_get searches the extensions in |ctx| for an
2686 * extension of the given type. If not found, it returns zero. Otherwise it
2687 * sets |out_data| to point to the extension contents (not including the type
2688 * and length bytes), sets |out_len| to the length of the extension contents
2689 * and returns one. */
2690OPENSSL_EXPORT int SSL_early_callback_ctx_extension_get(
2691 const struct ssl_early_callback_ctx *ctx, uint16_t extension_type,
2692 const uint8_t **out_data, size_t *out_len);
2693
2694/* SSL_CTX_set_select_certificate_cb sets a callback that is called before most
2695 * ClientHello processing and before the decision whether to resume a session
2696 * is made. The callback may inspect the ClientHello and configure the
2697 * connection. It may then return one to continue the handshake or zero to
2698 * pause the handshake to perform an asynchronous operation. If paused,
2699 * |SSL_get_error| will return |SSL_ERROR_PENDING_CERTIFICATE|.
2700 *
2701 * Note: The |ssl_early_callback_ctx| is only valid for the duration of the
2702 * callback and is not valid while the handshake is paused. Further, unlike with
2703 * most callbacks, when the handshake loop is resumed, it will not call the
2704 * callback a second time. The caller must finish reconfiguring the connection
2705 * before resuming the handshake. */
2706OPENSSL_EXPORT void SSL_CTX_set_select_certificate_cb(
2707 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2708
2709/* SSL_CTX_set_dos_protection_cb sets a callback that is called once the
2710 * resumption decision for a ClientHello has been made. It can return one to
2711 * allow the handshake to continue or zero to cause the handshake to abort. */
2712OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb(
2713 SSL_CTX *ctx, int (*cb)(const struct ssl_early_callback_ctx *));
2714
David Benjamin42fea372015-09-19 01:22:44 -04002715
David Benjamin71f07942015-04-08 02:36:59 -04002716/* Underdocumented functions.
2717 *
2718 * Functions below here haven't been touched up and may be underdocumented. */
2719
Adam Langleyb4a494c2015-01-23 15:10:10 -08002720#define SSL_MAX_SSL_SESSION_ID_LENGTH 32
2721#define SSL_MAX_SID_CTX_LENGTH 32
2722#define SSL_MAX_MASTER_KEY_LENGTH 48
Adam Langley95c29f32014-06-20 12:00:00 -07002723
2724/* These are used to specify which ciphers to use and not to use */
2725
Adam Langleyb4a494c2015-01-23 15:10:10 -08002726#define SSL_TXT_MEDIUM "MEDIUM"
2727#define SSL_TXT_HIGH "HIGH"
2728#define SSL_TXT_FIPS "FIPS"
Adam Langley95c29f32014-06-20 12:00:00 -07002729
Adam Langleyb4a494c2015-01-23 15:10:10 -08002730#define SSL_TXT_kRSA "kRSA"
David Benjamin7061e282015-03-19 11:10:48 -04002731#define SSL_TXT_kDHE "kDHE"
2732#define SSL_TXT_kEDH "kEDH" /* same as "kDHE" */
2733#define SSL_TXT_kECDHE "kECDHE"
2734#define SSL_TXT_kEECDH "kEECDH" /* same as "kECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002735#define SSL_TXT_kPSK "kPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07002736
Adam Langleyb4a494c2015-01-23 15:10:10 -08002737#define SSL_TXT_aRSA "aRSA"
2738#define SSL_TXT_aECDSA "aECDSA"
2739#define SSL_TXT_aPSK "aPSK"
Adam Langley95c29f32014-06-20 12:00:00 -07002740
Adam Langleyb4a494c2015-01-23 15:10:10 -08002741#define SSL_TXT_DH "DH"
David Benjamin32fbdf22015-04-07 01:14:06 -04002742#define SSL_TXT_DHE "DHE" /* same as "kDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04002743#define SSL_TXT_EDH "EDH" /* same as "DHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002744#define SSL_TXT_RSA "RSA"
2745#define SSL_TXT_ECDH "ECDH"
David Benjamin32fbdf22015-04-07 01:14:06 -04002746#define SSL_TXT_ECDHE "ECDHE" /* same as "kECDHE" */
David Benjamin7061e282015-03-19 11:10:48 -04002747#define SSL_TXT_EECDH "EECDH" /* same as "ECDHE" */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002748#define SSL_TXT_ECDSA "ECDSA"
2749#define SSL_TXT_PSK "PSK"
Adam Langley95c29f32014-06-20 12:00:00 -07002750
Adam Langleyb4a494c2015-01-23 15:10:10 -08002751#define SSL_TXT_3DES "3DES"
2752#define SSL_TXT_RC4 "RC4"
2753#define SSL_TXT_AES128 "AES128"
2754#define SSL_TXT_AES256 "AES256"
2755#define SSL_TXT_AES "AES"
2756#define SSL_TXT_AES_GCM "AESGCM"
2757#define SSL_TXT_CHACHA20 "CHACHA20"
Adam Langley95c29f32014-06-20 12:00:00 -07002758
Adam Langleyb4a494c2015-01-23 15:10:10 -08002759#define SSL_TXT_MD5 "MD5"
2760#define SSL_TXT_SHA1 "SHA1"
2761#define SSL_TXT_SHA "SHA" /* same as "SHA1" */
2762#define SSL_TXT_SHA256 "SHA256"
2763#define SSL_TXT_SHA384 "SHA384"
Adam Langley95c29f32014-06-20 12:00:00 -07002764
Adam Langleyb4a494c2015-01-23 15:10:10 -08002765#define SSL_TXT_SSLV3 "SSLv3"
2766#define SSL_TXT_TLSV1 "TLSv1"
2767#define SSL_TXT_TLSV1_1 "TLSv1.1"
2768#define SSL_TXT_TLSV1_2 "TLSv1.2"
Adam Langley95c29f32014-06-20 12:00:00 -07002769
Adam Langleyb4a494c2015-01-23 15:10:10 -08002770#define SSL_TXT_ALL "ALL"
Adam Langley95c29f32014-06-20 12:00:00 -07002771
Adam Langleyb4a494c2015-01-23 15:10:10 -08002772#define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT"
Adam Langley95c29f32014-06-20 12:00:00 -07002773
Adam Langley95c29f32014-06-20 12:00:00 -07002774/* Used in SSL_set_shutdown()/SSL_get_shutdown(); */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002775#define SSL_SENT_SHUTDOWN 1
2776#define SSL_RECEIVED_SHUTDOWN 2
Adam Langley95c29f32014-06-20 12:00:00 -07002777
David Benjamin82c9e902014-12-12 15:55:27 -05002778typedef struct ssl_protocol_method_st SSL_PROTOCOL_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07002779typedef struct ssl_conf_ctx_st SSL_CONF_CTX;
David Benjamin338fcaf2014-12-11 01:20:52 -05002780typedef struct ssl3_enc_method SSL3_ENC_METHOD;
Adam Langley95c29f32014-06-20 12:00:00 -07002781
Adam Langleyc9fb3752014-06-20 12:00:00 -07002782struct ssl_aead_ctx_st;
2783typedef struct ssl_aead_ctx_st SSL_AEAD_CTX;
2784
Adam Langleyb4a494c2015-01-23 15:10:10 -08002785OPENSSL_EXPORT void SSL_CTX_set_info_callback(SSL_CTX *ctx,
2786 void (*cb)(const SSL *ssl,
2787 int type, int val));
2788OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl,
2789 int type,
2790 int val);
David Benjamin6c7aed02014-08-27 16:42:38 -04002791
Adam Langleyb4a494c2015-01-23 15:10:10 -08002792/* The following are the possible values for ssl->state are are used to
2793 * indicate where we are up to in the SSL connection establishment. The macros
2794 * that follow are about the only things you should need to use and even then,
2795 * only when using non-blocking IO. It can also be useful to work out where you
2796 * were when the connection failed */
Adam Langley95c29f32014-06-20 12:00:00 -07002797
Adam Langleyb4a494c2015-01-23 15:10:10 -08002798#define SSL_ST_CONNECT 0x1000
2799#define SSL_ST_ACCEPT 0x2000
2800#define SSL_ST_MASK 0x0FFF
2801#define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08002802#define SSL_ST_OK 0x03
2803#define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT)
Adam Langley95c29f32014-06-20 12:00:00 -07002804
Adam Langleyb4a494c2015-01-23 15:10:10 -08002805#define SSL_CB_LOOP 0x01
2806#define SSL_CB_EXIT 0x02
2807#define SSL_CB_READ 0x04
2808#define SSL_CB_WRITE 0x08
2809#define SSL_CB_ALERT 0x4000 /* used in callback */
2810#define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ)
2811#define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE)
2812#define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP)
2813#define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT)
2814#define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP)
2815#define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT)
2816#define SSL_CB_HANDSHAKE_START 0x10
2817#define SSL_CB_HANDSHAKE_DONE 0x20
Adam Langley95c29f32014-06-20 12:00:00 -07002818
2819/* Is the SSL_connection established? */
Adam Langleyb4a494c2015-01-23 15:10:10 -08002820#define SSL_get_state(a) SSL_state(a)
2821#define SSL_is_init_finished(a) (SSL_state(a) == SSL_ST_OK)
David Benjaminccf74f82015-02-09 00:01:31 -05002822#define SSL_in_init(a) (SSL_state(a) & SSL_ST_INIT)
Adam Langleyb4a494c2015-01-23 15:10:10 -08002823#define SSL_in_connect_init(a) (SSL_state(a) & SSL_ST_CONNECT)
2824#define SSL_in_accept_init(a) (SSL_state(a) & SSL_ST_ACCEPT)
David Benjaminccf74f82015-02-09 00:01:31 -05002825
David Benjamined7c4752015-02-16 19:16:46 -05002826/* SSL_in_false_start returns one if |s| has a pending unfinished handshake that
2827 * is in False Start. |SSL_write| may be called at this point without waiting
2828 * for the peer, but |SSL_read| will require the handshake to be completed. */
2829OPENSSL_EXPORT int SSL_in_false_start(const SSL *s);
2830
Adam Langleyb4a494c2015-01-23 15:10:10 -08002831#define d2i_SSL_SESSION_bio(bp, s_id) \
2832 ASN1_d2i_bio_of(SSL_SESSION, SSL_SESSION_new, d2i_SSL_SESSION, bp, s_id)
2833#define i2d_SSL_SESSION_bio(bp, s_id) \
2834 ASN1_i2d_bio_of(SSL_SESSION, i2d_SSL_SESSION, bp, s_id)
Adam Langley95c29f32014-06-20 12:00:00 -07002835
2836DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION)
2837
Adam Langleyb4a494c2015-01-23 15:10:10 -08002838OPENSSL_EXPORT int SSL_get_fd(const SSL *s);
2839OPENSSL_EXPORT int SSL_get_rfd(const SSL *s);
2840OPENSSL_EXPORT int SSL_get_wfd(const SSL *s);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002841OPENSSL_EXPORT int SSL_set_fd(SSL *s, int fd);
2842OPENSSL_EXPORT int SSL_set_rfd(SSL *s, int fd);
2843OPENSSL_EXPORT int SSL_set_wfd(SSL *s, int fd);
Adam Langley95c29f32014-06-20 12:00:00 -07002844
David Benjaminb86847c2015-10-17 13:05:27 -04002845OPENSSL_EXPORT const char *SSL_state_string(const SSL *ssl);
2846OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *ssl);
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02002847
Adam Langleyb4a494c2015-01-23 15:10:10 -08002848OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002849OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002850OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl);
Adam Langleyb4a494c2015-01-23 15:10:10 -08002851OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002852OPENSSL_EXPORT void SSL_set_info_callback(SSL *ssl,
Adam Langleyb4a494c2015-01-23 15:10:10 -08002853 void (*cb)(const SSL *ssl, int type,
2854 int val));
2855OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl,
2856 int type, int val);
Adam Langleyeb7d2ed2014-07-30 16:02:14 -07002857OPENSSL_EXPORT int SSL_state(const SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07002858
Adam Langley95c29f32014-06-20 12:00:00 -07002859
David Benjamin71f07942015-04-08 02:36:59 -04002860/* Deprecated functions. */
2861
David Benjamin1d5ef3b2015-10-12 19:54:18 -04002862/* SSL_set_reject_peer_renegotiations calls |SSL_set_renegotiate_mode| with
2863 * |ssl_never_renegotiate| if |reject| is one and |ssl_renegotiate_freely| if
2864 * zero. */
2865OPENSSL_EXPORT void SSL_set_reject_peer_renegotiations(SSL *ssl, int reject);
2866
David Benjamin71f07942015-04-08 02:36:59 -04002867/* SSL_CIPHER_description writes a description of |cipher| into |buf| and
2868 * returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be
2869 * freed with |OPENSSL_free|, or NULL on error.
2870 *
2871 * The description includes a trailing newline and has the form:
2872 * AES128-SHA SSLv3 Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1
2873 *
2874 * Consider |SSL_CIPHER_get_name| or |SSL_CIPHER_get_rfc_name| instead. */
2875OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher,
2876 char *buf, int len);
2877
2878/* SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". */
2879OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher);
2880
David Benjamin3fb1ebc2015-09-16 00:29:20 -04002881typedef void COMP_METHOD;
2882
David Benjamin71f07942015-04-08 02:36:59 -04002883/* SSL_COMP_get_compression_methods returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002884OPENSSL_EXPORT COMP_METHOD *SSL_COMP_get_compression_methods(void);
David Benjamin71f07942015-04-08 02:36:59 -04002885
2886/* SSL_COMP_add_compression_method returns one. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002887OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm);
David Benjamin71f07942015-04-08 02:36:59 -04002888
2889/* SSL_COMP_get_name returns NULL. */
Matt Braithwaite6a1275b2015-06-26 12:09:10 -07002890OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp);
David Benjamin71f07942015-04-08 02:36:59 -04002891
David Benjamin0d8a7582015-04-08 23:55:15 -04002892/* SSLv23_method calls |TLS_method|. */
2893OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void);
2894
2895/* Version-specific methods behave exactly like |TLS_method| and |DTLS_method|
2896 * except they also call |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version|
2897 * to lock connections to that protocol version. */
2898OPENSSL_EXPORT const SSL_METHOD *SSLv3_method(void);
2899OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void);
2900OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void);
2901OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void);
2902OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void);
2903OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void);
2904
2905/* Client- and server-specific methods call their corresponding generic
2906 * methods. */
2907OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void);
2908OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void);
2909OPENSSL_EXPORT const SSL_METHOD *SSLv3_server_method(void);
2910OPENSSL_EXPORT const SSL_METHOD *SSLv3_client_method(void);
2911OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void);
2912OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void);
2913OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void);
2914OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void);
2915OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void);
2916OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void);
2917OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void);
2918OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void);
2919OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void);
2920OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void);
2921OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void);
2922OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void);
2923
David Benjamin4831c332015-05-16 11:43:13 -04002924/* SSL_clear resets |ssl| to allow another connection and returns one on success
2925 * or zero on failure. It returns most configuration state but releases memory
2926 * associated with the current connection.
2927 *
2928 * Free |ssl| and create a new one instead. */
2929OPENSSL_EXPORT int SSL_clear(SSL *ssl);
2930
David Benjamin59015c32015-04-26 13:13:55 -04002931/* SSL_CTX_set_tmp_rsa_callback does nothing. */
2932OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback(
2933 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002934
David Benjamin59015c32015-04-26 13:13:55 -04002935/* SSL_set_tmp_rsa_callback does nothing. */
2936OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl,
2937 RSA *(*cb)(SSL *ssl, int is_export,
2938 int keylength));
David Benjamindd978782015-04-24 15:20:13 -04002939
David Benjaminda881e92015-04-26 14:45:04 -04002940/* SSL_CTX_sess_connect returns zero. */
2941OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx);
2942
2943/* SSL_CTX_sess_connect_good returns zero. */
2944OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx);
2945
2946/* SSL_CTX_sess_connect_renegotiate returns zero. */
2947OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx);
2948
2949/* SSL_CTX_sess_accept returns zero. */
2950OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx);
2951
2952/* SSL_CTX_sess_accept_renegotiate returns zero. */
2953OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx);
2954
2955/* SSL_CTX_sess_accept_good returns zero. */
2956OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx);
2957
2958/* SSL_CTX_sess_hits returns zero. */
2959OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx);
2960
2961/* SSL_CTX_sess_cb_hits returns zero. */
2962OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx);
2963
2964/* SSL_CTX_sess_misses returns zero. */
2965OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx);
2966
2967/* SSL_CTX_sess_timeouts returns zero. */
2968OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx);
2969
2970/* SSL_CTX_sess_cache_full returns zero. */
2971OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx);
2972
David Benjamin101ead22015-04-26 18:36:23 -04002973/* SSL_cutthrough_complete calls |SSL_in_false_start|. */
2974OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *s);
2975
David Benjaminc0454692015-04-27 00:28:56 -04002976/* SSL_num_renegotiations calls |SSL_total_renegotiations|. */
2977OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl);
2978
2979/* SSL_CTX_need_tmp_RSA returns zero. */
2980OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx);
2981
2982/* SSL_need_tmp_RSA returns zero. */
2983OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl);
2984
2985/* SSL_CTX_set_tmp_rsa returns one. */
2986OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa);
2987
2988/* SSL_set_tmp_rsa returns one. */
2989OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa);
2990
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002991/* SSL_CTX_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002992OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx);
2993
2994/* SSL_CTX_set_read_ahead does nothing. */
2995OPENSSL_EXPORT void SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes);
2996
Kenny Root3a9e1fb2015-06-10 14:52:40 -07002997/* SSL_get_read_ahead returns zero. */
David Benjamin9a41d1b2015-05-16 01:30:09 -04002998OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *s);
2999
3000/* SSL_set_read_ahead does nothing. */
3001OPENSSL_EXPORT void SSL_set_read_ahead(SSL *s, int yes);
3002
David Benjamin44d3eed2015-05-21 01:29:55 -04003003/* SSL_renegotiate put an error on the error queue and returns zero. */
3004OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl);
3005
David Benjaminece089c2015-05-15 23:52:42 -04003006/* SSL_set_state does nothing. */
3007OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state);
3008
David Benjamin7e40d4e2015-09-07 13:17:45 -04003009/* SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START. */
3010#define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START
3011
3012/* i2d_SSL_SESSION serializes |in| to the bytes pointed to by |*pp|. On success,
3013 * it returns the number of bytes written and advances |*pp| by that many bytes.
3014 * On failure, it returns -1. If |pp| is NULL, no bytes are written and only the
3015 * length is returned.
3016 *
3017 * Use |SSL_SESSION_to_bytes| instead. */
3018OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp);
3019
3020/* d2i_SSL_SESSION parses a serialized session from the |length| bytes pointed
3021 * to by |*pp|. It returns the new |SSL_SESSION| and advances |*pp| by the
3022 * number of bytes consumed on success and NULL on failure. The caller takes
3023 * ownership of the new session and must call |SSL_SESSION_free| when done.
3024 *
3025 * If |a| is non-NULL, |*a| is released and set the new |SSL_SESSION|.
3026 *
3027 * Use |SSL_SESSION_from_bytes| instead. */
3028OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp,
3029 long length);
3030
David Benjamin27bbae42015-09-13 00:54:37 -04003031/* ERR_load_SSL_strings does nothing. */
3032OPENSSL_EXPORT void ERR_load_SSL_strings(void);
3033
3034/* SSL_load_error_strings does nothing. */
3035OPENSSL_EXPORT void SSL_load_error_strings(void);
3036
David Benjamincfd65b62015-09-14 01:54:44 -04003037/* SSL_CTX_set_tlsext_use_srtp calls |SSL_CTX_set_srtp_profiles|. It returns
3038 * zero on success and one on failure.
3039 *
3040 * WARNING: this function is dangerous because it breaks the usual return value
3041 * convention. Use |SSL_CTX_set_srtp_profiles| instead. */
3042OPENSSL_EXPORT int SSL_CTX_set_tlsext_use_srtp(SSL_CTX *ctx,
3043 const char *profiles);
3044
3045/* SSL_set_tlsext_use_srtp calls |SSL_set_srtp_profiles|. It returns zero on
3046 * success and one on failure.
3047 *
3048 * WARNING: this function is dangerous because it breaks the usual return value
3049 * convention. Use |SSL_set_srtp_profiles| instead. */
3050OPENSSL_EXPORT int SSL_set_tlsext_use_srtp(SSL *ssl, const char *profiles);
3051
David Benjamin3fb1ebc2015-09-16 00:29:20 -04003052/* SSL_get_current_compression returns NULL. */
3053OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *s);
3054
3055/* SSL_get_current_expansion returns NULL. */
3056OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *s);
3057
3058#define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)arg))
3059#define SSL_get_app_data(s) (SSL_get_ex_data(s, 0))
3060#define SSL_SESSION_set_app_data(s, a) \
3061 (SSL_SESSION_set_ex_data(s, 0, (char *)a))
3062#define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0))
3063#define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0))
3064#define SSL_CTX_set_app_data(ctx, arg) \
3065 (SSL_CTX_set_ex_data(ctx, 0, (char *)arg))
3066
3067#define OpenSSL_add_ssl_algorithms() SSL_library_init()
3068#define SSLeay_add_ssl_algorithms() SSL_library_init()
3069
3070#define SSL_get_cipher(ssl) SSL_CIPHER_get_name(SSL_get_current_cipher(ssl))
3071#define SSL_get_cipher_bits(ssl, out_alg_bits) \
3072 SSL_CIPHER_get_bits(SSL_get_current_cipher(ssl), out_alg_bits)
3073#define SSL_get_cipher_version(ssl) \
3074 SSL_CIPHER_get_version(SSL_get_current_cipher(ssl))
3075#define SSL_get_cipher_name(ssl) \
3076 SSL_CIPHER_get_name(SSL_get_current_cipher(ssl))
3077#define SSL_get_time(session) SSL_SESSION_get_time(session)
3078#define SSL_set_time(session, time) SSL_SESSION_set_time((session), (time))
3079#define SSL_get_timeout(session) SSL_SESSION_get_timeout(session)
3080#define SSL_set_timeout(session, timeout) \
3081 SSL_SESSION_set_timeout((session), (timeout))
3082
3083typedef struct ssl_comp_st SSL_COMP;
3084
3085struct ssl_comp_st {
3086 int id;
3087 const char *name;
3088 char *method;
3089};
3090
3091DECLARE_STACK_OF(SSL_COMP)
3092
3093/* The following flags toggle individual protocol versions. This is deprecated.
3094 * Use |SSL_CTX_set_min_version| and |SSL_CTX_set_max_version| instead. */
3095#define SSL_OP_NO_SSLv3 0x02000000L
3096#define SSL_OP_NO_TLSv1 0x04000000L
3097#define SSL_OP_NO_TLSv1_2 0x08000000L
3098#define SSL_OP_NO_TLSv1_1 0x10000000L
3099#define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1
3100#define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2
3101
3102/* The following flags do nothing and are included only to make it easier to
3103 * compile code with BoringSSL. */
David Benjamin907bd302015-09-19 13:29:36 -04003104#define SSL_MODE_AUTO_RETRY 0
3105#define SSL_MODE_RELEASE_BUFFERS 0
3106#define SSL_MODE_SEND_CLIENTHELLO_TIME 0
3107#define SSL_MODE_SEND_SERVERHELLO_TIME 0
David Benjamin3fb1ebc2015-09-16 00:29:20 -04003108#define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0
3109#define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0
3110#define SSL_OP_EPHEMERAL_RSA 0
3111#define SSL_OP_MICROSOFT_SESS_ID_BUG 0
3112#define SSL_OP_MSIE_SSLV2_RSA_PADDING 0
3113#define SSL_OP_NETSCAPE_CA_DN_BUG 0
3114#define SSL_OP_NETSCAPE_CHALLENGE_BUG 0
3115#define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0
3116#define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0
3117#define SSL_OP_NO_COMPRESSION 0
3118#define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0
3119#define SSL_OP_NO_SSLv2 0
3120#define SSL_OP_PKCS1_CHECK_1 0
3121#define SSL_OP_PKCS1_CHECK_2 0
3122#define SSL_OP_SINGLE_DH_USE 0
3123#define SSL_OP_SINGLE_ECDH_USE 0
3124#define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0
3125#define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0
3126#define SSL_OP_TLS_BLOCK_PADDING_BUG 0
3127#define SSL_OP_TLS_ROLLBACK_BUG 0
David Benjamin59937042015-09-19 13:04:22 -04003128#define SSL_VERIFY_CLIENT_ONCE 0
3129
David Benjamin42fea372015-09-19 01:22:44 -04003130/* SSL_cache_hit calls |SSL_session_resumed|. */
3131OPENSSL_EXPORT int SSL_cache_hit(SSL *ssl);
3132
3133/* SSL_get_default_timeout returns |SSL_DEFAULT_SESSION_TIMEOUT|. */
3134OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *ssl);
3135
3136/* SSL_get_version returns a string describing the TLS version used by |ssl|.
3137 * For example, "TLSv1.2" or "SSLv3". */
3138OPENSSL_EXPORT const char *SSL_get_version(const SSL *ssl);
3139
David Benjamin32876b32015-09-20 12:17:03 -04003140/* SSL_get_cipher_list returns the name of the |n|th cipher in the output of
3141 * |SSL_get_ciphers| or NULL if out of range. Use |SSL_get_ciphers| insteads. */
3142OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *ssl, int n);
3143
David Benjaminfd8e69f2015-10-03 10:49:20 -04003144/* SSL_CTX_set_client_cert_cb sets a callback which is called on the client if
3145 * the server requests a client certificate and none is configured. On success,
3146 * the callback should return one and set |*out_x509| to |*out_pkey| to a leaf
3147 * certificate and private key, respectively, passing ownership. It should
3148 * return zero to send no certificate and -1 to fail or pause the handshake. If
3149 * the handshake is paused, |SSL_get_error| will return
3150 * |SSL_ERROR_WANT_X509_LOOKUP|.
3151 *
3152 * The callback may call |SSL_get0_certificate_types| and
3153 * |SSL_get_client_CA_list| for information on the server's certificate request.
3154 *
3155 * Use |SSL_CTX_set_cert_cb| instead. Configuring intermediate certificates with
3156 * this function is confusing. */
3157OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb(
3158 SSL_CTX *ctx,
3159 int (*client_cert_cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey));
3160
3161/* SSL_CTX_get_client_cert_cb returns the callback set by
3162 * |SSL_CTX_set_client_cert_cb|. */
3163OPENSSL_EXPORT int (*SSL_CTX_get_client_cert_cb(SSL_CTX *ctx))(
3164 SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey);
3165
David Benjamin93d17492015-10-17 12:43:36 -04003166#define SSL_NOTHING 1
3167#define SSL_WRITING 2
3168#define SSL_READING 3
3169#define SSL_X509_LOOKUP 4
3170#define SSL_CHANNEL_ID_LOOKUP 5
3171#define SSL_PENDING_SESSION 7
3172#define SSL_CERTIFICATE_SELECTION_PENDING 8
3173#define SSL_PRIVATE_KEY_OPERATION 9
3174
3175/* SSL_want returns one of the above values to determine what the most recent
3176 * operation on |ssl| was blocked on. Use |SSL_get_error| instead. */
3177OPENSSL_EXPORT int SSL_want(const SSL *ssl);
3178
3179#define SSL_want_nothing(ssl) (SSL_want(ssl) == SSL_NOTHING)
3180#define SSL_want_read(ssl) (SSL_want(ssl) == SSL_READING)
3181#define SSL_want_write(ssl) (SSL_want(ssl) == SSL_WRITING)
3182#define SSL_want_x509_lookup(ssl) (SSL_want(ssl) == SSL_X509_LOOKUP)
3183#define SSL_want_channel_id_lookup(ssl) (SSL_want(ssl) == SSL_CHANNEL_ID_LOOKUP)
3184#define SSL_want_session(ssl) (SSL_want(ssl) == SSL_PENDING_SESSION)
3185#define SSL_want_certificate(ssl) \
3186 (SSL_want(ssl) == SSL_CERTIFICATE_SELECTION_PENDING)
3187#define SSL_want_private_key_operation(ssl) \
3188 (SSL_want(ssl) == SSL_PRIVATE_KEY_OPERATION)
3189
David Benjamin1a1b34d2015-10-17 12:51:52 -04003190 /* SSL_get_finished writes up to |count| bytes of the Finished message sent by
3191 * |ssl| to |buf|. It returns the total untruncated length or zero if none has
3192 * been sent yet.
3193 *
3194 * Use |SSL_get_tls_unique| instead. */
3195OPENSSL_EXPORT size_t SSL_get_finished(const SSL *ssl, void *buf, size_t count);
3196
3197 /* SSL_get_peer_finished writes up to |count| bytes of the Finished message
3198 * received from |ssl|'s peer to |buf|. It returns the total untruncated length
3199 * or zero if none has been received yet.
3200 *
3201 * Use |SSL_get_tls_unique| instead. */
3202OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *ssl, void *buf,
3203 size_t count);
3204
David Benjaminc2ae53d2015-10-17 13:26:57 -04003205/* SSL_alert_type_string returns "!". Use |SSL_alert_type_string_long|
3206 * instead. */
3207OPENSSL_EXPORT const char *SSL_alert_type_string(int value);
3208
3209/* SSL_alert_desc_string returns "!!". Use |SSL_alert_desc_string_long|
3210 * instead. */
3211OPENSSL_EXPORT const char *SSL_alert_desc_string(int value);
3212
David Benjamin71f07942015-04-08 02:36:59 -04003213
David Benjamin79c117a2015-09-13 13:53:19 -04003214/* Private structures.
3215 *
3216 * This structures are exposed for historical reasons, but access to them is
3217 * deprecated. */
3218
3219struct ssl_cipher_st {
3220 /* name is the OpenSSL name for the cipher. */
3221 const char *name;
3222 /* id is the cipher suite value bitwise OR-d with 0x03000000. */
3223 uint32_t id;
3224
3225 /* The following are internal fields. See ssl/internal.h for their values. */
3226
3227 uint32_t algorithm_mkey;
3228 uint32_t algorithm_auth;
3229 uint32_t algorithm_enc;
3230 uint32_t algorithm_mac;
3231 uint32_t algorithm_ssl;
3232 uint32_t algo_strength;
3233 uint32_t algorithm_prf;
3234
3235 /* strength_bits is the strength of the cipher in bits. */
3236 int strength_bits;
3237 /* alg_bits is the number of bits of key material used by the algorithm. */
3238 int alg_bits;
3239};
3240
3241struct ssl_session_st {
3242 int ssl_version; /* what ssl version session info is being kept in here? */
3243
3244 int master_key_length;
3245 uint8_t master_key[SSL_MAX_MASTER_KEY_LENGTH];
3246 /* session_id - valid? */
3247 unsigned int session_id_length;
3248 uint8_t session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
3249 /* this is used to determine whether the session is being reused in
3250 * the appropriate context. It is up to the application to set this,
3251 * via SSL_new */
3252 unsigned int sid_ctx_length;
3253 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
3254
3255 char *psk_identity;
3256 /* Used to indicate that session resumption is not allowed. Applications can
3257 * also set this bit for a new session via not_resumable_session_cb to
3258 * disable session caching and tickets. */
3259 int not_resumable;
3260
3261 /* peer is the peer's certificate. */
3262 X509 *peer;
3263
3264 /* cert_chain is the certificate chain sent by the peer. NOTE: for historical
3265 * reasons, when a client (so the peer is a server), the chain includes
3266 * |peer|, but when a server it does not. */
3267 STACK_OF(X509) *cert_chain;
3268
3269 /* when app_verify_callback accepts a session where the peer's certificate is
3270 * not ok, we must remember the error for session reuse: */
3271 long verify_result; /* only for servers */
3272
3273 CRYPTO_refcount_t references;
3274 long timeout;
3275 long time;
3276
3277 const SSL_CIPHER *cipher;
3278
3279 /* key_exchange_info contains an indication of the size of the asymmetric
3280 * primitive used in the handshake that created this session. In the event
3281 * that two asymmetric operations are used, this value applies to the one
3282 * that controls the confidentiality of the connection. Its interpretation
3283 * depends on the primitive that was used; as specified by the cipher suite:
3284 * DHE: the size, in bits, of the multiplicative group.
3285 * RSA: the size, in bits, of the modulus.
3286 * ECDHE: the TLS id for the curve.
3287 *
3288 * A zero indicates that the value is unknown. */
3289 uint32_t key_exchange_info;
3290
3291 CRYPTO_EX_DATA ex_data; /* application specific data */
3292
3293 /* These are used to make removal of session-ids more efficient and to
3294 * implement a maximum cache size. */
3295 SSL_SESSION *prev, *next;
3296 char *tlsext_hostname;
3297 /* RFC4507 info */
3298 uint8_t *tlsext_tick; /* Session ticket */
3299 size_t tlsext_ticklen; /* Session ticket length */
3300 uint32_t tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
3301
3302 size_t tlsext_signed_cert_timestamp_list_length;
3303 uint8_t *tlsext_signed_cert_timestamp_list; /* Server's list. */
3304
3305 /* The OCSP response that came with the session. */
3306 size_t ocsp_response_length;
3307 uint8_t *ocsp_response;
3308
3309 char peer_sha256_valid; /* Non-zero if peer_sha256 is valid */
3310 uint8_t
3311 peer_sha256[SHA256_DIGEST_LENGTH]; /* SHA256 of peer certificate */
3312
3313 /* original_handshake_hash contains the handshake hash (either SHA-1+MD5 or
3314 * SHA-2, depending on TLS version) for the original, full handshake that
3315 * created a session. This is used by Channel IDs during resumption. */
3316 uint8_t original_handshake_hash[EVP_MAX_MD_SIZE];
3317 unsigned int original_handshake_hash_len;
3318
3319 /* extended_master_secret is true if the master secret in this session was
3320 * generated using EMS and thus isn't vulnerable to the Triple Handshake
3321 * attack. */
3322 char extended_master_secret;
3323};
3324
3325/* ssl_cipher_preference_list_st contains a list of SSL_CIPHERs with
3326 * equal-preference groups. For TLS clients, the groups are moot because the
3327 * server picks the cipher and groups cannot be expressed on the wire. However,
3328 * for servers, the equal-preference groups allow the client's preferences to
3329 * be partially respected. (This only has an effect with
3330 * SSL_OP_CIPHER_SERVER_PREFERENCE).
3331 *
3332 * The equal-preference groups are expressed by grouping SSL_CIPHERs together.
3333 * All elements of a group have the same priority: no ordering is expressed
3334 * within a group.
3335 *
3336 * The values in |ciphers| are in one-to-one correspondence with
3337 * |in_group_flags|. (That is, sk_SSL_CIPHER_num(ciphers) is the number of
3338 * bytes in |in_group_flags|.) The bytes in |in_group_flags| are either 1, to
3339 * indicate that the corresponding SSL_CIPHER is not the last element of a
3340 * group, or 0 to indicate that it is.
3341 *
3342 * For example, if |in_group_flags| contains all zeros then that indicates a
3343 * traditional, fully-ordered preference. Every SSL_CIPHER is the last element
3344 * of the group (i.e. they are all in a one-element group).
3345 *
3346 * For a more complex example, consider:
3347 * ciphers: A B C D E F
3348 * in_group_flags: 1 1 0 0 1 0
3349 *
3350 * That would express the following, order:
3351 *
3352 * A E
3353 * B -> D -> F
3354 * C
3355 */
3356struct ssl_cipher_preference_list_st {
3357 STACK_OF(SSL_CIPHER) *ciphers;
3358 uint8_t *in_group_flags;
3359};
3360
3361struct ssl_ctx_st {
3362 const SSL_PROTOCOL_METHOD *method;
3363
3364 /* lock is used to protect various operations on this object. */
3365 CRYPTO_MUTEX lock;
3366
3367 /* max_version is the maximum acceptable protocol version. If zero, the
3368 * maximum supported version, currently (D)TLS 1.2, is used. */
3369 uint16_t max_version;
3370
3371 /* min_version is the minimum acceptable protocl version. If zero, the
3372 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
3373 uint16_t min_version;
3374
3375 struct ssl_cipher_preference_list_st *cipher_list;
3376 /* same as above but sorted for lookup */
3377 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
3378
3379 /* cipher_list_tls10 is the list of ciphers when TLS 1.0 or greater is in
3380 * use. This only applies to server connections as, for clients, the version
3381 * number is known at connect time and so the cipher list can be set then. If
3382 * |cipher_list_tls11| is non-NULL then this applies only to TLS 1.0
3383 * connections.
3384 *
3385 * TODO(agl): this exists to assist in the death of SSLv3. It can hopefully
3386 * be removed after that. */
3387 struct ssl_cipher_preference_list_st *cipher_list_tls10;
3388
3389 /* cipher_list_tls11 is the list of ciphers when TLS 1.1 or greater is in
3390 * use. This only applies to server connections as, for clients, the version
3391 * number is known at connect time and so the cipher list can be set then. */
3392 struct ssl_cipher_preference_list_st *cipher_list_tls11;
3393
3394 X509_STORE *cert_store;
3395 LHASH_OF(SSL_SESSION) *sessions;
3396 /* Most session-ids that will be cached, default is
3397 * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited. */
3398 unsigned long session_cache_size;
3399 SSL_SESSION *session_cache_head;
3400 SSL_SESSION *session_cache_tail;
3401
3402 /* handshakes_since_cache_flush is the number of successful handshakes since
3403 * the last cache flush. */
3404 int handshakes_since_cache_flush;
3405
3406 /* This can have one of 2 values, ored together,
3407 * SSL_SESS_CACHE_CLIENT,
3408 * SSL_SESS_CACHE_SERVER,
3409 * Default is SSL_SESSION_CACHE_SERVER, which means only
3410 * SSL_accept which cache SSL_SESSIONS. */
3411 int session_cache_mode;
3412
3413 /* If timeout is not 0, it is the default timeout value set when SSL_new() is
3414 * called. This has been put in to make life easier to set things up */
3415 long session_timeout;
3416
3417 /* If this callback is not null, it will be called each time a session id is
3418 * added to the cache. If this function returns 1, it means that the
3419 * callback will do a SSL_SESSION_free() when it has finished using it.
3420 * Otherwise, on 0, it means the callback has finished with it. If
3421 * remove_session_cb is not null, it will be called when a session-id is
3422 * removed from the cache. After the call, OpenSSL will SSL_SESSION_free()
3423 * it. */
3424 int (*new_session_cb)(SSL *ssl, SSL_SESSION *sess);
3425 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *sess);
3426 SSL_SESSION *(*get_session_cb)(SSL *ssl, uint8_t *data, int len,
3427 int *copy);
3428
3429 CRYPTO_refcount_t references;
3430
3431 /* if defined, these override the X509_verify_cert() calls */
David Benjamin59937042015-09-19 13:04:22 -04003432 int (*app_verify_callback)(X509_STORE_CTX *store_ctx, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003433 void *app_verify_arg;
David Benjamin79c117a2015-09-13 13:53:19 -04003434
3435 /* Default password callback. */
3436 pem_password_cb *default_passwd_callback;
3437
3438 /* Default password callback user data. */
3439 void *default_passwd_callback_userdata;
3440
3441 /* get client cert callback */
David Benjaminfd8e69f2015-10-03 10:49:20 -04003442 int (*client_cert_cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey);
David Benjamin79c117a2015-09-13 13:53:19 -04003443
3444 /* get channel id callback */
David Benjamin42fea372015-09-19 01:22:44 -04003445 void (*channel_id_cb)(SSL *ssl, EVP_PKEY **out_pkey);
David Benjamin79c117a2015-09-13 13:53:19 -04003446
3447 CRYPTO_EX_DATA ex_data;
3448
3449 /* custom_*_extensions stores any callback sets for custom extensions. Note
3450 * that these pointers will be NULL if the stack would otherwise be empty. */
3451 STACK_OF(SSL_CUSTOM_EXTENSION) *client_custom_extensions;
3452 STACK_OF(SSL_CUSTOM_EXTENSION) *server_custom_extensions;
3453
3454 /* Default values used when no per-SSL value is defined follow */
3455
3456 void (*info_callback)(const SSL *ssl, int type,
3457 int val); /* used if SSL's info_callback is NULL */
3458
3459 /* what we put in client cert requests */
3460 STACK_OF(X509_NAME) *client_CA;
3461
3462
3463 /* Default values to use in SSL structures follow (these are copied by
3464 * SSL_new) */
3465
3466 uint32_t options;
3467 uint32_t mode;
3468 uint32_t max_cert_list;
3469
3470 struct cert_st /* CERT */ *cert;
3471
3472 /* callback that allows applications to peek at protocol messages */
3473 void (*msg_callback)(int write_p, int version, int content_type,
3474 const void *buf, size_t len, SSL *ssl, void *arg);
3475 void *msg_callback_arg;
3476
3477 int verify_mode;
3478 unsigned int sid_ctx_length;
3479 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
3480 int (*default_verify_callback)(
3481 int ok, X509_STORE_CTX *ctx); /* called 'verify_callback' in the SSL */
3482
3483 /* Default generate session ID callback. */
3484 GEN_SESSION_CB generate_session_id;
3485
3486 X509_VERIFY_PARAM *param;
3487
3488 /* select_certificate_cb is called before most ClientHello processing and
3489 * before the decision whether to resume a session is made. It may return one
3490 * to continue the handshake or zero to cause the handshake loop to return
3491 * with an error and cause SSL_get_error to return
3492 * SSL_ERROR_PENDING_CERTIFICATE. Note: when the handshake loop is resumed, it
3493 * will not call the callback a second time. */
3494 int (*select_certificate_cb)(const struct ssl_early_callback_ctx *);
3495
3496 /* dos_protection_cb is called once the resumption decision for a ClientHello
3497 * has been made. It returns one to continue the handshake or zero to
3498 * abort. */
3499 int (*dos_protection_cb) (const struct ssl_early_callback_ctx *);
3500
3501 /* quiet_shutdown is true if the connection should not send a close_notify on
3502 * shutdown. */
3503 int quiet_shutdown;
3504
3505 /* Maximum amount of data to send in one fragment. actual record size can be
3506 * more than this due to padding and MAC overheads. */
3507 uint16_t max_send_fragment;
3508
3509 /* TLS extensions servername callback */
3510 int (*tlsext_servername_callback)(SSL *, int *, void *);
3511 void *tlsext_servername_arg;
3512 /* RFC 4507 session ticket keys */
3513 uint8_t tlsext_tick_key_name[SSL_TICKET_KEY_NAME_LEN];
3514 uint8_t tlsext_tick_hmac_key[16];
3515 uint8_t tlsext_tick_aes_key[16];
3516 /* Callback to support customisation of ticket key setting */
3517 int (*tlsext_ticket_key_cb)(SSL *ssl, uint8_t *name, uint8_t *iv,
3518 EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
3519
3520 /* Server-only: psk_identity_hint is the default identity hint to send in
3521 * PSK-based key exchanges. */
3522 char *psk_identity_hint;
3523
3524 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
3525 char *identity,
3526 unsigned int max_identity_len,
3527 uint8_t *psk, unsigned int max_psk_len);
3528 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
3529 uint8_t *psk, unsigned int max_psk_len);
3530
3531
3532 /* retain_only_sha256_of_client_certs is true if we should compute the SHA256
3533 * hash of the peer's certifiate and then discard it to save memory and
3534 * session space. Only effective on the server side. */
3535 char retain_only_sha256_of_client_certs;
3536
3537 /* Next protocol negotiation information */
3538 /* (for experimental NPN extension). */
3539
3540 /* For a server, this contains a callback function by which the set of
3541 * advertised protocols can be provided. */
David Benjamin977547b2015-09-16 00:25:52 -04003542 int (*next_protos_advertised_cb)(SSL *ssl, const uint8_t **out,
3543 unsigned *out_len, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003544 void *next_protos_advertised_cb_arg;
3545 /* For a client, this contains a callback function that selects the
3546 * next protocol from the list provided by the server. */
David Benjamin977547b2015-09-16 00:25:52 -04003547 int (*next_proto_select_cb)(SSL *ssl, uint8_t **out, uint8_t *out_len,
3548 const uint8_t *in, unsigned in_len, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003549 void *next_proto_select_cb_arg;
3550
3551 /* ALPN information
3552 * (we are in the process of transitioning from NPN to ALPN.) */
3553
3554 /* For a server, this contains a callback function that allows the
3555 * server to select the protocol for the connection.
3556 * out: on successful return, this must point to the raw protocol
3557 * name (without the length prefix).
3558 * outlen: on successful return, this contains the length of |*out|.
3559 * in: points to the client's list of supported protocols in
3560 * wire-format.
3561 * inlen: the length of |in|. */
David Benjamin8984f1f2015-09-16 00:10:19 -04003562 int (*alpn_select_cb)(SSL *s, const uint8_t **out, uint8_t *out_len,
3563 const uint8_t *in, unsigned in_len, void *arg);
David Benjamin79c117a2015-09-13 13:53:19 -04003564 void *alpn_select_cb_arg;
3565
3566 /* For a client, this contains the list of supported protocols in wire
3567 * format. */
3568 uint8_t *alpn_client_proto_list;
3569 unsigned alpn_client_proto_list_len;
3570
3571 /* SRTP profiles we are willing to do from RFC 5764 */
3572 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
3573
3574 /* EC extension values inherited by SSL structure */
3575 size_t tlsext_ellipticcurvelist_length;
3576 uint16_t *tlsext_ellipticcurvelist;
3577
3578 /* If true, a client will advertise the Channel ID extension and a server
3579 * will echo it. */
3580 char tlsext_channel_id_enabled;
3581 /* The client's Channel ID private key. */
3582 EVP_PKEY *tlsext_channel_id_private;
3583
3584 /* If true, a client will request certificate timestamps. */
3585 char signed_cert_timestamps_enabled;
3586
3587 /* Signed certificate timestamp list to be sent to the client, if requested */
3588 uint8_t *signed_cert_timestamp_list;
3589 size_t signed_cert_timestamp_list_length;
3590
3591 /* If true, a client will request a stapled OCSP response. */
3592 char ocsp_stapling_enabled;
3593
3594 /* OCSP response to be sent to the client, if requested. */
3595 uint8_t *ocsp_response;
3596 size_t ocsp_response_length;
3597
3598 /* If not NULL, session key material will be logged to this BIO for debugging
3599 * purposes. The format matches NSS's and is readable by Wireshark. */
3600 BIO *keylog_bio;
3601
3602 /* current_time_cb, if not NULL, is the function to use to get the current
3603 * time. It sets |*out_clock| to the current time. */
3604 void (*current_time_cb)(const SSL *ssl, struct timeval *out_clock);
3605};
3606
3607struct ssl_st {
3608 /* version is the protocol version. */
3609 int version;
3610
3611 /* method is the method table corresponding to the current protocol (DTLS or
3612 * TLS). */
3613 const SSL_PROTOCOL_METHOD *method;
3614
3615 /* enc_method is the method table corresponding to the current protocol
3616 * version. */
3617 const SSL3_ENC_METHOD *enc_method;
3618
3619 /* max_version is the maximum acceptable protocol version. If zero, the
3620 * maximum supported version, currently (D)TLS 1.2, is used. */
3621 uint16_t max_version;
3622
3623 /* min_version is the minimum acceptable protocl version. If zero, the
3624 * minimum supported version, currently SSL 3.0 and DTLS 1.0, is used */
3625 uint16_t min_version;
3626
3627 /* There are 2 BIO's even though they are normally both the same. This is so
3628 * data can be read and written to different handlers */
3629
3630 BIO *rbio; /* used by SSL_read */
3631 BIO *wbio; /* used by SSL_write */
3632 BIO *bbio; /* used during session-id reuse to concatenate
3633 * messages */
3634
3635 /* This holds a variable that indicates what we were doing when a 0 or -1 is
3636 * returned. This is needed for non-blocking IO so we know what request
3637 * needs re-doing when in SSL_accept or SSL_connect */
3638 int rwstate;
3639
3640 /* true when we are actually in SSL_accept() or SSL_connect() */
3641 int in_handshake;
3642 int (*handshake_func)(SSL *);
3643
3644 /* Imagine that here's a boolean member "init" that is switched as soon as
3645 * SSL_set_{accept/connect}_state is called for the first time, so that
3646 * "state" and "handshake_func" are properly initialized. But as
3647 * handshake_func is == 0 until then, we use this test instead of an "init"
3648 * member. */
3649
3650 /* server is true iff the this SSL* is the server half. Note: before the SSL*
3651 * is initialized by either SSL_set_accept_state or SSL_set_connect_state,
3652 * the side is not determined. In this state, server is always false. */
3653 int server;
3654
3655 /* quiet_shutdown is true if the connection should not send a close_notify on
3656 * shutdown. */
3657 int quiet_shutdown;
3658
3659 int shutdown; /* we have shut things down, 0x01 sent, 0x02
3660 * for received */
3661 int state; /* where we are */
3662
3663 BUF_MEM *init_buf; /* buffer used during init */
3664 uint8_t *init_msg; /* pointer to handshake message body, set by
3665 ssl3_get_message() */
3666 int init_num; /* amount read/written */
3667 int init_off; /* amount read/written */
3668
3669 struct ssl3_state_st *s3; /* SSLv3 variables */
3670 struct dtls1_state_st *d1; /* DTLSv1 variables */
3671
3672 /* callback that allows applications to peek at protocol messages */
3673 void (*msg_callback)(int write_p, int version, int content_type,
3674 const void *buf, size_t len, SSL *ssl, void *arg);
3675 void *msg_callback_arg;
3676
3677 int hit; /* reusing a previous session */
3678
3679 X509_VERIFY_PARAM *param;
3680
3681 /* crypto */
3682 struct ssl_cipher_preference_list_st *cipher_list;
3683 STACK_OF(SSL_CIPHER) *cipher_list_by_id;
3684
3685 SSL_AEAD_CTX *aead_read_ctx;
3686 SSL_AEAD_CTX *aead_write_ctx;
3687
3688 /* session info */
3689
3690 /* client cert? */
3691 /* This is used to hold the server certificate used */
3692 struct cert_st /* CERT */ *cert;
3693
3694 /* the session_id_context is used to ensure sessions are only reused
3695 * in the appropriate context */
3696 unsigned int sid_ctx_length;
3697 uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH];
3698
3699 /* This can also be in the session once a session is established */
3700 SSL_SESSION *session;
3701
3702 /* Default generate session ID callback. */
3703 GEN_SESSION_CB generate_session_id;
3704
3705 /* Used in SSL2 and SSL3 */
3706 int verify_mode; /* 0 don't care about verify failure.
3707 * 1 fail if verify fails */
3708 int (*verify_callback)(int ok,
3709 X509_STORE_CTX *ctx); /* fail if callback returns 0 */
3710
3711 void (*info_callback)(const SSL *ssl, int type,
3712 int val); /* optional informational callback */
3713
3714 /* Server-only: psk_identity_hint is the identity hint to send in
3715 * PSK-based key exchanges. */
3716 char *psk_identity_hint;
3717
3718 unsigned int (*psk_client_callback)(SSL *ssl, const char *hint,
3719 char *identity,
3720 unsigned int max_identity_len,
3721 uint8_t *psk, unsigned int max_psk_len);
3722 unsigned int (*psk_server_callback)(SSL *ssl, const char *identity,
3723 uint8_t *psk, unsigned int max_psk_len);
3724
3725 SSL_CTX *ctx;
3726
3727 /* extra application data */
3728 long verify_result;
3729 CRYPTO_EX_DATA ex_data;
3730
3731 /* for server side, keep the list of CA_dn we can use */
3732 STACK_OF(X509_NAME) *client_CA;
3733
3734 uint32_t options; /* protocol behaviour */
3735 uint32_t mode; /* API behaviour */
3736 uint32_t max_cert_list;
3737 int client_version; /* what was passed, used for
3738 * SSLv3/TLS rollback check */
3739 uint16_t max_send_fragment;
3740 char *tlsext_hostname;
3741 /* RFC4507 session ticket expected to be received or sent */
3742 int tlsext_ticket_expected;
3743 size_t tlsext_ellipticcurvelist_length;
3744 uint16_t *tlsext_ellipticcurvelist; /* our list */
3745
3746 SSL_CTX *initial_ctx; /* initial ctx, used to store sessions */
3747
3748 /* Next protocol negotiation. For the client, this is the protocol that we
3749 * sent in NextProtocol and is set when handling ServerHello extensions.
3750 *
3751 * For a server, this is the client's selected_protocol from NextProtocol and
3752 * is set when handling the NextProtocol message, before the Finished
3753 * message. */
3754 uint8_t *next_proto_negotiated;
3755 size_t next_proto_negotiated_len;
3756
3757 /* srtp_profiles is the list of configured SRTP protection profiles for
3758 * DTLS-SRTP. */
3759 STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
3760
3761 /* srtp_profile is the selected SRTP protection profile for
3762 * DTLS-SRTP. */
3763 const SRTP_PROTECTION_PROFILE *srtp_profile;
3764
3765 /* Copied from the SSL_CTX. For a server, means that we'll accept Channel IDs
3766 * from clients. For a client, means that we'll advertise support. */
3767 char tlsext_channel_id_enabled;
3768 /* The client's Channel ID private key. */
3769 EVP_PKEY *tlsext_channel_id_private;
3770
3771 /* Enable signed certificate time stamps. Currently client only. */
3772 char signed_cert_timestamps_enabled;
3773
3774 /* ocsp_stapling_enabled is only used by client connections and indicates
3775 * whether OCSP stapling will be requested. */
3776 char ocsp_stapling_enabled;
3777
3778 /* For a client, this contains the list of supported protocols in wire
3779 * format. */
3780 uint8_t *alpn_client_proto_list;
3781 unsigned alpn_client_proto_list_len;
3782
David Benjamin1d5ef3b2015-10-12 19:54:18 -04003783 /* renegotiate_mode controls how peer renegotiation attempts are handled. */
3784 enum ssl_renegotiate_mode_t renegotiate_mode;
David Benjamin79c117a2015-09-13 13:53:19 -04003785
3786 /* These fields are always NULL and exist only to keep wpa_supplicant happy
3787 * about the change to EVP_AEAD. They are only needed for EAP-FAST, which we
3788 * don't support. */
3789 EVP_CIPHER_CTX *enc_read_ctx;
3790 EVP_MD_CTX *read_hash;
3791};
3792
David Benjamind5635d42015-10-17 19:45:00 -04003793typedef struct ssl3_record_st {
3794 /* type is the record type. */
3795 uint8_t type;
3796 /* length is the number of unconsumed bytes of |data|. */
3797 uint16_t length;
3798 /* off is the number of consumed bytes of |data|. */
3799 uint16_t off;
3800 /* data is a non-owning pointer to the record contents. The total length of
3801 * the buffer is |off| + |length|. */
3802 uint8_t *data;
3803} SSL3_RECORD;
3804
3805typedef struct ssl3_buffer_st {
3806 /* buf is the memory allocated for this buffer. */
3807 uint8_t *buf;
3808 /* offset is the offset into |buf| which the buffer contents start at. */
3809 uint16_t offset;
3810 /* len is the length of the buffer contents from |buf| + |offset|. */
3811 uint16_t len;
3812 /* cap is how much memory beyond |buf| + |offset| is available. */
3813 uint16_t cap;
3814} SSL3_BUFFER;
3815
3816/* TODO(davidben): This flag can probably be merged into s3->change_cipher_spec
3817 * to something tri-state. (Normal / Expect CCS / Between CCS and Finished). */
3818#define SSL3_FLAGS_EXPECT_CCS 0x0080
3819
3820typedef struct ssl3_state_st {
3821 long flags;
3822
3823 uint8_t read_sequence[8];
3824 int read_mac_secret_size;
3825 uint8_t read_mac_secret[EVP_MAX_MD_SIZE];
3826 uint8_t write_sequence[8];
3827 int write_mac_secret_size;
3828 uint8_t write_mac_secret[EVP_MAX_MD_SIZE];
3829
3830 uint8_t server_random[SSL3_RANDOM_SIZE];
3831 uint8_t client_random[SSL3_RANDOM_SIZE];
3832
3833 /* flags for countermeasure against known-IV weakness */
3834 int need_record_splitting;
3835
3836 /* have_version is true if the connection's final version is known. Otherwise
3837 * the version has not been negotiated yet. */
3838 char have_version;
3839
3840 /* initial_handshake_complete is true if the initial handshake has
3841 * completed. */
3842 char initial_handshake_complete;
3843
3844 /* read_buffer holds data from the transport to be processed. */
3845 SSL3_BUFFER read_buffer;
3846 /* write_buffer holds data to be written to the transport. */
3847 SSL3_BUFFER write_buffer;
3848
3849 SSL3_RECORD rrec; /* each decoded record goes in here */
3850
3851 /* storage for Handshake protocol data received but not yet processed by
3852 * ssl3_read_bytes: */
3853 uint8_t handshake_fragment[4];
3854 unsigned int handshake_fragment_len;
3855
3856 /* partial write - check the numbers match */
3857 unsigned int wnum; /* number of bytes sent so far */
3858 int wpend_tot; /* number bytes written */
3859 int wpend_type;
3860 int wpend_ret; /* number of bytes submitted */
3861 const uint8_t *wpend_buf;
3862
3863 /* handshake_buffer, if non-NULL, contains the handshake transcript. */
3864 BUF_MEM *handshake_buffer;
3865 /* handshake_hash, if initialized with an |EVP_MD|, maintains the handshake
3866 * hash. For TLS 1.1 and below, it is the SHA-1 half. */
3867 EVP_MD_CTX handshake_hash;
3868 /* handshake_md5, if initialized with an |EVP_MD|, maintains the MD5 half of
3869 * the handshake hash for TLS 1.1 and below. */
3870 EVP_MD_CTX handshake_md5;
3871
3872 /* this is set whenerver we see a change_cipher_spec message come in when we
3873 * are not looking for one */
3874 int change_cipher_spec;
3875
3876 int warn_alert;
3877 int fatal_alert;
3878 /* we allow one fatal and one warning alert to be outstanding, send close
3879 * alert via the warning alert */
3880 int alert_dispatch;
3881 uint8_t send_alert[2];
3882
3883 int total_renegotiations;
3884
3885 /* empty_record_count is the number of consecutive empty records received. */
3886 uint8_t empty_record_count;
3887
3888 /* warning_alert_count is the number of consecutive warning alerts
3889 * received. */
3890 uint8_t warning_alert_count;
3891
3892 /* State pertaining to the pending handshake.
3893 *
3894 * TODO(davidben): State is current spread all over the place. Move
3895 * pending handshake state here so it can be managed separately from
3896 * established connection state in case of renegotiations. */
3897 struct {
3898 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
3899 uint8_t finish_md[EVP_MAX_MD_SIZE * 2];
3900 int finish_md_len;
3901 uint8_t peer_finish_md[EVP_MAX_MD_SIZE * 2];
3902 int peer_finish_md_len;
3903
3904 unsigned long message_size;
3905 int message_type;
3906
3907 /* used to hold the new cipher we are going to use */
3908 const SSL_CIPHER *new_cipher;
3909 DH *dh;
3910
3911 EC_KEY *ecdh; /* holds short lived ECDH key */
3912
3913 /* used when SSL_ST_FLUSH_DATA is entered */
3914 int next_state;
3915
3916 int reuse_message;
3917
3918 union {
3919 /* sent is a bitset where the bits correspond to elements of kExtensions
3920 * in t1_lib.c. Each bit is set if that extension was sent in a
3921 * ClientHello. It's not used by servers. */
3922 uint32_t sent;
3923 /* received is a bitset, like |sent|, but is used by servers to record
3924 * which extensions were received from a client. */
3925 uint32_t received;
3926 } extensions;
3927
3928 union {
3929 /* sent is a bitset where the bits correspond to elements of
3930 * |client_custom_extensions| in the |SSL_CTX|. Each bit is set if that
3931 * extension was sent in a ClientHello. It's not used by servers. */
3932 uint16_t sent;
3933 /* received is a bitset, like |sent|, but is used by servers to record
3934 * which custom extensions were received from a client. The bits here
3935 * correspond to |server_custom_extensions|. */
3936 uint16_t received;
3937 } custom_extensions;
3938
3939 /* SNI extension */
3940
3941 /* should_ack_sni is used by a server and indicates that the SNI extension
3942 * should be echoed in the ServerHello. */
3943 unsigned should_ack_sni:1;
3944
3945
3946 /* Client-only: cert_req determines if a client certificate is to be sent.
3947 * This is 0 if no client Certificate message is to be sent, 1 if there is
3948 * a client certificate, and 2 to send an empty client Certificate
3949 * message. */
3950 int cert_req;
3951
3952 /* Client-only: ca_names contains the list of CAs received in a
3953 * CertificateRequest message. */
3954 STACK_OF(X509_NAME) *ca_names;
3955
3956 /* Client-only: certificate_types contains the set of certificate types
3957 * received in a CertificateRequest message. */
3958 uint8_t *certificate_types;
3959 size_t num_certificate_types;
3960
3961 int key_block_length;
3962 uint8_t *key_block;
3963
3964 const EVP_AEAD *new_aead;
3965 uint8_t new_mac_secret_len;
3966 uint8_t new_fixed_iv_len;
3967 uint8_t new_variable_iv_len;
3968
3969 /* Server-only: cert_request is true if a client certificate was
3970 * requested. */
3971 int cert_request;
3972
3973 /* certificate_status_expected is true if OCSP stapling was negotiated and
3974 * the server is expected to send a CertificateStatus message. (This is
3975 * used on both the client and server sides.) */
3976 unsigned certificate_status_expected:1;
3977
3978 /* ocsp_stapling_requested is true if a client requested OCSP stapling. */
3979 unsigned ocsp_stapling_requested:1;
3980
3981 /* Server-only: peer_ellipticcurvelist contains the EC curve IDs advertised
3982 * by the peer. This is only set on the server's end. The server does not
3983 * advertise this extension to the client. */
3984 uint16_t *peer_ellipticcurvelist;
3985 size_t peer_ellipticcurvelist_length;
3986
3987 /* extended_master_secret indicates whether the extended master secret
3988 * computation is used in this handshake. Note that this is different from
3989 * whether it was used for the current session. If this is a resumption
3990 * handshake then EMS might be negotiated in the client and server hello
3991 * messages, but it doesn't matter if the session that's being resumed
3992 * didn't use it to create the master secret initially. */
3993 char extended_master_secret;
3994
3995 /* Client-only: peer_psk_identity_hint is the psk_identity_hint sent by the
3996 * server when using a PSK key exchange. */
3997 char *peer_psk_identity_hint;
3998
3999 /* new_mac_secret_size is unused and exists only until wpa_supplicant can
4000 * be updated. It is only needed for EAP-FAST, which we don't support. */
4001 uint8_t new_mac_secret_size;
4002
4003 /* Client-only: in_false_start is one if there is a pending handshake in
4004 * False Start. The client may write data at this point. */
4005 char in_false_start;
4006
4007 /* peer_dh_tmp, on a client, is the server's DHE public key. */
4008 DH *peer_dh_tmp;
4009
4010 /* peer_ecdh_tmp, on a client, is the server's ECDHE public key. */
4011 EC_KEY *peer_ecdh_tmp;
4012 } tmp;
4013
4014 /* Connection binding to prevent renegotiation attacks */
4015 uint8_t previous_client_finished[EVP_MAX_MD_SIZE];
4016 uint8_t previous_client_finished_len;
4017 uint8_t previous_server_finished[EVP_MAX_MD_SIZE];
4018 uint8_t previous_server_finished_len;
4019 int send_connection_binding; /* TODOEKR */
4020
4021 /* Set if we saw the Next Protocol Negotiation extension from our peer. */
4022 int next_proto_neg_seen;
4023
4024 /* ALPN information
4025 * (we are in the process of transitioning from NPN to ALPN.) */
4026
4027 /* In a server these point to the selected ALPN protocol after the
4028 * ClientHello has been processed. In a client these contain the protocol
4029 * that the server selected once the ServerHello has been processed. */
4030 uint8_t *alpn_selected;
4031 size_t alpn_selected_len;
4032
4033 /* In a client, this means that the server supported Channel ID and that a
4034 * Channel ID was sent. In a server it means that we echoed support for
4035 * Channel IDs and that tlsext_channel_id will be valid after the
4036 * handshake. */
4037 char tlsext_channel_id_valid;
4038 /* For a server:
4039 * If |tlsext_channel_id_valid| is true, then this contains the
4040 * verified Channel ID from the client: a P256 point, (x,y), where
4041 * each are big-endian values. */
4042 uint8_t tlsext_channel_id[64];
4043} SSL3_STATE;
4044
David Benjamin79c117a2015-09-13 13:53:19 -04004045
Adam Langley7cc3f992015-01-07 15:06:31 -08004046/* Android compatibility section.
4047 *
4048 * These functions are declared, temporarily, for Android because
4049 * wpa_supplicant will take a little time to sync with upstream. Outside of
4050 * Android they'll have no definition. */
4051
4052#define SSL_F_SSL_SET_SESSION_TICKET_EXT doesnt_exist
4053
Adam Langleyb4a494c2015-01-23 15:10:10 -08004054OPENSSL_EXPORT int SSL_set_session_ticket_ext(SSL *s, void *ext_data,
4055 int ext_len);
Adam Langley7cc3f992015-01-07 15:06:31 -08004056OPENSSL_EXPORT int SSL_set_session_secret_cb(SSL *s, void *cb, void *arg);
4057OPENSSL_EXPORT int SSL_set_session_ticket_ext_cb(SSL *s, void *cb, void *arg);
Adam Langley32156b92015-03-20 11:49:44 -07004058OPENSSL_EXPORT int SSL_set_ssl_method(SSL *s, const SSL_METHOD *method);
4059
4060#define OPENSSL_VERSION_TEXT "BoringSSL"
4061
4062#define SSLEAY_VERSION 0
4063
4064/* SSLeay_version is a compatibility function that returns the string
4065 * "BoringSSL". */
4066OPENSSL_EXPORT const char *SSLeay_version(int unused);
Adam Langley7cc3f992015-01-07 15:06:31 -08004067
4068
David Benjamin59015c32015-04-26 13:13:55 -04004069/* Preprocessor compatibility section.
4070 *
4071 * Historically, a number of APIs were implemented in OpenSSL as macros and
4072 * constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this
David Benjamincb3872f2015-06-16 13:20:36 -04004073 * section defines a number of legacy macros.
4074 *
4075 * Although using either the CTRL values or their wrapper macros in #ifdefs is
4076 * still supported, the CTRL values may not be passed to |SSL_ctrl| and
4077 * |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. */
David Benjamin59015c32015-04-26 13:13:55 -04004078
David Benjamincb3872f2015-06-16 13:20:36 -04004079#define DTLS_CTRL_GET_TIMEOUT doesnt_exist
4080#define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04004081#define SSL_CTRL_CHAIN doesnt_exist
4082#define SSL_CTRL_CHAIN_CERT doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004083#define SSL_CTRL_CHANNEL_ID doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04004084#define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004085#define SSL_CTRL_CLEAR_MODE doesnt_exist
4086#define SSL_CTRL_CLEAR_OPTIONS doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04004087#define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist
4088#define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004089#define SSL_CTRL_GET_CHANNEL_ID doesnt_exist
David Benjamin75910642015-08-09 10:42:33 -04004090#define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist
David Benjamin11c0f8e2015-07-06 00:18:15 -04004091#define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004092#define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04004093#define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004094#define SSL_CTRL_GET_READ_AHEAD doesnt_exist
4095#define SSL_CTRL_GET_RI_SUPPORT doesnt_exist
4096#define SSL_CTRL_GET_SESSION_REUSED doesnt_exist
4097#define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist
4098#define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04004099#define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjaminc0454692015-04-27 00:28:56 -04004100#define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004101#define SSL_CTRL_MODE doesnt_exist
4102#define SSL_CTRL_NEED_TMP_RSA doesnt_exist
4103#define SSL_CTRL_OPTIONS doesnt_exist
4104#define SSL_CTRL_SESS_NUMBER doesnt_exist
4105#define SSL_CTRL_SET_CHANNEL_ID doesnt_exist
David Benjaminfdb4cdd2015-08-09 11:13:23 -04004106#define SSL_CTRL_SET_CURVES doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004107#define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist
4108#define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04004109#define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04004110#define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist
David Benjamincb9cf792015-05-05 09:46:14 -04004111#define SSL_CTRL_SET_MTU doesnt_exist
David Benjamin61ecccf2015-05-05 09:44:51 -04004112#define SSL_CTRL_SET_READ_AHEAD doesnt_exist
David Benjamin71f7d3d2015-05-05 09:46:38 -04004113#define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004114#define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist
David Benjamin7133d422015-04-28 00:43:39 -04004115#define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004116#define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist
4117#define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist
David Benjamin6cacac02015-06-16 13:29:54 -04004118#define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04004119#define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist
David Benjamincb3872f2015-06-16 13:20:36 -04004120#define SSL_CTRL_SET_TMP_DH doesnt_exist
4121#define SSL_CTRL_SET_TMP_DH_CB doesnt_exist
4122#define SSL_CTRL_SET_TMP_ECDH doesnt_exist
4123#define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist
4124#define SSL_CTRL_SET_TMP_RSA doesnt_exist
4125#define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist
David Benjamin59015c32015-04-26 13:13:55 -04004126
David Benjamin8c249802015-05-05 09:44:18 -04004127#define DTLSv1_get_timeout DTLSv1_get_timeout
4128#define DTLSv1_handle_timeout DTLSv1_handle_timeout
David Benjamin11c0f8e2015-07-06 00:18:15 -04004129#define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert
4130#define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert
4131#define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert
4132#define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs
4133#define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04004134#define SSL_CTX_clear_mode SSL_CTX_clear_mode
4135#define SSL_CTX_clear_options SSL_CTX_clear_options
4136#define SSL_CTX_enable_tls_channel_id SSL_CTX_enable_tls_channel_id
David Benjamin11c0f8e2015-07-06 00:18:15 -04004137#define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs
4138#define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04004139#define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list
4140#define SSL_CTX_get_mode SSL_CTX_get_mode
4141#define SSL_CTX_get_options SSL_CTX_get_options
4142#define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead
4143#define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode
David Benjamin6cacac02015-06-16 13:29:54 -04004144#define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04004145#define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA
4146#define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size
4147#define SSL_CTX_sess_number SSL_CTX_sess_number
4148#define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size
David Benjamin11c0f8e2015-07-06 00:18:15 -04004149#define SSL_CTX_set0_chain SSL_CTX_set0_chain
4150#define SSL_CTX_set1_chain SSL_CTX_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04004151#define SSL_CTX_set1_curves SSL_CTX_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04004152#define SSL_CTX_set1_tls_channel_id SSL_CTX_set1_tls_channel_id
4153#define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list
4154#define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment
4155#define SSL_CTX_set_mode SSL_CTX_set_mode
4156#define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg
4157#define SSL_CTX_set_options SSL_CTX_set_options
4158#define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead
4159#define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode
4160#define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg
4161#define SSL_CTX_set_tlsext_servername_callback \
4162 SSL_CTX_set_tlsext_servername_callback
4163#define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb
David Benjamin6cacac02015-06-16 13:29:54 -04004164#define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys
David Benjamincb3872f2015-06-16 13:20:36 -04004165#define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh
4166#define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh
4167#define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa
David Benjamin11c0f8e2015-07-06 00:18:15 -04004168#define SSL_add0_chain_cert SSL_add0_chain_cert
4169#define SSL_add1_chain_cert SSL_add1_chain_cert
4170#define SSL_clear_chain_certs SSL_clear_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04004171#define SSL_clear_mode SSL_clear_mode
4172#define SSL_clear_options SSL_clear_options
4173#define SSL_enable_tls_channel_id SSL_enable_tls_channel_id
David Benjamin75910642015-08-09 10:42:33 -04004174#define SSL_get0_certificate_types SSL_get0_certificate_types
David Benjamin11c0f8e2015-07-06 00:18:15 -04004175#define SSL_get0_chain_certs SSL_get0_chain_certs
David Benjamincb3872f2015-06-16 13:20:36 -04004176#define SSL_get_max_cert_list SSL_get_max_cert_list
4177#define SSL_get_mode SSL_get_mode
4178#define SSL_get_options SSL_get_options
David Benjamincb9cf792015-05-05 09:46:14 -04004179#define SSL_get_secure_renegotiation_support \
4180 SSL_get_secure_renegotiation_support
David Benjaminc2807582015-04-28 00:19:50 -04004181#define SSL_get_tls_channel_id SSL_get_tls_channel_id
David Benjamincb3872f2015-06-16 13:20:36 -04004182#define SSL_need_tmp_RSA SSL_need_tmp_RSA
4183#define SSL_num_renegotiations SSL_num_renegotiations
4184#define SSL_session_reused SSL_session_reused
David Benjamin11c0f8e2015-07-06 00:18:15 -04004185#define SSL_set0_chain SSL_set0_chain
4186#define SSL_set1_chain SSL_set1_chain
David Benjaminfdb4cdd2015-08-09 11:13:23 -04004187#define SSL_set1_curves SSL_set1_curves
David Benjamincb3872f2015-06-16 13:20:36 -04004188#define SSL_set1_tls_channel_id SSL_set1_tls_channel_id
4189#define SSL_set_max_cert_list SSL_set_max_cert_list
4190#define SSL_set_max_send_fragment SSL_set_max_send_fragment
4191#define SSL_set_mode SSL_set_mode
4192#define SSL_set_msg_callback_arg SSL_set_msg_callback_arg
4193#define SSL_set_mtu SSL_set_mtu
4194#define SSL_set_options SSL_set_options
4195#define SSL_set_tlsext_host_name SSL_set_tlsext_host_name
4196#define SSL_set_tmp_dh SSL_set_tmp_dh
4197#define SSL_set_tmp_ecdh SSL_set_tmp_ecdh
4198#define SSL_set_tmp_rsa SSL_set_tmp_rsa
4199#define SSL_total_renegotiations SSL_total_renegotiations
David Benjamin59015c32015-04-26 13:13:55 -04004200
4201
David Benjamin087e4fa2015-04-08 23:46:10 -04004202#if defined(__cplusplus)
4203} /* extern C */
Adam Langley95c29f32014-06-20 12:00:00 -07004204#endif
David Benjamin2e521212014-07-16 14:37:51 -04004205
David Benjamin689be0f2015-02-11 15:55:26 -05004206#define SSL_R_APP_DATA_IN_HANDSHAKE 100
4207#define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101
4208#define SSL_R_BAD_ALERT 102
4209#define SSL_R_BAD_CHANGE_CIPHER_SPEC 103
4210#define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104
4211#define SSL_R_BAD_DH_P_LENGTH 105
4212#define SSL_R_BAD_DIGEST_LENGTH 106
4213#define SSL_R_BAD_ECC_CERT 107
4214#define SSL_R_BAD_ECPOINT 108
4215#define SSL_R_BAD_HANDSHAKE_LENGTH 109
4216#define SSL_R_BAD_HANDSHAKE_RECORD 110
Adam Langley95c29f32014-06-20 12:00:00 -07004217#define SSL_R_BAD_HELLO_REQUEST 111
David Benjamin689be0f2015-02-11 15:55:26 -05004218#define SSL_R_BAD_LENGTH 112
4219#define SSL_R_BAD_PACKET_LENGTH 113
4220#define SSL_R_BAD_RSA_ENCRYPT 114
4221#define SSL_R_BAD_SIGNATURE 115
4222#define SSL_R_BAD_SRTP_MKI_VALUE 116
4223#define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 117
4224#define SSL_R_BAD_SSL_FILETYPE 118
4225#define SSL_R_BAD_WRITE_RETRY 119
4226#define SSL_R_BIO_NOT_SET 120
4227#define SSL_R_BN_LIB 121
4228#define SSL_R_CANNOT_SERIALIZE_PUBLIC_KEY 122
4229#define SSL_R_CA_DN_LENGTH_MISMATCH 123
4230#define SSL_R_CA_DN_TOO_LONG 124
4231#define SSL_R_CCS_RECEIVED_EARLY 125
4232#define SSL_R_CERTIFICATE_VERIFY_FAILED 126
4233#define SSL_R_CERT_CB_ERROR 127
4234#define SSL_R_CERT_LENGTH_MISMATCH 128
4235#define SSL_R_CHANNEL_ID_NOT_P256 129
4236#define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 130
4237#define SSL_R_CIPHER_CODE_WRONG_LENGTH 131
4238#define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 132
4239#define SSL_R_CLIENTHELLO_PARSE_FAILED 133
4240#define SSL_R_CLIENTHELLO_TLSEXT 134
4241#define SSL_R_CONNECTION_REJECTED 135
4242#define SSL_R_CONNECTION_TYPE_NOT_SET 136
4243#define SSL_R_COOKIE_MISMATCH 137
4244#define SSL_R_D2I_ECDSA_SIG 138
4245#define SSL_R_DATA_BETWEEN_CCS_AND_FINISHED 139
4246#define SSL_R_DATA_LENGTH_TOO_LONG 140
4247#define SSL_R_DECODE_ERROR 141
4248#define SSL_R_DECRYPTION_FAILED 142
4249#define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 143
4250#define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 144
4251#define SSL_R_DIGEST_CHECK_FAILED 145
4252#define SSL_R_DTLS_MESSAGE_TOO_BIG 146
4253#define SSL_R_ECC_CERT_NOT_FOR_SIGNING 147
4254#define SSL_R_EMPTY_SRTP_PROTECTION_PROFILE_LIST 148
4255#define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 149
4256#define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 150
4257#define SSL_R_EVP_DIGESTSIGNFINAL_FAILED 151
4258#define SSL_R_EVP_DIGESTSIGNINIT_FAILED 152
4259#define SSL_R_EXCESSIVE_MESSAGE_SIZE 153
4260#define SSL_R_EXTRA_DATA_IN_MESSAGE 154
4261#define SSL_R_GOT_A_FIN_BEFORE_A_CCS 155
4262#define SSL_R_GOT_CHANNEL_ID_BEFORE_A_CCS 156
4263#define SSL_R_GOT_NEXT_PROTO_BEFORE_A_CCS 157
4264#define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 158
4265#define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 159
4266#define SSL_R_HANDSHAKE_RECORD_BEFORE_CCS 160
4267#define SSL_R_HTTPS_PROXY_REQUEST 161
4268#define SSL_R_HTTP_REQUEST 162
4269#define SSL_R_INAPPROPRIATE_FALLBACK 163
4270#define SSL_R_INVALID_COMMAND 164
4271#define SSL_R_INVALID_MESSAGE 165
4272#define SSL_R_INVALID_SSL_SESSION 166
4273#define SSL_R_INVALID_TICKET_KEYS_LENGTH 167
4274#define SSL_R_LENGTH_MISMATCH 168
4275#define SSL_R_LIBRARY_HAS_NO_CIPHERS 169
4276#define SSL_R_MISSING_DH_KEY 170
4277#define SSL_R_MISSING_ECDSA_SIGNING_CERT 171
4278#define SSL_R_MISSING_RSA_CERTIFICATE 172
4279#define SSL_R_MISSING_RSA_ENCRYPTING_CERT 173
4280#define SSL_R_MISSING_RSA_SIGNING_CERT 174
4281#define SSL_R_MISSING_TMP_DH_KEY 175
4282#define SSL_R_MISSING_TMP_ECDH_KEY 176
4283#define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 177
4284#define SSL_R_MTU_TOO_SMALL 178
4285#define SSL_R_NESTED_GROUP 179
4286#define SSL_R_NO_CERTIFICATES_RETURNED 180
4287#define SSL_R_NO_CERTIFICATE_ASSIGNED 181
4288#define SSL_R_NO_CERTIFICATE_SET 182
4289#define SSL_R_NO_CIPHERS_AVAILABLE 183
4290#define SSL_R_NO_CIPHERS_PASSED 184
4291#define SSL_R_NO_CIPHERS_SPECIFIED 185
4292#define SSL_R_NO_CIPHER_MATCH 186
4293#define SSL_R_NO_COMPRESSION_SPECIFIED 187
4294#define SSL_R_NO_METHOD_SPECIFIED 188
4295#define SSL_R_NO_P256_SUPPORT 189
4296#define SSL_R_NO_PRIVATE_KEY_ASSIGNED 190
4297#define SSL_R_NO_RENEGOTIATION 191
4298#define SSL_R_NO_REQUIRED_DIGEST 192
4299#define SSL_R_NO_SHARED_CIPHER 193
4300#define SSL_R_NO_SHARED_SIGATURE_ALGORITHMS 194
4301#define SSL_R_NO_SRTP_PROFILES 195
4302#define SSL_R_NULL_SSL_CTX 196
4303#define SSL_R_NULL_SSL_METHOD_PASSED 197
4304#define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 198
4305#define SSL_R_PACKET_LENGTH_TOO_LONG 199
4306#define SSL_R_PARSE_TLSEXT 200
4307#define SSL_R_PATH_TOO_LONG 201
4308#define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 202
4309#define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 203
4310#define SSL_R_PROTOCOL_IS_SHUTDOWN 204
4311#define SSL_R_PSK_IDENTITY_NOT_FOUND 205
4312#define SSL_R_PSK_NO_CLIENT_CB 206
4313#define SSL_R_PSK_NO_SERVER_CB 207
4314#define SSL_R_READ_BIO_NOT_SET 208
4315#define SSL_R_READ_TIMEOUT_EXPIRED 209
4316#define SSL_R_RECORD_LENGTH_MISMATCH 210
4317#define SSL_R_RECORD_TOO_LARGE 211
4318#define SSL_R_RENEGOTIATE_EXT_TOO_LONG 212
4319#define SSL_R_RENEGOTIATION_ENCODING_ERR 213
4320#define SSL_R_RENEGOTIATION_MISMATCH 214
4321#define SSL_R_REQUIRED_CIPHER_MISSING 215
4322#define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 216
4323#define SSL_R_SERVERHELLO_TLSEXT 217
4324#define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 218
4325#define SSL_R_SESSION_MAY_NOT_BE_CREATED 219
4326#define SSL_R_SIGNATURE_ALGORITHMS_ERROR 220
4327#define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 221
4328#define SSL_R_SRTP_PROTECTION_PROFILE_LIST_TOO_LONG 222
4329#define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 223
4330#define SSL_R_SSL3_EXT_INVALID_SERVERNAME 224
4331#define SSL_R_SSL3_EXT_INVALID_SERVERNAME_TYPE 225
4332#define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 226
4333#define SSL_R_SSL_HANDSHAKE_FAILURE 227
4334#define SSL_R_SSL_SESSION_ID_CALLBACK_FAILED 228
4335#define SSL_R_SSL_SESSION_ID_CONFLICT 229
4336#define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 230
4337#define SSL_R_SSL_SESSION_ID_HAS_BAD_LENGTH 231
4338#define SSL_R_TLS_CLIENT_CERT_REQ_WITH_ANON_CIPHER 232
4339#define SSL_R_TLS_ILLEGAL_EXPORTER_LABEL 233
4340#define SSL_R_TLS_INVALID_ECPOINTFORMAT_LIST 234
4341#define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 235
4342#define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 236
4343#define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 237
4344#define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 238
4345#define SSL_R_UNABLE_TO_FIND_PUBLIC_KEY_PARAMETERS 239
4346#define SSL_R_UNEXPECTED_GROUP_CLOSE 240
4347#define SSL_R_UNEXPECTED_MESSAGE 241
4348#define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 242
4349#define SSL_R_UNEXPECTED_RECORD 243
4350#define SSL_R_UNINITIALIZED 244
4351#define SSL_R_UNKNOWN_ALERT_TYPE 245
4352#define SSL_R_UNKNOWN_CERTIFICATE_TYPE 246
4353#define SSL_R_UNKNOWN_CIPHER_RETURNED 247
4354#define SSL_R_UNKNOWN_CIPHER_TYPE 248
4355#define SSL_R_UNKNOWN_DIGEST 249
4356#define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 250
4357#define SSL_R_UNKNOWN_PROTOCOL 251
4358#define SSL_R_UNKNOWN_SSL_VERSION 252
4359#define SSL_R_UNKNOWN_STATE 253
4360#define SSL_R_UNPROCESSED_HANDSHAKE_DATA 254
4361#define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 255
4362#define SSL_R_UNSUPPORTED_CIPHER 256
4363#define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 257
4364#define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 258
4365#define SSL_R_UNSUPPORTED_PROTOCOL 259
4366#define SSL_R_UNSUPPORTED_SSL_VERSION 260
4367#define SSL_R_USE_SRTP_NOT_NEGOTIATED 261
Adam Langley1258b6a2014-06-20 12:00:00 -07004368#define SSL_R_WRONG_CERTIFICATE_TYPE 262
David Benjamin689be0f2015-02-11 15:55:26 -05004369#define SSL_R_WRONG_CIPHER_RETURNED 263
4370#define SSL_R_WRONG_CURVE 264
4371#define SSL_R_WRONG_MESSAGE_TYPE 265
4372#define SSL_R_WRONG_SIGNATURE_TYPE 266
4373#define SSL_R_WRONG_SSL_VERSION 267
4374#define SSL_R_WRONG_VERSION_NUMBER 268
4375#define SSL_R_X509_LIB 269
4376#define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 270
David Benjamin75381222015-03-02 19:30:30 -05004377#define SSL_R_FRAGMENT_MISMATCH 271
David Benjamin9faafda2015-04-04 19:23:10 -04004378#define SSL_R_BUFFER_TOO_SMALL 272
David Benjaminece3de92015-03-16 18:02:20 -04004379#define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 273
David Benjamin31a07792015-03-03 14:20:26 -05004380#define SSL_R_OUTPUT_ALIASES_INPUT 274
Adam Langleyba5934b2015-06-02 10:50:35 -07004381#define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 275
4382#define SSL_R_EMS_STATE_INCONSISTENT 276
4383#define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 277
David Benjamin24f346d2015-06-06 03:28:08 -04004384#define SSL_R_TOO_MANY_WARNING_ALERTS 278
Adam Langley614c66a2015-06-12 15:26:58 -07004385#define SSL_R_UNEXPECTED_EXTENSION 279
Adam Langley2e857bd2015-07-01 16:09:19 -07004386#define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 280
Adam Langley33ad2b52015-07-20 17:43:53 -07004387#define SSL_R_ERROR_ADDING_EXTENSION 281
4388#define SSL_R_ERROR_PARSING_EXTENSION 282
4389#define SSL_R_MISSING_EXTENSION 283
Adam Langley09505632015-07-30 18:10:13 -07004390#define SSL_R_CUSTOM_EXTENSION_CONTENTS_TOO_LARGE 284
4391#define SSL_R_CUSTOM_EXTENSION_ERROR 285
David Benjamin76c2efc2015-08-31 14:24:29 -04004392#define SSL_R_NEGOTIATED_BOTH_NPN_AND_ALPN 286
David Benjamind7c53682014-09-17 12:08:13 -04004393#define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000
David Benjamin2e521212014-07-16 14:37:51 -04004394#define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010
4395#define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020
4396#define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021
4397#define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022
4398#define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030
4399#define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040
4400#define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041
4401#define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042
4402#define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043
4403#define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044
4404#define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045
4405#define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046
4406#define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047
4407#define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048
4408#define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049
4409#define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050
4410#define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051
4411#define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060
4412#define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070
4413#define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071
4414#define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080
David Benjamind7c53682014-09-17 12:08:13 -04004415#define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086
David Benjamin2e521212014-07-16 14:37:51 -04004416#define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090
4417#define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100
4418#define SSL_R_TLSV1_UNSUPPORTED_EXTENSION 1110
4419#define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE 1111
4420#define SSL_R_TLSV1_UNRECOGNIZED_NAME 1112
4421#define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE 1113
4422#define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE 1114
Adam Langley95c29f32014-06-20 12:00:00 -07004423
David Benjamin087e4fa2015-04-08 23:46:10 -04004424#endif /* OPENSSL_HEADER_SSL_H */