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.]
58 /* ====================================================================
59 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
60 * ECDH support in OpenSSL originally developed by
61 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
64 #ifndef HEADER_CRYPTO_H
65 #define HEADER_CRYPTO_H
69 #ifndef OPENSSL_NO_FP_API
73 #include <openssl/stack.h>
74 #include <openssl/safestack.h>
75 #include <openssl/opensslv.h>
78 #include <openssl/ebcdic.h>
81 /* Resolve problems on some operating systems with symbol names that clash
83 #include <openssl/symhacks.h>
89 /* Backward compatibility to SSLeay */
90 /* This is more to be used to check the correct DLL is being used
92 #define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
93 #define SSLEAY_VERSION 0
94 /* #define SSLEAY_OPTIONS 1 no longer supported */
95 #define SSLEAY_CFLAGS 2
96 #define SSLEAY_BUILT_ON 3
97 #define SSLEAY_PLATFORM 4
100 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
101 * names in cryptlib.c
104 #define CRYPTO_LOCK_ERR 1
105 #define CRYPTO_LOCK_EX_DATA 2
106 #define CRYPTO_LOCK_X509 3
107 #define CRYPTO_LOCK_X509_INFO 4
108 #define CRYPTO_LOCK_X509_PKEY 5
109 #define CRYPTO_LOCK_X509_CRL 6
110 #define CRYPTO_LOCK_X509_REQ 7
111 #define CRYPTO_LOCK_DSA 8
112 #define CRYPTO_LOCK_RSA 9
113 #define CRYPTO_LOCK_EVP_PKEY 10
114 #define CRYPTO_LOCK_X509_STORE 11
115 #define CRYPTO_LOCK_SSL_CTX 12
116 #define CRYPTO_LOCK_SSL_CERT 13
117 #define CRYPTO_LOCK_SSL_SESSION 14
118 #define CRYPTO_LOCK_SSL_SESS_CERT 15
119 #define CRYPTO_LOCK_SSL 16
120 #define CRYPTO_LOCK_SSL_METHOD 17
121 #define CRYPTO_LOCK_RAND 18
122 #define CRYPTO_LOCK_RAND2 19
123 #define CRYPTO_LOCK_MALLOC 20
124 #define CRYPTO_LOCK_BIO 21
125 #define CRYPTO_LOCK_GETHOSTBYNAME 22
126 #define CRYPTO_LOCK_GETSERVBYNAME 23
127 #define CRYPTO_LOCK_READDIR 24
128 #define CRYPTO_LOCK_RSA_BLINDING 25
129 #define CRYPTO_LOCK_DH 26
130 #define CRYPTO_LOCK_MALLOC2 27
131 #define CRYPTO_LOCK_DSO 28
132 #define CRYPTO_LOCK_DYNLOCK 29
133 #define CRYPTO_LOCK_ENGINE 30
134 #define CRYPTO_LOCK_UI 31
135 #define CRYPTO_LOCK_ECDSA 32
136 #define CRYPTO_LOCK_EC 33
137 #define CRYPTO_LOCK_ECDH 34
138 #define CRYPTO_NUM_LOCKS 35
140 #define CRYPTO_LOCK 1
141 #define CRYPTO_UNLOCK 2
142 #define CRYPTO_READ 4
143 #define CRYPTO_WRITE 8
145 #ifndef OPENSSL_NO_LOCKING
146 #ifndef CRYPTO_w_lock
147 #define CRYPTO_w_lock(type) \
148 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
149 #define CRYPTO_w_unlock(type) \
150 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
151 #define CRYPTO_r_lock(type) \
152 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
153 #define CRYPTO_r_unlock(type) \
154 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
155 #define CRYPTO_add(addr,amount,type) \
156 CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
159 #define CRYPTO_w_lock(a)
160 #define CRYPTO_w_unlock(a)
161 #define CRYPTO_r_lock(a)
162 #define CRYPTO_r_unlock(a)
163 #define CRYPTO_add(a,b,c) ((*(a))+=(b))
166 /* Some applications as well as some parts of OpenSSL need to allocate
167 and deallocate locks in a dynamic fashion. The following typedef
168 makes this possible in a type-safe manner. */
169 /* struct CRYPTO_dynlock_value has to be defined by the application. */
173 struct CRYPTO_dynlock_value *data;
177 /* The following can be used to detect memory leaks in the SSLeay library.
178 * It used, it turns on malloc checking */
180 #define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */
181 #define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */
182 #define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */
183 #define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */
185 /* The following are bit values to turn on or off options connected to the
186 * malloc checking functionality */
188 /* Adds time to the memory checking information */
189 #define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */
190 /* Adds thread number to the memory checking information */
191 #define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */
193 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
196 /* predec of the BIO type */
197 typedef struct bio_st BIO_dummy;
199 typedef struct crypto_ex_data_st
202 int dummy; /* gcc is screwing up this data structure :-( */
205 /* Called when a new object is created */
206 typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
207 int idx, long argl, void *argp);
208 /* Called when an object is free()ed */
209 typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
210 int idx, long argl, void *argp);
211 /* Called when we need to dup an object */
212 typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
213 int idx, long argl, void *argp);
215 /* This stuff is basically class callback functions
216 * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
218 typedef struct crypto_ex_data_func_st
220 long argl; /* Arbitary long */
221 void *argp; /* Arbitary void * */
222 CRYPTO_EX_new *new_func;
223 CRYPTO_EX_free *free_func;
224 CRYPTO_EX_dup *dup_func;
225 } CRYPTO_EX_DATA_FUNCS;
227 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
229 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
233 #define CRYPTO_EX_INDEX_BIO 0
234 #define CRYPTO_EX_INDEX_SSL 1
235 #define CRYPTO_EX_INDEX_SSL_CTX 2
236 #define CRYPTO_EX_INDEX_SSL_SESSION 3
237 #define CRYPTO_EX_INDEX_X509_STORE 4
238 #define CRYPTO_EX_INDEX_X509_STORE_CTX 5
239 #define CRYPTO_EX_INDEX_RSA 6
240 #define CRYPTO_EX_INDEX_DSA 7
241 #define CRYPTO_EX_INDEX_DH 8
242 #define CRYPTO_EX_INDEX_ENGINE 9
243 #define CRYPTO_EX_INDEX_X509 10
244 #define CRYPTO_EX_INDEX_UI 11
245 #define CRYPTO_EX_INDEX_ECDSA 12
246 #define CRYPTO_EX_INDEX_ECDH 13
248 /* Dynamically assigned indexes start from this value (don't use directly, use
249 * via CRYPTO_ex_data_new_class). */
250 #define CRYPTO_EX_INDEX_USER 100
253 /* This is the default callbacks, but we can have others as well:
254 * this is needed in Win32 where the application malloc and the
255 * library malloc may not be the same.
257 #define CRYPTO_malloc_init() CRYPTO_set_mem_functions(\
258 malloc, realloc, free)
260 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
261 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
262 # define CRYPTO_MDEBUG
266 /* Set standard debugging functions (not done by default
267 * unless CRYPTO_MDEBUG is defined) */
268 #define CRYPTO_malloc_debug_init() do {\
269 CRYPTO_set_mem_debug_functions(\
273 CRYPTO_dbg_set_options,\
274 CRYPTO_dbg_get_options);\
277 int CRYPTO_mem_ctrl(int mode);
278 int CRYPTO_is_mem_check_on(void);
280 /* for applications */
281 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
282 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
284 /* for library-internal use */
285 #define MemCheck_on() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
286 #define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
287 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
289 #define OPENSSL_malloc(num) CRYPTO_malloc((int)num,__FILE__,__LINE__)
290 #define OPENSSL_realloc(addr,num) \
291 CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
292 #define OPENSSL_remalloc(addr,num) \
293 CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
294 #define OPENSSL_freeFunc CRYPTO_free
295 #define OPENSSL_free(addr) CRYPTO_free(addr)
297 #define OPENSSL_malloc_locked(num) \
298 CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
299 #define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
302 const char *SSLeay_version(int type);
303 unsigned long SSLeay(void);
305 int OPENSSL_issetugid(void);
307 /* An opaque type representing an implementation of "ex_data" support */
308 typedef struct st_CRYPTO_EX_DATA_IMPL CRYPTO_EX_DATA_IMPL;
309 /* Return an opaque pointer to the current "ex_data" implementation */
310 const CRYPTO_EX_DATA_IMPL *CRYPTO_get_ex_data_implementation(void);
311 /* Sets the "ex_data" implementation to be used (if it's not too late) */
312 int CRYPTO_set_ex_data_implementation(const CRYPTO_EX_DATA_IMPL *i);
313 /* Get a new "ex_data" class, and return the corresponding "class_index" */
314 int CRYPTO_ex_data_new_class(void);
315 /* Within a given class, get/register a new index */
316 int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
317 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
318 CRYPTO_EX_free *free_func);
319 /* Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a given
320 * class (invokes whatever per-class callbacks are applicable) */
321 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
322 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
323 CRYPTO_EX_DATA *from);
324 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
325 /* Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular index
326 * (relative to the class type involved) */
327 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
328 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
329 /* This function cleans up all "ex_data" state. It mustn't be called under
330 * potential race-conditions. */
331 void CRYPTO_cleanup_all_ex_data(void);
333 int CRYPTO_get_new_lockid(char *name);
335 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
336 void CRYPTO_lock(int mode, int type,const char *file,int line);
337 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
338 const char *file,int line));
339 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
341 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
342 const char *file, int line));
343 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
344 const char *file,int line);
345 void CRYPTO_set_id_callback(unsigned long (*func)(void));
346 unsigned long (*CRYPTO_get_id_callback(void))(void);
347 unsigned long CRYPTO_thread_id(void);
348 const char *CRYPTO_get_lock_name(int type);
349 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
352 int CRYPTO_get_new_dynlockid(void);
353 void CRYPTO_destroy_dynlockid(int i);
354 struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
355 void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
356 void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
357 void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
358 struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
359 void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
360 void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);
362 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
363 * call the latter last if you need different functions */
364 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
365 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
366 int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
367 void *(*r)(void *,size_t,const char *,int),
369 int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
370 void (*free_func)(void *));
371 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
372 void (*r)(void *,void *,int,const char *,int,int),
373 void (*f)(void *,int),
376 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
377 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
378 void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
379 void *(**r)(void *, size_t,const char *,int),
381 void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
383 void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
384 void (**r)(void *,void *,int,const char *,int,int),
385 void (**f)(void *,int),
389 void *CRYPTO_malloc_locked(int num, const char *file, int line);
390 void CRYPTO_free_locked(void *);
391 void *CRYPTO_malloc(int num, const char *file, int line);
392 void CRYPTO_free(void *);
393 void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
394 void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
396 void CRYPTO_set_mem_debug_options(long bits);
397 long CRYPTO_get_mem_debug_options(void);
399 #define CRYPTO_push_info(info) \
400 CRYPTO_push_info_(info, __FILE__, __LINE__);
401 int CRYPTO_push_info_(const char *info, const char *file, int line);
402 int CRYPTO_pop_info(void);
403 int CRYPTO_remove_all_info(void);
406 /* Default debugging functions (enabled by CRYPTO_malloc_debug_init() macro;
407 * used as default in CRYPTO_MDEBUG compilations): */
408 /* The last argument has the following significance:
410 * 0: called before the actual memory allocation has taken place
411 * 1: called after the actual memory allocation has taken place
413 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
414 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
415 void CRYPTO_dbg_free(void *addr,int before_p);
416 /* Tell the debugging code about options. By default, the following values
419 * 0: Clear all options.
420 * V_CRYPTO_MDEBUG_TIME (1): Set the "Show Time" option.
421 * V_CRYPTO_MDEBUG_THREAD (2): Set the "Show Thread Number" option.
422 * V_CRYPTO_MDEBUG_ALL (3): 1 + 2
424 void CRYPTO_dbg_set_options(long bits);
425 long CRYPTO_dbg_get_options(void);
428 #ifndef OPENSSL_NO_FP_API
429 void CRYPTO_mem_leaks_fp(FILE *);
431 void CRYPTO_mem_leaks(struct bio_st *bio);
432 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
433 typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
434 void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
437 /* BEGIN ERROR CODES */
438 /* The following lines are auto generated by the script mkerr.pl. Any changes
439 * made after this point may be overwritten when the script is next run.
441 void ERR_load_CRYPTO_strings(void);
443 /* Error codes for the CRYPTO functions. */
445 /* Function codes. */
446 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100
447 #define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID 103
448 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101
449 #define CRYPTO_F_CRYPTO_SET_EX_DATA 102
450 #define CRYPTO_F_DEF_ADD_INDEX 104
451 #define CRYPTO_F_DEF_GET_CLASS 105
452 #define CRYPTO_F_INT_DUP_EX_DATA 106
453 #define CRYPTO_F_INT_FREE_EX_DATA 107
454 #define CRYPTO_F_INT_NEW_EX_DATA 108
457 #define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK 100