Ignore zero length constructed segments.
[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-2006 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 #ifndef HEADER_SSL_LOCL_H
118 #define HEADER_SSL_LOCL_H
119 #include <stdlib.h>
120 #include <time.h>
121 #include <string.h>
122 #include <errno.h>
123
124 #include "e_os.h"
125
126 #include <openssl/buffer.h>
127 #include <openssl/comp.h>
128 #include <openssl/bio.h>
129 #include <openssl/stack.h>
130 #ifndef OPENSSL_NO_RSA
131 #include <openssl/rsa.h>
132 #endif
133 #ifndef OPENSSL_NO_DSA
134 #include <openssl/dsa.h>
135 #endif
136 #include <openssl/err.h>
137 #include <openssl/ssl.h>
138 #include <openssl/symhacks.h>
139
140 #ifdef OPENSSL_BUILD_SHLIBSSL
141 # undef OPENSSL_EXTERN
142 # define OPENSSL_EXTERN OPENSSL_EXPORT
143 #endif
144
145 #define PKCS1_CHECK
146
147 #define c2l(c,l)        (l = ((unsigned long)(*((c)++)))     , \
148                          l|=(((unsigned long)(*((c)++)))<< 8), \
149                          l|=(((unsigned long)(*((c)++)))<<16), \
150                          l|=(((unsigned long)(*((c)++)))<<24))
151
152 /* NOTE - c is not incremented as per c2l */
153 #define c2ln(c,l1,l2,n) { \
154                         c+=n; \
155                         l1=l2=0; \
156                         switch (n) { \
157                         case 8: l2 =((unsigned long)(*(--(c))))<<24; \
158                         case 7: l2|=((unsigned long)(*(--(c))))<<16; \
159                         case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
160                         case 5: l2|=((unsigned long)(*(--(c))));     \
161                         case 4: l1 =((unsigned long)(*(--(c))))<<24; \
162                         case 3: l1|=((unsigned long)(*(--(c))))<<16; \
163                         case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
164                         case 1: l1|=((unsigned long)(*(--(c))));     \
165                                 } \
166                         }
167
168 #define l2c(l,c)        (*((c)++)=(unsigned char)(((l)    )&0xff), \
169                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
170                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
171                          *((c)++)=(unsigned char)(((l)>>24)&0xff))
172
173 #define n2l(c,l)        (l =((unsigned long)(*((c)++)))<<24, \
174                          l|=((unsigned long)(*((c)++)))<<16, \
175                          l|=((unsigned long)(*((c)++)))<< 8, \
176                          l|=((unsigned long)(*((c)++))))
177
178 #define l2n(l,c)        (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
179                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
180                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
181                          *((c)++)=(unsigned char)(((l)    )&0xff))
182
183 #define l2n6(l,c)       (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
184                          *((c)++)=(unsigned char)(((l)>>32)&0xff), \
185                          *((c)++)=(unsigned char)(((l)>>24)&0xff), \
186                          *((c)++)=(unsigned char)(((l)>>16)&0xff), \
187                          *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
188                          *((c)++)=(unsigned char)(((l)    )&0xff))
189
190 #define n2l6(c,l)       (l =((BN_ULLONG)(*((c)++)))<<40, \
191                          l|=((BN_ULLONG)(*((c)++)))<<32, \
192                          l|=((BN_ULLONG)(*((c)++)))<<24, \
193                          l|=((BN_ULLONG)(*((c)++)))<<16, \
194                          l|=((BN_ULLONG)(*((c)++)))<< 8, \
195                          l|=((BN_ULLONG)(*((c)++))))
196
197 /* NOTE - c is not incremented as per l2c */
198 #define l2cn(l1,l2,c,n) { \
199                         c+=n; \
200                         switch (n) { \
201                         case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
202                         case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
203                         case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
204                         case 5: *(--(c))=(unsigned char)(((l2)    )&0xff); \
205                         case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
206                         case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
207                         case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
208                         case 1: *(--(c))=(unsigned char)(((l1)    )&0xff); \
209                                 } \
210                         }
211
212 #define n2s(c,s)        ((s=(((unsigned int)(c[0]))<< 8)| \
213                             (((unsigned int)(c[1]))    )),c+=2)
214 #define s2n(s,c)        ((c[0]=(unsigned char)(((s)>> 8)&0xff), \
215                           c[1]=(unsigned char)(((s)    )&0xff)),c+=2)
216
217 #define n2l3(c,l)       ((l =(((unsigned long)(c[0]))<<16)| \
218                              (((unsigned long)(c[1]))<< 8)| \
219                              (((unsigned long)(c[2]))    )),c+=3)
220
221 #define l2n3(l,c)       ((c[0]=(unsigned char)(((l)>>16)&0xff), \
222                           c[1]=(unsigned char)(((l)>> 8)&0xff), \
223                           c[2]=(unsigned char)(((l)    )&0xff)),c+=3)
224
225 /* LOCAL STUFF */
226
227 #define SSL_DECRYPT     0
228 #define SSL_ENCRYPT     1
229
230 #define TWO_BYTE_BIT    0x80
231 #define SEC_ESC_BIT     0x40
232 #define TWO_BYTE_MASK   0x7fff
233 #define THREE_BYTE_MASK 0x3fff
234
235 #define INC32(a)        ((a)=((a)+1)&0xffffffffL)
236 #define DEC32(a)        ((a)=((a)-1)&0xffffffffL)
237 #define MAX_MAC_SIZE    20 /* up from 16 for SSLv3 */
238
239 /*
240  * Define the Bitmasks for SSL_CIPHER.algorithms.
241  * This bits are used packed as dense as possible. If new methods/ciphers
242  * etc will be added, the bits a likely to change, so this information
243  * is for internal library use only, even though SSL_CIPHER.algorithms
244  * can be publicly accessed.
245  * Use the according functions for cipher management instead.
246  *
247  * The bit mask handling in the selection and sorting scheme in
248  * ssl_create_cipher_list() has only limited capabilities, reflecting
249  * that the different entities within are mutually exclusive:
250  * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
251  */
252 #define SSL_MKEY_MASK           0x000000FFL
253 #define SSL_kRSA                0x00000001L /* RSA key exchange */
254 #define SSL_kDHr                0x00000002L /* DH cert RSA CA cert */
255 #define SSL_kDHd                0x00000004L /* DH cert DSA CA cert */
256 #define SSL_kFZA                0x00000008L
257 #define SSL_kEDH                0x00000010L /* tmp DH key no DH cert */
258 #define SSL_kKRB5               0x00000020L /* Kerberos5 key exchange */
259 #define SSL_kECDH               0x00000040L /* ECDH w/ long-term keys */
260 #define SSL_kECDHE              0x00000080L /* ephemeral ECDH */
261 #define SSL_EDH                 (SSL_kEDH|(SSL_AUTH_MASK^SSL_aNULL))
262
263 #define SSL_AUTH_MASK           0x00007F00L
264 #define SSL_aRSA                0x00000100L /* Authenticate with RSA */
265 #define SSL_aDSS                0x00000200L /* Authenticate with DSS */
266 #define SSL_DSS                 SSL_aDSS
267 #define SSL_aFZA                0x00000400L
268 #define SSL_aNULL               0x00000800L /* no Authenticate, ADH */
269 #define SSL_aDH                 0x00001000L /* no Authenticate, ADH */
270 #define SSL_aKRB5               0x00002000L /* Authenticate with KRB5 */
271 #define SSL_aECDSA              0x00004000L /* Authenticate with ECDSA */
272
273 #define SSL_NULL                (SSL_eNULL)
274 #define SSL_ADH                 (SSL_kEDH|SSL_aNULL)
275 #define SSL_RSA                 (SSL_kRSA|SSL_aRSA)
276 #define SSL_DH                  (SSL_kDHr|SSL_kDHd|SSL_kEDH)
277 #define SSL_ECDH                (SSL_kECDH|SSL_kECDHE)
278 #define SSL_FZA                 (SSL_aFZA|SSL_kFZA|SSL_eFZA)
279 #define SSL_KRB5                (SSL_kKRB5|SSL_aKRB5)
280
281 #define SSL_ENC_MASK            0x043F8000L
282 #define SSL_DES                 0x00008000L
283 #define SSL_3DES                0x00010000L
284 #define SSL_RC4                 0x00020000L
285 #define SSL_RC2                 0x00040000L
286 #define SSL_IDEA                0x00080000L
287 #define SSL_eFZA                0x00100000L
288 #define SSL_eNULL               0x00200000L
289 #define SSL_AES                 0x04000000L
290
291 #define SSL_MAC_MASK            0x00c00000L
292 #define SSL_MD5                 0x00400000L
293 #define SSL_SHA1                0x00800000L
294 #define SSL_SHA                 (SSL_SHA1)
295
296 #define SSL_SSL_MASK            0x03000000L
297 #define SSL_SSLV2               0x01000000L
298 #define SSL_SSLV3               0x02000000L
299 #define SSL_TLSV1               SSL_SSLV3       /* for now */
300
301 /* we have used 07ffffff - 5 bits left to go. */
302
303 /*
304  * Export and cipher strength information. For each cipher we have to decide
305  * whether it is exportable or not. This information is likely to change
306  * over time, since the export control rules are no static technical issue.
307  *
308  * Independent of the export flag the cipher strength is sorted into classes.
309  * SSL_EXP40 was denoting the 40bit US export limit of past times, which now
310  * is at 56bit (SSL_EXP56). If the exportable cipher class is going to change
311  * again (eg. to 64bit) the use of "SSL_EXP*" becomes blurred even more,
312  * since SSL_EXP64 could be similar to SSL_LOW.
313  * For this reason SSL_MICRO and SSL_MINI macros are included to widen the
314  * namespace of SSL_LOW-SSL_HIGH to lower values. As development of speed
315  * and ciphers goes, another extension to SSL_SUPER and/or SSL_ULTRA would
316  * be possible.
317  */
318 #define SSL_EXP_MASK            0x00000003L
319 #define SSL_NOT_EXP             0x00000001L
320 #define SSL_EXPORT              0x00000002L
321
322 #define SSL_STRONG_MASK         0x000000fcL
323 #define SSL_STRONG_NONE         0x00000004L
324 #define SSL_EXP40               0x00000008L
325 #define SSL_MICRO               (SSL_EXP40)
326 #define SSL_EXP56               0x00000010L
327 #define SSL_MINI                (SSL_EXP56)
328 #define SSL_LOW                 0x00000020L
329 #define SSL_MEDIUM              0x00000040L
330 #define SSL_HIGH                0x00000080L
331
332 /* we have used 000000ff - 24 bits left to go */
333
334 /*
335  * Macros to check the export status and cipher strength for export ciphers.
336  * Even though the macros for EXPORT and EXPORT40/56 have similar names,
337  * their meaning is different:
338  * *_EXPORT macros check the 'exportable' status.
339  * *_EXPORT40/56 macros are used to check whether a certain cipher strength
340  *          is given.
341  * Since the SSL_IS_EXPORT* and SSL_EXPORT* macros depend on the correct
342  * algorithm structure element to be passed (algorithms, algo_strength) and no
343  * typechecking can be done as they are all of type unsigned long, their
344  * direct usage is discouraged.
345  * Use the SSL_C_* macros instead.
346  */
347 #define SSL_IS_EXPORT(a)        ((a)&SSL_EXPORT)
348 #define SSL_IS_EXPORT56(a)      ((a)&SSL_EXP56)
349 #define SSL_IS_EXPORT40(a)      ((a)&SSL_EXP40)
350 #define SSL_C_IS_EXPORT(c)      SSL_IS_EXPORT((c)->algo_strength)
351 #define SSL_C_IS_EXPORT56(c)    SSL_IS_EXPORT56((c)->algo_strength)
352 #define SSL_C_IS_EXPORT40(c)    SSL_IS_EXPORT40((c)->algo_strength)
353
354 #define SSL_EXPORT_KEYLENGTH(a,s)       (SSL_IS_EXPORT40(s) ? 5 : \
355                                  ((a)&SSL_ENC_MASK) == SSL_DES ? 8 : 7)
356 #define SSL_EXPORT_PKEYLENGTH(a) (SSL_IS_EXPORT40(a) ? 512 : 1024)
357 #define SSL_C_EXPORT_KEYLENGTH(c)       SSL_EXPORT_KEYLENGTH((c)->algorithms, \
358                                 (c)->algo_strength)
359 #define SSL_C_EXPORT_PKEYLENGTH(c)      SSL_EXPORT_PKEYLENGTH((c)->algo_strength)
360
361
362 #define SSL_ALL                 0xffffffffL
363 #define SSL_ALL_CIPHERS         (SSL_MKEY_MASK|SSL_AUTH_MASK|SSL_ENC_MASK|\
364                                 SSL_MAC_MASK)
365 #define SSL_ALL_STRENGTHS       (SSL_EXP_MASK|SSL_STRONG_MASK)
366
367 /* Mostly for SSLv3 */
368 #define SSL_PKEY_RSA_ENC        0
369 #define SSL_PKEY_RSA_SIGN       1
370 #define SSL_PKEY_DSA_SIGN       2
371 #define SSL_PKEY_DH_RSA         3
372 #define SSL_PKEY_DH_DSA         4
373 #define SSL_PKEY_ECC            5
374 #define SSL_PKEY_NUM            6
375
376 /* SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
377  *          <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
378  * SSL_kDH  <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
379  * SSL_kEDH <- RSA_ENC | RSA_SIGN | DSA_SIGN
380  * SSL_aRSA <- RSA_ENC | RSA_SIGN
381  * SSL_aDSS <- DSA_SIGN
382  */
383
384 /*
385 #define CERT_INVALID            0
386 #define CERT_PUBLIC_KEY         1
387 #define CERT_PRIVATE_KEY        2
388 */
389
390 #ifndef OPENSSL_NO_EC
391 /* From ECC-TLS draft, used in encoding the curve type in 
392  * ECParameters
393  */
394 #define EXPLICIT_PRIME_CURVE_TYPE  1   
395 #define EXPLICIT_CHAR2_CURVE_TYPE  2
396 #define NAMED_CURVE_TYPE           3
397 #endif  /* OPENSSL_NO_EC */
398
399 typedef struct cert_pkey_st
400         {
401         X509 *x509;
402         EVP_PKEY *privatekey;
403         } CERT_PKEY;
404
405 typedef struct cert_st
406         {
407         /* Current active set */
408         CERT_PKEY *key; /* ALWAYS points to an element of the pkeys array
409                          * Probably it would make more sense to store
410                          * an index, not a pointer. */
411  
412         /* The following masks are for the key and auth
413          * algorithms that are supported by the certs below */
414         int valid;
415         unsigned long mask;
416         unsigned long export_mask;
417 #ifndef OPENSSL_NO_RSA
418         RSA *rsa_tmp;
419         RSA *(*rsa_tmp_cb)(SSL *ssl,int is_export,int keysize);
420 #endif
421 #ifndef OPENSSL_NO_DH
422         DH *dh_tmp;
423         DH *(*dh_tmp_cb)(SSL *ssl,int is_export,int keysize);
424 #endif
425 #ifndef OPENSSL_NO_ECDH
426         EC_KEY *ecdh_tmp;
427         /* Callback for generating ephemeral ECDH keys */
428         EC_KEY *(*ecdh_tmp_cb)(SSL *ssl,int is_export,int keysize);
429 #endif
430
431         CERT_PKEY pkeys[SSL_PKEY_NUM];
432
433         int references; /* >1 only if SSL_copy_session_id is used */
434         } CERT;
435
436
437 typedef struct sess_cert_st
438         {
439         STACK_OF(X509) *cert_chain; /* as received from peer (not for SSL2) */
440
441         /* The 'peer_...' members are used only by clients. */
442         int peer_cert_type;
443
444         CERT_PKEY *peer_key; /* points to an element of peer_pkeys (never NULL!) */
445         CERT_PKEY peer_pkeys[SSL_PKEY_NUM];
446         /* Obviously we don't have the private keys of these,
447          * so maybe we shouldn't even use the CERT_PKEY type here. */
448
449 #ifndef OPENSSL_NO_RSA
450         RSA *peer_rsa_tmp; /* not used for SSL 2 */
451 #endif
452 #ifndef OPENSSL_NO_DH
453         DH *peer_dh_tmp; /* not used for SSL 2 */
454 #endif
455 #ifndef OPENSSL_NO_ECDH
456         EC_KEY *peer_ecdh_tmp;
457 #endif
458
459         int references; /* actually always 1 at the moment */
460         } SESS_CERT;
461
462
463 /*#define MAC_DEBUG     */
464
465 /*#define ERR_DEBUG     */
466 /*#define ABORT_DEBUG   */
467 /*#define PKT_DEBUG 1   */
468 /*#define DES_DEBUG     */
469 /*#define DES_OFB_DEBUG */
470 /*#define SSL_DEBUG     */
471 /*#define RSA_DEBUG     */ 
472 /*#define IDEA_DEBUG    */ 
473
474 #define FP_ICC  (int (*)(const void *,const void *))
475 #define ssl_put_cipher_by_char(ssl,ciph,ptr) \
476                 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
477 #define ssl_get_cipher_by_char(ssl,ptr) \
478                 ((ssl)->method->get_cipher_by_char(ptr))
479
480 /* This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff
481  * It is a bit of a mess of functions, but hell, think of it as
482  * an opaque structure :-) */
483 typedef struct ssl3_enc_method
484         {
485         int (*enc)(SSL *, int);
486         int (*mac)(SSL *, unsigned char *, int);
487         int (*setup_key_block)(SSL *);
488         int (*generate_master_secret)(SSL *, unsigned char *, unsigned char *, int);
489         int (*change_cipher_state)(SSL *, int);
490         int (*final_finish_mac)(SSL *, EVP_MD_CTX *, EVP_MD_CTX *, const char *, int, unsigned char *);
491         int finish_mac_length;
492         int (*cert_verify_mac)(SSL *, EVP_MD_CTX *, unsigned char *);
493         const char *client_finished_label;
494         int client_finished_label_len;
495         const char *server_finished_label;
496         int server_finished_label_len;
497         int (*alert_value)(int);
498         } SSL3_ENC_METHOD;
499
500 /* Used for holding the relevant compression methods loaded into SSL_CTX */
501 typedef struct ssl3_comp_st
502         {
503         int comp_id;    /* The identifier byte for this compression type */
504         char *name;     /* Text name used for the compression type */
505         COMP_METHOD *method; /* The method :-) */
506         } SSL3_COMP;
507
508 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
509 OPENSSL_EXTERN SSL_CIPHER ssl2_ciphers[];
510 OPENSSL_EXTERN SSL_CIPHER ssl3_ciphers[];
511
512
513 SSL_METHOD *ssl_bad_method(int ver);
514
515 extern SSL3_ENC_METHOD TLSv1_enc_data;
516 extern SSL3_ENC_METHOD SSLv3_enc_data;
517 extern SSL3_ENC_METHOD DTLSv1_enc_data;
518
519 #define IMPLEMENT_tls1_meth_func(func_name, s_accept, s_connect, s_get_meth) \
520 const SSL_METHOD *func_name(void)  \
521         { \
522         static const SSL_METHOD func_name##_data= { \
523                 TLS1_VERSION, \
524                 tls1_new, \
525                 tls1_clear, \
526                 tls1_free, \
527                 s_accept, \
528                 s_connect, \
529                 ssl3_read, \
530                 ssl3_peek, \
531                 ssl3_write, \
532                 ssl3_shutdown, \
533                 ssl3_renegotiate, \
534                 ssl3_renegotiate_check, \
535                 ssl3_get_message, \
536                 ssl3_read_bytes, \
537                 ssl3_write_bytes, \
538                 ssl3_dispatch_alert, \
539                 ssl3_ctrl, \
540                 ssl3_ctx_ctrl, \
541                 ssl3_get_cipher_by_char, \
542                 ssl3_put_cipher_by_char, \
543                 ssl3_pending, \
544                 ssl3_num_ciphers, \
545                 ssl3_get_cipher, \
546                 s_get_meth, \
547                 tls1_default_timeout, \
548                 &TLSv1_enc_data, \
549                 ssl_undefined_void_function, \
550                 ssl3_callback_ctrl, \
551                 ssl3_ctx_callback_ctrl, \
552         }; \
553         return &func_name##_data; \
554         }
555
556 #define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect, s_get_meth) \
557 const SSL_METHOD *func_name(void)  \
558         { \
559         static const SSL_METHOD func_name##_data= { \
560                 SSL3_VERSION, \
561                 ssl3_new, \
562                 ssl3_clear, \
563                 ssl3_free, \
564                 s_accept, \
565                 s_connect, \
566                 ssl3_read, \
567                 ssl3_peek, \
568                 ssl3_write, \
569                 ssl3_shutdown, \
570                 ssl3_renegotiate, \
571                 ssl3_renegotiate_check, \
572                 ssl3_get_message, \
573                 ssl3_read_bytes, \
574                 ssl3_write_bytes, \
575                 ssl3_dispatch_alert, \
576                 ssl3_ctrl, \
577                 ssl3_ctx_ctrl, \
578                 ssl3_get_cipher_by_char, \
579                 ssl3_put_cipher_by_char, \
580                 ssl3_pending, \
581                 ssl3_num_ciphers, \
582                 ssl3_get_cipher, \
583                 s_get_meth, \
584                 ssl3_default_timeout, \
585                 &SSLv3_enc_data, \
586                 ssl_undefined_void_function, \
587                 ssl3_callback_ctrl, \
588                 ssl3_ctx_callback_ctrl, \
589         }; \
590         return &func_name##_data; \
591         }
592
593 #define IMPLEMENT_ssl23_meth_func(func_name, s_accept, s_connect, s_get_meth) \
594 const SSL_METHOD *func_name(void)  \
595         { \
596         static const SSL_METHOD func_name##_data= { \
597         TLS1_VERSION, \
598         tls1_new, \
599         tls1_clear, \
600         tls1_free, \
601         s_accept, \
602         s_connect, \
603         ssl23_read, \
604         ssl23_peek, \
605         ssl23_write, \
606         ssl_undefined_function, \
607         ssl_undefined_function, \
608         ssl_ok, \
609         ssl3_get_message, \
610         ssl3_read_bytes, \
611         ssl3_write_bytes, \
612         ssl3_dispatch_alert, \
613         ssl3_ctrl, \
614         ssl3_ctx_ctrl, \
615         ssl23_get_cipher_by_char, \
616         ssl23_put_cipher_by_char, \
617         ssl_undefined_const_function, \
618         ssl23_num_ciphers, \
619         ssl23_get_cipher, \
620         s_get_meth, \
621         ssl23_default_timeout, \
622         &ssl3_undef_enc_method, \
623         ssl_undefined_void_function, \
624         ssl3_callback_ctrl, \
625         ssl3_ctx_callback_ctrl, \
626         }; \
627         return &func_name##_data; \
628         }
629
630 #define IMPLEMENT_ssl2_meth_func(func_name, s_accept, s_connect, s_get_meth) \
631 const SSL_METHOD *func_name(void)  \
632         { \
633         static const SSL_METHOD func_name##_data= { \
634                 SSL2_VERSION, \
635                 ssl2_new,       /* local */ \
636                 ssl2_clear,     /* local */ \
637                 ssl2_free,      /* local */ \
638                 s_accept, \
639                 s_connect, \
640                 ssl2_read, \
641                 ssl2_peek, \
642                 ssl2_write, \
643                 ssl2_shutdown, \
644                 ssl_ok, /* NULL - renegotiate */ \
645                 ssl_ok, /* NULL - check renegotiate */ \
646                 NULL, /* NULL - ssl_get_message */ \
647                 NULL, /* NULL - ssl_get_record */ \
648                 NULL, /* NULL - ssl_write_bytes */ \
649                 NULL, /* NULL - dispatch_alert */ \
650                 ssl2_ctrl,      /* local */ \
651                 ssl2_ctx_ctrl,  /* local */ \
652                 ssl2_get_cipher_by_char, \
653                 ssl2_put_cipher_by_char, \
654                 ssl2_pending, \
655                 ssl2_num_ciphers, \
656                 ssl2_get_cipher, \
657                 s_get_meth, \
658                 ssl2_default_timeout, \
659                 &ssl3_undef_enc_method, \
660                 ssl_undefined_void_function, \
661                 ssl2_callback_ctrl,     /* local */ \
662                 ssl2_ctx_callback_ctrl, /* local */ \
663         }; \
664         return &func_name##_data; \
665         }
666
667 #define IMPLEMENT_dtls1_meth_func(func_name, s_accept, s_connect, s_get_meth) \
668 const SSL_METHOD *func_name(void)  \
669         { \
670         static const SSL_METHOD func_name##_data= { \
671                 DTLS1_VERSION, \
672                 dtls1_new, \
673                 dtls1_clear, \
674                 dtls1_free, \
675                 s_accept, \
676                 s_connect, \
677                 ssl3_read, \
678                 ssl3_peek, \
679                 ssl3_write, \
680                 ssl3_shutdown, \
681                 ssl3_renegotiate, \
682                 ssl3_renegotiate_check, \
683                 dtls1_get_message, \
684                 dtls1_read_bytes, \
685                 dtls1_write_app_data_bytes, \
686                 dtls1_dispatch_alert, \
687                 ssl3_ctrl, \
688                 ssl3_ctx_ctrl, \
689                 ssl3_get_cipher_by_char, \
690                 ssl3_put_cipher_by_char, \
691                 ssl3_pending, \
692                 ssl3_num_ciphers, \
693                 ssl3_get_cipher, \
694                 s_get_meth, \
695                 dtls1_default_timeout, \
696                 &DTLSv1_enc_data, \
697                 ssl_undefined_void_function, \
698                 ssl3_callback_ctrl, \
699                 ssl3_ctx_callback_ctrl, \
700         }; \
701         return &func_name##_data; \
702         }
703
704 void ssl_clear_cipher_ctx(SSL *s);
705 int ssl_clear_bad_session(SSL *s);
706 CERT *ssl_cert_new(void);
707 CERT *ssl_cert_dup(CERT *cert);
708 int ssl_cert_inst(CERT **o);
709 void ssl_cert_free(CERT *c);
710 SESS_CERT *ssl_sess_cert_new(void);
711 void ssl_sess_cert_free(SESS_CERT *sc);
712 int ssl_set_peer_cert_type(SESS_CERT *c, int type);
713 int ssl_get_new_session(SSL *s, int session);
714 int ssl_get_prev_session(SSL *s, unsigned char *session,int len);
715 int ssl_cipher_id_cmp(const SSL_CIPHER *a,const SSL_CIPHER *b);
716 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER * const *ap,
717                         const SSL_CIPHER * const *bp);
718 STACK_OF(SSL_CIPHER) *ssl_bytes_to_cipher_list(SSL *s,unsigned char *p,int num,
719                                                STACK_OF(SSL_CIPHER) **skp);
720 int ssl_cipher_list_to_bytes(SSL *s,STACK_OF(SSL_CIPHER) *sk,unsigned char *p,
721                              int (*put_cb)(const SSL_CIPHER *, unsigned char *));
722 STACK_OF(SSL_CIPHER) *ssl_create_cipher_list(const SSL_METHOD *meth,
723                                              STACK_OF(SSL_CIPHER) **pref,
724                                              STACK_OF(SSL_CIPHER) **sorted,
725                                              const char *rule_str);
726 void ssl_update_cache(SSL *s, int mode);
727 int ssl_cipher_get_evp(const SSL_SESSION *s,const EVP_CIPHER **enc,
728                        const EVP_MD **md,SSL_COMP **comp);
729 int ssl_verify_cert_chain(SSL *s,STACK_OF(X509) *sk);
730 int ssl_undefined_function(SSL *s);
731 int ssl_undefined_void_function(void);
732 int ssl_undefined_const_function(const SSL *s);
733 X509 *ssl_get_server_send_cert(SSL *);
734 EVP_PKEY *ssl_get_sign_pkey(SSL *,SSL_CIPHER *);
735 int ssl_cert_type(X509 *x,EVP_PKEY *pkey);
736 void ssl_set_cert_masks(CERT *c, SSL_CIPHER *cipher);
737 STACK_OF(SSL_CIPHER) *ssl_get_ciphers_by_id(SSL *s);
738 int ssl_verify_alarm_type(long type);
739 void ssl_load_ciphers(void);
740
741 int ssl2_enc_init(SSL *s, int client);
742 int ssl2_generate_key_material(SSL *s);
743 void ssl2_enc(SSL *s,int send_data);
744 void ssl2_mac(SSL *s,unsigned char *mac,int send_data);
745 SSL_CIPHER *ssl2_get_cipher_by_char(const unsigned char *p);
746 int ssl2_put_cipher_by_char(const SSL_CIPHER *c,unsigned char *p);
747 int ssl2_part_read(SSL *s, unsigned long f, int i);
748 int ssl2_do_write(SSL *s);
749 int ssl2_set_certificate(SSL *s, int type, int len, const unsigned char *data);
750 void ssl2_return_error(SSL *s,int reason);
751 void ssl2_write_error(SSL *s);
752 int ssl2_num_ciphers(void);
753 SSL_CIPHER *ssl2_get_cipher(unsigned int u);
754 int     ssl2_new(SSL *s);
755 void    ssl2_free(SSL *s);
756 int     ssl2_accept(SSL *s);
757 int     ssl2_connect(SSL *s);
758 int     ssl2_read(SSL *s, void *buf, int len);
759 int     ssl2_peek(SSL *s, void *buf, int len);
760 int     ssl2_write(SSL *s, const void *buf, int len);
761 int     ssl2_shutdown(SSL *s);
762 void    ssl2_clear(SSL *s);
763 long    ssl2_ctrl(SSL *s,int cmd, long larg, void *parg);
764 long    ssl2_ctx_ctrl(SSL_CTX *s,int cmd, long larg, void *parg);
765 long    ssl2_callback_ctrl(SSL *s,int cmd, void (*fp)(void));
766 long    ssl2_ctx_callback_ctrl(SSL_CTX *s,int cmd, void (*fp)(void));
767 int     ssl2_pending(const SSL *s);
768 long    ssl2_default_timeout(void );
769
770 SSL_CIPHER *ssl3_get_cipher_by_char(const unsigned char *p);
771 int ssl3_put_cipher_by_char(const SSL_CIPHER *c,unsigned char *p);
772 void ssl3_init_finished_mac(SSL *s);
773 int ssl3_send_server_certificate(SSL *s);
774 int ssl3_get_finished(SSL *s,int state_a,int state_b);
775 int ssl3_setup_key_block(SSL *s);
776 int ssl3_send_change_cipher_spec(SSL *s,int state_a,int state_b);
777 int ssl3_change_cipher_state(SSL *s,int which);
778 void ssl3_cleanup_key_block(SSL *s);
779 int ssl3_do_write(SSL *s,int type);
780 void ssl3_send_alert(SSL *s,int level, int desc);
781 int ssl3_generate_master_secret(SSL *s, unsigned char *out,
782         unsigned char *p, int len);
783 int ssl3_get_req_cert_type(SSL *s,unsigned char *p);
784 long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
785 int ssl3_send_finished(SSL *s, int a, int b, const char *sender,int slen);
786 int ssl3_num_ciphers(void);
787 SSL_CIPHER *ssl3_get_cipher(unsigned int u);
788 int ssl3_renegotiate(SSL *ssl); 
789 int ssl3_renegotiate_check(SSL *ssl); 
790 int ssl3_dispatch_alert(SSL *s);
791 int ssl3_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
792 int ssl3_write_bytes(SSL *s, int type, const void *buf, int len);
793 int ssl3_final_finish_mac(SSL *s, EVP_MD_CTX *ctx1, EVP_MD_CTX *ctx2,
794         const char *sender, int slen,unsigned char *p);
795 int ssl3_cert_verify_mac(SSL *s, EVP_MD_CTX *in, unsigned char *p);
796 void ssl3_finish_mac(SSL *s, const unsigned char *buf, int len);
797 int ssl3_enc(SSL *s, int send_data);
798 int ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
799 unsigned long ssl3_output_cert_chain(SSL *s, X509 *x);
800 SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,STACK_OF(SSL_CIPHER) *clnt,
801                                STACK_OF(SSL_CIPHER) *srvr);
802 int     ssl3_setup_buffers(SSL *s);
803 int     ssl3_new(SSL *s);
804 void    ssl3_free(SSL *s);
805 int     ssl3_accept(SSL *s);
806 int     ssl3_connect(SSL *s);
807 int     ssl3_read(SSL *s, void *buf, int len);
808 int     ssl3_peek(SSL *s, void *buf, int len);
809 int     ssl3_write(SSL *s, const void *buf, int len);
810 int     ssl3_shutdown(SSL *s);
811 void    ssl3_clear(SSL *s);
812 long    ssl3_ctrl(SSL *s,int cmd, long larg, void *parg);
813 long    ssl3_ctx_ctrl(SSL_CTX *s,int cmd, long larg, void *parg);
814 long    ssl3_callback_ctrl(SSL *s,int cmd, void (*fp)(void));
815 long    ssl3_ctx_callback_ctrl(SSL_CTX *s,int cmd, void (*fp)(void));
816 int     ssl3_pending(const SSL *s);
817
818 void ssl3_record_sequence_update(unsigned char *seq);
819 int ssl3_do_change_cipher_spec(SSL *ssl);
820 long ssl3_default_timeout(void );
821
822 int ssl23_num_ciphers(void );
823 SSL_CIPHER *ssl23_get_cipher(unsigned int u);
824 int ssl23_read(SSL *s, void *buf, int len);
825 int ssl23_peek(SSL *s, void *buf, int len);
826 int ssl23_write(SSL *s, const void *buf, int len);
827 int ssl23_put_cipher_by_char(const SSL_CIPHER *c, unsigned char *p);
828 SSL_CIPHER *ssl23_get_cipher_by_char(const unsigned char *p);
829 long ssl23_default_timeout(void );
830
831 long tls1_default_timeout(void);
832 int dtls1_do_write(SSL *s,int type);
833 int ssl3_read_n(SSL *s, int n, int max, int extend);
834 int dtls1_read_bytes(SSL *s, int type, unsigned char *buf, int len, int peek);
835 int ssl3_do_compress(SSL *ssl);
836 int ssl3_do_uncompress(SSL *ssl);
837 int ssl3_write_pending(SSL *s, int type, const unsigned char *buf,
838         unsigned int len);
839 unsigned char *dtls1_set_message_header(SSL *s, 
840         unsigned char *p, unsigned char mt,     unsigned long len, 
841         unsigned long frag_off, unsigned long frag_len);
842
843 int dtls1_write_app_data_bytes(SSL *s, int type, const void *buf, int len);
844 int dtls1_write_bytes(SSL *s, int type, const void *buf, int len);
845
846 int dtls1_send_change_cipher_spec(SSL *s, int a, int b);
847 int dtls1_send_finished(SSL *s, int a, int b, const char *sender, int slen);
848 unsigned long dtls1_output_cert_chain(SSL *s, X509 *x);
849 int dtls1_read_failed(SSL *s, int code);
850 int dtls1_buffer_message(SSL *s, int ccs);
851 int dtls1_retransmit_message(SSL *s, unsigned short seq, 
852         unsigned long frag_off, int *found);
853 void dtls1_clear_record_buffer(SSL *s);
854 void dtls1_get_message_header(unsigned char *data, struct hm_header_st *msg_hdr);
855 void dtls1_get_ccs_header(unsigned char *data, struct ccs_header_st *ccs_hdr);
856 void dtls1_reset_seq_numbers(SSL *s, int rw);
857 long dtls1_default_timeout(void);
858
859
860 /* some client-only functions */
861 int ssl3_client_hello(SSL *s);
862 int ssl3_get_server_hello(SSL *s);
863 int ssl3_get_certificate_request(SSL *s);
864 int ssl3_get_server_done(SSL *s);
865 int ssl3_send_client_verify(SSL *s);
866 int ssl3_send_client_certificate(SSL *s);
867 int ssl3_send_client_key_exchange(SSL *s);
868 int ssl3_get_key_exchange(SSL *s);
869 int ssl3_get_server_certificate(SSL *s);
870 int ssl3_check_cert_and_algorithm(SSL *s);
871
872 int dtls1_client_hello(SSL *s);
873 int dtls1_send_client_certificate(SSL *s);
874 int dtls1_send_client_key_exchange(SSL *s);
875 int dtls1_send_client_verify(SSL *s);
876
877 /* some server-only functions */
878 int ssl3_get_client_hello(SSL *s);
879 int ssl3_send_server_hello(SSL *s);
880 int ssl3_send_hello_request(SSL *s);
881 int ssl3_send_server_key_exchange(SSL *s);
882 int ssl3_send_certificate_request(SSL *s);
883 int ssl3_send_server_done(SSL *s);
884 int ssl3_check_client_hello(SSL *s);
885 int ssl3_get_client_certificate(SSL *s);
886 int ssl3_get_client_key_exchange(SSL *s);
887 int ssl3_get_cert_verify(SSL *s);
888
889 int dtls1_send_hello_request(SSL *s);
890 int dtls1_send_server_hello(SSL *s);
891 int dtls1_send_server_certificate(SSL *s);
892 int dtls1_send_server_key_exchange(SSL *s);
893 int dtls1_send_certificate_request(SSL *s);
894 int dtls1_send_server_done(SSL *s);
895
896
897
898 int ssl23_accept(SSL *s);
899 int ssl23_connect(SSL *s);
900 int ssl23_read_bytes(SSL *s, int n);
901 int ssl23_write_bytes(SSL *s);
902
903 int tls1_new(SSL *s);
904 void tls1_free(SSL *s);
905 void tls1_clear(SSL *s);
906 long tls1_ctrl(SSL *s,int cmd, long larg, void *parg);
907 long tls1_callback_ctrl(SSL *s,int cmd, void (*fp)(void));
908
909 int dtls1_new(SSL *s);
910 int     dtls1_accept(SSL *s);
911 int     dtls1_connect(SSL *s);
912 void dtls1_free(SSL *s);
913 void dtls1_clear(SSL *s);
914 long dtls1_ctrl(SSL *s,int cmd, long larg, void *parg);
915
916 long dtls1_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
917 int dtls1_get_record(SSL *s);
918 int do_dtls1_write(SSL *s, int type, const unsigned char *buf,
919         unsigned int len, int create_empty_fragement);
920 int dtls1_dispatch_alert(SSL *s);
921 int dtls1_enc(SSL *s, int snd);
922
923 int ssl_init_wbio_buffer(SSL *s, int push);
924 void ssl_free_wbio_buffer(SSL *s);
925
926 int tls1_change_cipher_state(SSL *s, int which);
927 int tls1_setup_key_block(SSL *s);
928 int tls1_enc(SSL *s, int snd);
929 int tls1_final_finish_mac(SSL *s, EVP_MD_CTX *in1_ctx, EVP_MD_CTX *in2_ctx,
930         const char *str, int slen, unsigned char *p);
931 int tls1_cert_verify_mac(SSL *s, EVP_MD_CTX *in, unsigned char *p);
932 int tls1_mac(SSL *ssl, unsigned char *md, int snd);
933 int tls1_generate_master_secret(SSL *s, unsigned char *out,
934         unsigned char *p, int len);
935 int tls1_alert_code(int code);
936 int ssl3_alert_code(int code);
937 int ssl_ok(SSL *s);
938
939 int check_srvr_ecc_cert_and_alg(X509 *x, SSL_CIPHER *cs);
940
941 SSL_COMP *ssl3_comp_find(STACK_OF(SSL_COMP) *sk, int n);
942
943 #ifndef OPENSSL_NO_TLSEXT
944 unsigned char *ssl_add_clienthello_tlsext(SSL *s, unsigned char *p, unsigned char *limit); 
945 unsigned char *ssl_add_serverhello_tlsext(SSL *s, unsigned char *p, unsigned char *limit); 
946 int ssl_parse_clienthello_tlsext(SSL *s, unsigned char **data, unsigned char *d, int n, int *al);
947 int ssl_parse_serverhello_tlsext(SSL *s, unsigned char **data, unsigned char *d, int n, int *al);
948 int ssl_check_tlsext(SSL *s, int is_server);
949 #endif
950 #endif