4c8a5daa563ff5f3f33d41113467b11d055c8fbd
[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  * ECC cipher suite support in OpenSSL originally written by
68  * Vipul Gupta and Sumit Gupta of Sun Microsystems Laboratories.
69  *
70  */
71
72 #ifndef HEADER_TLS1_H 
73 #define HEADER_TLS1_H 
74
75 #include <openssl/buffer.h>
76
77 #ifdef  __cplusplus
78 extern "C" {
79 #endif
80
81 #define TLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES    1
82
83 #define TLS1_VERSION                    0x0301
84 #define TLS1_VERSION_MAJOR              0x03
85 #define TLS1_VERSION_MINOR              0x01
86
87 #define TLS1_AD_DECRYPTION_FAILED       21
88 #define TLS1_AD_RECORD_OVERFLOW         22
89 #define TLS1_AD_UNKNOWN_CA              48      /* fatal */
90 #define TLS1_AD_ACCESS_DENIED           49      /* fatal */
91 #define TLS1_AD_DECODE_ERROR            50      /* fatal */
92 #define TLS1_AD_DECRYPT_ERROR           51
93 #define TLS1_AD_EXPORT_RESTRICTION      60      /* fatal */
94 #define TLS1_AD_PROTOCOL_VERSION        70      /* fatal */
95 #define TLS1_AD_INSUFFICIENT_SECURITY   71      /* fatal */
96 #define TLS1_AD_INTERNAL_ERROR          80      /* fatal */
97 #define TLS1_AD_USER_CANCELLED          90
98 #define TLS1_AD_NO_RENEGOTIATION        100
99
100 #ifndef OPENSSL_NO_TLSEXT
101 #define TLS1_AD_UNRECOGNIZED_NAME       122
102
103 #define TLSEXT_TYPE_server_name                 0
104 #define TLSEXT_TYPE_max_fragment_length         1
105 #define TLSEXT_TYPE_client_certificate_url      2
106 #define TLSEXT_TYPE_trusted_ca_keys             3
107 #define TLSEXT_TYPE_truncated_hmac              4
108 #define TLSEXT_TYPE_status_request              5
109 #define TLSEXT_TYPE_srp                         6
110
111 #define TLSEXT_TYPE_SERVER_host 0
112
113 #define SSL_CTX_set_tlsext_hostname(ctx,name) \
114 SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TLSEXT_HOSTNAME,TLSEXT_TYPE_SERVER_host,(char *)name)
115 #define SSL_set_tlsext_hostname(s,name) \
116 SSL_ctrl(s,SSL_CTRL_SET_TLSEXT_HOSTNAME,TLSEXT_TYPE_SERVER_host,(char *)name)
117
118 #define SSL_CTX_set_tlsext_servername_callback(ctx, cb) \
119 SSL_CTX_callback_ctrl(ctx,SSL_CTRL_SET_TLSEXT_SERVERNAME_CB,(void (*)(void))cb)
120 #define SSL_CTX_set_tlsext_servername_arg(ctx, arg) \
121 SSL_CTX_ctrl(ctx,SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG,0, (void *)arg)
122
123
124 const char *SSL_get_servername(const SSL *s, const int type) ;
125 int SSL_get_servername_type(const SSL *s) ;
126
127 #if 0
128         #define SSL_get_tlsext_hostname(s,psn) \
129         SSL_ctrl(s,SSL_CTRL_GET_TLSEXT_HOSTNAME,TLSEXT_TYPE_SERVER_host, (void *)psn)
130 #else
131         #define SSL_get_tlsext_hostname(s,psn) \
132         (*psn = SSL_get_servername(s, TLSEXT_TYPE_SERVER_host),*psn != NULL)
133 #endif
134         #define SSL_set_tlsext_servername_done(s,t) \
135         SSL_ctrl(s,SSL_CTRL_SET_TLSEXT_SERVERNAME_DONE,t, NULL)
136
137 void SSL_set_ctx(SSL *s, SSL_CTX *ctx) ;
138
139 #define SSL_CTRL_SET_TLSEXT_SERVERNAME_CB       53
140 #define SSL_CTRL_SET_TLSEXT_SERVERNAME_ARG      54
141 #define SSL_CTRL_SET_TLSEXT_HOSTNAME            55
142 #define SSL_CTRL_GET_TLSEXT_HOSTNAME            56
143 #define SSL_CTRL_SET_TLSEXT_SERVERNAME_DONE     57
144   
145 #endif
146
147 /* Additional TLS ciphersuites from expired Internet Draft
148  * draft-ietf-tls-56-bit-ciphersuites-01.txt
149  * (available if TLS1_ALLOW_EXPERIMENTAL_CIPHERSUITES is defined, see
150  * s3_lib.c).  We actually treat them like SSL 3.0 ciphers, which we probably
151  * shouldn't.  Note that the first two are actually not in the IDs. */
152 #define TLS1_CK_RSA_EXPORT1024_WITH_RC4_56_MD5          0x03000060 /* not in ID */
153 #define TLS1_CK_RSA_EXPORT1024_WITH_RC2_CBC_56_MD5      0x03000061 /* not in ID */
154 #define TLS1_CK_RSA_EXPORT1024_WITH_DES_CBC_SHA         0x03000062
155 #define TLS1_CK_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA     0x03000063
156 #define TLS1_CK_RSA_EXPORT1024_WITH_RC4_56_SHA          0x03000064
157 #define TLS1_CK_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA      0x03000065
158 #define TLS1_CK_DHE_DSS_WITH_RC4_128_SHA                0x03000066
159
160 /* AES ciphersuites from RFC3268 */
161
162 #define TLS1_CK_RSA_WITH_AES_128_SHA                    0x0300002F
163 #define TLS1_CK_DH_DSS_WITH_AES_128_SHA                 0x03000030
164 #define TLS1_CK_DH_RSA_WITH_AES_128_SHA                 0x03000031
165 #define TLS1_CK_DHE_DSS_WITH_AES_128_SHA                0x03000032
166 #define TLS1_CK_DHE_RSA_WITH_AES_128_SHA                0x03000033
167 #define TLS1_CK_ADH_WITH_AES_128_SHA                    0x03000034
168
169 #define TLS1_CK_RSA_WITH_AES_256_SHA                    0x03000035
170 #define TLS1_CK_DH_DSS_WITH_AES_256_SHA                 0x03000036
171 #define TLS1_CK_DH_RSA_WITH_AES_256_SHA                 0x03000037
172 #define TLS1_CK_DHE_DSS_WITH_AES_256_SHA                0x03000038
173 #define TLS1_CK_DHE_RSA_WITH_AES_256_SHA                0x03000039
174 #define TLS1_CK_ADH_WITH_AES_256_SHA                    0x0300003A
175
176 /* ECC ciphersuites from draft-ietf-tls-ecc-12.txt with changes soon to be in draft 13 */
177 #define TLS1_CK_ECDH_ECDSA_WITH_NULL_SHA                0x0300C001
178 #define TLS1_CK_ECDH_ECDSA_WITH_RC4_128_SHA             0x0300C002
179 #define TLS1_CK_ECDH_ECDSA_WITH_DES_192_CBC3_SHA        0x0300C003
180 #define TLS1_CK_ECDH_ECDSA_WITH_AES_128_CBC_SHA         0x0300C004
181 #define TLS1_CK_ECDH_ECDSA_WITH_AES_256_CBC_SHA         0x0300C005
182
183 #define TLS1_CK_ECDHE_ECDSA_WITH_NULL_SHA               0x0300C006
184 #define TLS1_CK_ECDHE_ECDSA_WITH_RC4_128_SHA            0x0300C007
185 #define TLS1_CK_ECDHE_ECDSA_WITH_DES_192_CBC3_SHA       0x0300C008
186 #define TLS1_CK_ECDHE_ECDSA_WITH_AES_128_CBC_SHA        0x0300C009
187 #define TLS1_CK_ECDHE_ECDSA_WITH_AES_256_CBC_SHA        0x0300C00A
188
189 #define TLS1_CK_ECDH_RSA_WITH_NULL_SHA                  0x0300C00B
190 #define TLS1_CK_ECDH_RSA_WITH_RC4_128_SHA               0x0300C00C
191 #define TLS1_CK_ECDH_RSA_WITH_DES_192_CBC3_SHA          0x0300C00D
192 #define TLS1_CK_ECDH_RSA_WITH_AES_128_CBC_SHA           0x0300C00E
193 #define TLS1_CK_ECDH_RSA_WITH_AES_256_CBC_SHA           0x0300C00F
194
195 #define TLS1_CK_ECDHE_RSA_WITH_NULL_SHA                 0x0300C010
196 #define TLS1_CK_ECDHE_RSA_WITH_RC4_128_SHA              0x0300C011
197 #define TLS1_CK_ECDHE_RSA_WITH_DES_192_CBC3_SHA         0x0300C012
198 #define TLS1_CK_ECDHE_RSA_WITH_AES_128_CBC_SHA          0x0300C013
199 #define TLS1_CK_ECDHE_RSA_WITH_AES_256_CBC_SHA          0x0300C014
200
201 #define TLS1_CK_ECDH_anon_WITH_NULL_SHA                 0x0300C015
202 #define TLS1_CK_ECDH_anon_WITH_RC4_128_SHA              0x0300C016
203 #define TLS1_CK_ECDH_anon_WITH_DES_192_CBC3_SHA         0x0300C017
204 #define TLS1_CK_ECDH_anon_WITH_AES_128_CBC_SHA          0x0300C018
205 #define TLS1_CK_ECDH_anon_WITH_AES_256_CBC_SHA          0x0300C019
206
207 /* XXX
208  * Inconsistency alert:
209  * The OpenSSL names of ciphers with ephemeral DH here include the string
210  * "DHE", while elsewhere it has always been "EDH".
211  * (The alias for the list of all such ciphers also is "EDH".)
212  * The specifications speak of "EDH"; maybe we should allow both forms
213  * for everything. */
214 #define TLS1_TXT_RSA_EXPORT1024_WITH_RC4_56_MD5         "EXP1024-RC4-MD5"
215 #define TLS1_TXT_RSA_EXPORT1024_WITH_RC2_CBC_56_MD5     "EXP1024-RC2-CBC-MD5"
216 #define TLS1_TXT_RSA_EXPORT1024_WITH_DES_CBC_SHA        "EXP1024-DES-CBC-SHA"
217 #define TLS1_TXT_DHE_DSS_EXPORT1024_WITH_DES_CBC_SHA    "EXP1024-DHE-DSS-DES-CBC-SHA"
218 #define TLS1_TXT_RSA_EXPORT1024_WITH_RC4_56_SHA         "EXP1024-RC4-SHA"
219 #define TLS1_TXT_DHE_DSS_EXPORT1024_WITH_RC4_56_SHA     "EXP1024-DHE-DSS-RC4-SHA"
220 #define TLS1_TXT_DHE_DSS_WITH_RC4_128_SHA               "DHE-DSS-RC4-SHA"
221
222 /* AES ciphersuites from RFC3268 */
223 #define TLS1_TXT_RSA_WITH_AES_128_SHA                   "AES128-SHA"
224 #define TLS1_TXT_DH_DSS_WITH_AES_128_SHA                "DH-DSS-AES128-SHA"
225 #define TLS1_TXT_DH_RSA_WITH_AES_128_SHA                "DH-RSA-AES128-SHA"
226 #define TLS1_TXT_DHE_DSS_WITH_AES_128_SHA               "DHE-DSS-AES128-SHA"
227 #define TLS1_TXT_DHE_RSA_WITH_AES_128_SHA               "DHE-RSA-AES128-SHA"
228 #define TLS1_TXT_ADH_WITH_AES_128_SHA                   "ADH-AES128-SHA"
229
230 #define TLS1_TXT_RSA_WITH_AES_256_SHA                   "AES256-SHA"
231 #define TLS1_TXT_DH_DSS_WITH_AES_256_SHA                "DH-DSS-AES256-SHA"
232 #define TLS1_TXT_DH_RSA_WITH_AES_256_SHA                "DH-RSA-AES256-SHA"
233 #define TLS1_TXT_DHE_DSS_WITH_AES_256_SHA               "DHE-DSS-AES256-SHA"
234 #define TLS1_TXT_DHE_RSA_WITH_AES_256_SHA               "DHE-RSA-AES256-SHA"
235 #define TLS1_TXT_ADH_WITH_AES_256_SHA                   "ADH-AES256-SHA"
236
237 /* ECC ciphersuites from draft-ietf-tls-ecc-01.txt (Mar 15, 2001) */
238 #define TLS1_TXT_ECDH_ECDSA_WITH_NULL_SHA               "ECDH-ECDSA-NULL-SHA"
239 #define TLS1_TXT_ECDH_ECDSA_WITH_RC4_128_SHA            "ECDH-ECDSA-RC4-SHA"
240 #define TLS1_TXT_ECDH_ECDSA_WITH_DES_192_CBC3_SHA       "ECDH-ECDSA-DES-CBC3-SHA"
241 #define TLS1_TXT_ECDH_ECDSA_WITH_AES_128_CBC_SHA        "ECDH-ECDSA-AES128-SHA"
242 #define TLS1_TXT_ECDH_ECDSA_WITH_AES_256_CBC_SHA        "ECDH-ECDSA-AES256-SHA"
243
244 #define TLS1_TXT_ECDHE_ECDSA_WITH_NULL_SHA              "ECDHE-ECDSA-NULL-SHA"
245 #define TLS1_TXT_ECDHE_ECDSA_WITH_RC4_128_SHA           "ECDHE-ECDSA-RC4-SHA"
246 #define TLS1_TXT_ECDHE_ECDSA_WITH_DES_192_CBC3_SHA      "ECDHE-ECDSA-DES-CBC3-SHA"
247 #define TLS1_TXT_ECDHE_ECDSA_WITH_AES_128_CBC_SHA       "ECDHE-ECDSA-AES128-SHA"
248 #define TLS1_TXT_ECDHE_ECDSA_WITH_AES_256_CBC_SHA       "ECDHE-ECDSA-AES256-SHA"
249
250 #define TLS1_TXT_ECDH_RSA_WITH_NULL_SHA                 "ECDH-RSA-NULL-SHA"
251 #define TLS1_TXT_ECDH_RSA_WITH_RC4_128_SHA              "ECDH-RSA-RC4-SHA"
252 #define TLS1_TXT_ECDH_RSA_WITH_DES_192_CBC3_SHA         "ECDH-RSA-DES-CBC3-SHA"
253 #define TLS1_TXT_ECDH_RSA_WITH_AES_128_CBC_SHA          "ECDH-RSA-AES128-SHA"
254 #define TLS1_TXT_ECDH_RSA_WITH_AES_256_CBC_SHA          "ECDH-RSA-AES256-SHA"
255
256 #define TLS1_TXT_ECDHE_RSA_WITH_NULL_SHA                "ECDHE-RSA-NULL-SHA"
257 #define TLS1_TXT_ECDHE_RSA_WITH_RC4_128_SHA             "ECDHE-RSA-RC4-SHA"
258 #define TLS1_TXT_ECDHE_RSA_WITH_DES_192_CBC3_SHA        "ECDHE-RSA-DES-CBC3-SHA"
259 #define TLS1_TXT_ECDHE_RSA_WITH_AES_128_CBC_SHA         "ECDHE-RSA-AES128-SHA"
260 #define TLS1_TXT_ECDHE_RSA_WITH_AES_256_CBC_SHA         "ECDHE-RSA-AES256-SHA"
261
262 #define TLS1_TXT_ECDH_anon_WITH_NULL_SHA                "AECDH-NULL-SHA"
263 #define TLS1_TXT_ECDH_anon_WITH_RC4_128_SHA             "AECDH-RC4-SHA"
264 #define TLS1_TXT_ECDH_anon_WITH_DES_192_CBC3_SHA        "AECDH-DES-CBC3-SHA"
265 #define TLS1_TXT_ECDH_anon_WITH_AES_128_CBC_SHA         "AECDH-AES128-SHA"
266 #define TLS1_TXT_ECDH_anon_WITH_AES_256_CBC_SHA         "AECDH-AES256-SHA"
267
268 #define TLS_CT_RSA_SIGN                 1
269 #define TLS_CT_DSS_SIGN                 2
270 #define TLS_CT_RSA_FIXED_DH             3
271 #define TLS_CT_DSS_FIXED_DH             4
272 #define TLS_CT_ECDSA_SIGN               64
273 #define TLS_CT_RSA_FIXED_ECDH           65
274 #define TLS_CT_ECDSA_FIXED_ECDH         66
275 #define TLS_CT_NUMBER                   7
276
277 #define TLS1_FINISH_MAC_LENGTH          12
278
279 #define TLS_MD_MAX_CONST_SIZE                   20
280 #define TLS_MD_CLIENT_FINISH_CONST              "client finished"
281 #define TLS_MD_CLIENT_FINISH_CONST_SIZE         15
282 #define TLS_MD_SERVER_FINISH_CONST              "server finished"
283 #define TLS_MD_SERVER_FINISH_CONST_SIZE         15
284 #define TLS_MD_SERVER_WRITE_KEY_CONST           "server write key"
285 #define TLS_MD_SERVER_WRITE_KEY_CONST_SIZE      16
286 #define TLS_MD_KEY_EXPANSION_CONST              "key expansion"
287 #define TLS_MD_KEY_EXPANSION_CONST_SIZE         13
288 #define TLS_MD_CLIENT_WRITE_KEY_CONST           "client write key"
289 #define TLS_MD_CLIENT_WRITE_KEY_CONST_SIZE      16
290 #define TLS_MD_SERVER_WRITE_KEY_CONST           "server write key"
291 #define TLS_MD_SERVER_WRITE_KEY_CONST_SIZE      16
292 #define TLS_MD_IV_BLOCK_CONST                   "IV block"
293 #define TLS_MD_IV_BLOCK_CONST_SIZE              8
294 #define TLS_MD_MASTER_SECRET_CONST              "master secret"
295 #define TLS_MD_MASTER_SECRET_CONST_SIZE         13
296
297 #ifdef CHARSET_EBCDIC
298 #undef TLS_MD_CLIENT_FINISH_CONST
299 #define TLS_MD_CLIENT_FINISH_CONST    "\x63\x6c\x69\x65\x6e\x74\x20\x66\x69\x6e\x69\x73\x68\x65\x64"  /*client finished*/
300 #undef TLS_MD_SERVER_FINISH_CONST
301 #define TLS_MD_SERVER_FINISH_CONST    "\x73\x65\x72\x76\x65\x72\x20\x66\x69\x6e\x69\x73\x68\x65\x64"  /*server finished*/
302 #undef TLS_MD_SERVER_WRITE_KEY_CONST
303 #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*/
304 #undef TLS_MD_KEY_EXPANSION_CONST
305 #define TLS_MD_KEY_EXPANSION_CONST    "\x6b\x65\x79\x20\x65\x78\x70\x61\x6e\x73\x69\x6f\x6e"  /*key expansion*/
306 #undef TLS_MD_CLIENT_WRITE_KEY_CONST
307 #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*/
308 #undef TLS_MD_SERVER_WRITE_KEY_CONST
309 #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*/
310 #undef TLS_MD_IV_BLOCK_CONST
311 #define TLS_MD_IV_BLOCK_CONST         "\x49\x56\x20\x62\x6c\x6f\x63\x6b"  /*IV block*/
312 #undef TLS_MD_MASTER_SECRET_CONST
313 #define TLS_MD_MASTER_SECRET_CONST    "\x6d\x61\x73\x74\x65\x72\x20\x73\x65\x63\x72\x65\x74"  /*master secret*/
314 #endif
315
316 #ifdef  __cplusplus
317 }
318 #endif
319 #endif
320
321
322