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 #ifdef  __cplusplus
  63 extern "C" {
  64 #endif
  65
  66 #ifndef NO_FP_API
  67 #include <stdio.h>
  68 #endif
  69
  70 #include <openssl/stack.h>
  71 #include <openssl/opensslv.h>
  72
  73 /* Backward compatibility to SSLeay */
  74 /* This is more to be used to check the correct DLL is being used
  75  * in the MS world. */
  76 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
  77 #define SSLEAY_VERSION          0
  78 /* #define SSLEAY_OPTIONS       1 no longer supported */
  79 #define SSLEAY_CFLAGS           2
  80 #define SSLEAY_BUILT_ON         3
  81 #define SSLEAY_PLATFORM         4
  82
  83 /* When changing the CRYPTO_LOCK_* list, be sure to maintin the text lock
  84  * names in cryptlib.c
  85  */
  86
  87 #define CRYPTO_LOCK_ERR                 1
  88 #define CRYPTO_LOCK_ERR_HASH            2
  89 #define CRYPTO_LOCK_X509                3
  90 #define CRYPTO_LOCK_X509_INFO           4
  91 #define CRYPTO_LOCK_X509_PKEY           5
  92 #define CRYPTO_LOCK_X509_CRL            6
  93 #define CRYPTO_LOCK_X509_REQ            7
  94 #define CRYPTO_LOCK_DSA                 8
  95 #define CRYPTO_LOCK_RSA                 9
  96 #define CRYPTO_LOCK_EVP_PKEY            10
  97 #define CRYPTO_LOCK_X509_STORE          11
  98 #define CRYPTO_LOCK_SSL_CTX             12
  99 #define CRYPTO_LOCK_SSL_CERT            13
 100 #define CRYPTO_LOCK_SSL_SESSION         14
 101 #define CRYPTO_LOCK_SSL_SESS_CERT       15
 102 #define CRYPTO_LOCK_SSL                 16
 103 #define CRYPTO_LOCK_RAND                17
 104 #define CRYPTO_LOCK_MALLOC              18
 105 #define CRYPTO_LOCK_BIO                 19
 106 #define CRYPTO_LOCK_GETHOSTBYNAME       20
 107 #define CRYPTO_LOCK_GETSERVBYNAME       21
 108 #define CRYPTO_LOCK_READDIR             22
 109 #define CRYPTO_LOCK_RSA_BLINDING        23
 110 #define CRYPTO_NUM_LOCKS                24
 111
 112 #define CRYPTO_LOCK             1
 113 #define CRYPTO_UNLOCK           2
 114 #define CRYPTO_READ             4
 115 #define CRYPTO_WRITE            8
 116
 117 #ifndef NO_LOCKING
 118 #ifndef CRYPTO_w_lock
 119 #define CRYPTO_w_lock(type)     \
 120         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
 121 #define CRYPTO_w_unlock(type)   \
 122         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
 123 #define CRYPTO_r_lock(type)     \
 124         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
 125 #define CRYPTO_r_unlock(type)   \
 126         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
 127 #define CRYPTO_add(addr,amount,type)    \
 128         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
 129 #endif
 130 #else
 131 #define CRYPTO_w_lock(a)
 132 #define CRYPTO_w_unlock(a)
 133 #define CRYPTO_r_lock(a)
 134 #define CRYPTO_r_unlock(a)
 135 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
 136 #endif
 137
 138 /* The following can be used to detect memory leaks in the SSLeay library.
 139  * It used, it turns on malloc checking */
 140
 141 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
 142 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
 143 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
 144 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
 145
 146 /*
 147 typedef struct crypto_mem_st
 148         {
 149         char *(*malloc_func)();
 150         char *(*realloc_func)();
 151         void (*free_func)();
 152         } CRYPTO_MEM_FUNC;
 153 */
 154
 155 /* predec of the BIO type */
 156 typedef struct bio_st BIO_dummy;
 157
 158 typedef struct crypto_ex_data_st
 159         {
 160         STACK *sk;
 161         int dummy; /* gcc is screwing up this data structure :-( */
 162         } CRYPTO_EX_DATA;
 163
 164 /* This stuff is basically class callback functions
 165  * The current classes are SSL_CTX, SSL, SSL_SESION, and a few more */
 166 typedef struct crypto_ex_data_func_st
 167         {
 168         long argl;      /* Arbitary long */
 169         char *argp;     /* Arbitary char * */
 170         /* Called when a new object is created */
 171         int (*new_func)(/*char *obj,
 172                         char *item,int index,long argl,char *argp*/);
 173         /* Called when this object is free()ed */
 174         void (*free_func)(/*char *obj,
 175                         char *item,int index,long argl,char *argp*/);
 176
 177         /* Called when we need to dup this one */
 178         int (*dup_func)(/*char *obj_to,char *obj_from,
 179                         char **new,int index,long argl,char *argp*/);
 180         } CRYPTO_EX_DATA_FUNCS;
 181
 182 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
 183  * entry.
 184  */
 185
 186 #define CRYPTO_EX_INDEX_BIO             0
 187 #define CRYPTO_EX_INDEX_SSL             1
 188 #define CRYPTO_EX_INDEX_SSL_CTX         2
 189 #define CRYPTO_EX_INDEX_SSL_SESSION     3
 190 #define CRYPTO_EX_INDEX_X509_STORE      4
 191 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
 192
 193 /* Use this for win32 DLL's */
 194 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
 195         (char *(*)())malloc,\
 196         (char *(*)())realloc,\
 197         (void (*)())free)
 198
 199 #ifdef CRYPTO_MDEBUG
 200 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
 201 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
 202 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
 203 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
 204 #define Malloc(num)     CRYPTO_dbg_malloc((int)num,__FILE__,__LINE__)
 205 #define Realloc(addr,num) \
 206         CRYPTO_dbg_realloc((char *)addr,(int)num,__FILE__,__LINE__)
 207 #define Remalloc(addr,num) \
 208         CRYPTO_dbg_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
 209 #define FreeFunc        CRYPTO_dbg_free
 210 #define Free(addr)      CRYPTO_dbg_free(addr)
 211 #define Malloc_locked(num) CRYPTO_malloc_locked((int)num)
 212 #define Free_locked(addr) CRYPTO_free_locked(addr)
 213 #else
 214 #define MemCheck_start()
 215 #define MemCheck_stop()
 216 #define MemCheck_on()
 217 #define MemCheck_off()
 218 #define Remalloc        CRYPTO_remalloc
 219 #if defined(WIN32) || defined(MFUNC)
 220 #define Malloc          CRYPTO_malloc
 221 #define Realloc(a,n)    CRYPTO_realloc(a,(n))
 222 #define FreeFunc        CRYPTO_free
 223 #define Free(addr)      CRYPTO_free(addr)
 224 #define Malloc_locked   CRYPTO_malloc_locked
 225 #define Free_locked(addr) CRYPTO_free_locked(addr)
 226 #else
 227 #define Malloc          malloc
 228 #define Realloc         realloc
 229 #define FreeFunc        free
 230 #define Free(addr)      free(addr)
 231 #define Malloc_locked   malloc
 232 #define Free_locked(addr) free(addr)
 233 #endif /* WIN32 || MFUNC */
 234 #endif /* MDEBUG */
 235
 236 /* Case insensiteve linking causes problems.... */
 237 #if defined(WIN16) || defined(VMS)
 238 #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings
 239 #endif
 240
 241
 242 const char *SSLeay_version(int type);
 243 unsigned long SSLeay(void);
 244
 245 int CRYPTO_get_ex_new_index(int idx,STACK **sk,long argl,char *argp,
 246         int (*new_func)(),int (*dup_func)(),void (*free_func)());
 247 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad,int idx,char *val);
 248 char *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
 249 int CRYPTO_dup_ex_data(STACK *meth,CRYPTO_EX_DATA *from,CRYPTO_EX_DATA *to);
 250 void CRYPTO_free_ex_data(STACK *meth,char *obj,CRYPTO_EX_DATA *ad);
 251 void CRYPTO_new_ex_data(STACK *meth, char *obj, CRYPTO_EX_DATA *ad);
 252
 253 int CRYPTO_mem_ctrl(int mode);
 254 int CRYPTO_get_new_lockid(char *name);
 255 void CRYPTO_lock(int mode, int type,const char *file,int line);
 256 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
 257                                               const char *file,int line));
 258 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
 259                 int line);
 260 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
 261                                               const char *file, int line));
 262 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
 263                                           const char *file,int line);
 264 void CRYPTO_set_id_callback(unsigned long (*func)(void));
 265 unsigned long (*CRYPTO_get_id_callback(void))(void);
 266 unsigned long CRYPTO_thread_id(void);
 267 const char *CRYPTO_get_lock_name(int type);
 268 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
 269                     int line);
 270
 271 void CRYPTO_set_mem_functions(char *(*m)(),char *(*r)(), void (*free_func)());
 272 void CRYPTO_get_mem_functions(char *(**m)(),char *(**r)(), void (**f)());
 273 void CRYPTO_set_locked_mem_functions(char *(*m)(), void (*free_func)());
 274 void CRYPTO_get_locked_mem_functions(char *(**m)(), void (**f)());
 275
 276 void *CRYPTO_malloc_locked(int num);
 277 void CRYPTO_free_locked(void *);
 278 void *CRYPTO_malloc(int num);
 279 void CRYPTO_free(void *);
 280 void *CRYPTO_realloc(void *addr,int num);
 281 void *CRYPTO_remalloc(void *addr,int num);
 282
 283 void *CRYPTO_dbg_malloc(int num,const char *file,int line);
 284 void *CRYPTO_dbg_realloc(void *addr,int num,const char *file,int line);
 285 void CRYPTO_dbg_free(void *);
 286 void *CRYPTO_dbg_remalloc(void *addr,int num,const char *file,int line);
 287 #ifndef NO_FP_API
 288 void CRYPTO_mem_leaks_fp(FILE *);
 289 #endif
 290 void CRYPTO_mem_leaks(struct bio_st *bio);
 291 /* unsigned long order, char *file, int line, int num_bytes, char *addr */
 292 void CRYPTO_mem_leaks_cb(void (*cb)());
 293
 294 void ERR_load_CRYPTO_strings(void );
 295
 296 /* BEGIN ERROR CODES */
 297 /* The following lines are auto generated by the script mkerr.pl. Any changes
 298  * made after this point may be overwritten when the script is next run.
 299  */
 300
 301 /* Error codes for the CRYPTO functions. */
 302
 303 /* Function codes. */
 304 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
 305 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
 306 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
 307
 308 /* Reason codes. */
 309
 310 #ifdef  __cplusplus
 311 }
 312 #endif
 313 #endif
 314