77747c4c1efd466a046b8b583cbf64fbfaa227b7
[openssl.git] / ssl / ssl3.h
1 /* ssl/ssl3.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-2002 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_SSL3_H 
118 #define HEADER_SSL3_H 
119
120 #ifndef OPENSSL_NO_COMP
121 #include <openssl/comp.h>
122 #endif
123 #include <openssl/buffer.h>
124 #include <openssl/evp.h>
125 #include <openssl/ssl.h>
126
127 #ifdef  __cplusplus
128 extern "C" {
129 #endif
130
131 /* Signalling cipher suite value: from draft-ietf-tls-renegotiation-03.txt */
132 #define SSL3_CK_SCSV                            0x030000FF
133
134 #define SSL3_CK_RSA_NULL_MD5                    0x03000001
135 #define SSL3_CK_RSA_NULL_SHA                    0x03000002
136 #define SSL3_CK_RSA_RC4_40_MD5                  0x03000003
137 #define SSL3_CK_RSA_RC4_128_MD5                 0x03000004
138 #define SSL3_CK_RSA_RC4_128_SHA                 0x03000005
139 #define SSL3_CK_RSA_RC2_40_MD5                  0x03000006
140 #define SSL3_CK_RSA_IDEA_128_SHA                0x03000007
141 #define SSL3_CK_RSA_DES_40_CBC_SHA              0x03000008
142 #define SSL3_CK_RSA_DES_64_CBC_SHA              0x03000009
143 #define SSL3_CK_RSA_DES_192_CBC3_SHA            0x0300000A
144
145 #define SSL3_CK_DH_DSS_DES_40_CBC_SHA           0x0300000B
146 #define SSL3_CK_DH_DSS_DES_64_CBC_SHA           0x0300000C
147 #define SSL3_CK_DH_DSS_DES_192_CBC3_SHA         0x0300000D
148 #define SSL3_CK_DH_RSA_DES_40_CBC_SHA           0x0300000E
149 #define SSL3_CK_DH_RSA_DES_64_CBC_SHA           0x0300000F
150 #define SSL3_CK_DH_RSA_DES_192_CBC3_SHA         0x03000010
151
152 #define SSL3_CK_EDH_DSS_DES_40_CBC_SHA          0x03000011
153 #define SSL3_CK_EDH_DSS_DES_64_CBC_SHA          0x03000012
154 #define SSL3_CK_EDH_DSS_DES_192_CBC3_SHA        0x03000013
155 #define SSL3_CK_EDH_RSA_DES_40_CBC_SHA          0x03000014
156 #define SSL3_CK_EDH_RSA_DES_64_CBC_SHA          0x03000015
157 #define SSL3_CK_EDH_RSA_DES_192_CBC3_SHA        0x03000016
158
159 #define SSL3_CK_ADH_RC4_40_MD5                  0x03000017
160 #define SSL3_CK_ADH_RC4_128_MD5                 0x03000018
161 #define SSL3_CK_ADH_DES_40_CBC_SHA              0x03000019
162 #define SSL3_CK_ADH_DES_64_CBC_SHA              0x0300001A
163 #define SSL3_CK_ADH_DES_192_CBC_SHA             0x0300001B
164
165 #if 0
166         #define SSL3_CK_FZA_DMS_NULL_SHA                0x0300001C
167         #define SSL3_CK_FZA_DMS_FZA_SHA                 0x0300001D
168         #if 0 /* Because it clashes with KRB5, is never used any more, and is safe
169                  to remove according to David Hopwood <david.hopwood@zetnet.co.uk>
170                  of the ietf-tls list */
171         #define SSL3_CK_FZA_DMS_RC4_SHA                 0x0300001E
172         #endif
173 #endif
174
175 /*    VRS Additional Kerberos5 entries
176  */
177 #define SSL3_CK_KRB5_DES_64_CBC_SHA             0x0300001E
178 #define SSL3_CK_KRB5_DES_192_CBC3_SHA           0x0300001F
179 #define SSL3_CK_KRB5_RC4_128_SHA                0x03000020
180 #define SSL3_CK_KRB5_IDEA_128_CBC_SHA           0x03000021
181 #define SSL3_CK_KRB5_DES_64_CBC_MD5             0x03000022
182 #define SSL3_CK_KRB5_DES_192_CBC3_MD5           0x03000023
183 #define SSL3_CK_KRB5_RC4_128_MD5                0x03000024
184 #define SSL3_CK_KRB5_IDEA_128_CBC_MD5           0x03000025
185
186 #define SSL3_CK_KRB5_DES_40_CBC_SHA             0x03000026
187 #define SSL3_CK_KRB5_RC2_40_CBC_SHA             0x03000027
188 #define SSL3_CK_KRB5_RC4_40_SHA                 0x03000028
189 #define SSL3_CK_KRB5_DES_40_CBC_MD5             0x03000029
190 #define SSL3_CK_KRB5_RC2_40_CBC_MD5             0x0300002A
191 #define SSL3_CK_KRB5_RC4_40_MD5                 0x0300002B
192
193 #define SSL3_TXT_RSA_NULL_MD5                   "NULL-MD5"
194 #define SSL3_TXT_RSA_NULL_SHA                   "NULL-SHA"
195 #define SSL3_TXT_RSA_RC4_40_MD5                 "EXP-RC4-MD5"
196 #define SSL3_TXT_RSA_RC4_128_MD5                "RC4-MD5"
197 #define SSL3_TXT_RSA_RC4_128_SHA                "RC4-SHA"
198 #define SSL3_TXT_RSA_RC2_40_MD5                 "EXP-RC2-CBC-MD5"
199 #define SSL3_TXT_RSA_IDEA_128_SHA               "IDEA-CBC-SHA"
200 #define SSL3_TXT_RSA_DES_40_CBC_SHA             "EXP-DES-CBC-SHA"
201 #define SSL3_TXT_RSA_DES_64_CBC_SHA             "DES-CBC-SHA"
202 #define SSL3_TXT_RSA_DES_192_CBC3_SHA           "DES-CBC3-SHA"
203
204 #define SSL3_TXT_DH_DSS_DES_40_CBC_SHA          "EXP-DH-DSS-DES-CBC-SHA"
205 #define SSL3_TXT_DH_DSS_DES_64_CBC_SHA          "DH-DSS-DES-CBC-SHA"
206 #define SSL3_TXT_DH_DSS_DES_192_CBC3_SHA        "DH-DSS-DES-CBC3-SHA"
207 #define SSL3_TXT_DH_RSA_DES_40_CBC_SHA          "EXP-DH-RSA-DES-CBC-SHA"
208 #define SSL3_TXT_DH_RSA_DES_64_CBC_SHA          "DH-RSA-DES-CBC-SHA"
209 #define SSL3_TXT_DH_RSA_DES_192_CBC3_SHA        "DH-RSA-DES-CBC3-SHA"
210
211 #define SSL3_TXT_EDH_DSS_DES_40_CBC_SHA         "EXP-EDH-DSS-DES-CBC-SHA"
212 #define SSL3_TXT_EDH_DSS_DES_64_CBC_SHA         "EDH-DSS-DES-CBC-SHA"
213 #define SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA       "EDH-DSS-DES-CBC3-SHA"
214 #define SSL3_TXT_EDH_RSA_DES_40_CBC_SHA         "EXP-EDH-RSA-DES-CBC-SHA"
215 #define SSL3_TXT_EDH_RSA_DES_64_CBC_SHA         "EDH-RSA-DES-CBC-SHA"
216 #define SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA       "EDH-RSA-DES-CBC3-SHA"
217
218 #define SSL3_TXT_ADH_RC4_40_MD5                 "EXP-ADH-RC4-MD5"
219 #define SSL3_TXT_ADH_RC4_128_MD5                "ADH-RC4-MD5"
220 #define SSL3_TXT_ADH_DES_40_CBC_SHA             "EXP-ADH-DES-CBC-SHA"
221 #define SSL3_TXT_ADH_DES_64_CBC_SHA             "ADH-DES-CBC-SHA"
222 #define SSL3_TXT_ADH_DES_192_CBC_SHA            "ADH-DES-CBC3-SHA"
223
224 #if 0
225         #define SSL3_TXT_FZA_DMS_NULL_SHA               "FZA-NULL-SHA"
226         #define SSL3_TXT_FZA_DMS_FZA_SHA                "FZA-FZA-CBC-SHA"
227         #define SSL3_TXT_FZA_DMS_RC4_SHA                "FZA-RC4-SHA"
228 #endif
229
230 #define SSL3_TXT_KRB5_DES_64_CBC_SHA            "KRB5-DES-CBC-SHA"
231 #define SSL3_TXT_KRB5_DES_192_CBC3_SHA          "KRB5-DES-CBC3-SHA"
232 #define SSL3_TXT_KRB5_RC4_128_SHA               "KRB5-RC4-SHA"
233 #define SSL3_TXT_KRB5_IDEA_128_CBC_SHA          "KRB5-IDEA-CBC-SHA"
234 #define SSL3_TXT_KRB5_DES_64_CBC_MD5            "KRB5-DES-CBC-MD5"
235 #define SSL3_TXT_KRB5_DES_192_CBC3_MD5          "KRB5-DES-CBC3-MD5"
236 #define SSL3_TXT_KRB5_RC4_128_MD5               "KRB5-RC4-MD5"
237 #define SSL3_TXT_KRB5_IDEA_128_CBC_MD5          "KRB5-IDEA-CBC-MD5"
238
239 #define SSL3_TXT_KRB5_DES_40_CBC_SHA            "EXP-KRB5-DES-CBC-SHA"
240 #define SSL3_TXT_KRB5_RC2_40_CBC_SHA            "EXP-KRB5-RC2-CBC-SHA"
241 #define SSL3_TXT_KRB5_RC4_40_SHA                "EXP-KRB5-RC4-SHA"
242 #define SSL3_TXT_KRB5_DES_40_CBC_MD5            "EXP-KRB5-DES-CBC-MD5"
243 #define SSL3_TXT_KRB5_RC2_40_CBC_MD5            "EXP-KRB5-RC2-CBC-MD5"
244 #define SSL3_TXT_KRB5_RC4_40_MD5                "EXP-KRB5-RC4-MD5"
245
246 #define SSL3_SSL_SESSION_ID_LENGTH              32
247 #define SSL3_MAX_SSL_SESSION_ID_LENGTH          32
248
249 #define SSL3_MASTER_SECRET_SIZE                 48
250 #define SSL3_RANDOM_SIZE                        32
251 #define SSL3_SESSION_ID_SIZE                    32
252 #define SSL3_RT_HEADER_LENGTH                   5
253
254 #define SSL3_HM_HEADER_LENGTH                  4
255
256 #ifndef SSL3_ALIGN_PAYLOAD
257  /* Some will argue that this increases memory footprint, but it's
258   * not actually true. Point is that malloc has to return at least
259   * 64-bit aligned pointers, meaning that allocating 5 bytes wastes
260   * 3 bytes in either case. Suggested pre-gaping simply moves these
261   * wasted bytes from the end of allocated region to its front,
262   * but makes data payload aligned, which improves performance:-) */
263 # define SSL3_ALIGN_PAYLOAD                     8
264 #else
265 # if (SSL3_ALIGN_PAYLOAD&(SSL3_ALIGN_PAYLOAD-1))!=0
266 #  error "insane SSL3_ALIGN_PAYLOAD"
267 #  undef SSL3_ALIGN_PAYLOAD
268 # endif
269 #endif
270
271 /* This is the maximum MAC (digest) size used by the SSL library.
272  * Currently maximum of 20 is used by SHA1, but we reserve for
273  * future extension for 512-bit hashes.
274  */
275
276 #define SSL3_RT_MAX_MD_SIZE                     64
277
278 /* Maximum block size used in all ciphersuites. Currently 16 for AES.
279  */
280
281 #define SSL_RT_MAX_CIPHER_BLOCK_SIZE            16
282
283 #define SSL3_RT_MAX_EXTRA                       (16384)
284
285 /* Maximum plaintext length: defined by SSL/TLS standards */
286 #define SSL3_RT_MAX_PLAIN_LENGTH                16384
287 /* Maximum compression overhead: defined by SSL/TLS standards */
288 #define SSL3_RT_MAX_COMPRESSED_OVERHEAD         1024
289
290 /* The standards give a maximum encryption overhead of 1024 bytes.
291  * In practice the value is lower than this. The overhead is the maximum
292  * number of padding bytes (256) plus the mac size.
293  */
294 #define SSL3_RT_MAX_ENCRYPTED_OVERHEAD  (256 + SSL3_RT_MAX_MD_SIZE)
295
296 /* OpenSSL currently only uses a padding length of at most one block so
297  * the send overhead is smaller.
298  */
299
300 #define SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD \
301                         (SSL_RT_MAX_CIPHER_BLOCK_SIZE + SSL3_RT_MAX_MD_SIZE)
302
303 /* If compression isn't used don't include the compression overhead */
304
305 #ifdef OPENSSL_NO_COMP
306 #define SSL3_RT_MAX_COMPRESSED_LENGTH           SSL3_RT_MAX_PLAIN_LENGTH
307 #else
308 #define SSL3_RT_MAX_COMPRESSED_LENGTH   \
309                 (SSL3_RT_MAX_PLAIN_LENGTH+SSL3_RT_MAX_COMPRESSED_OVERHEAD)
310 #endif
311 #define SSL3_RT_MAX_ENCRYPTED_LENGTH    \
312                 (SSL3_RT_MAX_ENCRYPTED_OVERHEAD+SSL3_RT_MAX_COMPRESSED_LENGTH)
313 #define SSL3_RT_MAX_PACKET_SIZE         \
314                 (SSL3_RT_MAX_ENCRYPTED_LENGTH+SSL3_RT_HEADER_LENGTH)
315
316 #define SSL3_MD_CLIENT_FINISHED_CONST   "\x43\x4C\x4E\x54"
317 #define SSL3_MD_SERVER_FINISHED_CONST   "\x53\x52\x56\x52"
318
319 #define SSL3_VERSION                    0x0300
320 #define SSL3_VERSION_MAJOR              0x03
321 #define SSL3_VERSION_MINOR              0x00
322
323 #define SSL3_RT_CHANGE_CIPHER_SPEC      20
324 #define SSL3_RT_ALERT                   21
325 #define SSL3_RT_HANDSHAKE               22
326 #define SSL3_RT_APPLICATION_DATA        23
327 #define TLS1_RT_HEARTBEAT               24
328
329 /* Pseudo content types to indicate additional parameters */
330 #define TLS1_RT_CRYPTO                  0x1000
331 #define TLS1_RT_CRYPTO_PREMASTER        (TLS1_RT_CRYPTO | 0x1)
332 #define TLS1_RT_CRYPTO_CLIENT_RANDOM    (TLS1_RT_CRYPTO | 0x2)
333 #define TLS1_RT_CRYPTO_SERVER_RANDOM    (TLS1_RT_CRYPTO | 0x3)
334 #define TLS1_RT_CRYPTO_MASTER           (TLS1_RT_CRYPTO | 0x4)
335
336 #define TLS1_RT_CRYPTO_READ             0x0000
337 #define TLS1_RT_CRYPTO_WRITE            0x0100
338 #define TLS1_RT_CRYPTO_MAC              (TLS1_RT_CRYPTO | 0x5)
339 #define TLS1_RT_CRYPTO_KEY              (TLS1_RT_CRYPTO | 0x6)
340 #define TLS1_RT_CRYPTO_IV               (TLS1_RT_CRYPTO | 0x7)
341 #define TLS1_RT_CRYPTO_FIXED_IV         (TLS1_RT_CRYPTO | 0x8)
342
343 /* Pseudo content type for SSL/TLS header info */
344 #define SSL3_RT_HEADER                  0x100
345
346 #define SSL3_AL_WARNING                 1
347 #define SSL3_AL_FATAL                   2
348
349 #define SSL3_AD_CLOSE_NOTIFY             0
350 #define SSL3_AD_UNEXPECTED_MESSAGE      10      /* fatal */
351 #define SSL3_AD_BAD_RECORD_MAC          20      /* fatal */
352 #define SSL3_AD_DECOMPRESSION_FAILURE   30      /* fatal */
353 #define SSL3_AD_HANDSHAKE_FAILURE       40      /* fatal */
354 #define SSL3_AD_NO_CERTIFICATE          41
355 #define SSL3_AD_BAD_CERTIFICATE         42
356 #define SSL3_AD_UNSUPPORTED_CERTIFICATE 43
357 #define SSL3_AD_CERTIFICATE_REVOKED     44
358 #define SSL3_AD_CERTIFICATE_EXPIRED     45
359 #define SSL3_AD_CERTIFICATE_UNKNOWN     46
360 #define SSL3_AD_ILLEGAL_PARAMETER       47      /* fatal */
361
362 #define TLS1_HB_REQUEST         1
363 #define TLS1_HB_RESPONSE        2
364         
365 #ifndef OPENSSL_NO_SSL_INTERN
366
367 typedef struct ssl3_record_st
368         {
369 /*r */  int type;               /* type of record */
370 /*rw*/  unsigned int length;    /* How many bytes available */
371 /*rw*/  unsigned int orig_len;  /* How many bytes were available before padding
372                                    was removed? This is used to implement the
373                                    MAC check in constant time for CBC records.
374                                  */
375 /*r */  unsigned int off;       /* read/write offset into 'buf' */
376 /*rw*/  unsigned char *data;    /* pointer to the record data */
377 /*rw*/  unsigned char *input;   /* where the decode bytes are */
378 /*r */  unsigned char *comp;    /* only used with decompression - malloc()ed */
379 /*r */  unsigned long epoch;    /* epoch number, needed by DTLS1 */
380 /*r */  unsigned char seq_num[8]; /* sequence number, needed by DTLS1 */
381         } SSL3_RECORD;
382
383 typedef struct ssl3_buffer_st
384         {
385         unsigned char *buf;     /* at least SSL3_RT_MAX_PACKET_SIZE bytes,
386                                  * see ssl3_setup_buffers() */
387         size_t len;             /* buffer size */
388         int offset;             /* where to 'copy from' */
389         int left;               /* how many bytes left */
390         } SSL3_BUFFER;
391
392 #endif
393
394 #define SSL3_CT_RSA_SIGN                        1
395 #define SSL3_CT_DSS_SIGN                        2
396 #define SSL3_CT_RSA_FIXED_DH                    3
397 #define SSL3_CT_DSS_FIXED_DH                    4
398 #define SSL3_CT_RSA_EPHEMERAL_DH                5
399 #define SSL3_CT_DSS_EPHEMERAL_DH                6
400 #define SSL3_CT_FORTEZZA_DMS                    20
401 /* SSL3_CT_NUMBER is used to size arrays and it must be large
402  * enough to contain all of the cert types defined either for
403  * SSLv3 and TLSv1.
404  */
405 #define SSL3_CT_NUMBER                  9
406
407
408 #define SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS       0x0001
409 #define SSL3_FLAGS_DELAY_CLIENT_FINISHED        0x0002
410 #define SSL3_FLAGS_POP_BUFFER                   0x0004
411 #define TLS1_FLAGS_TLS_PADDING_BUG              0x0008
412 #define TLS1_FLAGS_SKIP_CERT_VERIFY             0x0010
413 #define TLS1_FLAGS_KEEP_HANDSHAKE               0x0020
414  
415 /* SSL3_FLAGS_SGC_RESTART_DONE is set when we
416  * restart a handshake because of MS SGC and so prevents us
417  * from restarting the handshake in a loop. It's reset on a
418  * renegotiation, so effectively limits the client to one restart
419  * per negotiation. This limits the possibility of a DDoS
420  * attack where the client handshakes in a loop using SGC to
421  * restart. Servers which permit renegotiation can still be
422  * effected, but we can't prevent that.
423  */
424 #define SSL3_FLAGS_SGC_RESTART_DONE             0x0040
425
426 #ifndef OPENSSL_NO_SSL_INTERN
427
428 typedef struct ssl3_state_st
429         {
430         long flags;
431         int delay_buf_pop_ret;
432
433         unsigned char read_sequence[8];
434         int read_mac_secret_size;
435         unsigned char read_mac_secret[EVP_MAX_MD_SIZE];
436         unsigned char write_sequence[8];
437         int write_mac_secret_size;
438         unsigned char write_mac_secret[EVP_MAX_MD_SIZE];
439
440         unsigned char server_random[SSL3_RANDOM_SIZE];
441         unsigned char client_random[SSL3_RANDOM_SIZE];
442
443         /* flags for countermeasure against known-IV weakness */
444         int need_empty_fragments;
445         int empty_fragment_done;
446
447         /* The value of 'extra' when the buffers were initialized */
448         int init_extra;
449
450         SSL3_BUFFER rbuf;       /* read IO goes into here */
451         SSL3_BUFFER wbuf;       /* write IO goes into here */
452
453         SSL3_RECORD rrec;       /* each decoded record goes in here */
454         SSL3_RECORD wrec;       /* goes out from here */
455
456         /* storage for Alert/Handshake protocol data received but not
457          * yet processed by ssl3_read_bytes: */
458         unsigned char alert_fragment[2];
459         unsigned int alert_fragment_len;
460         unsigned char handshake_fragment[4];
461         unsigned int handshake_fragment_len;
462
463         /* partial write - check the numbers match */
464         unsigned int wnum;      /* number of bytes sent so far */
465         int wpend_tot;          /* number bytes written */
466         int wpend_type;
467         int wpend_ret;          /* number of bytes submitted */
468         const unsigned char *wpend_buf;
469
470         /* used during startup, digest all incoming/outgoing packets */
471         BIO *handshake_buffer;
472         /* When set of handshake digests is determined, buffer is hashed
473          * and freed and MD_CTX-es for all required digests are stored in
474          * this array */
475         EVP_MD_CTX **handshake_dgst;
476         /* this is set whenerver we see a change_cipher_spec message
477          * come in when we are not looking for one */
478         int change_cipher_spec;
479
480         int warn_alert;
481         int fatal_alert;
482         /* we allow one fatal and one warning alert to be outstanding,
483          * send close alert via the warning alert */
484         int alert_dispatch;
485         unsigned char send_alert[2];
486
487         /* This flag is set when we should renegotiate ASAP, basically when
488          * there is no more data in the read or write buffers */
489         int renegotiate;
490         int total_renegotiations;
491         int num_renegotiations;
492
493         int in_read_app_data;
494
495         /* Opaque PRF input as used for the current handshake.
496          * These fields are used only if TLSEXT_TYPE_opaque_prf_input is defined
497          * (otherwise, they are merely present to improve binary compatibility) */
498         void *client_opaque_prf_input;
499         size_t client_opaque_prf_input_len;
500         void *server_opaque_prf_input;
501         size_t server_opaque_prf_input_len;
502
503         struct  {
504                 /* actually only needs to be 16+20 */
505                 unsigned char cert_verify_md[EVP_MAX_MD_SIZE*2];
506
507                 /* actually only need to be 16+20 for SSLv3 and 12 for TLS */
508                 unsigned char finish_md[EVP_MAX_MD_SIZE*2];
509                 int finish_md_len;
510                 unsigned char peer_finish_md[EVP_MAX_MD_SIZE*2];
511                 int peer_finish_md_len;
512
513                 unsigned long message_size;
514                 int message_type;
515
516                 /* used to hold the new cipher we are going to use */
517                 const SSL_CIPHER *new_cipher;
518 #ifndef OPENSSL_NO_DH
519                 DH *dh;
520 #endif
521
522 #ifndef OPENSSL_NO_ECDH
523                 EC_KEY *ecdh; /* holds short lived ECDH key */
524 #endif
525
526                 /* used when SSL_ST_FLUSH_DATA is entered */
527                 int next_state;                 
528
529                 int reuse_message;
530
531                 /* used for certificate requests */
532                 int cert_req;
533                 int ctype_num;
534                 char ctype[SSL3_CT_NUMBER];
535                 STACK_OF(X509_NAME) *ca_names;
536
537                 int use_rsa_tmp;
538
539                 int key_block_length;
540                 unsigned char *key_block;
541
542                 const EVP_CIPHER *new_sym_enc;
543                 const EVP_MD *new_hash;
544                 int new_mac_pkey_type;
545                 int new_mac_secret_size;
546 #ifndef OPENSSL_NO_COMP
547                 const SSL_COMP *new_compression;
548 #else
549                 char *new_compression;
550 #endif
551                 int cert_request;
552                 } tmp;
553
554         /* Connection binding to prevent renegotiation attacks */
555         unsigned char previous_client_finished[EVP_MAX_MD_SIZE];
556         unsigned char previous_client_finished_len;
557         unsigned char previous_server_finished[EVP_MAX_MD_SIZE];
558         unsigned char previous_server_finished_len;
559         int send_connection_binding; /* TODOEKR */
560
561 #ifndef OPENSSL_NO_NEXTPROTONEG
562         /* Set if we saw the Next Protocol Negotiation extension from our peer. */
563         int next_proto_neg_seen;
564 #endif
565
566 #ifndef OPENSSL_NO_TLSEXT
567         /* tlsext_authz_client_types contains an array of supported authz
568          * types, as advertised by the client. The array is sorted and
569          * does not contain any duplicates. */
570         unsigned char *tlsext_authz_client_types;
571         size_t tlsext_authz_client_types_len;
572         /* tlsext_authz_promised_to_client is true iff we're a server and we
573          * echoed the client's supplemental data extension and therefore must
574          * send a supplemental data handshake message. */
575         char tlsext_authz_promised_to_client;
576         /* tlsext_authz_server_promised is true iff we're a client and the
577          * server echoed our server_authz extension and therefore must send us
578          * a supplemental data handshake message. */
579         char tlsext_authz_server_promised;
580
581         /* tlsext_custom_types contains an array of TLS Extension types which 
582          * were advertised by the client in its ClientHello, which were not 
583          * otherwise handled by OpenSSL, and which the server has registered
584          * a custom_srv_ext_record to handle.
585          * The array does not contain any duplicates, and is in the same order
586          * as the types were received in the client hello. */
587         unsigned short *tlsext_custom_types;
588         size_t tlsext_custom_types_count; /* how many tlsext_custom_types */
589 #endif
590         } SSL3_STATE;
591
592 #endif
593
594 /* SSLv3 */
595 /*client */
596 /* extra state */
597 #define SSL3_ST_CW_FLUSH                (0x100|SSL_ST_CONNECT)
598 #ifndef OPENSSL_NO_SCTP
599 #define DTLS1_SCTP_ST_CW_WRITE_SOCK                     (0x310|SSL_ST_CONNECT)
600 #define DTLS1_SCTP_ST_CR_READ_SOCK                      (0x320|SSL_ST_CONNECT)
601 #endif  
602 /* write to server */
603 #define SSL3_ST_CW_CLNT_HELLO_A         (0x110|SSL_ST_CONNECT)
604 #define SSL3_ST_CW_CLNT_HELLO_B         (0x111|SSL_ST_CONNECT)
605 /* read from server */
606 #define SSL3_ST_CR_SRVR_HELLO_A         (0x120|SSL_ST_CONNECT)
607 #define SSL3_ST_CR_SRVR_HELLO_B         (0x121|SSL_ST_CONNECT)
608 #define DTLS1_ST_CR_HELLO_VERIFY_REQUEST_A (0x126|SSL_ST_CONNECT)
609 #define DTLS1_ST_CR_HELLO_VERIFY_REQUEST_B (0x127|SSL_ST_CONNECT)
610 #define SSL3_ST_CR_CERT_A               (0x130|SSL_ST_CONNECT)
611 #define SSL3_ST_CR_CERT_B               (0x131|SSL_ST_CONNECT)
612 #define SSL3_ST_CR_KEY_EXCH_A           (0x140|SSL_ST_CONNECT)
613 #define SSL3_ST_CR_KEY_EXCH_B           (0x141|SSL_ST_CONNECT)
614 #define SSL3_ST_CR_CERT_REQ_A           (0x150|SSL_ST_CONNECT)
615 #define SSL3_ST_CR_CERT_REQ_B           (0x151|SSL_ST_CONNECT)
616 #define SSL3_ST_CR_SRVR_DONE_A          (0x160|SSL_ST_CONNECT)
617 #define SSL3_ST_CR_SRVR_DONE_B          (0x161|SSL_ST_CONNECT)
618 #define SSL3_ST_CR_SUPPLEMENTAL_DATA_A  (0x210|SSL_ST_CONNECT)
619 #define SSL3_ST_CR_SUPPLEMENTAL_DATA_B  (0x211|SSL_ST_CONNECT)
620 /* write to server */
621 #define SSL3_ST_CW_CERT_A               (0x170|SSL_ST_CONNECT)
622 #define SSL3_ST_CW_CERT_B               (0x171|SSL_ST_CONNECT)
623 #define SSL3_ST_CW_CERT_C               (0x172|SSL_ST_CONNECT)
624 #define SSL3_ST_CW_CERT_D               (0x173|SSL_ST_CONNECT)
625 #define SSL3_ST_CW_KEY_EXCH_A           (0x180|SSL_ST_CONNECT)
626 #define SSL3_ST_CW_KEY_EXCH_B           (0x181|SSL_ST_CONNECT)
627 #define SSL3_ST_CW_CERT_VRFY_A          (0x190|SSL_ST_CONNECT)
628 #define SSL3_ST_CW_CERT_VRFY_B          (0x191|SSL_ST_CONNECT)
629 #define SSL3_ST_CW_CHANGE_A             (0x1A0|SSL_ST_CONNECT)
630 #define SSL3_ST_CW_CHANGE_B             (0x1A1|SSL_ST_CONNECT)
631 #ifndef OPENSSL_NO_NEXTPROTONEG
632 #define SSL3_ST_CW_NEXT_PROTO_A         (0x200|SSL_ST_CONNECT)
633 #define SSL3_ST_CW_NEXT_PROTO_B         (0x201|SSL_ST_CONNECT)
634 #endif
635 #define SSL3_ST_CW_FINISHED_A           (0x1B0|SSL_ST_CONNECT)
636 #define SSL3_ST_CW_FINISHED_B           (0x1B1|SSL_ST_CONNECT)
637 /* read from server */
638 #define SSL3_ST_CR_CHANGE_A             (0x1C0|SSL_ST_CONNECT)
639 #define SSL3_ST_CR_CHANGE_B             (0x1C1|SSL_ST_CONNECT)
640 #define SSL3_ST_CR_FINISHED_A           (0x1D0|SSL_ST_CONNECT)
641 #define SSL3_ST_CR_FINISHED_B           (0x1D1|SSL_ST_CONNECT)
642 #define SSL3_ST_CR_SESSION_TICKET_A     (0x1E0|SSL_ST_CONNECT)
643 #define SSL3_ST_CR_SESSION_TICKET_B     (0x1E1|SSL_ST_CONNECT)
644 #define SSL3_ST_CR_CERT_STATUS_A        (0x1F0|SSL_ST_CONNECT)
645 #define SSL3_ST_CR_CERT_STATUS_B        (0x1F1|SSL_ST_CONNECT)
646
647 /* server */
648 /* extra state */
649 #define SSL3_ST_SW_FLUSH                (0x100|SSL_ST_ACCEPT)
650 #ifndef OPENSSL_NO_SCTP
651 #define DTLS1_SCTP_ST_SW_WRITE_SOCK                     (0x310|SSL_ST_ACCEPT)
652 #define DTLS1_SCTP_ST_SR_READ_SOCK                      (0x320|SSL_ST_ACCEPT)
653 #endif  
654 /* read from client */
655 /* Do not change the number values, they do matter */
656 #define SSL3_ST_SR_CLNT_HELLO_A         (0x110|SSL_ST_ACCEPT)
657 #define SSL3_ST_SR_CLNT_HELLO_B         (0x111|SSL_ST_ACCEPT)
658 #define SSL3_ST_SR_CLNT_HELLO_C         (0x112|SSL_ST_ACCEPT)
659 /* write to client */
660 #define DTLS1_ST_SW_HELLO_VERIFY_REQUEST_A (0x113|SSL_ST_ACCEPT)
661 #define DTLS1_ST_SW_HELLO_VERIFY_REQUEST_B (0x114|SSL_ST_ACCEPT)
662 #define SSL3_ST_SW_HELLO_REQ_A          (0x120|SSL_ST_ACCEPT)
663 #define SSL3_ST_SW_HELLO_REQ_B          (0x121|SSL_ST_ACCEPT)
664 #define SSL3_ST_SW_HELLO_REQ_C          (0x122|SSL_ST_ACCEPT)
665 #define SSL3_ST_SW_SRVR_HELLO_A         (0x130|SSL_ST_ACCEPT)
666 #define SSL3_ST_SW_SRVR_HELLO_B         (0x131|SSL_ST_ACCEPT)
667 #define SSL3_ST_SW_CERT_A               (0x140|SSL_ST_ACCEPT)
668 #define SSL3_ST_SW_CERT_B               (0x141|SSL_ST_ACCEPT)
669 #define SSL3_ST_SW_KEY_EXCH_A           (0x150|SSL_ST_ACCEPT)
670 #define SSL3_ST_SW_KEY_EXCH_B           (0x151|SSL_ST_ACCEPT)
671 #define SSL3_ST_SW_CERT_REQ_A           (0x160|SSL_ST_ACCEPT)
672 #define SSL3_ST_SW_CERT_REQ_B           (0x161|SSL_ST_ACCEPT)
673 #define SSL3_ST_SW_SRVR_DONE_A          (0x170|SSL_ST_ACCEPT)
674 #define SSL3_ST_SW_SRVR_DONE_B          (0x171|SSL_ST_ACCEPT)
675 /* read from client */
676 #define SSL3_ST_SR_CERT_A               (0x180|SSL_ST_ACCEPT)
677 #define SSL3_ST_SR_CERT_B               (0x181|SSL_ST_ACCEPT)
678 #define SSL3_ST_SR_KEY_EXCH_A           (0x190|SSL_ST_ACCEPT)
679 #define SSL3_ST_SR_KEY_EXCH_B           (0x191|SSL_ST_ACCEPT)
680 #define SSL3_ST_SR_CERT_VRFY_A          (0x1A0|SSL_ST_ACCEPT)
681 #define SSL3_ST_SR_CERT_VRFY_B          (0x1A1|SSL_ST_ACCEPT)
682 #define SSL3_ST_SR_CHANGE_A             (0x1B0|SSL_ST_ACCEPT)
683 #define SSL3_ST_SR_CHANGE_B             (0x1B1|SSL_ST_ACCEPT)
684 #ifndef OPENSSL_NO_NEXTPROTONEG
685 #define SSL3_ST_SR_NEXT_PROTO_A         (0x210|SSL_ST_ACCEPT)
686 #define SSL3_ST_SR_NEXT_PROTO_B         (0x211|SSL_ST_ACCEPT)
687 #endif
688 #define SSL3_ST_SR_FINISHED_A           (0x1C0|SSL_ST_ACCEPT)
689 #define SSL3_ST_SR_FINISHED_B           (0x1C1|SSL_ST_ACCEPT)
690 /* write to client */
691 #define SSL3_ST_SW_CHANGE_A             (0x1D0|SSL_ST_ACCEPT)
692 #define SSL3_ST_SW_CHANGE_B             (0x1D1|SSL_ST_ACCEPT)
693 #define SSL3_ST_SW_FINISHED_A           (0x1E0|SSL_ST_ACCEPT)
694 #define SSL3_ST_SW_FINISHED_B           (0x1E1|SSL_ST_ACCEPT)
695 #define SSL3_ST_SW_SESSION_TICKET_A     (0x1F0|SSL_ST_ACCEPT)
696 #define SSL3_ST_SW_SESSION_TICKET_B     (0x1F1|SSL_ST_ACCEPT)
697 #define SSL3_ST_SW_CERT_STATUS_A        (0x200|SSL_ST_ACCEPT)
698 #define SSL3_ST_SW_CERT_STATUS_B        (0x201|SSL_ST_ACCEPT)
699 #define SSL3_ST_SW_SUPPLEMENTAL_DATA_A  (0x220|SSL_ST_ACCEPT)
700 #define SSL3_ST_SW_SUPPLEMENTAL_DATA_B  (0x221|SSL_ST_ACCEPT)
701
702 #define SSL3_MT_HELLO_REQUEST                   0
703 #define SSL3_MT_CLIENT_HELLO                    1
704 #define SSL3_MT_SERVER_HELLO                    2
705 #define SSL3_MT_NEWSESSION_TICKET               4
706 #define SSL3_MT_CERTIFICATE                     11
707 #define SSL3_MT_SERVER_KEY_EXCHANGE             12
708 #define SSL3_MT_CERTIFICATE_REQUEST             13
709 #define SSL3_MT_SERVER_DONE                     14
710 #define SSL3_MT_CERTIFICATE_VERIFY              15
711 #define SSL3_MT_CLIENT_KEY_EXCHANGE             16
712 #define SSL3_MT_FINISHED                        20
713 #define SSL3_MT_CERTIFICATE_STATUS              22
714 #define SSL3_MT_SUPPLEMENTAL_DATA               23
715 #ifndef OPENSSL_NO_NEXTPROTONEG
716 #define SSL3_MT_NEXT_PROTO                      67
717 #endif
718 #define DTLS1_MT_HELLO_VERIFY_REQUEST    3
719
720
721 #define SSL3_MT_CCS                             1
722
723 /* These are used when changing over to a new cipher */
724 #define SSL3_CC_READ            0x01
725 #define SSL3_CC_WRITE           0x02
726 #define SSL3_CC_CLIENT          0x10
727 #define SSL3_CC_SERVER          0x20
728 #define SSL3_CHANGE_CIPHER_CLIENT_WRITE (SSL3_CC_CLIENT|SSL3_CC_WRITE)  
729 #define SSL3_CHANGE_CIPHER_SERVER_READ  (SSL3_CC_SERVER|SSL3_CC_READ)
730 #define SSL3_CHANGE_CIPHER_CLIENT_READ  (SSL3_CC_CLIENT|SSL3_CC_READ)
731 #define SSL3_CHANGE_CIPHER_SERVER_WRITE (SSL3_CC_SERVER|SSL3_CC_WRITE)
732
733 #ifdef  __cplusplus
734 }
735 #endif
736 #endif