Miscellaneous style tweaks based on feedback received
[openssl.git] / include / openssl / ssl3.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 /* ====================================================================
11  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
12  * ECC cipher suite support in OpenSSL originally developed by
13  * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
14  */
15
16 #ifndef HEADER_SSL3_H
17 # define HEADER_SSL3_H
18
19 # include <openssl/comp.h>
20 # include <openssl/buffer.h>
21 # include <openssl/evp.h>
22 # include <openssl/ssl.h>
23
24 #ifdef  __cplusplus
25 extern "C" {
26 #endif
27
28 /* Flag used on OpenSSL ciphersuite ids to indicate they are for SSLv3+ */
29 # define SSL3_CK_CIPHERSUITE_FLAG                0x03000000
30
31 /*
32  * Signalling cipher suite value from RFC 5746
33  * (TLS_EMPTY_RENEGOTIATION_INFO_SCSV)
34  */
35 # define SSL3_CK_SCSV                            0x030000FF
36
37 /*
38  * Signalling cipher suite value from draft-ietf-tls-downgrade-scsv-00
39  * (TLS_FALLBACK_SCSV)
40  */
41 # define SSL3_CK_FALLBACK_SCSV                   0x03005600
42
43 # define SSL3_CK_RSA_NULL_MD5                    0x03000001
44 # define SSL3_CK_RSA_NULL_SHA                    0x03000002
45 # define SSL3_CK_RSA_RC4_40_MD5                  0x03000003
46 # define SSL3_CK_RSA_RC4_128_MD5                 0x03000004
47 # define SSL3_CK_RSA_RC4_128_SHA                 0x03000005
48 # define SSL3_CK_RSA_RC2_40_MD5                  0x03000006
49 # define SSL3_CK_RSA_IDEA_128_SHA                0x03000007
50 # define SSL3_CK_RSA_DES_40_CBC_SHA              0x03000008
51 # define SSL3_CK_RSA_DES_64_CBC_SHA              0x03000009
52 # define SSL3_CK_RSA_DES_192_CBC3_SHA            0x0300000A
53
54 # define SSL3_CK_DH_DSS_DES_40_CBC_SHA           0x0300000B
55 # define SSL3_CK_DH_DSS_DES_64_CBC_SHA           0x0300000C
56 # define SSL3_CK_DH_DSS_DES_192_CBC3_SHA         0x0300000D
57 # define SSL3_CK_DH_RSA_DES_40_CBC_SHA           0x0300000E
58 # define SSL3_CK_DH_RSA_DES_64_CBC_SHA           0x0300000F
59 # define SSL3_CK_DH_RSA_DES_192_CBC3_SHA         0x03000010
60
61 # define SSL3_CK_DHE_DSS_DES_40_CBC_SHA          0x03000011
62 # define SSL3_CK_EDH_DSS_DES_40_CBC_SHA          SSL3_CK_DHE_DSS_DES_40_CBC_SHA
63 # define SSL3_CK_DHE_DSS_DES_64_CBC_SHA          0x03000012
64 # define SSL3_CK_EDH_DSS_DES_64_CBC_SHA          SSL3_CK_DHE_DSS_DES_64_CBC_SHA
65 # define SSL3_CK_DHE_DSS_DES_192_CBC3_SHA        0x03000013
66 # define SSL3_CK_EDH_DSS_DES_192_CBC3_SHA        SSL3_CK_DHE_DSS_DES_192_CBC3_SHA
67 # define SSL3_CK_DHE_RSA_DES_40_CBC_SHA          0x03000014
68 # define SSL3_CK_EDH_RSA_DES_40_CBC_SHA          SSL3_CK_DHE_RSA_DES_40_CBC_SHA
69 # define SSL3_CK_DHE_RSA_DES_64_CBC_SHA          0x03000015
70 # define SSL3_CK_EDH_RSA_DES_64_CBC_SHA          SSL3_CK_DHE_RSA_DES_64_CBC_SHA
71 # define SSL3_CK_DHE_RSA_DES_192_CBC3_SHA        0x03000016
72 # define SSL3_CK_EDH_RSA_DES_192_CBC3_SHA        SSL3_CK_DHE_RSA_DES_192_CBC3_SHA
73
74 # define SSL3_CK_ADH_RC4_40_MD5                  0x03000017
75 # define SSL3_CK_ADH_RC4_128_MD5                 0x03000018
76 # define SSL3_CK_ADH_DES_40_CBC_SHA              0x03000019
77 # define SSL3_CK_ADH_DES_64_CBC_SHA              0x0300001A
78 # define SSL3_CK_ADH_DES_192_CBC_SHA             0x0300001B
79
80 # define SSL3_TXT_RSA_NULL_MD5                   "NULL-MD5"
81 # define SSL3_TXT_RSA_NULL_SHA                   "NULL-SHA"
82 # define SSL3_TXT_RSA_RC4_40_MD5                 "EXP-RC4-MD5"
83 # define SSL3_TXT_RSA_RC4_128_MD5                "RC4-MD5"
84 # define SSL3_TXT_RSA_RC4_128_SHA                "RC4-SHA"
85 # define SSL3_TXT_RSA_RC2_40_MD5                 "EXP-RC2-CBC-MD5"
86 # define SSL3_TXT_RSA_IDEA_128_SHA               "IDEA-CBC-SHA"
87 # define SSL3_TXT_RSA_DES_40_CBC_SHA             "EXP-DES-CBC-SHA"
88 # define SSL3_TXT_RSA_DES_64_CBC_SHA             "DES-CBC-SHA"
89 # define SSL3_TXT_RSA_DES_192_CBC3_SHA           "DES-CBC3-SHA"
90
91 # define SSL3_TXT_DH_DSS_DES_40_CBC_SHA          "EXP-DH-DSS-DES-CBC-SHA"
92 # define SSL3_TXT_DH_DSS_DES_64_CBC_SHA          "DH-DSS-DES-CBC-SHA"
93 # define SSL3_TXT_DH_DSS_DES_192_CBC3_SHA        "DH-DSS-DES-CBC3-SHA"
94 # define SSL3_TXT_DH_RSA_DES_40_CBC_SHA          "EXP-DH-RSA-DES-CBC-SHA"
95 # define SSL3_TXT_DH_RSA_DES_64_CBC_SHA          "DH-RSA-DES-CBC-SHA"
96 # define SSL3_TXT_DH_RSA_DES_192_CBC3_SHA        "DH-RSA-DES-CBC3-SHA"
97
98 # define SSL3_TXT_DHE_DSS_DES_40_CBC_SHA         "EXP-DHE-DSS-DES-CBC-SHA"
99 # define SSL3_TXT_DHE_DSS_DES_64_CBC_SHA         "DHE-DSS-DES-CBC-SHA"
100 # define SSL3_TXT_DHE_DSS_DES_192_CBC3_SHA       "DHE-DSS-DES-CBC3-SHA"
101 # define SSL3_TXT_DHE_RSA_DES_40_CBC_SHA         "EXP-DHE-RSA-DES-CBC-SHA"
102 # define SSL3_TXT_DHE_RSA_DES_64_CBC_SHA         "DHE-RSA-DES-CBC-SHA"
103 # define SSL3_TXT_DHE_RSA_DES_192_CBC3_SHA       "DHE-RSA-DES-CBC3-SHA"
104
105 /*
106  * This next block of six "EDH" labels is for backward compatibility with
107  * older versions of OpenSSL.  New code should use the six "DHE" labels above
108  * instead:
109  */
110 # define SSL3_TXT_EDH_DSS_DES_40_CBC_SHA         "EXP-EDH-DSS-DES-CBC-SHA"
111 # define SSL3_TXT_EDH_DSS_DES_64_CBC_SHA         "EDH-DSS-DES-CBC-SHA"
112 # define SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA       "EDH-DSS-DES-CBC3-SHA"
113 # define SSL3_TXT_EDH_RSA_DES_40_CBC_SHA         "EXP-EDH-RSA-DES-CBC-SHA"
114 # define SSL3_TXT_EDH_RSA_DES_64_CBC_SHA         "EDH-RSA-DES-CBC-SHA"
115 # define SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA       "EDH-RSA-DES-CBC3-SHA"
116
117 # define SSL3_TXT_ADH_RC4_40_MD5                 "EXP-ADH-RC4-MD5"
118 # define SSL3_TXT_ADH_RC4_128_MD5                "ADH-RC4-MD5"
119 # define SSL3_TXT_ADH_DES_40_CBC_SHA             "EXP-ADH-DES-CBC-SHA"
120 # define SSL3_TXT_ADH_DES_64_CBC_SHA             "ADH-DES-CBC-SHA"
121 # define SSL3_TXT_ADH_DES_192_CBC_SHA            "ADH-DES-CBC3-SHA"
122
123 # define SSL3_SSL_SESSION_ID_LENGTH              32
124 # define SSL3_MAX_SSL_SESSION_ID_LENGTH          32
125
126 # define SSL3_MASTER_SECRET_SIZE                 48
127 # define SSL3_RANDOM_SIZE                        32
128 # define SSL3_SESSION_ID_SIZE                    32
129 # define SSL3_RT_HEADER_LENGTH                   5
130
131 # define SSL3_HM_HEADER_LENGTH                  4
132
133 # ifndef SSL3_ALIGN_PAYLOAD
134  /*
135   * Some will argue that this increases memory footprint, but it's not
136   * actually true. Point is that malloc has to return at least 64-bit aligned
137   * pointers, meaning that allocating 5 bytes wastes 3 bytes in either case.
138   * Suggested pre-gaping simply moves these wasted bytes from the end of
139   * allocated region to its front, but makes data payload aligned, which
140   * improves performance:-)
141   */
142 #  define SSL3_ALIGN_PAYLOAD                     8
143 # else
144 #  if (SSL3_ALIGN_PAYLOAD&(SSL3_ALIGN_PAYLOAD-1))!=0
145 #   error "insane SSL3_ALIGN_PAYLOAD"
146 #   undef SSL3_ALIGN_PAYLOAD
147 #  endif
148 # endif
149
150 /*
151  * This is the maximum MAC (digest) size used by the SSL library. Currently
152  * maximum of 20 is used by SHA1, but we reserve for future extension for
153  * 512-bit hashes.
154  */
155
156 # define SSL3_RT_MAX_MD_SIZE                     64
157
158 /*
159  * Maximum block size used in all ciphersuites. Currently 16 for AES.
160  */
161
162 # define SSL_RT_MAX_CIPHER_BLOCK_SIZE            16
163
164 # define SSL3_RT_MAX_EXTRA                       (16384)
165
166 /* Maximum plaintext length: defined by SSL/TLS standards */
167 # define SSL3_RT_MAX_PLAIN_LENGTH                16384
168 /* Maximum compression overhead: defined by SSL/TLS standards */
169 # define SSL3_RT_MAX_COMPRESSED_OVERHEAD         1024
170
171 /*
172  * The standards give a maximum encryption overhead of 1024 bytes. In
173  * practice the value is lower than this. The overhead is the maximum number
174  * of padding bytes (256) plus the mac size.
175  */
176 # define SSL3_RT_MAX_ENCRYPTED_OVERHEAD  (256 + SSL3_RT_MAX_MD_SIZE)
177
178 /*
179  * OpenSSL currently only uses a padding length of at most one block so the
180  * send overhead is smaller.
181  */
182
183 # define SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD \
184                         (SSL_RT_MAX_CIPHER_BLOCK_SIZE + SSL3_RT_MAX_MD_SIZE)
185
186 /* If compression isn't used don't include the compression overhead */
187
188 # ifdef OPENSSL_NO_COMP
189 #  define SSL3_RT_MAX_COMPRESSED_LENGTH           SSL3_RT_MAX_PLAIN_LENGTH
190 # else
191 #  define SSL3_RT_MAX_COMPRESSED_LENGTH   \
192                 (SSL3_RT_MAX_PLAIN_LENGTH+SSL3_RT_MAX_COMPRESSED_OVERHEAD)
193 # endif
194 # define SSL3_RT_MAX_ENCRYPTED_LENGTH    \
195                 (SSL3_RT_MAX_ENCRYPTED_OVERHEAD+SSL3_RT_MAX_COMPRESSED_LENGTH)
196 # define SSL3_RT_MAX_PACKET_SIZE         \
197                 (SSL3_RT_MAX_ENCRYPTED_LENGTH+SSL3_RT_HEADER_LENGTH)
198
199 # define SSL3_MD_CLIENT_FINISHED_CONST   "\x43\x4C\x4E\x54"
200 # define SSL3_MD_SERVER_FINISHED_CONST   "\x53\x52\x56\x52"
201
202 # define SSL3_VERSION                    0x0300
203 # define SSL3_VERSION_MAJOR              0x03
204 # define SSL3_VERSION_MINOR              0x00
205
206 # define SSL3_RT_CHANGE_CIPHER_SPEC      20
207 # define SSL3_RT_ALERT                   21
208 # define SSL3_RT_HANDSHAKE               22
209 # define SSL3_RT_APPLICATION_DATA        23
210 # define DTLS1_RT_HEARTBEAT              24
211
212 /* Pseudo content types to indicate additional parameters */
213 # define TLS1_RT_CRYPTO                  0x1000
214 # define TLS1_RT_CRYPTO_PREMASTER        (TLS1_RT_CRYPTO | 0x1)
215 # define TLS1_RT_CRYPTO_CLIENT_RANDOM    (TLS1_RT_CRYPTO | 0x2)
216 # define TLS1_RT_CRYPTO_SERVER_RANDOM    (TLS1_RT_CRYPTO | 0x3)
217 # define TLS1_RT_CRYPTO_MASTER           (TLS1_RT_CRYPTO | 0x4)
218
219 # define TLS1_RT_CRYPTO_READ             0x0000
220 # define TLS1_RT_CRYPTO_WRITE            0x0100
221 # define TLS1_RT_CRYPTO_MAC              (TLS1_RT_CRYPTO | 0x5)
222 # define TLS1_RT_CRYPTO_KEY              (TLS1_RT_CRYPTO | 0x6)
223 # define TLS1_RT_CRYPTO_IV               (TLS1_RT_CRYPTO | 0x7)
224 # define TLS1_RT_CRYPTO_FIXED_IV         (TLS1_RT_CRYPTO | 0x8)
225
226 /* Pseudo content type for SSL/TLS header info */
227 # define SSL3_RT_HEADER                  0x100
228
229 # define SSL3_AL_WARNING                 1
230 # define SSL3_AL_FATAL                   2
231
232 # define SSL3_AD_CLOSE_NOTIFY             0
233 # define SSL3_AD_UNEXPECTED_MESSAGE      10/* fatal */
234 # define SSL3_AD_BAD_RECORD_MAC          20/* fatal */
235 # define SSL3_AD_DECOMPRESSION_FAILURE   30/* fatal */
236 # define SSL3_AD_HANDSHAKE_FAILURE       40/* fatal */
237 # define SSL3_AD_NO_CERTIFICATE          41
238 # define SSL3_AD_BAD_CERTIFICATE         42
239 # define SSL3_AD_UNSUPPORTED_CERTIFICATE 43
240 # define SSL3_AD_CERTIFICATE_REVOKED     44
241 # define SSL3_AD_CERTIFICATE_EXPIRED     45
242 # define SSL3_AD_CERTIFICATE_UNKNOWN     46
243 # define SSL3_AD_ILLEGAL_PARAMETER       47/* fatal */
244
245 # define TLS1_HB_REQUEST         1
246 # define TLS1_HB_RESPONSE        2
247
248
249 # define SSL3_CT_RSA_SIGN                        1
250 # define SSL3_CT_DSS_SIGN                        2
251 # define SSL3_CT_RSA_FIXED_DH                    3
252 # define SSL3_CT_DSS_FIXED_DH                    4
253 # define SSL3_CT_RSA_EPHEMERAL_DH                5
254 # define SSL3_CT_DSS_EPHEMERAL_DH                6
255 # define SSL3_CT_FORTEZZA_DMS                    20
256 /*
257  * SSL3_CT_NUMBER is used to size arrays and it must be large enough to
258  * contain all of the cert types defined either for SSLv3 and TLSv1.
259  */
260 # define SSL3_CT_NUMBER                  9
261
262 /* No longer used as of OpenSSL 1.1.1 */
263 # define SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS       0x0001
264
265 /* Removed from OpenSSL 1.1.0 */
266 # define TLS1_FLAGS_TLS_PADDING_BUG              0x0
267
268 # define TLS1_FLAGS_SKIP_CERT_VERIFY             0x0010
269
270 /* Set if we encrypt then mac instead of usual mac then encrypt */
271 # define TLS1_FLAGS_ENCRYPT_THEN_MAC             0x0100
272
273 /* Set if extended master secret extension received from peer */
274 # define TLS1_FLAGS_RECEIVED_EXTMS               0x0200
275
276 # define SSL3_MT_HELLO_REQUEST                   0
277 # define SSL3_MT_CLIENT_HELLO                    1
278 # define SSL3_MT_SERVER_HELLO                    2
279 # define SSL3_MT_NEWSESSION_TICKET               4
280 # define SSL3_MT_ENCRYPTED_EXTENSIONS            8
281 # define SSL3_MT_CERTIFICATE                     11
282 # define SSL3_MT_SERVER_KEY_EXCHANGE             12
283 # define SSL3_MT_CERTIFICATE_REQUEST             13
284 # define SSL3_MT_SERVER_DONE                     14
285 # define SSL3_MT_CERTIFICATE_VERIFY              15
286 # define SSL3_MT_CLIENT_KEY_EXCHANGE             16
287 # define SSL3_MT_FINISHED                        20
288 # define SSL3_MT_CERTIFICATE_STATUS              22
289 # ifndef OPENSSL_NO_NEXTPROTONEG
290 #  define SSL3_MT_NEXT_PROTO                      67
291 # endif
292 # define DTLS1_MT_HELLO_VERIFY_REQUEST    3
293
294 /* Dummy message type for handling CCS like a normal handshake message */
295 # define SSL3_MT_CHANGE_CIPHER_SPEC              0x0101
296
297 # define SSL3_MT_CCS                             1
298
299 /* These are used when changing over to a new cipher */
300 # define SSL3_CC_READ            0x01
301 # define SSL3_CC_WRITE           0x02
302 # define SSL3_CC_CLIENT          0x10
303 # define SSL3_CC_SERVER          0x20
304 # define SSL3_CC_HANDSHAKE       0x40
305 # define SSL3_CC_APPLICATION     0x80
306 # define SSL3_CHANGE_CIPHER_CLIENT_WRITE (SSL3_CC_CLIENT|SSL3_CC_WRITE)
307 # define SSL3_CHANGE_CIPHER_SERVER_READ  (SSL3_CC_SERVER|SSL3_CC_READ)
308 # define SSL3_CHANGE_CIPHER_CLIENT_READ  (SSL3_CC_CLIENT|SSL3_CC_READ)
309 # define SSL3_CHANGE_CIPHER_SERVER_WRITE (SSL3_CC_SERVER|SSL3_CC_WRITE)
310
311 #ifdef  __cplusplus
312 }
313 #endif
314 #endif