ECC ciphersuite support
[openssl.git] / ssl / tls1.h
1 /* ssl/tls1.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60  *
61  * Portions of the attached software ("Contribution") are developed by 
62  * SUN MICROSYSTEMS, INC., and are contributed to the OpenSSL project.
63  *
64  * The Contribution is licensed pursuant to the OpenSSL open source
65  * license provided above.
66  *
67  * In addition, Sun covenants to all licensees who provide a reciprocal
68  * covenant with respect to their own patents if any, not to sue under
69  * current and future patent claims necessarily infringed by the making,
70  * using, practicing, selling, offering for sale and/or otherwise
71  * disposing of the Contribution as delivered hereunder 
72  * (or portions thereof), provided that such covenant shall not apply:
73  *  1) for code that a licensee deletes from the Contribution;
74  *  2) separates from the Contribution; or
75  *  3) for infringements caused by:
76  *       i) the modification of the Contribution or
77  *      ii) the combination of the  Contribution with other software or
78  *          devices where such combination causes the infringement.
79  *
80  * ECC cipher suite support in OpenSSL originally written by
81  * Vipul Gupta and Sumit Gupta of Sun Microsystems Laboratories.
82  *
83  */
84
85 #ifndef HEADER_TLS1_H 
86 #define HEADER_TLS1_H 
87
88 #include <openssl/buffer.h>
89
90 #ifdef  __cplusplus
91 extern "C" {
92 #endif
93
94 #define TLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES    1
95
96 #define TLS1_VERSION                    0x0301
97 #define TLS1_VERSION_MAJOR              0x03
98 #define TLS1_VERSION_MINOR              0x01
99
100 #define TLS1_AD_DECRYPTION_FAILED       21
101 #define TLS1_AD_RECORD_OVERFLOW         22
102 #define TLS1_AD_UNKNOWN_CA              48      /* fatal */
103 #define TLS1_AD_ACCESS_DENIED           49      /* fatal */
104 #define TLS1_AD_DECODE_ERROR            50      /* fatal */
105 #define TLS1_AD_DECRYPT_ERROR           51
106 #define TLS1_AD_EXPORT_RESTRICTION      60      /* fatal */
107 #define TLS1_AD_PROTOCOL_VERSION        70      /* fatal */
108 #define TLS1_AD_INSUFFICIENT_SECURITY   71      /* fatal */
109 #define TLS1_AD_INTERNAL_ERROR          80      /* fatal */
110 #define TLS1_AD_USER_CANCELLED          90
111 #define TLS1_AD_NO_RENEGOTIATION        100
112
113 /* Additional TLS ciphersuites from draft-ietf-tls-56-bit-ciphersuites-00.txt
114  * (available if TLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES is defined, see
115  * s3_lib.c).  We actually treat them like SSL 3.0 ciphers, which we probably
116  * shouldn't. */
117 #define TLS1_CK_RSA_EXPORT1024_WITH_RC4_56_MD5          0x03000060
118 #define TLS1_CK_RSA_EXPORT1024_WITH_RC2_CBC_56_MD5      0x03000061
119 #define TLS1_CK_RSA_EXPORT1024_WITH_DES_CBC_SHA         0x03000062
120 #define TLS1_CK_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA     0x03000063
121 #define TLS1_CK_RSA_EXPORT1024_WITH_RC4_56_SHA          0x03000064
122 #define TLS1_CK_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA      0x03000065
123 #define TLS1_CK_DHE_DSS_WITH_RC4_128_SHA                0x03000066
124
125 /* AES ciphersuites from RFC3268 */
126
127 #define TLS1_CK_RSA_WITH_AES_128_SHA                    0x0300002F
128 #define TLS1_CK_DH_DSS_WITH_AES_128_SHA                 0x03000030
129 #define TLS1_CK_DH_RSA_WITH_AES_128_SHA                 0x03000031
130 #define TLS1_CK_DHE_DSS_WITH_AES_128_SHA                0x03000032
131 #define TLS1_CK_DHE_RSA_WITH_AES_128_SHA                0x03000033
132 #define TLS1_CK_ADH_WITH_AES_128_SHA                    0x03000034
133
134 #define TLS1_CK_RSA_WITH_AES_256_SHA                    0x03000035
135 #define TLS1_CK_DH_DSS_WITH_AES_256_SHA                 0x03000036
136 #define TLS1_CK_DH_RSA_WITH_AES_256_SHA                 0x03000037
137 #define TLS1_CK_DHE_DSS_WITH_AES_256_SHA                0x03000038
138 #define TLS1_CK_DHE_RSA_WITH_AES_256_SHA                0x03000039
139 #define TLS1_CK_ADH_WITH_AES_256_SHA                    0x0300003A
140
141 /* ECC ciphersuites from draft-ietf-tls-ecc-01.txt (Mar 15, 2001).
142  * XXX NOTE: There is a bug in the draft, cipher numbers 4B, and 4C
143  * are defined twice so we define ECDH_ECDSA_EXPORT cipher
144  * suites to use 5B and 5C instead (this may change with future
145  * updates to the IETF draft).
146  */
147 #define TLS1_CK_ECDH_ECDSA_WITH_NULL_SHA                0x03000047
148 #define TLS1_CK_ECDH_ECDSA_WITH_RC4_128_SHA             0x03000048
149 #define TLS1_CK_ECDH_ECDSA_WITH_DES_CBC_SHA             0x03000049
150 #define TLS1_CK_ECDH_ECDSA_WITH_DES_192_CBC3_SHA        0x0300004A
151 #define TLS1_CK_ECDH_ECDSA_WITH_AES_128_CBC_SHA         0x0300004B
152 #define TLS1_CK_ECDH_ECDSA_WITH_AES_256_CBC_SHA         0x0300004C
153 #define TLS1_CK_ECDH_ECDSA_EXPORT_WITH_RC4_40_SHA       0x0300005B
154 #define TLS1_CK_ECDH_ECDSA_EXPORT_WITH_RC4_56_SHA       0x0300005C
155
156 #define TLS1_CK_ECDH_RSA_WITH_NULL_SHA                  0x0300004D
157 #define TLS1_CK_ECDH_RSA_WITH_RC4_128_SHA               0x0300004E
158 #define TLS1_CK_ECDH_RSA_WITH_DES_CBC_SHA               0x0300004F
159 #define TLS1_CK_ECDH_RSA_WITH_DES_192_CBC3_SHA          0x03000050
160 #define TLS1_CK_ECDH_RSA_WITH_AES_128_CBC_SHA           0x03000051
161 #define TLS1_CK_ECDH_RSA_WITH_AES_256_CBC_SHA           0x03000052
162 #define TLS1_CK_ECDH_RSA_EXPORT_WITH_RC4_40_SHA         0x03000053
163 #define TLS1_CK_ECDH_RSA_EXPORT_WITH_RC4_56_SHA         0x03000054
164
165 #define TLS1_CK_ECDH_anon_WITH_NULL_SHA                 0x03000055
166 #define TLS1_CK_ECDH_anon_WITH_RC4_128_SHA              0x03000056
167 #define TLS1_CK_ECDH_anon_WITH_DES_CBC_SHA              0x03000057
168 #define TLS1_CK_ECDH_anon_WITH_DES_192_CBC3_SHA         0x03000058
169 #define TLS1_CK_ECDH_anon_EXPORT_WITH_DES_40_CBC_SHA    0x03000059
170 #define TLS1_CK_ECDH_anon_EXPORT_WITH_RC4_40_SHA        0x0300005A
171
172 /* XXX: ECC ciphersuites offering forward secrecy are not yet specified
173  * in the ECC/TLS draft but our code allows them to be implemented
174  * very easily. To add such a cipher suite, one needs to add two constant
175  * definitions to this file and a new structure in s3_lib.c. We illustrate
176  * the process for the made-up ciphers ECDHE-ECDSA-AES128-SHA and
177  * ECDHE-RSA-AES128-SHA.
178  */
179 #define TLS1_CK_ECDHE_ECDSA_WITH_AES_128_CBC_SHA        0x03000077
180 #define TLS1_CK_ECDHE_RSA_WITH_AES_128_CBC_SHA          0x03000078
181
182
183 /* XXX
184  * Inconsistency alert:
185  * The OpenSSL names of ciphers with ephemeral DH here include the string
186  * "DHE", while elsewhere it has always been "EDH".
187  * (The alias for the list of all such ciphers also is "EDH".)
188  * The specifications speak of "EDH"; maybe we should allow both forms
189  * for everything. */
190 #define TLS1_TXT_RSA_EXPORT1024_WITH_RC4_56_MD5         "EXP1024-RC4-MD5"
191 #define TLS1_TXT_RSA_EXPORT1024_WITH_RC2_CBC_56_MD5     "EXP1024-RC2-CBC-MD5"
192 #define TLS1_TXT_RSA_EXPORT1024_WITH_DES_CBC_SHA        "EXP1024-DES-CBC-SHA"
193 #define TLS1_TXT_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA    "EXP1024-DHE-DSS-DES-CBC-SHA"
194 #define TLS1_TXT_RSA_EXPORT1024_WITH_RC4_56_SHA         "EXP1024-RC4-SHA"
195 #define TLS1_TXT_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA     "EXP1024-DHE-DSS-RC4-SHA"
196 #define TLS1_TXT_DHE_DSS_WITH_RC4_128_SHA               "DHE-DSS-RC4-SHA"
197
198 /* AES ciphersuites from RFC3268 */
199 #define TLS1_TXT_RSA_WITH_AES_128_SHA                   "AES128-SHA"
200 #define TLS1_TXT_DH_DSS_WITH_AES_128_SHA                "DH-DSS-AES128-SHA"
201 #define TLS1_TXT_DH_RSA_WITH_AES_128_SHA                "DH-RSA-AES128-SHA"
202 #define TLS1_TXT_DHE_DSS_WITH_AES_128_SHA               "DHE-DSS-AES128-SHA"
203 #define TLS1_TXT_DHE_RSA_WITH_AES_128_SHA               "DHE-RSA-AES128-SHA"
204 #define TLS1_TXT_ADH_WITH_AES_128_SHA                   "ADH-AES128-SHA"
205
206 #define TLS1_TXT_RSA_WITH_AES_256_SHA                   "AES256-SHA"
207 #define TLS1_TXT_DH_DSS_WITH_AES_256_SHA                "DH-DSS-AES256-SHA"
208 #define TLS1_TXT_DH_RSA_WITH_AES_256_SHA                "DH-RSA-AES256-SHA"
209 #define TLS1_TXT_DHE_DSS_WITH_AES_256_SHA               "DHE-DSS-AES256-SHA"
210 #define TLS1_TXT_DHE_RSA_WITH_AES_256_SHA               "DHE-RSA-AES256-SHA"
211 #define TLS1_TXT_ADH_WITH_AES_256_SHA                   "ADH-AES256-SHA"
212
213 /* ECC ciphersuites from draft-ietf-tls-ecc-01.txt (Mar 15, 2001) */
214 #define TLS1_TXT_ECDH_ECDSA_WITH_NULL_SHA               "ECDH-ECDSA-NULL-SHA"
215 #define TLS1_TXT_ECDH_ECDSA_WITH_RC4_128_SHA            "ECDH-ECDSA-RC4-SHA"
216 #define TLS1_TXT_ECDH_ECDSA_WITH_DES_CBC_SHA            "ECDH-ECDSA-DES-CBC-SHA"
217 #define TLS1_TXT_ECDH_ECDSA_WITH_DES_192_CBC3_SHA       "ECDH-ECDSA-DES-CBC3-SHA"
218 #define TLS1_TXT_ECDH_ECDSA_WITH_AES_128_CBC_SHA        "ECDH-ECDSA-AES128-SHA"
219 #define TLS1_TXT_ECDH_ECDSA_WITH_AES_256_CBC_SHA        "ECDH-ECDSA-AES256-SHA"
220 #define TLS1_TXT_ECDH_ECDSA_EXPORT_WITH_RC4_40_SHA      "EXP-ECDH-ECDSA-RC4-40-SHA"
221 #define TLS1_TXT_ECDH_ECDSA_EXPORT_WITH_RC4_56_SHA      "EXP-ECDH-ECDSA-RC4-56-SHA"
222
223 #define TLS1_TXT_ECDH_RSA_WITH_NULL_SHA                 "ECDH-RSA-NULL-SHA"
224 #define TLS1_TXT_ECDH_RSA_WITH_RC4_128_SHA              "ECDH-RSA-RC4-SHA"
225 #define TLS1_TXT_ECDH_RSA_WITH_DES_CBC_SHA              "ECDH-RSA-DES-CBC-SHA"
226 #define TLS1_TXT_ECDH_RSA_WITH_DES_192_CBC3_SHA         "ECDH-RSA-DES-CBC3-SHA"
227 #define TLS1_TXT_ECDH_RSA_WITH_AES_128_CBC_SHA          "ECDH-RSA-AES128-SHA"
228 #define TLS1_TXT_ECDH_RSA_WITH_AES_256_CBC_SHA          "ECDH-RSA-AES256-SHA"
229 #define TLS1_TXT_ECDH_RSA_EXPORT_WITH_RC4_40_SHA        "EXP-ECDH-RSA-RC4-40-SHA"
230 #define TLS1_TXT_ECDH_RSA_EXPORT_WITH_RC4_56_SHA        "EXP-ECDH-RSA-RC4-56-SHA"
231
232 #define TLS1_TXT_ECDH_anon_WITH_NULL_SHA                "AECDH-NULL-SHA"
233 #define TLS1_TXT_ECDH_anon_WITH_RC4_128_SHA             "AECDH-RC4-SHA"
234 #define TLS1_TXT_ECDH_anon_WITH_DES_CBC_SHA             "AECDH-DES-CBC-SHA"
235 #define TLS1_TXT_ECDH_anon_WITH_DES_192_CBC3_SHA        "AECDH-DES-CBC3-SHA"
236 #define TLS1_TXT_ECDH_anon_EXPORT_WITH_DES_40_CBC_SHA   "EXP-AECDH-DES-40-CBC-SHA"
237 #define TLS1_TXT_ECDH_anon_EXPORT_WITH_RC4_40_SHA       "EXP-AECDH-RC4-40-SHA"
238
239 /* XXX: Made-up ECC cipher suites offering forward secrecy. This is for 
240  * illustration only. 
241  */
242 #define TLS1_TXT_ECDHE_ECDSA_WITH_AES_128_CBC_SHA       "ECDHE-ECDSA-AES128-SHA"
243 #define TLS1_TXT_ECDHE_RSA_WITH_AES_128_CBC_SHA         "ECDHE-RSA-AES128-SHA"
244
245
246 #define TLS_CT_RSA_SIGN                 1
247 #define TLS_CT_DSS_SIGN                 2
248 #define TLS_CT_RSA_FIXED_DH             3
249 #define TLS_CT_DSS_FIXED_DH             4
250 #define TLS_CT_ECDSA_SIGN               5
251 #define TLS_CT_RSA_FIXED_ECDH           6
252 #define TLS_CT_ECDSA_FIXED_ECDH         7
253 #define TLS_CT_NUMBER                   7
254
255 #define TLS1_FINISH_MAC_LENGTH          12
256
257 #define TLS_MD_MAX_CONST_SIZE                   20
258 #define TLS_MD_CLIENT_FINISH_CONST              "client finished"
259 #define TLS_MD_CLIENT_FINISH_CONST_SIZE         15
260 #define TLS_MD_SERVER_FINISH_CONST              "server finished"
261 #define TLS_MD_SERVER_FINISH_CONST_SIZE         15
262 #define TLS_MD_SERVER_WRITE_KEY_CONST           "server write key"
263 #define TLS_MD_SERVER_WRITE_KEY_CONST_SIZE      16
264 #define TLS_MD_KEY_EXPANSION_CONST              "key expansion"
265 #define TLS_MD_KEY_EXPANSION_CONST_SIZE         13
266 #define TLS_MD_CLIENT_WRITE_KEY_CONST           "client write key"
267 #define TLS_MD_CLIENT_WRITE_KEY_CONST_SIZE      16
268 #define TLS_MD_SERVER_WRITE_KEY_CONST           "server write key"
269 #define TLS_MD_SERVER_WRITE_KEY_CONST_SIZE      16
270 #define TLS_MD_IV_BLOCK_CONST                   "IV block"
271 #define TLS_MD_IV_BLOCK_CONST_SIZE              8
272 #define TLS_MD_MASTER_SECRET_CONST              "master secret"
273 #define TLS_MD_MASTER_SECRET_CONST_SIZE         13
274
275 #ifdef CHARSET_EBCDIC
276 #undef TLS_MD_CLIENT_FINISH_CONST
277 #define TLS_MD_CLIENT_FINISH_CONST    "\x63\x6c\x69\x65\x6e\x74\x20\x66\x69\x6e\x69\x73\x68\x65\x64"  /*client finished*/
278 #undef TLS_MD_SERVER_FINISH_CONST
279 #define TLS_MD_SERVER_FINISH_CONST    "\x73\x65\x72\x76\x65\x72\x20\x66\x69\x6e\x69\x73\x68\x65\x64"  /*server finished*/
280 #undef TLS_MD_SERVER_WRITE_KEY_CONST
281 #define TLS_MD_SERVER_WRITE_KEY_CONST "\x73\x65\x72\x76\x65\x72\x20\x77\x72\x69\x74\x65\x20\x6b\x65\x79"  /*server write key*/
282 #undef TLS_MD_KEY_EXPANSION_CONST
283 #define TLS_MD_KEY_EXPANSION_CONST    "\x6b\x65\x79\x20\x65\x78\x70\x61\x6e\x73\x69\x6f\x6e"  /*key expansion*/
284 #undef TLS_MD_CLIENT_WRITE_KEY_CONST
285 #define TLS_MD_CLIENT_WRITE_KEY_CONST "\x63\x6c\x69\x65\x6e\x74\x20\x77\x72\x69\x74\x65\x20\x6b\x65\x79"  /*client write key*/
286 #undef TLS_MD_SERVER_WRITE_KEY_CONST
287 #define TLS_MD_SERVER_WRITE_KEY_CONST "\x73\x65\x72\x76\x65\x72\x20\x77\x72\x69\x74\x65\x20\x6b\x65\x79"  /*server write key*/
288 #undef TLS_MD_IV_BLOCK_CONST
289 #define TLS_MD_IV_BLOCK_CONST         "\x49\x56\x20\x62\x6c\x6f\x63\x6b"  /*IV block*/
290 #undef TLS_MD_MASTER_SECRET_CONST
291 #define TLS_MD_MASTER_SECRET_CONST    "\x6d\x61\x73\x74\x65\x72\x20\x73\x65\x63\x72\x65\x74"  /*master secret*/
292 #endif
293
294 #ifdef  __cplusplus
295 }
296 #endif
297 #endif
298
299
300