Run util/openssl-format-source -v -c .
[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_kEDH                0x00000008L
299 /* forward-compatible synonym */
300 # define SSL_kDHE                SSL_kEDH
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_kEECDH              0x00000080L
309 /* forward-compatible synonym */
310 # define SSL_kECDHE              SSL_kEECDH
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_SSLV2               0x00000001L
374 # define SSL_SSLV3               0x00000002L
375 # define SSL_TLSV1               SSL_SSLV3/* for now */
376 # define SSL_TLSV1_2             0x00000004L
377
378 /* Bits for algorithm2 (handshake digests and other extra flags) */
379
380 # define SSL_HANDSHAKE_MAC_MD5 0x10
381 # define SSL_HANDSHAKE_MAC_SHA 0x20
382 # define SSL_HANDSHAKE_MAC_GOST94 0x40
383 # define SSL_HANDSHAKE_MAC_SHA256 0x80
384 # define SSL_HANDSHAKE_MAC_SHA384 0x100
385 # define SSL_HANDSHAKE_MAC_DEFAULT (SSL_HANDSHAKE_MAC_MD5 | SSL_HANDSHAKE_MAC_SHA)
386
387 /*
388  * When adding new digest in the ssl_ciph.c and increment SSM_MD_NUM_IDX make
389  * sure to update this constant too
390  */
391 # define SSL_MAX_DIGEST 6
392
393 # define TLS1_PRF_DGST_MASK      (0xff << TLS1_PRF_DGST_SHIFT)
394
395 # define TLS1_PRF_DGST_SHIFT 10
396 # define TLS1_PRF_MD5 (SSL_HANDSHAKE_MAC_MD5 << TLS1_PRF_DGST_SHIFT)
397 # define TLS1_PRF_SHA1 (SSL_HANDSHAKE_MAC_SHA << TLS1_PRF_DGST_SHIFT)
398 # define TLS1_PRF_SHA256 (SSL_HANDSHAKE_MAC_SHA256 << TLS1_PRF_DGST_SHIFT)
399 # define TLS1_PRF_SHA384 (SSL_HANDSHAKE_MAC_SHA384 << TLS1_PRF_DGST_SHIFT)
400 # define TLS1_PRF_GOST94 (SSL_HANDSHAKE_MAC_GOST94 << TLS1_PRF_DGST_SHIFT)
401 # define TLS1_PRF (TLS1_PRF_MD5 | TLS1_PRF_SHA1)
402
403 /*
404  * Stream MAC for GOST ciphersuites from cryptopro draft (currently this also
405  * goes into algorithm2)
406  */
407 # define TLS1_STREAM_MAC 0x04
408
409 /*
410  * Export and cipher strength information. For each cipher we have to decide
411  * whether it is exportable or not. This information is likely to change
412  * over time, since the export control rules are no static technical issue.
413  *
414  * Independent of the export flag the cipher strength is sorted into classes.
415  * SSL_EXP40 was denoting the 40bit US export limit of past times, which now
416  * is at 56bit (SSL_EXP56). If the exportable cipher class is going to change
417  * again (eg. to 64bit) the use of "SSL_EXP*" becomes blurred even more,
418  * since SSL_EXP64 could be similar to SSL_LOW.
419  * For this reason SSL_MICRO and SSL_MINI macros are included to widen the
420  * namespace of SSL_LOW-SSL_HIGH to lower values. As development of speed
421  * and ciphers goes, another extension to SSL_SUPER and/or SSL_ULTRA would
422  * be possible.
423  */
424 # define SSL_EXP_MASK            0x00000003L
425 # define SSL_STRONG_MASK         0x000001fcL
426
427 # define SSL_NOT_EXP             0x00000001L
428 # define SSL_EXPORT              0x00000002L
429
430 # define SSL_STRONG_NONE         0x00000004L
431 # define SSL_EXP40               0x00000008L
432 # define SSL_MICRO               (SSL_EXP40)
433 # define SSL_EXP56               0x00000010L
434 # define SSL_MINI                (SSL_EXP56)
435 # define SSL_LOW                 0x00000020L
436 # define SSL_MEDIUM              0x00000040L
437 # define SSL_HIGH                0x00000080L
438 # define SSL_FIPS                0x00000100L
439
440 /* we have used 000001ff - 23 bits left to go */
441
442 /*-
443  * Macros to check the export status and cipher strength for export ciphers.
444  * Even though the macros for EXPORT and EXPORT40/56 have similar names,
445  * their meaning is different:
446  * *_EXPORT macros check the 'exportable' status.
447  * *_EXPORT40/56 macros are used to check whether a certain cipher strength
448  *          is given.
449  * Since the SSL_IS_EXPORT* and SSL_EXPORT* macros depend on the correct
450  * algorithm structure element to be passed (algorithms, algo_strength) and no
451  * typechecking can be done as they are all of type unsigned long, their
452  * direct usage is discouraged.
453  * Use the SSL_C_* macros instead.
454  */
455 # define SSL_IS_EXPORT(a)        ((a)&SSL_EXPORT)
456 # define SSL_IS_EXPORT56(a)      ((a)&SSL_EXP56)
457 # define SSL_IS_EXPORT40(a)      ((a)&SSL_EXP40)
458 # define SSL_C_IS_EXPORT(c)      SSL_IS_EXPORT((c)->algo_strength)
459 # define SSL_C_IS_EXPORT56(c)    SSL_IS_EXPORT56((c)->algo_strength)
460 # define SSL_C_IS_EXPORT40(c)    SSL_IS_EXPORT40((c)->algo_strength)
461
462 # define SSL_EXPORT_KEYLENGTH(a,s)       (SSL_IS_EXPORT40(s) ? 5 : \
463                                  (a) == SSL_DES ? 8 : 7)
464 # define SSL_EXPORT_PKEYLENGTH(a) (SSL_IS_EXPORT40(a) ? 512 : 1024)
465 # define SSL_C_EXPORT_KEYLENGTH(c)       SSL_EXPORT_KEYLENGTH((c)->algorithm_enc, \
466                                 (c)->algo_strength)
467 # define SSL_C_EXPORT_PKEYLENGTH(c)      SSL_EXPORT_PKEYLENGTH((c)->algo_strength)
468
469 /* Check if an SSL structure is using DTLS */
470 # define SSL_IS_DTLS(s)  (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_DTLS)
471 /* See if we need explicit IV */
472 # define SSL_USE_EXPLICIT_IV(s)  \
473                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_EXPLICIT_IV)
474 /*
475  * See if we use signature algorithms extension and signature algorithm
476  * before signatures.
477  */
478 # define SSL_USE_SIGALGS(s)      \
479                         (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_SIGALGS)
480 /*
481  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
482  * apply to others in future.
483  */
484 # define SSL_USE_TLS1_2_CIPHERS(s)       \
485                 (s->method->ssl3_enc->enc_flags & SSL_ENC_FLAG_TLS1_2_CIPHERS)
486 /*
487  * Determine if a client can use TLS 1.2 ciphersuites: can't rely on method
488  * flags because it may not be set to correct version yet.
489  */
490 # define SSL_CLIENT_USE_TLS1_2_CIPHERS(s)        \
491                 ((SSL_IS_DTLS(s) && s->client_version <= DTLS1_2_VERSION) || \
492                 (!SSL_IS_DTLS(s) && s->client_version >= TLS1_2_VERSION))
493
494 /* Mostly for SSLv3 */
495 # define SSL_PKEY_RSA_ENC        0
496 # define SSL_PKEY_RSA_SIGN       1
497 # define SSL_PKEY_DSA_SIGN       2
498 # define SSL_PKEY_DH_RSA         3
499 # define SSL_PKEY_DH_DSA         4
500 # define SSL_PKEY_ECC            5
501 # define SSL_PKEY_GOST94         6
502 # define SSL_PKEY_GOST01         7
503 # define SSL_PKEY_NUM            8
504
505 /*-
506  * SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
507  *          <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
508  * SSL_kDH  <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
509  * SSL_kEDH <- RSA_ENC | RSA_SIGN | DSA_SIGN
510  * SSL_aRSA <- RSA_ENC | RSA_SIGN
511  * SSL_aDSS <- DSA_SIGN
512  */
513
514 /*-
515 #define CERT_INVALID            0
516 #define CERT_PUBLIC_KEY         1
517 #define CERT_PRIVATE_KEY        2
518 */
519
520 # ifndef OPENSSL_NO_EC
521 /*
522  * From ECC-TLS draft, used in encoding the curve type in ECParameters
523  */
524 #  define EXPLICIT_PRIME_CURVE_TYPE  1
525 #  define EXPLICIT_CHAR2_CURVE_TYPE  2
526 #  define NAMED_CURVE_TYPE           3
527 # endif                         /* OPENSSL_NO_EC */
528
529 typedef struct cert_pkey_st {
530     X509 *x509;
531     EVP_PKEY *privatekey;
532     /* Digest to use when signing */
533     const EVP_MD *digest;
534     /* Chain for this certificate */
535     STACK_OF(X509) *chain;
536 # ifndef OPENSSL_NO_TLSEXT
537         /*-
538          * serverinfo data for this certificate.  The data is in TLS Extension
539          * wire format, specifically it's a series of records like:
540          *   uint16_t extension_type; // (RFC 5246, 7.4.1.4, Extension)
541          *   uint16_t length;
542          *   uint8_t data[length];
543          */
544     unsigned char *serverinfo;
545     size_t serverinfo_length;
546 # endif
547     /*
548      * Set if CERT_PKEY can be used with current SSL session: e.g.
549      * appropriate curve, signature algorithms etc. If zero it can't be used
550      * at all.
551      */
552     int valid_flags;
553 } CERT_PKEY;
554 /* Retrieve Suite B flags */
555 # define tls1_suiteb(s)  (s->cert->cert_flags & SSL_CERT_FLAG_SUITEB_128_LOS)
556 /* Uses to check strict mode: suite B modes are always strict */
557 # define SSL_CERT_FLAGS_CHECK_TLS_STRICT \
558         (SSL_CERT_FLAG_SUITEB_128_LOS|SSL_CERT_FLAG_TLS_STRICT)
559
560 typedef struct {
561     unsigned short ext_type;
562     /*
563      * Per-connection flags relating to this extension type: not used if
564      * part of an SSL_CTX structure.
565      */
566     unsigned short ext_flags;
567     custom_ext_add_cb add_cb;
568     custom_ext_free_cb free_cb;
569     void *add_arg;
570     custom_ext_parse_cb parse_cb;
571     void *parse_arg;
572 } custom_ext_method;
573
574 /* ext_flags values */
575
576 /*
577  * Indicates an extension has been received. Used to check for unsolicited or
578  * duplicate extensions.
579  */
580 # define SSL_EXT_FLAG_RECEIVED   0x1
581 /*
582  * Indicates an extension has been sent: used to enable sending of
583  * corresponding ServerHello extension.
584  */
585 # define SSL_EXT_FLAG_SENT       0x2
586
587 typedef struct {
588     custom_ext_method *meths;
589     size_t meths_count;
590 } custom_ext_methods;
591
592 typedef struct cert_st {
593     /* Current active set */
594     /*
595      * ALWAYS points to an element of the pkeys array
596      * Probably it would make more sense to store
597      * an index, not a pointer.
598      */
599     CERT_PKEY *key;
600     /*
601      * For servers the following masks are for the key and auth algorithms
602      * that are supported by the certs below. For clients they are masks of
603      * *disabled* algorithms based on the current session.
604      */
605     int valid;
606     unsigned long mask_k;
607     unsigned long mask_a;
608     unsigned long export_mask_k;
609     unsigned long export_mask_a;
610     /* Client only */
611     unsigned long mask_ssl;
612 # ifndef OPENSSL_NO_RSA
613     RSA *rsa_tmp;
614     RSA *(*rsa_tmp_cb) (SSL *ssl, int is_export, int keysize);
615 # endif
616 # ifndef OPENSSL_NO_DH
617     DH *dh_tmp;
618     DH *(*dh_tmp_cb) (SSL *ssl, int is_export, int keysize);
619 # endif
620 # ifndef OPENSSL_NO_ECDH
621     EC_KEY *ecdh_tmp;
622     /* Callback for generating ephemeral ECDH keys */
623     EC_KEY *(*ecdh_tmp_cb) (SSL *ssl, int is_export, int keysize);
624     /* Select ECDH parameters automatically */
625     int ecdh_tmp_auto;
626 # endif
627     /* Flags related to certificates */
628     unsigned int cert_flags;
629     CERT_PKEY pkeys[SSL_PKEY_NUM];
630     /*
631      * Certificate types (received or sent) in certificate request message.
632      * On receive this is only set if number of certificate types exceeds
633      * SSL3_CT_NUMBER.
634      */
635     unsigned char *ctypes;
636     size_t ctype_num;
637     /*
638      * signature algorithms peer reports: e.g. supported signature algorithms
639      * extension for server or as part of a certificate request for client.
640      */
641     unsigned char *peer_sigalgs;
642     /* Size of above array */
643     size_t peer_sigalgslen;
644     /*
645      * suppported signature algorithms. When set on a client this is sent in
646      * the client hello as the supported signature algorithms extension. For
647      * servers it represents the signature algorithms we are willing to use.
648      */
649     unsigned char *conf_sigalgs;
650     /* Size of above array */
651     size_t conf_sigalgslen;
652     /*
653      * Client authentication signature algorithms, if not set then uses
654      * conf_sigalgs. On servers these will be the signature algorithms sent
655      * to the client in a cerificate request for TLS 1.2. On a client this
656      * represents the signature algortithms we are willing to use for client
657      * authentication.
658      */
659     unsigned char *client_sigalgs;
660     /* Size of above array */
661     size_t client_sigalgslen;
662     /*
663      * Signature algorithms shared by client and server: cached because these
664      * are used most often.
665      */
666     TLS_SIGALGS *shared_sigalgs;
667     size_t shared_sigalgslen;
668     /*
669      * Certificate setup callback: if set is called whenever a certificate
670      * may be required (client or server). the callback can then examine any
671      * appropriate parameters and setup any certificates required. This
672      * allows advanced applications to select certificates on the fly: for
673      * example based on supported signature algorithms or curves.
674      */
675     int (*cert_cb) (SSL *ssl, void *arg);
676     void *cert_cb_arg;
677     /*
678      * Optional X509_STORE for chain building or certificate validation If
679      * NULL the parent SSL_CTX store is used instead.
680      */
681     X509_STORE *chain_store;
682     X509_STORE *verify_store;
683     /* Raw values of the cipher list from a client */
684     unsigned char *ciphers_raw;
685     size_t ciphers_rawlen;
686     /* Custom extension methods for server and client */
687     custom_ext_methods cli_ext;
688     custom_ext_methods srv_ext;
689     int references;             /* >1 only if SSL_copy_session_id is used */
690 } CERT;
691
692 typedef struct sess_cert_st {
693     STACK_OF(X509) *cert_chain; /* as received from peer (not for SSL2) */
694     /* The 'peer_...' members are used only by clients. */
695     int peer_cert_type;
696     CERT_PKEY *peer_key;        /* points to an element of peer_pkeys (never
697                                  * NULL!) */
698     CERT_PKEY peer_pkeys[SSL_PKEY_NUM];
699     /*
700      * Obviously we don't have the private keys of these, so maybe we
701      * shouldn't even use the CERT_PKEY type here.
702      */
703 # ifndef OPENSSL_NO_RSA
704     RSA *peer_rsa_tmp;          /* not used for SSL 2 */
705 # endif
706 # ifndef OPENSSL_NO_DH
707     DH *peer_dh_tmp;            /* not used for SSL 2 */
708 # endif
709 # ifndef OPENSSL_NO_ECDH
710     EC_KEY *peer_ecdh_tmp;
711 # endif
712     int references;             /* actually always 1 at the moment */
713 } SESS_CERT;
714 /* Structure containing decoded values of signature algorithms extension */
715 struct tls_sigalgs_st {
716     /* NID of hash algorithm */
717     int hash_nid;
718     /* NID of signature algorithm */
719     int sign_nid;
720     /* Combined hash and signature NID */
721     int signandhash_nid;
722     /* Raw values used in extension */
723     unsigned char rsign;
724     unsigned char rhash;
725 };
726
727 /*
728  * #define MAC_DEBUG
729  */
730
731 /*
732  * #define ERR_DEBUG
733  */
734 /*
735  * #define ABORT_DEBUG
736  */
737 /*
738  * #define PKT_DEBUG 1
739  */
740 /*
741  * #define DES_DEBUG
742  */
743 /*
744  * #define DES_OFB_DEBUG
745  */
746 /*
747  * #define SSL_DEBUG
748  */
749 /*
750  * #define RSA_DEBUG
751  */
752 /*
753  * #define IDEA_DEBUG
754  */
755
756 # define FP_ICC  (int (*)(const void *,const void *))
757 # define ssl_put_cipher_by_char(ssl,ciph,ptr) \
758                 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
759
760 /*
761  * This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff It is a bit
762  * of a mess of functions, but hell, think of it as an opaque structure :-)
763  */
764 typedef struct ssl3_enc_method {
765     int (*enc) (SSL *, int);
766     int (*mac) (SSL *, unsigned char *, int);
767     int (*setup_key_block) (SSL *);
768     int (*generate_master_secret) (SSL *, unsigned char *, unsigned char *,
769                                    int);
770     int (*change_cipher_state) (SSL *, int);
771     int (*final_finish_mac) (SSL *, const char *, int, unsigned char *);
772     int finish_mac_length;
773     int (*cert_verify_mac) (SSL *, int, unsigned char *);
774     const char *client_finished_label;
775     int client_finished_label_len;
776     const char *server_finished_label;
777     int server_finished_label_len;
778     int (*alert_value) (int);
779     int (*export_keying_material) (SSL *, unsigned char *, size_t,
780                                    const char *, size_t,
781                                    const unsigned char *, size_t,
782                                    int use_context);
783     /* Various flags indicating protocol version requirements */
784     unsigned int enc_flags;
785     /* Handshake header length */
786     unsigned int hhlen;
787     /* Set the handshake header */
788     void (*set_handshake_header) (SSL *s, int type, unsigned long len);
789     /* Write out handshake message */
790     int (*do_write) (SSL *s);
791 } SSL3_ENC_METHOD;
792
793 # define SSL_HM_HEADER_LENGTH(s) s->method->ssl3_enc->hhlen
794 # define ssl_handshake_start(s) \
795         (((unsigned char *)s->init_buf->data) + s->method->ssl3_enc->hhlen)
796 # define ssl_set_handshake_header(s, htype, len) \
797         s->method->ssl3_enc->set_handshake_header(s, htype, len)
798 # define ssl_do_write(s)  s->method->ssl3_enc->do_write(s)
799
800 /* Values for enc_flags */
801
802 /* Uses explicit IV for CBC mode */
803 # define SSL_ENC_FLAG_EXPLICIT_IV        0x1
804 /* Uses signature algorithms extension */
805 # define SSL_ENC_FLAG_SIGALGS            0x2
806 /* Uses SHA256 default PRF */
807 # define SSL_ENC_FLAG_SHA256_PRF         0x4
808 /* Is DTLS */
809 # define SSL_ENC_FLAG_DTLS               0x8
810 /*
811  * Allow TLS 1.2 ciphersuites: applies to DTLS 1.2 as well as TLS 1.2: may
812  * apply to others in future.
813  */
814 # define SSL_ENC_FLAG_TLS1_2_CIPHERS     0x10
815
816 # ifndef OPENSSL_NO_COMP
817 /* Used for holding the relevant compression methods loaded into SSL_CTX */
818 typedef struct ssl3_comp_st {
819     int comp_id;                /* The identifier byte for this compression
820                                  * type */
821     char *name;                 /* Text name used for the compression type */
822     COMP_METHOD *method;        /* The method :-) */
823 } SSL3_COMP;
824 # endif
825
826 # ifndef OPENSSL_NO_BUF_FREELISTS
827 typedef struct ssl3_buf_freelist_st {
828     size_t chunklen;
829     unsigned int len;
830     struct ssl3_buf_freelist_entry_st *head;
831 } SSL3_BUF_FREELIST;
832
833 typedef struct ssl3_buf_freelist_entry_st {
834     struct ssl3_buf_freelist_entry_st *next;
835 } SSL3_BUF_FREELIST_ENTRY;
836 # endif
837
838 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
839 OPENSSL_EXTERN const SSL_CIPHER ssl2_ciphers[];
840 OPENSSL_EXTERN SSL_CIPHER ssl3_ciphers[];
841
842 SSL_METHOD *ssl_bad_method(int ver);
843
844 extern SSL3_ENC_METHOD TLSv1_enc_data;
845 extern SSL3_ENC_METHOD TLSv1_1_enc_data;
846 extern SSL3_ENC_METHOD TLSv1_2_enc_data;
847 extern SSL3_ENC_METHOD SSLv3_enc_data;
848 extern SSL3_ENC_METHOD DTLSv1_enc_data;
849 extern SSL3_ENC_METHOD DTLSv1_2_enc_data;
850
851 # define IMPLEMENT_tls_meth_func(version, func_name, s_accept, s_connect, \
852                                 s_get_meth, enc_data) \
853 const SSL_METHOD *func_name(void)  \
854         { \
855         static const SSL_METHOD func_name##_data= { \
856                 version, \
857                 tls1_new, \
858                 tls1_clear, \
859                 tls1_free, \
860                 s_accept, \
861                 s_connect, \
862                 ssl3_read, \
863                 ssl3_peek, \
864                 ssl3_write, \
865                 ssl3_shutdown, \
866                 ssl3_renegotiate, \
867                 ssl3_renegotiate_check, \
868                 ssl3_get_message, \
869                 ssl3_read_bytes, \
870                 ssl3_write_bytes, \
871                 ssl3_dispatch_alert, \
872                 ssl3_ctrl, \
873                 ssl3_ctx_ctrl, \
874                 ssl3_get_cipher_by_char, \
875                 ssl3_put_cipher_by_char, \
876                 ssl3_pending, \
877                 ssl3_num_ciphers, \
878                 ssl3_get_cipher, \
879                 s_get_meth, \
880                 tls1_default_timeout, \
881                 &enc_data, \
882                 ssl_undefined_void_function, \
883                 ssl3_callback_ctrl, \
884                 ssl3_ctx_callback_ctrl, \
885         }; \
886         return &func_name##_data; \
887         }
888
889 # define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect, s_get_meth) \
890 const SSL_METHOD *func_name(void)  \
891         { \
892         static const SSL_METHOD func_name##_data= { \
893                 SSL3_VERSION, \
894                 ssl3_new, \
895                 ssl3_clear, \
896                 ssl3_free, \
897                 s_accept, \
898                 s_connect, \
899                 ssl3_read, \
900                 ssl3_peek, \
901                 ssl3_write, \
902                 ssl3_shutdown, \
903                 ssl3_renegotiate, \
904                 ssl3_renegotiate_check, \
905                 ssl3_get_message, \
906                 ssl3_read_bytes, \
907                 ssl3_write_bytes, \
908                 ssl3_dispatch_alert, \
909                 ssl3_ctrl, \
910                 ssl3_ctx_ctrl, \
911                 ssl3_get_cipher_by_char, \
912                 ssl3_put_cipher_by_char, \
913                 ssl3_pending, \
914                 ssl3_num_ciphers, \
915                 ssl3_get_cipher, \
916                 s_get_meth, \
917                 ssl3_default_timeout, \
918                 &SSLv3_enc_data, \
919                 ssl_undefined_void_function, \
920                 ssl3_callback_ctrl, \
921                 ssl3_ctx_callback_ctrl, \
922         }; \
923         return &func_name##_data; \
924         }
925
926 # define IMPLEMENT_ssl23_meth_func(func_name, s_accept, s_connect, s_get_meth) \
927 const SSL_METHOD *func_name(void)  \
928         { \
929         static const SSL_METHOD func_name##_data= { \
930         TLS1_2_VERSION, \
931         tls1_new, \
932         tls1_clear, \
933         tls1_free, \
934         s_accept, \
935         s_connect, \
936         ssl23_read, \
937         ssl23_peek, \
938         ssl23_write, \
939         ssl_undefined_function, \
940         ssl_undefined_function, \
941         ssl_ok, \
942         ssl3_get_message, \
943         ssl3_read_bytes, \
944         ssl3_write_bytes, \
945         ssl3_dispatch_alert, \
946         ssl3_ctrl, \
947         ssl3_ctx_ctrl, \
948         ssl23_get_cipher_by_char, \
949         ssl23_put_cipher_by_char, \
950         ssl_undefined_const_function, \
951         ssl23_num_ciphers, \
952         ssl23_get_cipher, \
953         s_get_meth, \
954         ssl23_default_timeout, \
955         &TLSv1_2_enc_data, \
956         ssl_undefined_void_function, \
957         ssl3_callback_ctrl, \
958         ssl3_ctx_callback_ctrl, \
959         }; \
960         return &func_name##_data; \
961         }
962
963 # define IMPLEMENT_ssl2_meth_func(func_name, s_accept, s_connect, s_get_meth) \
964 const SSL_METHOD *func_name(void)  \
965         { \
966         static const SSL_METHOD func_name##_data= { \
967                 SSL2_VERSION, \
968                 ssl2_new,       /* local */ \
969                 ssl2_clear,     /* local */ \
970                 ssl2_free,      /* local */ \
971                 s_accept, \
972                 s_connect, \
973                 ssl2_read, \
974                 ssl2_peek, \
975                 ssl2_write, \
976                 ssl2_shutdown, \
977                 ssl_ok, /* NULL - renegotiate */ \
978                 ssl_ok, /* NULL - check renegotiate */ \
979                 NULL, /* NULL - ssl_get_message */ \
980                 NULL, /* NULL - ssl_get_record */ \
981                 NULL, /* NULL - ssl_write_bytes */ \
982                 NULL, /* NULL - dispatch_alert */ \
983                 ssl2_ctrl,      /* local */ \
984                 ssl2_ctx_ctrl,  /* local */ \
985                 ssl2_get_cipher_by_char, \
986                 ssl2_put_cipher_by_char, \
987                 ssl2_pending, \
988                 ssl2_num_ciphers, \
989                 ssl2_get_cipher, \
990                 s_get_meth, \
991                 ssl2_default_timeout, \
992                 &ssl3_undef_enc_method, \
993                 ssl_undefined_void_function, \
994                 ssl2_callback_ctrl,     /* local */ \
995                 ssl2_ctx_callback_ctrl, /* local */ \
996         }; \
997         return &func_name##_data; \
998         }
999
1000 # define IMPLEMENT_dtls1_meth_func(version, func_name, s_accept, s_connect, \
1001                                         s_get_meth, enc_data) \
1002 const SSL_METHOD *func_name(void)  \
1003         { \
1004         static const SSL_METHOD func_name##_data= { \
1005                 version, \
1006                 dtls1_new, \
1007                 dtls1_clear, \
1008                 dtls1_free, \
1009                 s_accept, \
1010                 s_connect, \
1011                 ssl3_read, \
1012                 ssl3_peek, \
1013                 ssl3_write, \
1014                 dtls1_shutdown, \
1015                 ssl3_renegotiate, \
1016                 ssl3_renegotiate_check, \
1017                 dtls1_get_message, \
1018                 dtls1_read_bytes, \
1019                 dtls1_write_app_data_bytes, \
1020                 dtls1_dispatch_alert, \
1021                 dtls1_ctrl, \
1022                 ssl3_ctx_ctrl, \
1023                 ssl3_get_cipher_by_char, \
1024                 ssl3_put_cipher_by_char, \
1025                 ssl3_pending, \
1026                 ssl3_num_ciphers, \
1027                 dtls1_get_cipher, \
1028                 s_get_meth, \
1029                 dtls1_default_timeout, \
1030                 &enc_data, \
1031                 ssl_undefined_void_function, \
1032                 ssl3_callback_ctrl, \
1033                 ssl3_ctx_callback_ctrl, \
1034         }; \
1035         return &func_name##_data; \
1036         }
1037
1038 struct openssl_ssl_test_functions {
1039     int (*p_ssl_init_wbio_buffer) (SSL *s, int push);
1040     int (*p_ssl3_setup_buffers) (SSL *s);
1041     int (*p_tls1_process_heartbeat) (SSL *s);
1042     int (*p_dtls1_process_heartbeat) (SSL *s);
1043 };
1044
1045 # ifndef OPENSSL_UNIT_TEST
1046
1047 void ssl_clear_cipher_ctx(SSL *s);
1048 int ssl_clear_bad_session(SSL *s);
1049 CERT *ssl_cert_new(void);
1050 CERT *ssl_cert_dup(CERT *cert);
1051 void ssl_cert_set_default_md(CERT *cert);
1052 int ssl_cert_inst(CERT **o);
1053 void ssl_cert_clear_certs(CERT *c);
1054 void ssl_cert_free(CERT *c);
1055 SESS_CERT *ssl_sess_cert_new(void);
1056 void ssl_sess_cert_free(SESS_CERT *sc);
1057 int ssl_set_peer_cert_type(SESS_CERT *c, int type);
1058 int ssl_get_new_session(SSL *s, int session);
1059 int ssl_get_prev_session(SSL *s, unsigned char *session, int len,
1060                          const unsigned char *limit);
1061 int ssl_cipher_id_cmp(const SSL_CIPHER *a, const SSL_CIPHER *b);
1062 DECLARE_OBJ_BSEARCH_GLOBAL_CMP_FN(SSL_CIPHER, SSL_CIPHER, ssl_cipher_id);
1063 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER *const *ap,
1064                           const SSL_CIPHER *const *bp);
1065 STACK_OF(SSL_CIPHER) *ssl_bytes_to_cipher_list(SSL *s, unsigned char *p,
1066                                                int num,
1067                                                STACK_OF(SSL_CIPHER) **skp);
1068 int ssl_cipher_list_to_bytes(SSL *s, STACK_OF(SSL_CIPHER) *sk,
1069                              unsigned char *p,
1070                              int (*put_cb) (const SSL_CIPHER *,
1071                                             unsigned char *));
1072 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
1073                                              STACK_OF(SSL_CIPHER) **pref,
1074                                              STACK_OF(SSL_CIPHER) **sorted,
1075                                              const char *rule_str, CERT *c);
1076 void ssl_update_cache(SSL *s, int mode);
1077 int ssl_cipher_get_evp(const SSL_SESSION *s, const EVP_CIPHER **enc,
1078                        const EVP_MD **md, int *mac_pkey_type,
1079                        int *mac_secret_size, SSL_COMP **comp);
1080 int ssl_get_handshake_digest(int i, long *mask, const EVP_MD **md);
1081 int ssl_cipher_get_cert_index(const SSL_CIPHER *c);
1082 const SSL_CIPHER *ssl_get_cipher_by_char(SSL *ssl, const unsigned char *ptr);
1083 int ssl_cert_set0_chain(CERT *c, STACK_OF(X509) *chain);
1084 int ssl_cert_set1_chain(CERT *c, STACK_OF(X509) *chain);
1085 int ssl_cert_add0_chain_cert(CERT *c, X509 *x);
1086 int ssl_cert_add1_chain_cert(CERT *c, X509 *x);
1087 int ssl_cert_select_current(CERT *c, X509 *x);
1088 int ssl_cert_set_current(CERT *c, long arg);
1089 X509 *ssl_cert_get0_next_certificate(CERT *c, int first);
1090 void ssl_cert_set_cert_cb(CERT *c, int (*cb) (SSL *ssl, void *arg),
1091                           void *arg);
1092
1093 int ssl_verify_cert_chain(SSL *s, STACK_OF(X509) *sk);
1094 int ssl_add_cert_chain(SSL *s, CERT_PKEY *cpk, unsigned long *l);
1095 int ssl_build_cert_chain(CERT *c, X509_STORE *chain_store, int flags);
1096 int ssl_cert_set_cert_store(CERT *c, X509_STORE *store, int chain, int ref);
1097 int ssl_undefined_function(SSL *s);
1098 int ssl_undefined_void_function(void);
1099 int ssl_undefined_const_function(const SSL *s);
1100 CERT_PKEY *ssl_get_server_send_pkey(const SSL *s);
1101 #  ifndef OPENSSL_NO_TLSEXT
1102 int ssl_get_server_cert_serverinfo(SSL *s, const unsigned char **serverinfo,
1103                                    size_t *serverinfo_length);
1104 #  endif
1105 EVP_PKEY *ssl_get_sign_pkey(SSL *s, const SSL_CIPHER *c, const EVP_MD **pmd);
1106 int ssl_cert_type(X509 *x, EVP_PKEY *pkey);
1107 void ssl_set_cert_masks(CERT *c, const SSL_CIPHER *cipher);
1108 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
1109 int ssl_verify_alarm_type(long type);
1110 void ssl_load_ciphers(void);
1111 int ssl_fill_hello_random(SSL *s, int server, unsigned char *field, int len);
1112
1113 int ssl2_enc_init(SSL *s, int client);
1114 int ssl2_generate_key_material(SSL *s);
1115 int ssl2_enc(SSL *s, int send_data);
1116 void ssl2_mac(SSL *s, unsigned char *mac, int send_data);
1117 const SSL_CIPHER *ssl2_get_cipher_by_char(const unsigned char *p);
1118 int ssl2_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
1119 int ssl2_part_read(SSL *s, unsigned long f, int i);
1120 int ssl2_do_write(SSL *s);
1121 int ssl2_set_certificate(SSL *s, int type, int len,
1122                          const unsigned char *data);
1123 void ssl2_return_error(SSL *s, int reason);
1124 void ssl2_write_error(SSL *s);
1125 int ssl2_num_ciphers(void);
1126 const SSL_CIPHER *ssl2_get_cipher(unsigned int u);
1127 int ssl2_new(SSL *s);
1128 void ssl2_free(SSL *s);
1129 int ssl2_accept(SSL *s);
1130 int ssl2_connect(SSL *s);
1131 int ssl2_read(SSL *s, void *buf, int len);
1132 int ssl2_peek(SSL *s, void *buf, int len);
1133 int ssl2_write(SSL *s, const void *buf, int len);
1134 int ssl2_shutdown(SSL *s);
1135 void ssl2_clear(SSL *s);
1136 long ssl2_ctrl(SSL *s, int cmd, long larg, void *parg);
1137 long ssl2_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
1138 long ssl2_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
1139 long ssl2_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
1140 int ssl2_pending(const SSL *s);
1141 long ssl2_default_timeout(void);
1142
1143 const SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
1144 int ssl3_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
1145 void ssl3_init_finished_mac(SSL *s);
1146 int ssl3_send_server_certificate(SSL *s);
1147 int ssl3_send_newsession_ticket(SSL *s);
1148 int ssl3_send_cert_status(SSL *s);
1149 int ssl3_get_finished(SSL *s, int state_a, int state_b);
1150 int ssl3_setup_key_block(SSL *s);
1151 int ssl3_send_change_cipher_spec(SSL *s, int state_a, int state_b);
1152 int ssl3_change_cipher_state(SSL *s, int which);
1153 void ssl3_cleanup_key_block(SSL *s);
1154 int ssl3_do_write(SSL *s, int type);
1155 int ssl3_send_alert(SSL *s, int level, int desc);
1156 int ssl3_generate_master_secret(SSL *s, unsigned char *out,
1157                                 unsigned char *p, int len);
1158 int ssl3_get_req_cert_type(SSL *s, unsigned char *p);
1159 long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
1160 int ssl3_send_finished(SSL *s, int a, int b, const char *sender, int slen);
1161 int ssl3_num_ciphers(void);
1162 const SSL_CIPHER *ssl3_get_cipher(unsigned int u);
1163 int ssl3_renegotiate(SSL *ssl);
1164 int ssl3_renegotiate_check(SSL *ssl);
1165 int ssl3_dispatch_alert(SSL *s);
1166 int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
1167 int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
1168 int ssl3_final_finish_mac(SSL *s, const char *sender, int slen,
1169                           unsigned char *p);
1170 int ssl3_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
1171 void ssl3_finish_mac(SSL *s, const unsigned char *buf, int len);
1172 int ssl3_enc(SSL *s, int send_data);
1173 int n_ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
1174 void ssl3_free_digest_list(SSL *s);
1175 unsigned long ssl3_output_cert_chain(SSL *s, CERT_PKEY *cpk);
1176 SSL_CIPHER *ssl3_choose_cipher(SSL *ssl, STACK_OF(SSL_CIPHER) *clnt,
1177                                STACK_OF(SSL_CIPHER) *srvr);
1178 int ssl3_setup_buffers(SSL *s);
1179 int ssl3_setup_read_buffer(SSL *s);
1180 int ssl3_setup_write_buffer(SSL *s);
1181 int ssl3_release_read_buffer(SSL *s);
1182 int ssl3_release_write_buffer(SSL *s);
1183 int ssl3_digest_cached_records(SSL *s);
1184 int ssl3_new(SSL *s);
1185 void ssl3_free(SSL *s);
1186 int ssl3_accept(SSL *s);
1187 int ssl3_connect(SSL *s);
1188 int ssl3_read(SSL *s, void *buf, int len);
1189 int ssl3_peek(SSL *s, void *buf, int len);
1190 int ssl3_write(SSL *s, const void *buf, int len);
1191 int ssl3_shutdown(SSL *s);
1192 void ssl3_clear(SSL *s);
1193 long ssl3_ctrl(SSL *s, int cmd, long larg, void *parg);
1194 long ssl3_ctx_ctrl(SSL_CTX *s, int cmd, long larg, void *parg);
1195 long ssl3_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
1196 long ssl3_ctx_callback_ctrl(SSL_CTX *s, int cmd, void (*fp) (void));
1197 int ssl3_pending(const SSL *s);
1198
1199 void ssl3_record_sequence_update(unsigned char *seq);
1200 int ssl3_do_change_cipher_spec(SSL *ssl);
1201 long ssl3_default_timeout(void);
1202
1203 void ssl3_set_handshake_header(SSL *s, int htype, unsigned long len);
1204 int ssl3_handshake_write(SSL *s);
1205
1206 int ssl23_num_ciphers(void);
1207 const SSL_CIPHER *ssl23_get_cipher(unsigned int u);
1208 int ssl23_read(SSL *s, void *buf, int len);
1209 int ssl23_peek(SSL *s, void *buf, int len);
1210 int ssl23_write(SSL *s, const void *buf, int len);
1211 int ssl23_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
1212 const SSL_CIPHER *ssl23_get_cipher_by_char(const unsigned char *p);
1213 long ssl23_default_timeout(void);
1214
1215 long tls1_default_timeout(void);
1216 int dtls1_do_write(SSL *s, int type);
1217 int ssl3_read_n(SSL *s, int n, int max, int extend);
1218 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
1219 int ssl3_do_compress(SSL *ssl);
1220 int ssl3_do_uncompress(SSL *ssl);
1221 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
1222                        unsigned int len);
1223 unsigned char *dtls1_set_message_header(SSL *s,
1224                                         unsigned char *p, unsigned char mt,
1225                                         unsigned long len,
1226                                         unsigned long frag_off,
1227                                         unsigned long frag_len);
1228
1229 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf, int len);
1230 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
1231
1232 int dtls1_send_change_cipher_spec(SSL *s, int a, int b);
1233 int dtls1_send_finished(SSL *s, int a, int b, const char *sender, int slen);
1234 int dtls1_read_failed(SSL *s, int code);
1235 int dtls1_buffer_message(SSL *s, int ccs);
1236 int dtls1_retransmit_message(SSL *s, unsigned short seq,
1237                              unsigned long frag_off, int *found);
1238 int dtls1_get_queue_priority(unsigned short seq, int is_ccs);
1239 int dtls1_retransmit_buffered_messages(SSL *s);
1240 void dtls1_clear_record_buffer(SSL *s);
1241 void dtls1_get_message_header(unsigned char *data,
1242                               struct hm_header_st *msg_hdr);
1243 void dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr);
1244 void dtls1_reset_seq_numbers(SSL *s, int rw);
1245 long dtls1_default_timeout(void);
1246 struct timeval *dtls1_get_timeout(SSL *s, struct timeval *timeleft);
1247 int dtls1_check_timeout_num(SSL *s);
1248 int dtls1_handle_timeout(SSL *s);
1249 const SSL_CIPHER *dtls1_get_cipher(unsigned int u);
1250 void dtls1_start_timer(SSL *s);
1251 void dtls1_stop_timer(SSL *s);
1252 int dtls1_is_timer_expired(SSL *s);
1253 void dtls1_double_timeout(SSL *s);
1254 int dtls1_send_newsession_ticket(SSL *s);
1255 unsigned int dtls1_min_mtu(SSL *s);
1256 unsigned int dtls1_link_min_mtu(void);
1257 void dtls1_hm_fragment_free(hm_fragment *frag);
1258
1259 /* some client-only functions */
1260 int ssl3_client_hello(SSL *s);
1261 int ssl3_get_server_hello(SSL *s);
1262 int ssl3_get_certificate_request(SSL *s);
1263 int ssl3_get_new_session_ticket(SSL *s);
1264 int ssl3_get_cert_status(SSL *s);
1265 int ssl3_get_server_done(SSL *s);
1266 int ssl3_send_client_verify(SSL *s);
1267 int ssl3_send_client_certificate(SSL *s);
1268 int ssl_do_client_cert_cb(SSL *s, X509 **px509, EVP_PKEY **ppkey);
1269 int ssl3_send_client_key_exchange(SSL *s);
1270 int ssl3_get_key_exchange(SSL *s);
1271 int ssl3_get_server_certificate(SSL *s);
1272 int ssl3_check_cert_and_algorithm(SSL *s);
1273 #  ifndef OPENSSL_NO_TLSEXT
1274 #   ifndef OPENSSL_NO_NEXTPROTONEG
1275 int ssl3_send_next_proto(SSL *s);
1276 #   endif
1277 #  endif
1278
1279 int dtls1_client_hello(SSL *s);
1280
1281 /* some server-only functions */
1282 int ssl3_get_client_hello(SSL *s);
1283 int ssl3_send_server_hello(SSL *s);
1284 int ssl3_send_hello_request(SSL *s);
1285 int ssl3_send_server_key_exchange(SSL *s);
1286 int ssl3_send_certificate_request(SSL *s);
1287 int ssl3_send_server_done(SSL *s);
1288 int ssl3_get_client_certificate(SSL *s);
1289 int ssl3_get_client_key_exchange(SSL *s);
1290 int ssl3_get_cert_verify(SSL *s);
1291 #  ifndef OPENSSL_NO_NEXTPROTONEG
1292 int ssl3_get_next_proto(SSL *s);
1293 #  endif
1294
1295 int ssl23_accept(SSL *s);
1296 int ssl23_connect(SSL *s);
1297 int ssl23_read_bytes(SSL *s, int n);
1298 int ssl23_write_bytes(SSL *s);
1299
1300 int tls1_new(SSL *s);
1301 void tls1_free(SSL *s);
1302 void tls1_clear(SSL *s);
1303 long tls1_ctrl(SSL *s, int cmd, long larg, void *parg);
1304 long tls1_callback_ctrl(SSL *s, int cmd, void (*fp) (void));
1305
1306 int dtls1_new(SSL *s);
1307 int dtls1_accept(SSL *s);
1308 int dtls1_connect(SSL *s);
1309 void dtls1_free(SSL *s);
1310 void dtls1_clear(SSL *s);
1311 long dtls1_ctrl(SSL *s, int cmd, long larg, void *parg);
1312 int dtls1_shutdown(SSL *s);
1313
1314 long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
1315 int dtls1_get_record(SSL *s);
1316 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
1317                    unsigned int len, int create_empty_fragement);
1318 int dtls1_dispatch_alert(SSL *s);
1319
1320 int ssl_init_wbio_buffer(SSL *s, int push);
1321 void ssl_free_wbio_buffer(SSL *s);
1322
1323 int tls1_change_cipher_state(SSL *s, int which);
1324 int tls1_setup_key_block(SSL *s);
1325 int tls1_enc(SSL *s, int snd);
1326 int tls1_final_finish_mac(SSL *s,
1327                           const char *str, int slen, unsigned char *p);
1328 int tls1_cert_verify_mac(SSL *s, int md_nid, unsigned char *p);
1329 int tls1_mac(SSL *ssl, unsigned char *md, int snd);
1330 int tls1_generate_master_secret(SSL *s, unsigned char *out,
1331                                 unsigned char *p, int len);
1332 int tls1_export_keying_material(SSL *s, unsigned char *out, size_t olen,
1333                                 const char *label, size_t llen,
1334                                 const unsigned char *p, size_t plen,
1335                                 int use_context);
1336 int tls1_alert_code(int code);
1337 int ssl3_alert_code(int code);
1338 int ssl_ok(SSL *s);
1339
1340 #  ifndef OPENSSL_NO_ECDH
1341 int ssl_check_srvr_ecc_cert_and_alg(X509 *x, SSL *s);
1342 #  endif
1343
1344 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
1345
1346 #  ifndef OPENSSL_NO_EC
1347 int tls1_ec_curve_id2nid(int curve_id);
1348 int tls1_ec_nid2curve_id(int nid);
1349 int tls1_check_curve(SSL *s, const unsigned char *p, size_t len);
1350 int tls1_shared_curve(SSL *s, int nmatch);
1351 int tls1_set_curves(unsigned char **pext, size_t *pextlen,
1352                     int *curves, size_t ncurves);
1353 int tls1_set_curves_list(unsigned char **pext, size_t *pextlen,
1354                          const char *str);
1355 #   ifndef OPENSSL_NO_ECDH
1356 int tls1_check_ec_tmp_key(SSL *s, unsigned long id);
1357 #   endif                       /* OPENSSL_NO_ECDH */
1358 #  endif                        /* OPENSSL_NO_EC */
1359
1360 #  ifndef OPENSSL_NO_TLSEXT
1361 int tls1_shared_list(SSL *s,
1362                      const unsigned char *l1, size_t l1len,
1363                      const unsigned char *l2, size_t l2len, int nmatch);
1364 unsigned char *ssl_add_clienthello_tlsext(SSL *s, unsigned char *buf,
1365                                           unsigned char *limit, int *al);
1366 unsigned char *ssl_add_serverhello_tlsext(SSL *s, unsigned char *buf,
1367                                           unsigned char *limit, int *al);
1368 int ssl_parse_clienthello_tlsext(SSL *s, unsigned char **data,
1369                                  unsigned char *d, int n);
1370 int tls1_set_server_sigalgs(SSL *s);
1371 int ssl_check_clienthello_tlsext_late(SSL *s);
1372 int ssl_parse_serverhello_tlsext(SSL *s, unsigned char **data,
1373                                  unsigned char *d, int n);
1374 int ssl_prepare_clienthello_tlsext(SSL *s);
1375 int ssl_prepare_serverhello_tlsext(SSL *s);
1376
1377 #   ifndef OPENSSL_NO_HEARTBEATS
1378 int tls1_heartbeat(SSL *s);
1379 int dtls1_heartbeat(SSL *s);
1380 int tls1_process_heartbeat(SSL *s);
1381 int dtls1_process_heartbeat(SSL *s);
1382 #   endif
1383
1384 #   ifdef OPENSSL_NO_SHA256
1385 #    define tlsext_tick_md  EVP_sha1
1386 #   else
1387 #    define tlsext_tick_md  EVP_sha256
1388 #   endif
1389 int tls1_process_ticket(SSL *s, unsigned char *session_id, int len,
1390                         const unsigned char *limit, SSL_SESSION **ret);
1391
1392 int tls12_get_sigandhash(unsigned char *p, const EVP_PKEY *pk,
1393                          const EVP_MD *md);
1394 int tls12_get_sigid(const EVP_PKEY *pk);
1395 const EVP_MD *tls12_get_hash(unsigned char hash_alg);
1396
1397 int tls1_set_sigalgs_list(CERT *c, const char *str, int client);
1398 int tls1_set_sigalgs(CERT *c, const int *salg, size_t salglen, int client);
1399 int tls1_check_chain(SSL *s, X509 *x, EVP_PKEY *pk, STACK_OF(X509) *chain,
1400                      int idx);
1401 void tls1_set_cert_validity(SSL *s);
1402
1403 #  endif
1404 EVP_MD_CTX *ssl_replace_hash(EVP_MD_CTX **hash, const EVP_MD *md);
1405 void ssl_clear_hash_ctx(EVP_MD_CTX **hash);
1406 int ssl_add_serverhello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
1407                                         int maxlen);
1408 int ssl_parse_serverhello_renegotiate_ext(SSL *s, unsigned char *d, int len,
1409                                           int *al);
1410 int ssl_add_clienthello_renegotiate_ext(SSL *s, unsigned char *p, int *len,
1411                                         int maxlen);
1412 int ssl_parse_clienthello_renegotiate_ext(SSL *s, unsigned char *d, int len,
1413                                           int *al);
1414 long ssl_get_algorithm2(SSL *s);
1415 int tls1_save_sigalgs(SSL *s, const unsigned char *data, int dsize);
1416 int tls1_process_sigalgs(SSL *s);
1417 size_t tls12_get_psigalgs(SSL *s, const unsigned char **psigs);
1418 int tls12_check_peer_sigalg(const EVP_MD **pmd, SSL *s,
1419                             const unsigned char *sig, EVP_PKEY *pkey);
1420 void ssl_set_client_disabled(SSL *s);
1421
1422 int ssl_add_clienthello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
1423                                      int maxlen);
1424 int ssl_parse_clienthello_use_srtp_ext(SSL *s, unsigned char *d, int len,
1425                                        int *al);
1426 int ssl_add_serverhello_use_srtp_ext(SSL *s, unsigned char *p, int *len,
1427                                      int maxlen);
1428 int ssl_parse_serverhello_use_srtp_ext(SSL *s, unsigned char *d, int len,
1429                                        int *al);
1430
1431 /* s3_cbc.c */
1432 void ssl3_cbc_copy_mac(unsigned char *out,
1433                        const SSL3_RECORD *rec,
1434                        unsigned md_size, unsigned orig_len);
1435 int ssl3_cbc_remove_padding(const SSL *s,
1436                             SSL3_RECORD *rec,
1437                             unsigned block_size, unsigned mac_size);
1438 int tls1_cbc_remove_padding(const SSL *s,
1439                             SSL3_RECORD *rec,
1440                             unsigned block_size, unsigned mac_size);
1441 char ssl3_cbc_record_digest_supported(const EVP_MD_CTX *ctx);
1442 void ssl3_cbc_digest_record(const EVP_MD_CTX *ctx,
1443                             unsigned char *md_out,
1444                             size_t *md_out_size,
1445                             const unsigned char header[13],
1446                             const unsigned char *data,
1447                             size_t data_plus_mac_size,
1448                             size_t data_plus_mac_plus_padding_size,
1449                             const unsigned char *mac_secret,
1450                             unsigned mac_secret_length, char is_sslv3);
1451
1452 void tls_fips_digest_extra(const EVP_CIPHER_CTX *cipher_ctx,
1453                            EVP_MD_CTX *mac_ctx, const unsigned char *data,
1454                            size_t data_len, size_t orig_len);
1455
1456 int srp_verify_server_param(SSL *s, int *al);
1457
1458 /* t1_ext.c */
1459
1460 void custom_ext_init(custom_ext_methods *meths);
1461
1462 int custom_ext_parse(SSL *s, int server,
1463                      unsigned int ext_type,
1464                      const unsigned char *ext_data, size_t ext_size, int *al);
1465 int custom_ext_add(SSL *s, int server,
1466                    unsigned char **pret, unsigned char *limit, int *al);
1467
1468 int custom_exts_copy(custom_ext_methods *dst, const custom_ext_methods *src);
1469 void custom_exts_free(custom_ext_methods *exts);
1470
1471 # else
1472
1473 #  define ssl_init_wbio_buffer SSL_test_functions()->p_ssl_init_wbio_buffer
1474 #  define ssl3_setup_buffers SSL_test_functions()->p_ssl3_setup_buffers
1475 #  define tls1_process_heartbeat SSL_test_functions()->p_tls1_process_heartbeat
1476 #  define dtls1_process_heartbeat SSL_test_functions()->p_dtls1_process_heartbeat
1477
1478 # endif
1479 #endif