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