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