Fail if we receive a response to an extension that we didn't request
[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 /*
690  * Extension index values NOTE: Any updates to these defines should be mirrored
691  * with equivalent updates to ext_defs in extensions.c
692  */
693 typedef enum tlsext_index_en {
694     TLSEXT_IDX_renegotiate,
695     TLSEXT_IDX_server_name,
696     TLSEXT_IDX_srp,
697     TLSEXT_IDX_ec_point_formats,
698     TLSEXT_IDX_supported_groups,
699     TLSEXT_IDX_session_ticket,
700     TLSEXT_IDX_signature_algorithms,
701     TLSEXT_IDX_status_request,
702     TLSEXT_IDX_next_proto_neg,
703     TLSEXT_IDX_application_layer_protocol_negotiation,
704     TLSEXT_IDX_use_srtp,
705     TLSEXT_IDX_encrypt_then_mac,
706     TLSEXT_IDX_signed_certificate_timestamp,
707     TLSEXT_IDX_extended_master_secret,
708     TLSEXT_IDX_supported_versions,
709     TLSEXT_IDX_psk_kex_modes,
710     TLSEXT_IDX_key_share,
711     TLSEXT_IDX_cookie,
712     TLSEXT_IDX_cryptopro_bug,
713     TLSEXT_IDX_early_data,
714     TLSEXT_IDX_certificate_authorities,
715     TLSEXT_IDX_padding,
716     TLSEXT_IDX_psk,
717     /* Dummy index - must always be the last entry */
718     TLSEXT_IDX_num_builtins
719 } TLSEXT_INDEX;
720
721 DEFINE_LHASH_OF(SSL_SESSION);
722 /* Needed in ssl_cert.c */
723 DEFINE_LHASH_OF(X509_NAME);
724
725 # define TLSEXT_KEYNAME_LENGTH 16
726
727 struct ssl_ctx_st {
728     const SSL_METHOD *method;
729     STACK_OF(SSL_CIPHER) *cipher_list;
730     /* same as above but sorted for lookup */
731     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
732     struct x509_store_st /* X509_STORE */ *cert_store;
733     LHASH_OF(SSL_SESSION) *sessions;
734     /*
735      * Most session-ids that will be cached, default is
736      * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
737      */
738     size_t session_cache_size;
739     struct ssl_session_st *session_cache_head;
740     struct ssl_session_st *session_cache_tail;
741     /*
742      * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
743      * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
744      * means only SSL_accept which cache SSL_SESSIONS.
745      */
746     uint32_t session_cache_mode;
747     /*
748      * If timeout is not 0, it is the default timeout value set when
749      * SSL_new() is called.  This has been put in to make life easier to set
750      * things up
751      */
752     long session_timeout;
753     /*
754      * If this callback is not null, it will be called each time a session id
755      * is added to the cache.  If this function returns 1, it means that the
756      * callback will do a SSL_SESSION_free() when it has finished using it.
757      * Otherwise, on 0, it means the callback has finished with it. If
758      * remove_session_cb is not null, it will be called when a session-id is
759      * removed from the cache.  After the call, OpenSSL will
760      * SSL_SESSION_free() it.
761      */
762     int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
763     void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
764     SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
765                                     const unsigned char *data, int len,
766                                     int *copy);
767     struct {
768         int sess_connect;       /* SSL new conn - started */
769         int sess_connect_renegotiate; /* SSL reneg - requested */
770         int sess_connect_good;  /* SSL new conne/reneg - finished */
771         int sess_accept;        /* SSL new accept - started */
772         int sess_accept_renegotiate; /* SSL reneg - requested */
773         int sess_accept_good;   /* SSL accept/reneg - finished */
774         int sess_miss;          /* session lookup misses */
775         int sess_timeout;       /* reuse attempt on timeouted session */
776         int sess_cache_full;    /* session removed due to full cache */
777         int sess_hit;           /* session reuse actually done */
778         int sess_cb_hit;        /* session-id that was not in the cache was
779                                  * passed back via the callback.  This
780                                  * indicates that the application is supplying
781                                  * session-id's from other processes - spooky
782                                  * :-) */
783     } stats;
784
785     CRYPTO_REF_COUNT references;
786
787     /* if defined, these override the X509_verify_cert() calls */
788     int (*app_verify_callback) (X509_STORE_CTX *, void *);
789     void *app_verify_arg;
790     /*
791      * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
792      * ('app_verify_callback' was called with just one argument)
793      */
794
795     /* Default password callback. */
796     pem_password_cb *default_passwd_callback;
797
798     /* Default password callback user data. */
799     void *default_passwd_callback_userdata;
800
801     /* get client cert callback */
802     int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
803
804     /* cookie generate callback */
805     int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
806                               unsigned int *cookie_len);
807
808     /* verify cookie callback */
809     int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
810                                  unsigned int cookie_len);
811
812     CRYPTO_EX_DATA ex_data;
813
814     const EVP_MD *md5;          /* For SSLv3/TLSv1 'ssl3-md5' */
815     const EVP_MD *sha1;         /* For SSLv3/TLSv1 'ssl3->sha1' */
816
817     STACK_OF(X509) *extra_certs;
818     STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
819
820     /* Default values used when no per-SSL value is defined follow */
821
822     /* used if SSL's info_callback is NULL */
823     void (*info_callback) (const SSL *ssl, int type, int val);
824
825     /*
826      * What we put in certificate_authorities extension for TLS 1.3
827      * (ClientHello and CertificateRequest) or just client cert requests for
828      * earlier versions.
829      */
830     STACK_OF(X509_NAME) *ca_names;
831
832     /*
833      * Default values to use in SSL structures follow (these are copied by
834      * SSL_new)
835      */
836
837     uint32_t options;
838     uint32_t mode;
839     int min_proto_version;
840     int max_proto_version;
841     size_t max_cert_list;
842
843     struct cert_st /* CERT */ *cert;
844     int read_ahead;
845
846     /* callback that allows applications to peek at protocol messages */
847     void (*msg_callback) (int write_p, int version, int content_type,
848                           const void *buf, size_t len, SSL *ssl, void *arg);
849     void *msg_callback_arg;
850
851     uint32_t verify_mode;
852     size_t sid_ctx_length;
853     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
854     /* called 'verify_callback' in the SSL */
855     int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
856
857     /* Default generate session ID callback. */
858     GEN_SESSION_CB generate_session_id;
859
860     X509_VERIFY_PARAM *param;
861
862     int quiet_shutdown;
863
864 # ifndef OPENSSL_NO_CT
865     CTLOG_STORE *ctlog_store;   /* CT Log Store */
866     /*
867      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
868      * If they are not, the connection should be aborted.
869      */
870     ssl_ct_validation_cb ct_validation_callback;
871     void *ct_validation_callback_arg;
872 # endif
873
874     /*
875      * If we're using more than one pipeline how should we divide the data
876      * up between the pipes?
877      */
878     size_t split_send_fragment;
879     /*
880      * Maximum amount of data to send in one fragment. actual record size can
881      * be more than this due to padding and MAC overheads.
882      */
883     size_t max_send_fragment;
884
885     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
886     size_t max_pipelines;
887
888     /* The default read buffer length to use (0 means not set) */
889     size_t default_read_buf_len;
890
891 # ifndef OPENSSL_NO_ENGINE
892     /*
893      * Engine to pass requests for client certs to
894      */
895     ENGINE *client_cert_engine;
896 # endif
897
898     /* Early callback.  Mostly for extensions, but not entirely. */
899     SSL_early_cb_fn early_cb;
900     void *early_cb_arg;
901
902     /* TLS extensions. */
903     struct {
904         /* TLS extensions servername callback */
905         int (*servername_cb) (SSL *, int *, void *);
906         void *servername_arg;
907         /* RFC 4507 session ticket keys */
908         unsigned char tick_key_name[TLSEXT_KEYNAME_LENGTH];
909         unsigned char tick_hmac_key[32];
910         unsigned char tick_aes_key[32];
911         /* Callback to support customisation of ticket key setting */
912         int (*ticket_key_cb) (SSL *ssl,
913                               unsigned char *name, unsigned char *iv,
914                               EVP_CIPHER_CTX *ectx, HMAC_CTX *hctx, int enc);
915
916         /* certificate status request info */
917         /* Callback for status request */
918         int (*status_cb) (SSL *ssl, void *arg);
919         void *status_arg;
920         /* ext status type used for CSR extension (OCSP Stapling) */
921         int status_type;
922
923 # ifndef OPENSSL_NO_EC
924         /* EC extension values inherited by SSL structure */
925         size_t ecpointformats_len;
926         unsigned char *ecpointformats;
927         size_t supportedgroups_len;
928         unsigned char *supportedgroups;
929 # endif                         /* OPENSSL_NO_EC */
930
931         /*
932          * ALPN information (we are in the process of transitioning from NPN to
933          * ALPN.)
934          */
935
936         /*-
937          * For a server, this contains a callback function that allows the
938          * server to select the protocol for the connection.
939          *   out: on successful return, this must point to the raw protocol
940          *        name (without the length prefix).
941          *   outlen: on successful return, this contains the length of |*out|.
942          *   in: points to the client's list of supported protocols in
943          *       wire-format.
944          *   inlen: the length of |in|.
945          */
946         int (*alpn_select_cb) (SSL *s,
947                                const unsigned char **out,
948                                unsigned char *outlen,
949                                const unsigned char *in,
950                                unsigned int inlen, void *arg);
951         void *alpn_select_cb_arg;
952
953         /*
954          * For a client, this contains the list of supported protocols in wire
955          * format.
956          */
957         unsigned char *alpn;
958         size_t alpn_len;
959
960 # ifndef OPENSSL_NO_NEXTPROTONEG
961         /* Next protocol negotiation information */
962
963         /*
964          * For a server, this contains a callback function by which the set of
965          * advertised protocols can be provided.
966          */
967         SSL_CTX_npn_advertised_cb_func npn_advertised_cb;
968         void *npn_advertised_cb_arg;
969         /*
970          * For a client, this contains a callback function that selects the next
971          * protocol from the list provided by the server.
972          */
973         SSL_CTX_npn_select_cb_func npn_select_cb;
974         void *npn_select_cb_arg;
975 # endif
976     } ext;
977
978 # ifndef OPENSSL_NO_PSK
979     SSL_psk_client_cb_func psk_client_callback;
980     SSL_psk_server_cb_func psk_server_callback;
981 # endif
982
983 # ifndef OPENSSL_NO_SRP
984     SRP_CTX srp_ctx;            /* ctx for SRP authentication */
985 # endif
986
987     /* Shared DANE context */
988     struct dane_ctx_st dane;
989
990     /* SRTP profiles we are willing to do from RFC 5764 */
991     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
992     /*
993      * Callback for disabling session caching and ticket support on a session
994      * basis, depending on the chosen cipher.
995      */
996     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
997
998     CRYPTO_RWLOCK *lock;
999
1000     /*
1001      * Callback for logging key material for use with debugging tools like
1002      * Wireshark. The callback should log `line` followed by a newline.
1003      */
1004     SSL_CTX_keylog_cb_func keylog_callback;
1005
1006     /* The maximum number of bytes that can be sent as early data */
1007     uint32_t max_early_data;
1008
1009     /* TLS1.3 padding callback */
1010     size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1011     void *record_padding_arg;
1012     size_t block_padding;
1013 };
1014
1015 struct ssl_st {
1016     /*
1017      * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1018      * DTLS1_VERSION)
1019      */
1020     int version;
1021     /* SSLv3 */
1022     const SSL_METHOD *method;
1023     /*
1024      * There are 2 BIO's even though they are normally both the same.  This
1025      * is so data can be read and written to different handlers
1026      */
1027     /* used by SSL_read */
1028     BIO *rbio;
1029     /* used by SSL_write */
1030     BIO *wbio;
1031     /* used during session-id reuse to concatenate messages */
1032     BIO *bbio;
1033     /*
1034      * This holds a variable that indicates what we were doing when a 0 or -1
1035      * is returned.  This is needed for non-blocking IO so we know what
1036      * request needs re-doing when in SSL_accept or SSL_connect
1037      */
1038     int rwstate;
1039     int (*handshake_func) (SSL *);
1040     /*
1041      * Imagine that here's a boolean member "init" that is switched as soon
1042      * as SSL_set_{accept/connect}_state is called for the first time, so
1043      * that "state" and "handshake_func" are properly initialized.  But as
1044      * handshake_func is == 0 until then, we use this test instead of an
1045      * "init" member.
1046      */
1047     /* are we the server side? */
1048     int server;
1049     /*
1050      * Generate a new session or reuse an old one.
1051      * NB: For servers, the 'new' session may actually be a previously
1052      * cached session or even the previous session unless
1053      * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1054      */
1055     int new_session;
1056     /* don't send shutdown packets */
1057     int quiet_shutdown;
1058     /* we have shut things down, 0x01 sent, 0x02 for received */
1059     int shutdown;
1060     /* where we are */
1061     OSSL_STATEM statem;
1062     SSL_EARLY_DATA_STATE early_data_state;
1063     BUF_MEM *init_buf;          /* buffer used during init */
1064     void *init_msg;             /* pointer to handshake message body, set by
1065                                  * ssl3_get_message() */
1066     size_t init_num;               /* amount read/written */
1067     size_t init_off;               /* amount read/written */
1068     struct ssl3_state_st *s3;   /* SSLv3 variables */
1069     struct dtls1_state_st *d1;  /* DTLSv1 variables */
1070     /* callback that allows applications to peek at protocol messages */
1071     void (*msg_callback) (int write_p, int version, int content_type,
1072                           const void *buf, size_t len, SSL *ssl, void *arg);
1073     void *msg_callback_arg;
1074     int hit;                    /* reusing a previous session */
1075     X509_VERIFY_PARAM *param;
1076     /* Per connection DANE state */
1077     SSL_DANE dane;
1078     /* crypto */
1079     STACK_OF(SSL_CIPHER) *cipher_list;
1080     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1081     /*
1082      * These are the ones being used, the ones in SSL_SESSION are the ones to
1083      * be 'copied' into these ones
1084      */
1085     uint32_t mac_flags;
1086     /*
1087      * The TLS1.3 secrets. The resumption master secret is stored in the
1088      * session.
1089      */
1090     unsigned char early_secret[EVP_MAX_MD_SIZE];
1091     unsigned char handshake_secret[EVP_MAX_MD_SIZE];
1092     unsigned char master_secret[EVP_MAX_MD_SIZE];
1093     unsigned char client_finished_secret[EVP_MAX_MD_SIZE];
1094     unsigned char server_finished_secret[EVP_MAX_MD_SIZE];
1095     unsigned char server_finished_hash[EVP_MAX_MD_SIZE];
1096     unsigned char handshake_traffic_hash[EVP_MAX_MD_SIZE];
1097     unsigned char client_app_traffic_secret[EVP_MAX_MD_SIZE];
1098     unsigned char server_app_traffic_secret[EVP_MAX_MD_SIZE];
1099     EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1100     unsigned char read_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static read IV */
1101     EVP_MD_CTX *read_hash;      /* used for mac generation */
1102     COMP_CTX *compress;         /* compression */
1103     COMP_CTX *expand;           /* uncompress */
1104     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1105     unsigned char write_iv[EVP_MAX_IV_LENGTH]; /* TLSv1.3 static write IV */
1106     EVP_MD_CTX *write_hash;     /* used for mac generation */
1107     /* Count of how many KeyUpdate messages we have received */
1108     unsigned int key_update_count;
1109     /* session info */
1110     /* client cert? */
1111     /* This is used to hold the server certificate used */
1112     struct cert_st /* CERT */ *cert;
1113
1114     /*
1115      * The hash of all messages prior to the CertificateVerify, and the length
1116      * of that hash.
1117      */
1118     unsigned char cert_verify_hash[EVP_MAX_MD_SIZE];
1119     size_t cert_verify_hash_len;
1120
1121     /* Flag to indicate whether we should send a HelloRetryRequest or not */
1122     int hello_retry_request;
1123
1124     /*
1125      * the session_id_context is used to ensure sessions are only reused in
1126      * the appropriate context
1127      */
1128     size_t sid_ctx_length;
1129     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1130     /* This can also be in the session once a session is established */
1131     SSL_SESSION *session;
1132     /* Default generate session ID callback. */
1133     GEN_SESSION_CB generate_session_id;
1134     /* Used in SSL3 */
1135     /*
1136      * 0 don't care about verify failure.
1137      * 1 fail if verify fails
1138      */
1139     uint32_t verify_mode;
1140     /* fail if callback returns 0 */
1141     int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1142     /* optional informational callback */
1143     void (*info_callback) (const SSL *ssl, int type, int val);
1144     /* error bytes to be written */
1145     int error;
1146     /* actual code */
1147     int error_code;
1148 # ifndef OPENSSL_NO_PSK
1149     SSL_psk_client_cb_func psk_client_callback;
1150     SSL_psk_server_cb_func psk_server_callback;
1151 # endif
1152     SSL_CTX *ctx;
1153     /* Verified chain of peer */
1154     STACK_OF(X509) *verified_chain;
1155     long verify_result;
1156     /* extra application data */
1157     CRYPTO_EX_DATA ex_data;
1158     /* for server side, keep the list of CA_dn we can use */
1159     STACK_OF(X509_NAME) *ca_names;
1160     CRYPTO_REF_COUNT references;
1161     /* protocol behaviour */
1162     uint32_t options;
1163     /* API behaviour */
1164     uint32_t mode;
1165     int min_proto_version;
1166     int max_proto_version;
1167     size_t max_cert_list;
1168     int first_packet;
1169     /*
1170      * What was passed in ClientHello.legacy_version. Used for RSA pre-master
1171      * secret and SSLv3/TLS (<=1.2) rollback check
1172      */
1173     int client_version;
1174     /*
1175      * If we're using more than one pipeline how should we divide the data
1176      * up between the pipes?
1177      */
1178     size_t split_send_fragment;
1179     /*
1180      * Maximum amount of data to send in one fragment. actual record size can
1181      * be more than this due to padding and MAC overheads.
1182      */
1183     size_t max_send_fragment;
1184     /* Up to how many pipelines should we use? If 0 then 1 is assumed */
1185     size_t max_pipelines;
1186
1187     struct {
1188         /* Built-in extension flags */
1189         uint8_t extflags[TLSEXT_IDX_num_builtins];
1190         /* TLS extension debug callback */
1191         void (*debug_cb)(SSL *s, int client_server, int type,
1192                          const unsigned char *data, int len, void *arg);
1193         void *debug_arg;
1194         char *hostname;
1195         /* certificate status request info */
1196         /* Status type or -1 if no status type */
1197         int status_type;
1198         /* Raw extension data, if seen */
1199         unsigned char *scts;
1200         /* Length of raw extension data, if seen */
1201         uint16_t scts_len;
1202         /* Expect OCSP CertificateStatus message */
1203         int status_expected;
1204
1205         struct {
1206             /* OCSP status request only */
1207             STACK_OF(OCSP_RESPID) *ids;
1208             X509_EXTENSIONS *exts;
1209             /* OCSP response received or to be sent */
1210             unsigned char *resp;
1211             size_t resp_len;
1212         } ocsp;
1213
1214         /* RFC4507 session ticket expected to be received or sent */
1215         int ticket_expected;
1216 # ifndef OPENSSL_NO_EC
1217         size_t ecpointformats_len;
1218         /* our list */
1219         unsigned char *ecpointformats;
1220         size_t supportedgroups_len;
1221         /* our list */
1222         unsigned char *supportedgroups;
1223 # endif                         /* OPENSSL_NO_EC */
1224         /* TLS Session Ticket extension override */
1225         TLS_SESSION_TICKET_EXT *session_ticket;
1226         /* TLS Session Ticket extension callback */
1227         tls_session_ticket_ext_cb_fn session_ticket_cb;
1228         void *session_ticket_cb_arg;
1229         /* TLS pre-shared secret session resumption */
1230         tls_session_secret_cb_fn session_secret_cb;
1231         void *session_secret_cb_arg;
1232         /*
1233          * For a client, this contains the list of supported protocols in wire
1234          * format.
1235          */
1236         unsigned char *alpn;
1237         size_t alpn_len;
1238         /*
1239          * Next protocol negotiation. For the client, this is the protocol that
1240          * we sent in NextProtocol and is set when handling ServerHello
1241          * extensions. For a server, this is the client's selected_protocol from
1242          * NextProtocol and is set when handling the NextProtocol message, before
1243          * the Finished message.
1244          */
1245         unsigned char *npn;
1246         size_t npn_len;
1247
1248         /* The available PSK key exchange modes */
1249         int psk_kex_mode;
1250
1251         /* Set to one if we have negotiated ETM */
1252         int use_etm;
1253
1254         /* Are we expecting to receive early data? */
1255         int early_data;
1256         /* Is the session suitable for early data? */
1257         int early_data_ok;
1258
1259         /* May be sent by a server in HRR. Must be echoed back in ClientHello */
1260         unsigned char *tls13_cookie;
1261         size_t tls13_cookie_len;
1262     } ext;
1263
1264     /* Parsed form of the ClientHello, kept around across early_cb calls. */
1265     CLIENTHELLO_MSG *clienthello;
1266
1267     /*-
1268      * no further mod of servername
1269      * 0 : call the servername extension callback.
1270      * 1 : prepare 2, allow last ack just after in server callback.
1271      * 2 : don't call servername callback, no ack in server hello
1272      */
1273     int servername_done;
1274 # ifndef OPENSSL_NO_CT
1275     /*
1276      * Validates that the SCTs (Signed Certificate Timestamps) are sufficient.
1277      * If they are not, the connection should be aborted.
1278      */
1279     ssl_ct_validation_cb ct_validation_callback;
1280     /* User-supplied argument that is passed to the ct_validation_callback */
1281     void *ct_validation_callback_arg;
1282     /*
1283      * Consolidated stack of SCTs from all sources.
1284      * Lazily populated by CT_get_peer_scts(SSL*)
1285      */
1286     STACK_OF(SCT) *scts;
1287     /* Have we attempted to find/parse SCTs yet? */
1288     int scts_parsed;
1289 # endif
1290     SSL_CTX *session_ctx;       /* initial ctx, used to store sessions */
1291     /* What we'll do */
1292     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1293     /* What's been chosen */
1294     SRTP_PROTECTION_PROFILE *srtp_profile;
1295     /*-
1296      * 1 if we are renegotiating.
1297      * 2 if we are a server and are inside a handshake
1298      * (i.e. not just sending a HelloRequest)
1299      */
1300     int renegotiate;
1301     /* If sending a KeyUpdate is pending */
1302     int key_update;
1303 # ifndef OPENSSL_NO_SRP
1304     /* ctx for SRP authentication */
1305     SRP_CTX srp_ctx;
1306 # endif
1307     /*
1308      * Callback for disabling session caching and ticket support on a session
1309      * basis, depending on the chosen cipher.
1310      */
1311     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1312     RECORD_LAYER rlayer;
1313     /* Default password callback. */
1314     pem_password_cb *default_passwd_callback;
1315     /* Default password callback user data. */
1316     void *default_passwd_callback_userdata;
1317     /* Async Job info */
1318     ASYNC_JOB *job;
1319     ASYNC_WAIT_CTX *waitctx;
1320     size_t asyncrw;
1321
1322     /* The maximum number of plaintext bytes that can be sent as early data */
1323     uint32_t max_early_data;
1324     /*
1325      * The number of bytes of early data received so far. If we accepted early
1326      * data then this is a count of the plaintext bytes. If we rejected it then
1327      * this is a count of the ciphertext bytes.
1328      */
1329     uint32_t early_data_count;
1330
1331     /* TLS1.3 padding callback */
1332     size_t (*record_padding_cb)(SSL *s, int type, size_t len, void *arg);
1333     void *record_padding_arg;
1334     size_t block_padding;
1335
1336     CRYPTO_RWLOCK *lock;
1337 };
1338
1339 /*
1340  * Structure containing table entry of values associated with the signature
1341  * algorithms (signature scheme) extension
1342 */
1343 typedef struct sigalg_lookup_st {
1344     /* TLS 1.3 signature scheme name */
1345     const char *name;
1346     /* Raw value used in extension */
1347     uint16_t sigalg;
1348     /* NID of hash algorithm */
1349     int hash;
1350     /* Index of hash algorithm */
1351     int hash_idx;
1352     /* NID of signature algorithm */
1353     int sig;
1354     /* Index of signature algorithm */
1355     int sig_idx;
1356     /* Combined hash and signature NID, if any */
1357     int sigandhash;
1358     /* Required public key curve (ECDSA only) */
1359     int curve;
1360 } SIGALG_LOOKUP;
1361
1362 typedef struct cert_pkey_st CERT_PKEY;
1363
1364 typedef struct ssl3_state_st {
1365     long flags;
1366     size_t read_mac_secret_size;
1367     unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1368     size_t write_mac_secret_size;
1369     unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1370     unsigned char server_random[SSL3_RANDOM_SIZE];
1371     unsigned char client_random[SSL3_RANDOM_SIZE];
1372     /* flags for countermeasure against known-IV weakness */
1373     int need_empty_fragments;
1374     int empty_fragment_done;
1375     /* used during startup, digest all incoming/outgoing packets */
1376     BIO *handshake_buffer;
1377     /*
1378      * When handshake digest is determined, buffer is hashed and
1379      * freed and MD_CTX for the required digest is stored here.
1380      */
1381     EVP_MD_CTX *handshake_dgst;
1382     /*
1383      * Set whenever an expected ChangeCipherSpec message is processed.
1384      * Unset when the peer's Finished message is received.
1385      * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1386      */
1387     int change_cipher_spec;
1388     int warn_alert;
1389     int fatal_alert;
1390     /*
1391      * we allow one fatal and one warning alert to be outstanding, send close
1392      * alert via the warning alert
1393      */
1394     int alert_dispatch;
1395     unsigned char send_alert[2];
1396     /*
1397      * This flag is set when we should renegotiate ASAP, basically when there
1398      * is no more data in the read or write buffers
1399      */
1400     int renegotiate;
1401     int total_renegotiations;
1402     int num_renegotiations;
1403     int in_read_app_data;
1404     struct {
1405         /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1406         unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1407         size_t finish_md_len;
1408         unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1409         size_t peer_finish_md_len;
1410         size_t message_size;
1411         int message_type;
1412         /* used to hold the new cipher we are going to use */
1413         const SSL_CIPHER *new_cipher;
1414 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1415         EVP_PKEY *pkey;         /* holds short lived DH/ECDH key */
1416 # endif
1417         /* used for certificate requests */
1418         int cert_req;
1419         /* Certificate types in certificate request message. */
1420         uint8_t *ctype;
1421         size_t ctype_len;
1422         /* Certificate authorities list peer sent */
1423         STACK_OF(X509_NAME) *peer_ca_names;
1424         size_t key_block_length;
1425         unsigned char *key_block;
1426         const EVP_CIPHER *new_sym_enc;
1427         const EVP_MD *new_hash;
1428         int new_mac_pkey_type;
1429         size_t new_mac_secret_size;
1430 # ifndef OPENSSL_NO_COMP
1431         const SSL_COMP *new_compression;
1432 # else
1433         char *new_compression;
1434 # endif
1435         int cert_request;
1436         /* Raw values of the cipher list from a client */
1437         unsigned char *ciphers_raw;
1438         size_t ciphers_rawlen;
1439         /* Temporary storage for premaster secret */
1440         unsigned char *pms;
1441         size_t pmslen;
1442 # ifndef OPENSSL_NO_PSK
1443         /* Temporary storage for PSK key */
1444         unsigned char *psk;
1445         size_t psklen;
1446 # endif
1447         /* Signature algorithm we actually use */
1448         const SIGALG_LOOKUP *sigalg;
1449         /* Pointer to certificate we use */
1450         CERT_PKEY *cert;
1451         /*
1452          * signature algorithms peer reports: e.g. supported signature
1453          * algorithms extension for server or as part of a certificate
1454          * request for client.
1455          */
1456         uint16_t *peer_sigalgs;
1457         /* Size of above array */
1458         size_t peer_sigalgslen;
1459         /* Sigalg peer actualy uses */
1460         const SIGALG_LOOKUP *peer_sigalg;
1461         /*
1462          * Set if corresponding CERT_PKEY can be used with current
1463          * SSL session: e.g. appropriate curve, signature algorithms etc.
1464          * If zero it can't be used at all.
1465          */
1466         uint32_t valid_flags[SSL_PKEY_NUM];
1467         /*
1468          * For servers the following masks are for the key and auth algorithms
1469          * that are supported by the certs below. For clients they are masks of
1470          * *disabled* algorithms based on the current session.
1471          */
1472         uint32_t mask_k;
1473         uint32_t mask_a;
1474         /*
1475          * The following are used by the client to see if a cipher is allowed or
1476          * not.  It contains the minimum and maximum version the client's using
1477          * based on what it knows so far.
1478          */
1479         int min_ver;
1480         int max_ver;
1481     } tmp;
1482
1483     /* Connection binding to prevent renegotiation attacks */
1484     unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1485     size_t previous_client_finished_len;
1486     unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1487     size_t previous_server_finished_len;
1488     int send_connection_binding; /* TODOEKR */
1489
1490 # ifndef OPENSSL_NO_NEXTPROTONEG
1491     /*
1492      * Set if we saw the Next Protocol Negotiation extension from our peer.
1493      */
1494     int npn_seen;
1495 # endif
1496
1497     /*
1498      * ALPN information (we are in the process of transitioning from NPN to
1499      * ALPN.)
1500      */
1501
1502     /*
1503      * In a server these point to the selected ALPN protocol after the
1504      * ClientHello has been processed. In a client these contain the protocol
1505      * that the server selected once the ServerHello has been processed.
1506      */
1507     unsigned char *alpn_selected;
1508     size_t alpn_selected_len;
1509     /* used by the server to know what options were proposed */
1510     unsigned char *alpn_proposed;
1511     size_t alpn_proposed_len;
1512     /* used by the client to know if it actually sent alpn */
1513     int alpn_sent;
1514
1515 # ifndef OPENSSL_NO_EC
1516     /*
1517      * This is set to true if we believe that this is a version of Safari
1518      * running on OS X 10.6 or newer. We wish to know this because Safari on
1519      * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1520      */
1521     char is_probably_safari;
1522 # endif                         /* !OPENSSL_NO_EC */
1523
1524     /* For clients: peer temporary key */
1525 # if !defined(OPENSSL_NO_EC) || !defined(OPENSSL_NO_DH)
1526     /* The group_id for the DH/ECDH key */
1527     unsigned int group_id;
1528     EVP_PKEY *peer_tmp;
1529 # endif
1530
1531 } SSL3_STATE;
1532
1533 /* DTLS structures */
1534
1535 # ifndef OPENSSL_NO_SCTP
1536 #  define DTLS1_SCTP_AUTH_LABEL   "EXPORTER_DTLS_OVER_SCTP"
1537 # endif
1538
1539 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1540 # define DTLS1_MAX_MTU_OVERHEAD                   48
1541
1542 /*
1543  * Flag used in message reuse to indicate the buffer contains the record
1544  * header as well as the the handshake message header.
1545  */
1546 # define DTLS1_SKIP_RECORD_HEADER                 2
1547
1548 struct dtls1_retransmit_state {
1549     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1550     EVP_MD_CTX *write_hash;     /* used for mac generation */
1551     COMP_CTX *compress;         /* compression */
1552     SSL_SESSION *session;
1553     unsigned short epoch;
1554 };
1555
1556 struct hm_header_st {
1557     unsigned char type;
1558     size_t msg_len;
1559     unsigned short seq;
1560     size_t frag_off;
1561     size_t frag_len;
1562     unsigned int is_ccs;
1563     struct dtls1_retransmit_state saved_retransmit_state;
1564 };
1565
1566 struct dtls1_timeout_st {
1567     /* Number of read timeouts so far */
1568     unsigned int read_timeouts;
1569     /* Number of write timeouts so far */
1570     unsigned int write_timeouts;
1571     /* Number of alerts received so far */
1572     unsigned int num_alerts;
1573 };
1574
1575 typedef struct hm_fragment_st {
1576     struct hm_header_st msg_header;
1577     unsigned char *fragment;
1578     unsigned char *reassembly;
1579 } hm_fragment;
1580
1581 typedef struct pqueue_st pqueue;
1582 typedef struct pitem_st pitem;
1583
1584 struct pitem_st {
1585     unsigned char priority[8];  /* 64-bit value in big-endian encoding */
1586     void *data;
1587     pitem *next;
1588 };
1589
1590 typedef struct pitem_st *piterator;
1591
1592 pitem *pitem_new(unsigned char *prio64be, void *data);
1593 void pitem_free(pitem *item);
1594 pqueue *pqueue_new(void);
1595 void pqueue_free(pqueue *pq);
1596 pitem *pqueue_insert(pqueue *pq, pitem *item);
1597 pitem *pqueue_peek(pqueue *pq);
1598 pitem *pqueue_pop(pqueue *pq);
1599 pitem *pqueue_find(pqueue *pq, unsigned char *prio64be);
1600 pitem *pqueue_iterator(pqueue *pq);
1601 pitem *pqueue_next(piterator *iter);
1602 size_t pqueue_size(pqueue *pq);
1603
1604 typedef struct dtls1_state_st {
1605     unsigned char cookie[DTLS1_COOKIE_LENGTH];
1606     size_t cookie_len;
1607     unsigned int cookie_verified;
1608     /* handshake message numbers */
1609     unsigned short handshake_write_seq;
1610     unsigned short next_handshake_write_seq;
1611     unsigned short handshake_read_seq;
1612     /* Buffered handshake messages */
1613     pqueue *buffered_messages;
1614     /* Buffered (sent) handshake records */
1615     pqueue *sent_messages;
1616     size_t link_mtu;      /* max on-the-wire DTLS packet size */
1617     size_t mtu;           /* max DTLS packet size */
1618     struct hm_header_st w_msg_hdr;
1619     struct hm_header_st r_msg_hdr;
1620     struct dtls1_timeout_st timeout;
1621     /*
1622      * Indicates when the last handshake msg sent will timeout
1623      */
1624     struct timeval next_timeout;
1625     /* Timeout duration */
1626     unsigned short timeout_duration;
1627     unsigned int retransmitting;
1628 # ifndef OPENSSL_NO_SCTP
1629     int shutdown_received;
1630 # endif
1631 } DTLS1_STATE;
1632
1633 # ifndef OPENSSL_NO_EC
1634 /*
1635  * From ECC-TLS draft, used in encoding the curve type in ECParameters
1636  */
1637 #  define EXPLICIT_PRIME_CURVE_TYPE  1
1638 #  define EXPLICIT_CHAR2_CURVE_TYPE  2
1639 #  define NAMED_CURVE_TYPE           3
1640 # endif                         /* OPENSSL_NO_EC */
1641
1642 struct cert_pkey_st {
1643     X509 *x509;
1644     EVP_PKEY *privatekey;
1645     /* Chain for this certificate */
1646     STACK_OF(X509) *chain;
1647     /*-
1648      * serverinfo data for this certificate.  The data is in TLS Extension
1649      * wire format, specifically it's a series of records like:
1650      *   uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1651      *   uint16_t length;
1652      *   uint8_t data[length];
1653      */
1654     unsigned char *serverinfo;
1655     size_t serverinfo_length;
1656 };
1657 /* Retrieve Suite B flags */
1658 # define tls1_suiteb(s)  (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1659 /* Uses to check strict mode: suite B modes are always strict */
1660 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1661         (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1662
1663 typedef enum {
1664     ENDPOINT_CLIENT = 0,
1665     ENDPOINT_SERVER,
1666     ENDPOINT_BOTH
1667 } ENDPOINT;
1668
1669
1670 typedef struct {
1671     unsigned short ext_type;
1672     ENDPOINT role;
1673     /* The context which this extension applies to */
1674     unsigned int context;
1675     /*
1676      * Per-connection flags relating to this extension type: not used if
1677      * part of an SSL_CTX structure.
1678      */
1679     uint32_t ext_flags;
1680     SSL_custom_ext_add_cb_ex add_cb;
1681     SSL_custom_ext_free_cb_ex free_cb;
1682     void *add_arg;
1683     SSL_custom_ext_parse_cb_ex parse_cb;
1684     void *parse_arg;
1685 } custom_ext_method;
1686
1687 /* ext_flags values */
1688
1689 /*
1690  * Indicates an extension has been received. Used to check for unsolicited or
1691  * duplicate extensions.
1692  */
1693 # define SSL_EXT_FLAG_RECEIVED   0x1
1694 /*
1695  * Indicates an extension has been sent: used to enable sending of
1696  * corresponding ServerHello extension.
1697  */
1698 # define SSL_EXT_FLAG_SENT       0x2
1699
1700 typedef struct {
1701     custom_ext_method *meths;
1702     size_t meths_count;
1703 } custom_ext_methods;
1704
1705 typedef struct cert_st {
1706     /* Current active set */
1707     /*
1708      * ALWAYS points to an element of the pkeys array
1709      * Probably it would make more sense to store
1710      * an index, not a pointer.
1711      */
1712     CERT_PKEY *key;
1713 # ifndef OPENSSL_NO_DH
1714     EVP_PKEY *dh_tmp;
1715     DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1716     int dh_tmp_auto;
1717 # endif
1718     /* Flags related to certificates */
1719     uint32_t cert_flags;
1720     CERT_PKEY pkeys[SSL_PKEY_NUM];
1721     /* Custom certificate types sent in certificate request message. */
1722     uint8_t *ctype;
1723     size_t ctype_len;
1724     /*
1725      * supported signature algorithms. When set on a client this is sent in
1726      * the client hello as the supported signature algorithms extension. For
1727      * servers it represents the signature algorithms we are willing to use.
1728      */
1729     uint16_t *conf_sigalgs;
1730     /* Size of above array */
1731     size_t conf_sigalgslen;
1732     /*
1733      * Client authentication signature algorithms, if not set then uses
1734      * conf_sigalgs. On servers these will be the signature algorithms sent
1735      * to the client in a certificate request for TLS 1.2. On a client this
1736      * represents the signature algorithms we are willing to use for client
1737      * authentication.
1738      */
1739     uint16_t *client_sigalgs;
1740     /* Size of above array */
1741     size_t client_sigalgslen;
1742     /*
1743      * Signature algorithms shared by client and server: cached because these
1744      * are used most often.
1745      */
1746     const SIGALG_LOOKUP **shared_sigalgs;
1747     size_t shared_sigalgslen;
1748     /*
1749      * Certificate setup callback: if set is called whenever a certificate
1750      * may be required (client or server). the callback can then examine any
1751      * appropriate parameters and setup any certificates required. This
1752      * allows advanced applications to select certificates on the fly: for
1753      * example based on supported signature algorithms or curves.
1754      */
1755     int (*cert_cb) (SSL *ssl, void *arg);
1756     void *cert_cb_arg;
1757     /*
1758      * Optional X509_STORE for chain building or certificate validation If
1759      * NULL the parent SSL_CTX store is used instead.
1760      */
1761     X509_STORE *chain_store;
1762     X509_STORE *verify_store;
1763     /* Custom extensions */
1764     custom_ext_methods custext;
1765     /* Security callback */
1766     int (*sec_cb) (const SSL *s, const SSL_CTX *ctx, int op, int bits, int nid,
1767                    void *other, void *ex);
1768     /* Security level */
1769     int sec_level;
1770     void *sec_ex;
1771 # ifndef OPENSSL_NO_PSK
1772     /* If not NULL psk identity hint to use for servers */
1773     char *psk_identity_hint;
1774 # endif
1775     CRYPTO_REF_COUNT references;             /* >1 only if SSL_copy_session_id is used */
1776     CRYPTO_RWLOCK *lock;
1777 } CERT;
1778
1779 # define FP_ICC  (int (*)(const void *,const void *))
1780
1781 /*
1782  * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1783  * of a mess of functions, but hell, think of it as an opaque structure :-)
1784  */
1785 typedef struct ssl3_enc_method {
1786     int (*enc) (SSL *, SSL3_RECORD *, size_t, int);
1787     int (*mac) (SSL *, SSL3_RECORD *, unsigned char *, int);
1788     int (*setup_key_block) (SSL *);
1789     int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1790                                    size_t, size_t *);
1791     int (*change_cipher_state) (SSL *, int);
1792     size_t (*final_finish_mac) (SSL *, const char *, size_t, unsigned char *);
1793     const char *client_finished_label;
1794     size_t client_finished_label_len;
1795     const char *server_finished_label;
1796     size_t server_finished_label_len;
1797     int (*alert_value) (int);
1798     int (*export_keying_material) (SSL *, unsigned char *, size_t,
1799                                    const char *, size_t,
1800                                    const unsigned char *, size_t,
1801                                    int use_context);
1802     /* Various flags indicating protocol version requirements */
1803     uint32_t enc_flags;
1804     /* Set the handshake header */
1805     int (*set_handshake_header) (SSL *s, WPACKET *pkt, int type);
1806     /* Close construction of the handshake message */
1807     int (*close_construct_packet) (SSL *s, WPACKET *pkt, int htype);
1808     /* Write out handshake message */
1809     int (*do_write) (SSL *s);
1810 } SSL3_ENC_METHOD;
1811
1812 # define ssl_set_handshake_header(s, pkt, htype) \
1813         s->method->ssl3_enc->set_handshake_header((s), (pkt), (htype))
1814 # define ssl_close_construct_packet(s, pkt, htype) \
1815         s->method->ssl3_enc->close_construct_packet((s), (pkt), (htype))
1816 # define ssl_do_write(s)  s->method->ssl3_enc->do_write(s)
1817
1818 /* Values for enc_flags */
1819
1820 /* Uses explicit IV for CBC mode */
1821 # define SSL_ENC_FLAG_EXPLICIT_IV        0x1
1822 /* Uses signature algorithms extension */
1823 # define SSL_ENC_FLAG_SIGALGS            0x2
1824 /* Uses SHA256 default PRF */
1825 # define SSL_ENC_FLAG_SHA256_PRF         0x4
1826 /* Is DTLS */
1827 # define SSL_ENC_FLAG_DTLS               0x8
1828 /*
1829  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1830  * apply to others in future.
1831  */
1832 # define SSL_ENC_FLAG_TLS1_2_CIPHERS     0x10
1833
1834 # ifndef OPENSSL_NO_COMP
1835 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1836 typedef struct ssl3_comp_st {
1837     int comp_id;                /* The identifier byte for this compression
1838                                  * type */
1839     char *name;                 /* Text name used for the compression type */
1840     COMP_METHOD *method;        /* The method :-) */
1841 } SSL3_COMP;
1842 # endif
1843
1844 typedef enum downgrade_en {
1845     DOWNGRADE_NONE,
1846     DOWNGRADE_TO_1_2,
1847     DOWNGRADE_TO_1_1
1848 } DOWNGRADE;
1849
1850 /*
1851  * Dummy status type for the status_type extension. Indicates no status type
1852  * set
1853  */
1854 #define TLSEXT_STATUSTYPE_nothing  -1
1855
1856 /* Sigalgs values */
1857 #define TLSEXT_SIGALG_ecdsa_secp256r1_sha256                    0x0403
1858 #define TLSEXT_SIGALG_ecdsa_secp384r1_sha384                    0x0503
1859 #define TLSEXT_SIGALG_ecdsa_secp521r1_sha512                    0x0603
1860 #define TLSEXT_SIGALG_ecdsa_sha1                                0x0203
1861 #define TLSEXT_SIGALG_rsa_pss_sha256                            0x0804
1862 #define TLSEXT_SIGALG_rsa_pss_sha384                            0x0805
1863 #define TLSEXT_SIGALG_rsa_pss_sha512                            0x0806
1864 #define TLSEXT_SIGALG_rsa_pkcs1_sha256                          0x0401
1865 #define TLSEXT_SIGALG_rsa_pkcs1_sha384                          0x0501
1866 #define TLSEXT_SIGALG_rsa_pkcs1_sha512                          0x0601
1867 #define TLSEXT_SIGALG_rsa_pkcs1_sha1                            0x0201
1868 #define TLSEXT_SIGALG_dsa_sha256                                0x0402
1869 #define TLSEXT_SIGALG_dsa_sha384                                0x0502
1870 #define TLSEXT_SIGALG_dsa_sha512                                0x0602
1871 #define TLSEXT_SIGALG_dsa_sha1                                  0x0202
1872 #define TLSEXT_SIGALG_gostr34102012_256_gostr34112012_256       0xeeee
1873 #define TLSEXT_SIGALG_gostr34102012_512_gostr34112012_512       0xefef
1874 #define TLSEXT_SIGALG_gostr34102001_gostr3411                   0xeded
1875
1876 /* Known PSK key exchange modes */
1877 #define TLSEXT_KEX_MODE_KE                                      0x00
1878 #define TLSEXT_KEX_MODE_KE_DHE                                  0x01
1879
1880 /*
1881  * Internal representations of key exchange modes
1882  */
1883 #define TLSEXT_KEX_MODE_FLAG_NONE                               0
1884 #define TLSEXT_KEX_MODE_FLAG_KE                                 1
1885 #define TLSEXT_KEX_MODE_FLAG_KE_DHE                             2
1886
1887 /* An invalid index into the TLSv1.3 PSK identities */
1888 #define TLSEXT_PSK_BAD_IDENTITY                                 -1
1889
1890 #define SSL_USE_PSS(s) (s->s3->tmp.peer_sigalg != NULL && \
1891                         s->s3->tmp.peer_sigalg->sig == EVP_PKEY_RSA_PSS)
1892
1893 /* A dummy signature value not valid for TLSv1.2 signature algs */
1894 #define TLSEXT_signature_rsa_pss                                0x0101
1895
1896 /* TLSv1.3 downgrade protection sentinel values */
1897 extern const unsigned char tls11downgrade[8];
1898 extern const unsigned char tls12downgrade[8];
1899
1900 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1901
1902 __owur const SSL_METHOD *ssl_bad_method(int ver);
1903 __owur const SSL_METHOD *sslv3_method(void);
1904 __owur const SSL_METHOD *sslv3_server_method(void);
1905 __owur const SSL_METHOD *sslv3_client_method(void);
1906 __owur const SSL_METHOD *tlsv1_method(void);
1907 __owur const SSL_METHOD *tlsv1_server_method(void);
1908 __owur const SSL_METHOD *tlsv1_client_method(void);
1909 __owur const SSL_METHOD *tlsv1_1_method(void);
1910 __owur const SSL_METHOD *tlsv1_1_server_method(void);
1911 __owur const SSL_METHOD *tlsv1_1_client_method(void);
1912 __owur const SSL_METHOD *tlsv1_2_method(void);
1913 __owur const SSL_METHOD *tlsv1_2_server_method(void);
1914 __owur const SSL_METHOD *tlsv1_2_client_method(void);
1915 __owur const SSL_METHOD *tlsv1_3_method(void);
1916 __owur const SSL_METHOD *tlsv1_3_server_method(void);
1917 __owur const SSL_METHOD *tlsv1_3_client_method(void);
1918 __owur const SSL_METHOD *dtlsv1_method(void);
1919 __owur const SSL_METHOD *dtlsv1_server_method(void);
1920 __owur const SSL_METHOD *dtlsv1_client_method(void);
1921 __owur const SSL_METHOD *dtls_bad_ver_client_method(void);
1922 __owur const SSL_METHOD *dtlsv1_2_method(void);
1923 __owur const SSL_METHOD *dtlsv1_2_server_method(void);
1924 __owur const SSL_METHOD *dtlsv1_2_client_method(void);
1925
1926 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1927 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1928 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1929 extern const SSL3_ENC_METHOD TLSv1_3_enc_data;
1930 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1931 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1932 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1933
1934 /*
1935  * Flags for SSL methods
1936  */
1937 # define SSL_METHOD_NO_FIPS      (1U<<0)
1938 # define SSL_METHOD_NO_SUITEB    (1U<<1)
1939
1940 # define IMPLEMENT_tls_meth_func(version, flags, mask, func_name, s_accept, \
1941                                  s_connect, enc_data) \
1942 const SSL_METHOD *func_name(void)  \
1943         { \
1944         static const SSL_METHOD func_name##_data= { \
1945                 version, \
1946                 flags, \
1947                 mask, \
1948                 tls1_new, \
1949                 tls1_clear, \
1950                 tls1_free, \
1951                 s_accept, \
1952                 s_connect, \
1953                 ssl3_read, \
1954                 ssl3_peek, \
1955                 ssl3_write, \
1956                 ssl3_shutdown, \
1957                 ssl3_renegotiate, \
1958                 ssl3_renegotiate_check, \
1959                 ssl3_read_bytes, \
1960                 ssl3_write_bytes, \
1961                 ssl3_dispatch_alert, \
1962                 ssl3_ctrl, \
1963                 ssl3_ctx_ctrl, \
1964                 ssl3_get_cipher_by_char, \
1965                 ssl3_put_cipher_by_char, \
1966                 ssl3_pending, \
1967                 ssl3_num_ciphers, \
1968                 ssl3_get_cipher, \
1969                 tls1_default_timeout, \
1970                 &enc_data, \
1971                 ssl_undefined_void_function, \
1972                 ssl3_callback_ctrl, \
1973                 ssl3_ctx_callback_ctrl, \
1974         }; \
1975         return &func_name##_data; \
1976         }
1977
1978 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect) \
1979 const SSL_METHOD *func_name(void)  \
1980         { \
1981         static const SSL_METHOD func_name##_data= { \
1982                 SSL3_VERSION, \
1983                 SSL_METHOD_NO_FIPS | SSL_METHOD_NO_SUITEB, \
1984                 SSL_OP_NO_SSLv3, \
1985                 ssl3_new, \
1986                 ssl3_clear, \
1987                 ssl3_free, \
1988                 s_accept, \
1989                 s_connect, \
1990                 ssl3_read, \
1991                 ssl3_peek, \
1992                 ssl3_write, \
1993                 ssl3_shutdown, \
1994                 ssl3_renegotiate, \
1995                 ssl3_renegotiate_check, \
1996                 ssl3_read_bytes, \
1997                 ssl3_write_bytes, \
1998                 ssl3_dispatch_alert, \
1999                 ssl3_ctrl, \
2000                 ssl3_ctx_ctrl, \
2001                 ssl3_get_cipher_by_char, \
2002                 ssl3_put_cipher_by_char, \
2003                 ssl3_pending, \
2004                 ssl3_num_ciphers, \
2005                 ssl3_get_cipher, \
2006                 ssl3_default_timeout, \
2007                 &SSLv3_enc_data, \
2008                 ssl_undefined_void_function, \
2009                 ssl3_callback_ctrl, \
2010                 ssl3_ctx_callback_ctrl, \
2011         }; \
2012         return &func_name##_data; \
2013         }
2014
2015 # define IMPLEMENT_dtls1_meth_func(version, flags, mask, func_name, s_accept, \
2016                                         s_connect, enc_data) \
2017 const SSL_METHOD *func_name(void)  \
2018         { \
2019         static const SSL_METHOD func_name##_data= { \
2020                 version, \
2021                 flags, \
2022                 mask, \
2023                 dtls1_new, \
2024                 dtls1_clear, \
2025                 dtls1_free, \
2026                 s_accept, \
2027                 s_connect, \
2028                 ssl3_read, \
2029                 ssl3_peek, \
2030                 ssl3_write, \
2031                 dtls1_shutdown, \
2032                 ssl3_renegotiate, \
2033                 ssl3_renegotiate_check, \
2034                 dtls1_read_bytes, \
2035                 dtls1_write_app_data_bytes, \
2036                 dtls1_dispatch_alert, \
2037                 dtls1_ctrl, \
2038                 ssl3_ctx_ctrl, \
2039                 ssl3_get_cipher_by_char, \
2040                 ssl3_put_cipher_by_char, \
2041                 ssl3_pending, \
2042                 ssl3_num_ciphers, \
2043                 ssl3_get_cipher, \
2044                 dtls1_default_timeout, \
2045                 &enc_data, \
2046                 ssl_undefined_void_function, \
2047                 ssl3_callback_ctrl, \
2048                 ssl3_ctx_callback_ctrl, \
2049         }; \
2050         return &func_name##_data; \
2051         }
2052
2053 struct openssl_ssl_test_functions {
2054     int (*p_ssl_init_wbio_buffer) (SSL *s);
2055     int (*p_ssl3_setup_buffers) (SSL *s);
2056 };
2057
2058 const char *ssl_protocol_to_string(int version);
2059
2060 /* Returns true if certificate and private key for 'idx' are present */
2061 static ossl_inline int ssl_has_cert(const SSL *s, int idx)
2062 {
2063     if (idx < 0 || idx >= SSL_PKEY_NUM)
2064         return 0;
2065     return s->cert->pkeys[idx].x509 != NULL
2066         && s->cert->pkeys[idx].privatekey != NULL;
2067 }
2068
2069 # ifndef OPENSSL_UNIT_TEST
2070
2071 __owur int ssl_read_internal(SSL *s, void *buf, size_t num, size_t *readbytes);
2072 __owur int ssl_write_internal(SSL *s, const void *buf, size_t num, size_t *written);
2073 void ssl_clear_cipher_ctx(SSL *s);
2074 int ssl_clear_bad_session(SSL *s);
2075 __owur CERT *ssl_cert_new(void);
2076 __owur CERT *ssl_cert_dup(CERT *cert);
2077 void ssl_cert_clear_certs(CERT *c);
2078 void ssl_cert_free(CERT *c);
2079 __owur int ssl_get_new_session(SSL *s, int session);
2080 __owur int ssl_get_prev_session(SSL *s, CLIENTHELLO_MSG *hello, int *al);
2081 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2082 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2083 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2084 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2085                                  const SSL_CIPHER *const *bp);
2086 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2087                                                     STACK_OF(SSL_CIPHER) **pref,
2088                                                     STACK_OF(SSL_CIPHER)
2089                                                     **sorted,
2090                                                     const char *rule_str,
2091                                                     CERT *c);
2092 __owur int ssl_cache_cipherlist(SSL *s, PACKET *cipher_suites,
2093                                 int sslv2format, int *al);
2094 __owur int bytes_to_cipher_list(SSL *s, PACKET *cipher_suites,
2095                                 STACK_OF(SSL_CIPHER) **skp,
2096                                 STACK_OF(SSL_CIPHER) **scsvs, int sslv2format,
2097                                 int *al);
2098 void ssl_update_cache(SSL *s, int mode);
2099 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2100                               const EVP_MD **md, int *mac_pkey_type,
2101                               size_t *mac_secret_size, SSL_COMP **comp,
2102                               int use_etm);
2103 __owur int ssl_cipher_get_overhead(const SSL_CIPHER *c, size_t *mac_overhead,
2104                                    size_t *int_overhead, size_t *blocksize,
2105                                    size_t *ext_overhead);
2106 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2107 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl,
2108                                                 const unsigned char *ptr,
2109                                                 int all);
2110 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2111 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2112 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2113 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2114 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2115 __owur int ssl_cert_set_current(CERT *c, long arg);
2116 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2117 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg), void *arg);
2118
2119 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2120 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2121 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain,
2122                                    int ref);
2123
2124 __owur int ssl_security(const SSL *s, int op, int bits, int nid, void *other);
2125 __owur int ssl_ctx_security(const SSL_CTX *ctx, int op, int bits, int nid,
2126                             void *other);
2127
2128 int ssl_undefined_function(SSL *s);
2129 __owur int ssl_undefined_void_function(void);
2130 __owur int ssl_undefined_const_function(const SSL *s);
2131 __owur int ssl_get_server_cert_serverinfo(SSL *s,
2132                                           const unsigned char **serverinfo,
2133                                           size_t *serverinfo_length);
2134 __owur int ssl_cert_type(const X509 *x, const EVP_PKEY *pkey);
2135 void ssl_set_masks(SSL *s);
2136 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2137 __owur int ssl_verify_alarm_type(long type);
2138 void ssl_sort_cipher_list(void);
2139 void ssl_load_ciphers(void);
2140 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field,
2141                                  size_t len, DOWNGRADE dgrd);
2142 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2143                                       int free_pms);
2144 __owur EVP_PKEY *ssl_generate_pkey(EVP_PKEY *pm);
2145 __owur int ssl_derive(SSL *s, EVP_PKEY *privkey, EVP_PKEY *pubkey,
2146                       int genmaster);
2147 __owur EVP_PKEY *ssl_dh_to_pkey(DH *dh);
2148
2149 __owur const SSL_CIPHER *ssl3_get_cipher_by_id(uint32_t id);
2150 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2151 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, WPACKET *pkt,
2152                                    size_t *len);
2153 int ssl3_init_finished_mac(SSL *s);
2154 __owur int ssl3_setup_key_block(SSL *s);
2155 __owur int ssl3_change_cipher_state(SSL *s, int which);
2156 void ssl3_cleanup_key_block(SSL *s);
2157 __owur int ssl3_do_write(SSL *s, int type);
2158 int ssl3_send_alert(SSL *s, int level, int desc);
2159 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2160                                        unsigned char *p, size_t len,
2161                                        size_t *secret_size);
2162 __owur int ssl3_get_req_cert_type(SSL *s, WPACKET *pkt);
2163 __owur int ssl3_num_ciphers(void);
2164 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2165 int ssl3_renegotiate(SSL *ssl);
2166 int ssl3_renegotiate_check(SSL *ssl, int initok);
2167 __owur int ssl3_dispatch_alert(SSL *s);
2168 __owur size_t ssl3_final_finish_mac(SSL *s, const char *sender, size_t slen,
2169                                     unsigned char *p);
2170 __owur int ssl3_finish_mac(SSL *s, const unsigned char *buf, size_t len);
2171 void ssl3_free_digest_list(SSL *s);
2172 __owur unsigned long ssl3_output_cert_chain(SSL *s, WPACKET *pkt,
2173                                             CERT_PKEY *cpk, int *al);
2174 __owur const SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,
2175                                             STACK_OF(SSL_CIPHER) *clnt,
2176                                             STACK_OF(SSL_CIPHER) *srvr);
2177 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2178 __owur int ssl3_new(SSL *s);
2179 void ssl3_free(SSL *s);
2180 __owur int ssl3_read(SSL *s, void *buf, size_t len, size_t *readbytes);
2181 __owur int ssl3_peek(SSL *s, void *buf, size_t len, size_t *readbytes);
2182 __owur int ssl3_write(SSL *s, const void *buf, size_t len, size_t *written);
2183 __owur int ssl3_shutdown(SSL *s);
2184 void ssl3_clear(SSL *s);
2185 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2186 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2187 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2188 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2189
2190 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2191 __owur long ssl3_default_timeout(void);
2192
2193 __owur int ssl3_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2194 __owur int tls_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2195 __owur int tls_setup_handshake(SSL *s);
2196 __owur int dtls1_set_handshake_header(SSL *s, WPACKET *pkt, int htype);
2197 __owur int dtls1_close_construct_packet(SSL *s, WPACKET *pkt, int htype);
2198 __owur int ssl3_handshake_write(SSL *s);
2199
2200 __owur int ssl_allow_compression(SSL *s);
2201
2202 __owur int ssl_version_supported(const SSL *s, int version);
2203
2204 __owur int ssl_set_client_hello_version(SSL *s);
2205 __owur int ssl_check_version_downgrade(SSL *s);
2206 __owur int ssl_set_version_bound(int method_version, int version, int *bound);
2207 __owur int ssl_choose_server_version(SSL *s, CLIENTHELLO_MSG *hello,
2208                                      DOWNGRADE *dgrd);
2209 __owur int ssl_choose_client_version(SSL *s, int version, int checkdgrd,
2210                                      int *al);
2211 int ssl_get_min_max_version(const SSL *s, int *min_version, int *max_version);
2212
2213 __owur long tls1_default_timeout(void);
2214 __owur int dtls1_do_write(SSL *s, int type);
2215 void dtls1_set_message_header(SSL *s,
2216                               unsigned char mt,
2217                               size_t len,
2218                               size_t frag_off, size_t frag_len);
2219
2220 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf_, size_t len,
2221                                size_t *written);
2222
2223 __owur int dtls1_read_failed(SSL *s, int code);
2224 __owur int dtls1_buffer_message(SSL *s, int ccs);
2225 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq, int *found);
2226 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2227 int dtls1_retransmit_buffered_messages(SSL *s);
2228 void dtls1_clear_received_buffer(SSL *s);
2229 void dtls1_clear_sent_buffer(SSL *s);
2230 void dtls1_get_message_header(unsigned char *data,
2231                               struct hm_header_st *msg_hdr);
2232 __owur long dtls1_default_timeout(void);
2233 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2234 __owur int dtls1_check_timeout_num(SSL *s);
2235 __owur int dtls1_handle_timeout(SSL *s);
2236 void dtls1_start_timer(SSL *s);
2237 void dtls1_stop_timer(SSL *s);
2238 __owur int dtls1_is_timer_expired(SSL *s);
2239 void dtls1_double_timeout(SSL *s);
2240 __owur int dtls_raw_hello_verify_request(WPACKET *pkt, unsigned char *cookie,
2241                                          size_t cookie_len);
2242 __owur int dtls1_send_newsession_ticket(SSL *s);
2243 __owur size_t dtls1_min_mtu(SSL *s);
2244 void dtls1_hm_fragment_free(hm_fragment *frag);
2245 __owur int dtls1_query_mtu(SSL *s);
2246
2247 __owur int tls1_new(SSL *s);
2248 void tls1_free(SSL *s);
2249 void tls1_clear(SSL *s);
2250 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2251 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2252
2253 __owur int dtls1_new(SSL *s);
2254 void dtls1_free(SSL *s);
2255 void dtls1_clear(SSL *s);
2256 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2257 __owur int dtls1_shutdown(SSL *s);
2258
2259 __owur int dtls1_dispatch_alert(SSL *s);
2260
2261 __owur int ssl_init_wbio_buffer(SSL *s);
2262 void ssl_free_wbio_buffer(SSL *s);
2263
2264 __owur int tls1_change_cipher_state(SSL *s, int which);
2265 __owur int tls1_setup_key_block(SSL *s);
2266 __owur size_t tls1_final_finish_mac(SSL *s, const char *str, size_t slen,
2267                                     unsigned char *p);
2268 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2269                                        unsigned char *p, size_t len,
2270                                        size_t *secret_size);
2271 __owur int tls13_setup_key_block(SSL *s);
2272 __owur size_t tls13_final_finish_mac(SSL *s, const char *str, size_t slen,
2273                                      unsigned char *p);
2274 __owur int tls13_change_cipher_state(SSL *s, int which);
2275 __owur int tls13_update_key(SSL *s, int send);
2276 __owur int tls13_hkdf_expand(SSL *s, const EVP_MD *md,
2277                              const unsigned char *secret,
2278                              const unsigned char *label, size_t labellen,
2279                              const unsigned char *hash,
2280                              unsigned char *out, size_t outlen);
2281 __owur int tls13_derive_key(SSL *s, const EVP_MD *md,
2282                             const unsigned char *secret, unsigned char *key,
2283                             size_t keylen);
2284 __owur int tls13_derive_iv(SSL *s, const EVP_MD *md,
2285                            const unsigned char *secret, unsigned char *iv,
2286                            size_t ivlen);
2287 __owur int tls13_derive_finishedkey(SSL *s, const EVP_MD *md,
2288                                     const unsigned char *secret,
2289                                     unsigned char *fin, size_t finlen);
2290 int tls13_generate_secret(SSL *s, const EVP_MD *md,
2291                           const unsigned char *prevsecret,
2292                           const unsigned char *insecret,
2293                           size_t insecretlen,
2294                           unsigned char *outsecret);
2295 __owur int tls13_generate_handshake_secret(SSL *s,
2296                                            const unsigned char *insecret,
2297                                            size_t insecretlen);
2298 __owur int tls13_generate_master_secret(SSL *s, unsigned char *out,
2299                                         unsigned char *prev, size_t prevlen,
2300                                         size_t *secret_size);
2301 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2302                                        const char *label, size_t llen,
2303                                        const unsigned char *p, size_t plen,
2304                                        int use_context);
2305 __owur int tls1_alert_code(int code);
2306 __owur int tls13_alert_code(int code);
2307 __owur int ssl3_alert_code(int code);
2308
2309 #  ifndef OPENSSL_NO_EC
2310 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2311 #  endif
2312
2313 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2314
2315 #  ifndef OPENSSL_NO_EC
2316 /* Flags values from tls1_ec_curve_id2nid() */
2317 /* Mask for curve type */
2318 # define TLS_CURVE_TYPE          0x3
2319 # define TLS_CURVE_PRIME         0x0
2320 # define TLS_CURVE_CHAR2         0x1
2321 # define TLS_CURVE_CUSTOM        0x2
2322
2323 #define bytestogroup(bytes) ((unsigned int)(bytes[0] << 8 | bytes[1]))
2324
2325 __owur int tls1_ec_curve_id2nid(int curve_id, unsigned int *pflags);
2326 __owur int tls1_ec_nid2curve_id(int nid);
2327 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2328 __owur int tls1_shared_group(SSL *s, int nmatch);
2329 __owur int tls1_set_groups(unsigned char **pext, size_t *pextlen,
2330                            int *curves, size_t ncurves);
2331 __owur int tls1_set_groups_list(unsigned char **pext, size_t *pextlen,
2332                                 const char *str);
2333 void tls1_get_formatlist(SSL *s, const unsigned char **pformats,
2334                          size_t *num_formats);
2335 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2336 __owur EVP_PKEY *ssl_generate_pkey_curve(int id);
2337 #  endif                        /* OPENSSL_NO_EC */
2338
2339 __owur int tls1_shared_list(SSL *s,
2340                             const unsigned char *l1, size_t l1len,
2341                             const unsigned char *l2, size_t l2len, int nmatch);
2342 __owur int tls_curve_allowed(SSL *s, const unsigned char *curve, int op);
2343 __owur  int tls1_get_curvelist(SSL *s, int sess, const unsigned char **pcurves,
2344                                size_t *num_curves);
2345
2346 void ssl_set_default_md(SSL *s);
2347 __owur int tls1_set_server_sigalgs(SSL *s);
2348
2349 /* Return codes for tls_get_ticket_from_client() and tls_decrypt_ticket() */
2350 typedef enum ticket_en {
2351     /* fatal error, malloc failure */
2352     TICKET_FATAL_ERR_MALLOC,
2353     /* fatal error, either from parsing or decrypting the ticket */
2354     TICKET_FATAL_ERR_OTHER,
2355     /* No ticket present */
2356     TICKET_NONE,
2357     /* Empty ticket present */
2358     TICKET_EMPTY,
2359     /* the ticket couldn't be decrypted */
2360     TICKET_NO_DECRYPT,
2361     /* a ticket was successfully decrypted */
2362     TICKET_SUCCESS,
2363     /* same as above but the ticket needs to be reneewed */
2364     TICKET_SUCCESS_RENEW
2365 } TICKET_RETURN;
2366
2367 __owur TICKET_RETURN tls_get_ticket_from_client(SSL *s, CLIENTHELLO_MSG *hello,
2368                                                 SSL_SESSION **ret);
2369 __owur TICKET_RETURN tls_decrypt_ticket(SSL *s, const unsigned char *etick,
2370                                         size_t eticklen,
2371                                         const unsigned char *sess_id,
2372                                         size_t sesslen, SSL_SESSION **psess);
2373
2374 __owur int tls_use_ticket(SSL *s);
2375
2376 void ssl_set_sig_mask(uint32_t *pmask_a, SSL *s, int op);
2377
2378 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2379 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen,
2380                             int client);
2381 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2382                      int idx);
2383 void tls1_set_cert_validity(SSL *s);
2384
2385 #  ifndef OPENSSL_NO_CT
2386 __owur int ssl_validate_ct(SSL *s);
2387 #  endif
2388
2389 #  ifndef OPENSSL_NO_DH
2390 __owur DH *ssl_get_auto_dh(SSL *s);
2391 #  endif
2392
2393 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2394 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex,
2395                                    int vfy);
2396
2397 int tls_choose_sigalg(SSL *s, int *al);
2398
2399 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2400 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2401 __owur long ssl_get_algorithm2(SSL *s);
2402 __owur int tls12_copy_sigalgs(SSL *s, WPACKET *pkt,
2403                               const uint16_t *psig, size_t psiglen);
2404 __owur int tls1_save_sigalgs(SSL *s, PACKET *pkt);
2405 __owur int tls1_process_sigalgs(SSL *s);
2406 __owur int tls1_set_peer_legacy_sigalg(SSL *s, const EVP_PKEY *pkey);
2407 __owur size_t tls12_get_psigalgs(SSL *s, int sent, const uint16_t **psigs);
2408 __owur int tls12_check_peer_sigalg(SSL *s, uint16_t, EVP_PKEY *pkey);
2409 void ssl_set_client_disabled(SSL *s);
2410 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op, int echde);
2411
2412 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, size_t outlen,
2413                                  size_t *hashlen);
2414 __owur const EVP_MD *ssl_md(int idx);
2415 __owur const EVP_MD *ssl_handshake_md(SSL *s);
2416 __owur const EVP_MD *ssl_prf_md(SSL *s);
2417
2418 /*
2419  * ssl_log_rsa_client_key_exchange logs |premaster| to the SSL_CTX associated
2420  * with |ssl|, if logging is enabled. It returns one on success and zero on
2421  * failure. The entry is identified by the first 8 bytes of
2422  * |encrypted_premaster|.
2423  */
2424 __owur int ssl_log_rsa_client_key_exchange(SSL *ssl,
2425                                            const uint8_t *encrypted_premaster,
2426                                            size_t encrypted_premaster_len,
2427                                            const uint8_t *premaster,
2428                                            size_t premaster_len);
2429
2430 /*
2431  * ssl_log_secret logs |secret| to the SSL_CTX associated with |ssl|, if
2432  * logging is available. It returns one on success and zero on failure. It tags
2433  * the entry with |label|.
2434  */
2435 __owur int ssl_log_secret(SSL *ssl, const char *label,
2436                           const uint8_t *secret, size_t secret_len);
2437
2438 #define MASTER_SECRET_LABEL "CLIENT_RANDOM"
2439 #define CLIENT_EARLY_LABEL "CLIENT_EARLY_TRAFFIC_SECRET"
2440 #define CLIENT_HANDSHAKE_LABEL "CLIENT_HANDSHAKE_TRAFFIC_SECRET"
2441 #define SERVER_HANDSHAKE_LABEL "SERVER_HANDSHAKE_TRAFFIC_SECRET"
2442 #define CLIENT_APPLICATION_LABEL "CLIENT_TRAFFIC_SECRET_0"
2443 #define SERVER_APPLICATION_LABEL "SERVER_TRAFFIC_SECRET_0"
2444
2445 /* s3_cbc.c */
2446 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2447 __owur int ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2448                                   unsigned char *md_out,
2449                                   size_t *md_out_size,
2450                                   const unsigned char header[13],
2451                                   const unsigned char *data,
2452                                   size_t data_plus_mac_size,
2453                                   size_t data_plus_mac_plus_padding_size,
2454                                   const unsigned char *mac_secret,
2455                                   size_t mac_secret_length, char is_sslv3);
2456
2457 __owur int srp_generate_server_master_secret(SSL *s);
2458 __owur int srp_generate_client_master_secret(SSL *s);
2459 __owur int srp_verify_server_param(SSL *s, int *al);
2460
2461 /* statem/extensions_cust.c */
2462
2463 custom_ext_method *custom_ext_find(const custom_ext_methods *exts,
2464                                    ENDPOINT role, unsigned int ext_type,
2465                                    size_t *idx);
2466
2467 void custom_ext_init(custom_ext_methods *meths);
2468
2469 __owur int custom_ext_parse(SSL *s, unsigned int context, unsigned int ext_type,
2470                             const unsigned char *ext_data, size_t ext_size,
2471                             X509 *x, size_t chainidx, int *al);
2472 __owur int custom_ext_add(SSL *s, int context, WPACKET *pkt, X509 *x,
2473                           size_t chainidx, int maxversion, int *al);
2474
2475 __owur int custom_exts_copy(custom_ext_methods *dst,
2476                             const custom_ext_methods *src);
2477 __owur int custom_exts_copy_flags(custom_ext_methods *dst,
2478                                   const custom_ext_methods *src);
2479 void custom_exts_free(custom_ext_methods *exts);
2480
2481 void ssl_comp_free_compression_methods_int(void);
2482
2483 # else /* OPENSSL_UNIT_TEST */
2484
2485 #  define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2486 #  define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2487
2488 # endif
2489 #endif