Create an ENDPOINT enum type for use internally
[openssl.git] / ssl / ssl_locl.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* ====================================================================
11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12  * ECC cipher suite support in OpenSSL originally developed by
13  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
14  */
15 /* ====================================================================
16  * Copyright 2005 Nokia. All rights reserved.
17  *
18  * The portions of the attached software ("Contribution") is developed by
19  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
20  * license.
21  *
22  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
23  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
24  * support (see RFC 4279) to OpenSSL.
25  *
26  * No patent licenses or other rights except those expressly stated in
27  * the OpenSSL open source license shall be deemed granted or received
28  * expressly, by implication, estoppel, or otherwise.
29  *
30  * No assurances are provided by Nokia that the Contribution does not
31  * infringe the patent or other intellectual property rights of any third
32  * party or that the license provides you with all the necessary rights
33  * to make use of the Contribution.
34  *
35  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
36  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
37  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
38  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
39  * OTHERWISE.
40  */
41
42 #ifndef HEADER_SSL_LOCL_H
43 # define HEADER_SSL_LOCL_H
44 # include <stdlib.h>
45 # include <time.h>
46 # include <string.h>
47 # include <errno.h>
48
49 # include "e_os.h"
50 # if defined(__unix) || defined(__unix__)
51 #  include <sys/time.h>         /* struct timeval for DTLS */
52 # endif
53
54 # include <openssl/buffer.h>
55 # include <openssl/comp.h>
56 # include <openssl/bio.h>
57 # include <openssl/stack.h>
58 # include <openssl/rsa.h>
59 # include <openssl/dsa.h>
60 # include <openssl/err.h>
61 # include <openssl/ssl.h>
62 # include <openssl/async.h>
63 # include <openssl/symhacks.h>
64 # include <openssl/ct.h>
65 # include "record/record.h"
66 # include "statem/statem.h"
67 # include "packet_locl.h"
68 # include "internal/dane.h"
69 # include "internal/refcount.h"
70
71 # ifdef OPENSSL_BUILD_SHLIBSSL
72 #  undef OPENSSL_EXTERN
73 #  define OPENSSL_EXTERN OPENSSL_EXPORT
74 # endif
75
76 # define c2l(c,l)        (l = ((unsigned long)(*((c)++)))     , \
77                          l|=(((unsigned long)(*((c)++)))<< 8), \
78                          l|=(((unsigned long)(*((c)++)))<<16), \
79                          l|=(((unsigned long)(*((c)++)))<<24))
80
81 /* NOTE - c is not incremented as per c2l */
82 # define c2ln(c,l1,l2,n) { \
83                         c+=n; \
84                         l1=l2=0; \
85                         switch (n) { \
86                         case 8: l2 =((unsigned long)(*(--(c))))<<24; \
87                         case 7: l2|=((unsigned long)(*(--(c))))<<16; \
88                         case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
89                         case 5: l2|=((unsigned long)(*(--(c))));     \
90                         case 4: l1 =((unsigned long)(*(--(c))))<<24; \
91                         case 3: l1|=((unsigned long)(*(--(c))))<<16; \
92                         case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
93                         case 1: l1|=((unsigned long)(*(--(c))));     \
94                                 } \
95                         }
96
97 # define l2c(l,c)        (*((c)++)=(unsigned char)(((l)    )&0xff), \
98                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
99                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
100                          *((c)++)=(unsigned char)(((l)>>24)&0xff))
101
102 # define n2l(c,l)        (l =((unsigned long)(*((c)++)))<<24, \
103                          l|=((unsigned long)(*((c)++)))<<16, \
104                          l|=((unsigned long)(*((c)++)))<< 8, \
105                          l|=((unsigned long)(*((c)++))))
106
107 # define n2l8(c,l)       (l =((uint64_t)(*((c)++)))<<56, \
108                          l|=((uint64_t)(*((c)++)))<<48, \
109                          l|=((uint64_t)(*((c)++)))<<40, \
110                          l|=((uint64_t)(*((c)++)))<<32, \
111                          l|=((uint64_t)(*((c)++)))<<24, \
112                          l|=((uint64_t)(*((c)++)))<<16, \
113                          l|=((uint64_t)(*((c)++)))<< 8, \
114                          l|=((uint64_t)(*((c)++))))
115
116
117 # define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
118                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
119                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
120                          *((c)++)=(unsigned char)(((l)    )&0xff))
121
122 # define l2n6(l,c)       (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
123                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
124                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
125                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
126                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
127                          *((c)++)=(unsigned char)(((l)    )&0xff))
128
129 # define l2n8(l,c)       (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
130                          *((c)++)=(unsigned char)(((l)>>48)&0xff), \
131                          *((c)++)=(unsigned char)(((l)>>40)&0xff), \
132                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
133                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
134                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
135                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
136                          *((c)++)=(unsigned char)(((l)    )&0xff))
137
138 /* NOTE - c is not incremented as per l2c */
139 # define l2cn(l1,l2,c,n) { \
140                         c+=n; \
141                         switch (n) { \
142                         case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
143                         case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
144                         case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
145                         case 5: *(--(c))=(unsigned char)(((l2)    )&0xff); \
146                         case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
147                         case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
148                         case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
149                         case 1: *(--(c))=(unsigned char)(((l1)    )&0xff); \
150                                 } \
151                         }
152
153 # define n2s(c,s)        ((s=(((unsigned int)((c)[0]))<< 8)| \
154                              (((unsigned int)((c)[1]))    )),(c)+=2)
155 # define s2n(s,c)        (((c)[0]=(unsigned char)(((s)>> 8)&0xff), \
156                            (c)[1]=(unsigned char)(((s)    )&0xff)),(c)+=2)
157
158 # define n2l3(c,l)       ((l =(((unsigned long)((c)[0]))<<16)| \
159                               (((unsigned long)((c)[1]))<< 8)| \
160                               (((unsigned long)((c)[2]))    )),(c)+=3)
161
162 # define l2n3(l,c)       (((c)[0]=(unsigned char)(((l)>>16)&0xff), \
163                            (c)[1]=(unsigned char)(((l)>> 8)&0xff), \
164                            (c)[2]=(unsigned char)(((l)    )&0xff)),(c)+=3)
165
166 /*
167  * DTLS version numbers are strange because they're inverted. Except for
168  * DTLS1_BAD_VER, which should be considered "lower" than the rest.
169  */
170 # define dtls_ver_ordinal(v1) (((v1) == DTLS1_BAD_VER) ? 0xff00 : (v1))
171 # define DTLS_VERSION_GT(v1, v2) (dtls_ver_ordinal(v1) < dtls_ver_ordinal(v2))
172 # define DTLS_VERSION_GE(v1, v2) (dtls_ver_ordinal(v1) <= dtls_ver_ordinal(v2))
173 # define DTLS_VERSION_LT(v1, v2) (dtls_ver_ordinal(v1) > dtls_ver_ordinal(v2))
174 # define DTLS_VERSION_LE(v1, v2) (dtls_ver_ordinal(v1) >= dtls_ver_ordinal(v2))
175
176
177 /*
178  * Define the Bitmasks for SSL_CIPHER.algorithms.
179  * This bits are used packed as dense as possible. If new methods/ciphers
180  * etc will be added, the bits a likely to change, so this information
181  * is for internal library use only, even though SSL_CIPHER.algorithms
182  * can be publicly accessed.
183  * Use the according functions for cipher management instead.
184  *
185  * The bit mask handling in the selection and sorting scheme in
186  * ssl_create_cipher_list() has only limited capabilities, reflecting
187  * that the different entities within are mutually exclusive:
188  * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
189  */
190
191 /* Bits for algorithm_mkey (key exchange algorithm) */
192 /* RSA key exchange */
193 # define SSL_kRSA                0x00000001U
194 /* tmp DH key no DH cert */
195 # define SSL_kDHE                0x00000002U
196 /* synonym */
197 # define SSL_kEDH                SSL_kDHE
198 /* ephemeral ECDH */
199 # define SSL_kECDHE              0x00000004U
200 /* synonym */
201 # define SSL_kEECDH              SSL_kECDHE
202 /* PSK */
203 # define SSL_kPSK                0x00000008U
204 /* GOST key exchange */
205 # define SSL_kGOST               0x00000010U
206 /* SRP */
207 # define SSL_kSRP                0x00000020U
208
209 # define SSL_kRSAPSK             0x00000040U
210 # define SSL_kECDHEPSK           0x00000080U
211 # define SSL_kDHEPSK             0x00000100U
212
213 /* all PSK */
214
215 # define SSL_PSK     (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
216
217 /* Any appropriate key exchange algorithm (for TLS 1.3 ciphersuites) */
218 # define SSL_kANY                0x00000000U
219
220 /* Bits for algorithm_auth (server authentication) */
221 /* RSA auth */
222 # define SSL_aRSA                0x00000001U
223 /* DSS auth */
224 # define SSL_aDSS                0x00000002U
225 /* no auth (i.e. use ADH or AECDH) */
226 # define SSL_aNULL               0x00000004U
227 /* ECDSA auth*/
228 # define SSL_aECDSA              0x00000008U
229 /* PSK auth */
230 # define SSL_aPSK                0x00000010U
231 /* GOST R 34.10-2001 signature auth */
232 # define SSL_aGOST01             0x00000020U
233 /* SRP auth */
234 # define SSL_aSRP                0x00000040U
235 /* GOST R 34.10-2012 signature auth */
236 # define SSL_aGOST12             0x00000080U
237 /* Any appropriate signature auth (for TLS 1.3 ciphersuites) */
238 # define SSL_aANY                0x00000000U
239
240 /* Bits for algorithm_enc (symmetric encryption) */
241 # define SSL_DES                 0x00000001U
242 # define SSL_3DES                0x00000002U
243 # define SSL_RC4                 0x00000004U
244 # define SSL_RC2                 0x00000008U
245 # define SSL_IDEA                0x00000010U
246 # define SSL_eNULL               0x00000020U
247 # define SSL_AES128              0x00000040U
248 # define SSL_AES256              0x00000080U
249 # define SSL_CAMELLIA128         0x00000100U
250 # define SSL_CAMELLIA256         0x00000200U
251 # define SSL_eGOST2814789CNT     0x00000400U
252 # define SSL_SEED                0x00000800U
253 # define SSL_AES128GCM           0x00001000U
254 # define SSL_AES256GCM           0x00002000U
255 # define SSL_AES128CCM           0x00004000U
256 # define SSL_AES256CCM           0x00008000U
257 # define SSL_AES128CCM8          0x00010000U
258 # define SSL_AES256CCM8          0x00020000U
259 # define SSL_eGOST2814789CNT12   0x00040000U
260 # define SSL_CHACHA20POLY1305    0x00080000U
261
262 # define SSL_AESGCM              (SSL_AES128GCM | SSL_AES256GCM)
263 # define SSL_AESCCM              (SSL_AES128CCM | SSL_AES256CCM | SSL_AES128CCM8 | SSL_AES256CCM8)
264 # define SSL_AES                 (SSL_AES128|SSL_AES256|SSL_AESGCM|SSL_AESCCM)
265 # define SSL_CAMELLIA            (SSL_CAMELLIA128|SSL_CAMELLIA256)
266 # define SSL_CHACHA20            (SSL_CHACHA20POLY1305)
267
268 /* Bits for algorithm_mac (symmetric authentication) */
269
270 # define SSL_MD5                 0x00000001U
271 # define SSL_SHA1                0x00000002U
272 # define SSL_GOST94      0x00000004U
273 # define SSL_GOST89MAC   0x00000008U
274 # define SSL_SHA256              0x00000010U
275 # define SSL_SHA384              0x00000020U
276 /* Not a real MAC, just an indication it is part of cipher */
277 # define SSL_AEAD                0x00000040U
278 # define SSL_GOST12_256          0x00000080U
279 # define SSL_GOST89MAC12         0x00000100U
280 # define SSL_GOST12_512          0x00000200U
281
282 /*
283  * When adding new digest in the ssl_ciph.c and increment SSL_MD_NUM_IDX make
284  * sure to update this constant too
285  */
286
287 # define SSL_MD_MD5_IDX  0
288 # define SSL_MD_SHA1_IDX 1
289 # define SSL_MD_GOST94_IDX 2
290 # define SSL_MD_GOST89MAC_IDX 3
291 # define SSL_MD_SHA256_IDX 4
292 # define SSL_MD_SHA384_IDX 5
293 # define SSL_MD_GOST12_256_IDX  6
294 # define SSL_MD_GOST89MAC12_IDX 7
295 # define SSL_MD_GOST12_512_IDX  8
296 # define SSL_MD_MD5_SHA1_IDX 9
297 # define SSL_MD_SHA224_IDX 10
298 # define SSL_MD_SHA512_IDX 11
299 # define SSL_MAX_DIGEST 12
300
301 /* Bits for algorithm2 (handshake digests and other extra flags) */
302
303 /* Bits 0-7 are handshake MAC */
304 # define SSL_HANDSHAKE_MAC_MASK  0xFF
305 # define SSL_HANDSHAKE_MAC_MD5_SHA1 SSL_MD_MD5_SHA1_IDX
306 # define SSL_HANDSHAKE_MAC_SHA256   SSL_MD_SHA256_IDX
307 # define SSL_HANDSHAKE_MAC_SHA384   SSL_MD_SHA384_IDX
308 # define SSL_HANDSHAKE_MAC_GOST94 SSL_MD_GOST94_IDX
309 # define SSL_HANDSHAKE_MAC_GOST12_256 SSL_MD_GOST12_256_IDX
310 # define SSL_HANDSHAKE_MAC_GOST12_512 SSL_MD_GOST12_512_IDX
311 # define SSL_HANDSHAKE_MAC_DEFAULT  SSL_HANDSHAKE_MAC_MD5_SHA1
312
313 /* Bits 8-15 bits are PRF */
314 # define TLS1_PRF_DGST_SHIFT 8
315 # define TLS1_PRF_SHA1_MD5 (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
316 # define TLS1_PRF_SHA256 (SSL_MD_SHA256_IDX << TLS1_PRF_DGST_SHIFT)
317 # define TLS1_PRF_SHA384 (SSL_MD_SHA384_IDX << TLS1_PRF_DGST_SHIFT)
318 # define TLS1_PRF_GOST94 (SSL_MD_GOST94_IDX << TLS1_PRF_DGST_SHIFT)
319 # define TLS1_PRF_GOST12_256 (SSL_MD_GOST12_256_IDX << TLS1_PRF_DGST_SHIFT)
320 # define TLS1_PRF_GOST12_512 (SSL_MD_GOST12_512_IDX << TLS1_PRF_DGST_SHIFT)
321 # define TLS1_PRF            (SSL_MD_MD5_SHA1_IDX << TLS1_PRF_DGST_SHIFT)
322
323 /*
324  * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
325  * goes into algorithm2)
326  */
327 # define TLS1_STREAM_MAC 0x10000
328
329 # define SSL_STRONG_MASK         0x0000001FU
330 # define SSL_DEFAULT_MASK        0X00000020U
331
332 # define SSL_STRONG_NONE         0x00000001U
333 # define SSL_LOW                 0x00000002U
334 # define SSL_MEDIUM              0x00000004U
335 # define SSL_HIGH                0x00000008U
336 # define SSL_FIPS                0x00000010U
337 # define SSL_NOT_DEFAULT         0x00000020U
338
339 /* we have used 0000003f - 26 bits left to go */
340
341 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
342 # define SSL3_CK_CIPHERSUITE_FLAG                0x03000000
343
344 /* Check if an SSL structure is using DTLS */
345 # define SSL_IS_DTLS(s)  (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
346
347 /* Check if we are using TLSv1.3 */
348 # define SSL_IS_TLS13(s) (!SSL_IS_DTLS(s) \
349                           && (s)->method->version >= TLS1_3_VERSION \
350                           && (s)->method->version != TLS_ANY_VERSION)
351
352 # define SSL_TREAT_AS_TLS13(s) \
353     (SSL_IS_TLS13(s) || (s)->early_data_state == SSL_EARLY_DATA_WRITING \
354      || (s)->early_data_state == SSL_EARLY_DATA_WRITE_RETRY)
355
356 # define SSL_IS_FIRST_HANDSHAKE(S) ((s)->s3->tmp.finish_md_len == 0)
357
358 /* See if we need explicit IV */
359 # define SSL_USE_EXPLICIT_IV(s)  \
360                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
361 /*
362  * See if we use signature algorithms extension and signature algorithm
363  * before signatures.
364  */
365 # define SSL_USE_SIGALGS(s)      \
366                         (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
367 /*
368  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
369  * apply to others in future.
370  */
371 # define SSL_USE_TLS1_2_CIPHERS(s)       \
372                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
373 /*
374  * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
375  * flags because it may not be set to correct version yet.
376  */
377 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s)        \
378     ((!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION) || \
379      (SSL_IS_DTLS(s) && DTLS_VERSION_GE(s->client_version, DTLS1_2_VERSION)))
380 /*
381  * Determine if a client should send signature algorithms extension:
382  * as with TLS1.2 cipher we can't rely on method flags.
383  */
384 # define SSL_CLIENT_USE_SIGALGS(s)        \
385     SSL_CLIENT_USE_TLS1_2_CIPHERS(s)
386
387 # define SSL_READ_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_READ)
388 # define SSL_WRITE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC_WRITE)
389
390 /* Mostly for SSLv3 */
391 # define SSL_PKEY_RSA            0
392 # define SSL_PKEY_DSA_SIGN       1
393 # define SSL_PKEY_ECC            2
394 # define SSL_PKEY_GOST01         3
395 # define SSL_PKEY_GOST12_256     4
396 # define SSL_PKEY_GOST12_512     5
397 # define SSL_PKEY_NUM            6
398 /*
399  * Pseudo-constant. GOST cipher suites can use different certs for 1
400  * SSL_CIPHER. So let's see which one we have in fact.
401  */
402 # define SSL_PKEY_GOST_EC SSL_PKEY_NUM+1
403
404 /*
405  * TODO(TLS1.3) for now use SSL_PKEY_RSA keys for PSS
406  */
407
408 #define SSL_PKEY_RSA_PSS_SIGN SSL_PKEY_RSA
409
410 /*-
411  * SSL_kRSA <- RSA_ENC
412  * SSL_kDH  <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
413  * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
414  * SSL_aRSA <- RSA_ENC | RSA_SIGN
415  * SSL_aDSS <- DSA_SIGN
416  */
417
418 /*-
419 #define CERT_INVALID            0
420 #define CERT_PUBLIC_KEY         1
421 #define CERT_PRIVATE_KEY        2
422 */
423
424 /* CipherSuite length. SSLv3 and all TLS versions. */
425 # define TLS_CIPHER_LEN 2
426 /* used to hold info on the particular ciphers used */
427 struct ssl_cipher_st {
428     uint32_t valid;
429     const char *name;           /* text name */
430     uint32_t id;                /* id, 4 bytes, first is version */
431     /*
432      * changed in 1.0.0: these four used to be portions of a single value
433      * 'algorithms'
434      */
435     uint32_t algorithm_mkey;    /* key exchange algorithm */
436     uint32_t algorithm_auth;    /* server authentication */
437     uint32_t algorithm_enc;     /* symmetric encryption */
438     uint32_t algorithm_mac;     /* symmetric authentication */
439     int min_tls;                /* minimum SSL/TLS protocol version */
440     int max_tls;                /* maximum SSL/TLS protocol version */
441     int min_dtls;               /* minimum DTLS protocol version */
442     int max_dtls;               /* maximum DTLS protocol version */
443     uint32_t algo_strength;     /* strength and export flags */
444     uint32_t algorithm2;        /* Extra flags */
445     int32_t strength_bits;      /* Number of bits really used */
446     uint32_t alg_bits;          /* Number of bits for algorithm */
447 };
448
449 /* Used to hold SSL/TLS functions */
450 struct ssl_method_st {
451     int version;
452     unsigned flags;
453     unsigned long mask;
454     int (*ssl_new) (SSL *s);
455     void (*ssl_clear) (SSL *s);
456     void (*ssl_free) (SSL *s);
457     int (*ssl_accept) (SSL *s);
458     int (*ssl_connect) (SSL *s);
459     int (*ssl_read) (SSL *s, void *buf, size_t len, size_t *readbytes);
460     int (*ssl_peek) (SSL *s, void *buf, size_t len, size_t *readbytes);
461     int (*ssl_write) (SSL *s, const void *buf, size_t len, size_t *written);
462     int (*ssl_shutdown) (SSL *s);
463     int (*ssl_renegotiate) (SSL *s);
464     int (*ssl_renegotiate_check) (SSL *s, int);
465     int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
466                            unsigned char *buf, size_t len, int peek,
467                            size_t *readbytes);
468     int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, size_t len,
469                             size_t *written);
470     int (*ssl_dispatch_alert) (SSL *s);
471     long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
472     long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
473     const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
474     int (*put_cipher_by_char) (const SSL_CIPHER *cipher, WPACKET *pkt,
475                                size_t *len);
476     size_t (*ssl_pending) (const SSL *s);
477     int (*num_ciphers) (void);
478     const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
479     long (*get_timeout) (void);
480     const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
481     int (*ssl_version) (void);
482     long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
483     long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
484 };
485
486 /*-
487  * Lets make this into an ASN.1 type structure as follows
488  * SSL_SESSION_ID ::= SEQUENCE {
489  *      version                 INTEGER,        -- structure version number
490  *      SSLversion              INTEGER,        -- SSL version number
491  *      Cipher                  OCTET STRING,   -- the 3 byte cipher ID
492  *      Session_ID              OCTET STRING,   -- the Session ID
493  *      Master_key              OCTET STRING,   -- the master key
494  *      Key_Arg [ 0 ] IMPLICIT  OCTET STRING,   -- the optional Key argument
495  *      Time [ 1 ] EXPLICIT     INTEGER,        -- optional Start Time
496  *      Timeout [ 2 ] EXPLICIT  INTEGER,        -- optional Timeout ins seconds
497  *      Peer [ 3 ] EXPLICIT     X509,           -- optional Peer Certificate
498  *      Session_ID_context [ 4 ] EXPLICIT OCTET STRING,   -- the Session ID context
499  *      Verify_result [ 5 ] EXPLICIT INTEGER,   -- X509_V_... code for `Peer'
500  *      HostName [ 6 ] EXPLICIT OCTET STRING,   -- optional HostName from servername TLS extension
501  *      PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
502  *      PSK_identity [ 8 ] EXPLICIT OCTET STRING,  -- optional PSK identity
503  *      Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
504  *      Ticket [10]             EXPLICIT OCTET STRING, -- session ticket (clients only)
505  *      Compression_meth [11]   EXPLICIT OCTET STRING, -- optional compression method
506  *      SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
507  *      flags [ 13 ] EXPLICIT INTEGER -- optional flags
508  *      }
509  * Look in ssl/ssl_asn1.c for more details
510  * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
511  */
512 struct ssl_session_st {
513     int ssl_version;            /* what ssl version session info is being kept
514                                  * in here? */
515     size_t master_key_length;
516
517     /*
518      * For <=TLS1.2 this is the master_key. For TLS1.3 this is the resumption
519      * master secret
520      */
521     unsigned char master_key[TLS13_MAX_RESUMPTION_MASTER_LENGTH];
522     /* session_id - valid? */
523     size_t session_id_length;
524     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
525     /*
526      * this is used to determine whether the session is being reused in the
527      * appropriate context. It is up to the application to set this, via
528      * SSL_new
529      */
530     size_t sid_ctx_length;
531     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
532 # ifndef OPENSSL_NO_PSK
533     char *psk_identity_hint;
534     char *psk_identity;
535 # endif
536     /*
537      * Used to indicate that session resumption is not allowed. Applications
538      * can also set this bit for a new session via not_resumable_session_cb
539      * to disable session caching and tickets.
540      */
541     int not_resumable;
542     /* This is the cert and type for the other end. */
543     X509 *peer;
544     int peer_type;
545     /* Certificate chain peer sent. */
546     STACK_OF(X509) *peer_chain;
547     /*
548      * when app_verify_callback accepts a session where the peer's
549      * certificate is not ok, we must remember the error for session reuse:
550      */
551     long verify_result;         /* only for servers */
552     CRYPTO_REF_COUNT references;
553     long timeout;
554     long time;
555     unsigned int compress_meth; /* Need to lookup the method */
556     const SSL_CIPHER *cipher;
557     unsigned long cipher_id;    /* when ASN.1 loaded, this needs to be used to
558                                  * load the 'cipher' structure */
559     STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
560     CRYPTO_EX_DATA ex_data;     /* application specific data */
561     /*
562      * These are used to make removal of session-ids more efficient and to
563      * implement a maximum cache size.
564      */
565     struct ssl_session_st *prev, *next;
566
567     struct {
568         char *hostname;
569 # ifndef OPENSSL_NO_EC
570         size_t ecpointformats_len;
571         unsigned char *ecpointformats; /* peer's list */
572         size_t supportedgroups_len;
573         unsigned char *supportedgroups; /* peer's list */
574 # endif                         /* OPENSSL_NO_EC */
575     /* RFC4507 info */
576         unsigned char *tick; /* Session ticket */
577         size_t ticklen;      /* Session ticket length */
578         /* Session lifetime hint in seconds */
579         unsigned long tick_lifetime_hint;
580         uint32_t tick_age_add;
581         int tick_identity;
582         /* Max number of bytes that can be sent as early data */
583         uint32_t max_early_data;
584         /* The ALPN protocol selected for this session */
585         unsigned char *alpn_selected;
586         size_t alpn_selected_len;
587     } ext;
588 # ifndef OPENSSL_NO_SRP
589     char *srp_username;
590 # endif
591     uint32_t flags;
592     CRYPTO_RWLOCK *lock;
593 };
594
595 /* Extended master secret support */
596 # define SSL_SESS_FLAG_EXTMS             0x1
597
598 # ifndef OPENSSL_NO_SRP
599
600 typedef struct srp_ctx_st {
601     /* param for all the callbacks */
602     void *SRP_cb_arg;
603     /* set client Hello login callback */
604     int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
605     /* set SRP N/g param callback for verification */
606     int (*SRP_verify_param_callback) (SSL *, void *);
607     /* set SRP client passwd callback */
608     char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
609     char *login;
610     BIGNUM *N, *g, *s, *B, *A;
611     BIGNUM *a, *b, *v;
612     char *info;
613     int strength;
614     unsigned long srp_Mask;
615 } SRP_CTX;
616
617 # endif
618
619 typedef enum {
620     SSL_EARLY_DATA_NONE = 0,
621     SSL_EARLY_DATA_CONNECT_RETRY,
622     SSL_EARLY_DATA_CONNECTING,
623     SSL_EARLY_DATA_WRITE_RETRY,
624     SSL_EARLY_DATA_WRITING,
625     SSL_EARLY_DATA_UNAUTH_WRITING,
626     SSL_EARLY_DATA_FINISHED_WRITING,
627     SSL_EARLY_DATA_ACCEPT_RETRY,
628     SSL_EARLY_DATA_ACCEPTING,
629     SSL_EARLY_DATA_READ_RETRY,
630     SSL_EARLY_DATA_READING,
631     SSL_EARLY_DATA_FINISHED_READING
632 } SSL_EARLY_DATA_STATE;
633
634 /*
635  * We check that the amount of unreadable early data doesn't exceed
636  * max_early_data. max_early_data is given in plaintext bytes. However if it is
637  * unreadable then we only know the number of ciphertext bytes. We also don't
638  * know how much the overhead should be because it depends on the ciphersuite.
639  * We make a small allowance. We assume 5 records of actual data plus the end
640  * of early data alert record. Each record has a tag and a content type byte.
641  * The longest tag length we know of is EVP_GCM_TLS_TAG_LEN. We don't count the
642  * content of the alert record either which is 2 bytes.
643  */
644 # define EARLY_DATA_CIPHERTEXT_OVERHEAD ((6 * (EVP_GCM_TLS_TAG_LEN + 1)) + 2)
645
646 /*
647  * The allowance we have between the client's calculated ticket age and our own.
648  * We allow for 10 seconds (units are in ms). If a ticket is presented and the
649  * client's age calculation is different by more than this than our own then we
650  * do not allow that ticket for early_data.
651  */
652 # define TICKET_AGE_ALLOWANCE   (10 * 1000)
653
654 #define MAX_COMPRESSIONS_SIZE   255
655
656 struct ssl_comp_st {
657     int id;
658     const char *name;
659     COMP_METHOD *method;
660 };
661
662 typedef struct raw_extension_st {
663     /* Raw packet data for the extension */
664     PACKET data;
665     /* Set to 1 if the extension is present or 0 otherwise */
666     int present;
667     /* Set to 1 if we have already parsed the extension or 0 otherwise */
668     int parsed;
669     /* The type of this extension, i.e. a TLSEXT_TYPE_* value */
670     unsigned int type;
671 } RAW_EXTENSION;
672
673 typedef struct {
674     unsigned int isv2;
675     unsigned int legacy_version;
676     unsigned char random[SSL3_RANDOM_SIZE];
677     size_t session_id_len;
678     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
679     size_t dtls_cookie_len;
680     unsigned char dtls_cookie[DTLS1_COOKIE_LENGTH];
681     PACKET ciphersuites;
682     size_t compressions_len;
683     unsigned char compressions[MAX_COMPRESSIONS_SIZE];
684     PACKET extensions;
685     size_t pre_proc_exts_len;
686     RAW_EXTENSION *pre_proc_exts;
687 } CLIENTHELLO_MSG;
688
689 DEFINE_LHASH_OF(SSL_SESSION);
690 /* Needed in ssl_cert.c */
691 DEFINE_LHASH_OF(X509_NAME);
692
693 # define TLSEXT_KEYNAME_LENGTH 16
694
695 struct ssl_ctx_st {
696     const SSL_METHOD *method;
697     STACK_OF(SSL_CIPHER) *cipher_list;
698     /* same as above but sorted for lookup */
699     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
700     struct x509_store_st /* X509_STORE */ *cert_store;
701     LHASH_OF(SSL_SESSION) *sessions;
702     /*
703      * Most session-ids that will be cached, default is
704      * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
705      */
706     size_t session_cache_size;
707     struct ssl_session_st *session_cache_head;
708     struct ssl_session_st *session_cache_tail;
709     /*
710      * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
711      * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
712      * means only SSL_accept which cache SSL_SESSIONS.
713      */
714     uint32_t session_cache_mode;
715     /*
716      * If timeout is not 0, it is the default timeout value set when
717      * SSL_new() is called.  This has been put in to make life easier to set
718      * things up
719      */
720     long session_timeout;
721     /*
722      * If this callback is not null, it will be called each time a session id
723      * is added to the cache.  If this function returns 1, it means that the
724      * callback will do a SSL_SESSION_free() when it has finished using it.
725      * Otherwise, on 0, it means the callback has finished with it. If
726      * remove_session_cb is not null, it will be called when a session-id is
727      * removed from the cache.  After the call, OpenSSL will
728      * SSL_SESSION_free() it.
729      */
730     int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
731     void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
732     SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
733                                     const unsigned char *data, int len,
734                                     int *copy);
735     struct {
736         int sess_connect;       /* SSL new conn - started */
737         int sess_connect_renegotiate; /* SSL reneg - requested */
738         int sess_connect_good;  /* SSL new conne/reneg - finished */
739         int sess_accept;        /* SSL new accept - started */
740         int sess_accept_renegotiate; /* SSL reneg - requested */
741         int sess_accept_good;   /* SSL accept/reneg - finished */
742         int sess_miss;          /* session lookup misses */
743         int sess_timeout;       /* reuse attempt on timeouted session */
744         int sess_cache_full;    /* session removed due to full cache */
745         int sess_hit;           /* session reuse actually done */
746         int sess_cb_hit;        /* session-id that was not in the cache was
747                                  * passed back via the callback.  This
748                                  * indicates that the application is supplying
749                                  * session-id's from other processes - spooky
750                                  * :-) */
751     } stats;
752
753     CRYPTO_REF_COUNT references;
754
755     /* if defined, these override the X509_verify_cert() calls */
756     int (*app_verify_callback) (X509_STORE_CTX *, void *);
757     void *app_verify_arg;
758     /*
759      * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
760      * ('app_verify_callback' was called with just one argument)
761      */
762
763     /* Default password callback. */
764     pem_password_cb *default_passwd_callback;
765
766     /* Default password callback user data. */
767     void *default_passwd_callback_userdata;
768
769     /* get client cert callback */
770     int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
771
772     /* cookie generate callback */
773     int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
774                               unsigned int *cookie_len);
775
776     /* verify cookie callback */
777     int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
778                                  unsigned int cookie_len);
779
780     CRYPTO_EX_DATA ex_data;
781
782     const EVP_MD *md5;          /* For SSLv3/TLSv1 'ssl3-md5' */
783     const EVP_MD *sha1;         /* For SSLv3/TLSv1 'ssl3->sha1' */
784
785     STACK_OF(X509) *extra_certs;
786     STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
787
788     /* Default values used when no per-SSL value is defined follow */
789
790     /* used if SSL's info_callback is NULL */
791     void (*info_callback) (const SSL *ssl, int type, int val);
792
793     /*
794      * What we put in certificate_authorities extension for TLS 1.3
795      * (ClientHello and CertificateRequest) or just client cert requests for
796      * earlier versions.
797      */
798     STACK_OF(X509_NAME) *ca_names;
799
800     /*
801      * Default values to use in SSL structures follow (these are copied by
802      * SSL_new)
803      */
804
805     uint32_t options;
806     uint32_t mode;
807     int min_proto_version;
808     int max_proto_version;
809     size_t max_cert_list;
810
811     struct cert_st /* CERT */ *cert;
812     int read_ahead;
813
814     /* callback that allows applications to peek at protocol messages */
815     void (*msg_callback) (int write_p, int version, int content_type,
816                           const void *buf, size_t len, SSL *ssl, void *arg);
817     void *msg_callback_arg;
818
819     uint32_t verify_mode;
820     size_t sid_ctx_length;
821     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
822     /* called 'verify_callback' in the SSL */
823     int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
824
825     /* Default generate session ID callback. */
826     GEN_SESSION_CB generate_session_id;
827
828     X509_VERIFY_PARAM *param;
829
830     int quiet_shutdown;
831
832 # ifndef OPENSSL_NO_CT
833     CTLOG_STORE *ctlog_store;   /* CT Log Store */
834     /*
835      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
836      * If they are not, the connection should be aborted.
837      */
838     ssl_ct_validation_cb ct_validation_callback;
839     void *ct_validation_callback_arg;
840 # endif
841
842     /*
843      * If we're using more than one pipeline how should we divide the data
844      * up between the pipes?
845      */
846     size_t split_send_fragment;
847     /*
848      * Maximum amount of data to send in one fragment. actual record size can
849      * be more than this due to padding and MAC overheads.
850      */
851     size_t max_send_fragment;
852
853     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
854     size_t max_pipelines;
855
856     /* The default read buffer length to use (0 means not set) */
857     size_t default_read_buf_len;
858
859 # ifndef OPENSSL_NO_ENGINE
860     /*
861      * Engine to pass requests for client certs to
862      */
863     ENGINE *client_cert_engine;
864 # endif
865
866     /* Early callback.  Mostly for extensions, but not entirely. */
867     SSL_early_cb_fn early_cb;
868     void *early_cb_arg;
869
870     /* TLS extensions. */
871     struct {
872         /* TLS extensions servername callback */
873         int (*servername_cb) (SSL *, int *, void *);
874         void *servername_arg;
875         /* RFC 4507 session ticket keys */
876         unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
877         unsigned char tick_hmac_key[32];
878         unsigned char tick_aes_key[32];
879         /* Callback to support customisation of ticket key setting */
880         int (*ticket_key_cb) (SSL *ssl,
881                               unsigned char *name, unsigned char *iv,
882                               EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
883
884         /* certificate status request info */
885         /* Callback for status request */
886         int (*status_cb) (SSL *ssl, void *arg);
887         void *status_arg;
888         /* ext status type used for CSR extension (OCSP Stapling) */
889         int status_type;
890
891 # ifndef OPENSSL_NO_EC
892         /* EC extension values inherited by SSL structure */
893         size_t ecpointformats_len;
894         unsigned char *ecpointformats;
895         size_t supportedgroups_len;
896         unsigned char *supportedgroups;
897 # endif                         /* OPENSSL_NO_EC */
898
899         /*
900          * ALPN information (we are in the process of transitioning from NPN to
901          * ALPN.)
902          */
903
904         /*-
905          * For a server, this contains a callback function that allows the
906          * server to select the protocol for the connection.
907          *   out: on successful return, this must point to the raw protocol
908          *        name (without the length prefix).
909          *   outlen: on successful return, this contains the length of |*out|.
910          *   in: points to the client's list of supported protocols in
911          *       wire-format.
912          *   inlen: the length of |in|.
913          */
914         int (*alpn_select_cb) (SSL *s,
915                                const unsigned char **out,
916                                unsigned char *outlen,
917                                const unsigned char *in,
918                                unsigned int inlen, void *arg);
919         void *alpn_select_cb_arg;
920
921         /*
922          * For a client, this contains the list of supported protocols in wire
923          * format.
924          */
925         unsigned char *alpn;
926         size_t alpn_len;
927
928 # ifndef OPENSSL_NO_NEXTPROTONEG
929         /* Next protocol negotiation information */
930
931         /*
932          * For a server, this contains a callback function by which the set of
933          * advertised protocols can be provided.
934          */
935         SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
936         void *npn_advertised_cb_arg;
937         /*
938          * For a client, this contains a callback function that selects the next
939          * protocol from the list provided by the server.
940          */
941         SSL_CTX_npn_select_cb_func npn_select_cb;
942         void *npn_select_cb_arg;
943 # endif
944     } ext;
945
946 # ifndef OPENSSL_NO_PSK
947     SSL_psk_client_cb_func psk_client_callback;
948     SSL_psk_server_cb_func psk_server_callback;
949 # endif
950
951 # ifndef OPENSSL_NO_SRP
952     SRP_CTX srp_ctx;            /* ctx for SRP authentication */
953 # endif
954
955     /* Shared DANE context */
956     struct dane_ctx_st dane;
957
958     /* SRTP profiles we are willing to do from RFC 5764 */
959     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
960     /*
961      * Callback for disabling session caching and ticket support on a session
962      * basis, depending on the chosen cipher.
963      */
964     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
965
966     CRYPTO_RWLOCK *lock;
967
968     /*
969      * Callback for logging key material for use with debugging tools like
970      * Wireshark. The callback should log `line` followed by a newline.
971      */
972     SSL_CTX_keylog_cb_func keylog_callback;
973
974     /* The maximum number of bytes that can be sent as early data */
975     uint32_t max_early_data;
976 };
977
978 struct ssl_st {
979     /*
980      * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
981      * DTLS1_VERSION)
982      */
983     int version;
984     /* SSLv3 */
985     const SSL_METHOD *method;
986     /*
987      * There are 2 BIO's even though they are normally both the same.  This
988      * is so data can be read and written to different handlers
989      */
990     /* used by SSL_read */
991     BIO *rbio;
992     /* used by SSL_write */
993     BIO *wbio;
994     /* used during session-id reuse to concatenate messages */
995     BIO *bbio;
996     /*
997      * This holds a variable that indicates what we were doing when a 0 or -1
998      * is returned.  This is needed for non-blocking IO so we know what
999      * request needs re-doing when in SSL_accept or SSL_connect
1000      */
1001     int rwstate;
1002     int (*handshake_func) (SSL *);
1003     /*
1004      * Imagine that here's a boolean member "init" that is switched as soon
1005      * as SSL_set_{accept/connect}_state is called for the first time, so
1006      * that "state" and "handshake_func" are properly initialized.  But as
1007      * handshake_func is == 0 until then, we use this test instead of an
1008      * "init" member.
1009      */
1010     /* are we the server side? */
1011     int server;
1012     /*
1013      * Generate a new session or reuse an old one.
1014      * NB: For servers, the 'new' session may actually be a previously
1015      * cached session or even the previous session unless
1016      * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1017      */
1018     int new_session;
1019     /* don't send shutdown packets */
1020     int quiet_shutdown;
1021     /* we have shut things down, 0x01 sent, 0x02 for received */
1022     int shutdown;
1023     /* where we are */
1024     OSSL_STATEM statem;
1025     SSL_EARLY_DATA_STATE early_data_state;
1026     BUF_MEM *init_buf;          /* buffer used during init */
1027     void *init_msg;             /* pointer to handshake message body, set by
1028                                  * ssl3_get_message() */
1029     size_t init_num;               /* amount read/written */
1030     size_t init_off;               /* amount read/written */
1031     struct ssl3_state_st *s3;   /* SSLv3 variables */
1032     struct dtls1_state_st *d1;  /* DTLSv1 variables */
1033     /* callback that allows applications to peek at protocol messages */
1034     void (*msg_callback) (int write_p, int version, int content_type,
1035                           const void *buf, size_t len, SSL *ssl, void *arg);
1036     void *msg_callback_arg;
1037     int hit;                    /* reusing a previous session */
1038     X509_VERIFY_PARAM *param;
1039     /* Per connection DANE state */
1040     SSL_DANE dane;
1041     /* crypto */
1042     STACK_OF(SSL_CIPHER) *cipher_list;
1043     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1044     /*
1045      * These are the ones being used, the ones in SSL_SESSION are the ones to
1046      * be 'copied' into these ones
1047      */
1048     uint32_t mac_flags;
1049     /*
1050      * The TLS1.3 secrets. The resumption master secret is stored in the
1051      * session.
1052      */
1053     unsigned char early_secret[EVP_MAX_MD_SIZE];
1054     unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1055     unsigned char master_secret[EVP_MAX_MD_SIZE];
1056     unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1057     unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1058     unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1059     unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1060     unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1061     unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1062     EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1063     unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1064     EVP_MD_CTX *read_hash;      /* used for mac generation */
1065     COMP_CTX *compress;         /* compression */
1066     COMP_CTX *expand;           /* uncompress */
1067     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1068     unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1069     EVP_MD_CTX *write_hash;     /* used for mac generation */
1070     /* Count of how many KeyUpdate messages we have received */
1071     unsigned int key_update_count;
1072     /* session info */
1073     /* client cert? */
1074     /* This is used to hold the server certificate used */
1075     struct cert_st /* CERT */ *cert;
1076
1077     /*
1078      * The hash of all messages prior to the CertificateVerify, and the length
1079      * of that hash.
1080      */
1081     unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1082     size_t cert_verify_hash_len;
1083
1084     /* Flag to indicate whether we should send a HelloRetryRequest or not */
1085     int hello_retry_request;
1086
1087     /*
1088      * the session_id_context is used to ensure sessions are only reused in
1089      * the appropriate context
1090      */
1091     size_t sid_ctx_length;
1092     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1093     /* This can also be in the session once a session is established */
1094     SSL_SESSION *session;
1095     /* Default generate session ID callback. */
1096     GEN_SESSION_CB generate_session_id;
1097     /* Used in SSL3 */
1098     /*
1099      * 0 don't care about verify failure.
1100      * 1 fail if verify fails
1101      */
1102     uint32_t verify_mode;
1103     /* fail if callback returns 0 */
1104     int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1105     /* optional informational callback */
1106     void (*info_callback) (const SSL *ssl, int type, int val);
1107     /* error bytes to be written */
1108     int error;
1109     /* actual code */
1110     int error_code;
1111 # ifndef OPENSSL_NO_PSK
1112     SSL_psk_client_cb_func psk_client_callback;
1113     SSL_psk_server_cb_func psk_server_callback;
1114 # endif
1115     SSL_CTX *ctx;
1116     /* Verified chain of peer */
1117     STACK_OF(X509) *verified_chain;
1118     long verify_result;
1119     /* extra application data */
1120     CRYPTO_EX_DATA ex_data;
1121     /* for server side, keep the list of CA_dn we can use */
1122     STACK_OF(X509_NAME) *ca_names;
1123     CRYPTO_REF_COUNT references;
1124     /* protocol behaviour */
1125     uint32_t options;
1126     /* API behaviour */
1127     uint32_t mode;
1128     int min_proto_version;
1129     int max_proto_version;
1130     size_t max_cert_list;
1131     int first_packet;
1132     /*
1133      * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1134      * secret and SSLv3/TLS (<=1.2) rollback check
1135      */
1136     int client_version;
1137     /*
1138      * If we're using more than one pipeline how should we divide the data
1139      * up between the pipes?
1140      */
1141     size_t split_send_fragment;
1142     /*
1143      * Maximum amount of data to send in one fragment. actual record size can
1144      * be more than this due to padding and MAC overheads.
1145      */
1146     size_t max_send_fragment;
1147     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1148     size_t max_pipelines;
1149
1150     struct {
1151         /* TLS extension debug callback */
1152         void (*debug_cb)(SSL *s, int client_server, int type,
1153                          const unsigned char *data, int len, void *arg);
1154         void *debug_arg;
1155         char *hostname;
1156         /* certificate status request info */
1157         /* Status type or -1 if no status type */
1158         int status_type;
1159         /* Raw extension data, if seen */
1160         unsigned char *scts;
1161         /* Length of raw extension data, if seen */
1162         uint16_t scts_len;
1163         /* Expect OCSP CertificateStatus message */
1164         int status_expected;
1165
1166         struct {
1167             /* OCSP status request only */
1168             STACK_OF(OCSP_RESPID) *ids;
1169             X509_EXTENSIONS *exts;
1170             /* OCSP response received or to be sent */
1171             unsigned char *resp;
1172             size_t resp_len;
1173         } ocsp;
1174
1175         /* RFC4507 session ticket expected to be received or sent */
1176         int ticket_expected;
1177 # ifndef OPENSSL_NO_EC
1178         size_t ecpointformats_len;
1179         /* our list */
1180         unsigned char *ecpointformats;
1181         size_t supportedgroups_len;
1182         /* our list */
1183         unsigned char *supportedgroups;
1184 # endif                         /* OPENSSL_NO_EC */
1185         /* TLS Session Ticket extension override */
1186         TLS_SESSION_TICKET_EXT *session_ticket;
1187         /* TLS Session Ticket extension callback */
1188         tls_session_ticket_ext_cb_fn session_ticket_cb;
1189         void *session_ticket_cb_arg;
1190         /* TLS pre-shared secret session resumption */
1191         tls_session_secret_cb_fn session_secret_cb;
1192         void *session_secret_cb_arg;
1193         /*
1194          * For a client, this contains the list of supported protocols in wire
1195          * format.
1196          */
1197         unsigned char *alpn;
1198         size_t alpn_len;
1199         /*
1200          * Next protocol negotiation. For the client, this is the protocol that
1201          * we sent in NextProtocol and is set when handling ServerHello
1202          * extensions. For a server, this is the client's selected_protocol from
1203          * NextProtocol and is set when handling the NextProtocol message, before
1204          * the Finished message.
1205          */
1206         unsigned char *npn;
1207         size_t npn_len;
1208
1209         /* The available PSK key exchange modes */
1210         int psk_kex_mode;
1211
1212         /* Set to one if we have negotiated ETM */
1213         int use_etm;
1214
1215         /* Are we expecting to receive early data? */
1216         int early_data;
1217         /* Is the session suitable for early data? */
1218         int early_data_ok;
1219
1220         /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1221         unsigned char *tls13_cookie;
1222         size_t tls13_cookie_len;
1223     } ext;
1224
1225     /* Parsed form of the ClientHello, kept around across early_cb calls. */
1226     CLIENTHELLO_MSG *clienthello;
1227
1228     /*-
1229      * no further mod of servername
1230      * 0 : call the servername extension callback.
1231      * 1 : prepare 2, allow last ack just after in server callback.
1232      * 2 : don't call servername callback, no ack in server hello
1233      */
1234     int servername_done;
1235 # ifndef OPENSSL_NO_CT
1236     /*
1237      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1238      * If they are not, the connection should be aborted.
1239      */
1240     ssl_ct_validation_cb ct_validation_callback;
1241     /* User-supplied argument that is passed to the ct_validation_callback */
1242     void *ct_validation_callback_arg;
1243     /*
1244      * Consolidated stack of SCTs from all sources.
1245      * Lazily populated by CT_get_peer_scts(SSL*)
1246      */
1247     STACK_OF(SCT) *scts;
1248     /* Have we attempted to find/parse SCTs yet? */
1249     int scts_parsed;
1250 # endif
1251     SSL_CTX *session_ctx;       /* initial ctx, used to store sessions */
1252     /* What we'll do */
1253     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1254     /* What's been chosen */
1255     SRTP_PROTECTION_PROFILE *srtp_profile;
1256     /*-
1257      * 1 if we are renegotiating.
1258      * 2 if we are a server and are inside a handshake
1259      * (i.e. not just sending a HelloRequest)
1260      */
1261     int renegotiate;
1262     /* If sending a KeyUpdate is pending */
1263     int key_update;
1264 # ifndef OPENSSL_NO_SRP
1265     /* ctx for SRP authentication */
1266     SRP_CTX srp_ctx;
1267 # endif
1268     /*
1269      * Callback for disabling session caching and ticket support on a session
1270      * basis, depending on the chosen cipher.
1271      */
1272     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1273     RECORD_LAYER rlayer;
1274     /* Default password callback. */
1275     pem_password_cb *default_passwd_callback;
1276     /* Default password callback user data. */
1277     void *default_passwd_callback_userdata;
1278     /* Async Job info */
1279     ASYNC_JOB *job;
1280     ASYNC_WAIT_CTX *waitctx;
1281     size_t asyncrw;
1282
1283     /* The maximum number of plaintext bytes that can be sent as early data */
1284     uint32_t max_early_data;
1285     /*
1286      * The number of bytes of early data received so far. If we accepted early
1287      * data then this is a count of the plaintext bytes. If we rejected it then
1288      * this is a count of the ciphertext bytes.
1289      */
1290     uint32_t early_data_count;
1291
1292     CRYPTO_RWLOCK *lock;
1293 };
1294
1295 /*
1296  * Structure containing table entry of values associated with the signature
1297  * algorithms (signature scheme) extension
1298 */
1299 typedef struct sigalg_lookup_st {
1300     /* TLS 1.3 signature scheme name */
1301     const char *name;
1302     /* Raw value used in extension */
1303     uint16_t sigalg;
1304     /* NID of hash algorithm */
1305     int hash;
1306     /* Index of hash algorithm */
1307     int hash_idx;
1308     /* NID of signature algorithm */
1309     int sig;
1310     /* Index of signature algorithm */
1311     int sig_idx;
1312     /* Combined hash and signature NID, if any */
1313     int sigandhash;
1314     /* Required public key curve (ECDSA only) */
1315     int curve;
1316 } SIGALG_LOOKUP;
1317
1318 typedef struct cert_pkey_st CERT_PKEY;
1319
1320 typedef struct ssl3_state_st {
1321     long flags;
1322     size_t read_mac_secret_size;
1323     unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1324     size_t write_mac_secret_size;
1325     unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1326     unsigned char server_random[SSL3_RANDOM_SIZE];
1327     unsigned char client_random[SSL3_RANDOM_SIZE];
1328     /* flags for countermeasure against known-IV weakness */
1329     int need_empty_fragments;
1330     int empty_fragment_done;
1331     /* used during startup, digest all incoming/outgoing packets */
1332     BIO *handshake_buffer;
1333     /*
1334      * When handshake digest is determined, buffer is hashed and
1335      * freed and MD_CTX for the required digest is stored here.
1336      */
1337     EVP_MD_CTX *handshake_dgst;
1338     /*
1339      * Set whenever an expected ChangeCipherSpec message is processed.
1340      * Unset when the peer's Finished message is received.
1341      * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1342      */
1343     int change_cipher_spec;
1344     int warn_alert;
1345     int fatal_alert;
1346     /*
1347      * we allow one fatal and one warning alert to be outstanding, send close
1348      * alert via the warning alert
1349      */
1350     int alert_dispatch;
1351     unsigned char send_alert[2];
1352     /*
1353      * This flag is set when we should renegotiate ASAP, basically when there
1354      * is no more data in the read or write buffers
1355      */
1356     int renegotiate;
1357     int total_renegotiations;
1358     int num_renegotiations;
1359     int in_read_app_data;
1360     struct {
1361         /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1362         unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1363         size_t finish_md_len;
1364         unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1365         size_t peer_finish_md_len;
1366         size_t message_size;
1367         int message_type;
1368         /* used to hold the new cipher we are going to use */
1369         const SSL_CIPHER *new_cipher;
1370 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1371         EVP_PKEY *pkey;         /* holds short lived DH/ECDH key */
1372 # endif
1373         /* used for certificate requests */
1374         int cert_req;
1375         /* Certificate types in certificate request message. */
1376         uint8_t *ctype;
1377         size_t ctype_len;
1378         /* Certificate authorities list peer sent */
1379         STACK_OF(X509_NAME) *peer_ca_names;
1380         size_t key_block_length;
1381         unsigned char *key_block;
1382         const EVP_CIPHER *new_sym_enc;
1383         const EVP_MD *new_hash;
1384         int new_mac_pkey_type;
1385         size_t new_mac_secret_size;
1386 # ifndef OPENSSL_NO_COMP
1387         const SSL_COMP *new_compression;
1388 # else
1389         char *new_compression;
1390 # endif
1391         int cert_request;
1392         /* Raw values of the cipher list from a client */
1393         unsigned char *ciphers_raw;
1394         size_t ciphers_rawlen;
1395         /* Temporary storage for premaster secret */
1396         unsigned char *pms;
1397         size_t pmslen;
1398 # ifndef OPENSSL_NO_PSK
1399         /* Temporary storage for PSK key */
1400         unsigned char *psk;
1401         size_t psklen;
1402 # endif
1403         /* Signature algorithm we actually use */
1404         const SIGALG_LOOKUP *sigalg;
1405         /* Pointer to certificate we use */
1406         CERT_PKEY *cert;
1407         /*
1408          * signature algorithms peer reports: e.g. supported signature
1409          * algorithms extension for server or as part of a certificate
1410          * request for client.
1411          */
1412         uint16_t *peer_sigalgs;
1413         /* Size of above array */
1414         size_t peer_sigalgslen;
1415         /* Sigalg peer actualy uses */
1416         const SIGALG_LOOKUP *peer_sigalg;
1417         /*
1418          * Set if corresponding CERT_PKEY can be used with current
1419          * SSL session: e.g. appropriate curve, signature algorithms etc.
1420          * If zero it can't be used at all.
1421          */
1422         uint32_t valid_flags[SSL_PKEY_NUM];
1423         /*
1424          * For servers the following masks are for the key and auth algorithms
1425          * that are supported by the certs below. For clients they are masks of
1426          * *disabled* algorithms based on the current session.
1427          */
1428         uint32_t mask_k;
1429         uint32_t mask_a;
1430         /*
1431          * The following are used by the client to see if a cipher is allowed or
1432          * not.  It contains the minimum and maximum version the client's using
1433          * based on what it knows so far.
1434          */
1435         int min_ver;
1436         int max_ver;
1437     } tmp;
1438
1439     /* Connection binding to prevent renegotiation attacks */
1440     unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1441     size_t previous_client_finished_len;
1442     unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1443     size_t previous_server_finished_len;
1444     int send_connection_binding; /* TODOEKR */
1445
1446 # ifndef OPENSSL_NO_NEXTPROTONEG
1447     /*
1448      * Set if we saw the Next Protocol Negotiation extension from our peer.
1449      */
1450     int npn_seen;
1451 # endif
1452
1453     /*
1454      * ALPN information (we are in the process of transitioning from NPN to
1455      * ALPN.)
1456      */
1457
1458     /*
1459      * In a server these point to the selected ALPN protocol after the
1460      * ClientHello has been processed. In a client these contain the protocol
1461      * that the server selected once the ServerHello has been processed.
1462      */
1463     unsigned char *alpn_selected;
1464     size_t alpn_selected_len;
1465     /* used by the server to know what options were proposed */
1466     unsigned char *alpn_proposed;
1467     size_t alpn_proposed_len;
1468     /* used by the client to know if it actually sent alpn */
1469     int alpn_sent;
1470
1471 # ifndef OPENSSL_NO_EC
1472     /*
1473      * This is set to true if we believe that this is a version of Safari
1474      * running on OS X 10.6 or newer. We wish to know this because Safari on
1475      * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1476      */
1477     char is_probably_safari;
1478 # endif                         /* !OPENSSL_NO_EC */
1479
1480     /* For clients: peer temporary key */
1481 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1482     /* The group_id for the DH/ECDH key */
1483     unsigned int group_id;
1484     EVP_PKEY *peer_tmp;
1485 # endif
1486
1487 } SSL3_STATE;
1488
1489 /* DTLS structures */
1490
1491 # ifndef OPENSSL_NO_SCTP
1492 #  define DTLS1_SCTP_AUTH_LABEL   "EXPORTER_DTLS_OVER_SCTP"
1493 # endif
1494
1495 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1496 # define DTLS1_MAX_MTU_OVERHEAD                   48
1497
1498 /*
1499  * Flag used in message reuse to indicate the buffer contains the record
1500  * header as well as the the handshake message header.
1501  */
1502 # define DTLS1_SKIP_RECORD_HEADER                 2
1503
1504 struct dtls1_retransmit_state {
1505     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1506     EVP_MD_CTX *write_hash;     /* used for mac generation */
1507     COMP_CTX *compress;         /* compression */
1508     SSL_SESSION *session;
1509     unsigned short epoch;
1510 };
1511
1512 struct hm_header_st {
1513     unsigned char type;
1514     size_t msg_len;
1515     unsigned short seq;
1516     size_t frag_off;
1517     size_t frag_len;
1518     unsigned int is_ccs;
1519     struct dtls1_retransmit_state saved_retransmit_state;
1520 };
1521
1522 struct dtls1_timeout_st {
1523     /* Number of read timeouts so far */
1524     unsigned int read_timeouts;
1525     /* Number of write timeouts so far */
1526     unsigned int write_timeouts;
1527     /* Number of alerts received so far */
1528     unsigned int num_alerts;
1529 };
1530
1531 typedef struct hm_fragment_st {
1532     struct hm_header_st msg_header;
1533     unsigned char *fragment;
1534     unsigned char *reassembly;
1535 } hm_fragment;
1536
1537 typedef struct pqueue_st pqueue;
1538 typedef struct pitem_st pitem;
1539
1540 struct pitem_st {
1541     unsigned char priority[8];  /* 64-bit value in big-endian encoding */
1542     void *data;
1543     pitem *next;
1544 };
1545
1546 typedef struct pitem_st *piterator;
1547
1548 pitem *pitem_new(unsigned char *prio64be, void *data);
1549 void pitem_free(pitem *item);
1550 pqueue *pqueue_new(void);
1551 void pqueue_free(pqueue *pq);
1552 pitem *pqueue_insert(pqueue *pq, pitem *item);
1553 pitem *pqueue_peek(pqueue *pq);
1554 pitem *pqueue_pop(pqueue *pq);
1555 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1556 pitem *pqueue_iterator(pqueue *pq);
1557 pitem *pqueue_next(piterator *iter);
1558 size_t pqueue_size(pqueue *pq);
1559
1560 typedef struct dtls1_state_st {
1561     unsigned char cookie[DTLS1_COOKIE_LENGTH];
1562     size_t cookie_len;
1563     unsigned int cookie_verified;
1564     /* handshake message numbers */
1565     unsigned short handshake_write_seq;
1566     unsigned short next_handshake_write_seq;
1567     unsigned short handshake_read_seq;
1568     /* Buffered handshake messages */
1569     pqueue *buffered_messages;
1570     /* Buffered (sent) handshake records */
1571     pqueue *sent_messages;
1572     size_t link_mtu;      /* max on-the-wire DTLS packet size */
1573     size_t mtu;           /* max DTLS packet size */
1574     struct hm_header_st w_msg_hdr;
1575     struct hm_header_st r_msg_hdr;
1576     struct dtls1_timeout_st timeout;
1577     /*
1578      * Indicates when the last handshake msg sent will timeout
1579      */
1580     struct timeval next_timeout;
1581     /* Timeout duration */
1582     unsigned short timeout_duration;
1583     unsigned int retransmitting;
1584 # ifndef OPENSSL_NO_SCTP
1585     int shutdown_received;
1586 # endif
1587 } DTLS1_STATE;
1588
1589 # ifndef OPENSSL_NO_EC
1590 /*
1591  * From ECC-TLS draft, used in encoding the curve type in ECParameters
1592  */
1593 #  define EXPLICIT_PRIME_CURVE_TYPE  1
1594 #  define EXPLICIT_CHAR2_CURVE_TYPE  2
1595 #  define NAMED_CURVE_TYPE           3
1596 # endif                         /* OPENSSL_NO_EC */
1597
1598 struct cert_pkey_st {
1599     X509 *x509;
1600     EVP_PKEY *privatekey;
1601     /* Chain for this certificate */
1602     STACK_OF(X509) *chain;
1603     /*-
1604      * serverinfo data for this certificate.  The data is in TLS Extension
1605      * wire format, specifically it's a series of records like:
1606      *   uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1607      *   uint16_t length;
1608      *   uint8_t data[length];
1609      */
1610     unsigned char *serverinfo;
1611     size_t serverinfo_length;
1612 };
1613 /* Retrieve Suite B flags */
1614 # define tls1_suiteb(s)  (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1615 /* Uses to check strict mode: suite B modes are always strict */
1616 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1617         (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1618
1619 typedef enum {
1620     ENDPOINT_CLIENT = 0,
1621     ENDPOINT_SERVER,
1622     ENDPOINT_BOTH
1623 } ENDPOINT;
1624
1625
1626 typedef struct {
1627     unsigned short ext_type;
1628     ENDPOINT role;
1629     /* The context which this extension applies to */
1630     unsigned int context;
1631     /*
1632      * Per-connection flags relating to this extension type: not used if
1633      * part of an SSL_CTX structure.
1634      */
1635     uint32_t ext_flags;
1636     SSL_custom_ext_add_cb_ex add_cb;
1637     SSL_custom_ext_free_cb_ex free_cb;
1638     void *add_arg;
1639     SSL_custom_ext_parse_cb_ex parse_cb;
1640     void *parse_arg;
1641 } custom_ext_method;
1642
1643 /* ext_flags values */
1644
1645 /*
1646  * Indicates an extension has been received. Used to check for unsolicited or
1647  * duplicate extensions.
1648  */
1649 # define SSL_EXT_FLAG_RECEIVED   0x1
1650 /*
1651  * Indicates an extension has been sent: used to enable sending of
1652  * corresponding ServerHello extension.
1653  */
1654 # define SSL_EXT_FLAG_SENT       0x2
1655
1656 typedef struct {
1657     custom_ext_method *meths;
1658     size_t meths_count;
1659 } custom_ext_methods;
1660
1661 typedef struct cert_st {
1662     /* Current active set */
1663     /*
1664      * ALWAYS points to an element of the pkeys array
1665      * Probably it would make more sense to store
1666      * an index, not a pointer.
1667      */
1668     CERT_PKEY *key;
1669 # ifndef OPENSSL_NO_DH
1670     EVP_PKEY *dh_tmp;
1671     DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1672     int dh_tmp_auto;
1673 # endif
1674     /* Flags related to certificates */
1675     uint32_t cert_flags;
1676     CERT_PKEY pkeys[SSL_PKEY_NUM];
1677     /* Custom certificate types sent in certificate request message. */
1678     uint8_t *ctype;
1679     size_t ctype_len;
1680     /*
1681      * supported signature algorithms. When set on a client this is sent in
1682      * the client hello as the supported signature algorithms extension. For
1683      * servers it represents the signature algorithms we are willing to use.
1684      */
1685     uint16_t *conf_sigalgs;
1686     /* Size of above array */
1687     size_t conf_sigalgslen;
1688     /*
1689      * Client authentication signature algorithms, if not set then uses
1690      * conf_sigalgs. On servers these will be the signature algorithms sent
1691      * to the client in a certificate request for TLS 1.2. On a client this
1692      * represents the signature algorithms we are willing to use for client
1693      * authentication.
1694      */
1695     uint16_t *client_sigalgs;
1696     /* Size of above array */
1697     size_t client_sigalgslen;
1698     /*
1699      * Signature algorithms shared by client and server: cached because these
1700      * are used most often.
1701      */
1702     const SIGALG_LOOKUP **shared_sigalgs;
1703     size_t shared_sigalgslen;
1704     /*
1705      * Certificate setup callback: if set is called whenever a certificate
1706      * may be required (client or server). the callback can then examine any
1707      * appropriate parameters and setup any certificates required. This
1708      * allows advanced applications to select certificates on the fly: for
1709      * example based on supported signature algorithms or curves.
1710      */
1711     int (*cert_cb) (SSL *ssl, void *arg);
1712     void *cert_cb_arg;
1713     /*
1714      * Optional X509_STORE for chain building or certificate validation If
1715      * NULL the parent SSL_CTX store is used instead.
1716      */
1717     X509_STORE *chain_store;
1718     X509_STORE *verify_store;
1719     /* Custom extensions */
1720     custom_ext_methods custext;
1721     /* Security callback */
1722     int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1723                    void *other, void *ex);
1724     /* Security level */
1725     int sec_level;
1726     void *sec_ex;
1727 # ifndef OPENSSL_NO_PSK
1728     /* If not NULL psk identity hint to use for servers */
1729     char *psk_identity_hint;
1730 # endif
1731     CRYPTO_REF_COUNT references;             /* >1 only if SSL_copy_session_id is used */
1732     CRYPTO_RWLOCK *lock;
1733 } CERT;
1734
1735 # define FP_ICC  (int (*)(const void *,const void *))
1736
1737 /*
1738  * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1739  * of a mess of functions, but hell, think of it as an opaque structure :-)
1740  */
1741 typedef struct ssl3_enc_method {
1742     int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1743     int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1744     int (*setup_key_block) (SSL *);
1745     int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1746                                    size_t, size_t *);
1747     int (*change_cipher_state) (SSL *, int);
1748     size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1749     const char *client_finished_label;
1750     size_t client_finished_label_len;
1751     const char *server_finished_label;
1752     size_t server_finished_label_len;
1753     int (*alert_value) (int);
1754     int (*export_keying_material) (SSL *, unsigned char *, size_t,
1755                                    const char *, size_t,
1756                                    const unsigned char *, size_t,
1757                                    int use_context);
1758     /* Various flags indicating protocol version requirements */
1759     uint32_t enc_flags;
1760     /* Set the handshake header */
1761     int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1762     /* Close construction of the handshake message */
1763     int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1764     /* Write out handshake message */
1765     int (*do_write) (SSL *s);
1766 } SSL3_ENC_METHOD;
1767
1768 # define ssl_set_handshake_header(s, pkt, htype) \
1769         s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1770 # define ssl_close_construct_packet(s, pkt, htype) \
1771         s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1772 # define ssl_do_write(s)  s->method->ssl3_enc->do_write(s)
1773
1774 /* Values for enc_flags */
1775
1776 /* Uses explicit IV for CBC mode */
1777 # define SSL_ENC_FLAG_EXPLICIT_IV        0x1
1778 /* Uses signature algorithms extension */
1779 # define SSL_ENC_FLAG_SIGALGS            0x2
1780 /* Uses SHA256 default PRF */
1781 # define SSL_ENC_FLAG_SHA256_PRF         0x4
1782 /* Is DTLS */
1783 # define SSL_ENC_FLAG_DTLS               0x8
1784 /*
1785  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1786  * apply to others in future.
1787  */
1788 # define SSL_ENC_FLAG_TLS1_2_CIPHERS     0x10
1789
1790 # ifndef OPENSSL_NO_COMP
1791 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1792 typedef struct ssl3_comp_st {
1793     int comp_id;                /* The identifier byte for this compression
1794                                  * type */
1795     char *name;                 /* Text name used for the compression type */
1796     COMP_METHOD *method;        /* The method :-) */
1797 } SSL3_COMP;
1798 # endif
1799
1800 typedef enum downgrade_en {
1801     DOWNGRADE_NONE,
1802     DOWNGRADE_TO_1_2,
1803     DOWNGRADE_TO_1_1
1804 } DOWNGRADE;
1805
1806 /*
1807  * Extension index values NOTE: Any updates to these defines should be mirrored
1808  * with equivalent updates to ext_defs in extensions.c
1809  */
1810 typedef enum tlsext_index_en {
1811     TLSEXT_IDX_renegotiate,
1812     TLSEXT_IDX_server_name,
1813     TLSEXT_IDX_srp,
1814     TLSEXT_IDX_ec_point_formats,
1815     TLSEXT_IDX_supported_groups,
1816     TLSEXT_IDX_session_ticket,
1817     TLSEXT_IDX_signature_algorithms,
1818     TLSEXT_IDX_status_request,
1819     TLSEXT_IDX_next_proto_neg,
1820     TLSEXT_IDX_application_layer_protocol_negotiation,
1821     TLSEXT_IDX_use_srtp,
1822     TLSEXT_IDX_encrypt_then_mac,
1823     TLSEXT_IDX_signed_certificate_timestamp,
1824     TLSEXT_IDX_extended_master_secret,
1825     TLSEXT_IDX_supported_versions,
1826     TLSEXT_IDX_psk_kex_modes,
1827     TLSEXT_IDX_key_share,
1828     TLSEXT_IDX_cookie,
1829     TLSEXT_IDX_cryptopro_bug,
1830     TLSEXT_IDX_early_data,
1831     TLSEXT_IDX_certificate_authorities,
1832     TLSEXT_IDX_padding,
1833     TLSEXT_IDX_psk
1834 } TLSEXT_INDEX;
1835
1836 /*
1837  * Dummy status type for the status_type extension. Indicates no status type
1838  * set
1839  */
1840 #define TLSEXT_STATUSTYPE_nothing  -1
1841
1842 /* Sigalgs values */
1843 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256                    0x0403
1844 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384                    0x0503
1845 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512                    0x0603
1846 #define TLSEXT_SIGALG_ecdsa_sha1                                0x0203
1847 #define TLSEXT_SIGALG_rsa_pss_sha256                            0x0804
1848 #define TLSEXT_SIGALG_rsa_pss_sha384                            0x0805
1849 #define TLSEXT_SIGALG_rsa_pss_sha512                            0x0806
1850 #define TLSEXT_SIGALG_rsa_pkcs1_sha256                          0x0401
1851 #define TLSEXT_SIGALG_rsa_pkcs1_sha384                          0x0501
1852 #define TLSEXT_SIGALG_rsa_pkcs1_sha512                          0x0601
1853 #define TLSEXT_SIGALG_rsa_pkcs1_sha1                            0x0201
1854 #define TLSEXT_SIGALG_dsa_sha256                                0x0402
1855 #define TLSEXT_SIGALG_dsa_sha384                                0x0502
1856 #define TLSEXT_SIGALG_dsa_sha512                                0x0602
1857 #define TLSEXT_SIGALG_dsa_sha1                                  0x0202
1858 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256       0xeeee
1859 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512       0xefef
1860 #define TLSEXT_SIGALG_gostr34102001_gostr3411                   0xeded
1861
1862 /* Known PSK key exchange modes */
1863 #define TLSEXT_KEX_MODE_KE                                      0x00
1864 #define TLSEXT_KEX_MODE_KE_DHE                                  0x01
1865
1866 /*
1867  * Internal representations of key exchange modes
1868  */
1869 #define TLSEXT_KEX_MODE_FLAG_NONE                               0
1870 #define TLSEXT_KEX_MODE_FLAG_KE                                 1
1871 #define TLSEXT_KEX_MODE_FLAG_KE_DHE                             2
1872
1873 /* An invalid index into the TLSv1.3 PSK identities */
1874 #define TLSEXT_PSK_BAD_IDENTITY                                 -1
1875
1876 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1877                         s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1878
1879 /* A dummy signature value not valid for TLSv1.2 signature algs */
1880 #define TLSEXT_signature_rsa_pss                                0x0101
1881
1882 /* TLSv1.3 downgrade protection sentinel values */
1883 extern const unsigned char tls11downgrade[8];
1884 extern const unsigned char tls12downgrade[8];
1885
1886 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1887
1888 __owur const SSL_METHOD *ssl_bad_method(int ver);
1889 __owur const SSL_METHOD *sslv3_method(void);
1890 __owur const SSL_METHOD *sslv3_server_method(void);
1891 __owur const SSL_METHOD *sslv3_client_method(void);
1892 __owur const SSL_METHOD *tlsv1_method(void);
1893 __owur const SSL_METHOD *tlsv1_server_method(void);
1894 __owur const SSL_METHOD *tlsv1_client_method(void);
1895 __owur const SSL_METHOD *tlsv1_1_method(void);
1896 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1897 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1898 __owur const SSL_METHOD *tlsv1_2_method(void);
1899 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1900 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1901 __owur const SSL_METHOD *tlsv1_3_method(void);
1902 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1903 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1904 __owur const SSL_METHOD *dtlsv1_method(void);
1905 __owur const SSL_METHOD *dtlsv1_server_method(void);
1906 __owur const SSL_METHOD *dtlsv1_client_method(void);
1907 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1908 __owur const SSL_METHOD *dtlsv1_2_method(void);
1909 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1910 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1911
1912 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1913 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1914 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1915 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1916 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1917 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1918 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1919
1920 /*
1921  * Flags for SSL methods
1922  */
1923 # define SSL_METHOD_NO_FIPS      (1U<<0)
1924 # define SSL_METHOD_NO_SUITEB    (1U<<1)
1925
1926 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1927                                  s_connect, enc_data) \
1928 const SSL_METHOD *func_name(void)  \
1929         { \
1930         static const SSL_METHOD func_name##_data= { \
1931                 version, \
1932                 flags, \
1933                 mask, \
1934                 tls1_new, \
1935                 tls1_clear, \
1936                 tls1_free, \
1937                 s_accept, \
1938                 s_connect, \
1939                 ssl3_read, \
1940                 ssl3_peek, \
1941                 ssl3_write, \
1942                 ssl3_shutdown, \
1943                 ssl3_renegotiate, \
1944                 ssl3_renegotiate_check, \
1945                 ssl3_read_bytes, \
1946                 ssl3_write_bytes, \
1947                 ssl3_dispatch_alert, \
1948                 ssl3_ctrl, \
1949                 ssl3_ctx_ctrl, \
1950                 ssl3_get_cipher_by_char, \
1951                 ssl3_put_cipher_by_char, \
1952                 ssl3_pending, \
1953                 ssl3_num_ciphers, \
1954                 ssl3_get_cipher, \
1955                 tls1_default_timeout, \
1956                 &enc_data, \
1957                 ssl_undefined_void_function, \
1958                 ssl3_callback_ctrl, \
1959                 ssl3_ctx_callback_ctrl, \
1960         }; \
1961         return &func_name##_data; \
1962         }
1963
1964 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1965 const SSL_METHOD *func_name(void)  \
1966         { \
1967         static const SSL_METHOD func_name##_data= { \
1968                 SSL3_VERSION, \
1969                 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1970                 SSL_OP_NO_SSLv3, \
1971                 ssl3_new, \
1972                 ssl3_clear, \
1973                 ssl3_free, \
1974                 s_accept, \
1975                 s_connect, \
1976                 ssl3_read, \
1977                 ssl3_peek, \
1978                 ssl3_write, \
1979                 ssl3_shutdown, \
1980                 ssl3_renegotiate, \
1981                 ssl3_renegotiate_check, \
1982                 ssl3_read_bytes, \
1983                 ssl3_write_bytes, \
1984                 ssl3_dispatch_alert, \
1985                 ssl3_ctrl, \
1986                 ssl3_ctx_ctrl, \
1987                 ssl3_get_cipher_by_char, \
1988                 ssl3_put_cipher_by_char, \
1989                 ssl3_pending, \
1990                 ssl3_num_ciphers, \
1991                 ssl3_get_cipher, \
1992                 ssl3_default_timeout, \
1993                 &SSLv3_enc_data, \
1994                 ssl_undefined_void_function, \
1995                 ssl3_callback_ctrl, \
1996                 ssl3_ctx_callback_ctrl, \
1997         }; \
1998         return &func_name##_data; \
1999         }
2000
2001 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2002                                         s_connect, enc_data) \
2003 const SSL_METHOD *func_name(void)  \
2004         { \
2005         static const SSL_METHOD func_name##_data= { \
2006                 version, \
2007                 flags, \
2008                 mask, \
2009                 dtls1_new, \
2010                 dtls1_clear, \
2011                 dtls1_free, \
2012                 s_accept, \
2013                 s_connect, \
2014                 ssl3_read, \
2015                 ssl3_peek, \
2016                 ssl3_write, \
2017                 dtls1_shutdown, \
2018                 ssl3_renegotiate, \
2019                 ssl3_renegotiate_check, \
2020                 dtls1_read_bytes, \
2021                 dtls1_write_app_data_bytes, \
2022                 dtls1_dispatch_alert, \
2023                 dtls1_ctrl, \
2024                 ssl3_ctx_ctrl, \
2025                 ssl3_get_cipher_by_char, \
2026                 ssl3_put_cipher_by_char, \
2027                 ssl3_pending, \
2028                 ssl3_num_ciphers, \
2029                 ssl3_get_cipher, \
2030                 dtls1_default_timeout, \
2031                 &enc_data, \
2032                 ssl_undefined_void_function, \
2033                 ssl3_callback_ctrl, \
2034                 ssl3_ctx_callback_ctrl, \
2035         }; \
2036         return &func_name##_data; \
2037         }
2038
2039 struct openssl_ssl_test_functions {
2040     int (*p_ssl_init_wbio_buffer) (SSL *s);
2041     int (*p_ssl3_setup_buffers) (SSL *s);
2042 };
2043
2044 const char *ssl_protocol_to_string(int version);
2045
2046 /* Returns true if certificate and private key for 'idx' are present */
2047 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2048 {
2049     if (idx < 0 || idx >= SSL_PKEY_NUM)
2050         return 0;
2051     return s->cert->pkeys[idx].x509 != NULL
2052         && s->cert->pkeys[idx].privatekey != NULL;
2053 }
2054
2055 # ifndef OPENSSL_UNIT_TEST
2056
2057 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2058 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2059 void ssl_clear_cipher_ctx(SSL *s);
2060 int ssl_clear_bad_session(SSL *s);
2061 __owur CERT *ssl_cert_new(void);
2062 __owur CERT *ssl_cert_dup(CERT *cert);
2063 void ssl_cert_clear_certs(CERT *c);
2064 void ssl_cert_free(CERT *c);
2065 __owur int ssl_get_new_session(SSL *s, int session);
2066 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
2067 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2068 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2069 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2070 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2071                                  const SSL_CIPHER *const *bp);
2072 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2073                                                     STACK_OF(SSL_CIPHER) **pref,
2074                                                     STACK_OF(SSL_CIPHER)
2075                                                     **sorted,
2076                                                     const char *rule_str,
2077                                                     CERT *c);
2078 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites,
2079                                 int sslv2format, int *al);
2080 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2081                                 STACK_OF(SSL_CIPHER) **skp,
2082                                 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2083                                 int *al);
2084 void ssl_update_cache(SSL *s, int mode);
2085 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2086                               const EVP_MD **md, int *mac_pkey_type,
2087                               size_t *mac_secret_size, SSL_COMP **comp,
2088                               int use_etm);
2089 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2090                                    size_t *int_overhead, size_t *blocksize,
2091                                    size_t *ext_overhead);
2092 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2093 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2094                                                 const unsigned char *ptr,
2095                                                 int all);
2096 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2097 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2098 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2099 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2100 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2101 __owur int ssl_cert_set_current(CERT *c, long arg);
2102 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2103 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2104
2105 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2106 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2107 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2108                                    int ref);
2109
2110 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2111 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2112                             void *other);
2113
2114 int ssl_undefined_function(SSL *s);
2115 __owur int ssl_undefined_void_function(void);
2116 __owur int ssl_undefined_const_function(const SSL *s);
2117 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2118                                           const unsigned char **serverinfo,
2119                                           size_t *serverinfo_length);
2120 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2121 void ssl_set_masks(SSL *s);
2122 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2123 __owur int ssl_verify_alarm_type(long type);
2124 void ssl_sort_cipher_list(void);
2125 void ssl_load_ciphers(void);
2126 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2127                                  size_t len, DOWNGRADE dgrd);
2128 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2129                                       int free_pms);
2130 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2131 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2132                       int genmaster);
2133 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2134
2135 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2136 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2137 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2138                                    size_t *len);
2139 int ssl3_init_finished_mac(SSL *s);
2140 __owur int ssl3_setup_key_block(SSL *s);
2141 __owur int ssl3_change_cipher_state(SSL *s, int which);
2142 void ssl3_cleanup_key_block(SSL *s);
2143 __owur int ssl3_do_write(SSL *s, int type);
2144 int ssl3_send_alert(SSL *s, int level, int desc);
2145 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2146                                        unsigned char *p, size_t len,
2147                                        size_t *secret_size);
2148 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2149 __owur int ssl3_num_ciphers(void);
2150 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2151 int ssl3_renegotiate(SSL *ssl);
2152 int ssl3_renegotiate_check(SSL *ssl, int initok);
2153 __owur int ssl3_dispatch_alert(SSL *s);
2154 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2155                                     unsigned char *p);
2156 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2157 void ssl3_free_digest_list(SSL *s);
2158 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2159                                             CERT_PKEY *cpk, int *al);
2160 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2161                                             STACK_OF(SSL_CIPHER) *clnt,
2162                                             STACK_OF(SSL_CIPHER) *srvr);
2163 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2164 __owur int ssl3_new(SSL *s);
2165 void ssl3_free(SSL *s);
2166 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2167 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2168 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2169 __owur int ssl3_shutdown(SSL *s);
2170 void ssl3_clear(SSL *s);
2171 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2172 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2173 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2174 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2175
2176 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2177 __owur long ssl3_default_timeout(void);
2178
2179 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2180 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2181 __owur int tls_setup_handshake(SSL *s);
2182 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2183 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2184 __owur int ssl3_handshake_write(SSL *s);
2185
2186 __owur int ssl_allow_compression(SSL *s);
2187
2188 __owur int ssl_version_supported(const SSL *s, int version);
2189
2190 __owur int ssl_set_client_hello_version(SSL *s);
2191 __owur int ssl_check_version_downgrade(SSL *s);
2192 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2193 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2194                                      DOWNGRADE *dgrd);
2195 __owur int ssl_choose_client_version(SSL *s, int version, int checkdgrd,
2196                                      int *al);
2197 int ssl_get_client_min_max_version(const SSL *s, int *min_version,
2198                                    int *max_version);
2199
2200 __owur long tls1_default_timeout(void);
2201 __owur int dtls1_do_write(SSL *s, int type);
2202 void dtls1_set_message_header(SSL *s,
2203                               unsigned char mt,
2204                               size_t len,
2205                               size_t frag_off, size_t frag_len);
2206
2207 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2208                                size_t *written);
2209
2210 __owur int dtls1_read_failed(SSL *s, int code);
2211 __owur int dtls1_buffer_message(SSL *s, int ccs);
2212 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2213 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2214 int dtls1_retransmit_buffered_messages(SSL *s);
2215 void dtls1_clear_received_buffer(SSL *s);
2216 void dtls1_clear_sent_buffer(SSL *s);
2217 void dtls1_get_message_header(unsigned char *data,
2218                               struct hm_header_st *msg_hdr);
2219 __owur long dtls1_default_timeout(void);
2220 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2221 __owur int dtls1_check_timeout_num(SSL *s);
2222 __owur int dtls1_handle_timeout(SSL *s);
2223 void dtls1_start_timer(SSL *s);
2224 void dtls1_stop_timer(SSL *s);
2225 __owur int dtls1_is_timer_expired(SSL *s);
2226 void dtls1_double_timeout(SSL *s);
2227 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2228                                          size_t cookie_len);
2229 __owur int dtls1_send_newsession_ticket(SSL *s);
2230 __owur size_t dtls1_min_mtu(SSL *s);
2231 void dtls1_hm_fragment_free(hm_fragment *frag);
2232 __owur int dtls1_query_mtu(SSL *s);
2233
2234 __owur int tls1_new(SSL *s);
2235 void tls1_free(SSL *s);
2236 void tls1_clear(SSL *s);
2237 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2238 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2239
2240 __owur int dtls1_new(SSL *s);
2241 void dtls1_free(SSL *s);
2242 void dtls1_clear(SSL *s);
2243 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2244 __owur int dtls1_shutdown(SSL *s);
2245
2246 __owur int dtls1_dispatch_alert(SSL *s);
2247
2248 __owur int ssl_init_wbio_buffer(SSL *s);
2249 void ssl_free_wbio_buffer(SSL *s);
2250
2251 __owur int tls1_change_cipher_state(SSL *s, int which);
2252 __owur int tls1_setup_key_block(SSL *s);
2253 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2254                                     unsigned char *p);
2255 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2256                                        unsigned char *p, size_t len,
2257                                        size_t *secret_size);
2258 __owur int tls13_setup_key_block(SSL *s);
2259 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2260                                      unsigned char *p);
2261 __owur int tls13_change_cipher_state(SSL *s, int which);
2262 __owur int tls13_update_key(SSL *s, int send);
2263 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2264                              const unsigned char *secret,
2265                              const unsigned char *label, size_t labellen,
2266                              const unsigned char *hash,
2267                              unsigned char *out, size_t outlen);
2268 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2269                             const unsigned char *secret, unsigned char *key,
2270                             size_t keylen);
2271 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2272                            const unsigned char *secret, unsigned char *iv,
2273                            size_t ivlen);
2274 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2275                                     const unsigned char *secret,
2276                                     unsigned char *fin, size_t finlen);
2277 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2278                           const unsigned char *prevsecret,
2279                           const unsigned char *insecret,
2280                           size_t insecretlen,
2281                           unsigned char *outsecret);
2282 __owur int tls13_generate_handshake_secret(SSL *s,
2283                                            const unsigned char *insecret,
2284                                            size_t insecretlen);
2285 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2286                                         unsigned char *prev, size_t prevlen,
2287                                         size_t *secret_size);
2288 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2289                                        const char *label, size_t llen,
2290                                        const unsigned char *p, size_t plen,
2291                                        int use_context);
2292 __owur int tls1_alert_code(int code);
2293 __owur int tls13_alert_code(int code);
2294 __owur int ssl3_alert_code(int code);
2295
2296 #  ifndef OPENSSL_NO_EC
2297 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2298 #  endif
2299
2300 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2301
2302 #  ifndef OPENSSL_NO_EC
2303 /* Flags values from tls1_ec_curve_id2nid() */
2304 /* Mask for curve type */
2305 # define TLS_CURVE_TYPE          0x3
2306 # define TLS_CURVE_PRIME         0x0
2307 # define TLS_CURVE_CHAR2         0x1
2308 # define TLS_CURVE_CUSTOM        0x2
2309
2310 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2311
2312 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2313 __owur int tls1_ec_nid2curve_id(int nid);
2314 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2315 __owur int tls1_shared_group(SSL *s, int nmatch);
2316 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2317                            int *curves, size_t ncurves);
2318 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2319                                 const char *str);
2320 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2321                          size_t *num_formats);
2322 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2323 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2324 #  endif                        /* OPENSSL_NO_EC */
2325
2326 __owur int tls1_shared_list(SSL *s,
2327                             const unsigned char *l1, size_t l1len,
2328                             const unsigned char *l2, size_t l2len, int nmatch);
2329 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2330 __owur  int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2331                                size_t *num_curves);
2332
2333 void ssl_set_default_md(SSL *s);
2334 __owur int tls1_set_server_sigalgs(SSL *s);
2335
2336 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2337 typedef enum ticket_en {
2338     /* fatal error, malloc failure */
2339     TICKET_FATAL_ERR_MALLOC,
2340     /* fatal error, either from parsing or decrypting the ticket */
2341     TICKET_FATAL_ERR_OTHER,
2342     /* No ticket present */
2343     TICKET_NONE,
2344     /* Empty ticket present */
2345     TICKET_EMPTY,
2346     /* the ticket couldn't be decrypted */
2347     TICKET_NO_DECRYPT,
2348     /* a ticket was successfully decrypted */
2349     TICKET_SUCCESS,
2350     /* same as above but the ticket needs to be reneewed */
2351     TICKET_SUCCESS_RENEW
2352 } TICKET_RETURN;
2353
2354 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2355                                                 SSL_SESSION **ret);
2356 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2357                                         size_t eticklen,
2358                                         const unsigned char *sess_id,
2359                                         size_t sesslen, SSL_SESSION **psess);
2360
2361 __owur int tls_use_ticket(SSL *s);
2362
2363 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2364
2365 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2366 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2367                             int client);
2368 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2369                      int idx);
2370 void tls1_set_cert_validity(SSL *s);
2371
2372 #  ifndef OPENSSL_NO_CT
2373 __owur int ssl_validate_ct(SSL *s);
2374 #  endif
2375
2376 #  ifndef OPENSSL_NO_DH
2377 __owur DH *ssl_get_auto_dh(SSL *s);
2378 #  endif
2379
2380 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2381 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2382                                    int vfy);
2383
2384 int tls_choose_sigalg(SSL *s, int *al);
2385
2386 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2387 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2388 __owur long ssl_get_algorithm2(SSL *s);
2389 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2390                               const uint16_t *psig, size_t psiglen);
2391 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2392 __owur int tls1_process_sigalgs(SSL *s);
2393 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2394 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2395 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2396 void ssl_set_client_disabled(SSL *s);
2397 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2398
2399 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2400                                  size_t *hashlen);
2401 __owur const EVP_MD *ssl_md(int idx);
2402 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2403 __owur const EVP_MD *ssl_prf_md(SSL *s);
2404
2405 /*
2406  * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2407  * with |ssl|, if logging is enabled. It returns one on success and zero on
2408  * failure. The entry is identified by the first 8 bytes of
2409  * |encrypted_premaster|.
2410  */
2411 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2412                                            const uint8_t *encrypted_premaster,
2413                                            size_t encrypted_premaster_len,
2414                                            const uint8_t *premaster,
2415                                            size_t premaster_len);
2416
2417 /*
2418  * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2419  * logging is available. It returns one on success and zero on failure. It tags
2420  * the entry with |label|.
2421  */
2422 __owur int ssl_log_secret(SSL *ssl, const char *label,
2423                           const uint8_t *secret, size_t secret_len);
2424
2425 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2426 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2427 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2428 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2429 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2430 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2431
2432 /* s3_cbc.c */
2433 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2434 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2435                                   unsigned char *md_out,
2436                                   size_t *md_out_size,
2437                                   const unsigned char header[13],
2438                                   const unsigned char *data,
2439                                   size_t data_plus_mac_size,
2440                                   size_t data_plus_mac_plus_padding_size,
2441                                   const unsigned char *mac_secret,
2442                                   size_t mac_secret_length, char is_sslv3);
2443
2444 __owur int srp_generate_server_master_secret(SSL *s);
2445 __owur int srp_generate_client_master_secret(SSL *s);
2446 __owur int srp_verify_server_param(SSL *s, int *al);
2447
2448 /* statem/extensions_cust.c */
2449
2450 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2451                                    ENDPOINT role, unsigned int ext_type,
2452                                    size_t *idx);
2453
2454 void custom_ext_init(custom_ext_methods *meths);
2455
2456 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2457                             const unsigned char *ext_data, size_t ext_size,
2458                             X509 *x, size_t chainidx, int *al);
2459 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2460                           size_t chainidx, int maxversion, int *al);
2461
2462 __owur int custom_exts_copy(custom_ext_methods *dst,
2463                             const custom_ext_methods *src);
2464 void custom_exts_free(custom_ext_methods *exts);
2465
2466 void ssl_comp_free_compression_methods_int(void);
2467
2468 # else /* OPENSSL_UNIT_TEST */
2469
2470 #  define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2471 #  define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2472
2473 # endif
2474 #endif