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