Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [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 | |
David Benjamin | 2ee94aa | 2015-04-07 22:38:30 -0400 | [diff] [blame] | 142 | #ifndef OPENSSL_HEADER_SSL_INTERNAL_H |
| 143 | #define OPENSSL_HEADER_SSL_INTERNAL_H |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 144 | |
| 145 | #include <openssl/base.h> |
| 146 | |
Adam Langley | c9fb375 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 147 | #include <openssl/aead.h> |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 148 | #include <openssl/ssl.h> |
| 149 | #include <openssl/stack.h> |
| 150 | |
Steven Valdez | cb96654 | 2016-08-17 16:56:14 -0400 | [diff] [blame] | 151 | |
David Benjamin | 4d2e7ce | 2015-05-08 13:29:45 -0400 | [diff] [blame] | 152 | #if defined(OPENSSL_WINDOWS) |
| 153 | /* Windows defines struct timeval in winsock2.h. */ |
David Benjamin | a353cdb | 2016-06-09 16:48:33 -0400 | [diff] [blame] | 154 | OPENSSL_MSVC_PRAGMA(warning(push, 3)) |
David Benjamin | 4d2e7ce | 2015-05-08 13:29:45 -0400 | [diff] [blame] | 155 | #include <winsock2.h> |
David Benjamin | a353cdb | 2016-06-09 16:48:33 -0400 | [diff] [blame] | 156 | OPENSSL_MSVC_PRAGMA(warning(pop)) |
David Benjamin | 4d2e7ce | 2015-05-08 13:29:45 -0400 | [diff] [blame] | 157 | #else |
David Benjamin | 0abd6f2 | 2015-12-04 21:49:53 -0500 | [diff] [blame] | 158 | #include <sys/time.h> |
David Benjamin | 4d2e7ce | 2015-05-08 13:29:45 -0400 | [diff] [blame] | 159 | #endif |
| 160 | |
Steven Valdez | 87eab49 | 2016-06-27 16:34:59 -0400 | [diff] [blame] | 161 | #if defined(__cplusplus) |
| 162 | extern "C" { |
| 163 | #endif |
| 164 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 165 | |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 166 | /* Cipher suites. */ |
| 167 | |
| 168 | /* Bits for |algorithm_mkey| (key exchange algorithm). */ |
| 169 | #define SSL_kRSA 0x00000001L |
| 170 | #define SSL_kDHE 0x00000002L |
| 171 | #define SSL_kECDHE 0x00000004L |
| 172 | /* SSL_kPSK is only set for plain PSK, not ECDHE_PSK. */ |
| 173 | #define SSL_kPSK 0x00000008L |
Matt Braithwaite | 053931e | 2016-05-25 12:06:05 -0700 | [diff] [blame] | 174 | #define SSL_kCECPQ1 0x00000010L |
Steven Valdez | 803c77a | 2016-09-06 14:13:43 -0400 | [diff] [blame] | 175 | #define SSL_kGENERIC 0x00000020L |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 176 | |
| 177 | /* Bits for |algorithm_auth| (server authentication). */ |
| 178 | #define SSL_aRSA 0x00000001L |
| 179 | #define SSL_aECDSA 0x00000002L |
| 180 | /* SSL_aPSK is set for both PSK and ECDHE_PSK. */ |
| 181 | #define SSL_aPSK 0x00000004L |
Steven Valdez | 803c77a | 2016-09-06 14:13:43 -0400 | [diff] [blame] | 182 | #define SSL_aGENERIC 0x00000008L |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 183 | |
David Benjamin | c032dfa | 2016-05-12 14:54:57 -0400 | [diff] [blame] | 184 | #define SSL_aCERT (SSL_aRSA | SSL_aECDSA) |
| 185 | |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 186 | /* Bits for |algorithm_enc| (symmetric encryption). */ |
Matthew Braithwaite | 8aaa9e1 | 2016-09-07 15:09:58 -0700 | [diff] [blame] | 187 | #define SSL_3DES 0x00000001L |
| 188 | #define SSL_AES128 0x00000002L |
| 189 | #define SSL_AES256 0x00000004L |
| 190 | #define SSL_AES128GCM 0x00000008L |
| 191 | #define SSL_AES256GCM 0x00000010L |
| 192 | #define SSL_CHACHA20POLY1305_OLD 0x00000020L |
| 193 | #define SSL_eNULL 0x00000040L |
| 194 | #define SSL_CHACHA20POLY1305 0x00000080L |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 195 | |
| 196 | #define SSL_AES (SSL_AES128 | SSL_AES256 | SSL_AES128GCM | SSL_AES256GCM) |
| 197 | |
| 198 | /* Bits for |algorithm_mac| (symmetric authentication). */ |
| 199 | #define SSL_MD5 0x00000001L |
| 200 | #define SSL_SHA1 0x00000002L |
| 201 | #define SSL_SHA256 0x00000004L |
| 202 | #define SSL_SHA384 0x00000008L |
| 203 | /* SSL_AEAD is set for all AEADs. */ |
| 204 | #define SSL_AEAD 0x00000010L |
| 205 | |
David Benjamin | 5055c76 | 2015-08-04 09:24:14 -0400 | [diff] [blame] | 206 | /* Bits for |algorithm_prf| (handshake digest). */ |
David Benjamin | b088331 | 2015-08-06 09:54:13 -0400 | [diff] [blame] | 207 | #define SSL_HANDSHAKE_MAC_DEFAULT 0x1 |
| 208 | #define SSL_HANDSHAKE_MAC_SHA256 0x2 |
| 209 | #define SSL_HANDSHAKE_MAC_SHA384 0x4 |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 210 | |
| 211 | /* SSL_MAX_DIGEST is the number of digest types which exist. When adding a new |
| 212 | * one, update the table in ssl_cipher.c. */ |
| 213 | #define SSL_MAX_DIGEST 4 |
| 214 | |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 215 | /* ssl_cipher_get_evp_aead sets |*out_aead| to point to the correct EVP_AEAD |
| 216 | * object for |cipher| protocol version |version|. It sets |*out_mac_secret_len| |
| 217 | * and |*out_fixed_iv_len| to the MAC key length and fixed IV length, |
| 218 | * respectively. The MAC key length is zero except for legacy block and stream |
| 219 | * ciphers. It returns 1 on success and 0 on error. */ |
| 220 | int ssl_cipher_get_evp_aead(const EVP_AEAD **out_aead, |
| 221 | size_t *out_mac_secret_len, |
| 222 | size_t *out_fixed_iv_len, |
| 223 | const SSL_CIPHER *cipher, uint16_t version); |
| 224 | |
David Benjamin | b088331 | 2015-08-06 09:54:13 -0400 | [diff] [blame] | 225 | /* ssl_get_handshake_digest returns the |EVP_MD| corresponding to |
| 226 | * |algorithm_prf|. It returns SHA-1 for |SSL_HANDSHAKE_DEFAULT|. The caller is |
| 227 | * responsible for maintaining the additional MD5 digest and switching to |
| 228 | * SHA-256 in TLS 1.2. */ |
| 229 | const EVP_MD *ssl_get_handshake_digest(uint32_t algorithm_prf); |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 230 | |
| 231 | /* ssl_create_cipher_list evaluates |rule_str| according to the ciphers in |
| 232 | * |ssl_method|. It sets |*out_cipher_list| to a newly-allocated |
| 233 | * |ssl_cipher_preference_list_st| containing the result. |
| 234 | * |*out_cipher_list_by_id| is set to a list of selected ciphers sorted by |
| 235 | * id. It returns |(*out_cipher_list)->ciphers| on success and NULL on |
| 236 | * failure. */ |
| 237 | STACK_OF(SSL_CIPHER) * |
| 238 | ssl_create_cipher_list(const SSL_PROTOCOL_METHOD *ssl_method, |
| 239 | struct ssl_cipher_preference_list_st **out_cipher_list, |
| 240 | STACK_OF(SSL_CIPHER) **out_cipher_list_by_id, |
| 241 | const char *rule_str); |
| 242 | |
David Benjamin | a1c90a5 | 2015-05-30 17:03:14 -0400 | [diff] [blame] | 243 | /* ssl_cipher_get_value returns the cipher suite id of |cipher|. */ |
| 244 | uint16_t ssl_cipher_get_value(const SSL_CIPHER *cipher); |
| 245 | |
David Benjamin | d1d8078 | 2015-07-05 11:54:09 -0400 | [diff] [blame] | 246 | /* ssl_cipher_get_key_type returns the |EVP_PKEY_*| value corresponding to the |
| 247 | * server key used in |cipher| or |EVP_PKEY_NONE| if there is none. */ |
| 248 | int ssl_cipher_get_key_type(const SSL_CIPHER *cipher); |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 249 | |
David Benjamin | c032dfa | 2016-05-12 14:54:57 -0400 | [diff] [blame] | 250 | /* ssl_cipher_uses_certificate_auth returns one if |cipher| authenticates the |
| 251 | * server and, optionally, the client with a certificate. Otherwise it returns |
| 252 | * zero. */ |
| 253 | int ssl_cipher_uses_certificate_auth(const SSL_CIPHER *cipher); |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 254 | |
| 255 | /* ssl_cipher_requires_server_key_exchange returns 1 if |cipher| requires a |
| 256 | * ServerKeyExchange message. Otherwise it returns 0. |
| 257 | * |
David Benjamin | c032dfa | 2016-05-12 14:54:57 -0400 | [diff] [blame] | 258 | * This function may return zero while still allowing |cipher| an optional |
| 259 | * ServerKeyExchange. This is the case for plain PSK ciphers. */ |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 260 | int ssl_cipher_requires_server_key_exchange(const SSL_CIPHER *cipher); |
| 261 | |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 262 | /* ssl_cipher_get_record_split_len, for TLS 1.0 CBC mode ciphers, returns the |
| 263 | * length of an encrypted 1-byte record, for use in record-splitting. Otherwise |
| 264 | * it returns zero. */ |
| 265 | size_t ssl_cipher_get_record_split_len(const SSL_CIPHER *cipher); |
| 266 | |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 267 | |
David Benjamin | 31a0779 | 2015-03-03 14:20:26 -0500 | [diff] [blame] | 268 | /* Encryption layer. */ |
| 269 | |
| 270 | /* SSL_AEAD_CTX contains information about an AEAD that is being used to encrypt |
| 271 | * an SSL connection. */ |
| 272 | struct ssl_aead_ctx_st { |
| 273 | const SSL_CIPHER *cipher; |
| 274 | EVP_AEAD_CTX ctx; |
| 275 | /* fixed_nonce contains any bytes of the nonce that are fixed for all |
| 276 | * records. */ |
David Benjamin | 13414b3 | 2015-12-09 23:02:39 -0500 | [diff] [blame] | 277 | uint8_t fixed_nonce[12]; |
David Benjamin | 31a0779 | 2015-03-03 14:20:26 -0500 | [diff] [blame] | 278 | uint8_t fixed_nonce_len, variable_nonce_len; |
| 279 | /* variable_nonce_included_in_record is non-zero if the variable nonce |
| 280 | * for a record is included as a prefix before the ciphertext. */ |
| 281 | char variable_nonce_included_in_record; |
| 282 | /* random_variable_nonce is non-zero if the variable nonce is |
| 283 | * randomly generated, rather than derived from the sequence |
| 284 | * number. */ |
| 285 | char random_variable_nonce; |
| 286 | /* omit_length_in_ad is non-zero if the length should be omitted in the |
| 287 | * AEAD's ad parameter. */ |
| 288 | char omit_length_in_ad; |
| 289 | /* omit_version_in_ad is non-zero if the version should be omitted |
| 290 | * in the AEAD's ad parameter. */ |
| 291 | char omit_version_in_ad; |
Steven Valdez | 494650c | 2016-05-24 12:43:04 -0400 | [diff] [blame] | 292 | /* omit_ad is non-zero if the AEAD's ad parameter should be omitted. */ |
| 293 | char omit_ad; |
David Benjamin | 13414b3 | 2015-12-09 23:02:39 -0500 | [diff] [blame] | 294 | /* xor_fixed_nonce is non-zero if the fixed nonce should be XOR'd into the |
| 295 | * variable nonce rather than prepended. */ |
| 296 | char xor_fixed_nonce; |
David Benjamin | 31a0779 | 2015-03-03 14:20:26 -0500 | [diff] [blame] | 297 | } /* SSL_AEAD_CTX */; |
| 298 | |
| 299 | /* SSL_AEAD_CTX_new creates a newly-allocated |SSL_AEAD_CTX| using the supplied |
| 300 | * key material. It returns NULL on error. Only one of |SSL_AEAD_CTX_open| or |
| 301 | * |SSL_AEAD_CTX_seal| may be used with the resulting object, depending on |
| 302 | * |direction|. |version| is the normalized protocol version, so DTLS 1.0 is |
| 303 | * represented as 0x0301, not 0xffef. */ |
| 304 | SSL_AEAD_CTX *SSL_AEAD_CTX_new(enum evp_aead_direction_t direction, |
| 305 | uint16_t version, const SSL_CIPHER *cipher, |
| 306 | const uint8_t *enc_key, size_t enc_key_len, |
| 307 | const uint8_t *mac_key, size_t mac_key_len, |
| 308 | const uint8_t *fixed_iv, size_t fixed_iv_len); |
| 309 | |
| 310 | /* SSL_AEAD_CTX_free frees |ctx|. */ |
| 311 | void SSL_AEAD_CTX_free(SSL_AEAD_CTX *ctx); |
| 312 | |
| 313 | /* SSL_AEAD_CTX_explicit_nonce_len returns the length of the explicit nonce for |
| 314 | * |ctx|, if any. |ctx| may be NULL to denote the null cipher. */ |
| 315 | size_t SSL_AEAD_CTX_explicit_nonce_len(SSL_AEAD_CTX *ctx); |
| 316 | |
| 317 | /* SSL_AEAD_CTX_max_overhead returns the maximum overhead of calling |
| 318 | * |SSL_AEAD_CTX_seal|. |ctx| may be NULL to denote the null cipher. */ |
| 319 | size_t SSL_AEAD_CTX_max_overhead(SSL_AEAD_CTX *ctx); |
| 320 | |
David Benjamin | a7810c1 | 2016-06-06 18:54:51 -0400 | [diff] [blame] | 321 | /* SSL_AEAD_CTX_open authenticates and decrypts |in_len| bytes from |in| |
| 322 | * in-place. On success, it sets |*out| to the plaintext in |in| and returns |
| 323 | * one. Otherwise, it returns zero. |ctx| may be NULL to denote the null cipher. |
| 324 | * The output will always be |explicit_nonce_len| bytes ahead of |in|. */ |
| 325 | int SSL_AEAD_CTX_open(SSL_AEAD_CTX *ctx, CBS *out, uint8_t type, |
| 326 | uint16_t wire_version, const uint8_t seqnum[8], |
| 327 | uint8_t *in, size_t in_len); |
David Benjamin | 31a0779 | 2015-03-03 14:20:26 -0500 | [diff] [blame] | 328 | |
| 329 | /* SSL_AEAD_CTX_seal encrypts and authenticates |in_len| bytes from |in| and |
| 330 | * writes the result to |out|. It returns one on success and zero on |
| 331 | * error. |ctx| may be NULL to denote the null cipher. |
| 332 | * |
David Benjamin | 2446db0 | 2016-06-08 18:31:42 -0400 | [diff] [blame] | 333 | * If |in| and |out| alias then |out| + |explicit_nonce_len| must be == |in|. */ |
David Benjamin | 31a0779 | 2015-03-03 14:20:26 -0500 | [diff] [blame] | 334 | int SSL_AEAD_CTX_seal(SSL_AEAD_CTX *ctx, uint8_t *out, size_t *out_len, |
| 335 | size_t max_out, uint8_t type, uint16_t wire_version, |
| 336 | const uint8_t seqnum[8], const uint8_t *in, |
| 337 | size_t in_len); |
| 338 | |
| 339 | |
David Benjamin | 7446a3b | 2015-07-25 17:53:57 -0400 | [diff] [blame] | 340 | /* DTLS replay bitmap. */ |
| 341 | |
| 342 | /* DTLS1_BITMAP maintains a sliding window of 64 sequence numbers to detect |
| 343 | * replayed packets. It should be initialized by zeroing every field. */ |
| 344 | typedef struct dtls1_bitmap_st { |
| 345 | /* map is a bit mask of the last 64 sequence numbers. Bit |
| 346 | * |1<<i| corresponds to |max_seq_num - i|. */ |
| 347 | uint64_t map; |
| 348 | /* max_seq_num is the largest sequence number seen so far as a 64-bit |
| 349 | * integer. */ |
| 350 | uint64_t max_seq_num; |
| 351 | } DTLS1_BITMAP; |
| 352 | |
| 353 | |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 354 | /* Record layer. */ |
| 355 | |
David Benjamin | 1db2156 | 2015-12-25 15:11:39 -0500 | [diff] [blame] | 356 | /* ssl_record_sequence_update increments the sequence number in |seq|. It |
| 357 | * returns one on success and zero on wraparound. */ |
| 358 | int ssl_record_sequence_update(uint8_t *seq, size_t seq_len); |
| 359 | |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 360 | /* ssl_record_prefix_len returns the length of the prefix before the ciphertext |
| 361 | * of a record for |ssl|. |
| 362 | * |
| 363 | * TODO(davidben): Expose this as part of public API once the high-level |
| 364 | * buffer-free APIs are available. */ |
| 365 | size_t ssl_record_prefix_len(const SSL *ssl); |
| 366 | |
| 367 | enum ssl_open_record_t { |
| 368 | ssl_open_record_success, |
| 369 | ssl_open_record_discard, |
| 370 | ssl_open_record_partial, |
David Benjamin | 728f354 | 2016-06-02 15:42:01 -0400 | [diff] [blame] | 371 | ssl_open_record_close_notify, |
| 372 | ssl_open_record_fatal_alert, |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 373 | ssl_open_record_error, |
| 374 | }; |
| 375 | |
David Benjamin | a7810c1 | 2016-06-06 18:54:51 -0400 | [diff] [blame] | 376 | /* tls_open_record decrypts a record from |in| in-place. |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 377 | * |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 378 | * If the input did not contain a complete record, it returns |
| 379 | * |ssl_open_record_partial|. It sets |*out_consumed| to the total number of |
| 380 | * bytes necessary. It is guaranteed that a successful call to |tls_open_record| |
| 381 | * will consume at least that many bytes. |
| 382 | * |
David Benjamin | 728f354 | 2016-06-02 15:42:01 -0400 | [diff] [blame] | 383 | * Otherwise, it sets |*out_consumed| to the number of bytes of input |
| 384 | * consumed. Note that input may be consumed on all return codes if a record was |
| 385 | * decrypted. |
| 386 | * |
| 387 | * On success, it returns |ssl_open_record_success|. It sets |*out_type| to the |
David Benjamin | a7810c1 | 2016-06-06 18:54:51 -0400 | [diff] [blame] | 388 | * record type and |*out| to the record body in |in|. Note that |*out| may be |
| 389 | * empty. |
David Benjamin | 728f354 | 2016-06-02 15:42:01 -0400 | [diff] [blame] | 390 | * |
| 391 | * If a record was successfully processed but should be discarded, it returns |
| 392 | * |ssl_open_record_discard|. |
| 393 | * |
| 394 | * If a record was successfully processed but is a close_notify or fatal alert, |
| 395 | * it returns |ssl_open_record_close_notify| or |ssl_open_record_fatal_alert|. |
| 396 | * |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 397 | * On failure, it returns |ssl_open_record_error| and sets |*out_alert| to an |
David Benjamin | a7810c1 | 2016-06-06 18:54:51 -0400 | [diff] [blame] | 398 | * alert to emit. */ |
| 399 | enum ssl_open_record_t tls_open_record(SSL *ssl, uint8_t *out_type, CBS *out, |
| 400 | size_t *out_consumed, uint8_t *out_alert, |
| 401 | uint8_t *in, size_t in_len); |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 402 | |
| 403 | /* dtls_open_record implements |tls_open_record| for DTLS. It never returns |
| 404 | * |ssl_open_record_partial| but otherwise behaves analogously. */ |
David Benjamin | a7810c1 | 2016-06-06 18:54:51 -0400 | [diff] [blame] | 405 | enum ssl_open_record_t dtls_open_record(SSL *ssl, uint8_t *out_type, CBS *out, |
| 406 | size_t *out_consumed, |
| 407 | uint8_t *out_alert, uint8_t *in, |
| 408 | size_t in_len); |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 409 | |
David Benjamin | 1a01e1f | 2016-06-08 18:31:24 -0400 | [diff] [blame] | 410 | /* ssl_seal_align_prefix_len returns the length of the prefix before the start |
| 411 | * of the bulk of the ciphertext when sealing a record with |ssl|. Callers may |
| 412 | * use this to align buffers. |
| 413 | * |
| 414 | * Note when TLS 1.0 CBC record-splitting is enabled, this includes the one byte |
| 415 | * record and is the offset into second record's ciphertext. Thus this value may |
| 416 | * differ from |ssl_record_prefix_len| and sealing a small record may result in |
| 417 | * a smaller output than this value. |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 418 | * |
| 419 | * TODO(davidben): Expose this as part of public API once the high-level |
| 420 | * buffer-free APIs are available. */ |
David Benjamin | 1a01e1f | 2016-06-08 18:31:24 -0400 | [diff] [blame] | 421 | size_t ssl_seal_align_prefix_len(const SSL *ssl); |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 422 | |
| 423 | /* ssl_max_seal_overhead returns the maximum overhead of sealing a record with |
David Benjamin | 1a01e1f | 2016-06-08 18:31:24 -0400 | [diff] [blame] | 424 | * |ssl|. |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 425 | * |
| 426 | * TODO(davidben): Expose this as part of public API once the high-level |
| 427 | * buffer-free APIs are available. */ |
| 428 | size_t ssl_max_seal_overhead(const SSL *ssl); |
| 429 | |
| 430 | /* tls_seal_record seals a new record of type |type| and body |in| and writes it |
| 431 | * to |out|. At most |max_out| bytes will be written. It returns one on success |
| 432 | * and zero on error. If enabled, |tls_seal_record| implements TLS 1.0 CBC 1/n-1 |
| 433 | * record splitting and may write two records concatenated. |
| 434 | * |
David Benjamin | 1a01e1f | 2016-06-08 18:31:24 -0400 | [diff] [blame] | 435 | * For a large record, the bulk of the ciphertext will begin |
| 436 | * |ssl_seal_align_prefix_len| bytes into out. Aligning |out| appropriately may |
| 437 | * improve performance. It writes at most |in_len| + |ssl_max_seal_overhead| |
| 438 | * bytes to |out|. |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 439 | * |
David Benjamin | 1a01e1f | 2016-06-08 18:31:24 -0400 | [diff] [blame] | 440 | * |in| and |out| may not alias. */ |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 441 | int tls_seal_record(SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 442 | uint8_t type, const uint8_t *in, size_t in_len); |
| 443 | |
| 444 | enum dtls1_use_epoch_t { |
| 445 | dtls1_use_previous_epoch, |
| 446 | dtls1_use_current_epoch, |
| 447 | }; |
| 448 | |
| 449 | /* dtls_seal_record implements |tls_seal_record| for DTLS. |use_epoch| selects |
| 450 | * which epoch's cipher state to use. */ |
| 451 | int dtls_seal_record(SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 452 | uint8_t type, const uint8_t *in, size_t in_len, |
| 453 | enum dtls1_use_epoch_t use_epoch); |
| 454 | |
David Benjamin | 728f354 | 2016-06-02 15:42:01 -0400 | [diff] [blame] | 455 | /* ssl_process_alert processes |in| as an alert and updates |ssl|'s shutdown |
| 456 | * state. It returns one of |ssl_open_record_discard|, |ssl_open_record_error|, |
| 457 | * |ssl_open_record_close_notify|, or |ssl_open_record_fatal_alert| as |
| 458 | * appropriate. */ |
| 459 | enum ssl_open_record_t ssl_process_alert(SSL *ssl, uint8_t *out_alert, |
| 460 | const uint8_t *in, size_t in_len); |
| 461 | |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 462 | |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 463 | /* Private key operations. */ |
| 464 | |
nagendra modadugu | 601448a | 2015-07-24 09:31:31 -0700 | [diff] [blame] | 465 | /* ssl_has_private_key returns one if |ssl| has a private key |
| 466 | * configured and zero otherwise. */ |
David Benjamin | 32a66d5 | 2016-07-13 22:03:11 -0400 | [diff] [blame] | 467 | int ssl_has_private_key(const SSL *ssl); |
nagendra modadugu | 601448a | 2015-07-24 09:31:31 -0700 | [diff] [blame] | 468 | |
David Benjamin | 0c0b7e1 | 2016-07-14 13:47:55 -0400 | [diff] [blame] | 469 | /* ssl_is_ecdsa_key_type returns one if |type| is an ECDSA key type and zero |
| 470 | * otherwise. */ |
| 471 | int ssl_is_ecdsa_key_type(int type); |
| 472 | |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 473 | /* ssl_private_key_* call the corresponding function on the |
| 474 | * |SSL_PRIVATE_KEY_METHOD| for |ssl|, if configured. Otherwise, they implement |
David Benjamin | d1d8078 | 2015-07-05 11:54:09 -0400 | [diff] [blame] | 475 | * the operation with |EVP_PKEY|. */ |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 476 | |
David Benjamin | d1d8078 | 2015-07-05 11:54:09 -0400 | [diff] [blame] | 477 | int ssl_private_key_type(SSL *ssl); |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 478 | |
David Benjamin | d1d8078 | 2015-07-05 11:54:09 -0400 | [diff] [blame] | 479 | size_t ssl_private_key_max_signature_len(SSL *ssl); |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 480 | |
| 481 | enum ssl_private_key_result_t ssl_private_key_sign( |
Steven Valdez | f0451ca | 2016-06-29 13:16:27 -0400 | [diff] [blame] | 482 | SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 483 | uint16_t signature_algorithm, const uint8_t *in, size_t in_len); |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 484 | |
nagendra modadugu | 3398dbf | 2015-08-07 14:07:52 -0700 | [diff] [blame] | 485 | enum ssl_private_key_result_t ssl_private_key_decrypt( |
| 486 | SSL *ssl, uint8_t *out, size_t *out_len, size_t max_out, |
| 487 | const uint8_t *in, size_t in_len); |
| 488 | |
David Benjamin | d3440b4 | 2016-07-14 14:52:41 -0400 | [diff] [blame] | 489 | enum ssl_private_key_result_t ssl_private_key_complete(SSL *ssl, uint8_t *out, |
| 490 | size_t *out_len, |
| 491 | size_t max_out); |
nagendra modadugu | 3398dbf | 2015-08-07 14:07:52 -0700 | [diff] [blame] | 492 | |
David Benjamin | 1fb125c | 2016-07-08 18:52:12 -0700 | [diff] [blame] | 493 | /* ssl_private_key_supports_signature_algorithm returns one if |ssl|'s private |
| 494 | * key supports |signature_algorithm| and zero otherwise. */ |
| 495 | int ssl_private_key_supports_signature_algorithm(SSL *ssl, |
| 496 | uint16_t signature_algorithm); |
| 497 | |
Steven Valdez | 2b8415e | 2016-06-30 13:27:23 -0400 | [diff] [blame] | 498 | /* ssl_public_key_verify verifies that the |signature| is valid for the public |
| 499 | * key |pkey| and input |in|, using the |signature_algorithm| specified. */ |
| 500 | int ssl_public_key_verify( |
| 501 | SSL *ssl, const uint8_t *signature, size_t signature_len, |
| 502 | uint16_t signature_algorithm, EVP_PKEY *pkey, |
| 503 | const uint8_t *in, size_t in_len); |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 504 | |
David Benjamin | 1fb125c | 2016-07-08 18:52:12 -0700 | [diff] [blame] | 505 | |
Adam Langley | 0950563 | 2015-07-30 18:10:13 -0700 | [diff] [blame] | 506 | /* Custom extensions */ |
| 507 | |
| 508 | /* ssl_custom_extension (a.k.a. SSL_CUSTOM_EXTENSION) is a structure that |
| 509 | * contains information about custom-extension callbacks. */ |
| 510 | struct ssl_custom_extension { |
| 511 | SSL_custom_ext_add_cb add_callback; |
| 512 | void *add_arg; |
| 513 | SSL_custom_ext_free_cb free_callback; |
| 514 | SSL_custom_ext_parse_cb parse_callback; |
| 515 | void *parse_arg; |
| 516 | uint16_t value; |
| 517 | }; |
| 518 | |
| 519 | void SSL_CUSTOM_EXTENSION_free(SSL_CUSTOM_EXTENSION *custom_extension); |
| 520 | |
| 521 | int custom_ext_add_clienthello(SSL *ssl, CBB *extensions); |
| 522 | int custom_ext_parse_serverhello(SSL *ssl, int *out_alert, uint16_t value, |
| 523 | const CBS *extension); |
| 524 | int custom_ext_parse_clienthello(SSL *ssl, int *out_alert, uint16_t value, |
| 525 | const CBS *extension); |
| 526 | int custom_ext_add_serverhello(SSL *ssl, CBB *extensions); |
| 527 | |
| 528 | |
David Benjamin | 9550c3a | 2015-08-05 08:50:34 -0400 | [diff] [blame] | 529 | /* Handshake hash. |
| 530 | * |
| 531 | * The TLS handshake maintains a transcript of all handshake messages. At |
| 532 | * various points in the protocol, this is either a handshake buffer, a rolling |
| 533 | * hash (selected by cipher suite) or both. */ |
| 534 | |
| 535 | /* ssl3_init_handshake_buffer initializes the handshake buffer and resets the |
| 536 | * handshake hash. It returns one success and zero on failure. */ |
| 537 | int ssl3_init_handshake_buffer(SSL *ssl); |
| 538 | |
| 539 | /* ssl3_init_handshake_hash initializes the handshake hash based on the pending |
| 540 | * cipher and the contents of the handshake buffer. Subsequent calls to |
| 541 | * |ssl3_update_handshake_hash| will update the rolling hash. It returns one on |
| 542 | * success and zero on failure. It is an error to call this function after the |
| 543 | * handshake buffer is released. */ |
| 544 | int ssl3_init_handshake_hash(SSL *ssl); |
| 545 | |
| 546 | /* ssl3_free_handshake_buffer releases the handshake buffer. Subsequent calls |
| 547 | * to |ssl3_update_handshake_hash| will not update the handshake buffer. */ |
| 548 | void ssl3_free_handshake_buffer(SSL *ssl); |
| 549 | |
| 550 | /* ssl3_free_handshake_hash releases the handshake hash. */ |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 551 | void ssl3_free_handshake_hash(SSL *ssl); |
David Benjamin | 9550c3a | 2015-08-05 08:50:34 -0400 | [diff] [blame] | 552 | |
| 553 | /* ssl3_update_handshake_hash adds |in| to the handshake buffer and handshake |
| 554 | * hash, whichever is enabled. It returns one on success and zero on failure. */ |
| 555 | int ssl3_update_handshake_hash(SSL *ssl, const uint8_t *in, size_t in_len); |
| 556 | |
| 557 | |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 558 | /* ECDH groups. */ |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 559 | |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 560 | /* An SSL_ECDH_METHOD is an implementation of ECDH-like key exchanges for |
| 561 | * TLS. */ |
| 562 | struct ssl_ecdh_method_st { |
| 563 | int nid; |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 564 | uint16_t group_id; |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 565 | const char name[8]; |
| 566 | |
| 567 | /* cleanup releases state in |ctx|. */ |
| 568 | void (*cleanup)(SSL_ECDH_CTX *ctx); |
| 569 | |
Matt Braithwaite | f4ce8e5 | 2016-05-16 14:27:14 -0700 | [diff] [blame] | 570 | /* offer generates a keypair and writes the public value to |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 571 | * |out_public_key|. It returns one on success and zero on error. */ |
Matt Braithwaite | f4ce8e5 | 2016-05-16 14:27:14 -0700 | [diff] [blame] | 572 | int (*offer)(SSL_ECDH_CTX *ctx, CBB *out_public_key); |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 573 | |
Matt Braithwaite | f4ce8e5 | 2016-05-16 14:27:14 -0700 | [diff] [blame] | 574 | /* accept performs a key exchange against the |peer_key| generated by |offer|. |
| 575 | * On success, it returns one, writes the public value to |out_public_key|, |
| 576 | * and sets |*out_secret| and |*out_secret_len| to a newly-allocated buffer |
| 577 | * containing the shared secret. The caller must release this buffer with |
| 578 | * |OPENSSL_free|. On failure, it returns zero and sets |*out_alert| to an |
| 579 | * alert to send to the peer. */ |
| 580 | int (*accept)(SSL_ECDH_CTX *ctx, CBB *out_public_key, uint8_t **out_secret, |
| 581 | size_t *out_secret_len, uint8_t *out_alert, |
| 582 | const uint8_t *peer_key, size_t peer_key_len); |
| 583 | |
| 584 | /* finish performs a key exchange against the |peer_key| generated by |
| 585 | * |accept|. On success, it returns one and sets |*out_secret| and |
| 586 | * |*out_secret_len| to a newly-allocated buffer containing the shared |
| 587 | * secret. The caller must release this buffer with |OPENSSL_free|. On |
| 588 | * failure, it returns zero and sets |*out_alert| to an alert to send to the |
| 589 | * peer. */ |
| 590 | int (*finish)(SSL_ECDH_CTX *ctx, uint8_t **out_secret, size_t *out_secret_len, |
| 591 | uint8_t *out_alert, const uint8_t *peer_key, |
| 592 | size_t peer_key_len); |
Matt Braithwaite | e25775b | 2016-05-16 16:31:05 -0700 | [diff] [blame] | 593 | |
| 594 | /* get_key initializes |out| with a length-prefixed key from |cbs|. It returns |
| 595 | * one on success and zero on error. */ |
| 596 | int (*get_key)(CBS *cbs, CBS *out); |
| 597 | |
| 598 | /* add_key initializes |out_contents| to receive a key. Typically it will then |
| 599 | * be passed to |offer| or |accept|. It returns one on success and zero on |
| 600 | * error. */ |
| 601 | int (*add_key)(CBB *cbb, CBB *out_contents); |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 602 | } /* SSL_ECDH_METHOD */; |
| 603 | |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 604 | /* ssl_nid_to_group_id looks up the group corresponding to |nid|. On success, it |
| 605 | * sets |*out_group_id| to the group ID and returns one. Otherwise, it returns |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 606 | * zero. */ |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 607 | int ssl_nid_to_group_id(uint16_t *out_group_id, int nid); |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 608 | |
Alessandro Ghedini | 5fd1807 | 2016-09-28 21:04:25 +0100 | [diff] [blame] | 609 | /* ssl_name_to_group_id looks up the group corresponding to the |name| string |
| 610 | * of length |len|. On success, it sets |*out_group_id| to the group ID and |
| 611 | * returns one. Otherwise, it returns zero. */ |
| 612 | int ssl_name_to_group_id(uint16_t *out_group_id, const char *name, size_t len); |
| 613 | |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 614 | /* SSL_ECDH_CTX_init sets up |ctx| for use with curve |group_id|. It returns one |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 615 | * on success and zero on error. */ |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 616 | int SSL_ECDH_CTX_init(SSL_ECDH_CTX *ctx, uint16_t group_id); |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 617 | |
David Benjamin | 974c7ba | 2015-12-19 16:58:04 -0500 | [diff] [blame] | 618 | /* SSL_ECDH_CTX_init_for_dhe sets up |ctx| for use with legacy DHE-based ciphers |
| 619 | * where the server specifies a group. It takes ownership of |params|. */ |
| 620 | void SSL_ECDH_CTX_init_for_dhe(SSL_ECDH_CTX *ctx, DH *params); |
| 621 | |
David Benjamin | 18a3518 | 2016-06-30 13:46:24 -0400 | [diff] [blame] | 622 | /* SSL_ECDH_CTX_init_for_cecpq1 sets up |ctx| for use with CECPQ1. */ |
| 623 | void SSL_ECDH_CTX_init_for_cecpq1(SSL_ECDH_CTX *ctx); |
| 624 | |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 625 | /* SSL_ECDH_CTX_cleanup releases memory associated with |ctx|. It is legal to |
| 626 | * call it in the zero state. */ |
| 627 | void SSL_ECDH_CTX_cleanup(SSL_ECDH_CTX *ctx); |
| 628 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 629 | /* SSL_ECDH_CTX_get_id returns the group ID for |ctx|. */ |
| 630 | uint16_t SSL_ECDH_CTX_get_id(const SSL_ECDH_CTX *ctx); |
| 631 | |
Matt Braithwaite | e25775b | 2016-05-16 16:31:05 -0700 | [diff] [blame] | 632 | /* SSL_ECDH_CTX_get_key calls the |get_key| method of |SSL_ECDH_METHOD|. */ |
| 633 | int SSL_ECDH_CTX_get_key(SSL_ECDH_CTX *ctx, CBS *cbs, CBS *out); |
| 634 | |
| 635 | /* SSL_ECDH_CTX_add_key calls the |add_key| method of |SSL_ECDH_METHOD|. */ |
| 636 | int SSL_ECDH_CTX_add_key(SSL_ECDH_CTX *ctx, CBB *cbb, CBB *out_contents); |
| 637 | |
Matt Braithwaite | f4ce8e5 | 2016-05-16 14:27:14 -0700 | [diff] [blame] | 638 | /* SSL_ECDH_CTX_offer calls the |offer| method of |SSL_ECDH_METHOD|. */ |
| 639 | int SSL_ECDH_CTX_offer(SSL_ECDH_CTX *ctx, CBB *out_public_key); |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 640 | |
Matt Braithwaite | f4ce8e5 | 2016-05-16 14:27:14 -0700 | [diff] [blame] | 641 | /* SSL_ECDH_CTX_accept calls the |accept| method of |SSL_ECDH_METHOD|. */ |
| 642 | int SSL_ECDH_CTX_accept(SSL_ECDH_CTX *ctx, CBB *out_public_key, |
| 643 | uint8_t **out_secret, size_t *out_secret_len, |
| 644 | uint8_t *out_alert, const uint8_t *peer_key, |
| 645 | size_t peer_key_len); |
| 646 | |
| 647 | /* SSL_ECDH_CTX_finish the |finish| method of |SSL_ECDH_METHOD|. */ |
| 648 | int SSL_ECDH_CTX_finish(SSL_ECDH_CTX *ctx, uint8_t **out_secret, |
| 649 | size_t *out_secret_len, uint8_t *out_alert, |
| 650 | const uint8_t *peer_key, size_t peer_key_len); |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 651 | |
David Benjamin | 060cfb0 | 2016-05-12 00:43:05 -0400 | [diff] [blame] | 652 | /* Handshake messages. */ |
| 653 | |
David Benjamin | 29a83c5 | 2016-06-17 19:12:54 -0400 | [diff] [blame] | 654 | /* SSL_MAX_HANDSHAKE_FLIGHT is the number of messages, including |
| 655 | * ChangeCipherSpec, in the longest handshake flight. Currently this is the |
| 656 | * client's second leg in a full handshake when client certificates, NPN, and |
| 657 | * Channel ID, are all enabled. */ |
| 658 | #define SSL_MAX_HANDSHAKE_FLIGHT 7 |
| 659 | |
David Benjamin | 060cfb0 | 2016-05-12 00:43:05 -0400 | [diff] [blame] | 660 | /* ssl_max_handshake_message_len returns the maximum number of bytes permitted |
| 661 | * in a handshake message for |ssl|. */ |
| 662 | size_t ssl_max_handshake_message_len(const SSL *ssl); |
| 663 | |
David Benjamin | ec847ce | 2016-06-17 19:30:47 -0400 | [diff] [blame] | 664 | /* dtls_clear_incoming_messages releases all buffered incoming messages. */ |
| 665 | void dtls_clear_incoming_messages(SSL *ssl); |
| 666 | |
David Benjamin | 6167281 | 2016-07-14 23:10:43 -0400 | [diff] [blame] | 667 | /* dtls_has_incoming_messages returns one if there are buffered incoming |
| 668 | * messages ahead of the current message and zero otherwise. */ |
| 669 | int dtls_has_incoming_messages(const SSL *ssl); |
| 670 | |
David Benjamin | 29a83c5 | 2016-06-17 19:12:54 -0400 | [diff] [blame] | 671 | typedef struct dtls_outgoing_message_st { |
| 672 | uint8_t *data; |
| 673 | uint32_t len; |
| 674 | uint16_t epoch; |
| 675 | char is_ccs; |
| 676 | } DTLS_OUTGOING_MESSAGE; |
| 677 | |
| 678 | /* dtls_clear_outgoing_messages releases all buffered outgoing messages. */ |
| 679 | void dtls_clear_outgoing_messages(SSL *ssl); |
| 680 | |
David Benjamin | 060cfb0 | 2016-05-12 00:43:05 -0400 | [diff] [blame] | 681 | |
David Benjamin | 4e9cc71 | 2016-06-01 20:16:03 -0400 | [diff] [blame] | 682 | /* Callbacks. */ |
| 683 | |
| 684 | /* ssl_do_info_callback calls |ssl|'s info callback, if set. */ |
| 685 | void ssl_do_info_callback(const SSL *ssl, int type, int value); |
| 686 | |
| 687 | /* ssl_do_msg_callback calls |ssl|'s message callback, if set. */ |
David Benjamin | c027999 | 2016-09-19 20:15:07 -0400 | [diff] [blame] | 688 | void ssl_do_msg_callback(SSL *ssl, int is_write, int content_type, |
David Benjamin | 4e9cc71 | 2016-06-01 20:16:03 -0400 | [diff] [blame] | 689 | const void *buf, size_t len); |
| 690 | |
| 691 | |
David Benjamin | b8d28cf | 2015-07-28 21:34:45 -0400 | [diff] [blame] | 692 | /* Transport buffers. */ |
| 693 | |
| 694 | /* ssl_read_buffer returns a pointer to contents of the read buffer. */ |
| 695 | uint8_t *ssl_read_buffer(SSL *ssl); |
| 696 | |
| 697 | /* ssl_read_buffer_len returns the length of the read buffer. */ |
| 698 | size_t ssl_read_buffer_len(const SSL *ssl); |
| 699 | |
| 700 | /* ssl_read_buffer_extend_to extends the read buffer to the desired length. For |
| 701 | * TLS, it reads to the end of the buffer until the buffer is |len| bytes |
| 702 | * long. For DTLS, it reads a new packet and ignores |len|. It returns one on |
| 703 | * success, zero on EOF, and a negative number on error. |
| 704 | * |
| 705 | * It is an error to call |ssl_read_buffer_extend_to| in DTLS when the buffer is |
| 706 | * non-empty. */ |
| 707 | int ssl_read_buffer_extend_to(SSL *ssl, size_t len); |
| 708 | |
| 709 | /* ssl_read_buffer_consume consumes |len| bytes from the read buffer. It |
| 710 | * advances the data pointer and decrements the length. The memory consumed will |
| 711 | * remain valid until the next call to |ssl_read_buffer_extend| or it is |
| 712 | * discarded with |ssl_read_buffer_discard|. */ |
| 713 | void ssl_read_buffer_consume(SSL *ssl, size_t len); |
| 714 | |
| 715 | /* ssl_read_buffer_discard discards the consumed bytes from the read buffer. If |
| 716 | * the buffer is now empty, it releases memory used by it. */ |
| 717 | void ssl_read_buffer_discard(SSL *ssl); |
| 718 | |
| 719 | /* ssl_read_buffer_clear releases all memory associated with the read buffer and |
| 720 | * zero-initializes it. */ |
| 721 | void ssl_read_buffer_clear(SSL *ssl); |
| 722 | |
| 723 | /* ssl_write_buffer_is_pending returns one if the write buffer has pending data |
| 724 | * and zero if is empty. */ |
| 725 | int ssl_write_buffer_is_pending(const SSL *ssl); |
| 726 | |
| 727 | /* ssl_write_buffer_init initializes the write buffer. On success, it sets |
| 728 | * |*out_ptr| to the start of the write buffer with space for up to |max_len| |
| 729 | * bytes. It returns one on success and zero on failure. Call |
| 730 | * |ssl_write_buffer_set_len| to complete initialization. */ |
| 731 | int ssl_write_buffer_init(SSL *ssl, uint8_t **out_ptr, size_t max_len); |
| 732 | |
| 733 | /* ssl_write_buffer_set_len is called after |ssl_write_buffer_init| to complete |
| 734 | * initialization after |len| bytes are written to the buffer. */ |
| 735 | void ssl_write_buffer_set_len(SSL *ssl, size_t len); |
| 736 | |
| 737 | /* ssl_write_buffer_flush flushes the write buffer to the transport. It returns |
| 738 | * one on success and <= 0 on error. For DTLS, whether or not the write |
| 739 | * succeeds, the write buffer will be cleared. */ |
| 740 | int ssl_write_buffer_flush(SSL *ssl); |
| 741 | |
| 742 | /* ssl_write_buffer_clear releases all memory associated with the write buffer |
| 743 | * and zero-initializes it. */ |
| 744 | void ssl_write_buffer_clear(SSL *ssl); |
| 745 | |
| 746 | |
David Benjamin | 7583643 | 2016-06-17 18:48:29 -0400 | [diff] [blame] | 747 | /* Certificate functions. */ |
| 748 | |
David Benjamin | 32a66d5 | 2016-07-13 22:03:11 -0400 | [diff] [blame] | 749 | /* ssl_has_certificate returns one if a certificate and private key are |
| 750 | * configured and zero otherwise. */ |
| 751 | int ssl_has_certificate(const SSL *ssl); |
| 752 | |
David Benjamin | 5c900c8 | 2016-07-13 23:03:26 -0400 | [diff] [blame] | 753 | /* ssl_parse_cert_chain parses a certificate list from |cbs| in the format used |
| 754 | * by a TLS Certificate message. On success, it returns a newly-allocated |
| 755 | * |X509| list and advances |cbs|. Otherwise, it returns NULL and sets |
| 756 | * |*out_alert| to an alert to send to the peer. If the list is non-empty and |
| 757 | * |out_leaf_sha256| is non-NULL, it writes the SHA-256 hash of the leaf to |
| 758 | * |out_leaf_sha256|. */ |
| 759 | STACK_OF(X509) *ssl_parse_cert_chain(SSL *ssl, uint8_t *out_alert, |
| 760 | uint8_t *out_leaf_sha256, CBS *cbs); |
| 761 | |
David Benjamin | 7583643 | 2016-06-17 18:48:29 -0400 | [diff] [blame] | 762 | /* ssl_add_cert_to_cbb adds |x509| to |cbb|. It returns one on success and zero |
| 763 | * on error. */ |
| 764 | int ssl_add_cert_to_cbb(CBB *cbb, X509 *x509); |
| 765 | |
David Benjamin | 32a66d5 | 2016-07-13 22:03:11 -0400 | [diff] [blame] | 766 | /* ssl_add_cert_chain adds |ssl|'s certificate chain to |cbb| in the format used |
| 767 | * by a TLS Certificate message. If there is no certificate chain, it emits an |
| 768 | * empty certificate list. It returns one on success and zero on error. */ |
| 769 | int ssl_add_cert_chain(SSL *ssl, CBB *cbb); |
| 770 | |
David Benjamin | e0332e8 | 2016-07-13 22:40:36 -0400 | [diff] [blame] | 771 | /* ssl_parse_client_CA_list parses a CA list from |cbs| in the format used by a |
| 772 | * TLS CertificateRequest message. On success, it returns a newly-allocated |
| 773 | * |X509_NAME| list and advances |cbs|. Otherwise, it returns NULL and sets |
| 774 | * |*out_alert| to an alert to send to the peer. */ |
| 775 | STACK_OF(X509_NAME) * |
| 776 | ssl_parse_client_CA_list(SSL *ssl, uint8_t *out_alert, CBS *cbs); |
| 777 | |
David Benjamin | 32a66d5 | 2016-07-13 22:03:11 -0400 | [diff] [blame] | 778 | /* ssl_add_client_CA_list adds the configured CA list to |cbb| in the format |
| 779 | * used by a TLS CertificateRequest message. It returns one on success and zero |
| 780 | * on error. */ |
| 781 | int ssl_add_client_CA_list(SSL *ssl, CBB *cbb); |
| 782 | |
Steven Valdez | bf5aa84 | 2016-07-15 07:07:40 -0400 | [diff] [blame] | 783 | /* ssl_check_leaf_certificate returns one if |leaf| is a suitable leaf server |
| 784 | * certificate for |ssl|. Otherwise, it returns zero and pushes an error on the |
| 785 | * error queue. */ |
| 786 | int ssl_check_leaf_certificate(SSL *ssl, X509 *leaf); |
| 787 | |
David Benjamin | 13f1ebe | 2016-07-20 10:11:04 +0200 | [diff] [blame] | 788 | /* ssl_do_client_cert_cb runs the client_cert_cb, if any, and returns one on |
| 789 | * success and zero on error. On error, it sets |*out_should_retry| to one if |
| 790 | * the callback failed and should be retried and zero otherwise. */ |
| 791 | int ssl_do_client_cert_cb(SSL *ssl, int *out_should_retry); |
| 792 | |
David Benjamin | 7583643 | 2016-06-17 18:48:29 -0400 | [diff] [blame] | 793 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 794 | /* TLS 1.3 key derivation. */ |
| 795 | |
| 796 | /* tls13_init_key_schedule initializes the handshake hash and key derivation |
| 797 | * state with the given resumption context. The cipher suite and PRF hash must |
| 798 | * have been selected at this point. It returns one on success and zero on |
| 799 | * error. */ |
| 800 | int tls13_init_key_schedule(SSL *ssl, const uint8_t *resumption_ctx, |
| 801 | size_t resumption_ctx_len); |
| 802 | |
| 803 | /* tls13_advance_key_schedule incorporates |in| into the key schedule with |
| 804 | * HKDF-Extract. It returns one on success and zero on error. */ |
| 805 | int tls13_advance_key_schedule(SSL *ssl, const uint8_t *in, size_t len); |
| 806 | |
| 807 | /* tls13_get_context_hashes writes Hash(Handshake Context) + |
| 808 | * Hash(resumption_context) to |out| which much have room for at least 2 * |
| 809 | * |EVP_MAX_MD_SIZE| bytes. On success, it returns one and sets |*out_len| to |
| 810 | * the number of bytes written. Otherwise, it returns zero. */ |
| 811 | int tls13_get_context_hashes(SSL *ssl, uint8_t *out, size_t *out_len); |
| 812 | |
| 813 | enum tls_record_type_t { |
| 814 | type_early_handshake, |
| 815 | type_early_data, |
| 816 | type_handshake, |
| 817 | type_data, |
| 818 | }; |
| 819 | |
| 820 | /* tls13_set_traffic_key sets the read or write traffic keys to |traffic_secret| |
| 821 | * for the given traffic phase |type|. It returns one on success and zero on |
| 822 | * error. */ |
| 823 | int tls13_set_traffic_key(SSL *ssl, enum tls_record_type_t type, |
| 824 | enum evp_aead_direction_t direction, |
| 825 | const uint8_t *traffic_secret, |
| 826 | size_t traffic_secret_len); |
| 827 | |
| 828 | /* tls13_set_handshake_traffic derives the handshake traffic secret and |
| 829 | * switches both read and write traffic to it. It returns one on success and |
| 830 | * zero on error. */ |
| 831 | int tls13_set_handshake_traffic(SSL *ssl); |
| 832 | |
Steven Valdez | 1dc53d2 | 2016-07-26 12:27:38 -0400 | [diff] [blame] | 833 | /* tls13_rotate_traffic_key derives the next read or write traffic secret. It |
| 834 | * returns one on success and zero on error. */ |
| 835 | int tls13_rotate_traffic_key(SSL *ssl, enum evp_aead_direction_t direction); |
| 836 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 837 | /* tls13_derive_traffic_secret_0 derives the initial application data traffic |
| 838 | * secret based on the handshake transcripts and |master_secret|. It returns one |
| 839 | * on success and zero on error. */ |
| 840 | int tls13_derive_traffic_secret_0(SSL *ssl); |
| 841 | |
| 842 | /* tls13_finalize_keys derives the |exporter_secret| and |resumption_secret|. */ |
| 843 | int tls13_finalize_keys(SSL *ssl); |
| 844 | |
| 845 | /* tls13_export_keying_material provides and exporter interface to use the |
| 846 | * |exporter_secret|. */ |
| 847 | int tls13_export_keying_material(SSL *ssl, uint8_t *out, size_t out_len, |
| 848 | const char *label, size_t label_len, |
| 849 | const uint8_t *context, size_t context_len, |
| 850 | int use_context); |
| 851 | |
| 852 | /* tls13_finished_mac calculates the MAC of the handshake transcript to verify |
| 853 | * the integrity of the Finished message, and stores the result in |out| and |
| 854 | * length in |out_len|. |is_server| is 1 if this is for the Server Finished and |
| 855 | * 0 for the Client Finished. */ |
| 856 | int tls13_finished_mac(SSL *ssl, uint8_t *out, size_t *out_len, int is_server); |
| 857 | |
Steven Valdez | 4aa154e | 2016-07-29 14:32:55 -0400 | [diff] [blame] | 858 | /* tls13_resumption_psk calculates the PSK to use for the resumption of |
| 859 | * |session| and stores the result in |out|. It returns one on success, and |
| 860 | * zero on failure. */ |
| 861 | int tls13_resumption_psk(SSL *ssl, uint8_t *out, size_t out_len, |
| 862 | const SSL_SESSION *session); |
| 863 | |
| 864 | /* tls13_resumption_context derives the context to be used for the handshake |
| 865 | * transcript on the resumption of |session|. It returns one on success, and |
| 866 | * zero on failure. */ |
| 867 | int tls13_resumption_context(SSL *ssl, uint8_t *out, size_t out_len, |
| 868 | const SSL_SESSION *session); |
| 869 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 870 | |
| 871 | /* Handshake functions. */ |
| 872 | |
| 873 | enum ssl_hs_wait_t { |
| 874 | ssl_hs_error, |
| 875 | ssl_hs_ok, |
| 876 | ssl_hs_read_message, |
| 877 | ssl_hs_write_message, |
| 878 | ssl_hs_flush, |
David Benjamin | f2401eb | 2016-07-18 22:25:05 +0200 | [diff] [blame] | 879 | ssl_hs_flush_and_read_message, |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 880 | ssl_hs_x509_lookup, |
| 881 | ssl_hs_private_key_operation, |
| 882 | }; |
| 883 | |
| 884 | struct ssl_handshake_st { |
| 885 | /* wait contains the operation |do_handshake| is currently blocking on or |
| 886 | * |ssl_hs_ok| if none. */ |
| 887 | enum ssl_hs_wait_t wait; |
| 888 | |
| 889 | /* do_handshake runs the handshake. On completion, it returns |ssl_hs_ok|. |
| 890 | * Otherwise, it returns a value corresponding to what operation is needed to |
| 891 | * progress. */ |
| 892 | enum ssl_hs_wait_t (*do_handshake)(SSL *ssl); |
| 893 | |
| 894 | int state; |
| 895 | |
| 896 | size_t hash_len; |
| 897 | uint8_t resumption_hash[EVP_MAX_MD_SIZE]; |
| 898 | uint8_t secret[EVP_MAX_MD_SIZE]; |
| 899 | uint8_t traffic_secret_0[EVP_MAX_MD_SIZE]; |
| 900 | |
David Benjamin | f5d2cd0 | 2016-10-06 19:39:20 -0400 | [diff] [blame^] | 901 | union { |
| 902 | /* sent is a bitset where the bits correspond to elements of kExtensions |
| 903 | * in t1_lib.c. Each bit is set if that extension was sent in a |
| 904 | * ClientHello. It's not used by servers. */ |
| 905 | uint32_t sent; |
| 906 | /* received is a bitset, like |sent|, but is used by servers to record |
| 907 | * which extensions were received from a client. */ |
| 908 | uint32_t received; |
| 909 | } extensions; |
| 910 | |
| 911 | union { |
| 912 | /* sent is a bitset where the bits correspond to elements of |
| 913 | * |client_custom_extensions| in the |SSL_CTX|. Each bit is set if that |
| 914 | * extension was sent in a ClientHello. It's not used by servers. */ |
| 915 | uint16_t sent; |
| 916 | /* received is a bitset, like |sent|, but is used by servers to record |
| 917 | * which custom extensions were received from a client. The bits here |
| 918 | * correspond to |server_custom_extensions|. */ |
| 919 | uint16_t received; |
| 920 | } custom_extensions; |
| 921 | |
David Benjamin | c8b6b4f | 2016-09-08 23:47:48 -0400 | [diff] [blame] | 922 | /* ecdh_ctx is the active client ECDH offer in TLS 1.3. */ |
| 923 | SSL_ECDH_CTX ecdh_ctx; |
David Benjamin | 4fe3c90 | 2016-08-16 02:17:03 -0400 | [diff] [blame] | 924 | |
| 925 | /* retry_group is the group ID selected by the server in HelloRetryRequest in |
| 926 | * TLS 1.3. */ |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 927 | uint16_t retry_group; |
David Benjamin | 4fe3c90 | 2016-08-16 02:17:03 -0400 | [diff] [blame] | 928 | |
| 929 | /* key_share_bytes is the value of the previously sent KeyShare extension by |
| 930 | * the client in TLS 1.3. */ |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 931 | uint8_t *key_share_bytes; |
| 932 | size_t key_share_bytes_len; |
David Benjamin | 4fe3c90 | 2016-08-16 02:17:03 -0400 | [diff] [blame] | 933 | |
| 934 | /* public_key, for servers, is the key share to be sent to the client in TLS |
| 935 | * 1.3. */ |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 936 | uint8_t *public_key; |
| 937 | size_t public_key_len; |
| 938 | |
David Benjamin | 0fc37ef | 2016-08-17 15:29:46 -0400 | [diff] [blame] | 939 | /* peer_sigalgs are the signature algorithms that the peer supports. These are |
| 940 | * taken from the contents of the signature algorithms extension for a server |
| 941 | * or from the CertificateRequest for a client. */ |
| 942 | uint16_t *peer_sigalgs; |
| 943 | /* num_peer_sigalgs is the number of entries in |peer_sigalgs|. */ |
| 944 | size_t num_peer_sigalgs; |
| 945 | |
David Benjamin | a048678 | 2016-10-06 19:11:32 -0400 | [diff] [blame] | 946 | /* session_tickets_sent, in TLS 1.3, is the number of tickets the server has |
| 947 | * sent. */ |
Steven Valdez | 1e6f11a | 2016-07-27 11:10:52 -0400 | [diff] [blame] | 948 | uint8_t session_tickets_sent; |
David Benjamin | bac75b8 | 2016-09-16 19:34:02 -0400 | [diff] [blame] | 949 | |
David Benjamin | a048678 | 2016-10-06 19:11:32 -0400 | [diff] [blame] | 950 | /* cert_request is one if a client certificate was requested and zero |
| 951 | * otherwise. */ |
| 952 | unsigned cert_request:1; |
| 953 | |
| 954 | /* certificate_status_expected is one if OCSP stapling was negotiated and the |
| 955 | * server is expected to send a CertificateStatus message. (This is used on |
| 956 | * both the client and server sides.) */ |
| 957 | unsigned certificate_status_expected:1; |
| 958 | |
| 959 | /* ocsp_stapling_requested is one if a client requested OCSP stapling. */ |
| 960 | unsigned ocsp_stapling_requested:1; |
| 961 | |
| 962 | /* should_ack_sni is used by a server and indicates that the SNI extension |
| 963 | * should be echoed in the ServerHello. */ |
| 964 | unsigned should_ack_sni:1; |
| 965 | |
| 966 | /* in_false_start is one if there is a pending client handshake in False |
| 967 | * Start. The client may write data at this point. */ |
| 968 | unsigned in_false_start:1; |
| 969 | |
David Benjamin | bac75b8 | 2016-09-16 19:34:02 -0400 | [diff] [blame] | 970 | /* peer_psk_identity_hint, on the client, is the psk_identity_hint sent by the |
| 971 | * server when using a TLS 1.2 PSK key exchange. */ |
| 972 | char *peer_psk_identity_hint; |
David Benjamin | a048678 | 2016-10-06 19:11:32 -0400 | [diff] [blame] | 973 | |
| 974 | /* ca_names, on the client, contains the list of CAs received in a |
| 975 | * CertificateRequest message. */ |
| 976 | STACK_OF(X509_NAME) *ca_names; |
| 977 | |
| 978 | /* certificate_types, on the client, contains the set of certificate types |
| 979 | * received in a CertificateRequest message. */ |
| 980 | uint8_t *certificate_types; |
| 981 | size_t num_certificate_types; |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 982 | } /* SSL_HANDSHAKE */; |
| 983 | |
| 984 | SSL_HANDSHAKE *ssl_handshake_new(enum ssl_hs_wait_t (*do_handshake)(SSL *ssl)); |
| 985 | |
| 986 | /* ssl_handshake_free releases all memory associated with |hs|. */ |
| 987 | void ssl_handshake_free(SSL_HANDSHAKE *hs); |
| 988 | |
| 989 | /* tls13_handshake runs the TLS 1.3 handshake. It returns one on success and <= |
| 990 | * 0 on error. */ |
| 991 | int tls13_handshake(SSL *ssl); |
| 992 | |
| 993 | /* The following are implementations of |do_handshake| for the client and |
| 994 | * server. */ |
| 995 | enum ssl_hs_wait_t tls13_client_handshake(SSL *ssl); |
| 996 | enum ssl_hs_wait_t tls13_server_handshake(SSL *ssl); |
| 997 | |
Steven Valdez | 8e1c7be | 2016-07-26 12:39:22 -0400 | [diff] [blame] | 998 | /* tls13_post_handshake processes a post-handshake message. It returns one on |
| 999 | * success and zero on failure. */ |
| 1000 | int tls13_post_handshake(SSL *ssl); |
| 1001 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 1002 | /* tls13_check_message_type checks if the current message has type |type|. If so |
| 1003 | * it returns one. Otherwise, it sends an alert and returns zero. */ |
| 1004 | int tls13_check_message_type(SSL *ssl, int type); |
| 1005 | |
David Benjamin | 4087df9 | 2016-08-01 20:16:31 -0400 | [diff] [blame] | 1006 | int tls13_process_certificate(SSL *ssl, int allow_anonymous); |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 1007 | int tls13_process_certificate_verify(SSL *ssl); |
| 1008 | int tls13_process_finished(SSL *ssl); |
| 1009 | |
| 1010 | int tls13_prepare_certificate(SSL *ssl); |
| 1011 | enum ssl_private_key_result_t tls13_prepare_certificate_verify( |
| 1012 | SSL *ssl, int is_first_run); |
| 1013 | int tls13_prepare_finished(SSL *ssl); |
Steven Valdez | 1e6f11a | 2016-07-27 11:10:52 -0400 | [diff] [blame] | 1014 | int tls13_process_new_session_ticket(SSL *ssl); |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 1015 | |
Steven Valdez | 7259f2f | 2016-08-02 16:55:05 -0400 | [diff] [blame] | 1016 | int ssl_ext_key_share_parse_serverhello(SSL *ssl, uint8_t **out_secret, |
| 1017 | size_t *out_secret_len, |
| 1018 | uint8_t *out_alert, CBS *contents); |
| 1019 | int ssl_ext_key_share_parse_clienthello(SSL *ssl, int *out_found, |
| 1020 | uint8_t **out_secret, |
| 1021 | size_t *out_secret_len, |
| 1022 | uint8_t *out_alert, CBS *contents); |
| 1023 | int ssl_ext_key_share_add_serverhello(SSL *ssl, CBB *out); |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 1024 | |
Steven Valdez | 4aa154e | 2016-07-29 14:32:55 -0400 | [diff] [blame] | 1025 | int ssl_ext_pre_shared_key_parse_serverhello(SSL *ssl, uint8_t *out_alert, |
| 1026 | CBS *contents); |
| 1027 | int ssl_ext_pre_shared_key_parse_clienthello(SSL *ssl, |
| 1028 | SSL_SESSION **out_session, |
| 1029 | uint8_t *out_alert, CBS *contents); |
| 1030 | int ssl_ext_pre_shared_key_add_serverhello(SSL *ssl, CBB *out); |
| 1031 | |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 1032 | int ssl_add_client_hello_body(SSL *ssl, CBB *body); |
| 1033 | |
David Benjamin | 4fe3c90 | 2016-08-16 02:17:03 -0400 | [diff] [blame] | 1034 | /* ssl_clear_tls13_state releases client state only needed for TLS 1.3. It |
| 1035 | * should be called once the version is known to be TLS 1.2 or earlier. */ |
| 1036 | void ssl_clear_tls13_state(SSL *ssl); |
| 1037 | |
Steven Valdez | 143e8b3 | 2016-07-11 13:19:03 -0400 | [diff] [blame] | 1038 | |
David Benjamin | e776cc2 | 2016-07-19 07:26:49 +0200 | [diff] [blame] | 1039 | /* SSLKEYLOGFILE functions. */ |
| 1040 | |
| 1041 | /* ssl_log_rsa_client_key_exchange logs |premaster|, if logging is enabled for |
| 1042 | * |ssl|. It returns one on success and zero on failure. The entry is identified |
| 1043 | * by the first 8 bytes of |encrypted_premaster|. */ |
| 1044 | int ssl_log_rsa_client_key_exchange(const SSL *ssl, |
| 1045 | const uint8_t *encrypted_premaster, |
| 1046 | size_t encrypted_premaster_len, |
| 1047 | const uint8_t *premaster, |
| 1048 | size_t premaster_len); |
| 1049 | |
| 1050 | /* ssl_log_secret logs |secret| with label |label|, if logging is enabled for |
| 1051 | * |ssl|. It returns one on success and zero on failure. */ |
| 1052 | int ssl_log_secret(const SSL *ssl, const char *label, const uint8_t *secret, |
| 1053 | size_t secret_len); |
| 1054 | |
| 1055 | |
David Benjamin | e14ff06 | 2016-08-09 16:21:24 -0400 | [diff] [blame] | 1056 | /* ClientHello functions. */ |
| 1057 | |
| 1058 | int ssl_early_callback_init(SSL *ssl, struct ssl_early_callback_ctx *ctx, |
| 1059 | const uint8_t *in, size_t in_len); |
| 1060 | |
| 1061 | int ssl_early_callback_get_extension(const struct ssl_early_callback_ctx *ctx, |
| 1062 | CBS *out, uint16_t extension_type); |
| 1063 | |
| 1064 | STACK_OF(SSL_CIPHER) * |
David Benjamin | 1deb41b | 2016-08-09 19:36:38 -0400 | [diff] [blame] | 1065 | ssl_parse_client_cipher_list(const struct ssl_early_callback_ctx *ctx); |
| 1066 | |
| 1067 | int ssl_client_cipher_list_contains_cipher( |
| 1068 | const struct ssl_early_callback_ctx *client_hello, uint16_t id); |
David Benjamin | e14ff06 | 2016-08-09 16:21:24 -0400 | [diff] [blame] | 1069 | |
| 1070 | |
David Benjamin | 65ac997 | 2016-09-02 21:35:25 -0400 | [diff] [blame] | 1071 | /* GREASE. */ |
| 1072 | |
| 1073 | enum ssl_grease_index_t { |
| 1074 | ssl_grease_cipher = 0, |
| 1075 | ssl_grease_group, |
| 1076 | ssl_grease_extension1, |
| 1077 | ssl_grease_extension2, |
David Benjamin | d9791bf | 2016-09-27 16:39:52 -0400 | [diff] [blame] | 1078 | ssl_grease_version, |
David Benjamin | 1a5e8ec | 2016-10-07 15:19:18 -0400 | [diff] [blame] | 1079 | ssl_grease_ticket_extension, |
David Benjamin | 65ac997 | 2016-09-02 21:35:25 -0400 | [diff] [blame] | 1080 | }; |
| 1081 | |
| 1082 | /* ssl_get_grease_value returns a GREASE value for |ssl|. For a given |
| 1083 | * connection, the values for each index will be deterministic. This allows the |
| 1084 | * same ClientHello be sent twice for a HelloRetryRequest or the same group be |
| 1085 | * advertised in both supported_groups and key_shares. */ |
| 1086 | uint16_t ssl_get_grease_value(const SSL *ssl, enum ssl_grease_index_t index); |
| 1087 | |
| 1088 | |
David Benjamin | 71f0794 | 2015-04-08 02:36:59 -0400 | [diff] [blame] | 1089 | /* Underdocumented functions. |
| 1090 | * |
| 1091 | * Functions below here haven't been touched up and may be underdocumented. */ |
| 1092 | |
Adam Langley | 1258b6a | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1093 | #define TLSEXT_CHANNEL_ID_SIZE 128 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1094 | |
David Benjamin | e518f65 | 2014-10-13 16:12:45 -0400 | [diff] [blame] | 1095 | /* From RFC4492, used in encoding the curve type in ECParameters */ |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1096 | #define NAMED_CURVE_TYPE 3 |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1097 | |
David Benjamin | 5ca39fb | 2015-03-01 23:57:54 -0500 | [diff] [blame] | 1098 | enum ssl_hash_message_t { |
| 1099 | ssl_dont_hash_message, |
| 1100 | ssl_hash_message, |
| 1101 | }; |
David Benjamin | 590cbe9 | 2014-08-25 21:34:56 -0400 | [diff] [blame] | 1102 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1103 | typedef struct cert_st { |
David Benjamin | d1d8078 | 2015-07-05 11:54:09 -0400 | [diff] [blame] | 1104 | X509 *x509; |
| 1105 | EVP_PKEY *privatekey; |
| 1106 | /* Chain for this certificate */ |
| 1107 | STACK_OF(X509) *chain; |
David Benjamin | f31e681 | 2014-11-13 18:05:55 -0500 | [diff] [blame] | 1108 | |
David Benjamin | b4d65fd | 2015-05-29 17:11:21 -0400 | [diff] [blame] | 1109 | /* key_method, if non-NULL, is a set of callbacks to call for private key |
| 1110 | * operations. */ |
| 1111 | const SSL_PRIVATE_KEY_METHOD *key_method; |
| 1112 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1113 | /* For clients the following masks are of *disabled* key and auth algorithms |
David Benjamin | c7817d8 | 2015-11-05 18:28:33 -0500 | [diff] [blame] | 1114 | * based on the current configuration. |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1115 | * |
| 1116 | * TODO(davidben): Remove these. They get checked twice: when sending the |
David Benjamin | c7817d8 | 2015-11-05 18:28:33 -0500 | [diff] [blame] | 1117 | * ClientHello and when processing the ServerHello. */ |
David Benjamin | 107db58 | 2015-04-08 00:41:59 -0400 | [diff] [blame] | 1118 | uint32_t mask_k; |
| 1119 | uint32_t mask_a; |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1120 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1121 | DH *dh_tmp; |
| 1122 | DH *(*dh_tmp_cb)(SSL *ssl, int is_export, int keysize); |
David Benjamin | dd97878 | 2015-04-24 15:20:13 -0400 | [diff] [blame] | 1123 | |
David Benjamin | 0fc37ef | 2016-08-17 15:29:46 -0400 | [diff] [blame] | 1124 | /* sigalgs, if non-NULL, is the set of signature algorithms supported by |
| 1125 | * |privatekey| in decreasing order of preference. */ |
David Benjamin | d246b81 | 2016-07-08 15:07:02 -0700 | [diff] [blame] | 1126 | uint16_t *sigalgs; |
David Benjamin | 0fc37ef | 2016-08-17 15:29:46 -0400 | [diff] [blame] | 1127 | size_t num_sigalgs; |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1128 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1129 | /* Certificate setup callback: if set is called whenever a |
| 1130 | * certificate may be required (client or server). the callback |
| 1131 | * can then examine any appropriate parameters and setup any |
| 1132 | * certificates required. This allows advanced applications |
| 1133 | * to select certificates on the fly: for example based on |
| 1134 | * supported signature algorithms or curves. */ |
| 1135 | int (*cert_cb)(SSL *ssl, void *arg); |
| 1136 | void *cert_cb_arg; |
Adam Langley | d323f4b | 2016-03-01 15:58:14 -0800 | [diff] [blame] | 1137 | |
| 1138 | /* Optional X509_STORE for certificate validation. If NULL the parent SSL_CTX |
| 1139 | * store is used instead. */ |
| 1140 | X509_STORE *verify_store; |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1141 | } CERT; |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1142 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1143 | /* SSL_METHOD is a compatibility structure to support the legacy version-locked |
| 1144 | * methods. */ |
| 1145 | struct ssl_method_st { |
| 1146 | /* version, if non-zero, is the only protocol version acceptable to an |
| 1147 | * SSL_CTX initialized from this method. */ |
| 1148 | uint16_t version; |
| 1149 | /* method is the underlying SSL_PROTOCOL_METHOD that initializes the |
| 1150 | * SSL_CTX. */ |
| 1151 | const SSL_PROTOCOL_METHOD *method; |
| 1152 | }; |
David Benjamin | 82c9e90 | 2014-12-12 15:55:27 -0500 | [diff] [blame] | 1153 | |
| 1154 | /* Used to hold functions for SSLv2 or SSLv3/TLSv1 functions */ |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1155 | struct ssl_protocol_method_st { |
David Benjamin | 9e13e1a | 2015-03-05 01:56:32 -0500 | [diff] [blame] | 1156 | /* is_dtls is one if the protocol is DTLS and zero otherwise. */ |
| 1157 | char is_dtls; |
David Benjamin | b6a0a51 | 2016-06-21 10:33:21 -0400 | [diff] [blame] | 1158 | /* min_version is the minimum implemented version. */ |
| 1159 | uint16_t min_version; |
| 1160 | /* max_version is the maximum implemented version. */ |
| 1161 | uint16_t max_version; |
David Benjamin | 2dc0204 | 2016-09-19 19:57:37 -0400 | [diff] [blame] | 1162 | /* version_from_wire maps |wire_version| to a protocol version. On success, it |
| 1163 | * sets |*out_version| to the result and returns one. If the version is |
| 1164 | * unknown, it returns zero. */ |
| 1165 | int (*version_from_wire)(uint16_t *out_version, uint16_t wire_version); |
David Benjamin | b6a0a51 | 2016-06-21 10:33:21 -0400 | [diff] [blame] | 1166 | /* version_to_wire maps |version| to the wire representation. It is an error |
| 1167 | * to call it with an invalid version. */ |
| 1168 | uint16_t (*version_to_wire)(uint16_t version); |
David Benjamin | a41280d | 2015-11-26 02:16:49 -0500 | [diff] [blame] | 1169 | int (*ssl_new)(SSL *ssl); |
| 1170 | void (*ssl_free)(SSL *ssl); |
David Benjamin | 09eb655 | 2016-07-08 14:32:11 -0700 | [diff] [blame] | 1171 | /* ssl_get_message reads the next handshake message. If |msg_type| is not -1, |
| 1172 | * the message must have the specified type. On success, it returns one and |
| 1173 | * sets |ssl->s3->tmp.message_type|, |ssl->init_msg|, and |ssl->init_num|. |
| 1174 | * Otherwise, it returns <= 0. */ |
| 1175 | int (*ssl_get_message)(SSL *ssl, int msg_type, |
| 1176 | enum ssl_hash_message_t hash_message); |
David Benjamin | 528bd26 | 2016-07-08 09:34:05 -0700 | [diff] [blame] | 1177 | /* hash_current_message incorporates the current handshake message into the |
| 1178 | * handshake hash. It returns one on success and zero on allocation |
| 1179 | * failure. */ |
| 1180 | int (*hash_current_message)(SSL *ssl); |
David Benjamin | 4497e58 | 2016-07-27 17:51:49 -0400 | [diff] [blame] | 1181 | /* release_current_message is called to release the current handshake message. |
| 1182 | * If |free_buffer| is one, buffers will also be released. */ |
| 1183 | void (*release_current_message)(SSL *ssl, int free_buffer); |
David Benjamin | 163f29a | 2016-07-28 11:05:58 -0400 | [diff] [blame] | 1184 | /* read_app_data reads up to |len| bytes of application data into |buf|. On |
| 1185 | * success, it returns the number of bytes read. Otherwise, it returns <= 0 |
| 1186 | * and sets |*out_got_handshake| to whether the failure was due to a |
| 1187 | * post-handshake handshake message. If so, it fills in the current message as |
| 1188 | * in |ssl_get_message|. */ |
| 1189 | int (*read_app_data)(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len, |
| 1190 | int peek); |
David Benjamin | f0ee907 | 2016-06-15 17:44:37 -0400 | [diff] [blame] | 1191 | int (*read_change_cipher_spec)(SSL *ssl); |
| 1192 | void (*read_close_notify)(SSL *ssl); |
| 1193 | int (*write_app_data)(SSL *ssl, const void *buf_, int len); |
| 1194 | int (*dispatch_alert)(SSL *ssl); |
David Benjamin | a1c90a5 | 2015-05-30 17:03:14 -0400 | [diff] [blame] | 1195 | /* supports_cipher returns one if |cipher| is supported by this protocol and |
| 1196 | * zero otherwise. */ |
| 1197 | int (*supports_cipher)(const SSL_CIPHER *cipher); |
David Benjamin | 7583643 | 2016-06-17 18:48:29 -0400 | [diff] [blame] | 1198 | /* init_message begins a new handshake message of type |type|. |cbb| is the |
| 1199 | * root CBB to be passed into |finish_message|. |*body| is set to a child CBB |
| 1200 | * the caller should write to. It returns one on success and zero on error. */ |
| 1201 | int (*init_message)(SSL *ssl, CBB *cbb, CBB *body, uint8_t type); |
| 1202 | /* finish_message finishes a handshake message and prepares it to be |
| 1203 | * written. It returns one on success and zero on error. */ |
| 1204 | int (*finish_message)(SSL *ssl, CBB *cbb); |
| 1205 | /* write_message writes the next message to the transport. It returns one on |
| 1206 | * success and <= 0 on error. */ |
| 1207 | int (*write_message)(SSL *ssl); |
David Benjamin | aa7734b | 2016-06-07 16:40:46 -0400 | [diff] [blame] | 1208 | /* send_change_cipher_spec sends a ChangeCipherSpec message. */ |
David Benjamin | 352d0a9 | 2016-06-28 11:22:02 -0400 | [diff] [blame] | 1209 | int (*send_change_cipher_spec)(SSL *ssl); |
David Benjamin | aa7734b | 2016-06-07 16:40:46 -0400 | [diff] [blame] | 1210 | /* expect_flight is called when the handshake expects a flight of messages from |
| 1211 | * the peer. */ |
| 1212 | void (*expect_flight)(SSL *ssl); |
| 1213 | /* received_flight is called when the handshake has received a flight of |
| 1214 | * messages from the peer. */ |
| 1215 | void (*received_flight)(SSL *ssl); |
David Benjamin | 6167281 | 2016-07-14 23:10:43 -0400 | [diff] [blame] | 1216 | /* set_read_state sets |ssl|'s read cipher state to |aead_ctx|. It takes |
| 1217 | * ownership of |aead_ctx|. It returns one on success and zero if changing the |
| 1218 | * read state is forbidden at this point. */ |
| 1219 | int (*set_read_state)(SSL *ssl, SSL_AEAD_CTX *aead_ctx); |
| 1220 | /* set_write_state sets |ssl|'s write cipher state to |aead_ctx|. It takes |
| 1221 | * ownership of |aead_ctx|. It returns one on success and zero if changing the |
| 1222 | * write state is forbidden at this point. */ |
| 1223 | int (*set_write_state)(SSL *ssl, SSL_AEAD_CTX *aead_ctx); |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1224 | }; |
David Benjamin | 82c9e90 | 2014-12-12 15:55:27 -0500 | [diff] [blame] | 1225 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1226 | /* This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit |
| 1227 | * of a mess of functions, but hell, think of it as an opaque structure. */ |
| 1228 | struct ssl3_enc_method { |
David Benjamin | 928f32a | 2015-12-29 23:32:29 -0500 | [diff] [blame] | 1229 | /* prf computes the PRF function for |ssl|. It writes |out_len| bytes to |
| 1230 | * |out|, using |secret| as the secret and |label| as the label. |seed1| and |
| 1231 | * |seed2| are concatenated to form the seed parameter. It returns one on |
| 1232 | * success and zero on failure. */ |
| 1233 | int (*prf)(const SSL *ssl, uint8_t *out, size_t out_len, |
| 1234 | const uint8_t *secret, size_t secret_len, const char *label, |
| 1235 | size_t label_len, const uint8_t *seed1, size_t seed1_len, |
| 1236 | const uint8_t *seed2, size_t seed2_len); |
David Benjamin | baa1216 | 2015-12-29 19:13:58 -0500 | [diff] [blame] | 1237 | int (*final_finish_mac)(SSL *ssl, int from_server, uint8_t *out); |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1238 | }; |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1239 | |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1240 | /* lengths of messages */ |
| 1241 | #define DTLS1_COOKIE_LENGTH 256 |
| 1242 | |
| 1243 | #define DTLS1_RT_HEADER_LENGTH 13 |
| 1244 | |
| 1245 | #define DTLS1_HM_HEADER_LENGTH 12 |
| 1246 | |
| 1247 | #define DTLS1_CCS_HEADER_LENGTH 1 |
| 1248 | |
| 1249 | #define DTLS1_AL_HEADER_LENGTH 2 |
| 1250 | |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1251 | struct hm_header_st { |
| 1252 | uint8_t type; |
| 1253 | uint32_t msg_len; |
| 1254 | uint16_t seq; |
| 1255 | uint32_t frag_off; |
| 1256 | uint32_t frag_len; |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1257 | }; |
| 1258 | |
David Benjamin | 528bd26 | 2016-07-08 09:34:05 -0700 | [diff] [blame] | 1259 | /* An hm_fragment is an incoming DTLS message, possibly not yet assembled. */ |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1260 | typedef struct hm_fragment_st { |
David Benjamin | 528bd26 | 2016-07-08 09:34:05 -0700 | [diff] [blame] | 1261 | /* type is the type of the message. */ |
| 1262 | uint8_t type; |
| 1263 | /* seq is the sequence number of this message. */ |
| 1264 | uint16_t seq; |
| 1265 | /* msg_len is the length of the message body. */ |
| 1266 | uint32_t msg_len; |
| 1267 | /* data is a pointer to the message, including message header. It has length |
| 1268 | * |DTLS1_HM_HEADER_LENGTH| + |msg_len|. */ |
| 1269 | uint8_t *data; |
| 1270 | /* reassembly is a bitmask of |msg_len| bits corresponding to which parts of |
| 1271 | * the message have been received. It is NULL if the message is complete. */ |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1272 | uint8_t *reassembly; |
| 1273 | } hm_fragment; |
| 1274 | |
| 1275 | typedef struct dtls1_state_st { |
| 1276 | /* send_cookie is true if we are resending the ClientHello |
| 1277 | * with a cookie from a HelloVerifyRequest. */ |
| 1278 | unsigned int send_cookie; |
| 1279 | |
| 1280 | uint8_t cookie[DTLS1_COOKIE_LENGTH]; |
| 1281 | size_t cookie_len; |
| 1282 | |
| 1283 | /* The current data and handshake epoch. This is initially undefined, and |
| 1284 | * starts at zero once the initial handshake is completed. */ |
| 1285 | uint16_t r_epoch; |
| 1286 | uint16_t w_epoch; |
| 1287 | |
| 1288 | /* records being received in the current epoch */ |
| 1289 | DTLS1_BITMAP bitmap; |
| 1290 | |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1291 | uint16_t handshake_write_seq; |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1292 | uint16_t handshake_read_seq; |
| 1293 | |
| 1294 | /* save last sequence number for retransmissions */ |
| 1295 | uint8_t last_write_sequence[8]; |
| 1296 | |
David Benjamin | ec847ce | 2016-06-17 19:30:47 -0400 | [diff] [blame] | 1297 | /* incoming_messages is a ring buffer of incoming handshake messages that have |
| 1298 | * yet to be processed. The front of the ring buffer is message number |
| 1299 | * |handshake_read_seq|, at position |handshake_read_seq| % |
| 1300 | * |SSL_MAX_HANDSHAKE_FLIGHT|. */ |
| 1301 | hm_fragment *incoming_messages[SSL_MAX_HANDSHAKE_FLIGHT]; |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1302 | |
David Benjamin | 29a83c5 | 2016-06-17 19:12:54 -0400 | [diff] [blame] | 1303 | /* outgoing_messages is the queue of outgoing messages from the last handshake |
| 1304 | * flight. */ |
| 1305 | DTLS_OUTGOING_MESSAGE outgoing_messages[SSL_MAX_HANDSHAKE_FLIGHT]; |
| 1306 | uint8_t outgoing_messages_len; |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1307 | |
| 1308 | unsigned int mtu; /* max DTLS packet size */ |
| 1309 | |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1310 | /* num_timeouts is the number of times the retransmit timer has fired since |
| 1311 | * the last time it was reset. */ |
| 1312 | unsigned int num_timeouts; |
| 1313 | |
| 1314 | /* Indicates when the last handshake msg or heartbeat sent will |
David Benjamin | 4d2e7ce | 2015-05-08 13:29:45 -0400 | [diff] [blame] | 1315 | * timeout. */ |
| 1316 | struct timeval next_timeout; |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1317 | |
Taylor Brandstetter | 376a0fe | 2016-05-10 19:30:28 -0700 | [diff] [blame] | 1318 | /* timeout_duration_ms is the timeout duration in milliseconds. */ |
| 1319 | unsigned timeout_duration_ms; |
David Benjamin | 593047f | 2015-05-08 13:08:52 -0400 | [diff] [blame] | 1320 | } DTLS1_STATE; |
| 1321 | |
David Benjamin | 338fcaf | 2014-12-11 01:20:52 -0500 | [diff] [blame] | 1322 | extern const SSL3_ENC_METHOD TLSv1_enc_data; |
David Benjamin | 338fcaf | 2014-12-11 01:20:52 -0500 | [diff] [blame] | 1323 | extern const SSL3_ENC_METHOD SSLv3_enc_data; |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1324 | |
Steven Valdez | 5b98608 | 2016-09-01 12:29:49 -0400 | [diff] [blame] | 1325 | /* From draft-ietf-tls-tls13-15, used in determining PSK modes. */ |
| 1326 | #define SSL_PSK_KE 0x0 |
| 1327 | #define SSL_PSK_DHE_KE 0x1 |
| 1328 | |
| 1329 | #define SSL_PSK_AUTH 0x0 |
| 1330 | #define SSL_PSK_SIGN_AUTH 0x1 |
Steven Valdez | 1e6f11a | 2016-07-27 11:10:52 -0400 | [diff] [blame] | 1331 | |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1332 | CERT *ssl_cert_new(void); |
| 1333 | CERT *ssl_cert_dup(CERT *cert); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1334 | void ssl_cert_clear_certs(CERT *c); |
| 1335 | void ssl_cert_free(CERT *c); |
David Benjamin | dc2aea2 | 2015-10-18 12:50:32 -0400 | [diff] [blame] | 1336 | int ssl_get_new_session(SSL *ssl, int is_server); |
Steven Valdez | 1e6f11a | 2016-07-27 11:10:52 -0400 | [diff] [blame] | 1337 | int ssl_encrypt_ticket(SSL *ssl, CBB *out, const SSL_SESSION *session); |
David Benjamin | e3aa1d9 | 2015-06-16 15:34:50 -0400 | [diff] [blame] | 1338 | |
Steven Valdez | 4aa154e | 2016-07-29 14:32:55 -0400 | [diff] [blame] | 1339 | /* ssl_session_is_context_valid returns one if |session|'s session ID context |
| 1340 | * matches the one set on |ssl| and zero otherwise. */ |
| 1341 | int ssl_session_is_context_valid(const SSL *ssl, const SSL_SESSION *session); |
| 1342 | |
| 1343 | /* ssl_session_is_time_valid returns one if |session| is still valid and zero if |
| 1344 | * it has expired. */ |
| 1345 | int ssl_session_is_time_valid(const SSL *ssl, const SSL_SESSION *session); |
| 1346 | |
David Benjamin | 4d0be24 | 2016-09-01 01:10:07 -0400 | [diff] [blame] | 1347 | void ssl_set_session(SSL *ssl, SSL_SESSION *session); |
| 1348 | |
David Benjamin | e3aa1d9 | 2015-06-16 15:34:50 -0400 | [diff] [blame] | 1349 | enum ssl_session_result_t { |
| 1350 | ssl_session_success, |
| 1351 | ssl_session_error, |
| 1352 | ssl_session_retry, |
| 1353 | }; |
| 1354 | |
| 1355 | /* ssl_get_prev_session looks up the previous session based on |ctx|. On |
| 1356 | * success, it sets |*out_session| to the session or NULL if none was found. It |
| 1357 | * sets |*out_send_ticket| to whether a ticket should be sent at the end of the |
| 1358 | * handshake. If the session could not be looked up synchronously, it returns |
| 1359 | * |ssl_session_retry| and should be called again. Otherwise, it returns |
| 1360 | * |ssl_session_error|. */ |
| 1361 | enum ssl_session_result_t ssl_get_prev_session( |
| 1362 | SSL *ssl, SSL_SESSION **out_session, int *out_send_ticket, |
| 1363 | const struct ssl_early_callback_ctx *ctx); |
| 1364 | |
Steven Valdez | 4aa154e | 2016-07-29 14:32:55 -0400 | [diff] [blame] | 1365 | /* The following flags determine which parts of the session are duplicated. */ |
| 1366 | #define SSL_SESSION_DUP_AUTH_ONLY 0x0 |
| 1367 | #define SSL_SESSION_INCLUDE_TICKET 0x1 |
| 1368 | #define SSL_SESSION_INCLUDE_NONAUTH 0x2 |
| 1369 | #define SSL_SESSION_DUP_ALL \ |
| 1370 | (SSL_SESSION_INCLUDE_TICKET | SSL_SESSION_INCLUDE_NONAUTH) |
| 1371 | |
Steven Valdez | 87eab49 | 2016-06-27 16:34:59 -0400 | [diff] [blame] | 1372 | /* SSL_SESSION_dup returns a newly-allocated |SSL_SESSION| with a copy of the |
| 1373 | * fields in |session| or NULL on error. The new session is non-resumable and |
| 1374 | * must be explicitly marked resumable once it has been filled in. */ |
| 1375 | OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_dup(SSL_SESSION *session, |
Steven Valdez | 4aa154e | 2016-07-29 14:32:55 -0400 | [diff] [blame] | 1376 | int dup_flags); |
Steven Valdez | 87eab49 | 2016-06-27 16:34:59 -0400 | [diff] [blame] | 1377 | |
Adam Langley | 858a88d | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1378 | void ssl_cipher_preference_list_free( |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1379 | struct ssl_cipher_preference_list_st *cipher_list); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1380 | struct ssl_cipher_preference_list_st *ssl_get_cipher_preferences(SSL *ssl); |
David Benjamin | ea72bd0 | 2014-12-21 21:27:41 -0500 | [diff] [blame] | 1381 | |
David Benjamin | d1d8078 | 2015-07-05 11:54:09 -0400 | [diff] [blame] | 1382 | int ssl_cert_set0_chain(CERT *cert, STACK_OF(X509) *chain); |
| 1383 | int ssl_cert_set1_chain(CERT *cert, STACK_OF(X509) *chain); |
| 1384 | int ssl_cert_add0_chain_cert(CERT *cert, X509 *x509); |
| 1385 | int ssl_cert_add1_chain_cert(CERT *cert, X509 *x509); |
| 1386 | void ssl_cert_set_cert_cb(CERT *cert, |
| 1387 | int (*cb)(SSL *ssl, void *arg), void *arg); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1388 | |
David Benjamin | 7aa31d6 | 2016-08-08 21:38:32 -0400 | [diff] [blame] | 1389 | int ssl_verify_cert_chain(SSL *ssl, long *out_verify_result, |
| 1390 | STACK_OF(X509) * cert_chain); |
David Benjamin | 1269ddd | 2015-10-18 15:18:55 -0400 | [diff] [blame] | 1391 | void ssl_update_cache(SSL *ssl, int mode); |
David Benjamin | f31e681 | 2014-11-13 18:05:55 -0500 | [diff] [blame] | 1392 | |
| 1393 | /* ssl_get_compatible_server_ciphers determines the key exchange and |
| 1394 | * authentication cipher suite masks compatible with the server configuration |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1395 | * and current ClientHello parameters of |ssl|. It sets |*out_mask_k| to the key |
David Benjamin | f31e681 | 2014-11-13 18:05:55 -0500 | [diff] [blame] | 1396 | * exchange mask and |*out_mask_a| to the authentication mask. */ |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1397 | void ssl_get_compatible_server_ciphers(SSL *ssl, uint32_t *out_mask_k, |
David Benjamin | 107db58 | 2015-04-08 00:41:59 -0400 | [diff] [blame] | 1398 | uint32_t *out_mask_a); |
David Benjamin | f31e681 | 2014-11-13 18:05:55 -0500 | [diff] [blame] | 1399 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1400 | STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1401 | int ssl_verify_alarm_type(long type); |
David Benjamin | 74d8bc2 | 2015-05-21 02:16:53 -0400 | [diff] [blame] | 1402 | |
David Benjamin | 1e6d6df | 2016-05-13 18:28:17 -0400 | [diff] [blame] | 1403 | int ssl3_get_finished(SSL *ssl); |
David Benjamin | 352d0a9 | 2016-06-28 11:22:02 -0400 | [diff] [blame] | 1404 | int ssl3_send_change_cipher_spec(SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1405 | void ssl3_cleanup_key_block(SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1406 | int ssl3_send_alert(SSL *ssl, int level, int desc); |
David Benjamin | 09eb655 | 2016-07-08 14:32:11 -0700 | [diff] [blame] | 1407 | int ssl3_get_message(SSL *ssl, int msg_type, |
| 1408 | enum ssl_hash_message_t hash_message); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1409 | int ssl3_hash_current_message(SSL *ssl); |
David Benjamin | 4497e58 | 2016-07-27 17:51:49 -0400 | [diff] [blame] | 1410 | void ssl3_release_current_message(SSL *ssl, int free_buffer); |
David Benjamin | 854dd65 | 2014-08-26 00:32:30 -0400 | [diff] [blame] | 1411 | |
Steven Valdez | 2b8415e | 2016-06-30 13:27:23 -0400 | [diff] [blame] | 1412 | /* ssl3_cert_verify_hash writes the SSL 3.0 CertificateVerify hash into the |
| 1413 | * bytes pointed to by |out| and writes the number of bytes to |*out_len|. |out| |
David Benjamin | 0aa25bd | 2016-07-08 14:44:56 -0700 | [diff] [blame] | 1414 | * must have room for |EVP_MAX_MD_SIZE| bytes. It sets |*out_md| to the hash |
| 1415 | * function used. It returns one on success and zero on failure. */ |
| 1416 | int ssl3_cert_verify_hash(SSL *ssl, const EVP_MD **out_md, uint8_t *out, |
| 1417 | size_t *out_len, uint16_t signature_algorithm); |
David Benjamin | 854dd65 | 2014-08-26 00:32:30 -0400 | [diff] [blame] | 1418 | |
David Benjamin | baa1216 | 2015-12-29 19:13:58 -0500 | [diff] [blame] | 1419 | int ssl3_send_finished(SSL *ssl, int a, int b); |
David Benjamin | a1c90a5 | 2015-05-30 17:03:14 -0400 | [diff] [blame] | 1420 | int ssl3_supports_cipher(const SSL_CIPHER *cipher); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1421 | int ssl3_dispatch_alert(SSL *ssl); |
David Benjamin | 163f29a | 2016-07-28 11:05:58 -0400 | [diff] [blame] | 1422 | int ssl3_read_app_data(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len, |
| 1423 | int peek); |
David Benjamin | a41280d | 2015-11-26 02:16:49 -0500 | [diff] [blame] | 1424 | int ssl3_read_change_cipher_spec(SSL *ssl); |
David Benjamin | a602277 | 2015-05-30 16:22:10 -0400 | [diff] [blame] | 1425 | void ssl3_read_close_notify(SSL *ssl); |
David Benjamin | 163f29a | 2016-07-28 11:05:58 -0400 | [diff] [blame] | 1426 | int ssl3_read_handshake_bytes(SSL *ssl, uint8_t *buf, int len); |
David Benjamin | c933a47 | 2015-05-30 16:14:58 -0400 | [diff] [blame] | 1427 | int ssl3_write_app_data(SSL *ssl, const void *buf, int len); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1428 | int ssl3_write_bytes(SSL *ssl, int type, const void *buf, int len); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1429 | int ssl3_output_cert_chain(SSL *ssl); |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1430 | const SSL_CIPHER *ssl3_choose_cipher( |
David Benjamin | fddbadc | 2016-08-09 19:53:00 -0400 | [diff] [blame] | 1431 | SSL *ssl, const struct ssl_early_callback_ctx *client_hello, |
| 1432 | const struct ssl_cipher_preference_list_st *srvr); |
Adam Langley | 7571292 | 2014-10-10 16:23:43 -0700 | [diff] [blame] | 1433 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1434 | int ssl3_new(SSL *ssl); |
| 1435 | void ssl3_free(SSL *ssl); |
| 1436 | int ssl3_accept(SSL *ssl); |
| 1437 | int ssl3_connect(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1438 | |
David Benjamin | 7583643 | 2016-06-17 18:48:29 -0400 | [diff] [blame] | 1439 | int ssl3_init_message(SSL *ssl, CBB *cbb, CBB *body, uint8_t type); |
| 1440 | int ssl3_finish_message(SSL *ssl, CBB *cbb); |
| 1441 | int ssl3_write_message(SSL *ssl); |
| 1442 | |
David Benjamin | aa7734b | 2016-06-07 16:40:46 -0400 | [diff] [blame] | 1443 | void ssl3_expect_flight(SSL *ssl); |
| 1444 | void ssl3_received_flight(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1445 | |
David Benjamin | 7583643 | 2016-06-17 18:48:29 -0400 | [diff] [blame] | 1446 | int dtls1_init_message(SSL *ssl, CBB *cbb, CBB *body, uint8_t type); |
| 1447 | int dtls1_finish_message(SSL *ssl, CBB *cbb); |
| 1448 | int dtls1_write_message(SSL *ssl); |
David Benjamin | c660417 | 2016-06-02 16:38:35 -0400 | [diff] [blame] | 1449 | |
| 1450 | /* dtls1_get_record reads a new input record. On success, it places it in |
| 1451 | * |ssl->s3->rrec| and returns one. Otherwise it returns <= 0 on error or if |
| 1452 | * more data is needed. */ |
| 1453 | int dtls1_get_record(SSL *ssl); |
| 1454 | |
David Benjamin | 163f29a | 2016-07-28 11:05:58 -0400 | [diff] [blame] | 1455 | int dtls1_read_app_data(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len, |
| 1456 | int peek); |
David Benjamin | a41280d | 2015-11-26 02:16:49 -0500 | [diff] [blame] | 1457 | int dtls1_read_change_cipher_spec(SSL *ssl); |
David Benjamin | a602277 | 2015-05-30 16:22:10 -0400 | [diff] [blame] | 1458 | void dtls1_read_close_notify(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1459 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1460 | int dtls1_write_app_data(SSL *ssl, const void *buf, int len); |
David Benjamin | 45d45c1 | 2016-06-07 15:20:49 -0400 | [diff] [blame] | 1461 | |
| 1462 | /* dtls1_write_record sends a record. It returns one on success and <= 0 on |
| 1463 | * error. */ |
| 1464 | int dtls1_write_record(SSL *ssl, int type, const uint8_t *buf, size_t len, |
| 1465 | enum dtls1_use_epoch_t use_epoch); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1466 | |
David Benjamin | 352d0a9 | 2016-06-28 11:22:02 -0400 | [diff] [blame] | 1467 | int dtls1_send_change_cipher_spec(SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1468 | int dtls1_send_finished(SSL *ssl, int a, int b, const char *sender, int slen); |
David Benjamin | aad50db | 2016-06-23 17:49:12 -0400 | [diff] [blame] | 1469 | int dtls1_retransmit_outgoing_messages(SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1470 | void dtls1_clear_record_buffer(SSL *ssl); |
David Benjamin | c660417 | 2016-06-02 16:38:35 -0400 | [diff] [blame] | 1471 | int dtls1_parse_fragment(CBS *cbs, struct hm_header_st *out_hdr, |
| 1472 | CBS *out_body); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1473 | int dtls1_check_timeout_num(SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1474 | int dtls1_handshake_write(SSL *ssl); |
David Benjamin | aa7734b | 2016-06-07 16:40:46 -0400 | [diff] [blame] | 1475 | void dtls1_expect_flight(SSL *ssl); |
| 1476 | void dtls1_received_flight(SSL *ssl); |
David Benjamin | 2fa83de | 2015-02-08 01:40:08 -0500 | [diff] [blame] | 1477 | |
David Benjamin | a1c90a5 | 2015-05-30 17:03:14 -0400 | [diff] [blame] | 1478 | int dtls1_supports_cipher(const SSL_CIPHER *cipher); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1479 | void dtls1_start_timer(SSL *ssl); |
| 1480 | void dtls1_stop_timer(SSL *ssl); |
| 1481 | int dtls1_is_timer_expired(SSL *ssl); |
| 1482 | void dtls1_double_timeout(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1483 | unsigned int dtls1_min_mtu(void); |
| 1484 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1485 | int dtls1_new(SSL *ssl); |
| 1486 | int dtls1_accept(SSL *ssl); |
| 1487 | int dtls1_connect(SSL *ssl); |
| 1488 | void dtls1_free(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1489 | |
David Benjamin | 09eb655 | 2016-07-08 14:32:11 -0700 | [diff] [blame] | 1490 | int dtls1_get_message(SSL *ssl, int mt, enum ssl_hash_message_t hash_message); |
David Benjamin | 528bd26 | 2016-07-08 09:34:05 -0700 | [diff] [blame] | 1491 | int dtls1_hash_current_message(SSL *ssl); |
David Benjamin | 4497e58 | 2016-07-27 17:51:49 -0400 | [diff] [blame] | 1492 | void dtls1_release_current_message(SSL *ssl, int free_buffer); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1493 | int dtls1_dispatch_alert(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1494 | |
David Benjamin | 30152fd | 2016-05-05 20:45:48 -0400 | [diff] [blame] | 1495 | /* ssl_is_wbio_buffered returns one if |ssl|'s write BIO is buffered and zero |
| 1496 | * otherwise. */ |
| 1497 | int ssl_is_wbio_buffered(const SSL *ssl); |
| 1498 | |
David Benjamin | b095f0f | 2016-05-05 21:50:24 -0400 | [diff] [blame] | 1499 | int ssl_init_wbio_buffer(SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1500 | void ssl_free_wbio_buffer(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1501 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1502 | int tls1_change_cipher_state(SSL *ssl, int which); |
| 1503 | int tls1_setup_key_block(SSL *ssl); |
| 1504 | int tls1_handshake_digest(SSL *ssl, uint8_t *out, size_t out_len); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1505 | int tls1_generate_master_secret(SSL *ssl, uint8_t *out, const uint8_t *premaster, |
David Benjamin | 31b1d81 | 2014-12-23 10:01:09 -0500 | [diff] [blame] | 1506 | size_t premaster_len); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1507 | |
Steven Valdez | 5440fe0 | 2016-07-18 12:40:30 -0400 | [diff] [blame] | 1508 | /* tls1_get_grouplist sets |*out_group_ids| and |*out_group_ids_len| to the |
| 1509 | * list of allowed group IDs. If |get_peer_groups| is non-zero, return the |
| 1510 | * peer's group list. Otherwise, return the preferred list. */ |
| 1511 | void tls1_get_grouplist(SSL *ssl, int get_peer_groups, |
| 1512 | const uint16_t **out_group_ids, |
| 1513 | size_t *out_group_ids_len); |
| 1514 | |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 1515 | /* tls1_check_group_id returns one if |group_id| is consistent with both our |
| 1516 | * and the peer's group preferences. Note: if called as the client, only our |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 1517 | * preferences are checked; the peer (the server) does not send preferences. */ |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 1518 | int tls1_check_group_id(SSL *ssl, uint16_t group_id); |
Sigbjorn Vik | 2b23d24 | 2015-06-29 15:07:26 +0200 | [diff] [blame] | 1519 | |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 1520 | /* tls1_get_shared_group sets |*out_group_id| to the first preferred shared |
| 1521 | * group between client and server preferences and returns one. If none may be |
David Benjamin | 4298d77 | 2015-12-19 00:18:25 -0500 | [diff] [blame] | 1522 | * found, it returns zero. */ |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 1523 | int tls1_get_shared_group(SSL *ssl, uint16_t *out_group_id); |
David Benjamin | 072334d | 2014-07-13 16:24:27 -0400 | [diff] [blame] | 1524 | |
| 1525 | /* tls1_set_curves converts the array of |ncurves| NIDs pointed to by |curves| |
Steven Valdez | ce902a9 | 2016-05-17 11:47:53 -0400 | [diff] [blame] | 1526 | * into a newly allocated array of TLS group IDs. On success, the function |
| 1527 | * returns one and writes the array to |*out_group_ids| and its size to |
| 1528 | * |*out_group_ids_len|. Otherwise, it returns zero. */ |
| 1529 | int tls1_set_curves(uint16_t **out_group_ids, size_t *out_group_ids_len, |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1530 | const int *curves, size_t ncurves); |
David Benjamin | 072334d | 2014-07-13 16:24:27 -0400 | [diff] [blame] | 1531 | |
Alessandro Ghedini | 5fd1807 | 2016-09-28 21:04:25 +0100 | [diff] [blame] | 1532 | /* tls1_set_curves_list converts the string of curves pointed to by |curves| |
| 1533 | * into a newly allocated array of TLS group IDs. On success, the function |
| 1534 | * returns one and writes the array to |*out_group_ids| and its size to |
| 1535 | * |*out_group_ids_len|. Otherwise, it returns zero. */ |
| 1536 | int tls1_set_curves_list(uint16_t **out_group_ids, size_t *out_group_ids_len, |
| 1537 | const char *curves); |
| 1538 | |
David Benjamin | 033e5f4 | 2014-11-13 18:47:41 -0500 | [diff] [blame] | 1539 | /* tls1_check_ec_cert returns one if |x| is an ECC certificate with curve and |
| 1540 | * point format compatible with the client's preferences. Otherwise it returns |
| 1541 | * zero. */ |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1542 | int tls1_check_ec_cert(SSL *ssl, X509 *x); |
David Benjamin | 033e5f4 | 2014-11-13 18:47:41 -0500 | [diff] [blame] | 1543 | |
David Benjamin | e8d5350 | 2015-10-10 14:13:23 -0400 | [diff] [blame] | 1544 | /* ssl_add_clienthello_tlsext writes ClientHello extensions to |out|. It |
| 1545 | * returns one on success and zero on failure. The |header_len| argument is the |
| 1546 | * length of the ClientHello written so far and is used to compute the padding |
| 1547 | * length. (It does not include the record header.) */ |
| 1548 | int ssl_add_clienthello_tlsext(SSL *ssl, CBB *out, size_t header_len); |
| 1549 | |
David Benjamin | 5638046 | 2015-10-10 14:59:09 -0400 | [diff] [blame] | 1550 | int ssl_add_serverhello_tlsext(SSL *ssl, CBB *out); |
David Benjamin | e14ff06 | 2016-08-09 16:21:24 -0400 | [diff] [blame] | 1551 | int ssl_parse_clienthello_tlsext( |
| 1552 | SSL *ssl, const struct ssl_early_callback_ctx *client_hello); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1553 | int ssl_parse_serverhello_tlsext(SSL *ssl, CBS *cbs); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1554 | |
Adam Langley | fcf2583 | 2014-12-18 17:42:32 -0800 | [diff] [blame] | 1555 | #define tlsext_tick_md EVP_sha256 |
David Benjamin | e3aa1d9 | 2015-06-16 15:34:50 -0400 | [diff] [blame] | 1556 | |
David Benjamin | ef1b009 | 2015-11-21 14:05:44 -0500 | [diff] [blame] | 1557 | /* tls_process_ticket processes a session ticket from the client. On success, |
| 1558 | * it sets |*out_session| to the decrypted session or NULL if the ticket was |
| 1559 | * rejected. If the ticket was valid, it sets |*out_renew_ticket| to whether |
| 1560 | * the ticket should be renewed. It returns one on success and zero on fatal |
David Benjamin | e3aa1d9 | 2015-06-16 15:34:50 -0400 | [diff] [blame] | 1561 | * error. */ |
| 1562 | int tls_process_ticket(SSL *ssl, SSL_SESSION **out_session, |
David Benjamin | ef1b009 | 2015-11-21 14:05:44 -0500 | [diff] [blame] | 1563 | int *out_renew_ticket, const uint8_t *ticket, |
David Benjamin | e3aa1d9 | 2015-06-16 15:34:50 -0400 | [diff] [blame] | 1564 | size_t ticket_len, const uint8_t *session_id, |
| 1565 | size_t session_id_len); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1566 | |
David Benjamin | d6a4ae9 | 2015-08-06 11:10:51 -0400 | [diff] [blame] | 1567 | /* tls1_channel_id_hash computes the hash to be signed by Channel ID and writes |
| 1568 | * it to |out|, which must contain at least |EVP_MAX_MD_SIZE| bytes. It returns |
| 1569 | * one on success and zero on failure. */ |
| 1570 | int tls1_channel_id_hash(SSL *ssl, uint8_t *out, size_t *out_len); |
| 1571 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1572 | int tls1_record_handshake_hashes_for_channel_id(SSL *ssl); |
Adam Langley | 1258b6a | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1573 | |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1574 | /* ssl3_can_false_start returns one if |ssl| is allowed to False Start and zero |
David Benjamin | ed7c475 | 2015-02-16 19:16:46 -0500 | [diff] [blame] | 1575 | * otherwise. */ |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1576 | int ssl3_can_false_start(const SSL *ssl); |
David Benjamin | ceb6f28 | 2014-12-07 23:56:19 -0500 | [diff] [blame] | 1577 | |
David Benjamin | e99e912 | 2014-12-11 01:46:01 -0500 | [diff] [blame] | 1578 | /* ssl3_get_enc_method returns the SSL3_ENC_METHOD corresponding to |
| 1579 | * |version|. */ |
| 1580 | const SSL3_ENC_METHOD *ssl3_get_enc_method(uint16_t version); |
| 1581 | |
David Benjamin | e0ff767 | 2016-09-19 18:40:03 -0400 | [diff] [blame] | 1582 | /* ssl_get_version_range sets |*out_min_version| and |*out_max_version| to the |
| 1583 | * minimum and maximum enabled protocol versions, respectively. */ |
David Benjamin | b6a0a51 | 2016-06-21 10:33:21 -0400 | [diff] [blame] | 1584 | int ssl_get_version_range(const SSL *ssl, uint16_t *out_min_version, |
David Benjamin | e0ff767 | 2016-09-19 18:40:03 -0400 | [diff] [blame] | 1585 | uint16_t *out_max_version); |
David Benjamin | b9e4fa5 | 2015-12-29 23:58:17 -0500 | [diff] [blame] | 1586 | |
| 1587 | /* ssl3_protocol_version returns |ssl|'s protocol version. It is an error to |
| 1588 | * call this function before the version is determined. */ |
| 1589 | uint16_t ssl3_protocol_version(const SSL *ssl); |
David Benjamin | ea72bd0 | 2014-12-21 21:27:41 -0500 | [diff] [blame] | 1590 | |
David Benjamin | 928f32a | 2015-12-29 23:32:29 -0500 | [diff] [blame] | 1591 | uint32_t ssl_get_algorithm_prf(const SSL *ssl); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1592 | int tls1_parse_peer_sigalgs(SSL *ssl, const CBS *sigalgs); |
David Benjamin | ec2f27d | 2014-11-13 19:17:25 -0500 | [diff] [blame] | 1593 | |
David Benjamin | ea9a0d5 | 2016-07-08 15:52:59 -0700 | [diff] [blame] | 1594 | /* tls1_choose_signature_algorithm sets |*out| to a signature algorithm for use |
| 1595 | * with |ssl|'s private key based on the peer's preferences and the digests |
| 1596 | * supported. It returns one on success and zero on error. */ |
| 1597 | int tls1_choose_signature_algorithm(SSL *ssl, uint16_t *out); |
David Benjamin | ec2f27d | 2014-11-13 19:17:25 -0500 | [diff] [blame] | 1598 | |
Steven Valdez | 0256385 | 2016-06-23 13:33:05 -0400 | [diff] [blame] | 1599 | size_t tls12_get_psigalgs(SSL *ssl, const uint16_t **psigs); |
David Benjamin | 6e80765 | 2015-11-02 12:02:20 -0500 | [diff] [blame] | 1600 | |
Steven Valdez | 0256385 | 2016-06-23 13:33:05 -0400 | [diff] [blame] | 1601 | /* tls12_check_peer_sigalg checks that |signature_algorithm| is consistent with |
David Benjamin | 887c300 | 2016-07-08 16:15:32 -0700 | [diff] [blame] | 1602 | * |ssl|'s sent, supported signature algorithms and returns 1. Otherwise it |
| 1603 | * returns 0 and writes an alert into |*out_alert|. */ |
Steven Valdez | f0451ca | 2016-06-29 13:16:27 -0400 | [diff] [blame] | 1604 | int tls12_check_peer_sigalg(SSL *ssl, int *out_alert, |
David Benjamin | 887c300 | 2016-07-08 16:15:32 -0700 | [diff] [blame] | 1605 | uint16_t signature_algorithm); |
David Benjamin | 0d56f88 | 2015-12-19 17:05:56 -0500 | [diff] [blame] | 1606 | void ssl_set_client_disabled(SSL *ssl); |
Adam Langley | 95c29f3 | 2014-06-20 12:00:00 -0700 | [diff] [blame] | 1607 | |
David Benjamin | 721e8b7 | 2016-08-03 13:13:17 -0400 | [diff] [blame] | 1608 | void ssl_get_current_time(const SSL *ssl, struct timeval *out_clock); |
| 1609 | |
Steven Valdez | 87eab49 | 2016-06-27 16:34:59 -0400 | [diff] [blame] | 1610 | |
| 1611 | #if defined(__cplusplus) |
| 1612 | } /* extern C */ |
| 1613 | #endif |
| 1614 | |
David Benjamin | 2ee94aa | 2015-04-07 22:38:30 -0400 | [diff] [blame] | 1615 | #endif /* OPENSSL_HEADER_SSL_INTERNAL_H */ |