Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 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 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 142 | #ifndef OPENSSL_HEADER_SSL_INTERNAL_H |
| 143 | #define OPENSSL_HEADER_SSL_INTERNAL_H |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 144 | |
| 145 | #include <openssl/base.h> |
| 146 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 147 | #include <openssl/aead.h> |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 148 | #include <openssl/ssl.h> |
| 149 | #include <openssl/stack.h> |
| 150 | |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 151 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 152 | #if defined(OPENSSL_WINDOWS) |
| 153 | /* Windows defines struct timeval in winsock2.h. */ |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 154 | OPENSSL_MSVC_PRAGMA(warning(push, 3)) |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 155 | #include <winsock2.h> |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 156 | OPENSSL_MSVC_PRAGMA(warning(pop)) |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 157 | #else |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 158 | #include <sys/time.h> |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 159 | #endif |
| 160 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 161 | #if defined(__cplusplus) |
| 162 | extern "C" { |
| 163 | #endif |
| 164 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 165 | |
| 166 | /* Cipher suites. */ |
| 167 | |
| 168 | /* Bits for |algorithm_mkey| (key exchange algorithm). */ |
| 169 | #define SSL_kRSA 0x00000001L |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 170 | #define SSL_kECDHE 0x00000002L |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 171 | /* SSL_kPSK is only set for plain PSK, not ECDHE_PSK. */ |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 172 | #define SSL_kPSK 0x00000004L |
| 173 | #define SSL_kGENERIC 0x00000008L |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 174 | |
| 175 | /* Bits for |algorithm_auth| (server authentication). */ |
| 176 | #define SSL_aRSA 0x00000001L |
| 177 | #define SSL_aECDSA 0x00000002L |
| 178 | /* SSL_aPSK is set for both PSK and ECDHE_PSK. */ |
| 179 | #define SSL_aPSK 0x00000004L |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 180 | #define SSL_aGENERIC 0x00000008L |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 181 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 182 | #define SSL_aCERT (SSL_aRSA | SSL_aECDSA) |
| 183 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 184 | /* Bits for |algorithm_enc| (symmetric encryption). */ |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 185 | #define SSL_3DES 0x00000001L |
| 186 | #define SSL_AES128 0x00000002L |
| 187 | #define SSL_AES256 0x00000004L |
| 188 | #define SSL_AES128GCM 0x00000008L |
| 189 | #define SSL_AES256GCM 0x00000010L |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 190 | #define SSL_eNULL 0x00000020L |
| 191 | #define SSL_CHACHA20POLY1305 0x00000040L |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 192 | |
| 193 | #define SSL_AES (SSL_AES128 | SSL_AES256 | SSL_AES128GCM | SSL_AES256GCM) |
| 194 | |
| 195 | /* Bits for |algorithm_mac| (symmetric authentication). */ |
Steven Valdez | b0b45c6 | 2017-01-17 16:23:54 -0500 | [diff] [blame] | 196 | #define SSL_SHA1 0x00000001L |
| 197 | #define SSL_SHA256 0x00000002L |
| 198 | #define SSL_SHA384 0x00000004L |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 199 | /* SSL_AEAD is set for all AEADs. */ |
Steven Valdez | b0b45c6 | 2017-01-17 16:23:54 -0500 | [diff] [blame] | 200 | #define SSL_AEAD 0x00000008L |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 201 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 202 | /* Bits for |algorithm_prf| (handshake digest). */ |
| 203 | #define SSL_HANDSHAKE_MAC_DEFAULT 0x1 |
| 204 | #define SSL_HANDSHAKE_MAC_SHA256 0x2 |
| 205 | #define SSL_HANDSHAKE_MAC_SHA384 0x4 |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 206 | |
| 207 | /* SSL_MAX_DIGEST is the number of digest types which exist. When adding a new |
| 208 | * one, update the table in ssl_cipher.c. */ |
| 209 | #define SSL_MAX_DIGEST 4 |
| 210 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 211 | /* ssl_cipher_get_evp_aead sets |*out_aead| to point to the correct EVP_AEAD |
| 212 | * object for |cipher| protocol version |version|. It sets |*out_mac_secret_len| |
| 213 | * and |*out_fixed_iv_len| to the MAC key length and fixed IV length, |
| 214 | * respectively. The MAC key length is zero except for legacy block and stream |
| 215 | * ciphers. It returns 1 on success and 0 on error. */ |
| 216 | int ssl_cipher_get_evp_aead(const EVP_AEAD **out_aead, |
| 217 | size_t *out_mac_secret_len, |
| 218 | size_t *out_fixed_iv_len, |
| 219 | const SSL_CIPHER *cipher, uint16_t version); |
| 220 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 221 | /* ssl_get_handshake_digest returns the |EVP_MD| corresponding to |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 222 | * |algorithm_prf| and the |version|. */ |
| 223 | const EVP_MD *ssl_get_handshake_digest(uint32_t algorithm_prf, |
| 224 | uint16_t version); |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 225 | |
| 226 | /* ssl_create_cipher_list evaluates |rule_str| according to the ciphers in |
| 227 | * |ssl_method|. It sets |*out_cipher_list| to a newly-allocated |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 228 | * |ssl_cipher_preference_list_st| containing the result. It returns 1 on |
| 229 | * success and 0 on failure. If |strict| is true, nonsense will be rejected. If |
| 230 | * false, nonsense will be silently ignored. An empty result is considered an |
| 231 | * error regardless of |strict|. */ |
| 232 | int ssl_create_cipher_list( |
| 233 | const SSL_PROTOCOL_METHOD *ssl_method, |
| 234 | struct ssl_cipher_preference_list_st **out_cipher_list, |
| 235 | const char *rule_str, int strict); |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 236 | |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 237 | /* ssl_cipher_get_value returns the cipher suite id of |cipher|. */ |
| 238 | uint16_t ssl_cipher_get_value(const SSL_CIPHER *cipher); |
| 239 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 240 | /* ssl_cipher_auth_mask_for_key returns the mask of cipher |algorithm_auth| |
| 241 | * values suitable for use with |key| in TLS 1.2 and below. */ |
| 242 | uint32_t ssl_cipher_auth_mask_for_key(const EVP_PKEY *key); |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 243 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 244 | /* ssl_cipher_uses_certificate_auth returns one if |cipher| authenticates the |
| 245 | * server and, optionally, the client with a certificate. Otherwise it returns |
| 246 | * zero. */ |
| 247 | int ssl_cipher_uses_certificate_auth(const SSL_CIPHER *cipher); |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 248 | |
| 249 | /* ssl_cipher_requires_server_key_exchange returns 1 if |cipher| requires a |
| 250 | * ServerKeyExchange message. Otherwise it returns 0. |
| 251 | * |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 252 | * This function may return zero while still allowing |cipher| an optional |
| 253 | * ServerKeyExchange. This is the case for plain PSK ciphers. */ |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 254 | int ssl_cipher_requires_server_key_exchange(const SSL_CIPHER *cipher); |
| 255 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 256 | /* ssl_cipher_get_record_split_len, for TLS 1.0 CBC mode ciphers, returns the |
| 257 | * length of an encrypted 1-byte record, for use in record-splitting. Otherwise |
| 258 | * it returns zero. */ |
| 259 | size_t ssl_cipher_get_record_split_len(const SSL_CIPHER *cipher); |
| 260 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 261 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 262 | /* Transcript layer. */ |
| 263 | |
| 264 | /* SSL_TRANSCRIPT maintains the handshake transcript as a combination of a |
| 265 | * buffer and running hash. */ |
| 266 | typedef struct ssl_transcript_st { |
| 267 | /* buffer, if non-NULL, contains the handshake transcript. */ |
| 268 | BUF_MEM *buffer; |
| 269 | /* hash, if initialized with an |EVP_MD|, maintains the handshake hash. For |
| 270 | * TLS 1.1 and below, it is the SHA-1 half. */ |
| 271 | EVP_MD_CTX hash; |
| 272 | /* md5, if initialized with an |EVP_MD|, maintains the MD5 half of the |
| 273 | * handshake hash for TLS 1.1 and below. */ |
| 274 | EVP_MD_CTX md5; |
| 275 | } SSL_TRANSCRIPT; |
| 276 | |
| 277 | /* SSL_TRANSCRIPT_init initializes the handshake transcript. If called on an |
| 278 | * existing transcript, it resets the transcript and hash. It returns one on |
| 279 | * success and zero on failure. */ |
| 280 | int SSL_TRANSCRIPT_init(SSL_TRANSCRIPT *transcript); |
| 281 | |
| 282 | /* SSL_TRANSCRIPT_init_hash initializes the handshake hash based on the PRF and |
| 283 | * contents of the handshake transcript. Subsequent calls to |
| 284 | * |SSL_TRANSCRIPT_update| will update the rolling hash. It returns one on |
| 285 | * success and zero on failure. It is an error to call this function after the |
| 286 | * handshake buffer is released. */ |
| 287 | int SSL_TRANSCRIPT_init_hash(SSL_TRANSCRIPT *transcript, uint16_t version, |
| 288 | int algorithm_prf); |
| 289 | |
| 290 | /* SSL_TRANSCRIPT_cleanup cleans up the hash and transcript. */ |
| 291 | void SSL_TRANSCRIPT_cleanup(SSL_TRANSCRIPT *transcript); |
| 292 | |
| 293 | /* SSL_TRANSCRIPT_free_buffer releases the handshake buffer. Subsequent calls to |
| 294 | * |SSL_TRANSCRIPT_update| will not update the handshake buffer. */ |
| 295 | void SSL_TRANSCRIPT_free_buffer(SSL_TRANSCRIPT *transcript); |
| 296 | |
| 297 | /* SSL_TRANSCRIPT_digest_len returns the length of the PRF hash. */ |
| 298 | size_t SSL_TRANSCRIPT_digest_len(const SSL_TRANSCRIPT *transcript); |
| 299 | |
| 300 | /* SSL_TRANSCRIPT_md returns the PRF hash. For TLS 1.1 and below, this is |
| 301 | * |EVP_md5_sha1|. */ |
| 302 | const EVP_MD *SSL_TRANSCRIPT_md(const SSL_TRANSCRIPT *transcript); |
| 303 | |
| 304 | /* SSL_TRANSCRIPT_update adds |in| to the handshake buffer and handshake hash, |
| 305 | * whichever is enabled. It returns one on success and zero on failure. */ |
| 306 | int SSL_TRANSCRIPT_update(SSL_TRANSCRIPT *transcript, const uint8_t *in, |
| 307 | size_t in_len); |
| 308 | |
| 309 | /* SSL_TRANSCRIPT_get_hash writes the handshake hash to |out| which must have |
| 310 | * room for at least |SSL_TRANSCRIPT_digest_len| bytes. On success, it returns |
| 311 | * one and sets |*out_len| to the number of bytes written. Otherwise, it returns |
| 312 | * zero. */ |
| 313 | int SSL_TRANSCRIPT_get_hash(const SSL_TRANSCRIPT *transcript, uint8_t *out, |
| 314 | size_t *out_len); |
| 315 | |
| 316 | /* SSL_TRANSCRIPT_ssl3_cert_verify_hash writes the SSL 3.0 CertificateVerify |
| 317 | * hash into the bytes pointed to by |out| and writes the number of bytes to |
| 318 | * |*out_len|. |out| must have room for |EVP_MAX_MD_SIZE| bytes. It returns one |
| 319 | * on success and zero on failure. */ |
| 320 | int SSL_TRANSCRIPT_ssl3_cert_verify_hash(SSL_TRANSCRIPT *transcript, |
| 321 | uint8_t *out, size_t *out_len, |
| 322 | const SSL_SESSION *session, |
| 323 | int signature_algorithm); |
| 324 | |
| 325 | /* SSL_TRANSCRIPT_finish_mac computes the MAC for the Finished message into the |
| 326 | * bytes pointed by |out| and writes the number of bytes to |*out_len|. |out| |
| 327 | * must have room for |EVP_MAX_MD_SIZE| bytes. It returns one on success and |
| 328 | * zero on failure. */ |
| 329 | int SSL_TRANSCRIPT_finish_mac(SSL_TRANSCRIPT *transcript, uint8_t *out, |
| 330 | size_t *out_len, const SSL_SESSION *session, |
| 331 | int from_server, uint16_t version); |
| 332 | |
| 333 | /* tls1_prf computes the PRF function for |ssl|. It writes |out_len| bytes to |
| 334 | * |out|, using |secret| as the secret and |label| as the label. |seed1| and |
| 335 | * |seed2| are concatenated to form the seed parameter. It returns one on |
| 336 | * success and zero on failure. */ |
| 337 | int tls1_prf(const EVP_MD *digest, uint8_t *out, size_t out_len, |
| 338 | const uint8_t *secret, size_t secret_len, const char *label, |
| 339 | size_t label_len, const uint8_t *seed1, size_t seed1_len, |
| 340 | const uint8_t *seed2, size_t seed2_len); |
| 341 | |
| 342 | |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 343 | /* Encryption layer. */ |
| 344 | |
| 345 | /* SSL_AEAD_CTX contains information about an AEAD that is being used to encrypt |
| 346 | * an SSL connection. */ |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 347 | typedef struct ssl_aead_ctx_st { |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 348 | const SSL_CIPHER *cipher; |
| 349 | EVP_AEAD_CTX ctx; |
| 350 | /* fixed_nonce contains any bytes of the nonce that are fixed for all |
| 351 | * records. */ |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 352 | uint8_t fixed_nonce[12]; |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 353 | uint8_t fixed_nonce_len, variable_nonce_len; |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 354 | /* version is the protocol version that should be used with this AEAD. */ |
| 355 | uint16_t version; |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 356 | /* variable_nonce_included_in_record is non-zero if the variable nonce |
| 357 | * for a record is included as a prefix before the ciphertext. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 358 | unsigned variable_nonce_included_in_record : 1; |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 359 | /* random_variable_nonce is non-zero if the variable nonce is |
| 360 | * randomly generated, rather than derived from the sequence |
| 361 | * number. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 362 | unsigned random_variable_nonce : 1; |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 363 | /* omit_length_in_ad is non-zero if the length should be omitted in the |
| 364 | * AEAD's ad parameter. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 365 | unsigned omit_length_in_ad : 1; |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 366 | /* omit_version_in_ad is non-zero if the version should be omitted |
| 367 | * in the AEAD's ad parameter. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 368 | unsigned omit_version_in_ad : 1; |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 369 | /* omit_ad is non-zero if the AEAD's ad parameter should be omitted. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 370 | unsigned omit_ad : 1; |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 371 | /* xor_fixed_nonce is non-zero if the fixed nonce should be XOR'd into the |
| 372 | * variable nonce rather than prepended. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 373 | unsigned xor_fixed_nonce : 1; |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 374 | } SSL_AEAD_CTX; |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 375 | |
| 376 | /* SSL_AEAD_CTX_new creates a newly-allocated |SSL_AEAD_CTX| using the supplied |
| 377 | * key material. It returns NULL on error. Only one of |SSL_AEAD_CTX_open| or |
| 378 | * |SSL_AEAD_CTX_seal| may be used with the resulting object, depending on |
| 379 | * |direction|. |version| is the normalized protocol version, so DTLS 1.0 is |
| 380 | * represented as 0x0301, not 0xffef. */ |
| 381 | SSL_AEAD_CTX *SSL_AEAD_CTX_new(enum evp_aead_direction_t direction, |
| 382 | uint16_t version, const SSL_CIPHER *cipher, |
| 383 | const uint8_t *enc_key, size_t enc_key_len, |
| 384 | const uint8_t *mac_key, size_t mac_key_len, |
| 385 | const uint8_t *fixed_iv, size_t fixed_iv_len); |
| 386 | |
| 387 | /* SSL_AEAD_CTX_free frees |ctx|. */ |
| 388 | void SSL_AEAD_CTX_free(SSL_AEAD_CTX *ctx); |
| 389 | |
| 390 | /* SSL_AEAD_CTX_explicit_nonce_len returns the length of the explicit nonce for |
| 391 | * |ctx|, if any. |ctx| may be NULL to denote the null cipher. */ |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 392 | size_t SSL_AEAD_CTX_explicit_nonce_len(const SSL_AEAD_CTX *ctx); |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 393 | |
| 394 | /* SSL_AEAD_CTX_max_overhead returns the maximum overhead of calling |
| 395 | * |SSL_AEAD_CTX_seal|. |ctx| may be NULL to denote the null cipher. */ |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 396 | size_t SSL_AEAD_CTX_max_overhead(const SSL_AEAD_CTX *ctx); |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 397 | |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 398 | /* SSL_AEAD_CTX_open authenticates and decrypts |in_len| bytes from |in| |
| 399 | * in-place. On success, it sets |*out| to the plaintext in |in| and returns |
| 400 | * one. Otherwise, it returns zero. |ctx| may be NULL to denote the null cipher. |
| 401 | * The output will always be |explicit_nonce_len| bytes ahead of |in|. */ |
| 402 | int SSL_AEAD_CTX_open(SSL_AEAD_CTX *ctx, CBS *out, uint8_t type, |
| 403 | uint16_t wire_version, const uint8_t seqnum[8], |
| 404 | uint8_t *in, size_t in_len); |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 405 | |
| 406 | /* SSL_AEAD_CTX_seal encrypts and authenticates |in_len| bytes from |in| and |
| 407 | * writes the result to |out|. It returns one on success and zero on |
| 408 | * error. |ctx| may be NULL to denote the null cipher. |
| 409 | * |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 410 | * If |in| and |out| alias then |out| + |explicit_nonce_len| must be == |in|. */ |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 411 | int SSL_AEAD_CTX_seal(SSL_AEAD_CTX *ctx, uint8_t *out, size_t *out_len, |
| 412 | size_t max_out, uint8_t type, uint16_t wire_version, |
| 413 | const uint8_t seqnum[8], const uint8_t *in, |
| 414 | size_t in_len); |
| 415 | |
| 416 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 417 | /* DTLS replay bitmap. */ |
| 418 | |
| 419 | /* DTLS1_BITMAP maintains a sliding window of 64 sequence numbers to detect |
| 420 | * replayed packets. It should be initialized by zeroing every field. */ |
| 421 | typedef struct dtls1_bitmap_st { |
| 422 | /* map is a bit mask of the last 64 sequence numbers. Bit |
| 423 | * |1<<i| corresponds to |max_seq_num - i|. */ |
| 424 | uint64_t map; |
| 425 | /* max_seq_num is the largest sequence number seen so far as a 64-bit |
| 426 | * integer. */ |
| 427 | uint64_t max_seq_num; |
| 428 | } DTLS1_BITMAP; |
| 429 | |
| 430 | |
| 431 | /* Record layer. */ |
| 432 | |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 433 | /* ssl_record_sequence_update increments the sequence number in |seq|. It |
| 434 | * returns one on success and zero on wraparound. */ |
| 435 | int ssl_record_sequence_update(uint8_t *seq, size_t seq_len); |
| 436 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 437 | /* ssl_record_prefix_len returns the length of the prefix before the ciphertext |
| 438 | * of a record for |ssl|. |
| 439 | * |
| 440 | * TODO(davidben): Expose this as part of public API once the high-level |
| 441 | * buffer-free APIs are available. */ |
| 442 | size_t ssl_record_prefix_len(const SSL *ssl); |
| 443 | |
| 444 | enum ssl_open_record_t { |
| 445 | ssl_open_record_success, |
| 446 | ssl_open_record_discard, |
| 447 | ssl_open_record_partial, |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 448 | ssl_open_record_close_notify, |
| 449 | ssl_open_record_fatal_alert, |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 450 | ssl_open_record_error, |
| 451 | }; |
| 452 | |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 453 | /* tls_open_record decrypts a record from |in| in-place. |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 454 | * |
| 455 | * If the input did not contain a complete record, it returns |
| 456 | * |ssl_open_record_partial|. It sets |*out_consumed| to the total number of |
| 457 | * bytes necessary. It is guaranteed that a successful call to |tls_open_record| |
| 458 | * will consume at least that many bytes. |
| 459 | * |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 460 | * Otherwise, it sets |*out_consumed| to the number of bytes of input |
| 461 | * consumed. Note that input may be consumed on all return codes if a record was |
| 462 | * decrypted. |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 463 | * |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 464 | * On success, it returns |ssl_open_record_success|. It sets |*out_type| to the |
| 465 | * record type and |*out| to the record body in |in|. Note that |*out| may be |
| 466 | * empty. |
| 467 | * |
| 468 | * If a record was successfully processed but should be discarded, it returns |
| 469 | * |ssl_open_record_discard|. |
| 470 | * |
| 471 | * If a record was successfully processed but is a close_notify or fatal alert, |
| 472 | * it returns |ssl_open_record_close_notify| or |ssl_open_record_fatal_alert|. |
| 473 | * |
| 474 | * On failure, it returns |ssl_open_record_error| and sets |*out_alert| to an |
| 475 | * alert to emit. */ |
| 476 | enum ssl_open_record_t tls_open_record(SSL *ssl, uint8_t *out_type, CBS *out, |
| 477 | size_t *out_consumed, uint8_t *out_alert, |
| 478 | uint8_t *in, size_t in_len); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 479 | |
| 480 | /* dtls_open_record implements |tls_open_record| for DTLS. It never returns |
| 481 | * |ssl_open_record_partial| but otherwise behaves analogously. */ |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 482 | enum ssl_open_record_t dtls_open_record(SSL *ssl, uint8_t *out_type, CBS *out, |
| 483 | size_t *out_consumed, |
| 484 | uint8_t *out_alert, uint8_t *in, |
| 485 | size_t in_len); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 486 | |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 487 | /* ssl_seal_align_prefix_len returns the length of the prefix before the start |
| 488 | * of the bulk of the ciphertext when sealing a record with |ssl|. Callers may |
| 489 | * use this to align buffers. |
| 490 | * |
| 491 | * Note when TLS 1.0 CBC record-splitting is enabled, this includes the one byte |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 492 | * record and is the offset into second record's ciphertext. Thus sealing a |
| 493 | * small record may result in a smaller output than this value. |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 494 | * |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 495 | * TODO(davidben): Is this alignment valuable? Record-splitting makes this a |
| 496 | * mess. */ |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 497 | size_t ssl_seal_align_prefix_len(const SSL *ssl); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 498 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 499 | /* tls_seal_record seals a new record of type |type| and body |in| and writes it |
| 500 | * to |out|. At most |max_out| bytes will be written. It returns one on success |
| 501 | * and zero on error. If enabled, |tls_seal_record| implements TLS 1.0 CBC 1/n-1 |
| 502 | * record splitting and may write two records concatenated. |
| 503 | * |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 504 | * For a large record, the bulk of the ciphertext will begin |
| 505 | * |ssl_seal_align_prefix_len| bytes into out. Aligning |out| appropriately may |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 506 | * improve performance. It writes at most |in_len| + |SSL_max_seal_overhead| |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 507 | * bytes to |out|. |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 508 | * |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 509 | * |in| and |out| may not alias. */ |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 510 | int tls_seal_record(SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 511 | uint8_t type, const uint8_t *in, size_t in_len); |
| 512 | |
| 513 | enum dtls1_use_epoch_t { |
| 514 | dtls1_use_previous_epoch, |
| 515 | dtls1_use_current_epoch, |
| 516 | }; |
| 517 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 518 | /* dtls_max_seal_overhead returns the maximum overhead, in bytes, of sealing a |
| 519 | * record. */ |
| 520 | size_t dtls_max_seal_overhead(const SSL *ssl, enum dtls1_use_epoch_t use_epoch); |
| 521 | |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 522 | /* dtls_seal_prefix_len returns the number of bytes of prefix to reserve in |
| 523 | * front of the plaintext when sealing a record in-place. */ |
| 524 | size_t dtls_seal_prefix_len(const SSL *ssl, enum dtls1_use_epoch_t use_epoch); |
| 525 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 526 | /* dtls_seal_record implements |tls_seal_record| for DTLS. |use_epoch| selects |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 527 | * which epoch's cipher state to use. Unlike |tls_seal_record|, |in| and |out| |
| 528 | * may alias but, if they do, |in| must be exactly |dtls_seal_prefix_len| bytes |
| 529 | * ahead of |out|. */ |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 530 | int dtls_seal_record(SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 531 | uint8_t type, const uint8_t *in, size_t in_len, |
| 532 | enum dtls1_use_epoch_t use_epoch); |
| 533 | |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 534 | /* ssl_process_alert processes |in| as an alert and updates |ssl|'s shutdown |
| 535 | * state. It returns one of |ssl_open_record_discard|, |ssl_open_record_error|, |
| 536 | * |ssl_open_record_close_notify|, or |ssl_open_record_fatal_alert| as |
| 537 | * appropriate. */ |
| 538 | enum ssl_open_record_t ssl_process_alert(SSL *ssl, uint8_t *out_alert, |
| 539 | const uint8_t *in, size_t in_len); |
| 540 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 541 | |
| 542 | /* Private key operations. */ |
| 543 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 544 | typedef struct ssl_handshake_st SSL_HANDSHAKE; |
| 545 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 546 | /* ssl_has_private_key returns one if |ssl| has a private key |
| 547 | * configured and zero otherwise. */ |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 548 | int ssl_has_private_key(const SSL *ssl); |
| 549 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 550 | /* ssl_private_key_* call the corresponding function on the |
| 551 | * |SSL_PRIVATE_KEY_METHOD| for |ssl|, if configured. Otherwise, they implement |
| 552 | * the operation with |EVP_PKEY|. */ |
| 553 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 554 | enum ssl_private_key_result_t ssl_private_key_sign( |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 555 | SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 556 | uint16_t signature_algorithm, const uint8_t *in, size_t in_len); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 557 | |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 558 | enum ssl_private_key_result_t ssl_private_key_decrypt( |
| 559 | SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 560 | const uint8_t *in, size_t in_len); |
| 561 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 562 | enum ssl_private_key_result_t ssl_private_key_complete(SSL *ssl, uint8_t *out, |
| 563 | size_t *out_len, |
| 564 | size_t max_out); |
| 565 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 566 | /* ssl_private_key_supports_signature_algorithm returns one if |hs|'s private |
| 567 | * key supports |sigalg| and zero otherwise. */ |
| 568 | int ssl_private_key_supports_signature_algorithm(SSL_HANDSHAKE *hs, |
| 569 | uint16_t sigalg); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 570 | |
| 571 | /* ssl_public_key_verify verifies that the |signature| is valid for the public |
| 572 | * key |pkey| and input |in|, using the |signature_algorithm| specified. */ |
| 573 | int ssl_public_key_verify( |
| 574 | SSL *ssl, const uint8_t *signature, size_t signature_len, |
| 575 | uint16_t signature_algorithm, EVP_PKEY *pkey, |
| 576 | const uint8_t *in, size_t in_len); |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 577 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 578 | |
| 579 | /* Custom extensions */ |
| 580 | |
| 581 | /* ssl_custom_extension (a.k.a. SSL_CUSTOM_EXTENSION) is a structure that |
| 582 | * contains information about custom-extension callbacks. */ |
| 583 | struct ssl_custom_extension { |
| 584 | SSL_custom_ext_add_cb add_callback; |
| 585 | void *add_arg; |
| 586 | SSL_custom_ext_free_cb free_callback; |
| 587 | SSL_custom_ext_parse_cb parse_callback; |
| 588 | void *parse_arg; |
| 589 | uint16_t value; |
| 590 | }; |
| 591 | |
| 592 | void SSL_CUSTOM_EXTENSION_free(SSL_CUSTOM_EXTENSION *custom_extension); |
| 593 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 594 | int custom_ext_add_clienthello(SSL_HANDSHAKE *hs, CBB *extensions); |
| 595 | int custom_ext_parse_serverhello(SSL_HANDSHAKE *hs, int *out_alert, |
| 596 | uint16_t value, const CBS *extension); |
| 597 | int custom_ext_parse_clienthello(SSL_HANDSHAKE *hs, int *out_alert, |
| 598 | uint16_t value, const CBS *extension); |
| 599 | int custom_ext_add_serverhello(SSL_HANDSHAKE *hs, CBB *extensions); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 600 | |
| 601 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 602 | /* ECDH groups. */ |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 603 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 604 | typedef struct ssl_ecdh_ctx_st SSL_ECDH_CTX; |
| 605 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 606 | /* An SSL_ECDH_METHOD is an implementation of ECDH-like key exchanges for |
| 607 | * TLS. */ |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 608 | typedef struct ssl_ecdh_method_st { |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 609 | int nid; |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 610 | uint16_t group_id; |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 611 | const char name[8]; |
| 612 | |
| 613 | /* cleanup releases state in |ctx|. */ |
| 614 | void (*cleanup)(SSL_ECDH_CTX *ctx); |
| 615 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 616 | /* offer generates a keypair and writes the public value to |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 617 | * |out_public_key|. It returns one on success and zero on error. */ |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 618 | int (*offer)(SSL_ECDH_CTX *ctx, CBB *out_public_key); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 619 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 620 | /* accept performs a key exchange against the |peer_key| generated by |offer|. |
| 621 | * On success, it returns one, writes the public value to |out_public_key|, |
| 622 | * and sets |*out_secret| and |*out_secret_len| to a newly-allocated buffer |
| 623 | * containing the shared secret. The caller must release this buffer with |
| 624 | * |OPENSSL_free|. On failure, it returns zero and sets |*out_alert| to an |
| 625 | * alert to send to the peer. */ |
| 626 | int (*accept)(SSL_ECDH_CTX *ctx, CBB *out_public_key, uint8_t **out_secret, |
| 627 | size_t *out_secret_len, uint8_t *out_alert, |
| 628 | const uint8_t *peer_key, size_t peer_key_len); |
| 629 | |
| 630 | /* finish performs a key exchange against the |peer_key| generated by |
| 631 | * |accept|. On success, it returns one and sets |*out_secret| and |
| 632 | * |*out_secret_len| to a newly-allocated buffer containing the shared |
| 633 | * secret. The caller must release this buffer with |OPENSSL_free|. On |
| 634 | * failure, it returns zero and sets |*out_alert| to an alert to send to the |
| 635 | * peer. */ |
| 636 | int (*finish)(SSL_ECDH_CTX *ctx, uint8_t **out_secret, size_t *out_secret_len, |
| 637 | uint8_t *out_alert, const uint8_t *peer_key, |
| 638 | size_t peer_key_len); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 639 | } SSL_ECDH_METHOD; |
| 640 | |
| 641 | struct ssl_ecdh_ctx_st { |
| 642 | const SSL_ECDH_METHOD *method; |
| 643 | void *data; |
| 644 | }; |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 645 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 646 | /* ssl_nid_to_group_id looks up the group corresponding to |nid|. On success, it |
| 647 | * sets |*out_group_id| to the group ID and returns one. Otherwise, it returns |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 648 | * zero. */ |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 649 | int ssl_nid_to_group_id(uint16_t *out_group_id, int nid); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 650 | |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 651 | /* ssl_name_to_group_id looks up the group corresponding to the |name| string |
| 652 | * of length |len|. On success, it sets |*out_group_id| to the group ID and |
| 653 | * returns one. Otherwise, it returns zero. */ |
| 654 | int ssl_name_to_group_id(uint16_t *out_group_id, const char *name, size_t len); |
| 655 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 656 | /* SSL_ECDH_CTX_init sets up |ctx| for use with curve |group_id|. It returns one |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 657 | * on success and zero on error. */ |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 658 | int SSL_ECDH_CTX_init(SSL_ECDH_CTX *ctx, uint16_t group_id); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 659 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 660 | /* SSL_ECDH_CTX_cleanup releases memory associated with |ctx|. It is legal to |
| 661 | * call it in the zero state. */ |
| 662 | void SSL_ECDH_CTX_cleanup(SSL_ECDH_CTX *ctx); |
| 663 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 664 | /* SSL_ECDH_CTX_get_id returns the group ID for |ctx|. */ |
| 665 | uint16_t SSL_ECDH_CTX_get_id(const SSL_ECDH_CTX *ctx); |
| 666 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 667 | /* SSL_ECDH_CTX_get_key calls the |get_key| method of |SSL_ECDH_METHOD|. */ |
| 668 | int SSL_ECDH_CTX_get_key(SSL_ECDH_CTX *ctx, CBS *cbs, CBS *out); |
| 669 | |
| 670 | /* SSL_ECDH_CTX_add_key calls the |add_key| method of |SSL_ECDH_METHOD|. */ |
| 671 | int SSL_ECDH_CTX_add_key(SSL_ECDH_CTX *ctx, CBB *cbb, CBB *out_contents); |
| 672 | |
| 673 | /* SSL_ECDH_CTX_offer calls the |offer| method of |SSL_ECDH_METHOD|. */ |
| 674 | int SSL_ECDH_CTX_offer(SSL_ECDH_CTX *ctx, CBB *out_public_key); |
| 675 | |
| 676 | /* SSL_ECDH_CTX_accept calls the |accept| method of |SSL_ECDH_METHOD|. */ |
| 677 | int SSL_ECDH_CTX_accept(SSL_ECDH_CTX *ctx, CBB *out_public_key, |
| 678 | uint8_t **out_secret, size_t *out_secret_len, |
| 679 | uint8_t *out_alert, const uint8_t *peer_key, |
| 680 | size_t peer_key_len); |
| 681 | |
| 682 | /* SSL_ECDH_CTX_finish the |finish| method of |SSL_ECDH_METHOD|. */ |
| 683 | int SSL_ECDH_CTX_finish(SSL_ECDH_CTX *ctx, uint8_t **out_secret, |
| 684 | size_t *out_secret_len, uint8_t *out_alert, |
| 685 | const uint8_t *peer_key, size_t peer_key_len); |
| 686 | |
| 687 | /* Handshake messages. */ |
| 688 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 689 | /* SSL_MAX_HANDSHAKE_FLIGHT is the number of messages, including |
| 690 | * ChangeCipherSpec, in the longest handshake flight. Currently this is the |
| 691 | * client's second leg in a full handshake when client certificates, NPN, and |
| 692 | * Channel ID, are all enabled. */ |
| 693 | #define SSL_MAX_HANDSHAKE_FLIGHT 7 |
| 694 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 695 | /* ssl_max_handshake_message_len returns the maximum number of bytes permitted |
| 696 | * in a handshake message for |ssl|. */ |
| 697 | size_t ssl_max_handshake_message_len(const SSL *ssl); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 698 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 699 | /* dtls_clear_incoming_messages releases all buffered incoming messages. */ |
| 700 | void dtls_clear_incoming_messages(SSL *ssl); |
| 701 | |
| 702 | /* dtls_has_incoming_messages returns one if there are buffered incoming |
| 703 | * messages ahead of the current message and zero otherwise. */ |
| 704 | int dtls_has_incoming_messages(const SSL *ssl); |
| 705 | |
| 706 | typedef struct dtls_outgoing_message_st { |
| 707 | uint8_t *data; |
| 708 | uint32_t len; |
| 709 | uint16_t epoch; |
| 710 | char is_ccs; |
| 711 | } DTLS_OUTGOING_MESSAGE; |
| 712 | |
| 713 | /* dtls_clear_outgoing_messages releases all buffered outgoing messages. */ |
| 714 | void dtls_clear_outgoing_messages(SSL *ssl); |
| 715 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 716 | |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 717 | /* Callbacks. */ |
| 718 | |
| 719 | /* ssl_do_info_callback calls |ssl|'s info callback, if set. */ |
| 720 | void ssl_do_info_callback(const SSL *ssl, int type, int value); |
| 721 | |
| 722 | /* ssl_do_msg_callback calls |ssl|'s message callback, if set. */ |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 723 | void ssl_do_msg_callback(SSL *ssl, int is_write, int content_type, |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 724 | const void *buf, size_t len); |
| 725 | |
| 726 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 727 | /* Transport buffers. */ |
| 728 | |
| 729 | /* ssl_read_buffer returns a pointer to contents of the read buffer. */ |
| 730 | uint8_t *ssl_read_buffer(SSL *ssl); |
| 731 | |
| 732 | /* ssl_read_buffer_len returns the length of the read buffer. */ |
| 733 | size_t ssl_read_buffer_len(const SSL *ssl); |
| 734 | |
| 735 | /* ssl_read_buffer_extend_to extends the read buffer to the desired length. For |
| 736 | * TLS, it reads to the end of the buffer until the buffer is |len| bytes |
| 737 | * long. For DTLS, it reads a new packet and ignores |len|. It returns one on |
| 738 | * success, zero on EOF, and a negative number on error. |
| 739 | * |
| 740 | * It is an error to call |ssl_read_buffer_extend_to| in DTLS when the buffer is |
| 741 | * non-empty. */ |
| 742 | int ssl_read_buffer_extend_to(SSL *ssl, size_t len); |
| 743 | |
| 744 | /* ssl_read_buffer_consume consumes |len| bytes from the read buffer. It |
| 745 | * advances the data pointer and decrements the length. The memory consumed will |
| 746 | * remain valid until the next call to |ssl_read_buffer_extend| or it is |
| 747 | * discarded with |ssl_read_buffer_discard|. */ |
| 748 | void ssl_read_buffer_consume(SSL *ssl, size_t len); |
| 749 | |
| 750 | /* ssl_read_buffer_discard discards the consumed bytes from the read buffer. If |
| 751 | * the buffer is now empty, it releases memory used by it. */ |
| 752 | void ssl_read_buffer_discard(SSL *ssl); |
| 753 | |
| 754 | /* ssl_read_buffer_clear releases all memory associated with the read buffer and |
| 755 | * zero-initializes it. */ |
| 756 | void ssl_read_buffer_clear(SSL *ssl); |
| 757 | |
| 758 | /* ssl_write_buffer_is_pending returns one if the write buffer has pending data |
| 759 | * and zero if is empty. */ |
| 760 | int ssl_write_buffer_is_pending(const SSL *ssl); |
| 761 | |
| 762 | /* ssl_write_buffer_init initializes the write buffer. On success, it sets |
| 763 | * |*out_ptr| to the start of the write buffer with space for up to |max_len| |
| 764 | * bytes. It returns one on success and zero on failure. Call |
| 765 | * |ssl_write_buffer_set_len| to complete initialization. */ |
| 766 | int ssl_write_buffer_init(SSL *ssl, uint8_t **out_ptr, size_t max_len); |
| 767 | |
| 768 | /* ssl_write_buffer_set_len is called after |ssl_write_buffer_init| to complete |
| 769 | * initialization after |len| bytes are written to the buffer. */ |
| 770 | void ssl_write_buffer_set_len(SSL *ssl, size_t len); |
| 771 | |
| 772 | /* ssl_write_buffer_flush flushes the write buffer to the transport. It returns |
| 773 | * one on success and <= 0 on error. For DTLS, whether or not the write |
| 774 | * succeeds, the write buffer will be cleared. */ |
| 775 | int ssl_write_buffer_flush(SSL *ssl); |
| 776 | |
| 777 | /* ssl_write_buffer_clear releases all memory associated with the write buffer |
| 778 | * and zero-initializes it. */ |
| 779 | void ssl_write_buffer_clear(SSL *ssl); |
| 780 | |
| 781 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 782 | /* Certificate functions. */ |
| 783 | |
| 784 | /* ssl_has_certificate returns one if a certificate and private key are |
| 785 | * configured and zero otherwise. */ |
| 786 | int ssl_has_certificate(const SSL *ssl); |
| 787 | |
| 788 | /* ssl_parse_cert_chain parses a certificate list from |cbs| in the format used |
| 789 | * by a TLS Certificate message. On success, it returns a newly-allocated |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 790 | * |CRYPTO_BUFFER| list and advances |cbs|. Otherwise, it returns NULL and sets |
| 791 | * |*out_alert| to an alert to send to the peer. |
| 792 | * |
| 793 | * If the list is non-empty then |*out_pubkey| will be set to a freshly |
| 794 | * allocated public-key from the leaf certificate. |
| 795 | * |
| 796 | * If the list is non-empty and |out_leaf_sha256| is non-NULL, it writes the |
| 797 | * SHA-256 hash of the leaf to |out_leaf_sha256|. */ |
| 798 | STACK_OF(CRYPTO_BUFFER) *ssl_parse_cert_chain(uint8_t *out_alert, |
| 799 | EVP_PKEY **out_pubkey, |
| 800 | uint8_t *out_leaf_sha256, |
| 801 | CBS *cbs, |
| 802 | CRYPTO_BUFFER_POOL *pool); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 803 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 804 | /* ssl_add_cert_chain adds |ssl|'s certificate chain to |cbb| in the format used |
| 805 | * by a TLS Certificate message. If there is no certificate chain, it emits an |
| 806 | * empty certificate list. It returns one on success and zero on error. */ |
| 807 | int ssl_add_cert_chain(SSL *ssl, CBB *cbb); |
| 808 | |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 809 | /* ssl_cert_check_digital_signature_key_usage parses the DER-encoded, X.509 |
| 810 | * certificate in |in| and returns one if doesn't specify a key usage or, if it |
| 811 | * does, if it includes digitalSignature. Otherwise it pushes to the error |
| 812 | * queue and returns zero. */ |
| 813 | int ssl_cert_check_digital_signature_key_usage(const CBS *in); |
| 814 | |
| 815 | /* ssl_cert_parse_pubkey extracts the public key from the DER-encoded, X.509 |
| 816 | * certificate in |in|. It returns an allocated |EVP_PKEY| or else returns NULL |
| 817 | * and pushes to the error queue. */ |
| 818 | EVP_PKEY *ssl_cert_parse_pubkey(const CBS *in); |
| 819 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 820 | /* ssl_parse_client_CA_list parses a CA list from |cbs| in the format used by a |
| 821 | * TLS CertificateRequest message. On success, it returns a newly-allocated |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 822 | * |CRYPTO_BUFFER| list and advances |cbs|. Otherwise, it returns NULL and sets |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 823 | * |*out_alert| to an alert to send to the peer. */ |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 824 | STACK_OF(CRYPTO_BUFFER) * |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 825 | ssl_parse_client_CA_list(SSL *ssl, uint8_t *out_alert, CBS *cbs); |
| 826 | |
| 827 | /* ssl_add_client_CA_list adds the configured CA list to |cbb| in the format |
| 828 | * used by a TLS CertificateRequest message. It returns one on success and zero |
| 829 | * on error. */ |
| 830 | int ssl_add_client_CA_list(SSL *ssl, CBB *cbb); |
| 831 | |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 832 | /* ssl_check_leaf_certificate returns one if |pkey| and |leaf| are suitable as |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 833 | * a server's leaf certificate for |hs|. Otherwise, it returns zero and pushes |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 834 | * an error on the error queue. */ |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 835 | int ssl_check_leaf_certificate(SSL_HANDSHAKE *hs, EVP_PKEY *pkey, |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 836 | const CRYPTO_BUFFER *leaf); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 837 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 838 | /* ssl_on_certificate_selected is called once the certificate has been selected. |
| 839 | * It finalizes the certificate and initializes |hs->local_pubkey|. It returns |
| 840 | * one on success and zero on error. */ |
| 841 | int ssl_on_certificate_selected(SSL_HANDSHAKE *hs); |
| 842 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 843 | |
| 844 | /* TLS 1.3 key derivation. */ |
| 845 | |
| 846 | /* tls13_init_key_schedule initializes the handshake hash and key derivation |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 847 | * state. The cipher suite and PRF hash must have been selected at this point. |
| 848 | * It returns one on success and zero on error. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 849 | int tls13_init_key_schedule(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 850 | |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 851 | /* tls13_init_early_key_schedule initializes the handshake hash and key |
| 852 | * derivation state from the resumption secret to derive the early secrets. It |
| 853 | * returns one on success and zero on error. */ |
| 854 | int tls13_init_early_key_schedule(SSL_HANDSHAKE *hs); |
| 855 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 856 | /* tls13_advance_key_schedule incorporates |in| into the key schedule with |
| 857 | * HKDF-Extract. It returns one on success and zero on error. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 858 | int tls13_advance_key_schedule(SSL_HANDSHAKE *hs, const uint8_t *in, |
| 859 | size_t len); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 860 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 861 | /* tls13_set_traffic_key sets the read or write traffic keys to |
| 862 | * |traffic_secret|. It returns one on success and zero on error. */ |
| 863 | int tls13_set_traffic_key(SSL *ssl, enum evp_aead_direction_t direction, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 864 | const uint8_t *traffic_secret, |
| 865 | size_t traffic_secret_len); |
| 866 | |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 867 | /* tls13_derive_early_secrets derives the early traffic secret. It returns one |
| 868 | * on success and zero on error. */ |
| 869 | int tls13_derive_early_secrets(SSL_HANDSHAKE *hs); |
| 870 | |
Robert Sloan | 69939df | 2017-01-09 10:53:07 -0800 | [diff] [blame] | 871 | /* tls13_derive_handshake_secrets derives the handshake traffic secret. It |
| 872 | * returns one on success and zero on error. */ |
| 873 | int tls13_derive_handshake_secrets(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 874 | |
| 875 | /* tls13_rotate_traffic_key derives the next read or write traffic secret. It |
| 876 | * returns one on success and zero on error. */ |
| 877 | int tls13_rotate_traffic_key(SSL *ssl, enum evp_aead_direction_t direction); |
| 878 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 879 | /* tls13_derive_application_secrets derives the initial application data traffic |
| 880 | * and exporter secrets based on the handshake transcripts and |master_secret|. |
| 881 | * It returns one on success and zero on error. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 882 | int tls13_derive_application_secrets(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 883 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 884 | /* tls13_derive_resumption_secret derives the |resumption_secret|. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 885 | int tls13_derive_resumption_secret(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 886 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 887 | /* tls13_export_keying_material provides an exporter interface to use the |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 888 | * |exporter_secret|. */ |
| 889 | int tls13_export_keying_material(SSL *ssl, uint8_t *out, size_t out_len, |
| 890 | const char *label, size_t label_len, |
| 891 | const uint8_t *context, size_t context_len, |
| 892 | int use_context); |
| 893 | |
| 894 | /* tls13_finished_mac calculates the MAC of the handshake transcript to verify |
| 895 | * the integrity of the Finished message, and stores the result in |out| and |
| 896 | * length in |out_len|. |is_server| is 1 if this is for the Server Finished and |
| 897 | * 0 for the Client Finished. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 898 | int tls13_finished_mac(SSL_HANDSHAKE *hs, uint8_t *out, |
| 899 | size_t *out_len, int is_server); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 900 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 901 | /* tls13_write_psk_binder calculates the PSK binder value and replaces the last |
| 902 | * bytes of |msg| with the resulting value. It returns 1 on success, and 0 on |
| 903 | * failure. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 904 | int tls13_write_psk_binder(SSL_HANDSHAKE *hs, uint8_t *msg, size_t len); |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 905 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 906 | /* tls13_verify_psk_binder verifies that the handshake transcript, truncated |
| 907 | * up to the binders has a valid signature using the value of |session|'s |
| 908 | * resumption secret. It returns 1 on success, and 0 on failure. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 909 | int tls13_verify_psk_binder(SSL_HANDSHAKE *hs, SSL_SESSION *session, |
| 910 | CBS *binders); |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 911 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 912 | |
| 913 | /* Handshake functions. */ |
| 914 | |
| 915 | enum ssl_hs_wait_t { |
| 916 | ssl_hs_error, |
| 917 | ssl_hs_ok, |
| 918 | ssl_hs_read_message, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 919 | ssl_hs_flush, |
| 920 | ssl_hs_flush_and_read_message, |
| 921 | ssl_hs_x509_lookup, |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 922 | ssl_hs_channel_id_lookup, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 923 | ssl_hs_private_key_operation, |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 924 | ssl_hs_pending_ticket, |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 925 | ssl_hs_read_end_of_early_data, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 926 | }; |
| 927 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 928 | struct ssl_handshake_st { |
| 929 | /* ssl is a non-owning pointer to the parent |SSL| object. */ |
| 930 | SSL *ssl; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 931 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 932 | /* do_tls13_handshake runs the TLS 1.3 handshake. On completion, it returns |
| 933 | * |ssl_hs_ok|. Otherwise, it returns a value corresponding to what operation |
| 934 | * is needed to progress. */ |
| 935 | enum ssl_hs_wait_t (*do_tls13_handshake)(SSL_HANDSHAKE *hs); |
| 936 | |
| 937 | /* wait contains the operation |do_tls13_handshake| is currently blocking on |
| 938 | * or |ssl_hs_ok| if none. */ |
| 939 | enum ssl_hs_wait_t wait; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 940 | |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 941 | /* state contains one of the SSL3_ST_* values. */ |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 942 | int state; |
| 943 | |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 944 | /* next_state is used when SSL_ST_FLUSH_DATA is entered */ |
| 945 | int next_state; |
| 946 | |
| 947 | /* tls13_state is the internal state for the TLS 1.3 handshake. Its values |
| 948 | * depend on |do_tls13_handshake| but the starting state is always zero. */ |
| 949 | int tls13_state; |
| 950 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 951 | size_t hash_len; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 952 | uint8_t secret[EVP_MAX_MD_SIZE]; |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 953 | uint8_t early_traffic_secret[EVP_MAX_MD_SIZE]; |
Robert Sloan | 69939df | 2017-01-09 10:53:07 -0800 | [diff] [blame] | 954 | uint8_t client_handshake_secret[EVP_MAX_MD_SIZE]; |
| 955 | uint8_t server_handshake_secret[EVP_MAX_MD_SIZE]; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 956 | uint8_t client_traffic_secret_0[EVP_MAX_MD_SIZE]; |
| 957 | uint8_t server_traffic_secret_0[EVP_MAX_MD_SIZE]; |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 958 | uint8_t expected_client_finished[EVP_MAX_MD_SIZE]; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 959 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 960 | union { |
| 961 | /* sent is a bitset where the bits correspond to elements of kExtensions |
| 962 | * in t1_lib.c. Each bit is set if that extension was sent in a |
| 963 | * ClientHello. It's not used by servers. */ |
| 964 | uint32_t sent; |
| 965 | /* received is a bitset, like |sent|, but is used by servers to record |
| 966 | * which extensions were received from a client. */ |
| 967 | uint32_t received; |
| 968 | } extensions; |
| 969 | |
| 970 | union { |
| 971 | /* sent is a bitset where the bits correspond to elements of |
| 972 | * |client_custom_extensions| in the |SSL_CTX|. Each bit is set if that |
| 973 | * extension was sent in a ClientHello. It's not used by servers. */ |
| 974 | uint16_t sent; |
| 975 | /* received is a bitset, like |sent|, but is used by servers to record |
| 976 | * which custom extensions were received from a client. The bits here |
| 977 | * correspond to |server_custom_extensions|. */ |
| 978 | uint16_t received; |
| 979 | } custom_extensions; |
| 980 | |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 981 | /* retry_group is the group ID selected by the server in HelloRetryRequest in |
| 982 | * TLS 1.3. */ |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 983 | uint16_t retry_group; |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 984 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 985 | /* ecdh_ctx is the current ECDH instance. */ |
| 986 | SSL_ECDH_CTX ecdh_ctx; |
| 987 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 988 | /* transcript is the current handshake transcript. */ |
| 989 | SSL_TRANSCRIPT transcript; |
| 990 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 991 | /* cookie is the value of the cookie received from the server, if any. */ |
| 992 | uint8_t *cookie; |
| 993 | size_t cookie_len; |
| 994 | |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 995 | /* key_share_bytes is the value of the previously sent KeyShare extension by |
| 996 | * the client in TLS 1.3. */ |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 997 | uint8_t *key_share_bytes; |
| 998 | size_t key_share_bytes_len; |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 999 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 1000 | /* ecdh_public_key, for servers, is the key share to be sent to the client in |
| 1001 | * TLS 1.3. */ |
| 1002 | uint8_t *ecdh_public_key; |
| 1003 | size_t ecdh_public_key_len; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1004 | |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1005 | /* peer_sigalgs are the signature algorithms that the peer supports. These are |
| 1006 | * taken from the contents of the signature algorithms extension for a server |
| 1007 | * or from the CertificateRequest for a client. */ |
| 1008 | uint16_t *peer_sigalgs; |
| 1009 | /* num_peer_sigalgs is the number of entries in |peer_sigalgs|. */ |
| 1010 | size_t num_peer_sigalgs; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1011 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1012 | /* peer_supported_group_list contains the supported group IDs advertised by |
| 1013 | * the peer. This is only set on the server's end. The server does not |
| 1014 | * advertise this extension to the client. */ |
| 1015 | uint16_t *peer_supported_group_list; |
| 1016 | size_t peer_supported_group_list_len; |
| 1017 | |
| 1018 | /* peer_key is the peer's ECDH key for a TLS 1.2 client. */ |
| 1019 | uint8_t *peer_key; |
| 1020 | size_t peer_key_len; |
| 1021 | |
| 1022 | /* server_params, in TLS 1.2, stores the ServerKeyExchange parameters to be |
| 1023 | * signed while the signature is being computed. */ |
| 1024 | uint8_t *server_params; |
| 1025 | size_t server_params_len; |
| 1026 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1027 | /* peer_psk_identity_hint, on the client, is the psk_identity_hint sent by the |
| 1028 | * server when using a TLS 1.2 PSK key exchange. */ |
| 1029 | char *peer_psk_identity_hint; |
| 1030 | |
| 1031 | /* ca_names, on the client, contains the list of CAs received in a |
| 1032 | * CertificateRequest message. */ |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1033 | STACK_OF(CRYPTO_BUFFER) *ca_names; |
| 1034 | |
| 1035 | /* cached_x509_ca_names contains a cache of parsed versions of the elements |
| 1036 | * of |ca_names|. */ |
| 1037 | STACK_OF(X509_NAME) *cached_x509_ca_names; |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1038 | |
| 1039 | /* certificate_types, on the client, contains the set of certificate types |
| 1040 | * received in a CertificateRequest message. */ |
| 1041 | uint8_t *certificate_types; |
| 1042 | size_t num_certificate_types; |
| 1043 | |
| 1044 | /* hostname, on the server, is the value of the SNI extension. */ |
| 1045 | char *hostname; |
| 1046 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 1047 | /* local_pubkey is the public key we are authenticating as. */ |
| 1048 | EVP_PKEY *local_pubkey; |
| 1049 | |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 1050 | /* peer_pubkey is the public key parsed from the peer's leaf certificate. */ |
| 1051 | EVP_PKEY *peer_pubkey; |
| 1052 | |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 1053 | /* new_session is the new mutable session being established by the current |
| 1054 | * handshake. It should not be cached. */ |
| 1055 | SSL_SESSION *new_session; |
| 1056 | |
| 1057 | /* new_cipher is the cipher being negotiated in this handshake. */ |
| 1058 | const SSL_CIPHER *new_cipher; |
| 1059 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1060 | /* key_block is the record-layer key block for TLS 1.2 and earlier. */ |
| 1061 | uint8_t *key_block; |
| 1062 | uint8_t key_block_len; |
| 1063 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1064 | /* scts_requested is one if the SCT extension is in the ClientHello. */ |
| 1065 | unsigned scts_requested:1; |
| 1066 | |
| 1067 | /* needs_psk_binder if the ClientHello has a placeholder PSK binder to be |
| 1068 | * filled in. */ |
| 1069 | unsigned needs_psk_binder:1; |
| 1070 | |
| 1071 | unsigned received_hello_retry_request:1; |
| 1072 | |
| 1073 | /* accept_psk_mode stores whether the client's PSK mode is compatible with our |
| 1074 | * preferences. */ |
| 1075 | unsigned accept_psk_mode:1; |
| 1076 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1077 | /* cert_request is one if a client certificate was requested and zero |
| 1078 | * otherwise. */ |
| 1079 | unsigned cert_request:1; |
| 1080 | |
| 1081 | /* certificate_status_expected is one if OCSP stapling was negotiated and the |
| 1082 | * server is expected to send a CertificateStatus message. (This is used on |
| 1083 | * both the client and server sides.) */ |
| 1084 | unsigned certificate_status_expected:1; |
| 1085 | |
| 1086 | /* ocsp_stapling_requested is one if a client requested OCSP stapling. */ |
| 1087 | unsigned ocsp_stapling_requested:1; |
| 1088 | |
| 1089 | /* should_ack_sni is used by a server and indicates that the SNI extension |
| 1090 | * should be echoed in the ServerHello. */ |
| 1091 | unsigned should_ack_sni:1; |
| 1092 | |
| 1093 | /* in_false_start is one if there is a pending client handshake in False |
| 1094 | * Start. The client may write data at this point. */ |
| 1095 | unsigned in_false_start:1; |
| 1096 | |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 1097 | /* early_data_offered is one if the client sent the early_data extension. */ |
| 1098 | unsigned early_data_offered:1; |
| 1099 | |
| 1100 | /* can_early_read is one if application data may be read at this point in the |
| 1101 | * handshake. */ |
| 1102 | unsigned can_early_read:1; |
| 1103 | |
| 1104 | /* can_early_write is one if application data may be written at this point in |
| 1105 | * the handshake. */ |
| 1106 | unsigned can_early_write:1; |
| 1107 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1108 | /* next_proto_neg_seen is one of NPN was negotiated. */ |
| 1109 | unsigned next_proto_neg_seen:1; |
| 1110 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1111 | /* ticket_expected is one if a TLS 1.2 NewSessionTicket message is to be sent |
| 1112 | * or received. */ |
| 1113 | unsigned ticket_expected:1; |
| 1114 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1115 | /* v2_clienthello is one if we received a V2ClientHello. */ |
| 1116 | unsigned v2_clienthello:1; |
| 1117 | |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 1118 | /* extended_master_secret is one if the extended master secret extension is |
| 1119 | * negotiated in this handshake. */ |
| 1120 | unsigned extended_master_secret:1; |
| 1121 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1122 | /* client_version is the value sent or received in the ClientHello version. */ |
| 1123 | uint16_t client_version; |
Robert Sloan | 9254e68 | 2017-04-24 09:42:06 -0700 | [diff] [blame] | 1124 | |
| 1125 | /* early_data_read is the amount of early data that has been read by the |
| 1126 | * record layer. */ |
| 1127 | uint16_t early_data_read; |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1128 | } /* SSL_HANDSHAKE */; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1129 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1130 | SSL_HANDSHAKE *ssl_handshake_new(SSL *ssl); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1131 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1132 | /* ssl_handshake_free releases all memory associated with |hs|. */ |
| 1133 | void ssl_handshake_free(SSL_HANDSHAKE *hs); |
| 1134 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1135 | /* ssl_check_message_type checks if the current message has type |type|. If so |
| 1136 | * it returns one. Otherwise, it sends an alert and returns zero. */ |
| 1137 | int ssl_check_message_type(SSL *ssl, int type); |
| 1138 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1139 | /* tls13_handshake runs the TLS 1.3 handshake. It returns one on success and <= |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 1140 | * 0 on error. It sets |out_early_return| to one if we've completed the |
| 1141 | * handshake early. */ |
| 1142 | int tls13_handshake(SSL_HANDSHAKE *hs, int *out_early_return); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1143 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1144 | /* The following are implementations of |do_tls13_handshake| for the client and |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1145 | * server. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1146 | enum ssl_hs_wait_t tls13_client_handshake(SSL_HANDSHAKE *hs); |
| 1147 | enum ssl_hs_wait_t tls13_server_handshake(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1148 | |
| 1149 | /* tls13_post_handshake processes a post-handshake message. It returns one on |
| 1150 | * success and zero on failure. */ |
| 1151 | int tls13_post_handshake(SSL *ssl); |
| 1152 | |
Steven Valdez | e7531f0 | 2016-12-14 13:29:57 -0500 | [diff] [blame] | 1153 | int tls13_process_certificate(SSL_HANDSHAKE *hs, int allow_anonymous); |
| 1154 | int tls13_process_certificate_verify(SSL_HANDSHAKE *hs); |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 1155 | |
| 1156 | /* tls13_process_finished processes the current message as a Finished message |
| 1157 | * from the peer. If |use_saved_value| is one, the verify_data is compared |
| 1158 | * against |hs->expected_client_finished| rather than computed fresh. */ |
| 1159 | int tls13_process_finished(SSL_HANDSHAKE *hs, int use_saved_value); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1160 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1161 | int tls13_add_certificate(SSL_HANDSHAKE *hs); |
| 1162 | enum ssl_private_key_result_t tls13_add_certificate_verify(SSL_HANDSHAKE *hs, |
| 1163 | int is_first_run); |
| 1164 | int tls13_add_finished(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1165 | int tls13_process_new_session_ticket(SSL *ssl); |
| 1166 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1167 | int ssl_ext_key_share_parse_serverhello(SSL_HANDSHAKE *hs, uint8_t **out_secret, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1168 | size_t *out_secret_len, |
| 1169 | uint8_t *out_alert, CBS *contents); |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1170 | int ssl_ext_key_share_parse_clienthello(SSL_HANDSHAKE *hs, int *out_found, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1171 | uint8_t **out_secret, |
| 1172 | size_t *out_secret_len, |
| 1173 | uint8_t *out_alert, CBS *contents); |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1174 | int ssl_ext_key_share_add_serverhello(SSL_HANDSHAKE *hs, CBB *out); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1175 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1176 | int ssl_ext_pre_shared_key_parse_serverhello(SSL_HANDSHAKE *hs, |
| 1177 | uint8_t *out_alert, CBS *contents); |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 1178 | int ssl_ext_pre_shared_key_parse_clienthello( |
| 1179 | SSL_HANDSHAKE *hs, CBS *out_ticket, CBS *out_binders, |
| 1180 | uint32_t *out_obfuscated_ticket_age, uint8_t *out_alert, CBS *contents); |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1181 | int ssl_ext_pre_shared_key_add_serverhello(SSL_HANDSHAKE *hs, CBB *out); |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1182 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1183 | /* ssl_is_sct_list_valid does a shallow parse of the SCT list in |contents| and |
| 1184 | * returns one iff it's valid. */ |
| 1185 | int ssl_is_sct_list_valid(const CBS *contents); |
| 1186 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1187 | int ssl_write_client_hello(SSL_HANDSHAKE *hs); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1188 | |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1189 | /* ssl_clear_tls13_state releases client state only needed for TLS 1.3. It |
| 1190 | * should be called once the version is known to be TLS 1.2 or earlier. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1191 | void ssl_clear_tls13_state(SSL_HANDSHAKE *hs); |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1192 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1193 | enum ssl_cert_verify_context_t { |
| 1194 | ssl_cert_verify_server, |
| 1195 | ssl_cert_verify_client, |
| 1196 | ssl_cert_verify_channel_id, |
| 1197 | }; |
| 1198 | |
| 1199 | /* tls13_get_cert_verify_signature_input generates the message to be signed for |
| 1200 | * TLS 1.3's CertificateVerify message. |cert_verify_context| determines the |
| 1201 | * type of signature. It sets |*out| and |*out_len| to a newly allocated buffer |
| 1202 | * containing the result. The caller must free it with |OPENSSL_free| to release |
| 1203 | * it. This function returns one on success and zero on failure. */ |
| 1204 | int tls13_get_cert_verify_signature_input( |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1205 | SSL_HANDSHAKE *hs, uint8_t **out, size_t *out_len, |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1206 | enum ssl_cert_verify_context_t cert_verify_context); |
| 1207 | |
| 1208 | /* ssl_negotiate_alpn negotiates the ALPN extension, if applicable. It returns |
| 1209 | * one on successful negotiation or if nothing was negotiated. It returns zero |
| 1210 | * and sets |*out_alert| to an alert on error. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1211 | int ssl_negotiate_alpn(SSL_HANDSHAKE *hs, uint8_t *out_alert, |
| 1212 | const SSL_CLIENT_HELLO *client_hello); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1213 | |
| 1214 | typedef struct { |
| 1215 | uint16_t type; |
| 1216 | int *out_present; |
| 1217 | CBS *out_data; |
| 1218 | } SSL_EXTENSION_TYPE; |
| 1219 | |
| 1220 | /* ssl_parse_extensions parses a TLS extensions block out of |cbs| and advances |
| 1221 | * it. It writes the parsed extensions to pointers denoted by |ext_types|. On |
| 1222 | * success, it fills in the |out_present| and |out_data| fields and returns one. |
| 1223 | * Otherwise, it sets |*out_alert| to an alert to send and returns zero. Unknown |
Robert Sloan | 69939df | 2017-01-09 10:53:07 -0800 | [diff] [blame] | 1224 | * extensions are rejected unless |ignore_unknown| is 1. */ |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1225 | int ssl_parse_extensions(const CBS *cbs, uint8_t *out_alert, |
| 1226 | const SSL_EXTENSION_TYPE *ext_types, |
Robert Sloan | 69939df | 2017-01-09 10:53:07 -0800 | [diff] [blame] | 1227 | size_t num_ext_types, int ignore_unknown); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1228 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1229 | |
| 1230 | /* SSLKEYLOGFILE functions. */ |
| 1231 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1232 | /* ssl_log_secret logs |secret| with label |label|, if logging is enabled for |
| 1233 | * |ssl|. It returns one on success and zero on failure. */ |
| 1234 | int ssl_log_secret(const SSL *ssl, const char *label, const uint8_t *secret, |
| 1235 | size_t secret_len); |
| 1236 | |
| 1237 | |
| 1238 | /* ClientHello functions. */ |
| 1239 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1240 | int ssl_client_hello_init(SSL *ssl, SSL_CLIENT_HELLO *out, const uint8_t *in, |
| 1241 | size_t in_len); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1242 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1243 | int ssl_client_hello_get_extension(const SSL_CLIENT_HELLO *client_hello, |
| 1244 | CBS *out, uint16_t extension_type); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1245 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1246 | int ssl_client_cipher_list_contains_cipher(const SSL_CLIENT_HELLO *client_hello, |
| 1247 | uint16_t id); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1248 | |
| 1249 | |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 1250 | /* GREASE. */ |
| 1251 | |
| 1252 | enum ssl_grease_index_t { |
| 1253 | ssl_grease_cipher = 0, |
| 1254 | ssl_grease_group, |
| 1255 | ssl_grease_extension1, |
| 1256 | ssl_grease_extension2, |
| 1257 | ssl_grease_version, |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1258 | ssl_grease_ticket_extension, |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 1259 | }; |
| 1260 | |
| 1261 | /* ssl_get_grease_value returns a GREASE value for |ssl|. For a given |
| 1262 | * connection, the values for each index will be deterministic. This allows the |
| 1263 | * same ClientHello be sent twice for a HelloRetryRequest or the same group be |
| 1264 | * advertised in both supported_groups and key_shares. */ |
| 1265 | uint16_t ssl_get_grease_value(const SSL *ssl, enum ssl_grease_index_t index); |
| 1266 | |
| 1267 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1268 | /* Signature algorithms. */ |
| 1269 | |
| 1270 | /* tls1_parse_peer_sigalgs parses |sigalgs| as the list of peer signature |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1271 | * algorithms and saves them on |hs|. It returns one on success and zero on |
| 1272 | * error. */ |
| 1273 | int tls1_parse_peer_sigalgs(SSL_HANDSHAKE *hs, const CBS *sigalgs); |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1274 | |
Robert Sloan | 2424d84 | 2017-05-01 07:46:28 -0700 | [diff] [blame] | 1275 | /* tls1_get_legacy_signature_algorithm sets |*out| to the signature algorithm |
| 1276 | * that should be used with |pkey| in TLS 1.1 and earlier. It returns one on |
| 1277 | * success and zero if |pkey| may not be used at those versions. */ |
| 1278 | int tls1_get_legacy_signature_algorithm(uint16_t *out, const EVP_PKEY *pkey); |
| 1279 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1280 | /* tls1_choose_signature_algorithm sets |*out| to a signature algorithm for use |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1281 | * with |hs|'s private key based on the peer's preferences and the algorithms |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1282 | * supported. It returns one on success and zero on error. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1283 | int tls1_choose_signature_algorithm(SSL_HANDSHAKE *hs, uint16_t *out); |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1284 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 1285 | /* tls12_add_verify_sigalgs adds the signature algorithms acceptable for the |
| 1286 | * peer signature to |out|. It returns one on success and zero on error. */ |
| 1287 | int tls12_add_verify_sigalgs(const SSL *ssl, CBB *out); |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1288 | |
| 1289 | /* tls12_check_peer_sigalg checks if |sigalg| is acceptable for the peer |
| 1290 | * signature. It returns one on success and zero on error, setting |*out_alert| |
| 1291 | * to an alert to send. */ |
| 1292 | int tls12_check_peer_sigalg(SSL *ssl, int *out_alert, uint16_t sigalg); |
| 1293 | |
| 1294 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1295 | /* Underdocumented functions. |
| 1296 | * |
| 1297 | * Functions below here haven't been touched up and may be underdocumented. */ |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1298 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1299 | #define TLSEXT_CHANNEL_ID_SIZE 128 |
| 1300 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1301 | /* From RFC4492, used in encoding the curve type in ECParameters */ |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1302 | #define NAMED_CURVE_TYPE 3 |
| 1303 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 1304 | typedef struct cert_st { |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1305 | EVP_PKEY *privatekey; |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1306 | |
| 1307 | /* chain contains the certificate chain, with the leaf at the beginning. The |
| 1308 | * first element of |chain| may be NULL to indicate that the leaf certificate |
| 1309 | * has not yet been set. |
| 1310 | * If |chain| != NULL -> len(chain) >= 1 |
| 1311 | * If |chain[0]| == NULL -> len(chain) >= 2. |
| 1312 | * |chain[1..]| != NULL */ |
| 1313 | STACK_OF(CRYPTO_BUFFER) *chain; |
| 1314 | |
| 1315 | /* x509_chain may contain a parsed copy of |chain[1..]|. This is only used as |
| 1316 | * a cache in order to implement “get0” functions that return a non-owning |
| 1317 | * pointer to the certificate chain. */ |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1318 | STACK_OF(X509) *x509_chain; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1319 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1320 | /* x509_leaf may contain a parsed copy of the first element of |chain|. This |
| 1321 | * is only used as a cache in order to implement “get0” functions that return |
| 1322 | * a non-owning pointer to the certificate chain. */ |
| 1323 | X509 *x509_leaf; |
| 1324 | |
| 1325 | /* x509_stash contains the last |X509| object append to the chain. This is a |
| 1326 | * workaround for some third-party code that continue to use an |X509| object |
| 1327 | * even after passing ownership with an “add0” function. */ |
| 1328 | X509 *x509_stash; |
| 1329 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 1330 | /* key_method, if non-NULL, is a set of callbacks to call for private key |
| 1331 | * operations. */ |
| 1332 | const SSL_PRIVATE_KEY_METHOD *key_method; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1333 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1334 | /* x509_method contains pointers to functions that might deal with |X509| |
| 1335 | * compatibility, or might be a no-op, depending on the application. */ |
| 1336 | const SSL_X509_METHOD *x509_method; |
| 1337 | |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1338 | /* sigalgs, if non-NULL, is the set of signature algorithms supported by |
| 1339 | * |privatekey| in decreasing order of preference. */ |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1340 | uint16_t *sigalgs; |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1341 | size_t num_sigalgs; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1342 | |
| 1343 | /* Certificate setup callback: if set is called whenever a |
| 1344 | * certificate may be required (client or server). the callback |
| 1345 | * can then examine any appropriate parameters and setup any |
| 1346 | * certificates required. This allows advanced applications |
| 1347 | * to select certificates on the fly: for example based on |
| 1348 | * supported signature algorithms or curves. */ |
| 1349 | int (*cert_cb)(SSL *ssl, void *arg); |
| 1350 | void *cert_cb_arg; |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 1351 | |
| 1352 | /* Optional X509_STORE for certificate validation. If NULL the parent SSL_CTX |
| 1353 | * store is used instead. */ |
| 1354 | X509_STORE *verify_store; |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 1355 | |
| 1356 | /* Signed certificate timestamp list to be sent to the client, if requested */ |
| 1357 | CRYPTO_BUFFER *signed_cert_timestamp_list; |
| 1358 | |
| 1359 | /* OCSP response to be sent to the client, if requested. */ |
| 1360 | CRYPTO_BUFFER *ocsp_response; |
| 1361 | |
| 1362 | /* sid_ctx partitions the session space within a shared session cache or |
| 1363 | * ticket key. Only sessions with a matching value will be accepted. */ |
| 1364 | uint8_t sid_ctx_length; |
| 1365 | uint8_t sid_ctx[SSL_MAX_SID_CTX_LENGTH]; |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 1366 | |
| 1367 | /* If enable_early_data is non-zero, early data can be sent and accepted. */ |
| 1368 | unsigned enable_early_data:1; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1369 | } CERT; |
| 1370 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1371 | /* SSL_METHOD is a compatibility structure to support the legacy version-locked |
| 1372 | * methods. */ |
| 1373 | struct ssl_method_st { |
| 1374 | /* version, if non-zero, is the only protocol version acceptable to an |
| 1375 | * SSL_CTX initialized from this method. */ |
| 1376 | uint16_t version; |
| 1377 | /* method is the underlying SSL_PROTOCOL_METHOD that initializes the |
| 1378 | * SSL_CTX. */ |
| 1379 | const SSL_PROTOCOL_METHOD *method; |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1380 | /* x509_method contains pointers to functions that might deal with |X509| |
| 1381 | * compatibility, or might be a no-op, depending on the application. */ |
| 1382 | const SSL_X509_METHOD *x509_method; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1383 | }; |
| 1384 | |
| 1385 | /* Used to hold functions for SSLv2 or SSLv3/TLSv1 functions */ |
| 1386 | struct ssl_protocol_method_st { |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1387 | /* is_dtls is one if the protocol is DTLS and zero otherwise. */ |
| 1388 | char is_dtls; |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1389 | /* min_version is the minimum implemented version. */ |
| 1390 | uint16_t min_version; |
| 1391 | /* max_version is the maximum implemented version. */ |
| 1392 | uint16_t max_version; |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1393 | /* version_from_wire maps |wire_version| to a protocol version. On success, it |
| 1394 | * sets |*out_version| to the result and returns one. If the version is |
| 1395 | * unknown, it returns zero. */ |
| 1396 | int (*version_from_wire)(uint16_t *out_version, uint16_t wire_version); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1397 | /* version_to_wire maps |version| to the wire representation. It is an error |
| 1398 | * to call it with an invalid version. */ |
| 1399 | uint16_t (*version_to_wire)(uint16_t version); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 1400 | int (*ssl_new)(SSL *ssl); |
| 1401 | void (*ssl_free)(SSL *ssl); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1402 | /* ssl_get_message reads the next handshake message. On success, it returns |
| 1403 | * one and sets |ssl->s3->tmp.message_type|, |ssl->init_msg|, and |
| 1404 | * |ssl->init_num|. Otherwise, it returns <= 0. */ |
| 1405 | int (*ssl_get_message)(SSL *ssl); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1406 | /* get_current_message sets |*out| to the current handshake message. This |
| 1407 | * includes the protocol-specific message header. */ |
| 1408 | void (*get_current_message)(const SSL *ssl, CBS *out); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1409 | /* release_current_message is called to release the current handshake message. |
| 1410 | * If |free_buffer| is one, buffers will also be released. */ |
| 1411 | void (*release_current_message)(SSL *ssl, int free_buffer); |
| 1412 | /* read_app_data reads up to |len| bytes of application data into |buf|. On |
| 1413 | * success, it returns the number of bytes read. Otherwise, it returns <= 0 |
| 1414 | * and sets |*out_got_handshake| to whether the failure was due to a |
| 1415 | * post-handshake handshake message. If so, it fills in the current message as |
| 1416 | * in |ssl_get_message|. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1417 | int (*read_app_data)(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1418 | int peek); |
| 1419 | int (*read_change_cipher_spec)(SSL *ssl); |
| 1420 | void (*read_close_notify)(SSL *ssl); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1421 | int (*write_app_data)(SSL *ssl, const uint8_t *buf, int len); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1422 | int (*dispatch_alert)(SSL *ssl); |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 1423 | /* supports_cipher returns one if |cipher| is supported by this protocol and |
| 1424 | * zero otherwise. */ |
| 1425 | int (*supports_cipher)(const SSL_CIPHER *cipher); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1426 | /* init_message begins a new handshake message of type |type|. |cbb| is the |
| 1427 | * root CBB to be passed into |finish_message|. |*body| is set to a child CBB |
| 1428 | * the caller should write to. It returns one on success and zero on error. */ |
| 1429 | int (*init_message)(SSL *ssl, CBB *cbb, CBB *body, uint8_t type); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1430 | /* finish_message finishes a handshake message. It sets |*out_msg| to a |
| 1431 | * newly-allocated buffer with the serialized message. The caller must |
| 1432 | * release it with |OPENSSL_free| when done. It returns one on success and |
| 1433 | * zero on error. */ |
| 1434 | int (*finish_message)(SSL *ssl, CBB *cbb, uint8_t **out_msg, size_t *out_len); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1435 | /* add_message adds a handshake message to the pending flight. It returns one |
| 1436 | * on success and zero on error. In either case, it takes ownership of |msg| |
| 1437 | * and releases it with |OPENSSL_free| when done. */ |
| 1438 | int (*add_message)(SSL *ssl, uint8_t *msg, size_t len); |
| 1439 | /* add_change_cipher_spec adds a ChangeCipherSpec record to the pending |
| 1440 | * flight. It returns one on success and zero on error. */ |
| 1441 | int (*add_change_cipher_spec)(SSL *ssl); |
| 1442 | /* add_alert adds an alert to the pending flight. It returns one on success |
| 1443 | * and zero on error. */ |
| 1444 | int (*add_alert)(SSL *ssl, uint8_t level, uint8_t desc); |
| 1445 | /* flush_flight flushes the pending flight to the transport. It returns one on |
David Benjamin | f31229b | 2017-01-25 14:08:15 -0500 | [diff] [blame] | 1446 | * success and <= 0 on error. */ |
| 1447 | int (*flush_flight)(SSL *ssl); |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 1448 | /* expect_flight is called when the handshake expects a flight of messages from |
| 1449 | * the peer. */ |
| 1450 | void (*expect_flight)(SSL *ssl); |
| 1451 | /* received_flight is called when the handshake has received a flight of |
| 1452 | * messages from the peer. */ |
| 1453 | void (*received_flight)(SSL *ssl); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1454 | /* set_read_state sets |ssl|'s read cipher state to |aead_ctx|. It takes |
| 1455 | * ownership of |aead_ctx|. It returns one on success and zero if changing the |
| 1456 | * read state is forbidden at this point. */ |
| 1457 | int (*set_read_state)(SSL *ssl, SSL_AEAD_CTX *aead_ctx); |
| 1458 | /* set_write_state sets |ssl|'s write cipher state to |aead_ctx|. It takes |
| 1459 | * ownership of |aead_ctx|. It returns one on success and zero if changing the |
| 1460 | * write state is forbidden at this point. */ |
| 1461 | int (*set_write_state)(SSL *ssl, SSL_AEAD_CTX *aead_ctx); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1462 | }; |
| 1463 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1464 | struct ssl_x509_method_st { |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1465 | /* check_client_CA_list returns one if |names| is a good list of X.509 |
| 1466 | * distinguished names and zero otherwise. This is used to ensure that we can |
| 1467 | * reject unparsable values at handshake time when using crypto/x509. */ |
| 1468 | int (*check_client_CA_list)(STACK_OF(CRYPTO_BUFFER) *names); |
| 1469 | |
| 1470 | /* cert_clear frees and NULLs all X509 certificate-related state. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1471 | void (*cert_clear)(CERT *cert); |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1472 | /* cert_free frees all X509-related state. */ |
| 1473 | void (*cert_free)(CERT *cert); |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1474 | /* cert_flush_cached_chain drops any cached |X509|-based certificate chain |
| 1475 | * from |cert|. */ |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1476 | /* cert_dup duplicates any needed fields from |cert| to |new_cert|. */ |
| 1477 | void (*cert_dup)(CERT *new_cert, const CERT *cert); |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1478 | void (*cert_flush_cached_chain)(CERT *cert); |
| 1479 | /* cert_flush_cached_chain drops any cached |X509|-based leaf certificate |
| 1480 | * from |cert|. */ |
| 1481 | void (*cert_flush_cached_leaf)(CERT *cert); |
| 1482 | |
| 1483 | /* session_cache_objects fills out |sess->x509_peer| and |sess->x509_chain| |
| 1484 | * from |sess->certs| and erases |sess->x509_chain_without_leaf|. It returns |
| 1485 | * one on success or zero on error. */ |
| 1486 | int (*session_cache_objects)(SSL_SESSION *session); |
| 1487 | /* session_dup duplicates any needed fields from |session| to |new_session|. |
| 1488 | * It returns one on success or zero on error. */ |
| 1489 | int (*session_dup)(SSL_SESSION *new_session, const SSL_SESSION *session); |
| 1490 | /* session_clear frees any X509-related state from |session|. */ |
| 1491 | void (*session_clear)(SSL_SESSION *session); |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1492 | /* session_verify_cert_chain verifies the certificate chain in |session|, |
| 1493 | * sets |session->verify_result| and returns one on success or zero on |
| 1494 | * error. */ |
| 1495 | int (*session_verify_cert_chain)(SSL_SESSION *session, SSL *ssl); |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1496 | |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1497 | /* hs_flush_cached_ca_names drops any cached |X509_NAME|s from |hs|. */ |
| 1498 | void (*hs_flush_cached_ca_names)(SSL_HANDSHAKE *hs); |
| 1499 | /* ssl_new does any neccessary initialisation of |ssl|. It returns one on |
| 1500 | * success or zero on error. */ |
| 1501 | int (*ssl_new)(SSL *ssl); |
| 1502 | /* ssl_free frees anything created by |ssl_new|. */ |
| 1503 | void (*ssl_free)(SSL *ssl); |
| 1504 | /* ssl_flush_cached_client_CA drops any cached |X509_NAME|s from |ssl|. */ |
| 1505 | void (*ssl_flush_cached_client_CA)(SSL *ssl); |
| 1506 | /* ssl_auto_chain_if_needed runs the deprecated auto-chaining logic if |
| 1507 | * necessary. On success, it updates |ssl|'s certificate configuration as |
| 1508 | * needed and returns one. Otherwise, it returns zero. */ |
| 1509 | int (*ssl_auto_chain_if_needed)(SSL *ssl); |
| 1510 | /* ssl_ctx_new does any neccessary initialisation of |ctx|. It returns one on |
| 1511 | * success or zero on error. */ |
| 1512 | int (*ssl_ctx_new)(SSL_CTX *ctx); |
| 1513 | /* ssl_ctx_free frees anything created by |ssl_ctx_new|. */ |
| 1514 | void (*ssl_ctx_free)(SSL_CTX *ctx); |
| 1515 | /* ssl_ctx_flush_cached_client_CA drops any cached |X509_NAME|s from |ctx|. */ |
| 1516 | void (*ssl_ctx_flush_cached_client_CA)(SSL_CTX *ssl); |
| 1517 | }; |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1518 | |
| 1519 | /* ssl_crypto_x509_method provides the |ssl_x509_method_st| functions using |
| 1520 | * crypto/x509. */ |
| 1521 | extern const struct ssl_x509_method_st ssl_crypto_x509_method; |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1522 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1523 | typedef struct ssl3_record_st { |
| 1524 | /* type is the record type. */ |
| 1525 | uint8_t type; |
| 1526 | /* length is the number of unconsumed bytes in the record. */ |
| 1527 | uint16_t length; |
| 1528 | /* data is a non-owning pointer to the first unconsumed byte of the record. */ |
| 1529 | uint8_t *data; |
| 1530 | } SSL3_RECORD; |
| 1531 | |
| 1532 | typedef struct ssl3_buffer_st { |
| 1533 | /* buf is the memory allocated for this buffer. */ |
| 1534 | uint8_t *buf; |
| 1535 | /* offset is the offset into |buf| which the buffer contents start at. */ |
| 1536 | uint16_t offset; |
| 1537 | /* len is the length of the buffer contents from |buf| + |offset|. */ |
| 1538 | uint16_t len; |
| 1539 | /* cap is how much memory beyond |buf| + |offset| is available. */ |
| 1540 | uint16_t cap; |
| 1541 | } SSL3_BUFFER; |
| 1542 | |
| 1543 | /* An ssl_shutdown_t describes the shutdown state of one end of the connection, |
| 1544 | * whether it is alive or has been shutdown via close_notify or fatal alert. */ |
| 1545 | enum ssl_shutdown_t { |
| 1546 | ssl_shutdown_none = 0, |
| 1547 | ssl_shutdown_close_notify = 1, |
| 1548 | ssl_shutdown_fatal_alert = 2, |
| 1549 | }; |
| 1550 | |
| 1551 | typedef struct ssl3_state_st { |
| 1552 | uint8_t read_sequence[8]; |
| 1553 | uint8_t write_sequence[8]; |
| 1554 | |
| 1555 | uint8_t server_random[SSL3_RANDOM_SIZE]; |
| 1556 | uint8_t client_random[SSL3_RANDOM_SIZE]; |
| 1557 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1558 | /* read_buffer holds data from the transport to be processed. */ |
| 1559 | SSL3_BUFFER read_buffer; |
| 1560 | /* write_buffer holds data to be written to the transport. */ |
| 1561 | SSL3_BUFFER write_buffer; |
| 1562 | |
| 1563 | SSL3_RECORD rrec; /* each decoded record goes in here */ |
| 1564 | |
| 1565 | /* partial write - check the numbers match */ |
| 1566 | unsigned int wnum; /* number of bytes sent so far */ |
| 1567 | int wpend_tot; /* number bytes written */ |
| 1568 | int wpend_type; |
| 1569 | int wpend_ret; /* number of bytes submitted */ |
| 1570 | const uint8_t *wpend_buf; |
| 1571 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1572 | /* recv_shutdown is the shutdown state for the receive half of the |
| 1573 | * connection. */ |
| 1574 | enum ssl_shutdown_t recv_shutdown; |
| 1575 | |
| 1576 | /* recv_shutdown is the shutdown state for the send half of the connection. */ |
| 1577 | enum ssl_shutdown_t send_shutdown; |
| 1578 | |
| 1579 | int alert_dispatch; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1580 | |
| 1581 | int total_renegotiations; |
| 1582 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1583 | /* early_data_skipped is the amount of early data that has been skipped by the |
| 1584 | * record layer. */ |
| 1585 | uint16_t early_data_skipped; |
| 1586 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1587 | /* empty_record_count is the number of consecutive empty records received. */ |
| 1588 | uint8_t empty_record_count; |
| 1589 | |
| 1590 | /* warning_alert_count is the number of consecutive warning alerts |
| 1591 | * received. */ |
| 1592 | uint8_t warning_alert_count; |
| 1593 | |
| 1594 | /* key_update_count is the number of consecutive KeyUpdates received. */ |
| 1595 | uint8_t key_update_count; |
| 1596 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1597 | /* skip_early_data instructs the record layer to skip unexpected early data |
| 1598 | * messages when 0RTT is rejected. */ |
| 1599 | unsigned skip_early_data:1; |
| 1600 | |
| 1601 | /* have_version is true if the connection's final version is known. Otherwise |
| 1602 | * the version has not been negotiated yet. */ |
| 1603 | unsigned have_version:1; |
| 1604 | |
| 1605 | /* v2_hello_done is true if the peer's V2ClientHello, if any, has been handled |
| 1606 | * and future messages should use the record layer. */ |
| 1607 | unsigned v2_hello_done:1; |
| 1608 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1609 | /* is_v2_hello is true if the current handshake message was derived from a |
| 1610 | * V2ClientHello rather than received from the peer directly. */ |
| 1611 | unsigned is_v2_hello:1; |
| 1612 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1613 | /* initial_handshake_complete is true if the initial handshake has |
| 1614 | * completed. */ |
| 1615 | unsigned initial_handshake_complete:1; |
| 1616 | |
| 1617 | /* session_reused indicates whether a session was resumed. */ |
| 1618 | unsigned session_reused:1; |
| 1619 | |
| 1620 | unsigned send_connection_binding:1; |
| 1621 | |
| 1622 | /* In a client, this means that the server supported Channel ID and that a |
| 1623 | * Channel ID was sent. In a server it means that we echoed support for |
| 1624 | * Channel IDs and that tlsext_channel_id will be valid after the |
| 1625 | * handshake. */ |
| 1626 | unsigned tlsext_channel_id_valid:1; |
| 1627 | |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 1628 | /* key_update_pending is one if we have a KeyUpdate acknowledgment |
| 1629 | * outstanding. */ |
| 1630 | unsigned key_update_pending:1; |
| 1631 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1632 | uint8_t send_alert[2]; |
| 1633 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1634 | /* pending_flight is the pending outgoing flight. This is used to flush each |
Robert Sloan | 572a4e2 | 2017-04-17 10:52:19 -0700 | [diff] [blame] | 1635 | * handshake flight in a single write. |write_buffer| must be written out |
| 1636 | * before this data. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1637 | BUF_MEM *pending_flight; |
| 1638 | |
| 1639 | /* pending_flight_offset is the number of bytes of |pending_flight| which have |
| 1640 | * been successfully written. */ |
| 1641 | uint32_t pending_flight_offset; |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1642 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1643 | /* aead_read_ctx is the current read cipher state. */ |
| 1644 | SSL_AEAD_CTX *aead_read_ctx; |
| 1645 | |
| 1646 | /* aead_write_ctx is the current write cipher state. */ |
| 1647 | SSL_AEAD_CTX *aead_write_ctx; |
| 1648 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1649 | /* hs is the handshake state for the current handshake or NULL if there isn't |
| 1650 | * one. */ |
| 1651 | SSL_HANDSHAKE *hs; |
| 1652 | |
| 1653 | uint8_t write_traffic_secret[EVP_MAX_MD_SIZE]; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1654 | uint8_t read_traffic_secret[EVP_MAX_MD_SIZE]; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1655 | uint8_t exporter_secret[EVP_MAX_MD_SIZE]; |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 1656 | uint8_t early_exporter_secret[EVP_MAX_MD_SIZE]; |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1657 | uint8_t write_traffic_secret_len; |
| 1658 | uint8_t read_traffic_secret_len; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1659 | uint8_t exporter_secret_len; |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 1660 | uint8_t early_exporter_secret_len; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1661 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1662 | /* Connection binding to prevent renegotiation attacks */ |
| 1663 | uint8_t previous_client_finished[12]; |
| 1664 | uint8_t previous_client_finished_len; |
| 1665 | uint8_t previous_server_finished_len; |
| 1666 | uint8_t previous_server_finished[12]; |
| 1667 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1668 | /* State pertaining to the pending handshake. |
| 1669 | * |
| 1670 | * TODO(davidben): Move everything not needed after the handshake completes to |
| 1671 | * |hs| and remove this. */ |
| 1672 | struct { |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1673 | int message_type; |
| 1674 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1675 | int reuse_message; |
| 1676 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1677 | uint8_t new_mac_secret_len; |
| 1678 | uint8_t new_key_len; |
| 1679 | uint8_t new_fixed_iv_len; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1680 | } tmp; |
| 1681 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1682 | /* established_session is the session established by the connection. This |
| 1683 | * session is only filled upon the completion of the handshake and is |
| 1684 | * immutable. */ |
| 1685 | SSL_SESSION *established_session; |
| 1686 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1687 | /* Next protocol negotiation. For the client, this is the protocol that we |
| 1688 | * sent in NextProtocol and is set when handling ServerHello extensions. |
| 1689 | * |
| 1690 | * For a server, this is the client's selected_protocol from NextProtocol and |
| 1691 | * is set when handling the NextProtocol message, before the Finished |
| 1692 | * message. */ |
| 1693 | uint8_t *next_proto_negotiated; |
| 1694 | size_t next_proto_negotiated_len; |
| 1695 | |
| 1696 | /* ALPN information |
| 1697 | * (we are in the process of transitioning from NPN to ALPN.) */ |
| 1698 | |
| 1699 | /* In a server these point to the selected ALPN protocol after the |
| 1700 | * ClientHello has been processed. In a client these contain the protocol |
| 1701 | * that the server selected once the ServerHello has been processed. */ |
| 1702 | uint8_t *alpn_selected; |
| 1703 | size_t alpn_selected_len; |
| 1704 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1705 | /* For a server: |
| 1706 | * If |tlsext_channel_id_valid| is true, then this contains the |
| 1707 | * verified Channel ID from the client: a P256 point, (x,y), where |
| 1708 | * each are big-endian values. */ |
| 1709 | uint8_t tlsext_channel_id[64]; |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 1710 | |
| 1711 | /* ticket_age_skew is the difference, in seconds, between the client-sent |
| 1712 | * ticket age and the server-computed value in TLS 1.3 server connections |
| 1713 | * which resumed a session. */ |
| 1714 | int32_t ticket_age_skew; |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1715 | } SSL3_STATE; |
| 1716 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1717 | /* lengths of messages */ |
| 1718 | #define DTLS1_COOKIE_LENGTH 256 |
| 1719 | |
| 1720 | #define DTLS1_RT_HEADER_LENGTH 13 |
| 1721 | |
| 1722 | #define DTLS1_HM_HEADER_LENGTH 12 |
| 1723 | |
| 1724 | #define DTLS1_CCS_HEADER_LENGTH 1 |
| 1725 | |
| 1726 | #define DTLS1_AL_HEADER_LENGTH 2 |
| 1727 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1728 | struct hm_header_st { |
| 1729 | uint8_t type; |
| 1730 | uint32_t msg_len; |
| 1731 | uint16_t seq; |
| 1732 | uint32_t frag_off; |
| 1733 | uint32_t frag_len; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1734 | }; |
| 1735 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1736 | /* An hm_fragment is an incoming DTLS message, possibly not yet assembled. */ |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1737 | typedef struct hm_fragment_st { |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1738 | /* type is the type of the message. */ |
| 1739 | uint8_t type; |
| 1740 | /* seq is the sequence number of this message. */ |
| 1741 | uint16_t seq; |
| 1742 | /* msg_len is the length of the message body. */ |
| 1743 | uint32_t msg_len; |
| 1744 | /* data is a pointer to the message, including message header. It has length |
| 1745 | * |DTLS1_HM_HEADER_LENGTH| + |msg_len|. */ |
| 1746 | uint8_t *data; |
| 1747 | /* reassembly is a bitmask of |msg_len| bits corresponding to which parts of |
| 1748 | * the message have been received. It is NULL if the message is complete. */ |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1749 | uint8_t *reassembly; |
| 1750 | } hm_fragment; |
| 1751 | |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1752 | struct OPENSSL_timeval { |
| 1753 | uint64_t tv_sec; |
| 1754 | uint32_t tv_usec; |
| 1755 | }; |
| 1756 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1757 | typedef struct dtls1_state_st { |
| 1758 | /* send_cookie is true if we are resending the ClientHello |
| 1759 | * with a cookie from a HelloVerifyRequest. */ |
| 1760 | unsigned int send_cookie; |
| 1761 | |
| 1762 | uint8_t cookie[DTLS1_COOKIE_LENGTH]; |
| 1763 | size_t cookie_len; |
| 1764 | |
| 1765 | /* The current data and handshake epoch. This is initially undefined, and |
| 1766 | * starts at zero once the initial handshake is completed. */ |
| 1767 | uint16_t r_epoch; |
| 1768 | uint16_t w_epoch; |
| 1769 | |
| 1770 | /* records being received in the current epoch */ |
| 1771 | DTLS1_BITMAP bitmap; |
| 1772 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1773 | uint16_t handshake_write_seq; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1774 | uint16_t handshake_read_seq; |
| 1775 | |
| 1776 | /* save last sequence number for retransmissions */ |
| 1777 | uint8_t last_write_sequence[8]; |
| 1778 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1779 | /* incoming_messages is a ring buffer of incoming handshake messages that have |
| 1780 | * yet to be processed. The front of the ring buffer is message number |
| 1781 | * |handshake_read_seq|, at position |handshake_read_seq| % |
| 1782 | * |SSL_MAX_HANDSHAKE_FLIGHT|. */ |
| 1783 | hm_fragment *incoming_messages[SSL_MAX_HANDSHAKE_FLIGHT]; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1784 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1785 | /* outgoing_messages is the queue of outgoing messages from the last handshake |
| 1786 | * flight. */ |
| 1787 | DTLS_OUTGOING_MESSAGE outgoing_messages[SSL_MAX_HANDSHAKE_FLIGHT]; |
| 1788 | uint8_t outgoing_messages_len; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1789 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1790 | /* outgoing_written is the number of outgoing messages that have been |
| 1791 | * written. */ |
| 1792 | uint8_t outgoing_written; |
| 1793 | /* outgoing_offset is the number of bytes of the next outgoing message have |
| 1794 | * been written. */ |
| 1795 | uint32_t outgoing_offset; |
| 1796 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1797 | unsigned int mtu; /* max DTLS packet size */ |
| 1798 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1799 | /* num_timeouts is the number of times the retransmit timer has fired since |
| 1800 | * the last time it was reset. */ |
| 1801 | unsigned int num_timeouts; |
| 1802 | |
| 1803 | /* Indicates when the last handshake msg or heartbeat sent will |
| 1804 | * timeout. */ |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1805 | struct OPENSSL_timeval next_timeout; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1806 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 1807 | /* timeout_duration_ms is the timeout duration in milliseconds. */ |
| 1808 | unsigned timeout_duration_ms; |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 1809 | } DTLS1_STATE; |
| 1810 | |
Robert Sloan | 47f43ed | 2017-02-06 14:55:15 -0800 | [diff] [blame] | 1811 | struct ssl_st { |
| 1812 | /* method is the method table corresponding to the current protocol (DTLS or |
| 1813 | * TLS). */ |
| 1814 | const SSL_PROTOCOL_METHOD *method; |
| 1815 | |
| 1816 | /* version is the protocol version. */ |
| 1817 | int version; |
| 1818 | |
| 1819 | /* max_version is the maximum acceptable protocol version. Note this version |
| 1820 | * is normalized in DTLS. */ |
| 1821 | uint16_t max_version; |
| 1822 | |
| 1823 | /* min_version is the minimum acceptable protocol version. Note this version |
| 1824 | * is normalized in DTLS. */ |
| 1825 | uint16_t min_version; |
| 1826 | |
| 1827 | uint16_t max_send_fragment; |
| 1828 | |
| 1829 | /* There are 2 BIO's even though they are normally both the same. This is so |
| 1830 | * data can be read and written to different handlers */ |
| 1831 | |
| 1832 | BIO *rbio; /* used by SSL_read */ |
| 1833 | BIO *wbio; /* used by SSL_write */ |
| 1834 | |
| 1835 | int (*handshake_func)(SSL_HANDSHAKE *hs); |
| 1836 | |
| 1837 | BUF_MEM *init_buf; /* buffer used during init */ |
| 1838 | |
| 1839 | /* init_msg is a pointer to the current handshake message body. */ |
| 1840 | const uint8_t *init_msg; |
| 1841 | /* init_num is the length of the current handshake message body. */ |
| 1842 | uint32_t init_num; |
| 1843 | |
| 1844 | struct ssl3_state_st *s3; /* SSLv3 variables */ |
| 1845 | struct dtls1_state_st *d1; /* DTLSv1 variables */ |
| 1846 | |
| 1847 | /* callback that allows applications to peek at protocol messages */ |
| 1848 | void (*msg_callback)(int write_p, int version, int content_type, |
| 1849 | const void *buf, size_t len, SSL *ssl, void *arg); |
| 1850 | void *msg_callback_arg; |
| 1851 | |
| 1852 | X509_VERIFY_PARAM *param; |
| 1853 | |
| 1854 | /* crypto */ |
| 1855 | struct ssl_cipher_preference_list_st *cipher_list; |
| 1856 | |
| 1857 | /* session info */ |
| 1858 | |
| 1859 | /* client cert? */ |
| 1860 | /* This is used to hold the server certificate used */ |
| 1861 | struct cert_st /* CERT */ *cert; |
| 1862 | |
| 1863 | /* This holds a variable that indicates what we were doing when a 0 or -1 is |
| 1864 | * returned. This is needed for non-blocking IO so we know what request |
| 1865 | * needs re-doing when in SSL_accept or SSL_connect */ |
| 1866 | int rwstate; |
| 1867 | |
| 1868 | /* initial_timeout_duration_ms is the default DTLS timeout duration in |
| 1869 | * milliseconds. It's used to initialize the timer any time it's restarted. */ |
| 1870 | unsigned initial_timeout_duration_ms; |
| 1871 | |
Robert Sloan | 47f43ed | 2017-02-06 14:55:15 -0800 | [diff] [blame] | 1872 | /* session is the configured session to be offered by the client. This session |
| 1873 | * is immutable. */ |
| 1874 | SSL_SESSION *session; |
| 1875 | |
| 1876 | int (*verify_callback)(int ok, |
| 1877 | X509_STORE_CTX *ctx); /* fail if callback returns 0 */ |
| 1878 | |
| 1879 | void (*info_callback)(const SSL *ssl, int type, int value); |
| 1880 | |
| 1881 | /* Server-only: psk_identity_hint is the identity hint to send in |
| 1882 | * PSK-based key exchanges. */ |
| 1883 | char *psk_identity_hint; |
| 1884 | |
| 1885 | unsigned int (*psk_client_callback)(SSL *ssl, const char *hint, |
| 1886 | char *identity, |
| 1887 | unsigned int max_identity_len, |
| 1888 | uint8_t *psk, unsigned int max_psk_len); |
| 1889 | unsigned int (*psk_server_callback)(SSL *ssl, const char *identity, |
| 1890 | uint8_t *psk, unsigned int max_psk_len); |
| 1891 | |
| 1892 | SSL_CTX *ctx; |
| 1893 | |
| 1894 | /* extra application data */ |
| 1895 | CRYPTO_EX_DATA ex_data; |
| 1896 | |
| 1897 | /* for server side, keep the list of CA_dn we can use */ |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 1898 | STACK_OF(CRYPTO_BUFFER) *client_CA; |
| 1899 | |
| 1900 | /* cached_x509_client_CA is a cache of parsed versions of the elements of |
| 1901 | * |client_CA|. */ |
| 1902 | STACK_OF(X509_NAME) *cached_x509_client_CA; |
Robert Sloan | 47f43ed | 2017-02-06 14:55:15 -0800 | [diff] [blame] | 1903 | |
| 1904 | uint32_t options; /* protocol behaviour */ |
| 1905 | uint32_t mode; /* API behaviour */ |
| 1906 | uint32_t max_cert_list; |
| 1907 | char *tlsext_hostname; |
| 1908 | size_t supported_group_list_len; |
| 1909 | uint16_t *supported_group_list; /* our list */ |
| 1910 | |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 1911 | /* session_ctx is the |SSL_CTX| used for the session cache and related |
| 1912 | * settings. */ |
| 1913 | SSL_CTX *session_ctx; |
Robert Sloan | 47f43ed | 2017-02-06 14:55:15 -0800 | [diff] [blame] | 1914 | |
| 1915 | /* srtp_profiles is the list of configured SRTP protection profiles for |
| 1916 | * DTLS-SRTP. */ |
| 1917 | STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles; |
| 1918 | |
| 1919 | /* srtp_profile is the selected SRTP protection profile for |
| 1920 | * DTLS-SRTP. */ |
| 1921 | const SRTP_PROTECTION_PROFILE *srtp_profile; |
| 1922 | |
| 1923 | /* The client's Channel ID private key. */ |
| 1924 | EVP_PKEY *tlsext_channel_id_private; |
| 1925 | |
| 1926 | /* For a client, this contains the list of supported protocols in wire |
| 1927 | * format. */ |
| 1928 | uint8_t *alpn_client_proto_list; |
| 1929 | unsigned alpn_client_proto_list_len; |
| 1930 | |
| 1931 | /* renegotiate_mode controls how peer renegotiation attempts are handled. */ |
| 1932 | enum ssl_renegotiate_mode_t renegotiate_mode; |
| 1933 | |
| 1934 | /* verify_mode is a bitmask of |SSL_VERIFY_*| values. */ |
| 1935 | uint8_t verify_mode; |
| 1936 | |
| 1937 | /* server is true iff the this SSL* is the server half. Note: before the SSL* |
| 1938 | * is initialized by either SSL_set_accept_state or SSL_set_connect_state, |
| 1939 | * the side is not determined. In this state, server is always false. */ |
| 1940 | unsigned server:1; |
| 1941 | |
| 1942 | /* quiet_shutdown is true if the connection should not send a close_notify on |
| 1943 | * shutdown. */ |
| 1944 | unsigned quiet_shutdown:1; |
| 1945 | |
| 1946 | /* Enable signed certificate time stamps. Currently client only. */ |
| 1947 | unsigned signed_cert_timestamps_enabled:1; |
| 1948 | |
| 1949 | /* ocsp_stapling_enabled is only used by client connections and indicates |
| 1950 | * whether OCSP stapling will be requested. */ |
| 1951 | unsigned ocsp_stapling_enabled:1; |
| 1952 | |
| 1953 | /* tlsext_channel_id_enabled is copied from the |SSL_CTX|. For a server, |
| 1954 | * means that we'll accept Channel IDs from clients. For a client, means that |
| 1955 | * we'll advertise support. */ |
| 1956 | unsigned tlsext_channel_id_enabled:1; |
| 1957 | |
| 1958 | /* retain_only_sha256_of_client_certs is true if we should compute the SHA256 |
| 1959 | * hash of the peer's certificate and then discard it to save memory and |
| 1960 | * session space. Only effective on the server side. */ |
| 1961 | unsigned retain_only_sha256_of_client_certs:1; |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 1962 | |
| 1963 | /* early_data_accepted is true if early data was accepted by the server. */ |
| 1964 | unsigned early_data_accepted:1; |
Robert Sloan | 47f43ed | 2017-02-06 14:55:15 -0800 | [diff] [blame] | 1965 | }; |
| 1966 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 1967 | /* From draft-ietf-tls-tls13-18, used in determining PSK modes. */ |
| 1968 | #define SSL_PSK_KE 0x0 |
| 1969 | #define SSL_PSK_DHE_KE 0x1 |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1970 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 1971 | /* From draft-ietf-tls-tls13-16, used in determining whether to respond with a |
| 1972 | * KeyUpdate. */ |
| 1973 | #define SSL_KEY_UPDATE_NOT_REQUESTED 0 |
| 1974 | #define SSL_KEY_UPDATE_REQUESTED 1 |
| 1975 | |
Robert Sloan | 9254e68 | 2017-04-24 09:42:06 -0700 | [diff] [blame] | 1976 | /* kMaxEarlyDataAccepted is the advertised number of plaintext bytes of early |
| 1977 | * data that will be accepted. This value should be slightly below |
| 1978 | * kMaxEarlyDataSkipped in tls_record.c, which is measured in ciphertext. */ |
| 1979 | static const size_t kMaxEarlyDataAccepted = 14336; |
| 1980 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1981 | CERT *ssl_cert_new(const SSL_X509_METHOD *x509_method); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1982 | CERT *ssl_cert_dup(CERT *cert); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 1983 | void ssl_cert_clear_certs(CERT *c); |
| 1984 | void ssl_cert_free(CERT *c); |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1985 | int ssl_set_cert(CERT *cert, CRYPTO_BUFFER *buffer); |
| 1986 | int ssl_is_key_type_supported(int key_type); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 1987 | /* ssl_compare_public_and_private_key returns one if |pubkey| is the public |
| 1988 | * counterpart to |privkey|. Otherwise it returns zero and pushes a helpful |
| 1989 | * message on the error queue. */ |
| 1990 | int ssl_compare_public_and_private_key(const EVP_PKEY *pubkey, |
| 1991 | const EVP_PKEY *privkey); |
| 1992 | int ssl_cert_check_private_key(const CERT *cert, const EVP_PKEY *privkey); |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 1993 | int ssl_get_new_session(SSL_HANDSHAKE *hs, int is_server); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 1994 | int ssl_encrypt_ticket(SSL *ssl, CBB *out, const SSL_SESSION *session); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 1995 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 1996 | /* ssl_session_new returns a newly-allocated blank |SSL_SESSION| or NULL on |
| 1997 | * error. */ |
| 1998 | SSL_SESSION *ssl_session_new(const SSL_X509_METHOD *x509_method); |
| 1999 | |
| 2000 | /* SSL_SESSION_parse parses an |SSL_SESSION| from |cbs| and advances |cbs| over |
| 2001 | * the parsed data. */ |
| 2002 | SSL_SESSION *SSL_SESSION_parse(CBS *cbs, const SSL_X509_METHOD *x509_method, |
| 2003 | CRYPTO_BUFFER_POOL *pool); |
| 2004 | |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2005 | /* ssl_session_is_context_valid returns one if |session|'s session ID context |
| 2006 | * matches the one set on |ssl| and zero otherwise. */ |
| 2007 | int ssl_session_is_context_valid(const SSL *ssl, const SSL_SESSION *session); |
| 2008 | |
| 2009 | /* ssl_session_is_time_valid returns one if |session| is still valid and zero if |
| 2010 | * it has expired. */ |
| 2011 | int ssl_session_is_time_valid(const SSL *ssl, const SSL_SESSION *session); |
| 2012 | |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 2013 | /* ssl_session_is_resumable returns one if |session| is resumable for |hs| and |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2014 | * zero otherwise. */ |
Robert Sloan | a94fe05 | 2017-02-21 08:49:28 -0800 | [diff] [blame] | 2015 | int ssl_session_is_resumable(const SSL_HANDSHAKE *hs, |
| 2016 | const SSL_SESSION *session); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2017 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2018 | /* SSL_SESSION_get_digest returns the digest used in |session|. If the digest is |
| 2019 | * invalid, it returns NULL. */ |
| 2020 | const EVP_MD *SSL_SESSION_get_digest(const SSL_SESSION *session, |
| 2021 | const SSL *ssl); |
| 2022 | |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2023 | void ssl_set_session(SSL *ssl, SSL_SESSION *session); |
| 2024 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2025 | enum ssl_session_result_t { |
| 2026 | ssl_session_success, |
| 2027 | ssl_session_error, |
| 2028 | ssl_session_retry, |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 2029 | ssl_session_ticket_retry, |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2030 | }; |
| 2031 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2032 | /* ssl_get_prev_session looks up the previous session based on |client_hello|. |
| 2033 | * On success, it sets |*out_session| to the session or NULL if none was found. |
| 2034 | * If the session could not be looked up synchronously, it returns |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 2035 | * |ssl_session_retry| and should be called again. If a ticket could not be |
| 2036 | * decrypted immediately it returns |ssl_session_ticket_retry| and should also |
| 2037 | * be called again. Otherwise, it returns |ssl_session_error|. */ |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2038 | enum ssl_session_result_t ssl_get_prev_session( |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2039 | SSL *ssl, SSL_SESSION **out_session, int *out_tickets_supported, |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2040 | int *out_renew_ticket, const SSL_CLIENT_HELLO *client_hello); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2041 | |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2042 | /* The following flags determine which parts of the session are duplicated. */ |
| 2043 | #define SSL_SESSION_DUP_AUTH_ONLY 0x0 |
| 2044 | #define SSL_SESSION_INCLUDE_TICKET 0x1 |
| 2045 | #define SSL_SESSION_INCLUDE_NONAUTH 0x2 |
| 2046 | #define SSL_SESSION_DUP_ALL \ |
| 2047 | (SSL_SESSION_INCLUDE_TICKET | SSL_SESSION_INCLUDE_NONAUTH) |
| 2048 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2049 | /* SSL_SESSION_dup returns a newly-allocated |SSL_SESSION| with a copy of the |
| 2050 | * fields in |session| or NULL on error. The new session is non-resumable and |
| 2051 | * must be explicitly marked resumable once it has been filled in. */ |
| 2052 | OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_dup(SSL_SESSION *session, |
David Benjamin | f0c4a6c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2053 | int dup_flags); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2054 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2055 | /* ssl_session_rebase_time updates |session|'s start time to the current time, |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2056 | * adjusting the timeout so the expiration time is unchanged. */ |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2057 | void ssl_session_rebase_time(SSL *ssl, SSL_SESSION *session); |
| 2058 | |
| 2059 | /* ssl_session_renew_timeout calls |ssl_session_rebase_time| and renews |
| 2060 | * |session|'s timeout to |timeout| (measured from the current time). The |
| 2061 | * renewal is clamped to the session's auth_timeout. */ |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 2062 | void ssl_session_renew_timeout(SSL *ssl, SSL_SESSION *session, |
| 2063 | uint32_t timeout); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2064 | |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2065 | void ssl_cipher_preference_list_free( |
| 2066 | struct ssl_cipher_preference_list_st *cipher_list); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2067 | |
| 2068 | /* ssl_get_cipher_preferences returns the cipher preference list for TLS 1.2 and |
| 2069 | * below. */ |
| 2070 | const struct ssl_cipher_preference_list_st *ssl_get_cipher_preferences( |
| 2071 | const SSL *ssl); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2072 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2073 | void ssl_update_cache(SSL_HANDSHAKE *hs, int mode); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2074 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2075 | int ssl3_get_finished(SSL_HANDSHAKE *hs); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2076 | int ssl3_send_alert(SSL *ssl, int level, int desc); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2077 | int ssl3_get_message(SSL *ssl); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2078 | void ssl3_get_current_message(const SSL *ssl, CBS *out); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2079 | void ssl3_release_current_message(SSL *ssl, int free_buffer); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2080 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2081 | int ssl3_send_finished(SSL_HANDSHAKE *hs); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2082 | int ssl3_dispatch_alert(SSL *ssl); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2083 | int ssl3_read_app_data(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len, |
| 2084 | int peek); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2085 | int ssl3_read_change_cipher_spec(SSL *ssl); |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 2086 | void ssl3_read_close_notify(SSL *ssl); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2087 | int ssl3_read_handshake_bytes(SSL *ssl, uint8_t *buf, int len); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2088 | int ssl3_write_app_data(SSL *ssl, const uint8_t *buf, int len); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2089 | int ssl3_output_cert_chain(SSL *ssl); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2090 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2091 | int ssl3_new(SSL *ssl); |
| 2092 | void ssl3_free(SSL *ssl); |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2093 | int ssl3_accept(SSL_HANDSHAKE *hs); |
| 2094 | int ssl3_connect(SSL_HANDSHAKE *hs); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2095 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2096 | int ssl3_init_message(SSL *ssl, CBB *cbb, CBB *body, uint8_t type); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2097 | int ssl3_finish_message(SSL *ssl, CBB *cbb, uint8_t **out_msg, size_t *out_len); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2098 | int ssl3_add_message(SSL *ssl, uint8_t *msg, size_t len); |
| 2099 | int ssl3_add_change_cipher_spec(SSL *ssl); |
| 2100 | int ssl3_add_alert(SSL *ssl, uint8_t level, uint8_t desc); |
| 2101 | int ssl3_flush_flight(SSL *ssl); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2102 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2103 | int dtls1_init_message(SSL *ssl, CBB *cbb, CBB *body, uint8_t type); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2104 | int dtls1_finish_message(SSL *ssl, CBB *cbb, uint8_t **out_msg, |
| 2105 | size_t *out_len); |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2106 | int dtls1_add_message(SSL *ssl, uint8_t *msg, size_t len); |
| 2107 | int dtls1_add_change_cipher_spec(SSL *ssl); |
| 2108 | int dtls1_add_alert(SSL *ssl, uint8_t level, uint8_t desc); |
| 2109 | int dtls1_flush_flight(SSL *ssl); |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 2110 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2111 | /* ssl_add_message_cbb finishes the handshake message in |cbb| and adds it to |
| 2112 | * the pending flight. It returns one on success and zero on error. */ |
| 2113 | int ssl_add_message_cbb(SSL *ssl, CBB *cbb); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2114 | |
| 2115 | /* ssl_hash_current_message incorporates the current handshake message into the |
| 2116 | * handshake hash. It returns one on success and zero on allocation failure. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2117 | int ssl_hash_current_message(SSL_HANDSHAKE *hs); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2118 | |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 2119 | /* dtls1_get_record reads a new input record. On success, it places it in |
| 2120 | * |ssl->s3->rrec| and returns one. Otherwise it returns <= 0 on error or if |
| 2121 | * more data is needed. */ |
| 2122 | int dtls1_get_record(SSL *ssl); |
| 2123 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2124 | int dtls1_read_app_data(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len, |
| 2125 | int peek); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2126 | int dtls1_read_change_cipher_spec(SSL *ssl); |
Adam Langley | f4e4272 | 2015-06-04 17:45:09 -0700 | [diff] [blame] | 2127 | void dtls1_read_close_notify(SSL *ssl); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2128 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2129 | int dtls1_write_app_data(SSL *ssl, const uint8_t *buf, int len); |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 2130 | |
| 2131 | /* dtls1_write_record sends a record. It returns one on success and <= 0 on |
| 2132 | * error. */ |
| 2133 | int dtls1_write_record(SSL *ssl, int type, const uint8_t *buf, size_t len, |
| 2134 | enum dtls1_use_epoch_t use_epoch); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2135 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2136 | int dtls1_send_finished(SSL *ssl, int a, int b, const char *sender, int slen); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2137 | int dtls1_retransmit_outgoing_messages(SSL *ssl); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2138 | void dtls1_clear_record_buffer(SSL *ssl); |
David Benjamin | 6e899c7 | 2016-06-09 18:02:18 -0400 | [diff] [blame] | 2139 | int dtls1_parse_fragment(CBS *cbs, struct hm_header_st *out_hdr, |
| 2140 | CBS *out_body); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2141 | int dtls1_check_timeout_num(SSL *ssl); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2142 | int dtls1_handshake_write(SSL *ssl); |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 2143 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2144 | void dtls1_start_timer(SSL *ssl); |
| 2145 | void dtls1_stop_timer(SSL *ssl); |
| 2146 | int dtls1_is_timer_expired(SSL *ssl); |
| 2147 | void dtls1_double_timeout(SSL *ssl); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2148 | unsigned int dtls1_min_mtu(void); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2149 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2150 | int dtls1_new(SSL *ssl); |
| 2151 | int dtls1_accept(SSL *ssl); |
| 2152 | int dtls1_connect(SSL *ssl); |
| 2153 | void dtls1_free(SSL *ssl); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2154 | |
Robert Sloan | 4d1ac50 | 2017-02-06 08:36:14 -0800 | [diff] [blame] | 2155 | int dtls1_get_message(SSL *ssl); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2156 | void dtls1_get_current_message(const SSL *ssl, CBS *out); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2157 | void dtls1_release_current_message(SSL *ssl, int free_buffer); |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2158 | int dtls1_dispatch_alert(SSL *ssl); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2159 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2160 | int tls1_change_cipher_state(SSL_HANDSHAKE *hs, int which); |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2161 | int tls1_generate_master_secret(SSL_HANDSHAKE *hs, uint8_t *out, |
| 2162 | const uint8_t *premaster, size_t premaster_len); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2163 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2164 | /* tls1_get_grouplist sets |*out_group_ids| and |*out_group_ids_len| to the |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 2165 | * locally-configured group preference list. */ |
| 2166 | void tls1_get_grouplist(SSL *ssl, const uint16_t **out_group_ids, |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2167 | size_t *out_group_ids_len); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2168 | |
David Benjamin | 95add82 | 2016-10-19 01:09:12 -0400 | [diff] [blame] | 2169 | /* tls1_check_group_id returns one if |group_id| is consistent with |
| 2170 | * locally-configured group preferences. */ |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 2171 | int tls1_check_group_id(SSL *ssl, uint16_t group_id); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2172 | |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 2173 | /* tls1_get_shared_group sets |*out_group_id| to the first preferred shared |
| 2174 | * group between client and server preferences and returns one. If none may be |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2175 | * found, it returns zero. */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2176 | int tls1_get_shared_group(SSL_HANDSHAKE *hs, uint16_t *out_group_id); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2177 | |
| 2178 | /* tls1_set_curves converts the array of |ncurves| NIDs pointed to by |curves| |
David Benjamin | d316cba | 2016-06-02 16:17:39 -0400 | [diff] [blame] | 2179 | * into a newly allocated array of TLS group IDs. On success, the function |
| 2180 | * returns one and writes the array to |*out_group_ids| and its size to |
| 2181 | * |*out_group_ids_len|. Otherwise, it returns zero. */ |
| 2182 | int tls1_set_curves(uint16_t **out_group_ids, size_t *out_group_ids_len, |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2183 | const int *curves, size_t ncurves); |
| 2184 | |
Steven Valdez | bb1ceac | 2016-10-07 10:34:51 -0400 | [diff] [blame] | 2185 | /* tls1_set_curves_list converts the string of curves pointed to by |curves| |
| 2186 | * into a newly allocated array of TLS group IDs. On success, the function |
| 2187 | * returns one and writes the array to |*out_group_ids| and its size to |
| 2188 | * |*out_group_ids_len|. Otherwise, it returns zero. */ |
| 2189 | int tls1_set_curves_list(uint16_t **out_group_ids, size_t *out_group_ids_len, |
| 2190 | const char *curves); |
| 2191 | |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 2192 | /* ssl_add_clienthello_tlsext writes ClientHello extensions to |out|. It |
| 2193 | * returns one on success and zero on failure. The |header_len| argument is the |
| 2194 | * length of the ClientHello written so far and is used to compute the padding |
| 2195 | * length. (It does not include the record header.) */ |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2196 | int ssl_add_clienthello_tlsext(SSL_HANDSHAKE *hs, CBB *out, size_t header_len); |
Kenny Root | e99801b | 2015-11-06 15:31:15 -0800 | [diff] [blame] | 2197 | |
David Benjamin | 1b24967 | 2016-12-06 18:25:50 -0500 | [diff] [blame] | 2198 | int ssl_add_serverhello_tlsext(SSL_HANDSHAKE *hs, CBB *out); |
| 2199 | int ssl_parse_clienthello_tlsext(SSL_HANDSHAKE *hs, |
| 2200 | const SSL_CLIENT_HELLO *client_hello); |
| 2201 | int ssl_parse_serverhello_tlsext(SSL_HANDSHAKE *hs, CBS *cbs); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2202 | |
| 2203 | #define tlsext_tick_md EVP_sha256 |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2204 | |
Robert Sloan | 1c9db53 | 2017-03-13 08:03:59 -0700 | [diff] [blame] | 2205 | /* ssl_process_ticket processes a session ticket from the client. It returns |
| 2206 | * one of: |
| 2207 | * |ssl_ticket_aead_success|: |*out_session| is set to the parsed session and |
| 2208 | * |*out_renew_ticket| is set to whether the ticket should be renewed. |
| 2209 | * |ssl_ticket_aead_ignore_ticket|: |*out_renew_ticket| is set to whether a |
| 2210 | * fresh ticket should be sent, but the given ticket cannot be used. |
| 2211 | * |ssl_ticket_aead_retry|: the ticket could not be immediately decrypted. |
| 2212 | * Retry later. |
| 2213 | * |ssl_ticket_aead_error|: an error occured that is fatal to the connection. */ |
| 2214 | enum ssl_ticket_aead_result_t ssl_process_ticket( |
| 2215 | SSL *ssl, SSL_SESSION **out_session, int *out_renew_ticket, |
| 2216 | const uint8_t *ticket, size_t ticket_len, const uint8_t *session_id, |
| 2217 | size_t session_id_len); |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2218 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2219 | /* tls1_verify_channel_id processes the current message as a Channel ID message, |
| 2220 | * and verifies the signature. If the key is valid, it saves the Channel ID and |
| 2221 | * returns one. Otherwise, it returns zero. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2222 | int tls1_verify_channel_id(SSL_HANDSHAKE *hs); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2223 | |
| 2224 | /* tls1_write_channel_id generates a Channel ID message and puts the output in |
| 2225 | * |cbb|. |ssl->tlsext_channel_id_private| must already be set before calling. |
| 2226 | * This function returns one on success and zero on error. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2227 | int tls1_write_channel_id(SSL_HANDSHAKE *hs, CBB *cbb); |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2228 | |
Kenny Root | b849459 | 2015-09-25 02:29:14 +0000 | [diff] [blame] | 2229 | /* tls1_channel_id_hash computes the hash to be signed by Channel ID and writes |
| 2230 | * it to |out|, which must contain at least |EVP_MAX_MD_SIZE| bytes. It returns |
| 2231 | * one on success and zero on failure. */ |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2232 | int tls1_channel_id_hash(SSL_HANDSHAKE *hs, uint8_t *out, size_t *out_len); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2233 | |
Robert Sloan | 5d62578 | 2017-02-13 09:55:39 -0800 | [diff] [blame] | 2234 | int tls1_record_handshake_hashes_for_channel_id(SSL_HANDSHAKE *hs); |
Kenny Root | a04d78d | 2015-09-25 00:26:37 +0000 | [diff] [blame] | 2235 | |
Steven Valdez | 909b19f | 2016-11-21 15:35:44 -0500 | [diff] [blame] | 2236 | /* ssl_do_channel_id_callback checks runs |ssl->ctx->channel_id_cb| if |
| 2237 | * necessary. It returns one on success and zero on fatal error. Note that, on |
| 2238 | * success, |ssl->tlsext_channel_id_private| may be unset, in which case the |
| 2239 | * operation should be retried later. */ |
| 2240 | int ssl_do_channel_id_callback(SSL *ssl); |
| 2241 | |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2242 | /* ssl3_can_false_start returns one if |ssl| is allowed to False Start and zero |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 2243 | * otherwise. */ |
Adam Langley | 4139edb | 2016-01-13 15:00:54 -0800 | [diff] [blame] | 2244 | int ssl3_can_false_start(const SSL *ssl); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2245 | |
Robert Sloan | 6d0d00e | 2017-03-27 07:13:07 -0700 | [diff] [blame] | 2246 | /* ssl_can_write returns one if |ssl| is allowed to write and zero otherwise. */ |
| 2247 | int ssl_can_write(const SSL *ssl); |
| 2248 | |
| 2249 | /* ssl_can_read returns one if |ssl| is allowed to read and zero otherwise. */ |
| 2250 | int ssl_can_read(const SSL *ssl); |
| 2251 | |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2252 | /* ssl_get_version_range sets |*out_min_version| and |*out_max_version| to the |
| 2253 | * minimum and maximum enabled protocol versions, respectively. */ |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2254 | int ssl_get_version_range(const SSL *ssl, uint16_t *out_min_version, |
David Benjamin | 7c0d06c | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2255 | uint16_t *out_max_version); |
Adam Langley | d9e397b | 2015-01-22 14:27:53 -0800 | [diff] [blame] | 2256 | |
David Benjamin | 4969cc9 | 2016-04-22 15:02:23 -0400 | [diff] [blame] | 2257 | /* ssl3_protocol_version returns |ssl|'s protocol version. It is an error to |
| 2258 | * call this function before the version is determined. */ |
| 2259 | uint16_t ssl3_protocol_version(const SSL *ssl); |
| 2260 | |
Robert Sloan | 7d422bc | 2017-03-06 10:04:29 -0800 | [diff] [blame] | 2261 | void ssl_get_current_time(const SSL *ssl, struct OPENSSL_timeval *out_clock); |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2262 | |
Robert Sloan | 69939df | 2017-01-09 10:53:07 -0800 | [diff] [blame] | 2263 | /* ssl_reset_error_state resets state for |SSL_get_error|. */ |
| 2264 | void ssl_reset_error_state(SSL *ssl); |
| 2265 | |
David Benjamin | c895d6b | 2016-08-11 13:26:41 -0400 | [diff] [blame] | 2266 | |
| 2267 | #if defined(__cplusplus) |
| 2268 | } /* extern C */ |
| 2269 | #endif |
| 2270 | |
Adam Langley | e9ada86 | 2015-05-11 17:20:37 -0700 | [diff] [blame] | 2271 | #endif /* OPENSSL_HEADER_SSL_INTERNAL_H */ |