Client TLS state machine rewrite cleanup
[openssl.git] / ssl / ssl_locl.h
1 /* ssl/ssl_locl.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  *
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  *
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  *
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  *
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  *
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2007 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer.
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111 /* ====================================================================
112  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113  * ECC cipher suite support in OpenSSL originally developed by
114  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115  */
116 /* ====================================================================
117  * Copyright 2005 Nokia. All rights reserved.
118  *
119  * The portions of the attached software ("Contribution") is developed by
120  * Nokia Corporation and is licensed pursuant to the OpenSSL open source
121  * license.
122  *
123  * The Contribution, originally written by Mika Kousa and Pasi Eronen of
124  * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
125  * support (see RFC 4279) to OpenSSL.
126  *
127  * No patent licenses or other rights except those expressly stated in
128  * the OpenSSL open source license shall be deemed granted or received
129  * expressly, by implication, estoppel, or otherwise.
130  *
131  * No assurances are provided by Nokia that the Contribution does not
132  * infringe the patent or other intellectual property rights of any third
133  * party or that the license provides you with all the necessary rights
134  * to make use of the Contribution.
135  *
136  * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
137  * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
138  * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
139  * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
140  * OTHERWISE.
141  */
142
143 #ifndef HEADER_SSL_LOCL_H
144 # define HEADER_SSL_LOCL_H
145 # include <stdlib.h>
146 # include <time.h>
147 # include <string.h>
148 # include <errno.h>
149
150 # include "e_os.h"
151
152 # include <openssl/buffer.h>
153 # ifndef OPENSSL_NO_COMP
154 #  include <openssl/comp.h>
155 # endif
156 # include <openssl/bio.h>
157 # include <openssl/stack.h>
158 # ifndef OPENSSL_NO_RSA
159 #  include <openssl/rsa.h>
160 # endif
161 # ifndef OPENSSL_NO_DSA
162 #  include <openssl/dsa.h>
163 # endif
164 # include <openssl/err.h>
165 # include <openssl/ssl.h>
166 # include <openssl/symhacks.h>
167
168 #include "record/record.h"
169 #include "packet_locl.h"
170
171 # ifdef OPENSSL_BUILD_SHLIBSSL
172 #  undef OPENSSL_EXTERN
173 #  define OPENSSL_EXTERN OPENSSL_EXPORT
174 # endif
175
176 # undef PKCS1_CHECK
177
178 # define c2l(c,l)        (l = ((unsigned long)(*((c)++)))     , \
179                          l|=(((unsigned long)(*((c)++)))<< 8), \
180                          l|=(((unsigned long)(*((c)++)))<<16), \
181                          l|=(((unsigned long)(*((c)++)))<<24))
182
183 /* NOTE - c is not incremented as per c2l */
184 # define c2ln(c,l1,l2,n) { \
185                         c+=n; \
186                         l1=l2=0; \
187                         switch (n) { \
188                         case 8: l2 =((unsigned long)(*(--(c))))<<24; \
189                         case 7: l2|=((unsigned long)(*(--(c))))<<16; \
190                         case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
191                         case 5: l2|=((unsigned long)(*(--(c))));     \
192                         case 4: l1 =((unsigned long)(*(--(c))))<<24; \
193                         case 3: l1|=((unsigned long)(*(--(c))))<<16; \
194                         case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
195                         case 1: l1|=((unsigned long)(*(--(c))));     \
196                                 } \
197                         }
198
199 # define l2c(l,c)        (*((c)++)=(unsigned char)(((l)    )&0xff), \
200                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
201                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
202                          *((c)++)=(unsigned char)(((l)>>24)&0xff))
203
204 # define n2l(c,l)        (l =((unsigned long)(*((c)++)))<<24, \
205                          l|=((unsigned long)(*((c)++)))<<16, \
206                          l|=((unsigned long)(*((c)++)))<< 8, \
207                          l|=((unsigned long)(*((c)++))))
208
209 # define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
210                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
211                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
212                          *((c)++)=(unsigned char)(((l)    )&0xff))
213
214 # define l2n6(l,c)       (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
215                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
216                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
217                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
218                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
219                          *((c)++)=(unsigned char)(((l)    )&0xff))
220
221 # define l2n8(l,c)       (*((c)++)=(unsigned char)(((l)>>56)&0xff), \
222                          *((c)++)=(unsigned char)(((l)>>48)&0xff), \
223                          *((c)++)=(unsigned char)(((l)>>40)&0xff), \
224                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
225                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
226                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
227                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
228                          *((c)++)=(unsigned char)(((l)    )&0xff))
229
230 # define n2l6(c,l)       (l =((BN_ULLONG)(*((c)++)))<<40, \
231                          l|=((BN_ULLONG)(*((c)++)))<<32, \
232                          l|=((BN_ULLONG)(*((c)++)))<<24, \
233                          l|=((BN_ULLONG)(*((c)++)))<<16, \
234                          l|=((BN_ULLONG)(*((c)++)))<< 8, \
235                          l|=((BN_ULLONG)(*((c)++))))
236
237 /* NOTE - c is not incremented as per l2c */
238 # define l2cn(l1,l2,c,n) { \
239                         c+=n; \
240                         switch (n) { \
241                         case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
242                         case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
243                         case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
244                         case 5: *(--(c))=(unsigned char)(((l2)    )&0xff); \
245                         case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
246                         case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
247                         case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
248                         case 1: *(--(c))=(unsigned char)(((l1)    )&0xff); \
249                                 } \
250                         }
251
252 # define n2s(c,s)        ((s=(((unsigned int)(c[0]))<< 8)| \
253                             (((unsigned int)(c[1]))    )),c+=2)
254 # define s2n(s,c)        ((c[0]=(unsigned char)(((s)>> 8)&0xff), \
255                           c[1]=(unsigned char)(((s)    )&0xff)),c+=2)
256
257 # define n2l3(c,l)       ((l =(((unsigned long)(c[0]))<<16)| \
258                              (((unsigned long)(c[1]))<< 8)| \
259                              (((unsigned long)(c[2]))    )),c+=3)
260
261 # define l2n3(l,c)       ((c[0]=(unsigned char)(((l)>>16)&0xff), \
262                           c[1]=(unsigned char)(((l)>> 8)&0xff), \
263                           c[2]=(unsigned char)(((l)    )&0xff)),c+=3)
264
265 /* LOCAL STUFF */
266
267 # define SSL_DECRYPT     0
268 # define SSL_ENCRYPT     1
269
270 # define TWO_BYTE_BIT    0x80
271 # define SEC_ESC_BIT     0x40
272 # define TWO_BYTE_MASK   0x7fff
273 # define THREE_BYTE_MASK 0x3fff
274
275 # define INC32(a)        ((a)=((a)+1)&0xffffffffL)
276 # define DEC32(a)        ((a)=((a)-1)&0xffffffffL)
277 # define MAX_MAC_SIZE    20     /* up from 16 for SSLv3 */
278
279 /*
280  * Define the Bitmasks for SSL_CIPHER.algorithms.
281  * This bits are used packed as dense as possible. If new methods/ciphers
282  * etc will be added, the bits a likely to change, so this information
283  * is for internal library use only, even though SSL_CIPHER.algorithms
284  * can be publicly accessed.
285  * Use the according functions for cipher management instead.
286  *
287  * The bit mask handling in the selection and sorting scheme in
288  * ssl_create_cipher_list() has only limited capabilities, reflecting
289  * that the different entities within are mutually exclusive:
290  * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
291  */
292
293 /* Bits for algorithm_mkey (key exchange algorithm) */
294 /* RSA key exchange */
295 # define SSL_kRSA                0x00000001L
296 /* DH cert, RSA CA cert */
297 # define SSL_kDHr                0x00000002L
298 /* DH cert, DSA CA cert */
299 # define SSL_kDHd                0x00000004L
300 /* tmp DH key no DH cert */
301 # define SSL_kDHE                0x00000008L
302 /* synonym */
303 # define SSL_kEDH                SSL_kDHE
304 /* ECDH cert, RSA CA cert */
305 # define SSL_kECDHr              0x00000020L
306 /* ECDH cert, ECDSA CA cert */
307 # define SSL_kECDHe              0x00000040L
308 /* ephemeral ECDH */
309 # define SSL_kECDHE              0x00000080L
310 /* synonym */
311 # define SSL_kEECDH              SSL_kECDHE
312 /* PSK */
313 # define SSL_kPSK                0x00000100L
314 /* GOST key exchange */
315 # define SSL_kGOST       0x00000200L
316 /* SRP */
317 # define SSL_kSRP        0x00000400L
318
319 # define SSL_kRSAPSK             0x00000800L
320 # define SSL_kECDHEPSK           0x00001000L
321 # define SSL_kDHEPSK             0x00002000L
322
323 /* all PSK */
324
325 #define SSL_PSK     (SSL_kPSK | SSL_kRSAPSK | SSL_kECDHEPSK | SSL_kDHEPSK)
326
327 /* Bits for algorithm_auth (server authentication) */
328 /* RSA auth */
329 # define SSL_aRSA                0x00000001L
330 /* DSS auth */
331 # define SSL_aDSS                0x00000002L
332 /* no auth (i.e. use ADH or AECDH) */
333 # define SSL_aNULL               0x00000004L
334 /* Fixed DH auth (kDHd or kDHr) */
335 # define SSL_aDH                 0x00000008L
336 /* Fixed ECDH auth (kECDHe or kECDHr) */
337 # define SSL_aECDH               0x00000010L
338 /* ECDSA auth*/
339 # define SSL_aECDSA              0x00000040L
340 /* PSK auth */
341 # define SSL_aPSK                0x00000080L
342 /* GOST R 34.10-2001 signature auth */
343 # define SSL_aGOST01                     0x00000200L
344 /* SRP auth */
345 # define SSL_aSRP                0x00000400L
346
347 /* Bits for algorithm_enc (symmetric encryption) */
348 # define SSL_DES                 0x00000001L
349 # define SSL_3DES                0x00000002L
350 # define SSL_RC4                 0x00000004L
351 # define SSL_RC2                 0x00000008L
352 # define SSL_IDEA                0x00000010L
353 # define SSL_eNULL               0x00000020L
354 # define SSL_AES128              0x00000040L
355 # define SSL_AES256              0x00000080L
356 # define SSL_CAMELLIA128         0x00000100L
357 # define SSL_CAMELLIA256         0x00000200L
358 # define SSL_eGOST2814789CNT     0x00000400L
359 # define SSL_SEED                0x00000800L
360 # define SSL_AES128GCM           0x00001000L
361 # define SSL_AES256GCM           0x00002000L
362 # define SSL_AES128CCM           0x00004000L
363 # define SSL_AES256CCM           0x00008000L
364 # define SSL_AES128CCM8          0x00010000L
365 # define SSL_AES256CCM8          0x00020000L
366
367 # define SSL_AES                 (SSL_AES128|SSL_AES256|SSL_AES128GCM|SSL_AES256GCM|SSL_AES128CCM|SSL_AES256CCM|SSL_AES128CCM8|SSL_AES256CCM8)
368 # define SSL_CAMELLIA            (SSL_CAMELLIA128|SSL_CAMELLIA256)
369
370 /* Bits for algorithm_mac (symmetric authentication) */
371
372 # define SSL_MD5                 0x00000001L
373 # define SSL_SHA1                0x00000002L
374 # define SSL_GOST94      0x00000004L
375 # define SSL_GOST89MAC   0x00000008L
376 # define SSL_SHA256              0x00000010L
377 # define SSL_SHA384              0x00000020L
378 /* Not a real MAC, just an indication it is part of cipher */
379 # define SSL_AEAD                0x00000040L
380
381 /* Bits for algorithm_ssl (protocol version) */
382 # define SSL_SSLV3               0x00000002L
383 # define SSL_TLSV1               SSL_SSLV3/* for now */
384 # define SSL_TLSV1_2             0x00000004L
385
386 /* Bits for algorithm2 (handshake digests and other extra flags) */
387
388 # define SSL_HANDSHAKE_MAC_MD5 0x10
389 # define SSL_HANDSHAKE_MAC_SHA 0x20
390 # define SSL_HANDSHAKE_MAC_GOST94 0x40
391 # define SSL_HANDSHAKE_MAC_SHA256 0x80
392 # define SSL_HANDSHAKE_MAC_SHA384 0x100
393 # define SSL_HANDSHAKE_MAC_DEFAULT (SSL_HANDSHAKE_MAC_MD5 | SSL_HANDSHAKE_MAC_SHA)
394
395 /*
396  * When adding new digest in the ssl_ciph.c and increment SSM_MD_NUM_IDX make
397  * sure to update this constant too
398  */
399 # define SSL_MAX_DIGEST 6
400
401 # define TLS1_PRF_DGST_SHIFT 10
402 # define TLS1_PRF_MD5 (SSL_HANDSHAKE_MAC_MD5 << TLS1_PRF_DGST_SHIFT)
403 # define TLS1_PRF_SHA1 (SSL_HANDSHAKE_MAC_SHA << TLS1_PRF_DGST_SHIFT)
404 # define TLS1_PRF_SHA256 (SSL_HANDSHAKE_MAC_SHA256 << TLS1_PRF_DGST_SHIFT)
405 # define TLS1_PRF_SHA384 (SSL_HANDSHAKE_MAC_SHA384 << TLS1_PRF_DGST_SHIFT)
406 # define TLS1_PRF_GOST94 (SSL_HANDSHAKE_MAC_GOST94 << TLS1_PRF_DGST_SHIFT)
407 # define TLS1_PRF (TLS1_PRF_MD5 | TLS1_PRF_SHA1)
408
409 /*
410  * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
411  * goes into algorithm2)
412  */
413 # define TLS1_STREAM_MAC 0x04
414
415 /*
416  * Export and cipher strength information. For each cipher we have to decide
417  * whether it is exportable or not. This information is likely to change
418  * over time, since the export control rules are no static technical issue.
419  *
420  * Independent of the export flag the cipher strength is sorted into classes.
421  * SSL_EXP40 was denoting the 40bit US export limit of past times, which now
422  * is at 56bit (SSL_EXP56). If the exportable cipher class is going to change
423  * again (eg. to 64bit) the use of "SSL_EXP*" becomes blurred even more,
424  * since SSL_EXP64 could be similar to SSL_LOW.
425  * For this reason SSL_MICRO and SSL_MINI macros are included to widen the
426  * namespace of SSL_LOW-SSL_HIGH to lower values. As development of speed
427  * and ciphers goes, another extension to SSL_SUPER and/or SSL_ULTRA would
428  * be possible.
429  */
430 # define SSL_EXP_MASK            0x00000003L
431 # define SSL_STRONG_MASK         0x000001fcL
432 # define SSL_DEFAULT_MASK        0X00000200L
433
434 # define SSL_NOT_EXP             0x00000001L
435 # define SSL_EXPORT              0x00000002L
436
437 # define SSL_STRONG_NONE         0x00000004L
438 # define SSL_EXP40               0x00000008L
439 # define SSL_MICRO               (SSL_EXP40)
440 # define SSL_EXP56               0x00000010L
441 # define SSL_MINI                (SSL_EXP56)
442 # define SSL_LOW                 0x00000020L
443 # define SSL_MEDIUM              0x00000040L
444 # define SSL_HIGH                0x00000080L
445 # define SSL_FIPS                0x00000100L
446
447 # define SSL_NOT_DEFAULT         0x00000200L
448
449 /* we have used 000003ff - 22 bits left to go */
450
451 /*-
452  * Macros to check the export status and cipher strength for export ciphers.
453  * Even though the macros for EXPORT and EXPORT40/56 have similar names,
454  * their meaning is different:
455  * *_EXPORT macros check the 'exportable' status.
456  * *_EXPORT40/56 macros are used to check whether a certain cipher strength
457  *          is given.
458  * Since the SSL_IS_EXPORT* and SSL_EXPORT* macros depend on the correct
459  * algorithm structure element to be passed (algorithms, algo_strength) and no
460  * typechecking can be done as they are all of type unsigned long, their
461  * direct usage is discouraged.
462  * Use the SSL_C_* macros instead.
463  */
464 # define SSL_IS_EXPORT(a)        ((a)&SSL_EXPORT)
465 # define SSL_IS_EXPORT56(a)      ((a)&SSL_EXP56)
466 # define SSL_IS_EXPORT40(a)      ((a)&SSL_EXP40)
467 # define SSL_C_IS_EXPORT(c)      SSL_IS_EXPORT((c)->algo_strength)
468 # define SSL_C_IS_EXPORT56(c)    SSL_IS_EXPORT56((c)->algo_strength)
469 # define SSL_C_IS_EXPORT40(c)    SSL_IS_EXPORT40((c)->algo_strength)
470
471 # define SSL_EXPORT_KEYLENGTH(a,s)       (SSL_IS_EXPORT40(s) ? 5 : \
472                                  (a) == SSL_DES ? 8 : 7)
473 # define SSL_EXPORT_PKEYLENGTH(a) (SSL_IS_EXPORT40(a) ? 512 : 1024)
474 # define SSL_C_EXPORT_KEYLENGTH(c)       SSL_EXPORT_KEYLENGTH((c)->algorithm_enc, \
475                                 (c)->algo_strength)
476 # define SSL_C_EXPORT_PKEYLENGTH(c)      SSL_EXPORT_PKEYLENGTH((c)->algo_strength)
477
478 /* Check if an SSL structure is using DTLS */
479 # define SSL_IS_DTLS(s)  (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
480 /* See if we need explicit IV */
481 # define SSL_USE_EXPLICIT_IV(s)  \
482                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
483 /*
484  * See if we use signature algorithms extension and signature algorithm
485  * before signatures.
486  */
487 # define SSL_USE_SIGALGS(s)      \
488                         (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
489 /*
490  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
491  * apply to others in future.
492  */
493 # define SSL_USE_TLS1_2_CIPHERS(s)       \
494                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
495 /*
496  * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
497  * flags because it may not be set to correct version yet.
498  */
499 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s)        \
500                 ((SSL_IS_DTLS(s) && s->client_version <= DTLS1_2_VERSION) || \
501                 (!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION))
502
503 # ifdef TLSEXT_TYPE_encrypt_then_mac
504 #  define SSL_USE_ETM(s) (s->s3->flags & TLS1_FLAGS_ENCRYPT_THEN_MAC)
505 # else
506 #  define SSL_USE_ETM(s) (0)
507 # endif
508
509 /* Mostly for SSLv3 */
510 # define SSL_PKEY_RSA_ENC        0
511 # define SSL_PKEY_RSA_SIGN       1
512 # define SSL_PKEY_DSA_SIGN       2
513 # define SSL_PKEY_DH_RSA         3
514 # define SSL_PKEY_DH_DSA         4
515 # define SSL_PKEY_ECC            5
516 # define SSL_PKEY_GOST01         7
517 # define SSL_PKEY_NUM            8
518
519 /*-
520  * SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
521  *          <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
522  * SSL_kDH  <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
523  * SSL_kDHE <- RSA_ENC | RSA_SIGN | DSA_SIGN
524  * SSL_aRSA <- RSA_ENC | RSA_SIGN
525  * SSL_aDSS <- DSA_SIGN
526  */
527
528 /*-
529 #define CERT_INVALID            0
530 #define CERT_PUBLIC_KEY         1
531 #define CERT_PRIVATE_KEY        2
532 */
533
534
535 /* CipherSuite length. SSLv3 and all TLS versions. */
536 #define TLS_CIPHER_LEN 2
537 /* used to hold info on the particular ciphers used */
538 struct ssl_cipher_st {
539     int valid;
540     const char *name;           /* text name */
541     unsigned long id;           /* id, 4 bytes, first is version */
542     /*
543      * changed in 0.9.9: these four used to be portions of a single value
544      * 'algorithms'
545      */
546     unsigned long algorithm_mkey; /* key exchange algorithm */
547     unsigned long algorithm_auth; /* server authentication */
548     unsigned long algorithm_enc; /* symmetric encryption */
549     unsigned long algorithm_mac; /* symmetric authentication */
550     unsigned long algorithm_ssl; /* (major) protocol version */
551     unsigned long algo_strength; /* strength and export flags */
552     unsigned long algorithm2;   /* Extra flags */
553     int strength_bits;          /* Number of bits really used */
554     int alg_bits;               /* Number of bits for algorithm */
555 };
556
557 /* Used to hold functions for SSLv2 or SSLv3/TLSv1 functions */
558 struct ssl_method_st {
559     int version;
560     int (*ssl_new) (SSL *s);
561     void (*ssl_clear) (SSL *s);
562     void (*ssl_free) (SSL *s);
563     int (*ssl_accept) (SSL *s);
564     int (*ssl_connect) (SSL *s);
565     int (*ssl_read) (SSL *s, void *buf, int len);
566     int (*ssl_peek) (SSL *s, void *buf, int len);
567     int (*ssl_write) (SSL *s, const void *buf, int len);
568     int (*ssl_shutdown) (SSL *s);
569     int (*ssl_renegotiate) (SSL *s);
570     int (*ssl_renegotiate_check) (SSL *s);
571     long (*ssl_get_message) (SSL *s, int st1, int stn, int mt, long
572                              max, int *ok);
573     int (*ssl_read_bytes) (SSL *s, int type, int *recvd_type,
574                            unsigned char *buf, int len, int peek);
575     int (*ssl_write_bytes) (SSL *s, int type, const void *buf_, int len);
576     int (*ssl_dispatch_alert) (SSL *s);
577     long (*ssl_ctrl) (SSL *s, int cmd, long larg, void *parg);
578     long (*ssl_ctx_ctrl) (SSL_CTX *ctx, int cmd, long larg, void *parg);
579     const SSL_CIPHER *(*get_cipher_by_char) (const unsigned char *ptr);
580     int (*put_cipher_by_char) (const SSL_CIPHER *cipher, unsigned char *ptr);
581     int (*ssl_pending) (const SSL *s);
582     int (*num_ciphers) (void);
583     const SSL_CIPHER *(*get_cipher) (unsigned ncipher);
584     const struct ssl_method_st *(*get_ssl_method) (int version);
585     long (*get_timeout) (void);
586     const struct ssl3_enc_method *ssl3_enc; /* Extra SSLv3/TLS stuff */
587     int (*ssl_version) (void);
588     long (*ssl_callback_ctrl) (SSL *s, int cb_id, void (*fp) (void));
589     long (*ssl_ctx_callback_ctrl) (SSL_CTX *s, int cb_id, void (*fp) (void));
590 };
591
592 /*-
593  * Lets make this into an ASN.1 type structure as follows
594  * SSL_SESSION_ID ::= SEQUENCE {
595  *      version                 INTEGER,        -- structure version number
596  *      SSLversion              INTEGER,        -- SSL version number
597  *      Cipher                  OCTET STRING,   -- the 3 byte cipher ID
598  *      Session_ID              OCTET STRING,   -- the Session ID
599  *      Master_key              OCTET STRING,   -- the master key
600  *      Key_Arg [ 0 ] IMPLICIT  OCTET STRING,   -- the optional Key argument
601  *      Time [ 1 ] EXPLICIT     INTEGER,        -- optional Start Time
602  *      Timeout [ 2 ] EXPLICIT  INTEGER,        -- optional Timeout ins seconds
603  *      Peer [ 3 ] EXPLICIT     X509,           -- optional Peer Certificate
604  *      Session_ID_context [ 4 ] EXPLICIT OCTET STRING,   -- the Session ID context
605  *      Verify_result [ 5 ] EXPLICIT INTEGER,   -- X509_V_... code for `Peer'
606  *      HostName [ 6 ] EXPLICIT OCTET STRING,   -- optional HostName from servername TLS extension
607  *      PSK_identity_hint [ 7 ] EXPLICIT OCTET STRING, -- optional PSK identity hint
608  *      PSK_identity [ 8 ] EXPLICIT OCTET STRING,  -- optional PSK identity
609  *      Ticket_lifetime_hint [9] EXPLICIT INTEGER, -- server's lifetime hint for session ticket
610  *      Ticket [10]             EXPLICIT OCTET STRING, -- session ticket (clients only)
611  *      Compression_meth [11]   EXPLICIT OCTET STRING, -- optional compression method
612  *      SRP_username [ 12 ] EXPLICIT OCTET STRING -- optional SRP username
613  *      flags [ 13 ] EXPLICIT INTEGER -- optional flags
614  *      }
615  * Look in ssl/ssl_asn1.c for more details
616  * I'm using EXPLICIT tags so I can read the damn things using asn1parse :-).
617  */
618 struct ssl_session_st {
619     int ssl_version;            /* what ssl version session info is being
620                                  * kept in here? */
621     int master_key_length;
622     unsigned char master_key[SSL_MAX_MASTER_KEY_LENGTH];
623     /* session_id - valid? */
624     unsigned int session_id_length;
625     unsigned char session_id[SSL_MAX_SSL_SESSION_ID_LENGTH];
626     /*
627      * this is used to determine whether the session is being reused in the
628      * appropriate context. It is up to the application to set this, via
629      * SSL_new
630      */
631     unsigned int sid_ctx_length;
632     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
633 # ifndef OPENSSL_NO_PSK
634     char *psk_identity_hint;
635     char *psk_identity;
636 # endif
637     /*
638      * Used to indicate that session resumption is not allowed. Applications
639      * can also set this bit for a new session via not_resumable_session_cb
640      * to disable session caching and tickets.
641      */
642     int not_resumable;
643     /* This is the cert and type for the other end. */
644     X509 *peer;
645     int peer_type;
646     /* Certificate chain of peer */
647     STACK_OF(X509) *peer_chain;
648     /*
649      * when app_verify_callback accepts a session where the peer's
650      * certificate is not ok, we must remember the error for session reuse:
651      */
652     long verify_result;         /* only for servers */
653     int references;
654     long timeout;
655     long time;
656     unsigned int compress_meth; /* Need to lookup the method */
657     const SSL_CIPHER *cipher;
658     unsigned long cipher_id;    /* when ASN.1 loaded, this needs to be used
659                                  * to load the 'cipher' structure */
660     STACK_OF(SSL_CIPHER) *ciphers; /* shared ciphers? */
661     CRYPTO_EX_DATA ex_data;     /* application specific data */
662     /*
663      * These are used to make removal of session-ids more efficient and to
664      * implement a maximum cache size.
665      */
666     struct ssl_session_st *prev, *next;
667     char *tlsext_hostname;
668 # ifndef OPENSSL_NO_EC
669     size_t tlsext_ecpointformatlist_length;
670     unsigned char *tlsext_ecpointformatlist; /* peer's list */
671     size_t tlsext_ellipticcurvelist_length;
672     unsigned char *tlsext_ellipticcurvelist; /* peer's list */
673 # endif                       /* OPENSSL_NO_EC */
674     /* RFC4507 info */
675     unsigned char *tlsext_tick; /* Session ticket */
676     size_t tlsext_ticklen;      /* Session ticket length */
677     unsigned long tlsext_tick_lifetime_hint; /* Session lifetime hint in seconds */
678 # ifndef OPENSSL_NO_SRP
679     char *srp_username;
680 # endif
681     uint32_t flags;
682 };
683
684 /* Extended master secret support */
685 #  define SSL_SESS_FLAG_EXTMS             0x1
686
687
688 # ifndef OPENSSL_NO_SRP
689
690 typedef struct srp_ctx_st {
691     /* param for all the callbacks */
692     void *SRP_cb_arg;
693     /* set client Hello login callback */
694     int (*TLS_ext_srp_username_callback) (SSL *, int *, void *);
695     /* set SRP N/g param callback for verification */
696     int (*SRP_verify_param_callback) (SSL *, void *);
697     /* set SRP client passwd callback */
698     char *(*SRP_give_srp_client_pwd_callback) (SSL *, void *);
699     char *login;
700     BIGNUM *N, *g, *s, *B, *A;
701     BIGNUM *a, *b, *v;
702     char *info;
703     int strength;
704     unsigned long srp_Mask;
705 } SRP_CTX;
706
707 # endif
708
709 typedef struct ssl_comp_st SSL_COMP;
710
711 struct ssl_comp_st {
712     int id;
713     const char *name;
714     COMP_METHOD *method;
715 };
716
717 DECLARE_STACK_OF(SSL_COMP)
718 DECLARE_LHASH_OF(SSL_SESSION);
719
720 /*
721  * The valid handshake states (one for each type message sent and one for each
722  * type of message received). There are also two "special" states:
723  * TLS = TLS or DTLS state
724  * DTLS = DTLS specific state
725  * CR/SR = Client Read/Server Read
726  * CW/SW = Client Write/Server Write
727  *
728  * The "special" states are:
729  * TLS_ST_BEFORE = No handshake has been initiated yet
730  * TLS_ST_OK = A handshake has been successfully completed
731  */
732 enum HANDSHAKE_STATE {
733     TLS_ST_BEFORE,
734     TLS_ST_OK,
735     DTLS_ST_CR_HELLO_VERIFY_REQUEST,
736     TLS_ST_CR_SRVR_HELLO,
737     TLS_ST_CR_CERT,
738     TLS_ST_CR_CERT_STATUS,
739     TLS_ST_CR_KEY_EXCH,
740     TLS_ST_CR_CERT_REQ,
741     TLS_ST_CR_SRVR_DONE,
742     TLS_ST_CR_SESSION_TICKET,
743     TLS_ST_CR_CHANGE,
744     TLS_ST_CR_FINISHED,
745     TLS_ST_CW_CLNT_HELLO,
746     TLS_ST_CW_CERT,
747     TLS_ST_CW_KEY_EXCH,
748     TLS_ST_CW_CERT_VRFY,
749     TLS_ST_CW_CHANGE,
750     TLS_ST_CW_NEXT_PROTO,
751     TLS_ST_CW_FINISHED,
752     TLS_ST_SW_HELLO_REQ,
753     TLS_ST_SR_CLNT_HELLO,
754     DTLS_ST_SW_HELLO_VERIFY_REQUEST,
755     TLS_ST_SW_SRVR_HELLO,
756     TLS_ST_SW_CERT,
757     TLS_ST_SW_KEY_EXCH,
758     TLS_ST_SW_CERT_REQ,
759     TLS_ST_SW_SRVR_DONE,
760     TLS_ST_SR_CERT,
761     TLS_ST_SR_KEY_EXCH,
762     TLS_ST_SR_CERT_VRFY,
763     TLS_ST_SR_NEXT_PROTO,
764     TLS_ST_SR_CHANGE,
765     TLS_ST_SR_FINISHED,
766     TLS_ST_SW_SESSION_TICKET,
767     TLS_ST_SW_CERT_STATUS,
768     TLS_ST_SW_CHANGE,
769     TLS_ST_SW_FINISHED
770 };
771
772 /*
773  * Valid return codes used for functions performing work prior to or after
774  * sending or receiving a message
775  */
776 enum WORK_STATE {
777     /* Something went wrong */
778     WORK_ERROR,
779     /* We're done working and there shouldn't be anything else to do after */
780     WORK_FINISHED_STOP,
781     /* We're done working move onto the next thing */
782     WORK_FINISHED_CONTINUE,
783     /* We're working on phase A */
784     WORK_MORE_A,
785     /* We're working on phase B */
786     WORK_MORE_B
787 };
788
789 /* Write transition return codes */
790 enum WRITE_TRAN {
791     /* Something went wrong */
792     WRITE_TRAN_ERROR,
793     /* A transition was successfully completed and we should continue */
794     WRITE_TRAN_CONTINUE,
795     /* There is no more write work to be done */
796     WRITE_TRAN_FINISHED
797 };
798
799 /* Message processing return codes */
800 enum MSG_PROCESS_RETURN {
801     MSG_PROCESS_ERROR,
802     MSG_PROCESS_FINISHED_READING,
803     MSG_PROCESS_CONTINUE_PROCESSING,
804     MSG_PROCESS_CONTINUE_READING
805 };
806
807 /* Message flow states */
808 enum MSG_FLOW_STATE {
809     /* No handshake in progress */
810     MSG_FLOW_UNINITED,
811     /* A permanent error with this connection */
812     MSG_FLOW_ERROR,
813     /* We are about to renegotiate */
814     MSG_FLOW_RENEGOTIATE,
815     /* We are reading messages */
816     MSG_FLOW_READING,
817     /* We are writing messages */
818     MSG_FLOW_WRITING,
819     /* Handshake has finished */
820     MSG_FLOW_FINISHED
821 };
822
823 /* Read states */
824 enum READ_STATE {
825     READ_STATE_HEADER,
826     READ_STATE_BODY,
827     READ_STATE_POST_PROCESS
828 };
829
830 /* Write states */
831 enum WRITE_STATE {
832     WRITE_STATE_TRANSITION,
833     WRITE_STATE_PRE_WORK,
834     WRITE_STATE_SEND,
835     WRITE_STATE_POST_WORK
836 };
837
838 struct statem_st {
839     enum MSG_FLOW_STATE state;
840     enum WRITE_STATE write_state;
841     enum WORK_STATE write_state_work;
842     enum READ_STATE read_state;
843     enum WORK_STATE read_state_work;
844     enum HANDSHAKE_STATE hand_state;
845     int read_state_first_init;
846     int use_timer;
847 #ifndef OPENSSL_NO_SCTP
848     int in_sctp_read_sock;
849 #endif
850 };
851 typedef struct statem_st STATEM;
852
853
854 struct ssl_ctx_st {
855     const SSL_METHOD *method;
856     STACK_OF(SSL_CIPHER) *cipher_list;
857     /* same as above but sorted for lookup */
858     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
859     struct x509_store_st /* X509_STORE */ *cert_store;
860     LHASH_OF(SSL_SESSION) *sessions;
861     /*
862      * Most session-ids that will be cached, default is
863      * SSL_SESSION_CACHE_MAX_SIZE_DEFAULT. 0 is unlimited.
864      */
865     unsigned long session_cache_size;
866     struct ssl_session_st *session_cache_head;
867     struct ssl_session_st *session_cache_tail;
868     /*
869      * This can have one of 2 values, ored together, SSL_SESS_CACHE_CLIENT,
870      * SSL_SESS_CACHE_SERVER, Default is SSL_SESSION_CACHE_SERVER, which
871      * means only SSL_accept which cache SSL_SESSIONS.
872      */
873     uint32_t session_cache_mode;
874     /*
875      * If timeout is not 0, it is the default timeout value set when
876      * SSL_new() is called.  This has been put in to make life easier to set
877      * things up
878      */
879     long session_timeout;
880     /*
881      * If this callback is not null, it will be called each time a session id
882      * is added to the cache.  If this function returns 1, it means that the
883      * callback will do a SSL_SESSION_free() when it has finished using it.
884      * Otherwise, on 0, it means the callback has finished with it. If
885      * remove_session_cb is not null, it will be called when a session-id is
886      * removed from the cache.  After the call, OpenSSL will
887      * SSL_SESSION_free() it.
888      */
889     int (*new_session_cb) (struct ssl_st *ssl, SSL_SESSION *sess);
890     void (*remove_session_cb) (struct ssl_ctx_st *ctx, SSL_SESSION *sess);
891     SSL_SESSION *(*get_session_cb) (struct ssl_st *ssl,
892                                     unsigned char *data, int len, int *copy);
893     struct {
894         int sess_connect;       /* SSL new conn - started */
895         int sess_connect_renegotiate; /* SSL reneg - requested */
896         int sess_connect_good;  /* SSL new conne/reneg - finished */
897         int sess_accept;        /* SSL new accept - started */
898         int sess_accept_renegotiate; /* SSL reneg - requested */
899         int sess_accept_good;   /* SSL accept/reneg - finished */
900         int sess_miss;          /* session lookup misses */
901         int sess_timeout;       /* reuse attempt on timeouted session */
902         int sess_cache_full;    /* session removed due to full cache */
903         int sess_hit;           /* session reuse actually done */
904         int sess_cb_hit;        /* session-id that was not in the cache was
905                                  * passed back via the callback.  This
906                                  * indicates that the application is
907                                  * supplying session-id's from other
908                                  * processes - spooky :-) */
909     } stats;
910
911     int references;
912
913     /* if defined, these override the X509_verify_cert() calls */
914     int (*app_verify_callback) (X509_STORE_CTX *, void *);
915     void *app_verify_arg;
916     /*
917      * before OpenSSL 0.9.7, 'app_verify_arg' was ignored
918      * ('app_verify_callback' was called with just one argument)
919      */
920
921     /* Default password callback. */
922     pem_password_cb *default_passwd_callback;
923
924     /* Default password callback user data. */
925     void *default_passwd_callback_userdata;
926
927     /* get client cert callback */
928     int (*client_cert_cb) (SSL *ssl, X509 **x509, EVP_PKEY **pkey);
929
930     /* cookie generate callback */
931     int (*app_gen_cookie_cb) (SSL *ssl, unsigned char *cookie,
932                               unsigned int *cookie_len);
933
934     /* verify cookie callback */
935     int (*app_verify_cookie_cb) (SSL *ssl, const unsigned char *cookie,
936                                  unsigned int cookie_len);
937
938     CRYPTO_EX_DATA ex_data;
939
940     const EVP_MD *md5;          /* For SSLv3/TLSv1 'ssl3-md5' */
941     const EVP_MD *sha1;         /* For SSLv3/TLSv1 'ssl3->sha1' */
942
943     STACK_OF(X509) *extra_certs;
944     STACK_OF(SSL_COMP) *comp_methods; /* stack of SSL_COMP, SSLv3/TLSv1 */
945
946     /* Default values used when no per-SSL value is defined follow */
947
948     /* used if SSL's info_callback is NULL */
949     void (*info_callback) (const SSL *ssl, int type, int val);
950
951     /* what we put in client cert requests */
952     STACK_OF(X509_NAME) *client_CA;
953
954     /*
955      * Default values to use in SSL structures follow (these are copied by
956      * SSL_new)
957      */
958
959     uint32_t options;
960     uint32_t mode;
961     long max_cert_list;
962
963     struct cert_st /* CERT */ *cert;
964     int read_ahead;
965
966     /* callback that allows applications to peek at protocol messages */
967     void (*msg_callback) (int write_p, int version, int content_type,
968                           const void *buf, size_t len, SSL *ssl, void *arg);
969     void *msg_callback_arg;
970
971     uint32_t verify_mode;
972     unsigned int sid_ctx_length;
973     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
974     /* called 'verify_callback' in the SSL */
975     int (*default_verify_callback) (int ok, X509_STORE_CTX *ctx);
976
977     /* Default generate session ID callback. */
978     GEN_SESSION_CB generate_session_id;
979
980     X509_VERIFY_PARAM *param;
981
982     int quiet_shutdown;
983
984     /*
985      * Maximum amount of data to send in one fragment. actual record size can
986      * be more than this due to padding and MAC overheads.
987      */
988     unsigned int max_send_fragment;
989
990 #  ifndef OPENSSL_NO_ENGINE
991     /*
992      * Engine to pass requests for client certs to
993      */
994     ENGINE *client_cert_engine;
995 #  endif
996
997     /* TLS extensions servername callback */
998     int (*tlsext_servername_callback) (SSL *, int *, void *);
999     void *tlsext_servername_arg;
1000     /* RFC 4507 session ticket keys */
1001     unsigned char tlsext_tick_key_name[16];
1002     unsigned char tlsext_tick_hmac_key[16];
1003     unsigned char tlsext_tick_aes_key[16];
1004     /* Callback to support customisation of ticket key setting */
1005     int (*tlsext_ticket_key_cb) (SSL *ssl,
1006                                  unsigned char *name, unsigned char *iv,
1007                                  EVP_CIPHER_CTX *ectx,
1008                                  HMAC_CTX *hctx, int enc);
1009
1010     /* certificate status request info */
1011     /* Callback for status request */
1012     int (*tlsext_status_cb) (SSL *ssl, void *arg);
1013     void *tlsext_status_arg;
1014
1015 #  ifndef OPENSSL_NO_PSK
1016     unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
1017                                          char *identity,
1018                                          unsigned int max_identity_len,
1019                                          unsigned char *psk,
1020                                          unsigned int max_psk_len);
1021     unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
1022                                          unsigned char *psk,
1023                                          unsigned int max_psk_len);
1024 #  endif
1025
1026 #  ifndef OPENSSL_NO_SRP
1027     SRP_CTX srp_ctx;            /* ctx for SRP authentication */
1028 #  endif
1029
1030 #  ifndef OPENSSL_NO_NEXTPROTONEG
1031     /* Next protocol negotiation information */
1032     /* (for experimental NPN extension). */
1033
1034     /*
1035      * For a server, this contains a callback function by which the set of
1036      * advertised protocols can be provided.
1037      */
1038     int (*next_protos_advertised_cb) (SSL *s, const unsigned char **buf,
1039                                       unsigned int *len, void *arg);
1040     void *next_protos_advertised_cb_arg;
1041     /*
1042      * For a client, this contains a callback function that selects the next
1043      * protocol from the list provided by the server.
1044      */
1045     int (*next_proto_select_cb) (SSL *s, unsigned char **out,
1046                                  unsigned char *outlen,
1047                                  const unsigned char *in,
1048                                  unsigned int inlen, void *arg);
1049     void *next_proto_select_cb_arg;
1050 #  endif
1051
1052     /*
1053      * ALPN information (we are in the process of transitioning from NPN to
1054      * ALPN.)
1055      */
1056
1057         /*-
1058          * For a server, this contains a callback function that allows the
1059          * server to select the protocol for the connection.
1060          *   out: on successful return, this must point to the raw protocol
1061          *        name (without the length prefix).
1062          *   outlen: on successful return, this contains the length of |*out|.
1063          *   in: points to the client's list of supported protocols in
1064          *       wire-format.
1065          *   inlen: the length of |in|.
1066          */
1067     int (*alpn_select_cb) (SSL *s,
1068                            const unsigned char **out,
1069                            unsigned char *outlen,
1070                            const unsigned char *in,
1071                            unsigned int inlen, void *arg);
1072     void *alpn_select_cb_arg;
1073
1074     /*
1075      * For a client, this contains the list of supported protocols in wire
1076      * format.
1077      */
1078     unsigned char *alpn_client_proto_list;
1079     unsigned alpn_client_proto_list_len;
1080
1081     /* SRTP profiles we are willing to do from RFC 5764 */
1082     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1083     /*
1084      * Callback for disabling session caching and ticket support on a session
1085      * basis, depending on the chosen cipher.
1086      */
1087     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1088 #  ifndef OPENSSL_NO_EC
1089     /* EC extension values inherited by SSL structure */
1090     size_t tlsext_ecpointformatlist_length;
1091     unsigned char *tlsext_ecpointformatlist;
1092     size_t tlsext_ellipticcurvelist_length;
1093     unsigned char *tlsext_ellipticcurvelist;
1094 #  endif                        /* OPENSSL_NO_EC */
1095 };
1096
1097
1098 struct ssl_st {
1099     /*
1100      * protocol version (one of SSL2_VERSION, SSL3_VERSION, TLS1_VERSION,
1101      * DTLS1_VERSION)
1102      */
1103     int version;
1104     /* SSL_ST_CONNECT or SSL_ST_ACCEPT */
1105     int type;
1106     /* SSLv3 */
1107     const SSL_METHOD *method;
1108     /*
1109      * There are 2 BIO's even though they are normally both the same.  This
1110      * is so data can be read and written to different handlers
1111      */
1112     /* used by SSL_read */
1113     BIO *rbio;
1114     /* used by SSL_write */
1115     BIO *wbio;
1116     /* used during session-id reuse to concatenate messages */
1117     BIO *bbio;
1118     /*
1119      * This holds a variable that indicates what we were doing when a 0 or -1
1120      * is returned.  This is needed for non-blocking IO so we know what
1121      * request needs re-doing when in SSL_accept or SSL_connect
1122      */
1123     int rwstate;
1124     /* true when we are actually in SSL_accept() or SSL_connect() */
1125     int in_handshake;
1126     int (*handshake_func) (SSL *);
1127     /*
1128      * Imagine that here's a boolean member "init" that is switched as soon
1129      * as SSL_set_{accept/connect}_state is called for the first time, so
1130      * that "state" and "handshake_func" are properly initialized.  But as
1131      * handshake_func is == 0 until then, we use this test instead of an
1132      * "init" member.
1133      */
1134     /* are we the server side? - mostly used by SSL_clear */
1135     int server;
1136     /*
1137      * Generate a new session or reuse an old one.
1138      * NB: For servers, the 'new' session may actually be a previously
1139      * cached session or even the previous session unless
1140      * SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION is set
1141      */
1142     int new_session;
1143     /* don't send shutdown packets */
1144     int quiet_shutdown;
1145     /* we have shut things down, 0x01 sent, 0x02 for received */
1146     int shutdown;
1147     /* where we are */
1148     int state;
1149     STATEM statem;
1150
1151     BUF_MEM *init_buf;          /* buffer used during init */
1152     void *init_msg;             /* pointer to handshake message body, set by
1153                                  * ssl3_get_message() */
1154     int init_num;               /* amount read/written */
1155     int init_off;               /* amount read/written */
1156
1157     struct ssl3_state_st *s3;   /* SSLv3 variables */
1158     struct dtls1_state_st *d1;  /* DTLSv1 variables */
1159
1160     /* callback that allows applications to peek at protocol messages */
1161     void (*msg_callback) (int write_p, int version, int content_type,
1162                           const void *buf, size_t len, SSL *ssl, void *arg);
1163     void *msg_callback_arg;
1164     int hit;                    /* reusing a previous session */
1165     X509_VERIFY_PARAM *param;
1166     /* crypto */
1167     STACK_OF(SSL_CIPHER) *cipher_list;
1168     STACK_OF(SSL_CIPHER) *cipher_list_by_id;
1169     /*
1170      * These are the ones being used, the ones in SSL_SESSION are the ones to
1171      * be 'copied' into these ones
1172      */
1173     uint32_t mac_flags;
1174     EVP_CIPHER_CTX *enc_read_ctx; /* cryptographic state */
1175     EVP_MD_CTX *read_hash;      /* used for mac generation */
1176     COMP_CTX *compress;         /* compression */
1177     COMP_CTX *expand;           /* uncompress */
1178     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1179     EVP_MD_CTX *write_hash;     /* used for mac generation */
1180     /* session info */
1181     /* client cert? */
1182     /* This is used to hold the server certificate used */
1183     struct cert_st /* CERT */ *cert;
1184     /*
1185      * the session_id_context is used to ensure sessions are only reused in
1186      * the appropriate context
1187      */
1188     unsigned int sid_ctx_length;
1189     unsigned char sid_ctx[SSL_MAX_SID_CTX_LENGTH];
1190     /* This can also be in the session once a session is established */
1191     SSL_SESSION *session;
1192     /* Default generate session ID callback. */
1193     GEN_SESSION_CB generate_session_id;
1194     /* Used in SSL3 */
1195     /*
1196      * 0 don't care about verify failure.
1197      * 1 fail if verify fails
1198      */
1199     uint32_t verify_mode;
1200     /* fail if callback returns 0 */
1201     int (*verify_callback) (int ok, X509_STORE_CTX *ctx);
1202     /* optional informational callback */
1203     void (*info_callback) (const SSL *ssl, int type, int val);
1204     /* error bytes to be written */
1205     int error;
1206     /* actual code */
1207     int error_code;
1208 #  ifndef OPENSSL_NO_PSK
1209     unsigned int (*psk_client_callback) (SSL *ssl, const char *hint,
1210                                          char *identity,
1211                                          unsigned int max_identity_len,
1212                                          unsigned char *psk,
1213                                          unsigned int max_psk_len);
1214     unsigned int (*psk_server_callback) (SSL *ssl, const char *identity,
1215                                          unsigned char *psk,
1216                                          unsigned int max_psk_len);
1217 #  endif
1218     SSL_CTX *ctx;
1219     /*
1220      * set this flag to 1 and a sleep(1) is put into all SSL_read() and
1221      * SSL_write() calls, good for nbio debuging :-)
1222      */
1223     int debug;
1224     /* extra application data */
1225     long verify_result;
1226     CRYPTO_EX_DATA ex_data;
1227     /* for server side, keep the list of CA_dn we can use */
1228     STACK_OF(X509_NAME) *client_CA;
1229     int references;
1230     /* protocol behaviour */
1231     uint32_t options;
1232     /* API behaviour */
1233     uint32_t mode;
1234     long max_cert_list;
1235     int first_packet;
1236     /* what was passed, used for SSLv3/TLS rollback check */
1237     int client_version;
1238     unsigned int max_send_fragment;
1239
1240     /* TLS extension debug callback */
1241     void (*tlsext_debug_cb) (SSL *s, int client_server, int type,
1242                              unsigned char *data, int len, void *arg);
1243     void *tlsext_debug_arg;
1244     char *tlsext_hostname;
1245     /*-
1246      * no further mod of servername
1247      * 0 : call the servername extension callback.
1248      * 1 : prepare 2, allow last ack just after in server callback.
1249      * 2 : don't call servername callback, no ack in server hello
1250      */
1251     int servername_done;
1252     /* certificate status request info */
1253     /* Status type or -1 if no status type */
1254     int tlsext_status_type;
1255     /* Expect OCSP CertificateStatus message */
1256     int tlsext_status_expected;
1257     /* OCSP status request only */
1258     STACK_OF(OCSP_RESPID) *tlsext_ocsp_ids;
1259     X509_EXTENSIONS *tlsext_ocsp_exts;
1260     /* OCSP response received or to be sent */
1261     unsigned char *tlsext_ocsp_resp;
1262     int tlsext_ocsp_resplen;
1263     /* RFC4507 session ticket expected to be received or sent */
1264     int tlsext_ticket_expected;
1265 #  ifndef OPENSSL_NO_EC
1266     size_t tlsext_ecpointformatlist_length;
1267     /* our list */
1268     unsigned char *tlsext_ecpointformatlist;
1269     size_t tlsext_ellipticcurvelist_length;
1270     /* our list */
1271     unsigned char *tlsext_ellipticcurvelist;
1272 #  endif                       /* OPENSSL_NO_EC */
1273     /* TLS Session Ticket extension override */
1274     TLS_SESSION_TICKET_EXT *tlsext_session_ticket;
1275     /* TLS Session Ticket extension callback */
1276     tls_session_ticket_ext_cb_fn tls_session_ticket_ext_cb;
1277     void *tls_session_ticket_ext_cb_arg;
1278     /* TLS pre-shared secret session resumption */
1279     tls_session_secret_cb_fn tls_session_secret_cb;
1280     void *tls_session_secret_cb_arg;
1281     SSL_CTX *initial_ctx;       /* initial ctx, used to store sessions */
1282 #  ifndef OPENSSL_NO_NEXTPROTONEG
1283     /*
1284      * Next protocol negotiation. For the client, this is the protocol that
1285      * we sent in NextProtocol and is set when handling ServerHello
1286      * extensions. For a server, this is the client's selected_protocol from
1287      * NextProtocol and is set when handling the NextProtocol message, before
1288      * the Finished message.
1289      */
1290     unsigned char *next_proto_negotiated;
1291     unsigned char next_proto_negotiated_len;
1292 #  endif
1293 #  define session_ctx initial_ctx
1294     /* What we'll do */
1295     STACK_OF(SRTP_PROTECTION_PROFILE) *srtp_profiles;
1296     /* What's been chosen */
1297     SRTP_PROTECTION_PROFILE *srtp_profile;
1298         /*-
1299          * Is use of the Heartbeat extension negotiated?
1300          *  0: disabled
1301          *  1: enabled
1302          *  2: enabled, but not allowed to send Requests
1303          */
1304     unsigned int tlsext_heartbeat;
1305     /* Indicates if a HeartbeatRequest is in flight */
1306     unsigned int tlsext_hb_pending;
1307     /* HeartbeatRequest sequence number */
1308     unsigned int tlsext_hb_seq;
1309     /*
1310      * For a client, this contains the list of supported protocols in wire
1311      * format.
1312      */
1313     unsigned char *alpn_client_proto_list;
1314     unsigned alpn_client_proto_list_len;
1315
1316     /*-
1317      * 1 if we are renegotiating.
1318      * 2 if we are a server and are inside a handshake
1319      * (i.e. not just sending a HelloRequest)
1320      */
1321     int renegotiate;
1322 #  ifndef OPENSSL_NO_SRP
1323     /* ctx for SRP authentication */
1324     SRP_CTX srp_ctx;
1325 #  endif
1326     /*
1327      * Callback for disabling session caching and ticket support on a session
1328      * basis, depending on the chosen cipher.
1329      */
1330     int (*not_resumable_session_cb) (SSL *ssl, int is_forward_secure);
1331     
1332     RECORD_LAYER rlayer;
1333 };
1334
1335
1336 typedef struct ssl3_state_st {
1337     long flags;
1338     int read_mac_secret_size;
1339     unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
1340     int write_mac_secret_size;
1341     unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
1342     unsigned char server_random[SSL3_RANDOM_SIZE];
1343     unsigned char client_random[SSL3_RANDOM_SIZE];
1344     /* flags for countermeasure against known-IV weakness */
1345     int need_empty_fragments;
1346     int empty_fragment_done;
1347     /* The value of 'extra' when the buffers were initialized */
1348     int init_extra;
1349     /* used during startup, digest all incoming/outgoing packets */
1350     BIO *handshake_buffer;
1351     /*
1352      * When set of handshake digests is determined, buffer is hashed and
1353      * freed and MD_CTX-es for all required digests are stored in this array
1354      */
1355     EVP_MD_CTX **handshake_dgst;
1356     /*
1357      * Set whenever an expected ChangeCipherSpec message is processed.
1358      * Unset when the peer's Finished message is received.
1359      * Unexpected ChangeCipherSpec messages trigger a fatal alert.
1360      */
1361     int change_cipher_spec;
1362     int warn_alert;
1363     int fatal_alert;
1364     /*
1365      * we allow one fatal and one warning alert to be outstanding, send close
1366      * alert via the warning alert
1367      */
1368     int alert_dispatch;
1369     unsigned char send_alert[2];
1370     /*
1371      * This flag is set when we should renegotiate ASAP, basically when there
1372      * is no more data in the read or write buffers
1373      */
1374     int renegotiate;
1375     int total_renegotiations;
1376     int num_renegotiations;
1377     int in_read_app_data;
1378     struct {
1379         /* actually only needs to be 16+20 */
1380         unsigned char cert_verify_md[EVP_MAX_MD_SIZE * 2];
1381         /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
1382         unsigned char finish_md[EVP_MAX_MD_SIZE * 2];
1383         int finish_md_len;
1384         unsigned char peer_finish_md[EVP_MAX_MD_SIZE * 2];
1385         int peer_finish_md_len;
1386         unsigned long message_size;
1387         int message_type;
1388         /* used to hold the new cipher we are going to use */
1389         const SSL_CIPHER *new_cipher;
1390 #  ifndef OPENSSL_NO_DH
1391         DH *dh;
1392 #  endif
1393 #  ifndef OPENSSL_NO_EC
1394         EC_KEY *ecdh;           /* holds short lived ECDH key */
1395 #  endif
1396         /* used when SSL_ST_FLUSH_DATA is entered */
1397         int next_state;
1398         int reuse_message;
1399         /* used for certificate requests */
1400         int cert_req;
1401         int ctype_num;
1402         char ctype[SSL3_CT_NUMBER];
1403         STACK_OF(X509_NAME) *ca_names;
1404         int use_rsa_tmp;
1405         int key_block_length;
1406         unsigned char *key_block;
1407         const EVP_CIPHER *new_sym_enc;
1408         const EVP_MD *new_hash;
1409         int new_mac_pkey_type;
1410         int new_mac_secret_size;
1411 #  ifndef OPENSSL_NO_COMP
1412         const SSL_COMP *new_compression;
1413 #  else
1414         char *new_compression;
1415 #  endif
1416         int cert_request;
1417         /* Raw values of the cipher list from a client */
1418         unsigned char *ciphers_raw;
1419         size_t ciphers_rawlen;
1420         /* Temporary storage for premaster secret */
1421         unsigned char *pms;
1422         size_t pmslen;
1423 #ifndef OPENSSL_NO_PSK
1424         /* Temporary storage for PSK key */
1425         unsigned char *psk;
1426         size_t psklen;
1427 #endif
1428         /*
1429          * signature algorithms peer reports: e.g. supported signature
1430          * algorithms extension for server or as part of a certificate
1431          * request for client.
1432          */
1433         unsigned char *peer_sigalgs;
1434         /* Size of above array */
1435         size_t peer_sigalgslen;
1436         /* Digest peer uses for signing */
1437         const EVP_MD *peer_md;
1438         /* Array of digests used for signing */
1439         const EVP_MD *md[SSL_PKEY_NUM];
1440         /*
1441          * Set if corresponding CERT_PKEY can be used with current
1442          * SSL session: e.g. appropriate curve, signature algorithms etc.
1443          * If zero it can't be used at all.
1444          */
1445         uint32_t valid_flags[SSL_PKEY_NUM];
1446         /*
1447          * For servers the following masks are for the key and auth algorithms
1448          * that are supported by the certs below. For clients they are masks of
1449          * *disabled* algorithms based on the current session.
1450          */
1451         unsigned long mask_k;
1452         unsigned long mask_a;
1453         unsigned long export_mask_k;
1454         unsigned long export_mask_a;
1455         /* Client only */
1456         unsigned long mask_ssl;
1457     } tmp;
1458
1459     /* Connection binding to prevent renegotiation attacks */
1460     unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
1461     unsigned char previous_client_finished_len;
1462     unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
1463     unsigned char previous_server_finished_len;
1464     int send_connection_binding; /* TODOEKR */
1465
1466 #  ifndef OPENSSL_NO_NEXTPROTONEG
1467     /*
1468      * Set if we saw the Next Protocol Negotiation extension from our peer.
1469      */
1470     int next_proto_neg_seen;
1471 #  endif
1472
1473     /*
1474      * ALPN information (we are in the process of transitioning from NPN to
1475      * ALPN.)
1476      */
1477
1478     /*
1479      * In a server these point to the selected ALPN protocol after the
1480      * ClientHello has been processed. In a client these contain the protocol
1481      * that the server selected once the ServerHello has been processed.
1482      */
1483     unsigned char *alpn_selected;
1484     unsigned alpn_selected_len;
1485
1486 #   ifndef OPENSSL_NO_EC
1487     /*
1488      * This is set to true if we believe that this is a version of Safari
1489      * running on OS X 10.6 or newer. We wish to know this because Safari on
1490      * 10.8 .. 10.8.3 has broken ECDHE-ECDSA support.
1491      */
1492     char is_probably_safari;
1493 #   endif                       /* !OPENSSL_NO_EC */
1494
1495     /* For clients: peer temporary key */
1496 # ifndef OPENSSL_NO_RSA
1497     RSA *peer_rsa_tmp;
1498 # endif
1499 # ifndef OPENSSL_NO_DH
1500     DH *peer_dh_tmp;
1501 # endif
1502 # ifndef OPENSSL_NO_EC
1503     EC_KEY *peer_ecdh_tmp;
1504 # endif
1505
1506 } SSL3_STATE;
1507
1508
1509 /* DTLS structures */
1510
1511 #  ifndef OPENSSL_NO_SCTP
1512 #   define DTLS1_SCTP_AUTH_LABEL   "EXPORTER_DTLS_OVER_SCTP"
1513 #  endif
1514
1515 /* Max MTU overhead we know about so far is 40 for IPv6 + 8 for UDP */
1516 #  define DTLS1_MAX_MTU_OVERHEAD                   48
1517
1518 /*
1519  * Flag used in message reuse to indicate the buffer contains the record
1520  * header as well as the the handshake message header.
1521  */
1522 #  define DTLS1_SKIP_RECORD_HEADER                 2
1523
1524 struct dtls1_retransmit_state {
1525     EVP_CIPHER_CTX *enc_write_ctx; /* cryptographic state */
1526     EVP_MD_CTX *write_hash;     /* used for mac generation */
1527     COMP_CTX *compress;         /* compression */
1528     SSL_SESSION *session;
1529     unsigned short epoch;
1530 };
1531
1532 struct hm_header_st {
1533     unsigned char type;
1534     unsigned long msg_len;
1535     unsigned short seq;
1536     unsigned long frag_off;
1537     unsigned long frag_len;
1538     unsigned int is_ccs;
1539     struct dtls1_retransmit_state saved_retransmit_state;
1540 };
1541
1542 struct dtls1_timeout_st {
1543     /* Number of read timeouts so far */
1544     unsigned int read_timeouts;
1545     /* Number of write timeouts so far */
1546     unsigned int write_timeouts;
1547     /* Number of alerts received so far */
1548     unsigned int num_alerts;
1549 };
1550
1551 typedef struct hm_fragment_st {
1552     struct hm_header_st msg_header;
1553     unsigned char *fragment;
1554     unsigned char *reassembly;
1555 } hm_fragment;
1556
1557 typedef struct dtls1_state_st {
1558     unsigned int send_cookie;
1559     unsigned char cookie[DTLS1_COOKIE_LENGTH];
1560     unsigned int cookie_len;
1561
1562     /* handshake message numbers */
1563     unsigned short handshake_write_seq;
1564     unsigned short next_handshake_write_seq;
1565     unsigned short handshake_read_seq;
1566
1567     /* Buffered handshake messages */
1568     pqueue buffered_messages;
1569     /* Buffered (sent) handshake records */
1570     pqueue sent_messages;
1571
1572     unsigned int link_mtu;      /* max on-the-wire DTLS packet size */
1573     unsigned int mtu;           /* max DTLS packet size */
1574     struct hm_header_st w_msg_hdr;
1575     struct hm_header_st r_msg_hdr;
1576     struct dtls1_timeout_st timeout;
1577     /*
1578      * Indicates when the last handshake msg or heartbeat sent will timeout
1579      */
1580     struct timeval next_timeout;
1581     /* Timeout duration */
1582     unsigned short timeout_duration;
1583
1584     unsigned int retransmitting;
1585 #  ifndef OPENSSL_NO_SCTP
1586     /* used when SSL_ST_XX_FLUSH is entered */
1587     int next_state;
1588     int shutdown_received;
1589 #  endif
1590 } DTLS1_STATE;
1591
1592
1593
1594 # ifndef OPENSSL_NO_EC
1595 /*
1596  * From ECC-TLS draft, used in encoding the curve type in ECParameters
1597  */
1598 #  define EXPLICIT_PRIME_CURVE_TYPE  1
1599 #  define EXPLICIT_CHAR2_CURVE_TYPE  2
1600 #  define NAMED_CURVE_TYPE           3
1601 # endif                         /* OPENSSL_NO_EC */
1602
1603 typedef struct cert_pkey_st {
1604     X509 *x509;
1605     EVP_PKEY *privatekey;
1606     /* Chain for this certificate */
1607     STACK_OF(X509) *chain;
1608
1609     /*-
1610      * serverinfo data for this certificate.  The data is in TLS Extension
1611      * wire format, specifically it's a series of records like:
1612      *   uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
1613      *   uint16_t length;
1614      *   uint8_t data[length];
1615      */
1616     unsigned char *serverinfo;
1617     size_t serverinfo_length;
1618 } CERT_PKEY;
1619 /* Retrieve Suite B flags */
1620 # define tls1_suiteb(s)  (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
1621 /* Uses to check strict mode: suite B modes are always strict */
1622 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
1623         (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
1624
1625 typedef struct {
1626     unsigned short ext_type;
1627     /*
1628      * Per-connection flags relating to this extension type: not used if
1629      * part of an SSL_CTX structure.
1630      */
1631     uint32_t ext_flags;
1632     custom_ext_add_cb add_cb;
1633     custom_ext_free_cb free_cb;
1634     void *add_arg;
1635     custom_ext_parse_cb parse_cb;
1636     void *parse_arg;
1637 } custom_ext_method;
1638
1639 /* ext_flags values */
1640
1641 /*
1642  * Indicates an extension has been received. Used to check for unsolicited or
1643  * duplicate extensions.
1644  */
1645 # define SSL_EXT_FLAG_RECEIVED   0x1
1646 /*
1647  * Indicates an extension has been sent: used to enable sending of
1648  * corresponding ServerHello extension.
1649  */
1650 # define SSL_EXT_FLAG_SENT       0x2
1651
1652 typedef struct {
1653     custom_ext_method *meths;
1654     size_t meths_count;
1655 } custom_ext_methods;
1656
1657 typedef struct cert_st {
1658     /* Current active set */
1659     /*
1660      * ALWAYS points to an element of the pkeys array
1661      * Probably it would make more sense to store
1662      * an index, not a pointer.
1663      */
1664     CERT_PKEY *key;
1665 # ifndef OPENSSL_NO_RSA
1666     RSA *rsa_tmp;
1667     RSA *(*rsa_tmp_cb) (SSL *ssl, int is_export, int keysize);
1668 # endif
1669 # ifndef OPENSSL_NO_DH
1670     DH *dh_tmp;
1671     DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1672     int dh_tmp_auto;
1673 # endif
1674 # ifndef OPENSSL_NO_EC
1675     EC_KEY *ecdh_tmp;
1676     /* Callback for generating ephemeral ECDH keys */
1677     EC_KEY *(*ecdh_tmp_cb) (SSL *ssl, int is_export, int keysize);
1678     /* Select ECDH parameters automatically */
1679     int ecdh_tmp_auto;
1680 # endif
1681     /* Flags related to certificates */
1682     uint32_t cert_flags;
1683     CERT_PKEY pkeys[SSL_PKEY_NUM];
1684     /*
1685      * Certificate types (received or sent) in certificate request message.
1686      * On receive this is only set if number of certificate types exceeds
1687      * SSL3_CT_NUMBER.
1688      */
1689     unsigned char *ctypes;
1690     size_t ctype_num;
1691     /*
1692      * suppported signature algorithms. When set on a client this is sent in
1693      * the client hello as the supported signature algorithms extension. For
1694      * servers it represents the signature algorithms we are willing to use.
1695      */
1696     unsigned char *conf_sigalgs;
1697     /* Size of above array */
1698     size_t conf_sigalgslen;
1699     /*
1700      * Client authentication signature algorithms, if not set then uses
1701      * conf_sigalgs. On servers these will be the signature algorithms sent
1702      * to the client in a cerificate request for TLS 1.2. On a client this
1703      * represents the signature algortithms we are willing to use for client
1704      * authentication.
1705      */
1706     unsigned char *client_sigalgs;
1707     /* Size of above array */
1708     size_t client_sigalgslen;
1709     /*
1710      * Signature algorithms shared by client and server: cached because these
1711      * are used most often.
1712      */
1713     TLS_SIGALGS *shared_sigalgs;
1714     size_t shared_sigalgslen;
1715     /*
1716      * Certificate setup callback: if set is called whenever a certificate
1717      * may be required (client or server). the callback can then examine any
1718      * appropriate parameters and setup any certificates required. This
1719      * allows advanced applications to select certificates on the fly: for
1720      * example based on supported signature algorithms or curves.
1721      */
1722     int (*cert_cb) (SSL *ssl, void *arg);
1723     void *cert_cb_arg;
1724     /*
1725      * Optional X509_STORE for chain building or certificate validation If
1726      * NULL the parent SSL_CTX store is used instead.
1727      */
1728     X509_STORE *chain_store;
1729     X509_STORE *verify_store;
1730     /* Custom extension methods for server and client */
1731     custom_ext_methods cli_ext;
1732     custom_ext_methods srv_ext;
1733     /* Security callback */
1734     int (*sec_cb) (SSL *s, SSL_CTX *ctx, int op, int bits, int nid,
1735                    void *other, void *ex);
1736     /* Security level */
1737     int sec_level;
1738     void *sec_ex;
1739 #ifndef OPENSSL_NO_PSK
1740     /* If not NULL psk identity hint to use for servers */
1741     char *psk_identity_hint;
1742 #endif
1743     int references;             /* >1 only if SSL_copy_session_id is used */
1744 } CERT;
1745
1746 /* Structure containing decoded values of signature algorithms extension */
1747 struct tls_sigalgs_st {
1748     /* NID of hash algorithm */
1749     int hash_nid;
1750     /* NID of signature algorithm */
1751     int sign_nid;
1752     /* Combined hash and signature NID */
1753     int signandhash_nid;
1754     /* Raw values used in extension */
1755     unsigned char rsign;
1756     unsigned char rhash;
1757 };
1758
1759 /*
1760  * #define MAC_DEBUG
1761  */
1762
1763 /*
1764  * #define ERR_DEBUG
1765  */
1766 /*
1767  * #define ABORT_DEBUG
1768  */
1769 /*
1770  * #define PKT_DEBUG 1
1771  */
1772 /*
1773  * #define DES_DEBUG
1774  */
1775 /*
1776  * #define DES_OFB_DEBUG
1777  */
1778 /*
1779  * #define SSL_DEBUG
1780  */
1781 /*
1782  * #define RSA_DEBUG
1783  */
1784 /*
1785  * #define IDEA_DEBUG
1786  */
1787
1788 # define FP_ICC  (int (*)(const void *,const void *))
1789
1790 /*
1791  * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
1792  * of a mess of functions, but hell, think of it as an opaque structure :-)
1793  */
1794 typedef struct ssl3_enc_method {
1795     int (*enc) (SSL *, int);
1796     int (*mac) (SSL *, unsigned char *, int);
1797     int (*setup_key_block) (SSL *);
1798     int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
1799                                    int);
1800     int (*change_cipher_state) (SSL *, int);
1801     int (*final_finish_mac) (SSL *, const char *, int, unsigned char *);
1802     int finish_mac_length;
1803     int (*cert_verify_mac) (SSL *, int, unsigned char *);
1804     const char *client_finished_label;
1805     int client_finished_label_len;
1806     const char *server_finished_label;
1807     int server_finished_label_len;
1808     int (*alert_value) (int);
1809     int (*export_keying_material) (SSL *, unsigned char *, size_t,
1810                                    const char *, size_t,
1811                                    const unsigned char *, size_t,
1812                                    int use_context);
1813     /* Various flags indicating protocol version requirements */
1814     uint32_t enc_flags;
1815     /* Handshake header length */
1816     unsigned int hhlen;
1817     /* Set the handshake header */
1818     int (*set_handshake_header) (SSL *s, int type, unsigned long len);
1819     /* Write out handshake message */
1820     int (*do_write) (SSL *s);
1821 } SSL3_ENC_METHOD;
1822
1823 # define SSL_HM_HEADER_LENGTH(s) s->method->ssl3_enc->hhlen
1824 # define ssl_handshake_start(s) \
1825         (((unsigned char *)s->init_buf->data) + s->method->ssl3_enc->hhlen)
1826 # define ssl_set_handshake_header(s, htype, len) \
1827         s->method->ssl3_enc->set_handshake_header(s, htype, len)
1828 # define ssl_do_write(s)  s->method->ssl3_enc->do_write(s)
1829
1830 /* Values for enc_flags */
1831
1832 /* Uses explicit IV for CBC mode */
1833 # define SSL_ENC_FLAG_EXPLICIT_IV        0x1
1834 /* Uses signature algorithms extension */
1835 # define SSL_ENC_FLAG_SIGALGS            0x2
1836 /* Uses SHA256 default PRF */
1837 # define SSL_ENC_FLAG_SHA256_PRF         0x4
1838 /* Is DTLS */
1839 # define SSL_ENC_FLAG_DTLS               0x8
1840 /*
1841  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
1842  * apply to others in future.
1843  */
1844 # define SSL_ENC_FLAG_TLS1_2_CIPHERS     0x10
1845
1846 # ifndef OPENSSL_NO_COMP
1847 /* Used for holding the relevant compression methods loaded into SSL_CTX */
1848 typedef struct ssl3_comp_st {
1849     int comp_id;                /* The identifier byte for this compression
1850                                  * type */
1851     char *name;                 /* Text name used for the compression type */
1852     COMP_METHOD *method;        /* The method :-) */
1853 } SSL3_COMP;
1854 # endif
1855
1856 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
1857 OPENSSL_EXTERN const SSL_CIPHER ssl3_ciphers[];
1858
1859 SSL_METHOD *ssl_bad_method(int ver);
1860
1861 extern const SSL3_ENC_METHOD TLSv1_enc_data;
1862 extern const SSL3_ENC_METHOD TLSv1_1_enc_data;
1863 extern const SSL3_ENC_METHOD TLSv1_2_enc_data;
1864 extern const SSL3_ENC_METHOD SSLv3_enc_data;
1865 extern const SSL3_ENC_METHOD DTLSv1_enc_data;
1866 extern const SSL3_ENC_METHOD DTLSv1_2_enc_data;
1867
1868 # define IMPLEMENT_tls_meth_func(version, func_name, s_accept, s_connect, \
1869                                 s_get_meth, enc_data) \
1870 const SSL_METHOD *func_name(void)  \
1871         { \
1872         static const SSL_METHOD func_name##_data= { \
1873                 version, \
1874                 tls1_new, \
1875                 tls1_clear, \
1876                 tls1_free, \
1877                 s_accept, \
1878                 s_connect, \
1879                 ssl3_read, \
1880                 ssl3_peek, \
1881                 ssl3_write, \
1882                 ssl3_shutdown, \
1883                 ssl3_renegotiate, \
1884                 ssl3_renegotiate_check, \
1885                 ssl3_get_message, \
1886                 ssl3_read_bytes, \
1887                 ssl3_write_bytes, \
1888                 ssl3_dispatch_alert, \
1889                 ssl3_ctrl, \
1890                 ssl3_ctx_ctrl, \
1891                 ssl3_get_cipher_by_char, \
1892                 ssl3_put_cipher_by_char, \
1893                 ssl3_pending, \
1894                 ssl3_num_ciphers, \
1895                 ssl3_get_cipher, \
1896                 s_get_meth, \
1897                 tls1_default_timeout, \
1898                 &enc_data, \
1899                 ssl_undefined_void_function, \
1900                 ssl3_callback_ctrl, \
1901                 ssl3_ctx_callback_ctrl, \
1902         }; \
1903         return &func_name##_data; \
1904         }
1905
1906 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect, s_get_meth) \
1907 const SSL_METHOD *func_name(void)  \
1908         { \
1909         static const SSL_METHOD func_name##_data= { \
1910                 SSL3_VERSION, \
1911                 ssl3_new, \
1912                 ssl3_clear, \
1913                 ssl3_free, \
1914                 s_accept, \
1915                 s_connect, \
1916                 ssl3_read, \
1917                 ssl3_peek, \
1918                 ssl3_write, \
1919                 ssl3_shutdown, \
1920                 ssl3_renegotiate, \
1921                 ssl3_renegotiate_check, \
1922                 ssl3_get_message, \
1923                 ssl3_read_bytes, \
1924                 ssl3_write_bytes, \
1925                 ssl3_dispatch_alert, \
1926                 ssl3_ctrl, \
1927                 ssl3_ctx_ctrl, \
1928                 ssl3_get_cipher_by_char, \
1929                 ssl3_put_cipher_by_char, \
1930                 ssl3_pending, \
1931                 ssl3_num_ciphers, \
1932                 ssl3_get_cipher, \
1933                 s_get_meth, \
1934                 ssl3_default_timeout, \
1935                 &SSLv3_enc_data, \
1936                 ssl_undefined_void_function, \
1937                 ssl3_callback_ctrl, \
1938                 ssl3_ctx_callback_ctrl, \
1939         }; \
1940         return &func_name##_data; \
1941         }
1942
1943 # define IMPLEMENT_dtls1_meth_func(version, func_name, s_accept, s_connect, \
1944                                         s_get_meth, enc_data) \
1945 const SSL_METHOD *func_name(void)  \
1946         { \
1947         static const SSL_METHOD func_name##_data= { \
1948                 version, \
1949                 dtls1_new, \
1950                 dtls1_clear, \
1951                 dtls1_free, \
1952                 s_accept, \
1953                 s_connect, \
1954                 ssl3_read, \
1955                 ssl3_peek, \
1956                 ssl3_write, \
1957                 dtls1_shutdown, \
1958                 ssl3_renegotiate, \
1959                 ssl3_renegotiate_check, \
1960                 dtls1_get_message, \
1961                 dtls1_read_bytes, \
1962                 dtls1_write_app_data_bytes, \
1963                 dtls1_dispatch_alert, \
1964                 dtls1_ctrl, \
1965                 ssl3_ctx_ctrl, \
1966                 ssl3_get_cipher_by_char, \
1967                 ssl3_put_cipher_by_char, \
1968                 ssl3_pending, \
1969                 ssl3_num_ciphers, \
1970                 dtls1_get_cipher, \
1971                 s_get_meth, \
1972                 dtls1_default_timeout, \
1973                 &enc_data, \
1974                 ssl_undefined_void_function, \
1975                 ssl3_callback_ctrl, \
1976                 ssl3_ctx_callback_ctrl, \
1977         }; \
1978         return &func_name##_data; \
1979         }
1980
1981 struct openssl_ssl_test_functions {
1982     int (*p_ssl_init_wbio_buffer) (SSL *s, int push);
1983     int (*p_ssl3_setup_buffers) (SSL *s);
1984     int (*p_tls1_process_heartbeat) (SSL *s,
1985         unsigned char *p, unsigned int length);
1986     int (*p_dtls1_process_heartbeat) (SSL *s,
1987         unsigned char *p, unsigned int length);
1988 };
1989
1990 # ifndef OPENSSL_UNIT_TEST
1991
1992 void ssl_clear_cipher_ctx(SSL *s);
1993 int ssl_clear_bad_session(SSL *s);
1994 __owur CERT *ssl_cert_new(void);
1995 __owur CERT *ssl_cert_dup(CERT *cert);
1996 void ssl_cert_clear_certs(CERT *c);
1997 void ssl_cert_free(CERT *c);
1998 __owur int ssl_get_new_session(SSL *s, int session);
1999 __owur int ssl_get_prev_session(SSL *s, const PACKET *ext,
2000                                 const PACKET *session_id);
2001 __owur SSL_SESSION *ssl_session_dup(SSL_SESSION *src, int ticket);
2002 __owur int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
2003 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
2004 __owur int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
2005                           const SSL_CIPHER *const *bp);
2006 __owur STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
2007                                              STACK_OF(SSL_CIPHER) **pref,
2008                                              STACK_OF(SSL_CIPHER) **sorted,
2009                                              const char *rule_str, CERT *c);
2010 void ssl_update_cache(SSL *s, int mode);
2011 __owur int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
2012                        const EVP_MD **md, int *mac_pkey_type,
2013                        int *mac_secret_size, SSL_COMP **comp, int use_etm);
2014 __owur int ssl_get_handshake_digest(int i, long *mask, const EVP_MD **md);
2015 __owur int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
2016 __owur const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr);
2017 __owur int ssl_cert_set0_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2018 __owur int ssl_cert_set1_chain(SSL *s, SSL_CTX *ctx, STACK_OF(X509) *chain);
2019 __owur int ssl_cert_add0_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2020 __owur int ssl_cert_add1_chain_cert(SSL *s, SSL_CTX *ctx, X509 *x);
2021 __owur int ssl_cert_select_current(CERT *c, X509 *x);
2022 __owur int ssl_cert_set_current(CERT *c, long arg);
2023 __owur X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
2024 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg),
2025                           void *arg);
2026
2027 __owur int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
2028 __owur int ssl_add_cert_chain(SSL *s, CERT_PKEY *cpk, unsigned long *l);
2029 __owur int ssl_build_cert_chain(SSL *s, SSL_CTX *ctx, int flags);
2030 __owur int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain, int ref);
2031
2032 __owur int ssl_security(SSL *s, int op, int bits, int nid, void *other);
2033 __owur int ssl_ctx_security(SSL_CTX *ctx, int op, int bits, int nid, void *other);
2034
2035 int ssl_undefined_function(SSL *s);
2036 __owur int ssl_undefined_void_function(void);
2037 __owur int ssl_undefined_const_function(const SSL *s);
2038 __owur CERT_PKEY *ssl_get_server_send_pkey(SSL *s);
2039 __owur int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
2040                                    size_t *serverinfo_length);
2041 __owur EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *c, const EVP_MD **pmd);
2042 __owur int ssl_cert_type(X509 *x, EVP_PKEY *pkey);
2043 void ssl_set_masks(SSL *s, const SSL_CIPHER *cipher);
2044 __owur STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
2045 __owur int ssl_verify_alarm_type(long type);
2046 void ssl_load_ciphers(void);
2047 __owur int ssl_fill_hello_random(SSL *s, int server, unsigned char *field, int len);
2048 __owur int ssl_generate_master_secret(SSL *s, unsigned char *pms, size_t pmslen,
2049                                       int free_pms);
2050
2051 __owur const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
2052 __owur int ssl3_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
2053 void ssl3_init_finished_mac(SSL *s);
2054 __owur int ssl3_send_server_certificate(SSL *s);
2055 __owur int ssl3_send_newsession_ticket(SSL *s);
2056 __owur int ssl3_send_cert_status(SSL *s);
2057 __owur int ssl3_get_change_cipher_spec(SSL *s, int a, int b);
2058 __owur int ssl3_get_finished(SSL *s, int state_a, int state_b);
2059 __owur int tls_construct_cert_status(SSL *s);
2060 __owur enum MSG_PROCESS_RETURN tls_process_change_cipher_spec(SSL *s, long n);
2061 __owur enum MSG_PROCESS_RETURN tls_process_finished(SSL *s, unsigned long n);
2062 __owur int ssl3_setup_key_block(SSL *s);
2063 __owur int ssl3_send_change_cipher_spec(SSL *s, int state_a, int state_b);
2064 __owur int tls_construct_change_cipher_spec(SSL *s);
2065 __owur int ssl3_change_cipher_state(SSL *s, int which);
2066 void ssl3_cleanup_key_block(SSL *s);
2067 __owur int ssl3_do_write(SSL *s, int type);
2068 int ssl3_send_alert(SSL *s, int level, int desc);
2069 __owur int ssl3_generate_master_secret(SSL *s, unsigned char *out,
2070                                 unsigned char *p, int len);
2071 __owur int ssl3_get_req_cert_type(SSL *s, unsigned char *p);
2072 __owur long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
2073 __owur int tls_get_message_header(SSL *s, int *mt);
2074 __owur int tls_get_message_body(SSL *s, unsigned long *len);
2075 __owur int ssl3_send_finished(SSL *s, int a, int b, const char *sender, int slen);
2076 __owur int tls_construct_finished(SSL *s, const char *sender, int slen);
2077 __owur enum WORK_STATE tls_finish_handshake(SSL *s, enum WORK_STATE wst);
2078 __owur int ssl3_num_ciphers(void);
2079 __owur const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
2080 int ssl3_renegotiate(SSL *ssl);
2081 int ssl3_renegotiate_check(SSL *ssl);
2082 __owur int ssl3_dispatch_alert(SSL *s);
2083 __owur int ssl3_final_finish_mac(SSL *s, const char *sender, int slen,
2084                           unsigned char *p);
2085 __owur int ssl3_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
2086 void ssl3_finish_mac(SSL *s, const unsigned char *buf, int len);
2087 void ssl3_free_digest_list(SSL *s);
2088 __owur unsigned long ssl3_output_cert_chain(SSL *s, CERT_PKEY *cpk);
2089 __owur SSL_CIPHER *ssl3_choose_cipher(SSL *ssl, STACK_OF(SSL_CIPHER) *clnt,
2090                                STACK_OF(SSL_CIPHER) *srvr);
2091 __owur int ssl3_digest_cached_records(SSL *s, int keep);
2092 __owur int ssl3_new(SSL *s);
2093 void ssl3_free(SSL *s);
2094 __owur int ssl3_accept(SSL *s);
2095 __owur int ssl3_connect(SSL *s);
2096 void statem_clear(SSL *s);
2097 void statem_set_renegotiate(SSL *s);
2098 void statem_set_error(SSL *s);
2099 __owur int statem_app_data_allowed(SSL *s);
2100 #ifndef OPENSSL_NO_SCTP
2101 void statem_set_sctp_read_sock(SSL *s, int read_sock);
2102 __owur int statem_in_sctp_read_sock(SSL *s);
2103 #endif
2104 __owur int ssl3_read(SSL *s, void *buf, int len);
2105 __owur int ssl3_peek(SSL *s, void *buf, int len);
2106 __owur int ssl3_write(SSL *s, const void *buf, int len);
2107 __owur int ssl3_shutdown(SSL *s);
2108 void ssl3_clear(SSL *s);
2109 __owur long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
2110 __owur long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
2111 __owur long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2112 __owur long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
2113
2114 __owur int ssl3_do_change_cipher_spec(SSL *ssl);
2115 __owur long ssl3_default_timeout(void);
2116
2117 __owur int ssl3_set_handshake_header(SSL *s, int htype, unsigned long len);
2118 __owur int ssl3_handshake_write(SSL *s);
2119
2120 __owur int ssl_allow_compression(SSL *s);
2121
2122 __owur long tls1_default_timeout(void);
2123 __owur int dtls1_do_write(SSL *s, int type);
2124 void dtls1_set_message_header(SSL *s,
2125                               unsigned char *p, unsigned char mt,
2126                               unsigned long len,
2127                               unsigned long frag_off,
2128                               unsigned long frag_len);
2129
2130 __owur int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf, int len);
2131
2132 __owur int dtls1_send_change_cipher_spec(SSL *s, int a, int b);
2133 __owur int dtls1_read_failed(SSL *s, int code);
2134 __owur int dtls1_buffer_message(SSL *s, int ccs);
2135 __owur int dtls1_retransmit_message(SSL *s, unsigned short seq,
2136                              unsigned long frag_off, int *found);
2137 __owur int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
2138 int dtls1_retransmit_buffered_messages(SSL *s);
2139 void dtls1_clear_record_buffer(SSL *s);
2140 void dtls1_get_message_header(unsigned char *data,
2141                               struct hm_header_st *msg_hdr);
2142 __owur long dtls1_default_timeout(void);
2143 __owur struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
2144 __owur int dtls1_check_timeout_num(SSL *s);
2145 __owur int dtls1_handle_timeout(SSL *s);
2146 __owur const SSL_CIPHER *dtls1_get_cipher(unsigned int u);
2147 void dtls1_start_timer(SSL *s);
2148 void dtls1_stop_timer(SSL *s);
2149 __owur int dtls1_is_timer_expired(SSL *s);
2150 void dtls1_double_timeout(SSL *s);
2151 __owur unsigned int dtls1_raw_hello_verify_request(unsigned char *buf,
2152                                                    unsigned char *cookie,
2153                                                    unsigned char cookie_len);
2154 __owur int dtls1_send_newsession_ticket(SSL *s);
2155 __owur unsigned int dtls1_min_mtu(SSL *s);
2156 __owur unsigned int dtls1_link_min_mtu(void);
2157 void dtls1_hm_fragment_free(hm_fragment *frag);
2158
2159 /* some client-only functions */
2160 __owur int ssl3_client_hello(SSL *s);
2161 __owur int tls_construct_client_hello(SSL *s);
2162 __owur int ssl3_get_server_hello(SSL *s);
2163 __owur int ssl3_get_certificate_request(SSL *s);
2164 __owur int ssl3_get_new_session_ticket(SSL *s);
2165 __owur int ssl3_get_cert_status(SSL *s);
2166 __owur int ssl3_get_server_done(SSL *s);
2167 __owur enum MSG_PROCESS_RETURN tls_process_server_hello(SSL *s,
2168                                                         unsigned long n);
2169 __owur enum MSG_PROCESS_RETURN tls_process_certificate_request(SSL *s,
2170                                                                unsigned long n);
2171 __owur enum MSG_PROCESS_RETURN tls_process_new_session_ticket(SSL *s,
2172                                                               unsigned long n);
2173 __owur enum MSG_PROCESS_RETURN tls_process_cert_status(SSL *s, unsigned long n);
2174 __owur enum MSG_PROCESS_RETURN tls_process_server_done(SSL *s, unsigned long n);
2175 __owur int ssl3_send_client_verify(SSL *s);
2176 __owur int tls_construct_client_verify(SSL *s);
2177 __owur int tls_construct_client_verify(SSL *s);
2178 int ssl3_send_client_certificate(SSL *s);
2179 __owur enum WORK_STATE tls_prepare_client_certificate(SSL *s,
2180                                                       enum WORK_STATE wst);
2181 __owur int tls_construct_client_certificate(SSL *s);
2182 __owur int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
2183 __owur int ssl3_send_client_key_exchange(SSL *s);
2184 __owur int tls_construct_client_key_exchange(SSL *s);
2185 __owur int tls_client_key_exchange_post_work(SSL *s);
2186 __owur int ssl3_get_key_exchange(SSL *s);
2187 __owur int ssl3_get_server_certificate(SSL *s);
2188 __owur enum MSG_PROCESS_RETURN tls_process_key_exchange(SSL *s,
2189                                                         unsigned long n);
2190 __owur enum MSG_PROCESS_RETURN tls_process_server_certificate(SSL *s,
2191                                                               unsigned long n);
2192 __owur int ssl3_check_cert_and_algorithm(SSL *s);
2193 #  ifndef OPENSSL_NO_NEXTPROTONEG
2194 __owur int ssl3_send_next_proto(SSL *s);
2195 __owur int tls_construct_next_proto(SSL *s);
2196 #  endif
2197
2198 int dtls1_client_hello(SSL *s);
2199
2200 /* some server-only functions */
2201 __owur int ssl3_get_client_hello(SSL *s);
2202 __owur int ssl3_send_server_hello(SSL *s);
2203 __owur enum MSG_PROCESS_RETURN tls_process_client_hello(SSL *s, long n);
2204 __owur enum WORK_STATE tls_post_process_client_hello(SSL *s,
2205                                                      enum WORK_STATE wst);
2206 __owur int tls_construct_server_hello(SSL *s);
2207 __owur int ssl3_send_hello_request(SSL *s);
2208 __owur int ssl3_send_server_key_exchange(SSL *s);
2209 __owur int ssl3_send_certificate_request(SSL *s);
2210 __owur int ssl3_send_server_done(SSL *s);
2211 __owur int ssl3_get_client_certificate(SSL *s);
2212 __owur int ssl3_get_client_key_exchange(SSL *s);
2213 __owur int ssl3_get_cert_verify(SSL *s);
2214 __owur enum MSG_PROCESS_RETURN tls_process_client_certificate(SSL *s, long n);
2215 __owur enum MSG_PROCESS_RETURN tls_process_client_key_exchange(SSL *s, long n);
2216 __owur enum WORK_STATE tls_post_process_client_key_exchange(SSL *s,
2217     enum WORK_STATE wst);
2218 __owur enum MSG_PROCESS_RETURN tls_process_cert_verify(SSL *s, long n);
2219 #  ifndef OPENSSL_NO_NEXTPROTONEG
2220 __owur int ssl3_get_next_proto(SSL *s);
2221 __owur enum MSG_PROCESS_RETURN tls_process_next_proto(SSL *s, long n);
2222 #  endif
2223
2224 __owur int tls1_new(SSL *s);
2225 void tls1_free(SSL *s);
2226 void tls1_clear(SSL *s);
2227 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2228 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
2229
2230 __owur int dtls1_new(SSL *s);
2231 __owur int dtls1_accept(SSL *s);
2232 __owur int dtls1_connect(SSL *s);
2233 void dtls1_free(SSL *s);
2234 void dtls1_clear(SSL *s);
2235 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
2236 __owur int dtls1_shutdown(SSL *s);
2237
2238 __owur long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
2239 __owur int dtls1_dispatch_alert(SSL *s);
2240
2241 __owur int ssl_init_wbio_buffer(SSL *s, int push);
2242 void ssl_free_wbio_buffer(SSL *s);
2243
2244 __owur int tls1_change_cipher_state(SSL *s, int which);
2245 __owur int tls1_setup_key_block(SSL *s);
2246 __owur int tls1_final_finish_mac(SSL *s,
2247                           const char *str, int slen, unsigned char *p);
2248 __owur int tls1_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
2249 __owur int tls1_generate_master_secret(SSL *s, unsigned char *out,
2250                                 unsigned char *p, int len);
2251 __owur int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
2252                                 const char *label, size_t llen,
2253                                 const unsigned char *p, size_t plen,
2254                                 int use_context);
2255 __owur int tls1_alert_code(int code);
2256 __owur int ssl3_alert_code(int code);
2257 __owur int ssl_ok(SSL *s);
2258
2259 #  ifndef OPENSSL_NO_EC
2260 __owur int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
2261 #  endif
2262
2263 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
2264
2265 #  ifndef OPENSSL_NO_EC
2266 __owur int tls1_ec_curve_id2nid(int curve_id);
2267 __owur int tls1_ec_nid2curve_id(int nid);
2268 __owur int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
2269 __owur int tls1_shared_curve(SSL *s, int nmatch);
2270 __owur int tls1_set_curves(unsigned char **pext, size_t *pextlen,
2271                     int *curves, size_t ncurves);
2272 __owur int tls1_set_curves_list(unsigned char **pext, size_t *pextlen,
2273                          const char *str);
2274 __owur int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
2275 #  endif                        /* OPENSSL_NO_EC */
2276
2277 __owur int tls1_shared_list(SSL *s,
2278                      const unsigned char *l1, size_t l1len,
2279                      const unsigned char *l2, size_t l2len, int nmatch);
2280 __owur unsigned char *ssl_add_clienthello_tlsext(SSL *s, unsigned char *buf,
2281                                           unsigned char *limit, int *al);
2282 __owur unsigned char *ssl_add_serverhello_tlsext(SSL *s, unsigned char *buf,
2283                                           unsigned char *limit, int *al);
2284 __owur int ssl_parse_clienthello_tlsext(SSL *s, PACKET *pkt);
2285 __owur int tls1_set_server_sigalgs(SSL *s);
2286 __owur int ssl_check_clienthello_tlsext_late(SSL *s);
2287 __owur int ssl_parse_serverhello_tlsext(SSL *s, PACKET *pkt);
2288 __owur int ssl_prepare_clienthello_tlsext(SSL *s);
2289 __owur int ssl_prepare_serverhello_tlsext(SSL *s);
2290
2291 #  ifndef OPENSSL_NO_HEARTBEATS
2292 __owur int tls1_heartbeat(SSL *s);
2293 __owur int dtls1_heartbeat(SSL *s);
2294 __owur int tls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length);
2295 __owur int dtls1_process_heartbeat(SSL *s, unsigned char *p, unsigned int length);
2296 #  endif
2297
2298 __owur int tls1_process_ticket(SSL *s, const PACKET *ext,
2299                                const PACKET *session_id, SSL_SESSION **ret);
2300
2301 __owur int tls12_get_sigandhash(unsigned char *p, const EVP_PKEY *pk,
2302                          const EVP_MD *md);
2303 __owur int tls12_get_sigid(const EVP_PKEY *pk);
2304 __owur const EVP_MD *tls12_get_hash(unsigned char hash_alg);
2305 void ssl_set_sig_mask(unsigned long *pmask_a, SSL *s, int op);
2306
2307 __owur int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
2308 __owur int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen, int client);
2309 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
2310                      int idx);
2311 void tls1_set_cert_validity(SSL *s);
2312
2313 #  ifndef OPENSSL_NO_DH
2314 __owur DH *ssl_get_auto_dh(SSL *s);
2315 #  endif
2316
2317 __owur int ssl_security_cert(SSL *s, SSL_CTX *ctx, X509 *x, int vfy, int is_ee);
2318 __owur int ssl_security_cert_chain(SSL *s, STACK_OF(X509) *sk, X509 *ex, int vfy);
2319
2320 __owur EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
2321 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
2322 __owur int ssl_add_serverhello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
2323                                         int maxlen);
2324 __owur int ssl_parse_serverhello_renegotiate_ext(SSL *s, PACKET *pkt,
2325                                           int *al);
2326 __owur int ssl_add_clienthello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
2327                                         int maxlen);
2328 __owur int ssl_parse_clienthello_renegotiate_ext(SSL *s, PACKET *pkt, int *al);
2329 __owur long ssl_get_algorithm2(SSL *s);
2330 __owur size_t tls12_copy_sigalgs(SSL *s, unsigned char *out,
2331                           const unsigned char *psig, size_t psiglen);
2332 __owur int tls1_save_sigalgs(SSL *s, const unsigned char *data, int dsize);
2333 __owur int tls1_process_sigalgs(SSL *s);
2334 __owur size_t tls12_get_psigalgs(SSL *s, const unsigned char **psigs);
2335 __owur int tls12_check_peer_sigalg(const EVP_MD **pmd, SSL *s,
2336                             const unsigned char *sig, EVP_PKEY *pkey);
2337 void ssl_set_client_disabled(SSL *s);
2338 __owur int ssl_cipher_disabled(SSL *s, const SSL_CIPHER *c, int op);
2339
2340 __owur int ssl_add_clienthello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
2341                                      int maxlen);
2342 __owur int ssl_parse_clienthello_use_srtp_ext(SSL *s, PACKET *pkt, int *al);
2343 __owur int ssl_add_serverhello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
2344                                      int maxlen);
2345 __owur int ssl_parse_serverhello_use_srtp_ext(SSL *s, PACKET *pkt, int *al);
2346
2347 __owur int ssl_handshake_hash(SSL *s, unsigned char *out, int outlen);
2348
2349 /* s3_cbc.c */
2350 __owur char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
2351 void ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
2352                             unsigned char *md_out,
2353                             size_t *md_out_size,
2354                             const unsigned char header[13],
2355                             const unsigned char *data,
2356                             size_t data_plus_mac_size,
2357                             size_t data_plus_mac_plus_padding_size,
2358                             const unsigned char *mac_secret,
2359                             unsigned mac_secret_length, char is_sslv3);
2360
2361 void tls_fips_digest_extra(const EVP_CIPHER_CTX *cipher_ctx,
2362                            EVP_MD_CTX *mac_ctx, const unsigned char *data,
2363                            size_t data_len, size_t orig_len);
2364
2365 __owur int srp_generate_server_master_secret(SSL *s);
2366 __owur int srp_generate_client_master_secret(SSL *s);
2367 __owur int srp_verify_server_param(SSL *s, int *al);
2368
2369 /* t1_ext.c */
2370
2371 void custom_ext_init(custom_ext_methods *meths);
2372
2373 __owur int custom_ext_parse(SSL *s, int server,
2374                      unsigned int ext_type,
2375                      const unsigned char *ext_data, size_t ext_size, int *al);
2376 __owur int custom_ext_add(SSL *s, int server,
2377                    unsigned char **pret, unsigned char *limit, int *al);
2378
2379 __owur int custom_exts_copy(custom_ext_methods *dst, const custom_ext_methods *src);
2380 void custom_exts_free(custom_ext_methods *exts);
2381
2382 # else
2383
2384 #  define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
2385 #  define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
2386 #  define tls1_process_heartbeat SSL_test_functions()->p_tls1_process_heartbeat
2387 #  define dtls1_process_heartbeat SSL_test_functions()->p_dtls1_process_heartbeat
2388
2389 # endif
2390 #endif