1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
4 * This package is an SSL implementation written
5 * by Eric Young (eay@cryptsoft.com).
6 * The implementation was written so as to conform with Netscapes SSL.
8 * This library is free for commercial and non-commercial use as long as
9 * the following conditions are aheared to. The following conditions
10 * apply to all code found in this distribution, be it the RC4, RSA,
11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
12 * included with this distribution is covered by the same copyright terms
13 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15 * Copyright remains Eric Young's, and as such any Copyright notices in
16 * the code are not to be removed.
17 * If this package is used in a product, Eric Young should be given attribution
18 * as the author of the parts of the library used.
19 * This can be in the form of a textual message at program startup or
20 * in documentation (online or textual) provided with the package.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
30 * 3. All advertising materials mentioning features or use of this software
31 * must display the following acknowledgement:
32 * "This product includes cryptographic software written by
33 * Eric Young (eay@cryptsoft.com)"
34 * The word 'cryptographic' can be left out if the rouines from the library
35 * being used are not cryptographic related :-).
36 * 4. If you include any Windows specific code (or a derivative thereof) from
37 * the apps directory (application code) you must include an acknowledgement:
38 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * The licence and distribution terms for any publically available version or
53 * derivative of this code cannot be changed. i.e. this code cannot simply be
54 * copied and put under another distribution licence
55 * [including the GNU Public Licence.]
57 /* ====================================================================
58 * Copyright (c) 1998-2002 The OpenSSL Project. All rights reserved.
60 * Redistribution and use in source and binary forms, with or without
61 * modification, are permitted provided that the following conditions
64 * 1. Redistributions of source code must retain the above copyright
65 * notice, this list of conditions and the following disclaimer.
67 * 2. Redistributions in binary form must reproduce the above copyright
68 * notice, this list of conditions and the following disclaimer in
69 * the documentation and/or other materials provided with the
72 * 3. All advertising materials mentioning features or use of this
73 * software must display the following acknowledgment:
74 * "This product includes software developed by the OpenSSL Project
75 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
78 * endorse or promote products derived from this software without
79 * prior written permission. For written permission, please contact
80 * openssl-core@openssl.org.
82 * 5. Products derived from this software may not be called "OpenSSL"
83 * nor may "OpenSSL" appear in their names without prior written
84 * permission of the OpenSSL Project.
86 * 6. Redistributions of any form whatsoever must retain the following
88 * "This product includes software developed by the OpenSSL Project
89 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
92 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
93 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
94 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
95 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
96 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
97 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
98 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
99 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
100 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
101 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
102 * OF THE POSSIBILITY OF SUCH DAMAGE.
103 * ====================================================================
105 * This product includes cryptographic software written by Eric Young
106 * (eay@cryptsoft.com). This product includes software written by Tim
107 * Hudson (tjh@cryptsoft.com).
110 /* ====================================================================
111 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
112 * ECC cipher suite support in OpenSSL originally developed by
113 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
116 #ifndef HEADER_SSL3_H
117 # define HEADER_SSL3_H
119 # ifndef OPENSSL_NO_COMP
120 # include <openssl/comp.h>
122 # include <openssl/buffer.h>
123 # include <openssl/evp.h>
124 # include <openssl/ssl.h>
131 * Signalling cipher suite value from RFC 5746
132 * (TLS_EMPTY_RENEGOTIATION_INFO_SCSV)
134 # define SSL3_CK_SCSV 0x030000FF
137 * Signalling cipher suite value from draft-ietf-tls-downgrade-scsv-00
138 * (TLS_FALLBACK_SCSV)
140 # define SSL3_CK_FALLBACK_SCSV 0x03005600
142 # define SSL3_CK_RSA_NULL_MD5 0x03000001
143 # define SSL3_CK_RSA_NULL_SHA 0x03000002
144 # define SSL3_CK_RSA_RC4_40_MD5 0x03000003
145 # define SSL3_CK_RSA_RC4_128_MD5 0x03000004
146 # define SSL3_CK_RSA_RC4_128_SHA 0x03000005
147 # define SSL3_CK_RSA_RC2_40_MD5 0x03000006
148 # define SSL3_CK_RSA_IDEA_128_SHA 0x03000007
149 # define SSL3_CK_RSA_DES_40_CBC_SHA 0x03000008
150 # define SSL3_CK_RSA_DES_64_CBC_SHA 0x03000009
151 # define SSL3_CK_RSA_DES_192_CBC3_SHA 0x0300000A
153 # define SSL3_CK_DH_DSS_DES_40_CBC_SHA 0x0300000B
154 # define SSL3_CK_DH_DSS_DES_64_CBC_SHA 0x0300000C
155 # define SSL3_CK_DH_DSS_DES_192_CBC3_SHA 0x0300000D
156 # define SSL3_CK_DH_RSA_DES_40_CBC_SHA 0x0300000E
157 # define SSL3_CK_DH_RSA_DES_64_CBC_SHA 0x0300000F
158 # define SSL3_CK_DH_RSA_DES_192_CBC3_SHA 0x03000010
160 # define SSL3_CK_DHE_DSS_DES_40_CBC_SHA 0x03000011
161 # define SSL3_CK_EDH_DSS_DES_40_CBC_SHA SSL3_CK_DHE_DSS_DES_40_CBC_SHA
162 # define SSL3_CK_DHE_DSS_DES_64_CBC_SHA 0x03000012
163 # define SSL3_CK_EDH_DSS_DES_64_CBC_SHA SSL3_CK_DHE_DSS_DES_64_CBC_SHA
164 # define SSL3_CK_DHE_DSS_DES_192_CBC3_SHA 0x03000013
165 # define SSL3_CK_EDH_DSS_DES_192_CBC3_SHA SSL3_CK_DHE_DSS_DES_192_CBC3_SHA
166 # define SSL3_CK_DHE_RSA_DES_40_CBC_SHA 0x03000014
167 # define SSL3_CK_EDH_RSA_DES_40_CBC_SHA SSL3_CK_DHE_RSA_DES_40_CBC_SHA
168 # define SSL3_CK_DHE_RSA_DES_64_CBC_SHA 0x03000015
169 # define SSL3_CK_EDH_RSA_DES_64_CBC_SHA SSL3_CK_DHE_RSA_DES_64_CBC_SHA
170 # define SSL3_CK_DHE_RSA_DES_192_CBC3_SHA 0x03000016
171 # define SSL3_CK_EDH_RSA_DES_192_CBC3_SHA SSL3_CK_DHE_RSA_DES_192_CBC3_SHA
173 # define SSL3_CK_ADH_RC4_40_MD5 0x03000017
174 # define SSL3_CK_ADH_RC4_128_MD5 0x03000018
175 # define SSL3_CK_ADH_DES_40_CBC_SHA 0x03000019
176 # define SSL3_CK_ADH_DES_64_CBC_SHA 0x0300001A
177 # define SSL3_CK_ADH_DES_192_CBC_SHA 0x0300001B
179 # define SSL3_TXT_RSA_NULL_MD5 "NULL-MD5"
180 # define SSL3_TXT_RSA_NULL_SHA "NULL-SHA"
181 # define SSL3_TXT_RSA_RC4_40_MD5 "EXP-RC4-MD5"
182 # define SSL3_TXT_RSA_RC4_128_MD5 "RC4-MD5"
183 # define SSL3_TXT_RSA_RC4_128_SHA "RC4-SHA"
184 # define SSL3_TXT_RSA_RC2_40_MD5 "EXP-RC2-CBC-MD5"
185 # define SSL3_TXT_RSA_IDEA_128_SHA "IDEA-CBC-SHA"
186 # define SSL3_TXT_RSA_DES_40_CBC_SHA "EXP-DES-CBC-SHA"
187 # define SSL3_TXT_RSA_DES_64_CBC_SHA "DES-CBC-SHA"
188 # define SSL3_TXT_RSA_DES_192_CBC3_SHA "DES-CBC3-SHA"
190 # define SSL3_TXT_DH_DSS_DES_40_CBC_SHA "EXP-DH-DSS-DES-CBC-SHA"
191 # define SSL3_TXT_DH_DSS_DES_64_CBC_SHA "DH-DSS-DES-CBC-SHA"
192 # define SSL3_TXT_DH_DSS_DES_192_CBC3_SHA "DH-DSS-DES-CBC3-SHA"
193 # define SSL3_TXT_DH_RSA_DES_40_CBC_SHA "EXP-DH-RSA-DES-CBC-SHA"
194 # define SSL3_TXT_DH_RSA_DES_64_CBC_SHA "DH-RSA-DES-CBC-SHA"
195 # define SSL3_TXT_DH_RSA_DES_192_CBC3_SHA "DH-RSA-DES-CBC3-SHA"
197 # define SSL3_TXT_DHE_DSS_DES_40_CBC_SHA "EXP-DHE-DSS-DES-CBC-SHA"
198 # define SSL3_TXT_DHE_DSS_DES_64_CBC_SHA "DHE-DSS-DES-CBC-SHA"
199 # define SSL3_TXT_DHE_DSS_DES_192_CBC3_SHA "DHE-DSS-DES-CBC3-SHA"
200 # define SSL3_TXT_DHE_RSA_DES_40_CBC_SHA "EXP-DHE-RSA-DES-CBC-SHA"
201 # define SSL3_TXT_DHE_RSA_DES_64_CBC_SHA "DHE-RSA-DES-CBC-SHA"
202 # define SSL3_TXT_DHE_RSA_DES_192_CBC3_SHA "DHE-RSA-DES-CBC3-SHA"
205 * This next block of six "EDH" labels is for backward compatibility with
206 * older versions of OpenSSL. New code should use the six "DHE" labels above
209 # define SSL3_TXT_EDH_DSS_DES_40_CBC_SHA "EXP-EDH-DSS-DES-CBC-SHA"
210 # define SSL3_TXT_EDH_DSS_DES_64_CBC_SHA "EDH-DSS-DES-CBC-SHA"
211 # define SSL3_TXT_EDH_DSS_DES_192_CBC3_SHA "EDH-DSS-DES-CBC3-SHA"
212 # define SSL3_TXT_EDH_RSA_DES_40_CBC_SHA "EXP-EDH-RSA-DES-CBC-SHA"
213 # define SSL3_TXT_EDH_RSA_DES_64_CBC_SHA "EDH-RSA-DES-CBC-SHA"
214 # define SSL3_TXT_EDH_RSA_DES_192_CBC3_SHA "EDH-RSA-DES-CBC3-SHA"
216 # define SSL3_TXT_ADH_RC4_40_MD5 "EXP-ADH-RC4-MD5"
217 # define SSL3_TXT_ADH_RC4_128_MD5 "ADH-RC4-MD5"
218 # define SSL3_TXT_ADH_DES_40_CBC_SHA "EXP-ADH-DES-CBC-SHA"
219 # define SSL3_TXT_ADH_DES_64_CBC_SHA "ADH-DES-CBC-SHA"
220 # define SSL3_TXT_ADH_DES_192_CBC_SHA "ADH-DES-CBC3-SHA"
222 # define SSL3_SSL_SESSION_ID_LENGTH 32
223 # define SSL3_MAX_SSL_SESSION_ID_LENGTH 32
225 # define SSL3_MASTER_SECRET_SIZE 48
226 # define SSL3_RANDOM_SIZE 32
227 # define SSL3_SESSION_ID_SIZE 32
228 # define SSL3_RT_HEADER_LENGTH 5
230 # define SSL3_HM_HEADER_LENGTH 4
232 # ifndef SSL3_ALIGN_PAYLOAD
234 * Some will argue that this increases memory footprint, but it's not
235 * actually true. Point is that malloc has to return at least 64-bit aligned
236 * pointers, meaning that allocating 5 bytes wastes 3 bytes in either case.
237 * Suggested pre-gaping simply moves these wasted bytes from the end of
238 * allocated region to its front, but makes data payload aligned, which
239 * improves performance:-)
241 # define SSL3_ALIGN_PAYLOAD 8
243 # if (SSL3_ALIGN_PAYLOAD&(SSL3_ALIGN_PAYLOAD-1))!=0
244 # error "insane SSL3_ALIGN_PAYLOAD"
245 # undef SSL3_ALIGN_PAYLOAD
250 * This is the maximum MAC (digest) size used by the SSL library. Currently
251 * maximum of 20 is used by SHA1, but we reserve for future extension for
255 # define SSL3_RT_MAX_MD_SIZE 64
258 * Maximum block size used in all ciphersuites. Currently 16 for AES.
261 # define SSL_RT_MAX_CIPHER_BLOCK_SIZE 16
263 # define SSL3_RT_MAX_EXTRA (16384)
265 /* Maximum plaintext length: defined by SSL/TLS standards */
266 # define SSL3_RT_MAX_PLAIN_LENGTH 16384
267 /* Maximum compression overhead: defined by SSL/TLS standards */
268 # define SSL3_RT_MAX_COMPRESSED_OVERHEAD 1024
271 * The standards give a maximum encryption overhead of 1024 bytes. In
272 * practice the value is lower than this. The overhead is the maximum number
273 * of padding bytes (256) plus the mac size.
275 # define SSL3_RT_MAX_ENCRYPTED_OVERHEAD (256 + SSL3_RT_MAX_MD_SIZE)
278 * OpenSSL currently only uses a padding length of at most one block so the
279 * send overhead is smaller.
282 # define SSL3_RT_SEND_MAX_ENCRYPTED_OVERHEAD \
283 (SSL_RT_MAX_CIPHER_BLOCK_SIZE + SSL3_RT_MAX_MD_SIZE)
285 /* If compression isn't used don't include the compression overhead */
287 # ifdef OPENSSL_NO_COMP
288 # define SSL3_RT_MAX_COMPRESSED_LENGTH SSL3_RT_MAX_PLAIN_LENGTH
290 # define SSL3_RT_MAX_COMPRESSED_LENGTH \
291 (SSL3_RT_MAX_PLAIN_LENGTH+SSL3_RT_MAX_COMPRESSED_OVERHEAD)
293 # define SSL3_RT_MAX_ENCRYPTED_LENGTH \
294 (SSL3_RT_MAX_ENCRYPTED_OVERHEAD+SSL3_RT_MAX_COMPRESSED_LENGTH)
295 # define SSL3_RT_MAX_PACKET_SIZE \
296 (SSL3_RT_MAX_ENCRYPTED_LENGTH+SSL3_RT_HEADER_LENGTH)
298 # define SSL3_MD_CLIENT_FINISHED_CONST "\x43\x4C\x4E\x54"
299 # define SSL3_MD_SERVER_FINISHED_CONST "\x53\x52\x56\x52"
301 # define SSL3_VERSION 0x0300
302 # define SSL3_VERSION_MAJOR 0x03
303 # define SSL3_VERSION_MINOR 0x00
305 # define SSL3_RT_CHANGE_CIPHER_SPEC 20
306 # define SSL3_RT_ALERT 21
307 # define SSL3_RT_HANDSHAKE 22
308 # define SSL3_RT_APPLICATION_DATA 23
309 # define DTLS1_RT_HEARTBEAT 24
311 /* Pseudo content types to indicate additional parameters */
312 # define TLS1_RT_CRYPTO 0x1000
313 # define TLS1_RT_CRYPTO_PREMASTER (TLS1_RT_CRYPTO | 0x1)
314 # define TLS1_RT_CRYPTO_CLIENT_RANDOM (TLS1_RT_CRYPTO | 0x2)
315 # define TLS1_RT_CRYPTO_SERVER_RANDOM (TLS1_RT_CRYPTO | 0x3)
316 # define TLS1_RT_CRYPTO_MASTER (TLS1_RT_CRYPTO | 0x4)
318 # define TLS1_RT_CRYPTO_READ 0x0000
319 # define TLS1_RT_CRYPTO_WRITE 0x0100
320 # define TLS1_RT_CRYPTO_MAC (TLS1_RT_CRYPTO | 0x5)
321 # define TLS1_RT_CRYPTO_KEY (TLS1_RT_CRYPTO | 0x6)
322 # define TLS1_RT_CRYPTO_IV (TLS1_RT_CRYPTO | 0x7)
323 # define TLS1_RT_CRYPTO_FIXED_IV (TLS1_RT_CRYPTO | 0x8)
325 /* Pseudo content type for SSL/TLS header info */
326 # define SSL3_RT_HEADER 0x100
328 # define SSL3_AL_WARNING 1
329 # define SSL3_AL_FATAL 2
331 # define SSL3_AD_CLOSE_NOTIFY 0
332 # define SSL3_AD_UNEXPECTED_MESSAGE 10/* fatal */
333 # define SSL3_AD_BAD_RECORD_MAC 20/* fatal */
334 # define SSL3_AD_DECOMPRESSION_FAILURE 30/* fatal */
335 # define SSL3_AD_HANDSHAKE_FAILURE 40/* fatal */
336 # define SSL3_AD_NO_CERTIFICATE 41
337 # define SSL3_AD_BAD_CERTIFICATE 42
338 # define SSL3_AD_UNSUPPORTED_CERTIFICATE 43
339 # define SSL3_AD_CERTIFICATE_REVOKED 44
340 # define SSL3_AD_CERTIFICATE_EXPIRED 45
341 # define SSL3_AD_CERTIFICATE_UNKNOWN 46
342 # define SSL3_AD_ILLEGAL_PARAMETER 47/* fatal */
344 # define TLS1_HB_REQUEST 1
345 # define TLS1_HB_RESPONSE 2
348 # define SSL3_CT_RSA_SIGN 1
349 # define SSL3_CT_DSS_SIGN 2
350 # define SSL3_CT_RSA_FIXED_DH 3
351 # define SSL3_CT_DSS_FIXED_DH 4
352 # define SSL3_CT_RSA_EPHEMERAL_DH 5
353 # define SSL3_CT_DSS_EPHEMERAL_DH 6
354 # define SSL3_CT_FORTEZZA_DMS 20
356 * SSL3_CT_NUMBER is used to size arrays and it must be large enough to
357 * contain all of the cert types defined either for SSLv3 and TLSv1.
359 # define SSL3_CT_NUMBER 9
361 # define SSL3_FLAGS_NO_RENEGOTIATE_CIPHERS 0x0001
363 /* Removed from OpenSSL 1.1.0 */
364 # define TLS1_FLAGS_TLS_PADDING_BUG 0x0
366 # define TLS1_FLAGS_SKIP_CERT_VERIFY 0x0010
368 /* Set if we encrypt then mac instead of usual mac then encrypt */
369 # define TLS1_FLAGS_ENCRYPT_THEN_MAC 0x0100
371 /* Set if extended master secret extension received from peer */
372 # define TLS1_FLAGS_RECEIVED_EXTMS 0x0200
374 # define SSL3_MT_HELLO_REQUEST 0
375 # define SSL3_MT_CLIENT_HELLO 1
376 # define SSL3_MT_SERVER_HELLO 2
377 # define SSL3_MT_NEWSESSION_TICKET 4
378 # define SSL3_MT_CERTIFICATE 11
379 # define SSL3_MT_SERVER_KEY_EXCHANGE 12
380 # define SSL3_MT_CERTIFICATE_REQUEST 13
381 # define SSL3_MT_SERVER_DONE 14
382 # define SSL3_MT_CERTIFICATE_VERIFY 15
383 # define SSL3_MT_CLIENT_KEY_EXCHANGE 16
384 # define SSL3_MT_FINISHED 20
385 # define SSL3_MT_CERTIFICATE_STATUS 22
386 # ifndef OPENSSL_NO_NEXTPROTONEG
387 # define SSL3_MT_NEXT_PROTO 67
389 # define DTLS1_MT_HELLO_VERIFY_REQUEST 3
391 /* Dummy message type for handling CCS like a normal handshake message */
392 # define SSL3_MT_CHANGE_CIPHER_SPEC 0x0101
394 # define SSL3_MT_CCS 1
396 /* These are used when changing over to a new cipher */
397 # define SSL3_CC_READ 0x01
398 # define SSL3_CC_WRITE 0x02
399 # define SSL3_CC_CLIENT 0x10
400 # define SSL3_CC_SERVER 0x20
401 # define SSL3_CHANGE_CIPHER_CLIENT_WRITE (SSL3_CC_CLIENT|SSL3_CC_WRITE)
402 # define SSL3_CHANGE_CIPHER_SERVER_READ (SSL3_CC_SERVER|SSL3_CC_READ)
403 # define SSL3_CHANGE_CIPHER_CLIENT_READ (SSL3_CC_CLIENT|SSL3_CC_READ)
404 # define SSL3_CHANGE_CIPHER_SERVER_WRITE (SSL3_CC_SERVER|SSL3_CC_WRITE)