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