]> git.ipfire.org Git - thirdparty/openssl.git/blame - crypto/crypto.h
Only OPENSSL_free() non-NULL pointers.
[thirdparty/openssl.git] / crypto / crypto.h
CommitLineData
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
f3e9b338
UM
62#include <stdlib.h>
63
cf1b7d96 64#ifndef OPENSSL_NO_FP_API
0b86eb3e
BM
65#include <stdio.h>
66#endif
67
ec577822 68#include <openssl/stack.h>
dd9d233e 69#include <openssl/safestack.h>
ec577822 70#include <openssl/opensslv.h>
5f326803 71
a53955d8
UM
72#ifdef CHARSET_EBCDIC
73#include <openssl/ebcdic.h>
74#endif
75
9fc25706
RL
76/* Resolve problems on some operating systems with symbol names that clash
77 one way or another */
78#include <openssl/symhacks.h>
c29b6d56 79
65962686
RL
80#ifdef __cplusplus
81extern "C" {
82#endif
83
5f326803 84/* Backward compatibility to SSLeay */
d02b48c6
RE
85/* This is more to be used to check the correct DLL is being used
86 * in the MS world. */
5f326803 87#define SSLEAY_VERSION_NUMBER OPENSSL_VERSION_NUMBER
d02b48c6
RE
88#define SSLEAY_VERSION 0
89/* #define SSLEAY_OPTIONS 1 no longer supported */
90#define SSLEAY_CFLAGS 2
91#define SSLEAY_BUILT_ON 3
dfeab068 92#define SSLEAY_PLATFORM 4
673b3fde 93#define SSLEAY_DIR 5
d02b48c6
RE
94
95/* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
96 * names in cryptlib.c
97 */
98
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
b56bce4f
BM
113#define CRYPTO_LOCK_SSL_SESS_CERT 15
114#define CRYPTO_LOCK_SSL 16
115#define CRYPTO_LOCK_RAND 17
daba492c
BM
116#define CRYPTO_LOCK_RAND2 18
117#define CRYPTO_LOCK_MALLOC 19
118#define CRYPTO_LOCK_BIO 20
119#define CRYPTO_LOCK_GETHOSTBYNAME 21
120#define CRYPTO_LOCK_GETSERVBYNAME 22
121#define CRYPTO_LOCK_READDIR 23
122#define CRYPTO_LOCK_RSA_BLINDING 24
123#define CRYPTO_LOCK_DH 25
124#define CRYPTO_LOCK_MALLOC2 26
125#define CRYPTO_LOCK_DSO 27
126#define CRYPTO_LOCK_DYNLOCK 28
127#define CRYPTO_LOCK_ENGINE 29
128#define CRYPTO_LOCK_UI 30
129#define CRYPTO_NUM_LOCKS 31
d02b48c6
RE
130
131#define CRYPTO_LOCK 1
132#define CRYPTO_UNLOCK 2
133#define CRYPTO_READ 4
134#define CRYPTO_WRITE 8
135
cf1b7d96 136#ifndef OPENSSL_NO_LOCKING
d02b48c6
RE
137#ifndef CRYPTO_w_lock
138#define CRYPTO_w_lock(type) \
139 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
140#define CRYPTO_w_unlock(type) \
141 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
142#define CRYPTO_r_lock(type) \
143 CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
144#define CRYPTO_r_unlock(type) \
145 CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
146#define CRYPTO_add(addr,amount,type) \
147 CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
dfeab068
RE
148#endif
149#else
150#define CRYPTO_w_lock(a)
151#define CRYPTO_w_unlock(a)
152#define CRYPTO_r_lock(a)
153#define CRYPTO_r_unlock(a)
154#define CRYPTO_add(a,b,c) ((*(a))+=(b))
d02b48c6
RE
155#endif
156
c7922304
RL
157/* Some applications as well as some parts of OpenSSL need to allocate
158 and deallocate locks in a dynamic fashion. The following typedef
159 makes this possible in a type-safe manner. */
e73a6965
RL
160/* struct CRYPTO_dynlock_value has to be defined by the application. */
161typedef struct
162 {
163 int references;
164 struct CRYPTO_dynlock_value *data;
165 } CRYPTO_dynlock;
c7922304
RL
166
167
d02b48c6
RE
168/* The following can be used to detect memory leaks in the SSLeay library.
169 * It used, it turns on malloc checking */
170
dfeab068
RE
171#define CRYPTO_MEM_CHECK_OFF 0x0 /* an enume */
172#define CRYPTO_MEM_CHECK_ON 0x1 /* a bit */
173#define CRYPTO_MEM_CHECK_ENABLE 0x2 /* a bit */
174#define CRYPTO_MEM_CHECK_DISABLE 0x3 /* an enume */
d02b48c6 175
d8df48a9
RL
176/* The following are bit values to turn on or off options connected to the
177 * malloc checking functionality */
178
179/* Adds time to the memory checking information */
180#define V_CRYPTO_MDEBUG_TIME 0x1 /* a bit */
181/* Adds thread number to the memory checking information */
182#define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */
183
b64e735b
BM
184#define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
185
d02b48c6 186
58964a49
RE
187/* predec of the BIO type */
188typedef struct bio_st BIO_dummy;
189
190typedef struct crypto_ex_data_st
191 {
192 STACK *sk;
193 int dummy; /* gcc is screwing up this data structure :-( */
194 } CRYPTO_EX_DATA;
195
dd9d233e
DSH
196/* Called when a new object is created */
197typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
198 int idx, long argl, void *argp);
199/* Called when an object is free()ed */
200typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
201 int idx, long argl, void *argp);
202/* Called when we need to dup an object */
203typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
204 int idx, long argl, void *argp);
205
58964a49 206/* This stuff is basically class callback functions
c29b6d56 207 * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
dd9d233e 208
58964a49
RE
209typedef struct crypto_ex_data_func_st
210 {
211 long argl; /* Arbitary long */
dd9d233e
DSH
212 void *argp; /* Arbitary void * */
213 CRYPTO_EX_new *new_func;
214 CRYPTO_EX_free *free_func;
215 CRYPTO_EX_dup *dup_func;
58964a49
RE
216 } CRYPTO_EX_DATA_FUNCS;
217
dd9d233e
DSH
218DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
219
58964a49
RE
220/* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
221 * entry.
222 */
223
224#define CRYPTO_EX_INDEX_BIO 0
225#define CRYPTO_EX_INDEX_SSL 1
226#define CRYPTO_EX_INDEX_SSL_CTX 2
227#define CRYPTO_EX_INDEX_SSL_SESSION 3
228#define CRYPTO_EX_INDEX_X509_STORE 4
229#define CRYPTO_EX_INDEX_X509_STORE_CTX 5
d02b48c6 230
d8df48a9 231
3d14b9d0
DSH
232/* This is the default callbacks, but we can have others as well:
233 * this is needed in Win32 where the application malloc and the
234 * library malloc may not be the same.
235 */
d02b48c6 236#define CRYPTO_malloc_init() CRYPTO_set_mem_functions(\
0cd08cce 237 malloc, realloc, free)
0cd08cce
BM
238
239#if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
240# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
241# define CRYPTO_MDEBUG
242# endif
243#endif
d02b48c6 244
0cd08cce 245/* Set standard debugging functions (not done by default
75acc288 246 * unless CRYPTO_MDEBUG is defined) */
9ac42ed8
RL
247#define CRYPTO_malloc_debug_init() do {\
248 CRYPTO_set_mem_debug_functions(\
e5acb2bd
RL
249 CRYPTO_dbg_malloc,\
250 CRYPTO_dbg_realloc,\
251 CRYPTO_dbg_free,\
252 CRYPTO_dbg_set_options,\
253 CRYPTO_dbg_get_options);\
f3a2a044 254 } while(0)
9ac42ed8 255
0cd08cce
BM
256int CRYPTO_mem_ctrl(int mode);
257int CRYPTO_is_mem_check_on(void);
458cddc1 258
0cd08cce 259/* for applications */
dfeab068
RE
260#define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
261#define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
0cd08cce
BM
262
263/* for library-internal use */
dfeab068
RE
264#define MemCheck_on() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
265#define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
0cd08cce 266#define is_MemCheck_on() CRYPTO_is_mem_check_on()
9ac42ed8 267
26a3a48d
RL
268#define OPENSSL_malloc(num) CRYPTO_malloc((int)num,__FILE__,__LINE__)
269#define OPENSSL_realloc(addr,num) \
9ac42ed8 270 CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
26a3a48d 271#define OPENSSL_remalloc(addr,num) \
9ac42ed8 272 CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
26a3a48d
RL
273#define OPENSSL_freeFunc CRYPTO_free
274#define OPENSSL_free(addr) CRYPTO_free(addr)
9ac42ed8 275
26a3a48d
RL
276#define OPENSSL_malloc_locked(num) \
277 CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
278#define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
9ac42ed8 279
d02b48c6 280
e778802f 281const char *SSLeay_version(int type);
d02b48c6
RE
282unsigned long SSLeay(void);
283
36fafffa
UM
284int OPENSSL_issetugid(void);
285
dd9d233e
DSH
286int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) **skp, long argl, void *argp,
287 CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
288int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
bbbc96a8 289void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad,int idx);
dd9d233e
DSH
290int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, CRYPTO_EX_DATA *to,
291 CRYPTO_EX_DATA *from);
292void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
293void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
58964a49 294
58964a49 295int CRYPTO_get_new_lockid(char *name);
a111306b
BM
296
297int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
e778802f
BL
298void CRYPTO_lock(int mode, int type,const char *file,int line);
299void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
300 const char *file,int line));
301void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
d02b48c6 302 int line);
e778802f
BL
303void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
304 const char *file, int line));
305int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
306 const char *file,int line);
d02b48c6
RE
307void CRYPTO_set_id_callback(unsigned long (*func)(void));
308unsigned long (*CRYPTO_get_id_callback(void))(void);
309unsigned long CRYPTO_thread_id(void);
e778802f
BL
310const char *CRYPTO_get_lock_name(int type);
311int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
312 int line);
55b7688e 313
c7922304
RL
314int CRYPTO_get_new_dynlockid(void);
315void CRYPTO_destroy_dynlockid(int i);
e73a6965 316struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
55b7688e
RL
317void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value *(*dyn_create_function)(const char *file, int line));
318void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)(int mode, struct CRYPTO_dynlock_value *l, const char *file, int line));
319void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)(struct CRYPTO_dynlock_value *l, const char *file, int line));
320struct CRYPTO_dynlock_value *(*CRYPTO_get_dynlock_create_callback(void))(const char *file,int line);
321void (*CRYPTO_get_dynlock_lock_callback(void))(int mode, struct CRYPTO_dynlock_value *l, const char *file,int line);
322void (*CRYPTO_get_dynlock_destroy_callback(void))(struct CRYPTO_dynlock_value *l, const char *file,int line);
d02b48c6 323
0cd08cce
BM
324/* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
325 * call the latter last if you need different functions */
326int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
327int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
65a22e8e
RL
328int CRYPTO_set_mem_ex_functions(void *(*m)(size_t,const char *,int),
329 void *(*r)(void *,size_t,const char *,int),
cd56182b 330 void (*f)(void *));
65a22e8e 331int CRYPTO_set_locked_mem_ex_functions(void *(*m)(size_t,const char *,int),
cd56182b 332 void (*free_func)(void *));
65962686
RL
333int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
334 void (*r)(void *,void *,int,const char *,int,int),
335 void (*f)(void *,int),
336 void (*so)(long),
337 long (*go)(void));
0cd08cce
BM
338void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
339void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
65a22e8e
RL
340void CRYPTO_get_mem_ex_functions(void *(**m)(size_t,const char *,int),
341 void *(**r)(void *, size_t,const char *,int),
cd56182b 342 void (**f)(void *));
65a22e8e 343void CRYPTO_get_locked_mem_ex_functions(void *(**m)(size_t,const char *,int),
cd56182b 344 void (**f)(void *));
65962686
RL
345void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
346 void (**r)(void *,void *,int,const char *,int,int),
347 void (**f)(void *,int),
348 void (**so)(long),
349 long (**go)(void));
d02b48c6 350
9d1a01be 351void *CRYPTO_malloc_locked(int num, const char *file, int line);
5a88a6ea 352void CRYPTO_free_locked(void *);
9d1a01be 353void *CRYPTO_malloc(int num, const char *file, int line);
5a88a6ea 354void CRYPTO_free(void *);
9d1a01be
UM
355void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
356void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
5a88a6ea 357
0cd08cce 358void CRYPTO_set_mem_debug_options(long bits);
667ac4ec 359long CRYPTO_get_mem_debug_options(void);
0cd08cce 360
2b6313d0
BM
361#define CRYPTO_push_info(info) \
362 CRYPTO_push_info_(info, __FILE__, __LINE__);
363int CRYPTO_push_info_(const char *info, const char *file, int line);
364int CRYPTO_pop_info(void);
9ac42ed8
RL
365int CRYPTO_remove_all_info(void);
366
367/* The last argument has the following significance:
368 *
369 * 0: called before the actual memory allocation has taken place
370 * 1: called after the actual memory allocation has taken place
371 */
372void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
373void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
d8df48a9 374void CRYPTO_dbg_free(void *addr,int before_p);
9ac42ed8
RL
375
376/* Tell the debugging code about options. By default, the following values
377 * apply:
378 *
379 * 0: Clear all options.
380 * 1: Set the "Show Time" option.
381 * 2: Set the "Show Thread Number" option.
382 * 3: 1 + 2
383 */
0cd08cce 384void CRYPTO_dbg_set_options(long bits);
667ac4ec 385long CRYPTO_dbg_get_options(void);
1f575f1b 386
cf1b7d96 387#ifndef OPENSSL_NO_FP_API
d02b48c6
RE
388void CRYPTO_mem_leaks_fp(FILE *);
389#endif
58964a49 390void CRYPTO_mem_leaks(struct bio_st *bio);
d02b48c6 391/* unsigned long order, char *file, int line, int num_bytes, char *addr */
98d517c5 392typedef void *CRYPTO_MEM_LEAK_CB(unsigned long, const char *, int, int, void *);
32654e79 393void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
d02b48c6 394
667ac4ec 395void ERR_load_CRYPTO_strings(void);
58964a49 396
58964a49 397/* BEGIN ERROR CODES */
6d311938
DSH
398/* The following lines are auto generated by the script mkerr.pl. Any changes
399 * made after this point may be overwritten when the script is next run.
400 */
401
58964a49
RE
402/* Error codes for the CRYPTO functions. */
403
404/* Function codes. */
405#define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX 100
c7922304 406#define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID 103
58964a49
RE
407#define CRYPTO_F_CRYPTO_GET_NEW_LOCKID 101
408#define CRYPTO_F_CRYPTO_SET_EX_DATA 102
409
410/* Reason codes. */
c7922304 411#define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK 100
6d311938 412
d02b48c6
RE
413#ifdef __cplusplus
414}
415#endif
d02b48c6 416#endif
c7922304 417