crypto.h revision 296465
1/* crypto/crypto.h */
2/* ====================================================================
3 * Copyright (c) 1998-2003 The OpenSSL Project.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in
14 *    the documentation and/or other materials provided with the
15 *    distribution.
16 *
17 * 3. All advertising materials mentioning features or use of this
18 *    software must display the following acknowledgment:
19 *    "This product includes software developed by the OpenSSL Project
20 *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
21 *
22 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
23 *    endorse or promote products derived from this software without
24 *    prior written permission. For written permission, please contact
25 *    openssl-core@openssl.org.
26 *
27 * 5. Products derived from this software may not be called "OpenSSL"
28 *    nor may "OpenSSL" appear in their names without prior written
29 *    permission of the OpenSSL Project.
30 *
31 * 6. Redistributions of any form whatsoever must retain the following
32 *    acknowledgment:
33 *    "This product includes software developed by the OpenSSL Project
34 *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
35 *
36 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
37 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
39 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
42 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
44 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
45 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
46 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
47 * OF THE POSSIBILITY OF SUCH DAMAGE.
48 * ====================================================================
49 *
50 * This product includes cryptographic software written by Eric Young
51 * (eay@cryptsoft.com).  This product includes software written by Tim
52 * Hudson (tjh@cryptsoft.com).
53 *
54 */
55/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
56 * All rights reserved.
57 *
58 * This package is an SSL implementation written
59 * by Eric Young (eay@cryptsoft.com).
60 * The implementation was written so as to conform with Netscapes SSL.
61 *
62 * This library is free for commercial and non-commercial use as long as
63 * the following conditions are aheared to.  The following conditions
64 * apply to all code found in this distribution, be it the RC4, RSA,
65 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
66 * included with this distribution is covered by the same copyright terms
67 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
68 *
69 * Copyright remains Eric Young's, and as such any Copyright notices in
70 * the code are not to be removed.
71 * If this package is used in a product, Eric Young should be given attribution
72 * as the author of the parts of the library used.
73 * This can be in the form of a textual message at program startup or
74 * in documentation (online or textual) provided with the package.
75 *
76 * Redistribution and use in source and binary forms, with or without
77 * modification, are permitted provided that the following conditions
78 * are met:
79 * 1. Redistributions of source code must retain the copyright
80 *    notice, this list of conditions and the following disclaimer.
81 * 2. Redistributions in binary form must reproduce the above copyright
82 *    notice, this list of conditions and the following disclaimer in the
83 *    documentation and/or other materials provided with the distribution.
84 * 3. All advertising materials mentioning features or use of this software
85 *    must display the following acknowledgement:
86 *    "This product includes cryptographic software written by
87 *     Eric Young (eay@cryptsoft.com)"
88 *    The word 'cryptographic' can be left out if the rouines from the library
89 *    being used are not cryptographic related :-).
90 * 4. If you include any Windows specific code (or a derivative thereof) from
91 *    the apps directory (application code) you must include an acknowledgement:
92 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
93 *
94 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
95 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
96 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
97 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
98 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
99 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
100 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
101 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
102 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
103 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
104 * SUCH DAMAGE.
105 *
106 * The licence and distribution terms for any publically available version or
107 * derivative of this code cannot be changed.  i.e. this code cannot simply be
108 * copied and put under another distribution licence
109 * [including the GNU Public Licence.]
110 */
111/* ====================================================================
112 * Copyright 2002 Sun Microsystems, Inc. ALL RIGHTS RESERVED.
113 * ECDH support in OpenSSL originally developed by
114 * SUN MICROSYSTEMS, INC., and contributed to the OpenSSL project.
115 */
116
117#ifndef HEADER_CRYPTO_H
118# define HEADER_CRYPTO_H
119
120# include <stdlib.h>
121
122# include <openssl/e_os2.h>
123
124# ifndef OPENSSL_NO_FP_API
125#  include <stdio.h>
126# endif
127
128# include <openssl/stack.h>
129# include <openssl/safestack.h>
130# include <openssl/opensslv.h>
131# include <openssl/ossl_typ.h>
132
133# ifdef CHARSET_EBCDIC
134#  include <openssl/ebcdic.h>
135# endif
136
137/*
138 * Resolve problems on some operating systems with symbol names that clash
139 * one way or another
140 */
141# include <openssl/symhacks.h>
142
143#ifdef  __cplusplus
144extern "C" {
145#endif
146
147/* Backward compatibility to SSLeay */
148/*
149 * This is more to be used to check the correct DLL is being used in the MS
150 * world.
151 */
152# define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
153# define SSLEAY_VERSION          0
154/* #define SSLEAY_OPTIONS       1 no longer supported */
155# define SSLEAY_CFLAGS           2
156# define SSLEAY_BUILT_ON         3
157# define SSLEAY_PLATFORM         4
158# define SSLEAY_DIR              5
159
160/* Already declared in ossl_typ.h */
161# if 0
162typedef struct crypto_ex_data_st CRYPTO_EX_DATA;
163/* Called when a new object is created */
164typedef int CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
165                           int idx, long argl, void *argp);
166/* Called when an object is free()ed */
167typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
168                             int idx, long argl, void *argp);
169/* Called when we need to dup an object */
170typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from,
171                           void *from_d, int idx, long argl, void *argp);
172# endif
173
174/* A generic structure to pass assorted data in a expandable way */
175typedef struct openssl_item_st {
176    int code;
177    void *value;                /* Not used for flag attributes */
178    size_t value_size;          /* Max size of value for output, length for
179                                 * input */
180    size_t *value_length;       /* Returned length of value for output */
181} OPENSSL_ITEM;
182
183/*
184 * When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
185 * names in cryptlib.c
186 */
187
188# define CRYPTO_LOCK_ERR                 1
189# define CRYPTO_LOCK_EX_DATA             2
190# define CRYPTO_LOCK_X509                3
191# define CRYPTO_LOCK_X509_INFO           4
192# define CRYPTO_LOCK_X509_PKEY           5
193# define CRYPTO_LOCK_X509_CRL            6
194# define CRYPTO_LOCK_X509_REQ            7
195# define CRYPTO_LOCK_DSA                 8
196# define CRYPTO_LOCK_RSA                 9
197# define CRYPTO_LOCK_EVP_PKEY            10
198# define CRYPTO_LOCK_X509_STORE          11
199# define CRYPTO_LOCK_SSL_CTX             12
200# define CRYPTO_LOCK_SSL_CERT            13
201# define CRYPTO_LOCK_SSL_SESSION         14
202# define CRYPTO_LOCK_SSL_SESS_CERT       15
203# define CRYPTO_LOCK_SSL                 16
204# define CRYPTO_LOCK_SSL_METHOD          17
205# define CRYPTO_LOCK_RAND                18
206# define CRYPTO_LOCK_RAND2               19
207# define CRYPTO_LOCK_MALLOC              20
208# define CRYPTO_LOCK_BIO                 21
209# define CRYPTO_LOCK_GETHOSTBYNAME       22
210# define CRYPTO_LOCK_GETSERVBYNAME       23
211# define CRYPTO_LOCK_READDIR             24
212# define CRYPTO_LOCK_RSA_BLINDING        25
213# define CRYPTO_LOCK_DH                  26
214# define CRYPTO_LOCK_MALLOC2             27
215# define CRYPTO_LOCK_DSO                 28
216# define CRYPTO_LOCK_DYNLOCK             29
217# define CRYPTO_LOCK_ENGINE              30
218# define CRYPTO_LOCK_UI                  31
219# define CRYPTO_LOCK_ECDSA               32
220# define CRYPTO_LOCK_EC                  33
221# define CRYPTO_LOCK_ECDH                34
222# define CRYPTO_LOCK_BN                  35
223# define CRYPTO_LOCK_EC_PRE_COMP         36
224# define CRYPTO_LOCK_STORE               37
225# define CRYPTO_LOCK_COMP                38
226# ifndef OPENSSL_FIPS
227#  define CRYPTO_NUM_LOCKS                39
228# else
229#  define CRYPTO_LOCK_FIPS                39
230#  define CRYPTO_LOCK_FIPS2               40
231#  define CRYPTO_NUM_LOCKS                41
232# endif
233
234# define CRYPTO_LOCK             1
235# define CRYPTO_UNLOCK           2
236# define CRYPTO_READ             4
237# define CRYPTO_WRITE            8
238
239# ifndef OPENSSL_NO_LOCKING
240#  ifndef CRYPTO_w_lock
241#   define CRYPTO_w_lock(type)     \
242        CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
243#   define CRYPTO_w_unlock(type)   \
244        CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
245#   define CRYPTO_r_lock(type)     \
246        CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
247#   define CRYPTO_r_unlock(type)   \
248        CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
249#   define CRYPTO_add(addr,amount,type)    \
250        CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
251#  endif
252# else
253#  define CRYPTO_w_lock(a)
254#  define CRYPTO_w_unlock(a)
255#  define CRYPTO_r_lock(a)
256#  define CRYPTO_r_unlock(a)
257#  define CRYPTO_add(a,b,c)       ((*(a))+=(b))
258# endif
259
260/*
261 * Some applications as well as some parts of OpenSSL need to allocate and
262 * deallocate locks in a dynamic fashion.  The following typedef makes this
263 * possible in a type-safe manner.
264 */
265/* struct CRYPTO_dynlock_value has to be defined by the application. */
266typedef struct {
267    int references;
268    struct CRYPTO_dynlock_value *data;
269} CRYPTO_dynlock;
270
271/*
272 * The following can be used to detect memory leaks in the SSLeay library. It
273 * used, it turns on malloc checking
274 */
275
276# define CRYPTO_MEM_CHECK_OFF    0x0/* an enume */
277# define CRYPTO_MEM_CHECK_ON     0x1/* a bit */
278# define CRYPTO_MEM_CHECK_ENABLE 0x2/* a bit */
279# define CRYPTO_MEM_CHECK_DISABLE 0x3/* an enume */
280
281/*
282 * The following are bit values to turn on or off options connected to the
283 * malloc checking functionality
284 */
285
286/* Adds time to the memory checking information */
287# define V_CRYPTO_MDEBUG_TIME    0x1/* a bit */
288/* Adds thread number to the memory checking information */
289# define V_CRYPTO_MDEBUG_THREAD  0x2/* a bit */
290
291# define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
292
293/* predec of the BIO type */
294typedef struct bio_st BIO_dummy;
295
296struct crypto_ex_data_st {
297    STACK *sk;
298    /* gcc is screwing up this data structure :-( */
299    int dummy;
300};
301
302/*
303 * This stuff is basically class callback functions The current classes are
304 * SSL_CTX, SSL, SSL_SESSION, and a few more
305 */
306
307typedef struct crypto_ex_data_func_st {
308    long argl;                  /* Arbitary long */
309    void *argp;                 /* Arbitary void * */
310    CRYPTO_EX_new *new_func;
311    CRYPTO_EX_free *free_func;
312    CRYPTO_EX_dup *dup_func;
313} CRYPTO_EX_DATA_FUNCS;
314
315DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
316
317/*
318 * Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
319 * entry.
320 */
321
322# define CRYPTO_EX_INDEX_BIO             0
323# define CRYPTO_EX_INDEX_SSL             1
324# define CRYPTO_EX_INDEX_SSL_CTX         2
325# define CRYPTO_EX_INDEX_SSL_SESSION     3
326# define CRYPTO_EX_INDEX_X509_STORE      4
327# define CRYPTO_EX_INDEX_X509_STORE_CTX  5
328# define CRYPTO_EX_INDEX_RSA             6
329# define CRYPTO_EX_INDEX_DSA             7
330# define CRYPTO_EX_INDEX_DH              8
331# define CRYPTO_EX_INDEX_ENGINE          9
332# define CRYPTO_EX_INDEX_X509            10
333# define CRYPTO_EX_INDEX_UI              11
334# define CRYPTO_EX_INDEX_ECDSA           12
335# define CRYPTO_EX_INDEX_ECDH            13
336# define CRYPTO_EX_INDEX_COMP            14
337# define CRYPTO_EX_INDEX_STORE           15
338
339/*
340 * Dynamically assigned indexes start from this value (don't use directly,
341 * use via CRYPTO_ex_data_new_class).
342 */
343# define CRYPTO_EX_INDEX_USER            100
344
345/*
346 * This is the default callbacks, but we can have others as well: this is
347 * needed in Win32 where the application malloc and the library malloc may
348 * not be the same.
349 */
350# define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
351        malloc, realloc, free)
352
353# if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
354#  ifndef CRYPTO_MDEBUG         /* avoid duplicate #define */
355#   define CRYPTO_MDEBUG
356#  endif
357# endif
358
359/*
360 * Set standard debugging functions (not done by default unless CRYPTO_MDEBUG
361 * is defined)
362 */
363void CRYPTO_malloc_debug_init(void);
364
365int CRYPTO_mem_ctrl(int mode);
366int CRYPTO_is_mem_check_on(void);
367
368/* for applications */
369# define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
370# define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
371
372/* for library-internal use */
373# define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
374# define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
375# define is_MemCheck_on() CRYPTO_is_mem_check_on()
376
377# define OPENSSL_malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
378# define OPENSSL_strdup(str)     CRYPTO_strdup((str),__FILE__,__LINE__)
379# define OPENSSL_realloc(addr,num) \
380        CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
381# define OPENSSL_realloc_clean(addr,old_num,num) \
382        CRYPTO_realloc_clean(addr,old_num,num,__FILE__,__LINE__)
383# define OPENSSL_remalloc(addr,num) \
384        CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
385# define OPENSSL_freeFunc        CRYPTO_free
386# define OPENSSL_free(addr)      CRYPTO_free(addr)
387
388# define OPENSSL_malloc_locked(num) \
389        CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
390# define OPENSSL_free_locked(addr) CRYPTO_free_locked(addr)
391
392const char *SSLeay_version(int type);
393unsigned long SSLeay(void);
394
395int OPENSSL_issetugid(void);
396
397/* An opaque type representing an implementation of "ex_data" support */
398typedef struct st_CRYPTO_EX_DATA_IMPL CRYPTO_EX_DATA_IMPL;
399/* Return an opaque pointer to the current "ex_data" implementation */
400const CRYPTO_EX_DATA_IMPL *CRYPTO_get_ex_data_implementation(void);
401/* Sets the "ex_data" implementation to be used (if it's not too late) */
402int CRYPTO_set_ex_data_implementation(const CRYPTO_EX_DATA_IMPL *i);
403/* Get a new "ex_data" class, and return the corresponding "class_index" */
404int CRYPTO_ex_data_new_class(void);
405/* Within a given class, get/register a new index */
406int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
407                            CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
408                            CRYPTO_EX_free *free_func);
409/*
410 * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
411 * given class (invokes whatever per-class callbacks are applicable)
412 */
413int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
414int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
415                       CRYPTO_EX_DATA *from);
416void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
417/*
418 * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
419 * index (relative to the class type involved)
420 */
421int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
422void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
423/*
424 * This function cleans up all "ex_data" state. It mustn't be called under
425 * potential race-conditions.
426 */
427void CRYPTO_cleanup_all_ex_data(void);
428
429int CRYPTO_get_new_lockid(char *name);
430
431int CRYPTO_num_locks(void);     /* return CRYPTO_NUM_LOCKS (shared libs!) */
432void CRYPTO_lock(int mode, int type, const char *file, int line);
433void CRYPTO_set_locking_callback(void (*func) (int mode, int type,
434                                               const char *file, int line));
435void (*CRYPTO_get_locking_callback(void)) (int mode, int type,
436                                           const char *file, int line);
437void CRYPTO_set_add_lock_callback(int (*func)
438                                   (int *num, int mount, int type,
439                                    const char *file, int line));
440int (*CRYPTO_get_add_lock_callback(void)) (int *num, int mount, int type,
441                                           const char *file, int line);
442void CRYPTO_set_id_callback(unsigned long (*func) (void));
443unsigned long (*CRYPTO_get_id_callback(void)) (void);
444unsigned long CRYPTO_thread_id(void);
445const char *CRYPTO_get_lock_name(int type);
446int CRYPTO_add_lock(int *pointer, int amount, int type, const char *file,
447                    int line);
448
449void int_CRYPTO_set_do_dynlock_callback(void (*do_dynlock_cb)
450                                         (int mode, int type,
451                                          const char *file, int line));
452
453int CRYPTO_get_new_dynlockid(void);
454void CRYPTO_destroy_dynlockid(int i);
455struct CRYPTO_dynlock_value *CRYPTO_get_dynlock_value(int i);
456void CRYPTO_set_dynlock_create_callback(struct CRYPTO_dynlock_value
457                                        *(*dyn_create_function) (const char
458                                                                 *file,
459                                                                 int line));
460void CRYPTO_set_dynlock_lock_callback(void (*dyn_lock_function)
461                                       (int mode,
462                                        struct CRYPTO_dynlock_value *l,
463                                        const char *file, int line));
464void CRYPTO_set_dynlock_destroy_callback(void (*dyn_destroy_function)
465                                          (struct CRYPTO_dynlock_value *l,
466                                           const char *file, int line));
467struct CRYPTO_dynlock_value
468*(*CRYPTO_get_dynlock_create_callback(void)) (const char *file, int line);
469void (*CRYPTO_get_dynlock_lock_callback(void)) (int mode,
470                                                struct CRYPTO_dynlock_value
471                                                *l, const char *file,
472                                                int line);
473void (*CRYPTO_get_dynlock_destroy_callback(void)) (struct CRYPTO_dynlock_value
474                                                   *l, const char *file,
475                                                   int line);
476
477/*
478 * CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions -- call
479 * the latter last if you need different functions
480 */
481int CRYPTO_set_mem_functions(void *(*m) (size_t), void *(*r) (void *, size_t),
482                             void (*f) (void *));
483int CRYPTO_set_locked_mem_functions(void *(*m) (size_t),
484                                    void (*free_func) (void *));
485int CRYPTO_set_mem_ex_functions(void *(*m) (size_t, const char *, int),
486                                void *(*r) (void *, size_t, const char *,
487                                            int), void (*f) (void *));
488int CRYPTO_set_locked_mem_ex_functions(void *(*m) (size_t, const char *, int),
489                                       void (*free_func) (void *));
490int CRYPTO_set_mem_debug_functions(void (*m)
491                                    (void *, int, const char *, int, int),
492                                   void (*r) (void *, void *, int,
493                                              const char *, int, int),
494                                   void (*f) (void *, int), void (*so) (long),
495                                   long (*go) (void));
496void CRYPTO_set_mem_info_functions(int (*push_info_fn)
497                                    (const char *info, const char *file,
498                                     int line), int (*pop_info_fn) (void),
499                                   int (*remove_all_info_fn) (void));
500void CRYPTO_get_mem_functions(void *(**m) (size_t),
501                              void *(**r) (void *, size_t),
502                              void (**f) (void *));
503void CRYPTO_get_locked_mem_functions(void *(**m) (size_t),
504                                     void (**f) (void *));
505void CRYPTO_get_mem_ex_functions(void *(**m) (size_t, const char *, int),
506                                 void *(**r) (void *, size_t, const char *,
507                                              int), void (**f) (void *));
508void CRYPTO_get_locked_mem_ex_functions(void
509                                        *(**m) (size_t, const char *, int),
510                                        void (**f) (void *));
511void CRYPTO_get_mem_debug_functions(void (**m)
512                                     (void *, int, const char *, int, int),
513                                    void (**r) (void *, void *, int,
514                                                const char *, int, int),
515                                    void (**f) (void *, int),
516                                    void (**so) (long), long (**go) (void));
517
518void *CRYPTO_malloc_locked(int num, const char *file, int line);
519void CRYPTO_free_locked(void *);
520void *CRYPTO_malloc(int num, const char *file, int line);
521char *CRYPTO_strdup(const char *str, const char *file, int line);
522void CRYPTO_free(void *);
523void *CRYPTO_realloc(void *addr, int num, const char *file, int line);
524void *CRYPTO_realloc_clean(void *addr, int old_num, int num, const char *file,
525                           int line);
526void *CRYPTO_remalloc(void *addr, int num, const char *file, int line);
527
528void OPENSSL_cleanse(void *ptr, size_t len);
529
530void CRYPTO_set_mem_debug_options(long bits);
531long CRYPTO_get_mem_debug_options(void);
532
533# define CRYPTO_push_info(info) \
534        CRYPTO_push_info_(info, __FILE__, __LINE__);
535int CRYPTO_push_info_(const char *info, const char *file, int line);
536int CRYPTO_pop_info(void);
537int CRYPTO_remove_all_info(void);
538
539/*
540 * Default debugging functions (enabled by CRYPTO_malloc_debug_init() macro;
541 * used as default in CRYPTO_MDEBUG compilations):
542 */
543/*-
544 * The last argument has the following significance:
545 *
546 * 0:   called before the actual memory allocation has taken place
547 * 1:   called after the actual memory allocation has taken place
548 */
549void CRYPTO_dbg_malloc(void *addr, int num, const char *file, int line,
550                       int before_p);
551void CRYPTO_dbg_realloc(void *addr1, void *addr2, int num, const char *file,
552                        int line, int before_p);
553void CRYPTO_dbg_free(void *addr, int before_p);
554/*-
555 * Tell the debugging code about options.  By default, the following values
556 * apply:
557 *
558 * 0:                           Clear all options.
559 * V_CRYPTO_MDEBUG_TIME (1):    Set the "Show Time" option.
560 * V_CRYPTO_MDEBUG_THREAD (2):  Set the "Show Thread Number" option.
561 * V_CRYPTO_MDEBUG_ALL (3):     1 + 2
562 */
563void CRYPTO_dbg_set_options(long bits);
564long CRYPTO_dbg_get_options(void);
565
566int CRYPTO_dbg_push_info(const char *info, const char *file, int line);
567int CRYPTO_dbg_pop_info(void);
568int CRYPTO_dbg_remove_all_info(void);
569
570# ifndef OPENSSL_NO_FP_API
571void CRYPTO_mem_leaks_fp(FILE *);
572# endif
573void CRYPTO_mem_leaks(struct bio_st *bio);
574/* unsigned long order, char *file, int line, int num_bytes, char *addr */
575typedef void *CRYPTO_MEM_LEAK_CB (unsigned long, const char *, int, int,
576                                  void *);
577void CRYPTO_mem_leaks_cb(CRYPTO_MEM_LEAK_CB *cb);
578
579/* die if we have to */
580void OpenSSLDie(const char *file, int line, const char *assertion);
581# define OPENSSL_assert(e)       (void)((e) ? 0 : (OpenSSLDie(__FILE__, __LINE__, #e),1))
582
583unsigned long *OPENSSL_ia32cap_loc(void);
584# define OPENSSL_ia32cap (*(OPENSSL_ia32cap_loc()))
585int OPENSSL_isservice(void);
586
587# ifdef OPENSSL_FIPS
588#  define FIPS_ERROR_IGNORED(alg) OpenSSLDie(__FILE__, __LINE__, \
589                alg " previous FIPS forbidden algorithm error ignored");
590
591#  define FIPS_BAD_ABORT(alg) OpenSSLDie(__FILE__, __LINE__, \
592                #alg " Algorithm forbidden in FIPS mode");
593
594#  ifdef OPENSSL_FIPS_STRICT
595#   define FIPS_BAD_ALGORITHM(alg) FIPS_BAD_ABORT(alg)
596#  else
597#   define FIPS_BAD_ALGORITHM(alg) \
598        { \
599        FIPSerr(FIPS_F_HASH_FINAL,FIPS_R_NON_FIPS_METHOD); \
600        ERR_add_error_data(2, "Algorithm=", #alg); \
601        return 0; \
602        }
603#  endif
604
605/* Low level digest API blocking macro */
606
607#  define FIPS_NON_FIPS_MD_Init(alg) \
608        int alg##_Init(alg##_CTX *c) \
609                { \
610                if (FIPS_mode()) \
611                        FIPS_BAD_ALGORITHM(alg) \
612                return private_##alg##_Init(c); \
613                } \
614        int private_##alg##_Init(alg##_CTX *c)
615
616/*
617 * For ciphers the API often varies from cipher to cipher and each needs to
618 * be treated as a special case. Variable key length ciphers (Blowfish, RC4,
619 * CAST) however are very similar and can use a blocking macro.
620 */
621
622#  define FIPS_NON_FIPS_VCIPHER_Init(alg) \
623        void alg##_set_key(alg##_KEY *key, int len, const unsigned char *data) \
624                { \
625                if (FIPS_mode()) \
626                        FIPS_BAD_ABORT(alg) \
627                private_##alg##_set_key(key, len, data); \
628                } \
629        void private_##alg##_set_key(alg##_KEY *key, int len, \
630                                        const unsigned char *data)
631
632# else
633
634#  define FIPS_NON_FIPS_VCIPHER_Init(alg) \
635        void alg##_set_key(alg##_KEY *key, int len, const unsigned char *data)
636
637#  define FIPS_NON_FIPS_MD_Init(alg) \
638        int alg##_Init(alg##_CTX *c)
639
640# endif                         /* def OPENSSL_FIPS */
641
642# define OPENSSL_HAVE_INIT       1
643void OPENSSL_init(void);
644
645/*
646 * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
647 * It takes an amount of time dependent on |len|, but independent of the
648 * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
649 * into a defined order as the return value when a != b is undefined, other
650 * than to be non-zero.
651 */
652int CRYPTO_memcmp(const void *a, const void *b, size_t len);
653
654/* BEGIN ERROR CODES */
655/*
656 * The following lines are auto generated by the script mkerr.pl. Any changes
657 * made after this point may be overwritten when the script is next run.
658 */
659void ERR_load_CRYPTO_strings(void);
660
661/* Error codes for the CRYPTO functions. */
662
663/* Function codes. */
664# define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
665# define CRYPTO_F_CRYPTO_GET_NEW_DYNLOCKID                103
666# define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
667# define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
668# define CRYPTO_F_DEF_ADD_INDEX                           104
669# define CRYPTO_F_DEF_GET_CLASS                           105
670# define CRYPTO_F_INT_DUP_EX_DATA                         106
671# define CRYPTO_F_INT_FREE_EX_DATA                        107
672# define CRYPTO_F_INT_NEW_EX_DATA                         108
673
674/* Reason codes. */
675# define CRYPTO_R_NO_DYNLOCK_CREATE_CALLBACK              100
676
677#ifdef  __cplusplus
678}
679#endif
680#endif
681