2 /* Copyright (C) 1995-1997 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
59 #ifndef HEADER_SSL_LOCL_H
60 #define HEADER_SSL_LOCL_H
82 #define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
83 l|=(((unsigned long)(*((c)++)))<< 8), \
84 l|=(((unsigned long)(*((c)++)))<<16), \
85 l|=(((unsigned long)(*((c)++)))<<24))
87 /* NOTE - c is not incremented as per c2l */
88 #define c2ln(c,l1,l2,n) { \
92 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
93 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
94 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
95 case 5: l2|=((unsigned long)(*(--(c)))); \
96 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
97 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
98 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
99 case 1: l1|=((unsigned long)(*(--(c)))); \
103 #define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
104 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
105 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
106 *((c)++)=(unsigned char)(((l)>>24)&0xff))
108 #define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
109 l|=((unsigned long)(*((c)++)))<<16, \
110 l|=((unsigned long)(*((c)++)))<< 8, \
111 l|=((unsigned long)(*((c)++))))
113 #define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
114 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
115 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
116 *((c)++)=(unsigned char)(((l) )&0xff))
118 /* NOTE - c is not incremented as per l2c */
119 #define l2cn(l1,l2,c,n) { \
122 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
123 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
124 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
125 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
126 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
127 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
128 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
129 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
133 #define n2s(c,s) (s =((unsigned int)(*((c)++)))<< 8, \
134 s|=((unsigned int)(*((c)++))))
135 #define s2n(s,c) (*((c)++)=(unsigned char)(((s)>> 8)&0xff), \
136 *((c)++)=(unsigned char)(((s) )&0xff))
138 #define n2l3(c,l) (l =((unsigned long)(*((c)++)))<<16, \
139 l|=((unsigned long)(*((c)++)))<< 8, \
140 l|=((unsigned long)(*((c)++))))
142 #define l2n3(l,c) (*((c)++)=(unsigned char)(((l)>>16)&0xff), \
143 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
144 *((c)++)=(unsigned char)(((l) )&0xff))
148 #define SSL_DECRYPT 0
149 #define SSL_ENCRYPT 1
151 #define TWO_BYTE_BIT 0x80
152 #define SEC_ESC_BIT 0x40
153 #define TWO_BYTE_MASK 0x7fff
154 #define THREE_BYTE_MASK 0x3fff
156 #define INC32(a) ((a)=((a)+1)&0xffffffffL)
157 #define DEC32(a) ((a)=((a)-1)&0xffffffffL)
158 #define MAX_MAC_SIZE 20 /* up from 16 for SSLv3 */
160 #define SSL_MKEY_MASK 0x0000001FL
161 #define SSL_kRSA 0x00000001L /* RSA key exchange */
162 #define SSL_kDHr 0x00000002L /* DH cert RSA CA cert */
163 #define SSL_kDHd 0x00000004L /* DH cert DSA CA cert */
164 #define SSL_kFZA 0x00000008L
165 #define SSL_kEDH 0x00000010L /* tmp DH key no DH cert */
166 #define SSL_EDH (SSL_kEDH|(SSL_AUTH_MASK^SSL_aNULL))
168 #define SSL_AUTH_MASK 0x000003e0L
169 #define SSL_aRSA 0x00000020L /* Authenticate with RSA */
170 #define SSL_aDSS 0x00000040L /* Authenticate with DSS */
171 #define SSL_DSS SSL_aDSS
172 #define SSL_aFZA 0x00000080L
173 #define SSL_aNULL 0x00000100L /* no Authenticate, ADH */
174 #define SSL_aDH 0x00000200L /* no Authenticate, ADH */
176 #define SSL_NULL (SSL_eNULL)
177 #define SSL_ADH (SSL_kEDH|SSL_aNULL)
178 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
179 #define SSL_DH (SSL_kDHr|SSL_kDHd|SSL_kEDH)
180 #define SSL_FZA (SSL_aFZA|SSL_kFZA|SSL_eFZA)
182 #define SSL_ENC_MASK 0x0001Fc00L
183 #define SSL_DES 0x00000400L
184 #define SSL_3DES 0x00000800L
185 #define SSL_RC4 0x00001000L
186 #define SSL_RC2 0x00002000L
187 #define SSL_IDEA 0x00004000L
188 #define SSL_eFZA 0x00008000L
189 #define SSL_eNULL 0x00010000L
191 #define SSL_MAC_MASK 0x000e0000L
192 #define SSL_MD5 0x00020000L
193 #define SSL_SHA0 0x00040000L
194 #define SSL_SHA1 0x00080000L
195 #define SSL_SHA (SSL_SHA0|SSL_SHA1)
197 #define SSL_EXP_MASK 0x00300000L
198 #define SSL_EXP 0x00100000L
199 #define SSL_NOT_EXP 0x00200000L
200 #define SSL_EXPORT SSL_EXP
202 #define SSL_SSL_MASK 0x00c00000L
203 #define SSL_SSLV2 0x00400000L
204 #define SSL_SSLV3 0x00800000L
206 #define SSL_STRONG_MASK 0x07000000L
207 #define SSL_LOW 0x01000000L
208 #define SSL_MEDIUM 0x02000000L
209 #define SSL_HIGH 0x04000000L
211 /* we have used 0fffffff - 4 bits left to go */
212 #define SSL_ALL 0xffffffffL
213 #define SSL_ALL_CIPHERS (SSL_MKEY_MASK|SSL_AUTH_MASK|SSL_ENC_MASK|\
214 SSL_MAC_MASK|SSL_EXP_MASK)
216 /* Mostly for SSLv3 */
217 #define SSL_PKEY_RSA_ENC 0
218 #define SSL_PKEY_RSA_SIGN 1
219 #define SSL_PKEY_DSA_SIGN 2
220 #define SSL_PKEY_DH_RSA 3
221 #define SSL_PKEY_DH_DSA 4
222 #define SSL_PKEY_NUM 5
224 /* SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
225 * <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
226 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
227 * SSL_kEDH <- RSA_ENC | RSA_SIGN | DSA_SIGN
228 * SSL_aRSA <- RSA_ENC | RSA_SIGN
229 * SSL_aDSS <- DSA_SIGN
233 #define CERT_INVALID 0
234 #define CERT_PUBLIC_KEY 1
235 #define CERT_PRIVATE_KEY 2
238 typedef struct cert_pkey_st
241 /* EVP_PKEY *publickey; *//* when extracted */
242 EVP_PKEY *privatekey;
245 typedef struct cert_st
251 EVP_PKEY *publickey; /* when extracted */
252 EVP_PKEY *privatekey;
254 pkeys[SSL_PKEY_RSA_ENC].x509
255 /* pkeys[SSL_PKEY_RSA_ENC].publickey */
256 pkeys[SSL_PKEY_RSA_ENC].privatekey
259 /* Current active set */
262 /* The following masks are for the key and auth
263 * algorithms that are supported by the certs below */
266 unsigned long export_mask;
270 RSA *(*rsa_tmp_cb)();
272 CERT_PKEY pkeys[SSL_PKEY_NUM];
279 /*#define MAC_DEBUG */
281 /*#define ERR_DEBUG */
282 /*#define ABORT_DEBUG */
283 /*#define PKT_DEBUG 1 */
284 /*#define DES_DEBUG */
285 /*#define DES_OFB_DEBUG */
286 /*#define SSL_DEBUG */
287 /*#define RSA_DEBUG */
288 /*#define IDEA_DEBUG */
291 #define FP_ICC (int (*)(const void *,const void *))
296 #define ssl_put_cipher_by_char(ssl,ciph,ptr) \
297 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
298 #define ssl_get_cipher_by_char(ssl,ptr) \
299 ((ssl)->method->get_cipher_by_char(ptr))
301 extern unsigned char ssl3_client_finished_const[4];
302 extern unsigned char ssl3_server_finished_const[4];
304 extern SSL_CIPHER ssl2_ciphers[];
305 extern SSL_CIPHER ssl3_ciphers[];
309 SSL_METHOD *ssl_bad_method(int ver);
310 SSL_METHOD *sslv2_base_method(void);
311 SSL_METHOD *sslv23_base_method(void);
312 SSL_METHOD *sslv3_base_method(void);
314 void ssl_clear_cipher_ctx(SSL *s);
315 int ssl_clear_bad_session(SSL *s);
316 CERT *ssl_cert_new(void);
317 void ssl_cert_free(CERT *c);
318 int ssl_set_cert_type(CERT *c, int type);
319 int ssl_get_new_session(SSL *s, int session);
320 int ssl_get_prev_session(SSL *s, int len, unsigned char *session);
321 int ssl_cipher_id_cmp(SSL_CIPHER *a,SSL_CIPHER *b);
322 int ssl_cipher_ptr_id_cmp(SSL_CIPHER **ap,SSL_CIPHER **bp);
323 STACK *ssl_bytes_to_cipher_list(SSL *s,unsigned char *p,int num,STACK **skp);
324 int ssl_cipher_list_to_bytes(SSL *s,STACK *sk,unsigned char *p);
325 STACK *ssl_create_cipher_list(SSL_METHOD *meth,STACK **pref,
326 STACK **sorted,char *str);
327 void ssl_update_cache(SSL *s, int mode);
328 int ssl_cipher_get_evp(SSL_CIPHER *c, EVP_CIPHER **enc, EVP_MD **md);
329 int ssl_verify_cert_chain(SSL *s,STACK *sk);
330 int ssl_undefined_function(SSL *s);
331 X509 *ssl_get_server_send_cert(SSL *);
332 EVP_PKEY *ssl_get_sign_pkey(SSL *,SSL_CIPHER *);
333 int ssl_cert_type(X509 *x,EVP_PKEY *pkey);
334 void ssl_set_cert_masks(CERT *c);
335 STACK *ssl_get_ciphers_by_id(SSL *s);
336 int ssl_verify_alarm_type(int type);
338 int ssl2_enc_init(SSL *s, int client);
339 void ssl2_generate_key_material(SSL *s);
340 void ssl2_enc(SSL *s,int send_data);
341 void ssl2_mac(SSL *s,unsigned char *mac,int send_data);
342 SSL_CIPHER *ssl2_get_cipher_by_char(unsigned char *p);
343 int ssl2_put_cipher_by_char(SSL_CIPHER *c,unsigned char *p);
344 int ssl2_part_read(SSL *s, unsigned long f, int i);
345 int ssl2_do_write(SSL *s);
346 int ssl2_set_certificate(SSL *s, int type, int len, unsigned char *data);
347 void ssl2_return_error(SSL *s,int reason);
348 void ssl2_write_error(SSL *s);
349 int ssl2_num_ciphers(void);
350 SSL_CIPHER *ssl2_get_cipher(unsigned int u);
351 int ssl2_new(SSL *s);
352 void ssl2_free(SSL *s);
353 int ssl2_accept(SSL *s);
354 int ssl2_connect(SSL *s);
355 int ssl2_read(SSL *s, char *buf, int len);
356 int ssl2_peek(SSL *s, char *buf, int len);
357 int ssl2_write(SSL *s, const char *buf, int len);
358 int ssl2_shutdown(SSL *s);
359 void ssl2_clear(SSL *s);
360 long ssl2_ctrl(SSL *s,int cmd, long larg, char *parg);
361 long ssl2_ctx_ctrl(SSL_CTX *s,int cmd, long larg, char *parg);
362 int ssl2_pending(SSL *s);
364 SSL_CIPHER *ssl3_get_cipher_by_char(unsigned char *p);
365 int ssl3_put_cipher_by_char(SSL_CIPHER *c,unsigned char *p);
366 void ssl3_init_finished_mac(SSL *s);
367 int ssl3_send_server_certificate(SSL *s);
368 int ssl3_get_finished(SSL *s,int state_a,int state_b,unsigned char *sender);
369 int ssl3_setup_key_block(SSL *s);
370 int ssl3_send_change_cipher_spec(SSL *s,int state_a,int state_b);
371 int ssl3_change_cipher_state(SSL *s,int which);
372 void ssl3_cleanup_key_block(SSL *s);
373 int ssl3_do_write(SSL *s,int type);
374 void ssl3_send_alert(SSL *s,int level, int desc);
375 int ssl3_generate_master_secret(SSL *s, unsigned char *out,
376 unsigned char *p, int len);
377 int ssl3_get_req_cert_type(SSL *s,unsigned char *p);
378 long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
379 int ssl3_send_finished(SSL *s, int a, int b, unsigned char *sender);
380 int ssl3_num_ciphers(void);
381 SSL_CIPHER *ssl3_get_cipher(unsigned int u);
382 int ssl3_renegotiate(SSL *ssl);
383 int ssl3_dispatch_alert(SSL *s);
384 int ssl3_read_bytes(SSL *s, int type, char *buf, int len);
385 void ssl3_generate_key_block(SSL *s, unsigned char *km, int num);
386 int ssl3_part_read(SSL *s, int i);
387 int ssl3_write_bytes(SSL *s, int type, char *buf, int len);
388 int ssl3_final_finish_mac(SSL *s, EVP_MD_CTX *in_ctx,
389 unsigned char *sender, unsigned char *p);
390 void ssl3_finish_mac(SSL *s, unsigned char *buf, int len);
391 int ssl3_enc(SSL *s, int send_data);
392 int ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
393 unsigned long ssl3_output_cert_chain(SSL *s, X509 *x);
394 SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,STACK *have,STACK *pref);
395 int ssl3_setup_buffers(SSL *s);
396 int ssl3_new(SSL *s);
397 void ssl3_free(SSL *s);
398 int ssl3_accept(SSL *s);
399 int ssl3_connect(SSL *s);
400 int ssl3_read(SSL *s, char *buf, int len);
401 int ssl3_peek(SSL *s,char *buf, int len);
402 int ssl3_write(SSL *s, const char *buf, int len);
403 int ssl3_shutdown(SSL *s);
404 void ssl3_clear(SSL *s);
405 long ssl3_ctrl(SSL *s,int cmd, long larg, char *parg);
406 long ssl3_ctx_ctrl(SSL_CTX *s,int cmd, long larg, char *parg);
407 int ssl3_pending(SSL *s);
409 int ssl23_accept(SSL *s);
410 int ssl23_connect(SSL *s);
411 int ssl23_read_bytes(SSL *s, int n);
412 int ssl23_write_bytes(SSL *s);
416 SSL_METHOD *ssl_bad_method();
417 SSL_METHOD *sslv2_base_method();
418 SSL_METHOD *sslv23_base_method();
419 SSL_METHOD *sslv3_base_method();
421 void ssl_clear_cipher_ctx();
422 int ssl_clear_bad_session();
423 CERT *ssl_cert_new();
424 void ssl_cert_free();
425 int ssl_set_cert_type();
426 int ssl_get_new_session();
427 int ssl_get_prev_session();
428 int ssl_cipher_id_cmp();
429 int ssl_cipher_ptr_id_cmp();
430 STACK *ssl_bytes_to_cipher_list();
431 int ssl_cipher_list_to_bytes();
432 STACK *ssl_create_cipher_list();
433 void ssl_update_cache();
434 int ssl_session_get_ciphers();
435 int ssl_verify_cert_chain();
436 int ssl_undefined_function();
437 X509 *ssl_get_server_send_cert();
438 EVP_PKEY *ssl_get_sign_pkey();
440 void ssl_set_cert_masks();
441 STACK *ssl_get_ciphers_by_id();
442 int ssl_verify_alarm_type();
445 void ssl2_generate_key_material();
448 SSL_CIPHER *ssl2_get_cipher_by_char();
449 int ssl2_put_cipher_by_char();
450 int ssl2_part_read();
452 int ssl2_set_certificate();
453 void ssl2_return_error();
454 void ssl2_write_error();
455 int ssl2_num_ciphers();
456 SSL_CIPHER *ssl2_get_cipher();
467 long ssl2_ctx_ctrl();
470 SSL_CIPHER *ssl3_get_cipher_by_char();
471 int ssl3_put_cipher_by_char();
472 void ssl3_init_finished_mac();
473 int ssl3_send_server_certificate();
474 int ssl3_get_finished();
475 int ssl3_setup_key_block();
476 int ssl3_send_change_cipher_spec();
477 int ssl3_change_cipher_state();
478 void ssl3_cleanup_key_block();
480 void ssl3_send_alert();
481 int ssl3_generate_master_secret();
482 int ssl3_get_req_cert_type();
483 long ssl3_get_message();
484 int ssl3_send_finished();
485 int ssl3_num_ciphers();
486 SSL_CIPHER *ssl3_get_cipher();
487 int ssl3_renegotiate();
488 int ssl3_dispatch_alert();
489 int ssl3_read_bytes();
490 void ssl3_generate_key_block();
491 int ssl3_part_read();
492 int ssl3_write_bytes();
493 int ssl3_final_finish_mac();
494 void ssl3_finish_mac();
497 unsigned long ssl3_output_cert_chain();
498 SSL_CIPHER *ssl3_choose_cipher();
499 int ssl3_setup_buffers();
510 long ssl3_ctx_ctrl();
515 int ssl23_read_bytes();
516 int ssl23_write_bytes();