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 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 #if defined(VMS) || defined(__VMS)
  77 #include "vms_idhacks.h"
  78 #endif
  79
  80
  81 #ifdef  __cplusplus
  82 extern "C" {
  83 #endif
  84
  85 /* Backward compatibility to SSLeay */
  86 /* This is more to be used to check the correct DLL is being used
  87  * in the MS world. */
  88 #define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
  89 #define SSLEAY_VERSION          0
  90 /* #define SSLEAY_OPTIONS       1 no longer supported */
  91 #define SSLEAY_CFLAGS           2
  92 #define SSLEAY_BUILT_ON         3
  93 #define SSLEAY_PLATFORM         4
  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_NUM_LOCKS                27
 126
 127 #define CRYPTO_LOCK             1
 128 #define CRYPTO_UNLOCK           2
 129 #define CRYPTO_READ             4
 130 #define CRYPTO_WRITE            8
 131
 132 #ifndef NO_LOCKING
 133 #ifndef CRYPTO_w_lock
 134 #define CRYPTO_w_lock(type)     \
 135         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
 136 #define CRYPTO_w_unlock(type)   \
 137         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_WRITE,type,__FILE__,__LINE__)
 138 #define CRYPTO_r_lock(type)     \
 139         CRYPTO_lock(CRYPTO_LOCK|CRYPTO_READ,type,__FILE__,__LINE__)
 140 #define CRYPTO_r_unlock(type)   \
 141         CRYPTO_lock(CRYPTO_UNLOCK|CRYPTO_READ,type,__FILE__,__LINE__)
 142 #define CRYPTO_add(addr,amount,type)    \
 143         CRYPTO_add_lock(addr,amount,type,__FILE__,__LINE__)
 144 #endif
 145 #else
 146 #define CRYPTO_w_lock(a)
 147 #define CRYPTO_w_unlock(a)
 148 #define CRYPTO_r_lock(a)
 149 #define CRYPTO_r_unlock(a)
 150 #define CRYPTO_add(a,b,c)       ((*(a))+=(b))
 151 #endif
 152
 153 /* The following can be used to detect memory leaks in the SSLeay library.
 154  * It used, it turns on malloc checking */
 155
 156 #define CRYPTO_MEM_CHECK_OFF    0x0     /* an enume */
 157 #define CRYPTO_MEM_CHECK_ON     0x1     /* a bit */
 158 #define CRYPTO_MEM_CHECK_ENABLE 0x2     /* a bit */
 159 #define CRYPTO_MEM_CHECK_DISABLE 0x3    /* an enume */
 160
 161 /* The following are bit values to turn on or off options connected to the
 162  * malloc checking functionality */
 163
 164 /* Adds time to the memory checking information */
 165 #define V_CRYPTO_MDEBUG_TIME    0x1 /* a bit */
 166 /* Adds thread number to the memory checking information */
 167 #define V_CRYPTO_MDEBUG_THREAD  0x2 /* a bit */
 168
 169 #define V_CRYPTO_MDEBUG_ALL (V_CRYPTO_MDEBUG_TIME | V_CRYPTO_MDEBUG_THREAD)
 170
 171
 172 /* predec of the BIO type */
 173 typedef struct bio_st BIO_dummy;
 174
 175 typedef struct crypto_ex_data_st
 176         {
 177         STACK *sk;
 178         int dummy; /* gcc is screwing up this data structure :-( */
 179         } CRYPTO_EX_DATA;
 180
 181 /* Called when a new object is created */
 182 typedef int CRYPTO_EX_new(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
 183                                         int idx, long argl, void *argp);
 184 /* Called when an object is free()ed */
 185 typedef void CRYPTO_EX_free(void *parent, void *ptr, CRYPTO_EX_DATA *ad,
 186                                         int idx, long argl, void *argp);
 187 /* Called when we need to dup an object */
 188 typedef int CRYPTO_EX_dup(CRYPTO_EX_DATA *to, CRYPTO_EX_DATA *from, void *from_d,
 189                                         int idx, long argl, void *argp);
 190
 191 /* This stuff is basically class callback functions
 192  * The current classes are SSL_CTX, SSL, SSL_SESSION, and a few more */
 193
 194 typedef struct crypto_ex_data_func_st
 195         {
 196         long argl;      /* Arbitary long */
 197         void *argp;     /* Arbitary void * */
 198         CRYPTO_EX_new *new_func;
 199         CRYPTO_EX_free *free_func;
 200         CRYPTO_EX_dup *dup_func;
 201         } CRYPTO_EX_DATA_FUNCS;
 202
 203 DECLARE_STACK_OF(CRYPTO_EX_DATA_FUNCS)
 204 /* This block of defines is updated by a perl script, please do not touch! */
 205 #ifndef DEBUG_SAFESTACK
 206         #define sk_CRYPTO_EX_DATA_FUNCS_new(a) sk_new((int (*) \
 207                 (const char * const *, const char * const *))(a))
 208         #define sk_CRYPTO_EX_DATA_FUNCS_new_null() sk_new_null()
 209         #define sk_CRYPTO_EX_DATA_FUNCS_free(a) sk_free(a)
 210         #define sk_CRYPTO_EX_DATA_FUNCS_num(a) sk_num(a)
 211         #define sk_CRYPTO_EX_DATA_FUNCS_value(a,b) ((CRYPTO_EX_DATA_FUNCS *) \
 212                 sk_value((a),(b)))
 213         #define sk_CRYPTO_EX_DATA_FUNCS_set(a,b,c) ((CRYPTO_EX_DATA_FUNCS *) \
 214                 sk_set((a),(b),(char *)(c)))
 215         #define sk_CRYPTO_EX_DATA_FUNCS_zero(a) sk_zero(a)
 216         #define sk_CRYPTO_EX_DATA_FUNCS_push(a,b) sk_push((a),(char *)(b))
 217         #define sk_CRYPTO_EX_DATA_FUNCS_unshift(a,b) sk_unshift((a),(b))
 218         #define sk_CRYPTO_EX_DATA_FUNCS_find(a,b) sk_find((a), (char *)(b))
 219         #define sk_CRYPTO_EX_DATA_FUNCS_delete(a,b) ((CRYPTO_EX_DATA_FUNCS *) \
 220                 sk_delete((a),(b)))
 221         #define sk_CRYPTO_EX_DATA_FUNCS_delete_ptr(a,b) ((CRYPTO_EX_DATA_FUNCS *) \
 222                 sk_delete_ptr((a),(char *)(b)))
 223         #define sk_CRYPTO_EX_DATA_FUNCS_insert(a,b,c) sk_insert((a),(char *)(b),(c))
 224         #define sk_CRYPTO_EX_DATA_FUNCS_set_cmp_func(a,b) ((int (*) \
 225                 (const CRYPTO_EX_DATA_FUNCS * const *,const CRYPTO_EX_DATA_FUNCS * const *)) \
 226                 sk_set_cmp_func((a),(int (*) \
 227                 (const char * const *, const char * const *))(b)))
 228         #define sk_CRYPTO_EX_DATA_FUNCS_dup(a) sk_dup(a)
 229         #define sk_CRYPTO_EX_DATA_FUNCS_pop_free(a,b) sk_pop_free((a),(void (*)(void *))(b))
 230         #define sk_CRYPTO_EX_DATA_FUNCS_shift(a) ((CRYPTO_EX_DATA_FUNCS *)sk_shift(a))
 231         #define sk_CRYPTO_EX_DATA_FUNCS_pop(a) ((CRYPTO_EX_DATA_FUNCS *)sk_pop(a))
 232         #define sk_CRYPTO_EX_DATA_FUNCS_sort(a) sk_sort(a)
 233 #endif /* !DEBUG_SAFESTACK */
 234 /* End of perl script block, you may now edit :-) */
 235
 236 /* Per class, we have a STACK of CRYPTO_EX_DATA_FUNCS for each CRYPTO_EX_DATA
 237  * entry.
 238  */
 239
 240 #define CRYPTO_EX_INDEX_BIO             0
 241 #define CRYPTO_EX_INDEX_SSL             1
 242 #define CRYPTO_EX_INDEX_SSL_CTX         2
 243 #define CRYPTO_EX_INDEX_SSL_SESSION     3
 244 #define CRYPTO_EX_INDEX_X509_STORE      4
 245 #define CRYPTO_EX_INDEX_X509_STORE_CTX  5
 246
 247
 248 /* This is the default callbacks, but we can have others as well:
 249  * this is needed in Win32 where the application malloc and the
 250  * library malloc may not be the same.
 251  */
 252 #define CRYPTO_malloc_init()    CRYPTO_set_mem_functions(\
 253         malloc, realloc, free)
 254
 255 #if defined CRYPTO_MDEBUG_ALL || defined CRYPTO_MDEBUG_TIME || defined CRYPTO_MDEBUG_THREAD
 256 # ifndef CRYPTO_MDEBUG /* avoid duplicate #define */
 257 #  define CRYPTO_MDEBUG
 258 # endif
 259 #endif
 260
 261 /* Set standard debugging functions (not done by default
 262  * unless CRYPTO_MDEBUG is defined) */
 263 #define CRYPTO_malloc_debug_init()      do {\
 264         CRYPTO_set_mem_debug_functions(\
 265                 (void (*)())CRYPTO_dbg_malloc,\
 266                 (void (*)())CRYPTO_dbg_realloc,\
 267                 (void (*)())CRYPTO_dbg_free,\
 268                 (void (*)())CRYPTO_dbg_set_options,\
 269                 (long (*)())CRYPTO_dbg_get_options);\
 270         } while(0)
 271
 272 int CRYPTO_mem_ctrl(int mode);
 273 int CRYPTO_is_mem_check_on(void);
 274
 275 /* for applications */
 276 #define MemCheck_start() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON)
 277 #define MemCheck_stop() CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_OFF)
 278
 279 /* for library-internal use */
 280 #define MemCheck_on()   CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ENABLE)
 281 #define MemCheck_off()  CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_DISABLE)
 282 #define is_MemCheck_on() CRYPTO_is_mem_check_on()
 283
 284 #define Malloc(num)     CRYPTO_malloc((int)num,__FILE__,__LINE__)
 285 #define Realloc(addr,num) \
 286         CRYPTO_realloc((char *)addr,(int)num,__FILE__,__LINE__)
 287 #define Remalloc(addr,num) \
 288         CRYPTO_remalloc((char **)addr,(int)num,__FILE__,__LINE__)
 289 #define FreeFunc        CRYPTO_free
 290 #define Free(addr)      CRYPTO_free(addr)
 291
 292 #define Malloc_locked(num) CRYPTO_malloc_locked((int)num,__FILE__,__LINE__)
 293 #define Free_locked(addr) CRYPTO_free_locked(addr)
 294
 295
 296 /* Case insensiteve linking causes problems.... */
 297 #if defined(WIN16) || defined(VMS)
 298 #define ERR_load_CRYPTO_strings ERR_load_CRYPTOlib_strings
 299 #endif
 300
 301
 302 const char *SSLeay_version(int type);
 303 unsigned long SSLeay(void);
 304
 305 int CRYPTO_get_ex_new_index(int idx, STACK_OF(CRYPTO_EX_DATA_FUNCS) **skp, long argl, void *argp,
 306              CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
 307 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
 308 void *CRYPTO_get_ex_data(CRYPTO_EX_DATA *ad,int idx);
 309 int CRYPTO_dup_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, CRYPTO_EX_DATA *to,
 310              CRYPTO_EX_DATA *from);
 311 void CRYPTO_free_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
 312 void CRYPTO_new_ex_data(STACK_OF(CRYPTO_EX_DATA_FUNCS) *meth, void *obj, CRYPTO_EX_DATA *ad);
 313
 314 int CRYPTO_get_new_lockid(char *name);
 315
 316 int CRYPTO_num_locks(void); /* return CRYPTO_NUM_LOCKS (shared libs!) */
 317 void CRYPTO_lock(int mode, int type,const char *file,int line);
 318 void CRYPTO_set_locking_callback(void (*func)(int mode,int type,
 319                                               const char *file,int line));
 320 void (*CRYPTO_get_locking_callback(void))(int mode,int type,const char *file,
 321                 int line);
 322 void CRYPTO_set_add_lock_callback(int (*func)(int *num,int mount,int type,
 323                                               const char *file, int line));
 324 int (*CRYPTO_get_add_lock_callback(void))(int *num,int mount,int type,
 325                                           const char *file,int line);
 326 void CRYPTO_set_id_callback(unsigned long (*func)(void));
 327 unsigned long (*CRYPTO_get_id_callback(void))(void);
 328 unsigned long CRYPTO_thread_id(void);
 329 const char *CRYPTO_get_lock_name(int type);
 330 int CRYPTO_add_lock(int *pointer,int amount,int type, const char *file,
 331                     int line);
 332
 333 /* CRYPTO_set_mem_functions includes CRYPTO_set_locked_mem_functions --
 334  * call the latter last if you need different functions */
 335 int CRYPTO_set_mem_functions(void *(*m)(size_t),void *(*r)(void *,size_t), void (*f)(void *));
 336 int CRYPTO_set_locked_mem_functions(void *(*m)(size_t), void (*free_func)(void *));
 337 int CRYPTO_set_mem_debug_functions(void (*m)(void *,int,const char *,int,int),
 338                                    void (*r)(void *,void *,int,const char *,int,int),
 339                                    void (*f)(void *,int),
 340                                    void (*so)(long),
 341                                    long (*go)(void));
 342 void CRYPTO_get_mem_functions(void *(**m)(size_t),void *(**r)(void *, size_t), void (**f)(void *));
 343 void CRYPTO_get_locked_mem_functions(void *(**m)(size_t), 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 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 void CRYPTO_mem_leaks_cb(void (*cb)(unsigned long, const char *, int, int, void *));
 392
 393 void ERR_load_CRYPTO_strings(void);
 394
 395 /* BEGIN ERROR CODES */
 396 /* The following lines are auto generated by the script mkerr.pl. Any changes
 397  * made after this point may be overwritten when the script is next run.
 398  */
 399
 400 /* Error codes for the CRYPTO functions. */
 401
 402 /* Function codes. */
 403 #define CRYPTO_F_CRYPTO_GET_EX_NEW_INDEX                 100
 404 #define CRYPTO_F_CRYPTO_GET_NEW_LOCKID                   101
 405 #define CRYPTO_F_CRYPTO_SET_EX_DATA                      102
 406
 407 /* Reason codes. */
 408
 409 #ifdef  __cplusplus
 410 }
 411 #endif
 412 #endif