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