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