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