3 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
6 * This package is an SSL implementation written
7 * by Eric Young (eay@cryptsoft.com).
8 * The implementation was written so as to conform with Netscapes SSL.
10 * This library is free for commercial and non-commercial use as long as
11 * the following conditions are aheared to. The following conditions
12 * apply to all code found in this distribution, be it the RC4, RSA,
13 * lhash, DES, etc., code; not just the SSL code. The SSL documentation
14 * included with this distribution is covered by the same copyright terms
15 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
17 * Copyright remains Eric Young's, and as such any Copyright notices in
18 * the code are not to be removed.
19 * If this package is used in a product, Eric Young should be given attribution
20 * as the author of the parts of the library used.
21 * This can be in the form of a textual message at program startup or
22 * in documentation (online or textual) provided with the package.
24 * Redistribution and use in source and binary forms, with or without
25 * modification, are permitted provided that the following conditions
27 * 1. Redistributions of source code must retain the copyright
28 * notice, this list of conditions and the following disclaimer.
29 * 2. Redistributions in binary form must reproduce the above copyright
30 * notice, this list of conditions and the following disclaimer in the
31 * documentation and/or other materials provided with the distribution.
32 * 3. All advertising materials mentioning features or use of this software
33 * must display the following acknowledgement:
34 * "This product includes cryptographic software written by
35 * Eric Young (eay@cryptsoft.com)"
36 * The word 'cryptographic' can be left out if the rouines from the library
37 * being used are not cryptographic related :-).
38 * 4. If you include any Windows specific code (or a derivative thereof) from
39 * the apps directory (application code) you must include an acknowledgement:
40 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
42 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
43 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
54 * The licence and distribution terms for any publically available version or
55 * derivative of this code cannot be changed. i.e. this code cannot simply be
56 * copied and put under another distribution licence
57 * [including the GNU Public Licence.]
59 /* ====================================================================
60 * Copyright (c) 1998-2006 The OpenSSL Project. All rights reserved.
62 * Redistribution and use in source and binary forms, with or without
63 * modification, are permitted provided that the following conditions
66 * 1. Redistributions of source code must retain the above copyright
67 * notice, this list of conditions and the following disclaimer.
69 * 2. Redistributions in binary form must reproduce the above copyright
70 * notice, this list of conditions and the following disclaimer in
71 * the documentation and/or other materials provided with the
74 * 3. All advertising materials mentioning features or use of this
75 * software must display the following acknowledgment:
76 * "This product includes software developed by the OpenSSL Project
77 * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
79 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
80 * endorse or promote products derived from this software without
81 * prior written permission. For written permission, please contact
82 * openssl-core@openssl.org.
84 * 5. Products derived from this software may not be called "OpenSSL"
85 * nor may "OpenSSL" appear in their names without prior written
86 * permission of the OpenSSL Project.
88 * 6. Redistributions of any form whatsoever must retain the following
90 * "This product includes software developed by the OpenSSL Project
91 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
93 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
94 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
95 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
96 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
97 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
98 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
99 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
100 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
102 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
103 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
104 * OF THE POSSIBILITY OF SUCH DAMAGE.
105 * ====================================================================
107 * This product includes cryptographic software written by Eric Young
108 * (eay@cryptsoft.com). This product includes software written by Tim
109 * Hudson (tjh@cryptsoft.com).
112 /* ====================================================================
113 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
114 * ECC cipher suite support in OpenSSL originally developed by
115 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
117 /* ====================================================================
118 * Copyright 2005 Nokia. All rights reserved.
120 * The portions of the attached software ("Contribution") is developed by
121 * Nokia Corporation and is licensed pursuant to the OpenSSL open source
124 * The Contribution, originally written by Mika Kousa and Pasi Eronen of
125 * Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
126 * support (see RFC 4279) to OpenSSL.
128 * No patent licenses or other rights except those expressly stated in
129 * the OpenSSL open source license shall be deemed granted or received
130 * expressly, by implication, estoppel, or otherwise.
132 * No assurances are provided by Nokia that the Contribution does not
133 * infringe the patent or other intellectual property rights of any third
134 * party or that the license provides you with all the necessary rights
135 * to make use of the Contribution.
137 * THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
138 * ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
139 * SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
140 * OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
144 #ifndef HEADER_SSL_LOCL_H
145 #define HEADER_SSL_LOCL_H
153 #include <openssl/buffer.h>
154 #include <openssl/comp.h>
155 #include <openssl/bio.h>
156 #include <openssl/stack.h>
157 #ifndef OPENSSL_NO_RSA
158 #include <openssl/rsa.h>
160 #ifndef OPENSSL_NO_DSA
161 #include <openssl/dsa.h>
163 #include <openssl/err.h>
164 #include <openssl/ssl.h>
165 #include <openssl/symhacks.h>
167 #ifdef OPENSSL_BUILD_SHLIBSSL
168 # undef OPENSSL_EXTERN
169 # define OPENSSL_EXTERN OPENSSL_EXPORT
174 #define c2l(c,l) (l = ((unsigned long)(*((c)++))) , \
175 l|=(((unsigned long)(*((c)++)))<< 8), \
176 l|=(((unsigned long)(*((c)++)))<<16), \
177 l|=(((unsigned long)(*((c)++)))<<24))
179 /* NOTE - c is not incremented as per c2l */
180 #define c2ln(c,l1,l2,n) { \
184 case 8: l2 =((unsigned long)(*(--(c))))<<24; \
185 case 7: l2|=((unsigned long)(*(--(c))))<<16; \
186 case 6: l2|=((unsigned long)(*(--(c))))<< 8; \
187 case 5: l2|=((unsigned long)(*(--(c)))); \
188 case 4: l1 =((unsigned long)(*(--(c))))<<24; \
189 case 3: l1|=((unsigned long)(*(--(c))))<<16; \
190 case 2: l1|=((unsigned long)(*(--(c))))<< 8; \
191 case 1: l1|=((unsigned long)(*(--(c)))); \
195 #define l2c(l,c) (*((c)++)=(unsigned char)(((l) )&0xff), \
196 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
197 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
198 *((c)++)=(unsigned char)(((l)>>24)&0xff))
200 #define n2l(c,l) (l =((unsigned long)(*((c)++)))<<24, \
201 l|=((unsigned long)(*((c)++)))<<16, \
202 l|=((unsigned long)(*((c)++)))<< 8, \
203 l|=((unsigned long)(*((c)++))))
205 #define l2n(l,c) (*((c)++)=(unsigned char)(((l)>>24)&0xff), \
206 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
207 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
208 *((c)++)=(unsigned char)(((l) )&0xff))
210 #define l2n6(l,c) (*((c)++)=(unsigned char)(((l)>>40)&0xff), \
211 *((c)++)=(unsigned char)(((l)>>32)&0xff), \
212 *((c)++)=(unsigned char)(((l)>>24)&0xff), \
213 *((c)++)=(unsigned char)(((l)>>16)&0xff), \
214 *((c)++)=(unsigned char)(((l)>> 8)&0xff), \
215 *((c)++)=(unsigned char)(((l) )&0xff))
217 #define n2l6(c,l) (l =((BN_ULLONG)(*((c)++)))<<40, \
218 l|=((BN_ULLONG)(*((c)++)))<<32, \
219 l|=((BN_ULLONG)(*((c)++)))<<24, \
220 l|=((BN_ULLONG)(*((c)++)))<<16, \
221 l|=((BN_ULLONG)(*((c)++)))<< 8, \
222 l|=((BN_ULLONG)(*((c)++))))
224 /* NOTE - c is not incremented as per l2c */
225 #define l2cn(l1,l2,c,n) { \
228 case 8: *(--(c))=(unsigned char)(((l2)>>24)&0xff); \
229 case 7: *(--(c))=(unsigned char)(((l2)>>16)&0xff); \
230 case 6: *(--(c))=(unsigned char)(((l2)>> 8)&0xff); \
231 case 5: *(--(c))=(unsigned char)(((l2) )&0xff); \
232 case 4: *(--(c))=(unsigned char)(((l1)>>24)&0xff); \
233 case 3: *(--(c))=(unsigned char)(((l1)>>16)&0xff); \
234 case 2: *(--(c))=(unsigned char)(((l1)>> 8)&0xff); \
235 case 1: *(--(c))=(unsigned char)(((l1) )&0xff); \
239 #define n2s(c,s) ((s=(((unsigned int)(c[0]))<< 8)| \
240 (((unsigned int)(c[1])) )),c+=2)
241 #define s2n(s,c) ((c[0]=(unsigned char)(((s)>> 8)&0xff), \
242 c[1]=(unsigned char)(((s) )&0xff)),c+=2)
244 #define n2l3(c,l) ((l =(((unsigned long)(c[0]))<<16)| \
245 (((unsigned long)(c[1]))<< 8)| \
246 (((unsigned long)(c[2])) )),c+=3)
248 #define l2n3(l,c) ((c[0]=(unsigned char)(((l)>>16)&0xff), \
249 c[1]=(unsigned char)(((l)>> 8)&0xff), \
250 c[2]=(unsigned char)(((l) )&0xff)),c+=3)
254 #define SSL_DECRYPT 0
255 #define SSL_ENCRYPT 1
257 #define TWO_BYTE_BIT 0x80
258 #define SEC_ESC_BIT 0x40
259 #define TWO_BYTE_MASK 0x7fff
260 #define THREE_BYTE_MASK 0x3fff
262 #define INC32(a) ((a)=((a)+1)&0xffffffffL)
263 #define DEC32(a) ((a)=((a)-1)&0xffffffffL)
264 #define MAX_MAC_SIZE 20 /* up from 16 for SSLv3 */
267 * Define the Bitmasks for SSL_CIPHER.algorithms.
268 * This bits are used packed as dense as possible. If new methods/ciphers
269 * etc will be added, the bits a likely to change, so this information
270 * is for internal library use only, even though SSL_CIPHER.algorithms
271 * can be publicly accessed.
272 * Use the according functions for cipher management instead.
274 * The bit mask handling in the selection and sorting scheme in
275 * ssl_create_cipher_list() has only limited capabilities, reflecting
276 * that the different entities within are mutually exclusive:
277 * ONLY ONE BIT PER MASK CAN BE SET AT A TIME.
279 #define SSL_MKEY_MASK 0x080000FFL
280 #define SSL_kRSA 0x00000001L /* RSA key exchange */
281 #define SSL_kDHr 0x00000002L /* DH cert RSA CA cert */
282 #define SSL_kDHd 0x00000004L /* DH cert DSA CA cert */
283 #define SSL_kFZA 0x00000008L
284 #define SSL_kEDH 0x00000010L /* tmp DH key no DH cert */
285 #define SSL_kKRB5 0x00000020L /* Kerberos5 key exchange */
286 #define SSL_kECDH 0x00000040L /* ECDH w/ long-term keys */
287 #define SSL_kECDHE 0x00000080L /* ephemeral ECDH */
288 #define SSL_EDH (SSL_kEDH|(SSL_AUTH_MASK^SSL_aNULL))
289 #define SSL_kPSK 0x08000000L /* PSK */
291 #define SSL_AUTH_MASK 0x10007f00L
292 #define SSL_aRSA 0x00000100L /* Authenticate with RSA */
293 #define SSL_aDSS 0x00000200L /* Authenticate with DSS */
294 #define SSL_DSS SSL_aDSS
295 #define SSL_aFZA 0x00000400L
296 #define SSL_aNULL 0x00000800L /* no Authenticate, ADH */
297 #define SSL_aDH 0x00001000L /* no Authenticate, ADH */
298 #define SSL_aKRB5 0x00002000L /* Authenticate with KRB5 */
299 #define SSL_aECDSA 0x00004000L /* Authenticate with ECDSA */
300 #define SSL_aPSK 0x10000000L /* PSK */
302 #define SSL_NULL (SSL_eNULL)
303 #define SSL_ADH (SSL_kEDH|SSL_aNULL)
304 #define SSL_RSA (SSL_kRSA|SSL_aRSA)
305 #define SSL_DH (SSL_kDHr|SSL_kDHd|SSL_kEDH)
306 #define SSL_ECDH (SSL_kECDH|SSL_kECDHE)
307 #define SSL_FZA (SSL_aFZA|SSL_kFZA|SSL_eFZA)
308 #define SSL_KRB5 (SSL_kKRB5|SSL_aKRB5)
309 #define SSL_PSK (SSL_kPSK|SSL_aPSK)
311 #define SSL_ENC_MASK 0x043F8000L
312 #define SSL_DES 0x00008000L
313 #define SSL_3DES 0x00010000L
314 #define SSL_RC4 0x00020000L
315 #define SSL_RC2 0x00040000L
316 #define SSL_IDEA 0x00080000L
317 #define SSL_eFZA 0x00100000L
318 #define SSL_eNULL 0x00200000L
319 #define SSL_AES 0x04000000L
321 #define SSL_MAC_MASK 0x00c00000L
322 #define SSL_MD5 0x00400000L
323 #define SSL_SHA1 0x00800000L
324 #define SSL_SHA (SSL_SHA1)
326 #define SSL_SSL_MASK 0x03000000L
327 #define SSL_SSLV2 0x01000000L
328 #define SSL_SSLV3 0x02000000L
329 #define SSL_TLSV1 SSL_SSLV3 /* for now */
331 /* we have used 1fffffff - 3 bits left to go. */
334 * Export and cipher strength information. For each cipher we have to decide
335 * whether it is exportable or not. This information is likely to change
336 * over time, since the export control rules are no static technical issue.
338 * Independent of the export flag the cipher strength is sorted into classes.
339 * SSL_EXP40 was denoting the 40bit US export limit of past times, which now
340 * is at 56bit (SSL_EXP56). If the exportable cipher class is going to change
341 * again (eg. to 64bit) the use of "SSL_EXP*" becomes blurred even more,
342 * since SSL_EXP64 could be similar to SSL_LOW.
343 * For this reason SSL_MICRO and SSL_MINI macros are included to widen the
344 * namespace of SSL_LOW-SSL_HIGH to lower values. As development of speed
345 * and ciphers goes, another extension to SSL_SUPER and/or SSL_ULTRA would
348 #define SSL_EXP_MASK 0x00000003L
349 #define SSL_NOT_EXP 0x00000001L
350 #define SSL_EXPORT 0x00000002L
352 #define SSL_STRONG_MASK 0x000000fcL
353 #define SSL_STRONG_NONE 0x00000004L
354 #define SSL_EXP40 0x00000008L
355 #define SSL_MICRO (SSL_EXP40)
356 #define SSL_EXP56 0x00000010L
357 #define SSL_MINI (SSL_EXP56)
358 #define SSL_LOW 0x00000020L
359 #define SSL_MEDIUM 0x00000040L
360 #define SSL_HIGH 0x00000080L
362 /* we have used 000000ff - 24 bits left to go */
365 * Macros to check the export status and cipher strength for export ciphers.
366 * Even though the macros for EXPORT and EXPORT40/56 have similar names,
367 * their meaning is different:
368 * *_EXPORT macros check the 'exportable' status.
369 * *_EXPORT40/56 macros are used to check whether a certain cipher strength
371 * Since the SSL_IS_EXPORT* and SSL_EXPORT* macros depend on the correct
372 * algorithm structure element to be passed (algorithms, algo_strength) and no
373 * typechecking can be done as they are all of type unsigned long, their
374 * direct usage is discouraged.
375 * Use the SSL_C_* macros instead.
377 #define SSL_IS_EXPORT(a) ((a)&SSL_EXPORT)
378 #define SSL_IS_EXPORT56(a) ((a)&SSL_EXP56)
379 #define SSL_IS_EXPORT40(a) ((a)&SSL_EXP40)
380 #define SSL_C_IS_EXPORT(c) SSL_IS_EXPORT((c)->algo_strength)
381 #define SSL_C_IS_EXPORT56(c) SSL_IS_EXPORT56((c)->algo_strength)
382 #define SSL_C_IS_EXPORT40(c) SSL_IS_EXPORT40((c)->algo_strength)
384 #define SSL_EXPORT_KEYLENGTH(a,s) (SSL_IS_EXPORT40(s) ? 5 : \
385 ((a)&SSL_ENC_MASK) == SSL_DES ? 8 : 7)
386 #define SSL_EXPORT_PKEYLENGTH(a) (SSL_IS_EXPORT40(a) ? 512 : 1024)
387 #define SSL_C_EXPORT_KEYLENGTH(c) SSL_EXPORT_KEYLENGTH((c)->algorithms, \
389 #define SSL_C_EXPORT_PKEYLENGTH(c) SSL_EXPORT_PKEYLENGTH((c)->algo_strength)
392 #define SSL_ALL 0xffffffffL
393 #define SSL_ALL_CIPHERS (SSL_MKEY_MASK|SSL_AUTH_MASK|SSL_ENC_MASK|\
395 #define SSL_ALL_STRENGTHS (SSL_EXP_MASK|SSL_STRONG_MASK)
397 /* Mostly for SSLv3 */
398 #define SSL_PKEY_RSA_ENC 0
399 #define SSL_PKEY_RSA_SIGN 1
400 #define SSL_PKEY_DSA_SIGN 2
401 #define SSL_PKEY_DH_RSA 3
402 #define SSL_PKEY_DH_DSA 4
403 #define SSL_PKEY_ECC 5
404 #define SSL_PKEY_NUM 6
406 /* SSL_kRSA <- RSA_ENC | (RSA_TMP & RSA_SIGN) |
407 * <- (EXPORT & (RSA_ENC | RSA_TMP) & RSA_SIGN)
408 * SSL_kDH <- DH_ENC & (RSA_ENC | RSA_SIGN | DSA_SIGN)
409 * SSL_kEDH <- RSA_ENC | RSA_SIGN | DSA_SIGN
410 * SSL_aRSA <- RSA_ENC | RSA_SIGN
411 * SSL_aDSS <- DSA_SIGN
415 #define CERT_INVALID 0
416 #define CERT_PUBLIC_KEY 1
417 #define CERT_PRIVATE_KEY 2
420 #ifndef OPENSSL_NO_EC
421 /* From ECC-TLS draft, used in encoding the curve type in
424 #define EXPLICIT_PRIME_CURVE_TYPE 1
425 #define EXPLICIT_CHAR2_CURVE_TYPE 2
426 #define NAMED_CURVE_TYPE 3
427 #endif /* OPENSSL_NO_EC */
429 typedef struct cert_pkey_st
432 EVP_PKEY
*privatekey
;
435 typedef struct cert_st
437 /* Current active set */
438 CERT_PKEY
*key
; /* ALWAYS points to an element of the pkeys array
439 * Probably it would make more sense to store
440 * an index, not a pointer. */
442 /* The following masks are for the key and auth
443 * algorithms that are supported by the certs below */
446 unsigned long export_mask
;
447 #ifndef OPENSSL_NO_RSA
449 RSA
*(*rsa_tmp_cb
)(SSL
*ssl
,int is_export
,int keysize
);
451 #ifndef OPENSSL_NO_DH
453 DH
*(*dh_tmp_cb
)(SSL
*ssl
,int is_export
,int keysize
);
455 #ifndef OPENSSL_NO_ECDH
457 /* Callback for generating ephemeral ECDH keys */
458 EC_KEY
*(*ecdh_tmp_cb
)(SSL
*ssl
,int is_export
,int keysize
);
461 CERT_PKEY pkeys
[SSL_PKEY_NUM
];
463 int references
; /* >1 only if SSL_copy_session_id is used */
467 typedef struct sess_cert_st
469 STACK_OF(X509
) *cert_chain
; /* as received from peer (not for SSL2) */
471 /* The 'peer_...' members are used only by clients. */
474 CERT_PKEY
*peer_key
; /* points to an element of peer_pkeys (never NULL!) */
475 CERT_PKEY peer_pkeys
[SSL_PKEY_NUM
];
476 /* Obviously we don't have the private keys of these,
477 * so maybe we shouldn't even use the CERT_PKEY type here. */
479 #ifndef OPENSSL_NO_RSA
480 RSA
*peer_rsa_tmp
; /* not used for SSL 2 */
482 #ifndef OPENSSL_NO_DH
483 DH
*peer_dh_tmp
; /* not used for SSL 2 */
485 #ifndef OPENSSL_NO_ECDH
486 EC_KEY
*peer_ecdh_tmp
;
489 int references
; /* actually always 1 at the moment */
493 /*#define MAC_DEBUG */
495 /*#define ERR_DEBUG */
496 /*#define ABORT_DEBUG */
497 /*#define PKT_DEBUG 1 */
498 /*#define DES_DEBUG */
499 /*#define DES_OFB_DEBUG */
500 /*#define SSL_DEBUG */
501 /*#define RSA_DEBUG */
502 /*#define IDEA_DEBUG */
504 #define FP_ICC (int (*)(const void *,const void *))
505 #define ssl_put_cipher_by_char(ssl,ciph,ptr) \
506 ((ssl)->method->put_cipher_by_char((ciph),(ptr)))
507 #define ssl_get_cipher_by_char(ssl,ptr) \
508 ((ssl)->method->get_cipher_by_char(ptr))
510 /* This is for the SSLv3/TLSv1.0 differences in crypto/hash stuff
511 * It is a bit of a mess of functions, but hell, think of it as
512 * an opaque structure :-) */
513 typedef struct ssl3_enc_method
515 int (*enc
)(SSL
*, int);
516 int (*mac
)(SSL
*, unsigned char *, int);
517 int (*setup_key_block
)(SSL
*);
518 int (*generate_master_secret
)(SSL
*, unsigned char *, unsigned char *, int);
519 int (*change_cipher_state
)(SSL
*, int);
520 int (*final_finish_mac
)(SSL
*, EVP_MD_CTX
*, EVP_MD_CTX
*, const char *, int, unsigned char *);
521 int finish_mac_length
;
522 int (*cert_verify_mac
)(SSL
*, EVP_MD_CTX
*, unsigned char *);
523 const char *client_finished_label
;
524 int client_finished_label_len
;
525 const char *server_finished_label
;
526 int server_finished_label_len
;
527 int (*alert_value
)(int);
530 /* Used for holding the relevant compression methods loaded into SSL_CTX */
531 typedef struct ssl3_comp_st
533 int comp_id
; /* The identifier byte for this compression type */
534 char *name
; /* Text name used for the compression type */
535 COMP_METHOD
*method
; /* The method :-) */
538 extern SSL3_ENC_METHOD ssl3_undef_enc_method
;
539 OPENSSL_EXTERN SSL_CIPHER ssl2_ciphers
[];
540 OPENSSL_EXTERN SSL_CIPHER ssl3_ciphers
[];
543 SSL_METHOD
*ssl_bad_method(int ver
);
545 extern SSL3_ENC_METHOD TLSv1_enc_data
;
546 extern SSL3_ENC_METHOD SSLv3_enc_data
;
547 extern SSL3_ENC_METHOD DTLSv1_enc_data
;
549 #define IMPLEMENT_tls1_meth_func(func_name, s_accept, s_connect, s_get_meth) \
550 const SSL_METHOD *func_name(void) \
552 static const SSL_METHOD func_name##_data= { \
564 ssl3_renegotiate_check, \
568 ssl3_dispatch_alert, \
571 ssl3_get_cipher_by_char, \
572 ssl3_put_cipher_by_char, \
577 tls1_default_timeout, \
579 ssl_undefined_void_function, \
580 ssl3_callback_ctrl, \
581 ssl3_ctx_callback_ctrl, \
583 return &func_name##_data; \
586 #define IMPLEMENT_ssl3_meth_func(func_name, s_accept, s_connect, s_get_meth) \
587 const SSL_METHOD *func_name(void) \
589 static const SSL_METHOD func_name##_data= { \
601 ssl3_renegotiate_check, \
605 ssl3_dispatch_alert, \
608 ssl3_get_cipher_by_char, \
609 ssl3_put_cipher_by_char, \
614 ssl3_default_timeout, \
616 ssl_undefined_void_function, \
617 ssl3_callback_ctrl, \
618 ssl3_ctx_callback_ctrl, \
620 return &func_name##_data; \
623 #define IMPLEMENT_ssl23_meth_func(func_name, s_accept, s_connect, s_get_meth) \
624 const SSL_METHOD *func_name(void) \
626 static const SSL_METHOD func_name##_data= { \
636 ssl_undefined_function, \
637 ssl_undefined_function, \
642 ssl3_dispatch_alert, \
645 ssl23_get_cipher_by_char, \
646 ssl23_put_cipher_by_char, \
647 ssl_undefined_const_function, \
651 ssl23_default_timeout, \
652 &ssl3_undef_enc_method, \
653 ssl_undefined_void_function, \
654 ssl3_callback_ctrl, \
655 ssl3_ctx_callback_ctrl, \
657 return &func_name##_data; \
660 #define IMPLEMENT_ssl2_meth_func(func_name, s_accept, s_connect, s_get_meth) \
661 const SSL_METHOD *func_name(void) \
663 static const SSL_METHOD func_name##_data= { \
665 ssl2_new, /* local */ \
666 ssl2_clear, /* local */ \
667 ssl2_free, /* local */ \
674 ssl_ok, /* NULL - renegotiate */ \
675 ssl_ok, /* NULL - check renegotiate */ \
676 NULL, /* NULL - ssl_get_message */ \
677 NULL, /* NULL - ssl_get_record */ \
678 NULL, /* NULL - ssl_write_bytes */ \
679 NULL, /* NULL - dispatch_alert */ \
680 ssl2_ctrl, /* local */ \
681 ssl2_ctx_ctrl, /* local */ \
682 ssl2_get_cipher_by_char, \
683 ssl2_put_cipher_by_char, \
688 ssl2_default_timeout, \
689 &ssl3_undef_enc_method, \
690 ssl_undefined_void_function, \
691 ssl2_callback_ctrl, /* local */ \
692 ssl2_ctx_callback_ctrl, /* local */ \
694 return &func_name##_data; \
697 #define IMPLEMENT_dtls1_meth_func(func_name, s_accept, s_connect, s_get_meth) \
698 const SSL_METHOD *func_name(void) \
700 static const SSL_METHOD func_name##_data= { \
712 ssl3_renegotiate_check, \
715 dtls1_write_app_data_bytes, \
716 dtls1_dispatch_alert, \
719 ssl3_get_cipher_by_char, \
720 ssl3_put_cipher_by_char, \
725 dtls1_default_timeout, \
727 ssl_undefined_void_function, \
728 ssl3_callback_ctrl, \
729 ssl3_ctx_callback_ctrl, \
731 return &func_name##_data; \
734 void ssl_clear_cipher_ctx(SSL
*s
);
735 int ssl_clear_bad_session(SSL
*s
);
736 CERT
*ssl_cert_new(void);
737 CERT
*ssl_cert_dup(CERT
*cert
);
738 int ssl_cert_inst(CERT
**o
);
739 void ssl_cert_free(CERT
*c
);
740 SESS_CERT
*ssl_sess_cert_new(void);
741 void ssl_sess_cert_free(SESS_CERT
*sc
);
742 int ssl_set_peer_cert_type(SESS_CERT
*c
, int type
);
743 int ssl_get_new_session(SSL
*s
, int session
);
744 int ssl_get_prev_session(SSL
*s
, unsigned char *session
,int len
);
745 int ssl_cipher_id_cmp(const SSL_CIPHER
*a
,const SSL_CIPHER
*b
);
746 int ssl_cipher_ptr_id_cmp(const SSL_CIPHER
* const *ap
,
747 const SSL_CIPHER
* const *bp
);
748 STACK_OF(SSL_CIPHER
) *ssl_bytes_to_cipher_list(SSL
*s
,unsigned char *p
,int num
,
749 STACK_OF(SSL_CIPHER
) **skp
);
750 int ssl_cipher_list_to_bytes(SSL
*s
,STACK_OF(SSL_CIPHER
) *sk
,unsigned char *p
,
751 int (*put_cb
)(const SSL_CIPHER
*, unsigned char *));
752 STACK_OF(SSL_CIPHER
) *ssl_create_cipher_list(const SSL_METHOD
*meth
,
753 STACK_OF(SSL_CIPHER
) **pref
,
754 STACK_OF(SSL_CIPHER
) **sorted
,
755 const char *rule_str
);
756 void ssl_update_cache(SSL
*s
, int mode
);
757 int ssl_cipher_get_evp(const SSL_SESSION
*s
,const EVP_CIPHER
**enc
,
758 const EVP_MD
**md
,SSL_COMP
**comp
);
759 int ssl_verify_cert_chain(SSL
*s
,STACK_OF(X509
) *sk
);
760 int ssl_undefined_function(SSL
*s
);
761 int ssl_undefined_void_function(void);
762 int ssl_undefined_const_function(const SSL
*s
);
763 X509
*ssl_get_server_send_cert(SSL
*);
764 EVP_PKEY
*ssl_get_sign_pkey(SSL
*,SSL_CIPHER
*);
765 int ssl_cert_type(X509
*x
,EVP_PKEY
*pkey
);
766 void ssl_set_cert_masks(CERT
*c
, SSL_CIPHER
*cipher
);
767 STACK_OF(SSL_CIPHER
) *ssl_get_ciphers_by_id(SSL
*s
);
768 int ssl_verify_alarm_type(long type
);
769 void ssl_load_ciphers(void);
771 int ssl2_enc_init(SSL
*s
, int client
);
772 int ssl2_generate_key_material(SSL
*s
);
773 void ssl2_enc(SSL
*s
,int send_data
);
774 void ssl2_mac(SSL
*s
,unsigned char *mac
,int send_data
);
775 SSL_CIPHER
*ssl2_get_cipher_by_char(const unsigned char *p
);
776 int ssl2_put_cipher_by_char(const SSL_CIPHER
*c
,unsigned char *p
);
777 int ssl2_part_read(SSL
*s
, unsigned long f
, int i
);
778 int ssl2_do_write(SSL
*s
);
779 int ssl2_set_certificate(SSL
*s
, int type
, int len
, const unsigned char *data
);
780 void ssl2_return_error(SSL
*s
,int reason
);
781 void ssl2_write_error(SSL
*s
);
782 int ssl2_num_ciphers(void);
783 SSL_CIPHER
*ssl2_get_cipher(unsigned int u
);
784 int ssl2_new(SSL
*s
);
785 void ssl2_free(SSL
*s
);
786 int ssl2_accept(SSL
*s
);
787 int ssl2_connect(SSL
*s
);
788 int ssl2_read(SSL
*s
, void *buf
, int len
);
789 int ssl2_peek(SSL
*s
, void *buf
, int len
);
790 int ssl2_write(SSL
*s
, const void *buf
, int len
);
791 int ssl2_shutdown(SSL
*s
);
792 void ssl2_clear(SSL
*s
);
793 long ssl2_ctrl(SSL
*s
,int cmd
, long larg
, void *parg
);
794 long ssl2_ctx_ctrl(SSL_CTX
*s
,int cmd
, long larg
, void *parg
);
795 long ssl2_callback_ctrl(SSL
*s
,int cmd
, void (*fp
)(void));
796 long ssl2_ctx_callback_ctrl(SSL_CTX
*s
,int cmd
, void (*fp
)(void));
797 int ssl2_pending(const SSL
*s
);
798 long ssl2_default_timeout(void );
800 SSL_CIPHER
*ssl3_get_cipher_by_char(const unsigned char *p
);
801 int ssl3_put_cipher_by_char(const SSL_CIPHER
*c
,unsigned char *p
);
802 void ssl3_init_finished_mac(SSL
*s
);
803 int ssl3_send_server_certificate(SSL
*s
);
804 int ssl3_get_finished(SSL
*s
,int state_a
,int state_b
);
805 int ssl3_setup_key_block(SSL
*s
);
806 int ssl3_send_change_cipher_spec(SSL
*s
,int state_a
,int state_b
);
807 int ssl3_change_cipher_state(SSL
*s
,int which
);
808 void ssl3_cleanup_key_block(SSL
*s
);
809 int ssl3_do_write(SSL
*s
,int type
);
810 void ssl3_send_alert(SSL
*s
,int level
, int desc
);
811 int ssl3_generate_master_secret(SSL
*s
, unsigned char *out
,
812 unsigned char *p
, int len
);
813 int ssl3_get_req_cert_type(SSL
*s
,unsigned char *p
);
814 long ssl3_get_message(SSL
*s
, int st1
, int stn
, int mt
, long max
, int *ok
);
815 int ssl3_send_finished(SSL
*s
, int a
, int b
, const char *sender
,int slen
);
816 int ssl3_num_ciphers(void);
817 SSL_CIPHER
*ssl3_get_cipher(unsigned int u
);
818 int ssl3_renegotiate(SSL
*ssl
);
819 int ssl3_renegotiate_check(SSL
*ssl
);
820 int ssl3_dispatch_alert(SSL
*s
);
821 int ssl3_read_bytes(SSL
*s
, int type
, unsigned char *buf
, int len
, int peek
);
822 int ssl3_write_bytes(SSL
*s
, int type
, const void *buf
, int len
);
823 int ssl3_final_finish_mac(SSL
*s
, EVP_MD_CTX
*ctx1
, EVP_MD_CTX
*ctx2
,
824 const char *sender
, int slen
,unsigned char *p
);
825 int ssl3_cert_verify_mac(SSL
*s
, EVP_MD_CTX
*in
, unsigned char *p
);
826 void ssl3_finish_mac(SSL
*s
, const unsigned char *buf
, int len
);
827 int ssl3_enc(SSL
*s
, int send_data
);
828 int ssl3_mac(SSL
*ssl
, unsigned char *md
, int send_data
);
829 unsigned long ssl3_output_cert_chain(SSL
*s
, X509
*x
);
830 SSL_CIPHER
*ssl3_choose_cipher(SSL
*ssl
,STACK_OF(SSL_CIPHER
) *clnt
,
831 STACK_OF(SSL_CIPHER
) *srvr
);
832 int ssl3_setup_buffers(SSL
*s
);
833 int ssl3_new(SSL
*s
);
834 void ssl3_free(SSL
*s
);
835 int ssl3_accept(SSL
*s
);
836 int ssl3_connect(SSL
*s
);
837 int ssl3_read(SSL
*s
, void *buf
, int len
);
838 int ssl3_peek(SSL
*s
, void *buf
, int len
);
839 int ssl3_write(SSL
*s
, const void *buf
, int len
);
840 int ssl3_shutdown(SSL
*s
);
841 void ssl3_clear(SSL
*s
);
842 long ssl3_ctrl(SSL
*s
,int cmd
, long larg
, void *parg
);
843 long ssl3_ctx_ctrl(SSL_CTX
*s
,int cmd
, long larg
, void *parg
);
844 long ssl3_callback_ctrl(SSL
*s
,int cmd
, void (*fp
)(void));
845 long ssl3_ctx_callback_ctrl(SSL_CTX
*s
,int cmd
, void (*fp
)(void));
846 int ssl3_pending(const SSL
*s
);
848 void ssl3_record_sequence_update(unsigned char *seq
);
849 int ssl3_do_change_cipher_spec(SSL
*ssl
);
850 long ssl3_default_timeout(void );
852 int ssl23_num_ciphers(void );
853 SSL_CIPHER
*ssl23_get_cipher(unsigned int u
);
854 int ssl23_read(SSL
*s
, void *buf
, int len
);
855 int ssl23_peek(SSL
*s
, void *buf
, int len
);
856 int ssl23_write(SSL
*s
, const void *buf
, int len
);
857 int ssl23_put_cipher_by_char(const SSL_CIPHER
*c
, unsigned char *p
);
858 SSL_CIPHER
*ssl23_get_cipher_by_char(const unsigned char *p
);
859 long ssl23_default_timeout(void );
861 long tls1_default_timeout(void);
862 int dtls1_do_write(SSL
*s
,int type
);
863 int ssl3_read_n(SSL
*s
, int n
, int max
, int extend
);
864 int dtls1_read_bytes(SSL
*s
, int type
, unsigned char *buf
, int len
, int peek
);
865 int ssl3_do_compress(SSL
*ssl
);
866 int ssl3_do_uncompress(SSL
*ssl
);
867 int ssl3_write_pending(SSL
*s
, int type
, const unsigned char *buf
,
869 unsigned char *dtls1_set_message_header(SSL
*s
,
870 unsigned char *p
, unsigned char mt
, unsigned long len
,
871 unsigned long frag_off
, unsigned long frag_len
);
873 int dtls1_write_app_data_bytes(SSL
*s
, int type
, const void *buf
, int len
);
874 int dtls1_write_bytes(SSL
*s
, int type
, const void *buf
, int len
);
876 int dtls1_send_change_cipher_spec(SSL
*s
, int a
, int b
);
877 int dtls1_send_finished(SSL
*s
, int a
, int b
, const char *sender
, int slen
);
878 unsigned long dtls1_output_cert_chain(SSL
*s
, X509
*x
);
879 int dtls1_read_failed(SSL
*s
, int code
);
880 int dtls1_buffer_message(SSL
*s
, int ccs
);
881 int dtls1_retransmit_message(SSL
*s
, unsigned short seq
,
882 unsigned long frag_off
, int *found
);
883 void dtls1_clear_record_buffer(SSL
*s
);
884 void dtls1_get_message_header(unsigned char *data
, struct hm_header_st
*msg_hdr
);
885 void dtls1_get_ccs_header(unsigned char *data
, struct ccs_header_st
*ccs_hdr
);
886 void dtls1_reset_seq_numbers(SSL
*s
, int rw
);
887 long dtls1_default_timeout(void);
890 /* some client-only functions */
891 int ssl3_client_hello(SSL
*s
);
892 int ssl3_get_server_hello(SSL
*s
);
893 int ssl3_get_certificate_request(SSL
*s
);
894 int ssl3_get_server_done(SSL
*s
);
895 int ssl3_send_client_verify(SSL
*s
);
896 int ssl3_send_client_certificate(SSL
*s
);
897 int ssl3_send_client_key_exchange(SSL
*s
);
898 int ssl3_get_key_exchange(SSL
*s
);
899 int ssl3_get_server_certificate(SSL
*s
);
900 int ssl3_check_cert_and_algorithm(SSL
*s
);
902 int dtls1_client_hello(SSL
*s
);
903 int dtls1_send_client_certificate(SSL
*s
);
904 int dtls1_send_client_key_exchange(SSL
*s
);
905 int dtls1_send_client_verify(SSL
*s
);
907 /* some server-only functions */
908 int ssl3_get_client_hello(SSL
*s
);
909 int ssl3_send_server_hello(SSL
*s
);
910 int ssl3_send_hello_request(SSL
*s
);
911 int ssl3_send_server_key_exchange(SSL
*s
);
912 int ssl3_send_certificate_request(SSL
*s
);
913 int ssl3_send_server_done(SSL
*s
);
914 int ssl3_check_client_hello(SSL
*s
);
915 int ssl3_get_client_certificate(SSL
*s
);
916 int ssl3_get_client_key_exchange(SSL
*s
);
917 int ssl3_get_cert_verify(SSL
*s
);
919 int dtls1_send_hello_request(SSL
*s
);
920 int dtls1_send_server_hello(SSL
*s
);
921 int dtls1_send_server_certificate(SSL
*s
);
922 int dtls1_send_server_key_exchange(SSL
*s
);
923 int dtls1_send_certificate_request(SSL
*s
);
924 int dtls1_send_server_done(SSL
*s
);
928 int ssl23_accept(SSL
*s
);
929 int ssl23_connect(SSL
*s
);
930 int ssl23_read_bytes(SSL
*s
, int n
);
931 int ssl23_write_bytes(SSL
*s
);
933 int tls1_new(SSL
*s
);
934 void tls1_free(SSL
*s
);
935 void tls1_clear(SSL
*s
);
936 long tls1_ctrl(SSL
*s
,int cmd
, long larg
, void *parg
);
937 long tls1_callback_ctrl(SSL
*s
,int cmd
, void (*fp
)(void));
939 int dtls1_new(SSL
*s
);
940 int dtls1_accept(SSL
*s
);
941 int dtls1_connect(SSL
*s
);
942 void dtls1_free(SSL
*s
);
943 void dtls1_clear(SSL
*s
);
944 long dtls1_ctrl(SSL
*s
,int cmd
, long larg
, void *parg
);
946 long dtls1_get_message(SSL
*s
, int st1
, int stn
, int mt
, long max
, int *ok
);
947 int dtls1_get_record(SSL
*s
);
948 int do_dtls1_write(SSL
*s
, int type
, const unsigned char *buf
,
949 unsigned int len
, int create_empty_fragement
);
950 int dtls1_dispatch_alert(SSL
*s
);
951 int dtls1_enc(SSL
*s
, int snd
);
953 int ssl_init_wbio_buffer(SSL
*s
, int push
);
954 void ssl_free_wbio_buffer(SSL
*s
);
956 int tls1_change_cipher_state(SSL
*s
, int which
);
957 int tls1_setup_key_block(SSL
*s
);
958 int tls1_enc(SSL
*s
, int snd
);
959 int tls1_final_finish_mac(SSL
*s
, EVP_MD_CTX
*in1_ctx
, EVP_MD_CTX
*in2_ctx
,
960 const char *str
, int slen
, unsigned char *p
);
961 int tls1_cert_verify_mac(SSL
*s
, EVP_MD_CTX
*in
, unsigned char *p
);
962 int tls1_mac(SSL
*ssl
, unsigned char *md
, int snd
);
963 int tls1_generate_master_secret(SSL
*s
, unsigned char *out
,
964 unsigned char *p
, int len
);
965 int tls1_alert_code(int code
);
966 int ssl3_alert_code(int code
);
969 int check_srvr_ecc_cert_and_alg(X509
*x
, SSL_CIPHER
*cs
);
971 SSL_COMP
*ssl3_comp_find(STACK_OF(SSL_COMP
) *sk
, int n
);
973 #ifndef OPENSSL_NO_TLSEXT
974 unsigned char *ssl_add_clienthello_tlsext(SSL
*s
, unsigned char *p
, unsigned char *limit
);
975 unsigned char *ssl_add_serverhello_tlsext(SSL
*s
, unsigned char *p
, unsigned char *limit
);
976 int ssl_parse_clienthello_tlsext(SSL
*s
, unsigned char **data
, unsigned char *d
, int n
, int *al
);
977 int ssl_parse_serverhello_tlsext(SSL
*s
, unsigned char **data
, unsigned char *d
, int n
, int *al
);
978 int ssl_check_tlsext(SSL
*s
, int is_server
);