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