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