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