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