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