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