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