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