]>
Commit | Line | Data |
---|---|---|
d02b48c6 | 1 | /* crypto/crypto.h */ |
58964a49 | 2 | /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) |
d02b48c6 RE |
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_CRYPTO_H | |
60 | #define HEADER_CRYPTO_H | |
61 | ||
62 | #ifdef __cplusplus | |
63 | extern "C" { | |
64 | #endif | |
65 | ||
0cd08cce BM |
66 | #include <stdlib.h> |
67 | ||
0b86eb3e BM |
68 | #ifndef NO_FP_API |
69 | #include <stdio.h> | |
70 | #endif | |
71 | ||
ec577822 BM |
72 | #include <openssl/stack.h> |
73 | #include <openssl/opensslv.h> | |
5f326803 | 74 | |
a53955d8 UM |
75 | #ifdef CHARSET_EBCDIC |
76 | #include <openssl/ebcdic.h> | |
77 | #endif | |
78 | ||
5f326803 | 79 | /* Backward compatibility to SSLeay */ |
d02b48c6 RE |
80 | /* This is more to be used to check the correct DLL is being used |
81 | * in the MS world. */ | |
5f326803 | 82 | #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER |
d02b48c6 RE |
83 | #define SSLEAY_VERSION 0 |
84 | /* #define SSLEAY_OPTIONS 1 no longer supported */ | |
85 | #define SSLEAY_CFLAGS 2 | |
86 | #define SSLEAY_BUILT_ON 3 | |
dfeab068 | 87 | #define SSLEAY_PLATFORM 4 |
d02b48c6 RE |
88 | |
89 | /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock | |
90 | * names in cryptlib.c | |
91 | */ | |
92 | ||
93 | #define CRYPTO_LOCK_ERR 1 | |
94 | #define CRYPTO_LOCK_ERR_HASH 2 | |
95 | #define CRYPTO_LOCK_X509 3 | |
96 | #define CRYPTO_LOCK_X509_INFO 4 | |
97 | #define CRYPTO_LOCK_X509_PKEY 5 | |
98 | #define CRYPTO_LOCK_X509_CRL 6 | |
99 | #define CRYPTO_LOCK_X509_REQ 7 | |
100 | #define CRYPTO_LOCK_DSA 8 | |
101 | #define CRYPTO_LOCK_RSA 9 | |
102 | #define CRYPTO_LOCK_EVP_PKEY 10 | |
103 | #define CRYPTO_LOCK_X509_STORE 11 | |
104 | #define CRYPTO_LOCK_SSL_CTX 12 | |
105 | #define CRYPTO_LOCK_SSL_CERT 13 | |
106 | #define CRYPTO_LOCK_SSL_SESSION 14 | |
b56bce4f BM |
107 | #define CRYPTO_LOCK_SSL_SESS_CERT 15 |
108 | #define CRYPTO_LOCK_SSL 16 | |
109 | #define CRYPTO_LOCK_RAND 17 | |
110 | #define CRYPTO_LOCK_MALLOC 18 | |
111 | #define CRYPTO_LOCK_BIO 19 | |
2a82c7cf BM |
112 | #define CRYPTO_LOCK_GETHOSTBYNAME 20 |
113 | #define CRYPTO_LOCK_GETSERVBYNAME 21 | |
114 | #define CRYPTO_LOCK_READDIR 22 | |
115 | #define CRYPTO_LOCK_RSA_BLINDING 23 | |
13066cee | 116 | #define CRYPTO_LOCK_DH 24 |
1f575f1b RL |
117 | #define CRYPTO_LOCK_MALLOC2 25 |
118 | #define CRYPTO_NUM_LOCKS 26 | |
d02b48c6 RE |
119 | |
120 | #define CRYPTO_LOCK 1 | |
121 | #define CRYPTO_UNLOCK 2 | |
122 | #define CRYPTO_READ 4 | |
123 | #define CRYPTO_WRITE 8 | |
124 | ||
dfeab068 | 125 | #ifndef NO_LOCKING |
d02b48c6 RE |
126 | #ifndef CRYPTO_w_lock |
127 | #define CRYPTO_w_lock(type) \ | |
128 | CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__) | |
129 | #define CRYPTO_w_unlock(type) \ | |
130 | CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__) | |
131 | #define CRYPTO_r_lock(type) \ | |
132 | CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__) | |
133 | #define CRYPTO_r_unlock(type) \ | |
134 | CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__) | |
135 | #define CRYPTO_add(addr,amount,type) \ | |
136 | CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__) | |
dfeab068 RE |
137 | #endif |
138 | #else | |
139 | #define CRYPTO_w_lock(a) | |
140 | #define CRYPTO_w_unlock(a) | |
141 | #define CRYPTO_r_lock(a) | |
142 | #define CRYPTO_r_unlock(a) | |
143 | #define CRYPTO_add(a,b,c) ((*(a))+=(b)) | |
d02b48c6 RE |
144 | #endif |
145 | ||
146 | /* The following can be used to detect memory leaks in the SSLeay library. | |
147 | * It used, it turns on malloc checking */ | |
148 | ||
dfeab068 RE |
149 | #define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */ |
150 | #define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */ | |
151 | #define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */ | |
152 | #define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */ | |
d02b48c6 | 153 | |
d8df48a9 RL |
154 | /* The following are bit values to turn on or off options connected to the |
155 | * malloc checking functionality */ | |
156 | ||
157 | /* Adds time to the memory checking information */ | |
158 | #define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */ | |
159 | /* Adds thread number to the memory checking information */ | |
160 | #define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */ | |
161 | ||
d02b48c6 | 162 | |
58964a49 RE |
163 | /* predec of the BIO type */ |
164 | typedef struct bio_st BIO_dummy; | |
165 | ||
0cd08cce | 166 | |
58964a49 RE |
167 | typedef struct crypto_ex_data_st |
168 | { | |
169 | STACK *sk; | |
170 | int dummy; /* gcc is screwing up this data structure :-( */ | |
171 | } CRYPTO_EX_DATA; | |
172 | ||
173 | /* This stuff is basically class callback functions | |
174 | * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */ | |
175 | typedef struct crypto_ex_data_func_st | |
176 | { | |
177 | long argl; /* Arbitary long */ | |
178 | char *argp; /* Arbitary char * */ | |
179 | /* Called when a new object is created */ | |
180 | int (*new_func)(/*char *obj, | |
181 | char *item,int index,long argl,char *argp*/); | |
182 | /* Called when this object is free()ed */ | |
183 | void (*free_func)(/*char *obj, | |
184 | char *item,int index,long argl,char *argp*/); | |
185 | ||
186 | /* Called when we need to dup this one */ | |
187 | int (*dup_func)(/*char *obj_to,char *obj_from, | |
188 | char **new,int index,long argl,char *argp*/); | |
189 | } CRYPTO_EX_DATA_FUNCS; | |
190 | ||
191 | /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA | |
192 | * entry. | |
193 | */ | |
194 | ||
195 | #define CRYPTO_EX_INDEX_BIO 0 | |
196 | #define CRYPTO_EX_INDEX_SSL 1 | |
197 | #define CRYPTO_EX_INDEX_SSL_CTX 2 | |
198 | #define CRYPTO_EX_INDEX_SSL_SESSION 3 | |
199 | #define CRYPTO_EX_INDEX_X509_STORE 4 | |
200 | #define CRYPTO_EX_INDEX_X509_STORE_CTX 5 | |
d02b48c6 | 201 | |
d8df48a9 | 202 | |
3d14b9d0 DSH |
203 | /* This is the default callbacks, but we can have others as well: |
204 | * this is needed in Win32 where the application malloc and the | |
205 | * library malloc may not be the same. | |
206 | */ | |
d02b48c6 | 207 | #define CRYPTO_malloc_init() CRYPTO_set_mem_functions(\ |
0cd08cce | 208 | malloc, realloc, free) |
0cd08cce BM |
209 | |
210 | #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD | |
211 | # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */ | |
212 | # define CRYPTO_MDEBUG | |
213 | # endif | |
214 | #endif | |
d02b48c6 | 215 | |
0cd08cce | 216 | /* Set standard debugging functions (not done by default |
75acc288 | 217 | * unless CRYPTO_MDEBUG is defined) */ |
9ac42ed8 RL |
218 | #define CRYPTO_malloc_debug_init() do {\ |
219 | CRYPTO_set_mem_debug_functions(\ | |
220 | (void (*)())CRYPTO_dbg_malloc,\ | |
221 | (void (*)())CRYPTO_dbg_realloc,\ | |
222 | (void (*)())CRYPTO_dbg_free,\ | |
223 | (void (*)())CRYPTO_dbg_set_options,\ | |
0cd08cce | 224 | (long (*)())CRYPTO_dbg_get_options);\ |
f3a2a044 | 225 | } while(0) |
9ac42ed8 | 226 | |
0cd08cce BM |
227 | int CRYPTO_mem_ctrl(int mode); |
228 | int CRYPTO_is_mem_check_on(void); | |
458cddc1 | 229 | |
0cd08cce | 230 | /* for applications */ |
dfeab068 RE |
231 | #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON) |
232 | #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF) | |
0cd08cce BM |
233 | |
234 | /* for library-internal use */ | |
dfeab068 RE |
235 | #define MemCheck_on() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE) |
236 | #define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE) | |
0cd08cce | 237 | #define is_MemCheck_on() CRYPTO_is_mem_check_on() |
9ac42ed8 RL |
238 | |
239 | #define Malloc(num) CRYPTO_malloc((int)num,__FILE__,__LINE__) | |
d02b48c6 | 240 | #define Realloc(addr,num) \ |
9ac42ed8 | 241 | CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__) |
d02b48c6 | 242 | #define Remalloc(addr,num) \ |
9ac42ed8 | 243 | CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__) |
d02b48c6 | 244 | #define FreeFunc CRYPTO_free |
5a88a6ea | 245 | #define Free(addr) CRYPTO_free(addr) |
9ac42ed8 RL |
246 | |
247 | #define Malloc_locked(num) CRYPTO_malloc_locked((int)num,__FILE__,__LINE__) | |
5a88a6ea | 248 | #define Free_locked(addr) CRYPTO_free_locked(addr) |
9ac42ed8 | 249 | |
d02b48c6 | 250 | |
58964a49 | 251 | /* Case insensiteve linking causes problems.... */ |
7d7d2cbc | 252 | #if defined(WIN16) || defined(VMS) |
58964a49 RE |
253 | #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings |
254 | #endif | |
255 | ||
d02b48c6 | 256 | |
e778802f | 257 | const char *SSLeay_version(int type); |
d02b48c6 RE |
258 | unsigned long SSLeay(void); |
259 | ||
58964a49 RE |
260 | int CRYPTO_get_ex_new_index(int idx,STACK **sk,long argl,char *argp, |
261 | int (*new_func)(),int (*dup_func)(),void (*free_func)()); | |
262 | int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad,int idx,char *val); | |
263 | char *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx); | |
264 | int CRYPTO_dup_ex_data(STACK *meth,CRYPTO_EX_DATA *from,CRYPTO_EX_DATA *to); | |
265 | void CRYPTO_free_ex_data(STACK *meth,char *obj,CRYPTO_EX_DATA *ad); | |
266 | void CRYPTO_new_ex_data(STACK *meth, char *obj, CRYPTO_EX_DATA *ad); | |
267 | ||
58964a49 | 268 | int CRYPTO_get_new_lockid(char *name); |
a111306b BM |
269 | |
270 | int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */ | |
e778802f BL |
271 | void CRYPTO_lock(int mode, int type,const char *file,int line); |
272 | void CRYPTO_set_locking_callback(void (*func)(int mode,int type, | |
273 | const char *file,int line)); | |
274 | void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file, | |
d02b48c6 | 275 | int line); |
e778802f BL |
276 | void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type, |
277 | const char *file, int line)); | |
278 | int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type, | |
279 | const char *file,int line); | |
d02b48c6 RE |
280 | void CRYPTO_set_id_callback(unsigned long (*func)(void)); |
281 | unsigned long (*CRYPTO_get_id_callback(void))(void); | |
282 | unsigned long CRYPTO_thread_id(void); | |
e778802f BL |
283 | const char *CRYPTO_get_lock_name(int type); |
284 | int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file, | |
285 | int line); | |
d02b48c6 | 286 | |
0cd08cce BM |
287 | /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions -- |
288 | * call the latter last if you need different functions */ | |
289 | int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *)); | |
290 | int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *)); | |
291 | int CRYPTO_set_mem_debug_functions(void (*m)(),void (*r)(),void (*f)(),void (*so)(),long (*go)()); | |
292 | void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *)); | |
293 | void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *)); | |
294 | void CRYPTO_get_mem_debug_functions(void (**m)(),void (**r)(),void (**f)(),void (**so)(),long (**go)()); | |
d02b48c6 | 295 | |
9ac42ed8 | 296 | void *CRYPTO_malloc_locked(int num, char *file, int line); |
5a88a6ea | 297 | void CRYPTO_free_locked(void *); |
9ac42ed8 | 298 | void *CRYPTO_malloc(int num, char *file, int line); |
5a88a6ea | 299 | void CRYPTO_free(void *); |
9ac42ed8 RL |
300 | void *CRYPTO_realloc(void *addr,int num, char *file, int line); |
301 | void *CRYPTO_remalloc(void *addr,int num, char *file, int line); | |
5a88a6ea | 302 | |
0cd08cce BM |
303 | void CRYPTO_set_mem_debug_options(long bits); |
304 | long CRYPTO_get_mem_debug_options(); | |
305 | ||
2b6313d0 BM |
306 | #define CRYPTO_push_info(info) \ |
307 | CRYPTO_push_info_(info, __FILE__, __LINE__); | |
308 | int CRYPTO_push_info_(const char *info, const char *file, int line); | |
309 | int CRYPTO_pop_info(void); | |
9ac42ed8 RL |
310 | int CRYPTO_remove_all_info(void); |
311 | ||
312 | /* The last argument has the following significance: | |
313 | * | |
314 | * 0: called before the actual memory allocation has taken place | |
315 | * 1: called after the actual memory allocation has taken place | |
316 | */ | |
317 | void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p); | |
318 | void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p); | |
d8df48a9 | 319 | void CRYPTO_dbg_free(void *addr,int before_p); |
9ac42ed8 RL |
320 | |
321 | /* Tell the debugging code about options. By default, the following values | |
322 | * apply: | |
323 | * | |
324 | * 0: Clear all options. | |
325 | * 1: Set the "Show Time" option. | |
326 | * 2: Set the "Show Thread Number" option. | |
327 | * 3: 1 + 2 | |
328 | */ | |
0cd08cce BM |
329 | void CRYPTO_dbg_set_options(long bits); |
330 | long CRYPTO_dbg_get_options(); | |
1f575f1b | 331 | |
58964a49 | 332 | #ifndef NO_FP_API |
d02b48c6 RE |
333 | void CRYPTO_mem_leaks_fp(FILE *); |
334 | #endif | |
58964a49 | 335 | void CRYPTO_mem_leaks(struct bio_st *bio); |
d02b48c6 RE |
336 | /* unsigned long order, char *file, int line, int num_bytes, char *addr */ |
337 | void CRYPTO_mem_leaks_cb(void (*cb)()); | |
338 | ||
58964a49 RE |
339 | void ERR_load_CRYPTO_strings(void ); |
340 | ||
58964a49 | 341 | /* BEGIN ERROR CODES */ |
6d311938 DSH |
342 | /* The following lines are auto generated by the script mkerr.pl. Any changes |
343 | * made after this point may be overwritten when the script is next run. | |
344 | */ | |
345 | ||
58964a49 RE |
346 | /* Error codes for the CRYPTO functions. */ |
347 | ||
348 | /* Function codes. */ | |
349 | #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100 | |
350 | #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101 | |
351 | #define CRYPTO_F_CRYPTO_SET_EX_DATA 102 | |
352 | ||
353 | /* Reason codes. */ | |
6d311938 | 354 | |
d02b48c6 RE |
355 | #ifdef __cplusplus |
356 | } | |
357 | #endif | |
d02b48c6 | 358 | #endif |
58964a49 | 359 |