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