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