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