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