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_CRYPTO_H
60 #define HEADER_CRYPTO_H
64 #ifndef OPENSSL_NO_FP_API
68 #include <openssl/stack.h>
69 #include <openssl/safestack.h>
70 #include <openssl/opensslv.h>
73 #include <openssl/ebcdic.h>
76 /* Resolve problems on some operating systems with symbol names that clash
78 #include <openssl/symhacks.h>
84 /* Backward compatibility to SSLeay */
85 /* This is more to be used to check the correct DLL is being used
87 #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
88 #define SSLEAY_VERSION 0
89 /* #define SSLEAY_OPTIONS 1 no longer supported */
90 #define SSLEAY_CFLAGS 2
91 #define SSLEAY_BUILT_ON 3
92 #define SSLEAY_PLATFORM 4
95 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
99 #define CRYPTO_LOCK_ERR 1
100 #define CRYPTO_LOCK_ERR_HASH 2
101 #define CRYPTO_LOCK_X509 3
102 #define CRYPTO_LOCK_X509_INFO 4
103 #define CRYPTO_LOCK_X509_PKEY 5
104 #define CRYPTO_LOCK_X509_CRL 6
105 #define CRYPTO_LOCK_X509_REQ 7
106 #define CRYPTO_LOCK_DSA 8
107 #define CRYPTO_LOCK_RSA 9
108 #define CRYPTO_LOCK_EVP_PKEY 10
109 #define CRYPTO_LOCK_X509_STORE 11
110 #define CRYPTO_LOCK_SSL_CTX 12
111 #define CRYPTO_LOCK_SSL_CERT 13
112 #define CRYPTO_LOCK_SSL_SESSION 14
113 #define CRYPTO_LOCK_SSL_SESS_CERT 15
114 #define CRYPTO_LOCK_SSL 16
115 #define CRYPTO_LOCK_RAND 17
116 #define CRYPTO_LOCK_MALLOC 18
117 #define CRYPTO_LOCK_BIO 19
118 #define CRYPTO_LOCK_GETHOSTBYNAME 20
119 #define CRYPTO_LOCK_GETSERVBYNAME 21
120 #define CRYPTO_LOCK_READDIR 22
121 #define CRYPTO_LOCK_RSA_BLINDING 23
122 #define CRYPTO_LOCK_DH 24
123 #define CRYPTO_LOCK_MALLOC2 25
124 #define CRYPTO_LOCK_DSO 26
125 #define CRYPTO_LOCK_DYNLOCK 27
126 #define CRYPTO_LOCK_ENGINE 28
127 #define CRYPTO_NUM_LOCKS 29
129 #define CRYPTO_LOCK 1
130 #define CRYPTO_UNLOCK 2
131 #define CRYPTO_READ 4
132 #define CRYPTO_WRITE 8
134 #ifndef OPENSSL_NO_LOCKING
135 #ifndef CRYPTO_w_lock
136 #define CRYPTO_w_lock(type) \
137 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
138 #define CRYPTO_w_unlock(type) \
139 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
140 #define CRYPTO_r_lock(type) \
141 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
142 #define CRYPTO_r_unlock(type) \
143 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
144 #define CRYPTO_add(addr,amount,type) \
145 CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
148 #define CRYPTO_w_lock(a)
149 #define CRYPTO_w_unlock(a)
150 #define CRYPTO_r_lock(a)
151 #define CRYPTO_r_unlock(a)
152 #define CRYPTO_add(a,b,c) ((*(a))+=(b))
155 /* Some applications as well as some parts of OpenSSL need to allocate
156 and deallocate locks in a dynamic fashion. The following typedef
157 makes this possible in a type-safe manner. */
158 /* struct CRYPTO_dynlock_value has to be defined by the application. */
162 struct CRYPTO_dynlock_value *data;
166 /* The following can be used to detect memory leaks in the SSLeay library.
167 * It used, it turns on malloc checking */
169 #define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */
170 #define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */
171 #define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */
172 #define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */
174 /* The following are bit values to turn on or off options connected to the
175 * malloc checking functionality */
177 /* Adds time to the memory checking information */
178 #define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */
179 /* Adds thread number to the memory checking information */
180 #define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */
182 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
185 /* predec of the BIO type */
186 typedef struct bio_st BIO_dummy;
188 typedef struct crypto_ex_data_st
191 int dummy; /* gcc is screwing up this data structure :-( */
194 /* Called when a new object is created */
195 typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
196 int idx, long argl, void *argp);
197 /* Called when an object is free()ed */
198 typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
199 int idx, long argl, void *argp);
200 /* Called when we need to dup an object */
201 typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
202 int idx, long argl, void *argp);
204 /* This stuff is basically class callback functions
205 * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
207 typedef struct crypto_ex_data_func_st
209 long argl; /* Arbitary long */
210 void *argp; /* Arbitary void * */
211 CRYPTO_EX_new *new_func;
212 CRYPTO_EX_free *free_func;
213 CRYPTO_EX_dup *dup_func;
214 } CRYPTO_EX_DATA_FUNCS;
216 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
218 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
222 #define CRYPTO_EX_INDEX_BIO 0
223 #define CRYPTO_EX_INDEX_SSL 1
224 #define CRYPTO_EX_INDEX_SSL_CTX 2
225 #define CRYPTO_EX_INDEX_SSL_SESSION 3
226 #define CRYPTO_EX_INDEX_X509_STORE 4
227 #define CRYPTO_EX_INDEX_X509_STORE_CTX 5
230 /* This is the default callbacks, but we can have others as well:
231 * this is needed in Win32 where the application malloc and the
232 * library malloc may not be the same.
234 #define CRYPTO_malloc_init() CRYPTO_set_mem_functions(\
235 malloc, realloc, free)
237 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
238 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
239 # define CRYPTO_MDEBUG
243 /* Set standard debugging functions (not done by default
244 * unless CRYPTO_MDEBUG is defined) */
245 #define CRYPTO_malloc_debug_init() do {\
246 CRYPTO_set_mem_debug_functions(\
250 CRYPTO_dbg_set_options,\
251 CRYPTO_dbg_get_options);\
254 int CRYPTO_mem_ctrl(int mode);
255 int CRYPTO_is_mem_check_on(void);
257 /* for applications */
258 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
259 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
261 /* for library-internal use */
262 #define MemCheck_on() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
263 #define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
264 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
266 #define OPENSSL_malloc(num) CRYPTO_malloc((int)num,__FILE__,__LINE__)
267 #define OPENSSL_realloc(addr,num) \
268 CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
269 #define OPENSSL_remalloc(addr,num) \
270 CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
271 #define OPENSSL_freeFunc CRYPTO_free
272 #define OPENSSL_free(addr) CRYPTO_free(addr)
274 #define OPENSSL_malloc_locked(num) \
275 CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
276 #define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
279 const char *SSLeay_version(int type);
280 unsigned long SSLeay(void);
282 int OPENSSL_issetugid(void);
284 int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) **skp, long argl, void *argp,
285 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
286 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
287 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
288 int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, CRYPTO_EX_DATA *to,
289 CRYPTO_EX_DATA *from);
290 void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
291 void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
293 int CRYPTO_get_new_lockid(char *name);
295 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
296 void CRYPTO_lock(int mode, int type,const char *file,int line);
297 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
298 const char *file,int line));
299 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
301 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
302 const char *file, int line));
303 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
304 const char *file,int line);
305 void CRYPTO_set_id_callback(unsigned long (*func)(void));
306 unsigned long (*CRYPTO_get_id_callback(void))(void);
307 unsigned long CRYPTO_thread_id(void);
308 const char *CRYPTO_get_lock_name(int type);
309 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
312 int CRYPTO_get_new_dynlockid(void);
313 void CRYPTO_destroy_dynlockid(int i);
314 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
315 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
316 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
317 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
318 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
319 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
320 void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);
322 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
323 * call the latter last if you need different functions */
324 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
325 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
326 int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
327 void *(*r)(void *,size_t,const char *,int),
329 int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
330 void (*free_func)(void *));
331 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
332 void (*r)(void *,void *,int,const char *,int,int),
333 void (*f)(void *,int),
336 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
337 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
338 void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
339 void *(**r)(void *, size_t,const char *,int),
341 void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
343 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
344 void (**r)(void *,void *,int,const char *,int,int),
345 void (**f)(void *,int),
349 void *CRYPTO_malloc_locked(int num, const char *file, int line);
350 void CRYPTO_free_locked(void *);
351 void *CRYPTO_malloc(int num, const char *file, int line);
352 void CRYPTO_free(void *);
353 void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
354 void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
356 void CRYPTO_set_mem_debug_options(long bits);
357 long CRYPTO_get_mem_debug_options(void);
359 #define CRYPTO_push_info(info) \
360 CRYPTO_push_info_(info, __FILE__, __LINE__);
361 int CRYPTO_push_info_(const char *info, const char *file, int line);
362 int CRYPTO_pop_info(void);
363 int CRYPTO_remove_all_info(void);
365 /* The last argument has the following significance:
367 * 0: called before the actual memory allocation has taken place
368 * 1: called after the actual memory allocation has taken place
370 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
371 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
372 void CRYPTO_dbg_free(void *addr,int before_p);
374 /* Tell the debugging code about options. By default, the following values
377 * 0: Clear all options.
378 * 1: Set the "Show Time" option.
379 * 2: Set the "Show Thread Number" option.
382 void CRYPTO_dbg_set_options(long bits);
383 long CRYPTO_dbg_get_options(void);
385 #ifndef OPENSSL_NO_FP_API
386 void CRYPTO_mem_leaks_fp(FILE *);
388 void CRYPTO_mem_leaks(struct bio_st *bio);
389 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
390 typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
391 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
393 void ERR_load_CRYPTO_strings(void);
395 /* BEGIN ERROR CODES */
396 /* The following lines are auto generated by the script mkerr.pl. Any changes
397 * made after this point may be overwritten when the script is next run.
400 /* Error codes for the CRYPTO functions. */
402 /* Function codes. */
403 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100
404 #define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID 103
405 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101
406 #define CRYPTO_F_CRYPTO_SET_EX_DATA 102
409 #define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK 100