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