ssl2.h revision 296465
1/* ssl/ssl2.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#ifndef HEADER_SSL2_H
60# define HEADER_SSL2_H
61
62#ifdef  __cplusplus
63extern "C" {
64#endif
65
66/* Protocol Version Codes */
67# define SSL2_VERSION            0x0002
68# define SSL2_VERSION_MAJOR      0x00
69# define SSL2_VERSION_MINOR      0x02
70/* #define SSL2_CLIENT_VERSION  0x0002 */
71/* #define SSL2_SERVER_VERSION  0x0002 */
72
73/* Protocol Message Codes */
74# define SSL2_MT_ERROR                   0
75# define SSL2_MT_CLIENT_HELLO            1
76# define SSL2_MT_CLIENT_MASTER_KEY       2
77# define SSL2_MT_CLIENT_FINISHED         3
78# define SSL2_MT_SERVER_HELLO            4
79# define SSL2_MT_SERVER_VERIFY           5
80# define SSL2_MT_SERVER_FINISHED         6
81# define SSL2_MT_REQUEST_CERTIFICATE     7
82# define SSL2_MT_CLIENT_CERTIFICATE      8
83
84/* Error Message Codes */
85# define SSL2_PE_UNDEFINED_ERROR         0x0000
86# define SSL2_PE_NO_CIPHER               0x0001
87# define SSL2_PE_NO_CERTIFICATE          0x0002
88# define SSL2_PE_BAD_CERTIFICATE         0x0004
89# define SSL2_PE_UNSUPPORTED_CERTIFICATE_TYPE 0x0006
90
91/* Cipher Kind Values */
92# define SSL2_CK_NULL_WITH_MD5                   0x02000000/* v3 */
93# define SSL2_CK_RC4_128_WITH_MD5                0x02010080
94# define SSL2_CK_RC4_128_EXPORT40_WITH_MD5       0x02020080
95# define SSL2_CK_RC2_128_CBC_WITH_MD5            0x02030080
96# define SSL2_CK_RC2_128_CBC_EXPORT40_WITH_MD5   0x02040080
97# define SSL2_CK_IDEA_128_CBC_WITH_MD5           0x02050080
98# define SSL2_CK_DES_64_CBC_WITH_MD5             0x02060040
99# define SSL2_CK_DES_64_CBC_WITH_SHA             0x02060140/* v3 */
100# define SSL2_CK_DES_192_EDE3_CBC_WITH_MD5       0x020700c0
101# define SSL2_CK_DES_192_EDE3_CBC_WITH_SHA       0x020701c0/* v3 */
102# define SSL2_CK_RC4_64_WITH_MD5                 0x02080080/* MS hack */
103
104# define SSL2_CK_DES_64_CFB64_WITH_MD5_1         0x02ff0800/* SSLeay */
105# define SSL2_CK_NULL                            0x02ff0810/* SSLeay */
106
107# define SSL2_TXT_DES_64_CFB64_WITH_MD5_1        "DES-CFB-M1"
108# define SSL2_TXT_NULL_WITH_MD5                  "NULL-MD5"
109# define SSL2_TXT_RC4_128_WITH_MD5               "RC4-MD5"
110# define SSL2_TXT_RC4_128_EXPORT40_WITH_MD5      "EXP-RC4-MD5"
111# define SSL2_TXT_RC2_128_CBC_WITH_MD5           "RC2-CBC-MD5"
112# define SSL2_TXT_RC2_128_CBC_EXPORT40_WITH_MD5  "EXP-RC2-CBC-MD5"
113# define SSL2_TXT_IDEA_128_CBC_WITH_MD5          "IDEA-CBC-MD5"
114# define SSL2_TXT_DES_64_CBC_WITH_MD5            "DES-CBC-MD5"
115# define SSL2_TXT_DES_64_CBC_WITH_SHA            "DES-CBC-SHA"
116# define SSL2_TXT_DES_192_EDE3_CBC_WITH_MD5      "DES-CBC3-MD5"
117# define SSL2_TXT_DES_192_EDE3_CBC_WITH_SHA      "DES-CBC3-SHA"
118# define SSL2_TXT_RC4_64_WITH_MD5                "RC4-64-MD5"
119
120# define SSL2_TXT_NULL                           "NULL"
121
122/* Flags for the SSL_CIPHER.algorithm2 field */
123# define SSL2_CF_5_BYTE_ENC                      0x01
124# define SSL2_CF_8_BYTE_ENC                      0x02
125
126/* Certificate Type Codes */
127# define SSL2_CT_X509_CERTIFICATE                0x01
128
129/* Authentication Type Code */
130# define SSL2_AT_MD5_WITH_RSA_ENCRYPTION         0x01
131
132# define SSL2_MAX_SSL_SESSION_ID_LENGTH          32
133
134/* Upper/Lower Bounds */
135# define SSL2_MAX_MASTER_KEY_LENGTH_IN_BITS      256
136# ifdef OPENSSL_SYS_MPE
137#  define SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER    29998u
138# else
139#  define SSL2_MAX_RECORD_LENGTH_2_BYTE_HEADER    32767u
140                                                       /* 2^15-1 */
141# endif
142# define SSL2_MAX_RECORD_LENGTH_3_BYTE_HEADER    16383/* 2^14-1 */
143
144# define SSL2_CHALLENGE_LENGTH   16
145/*
146 * #define SSL2_CHALLENGE_LENGTH 32
147 */
148# define SSL2_MIN_CHALLENGE_LENGTH       16
149# define SSL2_MAX_CHALLENGE_LENGTH       32
150# define SSL2_CONNECTION_ID_LENGTH       16
151# define SSL2_MAX_CONNECTION_ID_LENGTH   16
152# define SSL2_SSL_SESSION_ID_LENGTH      16
153# define SSL2_MAX_CERT_CHALLENGE_LENGTH  32
154# define SSL2_MIN_CERT_CHALLENGE_LENGTH  16
155# define SSL2_MAX_KEY_MATERIAL_LENGTH    24
156
157# ifndef HEADER_SSL_LOCL_H
158#  define  CERT           char
159# endif
160
161typedef struct ssl2_state_st {
162    int three_byte_header;
163    int clear_text;             /* clear text */
164    int escape;                 /* not used in SSLv2 */
165    int ssl2_rollback;          /* used if SSLv23 rolled back to SSLv2 */
166    /*
167     * non-blocking io info, used to make sure the same args were passwd
168     */
169    unsigned int wnum;          /* number of bytes sent so far */
170    int wpend_tot;
171    const unsigned char *wpend_buf;
172    int wpend_off;              /* offset to data to write */
173    int wpend_len;              /* number of bytes passwd to write */
174    int wpend_ret;              /* number of bytes to return to caller */
175    /* buffer raw data */
176    int rbuf_left;
177    int rbuf_offs;
178    unsigned char *rbuf;
179    unsigned char *wbuf;
180    unsigned char *write_ptr;   /* used to point to the start due to 2/3 byte
181                                 * header. */
182    unsigned int padding;
183    unsigned int rlength;       /* passed to ssl2_enc */
184    int ract_data_length;       /* Set when things are encrypted. */
185    unsigned int wlength;       /* passed to ssl2_enc */
186    int wact_data_length;       /* Set when things are decrypted. */
187    unsigned char *ract_data;
188    unsigned char *wact_data;
189    unsigned char *mac_data;
190    unsigned char *read_key;
191    unsigned char *write_key;
192    /* Stuff specifically to do with this SSL session */
193    unsigned int challenge_length;
194    unsigned char challenge[SSL2_MAX_CHALLENGE_LENGTH];
195    unsigned int conn_id_length;
196    unsigned char conn_id[SSL2_MAX_CONNECTION_ID_LENGTH];
197    unsigned int key_material_length;
198    unsigned char key_material[SSL2_MAX_KEY_MATERIAL_LENGTH * 2];
199    unsigned long read_sequence;
200    unsigned long write_sequence;
201    struct {
202        unsigned int conn_id_length;
203        unsigned int cert_type;
204        unsigned int cert_length;
205        unsigned int csl;
206        unsigned int clear;
207        unsigned int enc;
208        unsigned char ccl[SSL2_MAX_CERT_CHALLENGE_LENGTH];
209        unsigned int cipher_spec_length;
210        unsigned int session_id_length;
211        unsigned int clen;
212        unsigned int rlen;
213    } tmp;
214} SSL2_STATE;
215
216/* SSLv2 */
217/* client */
218# define SSL2_ST_SEND_CLIENT_HELLO_A             (0x10|SSL_ST_CONNECT)
219# define SSL2_ST_SEND_CLIENT_HELLO_B             (0x11|SSL_ST_CONNECT)
220# define SSL2_ST_GET_SERVER_HELLO_A              (0x20|SSL_ST_CONNECT)
221# define SSL2_ST_GET_SERVER_HELLO_B              (0x21|SSL_ST_CONNECT)
222# define SSL2_ST_SEND_CLIENT_MASTER_KEY_A        (0x30|SSL_ST_CONNECT)
223# define SSL2_ST_SEND_CLIENT_MASTER_KEY_B        (0x31|SSL_ST_CONNECT)
224# define SSL2_ST_SEND_CLIENT_FINISHED_A          (0x40|SSL_ST_CONNECT)
225# define SSL2_ST_SEND_CLIENT_FINISHED_B          (0x41|SSL_ST_CONNECT)
226# define SSL2_ST_SEND_CLIENT_CERTIFICATE_A       (0x50|SSL_ST_CONNECT)
227# define SSL2_ST_SEND_CLIENT_CERTIFICATE_B       (0x51|SSL_ST_CONNECT)
228# define SSL2_ST_SEND_CLIENT_CERTIFICATE_C       (0x52|SSL_ST_CONNECT)
229# define SSL2_ST_SEND_CLIENT_CERTIFICATE_D       (0x53|SSL_ST_CONNECT)
230# define SSL2_ST_GET_SERVER_VERIFY_A             (0x60|SSL_ST_CONNECT)
231# define SSL2_ST_GET_SERVER_VERIFY_B             (0x61|SSL_ST_CONNECT)
232# define SSL2_ST_GET_SERVER_FINISHED_A           (0x70|SSL_ST_CONNECT)
233# define SSL2_ST_GET_SERVER_FINISHED_B           (0x71|SSL_ST_CONNECT)
234# define SSL2_ST_CLIENT_START_ENCRYPTION         (0x80|SSL_ST_CONNECT)
235# define SSL2_ST_X509_GET_CLIENT_CERTIFICATE     (0x90|SSL_ST_CONNECT)
236/* server */
237# define SSL2_ST_GET_CLIENT_HELLO_A              (0x10|SSL_ST_ACCEPT)
238# define SSL2_ST_GET_CLIENT_HELLO_B              (0x11|SSL_ST_ACCEPT)
239# define SSL2_ST_GET_CLIENT_HELLO_C              (0x12|SSL_ST_ACCEPT)
240# define SSL2_ST_SEND_SERVER_HELLO_A             (0x20|SSL_ST_ACCEPT)
241# define SSL2_ST_SEND_SERVER_HELLO_B             (0x21|SSL_ST_ACCEPT)
242# define SSL2_ST_GET_CLIENT_MASTER_KEY_A         (0x30|SSL_ST_ACCEPT)
243# define SSL2_ST_GET_CLIENT_MASTER_KEY_B         (0x31|SSL_ST_ACCEPT)
244# define SSL2_ST_SEND_SERVER_VERIFY_A            (0x40|SSL_ST_ACCEPT)
245# define SSL2_ST_SEND_SERVER_VERIFY_B            (0x41|SSL_ST_ACCEPT)
246# define SSL2_ST_SEND_SERVER_VERIFY_C            (0x42|SSL_ST_ACCEPT)
247# define SSL2_ST_GET_CLIENT_FINISHED_A           (0x50|SSL_ST_ACCEPT)
248# define SSL2_ST_GET_CLIENT_FINISHED_B           (0x51|SSL_ST_ACCEPT)
249# define SSL2_ST_SEND_SERVER_FINISHED_A          (0x60|SSL_ST_ACCEPT)
250# define SSL2_ST_SEND_SERVER_FINISHED_B          (0x61|SSL_ST_ACCEPT)
251# define SSL2_ST_SEND_REQUEST_CERTIFICATE_A      (0x70|SSL_ST_ACCEPT)
252# define SSL2_ST_SEND_REQUEST_CERTIFICATE_B      (0x71|SSL_ST_ACCEPT)
253# define SSL2_ST_SEND_REQUEST_CERTIFICATE_C      (0x72|SSL_ST_ACCEPT)
254# define SSL2_ST_SEND_REQUEST_CERTIFICATE_D      (0x73|SSL_ST_ACCEPT)
255# define SSL2_ST_SERVER_START_ENCRYPTION         (0x80|SSL_ST_ACCEPT)
256# define SSL2_ST_X509_GET_SERVER_CERTIFICATE     (0x90|SSL_ST_ACCEPT)
257
258#ifdef  __cplusplus
259}
260#endif
261#endif
262