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