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