1 /* 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. 7 * 8 * 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). 14 * 15 * 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. 21 * 22 * 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 :-). 36 * 4. If you include any Windows specific code (or a derivative thereof) from 37 * the apps directory (application code) you must include an acknowledgement: 38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 39 * 40 * 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. 51 * 52 * 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 65 * notice, this list of conditions and the following disclaimer. 66 * 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. 112 * ECC cipher suite support in OpenSSL originally developed by 113 * 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 142 #ifndef OPENSSL_HEADER_SSL_H 143 #define OPENSSL_HEADER_SSL_H 144 145 #include <openssl/base.h> 146 147 #include <openssl/bio.h> 148 #include <openssl/buf.h> 149 #include <openssl/pem.h> 150 #include <openssl/span.h> 151 #include <openssl/ssl3.h> 152 #include <openssl/thread.h> 153 #include <openssl/tls1.h> 154 #include <openssl/x509.h> 155 156 #if !defined(OPENSSL_WINDOWS) 157 #include <sys/time.h> 158 #endif 159 160 // NGINX needs this #include. Consider revisiting this after NGINX 1.14.0 has 161 // been out for a year or so (assuming that they fix it in that release.) See 162 // https://boringssl-review.googlesource.com/c/boringssl/+/21664. 163 #include <openssl/hmac.h> 164 165 // Forward-declare struct timeval. On Windows, it is defined in winsock2.h and 166 // Windows headers define too many macros to be included in public headers. 167 // However, only a forward declaration is needed. 168 struct timeval; 169 170 #if defined(__cplusplus) 171 extern "C" { 172 #endif 173 174 175 // SSL implementation. 176 177 178 // SSL contexts. 179 // 180 // |SSL_CTX| objects manage shared state and configuration between multiple TLS 181 // or DTLS connections. Whether the connections are TLS or DTLS is selected by 182 // an |SSL_METHOD| on creation. 183 // 184 // |SSL_CTX| are reference-counted and may be shared by connections across 185 // multiple threads. Once shared, functions which change the |SSL_CTX|'s 186 // configuration may not be used. 187 188 // TLS_method is the |SSL_METHOD| used for TLS connections. 189 OPENSSL_EXPORT const SSL_METHOD *TLS_method(void); 190 191 // DTLS_method is the |SSL_METHOD| used for DTLS connections. 192 OPENSSL_EXPORT const SSL_METHOD *DTLS_method(void); 193 194 // TLS_with_buffers_method is like |TLS_method|, but avoids all use of 195 // crypto/x509. All client connections created with |TLS_with_buffers_method| 196 // will fail unless a certificate verifier is installed with 197 // |SSL_set_custom_verify| or |SSL_CTX_set_custom_verify|. 198 OPENSSL_EXPORT const SSL_METHOD *TLS_with_buffers_method(void); 199 200 // DTLS_with_buffers_method is like |DTLS_method|, but avoids all use of 201 // crypto/x509. 202 OPENSSL_EXPORT const SSL_METHOD *DTLS_with_buffers_method(void); 203 204 // SSL_CTX_new returns a newly-allocated |SSL_CTX| with default settings or NULL 205 // on error. 206 OPENSSL_EXPORT SSL_CTX *SSL_CTX_new(const SSL_METHOD *method); 207 208 // SSL_CTX_up_ref increments the reference count of |ctx|. It returns one. 209 OPENSSL_EXPORT int SSL_CTX_up_ref(SSL_CTX *ctx); 210 211 // SSL_CTX_free releases memory associated with |ctx|. 212 OPENSSL_EXPORT void SSL_CTX_free(SSL_CTX *ctx); 213 214 215 // SSL connections. 216 // 217 // An |SSL| object represents a single TLS or DTLS connection. Although the 218 // shared |SSL_CTX| is thread-safe, an |SSL| is not thread-safe and may only be 219 // used on one thread at a time. 220 221 // SSL_new returns a newly-allocated |SSL| using |ctx| or NULL on error. The new 222 // connection inherits settings from |ctx| at the time of creation. Settings may 223 // also be individually configured on the connection. 224 // 225 // On creation, an |SSL| is not configured to be either a client or server. Call 226 // |SSL_set_connect_state| or |SSL_set_accept_state| to set this. 227 OPENSSL_EXPORT SSL *SSL_new(SSL_CTX *ctx); 228 229 // SSL_free releases memory associated with |ssl|. 230 OPENSSL_EXPORT void SSL_free(SSL *ssl); 231 232 // SSL_get_SSL_CTX returns the |SSL_CTX| associated with |ssl|. If 233 // |SSL_set_SSL_CTX| is called, it returns the new |SSL_CTX|, not the initial 234 // one. 235 OPENSSL_EXPORT SSL_CTX *SSL_get_SSL_CTX(const SSL *ssl); 236 237 // SSL_set_connect_state configures |ssl| to be a client. 238 OPENSSL_EXPORT void SSL_set_connect_state(SSL *ssl); 239 240 // SSL_set_accept_state configures |ssl| to be a server. 241 OPENSSL_EXPORT void SSL_set_accept_state(SSL *ssl); 242 243 // SSL_is_server returns one if |ssl| is configured as a server and zero 244 // otherwise. 245 OPENSSL_EXPORT int SSL_is_server(const SSL *ssl); 246 247 // SSL_is_dtls returns one if |ssl| is a DTLS connection and zero otherwise. 248 OPENSSL_EXPORT int SSL_is_dtls(const SSL *ssl); 249 250 // SSL_set_bio configures |ssl| to read from |rbio| and write to |wbio|. |ssl| 251 // takes ownership of the two |BIO|s. If |rbio| and |wbio| are the same, |ssl| 252 // only takes ownership of one reference. 253 // 254 // In DTLS, |rbio| must be non-blocking to properly handle timeouts and 255 // retransmits. 256 // 257 // If |rbio| is the same as the currently configured |BIO| for reading, that 258 // side is left untouched and is not freed. 259 // 260 // If |wbio| is the same as the currently configured |BIO| for writing AND |ssl| 261 // is not currently configured to read from and write to the same |BIO|, that 262 // side is left untouched and is not freed. This asymmetry is present for 263 // historical reasons. 264 // 265 // Due to the very complex historical behavior of this function, calling this 266 // function if |ssl| already has |BIO|s configured is deprecated. Prefer 267 // |SSL_set0_rbio| and |SSL_set0_wbio| instead. 268 OPENSSL_EXPORT void SSL_set_bio(SSL *ssl, BIO *rbio, BIO *wbio); 269 270 // SSL_set0_rbio configures |ssl| to read from |rbio|. It takes ownership of 271 // |rbio|. 272 // 273 // Note that, although this function and |SSL_set0_wbio| may be called on the 274 // same |BIO|, each call takes a reference. Use |BIO_up_ref| to balance this. 275 OPENSSL_EXPORT void SSL_set0_rbio(SSL *ssl, BIO *rbio); 276 277 // SSL_set0_wbio configures |ssl| to write to |wbio|. It takes ownership of 278 // |wbio|. 279 // 280 // Note that, although this function and |SSL_set0_rbio| may be called on the 281 // same |BIO|, each call takes a reference. Use |BIO_up_ref| to balance this. 282 OPENSSL_EXPORT void SSL_set0_wbio(SSL *ssl, BIO *wbio); 283 284 // SSL_get_rbio returns the |BIO| that |ssl| reads from. 285 OPENSSL_EXPORT BIO *SSL_get_rbio(const SSL *ssl); 286 287 // SSL_get_wbio returns the |BIO| that |ssl| writes to. 288 OPENSSL_EXPORT BIO *SSL_get_wbio(const SSL *ssl); 289 290 // SSL_get_fd calls |SSL_get_rfd|. 291 OPENSSL_EXPORT int SSL_get_fd(const SSL *ssl); 292 293 // SSL_get_rfd returns the file descriptor that |ssl| is configured to read 294 // from. If |ssl|'s read |BIO| is not configured or doesn't wrap a file 295 // descriptor then it returns -1. 296 // 297 // Note: On Windows, this may return either a file descriptor or a socket (cast 298 // to int), depending on whether |ssl| was configured with a file descriptor or 299 // socket |BIO|. 300 OPENSSL_EXPORT int SSL_get_rfd(const SSL *ssl); 301 302 // SSL_get_wfd returns the file descriptor that |ssl| is configured to write 303 // to. If |ssl|'s write |BIO| is not configured or doesn't wrap a file 304 // descriptor then it returns -1. 305 // 306 // Note: On Windows, this may return either a file descriptor or a socket (cast 307 // to int), depending on whether |ssl| was configured with a file descriptor or 308 // socket |BIO|. 309 OPENSSL_EXPORT int SSL_get_wfd(const SSL *ssl); 310 311 // SSL_set_fd configures |ssl| to read from and write to |fd|. It returns one 312 // on success and zero on allocation error. The caller retains ownership of 313 // |fd|. 314 // 315 // On Windows, |fd| is cast to a |SOCKET| and used with Winsock APIs. 316 OPENSSL_EXPORT int SSL_set_fd(SSL *ssl, int fd); 317 318 // SSL_set_rfd configures |ssl| to read from |fd|. It returns one on success and 319 // zero on allocation error. The caller retains ownership of |fd|. 320 // 321 // On Windows, |fd| is cast to a |SOCKET| and used with Winsock APIs. 322 OPENSSL_EXPORT int SSL_set_rfd(SSL *ssl, int fd); 323 324 // SSL_set_wfd configures |ssl| to write to |fd|. It returns one on success and 325 // zero on allocation error. The caller retains ownership of |fd|. 326 // 327 // On Windows, |fd| is cast to a |SOCKET| and used with Winsock APIs. 328 OPENSSL_EXPORT int SSL_set_wfd(SSL *ssl, int fd); 329 330 // SSL_do_handshake continues the current handshake. If there is none or the 331 // handshake has completed or False Started, it returns one. Otherwise, it 332 // returns <= 0. The caller should pass the value into |SSL_get_error| to 333 // determine how to proceed. 334 // 335 // In DTLS, the caller must drive retransmissions. Whenever |SSL_get_error| 336 // signals |SSL_ERROR_WANT_READ|, use |DTLSv1_get_timeout| to determine the 337 // current timeout. If it expires before the next retry, call 338 // |DTLSv1_handle_timeout|. Note that DTLS handshake retransmissions use fresh 339 // sequence numbers, so it is not sufficient to replay packets at the transport. 340 // 341 // TODO(davidben): Ensure 0 is only returned on transport EOF. 342 // https://crbug.com/466303. 343 OPENSSL_EXPORT int SSL_do_handshake(SSL *ssl); 344 345 // SSL_connect configures |ssl| as a client, if unconfigured, and calls 346 // |SSL_do_handshake|. 347 OPENSSL_EXPORT int SSL_connect(SSL *ssl); 348 349 // SSL_accept configures |ssl| as a server, if unconfigured, and calls 350 // |SSL_do_handshake|. 351 OPENSSL_EXPORT int SSL_accept(SSL *ssl); 352 353 // SSL_read reads up to |num| bytes from |ssl| into |buf|. It implicitly runs 354 // any pending handshakes, including renegotiations when enabled. On success, it 355 // returns the number of bytes read. Otherwise, it returns <= 0. The caller 356 // should pass the value into |SSL_get_error| to determine how to proceed. 357 // 358 // TODO(davidben): Ensure 0 is only returned on transport EOF. 359 // https://crbug.com/466303. 360 OPENSSL_EXPORT int SSL_read(SSL *ssl, void *buf, int num); 361 362 // SSL_peek behaves like |SSL_read| but does not consume any bytes returned. 363 OPENSSL_EXPORT int SSL_peek(SSL *ssl, void *buf, int num); 364 365 // SSL_pending returns the number of bytes available in |ssl|. It does not read 366 // from the transport. 367 OPENSSL_EXPORT int SSL_pending(const SSL *ssl); 368 369 // SSL_write writes up to |num| bytes from |buf| into |ssl|. It implicitly runs 370 // any pending handshakes, including renegotiations when enabled. On success, it 371 // returns the number of bytes written. Otherwise, it returns <= 0. The caller 372 // should pass the value into |SSL_get_error| to determine how to proceed. 373 // 374 // In TLS, a non-blocking |SSL_write| differs from non-blocking |write| in that 375 // a failed |SSL_write| still commits to the data passed in. When retrying, the 376 // caller must supply the original write buffer (or a larger one containing the 377 // original as a prefix). By default, retries will fail if they also do not 378 // reuse the same |buf| pointer. This may be relaxed with 379 // |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER|, but the buffer contents still must be 380 // unchanged. 381 // 382 // By default, in TLS, |SSL_write| will not return success until all |num| bytes 383 // are written. This may be relaxed with |SSL_MODE_ENABLE_PARTIAL_WRITE|. It 384 // allows |SSL_write| to complete with a partial result when only part of the 385 // input was written in a single record. 386 // 387 // In DTLS, neither |SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER| and 388 // |SSL_MODE_ENABLE_PARTIAL_WRITE| do anything. The caller may retry with a 389 // different buffer freely. A single call to |SSL_write| only ever writes a 390 // single record in a single packet, so |num| must be at most 391 // |SSL3_RT_MAX_PLAIN_LENGTH|. 392 // 393 // TODO(davidben): Ensure 0 is only returned on transport EOF. 394 // https://crbug.com/466303. 395 OPENSSL_EXPORT int SSL_write(SSL *ssl, const void *buf, int num); 396 397 // SSL_KEY_UPDATE_REQUESTED indicates that the peer should reply to a KeyUpdate 398 // message with its own, thus updating traffic secrets for both directions on 399 // the connection. 400 #define SSL_KEY_UPDATE_REQUESTED 1 401 402 // SSL_KEY_UPDATE_NOT_REQUESTED indicates that the peer should not reply with 403 // it's own KeyUpdate message. 404 #define SSL_KEY_UPDATE_NOT_REQUESTED 0 405 406 // SSL_key_update queues a TLS 1.3 KeyUpdate message to be sent on |ssl| 407 // if one is not already queued. The |request_type| argument must one of the 408 // |SSL_KEY_UPDATE_*| values. This function requires that |ssl| have completed a 409 // TLS >= 1.3 handshake. It returns one on success or zero on error. 410 // 411 // Note that this function does not _send_ the message itself. The next call to 412 // |SSL_write| will cause the message to be sent. |SSL_write| may be called with 413 // a zero length to flush a KeyUpdate message when no application data is 414 // pending. 415 OPENSSL_EXPORT int SSL_key_update(SSL *ssl, int request_type); 416 417 // SSL_shutdown shuts down |ssl|. It runs in two stages. First, it sends 418 // close_notify and returns zero or one on success or -1 on failure. Zero 419 // indicates that close_notify was sent, but not received, and one additionally 420 // indicates that the peer's close_notify had already been received. 421 // 422 // To then wait for the peer's close_notify, run |SSL_shutdown| to completion a 423 // second time. This returns 1 on success and -1 on failure. Application data 424 // is considered a fatal error at this point. To process or discard it, read 425 // until close_notify with |SSL_read| instead. 426 // 427 // In both cases, on failure, pass the return value into |SSL_get_error| to 428 // determine how to proceed. 429 // 430 // Most callers should stop at the first stage. Reading for close_notify is 431 // primarily used for uncommon protocols where the underlying transport is 432 // reused after TLS completes. Additionally, DTLS uses an unordered transport 433 // and is unordered, so the second stage is a no-op in DTLS. 434 OPENSSL_EXPORT int SSL_shutdown(SSL *ssl); 435 436 // SSL_CTX_set_quiet_shutdown sets quiet shutdown on |ctx| to |mode|. If 437 // enabled, |SSL_shutdown| will not send a close_notify alert or wait for one 438 // from the peer. It will instead synchronously return one. 439 OPENSSL_EXPORT void SSL_CTX_set_quiet_shutdown(SSL_CTX *ctx, int mode); 440 441 // SSL_CTX_get_quiet_shutdown returns whether quiet shutdown is enabled for 442 // |ctx|. 443 OPENSSL_EXPORT int SSL_CTX_get_quiet_shutdown(const SSL_CTX *ctx); 444 445 // SSL_set_quiet_shutdown sets quiet shutdown on |ssl| to |mode|. If enabled, 446 // |SSL_shutdown| will not send a close_notify alert or wait for one from the 447 // peer. It will instead synchronously return one. 448 OPENSSL_EXPORT void SSL_set_quiet_shutdown(SSL *ssl, int mode); 449 450 // SSL_get_quiet_shutdown returns whether quiet shutdown is enabled for 451 // |ssl|. 452 OPENSSL_EXPORT int SSL_get_quiet_shutdown(const SSL *ssl); 453 454 // SSL_get_error returns a |SSL_ERROR_*| value for the most recent operation on 455 // |ssl|. It should be called after an operation failed to determine whether the 456 // error was fatal and, if not, when to retry. 457 OPENSSL_EXPORT int SSL_get_error(const SSL *ssl, int ret_code); 458 459 // SSL_ERROR_NONE indicates the operation succeeded. 460 #define SSL_ERROR_NONE 0 461 462 // SSL_ERROR_SSL indicates the operation failed within the library. The caller 463 // may inspect the error queue for more information. 464 #define SSL_ERROR_SSL 1 465 466 // SSL_ERROR_WANT_READ indicates the operation failed attempting to read from 467 // the transport. The caller may retry the operation when the transport is ready 468 // for reading. 469 // 470 // If signaled by a DTLS handshake, the caller must also call 471 // |DTLSv1_get_timeout| and |DTLSv1_handle_timeout| as appropriate. See 472 // |SSL_do_handshake|. 473 #define SSL_ERROR_WANT_READ 2 474 475 // SSL_ERROR_WANT_WRITE indicates the operation failed attempting to write to 476 // the transport. The caller may retry the operation when the transport is ready 477 // for writing. 478 #define SSL_ERROR_WANT_WRITE 3 479 480 // SSL_ERROR_WANT_X509_LOOKUP indicates the operation failed in calling the 481 // |cert_cb| or |client_cert_cb|. The caller may retry the operation when the 482 // callback is ready to return a certificate or one has been configured 483 // externally. 484 // 485 // See also |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb|. 486 #define SSL_ERROR_WANT_X509_LOOKUP 4 487 488 // SSL_ERROR_SYSCALL indicates the operation failed externally to the library. 489 // The caller should consult the system-specific error mechanism. This is 490 // typically |errno| but may be something custom if using a custom |BIO|. It 491 // may also be signaled if the transport returned EOF, in which case the 492 // operation's return value will be zero. 493 #define SSL_ERROR_SYSCALL 5 494 495 // SSL_ERROR_ZERO_RETURN indicates the operation failed because the connection 496 // was cleanly shut down with a close_notify alert. 497 #define SSL_ERROR_ZERO_RETURN 6 498 499 // SSL_ERROR_WANT_CONNECT indicates the operation failed attempting to connect 500 // the transport (the |BIO| signaled |BIO_RR_CONNECT|). The caller may retry the 501 // operation when the transport is ready. 502 #define SSL_ERROR_WANT_CONNECT 7 503 504 // SSL_ERROR_WANT_ACCEPT indicates the operation failed attempting to accept a 505 // connection from the transport (the |BIO| signaled |BIO_RR_ACCEPT|). The 506 // caller may retry the operation when the transport is ready. 507 // 508 // TODO(davidben): Remove this. It's used by accept BIOs which are bizarre. 509 #define SSL_ERROR_WANT_ACCEPT 8 510 511 // SSL_ERROR_WANT_CHANNEL_ID_LOOKUP is never used. 512 // 513 // TODO(davidben): Remove this. Some callers reference it when stringifying 514 // errors. They should use |SSL_error_description| instead. 515 #define SSL_ERROR_WANT_CHANNEL_ID_LOOKUP 9 516 517 // SSL_ERROR_PENDING_SESSION indicates the operation failed because the session 518 // lookup callback indicated the session was unavailable. The caller may retry 519 // the operation when lookup has completed. 520 // 521 // See also |SSL_CTX_sess_set_get_cb| and |SSL_magic_pending_session_ptr|. 522 #define SSL_ERROR_PENDING_SESSION 11 523 524 // SSL_ERROR_PENDING_CERTIFICATE indicates the operation failed because the 525 // early callback indicated certificate lookup was incomplete. The caller may 526 // retry the operation when lookup has completed. 527 // 528 // See also |SSL_CTX_set_select_certificate_cb|. 529 #define SSL_ERROR_PENDING_CERTIFICATE 12 530 531 // SSL_ERROR_WANT_PRIVATE_KEY_OPERATION indicates the operation failed because 532 // a private key operation was unfinished. The caller may retry the operation 533 // when the private key operation is complete. 534 // 535 // See also |SSL_set_private_key_method| and 536 // |SSL_CTX_set_private_key_method|. 537 #define SSL_ERROR_WANT_PRIVATE_KEY_OPERATION 13 538 539 // SSL_ERROR_PENDING_TICKET indicates that a ticket decryption is pending. The 540 // caller may retry the operation when the decryption is ready. 541 // 542 // See also |SSL_CTX_set_ticket_aead_method|. 543 #define SSL_ERROR_PENDING_TICKET 14 544 545 // SSL_ERROR_EARLY_DATA_REJECTED indicates that early data was rejected. The 546 // caller should treat this as a connection failure and retry any operations 547 // associated with the rejected early data. |SSL_reset_early_data_reject| may be 548 // used to reuse the underlying connection for the retry. 549 #define SSL_ERROR_EARLY_DATA_REJECTED 15 550 551 // SSL_ERROR_WANT_CERTIFICATE_VERIFY indicates the operation failed because 552 // certificate verification was incomplete. The caller may retry the operation 553 // when certificate verification is complete. 554 // 555 // See also |SSL_CTX_set_custom_verify|. 556 #define SSL_ERROR_WANT_CERTIFICATE_VERIFY 16 557 558 #define SSL_ERROR_HANDOFF 17 559 #define SSL_ERROR_HANDBACK 18 560 561 // SSL_ERROR_WANT_RENEGOTIATE indicates the operation is pending a response to 562 // a renegotiation request from the server. The caller may call 563 // |SSL_renegotiate| to schedule a renegotiation and retry the operation. 564 // 565 // See also |ssl_renegotiate_explicit|. 566 #define SSL_ERROR_WANT_RENEGOTIATE 19 567 568 // SSL_ERROR_HANDSHAKE_HINTS_READY indicates the handshake has progressed enough 569 // for |SSL_serialize_handshake_hints| to be called. See also 570 // |SSL_request_handshake_hints|. 571 #define SSL_ERROR_HANDSHAKE_HINTS_READY 20 572 573 // SSL_error_description returns a string representation of |err|, where |err| 574 // is one of the |SSL_ERROR_*| constants returned by |SSL_get_error|, or NULL 575 // if the value is unrecognized. 576 OPENSSL_EXPORT const char *SSL_error_description(int err); 577 578 // SSL_set_mtu sets the |ssl|'s MTU in DTLS to |mtu|. It returns one on success 579 // and zero on failure. 580 OPENSSL_EXPORT int SSL_set_mtu(SSL *ssl, unsigned mtu); 581 582 // DTLSv1_set_initial_timeout_duration sets the initial duration for a DTLS 583 // handshake timeout. 584 // 585 // This duration overrides the default of 1 second, which is the strong 586 // recommendation of RFC 6347 (see section 4.2.4.1). However, there may exist 587 // situations where a shorter timeout would be beneficial, such as for 588 // time-sensitive applications. 589 OPENSSL_EXPORT void DTLSv1_set_initial_timeout_duration(SSL *ssl, 590 unsigned duration_ms); 591 592 // DTLSv1_get_timeout queries the next DTLS handshake timeout. If there is a 593 // timeout in progress, it sets |*out| to the time remaining and returns one. 594 // Otherwise, it returns zero. 595 // 596 // When the timeout expires, call |DTLSv1_handle_timeout| to handle the 597 // retransmit behavior. 598 // 599 // NOTE: This function must be queried again whenever the handshake state 600 // machine changes, including when |DTLSv1_handle_timeout| is called. 601 OPENSSL_EXPORT int DTLSv1_get_timeout(const SSL *ssl, struct timeval *out); 602 603 // DTLSv1_handle_timeout is called when a DTLS handshake timeout expires. If no 604 // timeout had expired, it returns 0. Otherwise, it retransmits the previous 605 // flight of handshake messages and returns 1. If too many timeouts had expired 606 // without progress or an error occurs, it returns -1. 607 // 608 // The caller's external timer should be compatible with the one |ssl| queries 609 // within some fudge factor. Otherwise, the call will be a no-op, but 610 // |DTLSv1_get_timeout| will return an updated timeout. 611 // 612 // If the function returns -1, checking if |SSL_get_error| returns 613 // |SSL_ERROR_WANT_WRITE| may be used to determine if the retransmit failed due 614 // to a non-fatal error at the write |BIO|. However, the operation may not be 615 // retried until the next timeout fires. 616 // 617 // WARNING: This function breaks the usual return value convention. 618 // 619 // TODO(davidben): This |SSL_ERROR_WANT_WRITE| behavior is kind of bizarre. 620 OPENSSL_EXPORT int DTLSv1_handle_timeout(SSL *ssl); 621 622 623 // Protocol versions. 624 625 #define DTLS1_VERSION_MAJOR 0xfe 626 #define SSL3_VERSION_MAJOR 0x03 627 628 #define SSL3_VERSION 0x0300 629 #define TLS1_VERSION 0x0301 630 #define TLS1_1_VERSION 0x0302 631 #define TLS1_2_VERSION 0x0303 632 #define TLS1_3_VERSION 0x0304 633 634 #define DTLS1_VERSION 0xfeff 635 #define DTLS1_2_VERSION 0xfefd 636 637 // SSL_CTX_set_min_proto_version sets the minimum protocol version for |ctx| to 638 // |version|. If |version| is zero, the default minimum version is used. It 639 // returns one on success and zero if |version| is invalid. 640 OPENSSL_EXPORT int SSL_CTX_set_min_proto_version(SSL_CTX *ctx, 641 uint16_t version); 642 643 // SSL_CTX_set_max_proto_version sets the maximum protocol version for |ctx| to 644 // |version|. If |version| is zero, the default maximum version is used. It 645 // returns one on success and zero if |version| is invalid. 646 OPENSSL_EXPORT int SSL_CTX_set_max_proto_version(SSL_CTX *ctx, 647 uint16_t version); 648 649 // SSL_CTX_get_min_proto_version returns the minimum protocol version for |ctx| 650 OPENSSL_EXPORT uint16_t SSL_CTX_get_min_proto_version(const SSL_CTX *ctx); 651 652 // SSL_CTX_get_max_proto_version returns the maximum protocol version for |ctx| 653 OPENSSL_EXPORT uint16_t SSL_CTX_get_max_proto_version(const SSL_CTX *ctx); 654 655 // SSL_set_min_proto_version sets the minimum protocol version for |ssl| to 656 // |version|. If |version| is zero, the default minimum version is used. It 657 // returns one on success and zero if |version| is invalid. 658 OPENSSL_EXPORT int SSL_set_min_proto_version(SSL *ssl, uint16_t version); 659 660 // SSL_set_max_proto_version sets the maximum protocol version for |ssl| to 661 // |version|. If |version| is zero, the default maximum version is used. It 662 // returns one on success and zero if |version| is invalid. 663 OPENSSL_EXPORT int SSL_set_max_proto_version(SSL *ssl, uint16_t version); 664 665 // SSL_get_min_proto_version returns the minimum protocol version for |ssl|. If 666 // the connection's configuration has been shed, 0 is returned. 667 OPENSSL_EXPORT uint16_t SSL_get_min_proto_version(const SSL *ssl); 668 669 // SSL_get_max_proto_version returns the maximum protocol version for |ssl|. If 670 // the connection's configuration has been shed, 0 is returned. 671 OPENSSL_EXPORT uint16_t SSL_get_max_proto_version(const SSL *ssl); 672 673 // SSL_version returns the TLS or DTLS protocol version used by |ssl|, which is 674 // one of the |*_VERSION| values. (E.g. |TLS1_2_VERSION|.) Before the version 675 // is negotiated, the result is undefined. 676 OPENSSL_EXPORT int SSL_version(const SSL *ssl); 677 678 679 // Options. 680 // 681 // Options configure protocol behavior. 682 683 // SSL_OP_NO_QUERY_MTU, in DTLS, disables querying the MTU from the underlying 684 // |BIO|. Instead, the MTU is configured with |SSL_set_mtu|. 685 #define SSL_OP_NO_QUERY_MTU 0x00001000L 686 687 // SSL_OP_NO_TICKET disables session ticket support (RFC 5077). 688 #define SSL_OP_NO_TICKET 0x00004000L 689 690 // SSL_OP_CIPHER_SERVER_PREFERENCE configures servers to select ciphers and 691 // ECDHE curves according to the server's preferences instead of the 692 // client's. 693 #define SSL_OP_CIPHER_SERVER_PREFERENCE 0x00400000L 694 695 // The following flags toggle individual protocol versions. This is deprecated. 696 // Use |SSL_CTX_set_min_proto_version| and |SSL_CTX_set_max_proto_version| 697 // instead. 698 #define SSL_OP_NO_TLSv1 0x04000000L 699 #define SSL_OP_NO_TLSv1_2 0x08000000L 700 #define SSL_OP_NO_TLSv1_1 0x10000000L 701 #define SSL_OP_NO_TLSv1_3 0x20000000L 702 #define SSL_OP_NO_DTLSv1 SSL_OP_NO_TLSv1 703 #define SSL_OP_NO_DTLSv1_2 SSL_OP_NO_TLSv1_2 704 705 // SSL_CTX_set_options enables all options set in |options| (which should be one 706 // or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a 707 // bitmask representing the resulting enabled options. 708 OPENSSL_EXPORT uint32_t SSL_CTX_set_options(SSL_CTX *ctx, uint32_t options); 709 710 // SSL_CTX_clear_options disables all options set in |options| (which should be 711 // one or more of the |SSL_OP_*| values, ORed together) in |ctx|. It returns a 712 // bitmask representing the resulting enabled options. 713 OPENSSL_EXPORT uint32_t SSL_CTX_clear_options(SSL_CTX *ctx, uint32_t options); 714 715 // SSL_CTX_get_options returns a bitmask of |SSL_OP_*| values that represent all 716 // the options enabled for |ctx|. 717 OPENSSL_EXPORT uint32_t SSL_CTX_get_options(const SSL_CTX *ctx); 718 719 // SSL_set_options enables all options set in |options| (which should be one or 720 // more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a bitmask 721 // representing the resulting enabled options. 722 OPENSSL_EXPORT uint32_t SSL_set_options(SSL *ssl, uint32_t options); 723 724 // SSL_clear_options disables all options set in |options| (which should be one 725 // or more of the |SSL_OP_*| values, ORed together) in |ssl|. It returns a 726 // bitmask representing the resulting enabled options. 727 OPENSSL_EXPORT uint32_t SSL_clear_options(SSL *ssl, uint32_t options); 728 729 // SSL_get_options returns a bitmask of |SSL_OP_*| values that represent all the 730 // options enabled for |ssl|. 731 OPENSSL_EXPORT uint32_t SSL_get_options(const SSL *ssl); 732 733 734 // Modes. 735 // 736 // Modes configure API behavior. 737 738 // SSL_MODE_ENABLE_PARTIAL_WRITE, in TLS, allows |SSL_write| to complete with a 739 // partial result when the only part of the input was written in a single 740 // record. In DTLS, it does nothing. 741 #define SSL_MODE_ENABLE_PARTIAL_WRITE 0x00000001L 742 743 // SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER, in TLS, allows retrying an incomplete 744 // |SSL_write| with a different buffer. However, |SSL_write| still assumes the 745 // buffer contents are unchanged. This is not the default to avoid the 746 // misconception that non-blocking |SSL_write| behaves like non-blocking 747 // |write|. In DTLS, it does nothing. 748 #define SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER 0x00000002L 749 750 // SSL_MODE_NO_AUTO_CHAIN disables automatically building a certificate chain 751 // before sending certificates to the peer. This flag is set (and the feature 752 // disabled) by default. 753 // TODO(davidben): Remove this behavior. https://crbug.com/boringssl/42. 754 #define SSL_MODE_NO_AUTO_CHAIN 0x00000008L 755 756 // SSL_MODE_ENABLE_FALSE_START allows clients to send application data before 757 // receipt of ChangeCipherSpec and Finished. This mode enables full handshakes 758 // to 'complete' in one RTT. See RFC 7918. 759 // 760 // When False Start is enabled, |SSL_do_handshake| may succeed before the 761 // handshake has completely finished. |SSL_write| will function at this point, 762 // and |SSL_read| will transparently wait for the final handshake leg before 763 // returning application data. To determine if False Start occurred or when the 764 // handshake is completely finished, see |SSL_in_false_start|, |SSL_in_init|, 765 // and |SSL_CB_HANDSHAKE_DONE| from |SSL_CTX_set_info_callback|. 766 #define SSL_MODE_ENABLE_FALSE_START 0x00000080L 767 768 // SSL_MODE_CBC_RECORD_SPLITTING causes multi-byte CBC records in TLS 1.0 to be 769 // split in two: the first record will contain a single byte and the second will 770 // contain the remainder. This effectively randomises the IV and prevents BEAST 771 // attacks. 772 #define SSL_MODE_CBC_RECORD_SPLITTING 0x00000100L 773 774 // SSL_MODE_NO_SESSION_CREATION will cause any attempts to create a session to 775 // fail with SSL_R_SESSION_MAY_NOT_BE_CREATED. This can be used to enforce that 776 // session resumption is used for a given SSL*. 777 #define SSL_MODE_NO_SESSION_CREATION 0x00000200L 778 779 // SSL_MODE_SEND_FALLBACK_SCSV sends TLS_FALLBACK_SCSV in the ClientHello. 780 // To be set only by applications that reconnect with a downgraded protocol 781 // version; see RFC 7507 for details. 782 // 783 // DO NOT ENABLE THIS if your application attempts a normal handshake. Only use 784 // this in explicit fallback retries, following the guidance in RFC 7507. 785 #define SSL_MODE_SEND_FALLBACK_SCSV 0x00000400L 786 787 // SSL_CTX_set_mode enables all modes set in |mode| (which should be one or more 788 // of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a bitmask 789 // representing the resulting enabled modes. 790 OPENSSL_EXPORT uint32_t SSL_CTX_set_mode(SSL_CTX *ctx, uint32_t mode); 791 792 // SSL_CTX_clear_mode disables all modes set in |mode| (which should be one or 793 // more of the |SSL_MODE_*| values, ORed together) in |ctx|. It returns a 794 // bitmask representing the resulting enabled modes. 795 OPENSSL_EXPORT uint32_t SSL_CTX_clear_mode(SSL_CTX *ctx, uint32_t mode); 796 797 // SSL_CTX_get_mode returns a bitmask of |SSL_MODE_*| values that represent all 798 // the modes enabled for |ssl|. 799 OPENSSL_EXPORT uint32_t SSL_CTX_get_mode(const SSL_CTX *ctx); 800 801 // SSL_set_mode enables all modes set in |mode| (which should be one or more of 802 // the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask 803 // representing the resulting enabled modes. 804 OPENSSL_EXPORT uint32_t SSL_set_mode(SSL *ssl, uint32_t mode); 805 806 // SSL_clear_mode disables all modes set in |mode| (which should be one or more 807 // of the |SSL_MODE_*| values, ORed together) in |ssl|. It returns a bitmask 808 // representing the resulting enabled modes. 809 OPENSSL_EXPORT uint32_t SSL_clear_mode(SSL *ssl, uint32_t mode); 810 811 // SSL_get_mode returns a bitmask of |SSL_MODE_*| values that represent all the 812 // modes enabled for |ssl|. 813 OPENSSL_EXPORT uint32_t SSL_get_mode(const SSL *ssl); 814 815 // SSL_CTX_set0_buffer_pool sets a |CRYPTO_BUFFER_POOL| that will be used to 816 // store certificates. This can allow multiple connections to share 817 // certificates and thus save memory. 818 // 819 // The SSL_CTX does not take ownership of |pool| and the caller must ensure 820 // that |pool| outlives |ctx| and all objects linked to it, including |SSL|, 821 // |X509| and |SSL_SESSION| objects. Basically, don't ever free |pool|. 822 OPENSSL_EXPORT void SSL_CTX_set0_buffer_pool(SSL_CTX *ctx, 823 CRYPTO_BUFFER_POOL *pool); 824 825 826 // Configuring certificates and private keys. 827 // 828 // These functions configure the connection's leaf certificate, private key, and 829 // certificate chain. The certificate chain is ordered leaf to root (as sent on 830 // the wire) but does not include the leaf. Both client and server certificates 831 // use these functions. 832 // 833 // Certificates and keys may be configured before the handshake or dynamically 834 // in the early callback and certificate callback. 835 836 // SSL_CTX_use_certificate sets |ctx|'s leaf certificate to |x509|. It returns 837 // one on success and zero on failure. 838 OPENSSL_EXPORT int SSL_CTX_use_certificate(SSL_CTX *ctx, X509 *x509); 839 840 // SSL_use_certificate sets |ssl|'s leaf certificate to |x509|. It returns one 841 // on success and zero on failure. 842 OPENSSL_EXPORT int SSL_use_certificate(SSL *ssl, X509 *x509); 843 844 // SSL_CTX_use_PrivateKey sets |ctx|'s private key to |pkey|. It returns one on 845 // success and zero on failure. 846 OPENSSL_EXPORT int SSL_CTX_use_PrivateKey(SSL_CTX *ctx, EVP_PKEY *pkey); 847 848 // SSL_use_PrivateKey sets |ssl|'s private key to |pkey|. It returns one on 849 // success and zero on failure. 850 OPENSSL_EXPORT int SSL_use_PrivateKey(SSL *ssl, EVP_PKEY *pkey); 851 852 // SSL_CTX_set0_chain sets |ctx|'s certificate chain, excluding the leaf, to 853 // |chain|. On success, it returns one and takes ownership of |chain|. 854 // Otherwise, it returns zero. 855 OPENSSL_EXPORT int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *chain); 856 857 // SSL_CTX_set1_chain sets |ctx|'s certificate chain, excluding the leaf, to 858 // |chain|. It returns one on success and zero on failure. The caller retains 859 // ownership of |chain| and may release it freely. 860 OPENSSL_EXPORT int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *chain); 861 862 // SSL_set0_chain sets |ssl|'s certificate chain, excluding the leaf, to 863 // |chain|. On success, it returns one and takes ownership of |chain|. 864 // Otherwise, it returns zero. 865 OPENSSL_EXPORT int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *chain); 866 867 // SSL_set1_chain sets |ssl|'s certificate chain, excluding the leaf, to 868 // |chain|. It returns one on success and zero on failure. The caller retains 869 // ownership of |chain| and may release it freely. 870 OPENSSL_EXPORT int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *chain); 871 872 // SSL_CTX_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On 873 // success, it returns one and takes ownership of |x509|. Otherwise, it returns 874 // zero. 875 OPENSSL_EXPORT int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509); 876 877 // SSL_CTX_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It 878 // returns one on success and zero on failure. The caller retains ownership of 879 // |x509| and may release it freely. 880 OPENSSL_EXPORT int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509); 881 882 // SSL_add0_chain_cert appends |x509| to |ctx|'s certificate chain. On success, 883 // it returns one and takes ownership of |x509|. Otherwise, it returns zero. 884 OPENSSL_EXPORT int SSL_add0_chain_cert(SSL *ssl, X509 *x509); 885 886 // SSL_CTX_add_extra_chain_cert calls |SSL_CTX_add0_chain_cert|. 887 OPENSSL_EXPORT int SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509); 888 889 // SSL_add1_chain_cert appends |x509| to |ctx|'s certificate chain. It returns 890 // one on success and zero on failure. The caller retains ownership of |x509| 891 // and may release it freely. 892 OPENSSL_EXPORT int SSL_add1_chain_cert(SSL *ssl, X509 *x509); 893 894 // SSL_CTX_clear_chain_certs clears |ctx|'s certificate chain and returns 895 // one. 896 OPENSSL_EXPORT int SSL_CTX_clear_chain_certs(SSL_CTX *ctx); 897 898 // SSL_CTX_clear_extra_chain_certs calls |SSL_CTX_clear_chain_certs|. 899 OPENSSL_EXPORT int SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx); 900 901 // SSL_clear_chain_certs clears |ssl|'s certificate chain and returns one. 902 OPENSSL_EXPORT int SSL_clear_chain_certs(SSL *ssl); 903 904 // SSL_CTX_set_cert_cb sets a callback that is called to select a certificate. 905 // The callback returns one on success, zero on internal error, and a negative 906 // number on failure or to pause the handshake. If the handshake is paused, 907 // |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. 908 // 909 // On the client, the callback may call |SSL_get0_certificate_types| and 910 // |SSL_get_client_CA_list| for information on the server's certificate 911 // request. 912 // 913 // On the server, the callback will be called after extensions have been 914 // processed, but before the resumption decision has been made. This differs 915 // from OpenSSL which handles resumption before selecting the certificate. 916 OPENSSL_EXPORT void SSL_CTX_set_cert_cb(SSL_CTX *ctx, 917 int (*cb)(SSL *ssl, void *arg), 918 void *arg); 919 920 // SSL_set_cert_cb sets a callback that is called to select a certificate. The 921 // callback returns one on success, zero on internal error, and a negative 922 // number on failure or to pause the handshake. If the handshake is paused, 923 // |SSL_get_error| will return |SSL_ERROR_WANT_X509_LOOKUP|. 924 // 925 // On the client, the callback may call |SSL_get0_certificate_types| and 926 // |SSL_get_client_CA_list| for information on the server's certificate 927 // request. 928 // 929 // On the server, the callback will be called after extensions have been 930 // processed, but before the resumption decision has been made. This differs 931 // from OpenSSL which handles resumption before selecting the certificate. 932 OPENSSL_EXPORT void SSL_set_cert_cb(SSL *ssl, int (*cb)(SSL *ssl, void *arg), 933 void *arg); 934 935 // SSL_get0_certificate_types, for a client, sets |*out_types| to an array 936 // containing the client certificate types requested by a server. It returns the 937 // length of the array. Note this list is always empty in TLS 1.3. The server 938 // will instead send signature algorithms. See 939 // |SSL_get0_peer_verify_algorithms|. 940 // 941 // The behavior of this function is undefined except during the callbacks set by 942 // by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or when the 943 // handshake is paused because of them. 944 OPENSSL_EXPORT size_t SSL_get0_certificate_types(const SSL *ssl, 945 const uint8_t **out_types); 946 947 // SSL_get0_peer_verify_algorithms sets |*out_sigalgs| to an array containing 948 // the signature algorithms the peer is able to verify. It returns the length of 949 // the array. Note these values are only sent starting TLS 1.2 and only 950 // mandatory starting TLS 1.3. If not sent, the empty array is returned. For the 951 // historical client certificate types list, see |SSL_get0_certificate_types|. 952 // 953 // The behavior of this function is undefined except during the callbacks set by 954 // by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or when the 955 // handshake is paused because of them. 956 OPENSSL_EXPORT size_t 957 SSL_get0_peer_verify_algorithms(const SSL *ssl, const uint16_t **out_sigalgs); 958 959 // SSL_get0_peer_delegation_algorithms sets |*out_sigalgs| to an array 960 // containing the signature algorithms the peer is willing to use with delegated 961 // credentials. It returns the length of the array. If not sent, the empty 962 // array is returned. 963 // 964 // The behavior of this function is undefined except during the callbacks set by 965 // by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or when the 966 // handshake is paused because of them. 967 OPENSSL_EXPORT size_t 968 SSL_get0_peer_delegation_algorithms(const SSL *ssl, 969 const uint16_t **out_sigalgs); 970 971 // SSL_certs_clear resets the private key, leaf certificate, and certificate 972 // chain of |ssl|. 973 OPENSSL_EXPORT void SSL_certs_clear(SSL *ssl); 974 975 // SSL_CTX_check_private_key returns one if the certificate and private key 976 // configured in |ctx| are consistent and zero otherwise. 977 OPENSSL_EXPORT int SSL_CTX_check_private_key(const SSL_CTX *ctx); 978 979 // SSL_check_private_key returns one if the certificate and private key 980 // configured in |ssl| are consistent and zero otherwise. 981 OPENSSL_EXPORT int SSL_check_private_key(const SSL *ssl); 982 983 // SSL_CTX_get0_certificate returns |ctx|'s leaf certificate. 984 OPENSSL_EXPORT X509 *SSL_CTX_get0_certificate(const SSL_CTX *ctx); 985 986 // SSL_get_certificate returns |ssl|'s leaf certificate. 987 OPENSSL_EXPORT X509 *SSL_get_certificate(const SSL *ssl); 988 989 // SSL_CTX_get0_privatekey returns |ctx|'s private key. 990 OPENSSL_EXPORT EVP_PKEY *SSL_CTX_get0_privatekey(const SSL_CTX *ctx); 991 992 // SSL_get_privatekey returns |ssl|'s private key. 993 OPENSSL_EXPORT EVP_PKEY *SSL_get_privatekey(const SSL *ssl); 994 995 // SSL_CTX_get0_chain_certs sets |*out_chain| to |ctx|'s certificate chain and 996 // returns one. 997 OPENSSL_EXPORT int SSL_CTX_get0_chain_certs(const SSL_CTX *ctx, 998 STACK_OF(X509) **out_chain); 999 1000 // SSL_CTX_get_extra_chain_certs calls |SSL_CTX_get0_chain_certs|. 1001 OPENSSL_EXPORT int SSL_CTX_get_extra_chain_certs(const SSL_CTX *ctx, 1002 STACK_OF(X509) **out_chain); 1003 1004 // SSL_get0_chain_certs sets |*out_chain| to |ssl|'s certificate chain and 1005 // returns one. 1006 OPENSSL_EXPORT int SSL_get0_chain_certs(const SSL *ssl, 1007 STACK_OF(X509) **out_chain); 1008 1009 // SSL_CTX_set_signed_cert_timestamp_list sets the list of signed certificate 1010 // timestamps that is sent to clients that request it. The |list| argument must 1011 // contain one or more SCT structures serialised as a SignedCertificateTimestamp 1012 // List (see https://tools.ietf.org/html/rfc6962#section-3.3) – i.e. each SCT 1013 // is prefixed by a big-endian, uint16 length and the concatenation of one or 1014 // more such prefixed SCTs are themselves also prefixed by a uint16 length. It 1015 // returns one on success and zero on error. The caller retains ownership of 1016 // |list|. 1017 OPENSSL_EXPORT int SSL_CTX_set_signed_cert_timestamp_list(SSL_CTX *ctx, 1018 const uint8_t *list, 1019 size_t list_len); 1020 1021 // SSL_set_signed_cert_timestamp_list sets the list of signed certificate 1022 // timestamps that is sent to clients that request is. The same format as the 1023 // one used for |SSL_CTX_set_signed_cert_timestamp_list| applies. The caller 1024 // retains ownership of |list|. 1025 OPENSSL_EXPORT int SSL_set_signed_cert_timestamp_list(SSL *ctx, 1026 const uint8_t *list, 1027 size_t list_len); 1028 1029 // SSL_CTX_set_ocsp_response sets the OCSP response that is sent to clients 1030 // which request it. It returns one on success and zero on error. The caller 1031 // retains ownership of |response|. 1032 OPENSSL_EXPORT int SSL_CTX_set_ocsp_response(SSL_CTX *ctx, 1033 const uint8_t *response, 1034 size_t response_len); 1035 1036 // SSL_set_ocsp_response sets the OCSP response that is sent to clients which 1037 // request it. It returns one on success and zero on error. The caller retains 1038 // ownership of |response|. 1039 OPENSSL_EXPORT int SSL_set_ocsp_response(SSL *ssl, 1040 const uint8_t *response, 1041 size_t response_len); 1042 1043 // SSL_SIGN_* are signature algorithm values as defined in TLS 1.3. 1044 #define SSL_SIGN_RSA_PKCS1_SHA1 0x0201 1045 #define SSL_SIGN_RSA_PKCS1_SHA256 0x0401 1046 #define SSL_SIGN_RSA_PKCS1_SHA384 0x0501 1047 #define SSL_SIGN_RSA_PKCS1_SHA512 0x0601 1048 #define SSL_SIGN_ECDSA_SHA1 0x0203 1049 #define SSL_SIGN_ECDSA_SECP256R1_SHA256 0x0403 1050 #define SSL_SIGN_ECDSA_SECP384R1_SHA384 0x0503 1051 #define SSL_SIGN_ECDSA_SECP521R1_SHA512 0x0603 1052 #define SSL_SIGN_RSA_PSS_RSAE_SHA256 0x0804 1053 #define SSL_SIGN_RSA_PSS_RSAE_SHA384 0x0805 1054 #define SSL_SIGN_RSA_PSS_RSAE_SHA512 0x0806 1055 #define SSL_SIGN_ED25519 0x0807 1056 1057 // SSL_SIGN_RSA_PKCS1_MD5_SHA1 is an internal signature algorithm used to 1058 // specify raw RSASSA-PKCS1-v1_5 with an MD5/SHA-1 concatenation, as used in TLS 1059 // before TLS 1.2. 1060 #define SSL_SIGN_RSA_PKCS1_MD5_SHA1 0xff01 1061 1062 // SSL_get_signature_algorithm_name returns a human-readable name for |sigalg|, 1063 // or NULL if unknown. If |include_curve| is one, the curve for ECDSA algorithms 1064 // is included as in TLS 1.3. Otherwise, it is excluded as in TLS 1.2. 1065 OPENSSL_EXPORT const char *SSL_get_signature_algorithm_name(uint16_t sigalg, 1066 int include_curve); 1067 1068 // SSL_get_signature_algorithm_key_type returns the key type associated with 1069 // |sigalg| as an |EVP_PKEY_*| constant or |EVP_PKEY_NONE| if unknown. 1070 OPENSSL_EXPORT int SSL_get_signature_algorithm_key_type(uint16_t sigalg); 1071 1072 // SSL_get_signature_algorithm_digest returns the digest function associated 1073 // with |sigalg| or |NULL| if |sigalg| has no prehash (Ed25519) or is unknown. 1074 OPENSSL_EXPORT const EVP_MD *SSL_get_signature_algorithm_digest( 1075 uint16_t sigalg); 1076 1077 // SSL_is_signature_algorithm_rsa_pss returns one if |sigalg| is an RSA-PSS 1078 // signature algorithm and zero otherwise. 1079 OPENSSL_EXPORT int SSL_is_signature_algorithm_rsa_pss(uint16_t sigalg); 1080 1081 // SSL_CTX_set_signing_algorithm_prefs configures |ctx| to use |prefs| as the 1082 // preference list when signing with |ctx|'s private key. It returns one on 1083 // success and zero on error. |prefs| should not include the internal-only value 1084 // |SSL_SIGN_RSA_PKCS1_MD5_SHA1|. 1085 OPENSSL_EXPORT int SSL_CTX_set_signing_algorithm_prefs(SSL_CTX *ctx, 1086 const uint16_t *prefs, 1087 size_t num_prefs); 1088 1089 // SSL_set_signing_algorithm_prefs configures |ssl| to use |prefs| as the 1090 // preference list when signing with |ssl|'s private key. It returns one on 1091 // success and zero on error. |prefs| should not include the internal-only value 1092 // |SSL_SIGN_RSA_PKCS1_MD5_SHA1|. 1093 OPENSSL_EXPORT int SSL_set_signing_algorithm_prefs(SSL *ssl, 1094 const uint16_t *prefs, 1095 size_t num_prefs); 1096 1097 1098 // Certificate and private key convenience functions. 1099 1100 // SSL_CTX_set_chain_and_key sets the certificate chain and private key for a 1101 // TLS client or server. References to the given |CRYPTO_BUFFER| and |EVP_PKEY| 1102 // objects are added as needed. Exactly one of |privkey| or |privkey_method| 1103 // may be non-NULL. Returns one on success and zero on error. 1104 OPENSSL_EXPORT int SSL_CTX_set_chain_and_key( 1105 SSL_CTX *ctx, CRYPTO_BUFFER *const *certs, size_t num_certs, 1106 EVP_PKEY *privkey, const SSL_PRIVATE_KEY_METHOD *privkey_method); 1107 1108 // SSL_set_chain_and_key sets the certificate chain and private key for a TLS 1109 // client or server. References to the given |CRYPTO_BUFFER| and |EVP_PKEY| 1110 // objects are added as needed. Exactly one of |privkey| or |privkey_method| 1111 // may be non-NULL. Returns one on success and zero on error. 1112 OPENSSL_EXPORT int SSL_set_chain_and_key( 1113 SSL *ssl, CRYPTO_BUFFER *const *certs, size_t num_certs, EVP_PKEY *privkey, 1114 const SSL_PRIVATE_KEY_METHOD *privkey_method); 1115 1116 // SSL_CTX_get0_chain returns the list of |CRYPTO_BUFFER|s that were set by 1117 // |SSL_CTX_set_chain_and_key|. Reference counts are not incremented by this 1118 // call. The return value may be |NULL| if no chain has been set. 1119 // 1120 // (Note: if a chain was configured by non-|CRYPTO_BUFFER|-based functions then 1121 // the return value is undefined and, even if not NULL, the stack itself may 1122 // contain nullptrs. Thus you shouldn't mix this function with 1123 // non-|CRYPTO_BUFFER| functions for manipulating the chain.) 1124 // 1125 // There is no |SSL*| version of this function because connections discard 1126 // configuration after handshaking, thus making it of questionable utility. 1127 OPENSSL_EXPORT const STACK_OF(CRYPTO_BUFFER)* 1128 SSL_CTX_get0_chain(const SSL_CTX *ctx); 1129 1130 // SSL_CTX_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one 1131 // on success and zero on failure. 1132 OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey(SSL_CTX *ctx, RSA *rsa); 1133 1134 // SSL_use_RSAPrivateKey sets |ctx|'s private key to |rsa|. It returns one on 1135 // success and zero on failure. 1136 OPENSSL_EXPORT int SSL_use_RSAPrivateKey(SSL *ssl, RSA *rsa); 1137 1138 // The following functions configure certificates or private keys but take as 1139 // input DER-encoded structures. They return one on success and zero on 1140 // failure. 1141 1142 OPENSSL_EXPORT int SSL_CTX_use_certificate_ASN1(SSL_CTX *ctx, size_t der_len, 1143 const uint8_t *der); 1144 OPENSSL_EXPORT int SSL_use_certificate_ASN1(SSL *ssl, const uint8_t *der, 1145 size_t der_len); 1146 1147 OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_ASN1(int pk, SSL_CTX *ctx, 1148 const uint8_t *der, 1149 size_t der_len); 1150 OPENSSL_EXPORT int SSL_use_PrivateKey_ASN1(int type, SSL *ssl, 1151 const uint8_t *der, size_t der_len); 1152 1153 OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_ASN1(SSL_CTX *ctx, 1154 const uint8_t *der, 1155 size_t der_len); 1156 OPENSSL_EXPORT int SSL_use_RSAPrivateKey_ASN1(SSL *ssl, const uint8_t *der, 1157 size_t der_len); 1158 1159 // The following functions configure certificates or private keys but take as 1160 // input files to read from. They return one on success and zero on failure. The 1161 // |type| parameter is one of the |SSL_FILETYPE_*| values and determines whether 1162 // the file's contents are read as PEM or DER. 1163 1164 #define SSL_FILETYPE_PEM 1 1165 #define SSL_FILETYPE_ASN1 2 1166 1167 OPENSSL_EXPORT int SSL_CTX_use_RSAPrivateKey_file(SSL_CTX *ctx, 1168 const char *file, 1169 int type); 1170 OPENSSL_EXPORT int SSL_use_RSAPrivateKey_file(SSL *ssl, const char *file, 1171 int type); 1172 1173 OPENSSL_EXPORT int SSL_CTX_use_certificate_file(SSL_CTX *ctx, const char *file, 1174 int type); 1175 OPENSSL_EXPORT int SSL_use_certificate_file(SSL *ssl, const char *file, 1176 int type); 1177 1178 OPENSSL_EXPORT int SSL_CTX_use_PrivateKey_file(SSL_CTX *ctx, const char *file, 1179 int type); 1180 OPENSSL_EXPORT int SSL_use_PrivateKey_file(SSL *ssl, const char *file, 1181 int type); 1182 1183 // SSL_CTX_use_certificate_chain_file configures certificates for |ctx|. It 1184 // reads the contents of |file| as a PEM-encoded leaf certificate followed 1185 // optionally by the certificate chain to send to the peer. It returns one on 1186 // success and zero on failure. 1187 OPENSSL_EXPORT int SSL_CTX_use_certificate_chain_file(SSL_CTX *ctx, 1188 const char *file); 1189 1190 // SSL_CTX_set_default_passwd_cb sets the password callback for PEM-based 1191 // convenience functions called on |ctx|. 1192 OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb(SSL_CTX *ctx, 1193 pem_password_cb *cb); 1194 1195 // SSL_CTX_get_default_passwd_cb returns the callback set by 1196 // |SSL_CTX_set_default_passwd_cb|. 1197 OPENSSL_EXPORT pem_password_cb *SSL_CTX_get_default_passwd_cb( 1198 const SSL_CTX *ctx); 1199 1200 // SSL_CTX_set_default_passwd_cb_userdata sets the userdata parameter for 1201 // |ctx|'s password callback. 1202 OPENSSL_EXPORT void SSL_CTX_set_default_passwd_cb_userdata(SSL_CTX *ctx, 1203 void *data); 1204 1205 // SSL_CTX_get_default_passwd_cb_userdata returns the userdata parameter set by 1206 // |SSL_CTX_set_default_passwd_cb_userdata|. 1207 OPENSSL_EXPORT void *SSL_CTX_get_default_passwd_cb_userdata(const SSL_CTX *ctx); 1208 1209 1210 // Custom private keys. 1211 1212 enum ssl_private_key_result_t BORINGSSL_ENUM_INT { 1213 ssl_private_key_success, 1214 ssl_private_key_retry, 1215 ssl_private_key_failure, 1216 }; 1217 1218 // ssl_private_key_method_st (aka |SSL_PRIVATE_KEY_METHOD|) describes private 1219 // key hooks. This is used to off-load signing operations to a custom, 1220 // potentially asynchronous, backend. Metadata about the key such as the type 1221 // and size are parsed out of the certificate. 1222 // 1223 // Callers that use this structure should additionally call 1224 // |SSL_set_signing_algorithm_prefs| or |SSL_CTX_set_signing_algorithm_prefs| 1225 // with the private key's capabilities. This ensures BoringSSL will select a 1226 // suitable signature algorithm for the private key. 1227 struct ssl_private_key_method_st { 1228 // sign signs the message |in| in using the specified signature algorithm. On 1229 // success, it returns |ssl_private_key_success| and writes at most |max_out| 1230 // bytes of signature data to |out| and sets |*out_len| to the number of bytes 1231 // written. On failure, it returns |ssl_private_key_failure|. If the operation 1232 // has not completed, it returns |ssl_private_key_retry|. |sign| should 1233 // arrange for the high-level operation on |ssl| to be retried when the 1234 // operation is completed. This will result in a call to |complete|. 1235 // 1236 // |signature_algorithm| is one of the |SSL_SIGN_*| values, as defined in TLS 1237 // 1.3. Note that, in TLS 1.2, ECDSA algorithms do not require that curve 1238 // sizes match hash sizes, so the curve portion of |SSL_SIGN_ECDSA_*| values 1239 // must be ignored. BoringSSL will internally handle the curve matching logic 1240 // where appropriate. 1241 // 1242 // It is an error to call |sign| while another private key operation is in 1243 // progress on |ssl|. 1244 enum ssl_private_key_result_t (*sign)(SSL *ssl, uint8_t *out, size_t *out_len, 1245 size_t max_out, 1246 uint16_t signature_algorithm, 1247 const uint8_t *in, size_t in_len); 1248 1249 // decrypt decrypts |in_len| bytes of encrypted data from |in|. On success it 1250 // returns |ssl_private_key_success|, writes at most |max_out| bytes of 1251 // decrypted data to |out| and sets |*out_len| to the actual number of bytes 1252 // written. On failure it returns |ssl_private_key_failure|. If the operation 1253 // has not completed, it returns |ssl_private_key_retry|. The caller should 1254 // arrange for the high-level operation on |ssl| to be retried when the 1255 // operation is completed, which will result in a call to |complete|. This 1256 // function only works with RSA keys and should perform a raw RSA decryption 1257 // operation with no padding. 1258 // 1259 // It is an error to call |decrypt| while another private key operation is in 1260 // progress on |ssl|. 1261 enum ssl_private_key_result_t (*decrypt)(SSL *ssl, uint8_t *out, 1262 size_t *out_len, size_t max_out, 1263 const uint8_t *in, size_t in_len); 1264 1265 // complete completes a pending operation. If the operation has completed, it 1266 // returns |ssl_private_key_success| and writes the result to |out| as in 1267 // |sign|. Otherwise, it returns |ssl_private_key_failure| on failure and 1268 // |ssl_private_key_retry| if the operation is still in progress. 1269 // 1270 // |complete| may be called arbitrarily many times before completion, but it 1271 // is an error to call |complete| if there is no pending operation in progress 1272 // on |ssl|. 1273 enum ssl_private_key_result_t (*complete)(SSL *ssl, uint8_t *out, 1274 size_t *out_len, size_t max_out); 1275 }; 1276 1277 // SSL_set_private_key_method configures a custom private key on |ssl|. 1278 // |key_method| must remain valid for the lifetime of |ssl|. 1279 OPENSSL_EXPORT void SSL_set_private_key_method( 1280 SSL *ssl, const SSL_PRIVATE_KEY_METHOD *key_method); 1281 1282 // SSL_CTX_set_private_key_method configures a custom private key on |ctx|. 1283 // |key_method| must remain valid for the lifetime of |ctx|. 1284 OPENSSL_EXPORT void SSL_CTX_set_private_key_method( 1285 SSL_CTX *ctx, const SSL_PRIVATE_KEY_METHOD *key_method); 1286 1287 // SSL_can_release_private_key returns one if |ssl| will no longer call into the 1288 // private key and zero otherwise. If the function returns one, the caller can 1289 // release state associated with the private key. 1290 // 1291 // NOTE: This function assumes the caller does not use |SSL_clear| to reuse 1292 // |ssl| for a second connection. If |SSL_clear| is used, BoringSSL may still 1293 // use the private key on the second connection. 1294 OPENSSL_EXPORT int SSL_can_release_private_key(const SSL *ssl); 1295 1296 1297 // Cipher suites. 1298 // 1299 // |SSL_CIPHER| objects represent cipher suites. 1300 1301 DEFINE_CONST_STACK_OF(SSL_CIPHER) 1302 1303 // SSL_get_cipher_by_value returns the structure representing a TLS cipher 1304 // suite based on its assigned number, or NULL if unknown. See 1305 // https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4. 1306 OPENSSL_EXPORT const SSL_CIPHER *SSL_get_cipher_by_value(uint16_t value); 1307 1308 // SSL_CIPHER_get_id returns |cipher|'s non-IANA id. This is not its 1309 // IANA-assigned number, which is called the "value" here, although it may be 1310 // cast to a |uint16_t| to get it. 1311 OPENSSL_EXPORT uint32_t SSL_CIPHER_get_id(const SSL_CIPHER *cipher); 1312 1313 // SSL_CIPHER_get_protocol_id returns |cipher|'s IANA-assigned number. 1314 OPENSSL_EXPORT uint16_t SSL_CIPHER_get_protocol_id(const SSL_CIPHER *cipher); 1315 1316 // SSL_CIPHER_is_aead returns one if |cipher| uses an AEAD cipher. 1317 OPENSSL_EXPORT int SSL_CIPHER_is_aead(const SSL_CIPHER *cipher); 1318 1319 // SSL_CIPHER_is_block_cipher returns one if |cipher| is a block cipher. 1320 OPENSSL_EXPORT int SSL_CIPHER_is_block_cipher(const SSL_CIPHER *cipher); 1321 1322 // SSL_CIPHER_get_cipher_nid returns the NID for |cipher|'s bulk 1323 // cipher. Possible values are |NID_aes_128_gcm|, |NID_aes_256_gcm|, 1324 // |NID_chacha20_poly1305|, |NID_aes_128_cbc|, |NID_aes_256_cbc|, and 1325 // |NID_des_ede3_cbc|. 1326 OPENSSL_EXPORT int SSL_CIPHER_get_cipher_nid(const SSL_CIPHER *cipher); 1327 1328 // SSL_CIPHER_get_digest_nid returns the NID for |cipher|'s HMAC if it is a 1329 // legacy cipher suite. For modern AEAD-based ciphers (see 1330 // |SSL_CIPHER_is_aead|), it returns |NID_undef|. 1331 // 1332 // Note this function only returns the legacy HMAC digest, not the PRF hash. 1333 OPENSSL_EXPORT int SSL_CIPHER_get_digest_nid(const SSL_CIPHER *cipher); 1334 1335 // SSL_CIPHER_get_kx_nid returns the NID for |cipher|'s key exchange. This may 1336 // be |NID_kx_rsa|, |NID_kx_ecdhe|, or |NID_kx_psk| for TLS 1.2. In TLS 1.3, 1337 // cipher suites do not specify the key exchange, so this function returns 1338 // |NID_kx_any|. 1339 OPENSSL_EXPORT int SSL_CIPHER_get_kx_nid(const SSL_CIPHER *cipher); 1340 1341 // SSL_CIPHER_get_auth_nid returns the NID for |cipher|'s authentication 1342 // type. This may be |NID_auth_rsa|, |NID_auth_ecdsa|, or |NID_auth_psk| for TLS 1343 // 1.2. In TLS 1.3, cipher suites do not specify authentication, so this 1344 // function returns |NID_auth_any|. 1345 OPENSSL_EXPORT int SSL_CIPHER_get_auth_nid(const SSL_CIPHER *cipher); 1346 1347 // SSL_CIPHER_get_prf_nid retuns the NID for |cipher|'s PRF hash. If |cipher| is 1348 // a pre-TLS-1.2 cipher, it returns |NID_md5_sha1| but note these ciphers use 1349 // SHA-256 in TLS 1.2. Other return values may be treated uniformly in all 1350 // applicable versions. 1351 OPENSSL_EXPORT int SSL_CIPHER_get_prf_nid(const SSL_CIPHER *cipher); 1352 1353 // SSL_CIPHER_get_min_version returns the minimum protocol version required 1354 // for |cipher|. 1355 OPENSSL_EXPORT uint16_t SSL_CIPHER_get_min_version(const SSL_CIPHER *cipher); 1356 1357 // SSL_CIPHER_get_max_version returns the maximum protocol version that 1358 // supports |cipher|. 1359 OPENSSL_EXPORT uint16_t SSL_CIPHER_get_max_version(const SSL_CIPHER *cipher); 1360 1361 // SSL_CIPHER_standard_name returns the standard IETF name for |cipher|. For 1362 // example, "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256". 1363 OPENSSL_EXPORT const char *SSL_CIPHER_standard_name(const SSL_CIPHER *cipher); 1364 1365 // SSL_CIPHER_get_name returns the OpenSSL name of |cipher|. For example, 1366 // "ECDHE-RSA-AES128-GCM-SHA256". Callers are recommended to use 1367 // |SSL_CIPHER_standard_name| instead. 1368 OPENSSL_EXPORT const char *SSL_CIPHER_get_name(const SSL_CIPHER *cipher); 1369 1370 // SSL_CIPHER_get_kx_name returns a string that describes the key-exchange 1371 // method used by |cipher|. For example, "ECDHE_ECDSA". TLS 1.3 AEAD-only 1372 // ciphers return the string "GENERIC". 1373 OPENSSL_EXPORT const char *SSL_CIPHER_get_kx_name(const SSL_CIPHER *cipher); 1374 1375 // SSL_CIPHER_get_bits returns the strength, in bits, of |cipher|. If 1376 // |out_alg_bits| is not NULL, it writes the number of bits consumed by the 1377 // symmetric algorithm to |*out_alg_bits|. 1378 OPENSSL_EXPORT int SSL_CIPHER_get_bits(const SSL_CIPHER *cipher, 1379 int *out_alg_bits); 1380 1381 1382 // Cipher suite configuration. 1383 // 1384 // OpenSSL uses a mini-language to configure cipher suites. The language 1385 // maintains an ordered list of enabled ciphers, along with an ordered list of 1386 // disabled but available ciphers. Initially, all ciphers are disabled with a 1387 // default ordering. The cipher string is then interpreted as a sequence of 1388 // directives, separated by colons, each of which modifies this state. 1389 // 1390 // Most directives consist of a one character or empty opcode followed by a 1391 // selector which matches a subset of available ciphers. 1392 // 1393 // Available opcodes are: 1394 // 1395 // The empty opcode enables and appends all matching disabled ciphers to the 1396 // end of the enabled list. The newly appended ciphers are ordered relative to 1397 // each other matching their order in the disabled list. 1398 // 1399 // |-| disables all matching enabled ciphers and prepends them to the disabled 1400 // list, with relative order from the enabled list preserved. This means the 1401 // most recently disabled ciphers get highest preference relative to other 1402 // disabled ciphers if re-enabled. 1403 // 1404 // |+| moves all matching enabled ciphers to the end of the enabled list, with 1405 // relative order preserved. 1406 // 1407 // |!| deletes all matching ciphers, enabled or not, from either list. Deleted 1408 // ciphers will not matched by future operations. 1409 // 1410 // A selector may be a specific cipher (using either the standard or OpenSSL 1411 // name for the cipher) or one or more rules separated by |+|. The final 1412 // selector matches the intersection of each rule. For instance, |AESGCM+aECDSA| 1413 // matches ECDSA-authenticated AES-GCM ciphers. 1414 // 1415 // Available cipher rules are: 1416 // 1417 // |ALL| matches all ciphers. 1418 // 1419 // |kRSA|, |kDHE|, |kECDHE|, and |kPSK| match ciphers using plain RSA, DHE, 1420 // ECDHE, and plain PSK key exchanges, respectively. Note that ECDHE_PSK is 1421 // matched by |kECDHE| and not |kPSK|. 1422 // 1423 // |aRSA|, |aECDSA|, and |aPSK| match ciphers authenticated by RSA, ECDSA, and 1424 // a pre-shared key, respectively. 1425 // 1426 // |RSA|, |DHE|, |ECDHE|, |PSK|, |ECDSA|, and |PSK| are aliases for the 1427 // corresponding |k*| or |a*| cipher rule. |RSA| is an alias for |kRSA|, not 1428 // |aRSA|. 1429 // 1430 // |3DES|, |AES128|, |AES256|, |AES|, |AESGCM|, |CHACHA20| match ciphers 1431 // whose bulk cipher use the corresponding encryption scheme. Note that 1432 // |AES|, |AES128|, and |AES256| match both CBC and GCM ciphers. 1433 // 1434 // |SHA1|, and its alias |SHA|, match legacy cipher suites using HMAC-SHA1. 1435 // 1436 // Although implemented, authentication-only ciphers match no rules and must be 1437 // explicitly selected by name. 1438 // 1439 // Deprecated cipher rules: 1440 // 1441 // |kEDH|, |EDH|, |kEECDH|, and |EECDH| are legacy aliases for |kDHE|, |DHE|, 1442 // |kECDHE|, and |ECDHE|, respectively. 1443 // 1444 // |HIGH| is an alias for |ALL|. 1445 // 1446 // |FIPS| is an alias for |HIGH|. 1447 // 1448 // |SSLv3| and |TLSv1| match ciphers available in TLS 1.1 or earlier. 1449 // |TLSv1_2| matches ciphers new in TLS 1.2. This is confusing and should not 1450 // be used. 1451 // 1452 // Unknown rules are silently ignored by legacy APIs, and rejected by APIs with 1453 // "strict" in the name, which should be preferred. Cipher lists can be long 1454 // and it's easy to commit typos. Strict functions will also reject the use of 1455 // spaces, semi-colons and commas as alternative separators. 1456 // 1457 // The special |@STRENGTH| directive will sort all enabled ciphers by strength. 1458 // 1459 // The |DEFAULT| directive, when appearing at the front of the string, expands 1460 // to the default ordering of available ciphers. 1461 // 1462 // If configuring a server, one may also configure equal-preference groups to 1463 // partially respect the client's preferences when 1464 // |SSL_OP_CIPHER_SERVER_PREFERENCE| is enabled. Ciphers in an equal-preference 1465 // group have equal priority and use the client order. This may be used to 1466 // enforce that AEADs are preferred but select AES-GCM vs. ChaCha20-Poly1305 1467 // based on client preferences. An equal-preference is specified with square 1468 // brackets, combining multiple selectors separated by |. For example: 1469 // 1470 // [TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256|TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256] 1471 // 1472 // Once an equal-preference group is used, future directives must be 1473 // opcode-less. Inside an equal-preference group, spaces are not allowed. 1474 // 1475 // TLS 1.3 ciphers do not participate in this mechanism and instead have a 1476 // built-in preference order. Functions to set cipher lists do not affect TLS 1477 // 1.3, and functions to query the cipher list do not include TLS 1.3 1478 // ciphers. 1479 1480 // SSL_DEFAULT_CIPHER_LIST is the default cipher suite configuration. It is 1481 // substituted when a cipher string starts with 'DEFAULT'. 1482 #define SSL_DEFAULT_CIPHER_LIST "ALL" 1483 1484 // SSL_CTX_set_strict_cipher_list configures the cipher list for |ctx|, 1485 // evaluating |str| as a cipher string and returning error if |str| contains 1486 // anything meaningless. It returns one on success and zero on failure. 1487 OPENSSL_EXPORT int SSL_CTX_set_strict_cipher_list(SSL_CTX *ctx, 1488 const char *str); 1489 1490 // SSL_CTX_set_cipher_list configures the cipher list for |ctx|, evaluating 1491 // |str| as a cipher string. It returns one on success and zero on failure. 1492 // 1493 // Prefer to use |SSL_CTX_set_strict_cipher_list|. This function tolerates 1494 // garbage inputs, unless an empty cipher list results. 1495 OPENSSL_EXPORT int SSL_CTX_set_cipher_list(SSL_CTX *ctx, const char *str); 1496 1497 // SSL_set_strict_cipher_list configures the cipher list for |ssl|, evaluating 1498 // |str| as a cipher string and returning error if |str| contains anything 1499 // meaningless. It returns one on success and zero on failure. 1500 OPENSSL_EXPORT int SSL_set_strict_cipher_list(SSL *ssl, const char *str); 1501 1502 // SSL_set_cipher_list configures the cipher list for |ssl|, evaluating |str| as 1503 // a cipher string. It returns one on success and zero on failure. 1504 // 1505 // Prefer to use |SSL_set_strict_cipher_list|. This function tolerates garbage 1506 // inputs, unless an empty cipher list results. 1507 OPENSSL_EXPORT int SSL_set_cipher_list(SSL *ssl, const char *str); 1508 1509 // SSL_CTX_get_ciphers returns the cipher list for |ctx|, in order of 1510 // preference. 1511 OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_CTX_get_ciphers(const SSL_CTX *ctx); 1512 1513 // SSL_CTX_cipher_in_group returns one if the |i|th cipher (see 1514 // |SSL_CTX_get_ciphers|) is in the same equipreference group as the one 1515 // following it and zero otherwise. 1516 OPENSSL_EXPORT int SSL_CTX_cipher_in_group(const SSL_CTX *ctx, size_t i); 1517 1518 // SSL_get_ciphers returns the cipher list for |ssl|, in order of preference. 1519 OPENSSL_EXPORT STACK_OF(SSL_CIPHER) *SSL_get_ciphers(const SSL *ssl); 1520 1521 1522 // Connection information. 1523 1524 // SSL_is_init_finished returns one if |ssl| has completed its initial handshake 1525 // and has no pending handshake. It returns zero otherwise. 1526 OPENSSL_EXPORT int SSL_is_init_finished(const SSL *ssl); 1527 1528 // SSL_in_init returns one if |ssl| has a pending handshake and zero 1529 // otherwise. 1530 OPENSSL_EXPORT int SSL_in_init(const SSL *ssl); 1531 1532 // SSL_in_false_start returns one if |ssl| has a pending handshake that is in 1533 // False Start. |SSL_write| may be called at this point without waiting for the 1534 // peer, but |SSL_read| will complete the handshake before accepting application 1535 // data. 1536 // 1537 // See also |SSL_MODE_ENABLE_FALSE_START|. 1538 OPENSSL_EXPORT int SSL_in_false_start(const SSL *ssl); 1539 1540 // SSL_get_peer_certificate returns the peer's leaf certificate or NULL if the 1541 // peer did not use certificates. The caller must call |X509_free| on the 1542 // result to release it. 1543 OPENSSL_EXPORT X509 *SSL_get_peer_certificate(const SSL *ssl); 1544 1545 // SSL_get_peer_cert_chain returns the peer's certificate chain or NULL if 1546 // unavailable or the peer did not use certificates. This is the unverified list 1547 // of certificates as sent by the peer, not the final chain built during 1548 // verification. The caller does not take ownership of the result. 1549 // 1550 // WARNING: This function behaves differently between client and server. If 1551 // |ssl| is a server, the returned chain does not include the leaf certificate. 1552 // If a client, it does. 1553 OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl); 1554 1555 // SSL_get_peer_full_cert_chain returns the peer's certificate chain, or NULL if 1556 // unavailable or the peer did not use certificates. This is the unverified list 1557 // of certificates as sent by the peer, not the final chain built during 1558 // verification. The caller does not take ownership of the result. 1559 // 1560 // This is the same as |SSL_get_peer_cert_chain| except that this function 1561 // always returns the full chain, i.e. the first element of the return value 1562 // (if any) will be the leaf certificate. In constrast, 1563 // |SSL_get_peer_cert_chain| returns only the intermediate certificates if the 1564 // |ssl| is a server. 1565 OPENSSL_EXPORT STACK_OF(X509) *SSL_get_peer_full_cert_chain(const SSL *ssl); 1566 1567 // SSL_get0_peer_certificates returns the peer's certificate chain, or NULL if 1568 // unavailable or the peer did not use certificates. This is the unverified list 1569 // of certificates as sent by the peer, not the final chain built during 1570 // verification. The caller does not take ownership of the result. 1571 // 1572 // This is the |CRYPTO_BUFFER| variant of |SSL_get_peer_full_cert_chain|. 1573 OPENSSL_EXPORT const STACK_OF(CRYPTO_BUFFER) * 1574 SSL_get0_peer_certificates(const SSL *ssl); 1575 1576 // SSL_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to point to 1577 // |*out_len| bytes of SCT information from the server. This is only valid if 1578 // |ssl| is a client. The SCT information is a SignedCertificateTimestampList 1579 // (including the two leading length bytes). 1580 // See https://tools.ietf.org/html/rfc6962#section-3.3 1581 // If no SCT was received then |*out_len| will be zero on return. 1582 // 1583 // WARNING: the returned data is not guaranteed to be well formed. 1584 OPENSSL_EXPORT void SSL_get0_signed_cert_timestamp_list(const SSL *ssl, 1585 const uint8_t **out, 1586 size_t *out_len); 1587 1588 // SSL_get0_ocsp_response sets |*out| and |*out_len| to point to |*out_len| 1589 // bytes of an OCSP response from the server. This is the DER encoding of an 1590 // OCSPResponse type as defined in RFC 2560. 1591 // 1592 // WARNING: the returned data is not guaranteed to be well formed. 1593 OPENSSL_EXPORT void SSL_get0_ocsp_response(const SSL *ssl, const uint8_t **out, 1594 size_t *out_len); 1595 1596 // SSL_get_tls_unique writes at most |max_out| bytes of the tls-unique value 1597 // for |ssl| to |out| and sets |*out_len| to the number of bytes written. It 1598 // returns one on success or zero on error. In general |max_out| should be at 1599 // least 12. 1600 // 1601 // This function will always fail if the initial handshake has not completed. 1602 // The tls-unique value will change after a renegotiation but, since 1603 // renegotiations can be initiated by the server at any point, the higher-level 1604 // protocol must either leave them disabled or define states in which the 1605 // tls-unique value can be read. 1606 // 1607 // The tls-unique value is defined by 1608 // https://tools.ietf.org/html/rfc5929#section-3.1. Due to a weakness in the 1609 // TLS protocol, tls-unique is broken for resumed connections unless the 1610 // Extended Master Secret extension is negotiated. Thus this function will 1611 // return zero if |ssl| performed session resumption unless EMS was used when 1612 // negotiating the original session. 1613 OPENSSL_EXPORT int SSL_get_tls_unique(const SSL *ssl, uint8_t *out, 1614 size_t *out_len, size_t max_out); 1615 1616 // SSL_get_extms_support returns one if the Extended Master Secret extension or 1617 // TLS 1.3 was negotiated. Otherwise, it returns zero. 1618 OPENSSL_EXPORT int SSL_get_extms_support(const SSL *ssl); 1619 1620 // SSL_get_current_cipher returns cipher suite used by |ssl|, or NULL if it has 1621 // not been negotiated yet. 1622 OPENSSL_EXPORT const SSL_CIPHER *SSL_get_current_cipher(const SSL *ssl); 1623 1624 // SSL_session_reused returns one if |ssl| performed an abbreviated handshake 1625 // and zero otherwise. 1626 // 1627 // TODO(davidben): Hammer down the semantics of this API while a handshake, 1628 // initial or renego, is in progress. 1629 OPENSSL_EXPORT int SSL_session_reused(const SSL *ssl); 1630 1631 // SSL_get_secure_renegotiation_support returns one if the peer supports secure 1632 // renegotiation (RFC 5746) or TLS 1.3. Otherwise, it returns zero. 1633 OPENSSL_EXPORT int SSL_get_secure_renegotiation_support(const SSL *ssl); 1634 1635 // SSL_export_keying_material exports a value derived from the master secret, as 1636 // specified in RFC 5705. It writes |out_len| bytes to |out| given a label and 1637 // optional context. (Since a zero length context is allowed, the |use_context| 1638 // flag controls whether a context is included.) 1639 // 1640 // It returns one on success and zero otherwise. 1641 OPENSSL_EXPORT int SSL_export_keying_material( 1642 SSL *ssl, uint8_t *out, size_t out_len, const char *label, size_t label_len, 1643 const uint8_t *context, size_t context_len, int use_context); 1644 1645 1646 // Sessions. 1647 // 1648 // An |SSL_SESSION| represents an SSL session that may be resumed in an 1649 // abbreviated handshake. It is reference-counted and immutable. Once 1650 // established, an |SSL_SESSION| may be shared by multiple |SSL| objects on 1651 // different threads and must not be modified. 1652 // 1653 // Note the TLS notion of "session" is not suitable for application-level 1654 // session state. It is an optional caching mechanism for the handshake. Not all 1655 // connections within an application-level session will reuse TLS sessions. TLS 1656 // sessions may be dropped by the client or ignored by the server at any time. 1657 1658 DECLARE_PEM_rw(SSL_SESSION, SSL_SESSION) 1659 1660 // SSL_SESSION_new returns a newly-allocated blank |SSL_SESSION| or NULL on 1661 // error. This may be useful when writing tests but should otherwise not be 1662 // used. 1663 OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_new(const SSL_CTX *ctx); 1664 1665 // SSL_SESSION_up_ref increments the reference count of |session| and returns 1666 // one. 1667 OPENSSL_EXPORT int SSL_SESSION_up_ref(SSL_SESSION *session); 1668 1669 // SSL_SESSION_free decrements the reference count of |session|. If it reaches 1670 // zero, all data referenced by |session| and |session| itself are released. 1671 OPENSSL_EXPORT void SSL_SESSION_free(SSL_SESSION *session); 1672 1673 // SSL_SESSION_to_bytes serializes |in| into a newly allocated buffer and sets 1674 // |*out_data| to that buffer and |*out_len| to its length. The caller takes 1675 // ownership of the buffer and must call |OPENSSL_free| when done. It returns 1676 // one on success and zero on error. 1677 OPENSSL_EXPORT int SSL_SESSION_to_bytes(const SSL_SESSION *in, 1678 uint8_t **out_data, size_t *out_len); 1679 1680 // SSL_SESSION_to_bytes_for_ticket serializes |in|, but excludes the session 1681 // identification information, namely the session ID and ticket. 1682 OPENSSL_EXPORT int SSL_SESSION_to_bytes_for_ticket(const SSL_SESSION *in, 1683 uint8_t **out_data, 1684 size_t *out_len); 1685 1686 // SSL_SESSION_from_bytes parses |in_len| bytes from |in| as an SSL_SESSION. It 1687 // returns a newly-allocated |SSL_SESSION| on success or NULL on error. 1688 OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_from_bytes( 1689 const uint8_t *in, size_t in_len, const SSL_CTX *ctx); 1690 1691 // SSL_SESSION_get_version returns a string describing the TLS or DTLS version 1692 // |session| was established at. For example, "TLSv1.2" or "DTLSv1". 1693 OPENSSL_EXPORT const char *SSL_SESSION_get_version(const SSL_SESSION *session); 1694 1695 // SSL_SESSION_get_protocol_version returns the TLS or DTLS version |session| 1696 // was established at. 1697 OPENSSL_EXPORT uint16_t 1698 SSL_SESSION_get_protocol_version(const SSL_SESSION *session); 1699 1700 // SSL_SESSION_set_protocol_version sets |session|'s TLS or DTLS version to 1701 // |version|. This may be useful when writing tests but should otherwise not be 1702 // used. It returns one on success and zero on error. 1703 OPENSSL_EXPORT int SSL_SESSION_set_protocol_version(SSL_SESSION *session, 1704 uint16_t version); 1705 1706 // SSL_MAX_SSL_SESSION_ID_LENGTH is the maximum length of an SSL session ID. 1707 #define SSL_MAX_SSL_SESSION_ID_LENGTH 32 1708 1709 // SSL_SESSION_get_id returns a pointer to a buffer containing |session|'s 1710 // session ID and sets |*out_len| to its length. 1711 // 1712 // This function should only be used for implementing a TLS session cache. TLS 1713 // sessions are not suitable for application-level session state, and a session 1714 // ID is an implementation detail of the TLS resumption handshake mechanism. Not 1715 // all resumption flows use session IDs, and not all connections within an 1716 // application-level session will reuse TLS sessions. 1717 // 1718 // To determine if resumption occurred, use |SSL_session_reused| instead. 1719 // Comparing session IDs will not give the right result in all cases. 1720 // 1721 // As a workaround for some broken applications, BoringSSL sometimes synthesizes 1722 // arbitrary session IDs for non-ID-based sessions. This behavior may be 1723 // removed in the future. 1724 OPENSSL_EXPORT const uint8_t *SSL_SESSION_get_id(const SSL_SESSION *session, 1725 unsigned *out_len); 1726 1727 // SSL_SESSION_set1_id sets |session|'s session ID to |sid|, It returns one on 1728 // success and zero on error. This function may be useful in writing tests but 1729 // otherwise should not be used. 1730 OPENSSL_EXPORT int SSL_SESSION_set1_id(SSL_SESSION *session, const uint8_t *sid, 1731 size_t sid_len); 1732 1733 // SSL_SESSION_get_time returns the time at which |session| was established in 1734 // seconds since the UNIX epoch. 1735 OPENSSL_EXPORT uint64_t SSL_SESSION_get_time(const SSL_SESSION *session); 1736 1737 // SSL_SESSION_get_timeout returns the lifetime of |session| in seconds. 1738 OPENSSL_EXPORT uint32_t SSL_SESSION_get_timeout(const SSL_SESSION *session); 1739 1740 // SSL_SESSION_get0_peer returns the peer leaf certificate stored in 1741 // |session|. 1742 // 1743 // TODO(davidben): This should return a const X509 *. 1744 OPENSSL_EXPORT X509 *SSL_SESSION_get0_peer(const SSL_SESSION *session); 1745 1746 // SSL_SESSION_get0_peer_certificates returns the peer certificate chain stored 1747 // in |session|, or NULL if the peer did not use certificates. This is the 1748 // unverified list of certificates as sent by the peer, not the final chain 1749 // built during verification. The caller does not take ownership of the result. 1750 OPENSSL_EXPORT const STACK_OF(CRYPTO_BUFFER) * 1751 SSL_SESSION_get0_peer_certificates(const SSL_SESSION *session); 1752 1753 // SSL_SESSION_get0_signed_cert_timestamp_list sets |*out| and |*out_len| to 1754 // point to |*out_len| bytes of SCT information stored in |session|. This is 1755 // only valid for client sessions. The SCT information is a 1756 // SignedCertificateTimestampList (including the two leading length bytes). See 1757 // https://tools.ietf.org/html/rfc6962#section-3.3 If no SCT was received then 1758 // |*out_len| will be zero on return. 1759 // 1760 // WARNING: the returned data is not guaranteed to be well formed. 1761 OPENSSL_EXPORT void SSL_SESSION_get0_signed_cert_timestamp_list( 1762 const SSL_SESSION *session, const uint8_t **out, size_t *out_len); 1763 1764 // SSL_SESSION_get0_ocsp_response sets |*out| and |*out_len| to point to 1765 // |*out_len| bytes of an OCSP response from the server. This is the DER 1766 // encoding of an OCSPResponse type as defined in RFC 2560. 1767 // 1768 // WARNING: the returned data is not guaranteed to be well formed. 1769 OPENSSL_EXPORT void SSL_SESSION_get0_ocsp_response(const SSL_SESSION *session, 1770 const uint8_t **out, 1771 size_t *out_len); 1772 1773 // SSL_MAX_MASTER_KEY_LENGTH is the maximum length of a master secret. 1774 #define SSL_MAX_MASTER_KEY_LENGTH 48 1775 1776 // SSL_SESSION_get_master_key writes up to |max_out| bytes of |session|'s secret 1777 // to |out| and returns the number of bytes written. If |max_out| is zero, it 1778 // returns the size of the secret. 1779 OPENSSL_EXPORT size_t SSL_SESSION_get_master_key(const SSL_SESSION *session, 1780 uint8_t *out, size_t max_out); 1781 1782 // SSL_SESSION_set_time sets |session|'s creation time to |time| and returns 1783 // |time|. This function may be useful in writing tests but otherwise should not 1784 // be used. 1785 OPENSSL_EXPORT uint64_t SSL_SESSION_set_time(SSL_SESSION *session, 1786 uint64_t time); 1787 1788 // SSL_SESSION_set_timeout sets |session|'s timeout to |timeout| and returns 1789 // one. This function may be useful in writing tests but otherwise should not 1790 // be used. 1791 OPENSSL_EXPORT uint32_t SSL_SESSION_set_timeout(SSL_SESSION *session, 1792 uint32_t timeout); 1793 1794 // SSL_SESSION_get0_id_context returns a pointer to a buffer containing 1795 // |session|'s session ID context (see |SSL_CTX_set_session_id_context|) and 1796 // sets |*out_len| to its length. 1797 OPENSSL_EXPORT const uint8_t *SSL_SESSION_get0_id_context( 1798 const SSL_SESSION *session, unsigned *out_len); 1799 1800 // SSL_SESSION_set1_id_context sets |session|'s session ID context (see 1801 // |SSL_CTX_set_session_id_context|) to |sid_ctx|. It returns one on success and 1802 // zero on error. This function may be useful in writing tests but otherwise 1803 // should not be used. 1804 OPENSSL_EXPORT int SSL_SESSION_set1_id_context(SSL_SESSION *session, 1805 const uint8_t *sid_ctx, 1806 size_t sid_ctx_len); 1807 1808 // SSL_SESSION_should_be_single_use returns one if |session| should be 1809 // single-use (TLS 1.3 and later) and zero otherwise. 1810 // 1811 // If this function returns one, clients retain multiple sessions and use each 1812 // only once. This prevents passive observers from correlating connections with 1813 // tickets. See RFC 8446, appendix C.4. If it returns zero, |session| cannot be 1814 // used without leaking a correlator. 1815 OPENSSL_EXPORT int SSL_SESSION_should_be_single_use(const SSL_SESSION *session); 1816 1817 // SSL_SESSION_is_resumable returns one if |session| is complete and contains a 1818 // session ID or ticket. It returns zero otherwise. Note this function does not 1819 // ensure |session| will be resumed. It may be expired, dropped by the server, 1820 // or associated with incompatible parameters. 1821 OPENSSL_EXPORT int SSL_SESSION_is_resumable(const SSL_SESSION *session); 1822 1823 // SSL_SESSION_has_ticket returns one if |session| has a ticket and zero 1824 // otherwise. 1825 OPENSSL_EXPORT int SSL_SESSION_has_ticket(const SSL_SESSION *session); 1826 1827 // SSL_SESSION_get0_ticket sets |*out_ticket| and |*out_len| to |session|'s 1828 // ticket, or NULL and zero if it does not have one. |out_ticket| may be NULL 1829 // if only the ticket length is needed. 1830 OPENSSL_EXPORT void SSL_SESSION_get0_ticket(const SSL_SESSION *session, 1831 const uint8_t **out_ticket, 1832 size_t *out_len); 1833 1834 // SSL_SESSION_set_ticket sets |session|'s ticket to |ticket|. It returns one on 1835 // success and zero on error. This function may be useful in writing tests but 1836 // otherwise should not be used. 1837 OPENSSL_EXPORT int SSL_SESSION_set_ticket(SSL_SESSION *session, 1838 const uint8_t *ticket, 1839 size_t ticket_len); 1840 1841 // SSL_SESSION_get_ticket_lifetime_hint returns ticket lifetime hint of 1842 // |session| in seconds or zero if none was set. 1843 OPENSSL_EXPORT uint32_t 1844 SSL_SESSION_get_ticket_lifetime_hint(const SSL_SESSION *session); 1845 1846 // SSL_SESSION_get0_cipher returns the cipher negotiated by the connection which 1847 // established |session|. 1848 // 1849 // Note that, in TLS 1.3, there is no guarantee that resumptions with |session| 1850 // will use that cipher. Prefer calling |SSL_get_current_cipher| on the |SSL| 1851 // instead. 1852 OPENSSL_EXPORT const SSL_CIPHER *SSL_SESSION_get0_cipher( 1853 const SSL_SESSION *session); 1854 1855 // SSL_SESSION_has_peer_sha256 returns one if |session| has a SHA-256 hash of 1856 // the peer's certificate retained and zero if the peer did not present a 1857 // certificate or if this was not enabled when |session| was created. See also 1858 // |SSL_CTX_set_retain_only_sha256_of_client_certs|. 1859 OPENSSL_EXPORT int SSL_SESSION_has_peer_sha256(const SSL_SESSION *session); 1860 1861 // SSL_SESSION_get0_peer_sha256 sets |*out_ptr| and |*out_len| to the SHA-256 1862 // hash of the peer certificate retained in |session|, or NULL and zero if it 1863 // does not have one. See also |SSL_CTX_set_retain_only_sha256_of_client_certs|. 1864 OPENSSL_EXPORT void SSL_SESSION_get0_peer_sha256(const SSL_SESSION *session, 1865 const uint8_t **out_ptr, 1866 size_t *out_len); 1867 1868 1869 // Session caching. 1870 // 1871 // Session caching allows connections to be established more efficiently based 1872 // on saved parameters from a previous connection, called a session (see 1873 // |SSL_SESSION|). The client offers a saved session, using an opaque identifier 1874 // from a previous connection. The server may accept the session, if it has the 1875 // parameters available. Otherwise, it will decline and continue with a full 1876 // handshake. 1877 // 1878 // This requires both the client and the server to retain session state. A 1879 // client does so with a stateful session cache. A server may do the same or, if 1880 // supported by both sides, statelessly using session tickets. For more 1881 // information on the latter, see the next section. 1882 // 1883 // For a server, the library implements a built-in internal session cache as an 1884 // in-memory hash table. Servers may also use |SSL_CTX_sess_set_get_cb| and 1885 // |SSL_CTX_sess_set_new_cb| to implement a custom external session cache. In 1886 // particular, this may be used to share a session cache between multiple 1887 // servers in a large deployment. An external cache may be used in addition to 1888 // or instead of the internal one. Use |SSL_CTX_set_session_cache_mode| to 1889 // toggle the internal cache. 1890 // 1891 // For a client, the only option is an external session cache. Clients may use 1892 // |SSL_CTX_sess_set_new_cb| to register a callback for when new sessions are 1893 // available. These may be cached and, in subsequent compatible connections, 1894 // configured with |SSL_set_session|. 1895 // 1896 // Note that offering or accepting a session short-circuits certificate 1897 // verification and most parameter negotiation. Resuming sessions across 1898 // different contexts may result in security failures and surprising 1899 // behavior. For a typical client, this means sessions for different hosts must 1900 // be cached under different keys. A client that connects to the same host with, 1901 // e.g., different cipher suite settings or client certificates should also use 1902 // separate session caches between those contexts. Servers should also partition 1903 // session caches between SNI hosts with |SSL_CTX_set_session_id_context|. 1904 // 1905 // Note also, in TLS 1.2 and earlier, offering sessions allows passive observers 1906 // to correlate different client connections. TLS 1.3 and later fix this, 1907 // provided clients use sessions at most once. Session caches are managed by the 1908 // caller in BoringSSL, so this must be implemented externally. See 1909 // |SSL_SESSION_should_be_single_use| for details. 1910 1911 // SSL_SESS_CACHE_OFF disables all session caching. 1912 #define SSL_SESS_CACHE_OFF 0x0000 1913 1914 // SSL_SESS_CACHE_CLIENT enables session caching for a client. The internal 1915 // cache is never used on a client, so this only enables the callbacks. 1916 #define SSL_SESS_CACHE_CLIENT 0x0001 1917 1918 // SSL_SESS_CACHE_SERVER enables session caching for a server. 1919 #define SSL_SESS_CACHE_SERVER 0x0002 1920 1921 // SSL_SESS_CACHE_BOTH enables session caching for both client and server. 1922 #define SSL_SESS_CACHE_BOTH (SSL_SESS_CACHE_CLIENT | SSL_SESS_CACHE_SERVER) 1923 1924 // SSL_SESS_CACHE_NO_AUTO_CLEAR disables automatically calling 1925 // |SSL_CTX_flush_sessions| every 255 connections. 1926 #define SSL_SESS_CACHE_NO_AUTO_CLEAR 0x0080 1927 1928 // SSL_SESS_CACHE_NO_INTERNAL_LOOKUP, on a server, disables looking up a session 1929 // from the internal session cache. 1930 #define SSL_SESS_CACHE_NO_INTERNAL_LOOKUP 0x0100 1931 1932 // SSL_SESS_CACHE_NO_INTERNAL_STORE, on a server, disables storing sessions in 1933 // the internal session cache. 1934 #define SSL_SESS_CACHE_NO_INTERNAL_STORE 0x0200 1935 1936 // SSL_SESS_CACHE_NO_INTERNAL, on a server, disables the internal session 1937 // cache. 1938 #define SSL_SESS_CACHE_NO_INTERNAL \ 1939 (SSL_SESS_CACHE_NO_INTERNAL_LOOKUP | SSL_SESS_CACHE_NO_INTERNAL_STORE) 1940 1941 // SSL_CTX_set_session_cache_mode sets the session cache mode bits for |ctx| to 1942 // |mode|. It returns the previous value. 1943 OPENSSL_EXPORT int SSL_CTX_set_session_cache_mode(SSL_CTX *ctx, int mode); 1944 1945 // SSL_CTX_get_session_cache_mode returns the session cache mode bits for 1946 // |ctx| 1947 OPENSSL_EXPORT int SSL_CTX_get_session_cache_mode(const SSL_CTX *ctx); 1948 1949 // SSL_set_session, for a client, configures |ssl| to offer to resume |session| 1950 // in the initial handshake and returns one. The caller retains ownership of 1951 // |session|. Note that configuring a session assumes the authentication in the 1952 // session is valid. For callers that wish to revalidate the session before 1953 // offering, see |SSL_SESSION_get0_peer_certificates|, 1954 // |SSL_SESSION_get0_signed_cert_timestamp_list|, and 1955 // |SSL_SESSION_get0_ocsp_response|. 1956 // 1957 // It is an error to call this function after the handshake has begun. 1958 OPENSSL_EXPORT int SSL_set_session(SSL *ssl, SSL_SESSION *session); 1959 1960 // SSL_DEFAULT_SESSION_TIMEOUT is the default lifetime, in seconds, of a 1961 // session in TLS 1.2 or earlier. This is how long we are willing to use the 1962 // secret to encrypt traffic without fresh key material. 1963 #define SSL_DEFAULT_SESSION_TIMEOUT (2 * 60 * 60) 1964 1965 // SSL_DEFAULT_SESSION_PSK_DHE_TIMEOUT is the default lifetime, in seconds, of a 1966 // session for TLS 1.3 psk_dhe_ke. This is how long we are willing to use the 1967 // secret as an authenticator. 1968 #define SSL_DEFAULT_SESSION_PSK_DHE_TIMEOUT (2 * 24 * 60 * 60) 1969 1970 // SSL_DEFAULT_SESSION_AUTH_TIMEOUT is the default non-renewable lifetime, in 1971 // seconds, of a TLS 1.3 session. This is how long we are willing to trust the 1972 // signature in the initial handshake. 1973 #define SSL_DEFAULT_SESSION_AUTH_TIMEOUT (7 * 24 * 60 * 60) 1974 1975 // SSL_CTX_set_timeout sets the lifetime, in seconds, of TLS 1.2 (or earlier) 1976 // sessions created in |ctx| to |timeout|. 1977 OPENSSL_EXPORT uint32_t SSL_CTX_set_timeout(SSL_CTX *ctx, uint32_t timeout); 1978 1979 // SSL_CTX_set_session_psk_dhe_timeout sets the lifetime, in seconds, of TLS 1.3 1980 // sessions created in |ctx| to |timeout|. 1981 OPENSSL_EXPORT void SSL_CTX_set_session_psk_dhe_timeout(SSL_CTX *ctx, 1982 uint32_t timeout); 1983 1984 // SSL_CTX_get_timeout returns the lifetime, in seconds, of TLS 1.2 (or earlier) 1985 // sessions created in |ctx|. 1986 OPENSSL_EXPORT uint32_t SSL_CTX_get_timeout(const SSL_CTX *ctx); 1987 1988 // SSL_MAX_SID_CTX_LENGTH is the maximum length of a session ID context. 1989 #define SSL_MAX_SID_CTX_LENGTH 32 1990 1991 // SSL_CTX_set_session_id_context sets |ctx|'s session ID context to |sid_ctx|. 1992 // It returns one on success and zero on error. The session ID context is an 1993 // application-defined opaque byte string. A session will not be used in a 1994 // connection without a matching session ID context. 1995 // 1996 // For a server, if |SSL_VERIFY_PEER| is enabled, it is an error to not set a 1997 // session ID context. 1998 OPENSSL_EXPORT int SSL_CTX_set_session_id_context(SSL_CTX *ctx, 1999 const uint8_t *sid_ctx, 2000 size_t sid_ctx_len); 2001 2002 // SSL_set_session_id_context sets |ssl|'s session ID context to |sid_ctx|. It 2003 // returns one on success and zero on error. See also 2004 // |SSL_CTX_set_session_id_context|. 2005 OPENSSL_EXPORT int SSL_set_session_id_context(SSL *ssl, const uint8_t *sid_ctx, 2006 size_t sid_ctx_len); 2007 2008 // SSL_get0_session_id_context returns a pointer to |ssl|'s session ID context 2009 // and sets |*out_len| to its length. It returns NULL on error. 2010 OPENSSL_EXPORT const uint8_t *SSL_get0_session_id_context(const SSL *ssl, 2011 size_t *out_len); 2012 2013 // SSL_SESSION_CACHE_MAX_SIZE_DEFAULT is the default maximum size of a session 2014 // cache. 2015 #define SSL_SESSION_CACHE_MAX_SIZE_DEFAULT (1024 * 20) 2016 2017 // SSL_CTX_sess_set_cache_size sets the maximum size of |ctx|'s internal session 2018 // cache to |size|. It returns the previous value. 2019 OPENSSL_EXPORT unsigned long SSL_CTX_sess_set_cache_size(SSL_CTX *ctx, 2020 unsigned long size); 2021 2022 // SSL_CTX_sess_get_cache_size returns the maximum size of |ctx|'s internal 2023 // session cache. 2024 OPENSSL_EXPORT unsigned long SSL_CTX_sess_get_cache_size(const SSL_CTX *ctx); 2025 2026 // SSL_CTX_sess_number returns the number of sessions in |ctx|'s internal 2027 // session cache. 2028 OPENSSL_EXPORT size_t SSL_CTX_sess_number(const SSL_CTX *ctx); 2029 2030 // SSL_CTX_add_session inserts |session| into |ctx|'s internal session cache. It 2031 // returns one on success and zero on error or if |session| is already in the 2032 // cache. The caller retains its reference to |session|. 2033 OPENSSL_EXPORT int SSL_CTX_add_session(SSL_CTX *ctx, SSL_SESSION *session); 2034 2035 // SSL_CTX_remove_session removes |session| from |ctx|'s internal session cache. 2036 // It returns one on success and zero if |session| was not in the cache. 2037 OPENSSL_EXPORT int SSL_CTX_remove_session(SSL_CTX *ctx, SSL_SESSION *session); 2038 2039 // SSL_CTX_flush_sessions removes all sessions from |ctx| which have expired as 2040 // of time |time|. If |time| is zero, all sessions are removed. 2041 OPENSSL_EXPORT void SSL_CTX_flush_sessions(SSL_CTX *ctx, uint64_t time); 2042 2043 // SSL_CTX_sess_set_new_cb sets the callback to be called when a new session is 2044 // established and ready to be cached. If the session cache is disabled (the 2045 // appropriate one of |SSL_SESS_CACHE_CLIENT| or |SSL_SESS_CACHE_SERVER| is 2046 // unset), the callback is not called. 2047 // 2048 // The callback is passed a reference to |session|. It returns one if it takes 2049 // ownership (and then calls |SSL_SESSION_free| when done) and zero otherwise. A 2050 // consumer which places |session| into an in-memory cache will likely return 2051 // one, with the cache calling |SSL_SESSION_free|. A consumer which serializes 2052 // |session| with |SSL_SESSION_to_bytes| may not need to retain |session| and 2053 // will likely return zero. Returning one is equivalent to calling 2054 // |SSL_SESSION_up_ref| and then returning zero. 2055 // 2056 // Note: For a client, the callback may be called on abbreviated handshakes if a 2057 // ticket is renewed. Further, it may not be called until some time after 2058 // |SSL_do_handshake| or |SSL_connect| completes if False Start is enabled. Thus 2059 // it's recommended to use this callback over calling |SSL_get_session| on 2060 // handshake completion. 2061 OPENSSL_EXPORT void SSL_CTX_sess_set_new_cb( 2062 SSL_CTX *ctx, int (*new_session_cb)(SSL *ssl, SSL_SESSION *session)); 2063 2064 // SSL_CTX_sess_get_new_cb returns the callback set by 2065 // |SSL_CTX_sess_set_new_cb|. 2066 OPENSSL_EXPORT int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))( 2067 SSL *ssl, SSL_SESSION *session); 2068 2069 // SSL_CTX_sess_set_remove_cb sets a callback which is called when a session is 2070 // removed from the internal session cache. 2071 // 2072 // TODO(davidben): What is the point of this callback? It seems useless since it 2073 // only fires on sessions in the internal cache. 2074 OPENSSL_EXPORT void SSL_CTX_sess_set_remove_cb( 2075 SSL_CTX *ctx, 2076 void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *session)); 2077 2078 // SSL_CTX_sess_get_remove_cb returns the callback set by 2079 // |SSL_CTX_sess_set_remove_cb|. 2080 OPENSSL_EXPORT void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))( 2081 SSL_CTX *ctx, SSL_SESSION *session); 2082 2083 // SSL_CTX_sess_set_get_cb sets a callback to look up a session by ID for a 2084 // server. The callback is passed the session ID and should return a matching 2085 // |SSL_SESSION| or NULL if not found. It should set |*out_copy| to zero and 2086 // return a new reference to the session. This callback is not used for a 2087 // client. 2088 // 2089 // For historical reasons, if |*out_copy| is set to one (default), the SSL 2090 // library will take a new reference to the returned |SSL_SESSION|, expecting 2091 // the callback to return a non-owning pointer. This is not recommended. If 2092 // |ctx| and thus the callback is used on multiple threads, the session may be 2093 // removed and invalidated before the SSL library calls |SSL_SESSION_up_ref|, 2094 // whereas the callback may synchronize internally. 2095 // 2096 // To look up a session asynchronously, the callback may return 2097 // |SSL_magic_pending_session_ptr|. See the documentation for that function and 2098 // |SSL_ERROR_PENDING_SESSION|. 2099 // 2100 // If the internal session cache is enabled, the callback is only consulted if 2101 // the internal cache does not return a match. 2102 OPENSSL_EXPORT void SSL_CTX_sess_set_get_cb( 2103 SSL_CTX *ctx, SSL_SESSION *(*get_session_cb)(SSL *ssl, const uint8_t *id, 2104 int id_len, int *out_copy)); 2105 2106 // SSL_CTX_sess_get_get_cb returns the callback set by 2107 // |SSL_CTX_sess_set_get_cb|. 2108 OPENSSL_EXPORT SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))( 2109 SSL *ssl, const uint8_t *id, int id_len, int *out_copy); 2110 2111 // SSL_magic_pending_session_ptr returns a magic |SSL_SESSION|* which indicates 2112 // that the session isn't currently unavailable. |SSL_get_error| will then 2113 // return |SSL_ERROR_PENDING_SESSION| and the handshake can be retried later 2114 // when the lookup has completed. 2115 OPENSSL_EXPORT SSL_SESSION *SSL_magic_pending_session_ptr(void); 2116 2117 2118 // Session tickets. 2119 // 2120 // Session tickets, from RFC 5077, allow session resumption without server-side 2121 // state. The server maintains a secret ticket key and sends the client opaque 2122 // encrypted session parameters, called a ticket. When offering the session, the 2123 // client sends the ticket which the server decrypts to recover session state. 2124 // Session tickets are enabled by default but may be disabled with 2125 // |SSL_OP_NO_TICKET|. 2126 // 2127 // On the client, ticket-based sessions use the same APIs as ID-based tickets. 2128 // Callers do not need to handle them differently. 2129 // 2130 // On the server, tickets are encrypted and authenticated with a secret key. 2131 // By default, an |SSL_CTX| will manage session ticket encryption keys by 2132 // generating them internally and rotating every 48 hours. Tickets are minted 2133 // and processed transparently. The following functions may be used to configure 2134 // a persistent key or implement more custom behavior, including key rotation 2135 // and sharing keys between multiple servers in a large deployment. There are 2136 // three levels of customisation possible: 2137 // 2138 // 1) One can simply set the keys with |SSL_CTX_set_tlsext_ticket_keys|. 2139 // 2) One can configure an |EVP_CIPHER_CTX| and |HMAC_CTX| directly for 2140 // encryption and authentication. 2141 // 3) One can configure an |SSL_TICKET_AEAD_METHOD| to have more control 2142 // and the option of asynchronous decryption. 2143 // 2144 // An attacker that compromises a server's session ticket key can impersonate 2145 // the server and, prior to TLS 1.3, retroactively decrypt all application 2146 // traffic from sessions using that ticket key. Thus ticket keys must be 2147 // regularly rotated for forward secrecy. Note the default key is rotated 2148 // automatically once every 48 hours but manually configured keys are not. 2149 2150 // SSL_DEFAULT_TICKET_KEY_ROTATION_INTERVAL is the interval with which the 2151 // default session ticket encryption key is rotated, if in use. If any 2152 // non-default ticket encryption mechanism is configured, automatic rotation is 2153 // disabled. 2154 #define SSL_DEFAULT_TICKET_KEY_ROTATION_INTERVAL (2 * 24 * 60 * 60) 2155 2156 // SSL_CTX_get_tlsext_ticket_keys writes |ctx|'s session ticket key material to 2157 // |len| bytes of |out|. It returns one on success and zero if |len| is not 2158 // 48. If |out| is NULL, it returns 48 instead. 2159 OPENSSL_EXPORT int SSL_CTX_get_tlsext_ticket_keys(SSL_CTX *ctx, void *out, 2160 size_t len); 2161 2162 // SSL_CTX_set_tlsext_ticket_keys sets |ctx|'s session ticket key material to 2163 // |len| bytes of |in|. It returns one on success and zero if |len| is not 2164 // 48. If |in| is NULL, it returns 48 instead. 2165 OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_keys(SSL_CTX *ctx, const void *in, 2166 size_t len); 2167 2168 // SSL_TICKET_KEY_NAME_LEN is the length of the key name prefix of a session 2169 // ticket. 2170 #define SSL_TICKET_KEY_NAME_LEN 16 2171 2172 // SSL_CTX_set_tlsext_ticket_key_cb sets the ticket callback to |callback| and 2173 // returns one. |callback| will be called when encrypting a new ticket and when 2174 // decrypting a ticket from the client. 2175 // 2176 // In both modes, |ctx| and |hmac_ctx| will already have been initialized with 2177 // |EVP_CIPHER_CTX_init| and |HMAC_CTX_init|, respectively. |callback| 2178 // configures |hmac_ctx| with an HMAC digest and key, and configures |ctx| 2179 // for encryption or decryption, based on the mode. 2180 // 2181 // When encrypting a new ticket, |encrypt| will be one. It writes a public 2182 // 16-byte key name to |key_name| and a fresh IV to |iv|. The output IV length 2183 // must match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode, 2184 // |callback| returns 1 on success and -1 on error. 2185 // 2186 // When decrypting a ticket, |encrypt| will be zero. |key_name| will point to a 2187 // 16-byte key name and |iv| points to an IV. The length of the IV consumed must 2188 // match |EVP_CIPHER_CTX_iv_length| of the cipher selected. In this mode, 2189 // |callback| returns -1 to abort the handshake, 0 if decrypting the ticket 2190 // failed, and 1 or 2 on success. If it returns 2, the ticket will be renewed. 2191 // This may be used to re-key the ticket. 2192 // 2193 // WARNING: |callback| wildly breaks the usual return value convention and is 2194 // called in two different modes. 2195 OPENSSL_EXPORT int SSL_CTX_set_tlsext_ticket_key_cb( 2196 SSL_CTX *ctx, int (*callback)(SSL *ssl, uint8_t *key_name, uint8_t *iv, 2197 EVP_CIPHER_CTX *ctx, HMAC_CTX *hmac_ctx, 2198 int encrypt)); 2199 2200 // ssl_ticket_aead_result_t enumerates the possible results from decrypting a 2201 // ticket with an |SSL_TICKET_AEAD_METHOD|. 2202 enum ssl_ticket_aead_result_t BORINGSSL_ENUM_INT { 2203 // ssl_ticket_aead_success indicates that the ticket was successfully 2204 // decrypted. 2205 ssl_ticket_aead_success, 2206 // ssl_ticket_aead_retry indicates that the operation could not be 2207 // immediately completed and must be reattempted, via |open|, at a later 2208 // point. 2209 ssl_ticket_aead_retry, 2210 // ssl_ticket_aead_ignore_ticket indicates that the ticket should be ignored 2211 // (i.e. is corrupt or otherwise undecryptable). 2212 ssl_ticket_aead_ignore_ticket, 2213 // ssl_ticket_aead_error indicates that a fatal error occured and the 2214 // handshake should be terminated. 2215 ssl_ticket_aead_error, 2216 }; 2217 2218 // ssl_ticket_aead_method_st (aka |SSL_TICKET_AEAD_METHOD|) contains methods 2219 // for encrypting and decrypting session tickets. 2220 struct ssl_ticket_aead_method_st { 2221 // max_overhead returns the maximum number of bytes of overhead that |seal| 2222 // may add. 2223 size_t (*max_overhead)(SSL *ssl); 2224 2225 // seal encrypts and authenticates |in_len| bytes from |in|, writes, at most, 2226 // |max_out_len| bytes to |out|, and puts the number of bytes written in 2227 // |*out_len|. The |in| and |out| buffers may be equal but will not otherwise 2228 // alias. It returns one on success or zero on error. 2229 int (*seal)(SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out_len, 2230 const uint8_t *in, size_t in_len); 2231 2232 // open authenticates and decrypts |in_len| bytes from |in|, writes, at most, 2233 // |max_out_len| bytes of plaintext to |out|, and puts the number of bytes 2234 // written in |*out_len|. The |in| and |out| buffers may be equal but will 2235 // not otherwise alias. See |ssl_ticket_aead_result_t| for details of the 2236 // return values. In the case that a retry is indicated, the caller should 2237 // arrange for the high-level operation on |ssl| to be retried when the 2238 // operation is completed, which will result in another call to |open|. 2239 enum ssl_ticket_aead_result_t (*open)(SSL *ssl, uint8_t *out, size_t *out_len, 2240 size_t max_out_len, const uint8_t *in, 2241 size_t in_len); 2242 }; 2243 2244 // SSL_CTX_set_ticket_aead_method configures a custom ticket AEAD method table 2245 // on |ctx|. |aead_method| must remain valid for the lifetime of |ctx|. 2246 OPENSSL_EXPORT void SSL_CTX_set_ticket_aead_method( 2247 SSL_CTX *ctx, const SSL_TICKET_AEAD_METHOD *aead_method); 2248 2249 // SSL_process_tls13_new_session_ticket processes an unencrypted TLS 1.3 2250 // NewSessionTicket message from |buf| and returns a resumable |SSL_SESSION|, 2251 // or NULL on error. The caller takes ownership of the returned session and 2252 // must call |SSL_SESSION_free| to free it. 2253 // 2254 // |buf| contains |buf_len| bytes that represents a complete NewSessionTicket 2255 // message including its header, i.e., one byte for the type (0x04) and three 2256 // bytes for the length. |buf| must contain only one such message. 2257 // 2258 // This function may be used to process NewSessionTicket messages in TLS 1.3 2259 // clients that are handling the record layer externally. 2260 OPENSSL_EXPORT SSL_SESSION *SSL_process_tls13_new_session_ticket( 2261 SSL *ssl, const uint8_t *buf, size_t buf_len); 2262 2263 2264 // Elliptic curve Diffie-Hellman. 2265 // 2266 // Cipher suites using an ECDHE key exchange perform Diffie-Hellman over an 2267 // elliptic curve negotiated by both endpoints. See RFC 4492. Only named curves 2268 // are supported. ECDHE is always enabled, but the curve preferences may be 2269 // configured with these functions. 2270 // 2271 // Note that TLS 1.3 renames these from curves to groups. For consistency, we 2272 // currently use the TLS 1.2 name in the API. 2273 2274 // SSL_CTX_set1_curves sets the preferred curves for |ctx| to be |curves|. Each 2275 // element of |curves| should be a curve nid. It returns one on success and 2276 // zero on failure. 2277 // 2278 // Note that this API uses nid values from nid.h and not the |SSL_CURVE_*| 2279 // values defined below. 2280 OPENSSL_EXPORT int SSL_CTX_set1_curves(SSL_CTX *ctx, const int *curves, 2281 size_t curves_len); 2282 2283 // SSL_set1_curves sets the preferred curves for |ssl| to be |curves|. Each 2284 // element of |curves| should be a curve nid. It returns one on success and 2285 // zero on failure. 2286 // 2287 // Note that this API uses nid values from nid.h and not the |SSL_CURVE_*| 2288 // values defined below. 2289 OPENSSL_EXPORT int SSL_set1_curves(SSL *ssl, const int *curves, 2290 size_t curves_len); 2291 2292 // SSL_CTX_set1_curves_list sets the preferred curves for |ctx| to be the 2293 // colon-separated list |curves|. Each element of |curves| should be a curve 2294 // name (e.g. P-256, X25519, ...). It returns one on success and zero on 2295 // failure. 2296 OPENSSL_EXPORT int SSL_CTX_set1_curves_list(SSL_CTX *ctx, const char *curves); 2297 2298 // SSL_set1_curves_list sets the preferred curves for |ssl| to be the 2299 // colon-separated list |curves|. Each element of |curves| should be a curve 2300 // name (e.g. P-256, X25519, ...). It returns one on success and zero on 2301 // failure. 2302 OPENSSL_EXPORT int SSL_set1_curves_list(SSL *ssl, const char *curves); 2303 2304 // SSL_CURVE_* define TLS curve IDs. 2305 #define SSL_CURVE_SECP224R1 21 2306 #define SSL_CURVE_SECP256R1 23 2307 #define SSL_CURVE_SECP384R1 24 2308 #define SSL_CURVE_SECP521R1 25 2309 #define SSL_CURVE_X25519 29 2310 #define SSL_CURVE_CECPQ2 16696 2311 2312 // SSL_get_curve_id returns the ID of the curve used by |ssl|'s most recently 2313 // completed handshake or 0 if not applicable. 2314 // 2315 // TODO(davidben): This API currently does not work correctly if there is a 2316 // renegotiation in progress. Fix this. 2317 OPENSSL_EXPORT uint16_t SSL_get_curve_id(const SSL *ssl); 2318 2319 // SSL_get_curve_name returns a human-readable name for the curve specified by 2320 // the given TLS curve id, or NULL if the curve is unknown. 2321 OPENSSL_EXPORT const char *SSL_get_curve_name(uint16_t curve_id); 2322 2323 2324 // Certificate verification. 2325 // 2326 // SSL may authenticate either endpoint with an X.509 certificate. Typically 2327 // this is used to authenticate the server to the client. These functions 2328 // configure certificate verification. 2329 // 2330 // WARNING: By default, certificate verification errors on a client are not 2331 // fatal. See |SSL_VERIFY_NONE| This may be configured with 2332 // |SSL_CTX_set_verify|. 2333 // 2334 // By default clients are anonymous but a server may request a certificate from 2335 // the client by setting |SSL_VERIFY_PEER|. 2336 // 2337 // Many of these functions use OpenSSL's legacy X.509 stack which is 2338 // underdocumented and deprecated, but the replacement isn't ready yet. For 2339 // now, consumers may use the existing stack or bypass it by performing 2340 // certificate verification externally. This may be done with 2341 // |SSL_CTX_set_cert_verify_callback| or by extracting the chain with 2342 // |SSL_get_peer_cert_chain| after the handshake. In the future, functions will 2343 // be added to use the SSL stack without dependency on any part of the legacy 2344 // X.509 and ASN.1 stack. 2345 // 2346 // To augment certificate verification, a client may also enable OCSP stapling 2347 // (RFC 6066) and Certificate Transparency (RFC 6962) extensions. 2348 2349 // SSL_VERIFY_NONE, on a client, verifies the server certificate but does not 2350 // make errors fatal. The result may be checked with |SSL_get_verify_result|. On 2351 // a server it does not request a client certificate. This is the default. 2352 #define SSL_VERIFY_NONE 0x00 2353 2354 // SSL_VERIFY_PEER, on a client, makes server certificate errors fatal. On a 2355 // server it requests a client certificate and makes errors fatal. However, 2356 // anonymous clients are still allowed. See 2357 // |SSL_VERIFY_FAIL_IF_NO_PEER_CERT|. 2358 #define SSL_VERIFY_PEER 0x01 2359 2360 // SSL_VERIFY_FAIL_IF_NO_PEER_CERT configures a server to reject connections if 2361 // the client declines to send a certificate. This flag must be used together 2362 // with |SSL_VERIFY_PEER|, otherwise it won't work. 2363 #define SSL_VERIFY_FAIL_IF_NO_PEER_CERT 0x02 2364 2365 // SSL_VERIFY_PEER_IF_NO_OBC configures a server to request a client certificate 2366 // if and only if Channel ID is not negotiated. 2367 #define SSL_VERIFY_PEER_IF_NO_OBC 0x04 2368 2369 // SSL_CTX_set_verify configures certificate verification behavior. |mode| is 2370 // one of the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is 2371 // used to customize certificate verification. See the behavior of 2372 // |X509_STORE_CTX_set_verify_cb|. 2373 // 2374 // The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with 2375 // |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. 2376 OPENSSL_EXPORT void SSL_CTX_set_verify( 2377 SSL_CTX *ctx, int mode, int (*callback)(int ok, X509_STORE_CTX *store_ctx)); 2378 2379 // SSL_set_verify configures certificate verification behavior. |mode| is one of 2380 // the |SSL_VERIFY_*| values defined above. |callback|, if not NULL, is used to 2381 // customize certificate verification. See the behavior of 2382 // |X509_STORE_CTX_set_verify_cb|. 2383 // 2384 // The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| with 2385 // |X509_STORE_CTX_get_ex_data| to look up the |SSL| from |store_ctx|. 2386 OPENSSL_EXPORT void SSL_set_verify(SSL *ssl, int mode, 2387 int (*callback)(int ok, 2388 X509_STORE_CTX *store_ctx)); 2389 2390 enum ssl_verify_result_t BORINGSSL_ENUM_INT { 2391 ssl_verify_ok, 2392 ssl_verify_invalid, 2393 ssl_verify_retry, 2394 }; 2395 2396 // SSL_CTX_set_custom_verify configures certificate verification. |mode| is one 2397 // of the |SSL_VERIFY_*| values defined above. |callback| performs the 2398 // certificate verification. 2399 // 2400 // The callback may call |SSL_get0_peer_certificates| for the certificate chain 2401 // to validate. The callback should return |ssl_verify_ok| if the certificate is 2402 // valid. If the certificate is invalid, the callback should return 2403 // |ssl_verify_invalid| and optionally set |*out_alert| to an alert to send to 2404 // the peer. Some useful alerts include |SSL_AD_CERTIFICATE_EXPIRED|, 2405 // |SSL_AD_CERTIFICATE_REVOKED|, |SSL_AD_UNKNOWN_CA|, |SSL_AD_BAD_CERTIFICATE|, 2406 // |SSL_AD_CERTIFICATE_UNKNOWN|, and |SSL_AD_INTERNAL_ERROR|. See RFC 5246 2407 // section 7.2.2 for their precise meanings. If unspecified, 2408 // |SSL_AD_CERTIFICATE_UNKNOWN| will be sent by default. 2409 // 2410 // To verify a certificate asynchronously, the callback may return 2411 // |ssl_verify_retry|. The handshake will then pause with |SSL_get_error| 2412 // returning |SSL_ERROR_WANT_CERTIFICATE_VERIFY|. 2413 OPENSSL_EXPORT void SSL_CTX_set_custom_verify( 2414 SSL_CTX *ctx, int mode, 2415 enum ssl_verify_result_t (*callback)(SSL *ssl, uint8_t *out_alert)); 2416 2417 // SSL_set_custom_verify behaves like |SSL_CTX_set_custom_verify| but configures 2418 // an individual |SSL|. 2419 OPENSSL_EXPORT void SSL_set_custom_verify( 2420 SSL *ssl, int mode, 2421 enum ssl_verify_result_t (*callback)(SSL *ssl, uint8_t *out_alert)); 2422 2423 // SSL_CTX_get_verify_mode returns |ctx|'s verify mode, set by 2424 // |SSL_CTX_set_verify|. 2425 OPENSSL_EXPORT int SSL_CTX_get_verify_mode(const SSL_CTX *ctx); 2426 2427 // SSL_get_verify_mode returns |ssl|'s verify mode, set by |SSL_CTX_set_verify| 2428 // or |SSL_set_verify|. It returns -1 on error. 2429 OPENSSL_EXPORT int SSL_get_verify_mode(const SSL *ssl); 2430 2431 // SSL_CTX_get_verify_callback returns the callback set by 2432 // |SSL_CTX_set_verify|. 2433 OPENSSL_EXPORT int (*SSL_CTX_get_verify_callback(const SSL_CTX *ctx))( 2434 int ok, X509_STORE_CTX *store_ctx); 2435 2436 // SSL_get_verify_callback returns the callback set by |SSL_CTX_set_verify| or 2437 // |SSL_set_verify|. 2438 OPENSSL_EXPORT int (*SSL_get_verify_callback(const SSL *ssl))( 2439 int ok, X509_STORE_CTX *store_ctx); 2440 2441 // SSL_CTX_set_verify_depth sets the maximum depth of a certificate chain 2442 // accepted in verification. This number does not include the leaf, so a depth 2443 // of 1 allows the leaf and one CA certificate. 2444 OPENSSL_EXPORT void SSL_CTX_set_verify_depth(SSL_CTX *ctx, int depth); 2445 2446 // SSL_set_verify_depth sets the maximum depth of a certificate chain accepted 2447 // in verification. This number does not include the leaf, so a depth of 1 2448 // allows the leaf and one CA certificate. 2449 OPENSSL_EXPORT void SSL_set_verify_depth(SSL *ssl, int depth); 2450 2451 // SSL_CTX_get_verify_depth returns the maximum depth of a certificate accepted 2452 // in verification. 2453 OPENSSL_EXPORT int SSL_CTX_get_verify_depth(const SSL_CTX *ctx); 2454 2455 // SSL_get_verify_depth returns the maximum depth of a certificate accepted in 2456 // verification. 2457 OPENSSL_EXPORT int SSL_get_verify_depth(const SSL *ssl); 2458 2459 // SSL_CTX_set1_param sets verification parameters from |param|. It returns one 2460 // on success and zero on failure. The caller retains ownership of |param|. 2461 OPENSSL_EXPORT int SSL_CTX_set1_param(SSL_CTX *ctx, 2462 const X509_VERIFY_PARAM *param); 2463 2464 // SSL_set1_param sets verification parameters from |param|. It returns one on 2465 // success and zero on failure. The caller retains ownership of |param|. 2466 OPENSSL_EXPORT int SSL_set1_param(SSL *ssl, 2467 const X509_VERIFY_PARAM *param); 2468 2469 // SSL_CTX_get0_param returns |ctx|'s |X509_VERIFY_PARAM| for certificate 2470 // verification. The caller must not release the returned pointer but may call 2471 // functions on it to configure it. 2472 OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_CTX_get0_param(SSL_CTX *ctx); 2473 2474 // SSL_get0_param returns |ssl|'s |X509_VERIFY_PARAM| for certificate 2475 // verification. The caller must not release the returned pointer but may call 2476 // functions on it to configure it. 2477 OPENSSL_EXPORT X509_VERIFY_PARAM *SSL_get0_param(SSL *ssl); 2478 2479 // SSL_CTX_set_purpose sets |ctx|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to 2480 // |purpose|. It returns one on success and zero on error. 2481 OPENSSL_EXPORT int SSL_CTX_set_purpose(SSL_CTX *ctx, int purpose); 2482 2483 // SSL_set_purpose sets |ssl|'s |X509_VERIFY_PARAM|'s 'purpose' parameter to 2484 // |purpose|. It returns one on success and zero on error. 2485 OPENSSL_EXPORT int SSL_set_purpose(SSL *ssl, int purpose); 2486 2487 // SSL_CTX_set_trust sets |ctx|'s |X509_VERIFY_PARAM|'s 'trust' parameter to 2488 // |trust|. It returns one on success and zero on error. 2489 OPENSSL_EXPORT int SSL_CTX_set_trust(SSL_CTX *ctx, int trust); 2490 2491 // SSL_set_trust sets |ssl|'s |X509_VERIFY_PARAM|'s 'trust' parameter to 2492 // |trust|. It returns one on success and zero on error. 2493 OPENSSL_EXPORT int SSL_set_trust(SSL *ssl, int trust); 2494 2495 // SSL_CTX_set_cert_store sets |ctx|'s certificate store to |store|. It takes 2496 // ownership of |store|. The store is used for certificate verification. 2497 // 2498 // The store is also used for the auto-chaining feature, but this is deprecated. 2499 // See also |SSL_MODE_NO_AUTO_CHAIN|. 2500 OPENSSL_EXPORT void SSL_CTX_set_cert_store(SSL_CTX *ctx, X509_STORE *store); 2501 2502 // SSL_CTX_get_cert_store returns |ctx|'s certificate store. 2503 OPENSSL_EXPORT X509_STORE *SSL_CTX_get_cert_store(const SSL_CTX *ctx); 2504 2505 // SSL_CTX_set_default_verify_paths loads the OpenSSL system-default trust 2506 // anchors into |ctx|'s store. It returns one on success and zero on failure. 2507 OPENSSL_EXPORT int SSL_CTX_set_default_verify_paths(SSL_CTX *ctx); 2508 2509 // SSL_CTX_load_verify_locations loads trust anchors into |ctx|'s store from 2510 // |ca_file| and |ca_dir|, either of which may be NULL. If |ca_file| is passed, 2511 // it is opened and PEM-encoded CA certificates are read. If |ca_dir| is passed, 2512 // it is treated as a directory in OpenSSL's hashed directory format. It returns 2513 // one on success and zero on failure. 2514 // 2515 // See 2516 // https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_load_verify_locations.html 2517 // for documentation on the directory format. 2518 OPENSSL_EXPORT int SSL_CTX_load_verify_locations(SSL_CTX *ctx, 2519 const char *ca_file, 2520 const char *ca_dir); 2521 2522 // SSL_get_verify_result returns the result of certificate verification. It is 2523 // either |X509_V_OK| or a |X509_V_ERR_*| value. 2524 OPENSSL_EXPORT long SSL_get_verify_result(const SSL *ssl); 2525 2526 // SSL_alert_from_verify_result returns the SSL alert code, such as 2527 // |SSL_AD_CERTIFICATE_EXPIRED|, that corresponds to an |X509_V_ERR_*| value. 2528 // The return value is always an alert, even when |result| is |X509_V_OK|. 2529 OPENSSL_EXPORT int SSL_alert_from_verify_result(long result); 2530 2531 // SSL_get_ex_data_X509_STORE_CTX_idx returns the ex_data index used to look up 2532 // the |SSL| associated with an |X509_STORE_CTX| in the verify callback. 2533 OPENSSL_EXPORT int SSL_get_ex_data_X509_STORE_CTX_idx(void); 2534 2535 // SSL_CTX_set_cert_verify_callback sets a custom callback to be called on 2536 // certificate verification rather than |X509_verify_cert|. |store_ctx| contains 2537 // the verification parameters. The callback should return one on success and 2538 // zero on fatal error. It may use |X509_STORE_CTX_set_error| to set a 2539 // verification result. 2540 // 2541 // The callback may use |SSL_get_ex_data_X509_STORE_CTX_idx| to recover the 2542 // |SSL| object from |store_ctx|. 2543 OPENSSL_EXPORT void SSL_CTX_set_cert_verify_callback( 2544 SSL_CTX *ctx, int (*callback)(X509_STORE_CTX *store_ctx, void *arg), 2545 void *arg); 2546 2547 // SSL_enable_signed_cert_timestamps causes |ssl| (which must be the client end 2548 // of a connection) to request SCTs from the server. See 2549 // https://tools.ietf.org/html/rfc6962. 2550 // 2551 // Call |SSL_get0_signed_cert_timestamp_list| to recover the SCT after the 2552 // handshake. 2553 OPENSSL_EXPORT void SSL_enable_signed_cert_timestamps(SSL *ssl); 2554 2555 // SSL_CTX_enable_signed_cert_timestamps enables SCT requests on all client SSL 2556 // objects created from |ctx|. 2557 // 2558 // Call |SSL_get0_signed_cert_timestamp_list| to recover the SCT after the 2559 // handshake. 2560 OPENSSL_EXPORT void SSL_CTX_enable_signed_cert_timestamps(SSL_CTX *ctx); 2561 2562 // SSL_enable_ocsp_stapling causes |ssl| (which must be the client end of a 2563 // connection) to request a stapled OCSP response from the server. 2564 // 2565 // Call |SSL_get0_ocsp_response| to recover the OCSP response after the 2566 // handshake. 2567 OPENSSL_EXPORT void SSL_enable_ocsp_stapling(SSL *ssl); 2568 2569 // SSL_CTX_enable_ocsp_stapling enables OCSP stapling on all client SSL objects 2570 // created from |ctx|. 2571 // 2572 // Call |SSL_get0_ocsp_response| to recover the OCSP response after the 2573 // handshake. 2574 OPENSSL_EXPORT void SSL_CTX_enable_ocsp_stapling(SSL_CTX *ctx); 2575 2576 // SSL_CTX_set0_verify_cert_store sets an |X509_STORE| that will be used 2577 // exclusively for certificate verification and returns one. Ownership of 2578 // |store| is transferred to the |SSL_CTX|. 2579 OPENSSL_EXPORT int SSL_CTX_set0_verify_cert_store(SSL_CTX *ctx, 2580 X509_STORE *store); 2581 2582 // SSL_CTX_set1_verify_cert_store sets an |X509_STORE| that will be used 2583 // exclusively for certificate verification and returns one. An additional 2584 // reference to |store| will be taken. 2585 OPENSSL_EXPORT int SSL_CTX_set1_verify_cert_store(SSL_CTX *ctx, 2586 X509_STORE *store); 2587 2588 // SSL_set0_verify_cert_store sets an |X509_STORE| that will be used 2589 // exclusively for certificate verification and returns one. Ownership of 2590 // |store| is transferred to the |SSL|. 2591 OPENSSL_EXPORT int SSL_set0_verify_cert_store(SSL *ssl, X509_STORE *store); 2592 2593 // SSL_set1_verify_cert_store sets an |X509_STORE| that will be used 2594 // exclusively for certificate verification and returns one. An additional 2595 // reference to |store| will be taken. 2596 OPENSSL_EXPORT int SSL_set1_verify_cert_store(SSL *ssl, X509_STORE *store); 2597 2598 // SSL_CTX_set_verify_algorithm_prefs configures |ctx| to use |prefs| as the 2599 // preference list when verifying signatures from the peer's long-term key. It 2600 // returns one on zero on error. |prefs| should not include the internal-only 2601 // value |SSL_SIGN_RSA_PKCS1_MD5_SHA1|. 2602 OPENSSL_EXPORT int SSL_CTX_set_verify_algorithm_prefs(SSL_CTX *ctx, 2603 const uint16_t *prefs, 2604 size_t num_prefs); 2605 2606 // SSL_set_verify_algorithm_prefs configures |ssl| to use |prefs| as the 2607 // preference list when verifying signatures from the peer's long-term key. It 2608 // returns one on zero on error. |prefs| should not include the internal-only 2609 // value |SSL_SIGN_RSA_PKCS1_MD5_SHA1|. 2610 OPENSSL_EXPORT int SSL_set_verify_algorithm_prefs(SSL *ssl, 2611 const uint16_t *prefs, 2612 size_t num_prefs); 2613 2614 2615 // Client certificate CA list. 2616 // 2617 // When requesting a client certificate, a server may advertise a list of 2618 // certificate authorities which are accepted. These functions may be used to 2619 // configure this list. 2620 2621 // SSL_set_client_CA_list sets |ssl|'s client certificate CA list to 2622 // |name_list|. It takes ownership of |name_list|. 2623 OPENSSL_EXPORT void SSL_set_client_CA_list(SSL *ssl, 2624 STACK_OF(X509_NAME) *name_list); 2625 2626 // SSL_CTX_set_client_CA_list sets |ctx|'s client certificate CA list to 2627 // |name_list|. It takes ownership of |name_list|. 2628 OPENSSL_EXPORT void SSL_CTX_set_client_CA_list(SSL_CTX *ctx, 2629 STACK_OF(X509_NAME) *name_list); 2630 2631 // SSL_set0_client_CAs sets |ssl|'s client certificate CA list to |name_list|, 2632 // which should contain DER-encoded distinguished names (RFC 5280). It takes 2633 // ownership of |name_list|. 2634 OPENSSL_EXPORT void SSL_set0_client_CAs(SSL *ssl, 2635 STACK_OF(CRYPTO_BUFFER) *name_list); 2636 2637 // SSL_CTX_set0_client_CAs sets |ctx|'s client certificate CA list to 2638 // |name_list|, which should contain DER-encoded distinguished names (RFC 5280). 2639 // It takes ownership of |name_list|. 2640 OPENSSL_EXPORT void SSL_CTX_set0_client_CAs(SSL_CTX *ctx, 2641 STACK_OF(CRYPTO_BUFFER) *name_list); 2642 2643 // SSL_get_client_CA_list returns |ssl|'s client certificate CA list. If |ssl| 2644 // has not been configured as a client, this is the list configured by 2645 // |SSL_CTX_set_client_CA_list|. 2646 // 2647 // If configured as a client, it returns the client certificate CA list sent by 2648 // the server. In this mode, the behavior is undefined except during the 2649 // callbacks set by |SSL_CTX_set_cert_cb| and |SSL_CTX_set_client_cert_cb| or 2650 // when the handshake is paused because of them. 2651 OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_get_client_CA_list(const SSL *ssl); 2652 2653 // SSL_get0_server_requested_CAs returns the CAs sent by a server to guide a 2654 // client in certificate selection. They are a series of DER-encoded X.509 2655 // names. This function may only be called during a callback set by 2656 // |SSL_CTX_set_cert_cb| or when the handshake is paused because of it. 2657 // 2658 // The returned stack is owned by |ssl|, as are its contents. It should not be 2659 // used past the point where the handshake is restarted after the callback. 2660 OPENSSL_EXPORT const STACK_OF(CRYPTO_BUFFER) * 2661 SSL_get0_server_requested_CAs(const SSL *ssl); 2662 2663 // SSL_CTX_get_client_CA_list returns |ctx|'s client certificate CA list. 2664 OPENSSL_EXPORT STACK_OF(X509_NAME) * 2665 SSL_CTX_get_client_CA_list(const SSL_CTX *ctx); 2666 2667 // SSL_add_client_CA appends |x509|'s subject to the client certificate CA list. 2668 // It returns one on success or zero on error. The caller retains ownership of 2669 // |x509|. 2670 OPENSSL_EXPORT int SSL_add_client_CA(SSL *ssl, X509 *x509); 2671 2672 // SSL_CTX_add_client_CA appends |x509|'s subject to the client certificate CA 2673 // list. It returns one on success or zero on error. The caller retains 2674 // ownership of |x509|. 2675 OPENSSL_EXPORT int SSL_CTX_add_client_CA(SSL_CTX *ctx, X509 *x509); 2676 2677 // SSL_load_client_CA_file opens |file| and reads PEM-encoded certificates from 2678 // it. It returns a newly-allocated stack of the certificate subjects or NULL 2679 // on error. 2680 OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_load_client_CA_file(const char *file); 2681 2682 // SSL_dup_CA_list makes a deep copy of |list|. It returns the new list on 2683 // success or NULL on allocation error. 2684 OPENSSL_EXPORT STACK_OF(X509_NAME) *SSL_dup_CA_list(STACK_OF(X509_NAME) *list); 2685 2686 // SSL_add_file_cert_subjects_to_stack behaves like |SSL_load_client_CA_file| 2687 // but appends the result to |out|. It returns one on success or zero on 2688 // error. 2689 OPENSSL_EXPORT int SSL_add_file_cert_subjects_to_stack(STACK_OF(X509_NAME) *out, 2690 const char *file); 2691 2692 2693 // Server name indication. 2694 // 2695 // The server_name extension (RFC 3546) allows the client to advertise the name 2696 // of the server it is connecting to. This is used in virtual hosting 2697 // deployments to select one of a several certificates on a single IP. Only the 2698 // host_name name type is supported. 2699 2700 #define TLSEXT_NAMETYPE_host_name 0 2701 2702 // SSL_set_tlsext_host_name, for a client, configures |ssl| to advertise |name| 2703 // in the server_name extension. It returns one on success and zero on error. 2704 OPENSSL_EXPORT int SSL_set_tlsext_host_name(SSL *ssl, const char *name); 2705 2706 // SSL_get_servername, for a server, returns the hostname supplied by the 2707 // client or NULL if there was none. The |type| argument must be 2708 // |TLSEXT_NAMETYPE_host_name|. 2709 OPENSSL_EXPORT const char *SSL_get_servername(const SSL *ssl, const int type); 2710 2711 // SSL_get_servername_type, for a server, returns |TLSEXT_NAMETYPE_host_name| 2712 // if the client sent a hostname and -1 otherwise. 2713 OPENSSL_EXPORT int SSL_get_servername_type(const SSL *ssl); 2714 2715 // SSL_CTX_set_tlsext_servername_callback configures |callback| to be called on 2716 // the server after ClientHello extensions have been parsed and returns one. 2717 // The callback may use |SSL_get_servername| to examine the server_name 2718 // extension and returns a |SSL_TLSEXT_ERR_*| value. The value of |arg| may be 2719 // set by calling |SSL_CTX_set_tlsext_servername_arg|. 2720 // 2721 // If the callback returns |SSL_TLSEXT_ERR_NOACK|, the server_name extension is 2722 // not acknowledged in the ServerHello. If the return value is 2723 // |SSL_TLSEXT_ERR_ALERT_FATAL|, then |*out_alert| is the alert to send, 2724 // defaulting to |SSL_AD_UNRECOGNIZED_NAME|. |SSL_TLSEXT_ERR_ALERT_WARNING| is 2725 // ignored and treated as |SSL_TLSEXT_ERR_OK|. 2726 OPENSSL_EXPORT int SSL_CTX_set_tlsext_servername_callback( 2727 SSL_CTX *ctx, int (*callback)(SSL *ssl, int *out_alert, void *arg)); 2728 2729 // SSL_CTX_set_tlsext_servername_arg sets the argument to the servername 2730 // callback and returns one. See |SSL_CTX_set_tlsext_servername_callback|. 2731 OPENSSL_EXPORT int SSL_CTX_set_tlsext_servername_arg(SSL_CTX *ctx, void *arg); 2732 2733 // SSL_TLSEXT_ERR_* are values returned by some extension-related callbacks. 2734 #define SSL_TLSEXT_ERR_OK 0 2735 #define SSL_TLSEXT_ERR_ALERT_WARNING 1 2736 #define SSL_TLSEXT_ERR_ALERT_FATAL 2 2737 #define SSL_TLSEXT_ERR_NOACK 3 2738 2739 // SSL_set_SSL_CTX changes |ssl|'s |SSL_CTX|. |ssl| will use the 2740 // certificate-related settings from |ctx|, and |SSL_get_SSL_CTX| will report 2741 // |ctx|. This function may be used during the callbacks registered by 2742 // |SSL_CTX_set_select_certificate_cb|, 2743 // |SSL_CTX_set_tlsext_servername_callback|, and |SSL_CTX_set_cert_cb| or when 2744 // the handshake is paused from them. It is typically used to switch 2745 // certificates based on SNI. 2746 // 2747 // Note the session cache and related settings will continue to use the initial 2748 // |SSL_CTX|. Callers should use |SSL_CTX_set_session_id_context| to partition 2749 // the session cache between different domains. 2750 // 2751 // TODO(davidben): Should other settings change after this call? 2752 OPENSSL_EXPORT SSL_CTX *SSL_set_SSL_CTX(SSL *ssl, SSL_CTX *ctx); 2753 2754 2755 // Application-layer protocol negotiation. 2756 // 2757 // The ALPN extension (RFC 7301) allows negotiating different application-layer 2758 // protocols over a single port. This is used, for example, to negotiate 2759 // HTTP/2. 2760 2761 // SSL_CTX_set_alpn_protos sets the client ALPN protocol list on |ctx| to 2762 // |protos|. |protos| must be in wire-format (i.e. a series of non-empty, 8-bit 2763 // length-prefixed strings), or the empty string to disable ALPN. It returns 2764 // zero on success and one on failure. Configuring a non-empty string enables 2765 // ALPN on a client. 2766 // 2767 // WARNING: this function is dangerous because it breaks the usual return value 2768 // convention. 2769 OPENSSL_EXPORT int SSL_CTX_set_alpn_protos(SSL_CTX *ctx, const uint8_t *protos, 2770 unsigned protos_len); 2771 2772 // SSL_set_alpn_protos sets the client ALPN protocol list on |ssl| to |protos|. 2773 // |protos| must be in wire-format (i.e. a series of non-empty, 8-bit 2774 // length-prefixed strings), or the empty string to disable ALPN. It returns 2775 // zero on success and one on failure. Configuring a non-empty string enables 2776 // ALPN on a client. 2777 // 2778 // WARNING: this function is dangerous because it breaks the usual return value 2779 // convention. 2780 OPENSSL_EXPORT int SSL_set_alpn_protos(SSL *ssl, const uint8_t *protos, 2781 unsigned protos_len); 2782 2783 // SSL_CTX_set_alpn_select_cb sets a callback function on |ctx| that is called 2784 // during ClientHello processing in order to select an ALPN protocol from the 2785 // client's list of offered protocols. 2786 // 2787 // The callback is passed a wire-format (i.e. a series of non-empty, 8-bit 2788 // length-prefixed strings) ALPN protocol list in |in|. To select a protocol, 2789 // the callback should set |*out| and |*out_len| to the selected protocol and 2790 // return |SSL_TLSEXT_ERR_OK| on success. It does not pass ownership of the 2791 // buffer, so |*out| should point to a static string, a buffer that outlives the 2792 // callback call, or the corresponding entry in |in|. 2793 // 2794 // If the server supports ALPN, but there are no protocols in common, the 2795 // callback should return |SSL_TLSEXT_ERR_ALERT_FATAL| to abort the connection 2796 // with a no_application_protocol alert. 2797 // 2798 // If the server does not support ALPN, it can return |SSL_TLSEXT_ERR_NOACK| to 2799 // continue the handshake without negotiating a protocol. This may be useful if 2800 // multiple server configurations share an |SSL_CTX|, only some of which have 2801 // ALPN protocols configured. 2802 // 2803 // |SSL_TLSEXT_ERR_ALERT_WARNING| is ignored and will be treated as 2804 // |SSL_TLSEXT_ERR_NOACK|. 2805 // 2806 // The callback will only be called if the client supports ALPN. Callers that 2807 // wish to require ALPN for all clients must check |SSL_get0_alpn_selected| 2808 // after the handshake. In QUIC connections, this is done automatically. 2809 // 2810 // The cipher suite is selected before negotiating ALPN. The callback may use 2811 // |SSL_get_pending_cipher| to query the cipher suite. This may be used to 2812 // implement HTTP/2's cipher suite constraints. 2813 OPENSSL_EXPORT void SSL_CTX_set_alpn_select_cb( 2814 SSL_CTX *ctx, int (*cb)(SSL *ssl, const uint8_t **out, uint8_t *out_len, 2815 const uint8_t *in, unsigned in_len, void *arg), 2816 void *arg); 2817 2818 // SSL_get0_alpn_selected gets the selected ALPN protocol (if any) from |ssl|. 2819 // On return it sets |*out_data| to point to |*out_len| bytes of protocol name 2820 // (not including the leading length-prefix byte). If the server didn't respond 2821 // with a negotiated protocol then |*out_len| will be zero. 2822 OPENSSL_EXPORT void SSL_get0_alpn_selected(const SSL *ssl, 2823 const uint8_t **out_data, 2824 unsigned *out_len); 2825 2826 // SSL_CTX_set_allow_unknown_alpn_protos configures client connections on |ctx| 2827 // to allow unknown ALPN protocols from the server. Otherwise, by default, the 2828 // client will require that the protocol be advertised in 2829 // |SSL_CTX_set_alpn_protos|. 2830 OPENSSL_EXPORT void SSL_CTX_set_allow_unknown_alpn_protos(SSL_CTX *ctx, 2831 int enabled); 2832 2833 2834 // Application-layer protocol settings 2835 // 2836 // The ALPS extension (draft-vvv-tls-alps) allows exchanging application-layer 2837 // settings in the TLS handshake for applications negotiated with ALPN. Note 2838 // that, when ALPS is negotiated, the client and server each advertise their own 2839 // settings, so there are functions to both configure setting to send and query 2840 // received settings. 2841 2842 // SSL_add_application_settings configures |ssl| to enable ALPS with ALPN 2843 // protocol |proto|, sending an ALPS value of |settings|. It returns one on 2844 // success and zero on error. If |proto| is negotiated via ALPN and the peer 2845 // supports ALPS, |settings| will be sent to the peer. The peer's ALPS value can 2846 // be retrieved with |SSL_get0_peer_application_settings|. 2847 // 2848 // On the client, this function should be called before the handshake, once for 2849 // each supported ALPN protocol which uses ALPS. |proto| must be included in the 2850 // client's ALPN configuration (see |SSL_CTX_set_alpn_protos| and 2851 // |SSL_set_alpn_protos|). On the server, ALPS can be preconfigured for each 2852 // protocol as in the client, or configuration can be deferred to the ALPN 2853 // callback (see |SSL_CTX_set_alpn_select_cb|), in which case only the selected 2854 // protocol needs to be configured. 2855 // 2856 // ALPS can be independently configured from 0-RTT, however changes in protocol 2857 // settings will fallback to 1-RTT to negotiate the new value, so it is 2858 // recommended for |settings| to be relatively stable. 2859 OPENSSL_EXPORT int SSL_add_application_settings(SSL *ssl, const uint8_t *proto, 2860 size_t proto_len, 2861 const uint8_t *settings, 2862 size_t settings_len); 2863 2864 // SSL_get0_peer_application_settings sets |*out_data| and |*out_len| to a 2865 // buffer containing the peer's ALPS value, or the empty string if ALPS was not 2866 // negotiated. Note an empty string could also indicate the peer sent an empty 2867 // settings value. Use |SSL_has_application_settings| to check if ALPS was 2868 // negotiated. The output buffer is owned by |ssl| and is valid until the next 2869 // time |ssl| is modified. 2870 OPENSSL_EXPORT void SSL_get0_peer_application_settings(const SSL *ssl, 2871 const uint8_t **out_data, 2872 size_t *out_len); 2873 2874 // SSL_has_application_settings returns one if ALPS was negotiated on this 2875 // connection and zero otherwise. 2876 OPENSSL_EXPORT int SSL_has_application_settings(const SSL *ssl); 2877 2878 2879 // Certificate compression. 2880 // 2881 // Certificates in TLS 1.3 can be compressed (RFC 8879). BoringSSL supports this 2882 // as both a client and a server, but does not link against any specific 2883 // compression libraries in order to keep dependencies to a minimum. Instead, 2884 // hooks for compression and decompression can be installed in an |SSL_CTX| to 2885 // enable support. 2886 2887 // ssl_cert_compression_func_t is a pointer to a function that performs 2888 // compression. It must write the compressed representation of |in| to |out|, 2889 // returning one on success and zero on error. The results of compressing 2890 // certificates are not cached internally. Implementations may wish to implement 2891 // their own cache if they expect it to be useful given the certificates that 2892 // they serve. 2893 typedef int (*ssl_cert_compression_func_t)(SSL *ssl, CBB *out, 2894 const uint8_t *in, size_t in_len); 2895 2896 // ssl_cert_decompression_func_t is a pointer to a function that performs 2897 // decompression. The compressed data from the peer is passed as |in| and the 2898 // decompressed result must be exactly |uncompressed_len| bytes long. It returns 2899 // one on success, in which case |*out| must be set to the result of 2900 // decompressing |in|, or zero on error. Setting |*out| transfers ownership, 2901 // i.e. |CRYPTO_BUFFER_free| will be called on |*out| at some point in the 2902 // future. The results of decompressions are not cached internally. 2903 // Implementations may wish to implement their own cache if they expect it to be 2904 // useful. 2905 typedef int (*ssl_cert_decompression_func_t)(SSL *ssl, CRYPTO_BUFFER **out, 2906 size_t uncompressed_len, 2907 const uint8_t *in, size_t in_len); 2908 2909 // SSL_CTX_add_cert_compression_alg registers a certificate compression 2910 // algorithm on |ctx| with ID |alg_id|. (The value of |alg_id| should be an IANA 2911 // assigned value and each can only be registered once.) 2912 // 2913 // One of the function pointers may be NULL to avoid having to implement both 2914 // sides of a compression algorithm if you're only going to use it in one 2915 // direction. In this case, the unimplemented direction acts like it was never 2916 // configured. 2917 // 2918 // For a server, algorithms are registered in preference order with the most 2919 // preferable first. It returns one on success or zero on error. 2920 OPENSSL_EXPORT int SSL_CTX_add_cert_compression_alg( 2921 SSL_CTX *ctx, uint16_t alg_id, ssl_cert_compression_func_t compress, 2922 ssl_cert_decompression_func_t decompress); 2923 2924 2925 // Next protocol negotiation. 2926 // 2927 // The NPN extension (draft-agl-tls-nextprotoneg-03) is the predecessor to ALPN 2928 // and deprecated in favor of it. 2929 2930 // SSL_CTX_set_next_protos_advertised_cb sets a callback that is called when a 2931 // TLS server needs a list of supported protocols for Next Protocol 2932 // Negotiation. The returned list must be in wire format. The list is returned 2933 // by setting |*out| to point to it and |*out_len| to its length. This memory 2934 // will not be modified, but one should assume that |ssl| keeps a reference to 2935 // it. 2936 // 2937 // The callback should return |SSL_TLSEXT_ERR_OK| if it wishes to advertise. 2938 // Otherwise, no such extension will be included in the ServerHello. 2939 OPENSSL_EXPORT void SSL_CTX_set_next_protos_advertised_cb( 2940 SSL_CTX *ctx, 2941 int (*cb)(SSL *ssl, const uint8_t **out, unsigned *out_len, void *arg), 2942 void *arg); 2943 2944 // SSL_CTX_set_next_proto_select_cb sets a callback that is called when a client 2945 // needs to select a protocol from the server's provided list. |*out| must be 2946 // set to point to the selected protocol (which may be within |in|). The length 2947 // of the protocol name must be written into |*out_len|. The server's advertised 2948 // protocols are provided in |in| and |in_len|. The callback can assume that 2949 // |in| is syntactically valid. 2950 // 2951 // The client must select a protocol. It is fatal to the connection if this 2952 // callback returns a value other than |SSL_TLSEXT_ERR_OK|. 2953 // 2954 // Configuring this callback enables NPN on a client. 2955 OPENSSL_EXPORT void SSL_CTX_set_next_proto_select_cb( 2956 SSL_CTX *ctx, int (*cb)(SSL *ssl, uint8_t **out, uint8_t *out_len, 2957 const uint8_t *in, unsigned in_len, void *arg), 2958 void *arg); 2959 2960 // SSL_get0_next_proto_negotiated sets |*out_data| and |*out_len| to point to 2961 // the client's requested protocol for this connection. If the client didn't 2962 // request any protocol, then |*out_data| is set to NULL. 2963 // 2964 // Note that the client can request any protocol it chooses. The value returned 2965 // from this function need not be a member of the list of supported protocols 2966 // provided by the server. 2967 OPENSSL_EXPORT void SSL_get0_next_proto_negotiated(const SSL *ssl, 2968 const uint8_t **out_data, 2969 unsigned *out_len); 2970 2971 // SSL_select_next_proto implements the standard protocol selection. It is 2972 // expected that this function is called from the callback set by 2973 // |SSL_CTX_set_next_proto_select_cb|. 2974 // 2975 // |peer| and |supported| must be vectors of 8-bit, length-prefixed byte strings 2976 // containing the peer and locally-configured protocols, respectively. The 2977 // length byte itself is not included in the length. A byte string of length 0 2978 // is invalid. No byte string may be truncated. |supported| is assumed to be 2979 // non-empty. 2980 // 2981 // This function finds the first protocol in |peer| which is also in 2982 // |supported|. If one was found, it sets |*out| and |*out_len| to point to it 2983 // and returns |OPENSSL_NPN_NEGOTIATED|. Otherwise, it returns 2984 // |OPENSSL_NPN_NO_OVERLAP| and sets |*out| and |*out_len| to the first 2985 // supported protocol. 2986 OPENSSL_EXPORT int SSL_select_next_proto(uint8_t **out, uint8_t *out_len, 2987 const uint8_t *peer, unsigned peer_len, 2988 const uint8_t *supported, 2989 unsigned supported_len); 2990 2991 #define OPENSSL_NPN_UNSUPPORTED 0 2992 #define OPENSSL_NPN_NEGOTIATED 1 2993 #define OPENSSL_NPN_NO_OVERLAP 2 2994 2995 2996 // Channel ID. 2997 // 2998 // See draft-balfanz-tls-channelid-01. This is an old, experimental mechanism 2999 // and should not be used in new code. 3000 3001 // SSL_CTX_set_tls_channel_id_enabled configures whether connections associated 3002 // with |ctx| should enable Channel ID as a server. 3003 OPENSSL_EXPORT void SSL_CTX_set_tls_channel_id_enabled(SSL_CTX *ctx, 3004 int enabled); 3005 3006 // SSL_set_tls_channel_id_enabled configures whether |ssl| should enable Channel 3007 // ID as a server. 3008 OPENSSL_EXPORT void SSL_set_tls_channel_id_enabled(SSL *ssl, int enabled); 3009 3010 // SSL_CTX_set1_tls_channel_id configures a TLS client to send a TLS Channel ID 3011 // to compatible servers. |private_key| must be a P-256 EC key. It returns one 3012 // on success and zero on error. 3013 OPENSSL_EXPORT int SSL_CTX_set1_tls_channel_id(SSL_CTX *ctx, 3014 EVP_PKEY *private_key); 3015 3016 // SSL_set1_tls_channel_id configures a TLS client to send a TLS Channel ID to 3017 // compatible servers. |private_key| must be a P-256 EC key. It returns one on 3018 // success and zero on error. 3019 OPENSSL_EXPORT int SSL_set1_tls_channel_id(SSL *ssl, EVP_PKEY *private_key); 3020 3021 // SSL_get_tls_channel_id gets the client's TLS Channel ID from a server |SSL| 3022 // and copies up to the first |max_out| bytes into |out|. The Channel ID 3023 // consists of the client's P-256 public key as an (x,y) pair where each is a 3024 // 32-byte, big-endian field element. It returns 0 if the client didn't offer a 3025 // Channel ID and the length of the complete Channel ID otherwise. This function 3026 // always returns zero if |ssl| is a client. 3027 OPENSSL_EXPORT size_t SSL_get_tls_channel_id(SSL *ssl, uint8_t *out, 3028 size_t max_out); 3029 3030 3031 // DTLS-SRTP. 3032 // 3033 // See RFC 5764. 3034 3035 // srtp_protection_profile_st (aka |SRTP_PROTECTION_PROFILE|) is an SRTP 3036 // profile for use with the use_srtp extension. 3037 struct srtp_protection_profile_st { 3038 const char *name; 3039 unsigned long id; 3040 } /* SRTP_PROTECTION_PROFILE */; 3041 3042 DEFINE_CONST_STACK_OF(SRTP_PROTECTION_PROFILE) 3043 3044 // SRTP_* define constants for SRTP profiles. 3045 #define SRTP_AES128_CM_SHA1_80 0x0001 3046 #define SRTP_AES128_CM_SHA1_32 0x0002 3047 #define SRTP_AES128_F8_SHA1_80 0x0003 3048 #define SRTP_AES128_F8_SHA1_32 0x0004 3049 #define SRTP_NULL_SHA1_80 0x0005 3050 #define SRTP_NULL_SHA1_32 0x0006 3051 #define SRTP_AEAD_AES_128_GCM 0x0007 3052 #define SRTP_AEAD_AES_256_GCM 0x0008 3053 3054 // SSL_CTX_set_srtp_profiles enables SRTP for all SSL objects created from 3055 // |ctx|. |profile| contains a colon-separated list of profile names. It returns 3056 // one on success and zero on failure. 3057 OPENSSL_EXPORT int SSL_CTX_set_srtp_profiles(SSL_CTX *ctx, 3058 const char *profiles); 3059 3060 // SSL_set_srtp_profiles enables SRTP for |ssl|. |profile| contains a 3061 // colon-separated list of profile names. It returns one on success and zero on 3062 // failure. 3063 OPENSSL_EXPORT int SSL_set_srtp_profiles(SSL *ssl, const char *profiles); 3064 3065 // SSL_get_srtp_profiles returns the SRTP profiles supported by |ssl|. 3066 OPENSSL_EXPORT const STACK_OF(SRTP_PROTECTION_PROFILE) *SSL_get_srtp_profiles( 3067 const SSL *ssl); 3068 3069 // SSL_get_selected_srtp_profile returns the selected SRTP profile, or NULL if 3070 // SRTP was not negotiated. 3071 OPENSSL_EXPORT const SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile( 3072 SSL *ssl); 3073 3074 3075 // Pre-shared keys. 3076 // 3077 // Connections may be configured with PSK (Pre-Shared Key) cipher suites. These 3078 // authenticate using out-of-band pre-shared keys rather than certificates. See 3079 // RFC 4279. 3080 // 3081 // This implementation uses NUL-terminated C strings for identities and identity 3082 // hints, so values with a NUL character are not supported. (RFC 4279 does not 3083 // specify the format of an identity.) 3084 3085 // PSK_MAX_IDENTITY_LEN is the maximum supported length of a PSK identity, 3086 // excluding the NUL terminator. 3087 #define PSK_MAX_IDENTITY_LEN 128 3088 3089 // PSK_MAX_PSK_LEN is the maximum supported length of a pre-shared key. 3090 #define PSK_MAX_PSK_LEN 256 3091 3092 // SSL_CTX_set_psk_client_callback sets the callback to be called when PSK is 3093 // negotiated on the client. This callback must be set to enable PSK cipher 3094 // suites on the client. 3095 // 3096 // The callback is passed the identity hint in |hint| or NULL if none was 3097 // provided. It should select a PSK identity and write the identity and the 3098 // corresponding PSK to |identity| and |psk|, respectively. The identity is 3099 // written as a NUL-terminated C string of length (excluding the NUL terminator) 3100 // at most |max_identity_len|. The PSK's length must be at most |max_psk_len|. 3101 // The callback returns the length of the PSK or 0 if no suitable identity was 3102 // found. 3103 OPENSSL_EXPORT void SSL_CTX_set_psk_client_callback( 3104 SSL_CTX *ctx, unsigned (*cb)(SSL *ssl, const char *hint, char *identity, 3105 unsigned max_identity_len, uint8_t *psk, 3106 unsigned max_psk_len)); 3107 3108 // SSL_set_psk_client_callback sets the callback to be called when PSK is 3109 // negotiated on the client. This callback must be set to enable PSK cipher 3110 // suites on the client. See also |SSL_CTX_set_psk_client_callback|. 3111 OPENSSL_EXPORT void SSL_set_psk_client_callback( 3112 SSL *ssl, unsigned (*cb)(SSL *ssl, const char *hint, char *identity, 3113 unsigned max_identity_len, uint8_t *psk, 3114 unsigned max_psk_len)); 3115 3116 // SSL_CTX_set_psk_server_callback sets the callback to be called when PSK is 3117 // negotiated on the server. This callback must be set to enable PSK cipher 3118 // suites on the server. 3119 // 3120 // The callback is passed the identity in |identity|. It should write a PSK of 3121 // length at most |max_psk_len| to |psk| and return the number of bytes written 3122 // or zero if the PSK identity is unknown. 3123 OPENSSL_EXPORT void SSL_CTX_set_psk_server_callback( 3124 SSL_CTX *ctx, unsigned (*cb)(SSL *ssl, const char *identity, uint8_t *psk, 3125 unsigned max_psk_len)); 3126 3127 // SSL_set_psk_server_callback sets the callback to be called when PSK is 3128 // negotiated on the server. This callback must be set to enable PSK cipher 3129 // suites on the server. See also |SSL_CTX_set_psk_server_callback|. 3130 OPENSSL_EXPORT void SSL_set_psk_server_callback( 3131 SSL *ssl, unsigned (*cb)(SSL *ssl, const char *identity, uint8_t *psk, 3132 unsigned max_psk_len)); 3133 3134 // SSL_CTX_use_psk_identity_hint configures server connections to advertise an 3135 // identity hint of |identity_hint|. It returns one on success and zero on 3136 // error. 3137 OPENSSL_EXPORT int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, 3138 const char *identity_hint); 3139 3140 // SSL_use_psk_identity_hint configures server connections to advertise an 3141 // identity hint of |identity_hint|. It returns one on success and zero on 3142 // error. 3143 OPENSSL_EXPORT int SSL_use_psk_identity_hint(SSL *ssl, 3144 const char *identity_hint); 3145 3146 // SSL_get_psk_identity_hint returns the PSK identity hint advertised for |ssl| 3147 // or NULL if there is none. 3148 OPENSSL_EXPORT const char *SSL_get_psk_identity_hint(const SSL *ssl); 3149 3150 // SSL_get_psk_identity, after the handshake completes, returns the PSK identity 3151 // that was negotiated by |ssl| or NULL if PSK was not used. 3152 OPENSSL_EXPORT const char *SSL_get_psk_identity(const SSL *ssl); 3153 3154 3155 // Delegated credentials. 3156 // 3157 // *** EXPERIMENTAL — PRONE TO CHANGE *** 3158 // 3159 // draft-ietf-tls-subcerts is a proposed extension for TLS 1.3 and above that 3160 // allows an end point to use its certificate to delegate credentials for 3161 // authentication. If the peer indicates support for this extension, then this 3162 // host may use a delegated credential to sign the handshake. Once issued, 3163 // credentials can't be revoked. In order to mitigate the damage in case the 3164 // credential secret key is compromised, the credential is only valid for a 3165 // short time (days, hours, or even minutes). This library implements draft-03 3166 // of the protocol spec. 3167 // 3168 // The extension ID has not been assigned; we're using 0xff02 for the time 3169 // being. Currently only the server side is implemented. 3170 // 3171 // Servers configure a DC for use in the handshake via 3172 // |SSL_set1_delegated_credential|. It must be signed by the host's end-entity 3173 // certificate as defined in draft-ietf-tls-subcerts-03. 3174 3175 // SSL_set1_delegated_credential configures the delegated credential (DC) that 3176 // will be sent to the peer for the current connection. |dc| is the DC in wire 3177 // format, and |pkey| or |key_method| is the corresponding private key. 3178 // Currently (as of draft-03), only servers may configure a DC to use in the 3179 // handshake. 3180 // 3181 // The DC will only be used if the protocol version is correct and the signature 3182 // scheme is supported by the peer. If not, the DC will not be negotiated and 3183 // the handshake will use the private key (or private key method) associated 3184 // with the certificate. 3185 OPENSSL_EXPORT int SSL_set1_delegated_credential( 3186 SSL *ssl, CRYPTO_BUFFER *dc, EVP_PKEY *pkey, 3187 const SSL_PRIVATE_KEY_METHOD *key_method); 3188 3189 // SSL_delegated_credential_used returns one if a delegated credential was used 3190 // and zero otherwise. 3191 OPENSSL_EXPORT int SSL_delegated_credential_used(const SSL *ssl); 3192 3193 3194 // QUIC integration. 3195 // 3196 // QUIC acts as an underlying transport for the TLS 1.3 handshake. The following 3197 // functions allow a QUIC implementation to serve as the underlying transport as 3198 // described in RFC 9001. 3199 // 3200 // When configured for QUIC, |SSL_do_handshake| will drive the handshake as 3201 // before, but it will not use the configured |BIO|. It will call functions on 3202 // |SSL_QUIC_METHOD| to configure secrets and send data. If data is needed from 3203 // the peer, it will return |SSL_ERROR_WANT_READ|. As the caller receives data 3204 // it can decrypt, it calls |SSL_provide_quic_data|. Subsequent 3205 // |SSL_do_handshake| calls will then consume that data and progress the 3206 // handshake. After the handshake is complete, the caller should continue to 3207 // call |SSL_provide_quic_data| for any post-handshake data, followed by 3208 // |SSL_process_quic_post_handshake| to process it. It is an error to call 3209 // |SSL_read| and |SSL_write| in QUIC. 3210 // 3211 // 0-RTT behaves similarly to |TLS_method|'s usual behavior. |SSL_do_handshake| 3212 // returns early as soon as the client (respectively, server) is allowed to send 3213 // 0-RTT (respectively, half-RTT) data. The caller should then call 3214 // |SSL_do_handshake| again to consume the remaining handshake messages and 3215 // confirm the handshake. As a client, |SSL_ERROR_EARLY_DATA_REJECTED| and 3216 // |SSL_reset_early_data_reject| behave as usual. 3217 // 3218 // See https://www.rfc-editor.org/rfc/rfc9001.html#section-4.1 for more details. 3219 // 3220 // To avoid DoS attacks, the QUIC implementation must limit the amount of data 3221 // being queued up. The implementation can call 3222 // |SSL_quic_max_handshake_flight_len| to get the maximum buffer length at each 3223 // encryption level. 3224 // 3225 // QUIC implementations must additionally configure transport parameters with 3226 // |SSL_set_quic_transport_params|. |SSL_get_peer_quic_transport_params| may be 3227 // used to query the value received from the peer. BoringSSL handles this 3228 // extension as an opaque byte string. The caller is responsible for serializing 3229 // and parsing them. See https://www.rfc-editor.org/rfc/rfc9000#section-7.4 for 3230 // details. 3231 // 3232 // QUIC additionally imposes restrictions on 0-RTT. In particular, the QUIC 3233 // transport layer requires that if a server accepts 0-RTT data, then the 3234 // transport parameters sent on the resumed connection must not lower any limits 3235 // compared to the transport parameters that the server sent on the connection 3236 // where the ticket for 0-RTT was issued. In effect, the server must remember 3237 // the transport parameters with the ticket. Application protocols running on 3238 // QUIC may impose similar restrictions, for example HTTP/3's restrictions on 3239 // SETTINGS frames. 3240 // 3241 // BoringSSL implements this check by doing a byte-for-byte comparison of an 3242 // opaque context passed in by the server. This context must be the same on the 3243 // connection where the ticket was issued and the connection where that ticket 3244 // is used for 0-RTT. If there is a mismatch, or the context was not set, 3245 // BoringSSL will reject early data (but not reject the resumption attempt). 3246 // This context is set via |SSL_set_quic_early_data_context| and should cover 3247 // both transport parameters and any application state. 3248 // |SSL_set_quic_early_data_context| must be called on the server with a 3249 // non-empty context if the server is to support 0-RTT in QUIC. 3250 // 3251 // BoringSSL does not perform any client-side checks on the transport 3252 // parameters received from a server that also accepted early data. It is up to 3253 // the caller to verify that the received transport parameters do not lower any 3254 // limits, and to close the QUIC connection if that is not the case. The same 3255 // holds for any application protocol state remembered for 0-RTT, e.g. HTTP/3 3256 // SETTINGS. 3257 3258 // ssl_encryption_level_t represents a specific QUIC encryption level used to 3259 // transmit handshake messages. 3260 enum ssl_encryption_level_t BORINGSSL_ENUM_INT { 3261 ssl_encryption_initial = 0, 3262 ssl_encryption_early_data, 3263 ssl_encryption_handshake, 3264 ssl_encryption_application, 3265 }; 3266 3267 // ssl_quic_method_st (aka |SSL_QUIC_METHOD|) describes custom QUIC hooks. 3268 struct ssl_quic_method_st { 3269 // set_read_secret configures the read secret and cipher suite for the given 3270 // encryption level. It returns one on success and zero to terminate the 3271 // handshake with an error. It will be called at most once per encryption 3272 // level. 3273 // 3274 // BoringSSL will not release read keys before QUIC may use them. Once a level 3275 // has been initialized, QUIC may begin processing data from it. Handshake 3276 // data should be passed to |SSL_provide_quic_data| and application data (if 3277 // |level| is |ssl_encryption_early_data| or |ssl_encryption_application|) may 3278 // be processed according to the rules of the QUIC protocol. 3279 // 3280 // QUIC ACKs packets at the same encryption level they were received at, 3281 // except that client |ssl_encryption_early_data| (0-RTT) packets trigger 3282 // server |ssl_encryption_application| (1-RTT) ACKs. BoringSSL will always 3283 // install ACK-writing keys with |set_write_secret| before the packet-reading 3284 // keys with |set_read_secret|. This ensures the caller can always ACK any 3285 // packet it decrypts. Note this means the server installs 1-RTT write keys 3286 // before 0-RTT read keys. 3287 // 3288 // The converse is not true. An encryption level may be configured with write 3289 // secrets a roundtrip before the corresponding secrets for reading ACKs is 3290 // available. 3291 int (*set_read_secret)(SSL *ssl, enum ssl_encryption_level_t level, 3292 const SSL_CIPHER *cipher, const uint8_t *secret, 3293 size_t secret_len); 3294 // set_write_secret behaves like |set_read_secret| but configures the write 3295 // secret and cipher suite for the given encryption level. It will be called 3296 // at most once per encryption level. 3297 // 3298 // BoringSSL will not release write keys before QUIC may use them. If |level| 3299 // is |ssl_encryption_early_data| or |ssl_encryption_application|, QUIC may 3300 // begin sending application data at |level|. However, note that BoringSSL 3301 // configures server |ssl_encryption_application| write keys before the client 3302 // Finished. This allows QUIC to send half-RTT data, but the handshake is not 3303 // confirmed at this point and, if requesting client certificates, the client 3304 // is not yet authenticated. 3305 // 3306 // See |set_read_secret| for additional invariants between packets and their 3307 // ACKs. 3308 // 3309 // Note that, on 0-RTT reject, the |ssl_encryption_early_data| write secret 3310 // may use a different cipher suite from the other keys. 3311 int (*set_write_secret)(SSL *ssl, enum ssl_encryption_level_t level, 3312 const SSL_CIPHER *cipher, const uint8_t *secret, 3313 size_t secret_len); 3314 // add_handshake_data adds handshake data to the current flight at the given 3315 // encryption level. It returns one on success and zero on error. 3316 // 3317 // BoringSSL will pack data from a single encryption level together, but a 3318 // single handshake flight may include multiple encryption levels. Callers 3319 // should defer writing data to the network until |flush_flight| to better 3320 // pack QUIC packets into transport datagrams. 3321 // 3322 // If |level| is not |ssl_encryption_initial|, this function will not be 3323 // called before |level| is initialized with |set_write_secret|. 3324 int (*add_handshake_data)(SSL *ssl, enum ssl_encryption_level_t level, 3325 const uint8_t *data, size_t len); 3326 // flush_flight is called when the current flight is complete and should be 3327 // written to the transport. Note a flight may contain data at several 3328 // encryption levels. It returns one on success and zero on error. 3329 int (*flush_flight)(SSL *ssl); 3330 // send_alert sends a fatal alert at the specified encryption level. It 3331 // returns one on success and zero on error. 3332 // 3333 // If |level| is not |ssl_encryption_initial|, this function will not be 3334 // called before |level| is initialized with |set_write_secret|. 3335 int (*send_alert)(SSL *ssl, enum ssl_encryption_level_t level, uint8_t alert); 3336 }; 3337 3338 // SSL_quic_max_handshake_flight_len returns returns the maximum number of bytes 3339 // that may be received at the given encryption level. This function should be 3340 // used to limit buffering in the QUIC implementation. 3341 // 3342 // See https://www.rfc-editor.org/rfc/rfc9000#section-7.5 3343 OPENSSL_EXPORT size_t SSL_quic_max_handshake_flight_len( 3344 const SSL *ssl, enum ssl_encryption_level_t level); 3345 3346 // SSL_quic_read_level returns the current read encryption level. 3347 // 3348 // TODO(davidben): Is it still necessary to expose this function to callers? 3349 // QUICHE does not use it. 3350 OPENSSL_EXPORT enum ssl_encryption_level_t SSL_quic_read_level(const SSL *ssl); 3351 3352 // SSL_quic_write_level returns the current write encryption level. 3353 // 3354 // TODO(davidben): Is it still necessary to expose this function to callers? 3355 // QUICHE does not use it. 3356 OPENSSL_EXPORT enum ssl_encryption_level_t SSL_quic_write_level(const SSL *ssl); 3357 3358 // SSL_provide_quic_data provides data from QUIC at a particular encryption 3359 // level |level|. It returns one on success and zero on error. Note this 3360 // function will return zero if the handshake is not expecting data from |level| 3361 // at this time. The QUIC implementation should then close the connection with 3362 // an error. 3363 OPENSSL_EXPORT int SSL_provide_quic_data(SSL *ssl, 3364 enum ssl_encryption_level_t level, 3365 const uint8_t *data, size_t len); 3366 3367 3368 // SSL_process_quic_post_handshake processes any data that QUIC has provided 3369 // after the handshake has completed. This includes NewSessionTicket messages 3370 // sent by the server. It returns one on success and zero on error. 3371 OPENSSL_EXPORT int SSL_process_quic_post_handshake(SSL *ssl); 3372 3373 // SSL_CTX_set_quic_method configures the QUIC hooks. This should only be 3374 // configured with a minimum version of TLS 1.3. |quic_method| must remain valid 3375 // for the lifetime of |ctx|. It returns one on success and zero on error. 3376 OPENSSL_EXPORT int SSL_CTX_set_quic_method(SSL_CTX *ctx, 3377 const SSL_QUIC_METHOD *quic_method); 3378 3379 // SSL_set_quic_method configures the QUIC hooks. This should only be 3380 // configured with a minimum version of TLS 1.3. |quic_method| must remain valid 3381 // for the lifetime of |ssl|. It returns one on success and zero on error. 3382 OPENSSL_EXPORT int SSL_set_quic_method(SSL *ssl, 3383 const SSL_QUIC_METHOD *quic_method); 3384 3385 // SSL_set_quic_transport_params configures |ssl| to send |params| (of length 3386 // |params_len|) in the quic_transport_parameters extension in either the 3387 // ClientHello or EncryptedExtensions handshake message. It is an error to set 3388 // transport parameters if |ssl| is not configured for QUIC. The buffer pointed 3389 // to by |params| only need be valid for the duration of the call to this 3390 // function. This function returns 1 on success and 0 on failure. 3391 OPENSSL_EXPORT int SSL_set_quic_transport_params(SSL *ssl, 3392 const uint8_t *params, 3393 size_t params_len); 3394 3395 // SSL_get_peer_quic_transport_params provides the caller with the value of the 3396 // quic_transport_parameters extension sent by the peer. A pointer to the buffer 3397 // containing the TransportParameters will be put in |*out_params|, and its 3398 // length in |*params_len|. This buffer will be valid for the lifetime of the 3399 // |SSL|. If no params were received from the peer, |*out_params_len| will be 0. 3400 OPENSSL_EXPORT void SSL_get_peer_quic_transport_params( 3401 const SSL *ssl, const uint8_t **out_params, size_t *out_params_len); 3402 3403 // SSL_set_quic_use_legacy_codepoint configures whether to use the legacy QUIC 3404 // extension codepoint 0xffa5 as opposed to the official value 57. Call with 3405 // |use_legacy| set to 1 to use 0xffa5 and call with 0 to use 57. By default, 3406 // the standard code point is used. 3407 OPENSSL_EXPORT void SSL_set_quic_use_legacy_codepoint(SSL *ssl, int use_legacy); 3408 3409 // SSL_set_quic_early_data_context configures a context string in QUIC servers 3410 // for accepting early data. If a resumption connection offers early data, the 3411 // server will check if the value matches that of the connection which minted 3412 // the ticket. If not, resumption still succeeds but early data is rejected. 3413 // This should include all QUIC Transport Parameters except ones specified that 3414 // the client MUST NOT remember. This should also include any application 3415 // protocol-specific state. For HTTP/3, this should be the serialized server 3416 // SETTINGS frame and the QUIC Transport Parameters (except the stateless reset 3417 // token). 3418 // 3419 // This function may be called before |SSL_do_handshake| or during server 3420 // certificate selection. It returns 1 on success and 0 on failure. 3421 OPENSSL_EXPORT int SSL_set_quic_early_data_context(SSL *ssl, 3422 const uint8_t *context, 3423 size_t context_len); 3424 3425 3426 // Early data. 3427 // 3428 // WARNING: 0-RTT support in BoringSSL is currently experimental and not fully 3429 // implemented. It may cause interoperability or security failures when used. 3430 // 3431 // Early data, or 0-RTT, is a feature in TLS 1.3 which allows clients to send 3432 // data on the first flight during a resumption handshake. This can save a 3433 // round-trip in some application protocols. 3434 // 3435 // WARNING: A 0-RTT handshake has different security properties from normal 3436 // handshake, so it is off by default unless opted in. In particular, early data 3437 // is replayable by a network attacker. Callers must account for this when 3438 // sending or processing data before the handshake is confirmed. See RFC 8446 3439 // for more information. 3440 // 3441 // As a server, if early data is accepted, |SSL_do_handshake| will complete as 3442 // soon as the ClientHello is processed and server flight sent. |SSL_write| may 3443 // be used to send half-RTT data. |SSL_read| will consume early data and 3444 // transition to 1-RTT data as appropriate. Prior to the transition, 3445 // |SSL_in_init| will report the handshake is still in progress. Callers may use 3446 // it or |SSL_in_early_data| to defer or reject requests as needed. 3447 // 3448 // Early data as a client is more complex. If the offered session (see 3449 // |SSL_set_session|) is 0-RTT-capable, the handshake will return after sending 3450 // the ClientHello. The predicted peer certificates and ALPN protocol will be 3451 // available via the usual APIs. |SSL_write| will write early data, up to the 3452 // session's limit. Writes past this limit and |SSL_read| will complete the 3453 // handshake before continuing. Callers may also call |SSL_do_handshake| again 3454 // to complete the handshake sooner. 3455 // 3456 // If the server accepts early data, the handshake will succeed. |SSL_read| and 3457 // |SSL_write| will then act as in a 1-RTT handshake. The peer certificates and 3458 // ALPN protocol will be as predicted and need not be re-queried. 3459 // 3460 // If the server rejects early data, |SSL_do_handshake| (and thus |SSL_read| and 3461 // |SSL_write|) will then fail with |SSL_get_error| returning 3462 // |SSL_ERROR_EARLY_DATA_REJECTED|. The caller should treat this as a connection 3463 // error and most likely perform a high-level retry. Note the server may still 3464 // have processed the early data due to attacker replays. 3465 // 3466 // To then continue the handshake on the original connection, use 3467 // |SSL_reset_early_data_reject|. The connection will then behave as one which 3468 // had not yet completed the handshake. This allows a faster retry than making a 3469 // fresh connection. |SSL_do_handshake| will complete the full handshake, 3470 // possibly resulting in different peer certificates, ALPN protocol, and other 3471 // properties. The caller must disregard any values from before the reset and 3472 // query again. 3473 // 3474 // Finally, to implement the fallback described in RFC 8446 appendix D.3, retry 3475 // on a fresh connection without 0-RTT if the handshake fails with 3476 // |SSL_R_WRONG_VERSION_ON_EARLY_DATA|. 3477 3478 // SSL_CTX_set_early_data_enabled sets whether early data is allowed to be used 3479 // with resumptions using |ctx|. 3480 OPENSSL_EXPORT void SSL_CTX_set_early_data_enabled(SSL_CTX *ctx, int enabled); 3481 3482 // SSL_set_early_data_enabled sets whether early data is allowed to be used 3483 // with resumptions using |ssl|. See |SSL_CTX_set_early_data_enabled| for more 3484 // information. 3485 OPENSSL_EXPORT void SSL_set_early_data_enabled(SSL *ssl, int enabled); 3486 3487 // SSL_in_early_data returns one if |ssl| has a pending handshake that has 3488 // progressed enough to send or receive early data. Clients may call |SSL_write| 3489 // to send early data, but |SSL_read| will complete the handshake before 3490 // accepting application data. Servers may call |SSL_read| to read early data 3491 // and |SSL_write| to send half-RTT data. 3492 OPENSSL_EXPORT int SSL_in_early_data(const SSL *ssl); 3493 3494 // SSL_SESSION_early_data_capable returns whether early data would have been 3495 // attempted with |session| if enabled. 3496 OPENSSL_EXPORT int SSL_SESSION_early_data_capable(const SSL_SESSION *session); 3497 3498 // SSL_SESSION_copy_without_early_data returns a copy of |session| with early 3499 // data disabled. If |session| already does not support early data, it returns 3500 // |session| with the reference count increased. The caller takes ownership of 3501 // the result and must release it with |SSL_SESSION_free|. 3502 // 3503 // This function may be used on the client to clear early data support from 3504 // existing sessions when the server rejects early data. In particular, 3505 // |SSL_R_WRONG_VERSION_ON_EARLY_DATA| requires a fresh connection to retry, and 3506 // the client would not want 0-RTT enabled for the next connection attempt. 3507 OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_copy_without_early_data( 3508 SSL_SESSION *session); 3509 3510 // SSL_early_data_accepted returns whether early data was accepted on the 3511 // handshake performed by |ssl|. 3512 OPENSSL_EXPORT int SSL_early_data_accepted(const SSL *ssl); 3513 3514 // SSL_reset_early_data_reject resets |ssl| after an early data reject. All 3515 // 0-RTT state is discarded, including any pending |SSL_write| calls. The caller 3516 // should treat |ssl| as a logically fresh connection, usually by driving the 3517 // handshake to completion using |SSL_do_handshake|. 3518 // 3519 // It is an error to call this function on an |SSL| object that is not signaling 3520 // |SSL_ERROR_EARLY_DATA_REJECTED|. 3521 OPENSSL_EXPORT void SSL_reset_early_data_reject(SSL *ssl); 3522 3523 // SSL_get_ticket_age_skew returns the difference, in seconds, between the 3524 // client-sent ticket age and the server-computed value in TLS 1.3 server 3525 // connections which resumed a session. 3526 OPENSSL_EXPORT int32_t SSL_get_ticket_age_skew(const SSL *ssl); 3527 3528 // An ssl_early_data_reason_t describes why 0-RTT was accepted or rejected. 3529 // These values are persisted to logs. Entries should not be renumbered and 3530 // numeric values should never be reused. 3531 enum ssl_early_data_reason_t BORINGSSL_ENUM_INT { 3532 // The handshake has not progressed far enough for the 0-RTT status to be 3533 // known. 3534 ssl_early_data_unknown = 0, 3535 // 0-RTT is disabled for this connection. 3536 ssl_early_data_disabled = 1, 3537 // 0-RTT was accepted. 3538 ssl_early_data_accepted = 2, 3539 // The negotiated protocol version does not support 0-RTT. 3540 ssl_early_data_protocol_version = 3, 3541 // The peer declined to offer or accept 0-RTT for an unknown reason. 3542 ssl_early_data_peer_declined = 4, 3543 // The client did not offer a session. 3544 ssl_early_data_no_session_offered = 5, 3545 // The server declined to resume the session. 3546 ssl_early_data_session_not_resumed = 6, 3547 // The session does not support 0-RTT. 3548 ssl_early_data_unsupported_for_session = 7, 3549 // The server sent a HelloRetryRequest. 3550 ssl_early_data_hello_retry_request = 8, 3551 // The negotiated ALPN protocol did not match the session. 3552 ssl_early_data_alpn_mismatch = 9, 3553 // The connection negotiated Channel ID, which is incompatible with 0-RTT. 3554 ssl_early_data_channel_id = 10, 3555 // Value 11 is reserved. (It has historically |ssl_early_data_token_binding|.) 3556 // The client and server ticket age were too far apart. 3557 ssl_early_data_ticket_age_skew = 12, 3558 // QUIC parameters differ between this connection and the original. 3559 ssl_early_data_quic_parameter_mismatch = 13, 3560 // The application settings did not match the session. 3561 ssl_early_data_alps_mismatch = 14, 3562 // The value of the largest entry. 3563 ssl_early_data_reason_max_value = ssl_early_data_alps_mismatch, 3564 }; 3565 3566 // SSL_get_early_data_reason returns details why 0-RTT was accepted or rejected 3567 // on |ssl|. This is primarily useful on the server. 3568 OPENSSL_EXPORT enum ssl_early_data_reason_t SSL_get_early_data_reason( 3569 const SSL *ssl); 3570 3571 // SSL_early_data_reason_string returns a string representation for |reason|, or 3572 // NULL if |reason| is unknown. This function may be used for logging. 3573 OPENSSL_EXPORT const char *SSL_early_data_reason_string( 3574 enum ssl_early_data_reason_t reason); 3575 3576 3577 // Encrypted ClientHello. 3578 // 3579 // ECH is a mechanism for encrypting the entire ClientHello message in TLS 1.3. 3580 // This can prevent observers from seeing cleartext information about the 3581 // connection, such as the server_name extension. 3582 // 3583 // By default, BoringSSL will treat the server name, session ticket, and client 3584 // certificate as secret, but most other parameters, such as the ALPN protocol 3585 // list will be treated as public and sent in the cleartext ClientHello. Other 3586 // APIs may be added for applications with different secrecy requirements. 3587 // 3588 // ECH support in BoringSSL is still experimental and under development. 3589 // 3590 // See https://tools.ietf.org/html/draft-ietf-tls-esni-13. 3591 3592 // SSL_set_enable_ech_grease configures whether the client will send a GREASE 3593 // ECH extension when no supported ECHConfig is available. 3594 OPENSSL_EXPORT void SSL_set_enable_ech_grease(SSL *ssl, int enable); 3595 3596 // SSL_set1_ech_config_list configures |ssl| to, as a client, offer ECH with the 3597 // specified configuration. |ech_config_list| should contain a serialized 3598 // ECHConfigList structure. It returns one on success and zero on error. 3599 // 3600 // This function returns an error if the input is malformed. If the input is 3601 // valid but none of the ECHConfigs implement supported parameters, it will 3602 // return success and proceed without ECH. 3603 // 3604 // If a supported ECHConfig is found, |ssl| will encrypt the true ClientHello 3605 // parameters. If the server cannot decrypt it, e.g. due to a key mismatch, ECH 3606 // has a recovery flow. |ssl| will handshake using the cleartext parameters, 3607 // including a public name in the ECHConfig. If using 3608 // |SSL_CTX_set_custom_verify|, callers should use |SSL_get0_ech_name_override| 3609 // to verify the certificate with the public name. If using the built-in 3610 // verifier, the |X509_STORE_CTX| will be configured automatically. 3611 // 3612 // If no other errors are found in this handshake, it will fail with 3613 // |SSL_R_ECH_REJECTED|. Since it didn't use the true parameters, the connection 3614 // cannot be used for application data. Instead, callers should handle this 3615 // error by calling |SSL_get0_ech_retry_configs| and retrying the connection 3616 // with updated ECH parameters. If the retry also fails with 3617 // |SSL_R_ECH_REJECTED|, the caller should report a connection failure. 3618 OPENSSL_EXPORT int SSL_set1_ech_config_list(SSL *ssl, 3619 const uint8_t *ech_config_list, 3620 size_t ech_config_list_len); 3621 3622 // SSL_get0_ech_name_override, if |ssl| is a client and the server rejected ECH, 3623 // sets |*out_name| and |*out_name_len| to point to a buffer containing the ECH 3624 // public name. Otherwise, the buffer will be empty. 3625 // 3626 // When offering ECH as a client, this function should be called during the 3627 // certificate verification callback (see |SSL_CTX_set_custom_verify|). If 3628 // |*out_name_len| is non-zero, the caller should verify the certificate against 3629 // the result, interpreted as a DNS name, rather than the true server name. In 3630 // this case, the handshake will never succeed and is only used to authenticate 3631 // retry configs. See also |SSL_get0_ech_retry_configs|. 3632 OPENSSL_EXPORT void SSL_get0_ech_name_override(const SSL *ssl, 3633 const char **out_name, 3634 size_t *out_name_len); 3635 3636 // SSL_get0_ech_retry_configs sets |*out_retry_configs| and 3637 // |*out_retry_configs_len| to a buffer containing a serialized ECHConfigList. 3638 // If the server did not provide an ECHConfigList, |*out_retry_configs_len| will 3639 // be zero. 3640 // 3641 // When handling an |SSL_R_ECH_REJECTED| error code as a client, callers should 3642 // use this function to recover from potential key mismatches. If the result is 3643 // non-empty, the caller should retry the connection, passing this buffer to 3644 // |SSL_set1_ech_config_list|. If the result is empty, the server has rolled 3645 // back ECH support, and the caller should retry without ECH. 3646 // 3647 // This function must only be called in response to an |SSL_R_ECH_REJECTED| 3648 // error code. Calling this function on |ssl|s that have not authenticated the 3649 // rejection handshake will assert in debug builds and otherwise return an 3650 // unparsable list. 3651 OPENSSL_EXPORT void SSL_get0_ech_retry_configs( 3652 const SSL *ssl, const uint8_t **out_retry_configs, 3653 size_t *out_retry_configs_len); 3654 3655 // SSL_marshal_ech_config constructs a new serialized ECHConfig. On success, it 3656 // sets |*out| to a newly-allocated buffer containing the result and |*out_len| 3657 // to the size of the buffer. The caller must call |OPENSSL_free| on |*out| to 3658 // release the memory. On failure, it returns zero. 3659 // 3660 // The |config_id| field is a single byte identifer for the ECHConfig. Reusing 3661 // config IDs is allowed, but if multiple ECHConfigs with the same config ID are 3662 // active at a time, server load may increase. See 3663 // |SSL_ECH_KEYS_has_duplicate_config_id|. 3664 // 3665 // The public key and KEM algorithm are taken from |key|. |public_name| is the 3666 // DNS name used to authenticate the recovery flow. |max_name_len| should be the 3667 // length of the longest name in the ECHConfig's anonymity set and influences 3668 // client padding decisions. 3669 OPENSSL_EXPORT int SSL_marshal_ech_config(uint8_t **out, size_t *out_len, 3670 uint8_t config_id, 3671 const EVP_HPKE_KEY *key, 3672 const char *public_name, 3673 size_t max_name_len); 3674 3675 // SSL_ECH_KEYS_new returns a newly-allocated |SSL_ECH_KEYS| or NULL on error. 3676 OPENSSL_EXPORT SSL_ECH_KEYS *SSL_ECH_KEYS_new(void); 3677 3678 // SSL_ECH_KEYS_up_ref increments the reference count of |keys|. 3679 OPENSSL_EXPORT void SSL_ECH_KEYS_up_ref(SSL_ECH_KEYS *keys); 3680 3681 // SSL_ECH_KEYS_free releases memory associated with |keys|. 3682 OPENSSL_EXPORT void SSL_ECH_KEYS_free(SSL_ECH_KEYS *keys); 3683 3684 // SSL_ECH_KEYS_add decodes |ech_config| as an ECHConfig and appends it with 3685 // |key| to |keys|. If |is_retry_config| is non-zero, this config will be 3686 // returned to the client on configuration mismatch. It returns one on success 3687 // and zero on error. 3688 // 3689 // This function should be called successively to register each ECHConfig in 3690 // decreasing order of preference. This configuration must be completed before 3691 // setting |keys| on an |SSL_CTX| with |SSL_CTX_set1_ech_keys|. After that 3692 // point, |keys| is immutable; no more ECHConfig values may be added. 3693 // 3694 // See also |SSL_CTX_set1_ech_keys|. 3695 OPENSSL_EXPORT int SSL_ECH_KEYS_add(SSL_ECH_KEYS *keys, int is_retry_config, 3696 const uint8_t *ech_config, 3697 size_t ech_config_len, 3698 const EVP_HPKE_KEY *key); 3699 3700 // SSL_ECH_KEYS_has_duplicate_config_id returns one if |keys| has duplicate 3701 // config IDs or zero otherwise. Duplicate config IDs still work, but may 3702 // increase server load due to trial decryption. 3703 OPENSSL_EXPORT int SSL_ECH_KEYS_has_duplicate_config_id( 3704 const SSL_ECH_KEYS *keys); 3705 3706 // SSL_ECH_KEYS_marshal_retry_configs serializes the retry configs in |keys| as 3707 // an ECHConfigList. On success, it sets |*out| to a newly-allocated buffer 3708 // containing the result and |*out_len| to the size of the buffer. The caller 3709 // must call |OPENSSL_free| on |*out| to release the memory. On failure, it 3710 // returns zero. 3711 // 3712 // This output may be advertised to clients in DNS. 3713 OPENSSL_EXPORT int SSL_ECH_KEYS_marshal_retry_configs(const SSL_ECH_KEYS *keys, 3714 uint8_t **out, 3715 size_t *out_len); 3716 3717 // SSL_CTX_set1_ech_keys configures |ctx| to use |keys| to decrypt encrypted 3718 // ClientHellos. It returns one on success, and zero on failure. If |keys| does 3719 // not contain any retry configs, this function will fail. Retry configs are 3720 // marked as such when they are added to |keys| with |SSL_ECH_KEYS_add|. 3721 // 3722 // Once |keys| has been passed to this function, it is immutable. Unlike most 3723 // |SSL_CTX| configuration functions, this function may be called even if |ctx| 3724 // already has associated connections on multiple threads. This may be used to 3725 // rotate keys in a long-lived server process. 3726 // 3727 // The configured ECHConfig values should also be advertised out-of-band via DNS 3728 // (see draft-ietf-dnsop-svcb-https). Before advertising an ECHConfig in DNS, 3729 // deployments should ensure all instances of the service are configured with 3730 // the ECHConfig and corresponding private key. 3731 // 3732 // Only the most recent fully-deployed ECHConfigs should be advertised in DNS. 3733 // |keys| may contain a newer set if those ECHConfigs are mid-deployment. It 3734 // should also contain older sets, until the DNS change has rolled out and the 3735 // old records have expired from caches. 3736 // 3737 // If there is a mismatch, |SSL| objects associated with |ctx| will complete the 3738 // handshake using the cleartext ClientHello and send updated ECHConfig values 3739 // to the client. The client will then retry to recover, but with a latency 3740 // penalty. This recovery flow depends on the public name in the ECHConfig. 3741 // Before advertising an ECHConfig in DNS, deployments must ensure all instances 3742 // of the service can present a valid certificate for the public name. 3743 // 3744 // BoringSSL negotiates ECH before certificate selection callbacks are called, 3745 // including |SSL_CTX_set_select_certificate_cb|. If ECH is negotiated, the 3746 // reported |SSL_CLIENT_HELLO| structure and |SSL_get_servername| function will 3747 // transparently reflect the inner ClientHello. Callers should select parameters 3748 // based on these values to correctly handle ECH as well as the recovery flow. 3749 OPENSSL_EXPORT int SSL_CTX_set1_ech_keys(SSL_CTX *ctx, SSL_ECH_KEYS *keys); 3750 3751 // SSL_ech_accepted returns one if |ssl| negotiated ECH and zero otherwise. 3752 OPENSSL_EXPORT int SSL_ech_accepted(const SSL *ssl); 3753 3754 3755 // Alerts. 3756 // 3757 // TLS uses alerts to signal error conditions. Alerts have a type (warning or 3758 // fatal) and description. OpenSSL internally handles fatal alerts with 3759 // dedicated error codes (see |SSL_AD_REASON_OFFSET|). Except for close_notify, 3760 // warning alerts are silently ignored and may only be surfaced with 3761 // |SSL_CTX_set_info_callback|. 3762 3763 // SSL_AD_REASON_OFFSET is the offset between error reasons and |SSL_AD_*| 3764 // values. Any error code under |ERR_LIB_SSL| with an error reason above this 3765 // value corresponds to an alert description. Consumers may add or subtract 3766 // |SSL_AD_REASON_OFFSET| to convert between them. 3767 // 3768 // make_errors.go reserves error codes above 1000 for manually-assigned errors. 3769 // This value must be kept in sync with reservedReasonCode in make_errors.h 3770 #define SSL_AD_REASON_OFFSET 1000 3771 3772 // SSL_AD_* are alert descriptions. 3773 #define SSL_AD_CLOSE_NOTIFY SSL3_AD_CLOSE_NOTIFY 3774 #define SSL_AD_UNEXPECTED_MESSAGE SSL3_AD_UNEXPECTED_MESSAGE 3775 #define SSL_AD_BAD_RECORD_MAC SSL3_AD_BAD_RECORD_MAC 3776 #define SSL_AD_DECRYPTION_FAILED TLS1_AD_DECRYPTION_FAILED 3777 #define SSL_AD_RECORD_OVERFLOW TLS1_AD_RECORD_OVERFLOW 3778 #define SSL_AD_DECOMPRESSION_FAILURE SSL3_AD_DECOMPRESSION_FAILURE 3779 #define SSL_AD_HANDSHAKE_FAILURE SSL3_AD_HANDSHAKE_FAILURE 3780 #define SSL_AD_NO_CERTIFICATE SSL3_AD_NO_CERTIFICATE // Legacy SSL 3.0 value 3781 #define SSL_AD_BAD_CERTIFICATE SSL3_AD_BAD_CERTIFICATE 3782 #define SSL_AD_UNSUPPORTED_CERTIFICATE SSL3_AD_UNSUPPORTED_CERTIFICATE 3783 #define SSL_AD_CERTIFICATE_REVOKED SSL3_AD_CERTIFICATE_REVOKED 3784 #define SSL_AD_CERTIFICATE_EXPIRED SSL3_AD_CERTIFICATE_EXPIRED 3785 #define SSL_AD_CERTIFICATE_UNKNOWN SSL3_AD_CERTIFICATE_UNKNOWN 3786 #define SSL_AD_ILLEGAL_PARAMETER SSL3_AD_ILLEGAL_PARAMETER 3787 #define SSL_AD_UNKNOWN_CA TLS1_AD_UNKNOWN_CA 3788 #define SSL_AD_ACCESS_DENIED TLS1_AD_ACCESS_DENIED 3789 #define SSL_AD_DECODE_ERROR TLS1_AD_DECODE_ERROR 3790 #define SSL_AD_DECRYPT_ERROR TLS1_AD_DECRYPT_ERROR 3791 #define SSL_AD_EXPORT_RESTRICTION TLS1_AD_EXPORT_RESTRICTION 3792 #define SSL_AD_PROTOCOL_VERSION TLS1_AD_PROTOCOL_VERSION 3793 #define SSL_AD_INSUFFICIENT_SECURITY TLS1_AD_INSUFFICIENT_SECURITY 3794 #define SSL_AD_INTERNAL_ERROR TLS1_AD_INTERNAL_ERROR 3795 #define SSL_AD_INAPPROPRIATE_FALLBACK SSL3_AD_INAPPROPRIATE_FALLBACK 3796 #define SSL_AD_USER_CANCELLED TLS1_AD_USER_CANCELLED 3797 #define SSL_AD_NO_RENEGOTIATION TLS1_AD_NO_RENEGOTIATION 3798 #define SSL_AD_MISSING_EXTENSION TLS1_AD_MISSING_EXTENSION 3799 #define SSL_AD_UNSUPPORTED_EXTENSION TLS1_AD_UNSUPPORTED_EXTENSION 3800 #define SSL_AD_CERTIFICATE_UNOBTAINABLE TLS1_AD_CERTIFICATE_UNOBTAINABLE 3801 #define SSL_AD_UNRECOGNIZED_NAME TLS1_AD_UNRECOGNIZED_NAME 3802 #define SSL_AD_BAD_CERTIFICATE_STATUS_RESPONSE \ 3803 TLS1_AD_BAD_CERTIFICATE_STATUS_RESPONSE 3804 #define SSL_AD_BAD_CERTIFICATE_HASH_VALUE TLS1_AD_BAD_CERTIFICATE_HASH_VALUE 3805 #define SSL_AD_UNKNOWN_PSK_IDENTITY TLS1_AD_UNKNOWN_PSK_IDENTITY 3806 #define SSL_AD_CERTIFICATE_REQUIRED TLS1_AD_CERTIFICATE_REQUIRED 3807 #define SSL_AD_NO_APPLICATION_PROTOCOL TLS1_AD_NO_APPLICATION_PROTOCOL 3808 #define SSL_AD_ECH_REQUIRED TLS1_AD_ECH_REQUIRED 3809 3810 // SSL_alert_type_string_long returns a string description of |value| as an 3811 // alert type (warning or fatal). 3812 OPENSSL_EXPORT const char *SSL_alert_type_string_long(int value); 3813 3814 // SSL_alert_desc_string_long returns a string description of |value| as an 3815 // alert description or "unknown" if unknown. 3816 OPENSSL_EXPORT const char *SSL_alert_desc_string_long(int value); 3817 3818 // SSL_send_fatal_alert sends a fatal alert over |ssl| of the specified type, 3819 // which should be one of the |SSL_AD_*| constants. It returns one on success 3820 // and <= 0 on error. The caller should pass the return value into 3821 // |SSL_get_error| to determine how to proceed. Once this function has been 3822 // called, future calls to |SSL_write| will fail. 3823 // 3824 // If retrying a failed operation due to |SSL_ERROR_WANT_WRITE|, subsequent 3825 // calls must use the same |alert| parameter. 3826 OPENSSL_EXPORT int SSL_send_fatal_alert(SSL *ssl, uint8_t alert); 3827 3828 3829 // ex_data functions. 3830 // 3831 // See |ex_data.h| for details. 3832 3833 OPENSSL_EXPORT int SSL_set_ex_data(SSL *ssl, int idx, void *data); 3834 OPENSSL_EXPORT void *SSL_get_ex_data(const SSL *ssl, int idx); 3835 OPENSSL_EXPORT int SSL_get_ex_new_index(long argl, void *argp, 3836 CRYPTO_EX_unused *unused, 3837 CRYPTO_EX_dup *dup_unused, 3838 CRYPTO_EX_free *free_func); 3839 3840 OPENSSL_EXPORT int SSL_SESSION_set_ex_data(SSL_SESSION *session, int idx, 3841 void *data); 3842 OPENSSL_EXPORT void *SSL_SESSION_get_ex_data(const SSL_SESSION *session, 3843 int idx); 3844 OPENSSL_EXPORT int SSL_SESSION_get_ex_new_index(long argl, void *argp, 3845 CRYPTO_EX_unused *unused, 3846 CRYPTO_EX_dup *dup_unused, 3847 CRYPTO_EX_free *free_func); 3848 3849 OPENSSL_EXPORT int SSL_CTX_set_ex_data(SSL_CTX *ctx, int idx, void *data); 3850 OPENSSL_EXPORT void *SSL_CTX_get_ex_data(const SSL_CTX *ctx, int idx); 3851 OPENSSL_EXPORT int SSL_CTX_get_ex_new_index(long argl, void *argp, 3852 CRYPTO_EX_unused *unused, 3853 CRYPTO_EX_dup *dup_unused, 3854 CRYPTO_EX_free *free_func); 3855 3856 3857 // Low-level record-layer state. 3858 3859 // SSL_get_ivs sets |*out_iv_len| to the length of the IVs for the ciphers 3860 // underlying |ssl| and sets |*out_read_iv| and |*out_write_iv| to point to the 3861 // current IVs for the read and write directions. This is only meaningful for 3862 // connections with implicit IVs (i.e. CBC mode with TLS 1.0). 3863 // 3864 // It returns one on success or zero on error. 3865 OPENSSL_EXPORT int SSL_get_ivs(const SSL *ssl, const uint8_t **out_read_iv, 3866 const uint8_t **out_write_iv, 3867 size_t *out_iv_len); 3868 3869 // SSL_get_key_block_len returns the length of |ssl|'s key block. It is an error 3870 // to call this function during a handshake. 3871 OPENSSL_EXPORT size_t SSL_get_key_block_len(const SSL *ssl); 3872 3873 // SSL_generate_key_block generates |out_len| bytes of key material for |ssl|'s 3874 // current connection state. It is an error to call this function during a 3875 // handshake. 3876 OPENSSL_EXPORT int SSL_generate_key_block(const SSL *ssl, uint8_t *out, 3877 size_t out_len); 3878 3879 // SSL_get_read_sequence returns, in TLS, the expected sequence number of the 3880 // next incoming record in the current epoch. In DTLS, it returns the maximum 3881 // sequence number received in the current epoch and includes the epoch number 3882 // in the two most significant bytes. 3883 OPENSSL_EXPORT uint64_t SSL_get_read_sequence(const SSL *ssl); 3884 3885 // SSL_get_write_sequence returns the sequence number of the next outgoing 3886 // record in the current epoch. In DTLS, it includes the epoch number in the 3887 // two most significant bytes. 3888 OPENSSL_EXPORT uint64_t SSL_get_write_sequence(const SSL *ssl); 3889 3890 // SSL_CTX_set_record_protocol_version returns whether |version| is zero. 3891 OPENSSL_EXPORT int SSL_CTX_set_record_protocol_version(SSL_CTX *ctx, 3892 int version); 3893 3894 3895 // Handshake hints. 3896 // 3897 // *** EXPERIMENTAL — DO NOT USE WITHOUT CHECKING *** 3898 // 3899 // Some server deployments make asynchronous RPC calls in both ClientHello 3900 // dispatch and private key operations. In TLS handshakes where the private key 3901 // operation occurs in the first round-trip, this results in two consecutive RPC 3902 // round-trips. Handshake hints allow the RPC service to predicte a signature. 3903 // If correctly predicted, this can skip the second RPC call. 3904 // 3905 // First, the server installs a certificate selection callback (see 3906 // |SSL_CTX_set_select_certificate_cb|). When that is called, it performs the 3907 // RPC as before, but includes the ClientHello and a capabilities string from 3908 // |SSL_serialize_capabilities|. 3909 // 3910 // Next, the RPC service creates its own |SSL| object, applies the results of 3911 // certificate selection, calls |SSL_request_handshake_hints|, and runs the 3912 // handshake. If this successfully computes handshake hints (see 3913 // |SSL_serialize_handshake_hints|), the RPC server should send the hints 3914 // alongside any certificate selection results. 3915 // 3916 // Finally, the server calls |SSL_set_handshake_hints| and applies any 3917 // configuration from the RPC server. It then completes the handshake as before. 3918 // If the hints apply, BoringSSL will use the predicted signature and skip the 3919 // private key callbacks. Otherwise, BoringSSL will call private key callbacks 3920 // to generate a signature as before. 3921 // 3922 // Callers should synchronize configuration across the two services. 3923 // Configuration mismatches and some cases of version skew are not fatal, but 3924 // may result in the hints not applying. Additionally, some handshake flows use 3925 // the private key in later round-trips, such as TLS 1.3 HelloRetryRequest. In 3926 // those cases, BoringSSL will not predict a signature as there is no benefit. 3927 // Callers must allow for handshakes to complete without a predicted signature. 3928 // 3929 // For now, only TLS 1.3 is hinted. TLS 1.2 will work, but the hints will be 3930 // empty. 3931 3932 // SSL_serialize_capabilities writes an opaque byte string to |out| describing 3933 // some of |ssl|'s capabilities. It returns one on success and zero on error. 3934 // 3935 // This string is used by BoringSSL internally to reduce the impact of version 3936 // skew. 3937 OPENSSL_EXPORT int SSL_serialize_capabilities(const SSL *ssl, CBB *out); 3938 3939 // SSL_request_handshake_hints configures |ssl| to generate a handshake hint for 3940 // |client_hello|. It returns one on success and zero on error. |client_hello| 3941 // should contain a serialized ClientHello structure, from the |client_hello| 3942 // and |client_hello_len| fields of the |SSL_CLIENT_HELLO| structure. 3943 // |capabilities| should contain the output of |SSL_serialize_capabilities|. 3944 // 3945 // When configured, |ssl| will perform no I/O (so there is no need to configure 3946 // |BIO|s). For QUIC, the caller should still configure an |SSL_QUIC_METHOD|, 3947 // but the callbacks themselves will never be called and may be left NULL or 3948 // report failure. |SSL_provide_quic_data| also should not be called. 3949 // 3950 // If hint generation is successful, |SSL_do_handshake| will stop the handshake 3951 // early with |SSL_get_error| returning |SSL_ERROR_HANDSHAKE_HINTS_READY|. At 3952 // this point, the caller should run |SSL_serialize_handshake_hints| to extract 3953 // the resulting hints. 3954 // 3955 // Hint generation may fail if, e.g., |ssl| was unable to process the 3956 // ClientHello. Callers should then complete the certificate selection RPC and 3957 // continue the original handshake with no hint. It will likely fail, but this 3958 // reports the correct alert to the client and is more robust in case of 3959 // mismatch. 3960 OPENSSL_EXPORT int SSL_request_handshake_hints(SSL *ssl, 3961 const uint8_t *client_hello, 3962 size_t client_hello_len, 3963 const uint8_t *capabilities, 3964 size_t capabilities_len); 3965 3966 // SSL_serialize_handshake_hints writes an opaque byte string to |out| 3967 // containing the handshake hints computed by |out|. It returns one on success 3968 // and zero on error. This function should only be called if 3969 // |SSL_request_handshake_hints| was configured and the handshake terminated 3970 // with |SSL_ERROR_HANDSHAKE_HINTS_READY|. 3971 // 3972 // This string may be passed to |SSL_set_handshake_hints| on another |SSL| to 3973 // avoid an extra signature call. 3974 OPENSSL_EXPORT int SSL_serialize_handshake_hints(const SSL *ssl, CBB *out); 3975 3976 // SSL_set_handshake_hints configures |ssl| to use |hints| as handshake hints. 3977 // It returns one on success and zero on error. The handshake will then continue 3978 // as before, but apply predicted values from |hints| where applicable. 3979 // 3980 // Hints may contain connection and session secrets, so they must not leak and 3981 // must come from a source trusted to terminate the connection. However, they 3982 // will not change |ssl|'s configuration. The caller is responsible for 3983 // serializing and applying options from the RPC server as needed. This ensures 3984 // |ssl|'s behavior is self-consistent and consistent with the caller's local 3985 // decisions. 3986 OPENSSL_EXPORT int SSL_set_handshake_hints(SSL *ssl, const uint8_t *hints, 3987 size_t hints_len); 3988 3989 3990 // Obscure functions. 3991 3992 // SSL_CTX_set_msg_callback installs |cb| as the message callback for |ctx|. 3993 // This callback will be called when sending or receiving low-level record 3994 // headers, complete handshake messages, ChangeCipherSpec, and alerts. 3995 // |write_p| is one for outgoing messages and zero for incoming messages. 3996 // 3997 // For each record header, |cb| is called with |version| = 0 and |content_type| 3998 // = |SSL3_RT_HEADER|. The |len| bytes from |buf| contain the header. Note that 3999 // this does not include the record body. If the record is sealed, the length 4000 // in the header is the length of the ciphertext. 4001 // 4002 // For each handshake message, ChangeCipherSpec, and alert, |version| is the 4003 // protocol version and |content_type| is the corresponding record type. The 4004 // |len| bytes from |buf| contain the handshake message, one-byte 4005 // ChangeCipherSpec body, and two-byte alert, respectively. 4006 // 4007 // For a V2ClientHello, |version| is |SSL2_VERSION|, |content_type| is zero, and 4008 // the |len| bytes from |buf| contain the V2ClientHello structure. 4009 OPENSSL_EXPORT void SSL_CTX_set_msg_callback( 4010 SSL_CTX *ctx, void (*cb)(int write_p, int version, int content_type, 4011 const void *buf, size_t len, SSL *ssl, void *arg)); 4012 4013 // SSL_CTX_set_msg_callback_arg sets the |arg| parameter of the message 4014 // callback. 4015 OPENSSL_EXPORT void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg); 4016 4017 // SSL_set_msg_callback installs |cb| as the message callback of |ssl|. See 4018 // |SSL_CTX_set_msg_callback| for when this callback is called. 4019 OPENSSL_EXPORT void SSL_set_msg_callback( 4020 SSL *ssl, void (*cb)(int write_p, int version, int content_type, 4021 const void *buf, size_t len, SSL *ssl, void *arg)); 4022 4023 // SSL_set_msg_callback_arg sets the |arg| parameter of the message callback. 4024 OPENSSL_EXPORT void SSL_set_msg_callback_arg(SSL *ssl, void *arg); 4025 4026 // SSL_CTX_set_keylog_callback configures a callback to log key material. This 4027 // is intended for debugging use with tools like Wireshark. The |cb| function 4028 // should log |line| followed by a newline, synchronizing with any concurrent 4029 // access to the log. 4030 // 4031 // The format is described in 4032 // https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format. 4033 OPENSSL_EXPORT void SSL_CTX_set_keylog_callback( 4034 SSL_CTX *ctx, void (*cb)(const SSL *ssl, const char *line)); 4035 4036 // SSL_CTX_get_keylog_callback returns the callback configured by 4037 // |SSL_CTX_set_keylog_callback|. 4038 OPENSSL_EXPORT void (*SSL_CTX_get_keylog_callback(const SSL_CTX *ctx))( 4039 const SSL *ssl, const char *line); 4040 4041 // SSL_CTX_set_current_time_cb configures a callback to retrieve the current 4042 // time, which should be set in |*out_clock|. This can be used for testing 4043 // purposes; for example, a callback can be configured that returns a time 4044 // set explicitly by the test. The |ssl| pointer passed to |cb| is always null. 4045 OPENSSL_EXPORT void SSL_CTX_set_current_time_cb( 4046 SSL_CTX *ctx, void (*cb)(const SSL *ssl, struct timeval *out_clock)); 4047 4048 // SSL_set_shed_handshake_config allows some of the configuration of |ssl| to be 4049 // freed after its handshake completes. Once configuration has been shed, APIs 4050 // that query it may fail. "Configuration" in this context means anything that 4051 // was set by the caller, as distinct from information derived from the 4052 // handshake. For example, |SSL_get_ciphers| queries how the |SSL| was 4053 // configured by the caller, and fails after configuration has been shed, 4054 // whereas |SSL_get_cipher| queries the result of the handshake, and is 4055 // unaffected by configuration shedding. 4056 // 4057 // If configuration shedding is enabled, it is an error to call |SSL_clear|. 4058 // 4059 // Note that configuration shedding as a client additionally depends on 4060 // renegotiation being disabled (see |SSL_set_renegotiate_mode|). If 4061 // renegotiation is possible, the configuration will be retained. If 4062 // configuration shedding is enabled and renegotiation later disabled after the 4063 // handshake, |SSL_set_renegotiate_mode| will shed configuration then. This may 4064 // be useful for clients which support renegotiation with some ALPN protocols, 4065 // such as HTTP/1.1, and not others, such as HTTP/2. 4066 OPENSSL_EXPORT void SSL_set_shed_handshake_config(SSL *ssl, int enable); 4067 4068 enum ssl_renegotiate_mode_t BORINGSSL_ENUM_INT { 4069 ssl_renegotiate_never = 0, 4070 ssl_renegotiate_once, 4071 ssl_renegotiate_freely, 4072 ssl_renegotiate_ignore, 4073 ssl_renegotiate_explicit, 4074 }; 4075 4076 // SSL_set_renegotiate_mode configures how |ssl|, a client, reacts to 4077 // renegotiation attempts by a server. If |ssl| is a server, peer-initiated 4078 // renegotiations are *always* rejected and this function does nothing. 4079 // 4080 // The renegotiation mode defaults to |ssl_renegotiate_never|, but may be set 4081 // at any point in a connection's lifetime. Set it to |ssl_renegotiate_once| to 4082 // allow one renegotiation, |ssl_renegotiate_freely| to allow all 4083 // renegotiations or |ssl_renegotiate_ignore| to ignore HelloRequest messages. 4084 // Note that ignoring HelloRequest messages may cause the connection to stall 4085 // if the server waits for the renegotiation to complete. 4086 // 4087 // If set to |ssl_renegotiate_explicit|, |SSL_read| and |SSL_peek| calls which 4088 // encounter a HelloRequest will pause with |SSL_ERROR_WANT_RENEGOTIATE|. 4089 // |SSL_write| will continue to work while paused. The caller may call 4090 // |SSL_renegotiate| to begin the renegotiation at a later point. This mode may 4091 // be used if callers wish to eagerly call |SSL_peek| without triggering a 4092 // renegotiation. 4093 // 4094 // If configuration shedding is enabled (see |SSL_set_shed_handshake_config|), 4095 // configuration is released if, at any point after the handshake, renegotiation 4096 // is disabled. It is not possible to switch from disabling renegotiation to 4097 // enabling it on a given connection. Callers that condition renegotiation on, 4098 // e.g., ALPN must enable renegotiation before the handshake and conditionally 4099 // disable it afterwards. 4100 // 4101 // There is no support in BoringSSL for initiating renegotiations as a client 4102 // or server. 4103 OPENSSL_EXPORT void SSL_set_renegotiate_mode(SSL *ssl, 4104 enum ssl_renegotiate_mode_t mode); 4105 4106 // SSL_renegotiate starts a deferred renegotiation on |ssl| if it was configured 4107 // with |ssl_renegotiate_explicit| and has a pending HelloRequest. It returns 4108 // one on success and zero on error. 4109 // 4110 // This function does not do perform any I/O. On success, a subsequent 4111 // |SSL_do_handshake| call will run the handshake. |SSL_write| and 4112 // |SSL_read| will also complete the handshake before sending or receiving 4113 // application data. 4114 OPENSSL_EXPORT int SSL_renegotiate(SSL *ssl); 4115 4116 // SSL_renegotiate_pending returns one if |ssl| is in the middle of a 4117 // renegotiation. 4118 OPENSSL_EXPORT int SSL_renegotiate_pending(SSL *ssl); 4119 4120 // SSL_total_renegotiations returns the total number of renegotiation handshakes 4121 // performed by |ssl|. This includes the pending renegotiation, if any. 4122 OPENSSL_EXPORT int SSL_total_renegotiations(const SSL *ssl); 4123 4124 // SSL_MAX_CERT_LIST_DEFAULT is the default maximum length, in bytes, of a peer 4125 // certificate chain. 4126 #define SSL_MAX_CERT_LIST_DEFAULT (1024 * 100) 4127 4128 // SSL_CTX_get_max_cert_list returns the maximum length, in bytes, of a peer 4129 // certificate chain accepted by |ctx|. 4130 OPENSSL_EXPORT size_t SSL_CTX_get_max_cert_list(const SSL_CTX *ctx); 4131 4132 // SSL_CTX_set_max_cert_list sets the maximum length, in bytes, of a peer 4133 // certificate chain to |max_cert_list|. This affects how much memory may be 4134 // consumed during the handshake. 4135 OPENSSL_EXPORT void SSL_CTX_set_max_cert_list(SSL_CTX *ctx, 4136 size_t max_cert_list); 4137 4138 // SSL_get_max_cert_list returns the maximum length, in bytes, of a peer 4139 // certificate chain accepted by |ssl|. 4140 OPENSSL_EXPORT size_t SSL_get_max_cert_list(const SSL *ssl); 4141 4142 // SSL_set_max_cert_list sets the maximum length, in bytes, of a peer 4143 // certificate chain to |max_cert_list|. This affects how much memory may be 4144 // consumed during the handshake. 4145 OPENSSL_EXPORT void SSL_set_max_cert_list(SSL *ssl, size_t max_cert_list); 4146 4147 // SSL_CTX_set_max_send_fragment sets the maximum length, in bytes, of records 4148 // sent by |ctx|. Beyond this length, handshake messages and application data 4149 // will be split into multiple records. It returns one on success or zero on 4150 // error. 4151 OPENSSL_EXPORT int SSL_CTX_set_max_send_fragment(SSL_CTX *ctx, 4152 size_t max_send_fragment); 4153 4154 // SSL_set_max_send_fragment sets the maximum length, in bytes, of records sent 4155 // by |ssl|. Beyond this length, handshake messages and application data will 4156 // be split into multiple records. It returns one on success or zero on 4157 // error. 4158 OPENSSL_EXPORT int SSL_set_max_send_fragment(SSL *ssl, 4159 size_t max_send_fragment); 4160 4161 // ssl_early_callback_ctx (aka |SSL_CLIENT_HELLO|) is passed to certain 4162 // callbacks that are called very early on during the server handshake. At this 4163 // point, much of the SSL* hasn't been filled out and only the ClientHello can 4164 // be depended on. 4165 struct ssl_early_callback_ctx { 4166 SSL *ssl; 4167 const uint8_t *client_hello; 4168 size_t client_hello_len; 4169 uint16_t version; 4170 const uint8_t *random; 4171 size_t random_len; 4172 const uint8_t *session_id; 4173 size_t session_id_len; 4174 const uint8_t *cipher_suites; 4175 size_t cipher_suites_len; 4176 const uint8_t *compression_methods; 4177 size_t compression_methods_len; 4178 const uint8_t *extensions; 4179 size_t extensions_len; 4180 } /* SSL_CLIENT_HELLO */; 4181 4182 // ssl_select_cert_result_t enumerates the possible results from selecting a 4183 // certificate with |select_certificate_cb|. 4184 enum ssl_select_cert_result_t BORINGSSL_ENUM_INT { 4185 // ssl_select_cert_success indicates that the certificate selection was 4186 // successful. 4187 ssl_select_cert_success = 1, 4188 // ssl_select_cert_retry indicates that the operation could not be 4189 // immediately completed and must be reattempted at a later point. 4190 ssl_select_cert_retry = 0, 4191 // ssl_select_cert_error indicates that a fatal error occured and the 4192 // handshake should be terminated. 4193 ssl_select_cert_error = -1, 4194 }; 4195 4196 // SSL_early_callback_ctx_extension_get searches the extensions in 4197 // |client_hello| for an extension of the given type. If not found, it returns 4198 // zero. Otherwise it sets |out_data| to point to the extension contents (not 4199 // including the type and length bytes), sets |out_len| to the length of the 4200 // extension contents and returns one. 4201 OPENSSL_EXPORT int SSL_early_callback_ctx_extension_get( 4202 const SSL_CLIENT_HELLO *client_hello, uint16_t extension_type, 4203 const uint8_t **out_data, size_t *out_len); 4204 4205 // SSL_CTX_set_select_certificate_cb sets a callback that is called before most 4206 // ClientHello processing and before the decision whether to resume a session 4207 // is made. The callback may inspect the ClientHello and configure the 4208 // connection. See |ssl_select_cert_result_t| for details of the return values. 4209 // 4210 // In the case that a retry is indicated, |SSL_get_error| will return 4211 // |SSL_ERROR_PENDING_CERTIFICATE| and the caller should arrange for the 4212 // high-level operation on |ssl| to be retried at a later time, which will 4213 // result in another call to |cb|. 4214 // 4215 // |SSL_get_servername| may be used during this callback. 4216 // 4217 // Note: The |SSL_CLIENT_HELLO| is only valid for the duration of the callback 4218 // and is not valid while the handshake is paused. 4219 OPENSSL_EXPORT void SSL_CTX_set_select_certificate_cb( 4220 SSL_CTX *ctx, 4221 enum ssl_select_cert_result_t (*cb)(const SSL_CLIENT_HELLO *)); 4222 4223 // SSL_CTX_set_dos_protection_cb sets a callback that is called once the 4224 // resumption decision for a ClientHello has been made. It can return one to 4225 // allow the handshake to continue or zero to cause the handshake to abort. 4226 OPENSSL_EXPORT void SSL_CTX_set_dos_protection_cb( 4227 SSL_CTX *ctx, int (*cb)(const SSL_CLIENT_HELLO *)); 4228 4229 // SSL_CTX_set_reverify_on_resume configures whether the certificate 4230 // verification callback will be used to reverify stored certificates 4231 // when resuming a session. This only works with |SSL_CTX_set_custom_verify|. 4232 // For now, this is incompatible with |SSL_VERIFY_NONE| mode, and is only 4233 // respected on clients. 4234 OPENSSL_EXPORT void SSL_CTX_set_reverify_on_resume(SSL_CTX *ctx, int enabled); 4235 4236 // SSL_set_enforce_rsa_key_usage configures whether the keyUsage extension of 4237 // RSA leaf certificates will be checked for consistency with the TLS 4238 // usage. This parameter may be set late; it will not be read until after the 4239 // certificate verification callback. 4240 OPENSSL_EXPORT void SSL_set_enforce_rsa_key_usage(SSL *ssl, int enabled); 4241 4242 // SSL_ST_* are possible values for |SSL_state|, the bitmasks that make them up, 4243 // and some historical values for compatibility. Only |SSL_ST_INIT| and 4244 // |SSL_ST_OK| are ever returned. 4245 #define SSL_ST_CONNECT 0x1000 4246 #define SSL_ST_ACCEPT 0x2000 4247 #define SSL_ST_MASK 0x0FFF 4248 #define SSL_ST_INIT (SSL_ST_CONNECT | SSL_ST_ACCEPT) 4249 #define SSL_ST_OK 0x03 4250 #define SSL_ST_RENEGOTIATE (0x04 | SSL_ST_INIT) 4251 #define SSL_ST_BEFORE (0x05 | SSL_ST_INIT) 4252 4253 // TLS_ST_* are aliases for |SSL_ST_*| for OpenSSL 1.1.0 compatibility. 4254 #define TLS_ST_OK SSL_ST_OK 4255 #define TLS_ST_BEFORE SSL_ST_BEFORE 4256 4257 // SSL_CB_* are possible values for the |type| parameter in the info 4258 // callback and the bitmasks that make them up. 4259 #define SSL_CB_LOOP 0x01 4260 #define SSL_CB_EXIT 0x02 4261 #define SSL_CB_READ 0x04 4262 #define SSL_CB_WRITE 0x08 4263 #define SSL_CB_ALERT 0x4000 4264 #define SSL_CB_READ_ALERT (SSL_CB_ALERT | SSL_CB_READ) 4265 #define SSL_CB_WRITE_ALERT (SSL_CB_ALERT | SSL_CB_WRITE) 4266 #define SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT | SSL_CB_LOOP) 4267 #define SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT | SSL_CB_EXIT) 4268 #define SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT | SSL_CB_LOOP) 4269 #define SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT | SSL_CB_EXIT) 4270 #define SSL_CB_HANDSHAKE_START 0x10 4271 #define SSL_CB_HANDSHAKE_DONE 0x20 4272 4273 // SSL_CTX_set_info_callback configures a callback to be run when various 4274 // events occur during a connection's lifetime. The |type| argument determines 4275 // the type of event and the meaning of the |value| argument. Callbacks must 4276 // ignore unexpected |type| values. 4277 // 4278 // |SSL_CB_READ_ALERT| is signaled for each alert received, warning or fatal. 4279 // The |value| argument is a 16-bit value where the alert level (either 4280 // |SSL3_AL_WARNING| or |SSL3_AL_FATAL|) is in the most-significant eight bits 4281 // and the alert type (one of |SSL_AD_*|) is in the least-significant eight. 4282 // 4283 // |SSL_CB_WRITE_ALERT| is signaled for each alert sent. The |value| argument 4284 // is constructed as with |SSL_CB_READ_ALERT|. 4285 // 4286 // |SSL_CB_HANDSHAKE_START| is signaled when a handshake begins. The |value| 4287 // argument is always one. 4288 // 4289 // |SSL_CB_HANDSHAKE_DONE| is signaled when a handshake completes successfully. 4290 // The |value| argument is always one. If a handshake False Starts, this event 4291 // may be used to determine when the Finished message is received. 4292 // 4293 // The following event types expose implementation details of the handshake 4294 // state machine. Consuming them is deprecated. 4295 // 4296 // |SSL_CB_ACCEPT_LOOP| (respectively, |SSL_CB_CONNECT_LOOP|) is signaled when 4297 // a server (respectively, client) handshake progresses. The |value| argument 4298 // is always one. 4299 // 4300 // |SSL_CB_ACCEPT_EXIT| (respectively, |SSL_CB_CONNECT_EXIT|) is signaled when 4301 // a server (respectively, client) handshake completes, fails, or is paused. 4302 // The |value| argument is one if the handshake succeeded and <= 0 4303 // otherwise. 4304 OPENSSL_EXPORT void SSL_CTX_set_info_callback( 4305 SSL_CTX *ctx, void (*cb)(const SSL *ssl, int type, int value)); 4306 4307 // SSL_CTX_get_info_callback returns the callback set by 4308 // |SSL_CTX_set_info_callback|. 4309 OPENSSL_EXPORT void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))(const SSL *ssl, 4310 int type, 4311 int value); 4312 4313 // SSL_set_info_callback configures a callback to be run at various events 4314 // during a connection's lifetime. See |SSL_CTX_set_info_callback|. 4315 OPENSSL_EXPORT void SSL_set_info_callback( 4316 SSL *ssl, void (*cb)(const SSL *ssl, int type, int value)); 4317 4318 // SSL_get_info_callback returns the callback set by |SSL_set_info_callback|. 4319 OPENSSL_EXPORT void (*SSL_get_info_callback(const SSL *ssl))(const SSL *ssl, 4320 int type, 4321 int value); 4322 4323 // SSL_state_string_long returns the current state of the handshake state 4324 // machine as a string. This may be useful for debugging and logging. 4325 OPENSSL_EXPORT const char *SSL_state_string_long(const SSL *ssl); 4326 4327 #define SSL_SENT_SHUTDOWN 1 4328 #define SSL_RECEIVED_SHUTDOWN 2 4329 4330 // SSL_get_shutdown returns a bitmask with a subset of |SSL_SENT_SHUTDOWN| and 4331 // |SSL_RECEIVED_SHUTDOWN| to query whether close_notify was sent or received, 4332 // respectively. 4333 OPENSSL_EXPORT int SSL_get_shutdown(const SSL *ssl); 4334 4335 // SSL_get_peer_signature_algorithm returns the signature algorithm used by the 4336 // peer. If not applicable, it returns zero. 4337 OPENSSL_EXPORT uint16_t SSL_get_peer_signature_algorithm(const SSL *ssl); 4338 4339 // SSL_get_client_random writes up to |max_out| bytes of the most recent 4340 // handshake's client_random to |out| and returns the number of bytes written. 4341 // If |max_out| is zero, it returns the size of the client_random. 4342 OPENSSL_EXPORT size_t SSL_get_client_random(const SSL *ssl, uint8_t *out, 4343 size_t max_out); 4344 4345 // SSL_get_server_random writes up to |max_out| bytes of the most recent 4346 // handshake's server_random to |out| and returns the number of bytes written. 4347 // If |max_out| is zero, it returns the size of the server_random. 4348 OPENSSL_EXPORT size_t SSL_get_server_random(const SSL *ssl, uint8_t *out, 4349 size_t max_out); 4350 4351 // SSL_get_pending_cipher returns the cipher suite for the current handshake or 4352 // NULL if one has not been negotiated yet or there is no pending handshake. 4353 OPENSSL_EXPORT const SSL_CIPHER *SSL_get_pending_cipher(const SSL *ssl); 4354 4355 // SSL_set_retain_only_sha256_of_client_certs, on a server, sets whether only 4356 // the SHA-256 hash of peer's certificate should be saved in memory and in the 4357 // session. This can save memory, ticket size and session cache space. If 4358 // enabled, |SSL_get_peer_certificate| will return NULL after the handshake 4359 // completes. See |SSL_SESSION_has_peer_sha256| and 4360 // |SSL_SESSION_get0_peer_sha256| to query the hash. 4361 OPENSSL_EXPORT void SSL_set_retain_only_sha256_of_client_certs(SSL *ssl, 4362 int enable); 4363 4364 // SSL_CTX_set_retain_only_sha256_of_client_certs, on a server, sets whether 4365 // only the SHA-256 hash of peer's certificate should be saved in memory and in 4366 // the session. This can save memory, ticket size and session cache space. If 4367 // enabled, |SSL_get_peer_certificate| will return NULL after the handshake 4368 // completes. See |SSL_SESSION_has_peer_sha256| and 4369 // |SSL_SESSION_get0_peer_sha256| to query the hash. 4370 OPENSSL_EXPORT void SSL_CTX_set_retain_only_sha256_of_client_certs(SSL_CTX *ctx, 4371 int enable); 4372 4373 // SSL_CTX_set_grease_enabled configures whether sockets on |ctx| should enable 4374 // GREASE. See RFC 8701. 4375 OPENSSL_EXPORT void SSL_CTX_set_grease_enabled(SSL_CTX *ctx, int enabled); 4376 4377 // SSL_CTX_set_permute_extensions configures whether sockets on |ctx| should 4378 // permute extensions. For now, this is only implemented for the ClientHello. 4379 OPENSSL_EXPORT void SSL_CTX_set_permute_extensions(SSL_CTX *ctx, int enabled); 4380 4381 // SSL_set_permute_extensions configures whether sockets on |ssl| should 4382 // permute extensions. For now, this is only implemented for the ClientHello. 4383 OPENSSL_EXPORT void SSL_set_permute_extensions(SSL *ssl, int enabled); 4384 4385 // SSL_max_seal_overhead returns the maximum overhead, in bytes, of sealing a 4386 // record with |ssl|. 4387 OPENSSL_EXPORT size_t SSL_max_seal_overhead(const SSL *ssl); 4388 4389 // SSL_CTX_set_false_start_allowed_without_alpn configures whether connections 4390 // on |ctx| may use False Start (if |SSL_MODE_ENABLE_FALSE_START| is enabled) 4391 // without negotiating ALPN. 4392 OPENSSL_EXPORT void SSL_CTX_set_false_start_allowed_without_alpn(SSL_CTX *ctx, 4393 int allowed); 4394 4395 // SSL_used_hello_retry_request returns one if the TLS 1.3 HelloRetryRequest 4396 // message has been either sent by the server or received by the client. It 4397 // returns zero otherwise. 4398 OPENSSL_EXPORT int SSL_used_hello_retry_request(const SSL *ssl); 4399 4400 // SSL_set_jdk11_workaround configures whether to workaround various bugs in 4401 // JDK 11's TLS 1.3 implementation by disabling TLS 1.3 for such clients. 4402 // 4403 // https://bugs.openjdk.java.net/browse/JDK-8211806 4404 // https://bugs.openjdk.java.net/browse/JDK-8212885 4405 // https://bugs.openjdk.java.net/browse/JDK-8213202 4406 OPENSSL_EXPORT void SSL_set_jdk11_workaround(SSL *ssl, int enable); 4407 4408 4409 // Deprecated functions. 4410 4411 // SSL_library_init calls |CRYPTO_library_init| and returns one. 4412 OPENSSL_EXPORT int SSL_library_init(void); 4413 4414 // SSL_CIPHER_description writes a description of |cipher| into |buf| and 4415 // returns |buf|. If |buf| is NULL, it returns a newly allocated string, to be 4416 // freed with |OPENSSL_free|, or NULL on error. 4417 // 4418 // The description includes a trailing newline and has the form: 4419 // AES128-SHA Kx=RSA Au=RSA Enc=AES(128) Mac=SHA1 4420 // 4421 // Consider |SSL_CIPHER_standard_name| or |SSL_CIPHER_get_name| instead. 4422 OPENSSL_EXPORT const char *SSL_CIPHER_description(const SSL_CIPHER *cipher, 4423 char *buf, int len); 4424 4425 // SSL_CIPHER_get_version returns the string "TLSv1/SSLv3". 4426 OPENSSL_EXPORT const char *SSL_CIPHER_get_version(const SSL_CIPHER *cipher); 4427 4428 // SSL_CIPHER_get_rfc_name returns a newly-allocated string containing the 4429 // result of |SSL_CIPHER_standard_name| or NULL on error. The caller is 4430 // responsible for calling |OPENSSL_free| on the result. 4431 // 4432 // Use |SSL_CIPHER_standard_name| instead. 4433 OPENSSL_EXPORT char *SSL_CIPHER_get_rfc_name(const SSL_CIPHER *cipher); 4434 4435 typedef void COMP_METHOD; 4436 typedef struct ssl_comp_st SSL_COMP; 4437 4438 // SSL_COMP_get_compression_methods returns NULL. 4439 OPENSSL_EXPORT STACK_OF(SSL_COMP) *SSL_COMP_get_compression_methods(void); 4440 4441 // SSL_COMP_add_compression_method returns one. 4442 OPENSSL_EXPORT int SSL_COMP_add_compression_method(int id, COMP_METHOD *cm); 4443 4444 // SSL_COMP_get_name returns NULL. 4445 OPENSSL_EXPORT const char *SSL_COMP_get_name(const COMP_METHOD *comp); 4446 4447 // SSL_COMP_get0_name returns the |name| member of |comp|. 4448 OPENSSL_EXPORT const char *SSL_COMP_get0_name(const SSL_COMP *comp); 4449 4450 // SSL_COMP_get_id returns the |id| member of |comp|. 4451 OPENSSL_EXPORT int SSL_COMP_get_id(const SSL_COMP *comp); 4452 4453 // SSL_COMP_free_compression_methods does nothing. 4454 OPENSSL_EXPORT void SSL_COMP_free_compression_methods(void); 4455 4456 // SSLv23_method calls |TLS_method|. 4457 OPENSSL_EXPORT const SSL_METHOD *SSLv23_method(void); 4458 4459 // These version-specific methods behave exactly like |TLS_method| and 4460 // |DTLS_method| except they also call |SSL_CTX_set_min_proto_version| and 4461 // |SSL_CTX_set_max_proto_version| to lock connections to that protocol 4462 // version. 4463 OPENSSL_EXPORT const SSL_METHOD *TLSv1_method(void); 4464 OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_method(void); 4465 OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_method(void); 4466 OPENSSL_EXPORT const SSL_METHOD *DTLSv1_method(void); 4467 OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_method(void); 4468 4469 // These client- and server-specific methods call their corresponding generic 4470 // methods. 4471 OPENSSL_EXPORT const SSL_METHOD *TLS_server_method(void); 4472 OPENSSL_EXPORT const SSL_METHOD *TLS_client_method(void); 4473 OPENSSL_EXPORT const SSL_METHOD *SSLv23_server_method(void); 4474 OPENSSL_EXPORT const SSL_METHOD *SSLv23_client_method(void); 4475 OPENSSL_EXPORT const SSL_METHOD *TLSv1_server_method(void); 4476 OPENSSL_EXPORT const SSL_METHOD *TLSv1_client_method(void); 4477 OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_server_method(void); 4478 OPENSSL_EXPORT const SSL_METHOD *TLSv1_1_client_method(void); 4479 OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_server_method(void); 4480 OPENSSL_EXPORT const SSL_METHOD *TLSv1_2_client_method(void); 4481 OPENSSL_EXPORT const SSL_METHOD *DTLS_server_method(void); 4482 OPENSSL_EXPORT const SSL_METHOD *DTLS_client_method(void); 4483 OPENSSL_EXPORT const SSL_METHOD *DTLSv1_server_method(void); 4484 OPENSSL_EXPORT const SSL_METHOD *DTLSv1_client_method(void); 4485 OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_server_method(void); 4486 OPENSSL_EXPORT const SSL_METHOD *DTLSv1_2_client_method(void); 4487 4488 // SSL_clear resets |ssl| to allow another connection and returns one on success 4489 // or zero on failure. It returns most configuration state but releases memory 4490 // associated with the current connection. 4491 // 4492 // Free |ssl| and create a new one instead. 4493 OPENSSL_EXPORT int SSL_clear(SSL *ssl); 4494 4495 // SSL_CTX_set_tmp_rsa_callback does nothing. 4496 OPENSSL_EXPORT void SSL_CTX_set_tmp_rsa_callback( 4497 SSL_CTX *ctx, RSA *(*cb)(SSL *ssl, int is_export, int keylength)); 4498 4499 // SSL_set_tmp_rsa_callback does nothing. 4500 OPENSSL_EXPORT void SSL_set_tmp_rsa_callback(SSL *ssl, 4501 RSA *(*cb)(SSL *ssl, int is_export, 4502 int keylength)); 4503 4504 // SSL_CTX_sess_connect returns zero. 4505 OPENSSL_EXPORT int SSL_CTX_sess_connect(const SSL_CTX *ctx); 4506 4507 // SSL_CTX_sess_connect_good returns zero. 4508 OPENSSL_EXPORT int SSL_CTX_sess_connect_good(const SSL_CTX *ctx); 4509 4510 // SSL_CTX_sess_connect_renegotiate returns zero. 4511 OPENSSL_EXPORT int SSL_CTX_sess_connect_renegotiate(const SSL_CTX *ctx); 4512 4513 // SSL_CTX_sess_accept returns zero. 4514 OPENSSL_EXPORT int SSL_CTX_sess_accept(const SSL_CTX *ctx); 4515 4516 // SSL_CTX_sess_accept_renegotiate returns zero. 4517 OPENSSL_EXPORT int SSL_CTX_sess_accept_renegotiate(const SSL_CTX *ctx); 4518 4519 // SSL_CTX_sess_accept_good returns zero. 4520 OPENSSL_EXPORT int SSL_CTX_sess_accept_good(const SSL_CTX *ctx); 4521 4522 // SSL_CTX_sess_hits returns zero. 4523 OPENSSL_EXPORT int SSL_CTX_sess_hits(const SSL_CTX *ctx); 4524 4525 // SSL_CTX_sess_cb_hits returns zero. 4526 OPENSSL_EXPORT int SSL_CTX_sess_cb_hits(const SSL_CTX *ctx); 4527 4528 // SSL_CTX_sess_misses returns zero. 4529 OPENSSL_EXPORT int SSL_CTX_sess_misses(const SSL_CTX *ctx); 4530 4531 // SSL_CTX_sess_timeouts returns zero. 4532 OPENSSL_EXPORT int SSL_CTX_sess_timeouts(const SSL_CTX *ctx); 4533 4534 // SSL_CTX_sess_cache_full returns zero. 4535 OPENSSL_EXPORT int SSL_CTX_sess_cache_full(const SSL_CTX *ctx); 4536 4537 // SSL_cutthrough_complete calls |SSL_in_false_start|. 4538 OPENSSL_EXPORT int SSL_cutthrough_complete(const SSL *ssl); 4539 4540 // SSL_num_renegotiations calls |SSL_total_renegotiations|. 4541 OPENSSL_EXPORT int SSL_num_renegotiations(const SSL *ssl); 4542 4543 // SSL_CTX_need_tmp_RSA returns zero. 4544 OPENSSL_EXPORT int SSL_CTX_need_tmp_RSA(const SSL_CTX *ctx); 4545 4546 // SSL_need_tmp_RSA returns zero. 4547 OPENSSL_EXPORT int SSL_need_tmp_RSA(const SSL *ssl); 4548 4549 // SSL_CTX_set_tmp_rsa returns one. 4550 OPENSSL_EXPORT int SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, const RSA *rsa); 4551 4552 // SSL_set_tmp_rsa returns one. 4553 OPENSSL_EXPORT int SSL_set_tmp_rsa(SSL *ssl, const RSA *rsa); 4554 4555 // SSL_CTX_get_read_ahead returns zero. 4556 OPENSSL_EXPORT int SSL_CTX_get_read_ahead(const SSL_CTX *ctx); 4557 4558 // SSL_CTX_set_read_ahead returns one. 4559 OPENSSL_EXPORT int SSL_CTX_set_read_ahead(SSL_CTX *ctx, int yes); 4560 4561 // SSL_get_read_ahead returns zero. 4562 OPENSSL_EXPORT int SSL_get_read_ahead(const SSL *ssl); 4563 4564 // SSL_set_read_ahead returns one. 4565 OPENSSL_EXPORT int SSL_set_read_ahead(SSL *ssl, int yes); 4566 4567 // SSL_set_state does nothing. 4568 OPENSSL_EXPORT void SSL_set_state(SSL *ssl, int state); 4569 4570 // SSL_get_shared_ciphers writes an empty string to |buf| and returns a 4571 // pointer to |buf|, or NULL if |len| is less than or equal to zero. 4572 OPENSSL_EXPORT char *SSL_get_shared_ciphers(const SSL *ssl, char *buf, int len); 4573 4574 // SSL_get_shared_sigalgs returns zero. 4575 OPENSSL_EXPORT int SSL_get_shared_sigalgs(SSL *ssl, int idx, int *psign, 4576 int *phash, int *psignandhash, 4577 uint8_t *rsig, uint8_t *rhash); 4578 4579 // SSL_MODE_HANDSHAKE_CUTTHROUGH is the same as SSL_MODE_ENABLE_FALSE_START. 4580 #define SSL_MODE_HANDSHAKE_CUTTHROUGH SSL_MODE_ENABLE_FALSE_START 4581 4582 // i2d_SSL_SESSION serializes |in|, as described in |i2d_SAMPLE|. 4583 // 4584 // Use |SSL_SESSION_to_bytes| instead. 4585 OPENSSL_EXPORT int i2d_SSL_SESSION(SSL_SESSION *in, uint8_t **pp); 4586 4587 // d2i_SSL_SESSION parses a serialized session from the |length| bytes pointed 4588 // to by |*pp|, as described in |d2i_SAMPLE|. 4589 // 4590 // Use |SSL_SESSION_from_bytes| instead. 4591 OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION(SSL_SESSION **a, const uint8_t **pp, 4592 long length); 4593 4594 // i2d_SSL_SESSION_bio serializes |session| and writes the result to |bio|. It 4595 // returns the number of bytes written on success and <= 0 on error. 4596 OPENSSL_EXPORT int i2d_SSL_SESSION_bio(BIO *bio, const SSL_SESSION *session); 4597 4598 // d2i_SSL_SESSION_bio reads a serialized |SSL_SESSION| from |bio| and returns a 4599 // newly-allocated |SSL_SESSION| or NULL on error. If |out| is not NULL, it also 4600 // frees |*out| and sets |*out| to the new |SSL_SESSION|. 4601 OPENSSL_EXPORT SSL_SESSION *d2i_SSL_SESSION_bio(BIO *bio, SSL_SESSION **out); 4602 4603 // ERR_load_SSL_strings does nothing. 4604 OPENSSL_EXPORT void ERR_load_SSL_strings(void); 4605 4606 // SSL_load_error_strings does nothing. 4607 OPENSSL_EXPORT void SSL_load_error_strings(void); 4608 4609 // SSL_CTX_set_tlsext_use_srtp calls |SSL_CTX_set_srtp_profiles|. It returns 4610 // zero on success and one on failure. 4611 // 4612 // WARNING: this function is dangerous because it breaks the usual return value 4613 // convention. Use |SSL_CTX_set_srtp_profiles| instead. 4614 OPENSSL_EXPORT int SSL_CTX_set_tlsext_use_srtp(SSL_CTX *ctx, 4615 const char *profiles); 4616 4617 // SSL_set_tlsext_use_srtp calls |SSL_set_srtp_profiles|. It returns zero on 4618 // success and one on failure. 4619 // 4620 // WARNING: this function is dangerous because it breaks the usual return value 4621 // convention. Use |SSL_set_srtp_profiles| instead. 4622 OPENSSL_EXPORT int SSL_set_tlsext_use_srtp(SSL *ssl, const char *profiles); 4623 4624 // SSL_get_current_compression returns NULL. 4625 OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_compression(SSL *ssl); 4626 4627 // SSL_get_current_expansion returns NULL. 4628 OPENSSL_EXPORT const COMP_METHOD *SSL_get_current_expansion(SSL *ssl); 4629 4630 // SSL_get_server_tmp_key returns zero. 4631 OPENSSL_EXPORT int SSL_get_server_tmp_key(SSL *ssl, EVP_PKEY **out_key); 4632 4633 // SSL_CTX_set_tmp_dh returns 1. 4634 OPENSSL_EXPORT int SSL_CTX_set_tmp_dh(SSL_CTX *ctx, const DH *dh); 4635 4636 // SSL_set_tmp_dh returns 1. 4637 OPENSSL_EXPORT int SSL_set_tmp_dh(SSL *ssl, const DH *dh); 4638 4639 // SSL_CTX_set_tmp_dh_callback does nothing. 4640 OPENSSL_EXPORT void SSL_CTX_set_tmp_dh_callback( 4641 SSL_CTX *ctx, DH *(*cb)(SSL *ssl, int is_export, int keylength)); 4642 4643 // SSL_set_tmp_dh_callback does nothing. 4644 OPENSSL_EXPORT void SSL_set_tmp_dh_callback(SSL *ssl, 4645 DH *(*cb)(SSL *ssl, int is_export, 4646 int keylength)); 4647 4648 // SSL_CTX_set1_sigalgs takes |num_values| ints and interprets them as pairs 4649 // where the first is the nid of a hash function and the second is an 4650 // |EVP_PKEY_*| value. It configures the signature algorithm preferences for 4651 // |ctx| based on them and returns one on success or zero on error. 4652 // 4653 // This API is compatible with OpenSSL. However, BoringSSL-specific code should 4654 // prefer |SSL_CTX_set_signing_algorithm_prefs| because it's clearer and it's 4655 // more convenient to codesearch for specific algorithm values. 4656 OPENSSL_EXPORT int SSL_CTX_set1_sigalgs(SSL_CTX *ctx, const int *values, 4657 size_t num_values); 4658 4659 // SSL_set1_sigalgs takes |num_values| ints and interprets them as pairs where 4660 // the first is the nid of a hash function and the second is an |EVP_PKEY_*| 4661 // value. It configures the signature algorithm preferences for |ssl| based on 4662 // them and returns one on success or zero on error. 4663 // 4664 // This API is compatible with OpenSSL. However, BoringSSL-specific code should 4665 // prefer |SSL_CTX_set_signing_algorithm_prefs| because it's clearer and it's 4666 // more convenient to codesearch for specific algorithm values. 4667 OPENSSL_EXPORT int SSL_set1_sigalgs(SSL *ssl, const int *values, 4668 size_t num_values); 4669 4670 // SSL_CTX_set1_sigalgs_list takes a textual specification of a set of signature 4671 // algorithms and configures them on |ctx|. It returns one on success and zero 4672 // on error. See 4673 // https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_sigalgs_list.html for 4674 // a description of the text format. Also note that TLS 1.3 names (e.g. 4675 // "rsa_pkcs1_md5_sha1") can also be used (as in OpenSSL, although OpenSSL 4676 // doesn't document that). 4677 // 4678 // This API is compatible with OpenSSL. However, BoringSSL-specific code should 4679 // prefer |SSL_CTX_set_signing_algorithm_prefs| because it's clearer and it's 4680 // more convenient to codesearch for specific algorithm values. 4681 OPENSSL_EXPORT int SSL_CTX_set1_sigalgs_list(SSL_CTX *ctx, const char *str); 4682 4683 // SSL_set1_sigalgs_list takes a textual specification of a set of signature 4684 // algorithms and configures them on |ssl|. It returns one on success and zero 4685 // on error. See 4686 // https://www.openssl.org/docs/man1.1.0/man3/SSL_CTX_set1_sigalgs_list.html for 4687 // a description of the text format. Also note that TLS 1.3 names (e.g. 4688 // "rsa_pkcs1_md5_sha1") can also be used (as in OpenSSL, although OpenSSL 4689 // doesn't document that). 4690 // 4691 // This API is compatible with OpenSSL. However, BoringSSL-specific code should 4692 // prefer |SSL_CTX_set_signing_algorithm_prefs| because it's clearer and it's 4693 // more convenient to codesearch for specific algorithm values. 4694 OPENSSL_EXPORT int SSL_set1_sigalgs_list(SSL *ssl, const char *str); 4695 4696 #define SSL_set_app_data(s, arg) (SSL_set_ex_data(s, 0, (char *)(arg))) 4697 #define SSL_get_app_data(s) (SSL_get_ex_data(s, 0)) 4698 #define SSL_SESSION_set_app_data(s, a) \ 4699 (SSL_SESSION_set_ex_data(s, 0, (char *)(a))) 4700 #define SSL_SESSION_get_app_data(s) (SSL_SESSION_get_ex_data(s, 0)) 4701 #define SSL_CTX_get_app_data(ctx) (SSL_CTX_get_ex_data(ctx, 0)) 4702 #define SSL_CTX_set_app_data(ctx, arg) \ 4703 (SSL_CTX_set_ex_data(ctx, 0, (char *)(arg))) 4704 4705 #define OpenSSL_add_ssl_algorithms() SSL_library_init() 4706 #define SSLeay_add_ssl_algorithms() SSL_library_init() 4707 4708 #define SSL_get_cipher(ssl) SSL_CIPHER_get_name(SSL_get_current_cipher(ssl)) 4709 #define SSL_get_cipher_bits(ssl, out_alg_bits) \ 4710 SSL_CIPHER_get_bits(SSL_get_current_cipher(ssl), out_alg_bits) 4711 #define SSL_get_cipher_version(ssl) \ 4712 SSL_CIPHER_get_version(SSL_get_current_cipher(ssl)) 4713 #define SSL_get_cipher_name(ssl) \ 4714 SSL_CIPHER_get_name(SSL_get_current_cipher(ssl)) 4715 #define SSL_get_time(session) SSL_SESSION_get_time(session) 4716 #define SSL_set_time(session, time) SSL_SESSION_set_time((session), (time)) 4717 #define SSL_get_timeout(session) SSL_SESSION_get_timeout(session) 4718 #define SSL_set_timeout(session, timeout) \ 4719 SSL_SESSION_set_timeout((session), (timeout)) 4720 4721 struct ssl_comp_st { 4722 int id; 4723 const char *name; 4724 char *method; 4725 }; 4726 4727 DEFINE_STACK_OF(SSL_COMP) 4728 4729 // The following flags do nothing and are included only to make it easier to 4730 // compile code with BoringSSL. 4731 #define SSL_MODE_AUTO_RETRY 0 4732 #define SSL_MODE_RELEASE_BUFFERS 0 4733 #define SSL_MODE_SEND_CLIENTHELLO_TIME 0 4734 #define SSL_MODE_SEND_SERVERHELLO_TIME 0 4735 #define SSL_OP_ALL 0 4736 #define SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION 0 4737 #define SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS 0 4738 #define SSL_OP_EPHEMERAL_RSA 0 4739 #define SSL_OP_LEGACY_SERVER_CONNECT 0 4740 #define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0 4741 #define SSL_OP_MICROSOFT_SESS_ID_BUG 0 4742 #define SSL_OP_MSIE_SSLV2_RSA_PADDING 0 4743 #define SSL_OP_NETSCAPE_CA_DN_BUG 0 4744 #define SSL_OP_NETSCAPE_CHALLENGE_BUG 0 4745 #define SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG 0 4746 #define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0 4747 #define SSL_OP_NO_COMPRESSION 0 4748 #define SSL_OP_NO_RENEGOTIATION 0 // ssl_renegotiate_never is the default 4749 #define SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION 0 4750 #define SSL_OP_NO_SSLv2 0 4751 #define SSL_OP_NO_SSLv3 0 4752 #define SSL_OP_PKCS1_CHECK_1 0 4753 #define SSL_OP_PKCS1_CHECK_2 0 4754 #define SSL_OP_SINGLE_DH_USE 0 4755 #define SSL_OP_SINGLE_ECDH_USE 0 4756 #define SSL_OP_SSLEAY_080_CLIENT_DH_BUG 0 4757 #define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0 4758 #define SSL_OP_TLS_BLOCK_PADDING_BUG 0 4759 #define SSL_OP_TLS_D5_BUG 0 4760 #define SSL_OP_TLS_ROLLBACK_BUG 0 4761 #define SSL_VERIFY_CLIENT_ONCE 0 4762 4763 // SSL_cache_hit calls |SSL_session_reused|. 4764 OPENSSL_EXPORT int SSL_cache_hit(SSL *ssl); 4765 4766 // SSL_get_default_timeout returns |SSL_DEFAULT_SESSION_TIMEOUT|. 4767 OPENSSL_EXPORT long SSL_get_default_timeout(const SSL *ssl); 4768 4769 // SSL_get_version returns a string describing the TLS version used by |ssl|. 4770 // For example, "TLSv1.2" or "DTLSv1". 4771 OPENSSL_EXPORT const char *SSL_get_version(const SSL *ssl); 4772 4773 // SSL_get_cipher_list returns the name of the |n|th cipher in the output of 4774 // |SSL_get_ciphers| or NULL if out of range. Use |SSL_get_ciphers| instead. 4775 OPENSSL_EXPORT const char *SSL_get_cipher_list(const SSL *ssl, int n); 4776 4777 // SSL_CTX_set_client_cert_cb sets a callback which is called on the client if 4778 // the server requests a client certificate and none is configured. On success, 4779 // the callback should return one and set |*out_x509| to |*out_pkey| to a leaf 4780 // certificate and private key, respectively, passing ownership. It should 4781 // return zero to send no certificate and -1 to fail or pause the handshake. If 4782 // the handshake is paused, |SSL_get_error| will return 4783 // |SSL_ERROR_WANT_X509_LOOKUP|. 4784 // 4785 // The callback may call |SSL_get0_certificate_types| and 4786 // |SSL_get_client_CA_list| for information on the server's certificate request. 4787 // 4788 // Use |SSL_CTX_set_cert_cb| instead. Configuring intermediate certificates with 4789 // this function is confusing. This callback may not be registered concurrently 4790 // with |SSL_CTX_set_cert_cb| or |SSL_set_cert_cb|. 4791 OPENSSL_EXPORT void SSL_CTX_set_client_cert_cb( 4792 SSL_CTX *ctx, int (*cb)(SSL *ssl, X509 **out_x509, EVP_PKEY **out_pkey)); 4793 4794 #define SSL_NOTHING SSL_ERROR_NONE 4795 #define SSL_WRITING SSL_ERROR_WANT_WRITE 4796 #define SSL_READING SSL_ERROR_WANT_READ 4797 4798 // SSL_want returns one of the above values to determine what the most recent 4799 // operation on |ssl| was blocked on. Use |SSL_get_error| instead. 4800 OPENSSL_EXPORT int SSL_want(const SSL *ssl); 4801 4802 #define SSL_want_read(ssl) (SSL_want(ssl) == SSL_READING) 4803 #define SSL_want_write(ssl) (SSL_want(ssl) == SSL_WRITING) 4804 4805 // SSL_get_finished writes up to |count| bytes of the Finished message sent by 4806 // |ssl| to |buf|. It returns the total untruncated length or zero if none has 4807 // been sent yet. At TLS 1.3 and later, it returns zero. 4808 // 4809 // Use |SSL_get_tls_unique| instead. 4810 OPENSSL_EXPORT size_t SSL_get_finished(const SSL *ssl, void *buf, size_t count); 4811 4812 // SSL_get_peer_finished writes up to |count| bytes of the Finished message 4813 // received from |ssl|'s peer to |buf|. It returns the total untruncated length 4814 // or zero if none has been received yet. At TLS 1.3 and later, it returns 4815 // zero. 4816 // 4817 // Use |SSL_get_tls_unique| instead. 4818 OPENSSL_EXPORT size_t SSL_get_peer_finished(const SSL *ssl, void *buf, 4819 size_t count); 4820 4821 // SSL_alert_type_string returns "!". Use |SSL_alert_type_string_long| 4822 // instead. 4823 OPENSSL_EXPORT const char *SSL_alert_type_string(int value); 4824 4825 // SSL_alert_desc_string returns "!!". Use |SSL_alert_desc_string_long| 4826 // instead. 4827 OPENSSL_EXPORT const char *SSL_alert_desc_string(int value); 4828 4829 // SSL_state_string returns "!!!!!!". Use |SSL_state_string_long| for a more 4830 // intelligible string. 4831 OPENSSL_EXPORT const char *SSL_state_string(const SSL *ssl); 4832 4833 // SSL_TXT_* expand to strings. 4834 #define SSL_TXT_MEDIUM "MEDIUM" 4835 #define SSL_TXT_HIGH "HIGH" 4836 #define SSL_TXT_FIPS "FIPS" 4837 #define SSL_TXT_kRSA "kRSA" 4838 #define SSL_TXT_kDHE "kDHE" 4839 #define SSL_TXT_kEDH "kEDH" 4840 #define SSL_TXT_kECDHE "kECDHE" 4841 #define SSL_TXT_kEECDH "kEECDH" 4842 #define SSL_TXT_kPSK "kPSK" 4843 #define SSL_TXT_aRSA "aRSA" 4844 #define SSL_TXT_aECDSA "aECDSA" 4845 #define SSL_TXT_aPSK "aPSK" 4846 #define SSL_TXT_DH "DH" 4847 #define SSL_TXT_DHE "DHE" 4848 #define SSL_TXT_EDH "EDH" 4849 #define SSL_TXT_RSA "RSA" 4850 #define SSL_TXT_ECDH "ECDH" 4851 #define SSL_TXT_ECDHE "ECDHE" 4852 #define SSL_TXT_EECDH "EECDH" 4853 #define SSL_TXT_ECDSA "ECDSA" 4854 #define SSL_TXT_PSK "PSK" 4855 #define SSL_TXT_3DES "3DES" 4856 #define SSL_TXT_RC4 "RC4" 4857 #define SSL_TXT_AES128 "AES128" 4858 #define SSL_TXT_AES256 "AES256" 4859 #define SSL_TXT_AES "AES" 4860 #define SSL_TXT_AES_GCM "AESGCM" 4861 #define SSL_TXT_CHACHA20 "CHACHA20" 4862 #define SSL_TXT_MD5 "MD5" 4863 #define SSL_TXT_SHA1 "SHA1" 4864 #define SSL_TXT_SHA "SHA" 4865 #define SSL_TXT_SHA256 "SHA256" 4866 #define SSL_TXT_SHA384 "SHA384" 4867 #define SSL_TXT_SSLV3 "SSLv3" 4868 #define SSL_TXT_TLSV1 "TLSv1" 4869 #define SSL_TXT_TLSV1_1 "TLSv1.1" 4870 #define SSL_TXT_TLSV1_2 "TLSv1.2" 4871 #define SSL_TXT_TLSV1_3 "TLSv1.3" 4872 #define SSL_TXT_ALL "ALL" 4873 #define SSL_TXT_CMPDEF "COMPLEMENTOFDEFAULT" 4874 4875 typedef struct ssl_conf_ctx_st SSL_CONF_CTX; 4876 4877 // SSL_state returns |SSL_ST_INIT| if a handshake is in progress and |SSL_ST_OK| 4878 // otherwise. 4879 // 4880 // Use |SSL_is_init| instead. 4881 OPENSSL_EXPORT int SSL_state(const SSL *ssl); 4882 4883 #define SSL_get_state(ssl) SSL_state(ssl) 4884 4885 // SSL_set_shutdown causes |ssl| to behave as if the shutdown bitmask (see 4886 // |SSL_get_shutdown|) were |mode|. This may be used to skip sending or 4887 // receiving close_notify in |SSL_shutdown| by causing the implementation to 4888 // believe the events already happened. 4889 // 4890 // It is an error to use |SSL_set_shutdown| to unset a bit that has already been 4891 // set. Doing so will trigger an |assert| in debug builds and otherwise be 4892 // ignored. 4893 // 4894 // Use |SSL_CTX_set_quiet_shutdown| instead. 4895 OPENSSL_EXPORT void SSL_set_shutdown(SSL *ssl, int mode); 4896 4897 // SSL_CTX_set_tmp_ecdh calls |SSL_CTX_set1_curves| with a one-element list 4898 // containing |ec_key|'s curve. 4899 OPENSSL_EXPORT int SSL_CTX_set_tmp_ecdh(SSL_CTX *ctx, const EC_KEY *ec_key); 4900 4901 // SSL_set_tmp_ecdh calls |SSL_set1_curves| with a one-element list containing 4902 // |ec_key|'s curve. 4903 OPENSSL_EXPORT int SSL_set_tmp_ecdh(SSL *ssl, const EC_KEY *ec_key); 4904 4905 // SSL_add_dir_cert_subjects_to_stack lists files in directory |dir|. It calls 4906 // |SSL_add_file_cert_subjects_to_stack| on each file and returns one on success 4907 // or zero on error. This function is only available from the libdecrepit 4908 // library. 4909 OPENSSL_EXPORT int SSL_add_dir_cert_subjects_to_stack(STACK_OF(X509_NAME) *out, 4910 const char *dir); 4911 4912 // SSL_CTX_enable_tls_channel_id calls |SSL_CTX_set_tls_channel_id_enabled|. 4913 OPENSSL_EXPORT int SSL_CTX_enable_tls_channel_id(SSL_CTX *ctx); 4914 4915 // SSL_enable_tls_channel_id calls |SSL_set_tls_channel_id_enabled|. 4916 OPENSSL_EXPORT int SSL_enable_tls_channel_id(SSL *ssl); 4917 4918 // BIO_f_ssl returns a |BIO_METHOD| that can wrap an |SSL*| in a |BIO*|. Note 4919 // that this has quite different behaviour from the version in OpenSSL (notably 4920 // that it doesn't try to auto renegotiate). 4921 // 4922 // IMPORTANT: if you are not curl, don't use this. 4923 OPENSSL_EXPORT const BIO_METHOD *BIO_f_ssl(void); 4924 4925 // BIO_set_ssl sets |ssl| as the underlying connection for |bio|, which must 4926 // have been created using |BIO_f_ssl|. If |take_owership| is true, |bio| will 4927 // call |SSL_free| on |ssl| when closed. It returns one on success or something 4928 // other than one on error. 4929 OPENSSL_EXPORT long BIO_set_ssl(BIO *bio, SSL *ssl, int take_owership); 4930 4931 // SSL_CTX_set_ecdh_auto returns one. 4932 #define SSL_CTX_set_ecdh_auto(ctx, onoff) 1 4933 4934 // SSL_set_ecdh_auto returns one. 4935 #define SSL_set_ecdh_auto(ssl, onoff) 1 4936 4937 // SSL_get_session returns a non-owning pointer to |ssl|'s session. For 4938 // historical reasons, which session it returns depends on |ssl|'s state. 4939 // 4940 // Prior to the start of the initial handshake, it returns the session the 4941 // caller set with |SSL_set_session|. After the initial handshake has finished 4942 // and if no additional handshakes are in progress, it returns the currently 4943 // active session. Its behavior is undefined while a handshake is in progress. 4944 // 4945 // If trying to add new sessions to an external session cache, use 4946 // |SSL_CTX_sess_set_new_cb| instead. In particular, using the callback is 4947 // required as of TLS 1.3. For compatibility, this function will return an 4948 // unresumable session which may be cached, but will never be resumed. 4949 // 4950 // If querying properties of the connection, use APIs on the |SSL| object. 4951 OPENSSL_EXPORT SSL_SESSION *SSL_get_session(const SSL *ssl); 4952 4953 // SSL_get0_session is an alias for |SSL_get_session|. 4954 #define SSL_get0_session SSL_get_session 4955 4956 // SSL_get1_session acts like |SSL_get_session| but returns a new reference to 4957 // the session. 4958 OPENSSL_EXPORT SSL_SESSION *SSL_get1_session(SSL *ssl); 4959 4960 #define OPENSSL_INIT_NO_LOAD_SSL_STRINGS 0 4961 #define OPENSSL_INIT_LOAD_SSL_STRINGS 0 4962 #define OPENSSL_INIT_SSL_DEFAULT 0 4963 4964 // OPENSSL_init_ssl calls |CRYPTO_library_init| and returns one. 4965 OPENSSL_EXPORT int OPENSSL_init_ssl(uint64_t opts, 4966 const OPENSSL_INIT_SETTINGS *settings); 4967 4968 // The following constants are legacy aliases for RSA-PSS with rsaEncryption 4969 // keys. Use the new names instead. 4970 #define SSL_SIGN_RSA_PSS_SHA256 SSL_SIGN_RSA_PSS_RSAE_SHA256 4971 #define SSL_SIGN_RSA_PSS_SHA384 SSL_SIGN_RSA_PSS_RSAE_SHA384 4972 #define SSL_SIGN_RSA_PSS_SHA512 SSL_SIGN_RSA_PSS_RSAE_SHA512 4973 4974 // SSL_set_tlsext_status_type configures a client to request OCSP stapling if 4975 // |type| is |TLSEXT_STATUSTYPE_ocsp| and disables it otherwise. It returns one 4976 // on success and zero if handshake configuration has already been shed. 4977 // 4978 // Use |SSL_enable_ocsp_stapling| instead. 4979 OPENSSL_EXPORT int SSL_set_tlsext_status_type(SSL *ssl, int type); 4980 4981 // SSL_get_tlsext_status_type returns |TLSEXT_STATUSTYPE_ocsp| if the client 4982 // requested OCSP stapling and |TLSEXT_STATUSTYPE_nothing| otherwise. On the 4983 // client, this reflects whether OCSP stapling was enabled via, e.g., 4984 // |SSL_set_tlsext_status_type|. On the server, this is determined during the 4985 // handshake. It may be queried in callbacks set by |SSL_CTX_set_cert_cb|. The 4986 // result is undefined after the handshake completes. 4987 OPENSSL_EXPORT int SSL_get_tlsext_status_type(const SSL *ssl); 4988 4989 // SSL_set_tlsext_status_ocsp_resp sets the OCSP response. It returns one on 4990 // success and zero on error. On success, |ssl| takes ownership of |resp|, which 4991 // must have been allocated by |OPENSSL_malloc|. 4992 // 4993 // Use |SSL_set_ocsp_response| instead. 4994 OPENSSL_EXPORT int SSL_set_tlsext_status_ocsp_resp(SSL *ssl, uint8_t *resp, 4995 size_t resp_len); 4996 4997 // SSL_get_tlsext_status_ocsp_resp sets |*out| to point to the OCSP response 4998 // from the server. It returns the length of the response. If there was no 4999 // response, it sets |*out| to NULL and returns zero. 5000 // 5001 // Use |SSL_get0_ocsp_response| instead. 5002 // 5003 // WARNING: the returned data is not guaranteed to be well formed. 5004 OPENSSL_EXPORT size_t SSL_get_tlsext_status_ocsp_resp(const SSL *ssl, 5005 const uint8_t **out); 5006 5007 // SSL_CTX_set_tlsext_status_cb configures the legacy OpenSSL OCSP callback and 5008 // returns one. Though the type signature is the same, this callback has 5009 // different behavior for client and server connections: 5010 // 5011 // For clients, the callback is called after certificate verification. It should 5012 // return one for success, zero for a bad OCSP response, and a negative number 5013 // for internal error. Instead, handle this as part of certificate verification. 5014 // (Historically, OpenSSL verified certificates just before parsing stapled OCSP 5015 // responses, but BoringSSL fixes this ordering. All server credentials are 5016 // available during verification.) 5017 // 5018 // Do not use this callback as a server. It is provided for compatibility 5019 // purposes only. For servers, it is called to configure server credentials. It 5020 // should return |SSL_TLSEXT_ERR_OK| on success, |SSL_TLSEXT_ERR_NOACK| to 5021 // ignore OCSP requests, or |SSL_TLSEXT_ERR_ALERT_FATAL| on error. It is usually 5022 // used to fetch OCSP responses on demand, which is not ideal. Instead, treat 5023 // OCSP responses like other server credentials, such as certificates or SCT 5024 // lists. Configure, store, and refresh them eagerly. This avoids downtime if 5025 // the CA's OCSP responder is briefly offline. 5026 OPENSSL_EXPORT int SSL_CTX_set_tlsext_status_cb(SSL_CTX *ctx, 5027 int (*callback)(SSL *ssl, 5028 void *arg)); 5029 5030 // SSL_CTX_set_tlsext_status_arg sets additional data for 5031 // |SSL_CTX_set_tlsext_status_cb|'s callback and returns one. 5032 OPENSSL_EXPORT int SSL_CTX_set_tlsext_status_arg(SSL_CTX *ctx, void *arg); 5033 5034 // The following symbols are compatibility aliases for reason codes used when 5035 // receiving an alert from the peer. Use the other names instead, which fit the 5036 // naming convention. 5037 // 5038 // TODO(davidben): Fix references to |SSL_R_TLSV1_CERTIFICATE_REQUIRED| and 5039 // remove the compatibility value. The others come from OpenSSL. 5040 #define SSL_R_TLSV1_UNSUPPORTED_EXTENSION \ 5041 SSL_R_TLSV1_ALERT_UNSUPPORTED_EXTENSION 5042 #define SSL_R_TLSV1_CERTIFICATE_UNOBTAINABLE \ 5043 SSL_R_TLSV1_ALERT_CERTIFICATE_UNOBTAINABLE 5044 #define SSL_R_TLSV1_UNRECOGNIZED_NAME SSL_R_TLSV1_ALERT_UNRECOGNIZED_NAME 5045 #define SSL_R_TLSV1_BAD_CERTIFICATE_STATUS_RESPONSE \ 5046 SSL_R_TLSV1_ALERT_BAD_CERTIFICATE_STATUS_RESPONSE 5047 #define SSL_R_TLSV1_BAD_CERTIFICATE_HASH_VALUE \ 5048 SSL_R_TLSV1_ALERT_BAD_CERTIFICATE_HASH_VALUE 5049 #define SSL_R_TLSV1_CERTIFICATE_REQUIRED SSL_R_TLSV1_ALERT_CERTIFICATE_REQUIRED 5050 5051 // SSL_CIPHER_get_value calls |SSL_CIPHER_get_protocol_id|. 5052 // 5053 // TODO(davidben): |SSL_CIPHER_get_value| was our name for this function, but 5054 // upstream added it as |SSL_CIPHER_get_protocol_id|. Switch callers to the new 5055 // name and remove this one. 5056 OPENSSL_EXPORT uint16_t SSL_CIPHER_get_value(const SSL_CIPHER *cipher); 5057 5058 5059 // Nodejs compatibility section (hidden). 5060 // 5061 // These defines exist for node.js, with the hope that we can eliminate the 5062 // need for them over time. 5063 5064 #define SSLerr(function, reason) \ 5065 ERR_put_error(ERR_LIB_SSL, 0, reason, __FILE__, __LINE__) 5066 5067 5068 // Preprocessor compatibility section (hidden). 5069 // 5070 // Historically, a number of APIs were implemented in OpenSSL as macros and 5071 // constants to 'ctrl' functions. To avoid breaking #ifdefs in consumers, this 5072 // section defines a number of legacy macros. 5073 // 5074 // Although using either the CTRL values or their wrapper macros in #ifdefs is 5075 // still supported, the CTRL values may not be passed to |SSL_ctrl| and 5076 // |SSL_CTX_ctrl|. Call the functions (previously wrapper macros) instead. 5077 // 5078 // See PORTING.md in the BoringSSL source tree for a table of corresponding 5079 // functions. 5080 // https://boringssl.googlesource.com/boringssl/+/master/PORTING.md#Replacements-for-values 5081 5082 #define DTLS_CTRL_GET_TIMEOUT doesnt_exist 5083 #define DTLS_CTRL_HANDLE_TIMEOUT doesnt_exist 5084 #define SSL_CTRL_CHAIN doesnt_exist 5085 #define SSL_CTRL_CHAIN_CERT doesnt_exist 5086 #define SSL_CTRL_CHANNEL_ID doesnt_exist 5087 #define SSL_CTRL_CLEAR_EXTRA_CHAIN_CERTS doesnt_exist 5088 #define SSL_CTRL_CLEAR_MODE doesnt_exist 5089 #define SSL_CTRL_CLEAR_OPTIONS doesnt_exist 5090 #define SSL_CTRL_EXTRA_CHAIN_CERT doesnt_exist 5091 #define SSL_CTRL_GET_CHAIN_CERTS doesnt_exist 5092 #define SSL_CTRL_GET_CHANNEL_ID doesnt_exist 5093 #define SSL_CTRL_GET_CLIENT_CERT_TYPES doesnt_exist 5094 #define SSL_CTRL_GET_EXTRA_CHAIN_CERTS doesnt_exist 5095 #define SSL_CTRL_GET_MAX_CERT_LIST doesnt_exist 5096 #define SSL_CTRL_GET_NUM_RENEGOTIATIONS doesnt_exist 5097 #define SSL_CTRL_GET_READ_AHEAD doesnt_exist 5098 #define SSL_CTRL_GET_RI_SUPPORT doesnt_exist 5099 #define SSL_CTRL_GET_SERVER_TMP_KEY doesnt_exist 5100 #define SSL_CTRL_GET_SESSION_REUSED doesnt_exist 5101 #define SSL_CTRL_GET_SESS_CACHE_MODE doesnt_exist 5102 #define SSL_CTRL_GET_SESS_CACHE_SIZE doesnt_exist 5103 #define SSL_CTRL_GET_TLSEXT_TICKET_KEYS doesnt_exist 5104 #define SSL_CTRL_GET_TOTAL_RENEGOTIATIONS doesnt_exist 5105 #define SSL_CTRL_MODE doesnt_exist 5106 #define SSL_CTRL_NEED_TMP_RSA doesnt_exist 5107 #define SSL_CTRL_OPTIONS doesnt_exist 5108 #define SSL_CTRL_SESS_NUMBER doesnt_exist 5109 #define SSL_CTRL_SET_CURVES doesnt_exist 5110 #define SSL_CTRL_SET_CURVES_LIST doesnt_exist 5111 #define SSL_CTRL_SET_ECDH_AUTO doesnt_exist 5112 #define SSL_CTRL_SET_MAX_CERT_LIST doesnt_exist 5113 #define SSL_CTRL_SET_MAX_SEND_FRAGMENT doesnt_exist 5114 #define SSL_CTRL_SET_MSG_CALLBACK doesnt_exist 5115 #define SSL_CTRL_SET_MSG_CALLBACK_ARG doesnt_exist 5116 #define SSL_CTRL_SET_MTU doesnt_exist 5117 #define SSL_CTRL_SET_READ_AHEAD doesnt_exist 5118 #define SSL_CTRL_SET_SESS_CACHE_MODE doesnt_exist 5119 #define SSL_CTRL_SET_SESS_CACHE_SIZE doesnt_exist 5120 #define SSL_CTRL_SET_TLSEXT_HOSTNAME doesnt_exist 5121 #define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG doesnt_exist 5122 #define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB doesnt_exist 5123 #define SSL_CTRL_SET_TLSEXT_TICKET_KEYS doesnt_exist 5124 #define SSL_CTRL_SET_TLSEXT_TICKET_KEY_CB doesnt_exist 5125 #define SSL_CTRL_SET_TMP_DH doesnt_exist 5126 #define SSL_CTRL_SET_TMP_DH_CB doesnt_exist 5127 #define SSL_CTRL_SET_TMP_ECDH doesnt_exist 5128 #define SSL_CTRL_SET_TMP_ECDH_CB doesnt_exist 5129 #define SSL_CTRL_SET_TMP_RSA doesnt_exist 5130 #define SSL_CTRL_SET_TMP_RSA_CB doesnt_exist 5131 5132 // |BORINGSSL_PREFIX| already makes each of these symbols into macros, so there 5133 // is no need to define conflicting macros. 5134 #if !defined(BORINGSSL_PREFIX) 5135 5136 #define DTLSv1_get_timeout DTLSv1_get_timeout 5137 #define DTLSv1_handle_timeout DTLSv1_handle_timeout 5138 #define SSL_CTX_add0_chain_cert SSL_CTX_add0_chain_cert 5139 #define SSL_CTX_add1_chain_cert SSL_CTX_add1_chain_cert 5140 #define SSL_CTX_add_extra_chain_cert SSL_CTX_add_extra_chain_cert 5141 #define SSL_CTX_clear_extra_chain_certs SSL_CTX_clear_extra_chain_certs 5142 #define SSL_CTX_clear_chain_certs SSL_CTX_clear_chain_certs 5143 #define SSL_CTX_clear_mode SSL_CTX_clear_mode 5144 #define SSL_CTX_clear_options SSL_CTX_clear_options 5145 #define SSL_CTX_get0_chain_certs SSL_CTX_get0_chain_certs 5146 #define SSL_CTX_get_extra_chain_certs SSL_CTX_get_extra_chain_certs 5147 #define SSL_CTX_get_max_cert_list SSL_CTX_get_max_cert_list 5148 #define SSL_CTX_get_mode SSL_CTX_get_mode 5149 #define SSL_CTX_get_options SSL_CTX_get_options 5150 #define SSL_CTX_get_read_ahead SSL_CTX_get_read_ahead 5151 #define SSL_CTX_get_session_cache_mode SSL_CTX_get_session_cache_mode 5152 #define SSL_CTX_get_tlsext_ticket_keys SSL_CTX_get_tlsext_ticket_keys 5153 #define SSL_CTX_need_tmp_RSA SSL_CTX_need_tmp_RSA 5154 #define SSL_CTX_sess_get_cache_size SSL_CTX_sess_get_cache_size 5155 #define SSL_CTX_sess_number SSL_CTX_sess_number 5156 #define SSL_CTX_sess_set_cache_size SSL_CTX_sess_set_cache_size 5157 #define SSL_CTX_set0_chain SSL_CTX_set0_chain 5158 #define SSL_CTX_set1_chain SSL_CTX_set1_chain 5159 #define SSL_CTX_set1_curves SSL_CTX_set1_curves 5160 #define SSL_CTX_set_max_cert_list SSL_CTX_set_max_cert_list 5161 #define SSL_CTX_set_max_send_fragment SSL_CTX_set_max_send_fragment 5162 #define SSL_CTX_set_mode SSL_CTX_set_mode 5163 #define SSL_CTX_set_msg_callback_arg SSL_CTX_set_msg_callback_arg 5164 #define SSL_CTX_set_options SSL_CTX_set_options 5165 #define SSL_CTX_set_read_ahead SSL_CTX_set_read_ahead 5166 #define SSL_CTX_set_session_cache_mode SSL_CTX_set_session_cache_mode 5167 #define SSL_CTX_set_tlsext_servername_arg SSL_CTX_set_tlsext_servername_arg 5168 #define SSL_CTX_set_tlsext_servername_callback \ 5169 SSL_CTX_set_tlsext_servername_callback 5170 #define SSL_CTX_set_tlsext_ticket_key_cb SSL_CTX_set_tlsext_ticket_key_cb 5171 #define SSL_CTX_set_tlsext_ticket_keys SSL_CTX_set_tlsext_ticket_keys 5172 #define SSL_CTX_set_tmp_dh SSL_CTX_set_tmp_dh 5173 #define SSL_CTX_set_tmp_ecdh SSL_CTX_set_tmp_ecdh 5174 #define SSL_CTX_set_tmp_rsa SSL_CTX_set_tmp_rsa 5175 #define SSL_add0_chain_cert SSL_add0_chain_cert 5176 #define SSL_add1_chain_cert SSL_add1_chain_cert 5177 #define SSL_clear_chain_certs SSL_clear_chain_certs 5178 #define SSL_clear_mode SSL_clear_mode 5179 #define SSL_clear_options SSL_clear_options 5180 #define SSL_get0_certificate_types SSL_get0_certificate_types 5181 #define SSL_get0_chain_certs SSL_get0_chain_certs 5182 #define SSL_get_max_cert_list SSL_get_max_cert_list 5183 #define SSL_get_mode SSL_get_mode 5184 #define SSL_get_options SSL_get_options 5185 #define SSL_get_secure_renegotiation_support \ 5186 SSL_get_secure_renegotiation_support 5187 #define SSL_need_tmp_RSA SSL_need_tmp_RSA 5188 #define SSL_num_renegotiations SSL_num_renegotiations 5189 #define SSL_session_reused SSL_session_reused 5190 #define SSL_set0_chain SSL_set0_chain 5191 #define SSL_set1_chain SSL_set1_chain 5192 #define SSL_set1_curves SSL_set1_curves 5193 #define SSL_set_max_cert_list SSL_set_max_cert_list 5194 #define SSL_set_max_send_fragment SSL_set_max_send_fragment 5195 #define SSL_set_mode SSL_set_mode 5196 #define SSL_set_msg_callback_arg SSL_set_msg_callback_arg 5197 #define SSL_set_mtu SSL_set_mtu 5198 #define SSL_set_options SSL_set_options 5199 #define SSL_set_tlsext_host_name SSL_set_tlsext_host_name 5200 #define SSL_set_tmp_dh SSL_set_tmp_dh 5201 #define SSL_set_tmp_ecdh SSL_set_tmp_ecdh 5202 #define SSL_set_tmp_rsa SSL_set_tmp_rsa 5203 #define SSL_total_renegotiations SSL_total_renegotiations 5204 5205 #endif // !defined(BORINGSSL_PREFIX) 5206 5207 5208 #if defined(__cplusplus) 5209 } // extern C 5210 5211 #if !defined(BORINGSSL_NO_CXX) 5212 5213 extern "C++" { 5214 5215 BSSL_NAMESPACE_BEGIN 5216 5217 BORINGSSL_MAKE_DELETER(SSL, SSL_free) 5218 BORINGSSL_MAKE_DELETER(SSL_CTX, SSL_CTX_free) 5219 BORINGSSL_MAKE_UP_REF(SSL_CTX, SSL_CTX_up_ref) 5220 BORINGSSL_MAKE_DELETER(SSL_ECH_KEYS, SSL_ECH_KEYS_free) 5221 BORINGSSL_MAKE_UP_REF(SSL_ECH_KEYS, SSL_ECH_KEYS_up_ref) 5222 BORINGSSL_MAKE_DELETER(SSL_SESSION, SSL_SESSION_free) 5223 BORINGSSL_MAKE_UP_REF(SSL_SESSION, SSL_SESSION_up_ref) 5224 5225 enum class OpenRecordResult { 5226 kOK, 5227 kDiscard, 5228 kIncompleteRecord, 5229 kAlertCloseNotify, 5230 kError, 5231 }; 5232 5233 // *** EXPERIMENTAL -- DO NOT USE *** 5234 // 5235 // OpenRecord decrypts the first complete SSL record from |in| in-place, sets 5236 // |out| to the decrypted application data, and |out_record_len| to the length 5237 // of the encrypted record. Returns: 5238 // - kOK if an application-data record was successfully decrypted and verified. 5239 // - kDiscard if a record was sucessfully processed, but should be discarded. 5240 // - kIncompleteRecord if |in| did not contain a complete record. 5241 // - kAlertCloseNotify if a record was successfully processed but is a 5242 // close_notify alert. 5243 // - kError if an error occurred or the record is invalid. |*out_alert| will be 5244 // set to an alert to emit, or zero if no alert should be emitted. 5245 OPENSSL_EXPORT OpenRecordResult OpenRecord(SSL *ssl, Span<uint8_t> *out, 5246 size_t *out_record_len, 5247 uint8_t *out_alert, 5248 Span<uint8_t> in); 5249 5250 OPENSSL_EXPORT size_t SealRecordPrefixLen(const SSL *ssl, size_t plaintext_len); 5251 5252 // SealRecordSuffixLen returns the length of the suffix written by |SealRecord|. 5253 // 5254 // |plaintext_len| must be equal to the size of the plaintext passed to 5255 // |SealRecord|. 5256 // 5257 // |plaintext_len| must not exceed |SSL3_RT_MAX_PLAINTEXT_LENGTH|. The returned 5258 // suffix length will not exceed |SSL3_RT_MAX_ENCRYPTED_OVERHEAD|. 5259 OPENSSL_EXPORT size_t SealRecordSuffixLen(const SSL *ssl, size_t plaintext_len); 5260 5261 // *** EXPERIMENTAL -- DO NOT USE *** 5262 // 5263 // SealRecord encrypts the cleartext of |in| and scatters the resulting TLS 5264 // application data record between |out_prefix|, |out|, and |out_suffix|. It 5265 // returns true on success or false if an error occurred. 5266 // 5267 // The length of |out_prefix| must equal |SealRecordPrefixLen|. The length of 5268 // |out| must equal the length of |in|, which must not exceed 5269 // |SSL3_RT_MAX_PLAINTEXT_LENGTH|. The length of |out_suffix| must equal 5270 // |SealRecordSuffixLen|. 5271 // 5272 // If enabled, |SealRecord| may perform TLS 1.0 CBC 1/n-1 record splitting. 5273 // |SealRecordPrefixLen| accounts for the required overhead if that is the case. 5274 // 5275 // |out| may equal |in| to encrypt in-place but may not otherwise alias. 5276 // |out_prefix| and |out_suffix| may not alias anything. 5277 OPENSSL_EXPORT bool SealRecord(SSL *ssl, Span<uint8_t> out_prefix, 5278 Span<uint8_t> out, Span<uint8_t> out_suffix, 5279 Span<const uint8_t> in); 5280 5281 5282 // *** EXPERIMENTAL — DO NOT USE WITHOUT CHECKING *** 5283 // 5284 // Split handshakes. 5285 // 5286 // Split handshakes allows the handshake part of a TLS connection to be 5287 // performed in a different process (or on a different machine) than the data 5288 // exchange. This only applies to servers. 5289 // 5290 // In the first part of a split handshake, an |SSL| (where the |SSL_CTX| has 5291 // been configured with |SSL_CTX_set_handoff_mode|) is used normally. Once the 5292 // ClientHello message has been received, the handshake will stop and 5293 // |SSL_get_error| will indicate |SSL_ERROR_HANDOFF|. At this point (and only 5294 // at this point), |SSL_serialize_handoff| can be called to write the “handoff” 5295 // state of the connection. 5296 // 5297 // Elsewhere, a fresh |SSL| can be used with |SSL_apply_handoff| to continue 5298 // the connection. The connection from the client is fed into this |SSL|, and 5299 // the handshake resumed. When the handshake stops again and |SSL_get_error| 5300 // indicates |SSL_ERROR_HANDBACK|, |SSL_serialize_handback| should be called to 5301 // serialize the state of the handshake again. 5302 // 5303 // Back at the first location, a fresh |SSL| can be used with 5304 // |SSL_apply_handback|. Then the client's connection can be processed mostly 5305 // as normal. 5306 // 5307 // Lastly, when a connection is in the handoff state, whether or not 5308 // |SSL_serialize_handoff| is called, |SSL_decline_handoff| will move it back 5309 // into a normal state where the connection can proceed without impact. 5310 // 5311 // WARNING: Currently only works with TLS 1.0–1.2. 5312 // WARNING: The serialisation formats are not yet stable: version skew may be 5313 // fatal. 5314 // WARNING: The handback data contains sensitive key material and must be 5315 // protected. 5316 // WARNING: Some calls on the final |SSL| will not work. Just as an example, 5317 // calls like |SSL_get0_session_id_context| and |SSL_get_privatekey| won't 5318 // work because the certificate used for handshaking isn't available. 5319 // WARNING: |SSL_apply_handoff| may trigger “msg” callback calls. 5320 5321 OPENSSL_EXPORT void SSL_CTX_set_handoff_mode(SSL_CTX *ctx, bool on); 5322 OPENSSL_EXPORT void SSL_set_handoff_mode(SSL *SSL, bool on); 5323 OPENSSL_EXPORT bool SSL_serialize_handoff(const SSL *ssl, CBB *out, 5324 SSL_CLIENT_HELLO *out_hello); 5325 OPENSSL_EXPORT bool SSL_decline_handoff(SSL *ssl); 5326 OPENSSL_EXPORT bool SSL_apply_handoff(SSL *ssl, Span<const uint8_t> handoff); 5327 OPENSSL_EXPORT bool SSL_serialize_handback(const SSL *ssl, CBB *out); 5328 OPENSSL_EXPORT bool SSL_apply_handback(SSL *ssl, Span<const uint8_t> handback); 5329 5330 // SSL_get_traffic_secrets sets |*out_read_traffic_secret| and 5331 // |*out_write_traffic_secret| to reference the TLS 1.3 traffic secrets for 5332 // |ssl|. This function is only valid on TLS 1.3 connections that have 5333 // completed the handshake. It returns true on success and false on error. 5334 OPENSSL_EXPORT bool SSL_get_traffic_secrets( 5335 const SSL *ssl, Span<const uint8_t> *out_read_traffic_secret, 5336 Span<const uint8_t> *out_write_traffic_secret); 5337 5338 5339 BSSL_NAMESPACE_END 5340 5341 } // extern C++ 5342 5343 #endif // !defined(BORINGSSL_NO_CXX) 5344 5345 #endif 5346 5347 #define SSL_R_APP_DATA_IN_HANDSHAKE 100 5348 #define SSL_R_ATTEMPT_TO_REUSE_SESSION_IN_DIFFERENT_CONTEXT 101 5349 #define SSL_R_BAD_ALERT 102 5350 #define SSL_R_BAD_CHANGE_CIPHER_SPEC 103 5351 #define SSL_R_BAD_DATA_RETURNED_BY_CALLBACK 104 5352 #define SSL_R_BAD_DH_P_LENGTH 105 5353 #define SSL_R_BAD_DIGEST_LENGTH 106 5354 #define SSL_R_BAD_ECC_CERT 107 5355 #define SSL_R_BAD_ECPOINT 108 5356 #define SSL_R_BAD_HANDSHAKE_RECORD 109 5357 #define SSL_R_BAD_HELLO_REQUEST 110 5358 #define SSL_R_BAD_LENGTH 111 5359 #define SSL_R_BAD_PACKET_LENGTH 112 5360 #define SSL_R_BAD_RSA_ENCRYPT 113 5361 #define SSL_R_BAD_SIGNATURE 114 5362 #define SSL_R_BAD_SRTP_MKI_VALUE 115 5363 #define SSL_R_BAD_SRTP_PROTECTION_PROFILE_LIST 116 5364 #define SSL_R_BAD_SSL_FILETYPE 117 5365 #define SSL_R_BAD_WRITE_RETRY 118 5366 #define SSL_R_BIO_NOT_SET 119 5367 #define SSL_R_BN_LIB 120 5368 #define SSL_R_BUFFER_TOO_SMALL 121 5369 #define SSL_R_CA_DN_LENGTH_MISMATCH 122 5370 #define SSL_R_CA_DN_TOO_LONG 123 5371 #define SSL_R_CCS_RECEIVED_EARLY 124 5372 #define SSL_R_CERTIFICATE_VERIFY_FAILED 125 5373 #define SSL_R_CERT_CB_ERROR 126 5374 #define SSL_R_CERT_LENGTH_MISMATCH 127 5375 #define SSL_R_CHANNEL_ID_NOT_P256 128 5376 #define SSL_R_CHANNEL_ID_SIGNATURE_INVALID 129 5377 #define SSL_R_CIPHER_OR_HASH_UNAVAILABLE 130 5378 #define SSL_R_CLIENTHELLO_PARSE_FAILED 131 5379 #define SSL_R_CLIENTHELLO_TLSEXT 132 5380 #define SSL_R_CONNECTION_REJECTED 133 5381 #define SSL_R_CONNECTION_TYPE_NOT_SET 134 5382 #define SSL_R_CUSTOM_EXTENSION_ERROR 135 5383 #define SSL_R_DATA_LENGTH_TOO_LONG 136 5384 #define SSL_R_DECODE_ERROR 137 5385 #define SSL_R_DECRYPTION_FAILED 138 5386 #define SSL_R_DECRYPTION_FAILED_OR_BAD_RECORD_MAC 139 5387 #define SSL_R_DH_PUBLIC_VALUE_LENGTH_IS_WRONG 140 5388 #define SSL_R_DH_P_TOO_LONG 141 5389 #define SSL_R_DIGEST_CHECK_FAILED 142 5390 #define SSL_R_DTLS_MESSAGE_TOO_BIG 143 5391 #define SSL_R_ECC_CERT_NOT_FOR_SIGNING 144 5392 #define SSL_R_EMS_STATE_INCONSISTENT 145 5393 #define SSL_R_ENCRYPTED_LENGTH_TOO_LONG 146 5394 #define SSL_R_ERROR_ADDING_EXTENSION 147 5395 #define SSL_R_ERROR_IN_RECEIVED_CIPHER_LIST 148 5396 #define SSL_R_ERROR_PARSING_EXTENSION 149 5397 #define SSL_R_EXCESSIVE_MESSAGE_SIZE 150 5398 #define SSL_R_EXTRA_DATA_IN_MESSAGE 151 5399 #define SSL_R_FRAGMENT_MISMATCH 152 5400 #define SSL_R_GOT_NEXT_PROTO_WITHOUT_EXTENSION 153 5401 #define SSL_R_HANDSHAKE_FAILURE_ON_CLIENT_HELLO 154 5402 #define SSL_R_HTTPS_PROXY_REQUEST 155 5403 #define SSL_R_HTTP_REQUEST 156 5404 #define SSL_R_INAPPROPRIATE_FALLBACK 157 5405 #define SSL_R_INVALID_COMMAND 158 5406 #define SSL_R_INVALID_MESSAGE 159 5407 #define SSL_R_INVALID_SSL_SESSION 160 5408 #define SSL_R_INVALID_TICKET_KEYS_LENGTH 161 5409 #define SSL_R_LENGTH_MISMATCH 162 5410 #define SSL_R_MISSING_EXTENSION 164 5411 #define SSL_R_MISSING_RSA_CERTIFICATE 165 5412 #define SSL_R_MISSING_TMP_DH_KEY 166 5413 #define SSL_R_MISSING_TMP_ECDH_KEY 167 5414 #define SSL_R_MIXED_SPECIAL_OPERATOR_WITH_GROUPS 168 5415 #define SSL_R_MTU_TOO_SMALL 169 5416 #define SSL_R_NEGOTIATED_BOTH_NPN_AND_ALPN 170 5417 #define SSL_R_NESTED_GROUP 171 5418 #define SSL_R_NO_CERTIFICATES_RETURNED 172 5419 #define SSL_R_NO_CERTIFICATE_ASSIGNED 173 5420 #define SSL_R_NO_CERTIFICATE_SET 174 5421 #define SSL_R_NO_CIPHERS_AVAILABLE 175 5422 #define SSL_R_NO_CIPHERS_PASSED 176 5423 #define SSL_R_NO_CIPHER_MATCH 177 5424 #define SSL_R_NO_COMPRESSION_SPECIFIED 178 5425 #define SSL_R_NO_METHOD_SPECIFIED 179 5426 #define SSL_R_NO_P256_SUPPORT 180 5427 #define SSL_R_NO_PRIVATE_KEY_ASSIGNED 181 5428 #define SSL_R_NO_RENEGOTIATION 182 5429 #define SSL_R_NO_REQUIRED_DIGEST 183 5430 #define SSL_R_NO_SHARED_CIPHER 184 5431 #define SSL_R_NULL_SSL_CTX 185 5432 #define SSL_R_NULL_SSL_METHOD_PASSED 186 5433 #define SSL_R_OLD_SESSION_CIPHER_NOT_RETURNED 187 5434 #define SSL_R_OLD_SESSION_VERSION_NOT_RETURNED 188 5435 #define SSL_R_OUTPUT_ALIASES_INPUT 189 5436 #define SSL_R_PARSE_TLSEXT 190 5437 #define SSL_R_PATH_TOO_LONG 191 5438 #define SSL_R_PEER_DID_NOT_RETURN_A_CERTIFICATE 192 5439 #define SSL_R_PEER_ERROR_UNSUPPORTED_CERTIFICATE_TYPE 193 5440 #define SSL_R_PROTOCOL_IS_SHUTDOWN 194 5441 #define SSL_R_PSK_IDENTITY_NOT_FOUND 195 5442 #define SSL_R_PSK_NO_CLIENT_CB 196 5443 #define SSL_R_PSK_NO_SERVER_CB 197 5444 #define SSL_R_READ_TIMEOUT_EXPIRED 198 5445 #define SSL_R_RECORD_LENGTH_MISMATCH 199 5446 #define SSL_R_RECORD_TOO_LARGE 200 5447 #define SSL_R_RENEGOTIATION_ENCODING_ERR 201 5448 #define SSL_R_RENEGOTIATION_MISMATCH 202 5449 #define SSL_R_REQUIRED_CIPHER_MISSING 203 5450 #define SSL_R_RESUMED_EMS_SESSION_WITHOUT_EMS_EXTENSION 204 5451 #define SSL_R_RESUMED_NON_EMS_SESSION_WITH_EMS_EXTENSION 205 5452 #define SSL_R_SCSV_RECEIVED_WHEN_RENEGOTIATING 206 5453 #define SSL_R_SERVERHELLO_TLSEXT 207 5454 #define SSL_R_SESSION_ID_CONTEXT_UNINITIALIZED 208 5455 #define SSL_R_SESSION_MAY_NOT_BE_CREATED 209 5456 #define SSL_R_SIGNATURE_ALGORITHMS_EXTENSION_SENT_BY_SERVER 210 5457 #define SSL_R_SRTP_COULD_NOT_ALLOCATE_PROFILES 211 5458 #define SSL_R_SRTP_UNKNOWN_PROTECTION_PROFILE 212 5459 #define SSL_R_SSL3_EXT_INVALID_SERVERNAME 213 5460 #define SSL_R_SSL_CTX_HAS_NO_DEFAULT_SSL_VERSION 214 5461 #define SSL_R_SSL_HANDSHAKE_FAILURE 215 5462 #define SSL_R_SSL_SESSION_ID_CONTEXT_TOO_LONG 216 5463 #define SSL_R_TLS_PEER_DID_NOT_RESPOND_WITH_CERTIFICATE_LIST 217 5464 #define SSL_R_TLS_RSA_ENCRYPTED_VALUE_LENGTH_IS_WRONG 218 5465 #define SSL_R_TOO_MANY_EMPTY_FRAGMENTS 219 5466 #define SSL_R_TOO_MANY_WARNING_ALERTS 220 5467 #define SSL_R_UNABLE_TO_FIND_ECDH_PARAMETERS 221 5468 #define SSL_R_UNEXPECTED_EXTENSION 222 5469 #define SSL_R_UNEXPECTED_MESSAGE 223 5470 #define SSL_R_UNEXPECTED_OPERATOR_IN_GROUP 224 5471 #define SSL_R_UNEXPECTED_RECORD 225 5472 #define SSL_R_UNINITIALIZED 226 5473 #define SSL_R_UNKNOWN_ALERT_TYPE 227 5474 #define SSL_R_UNKNOWN_CERTIFICATE_TYPE 228 5475 #define SSL_R_UNKNOWN_CIPHER_RETURNED 229 5476 #define SSL_R_UNKNOWN_CIPHER_TYPE 230 5477 #define SSL_R_UNKNOWN_DIGEST 231 5478 #define SSL_R_UNKNOWN_KEY_EXCHANGE_TYPE 232 5479 #define SSL_R_UNKNOWN_PROTOCOL 233 5480 #define SSL_R_UNKNOWN_SSL_VERSION 234 5481 #define SSL_R_UNKNOWN_STATE 235 5482 #define SSL_R_UNSAFE_LEGACY_RENEGOTIATION_DISABLED 236 5483 #define SSL_R_UNSUPPORTED_CIPHER 237 5484 #define SSL_R_UNSUPPORTED_COMPRESSION_ALGORITHM 238 5485 #define SSL_R_UNSUPPORTED_ELLIPTIC_CURVE 239 5486 #define SSL_R_UNSUPPORTED_PROTOCOL 240 5487 #define SSL_R_WRONG_CERTIFICATE_TYPE 241 5488 #define SSL_R_WRONG_CIPHER_RETURNED 242 5489 #define SSL_R_WRONG_CURVE 243 5490 #define SSL_R_WRONG_MESSAGE_TYPE 244 5491 #define SSL_R_WRONG_SIGNATURE_TYPE 245 5492 #define SSL_R_WRONG_SSL_VERSION 246 5493 #define SSL_R_WRONG_VERSION_NUMBER 247 5494 #define SSL_R_X509_LIB 248 5495 #define SSL_R_X509_VERIFICATION_SETUP_PROBLEMS 249 5496 #define SSL_R_SHUTDOWN_WHILE_IN_INIT 250 5497 #define SSL_R_INVALID_OUTER_RECORD_TYPE 251 5498 #define SSL_R_UNSUPPORTED_PROTOCOL_FOR_CUSTOM_KEY 252 5499 #define SSL_R_NO_COMMON_SIGNATURE_ALGORITHMS 253 5500 #define SSL_R_DOWNGRADE_DETECTED 254 5501 #define SSL_R_EXCESS_HANDSHAKE_DATA 255 5502 #define SSL_R_INVALID_COMPRESSION_LIST 256 5503 #define SSL_R_DUPLICATE_EXTENSION 257 5504 #define SSL_R_MISSING_KEY_SHARE 258 5505 #define SSL_R_INVALID_ALPN_PROTOCOL 259 5506 #define SSL_R_TOO_MANY_KEY_UPDATES 260 5507 #define SSL_R_BLOCK_CIPHER_PAD_IS_WRONG 261 5508 #define SSL_R_NO_CIPHERS_SPECIFIED 262 5509 #define SSL_R_RENEGOTIATION_EMS_MISMATCH 263 5510 #define SSL_R_DUPLICATE_KEY_SHARE 264 5511 #define SSL_R_NO_GROUPS_SPECIFIED 265 5512 #define SSL_R_NO_SHARED_GROUP 266 5513 #define SSL_R_PRE_SHARED_KEY_MUST_BE_LAST 267 5514 #define SSL_R_OLD_SESSION_PRF_HASH_MISMATCH 268 5515 #define SSL_R_INVALID_SCT_LIST 269 5516 #define SSL_R_TOO_MUCH_SKIPPED_EARLY_DATA 270 5517 #define SSL_R_PSK_IDENTITY_BINDER_COUNT_MISMATCH 271 5518 #define SSL_R_CANNOT_PARSE_LEAF_CERT 272 5519 #define SSL_R_SERVER_CERT_CHANGED 273 5520 #define SSL_R_CERTIFICATE_AND_PRIVATE_KEY_MISMATCH 274 5521 #define SSL_R_CANNOT_HAVE_BOTH_PRIVKEY_AND_METHOD 275 5522 #define SSL_R_TICKET_ENCRYPTION_FAILED 276 5523 #define SSL_R_ALPN_MISMATCH_ON_EARLY_DATA 277 5524 #define SSL_R_WRONG_VERSION_ON_EARLY_DATA 278 5525 #define SSL_R_UNEXPECTED_EXTENSION_ON_EARLY_DATA 279 5526 #define SSL_R_NO_SUPPORTED_VERSIONS_ENABLED 280 5527 #define SSL_R_APPLICATION_DATA_INSTEAD_OF_HANDSHAKE 281 5528 #define SSL_R_EMPTY_HELLO_RETRY_REQUEST 282 5529 #define SSL_R_EARLY_DATA_NOT_IN_USE 283 5530 #define SSL_R_HANDSHAKE_NOT_COMPLETE 284 5531 #define SSL_R_NEGOTIATED_TB_WITHOUT_EMS_OR_RI 285 5532 #define SSL_R_SERVER_ECHOED_INVALID_SESSION_ID 286 5533 #define SSL_R_PRIVATE_KEY_OPERATION_FAILED 287 5534 #define SSL_R_SECOND_SERVERHELLO_VERSION_MISMATCH 288 5535 #define SSL_R_OCSP_CB_ERROR 289 5536 #define SSL_R_SSL_SESSION_ID_TOO_LONG 290 5537 #define SSL_R_APPLICATION_DATA_ON_SHUTDOWN 291 5538 #define SSL_R_CERT_DECOMPRESSION_FAILED 292 5539 #define SSL_R_UNCOMPRESSED_CERT_TOO_LARGE 293 5540 #define SSL_R_UNKNOWN_CERT_COMPRESSION_ALG 294 5541 #define SSL_R_INVALID_SIGNATURE_ALGORITHM 295 5542 #define SSL_R_DUPLICATE_SIGNATURE_ALGORITHM 296 5543 #define SSL_R_TLS13_DOWNGRADE 297 5544 #define SSL_R_QUIC_INTERNAL_ERROR 298 5545 #define SSL_R_WRONG_ENCRYPTION_LEVEL_RECEIVED 299 5546 #define SSL_R_TOO_MUCH_READ_EARLY_DATA 300 5547 #define SSL_R_INVALID_DELEGATED_CREDENTIAL 301 5548 #define SSL_R_KEY_USAGE_BIT_INCORRECT 302 5549 #define SSL_R_INCONSISTENT_CLIENT_HELLO 303 5550 #define SSL_R_CIPHER_MISMATCH_ON_EARLY_DATA 304 5551 #define SSL_R_QUIC_TRANSPORT_PARAMETERS_MISCONFIGURED 305 5552 #define SSL_R_UNEXPECTED_COMPATIBILITY_MODE 306 5553 #define SSL_R_NO_APPLICATION_PROTOCOL 307 5554 #define SSL_R_NEGOTIATED_ALPS_WITHOUT_ALPN 308 5555 #define SSL_R_ALPS_MISMATCH_ON_EARLY_DATA 309 5556 #define SSL_R_ECH_SERVER_CONFIG_AND_PRIVATE_KEY_MISMATCH 310 5557 #define SSL_R_ECH_SERVER_CONFIG_UNSUPPORTED_EXTENSION 311 5558 #define SSL_R_UNSUPPORTED_ECH_SERVER_CONFIG 312 5559 #define SSL_R_ECH_SERVER_WOULD_HAVE_NO_RETRY_CONFIGS 313 5560 #define SSL_R_INVALID_CLIENT_HELLO_INNER 314 5561 #define SSL_R_INVALID_ALPN_PROTOCOL_LIST 315 5562 #define SSL_R_COULD_NOT_PARSE_HINTS 316 5563 #define SSL_R_INVALID_ECH_PUBLIC_NAME 317 5564 #define SSL_R_INVALID_ECH_CONFIG_LIST 318 5565 #define SSL_R_ECH_REJECTED 319 5566 #define SSL_R_OUTER_EXTENSION_NOT_FOUND 320 5567 #define SSL_R_INCONSISTENT_ECH_NEGOTIATION 321 5568 #define SSL_R_SSLV3_ALERT_CLOSE_NOTIFY 1000 5569 #define SSL_R_SSLV3_ALERT_UNEXPECTED_MESSAGE 1010 5570 #define SSL_R_SSLV3_ALERT_BAD_RECORD_MAC 1020 5571 #define SSL_R_TLSV1_ALERT_DECRYPTION_FAILED 1021 5572 #define SSL_R_TLSV1_ALERT_RECORD_OVERFLOW 1022 5573 #define SSL_R_SSLV3_ALERT_DECOMPRESSION_FAILURE 1030 5574 #define SSL_R_SSLV3_ALERT_HANDSHAKE_FAILURE 1040 5575 #define SSL_R_SSLV3_ALERT_NO_CERTIFICATE 1041 5576 #define SSL_R_SSLV3_ALERT_BAD_CERTIFICATE 1042 5577 #define SSL_R_SSLV3_ALERT_UNSUPPORTED_CERTIFICATE 1043 5578 #define SSL_R_SSLV3_ALERT_CERTIFICATE_REVOKED 1044 5579 #define SSL_R_SSLV3_ALERT_CERTIFICATE_EXPIRED 1045 5580 #define SSL_R_SSLV3_ALERT_CERTIFICATE_UNKNOWN 1046 5581 #define SSL_R_SSLV3_ALERT_ILLEGAL_PARAMETER 1047 5582 #define SSL_R_TLSV1_ALERT_UNKNOWN_CA 1048 5583 #define SSL_R_TLSV1_ALERT_ACCESS_DENIED 1049 5584 #define SSL_R_TLSV1_ALERT_DECODE_ERROR 1050 5585 #define SSL_R_TLSV1_ALERT_DECRYPT_ERROR 1051 5586 #define SSL_R_TLSV1_ALERT_EXPORT_RESTRICTION 1060 5587 #define SSL_R_TLSV1_ALERT_PROTOCOL_VERSION 1070 5588 #define SSL_R_TLSV1_ALERT_INSUFFICIENT_SECURITY 1071 5589 #define SSL_R_TLSV1_ALERT_INTERNAL_ERROR 1080 5590 #define SSL_R_TLSV1_ALERT_INAPPROPRIATE_FALLBACK 1086 5591 #define SSL_R_TLSV1_ALERT_USER_CANCELLED 1090 5592 #define SSL_R_TLSV1_ALERT_NO_RENEGOTIATION 1100 5593 #define SSL_R_TLSV1_ALERT_UNSUPPORTED_EXTENSION 1110 5594 #define SSL_R_TLSV1_ALERT_CERTIFICATE_UNOBTAINABLE 1111 5595 #define SSL_R_TLSV1_ALERT_UNRECOGNIZED_NAME 1112 5596 #define SSL_R_TLSV1_ALERT_BAD_CERTIFICATE_STATUS_RESPONSE 1113 5597 #define SSL_R_TLSV1_ALERT_BAD_CERTIFICATE_HASH_VALUE 1114 5598 #define SSL_R_TLSV1_ALERT_UNKNOWN_PSK_IDENTITY 1115 5599 #define SSL_R_TLSV1_ALERT_CERTIFICATE_REQUIRED 1116 5600 #define SSL_R_TLSV1_ALERT_NO_APPLICATION_PROTOCOL 1120 5601 #define SSL_R_TLSV1_ALERT_ECH_REQUIRED 1121 5602 5603 #endif // OPENSSL_HEADER_SSL_H 5604