blob: 17667752e275e863c90c3dd01a2662ad0a8f1c7d [file] [log] [blame]
Adam Langley95c29f32014-06-20 12:00:00 -07001/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
2 * All rights reserved.
3 *
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
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 Benjamin2ee94aa2015-04-07 22:38:30 -0400142#ifndef OPENSSL_HEADER_SSL_INTERNAL_H
143#define OPENSSL_HEADER_SSL_INTERNAL_H
Adam Langley95c29f32014-06-20 12:00:00 -0700144
145#include <openssl/base.h>
146
Adam Langleyc9fb3752014-06-20 12:00:00 -0700147#include <openssl/aead.h>
Adam Langley95c29f32014-06-20 12:00:00 -0700148#include <openssl/ssl.h>
149#include <openssl/stack.h>
150
Steven Valdezcb966542016-08-17 16:56:14 -0400151
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400152#if defined(OPENSSL_WINDOWS)
153/* Windows defines struct timeval in winsock2.h. */
David Benjamina353cdb2016-06-09 16:48:33 -0400154OPENSSL_MSVC_PRAGMA(warning(push, 3))
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400155#include <winsock2.h>
David Benjamina353cdb2016-06-09 16:48:33 -0400156OPENSSL_MSVC_PRAGMA(warning(pop))
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400157#else
David Benjamin0abd6f22015-12-04 21:49:53 -0500158#include <sys/time.h>
David Benjamin4d2e7ce2015-05-08 13:29:45 -0400159#endif
160
Steven Valdez87eab492016-06-27 16:34:59 -0400161#if defined(__cplusplus)
162extern "C" {
163#endif
164
Adam Langleyfcf25832014-12-18 17:42:32 -0800165
David Benjamin71f07942015-04-08 02:36:59 -0400166/* 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 Braithwaite053931e2016-05-25 12:06:05 -0700174#define SSL_kCECPQ1 0x00000010L
Steven Valdez803c77a2016-09-06 14:13:43 -0400175#define SSL_kGENERIC 0x00000020L
David Benjamin71f07942015-04-08 02:36:59 -0400176
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 Valdez803c77a2016-09-06 14:13:43 -0400182#define SSL_aGENERIC 0x00000008L
David Benjamin71f07942015-04-08 02:36:59 -0400183
David Benjaminc032dfa2016-05-12 14:54:57 -0400184#define SSL_aCERT (SSL_aRSA | SSL_aECDSA)
185
David Benjamin71f07942015-04-08 02:36:59 -0400186/* Bits for |algorithm_enc| (symmetric encryption). */
Matthew Braithwaite8aaa9e12016-09-07 15:09:58 -0700187#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 Benjamin71f07942015-04-08 02:36:59 -0400195
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 Benjamin5055c762015-08-04 09:24:14 -0400206/* Bits for |algorithm_prf| (handshake digest). */
David Benjaminb0883312015-08-06 09:54:13 -0400207#define SSL_HANDSHAKE_MAC_DEFAULT 0x1
208#define SSL_HANDSHAKE_MAC_SHA256 0x2
209#define SSL_HANDSHAKE_MAC_SHA384 0x4
David Benjamin71f07942015-04-08 02:36:59 -0400210
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 Benjamin71f07942015-04-08 02:36:59 -0400215/* 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. */
220int 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 Benjaminb0883312015-08-06 09:54:13 -0400225/* 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. */
229const EVP_MD *ssl_get_handshake_digest(uint32_t algorithm_prf);
David Benjamin71f07942015-04-08 02:36:59 -0400230
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. */
237STACK_OF(SSL_CIPHER) *
238ssl_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 Benjamina1c90a52015-05-30 17:03:14 -0400243/* ssl_cipher_get_value returns the cipher suite id of |cipher|. */
244uint16_t ssl_cipher_get_value(const SSL_CIPHER *cipher);
245
David Benjamind1d80782015-07-05 11:54:09 -0400246/* 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. */
248int ssl_cipher_get_key_type(const SSL_CIPHER *cipher);
David Benjamin71f07942015-04-08 02:36:59 -0400249
David Benjaminc032dfa2016-05-12 14:54:57 -0400250/* 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. */
253int ssl_cipher_uses_certificate_auth(const SSL_CIPHER *cipher);
David Benjamin71f07942015-04-08 02:36:59 -0400254
255/* ssl_cipher_requires_server_key_exchange returns 1 if |cipher| requires a
256 * ServerKeyExchange message. Otherwise it returns 0.
257 *
David Benjaminc032dfa2016-05-12 14:54:57 -0400258 * This function may return zero while still allowing |cipher| an optional
259 * ServerKeyExchange. This is the case for plain PSK ciphers. */
David Benjamin71f07942015-04-08 02:36:59 -0400260int ssl_cipher_requires_server_key_exchange(const SSL_CIPHER *cipher);
261
David Benjaminb8d28cf2015-07-28 21:34:45 -0400262/* 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. */
265size_t ssl_cipher_get_record_split_len(const SSL_CIPHER *cipher);
266
David Benjamin71f07942015-04-08 02:36:59 -0400267
David Benjamin31a07792015-03-03 14:20:26 -0500268/* Encryption layer. */
269
270/* SSL_AEAD_CTX contains information about an AEAD that is being used to encrypt
271 * an SSL connection. */
272struct 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 Benjamin13414b32015-12-09 23:02:39 -0500277 uint8_t fixed_nonce[12];
David Benjamin31a07792015-03-03 14:20:26 -0500278 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 Valdez494650c2016-05-24 12:43:04 -0400292 /* omit_ad is non-zero if the AEAD's ad parameter should be omitted. */
293 char omit_ad;
David Benjamin13414b32015-12-09 23:02:39 -0500294 /* 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 Benjamin31a07792015-03-03 14:20:26 -0500297} /* 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. */
304SSL_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|. */
311void 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. */
315size_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. */
319size_t SSL_AEAD_CTX_max_overhead(SSL_AEAD_CTX *ctx);
320
David Benjamina7810c12016-06-06 18:54:51 -0400321/* 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|. */
325int 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 Benjamin31a07792015-03-03 14:20:26 -0500328
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 Benjamin2446db02016-06-08 18:31:42 -0400333 * If |in| and |out| alias then |out| + |explicit_nonce_len| must be == |in|. */
David Benjamin31a07792015-03-03 14:20:26 -0500334int 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 Benjamin7446a3b2015-07-25 17:53:57 -0400340/* 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. */
344typedef 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 Benjaminb8d28cf2015-07-28 21:34:45 -0400354/* Record layer. */
355
David Benjamin1db21562015-12-25 15:11:39 -0500356/* ssl_record_sequence_update increments the sequence number in |seq|. It
357 * returns one on success and zero on wraparound. */
358int ssl_record_sequence_update(uint8_t *seq, size_t seq_len);
359
David Benjaminb8d28cf2015-07-28 21:34:45 -0400360/* 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. */
365size_t ssl_record_prefix_len(const SSL *ssl);
366
367enum ssl_open_record_t {
368 ssl_open_record_success,
369 ssl_open_record_discard,
370 ssl_open_record_partial,
David Benjamin728f3542016-06-02 15:42:01 -0400371 ssl_open_record_close_notify,
372 ssl_open_record_fatal_alert,
David Benjaminb8d28cf2015-07-28 21:34:45 -0400373 ssl_open_record_error,
374};
375
David Benjamina7810c12016-06-06 18:54:51 -0400376/* tls_open_record decrypts a record from |in| in-place.
David Benjaminb8d28cf2015-07-28 21:34:45 -0400377 *
David Benjaminb8d28cf2015-07-28 21:34:45 -0400378 * 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 Benjamin728f3542016-06-02 15:42:01 -0400383 * 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 Benjamina7810c12016-06-06 18:54:51 -0400388 * record type and |*out| to the record body in |in|. Note that |*out| may be
389 * empty.
David Benjamin728f3542016-06-02 15:42:01 -0400390 *
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 Benjaminb8d28cf2015-07-28 21:34:45 -0400397 * On failure, it returns |ssl_open_record_error| and sets |*out_alert| to an
David Benjamina7810c12016-06-06 18:54:51 -0400398 * alert to emit. */
399enum 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 Benjaminb8d28cf2015-07-28 21:34:45 -0400402
403/* dtls_open_record implements |tls_open_record| for DTLS. It never returns
404 * |ssl_open_record_partial| but otherwise behaves analogously. */
David Benjamina7810c12016-06-06 18:54:51 -0400405enum 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 Benjaminb8d28cf2015-07-28 21:34:45 -0400409
David Benjamin1a01e1f2016-06-08 18:31:24 -0400410/* 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 Benjaminb8d28cf2015-07-28 21:34:45 -0400418 *
419 * TODO(davidben): Expose this as part of public API once the high-level
420 * buffer-free APIs are available. */
David Benjamin1a01e1f2016-06-08 18:31:24 -0400421size_t ssl_seal_align_prefix_len(const SSL *ssl);
David Benjaminb8d28cf2015-07-28 21:34:45 -0400422
423/* ssl_max_seal_overhead returns the maximum overhead of sealing a record with
David Benjamin1a01e1f2016-06-08 18:31:24 -0400424 * |ssl|.
David Benjaminb8d28cf2015-07-28 21:34:45 -0400425 *
426 * TODO(davidben): Expose this as part of public API once the high-level
427 * buffer-free APIs are available. */
428size_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 Benjamin1a01e1f2016-06-08 18:31:24 -0400435 * 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 Benjaminb8d28cf2015-07-28 21:34:45 -0400439 *
David Benjamin1a01e1f2016-06-08 18:31:24 -0400440 * |in| and |out| may not alias. */
David Benjaminb8d28cf2015-07-28 21:34:45 -0400441int 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
444enum 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. */
451int 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 Benjamin728f3542016-06-02 15:42:01 -0400455/* 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. */
459enum ssl_open_record_t ssl_process_alert(SSL *ssl, uint8_t *out_alert,
460 const uint8_t *in, size_t in_len);
461
David Benjaminb8d28cf2015-07-28 21:34:45 -0400462
David Benjaminb4d65fd2015-05-29 17:11:21 -0400463/* Private key operations. */
464
nagendra modadugu601448a2015-07-24 09:31:31 -0700465/* ssl_has_private_key returns one if |ssl| has a private key
466 * configured and zero otherwise. */
David Benjamin32a66d52016-07-13 22:03:11 -0400467int ssl_has_private_key(const SSL *ssl);
nagendra modadugu601448a2015-07-24 09:31:31 -0700468
David Benjamin0c0b7e12016-07-14 13:47:55 -0400469/* ssl_is_ecdsa_key_type returns one if |type| is an ECDSA key type and zero
470 * otherwise. */
471int ssl_is_ecdsa_key_type(int type);
472
David Benjaminb4d65fd2015-05-29 17:11:21 -0400473/* ssl_private_key_* call the corresponding function on the
474 * |SSL_PRIVATE_KEY_METHOD| for |ssl|, if configured. Otherwise, they implement
David Benjamind1d80782015-07-05 11:54:09 -0400475 * the operation with |EVP_PKEY|. */
David Benjaminb4d65fd2015-05-29 17:11:21 -0400476
David Benjamind1d80782015-07-05 11:54:09 -0400477int ssl_private_key_type(SSL *ssl);
David Benjaminb4d65fd2015-05-29 17:11:21 -0400478
David Benjamind1d80782015-07-05 11:54:09 -0400479size_t ssl_private_key_max_signature_len(SSL *ssl);
David Benjaminb4d65fd2015-05-29 17:11:21 -0400480
481enum ssl_private_key_result_t ssl_private_key_sign(
Steven Valdezf0451ca2016-06-29 13:16:27 -0400482 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 Benjaminb4d65fd2015-05-29 17:11:21 -0400484
nagendra modadugu3398dbf2015-08-07 14:07:52 -0700485enum 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 Benjamind3440b42016-07-14 14:52:41 -0400489enum 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 modadugu3398dbf2015-08-07 14:07:52 -0700492
David Benjamin1fb125c2016-07-08 18:52:12 -0700493/* ssl_private_key_supports_signature_algorithm returns one if |ssl|'s private
494 * key supports |signature_algorithm| and zero otherwise. */
495int ssl_private_key_supports_signature_algorithm(SSL *ssl,
496 uint16_t signature_algorithm);
497
Steven Valdez2b8415e2016-06-30 13:27:23 -0400498/* ssl_public_key_verify verifies that the |signature| is valid for the public
499 * key |pkey| and input |in|, using the |signature_algorithm| specified. */
500int 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 Benjaminb4d65fd2015-05-29 17:11:21 -0400504
David Benjamin1fb125c2016-07-08 18:52:12 -0700505
Adam Langley09505632015-07-30 18:10:13 -0700506/* Custom extensions */
507
508/* ssl_custom_extension (a.k.a. SSL_CUSTOM_EXTENSION) is a structure that
509 * contains information about custom-extension callbacks. */
510struct 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
519void SSL_CUSTOM_EXTENSION_free(SSL_CUSTOM_EXTENSION *custom_extension);
520
521int custom_ext_add_clienthello(SSL *ssl, CBB *extensions);
522int custom_ext_parse_serverhello(SSL *ssl, int *out_alert, uint16_t value,
523 const CBS *extension);
524int custom_ext_parse_clienthello(SSL *ssl, int *out_alert, uint16_t value,
525 const CBS *extension);
526int custom_ext_add_serverhello(SSL *ssl, CBB *extensions);
527
528
David Benjamin9550c3a2015-08-05 08:50:34 -0400529/* 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. */
537int 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. */
544int 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. */
548void ssl3_free_handshake_buffer(SSL *ssl);
549
550/* ssl3_free_handshake_hash releases the handshake hash. */
David Benjamin0d56f882015-12-19 17:05:56 -0500551void ssl3_free_handshake_hash(SSL *ssl);
David Benjamin9550c3a2015-08-05 08:50:34 -0400552
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. */
555int ssl3_update_handshake_hash(SSL *ssl, const uint8_t *in, size_t in_len);
556
557
Steven Valdezce902a92016-05-17 11:47:53 -0400558/* ECDH groups. */
David Benjamin4298d772015-12-19 00:18:25 -0500559
David Benjamin4298d772015-12-19 00:18:25 -0500560/* An SSL_ECDH_METHOD is an implementation of ECDH-like key exchanges for
561 * TLS. */
562struct ssl_ecdh_method_st {
563 int nid;
Steven Valdezce902a92016-05-17 11:47:53 -0400564 uint16_t group_id;
David Benjamin4298d772015-12-19 00:18:25 -0500565 const char name[8];
566
567 /* cleanup releases state in |ctx|. */
568 void (*cleanup)(SSL_ECDH_CTX *ctx);
569
Matt Braithwaitef4ce8e52016-05-16 14:27:14 -0700570 /* offer generates a keypair and writes the public value to
David Benjamin4298d772015-12-19 00:18:25 -0500571 * |out_public_key|. It returns one on success and zero on error. */
Matt Braithwaitef4ce8e52016-05-16 14:27:14 -0700572 int (*offer)(SSL_ECDH_CTX *ctx, CBB *out_public_key);
David Benjamin4298d772015-12-19 00:18:25 -0500573
Matt Braithwaitef4ce8e52016-05-16 14:27:14 -0700574 /* 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 Braithwaitee25775b2016-05-16 16:31:05 -0700593
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 Benjamin4298d772015-12-19 00:18:25 -0500602} /* SSL_ECDH_METHOD */;
603
Steven Valdezce902a92016-05-17 11:47:53 -0400604/* 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 Benjamin4298d772015-12-19 00:18:25 -0500606 * zero. */
Steven Valdezce902a92016-05-17 11:47:53 -0400607int ssl_nid_to_group_id(uint16_t *out_group_id, int nid);
David Benjamin4298d772015-12-19 00:18:25 -0500608
Alessandro Ghedini5fd18072016-09-28 21:04:25 +0100609/* 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. */
612int ssl_name_to_group_id(uint16_t *out_group_id, const char *name, size_t len);
613
Steven Valdezce902a92016-05-17 11:47:53 -0400614/* SSL_ECDH_CTX_init sets up |ctx| for use with curve |group_id|. It returns one
David Benjamin4298d772015-12-19 00:18:25 -0500615 * on success and zero on error. */
Steven Valdezce902a92016-05-17 11:47:53 -0400616int SSL_ECDH_CTX_init(SSL_ECDH_CTX *ctx, uint16_t group_id);
David Benjamin4298d772015-12-19 00:18:25 -0500617
David Benjamin974c7ba2015-12-19 16:58:04 -0500618/* 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|. */
620void SSL_ECDH_CTX_init_for_dhe(SSL_ECDH_CTX *ctx, DH *params);
621
David Benjamin18a35182016-06-30 13:46:24 -0400622/* SSL_ECDH_CTX_init_for_cecpq1 sets up |ctx| for use with CECPQ1. */
623void SSL_ECDH_CTX_init_for_cecpq1(SSL_ECDH_CTX *ctx);
624
David Benjamin4298d772015-12-19 00:18:25 -0500625/* SSL_ECDH_CTX_cleanup releases memory associated with |ctx|. It is legal to
626 * call it in the zero state. */
627void SSL_ECDH_CTX_cleanup(SSL_ECDH_CTX *ctx);
628
Steven Valdez143e8b32016-07-11 13:19:03 -0400629/* SSL_ECDH_CTX_get_id returns the group ID for |ctx|. */
630uint16_t SSL_ECDH_CTX_get_id(const SSL_ECDH_CTX *ctx);
631
Matt Braithwaitee25775b2016-05-16 16:31:05 -0700632/* SSL_ECDH_CTX_get_key calls the |get_key| method of |SSL_ECDH_METHOD|. */
633int 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|. */
636int SSL_ECDH_CTX_add_key(SSL_ECDH_CTX *ctx, CBB *cbb, CBB *out_contents);
637
Matt Braithwaitef4ce8e52016-05-16 14:27:14 -0700638/* SSL_ECDH_CTX_offer calls the |offer| method of |SSL_ECDH_METHOD|. */
639int SSL_ECDH_CTX_offer(SSL_ECDH_CTX *ctx, CBB *out_public_key);
David Benjamin4298d772015-12-19 00:18:25 -0500640
Matt Braithwaitef4ce8e52016-05-16 14:27:14 -0700641/* SSL_ECDH_CTX_accept calls the |accept| method of |SSL_ECDH_METHOD|. */
642int 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|. */
648int 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 Benjamin4298d772015-12-19 00:18:25 -0500651
David Benjamin060cfb02016-05-12 00:43:05 -0400652/* Handshake messages. */
653
David Benjamin29a83c52016-06-17 19:12:54 -0400654/* 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 Benjamin060cfb02016-05-12 00:43:05 -0400660/* ssl_max_handshake_message_len returns the maximum number of bytes permitted
661 * in a handshake message for |ssl|. */
662size_t ssl_max_handshake_message_len(const SSL *ssl);
663
David Benjaminec847ce2016-06-17 19:30:47 -0400664/* dtls_clear_incoming_messages releases all buffered incoming messages. */
665void dtls_clear_incoming_messages(SSL *ssl);
666
David Benjamin61672812016-07-14 23:10:43 -0400667/* dtls_has_incoming_messages returns one if there are buffered incoming
668 * messages ahead of the current message and zero otherwise. */
669int dtls_has_incoming_messages(const SSL *ssl);
670
David Benjamin29a83c52016-06-17 19:12:54 -0400671typedef 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. */
679void dtls_clear_outgoing_messages(SSL *ssl);
680
David Benjamin060cfb02016-05-12 00:43:05 -0400681
David Benjamin4e9cc712016-06-01 20:16:03 -0400682/* Callbacks. */
683
684/* ssl_do_info_callback calls |ssl|'s info callback, if set. */
685void 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 Benjaminc0279992016-09-19 20:15:07 -0400688void ssl_do_msg_callback(SSL *ssl, int is_write, int content_type,
David Benjamin4e9cc712016-06-01 20:16:03 -0400689 const void *buf, size_t len);
690
691
David Benjaminb8d28cf2015-07-28 21:34:45 -0400692/* Transport buffers. */
693
694/* ssl_read_buffer returns a pointer to contents of the read buffer. */
695uint8_t *ssl_read_buffer(SSL *ssl);
696
697/* ssl_read_buffer_len returns the length of the read buffer. */
698size_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. */
707int 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|. */
713void 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. */
717void 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. */
721void 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. */
725int 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. */
731int 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. */
735void 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. */
740int 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. */
744void ssl_write_buffer_clear(SSL *ssl);
745
746
David Benjamin75836432016-06-17 18:48:29 -0400747/* Certificate functions. */
748
David Benjamin32a66d52016-07-13 22:03:11 -0400749/* ssl_has_certificate returns one if a certificate and private key are
750 * configured and zero otherwise. */
751int ssl_has_certificate(const SSL *ssl);
752
David Benjamin5c900c82016-07-13 23:03:26 -0400753/* 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|. */
759STACK_OF(X509) *ssl_parse_cert_chain(SSL *ssl, uint8_t *out_alert,
760 uint8_t *out_leaf_sha256, CBS *cbs);
761
David Benjamin75836432016-06-17 18:48:29 -0400762/* ssl_add_cert_to_cbb adds |x509| to |cbb|. It returns one on success and zero
763 * on error. */
764int ssl_add_cert_to_cbb(CBB *cbb, X509 *x509);
765
David Benjamin32a66d52016-07-13 22:03:11 -0400766/* 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. */
769int ssl_add_cert_chain(SSL *ssl, CBB *cbb);
770
David Benjamine0332e82016-07-13 22:40:36 -0400771/* 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. */
775STACK_OF(X509_NAME) *
776 ssl_parse_client_CA_list(SSL *ssl, uint8_t *out_alert, CBS *cbs);
777
David Benjamin32a66d52016-07-13 22:03:11 -0400778/* 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. */
781int ssl_add_client_CA_list(SSL *ssl, CBB *cbb);
782
Steven Valdezbf5aa842016-07-15 07:07:40 -0400783/* 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. */
786int ssl_check_leaf_certificate(SSL *ssl, X509 *leaf);
787
David Benjamin13f1ebe2016-07-20 10:11:04 +0200788/* 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. */
791int ssl_do_client_cert_cb(SSL *ssl, int *out_should_retry);
792
David Benjamin75836432016-06-17 18:48:29 -0400793
Steven Valdez143e8b32016-07-11 13:19:03 -0400794/* 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. */
800int 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. */
805int 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. */
811int tls13_get_context_hashes(SSL *ssl, uint8_t *out, size_t *out_len);
812
813enum 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. */
823int 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. */
831int tls13_set_handshake_traffic(SSL *ssl);
832
Steven Valdez1dc53d22016-07-26 12:27:38 -0400833/* tls13_rotate_traffic_key derives the next read or write traffic secret. It
834 * returns one on success and zero on error. */
835int tls13_rotate_traffic_key(SSL *ssl, enum evp_aead_direction_t direction);
836
Steven Valdez143e8b32016-07-11 13:19:03 -0400837/* 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. */
840int tls13_derive_traffic_secret_0(SSL *ssl);
841
842/* tls13_finalize_keys derives the |exporter_secret| and |resumption_secret|. */
843int tls13_finalize_keys(SSL *ssl);
844
845/* tls13_export_keying_material provides and exporter interface to use the
846 * |exporter_secret|. */
847int 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. */
856int tls13_finished_mac(SSL *ssl, uint8_t *out, size_t *out_len, int is_server);
857
Steven Valdez4aa154e2016-07-29 14:32:55 -0400858/* 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. */
861int 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. */
867int tls13_resumption_context(SSL *ssl, uint8_t *out, size_t out_len,
868 const SSL_SESSION *session);
869
Steven Valdez143e8b32016-07-11 13:19:03 -0400870
871/* Handshake functions. */
872
873enum 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 Benjaminf2401eb2016-07-18 22:25:05 +0200879 ssl_hs_flush_and_read_message,
Steven Valdez143e8b32016-07-11 13:19:03 -0400880 ssl_hs_x509_lookup,
881 ssl_hs_private_key_operation,
882};
883
884struct 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 Benjaminf5d2cd02016-10-06 19:39:20 -0400901 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 Benjaminc8b6b4f2016-09-08 23:47:48 -0400922 /* ecdh_ctx is the active client ECDH offer in TLS 1.3. */
923 SSL_ECDH_CTX ecdh_ctx;
David Benjamin4fe3c902016-08-16 02:17:03 -0400924
925 /* retry_group is the group ID selected by the server in HelloRetryRequest in
926 * TLS 1.3. */
Steven Valdez5440fe02016-07-18 12:40:30 -0400927 uint16_t retry_group;
David Benjamin4fe3c902016-08-16 02:17:03 -0400928
929 /* key_share_bytes is the value of the previously sent KeyShare extension by
930 * the client in TLS 1.3. */
Steven Valdez5440fe02016-07-18 12:40:30 -0400931 uint8_t *key_share_bytes;
932 size_t key_share_bytes_len;
David Benjamin4fe3c902016-08-16 02:17:03 -0400933
934 /* public_key, for servers, is the key share to be sent to the client in TLS
935 * 1.3. */
Steven Valdez143e8b32016-07-11 13:19:03 -0400936 uint8_t *public_key;
937 size_t public_key_len;
938
David Benjamin0fc37ef2016-08-17 15:29:46 -0400939 /* 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 Benjamina0486782016-10-06 19:11:32 -0400946 /* session_tickets_sent, in TLS 1.3, is the number of tickets the server has
947 * sent. */
Steven Valdez1e6f11a2016-07-27 11:10:52 -0400948 uint8_t session_tickets_sent;
David Benjaminbac75b82016-09-16 19:34:02 -0400949
David Benjamina0486782016-10-06 19:11:32 -0400950 /* 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 Benjaminbac75b82016-09-16 19:34:02 -0400970 /* 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 Benjamina0486782016-10-06 19:11:32 -0400973
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 Valdez143e8b32016-07-11 13:19:03 -0400982} /* SSL_HANDSHAKE */;
983
984SSL_HANDSHAKE *ssl_handshake_new(enum ssl_hs_wait_t (*do_handshake)(SSL *ssl));
985
986/* ssl_handshake_free releases all memory associated with |hs|. */
987void 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. */
991int tls13_handshake(SSL *ssl);
992
993/* The following are implementations of |do_handshake| for the client and
994 * server. */
995enum ssl_hs_wait_t tls13_client_handshake(SSL *ssl);
996enum ssl_hs_wait_t tls13_server_handshake(SSL *ssl);
997
Steven Valdez8e1c7be2016-07-26 12:39:22 -0400998/* tls13_post_handshake processes a post-handshake message. It returns one on
999 * success and zero on failure. */
1000int tls13_post_handshake(SSL *ssl);
1001
Steven Valdez143e8b32016-07-11 13:19:03 -04001002/* 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. */
1004int tls13_check_message_type(SSL *ssl, int type);
1005
David Benjamin4087df92016-08-01 20:16:31 -04001006int tls13_process_certificate(SSL *ssl, int allow_anonymous);
Steven Valdez143e8b32016-07-11 13:19:03 -04001007int tls13_process_certificate_verify(SSL *ssl);
1008int tls13_process_finished(SSL *ssl);
1009
1010int tls13_prepare_certificate(SSL *ssl);
1011enum ssl_private_key_result_t tls13_prepare_certificate_verify(
1012 SSL *ssl, int is_first_run);
1013int tls13_prepare_finished(SSL *ssl);
Steven Valdez1e6f11a2016-07-27 11:10:52 -04001014int tls13_process_new_session_ticket(SSL *ssl);
Steven Valdez143e8b32016-07-11 13:19:03 -04001015
Steven Valdez7259f2f2016-08-02 16:55:05 -04001016int 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);
1019int 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);
1023int ssl_ext_key_share_add_serverhello(SSL *ssl, CBB *out);
Steven Valdez143e8b32016-07-11 13:19:03 -04001024
Steven Valdez4aa154e2016-07-29 14:32:55 -04001025int ssl_ext_pre_shared_key_parse_serverhello(SSL *ssl, uint8_t *out_alert,
1026 CBS *contents);
1027int ssl_ext_pre_shared_key_parse_clienthello(SSL *ssl,
1028 SSL_SESSION **out_session,
1029 uint8_t *out_alert, CBS *contents);
1030int ssl_ext_pre_shared_key_add_serverhello(SSL *ssl, CBB *out);
1031
Steven Valdez5440fe02016-07-18 12:40:30 -04001032int ssl_add_client_hello_body(SSL *ssl, CBB *body);
1033
David Benjamin4fe3c902016-08-16 02:17:03 -04001034/* 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. */
1036void ssl_clear_tls13_state(SSL *ssl);
1037
Steven Valdez143e8b32016-07-11 13:19:03 -04001038
David Benjamine776cc22016-07-19 07:26:49 +02001039/* 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|. */
1044int 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. */
1052int ssl_log_secret(const SSL *ssl, const char *label, const uint8_t *secret,
1053 size_t secret_len);
1054
1055
David Benjamine14ff062016-08-09 16:21:24 -04001056/* ClientHello functions. */
1057
1058int ssl_early_callback_init(SSL *ssl, struct ssl_early_callback_ctx *ctx,
1059 const uint8_t *in, size_t in_len);
1060
1061int ssl_early_callback_get_extension(const struct ssl_early_callback_ctx *ctx,
1062 CBS *out, uint16_t extension_type);
1063
1064STACK_OF(SSL_CIPHER) *
David Benjamin1deb41b2016-08-09 19:36:38 -04001065 ssl_parse_client_cipher_list(const struct ssl_early_callback_ctx *ctx);
1066
1067int ssl_client_cipher_list_contains_cipher(
1068 const struct ssl_early_callback_ctx *client_hello, uint16_t id);
David Benjamine14ff062016-08-09 16:21:24 -04001069
1070
David Benjamin65ac9972016-09-02 21:35:25 -04001071/* GREASE. */
1072
1073enum ssl_grease_index_t {
1074 ssl_grease_cipher = 0,
1075 ssl_grease_group,
1076 ssl_grease_extension1,
1077 ssl_grease_extension2,
David Benjamind9791bf2016-09-27 16:39:52 -04001078 ssl_grease_version,
David Benjamin1a5e8ec2016-10-07 15:19:18 -04001079 ssl_grease_ticket_extension,
David Benjamin65ac9972016-09-02 21:35:25 -04001080};
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. */
1086uint16_t ssl_get_grease_value(const SSL *ssl, enum ssl_grease_index_t index);
1087
1088
David Benjamin71f07942015-04-08 02:36:59 -04001089/* Underdocumented functions.
1090 *
1091 * Functions below here haven't been touched up and may be underdocumented. */
1092
Adam Langley1258b6a2014-06-20 12:00:00 -07001093#define TLSEXT_CHANNEL_ID_SIZE 128
Adam Langley95c29f32014-06-20 12:00:00 -07001094
David Benjamine518f652014-10-13 16:12:45 -04001095/* From RFC4492, used in encoding the curve type in ECParameters */
Adam Langleyfcf25832014-12-18 17:42:32 -08001096#define NAMED_CURVE_TYPE 3
Adam Langley95c29f32014-06-20 12:00:00 -07001097
David Benjamin5ca39fb2015-03-01 23:57:54 -05001098enum ssl_hash_message_t {
1099 ssl_dont_hash_message,
1100 ssl_hash_message,
1101};
David Benjamin590cbe92014-08-25 21:34:56 -04001102
Adam Langleyfcf25832014-12-18 17:42:32 -08001103typedef struct cert_st {
David Benjamind1d80782015-07-05 11:54:09 -04001104 X509 *x509;
1105 EVP_PKEY *privatekey;
1106 /* Chain for this certificate */
1107 STACK_OF(X509) *chain;
David Benjaminf31e6812014-11-13 18:05:55 -05001108
David Benjaminb4d65fd2015-05-29 17:11:21 -04001109 /* 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 Langleyfcf25832014-12-18 17:42:32 -08001113 /* For clients the following masks are of *disabled* key and auth algorithms
David Benjaminc7817d82015-11-05 18:28:33 -05001114 * based on the current configuration.
Adam Langleyfcf25832014-12-18 17:42:32 -08001115 *
1116 * TODO(davidben): Remove these. They get checked twice: when sending the
David Benjaminc7817d82015-11-05 18:28:33 -05001117 * ClientHello and when processing the ServerHello. */
David Benjamin107db582015-04-08 00:41:59 -04001118 uint32_t mask_k;
1119 uint32_t mask_a;
Adam Langley95c29f32014-06-20 12:00:00 -07001120
Adam Langleyfcf25832014-12-18 17:42:32 -08001121 DH *dh_tmp;
1122 DH *(*dh_tmp_cb)(SSL *ssl, int is_export, int keysize);
David Benjamindd978782015-04-24 15:20:13 -04001123
David Benjamin0fc37ef2016-08-17 15:29:46 -04001124 /* sigalgs, if non-NULL, is the set of signature algorithms supported by
1125 * |privatekey| in decreasing order of preference. */
David Benjamind246b812016-07-08 15:07:02 -07001126 uint16_t *sigalgs;
David Benjamin0fc37ef2016-08-17 15:29:46 -04001127 size_t num_sigalgs;
Adam Langley95c29f32014-06-20 12:00:00 -07001128
Adam Langleyfcf25832014-12-18 17:42:32 -08001129 /* 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 Langleyd323f4b2016-03-01 15:58:14 -08001137
1138 /* Optional X509_STORE for certificate validation. If NULL the parent SSL_CTX
1139 * store is used instead. */
1140 X509_STORE *verify_store;
Adam Langleyfcf25832014-12-18 17:42:32 -08001141} CERT;
Adam Langley95c29f32014-06-20 12:00:00 -07001142
Adam Langleyfcf25832014-12-18 17:42:32 -08001143/* SSL_METHOD is a compatibility structure to support the legacy version-locked
1144 * methods. */
1145struct 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 Benjamin82c9e902014-12-12 15:55:27 -05001153
1154/* Used to hold functions for SSLv2 or SSLv3/TLSv1 functions */
Adam Langleyfcf25832014-12-18 17:42:32 -08001155struct ssl_protocol_method_st {
David Benjamin9e13e1a2015-03-05 01:56:32 -05001156 /* is_dtls is one if the protocol is DTLS and zero otherwise. */
1157 char is_dtls;
David Benjaminb6a0a512016-06-21 10:33:21 -04001158 /* 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 Benjamin2dc02042016-09-19 19:57:37 -04001162 /* 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 Benjaminb6a0a512016-06-21 10:33:21 -04001166 /* 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 Benjamina41280d2015-11-26 02:16:49 -05001169 int (*ssl_new)(SSL *ssl);
1170 void (*ssl_free)(SSL *ssl);
David Benjamin09eb6552016-07-08 14:32:11 -07001171 /* 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 Benjamin528bd262016-07-08 09:34:05 -07001177 /* 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 Benjamin4497e582016-07-27 17:51:49 -04001181 /* 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 Benjamin163f29a2016-07-28 11:05:58 -04001184 /* 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 Benjaminf0ee9072016-06-15 17:44:37 -04001191 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 Benjamina1c90a52015-05-30 17:03:14 -04001195 /* supports_cipher returns one if |cipher| is supported by this protocol and
1196 * zero otherwise. */
1197 int (*supports_cipher)(const SSL_CIPHER *cipher);
David Benjamin75836432016-06-17 18:48:29 -04001198 /* 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 Benjaminaa7734b2016-06-07 16:40:46 -04001208 /* send_change_cipher_spec sends a ChangeCipherSpec message. */
David Benjamin352d0a92016-06-28 11:22:02 -04001209 int (*send_change_cipher_spec)(SSL *ssl);
David Benjaminaa7734b2016-06-07 16:40:46 -04001210 /* 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 Benjamin61672812016-07-14 23:10:43 -04001216 /* 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 Langleyfcf25832014-12-18 17:42:32 -08001224};
David Benjamin82c9e902014-12-12 15:55:27 -05001225
Adam Langleyfcf25832014-12-18 17:42:32 -08001226/* 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. */
1228struct ssl3_enc_method {
David Benjamin928f32a2015-12-29 23:32:29 -05001229 /* 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 Benjaminbaa12162015-12-29 19:13:58 -05001237 int (*final_finish_mac)(SSL *ssl, int from_server, uint8_t *out);
Adam Langleyfcf25832014-12-18 17:42:32 -08001238};
Adam Langley95c29f32014-06-20 12:00:00 -07001239
David Benjamin593047f2015-05-08 13:08:52 -04001240/* 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 Benjamin593047f2015-05-08 13:08:52 -04001251struct 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 Benjamin593047f2015-05-08 13:08:52 -04001257};
1258
David Benjamin528bd262016-07-08 09:34:05 -07001259/* An hm_fragment is an incoming DTLS message, possibly not yet assembled. */
David Benjamin593047f2015-05-08 13:08:52 -04001260typedef struct hm_fragment_st {
David Benjamin528bd262016-07-08 09:34:05 -07001261 /* 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 Benjamin593047f2015-05-08 13:08:52 -04001272 uint8_t *reassembly;
1273} hm_fragment;
1274
1275typedef 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 Benjamin593047f2015-05-08 13:08:52 -04001291 uint16_t handshake_write_seq;
David Benjamin593047f2015-05-08 13:08:52 -04001292 uint16_t handshake_read_seq;
1293
1294 /* save last sequence number for retransmissions */
1295 uint8_t last_write_sequence[8];
1296
David Benjaminec847ce2016-06-17 19:30:47 -04001297 /* 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 Benjamin593047f2015-05-08 13:08:52 -04001302
David Benjamin29a83c52016-06-17 19:12:54 -04001303 /* 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 Benjamin593047f2015-05-08 13:08:52 -04001307
1308 unsigned int mtu; /* max DTLS packet size */
1309
David Benjamin593047f2015-05-08 13:08:52 -04001310 /* 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 Benjamin4d2e7ce2015-05-08 13:29:45 -04001315 * timeout. */
1316 struct timeval next_timeout;
David Benjamin593047f2015-05-08 13:08:52 -04001317
Taylor Brandstetter376a0fe2016-05-10 19:30:28 -07001318 /* timeout_duration_ms is the timeout duration in milliseconds. */
1319 unsigned timeout_duration_ms;
David Benjamin593047f2015-05-08 13:08:52 -04001320} DTLS1_STATE;
1321
David Benjamin338fcaf2014-12-11 01:20:52 -05001322extern const SSL3_ENC_METHOD TLSv1_enc_data;
David Benjamin338fcaf2014-12-11 01:20:52 -05001323extern const SSL3_ENC_METHOD SSLv3_enc_data;
Adam Langley95c29f32014-06-20 12:00:00 -07001324
Steven Valdez5b986082016-09-01 12:29:49 -04001325/* 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 Valdez1e6f11a2016-07-27 11:10:52 -04001331
Adam Langley95c29f32014-06-20 12:00:00 -07001332CERT *ssl_cert_new(void);
1333CERT *ssl_cert_dup(CERT *cert);
Adam Langley95c29f32014-06-20 12:00:00 -07001334void ssl_cert_clear_certs(CERT *c);
1335void ssl_cert_free(CERT *c);
David Benjamindc2aea22015-10-18 12:50:32 -04001336int ssl_get_new_session(SSL *ssl, int is_server);
Steven Valdez1e6f11a2016-07-27 11:10:52 -04001337int ssl_encrypt_ticket(SSL *ssl, CBB *out, const SSL_SESSION *session);
David Benjamine3aa1d92015-06-16 15:34:50 -04001338
Steven Valdez4aa154e2016-07-29 14:32:55 -04001339/* ssl_session_is_context_valid returns one if |session|'s session ID context
1340 * matches the one set on |ssl| and zero otherwise. */
1341int 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. */
1345int ssl_session_is_time_valid(const SSL *ssl, const SSL_SESSION *session);
1346
David Benjamin4d0be242016-09-01 01:10:07 -04001347void ssl_set_session(SSL *ssl, SSL_SESSION *session);
1348
David Benjamine3aa1d92015-06-16 15:34:50 -04001349enum 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|. */
1361enum 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 Valdez4aa154e2016-07-29 14:32:55 -04001365/* 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 Valdez87eab492016-06-27 16:34:59 -04001372/* 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. */
1375OPENSSL_EXPORT SSL_SESSION *SSL_SESSION_dup(SSL_SESSION *session,
Steven Valdez4aa154e2016-07-29 14:32:55 -04001376 int dup_flags);
Steven Valdez87eab492016-06-27 16:34:59 -04001377
Adam Langley858a88d2014-06-20 12:00:00 -07001378void ssl_cipher_preference_list_free(
Adam Langleyfcf25832014-12-18 17:42:32 -08001379 struct ssl_cipher_preference_list_st *cipher_list);
David Benjamin0d56f882015-12-19 17:05:56 -05001380struct ssl_cipher_preference_list_st *ssl_get_cipher_preferences(SSL *ssl);
David Benjaminea72bd02014-12-21 21:27:41 -05001381
David Benjamind1d80782015-07-05 11:54:09 -04001382int ssl_cert_set0_chain(CERT *cert, STACK_OF(X509) *chain);
1383int ssl_cert_set1_chain(CERT *cert, STACK_OF(X509) *chain);
1384int ssl_cert_add0_chain_cert(CERT *cert, X509 *x509);
1385int ssl_cert_add1_chain_cert(CERT *cert, X509 *x509);
1386void ssl_cert_set_cert_cb(CERT *cert,
1387 int (*cb)(SSL *ssl, void *arg), void *arg);
Adam Langley95c29f32014-06-20 12:00:00 -07001388
David Benjamin7aa31d62016-08-08 21:38:32 -04001389int ssl_verify_cert_chain(SSL *ssl, long *out_verify_result,
1390 STACK_OF(X509) * cert_chain);
David Benjamin1269ddd2015-10-18 15:18:55 -04001391void ssl_update_cache(SSL *ssl, int mode);
David Benjaminf31e6812014-11-13 18:05:55 -05001392
1393/* ssl_get_compatible_server_ciphers determines the key exchange and
1394 * authentication cipher suite masks compatible with the server configuration
David Benjamin0d56f882015-12-19 17:05:56 -05001395 * and current ClientHello parameters of |ssl|. It sets |*out_mask_k| to the key
David Benjaminf31e6812014-11-13 18:05:55 -05001396 * exchange mask and |*out_mask_a| to the authentication mask. */
David Benjamin0d56f882015-12-19 17:05:56 -05001397void ssl_get_compatible_server_ciphers(SSL *ssl, uint32_t *out_mask_k,
David Benjamin107db582015-04-08 00:41:59 -04001398 uint32_t *out_mask_a);
David Benjaminf31e6812014-11-13 18:05:55 -05001399
David Benjamin0d56f882015-12-19 17:05:56 -05001400STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001401int ssl_verify_alarm_type(long type);
David Benjamin74d8bc22015-05-21 02:16:53 -04001402
David Benjamin1e6d6df2016-05-13 18:28:17 -04001403int ssl3_get_finished(SSL *ssl);
David Benjamin352d0a92016-06-28 11:22:02 -04001404int ssl3_send_change_cipher_spec(SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001405void ssl3_cleanup_key_block(SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001406int ssl3_send_alert(SSL *ssl, int level, int desc);
David Benjamin09eb6552016-07-08 14:32:11 -07001407int ssl3_get_message(SSL *ssl, int msg_type,
1408 enum ssl_hash_message_t hash_message);
David Benjamin0d56f882015-12-19 17:05:56 -05001409int ssl3_hash_current_message(SSL *ssl);
David Benjamin4497e582016-07-27 17:51:49 -04001410void ssl3_release_current_message(SSL *ssl, int free_buffer);
David Benjamin854dd652014-08-26 00:32:30 -04001411
Steven Valdez2b8415e2016-06-30 13:27:23 -04001412/* 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 Benjamin0aa25bd2016-07-08 14:44:56 -07001414 * 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. */
1416int ssl3_cert_verify_hash(SSL *ssl, const EVP_MD **out_md, uint8_t *out,
1417 size_t *out_len, uint16_t signature_algorithm);
David Benjamin854dd652014-08-26 00:32:30 -04001418
David Benjaminbaa12162015-12-29 19:13:58 -05001419int ssl3_send_finished(SSL *ssl, int a, int b);
David Benjamina1c90a52015-05-30 17:03:14 -04001420int ssl3_supports_cipher(const SSL_CIPHER *cipher);
David Benjamin0d56f882015-12-19 17:05:56 -05001421int ssl3_dispatch_alert(SSL *ssl);
David Benjamin163f29a2016-07-28 11:05:58 -04001422int ssl3_read_app_data(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len,
1423 int peek);
David Benjamina41280d2015-11-26 02:16:49 -05001424int ssl3_read_change_cipher_spec(SSL *ssl);
David Benjamina6022772015-05-30 16:22:10 -04001425void ssl3_read_close_notify(SSL *ssl);
David Benjamin163f29a2016-07-28 11:05:58 -04001426int ssl3_read_handshake_bytes(SSL *ssl, uint8_t *buf, int len);
David Benjaminc933a472015-05-30 16:14:58 -04001427int ssl3_write_app_data(SSL *ssl, const void *buf, int len);
David Benjamin0d56f882015-12-19 17:05:56 -05001428int ssl3_write_bytes(SSL *ssl, int type, const void *buf, int len);
David Benjamin0d56f882015-12-19 17:05:56 -05001429int ssl3_output_cert_chain(SSL *ssl);
Adam Langleyfcf25832014-12-18 17:42:32 -08001430const SSL_CIPHER *ssl3_choose_cipher(
David Benjaminfddbadc2016-08-09 19:53:00 -04001431 SSL *ssl, const struct ssl_early_callback_ctx *client_hello,
1432 const struct ssl_cipher_preference_list_st *srvr);
Adam Langley75712922014-10-10 16:23:43 -07001433
David Benjamin0d56f882015-12-19 17:05:56 -05001434int ssl3_new(SSL *ssl);
1435void ssl3_free(SSL *ssl);
1436int ssl3_accept(SSL *ssl);
1437int ssl3_connect(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001438
David Benjamin75836432016-06-17 18:48:29 -04001439int ssl3_init_message(SSL *ssl, CBB *cbb, CBB *body, uint8_t type);
1440int ssl3_finish_message(SSL *ssl, CBB *cbb);
1441int ssl3_write_message(SSL *ssl);
1442
David Benjaminaa7734b2016-06-07 16:40:46 -04001443void ssl3_expect_flight(SSL *ssl);
1444void ssl3_received_flight(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001445
David Benjamin75836432016-06-17 18:48:29 -04001446int dtls1_init_message(SSL *ssl, CBB *cbb, CBB *body, uint8_t type);
1447int dtls1_finish_message(SSL *ssl, CBB *cbb);
1448int dtls1_write_message(SSL *ssl);
David Benjaminc6604172016-06-02 16:38:35 -04001449
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. */
1453int dtls1_get_record(SSL *ssl);
1454
David Benjamin163f29a2016-07-28 11:05:58 -04001455int dtls1_read_app_data(SSL *ssl, int *out_got_handshake, uint8_t *buf, int len,
1456 int peek);
David Benjamina41280d2015-11-26 02:16:49 -05001457int dtls1_read_change_cipher_spec(SSL *ssl);
David Benjamina6022772015-05-30 16:22:10 -04001458void dtls1_read_close_notify(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001459
David Benjamin0d56f882015-12-19 17:05:56 -05001460int dtls1_write_app_data(SSL *ssl, const void *buf, int len);
David Benjamin45d45c12016-06-07 15:20:49 -04001461
1462/* dtls1_write_record sends a record. It returns one on success and <= 0 on
1463 * error. */
1464int dtls1_write_record(SSL *ssl, int type, const uint8_t *buf, size_t len,
1465 enum dtls1_use_epoch_t use_epoch);
Adam Langley95c29f32014-06-20 12:00:00 -07001466
David Benjamin352d0a92016-06-28 11:22:02 -04001467int dtls1_send_change_cipher_spec(SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001468int dtls1_send_finished(SSL *ssl, int a, int b, const char *sender, int slen);
David Benjaminaad50db2016-06-23 17:49:12 -04001469int dtls1_retransmit_outgoing_messages(SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001470void dtls1_clear_record_buffer(SSL *ssl);
David Benjaminc6604172016-06-02 16:38:35 -04001471int dtls1_parse_fragment(CBS *cbs, struct hm_header_st *out_hdr,
1472 CBS *out_body);
David Benjamin0d56f882015-12-19 17:05:56 -05001473int dtls1_check_timeout_num(SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001474int dtls1_handshake_write(SSL *ssl);
David Benjaminaa7734b2016-06-07 16:40:46 -04001475void dtls1_expect_flight(SSL *ssl);
1476void dtls1_received_flight(SSL *ssl);
David Benjamin2fa83de2015-02-08 01:40:08 -05001477
David Benjamina1c90a52015-05-30 17:03:14 -04001478int dtls1_supports_cipher(const SSL_CIPHER *cipher);
David Benjamin0d56f882015-12-19 17:05:56 -05001479void dtls1_start_timer(SSL *ssl);
1480void dtls1_stop_timer(SSL *ssl);
1481int dtls1_is_timer_expired(SSL *ssl);
1482void dtls1_double_timeout(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001483unsigned int dtls1_min_mtu(void);
1484
David Benjamin0d56f882015-12-19 17:05:56 -05001485int dtls1_new(SSL *ssl);
1486int dtls1_accept(SSL *ssl);
1487int dtls1_connect(SSL *ssl);
1488void dtls1_free(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001489
David Benjamin09eb6552016-07-08 14:32:11 -07001490int dtls1_get_message(SSL *ssl, int mt, enum ssl_hash_message_t hash_message);
David Benjamin528bd262016-07-08 09:34:05 -07001491int dtls1_hash_current_message(SSL *ssl);
David Benjamin4497e582016-07-27 17:51:49 -04001492void dtls1_release_current_message(SSL *ssl, int free_buffer);
David Benjamin0d56f882015-12-19 17:05:56 -05001493int dtls1_dispatch_alert(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001494
David Benjamin30152fd2016-05-05 20:45:48 -04001495/* ssl_is_wbio_buffered returns one if |ssl|'s write BIO is buffered and zero
1496 * otherwise. */
1497int ssl_is_wbio_buffered(const SSL *ssl);
1498
David Benjaminb095f0f2016-05-05 21:50:24 -04001499int ssl_init_wbio_buffer(SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001500void ssl_free_wbio_buffer(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001501
David Benjamin0d56f882015-12-19 17:05:56 -05001502int tls1_change_cipher_state(SSL *ssl, int which);
1503int tls1_setup_key_block(SSL *ssl);
1504int tls1_handshake_digest(SSL *ssl, uint8_t *out, size_t out_len);
David Benjamin0d56f882015-12-19 17:05:56 -05001505int tls1_generate_master_secret(SSL *ssl, uint8_t *out, const uint8_t *premaster,
David Benjamin31b1d812014-12-23 10:01:09 -05001506 size_t premaster_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001507
Steven Valdez5440fe02016-07-18 12:40:30 -04001508/* 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. */
1511void 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 Valdezce902a92016-05-17 11:47:53 -04001515/* 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 Benjamin4298d772015-12-19 00:18:25 -05001517 * preferences are checked; the peer (the server) does not send preferences. */
Steven Valdezce902a92016-05-17 11:47:53 -04001518int tls1_check_group_id(SSL *ssl, uint16_t group_id);
Sigbjorn Vik2b23d242015-06-29 15:07:26 +02001519
Steven Valdezce902a92016-05-17 11:47:53 -04001520/* 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 Benjamin4298d772015-12-19 00:18:25 -05001522 * found, it returns zero. */
Steven Valdezce902a92016-05-17 11:47:53 -04001523int tls1_get_shared_group(SSL *ssl, uint16_t *out_group_id);
David Benjamin072334d2014-07-13 16:24:27 -04001524
1525/* tls1_set_curves converts the array of |ncurves| NIDs pointed to by |curves|
Steven Valdezce902a92016-05-17 11:47:53 -04001526 * 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. */
1529int tls1_set_curves(uint16_t **out_group_ids, size_t *out_group_ids_len,
Adam Langleyfcf25832014-12-18 17:42:32 -08001530 const int *curves, size_t ncurves);
David Benjamin072334d2014-07-13 16:24:27 -04001531
Alessandro Ghedini5fd18072016-09-28 21:04:25 +01001532/* 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. */
1536int tls1_set_curves_list(uint16_t **out_group_ids, size_t *out_group_ids_len,
1537 const char *curves);
1538
David Benjamin033e5f42014-11-13 18:47:41 -05001539/* 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 Benjamin0d56f882015-12-19 17:05:56 -05001542int tls1_check_ec_cert(SSL *ssl, X509 *x);
David Benjamin033e5f42014-11-13 18:47:41 -05001543
David Benjamine8d53502015-10-10 14:13:23 -04001544/* 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.) */
1548int ssl_add_clienthello_tlsext(SSL *ssl, CBB *out, size_t header_len);
1549
David Benjamin56380462015-10-10 14:59:09 -04001550int ssl_add_serverhello_tlsext(SSL *ssl, CBB *out);
David Benjamine14ff062016-08-09 16:21:24 -04001551int ssl_parse_clienthello_tlsext(
1552 SSL *ssl, const struct ssl_early_callback_ctx *client_hello);
David Benjamin0d56f882015-12-19 17:05:56 -05001553int ssl_parse_serverhello_tlsext(SSL *ssl, CBS *cbs);
Adam Langley95c29f32014-06-20 12:00:00 -07001554
Adam Langleyfcf25832014-12-18 17:42:32 -08001555#define tlsext_tick_md EVP_sha256
David Benjamine3aa1d92015-06-16 15:34:50 -04001556
David Benjaminef1b0092015-11-21 14:05:44 -05001557/* 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 Benjamine3aa1d92015-06-16 15:34:50 -04001561 * error. */
1562int tls_process_ticket(SSL *ssl, SSL_SESSION **out_session,
David Benjaminef1b0092015-11-21 14:05:44 -05001563 int *out_renew_ticket, const uint8_t *ticket,
David Benjamine3aa1d92015-06-16 15:34:50 -04001564 size_t ticket_len, const uint8_t *session_id,
1565 size_t session_id_len);
Adam Langley95c29f32014-06-20 12:00:00 -07001566
David Benjamind6a4ae92015-08-06 11:10:51 -04001567/* 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. */
1570int tls1_channel_id_hash(SSL *ssl, uint8_t *out, size_t *out_len);
1571
David Benjamin0d56f882015-12-19 17:05:56 -05001572int tls1_record_handshake_hashes_for_channel_id(SSL *ssl);
Adam Langley1258b6a2014-06-20 12:00:00 -07001573
David Benjamin0d56f882015-12-19 17:05:56 -05001574/* ssl3_can_false_start returns one if |ssl| is allowed to False Start and zero
David Benjamined7c4752015-02-16 19:16:46 -05001575 * otherwise. */
David Benjamin0d56f882015-12-19 17:05:56 -05001576int ssl3_can_false_start(const SSL *ssl);
David Benjaminceb6f282014-12-07 23:56:19 -05001577
David Benjamine99e9122014-12-11 01:46:01 -05001578/* ssl3_get_enc_method returns the SSL3_ENC_METHOD corresponding to
1579 * |version|. */
1580const SSL3_ENC_METHOD *ssl3_get_enc_method(uint16_t version);
1581
David Benjamine0ff7672016-09-19 18:40:03 -04001582/* ssl_get_version_range sets |*out_min_version| and |*out_max_version| to the
1583 * minimum and maximum enabled protocol versions, respectively. */
David Benjaminb6a0a512016-06-21 10:33:21 -04001584int ssl_get_version_range(const SSL *ssl, uint16_t *out_min_version,
David Benjamine0ff7672016-09-19 18:40:03 -04001585 uint16_t *out_max_version);
David Benjaminb9e4fa52015-12-29 23:58:17 -05001586
1587/* ssl3_protocol_version returns |ssl|'s protocol version. It is an error to
1588 * call this function before the version is determined. */
1589uint16_t ssl3_protocol_version(const SSL *ssl);
David Benjaminea72bd02014-12-21 21:27:41 -05001590
David Benjamin928f32a2015-12-29 23:32:29 -05001591uint32_t ssl_get_algorithm_prf(const SSL *ssl);
David Benjamin0d56f882015-12-19 17:05:56 -05001592int tls1_parse_peer_sigalgs(SSL *ssl, const CBS *sigalgs);
David Benjaminec2f27d2014-11-13 19:17:25 -05001593
David Benjaminea9a0d52016-07-08 15:52:59 -07001594/* 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. */
1597int tls1_choose_signature_algorithm(SSL *ssl, uint16_t *out);
David Benjaminec2f27d2014-11-13 19:17:25 -05001598
Steven Valdez02563852016-06-23 13:33:05 -04001599size_t tls12_get_psigalgs(SSL *ssl, const uint16_t **psigs);
David Benjamin6e807652015-11-02 12:02:20 -05001600
Steven Valdez02563852016-06-23 13:33:05 -04001601/* tls12_check_peer_sigalg checks that |signature_algorithm| is consistent with
David Benjamin887c3002016-07-08 16:15:32 -07001602 * |ssl|'s sent, supported signature algorithms and returns 1. Otherwise it
1603 * returns 0 and writes an alert into |*out_alert|. */
Steven Valdezf0451ca2016-06-29 13:16:27 -04001604int tls12_check_peer_sigalg(SSL *ssl, int *out_alert,
David Benjamin887c3002016-07-08 16:15:32 -07001605 uint16_t signature_algorithm);
David Benjamin0d56f882015-12-19 17:05:56 -05001606void ssl_set_client_disabled(SSL *ssl);
Adam Langley95c29f32014-06-20 12:00:00 -07001607
David Benjamin721e8b72016-08-03 13:13:17 -04001608void ssl_get_current_time(const SSL *ssl, struct timeval *out_clock);
1609
Steven Valdez87eab492016-06-27 16:34:59 -04001610
1611#if defined(__cplusplus)
1612} /* extern C */
1613#endif
1614
David Benjamin2ee94aa2015-04-07 22:38:30 -04001615#endif /* OPENSSL_HEADER_SSL_INTERNAL_H */