is needed.
[openssl.git] / crypto / crypto.h
index 0a76c771a74f44813fd2b77d376ac7ad873aeada..84894af56ce2f6453cd22c45d2544637b62cc4ff 100644 (file)
 #ifndef HEADER_CRYPTO_H
 #define HEADER_CRYPTO_H
 
-#ifdef  __cplusplus
-extern "C" {
-#endif
+#include <stdlib.h>
 
 #ifndef NO_FP_API
 #include <stdio.h>
 #endif
 
 #include <openssl/stack.h>
+#include <openssl/safestack.h>
 #include <openssl/opensslv.h>
 
 #ifdef CHARSET_EBCDIC
 #include <openssl/ebcdic.h>
 #endif
 
+#if defined(VMS) || defined(__VMS)
+#include "vms_idhacks.h"
+#endif
+
+
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
 /* Backward compatibility to SSLeay */
 /* This is more to be used to check the correct DLL is being used
  * in the MS world. */
@@ -113,7 +121,8 @@ extern "C" {
 #define        CRYPTO_LOCK_RSA_BLINDING        23
 #define        CRYPTO_LOCK_DH                  24
 #define        CRYPTO_LOCK_MALLOC2             25
-#define        CRYPTO_NUM_LOCKS                26
+#define        CRYPTO_LOCK_DSO                 26
+#define        CRYPTO_NUM_LOCKS                27
 
 #define CRYPTO_LOCK            1
 #define CRYPTO_UNLOCK          2
@@ -149,14 +158,16 @@ extern "C" {
 #define CRYPTO_MEM_CHECK_ENABLE        0x2     /* a bit */
 #define CRYPTO_MEM_CHECK_DISABLE 0x3   /* an enume */
 
-/*
-typedef struct crypto_mem_st
-       {
-       char *(*malloc_func)();
-       char *(*realloc_func)();
-       void (*free_func)();
-       } CRYPTO_MEM_FUNC;
-*/
+/* The following are bit values to turn on or off options connected to the
+ * malloc checking functionality */
+
+/* Adds time to the memory checking information */
+#define V_CRYPTO_MDEBUG_TIME   0x1 /* a bit */
+/* Adds thread number to the memory checking information */
+#define V_CRYPTO_MDEBUG_THREAD 0x2 /* a bit */
+
+#define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
+
 
 /* predec of the BIO type */
 typedef struct bio_st BIO_dummy;
@@ -167,24 +178,30 @@ typedef struct crypto_ex_data_st
        int dummy; /* gcc is screwing up this data structure :-( */
        } CRYPTO_EX_DATA;
 
+/* Called when a new object is created */
+typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
+                                       int idx, long argl, void *argp);
+/* Called when an object is free()ed */
+typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
+                                       int idx, long argl, void *argp);
+/* Called when we need to dup an object */
+typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d, 
+                                       int idx, long argl, void *argp);
+
 /* This stuff is basically class callback functions
- * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */
+ * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
+
 typedef struct crypto_ex_data_func_st
        {
        long argl;      /* Arbitary long */
-       char *argp;     /* Arbitary char * */
-       /* Called when a new object is created */
-       int (*new_func)(/*char *obj,
-                       char *item,int index,long argl,char *argp*/);
-       /* Called when this object is free()ed */
-       void (*free_func)(/*char *obj,
-                       char *item,int index,long argl,char *argp*/);
-
-       /* Called when we need to dup this one */
-       int (*dup_func)(/*char *obj_to,char *obj_from,
-                       char **new,int index,long argl,char *argp*/);
+       void *argp;     /* Arbitary void * */
+       CRYPTO_EX_new *new_func;
+       CRYPTO_EX_free *free_func;
+       CRYPTO_EX_dup *dup_func;
        } CRYPTO_EX_DATA_FUNCS;
 
+DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
+
 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
  * entry.
  */
@@ -196,61 +213,42 @@ typedef struct crypto_ex_data_func_st
 #define CRYPTO_EX_INDEX_X509_STORE     4
 #define CRYPTO_EX_INDEX_X509_STORE_CTX 5
 
-/* This is the default callbacks, but we can have others as well */
-#define CRYPTO_malloc_init()   CRYPTO_set_mem_functions(\
-       (char *(*)())malloc,\
-       (char *(*)())realloc,\
-       (void (*)())free)
-
 
+/* This is the default callbacks, but we can have others as well:
+ * this is needed in Win32 where the application malloc and the
+ * library malloc may not be the same.
+ */
+#define CRYPTO_malloc_init()   CRYPTO_set_mem_functions(\
+       malloc, realloc, free)
 
-#ifdef CRYPTO_MDEBUG_ALL
-# ifndef CRYPTO_MDEBUG_TIME
-#  define CRYPTO_MDEBUG_TIME
-# endif
-# ifndef CRYPTO_MDEBUG_THREAD
-#  define CRYPTO_MDEBUG_THREAD
+#if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
+# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
+#  define CRYPTO_MDEBUG
 # endif
 #endif
 
-/* Magic to make sure we get correct values */
-#ifdef CRYPTO_MDEBUG_TIME
-#define V_CRYPTO_MDEBUG_TIME 1
-#else
-#define V_CRYPTO_MDEBUG_TIME 0
-#endif
-#ifdef CRYPTO_MDEBUG_THREAD
-#define V_CRYPTO_MDEBUG_THREAD 2
-#else
-#define V_CRYPTO_MDEBUG_THREAD 0
-#endif
-
+/* Set standard debugging functions (not done by default
+ * unless CRYPTO_MDEBUG is defined) */
 #define CRYPTO_malloc_debug_init()     do {\
        CRYPTO_set_mem_debug_functions(\
                (void (*)())CRYPTO_dbg_malloc,\
                (void (*)())CRYPTO_dbg_realloc,\
                (void (*)())CRYPTO_dbg_free,\
                (void (*)())CRYPTO_dbg_set_options,\
-               (void (*)())CRYPTO_dbg_get_options);\
-       CRYPTO_set_mem_debug_options(V_CRYPTO_MDEBUG_TIME|V_CRYPTO_MDEBUG_THREAD);\
-       } while(0);
+               (long (*)())CRYPTO_dbg_get_options);\
+       } while(0)
 
-#if defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
-# ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
-#  define CRYPTO_MDEBUG
-# endif
-#endif
+int CRYPTO_mem_ctrl(int mode);
+int CRYPTO_is_mem_check_on(void);
 
-#ifdef CRYPTO_MDEBUG
+/* for applications */
 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
 #define MemCheck_stop()        CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
-#else
-#define MemCheck_start()
-#define MemCheck_stop()
-#endif
+
+/* for library-internal use */
 #define MemCheck_on()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
 #define MemCheck_off() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
-#define is_MemCheck_on() CRYPTO_mem_check_on()
+#define is_MemCheck_on() CRYPTO_is_mem_check_on()
 
 #define Malloc(num)    CRYPTO_malloc((int)num,__FILE__,__LINE__)
 #define Realloc(addr,num) \
@@ -273,16 +271,15 @@ typedef struct crypto_ex_data_func_st
 const char *SSLeay_version(int type);
 unsigned long SSLeay(void);
 
-int CRYPTO_get_ex_new_index(int idx,STACK **sk,long argl,char *argp,
-       int (*new_func)(),int (*dup_func)(),void (*free_func)());
-int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad,int idx,char *val);
-char *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
-int CRYPTO_dup_ex_data(STACK *meth,CRYPTO_EX_DATA *from,CRYPTO_EX_DATA *to);
-void CRYPTO_free_ex_data(STACK *meth,char *obj,CRYPTO_EX_DATA *ad);
-void CRYPTO_new_ex_data(STACK *meth, char *obj, CRYPTO_EX_DATA *ad);
+int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) **skp, long argl, void *argp,
+            CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
+int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
+void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
+int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, CRYPTO_EX_DATA *to,
+            CRYPTO_EX_DATA *from);
+void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
+void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
 
-int CRYPTO_mem_ctrl(int mode);
-int CRYPTO_mem_check_on(void);
 int CRYPTO_get_new_lockid(char *name);
 
 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
@@ -302,24 +299,37 @@ const char *CRYPTO_get_lock_name(int type);
 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
                    int line);
 
-void CRYPTO_set_mem_functions(char *(*m)(),char *(*r)(), void (*f)());
-void CRYPTO_set_mem_debug_functions(void (*m)(),void (*r)(),void (*f)(),void (*so)(),int (*go)());
-void CRYPTO_set_mem_debug_options(int bits);
-void CRYPTO_get_mem_functions(char *(**m)(),char *(**r)(), void (**f)());
-void CRYPTO_get_mem_debug_functions(void (**m)(),void (**r)(),void (**f)(),void (**so)(),int (**go)());
-int CRYPTO_get_mem_debug_options();
-void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*free_func)());
-void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)());
-
-void *CRYPTO_malloc_locked(int num, char *file, int line);
+/* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
+ * call the latter last if you need different functions */
+int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
+int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
+int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
+                                  void (*r)(void *,void *,int,const char *,int,int),
+                                  void (*f)(void *,int),
+                                  void (*so)(long),
+                                  long (*go)(void));
+void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
+void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), void (**f)(void *));
+void CRYPTO_get_mem_debug_functions(void (**m)(void *,int,const char *,int,int),
+                                   void (**r)(void *,void *,int,const char *,int,int),
+                                   void (**f)(void *,int),
+                                   void (**so)(long),
+                                   long (**go)(void));
+
+void *CRYPTO_malloc_locked(int num, const char *file, int line);
 void CRYPTO_free_locked(void *);
-void *CRYPTO_malloc(int num, char *file, int line);
+void *CRYPTO_malloc(int num, const char *file, int line);
 void CRYPTO_free(void *);
-void *CRYPTO_realloc(void *addr,int num, char *file, int line);
-void *CRYPTO_remalloc(void *addr,int num, char *file, int line);
+void *CRYPTO_realloc(void *addr,int num, const char *file, int line);
+void *CRYPTO_remalloc(void *addr,int num, const char *file, int line);
 
-int CRYPTO_add_info(const char *file, int line, const char *info);
-int CRYPTO_remove_info(void);
+void CRYPTO_set_mem_debug_options(long bits);
+long CRYPTO_get_mem_debug_options(void);
+
+#define CRYPTO_push_info(info) \
+        CRYPTO_push_info_(info, __FILE__, __LINE__);
+int CRYPTO_push_info_(const char *info, const char *file, int line);
+int CRYPTO_pop_info(void);
 int CRYPTO_remove_all_info(void);
 
 /* The last argument has the following significance:
@@ -329,7 +339,7 @@ int CRYPTO_remove_all_info(void);
  */
 void CRYPTO_dbg_malloc(void *addr,int num,const char *file,int line,int before_p);
 void CRYPTO_dbg_realloc(void *addr1,void *addr2,int num,const char *file,int line,int before_p);
-void CRYPTO_dbg_free(void *,int before_p);
+void CRYPTO_dbg_free(void *addr,int before_p);
 
 /* Tell the debugging code about options.  By default, the following values
  * apply:
@@ -339,17 +349,17 @@ void CRYPTO_dbg_free(void *,int before_p);
  * 2:  Set the "Show Thread Number" option.
  * 3:  1 + 2
  */
-void CRYPTO_dbg_set_options(int num);
-int CRYPTO_dbg_get_options();
+void CRYPTO_dbg_set_options(long bits);
+long CRYPTO_dbg_get_options(void);
 
 #ifndef NO_FP_API
 void CRYPTO_mem_leaks_fp(FILE *);
 #endif
 void CRYPTO_mem_leaks(struct bio_st *bio);
 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
-void CRYPTO_mem_leaks_cb(void (*cb)());
+void CRYPTO_mem_leaks_cb(void (*cb)(unsigned long, const char *, int, int, void *));
 
-void ERR_load_CRYPTO_strings(void );
+void ERR_load_CRYPTO_strings(void);
 
 /* BEGIN ERROR CODES */
 /* The following lines are auto generated by the script mkerr.pl. Any changes
@@ -369,4 +379,3 @@ void ERR_load_CRYPTO_strings(void );
 }
 #endif
 #endif
-