2 /* Copyright (C) 1995-1998 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
80 #define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
81 l|=(((unsigned long)(*((c)++)))<< 8), \
82 l|=(((unsigned long)(*((c)++)))<<16), \
83 l|=(((unsigned long)(*((c)++)))<<24))
85 /* NOTE - c is not incremented as per c2l */
86 #define c2ln(c,l1,l2,n) { \
90 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
91 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
92 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
93 case 5: l2|=((unsigned long)(*(--(c)))); \
94 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
95 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
96 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
97 case 1: l1|=((unsigned long)(*(--(c)))); \
101 #define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
102 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
103 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
104 *((c)++)=(unsigned char)(((l)>>24)&0xff))
106 #define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
107 l|=((unsigned long)(*((c)++)))<<16, \
108 l|=((unsigned long)(*((c)++)))<< 8, \
109 l|=((unsigned long)(*((c)++))))
111 #define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
112 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
113 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
114 *((c)++)=(unsigned char)(((l) )&0xff))
116 /* NOTE - c is not incremented as per l2c */
117 #define l2cn(l1,l2,c,n) { \
120 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
121 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
122 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
123 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
124 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
125 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
126 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
127 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
131 #define n2s(c,s) ((s=(((unsigned int)(c[0]))<< 8)| \
132 (((unsigned int)(c[1])) )),c+=2)
133 #define s2n(s,c) ((c[0]=(unsigned char)(((s)>> 8)&0xff), \
134 c[1]=(unsigned char)(((s) )&0xff)),c+=2)
136 #define n2l3(c,l) ((l =(((unsigned long)(c[0]))<<16)| \
137 (((unsigned long)(c[1]))<< 8)| \
138 (((unsigned long)(c[2])) )),c+=3)
140 #define l2n3(l,c) ((c[0]=(unsigned char)(((l)>>16)&0xff), \
141 c[1]=(unsigned char)(((l)>> 8)&0xff), \
142 c[2]=(unsigned char)(((l) )&0xff)),c+=3)
146 #define SSL_DECRYPT 0
147 #define SSL_ENCRYPT 1
149 #define TWO_BYTE_BIT 0x80
150 #define SEC_ESC_BIT 0x40
151 #define TWO_BYTE_MASK 0x7fff
152 #define THREE_BYTE_MASK 0x3fff
154 #define INC32(a) ((a)=((a)+1)&0xffffffffL)
155 #define DEC32(a) ((a)=((a)-1)&0xffffffffL)
156 #define MAX_MAC_SIZE 20 /* up from 16 for SSLv3 */
158 #define SSL_MKEY_MASK 0x0000001FL
159 #define SSL_kRSA 0x00000001L /* RSA key exchange */
160 #define SSL_kDHr 0x00000002L /* DH cert RSA CA cert */
161 #define SSL_kDHd 0x00000004L /* DH cert DSA CA cert */
162 #define SSL_kFZA 0x00000008L
163 #define SSL_kEDH 0x00000010L /* tmp DH key no DH cert */
164 #define SSL_EDH (SSL_kEDH|(SSL_AUTH_MASK^SSL_aNULL))
166 #define SSL_AUTH_MASK 0x000003e0L
167 #define SSL_aRSA 0x00000020L /* Authenticate with RSA */
168 #define SSL_aDSS 0x00000040L /* Authenticate with DSS */
169 #define SSL_DSS SSL_aDSS
170 #define SSL_aFZA 0x00000080L
171 #define SSL_aNULL 0x00000100L /* no Authenticate, ADH */
172 #define SSL_aDH 0x00000200L /* no Authenticate, ADH */
174 #define SSL_NULL (SSL_eNULL)
175 #define SSL_ADH (SSL_kEDH|SSL_aNULL)
176 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
177 #define SSL_DH (SSL_kDHr|SSL_kDHd|SSL_kEDH)
178 #define SSL_FZA (SSL_aFZA|SSL_kFZA|SSL_eFZA)
180 #define SSL_ENC_MASK 0x0001Fc00L
181 #define SSL_DES 0x00000400L
182 #define SSL_3DES 0x00000800L
183 #define SSL_RC4 0x00001000L
184 #define SSL_RC2 0x00002000L
185 #define SSL_IDEA 0x00004000L
186 #define SSL_eFZA 0x00008000L
187 #define SSL_eNULL 0x00010000L
189 #define SSL_MAC_MASK 0x00060000L
190 #define SSL_MD5 0x00020000L
191 #define SSL_SHA1 0x00040000L
192 #define SSL_SHA (SSL_SHA1)
194 #define SSL_EXP_MASK 0x00300000L
195 #define SSL_EXP 0x00100000L
196 #define SSL_NOT_EXP 0x00200000L
197 #define SSL_EXPORT SSL_EXP
199 #define SSL_SSL_MASK 0x00c00000L
200 #define SSL_SSLV2 0x00400000L
201 #define SSL_SSLV3 0x00800000L
203 #define SSL_STRONG_MASK 0x07000000L
204 #define SSL_LOW 0x01000000L
205 #define SSL_MEDIUM 0x02000000L
206 #define SSL_HIGH 0x04000000L
208 /* we have used 0fffffff - 4 bits left to go */
209 #define SSL_ALL 0xffffffffL
210 #define SSL_ALL_CIPHERS (SSL_MKEY_MASK|SSL_AUTH_MASK|SSL_ENC_MASK|\
211 SSL_MAC_MASK|SSL_EXP_MASK)
213 /* Mostly for SSLv3 */
214 #define SSL_PKEY_RSA_ENC 0
215 #define SSL_PKEY_RSA_SIGN 1
216 #define SSL_PKEY_DSA_SIGN 2
217 #define SSL_PKEY_DH_RSA 3
218 #define SSL_PKEY_DH_DSA 4
219 #define SSL_PKEY_NUM 5
221 /* SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
222 * <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
223 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
224 * SSL_kEDH <- RSA_ENC | RSA_SIGN | DSA_SIGN
225 * SSL_aRSA <- RSA_ENC | RSA_SIGN
226 * SSL_aDSS <- DSA_SIGN
230 #define CERT_INVALID 0
231 #define CERT_PUBLIC_KEY 1
232 #define CERT_PRIVATE_KEY 2
235 typedef struct cert_pkey_st
238 /* EVP_PKEY *publickey; *//* when extracted */
239 EVP_PKEY *privatekey;
242 typedef struct cert_st
248 EVP_PKEY *publickey; /* when extracted */
249 EVP_PKEY *privatekey;
251 pkeys[SSL_PKEY_RSA_ENC].x509
252 /* pkeys[SSL_PKEY_RSA_ENC].publickey */
253 pkeys[SSL_PKEY_RSA_ENC].privatekey
256 /* Current active set */
259 /* The following masks are for the key and auth
260 * algorithms that are supported by the certs below */
263 unsigned long export_mask;
267 RSA *(*rsa_tmp_cb)();
269 CERT_PKEY pkeys[SSL_PKEY_NUM];
276 /*#define MAC_DEBUG */
278 /*#define ERR_DEBUG */
279 /*#define ABORT_DEBUG */
280 /*#define PKT_DEBUG 1 */
281 /*#define DES_DEBUG */
282 /*#define DES_OFB_DEBUG */
283 /*#define SSL_DEBUG */
284 /*#define RSA_DEBUG */
285 /*#define IDEA_DEBUG */
288 #define FP_ICC (int (*)(const void *,const void *))
293 #define ssl_put_cipher_by_char(ssl,ciph,ptr) \
294 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
295 #define ssl_get_cipher_by_char(ssl,ptr) \
296 ((ssl)->method->get_cipher_by_char(ptr))
298 /* This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff
299 * It is a bit of a mess of functions, but hell, think of it as
300 * an opaque strucute :-) */
301 typedef struct ssl3_enc_method
305 int (*setup_key_block)();
306 int (*generate_master_secret)();
307 int (*change_cipher_state)();
308 int (*final_finish_mac)();
309 int finish_mac_length;
310 int (*cert_verify_mac)();
311 unsigned char client_finished[20];
312 int client_finished_len;
313 unsigned char server_finished[20];
314 int server_finished_len;
315 int (*alert_value)();
318 /* Used for holding the relevant compression methods loaded into SSL_CTX */
319 typedef struct ssl3_comp_st
321 int comp_id; /* The identifer byte for this compression type */
322 char *name; /* Text name used for the compression type */
323 COMP_METHOD *method; /* The method :-) */
326 extern SSL3_ENC_METHOD ssl3_undef_enc_method;
327 extern SSL_CIPHER ssl2_ciphers[];
328 extern SSL_CIPHER ssl3_ciphers[];
332 SSL_METHOD *ssl_bad_method(int ver);
333 SSL_METHOD *sslv2_base_method(void);
334 SSL_METHOD *sslv23_base_method(void);
335 SSL_METHOD *sslv3_base_method(void);
337 void ssl_clear_cipher_ctx(SSL *s);
338 int ssl_clear_bad_session(SSL *s);
339 CERT *ssl_cert_new(void);
340 void ssl_cert_free(CERT *c);
341 int ssl_set_cert_type(CERT *c, int type);
342 int ssl_get_new_session(SSL *s, int session);
343 int ssl_get_prev_session(SSL *s, unsigned char *session,int len);
344 int ssl_cipher_id_cmp(SSL_CIPHER *a,SSL_CIPHER *b);
345 int ssl_cipher_ptr_id_cmp(SSL_CIPHER **ap,SSL_CIPHER **bp);
346 STACK *ssl_bytes_to_cipher_list(SSL *s,unsigned char *p,int num,STACK **skp);
347 int ssl_cipher_list_to_bytes(SSL *s,STACK *sk,unsigned char *p);
348 STACK *ssl_create_cipher_list(SSL_METHOD *meth,STACK **pref,
349 STACK **sorted,char *str);
350 void ssl_update_cache(SSL *s, int mode);
351 int ssl_cipher_get_evp(SSL_CIPHER *c, EVP_CIPHER **enc, EVP_MD **md);
352 int ssl_verify_cert_chain(SSL *s,STACK *sk);
353 int ssl_undefined_function(SSL *s);
354 X509 *ssl_get_server_send_cert(SSL *);
355 EVP_PKEY *ssl_get_sign_pkey(SSL *,SSL_CIPHER *);
356 int ssl_cert_type(X509 *x,EVP_PKEY *pkey);
357 void ssl_set_cert_masks(CERT *c);
358 STACK *ssl_get_ciphers_by_id(SSL *s);
359 int ssl_verify_alarm_type(long type);
361 int ssl2_enc_init(SSL *s, int client);
362 void ssl2_generate_key_material(SSL *s);
363 void ssl2_enc(SSL *s,int send_data);
364 void ssl2_mac(SSL *s,unsigned char *mac,int send_data);
365 SSL_CIPHER *ssl2_get_cipher_by_char(unsigned char *p);
366 int ssl2_put_cipher_by_char(SSL_CIPHER *c,unsigned char *p);
367 int ssl2_part_read(SSL *s, unsigned long f, int i);
368 int ssl2_do_write(SSL *s);
369 int ssl2_set_certificate(SSL *s, int type, int len, unsigned char *data);
370 void ssl2_return_error(SSL *s,int reason);
371 void ssl2_write_error(SSL *s);
372 int ssl2_num_ciphers(void);
373 SSL_CIPHER *ssl2_get_cipher(unsigned int u);
374 int ssl2_new(SSL *s);
375 void ssl2_free(SSL *s);
376 int ssl2_accept(SSL *s);
377 int ssl2_connect(SSL *s);
378 int ssl2_read(SSL *s, char *buf, int len);
379 int ssl2_peek(SSL *s, char *buf, int len);
380 int ssl2_write(SSL *s, char *buf, int len);
381 int ssl2_shutdown(SSL *s);
382 void ssl2_clear(SSL *s);
383 long ssl2_ctrl(SSL *s,int cmd, long larg, char *parg);
384 long ssl2_ctx_ctrl(SSL_CTX *s,int cmd, long larg, char *parg);
385 int ssl2_pending(SSL *s);
387 SSL_CIPHER *ssl3_get_cipher_by_char(unsigned char *p);
388 int ssl3_put_cipher_by_char(SSL_CIPHER *c,unsigned char *p);
389 void ssl3_init_finished_mac(SSL *s);
390 int ssl3_send_server_certificate(SSL *s);
391 int ssl3_get_finished(SSL *s,int state_a,int state_b);
392 int ssl3_setup_key_block(SSL *s);
393 int ssl3_send_change_cipher_spec(SSL *s,int state_a,int state_b);
394 int ssl3_change_cipher_state(SSL *s,int which);
395 void ssl3_cleanup_key_block(SSL *s);
396 int ssl3_do_write(SSL *s,int type);
397 void ssl3_send_alert(SSL *s,int level, int desc);
398 int ssl3_generate_master_secret(SSL *s, unsigned char *out,
399 unsigned char *p, int len);
400 int ssl3_get_req_cert_type(SSL *s,unsigned char *p);
401 long ssl3_get_message(SSL *s, int st1, int stn, int mt, long max, int *ok);
402 int ssl3_send_finished(SSL *s, int a, int b, unsigned char *sender,int slen);
403 int ssl3_num_ciphers(void);
404 SSL_CIPHER *ssl3_get_cipher(unsigned int u);
405 int ssl3_renegotiate(SSL *ssl);
406 int ssl3_renegotiate_check(SSL *ssl);
407 int ssl3_dispatch_alert(SSL *s);
408 int ssl3_read_bytes(SSL *s, int type, char *buf, int len);
409 int ssl3_part_read(SSL *s, int i);
410 int ssl3_write_bytes(SSL *s, int type, char *buf, int len);
411 int ssl3_final_finish_mac(SSL *s, EVP_MD_CTX *ctx1,EVP_MD_CTX *ctx2,
412 unsigned char *sender, int slen,unsigned char *p);
413 int ssl3_cert_verify_mac(SSL *s, EVP_MD_CTX *in, unsigned char *p);
414 void ssl3_finish_mac(SSL *s, unsigned char *buf, int len);
415 int ssl3_enc(SSL *s, int send_data);
416 int ssl3_mac(SSL *ssl, unsigned char *md, int send_data);
417 unsigned long ssl3_output_cert_chain(SSL *s, X509 *x);
418 SSL_CIPHER *ssl3_choose_cipher(SSL *ssl,STACK *have,STACK *pref);
419 int ssl3_setup_buffers(SSL *s);
420 int ssl3_new(SSL *s);
421 void ssl3_free(SSL *s);
422 int ssl3_accept(SSL *s);
423 int ssl3_connect(SSL *s);
424 int ssl3_read(SSL *s, char *buf, int len);
425 int ssl3_peek(SSL *s,char *buf, int len);
426 int ssl3_write(SSL *s, char *buf, int len);
427 int ssl3_shutdown(SSL *s);
428 void ssl3_clear(SSL *s);
429 long ssl3_ctrl(SSL *s,int cmd, long larg, char *parg);
430 long ssl3_ctx_ctrl(SSL_CTX *s,int cmd, long larg, char *parg);
431 int ssl3_pending(SSL *s);
433 int ssl23_accept(SSL *s);
434 int ssl23_connect(SSL *s);
435 int ssl23_read_bytes(SSL *s, int n);
436 int ssl23_write_bytes(SSL *s);
438 int tls1_new(SSL *s);
439 void tls1_free(SSL *s);
440 void tls1_clear(SSL *s);
441 long tls1_ctrl(SSL *s,int cmd, long larg, char *parg);
442 SSL_METHOD *tlsv1_base_method(void );
444 int ssl_init_wbio_buffer(SSL *s, int push);
446 int tls1_change_cipher_state(SSL *s, int which);
447 int tls1_setup_key_block(SSL *s);
448 int tls1_enc(SSL *s, int snd);
449 int tls1_final_finish_mac(SSL *s, EVP_MD_CTX *in1_ctx, EVP_MD_CTX *in2_ctx,
450 unsigned char *str, int slen, unsigned char *p);
451 int tls1_cert_verify_mac(SSL *s, EVP_MD_CTX *in, unsigned char *p);
452 int tls1_mac(SSL *ssl, unsigned char *md, int snd);
453 int tls1_generate_master_secret(SSL *s, unsigned char *out,
454 unsigned char *p, int len);
455 int tls1_alert_code(int code);
456 int ssl3_alert_code(int code);
462 SSL_METHOD *ssl_bad_method();
463 SSL_METHOD *sslv2_base_method();
464 SSL_METHOD *sslv23_base_method();
465 SSL_METHOD *sslv3_base_method();
467 void ssl_clear_cipher_ctx();
468 int ssl_clear_bad_session();
469 CERT *ssl_cert_new();
470 void ssl_cert_free();
471 int ssl_set_cert_type();
472 int ssl_get_new_session();
473 int ssl_get_prev_session();
474 int ssl_cipher_id_cmp();
475 int ssl_cipher_ptr_id_cmp();
476 STACK *ssl_bytes_to_cipher_list();
477 int ssl_cipher_list_to_bytes();
478 STACK *ssl_create_cipher_list();
479 void ssl_update_cache();
480 int ssl_session_get_ciphers();
481 int ssl_verify_cert_chain();
482 int ssl_undefined_function();
483 X509 *ssl_get_server_send_cert();
484 EVP_PKEY *ssl_get_sign_pkey();
486 void ssl_set_cert_masks();
487 STACK *ssl_get_ciphers_by_id();
488 int ssl_verify_alarm_type();
491 void ssl2_generate_key_material();
494 SSL_CIPHER *ssl2_get_cipher_by_char();
495 int ssl2_put_cipher_by_char();
496 int ssl2_part_read();
498 int ssl2_set_certificate();
499 void ssl2_return_error();
500 void ssl2_write_error();
501 int ssl2_num_ciphers();
502 SSL_CIPHER *ssl2_get_cipher();
513 long ssl2_ctx_ctrl();
516 SSL_CIPHER *ssl3_get_cipher_by_char();
517 int ssl3_put_cipher_by_char();
518 void ssl3_init_finished_mac();
519 int ssl3_send_server_certificate();
520 int ssl3_get_finished();
521 int ssl3_setup_key_block();
522 int ssl3_send_change_cipher_spec();
523 int ssl3_change_cipher_state();
524 void ssl3_cleanup_key_block();
526 void ssl3_send_alert();
527 int ssl3_generate_master_secret();
528 int ssl3_get_req_cert_type();
529 long ssl3_get_message();
530 int ssl3_send_finished();
531 int ssl3_num_ciphers();
532 SSL_CIPHER *ssl3_get_cipher();
533 int ssl3_renegotiate();
534 int ssl3_renegotiate_check();
535 int ssl3_dispatch_alert();
536 int ssl3_read_bytes();
537 int ssl3_part_read();
538 int ssl3_write_bytes();
539 int ssl3_final_finish_mac();
540 void ssl3_finish_mac();
543 unsigned long ssl3_output_cert_chain();
544 SSL_CIPHER *ssl3_choose_cipher();
545 int ssl3_setup_buffers();
556 long ssl3_ctx_ctrl();
561 int ssl23_read_bytes();
562 int ssl23_write_bytes();
564 int ssl_init_wbio_buffer();
569 int ssl3_cert_verify_mac();
570 int ssl3_alert_code();
575 SSL_METHOD *tlsv1_base_method();
576 int tls1_change_cipher_state();
577 int tls1_setup_key_block();
579 int tls1_final_finish_mac();
580 int tls1_cert_verify_mac();
582 int tls1_generate_master_secret();
583 int tls1_alert_code();