include/openssl/crypto.h

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright (c) 2002, Oracle and/or its affiliates. All rights reserved
   4  *
   5  * Licensed under the OpenSSL license (the "License").  You may not use
   6  * this file except in compliance with the License.  You can obtain a copy
   7  * in the file LICENSE in the source distribution or at
   8  * https://www.openssl.org/source/license.html
   9  */
  10
  11 #ifndef HEADER_CRYPTO_H
  12 # define HEADER_CRYPTO_H
  13
  14 # include <stdlib.h>
  15 # include <time.h>
  16
  17 # include <openssl/e_os2.h>
  18
  19 # ifndef OPENSSL_NO_STDIO
  20 #  include <stdio.h>
  21 # endif
  22
  23 # include <openssl/stack.h>
  24 # include <openssl/safestack.h>
  25 # include <openssl/opensslv.h>
  26 # include <openssl/ossl_typ.h>
  27 # include <openssl/opensslconf.h>
  28 # include <openssl/cryptoerr.h>
  29
  30 # ifdef CHARSET_EBCDIC
  31 #  include <openssl/ebcdic.h>
  32 # endif
  33
  34 /*
  35  * Resolve problems on some operating systems with symbol names that clash
  36  * one way or another
  37  */
  38 # include <openssl/symhacks.h>
  39
  40 # if OPENSSL_API_COMPAT < 0x10100000L
  41 #  include <openssl/opensslv.h>
  42 # endif
  43
  44 #ifdef  __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 # if OPENSSL_API_COMPAT < 0x10100000L
  49 #  define SSLeay                  OpenSSL_version_num
  50 #  define SSLeay_version          OpenSSL_version
  51 #  define SSLEAY_VERSION_NUMBER   OPENSSL_VERSION_NUMBER
  52 #  define SSLEAY_VERSION          OPENSSL_VERSION
  53 #  define SSLEAY_CFLAGS           OPENSSL_CFLAGS
  54 #  define SSLEAY_BUILT_ON         OPENSSL_BUILT_ON
  55 #  define SSLEAY_PLATFORM         OPENSSL_PLATFORM
  56 #  define SSLEAY_DIR              OPENSSL_DIR
  57
  58 /*
  59  * Old type for allocating dynamic locks. No longer used. Use the new thread
  60  * API instead.
  61  */
  62 typedef struct {
  63     int dummy;
  64 } CRYPTO_dynlock;
  65
  66 # endif /* OPENSSL_API_COMPAT */
  67
  68 typedef void CRYPTO_RWLOCK;
  69
  70 CRYPTO_RWLOCK *CRYPTO_THREAD_lock_new(void);
  71 int CRYPTO_THREAD_read_lock(CRYPTO_RWLOCK *lock);
  72 int CRYPTO_THREAD_write_lock(CRYPTO_RWLOCK *lock);
  73 int CRYPTO_THREAD_unlock(CRYPTO_RWLOCK *lock);
  74 void CRYPTO_THREAD_lock_free(CRYPTO_RWLOCK *lock);
  75
  76 int CRYPTO_atomic_add(int *val, int amount, int *ret, CRYPTO_RWLOCK *lock);
  77
  78 /*
  79  * The following can be used to detect memory leaks in the library. If
  80  * used, it turns on malloc checking
  81  */
  82 # define CRYPTO_MEM_CHECK_OFF     0x0   /* Control only */
  83 # define CRYPTO_MEM_CHECK_ON      0x1   /* Control and mode bit */
  84 # define CRYPTO_MEM_CHECK_ENABLE  0x2   /* Control and mode bit */
  85 # define CRYPTO_MEM_CHECK_DISABLE 0x3   /* Control only */
  86
  87 struct crypto_ex_data_st {
  88     STACK_OF(void) *sk;
  89 };
  90 DEFINE_STACK_OF(void)
  91
  92 /*
  93  * Per class, we have a STACK of function pointers.
  94  */
  95 # define CRYPTO_EX_INDEX_SSL              0
  96 # define CRYPTO_EX_INDEX_SSL_CTX          1
  97 # define CRYPTO_EX_INDEX_SSL_SESSION      2
  98 # define CRYPTO_EX_INDEX_X509             3
  99 # define CRYPTO_EX_INDEX_X509_STORE       4
 100 # define CRYPTO_EX_INDEX_X509_STORE_CTX   5
 101 # define CRYPTO_EX_INDEX_DH               6
 102 # define CRYPTO_EX_INDEX_DSA              7
 103 # define CRYPTO_EX_INDEX_EC_KEY           8
 104 # define CRYPTO_EX_INDEX_RSA              9
 105 # define CRYPTO_EX_INDEX_ENGINE          10
 106 # define CRYPTO_EX_INDEX_UI              11
 107 # define CRYPTO_EX_INDEX_BIO             12
 108 # define CRYPTO_EX_INDEX_APP             13
 109 # define CRYPTO_EX_INDEX_UI_METHOD       14
 110 # define CRYPTO_EX_INDEX__COUNT          15
 111
 112 /*
 113  * This is the default callbacks, but we can have others as well: this is
 114  * needed in Win32 where the application malloc and the library malloc may
 115  * not be the same.
 116  */
 117 #define OPENSSL_malloc_init() \
 118     CRYPTO_set_mem_functions(CRYPTO_malloc, CRYPTO_realloc, CRYPTO_free)
 119
 120 int CRYPTO_mem_ctrl(int mode);
 121
 122 # define OPENSSL_malloc(num) \
 123         CRYPTO_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
 124 # define OPENSSL_zalloc(num) \
 125         CRYPTO_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
 126 # define OPENSSL_realloc(addr, num) \
 127         CRYPTO_realloc(addr, num, OPENSSL_FILE, OPENSSL_LINE)
 128 # define OPENSSL_clear_realloc(addr, old_num, num) \
 129         CRYPTO_clear_realloc(addr, old_num, num, OPENSSL_FILE, OPENSSL_LINE)
 130 # define OPENSSL_clear_free(addr, num) \
 131         CRYPTO_clear_free(addr, num, OPENSSL_FILE, OPENSSL_LINE)
 132 # define OPENSSL_free(addr) \
 133         CRYPTO_free(addr, OPENSSL_FILE, OPENSSL_LINE)
 134 # define OPENSSL_memdup(str, s) \
 135         CRYPTO_memdup((str), s, OPENSSL_FILE, OPENSSL_LINE)
 136 # define OPENSSL_strdup(str) \
 137         CRYPTO_strdup(str, OPENSSL_FILE, OPENSSL_LINE)
 138 # define OPENSSL_strndup(str, n) \
 139         CRYPTO_strndup(str, n, OPENSSL_FILE, OPENSSL_LINE)
 140 # define OPENSSL_secure_malloc(num) \
 141         CRYPTO_secure_malloc(num, OPENSSL_FILE, OPENSSL_LINE)
 142 # define OPENSSL_secure_zalloc(num) \
 143         CRYPTO_secure_zalloc(num, OPENSSL_FILE, OPENSSL_LINE)
 144 # define OPENSSL_secure_free(addr) \
 145         CRYPTO_secure_free(addr, OPENSSL_FILE, OPENSSL_LINE)
 146 # define OPENSSL_secure_actual_size(ptr) \
 147         CRYPTO_secure_actual_size(ptr)
 148
 149 size_t OPENSSL_strlcpy(char *dst, const char *src, size_t siz);
 150 size_t OPENSSL_strlcat(char *dst, const char *src, size_t siz);
 151 size_t OPENSSL_strnlen(const char *str, size_t maxlen);
 152 char *OPENSSL_buf2hexstr(const unsigned char *buffer, long len);
 153 unsigned char *OPENSSL_hexstr2buf(const char *str, long *len);
 154 int OPENSSL_hexchar2int(unsigned char c);
 155
 156 # define OPENSSL_MALLOC_MAX_NELEMS(type)  (((1U<<(sizeof(int)*8-1))-1)/sizeof(type))
 157
 158 unsigned long OpenSSL_version_num(void);
 159 const char *OpenSSL_version(int type);
 160 # define OPENSSL_VERSION          0
 161 # define OPENSSL_CFLAGS           1
 162 # define OPENSSL_BUILT_ON         2
 163 # define OPENSSL_PLATFORM         3
 164 # define OPENSSL_DIR              4
 165 # define OPENSSL_ENGINES_DIR      5
 166
 167 int OPENSSL_issetugid(void);
 168
 169 typedef void CRYPTO_EX_new (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
 170                            int idx, long argl, void *argp);
 171 typedef void CRYPTO_EX_free (void *parent, void *ptr, CRYPTO_EX_DATA *ad,
 172                              int idx, long argl, void *argp);
 173 typedef int CRYPTO_EX_dup (CRYPTO_EX_DATA *to, const CRYPTO_EX_DATA *from,
 174                            void *from_d, int idx, long argl, void *argp);
 175 __owur int CRYPTO_get_ex_new_index(int class_index, long argl, void *argp,
 176                             CRYPTO_EX_new *new_func, CRYPTO_EX_dup *dup_func,
 177                             CRYPTO_EX_free *free_func);
 178 /* No longer use an index. */
 179 int CRYPTO_free_ex_index(int class_index, int idx);
 180
 181 /*
 182  * Initialise/duplicate/free CRYPTO_EX_DATA variables corresponding to a
 183  * given class (invokes whatever per-class callbacks are applicable)
 184  */
 185 int CRYPTO_new_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
 186 int CRYPTO_dup_ex_data(int class_index, CRYPTO_EX_DATA *to,
 187                        const CRYPTO_EX_DATA *from);
 188
 189 void CRYPTO_free_ex_data(int class_index, void *obj, CRYPTO_EX_DATA *ad);
 190
 191 /*
 192  * Get/set data in a CRYPTO_EX_DATA variable corresponding to a particular
 193  * index (relative to the class type involved)
 194  */
 195 int CRYPTO_set_ex_data(CRYPTO_EX_DATA *ad, int idx, void *val);
 196 void *CRYPTO_get_ex_data(const CRYPTO_EX_DATA *ad, int idx);
 197
 198 # if OPENSSL_API_COMPAT < 0x10100000L
 199 /*
 200  * This function cleans up all "ex_data" state. It mustn't be called under
 201  * potential race-conditions.
 202  */
 203 # define CRYPTO_cleanup_all_ex_data() while(0) continue
 204
 205 /*
 206  * The old locking functions have been removed completely without compatibility
 207  * macros. This is because the old functions either could not properly report
 208  * errors, or the returned error values were not clearly documented.
 209  * Replacing the locking functions with with no-ops would cause race condition
 210  * issues in the affected applications. It is far better for them to fail at
 211  * compile time.
 212  * On the other hand, the locking callbacks are no longer used.  Consequently,
 213  * the callback management functions can be safely replaced with no-op macros.
 214  */
 215 #  define CRYPTO_num_locks()            (1)
 216 #  define CRYPTO_set_locking_callback(func)
 217 #  define CRYPTO_get_locking_callback()         (NULL)
 218 #  define CRYPTO_set_add_lock_callback(func)
 219 #  define CRYPTO_get_add_lock_callback()        (NULL)
 220
 221 /*
 222  * These defines where used in combination with the old locking callbacks,
 223  * they are not called anymore, but old code that's not called might still
 224  * use them.
 225  */
 226 #  define CRYPTO_LOCK             1
 227 #  define CRYPTO_UNLOCK           2
 228 #  define CRYPTO_READ             4
 229 #  define CRYPTO_WRITE            8
 230
 231 /* This structure is no longer used */
 232 typedef struct crypto_threadid_st {
 233     int dummy;
 234 } CRYPTO_THREADID;
 235 /* Only use CRYPTO_THREADID_set_[numeric|pointer]() within callbacks */
 236 #  define CRYPTO_THREADID_set_numeric(id, val)
 237 #  define CRYPTO_THREADID_set_pointer(id, ptr)
 238 #  define CRYPTO_THREADID_set_callback(threadid_func)   (0)
 239 #  define CRYPTO_THREADID_get_callback()                (NULL)
 240 #  define CRYPTO_THREADID_current(id)
 241 #  define CRYPTO_THREADID_cmp(a, b)                     (-1)
 242 #  define CRYPTO_THREADID_cpy(dest, src)
 243 #  define CRYPTO_THREADID_hash(id)                      (0UL)
 244
 245 #  if OPENSSL_API_COMPAT < 0x10000000L
 246 #   define CRYPTO_set_id_callback(func)
 247 #   define CRYPTO_get_id_callback()                     (NULL)
 248 #   define CRYPTO_thread_id()                           (0UL)
 249 #  endif /* OPENSSL_API_COMPAT < 0x10000000L */
 250
 251 #  define CRYPTO_set_dynlock_create_callback(dyn_create_function)
 252 #  define CRYPTO_set_dynlock_lock_callback(dyn_lock_function)
 253 #  define CRYPTO_set_dynlock_destroy_callback(dyn_destroy_function)
 254 #  define CRYPTO_get_dynlock_create_callback()          (NULL)
 255 #  define CRYPTO_get_dynlock_lock_callback()            (NULL)
 256 #  define CRYPTO_get_dynlock_destroy_callback()         (NULL)
 257 # endif /* OPENSSL_API_COMPAT < 0x10100000L */
 258
 259 int CRYPTO_set_mem_functions(
 260         void *(*m) (size_t, const char *, int),
 261         void *(*r) (void *, size_t, const char *, int),
 262         void (*f) (void *, const char *, int));
 263 int CRYPTO_set_mem_debug(int flag);
 264 void CRYPTO_get_mem_functions(
 265         void *(**m) (size_t, const char *, int),
 266         void *(**r) (void *, size_t, const char *, int),
 267         void (**f) (void *, const char *, int));
 268
 269 void *CRYPTO_malloc(size_t num, const char *file, int line);
 270 void *CRYPTO_zalloc(size_t num, const char *file, int line);
 271 void *CRYPTO_memdup(const void *str, size_t siz, const char *file, int line);
 272 char *CRYPTO_strdup(const char *str, const char *file, int line);
 273 char *CRYPTO_strndup(const char *str, size_t s, const char *file, int line);
 274 void CRYPTO_free(void *ptr, const char *file, int line);
 275 void CRYPTO_clear_free(void *ptr, size_t num, const char *file, int line);
 276 void *CRYPTO_realloc(void *addr, size_t num, const char *file, int line);
 277 void *CRYPTO_clear_realloc(void *addr, size_t old_num, size_t num,
 278                            const char *file, int line);
 279
 280 int CRYPTO_secure_malloc_init(size_t sz, int minsize);
 281 int CRYPTO_secure_malloc_done(void);
 282 void *CRYPTO_secure_malloc(size_t num, const char *file, int line);
 283 void *CRYPTO_secure_zalloc(size_t num, const char *file, int line);
 284 void CRYPTO_secure_free(void *ptr, const char *file, int line);
 285 int CRYPTO_secure_allocated(const void *ptr);
 286 int CRYPTO_secure_malloc_initialized(void);
 287 size_t CRYPTO_secure_actual_size(void *ptr);
 288 size_t CRYPTO_secure_used(void);
 289
 290 void OPENSSL_cleanse(void *ptr, size_t len);
 291
 292 # ifndef OPENSSL_NO_CRYPTO_MDEBUG
 293 #  define OPENSSL_mem_debug_push(info) \
 294         CRYPTO_mem_debug_push(info, OPENSSL_FILE, OPENSSL_LINE)
 295 #  define OPENSSL_mem_debug_pop() \
 296         CRYPTO_mem_debug_pop()
 297 int CRYPTO_mem_debug_push(const char *info, const char *file, int line);
 298 int CRYPTO_mem_debug_pop(void);
 299
 300 /*-
 301  * Debugging functions (enabled by CRYPTO_set_mem_debug(1))
 302  * The flag argument has the following significance:
 303  *   0:   called before the actual memory allocation has taken place
 304  *   1:   called after the actual memory allocation has taken place
 305  */
 306 void CRYPTO_mem_debug_malloc(void *addr, size_t num, int flag,
 307         const char *file, int line);
 308 void CRYPTO_mem_debug_realloc(void *addr1, void *addr2, size_t num, int flag,
 309         const char *file, int line);
 310 void CRYPTO_mem_debug_free(void *addr, int flag,
 311         const char *file, int line);
 312
 313 int CRYPTO_mem_leaks_cb(int (*cb) (const char *str, size_t len, void *u),
 314                         void *u);
 315 #  ifndef OPENSSL_NO_STDIO
 316 int CRYPTO_mem_leaks_fp(FILE *);
 317 #  endif
 318 int CRYPTO_mem_leaks(BIO *bio);
 319 # endif
 320
 321 /* die if we have to */
 322 ossl_noreturn void OPENSSL_die(const char *assertion, const char *file, int line);
 323 # if OPENSSL_API_COMPAT < 0x10100000L
 324 #  define OpenSSLDie(f,l,a) OPENSSL_die((a),(f),(l))
 325 # endif
 326 # define OPENSSL_assert(e) \
 327     (void)((e) ? 0 : (OPENSSL_die("assertion failed: " #e, OPENSSL_FILE, OPENSSL_LINE), 1))
 328
 329 int OPENSSL_isservice(void);
 330
 331 int FIPS_mode(void);
 332 int FIPS_mode_set(int r);
 333
 334 void OPENSSL_init(void);
 335
 336 struct tm *OPENSSL_gmtime(const time_t *timer, struct tm *result);
 337 int OPENSSL_gmtime_adj(struct tm *tm, int offset_day, long offset_sec);
 338 int OPENSSL_gmtime_diff(int *pday, int *psec,
 339                         const struct tm *from, const struct tm *to);
 340
 341 /*
 342  * CRYPTO_memcmp returns zero iff the |len| bytes at |a| and |b| are equal.
 343  * It takes an amount of time dependent on |len|, but independent of the
 344  * contents of |a| and |b|. Unlike memcmp, it cannot be used to put elements
 345  * into a defined order as the return value when a != b is undefined, other
 346  * than to be non-zero.
 347  */
 348 int CRYPTO_memcmp(const void * in_a, const void * in_b, size_t len);
 349
 350 /* Standard initialisation options */
 351 # define OPENSSL_INIT_NO_LOAD_CRYPTO_STRINGS 0x00000001L
 352 # define OPENSSL_INIT_LOAD_CRYPTO_STRINGS    0x00000002L
 353 # define OPENSSL_INIT_ADD_ALL_CIPHERS        0x00000004L
 354 # define OPENSSL_INIT_ADD_ALL_DIGESTS        0x00000008L
 355 # define OPENSSL_INIT_NO_ADD_ALL_CIPHERS     0x00000010L
 356 # define OPENSSL_INIT_NO_ADD_ALL_DIGESTS     0x00000020L
 357 # define OPENSSL_INIT_LOAD_CONFIG            0x00000040L
 358 # define OPENSSL_INIT_NO_LOAD_CONFIG         0x00000080L
 359 # define OPENSSL_INIT_ASYNC                  0x00000100L
 360 # define OPENSSL_INIT_ENGINE_RDRAND          0x00000200L
 361 # define OPENSSL_INIT_ENGINE_DYNAMIC         0x00000400L
 362 # define OPENSSL_INIT_ENGINE_OPENSSL         0x00000800L
 363 # define OPENSSL_INIT_ENGINE_CRYPTODEV       0x00001000L
 364 # define OPENSSL_INIT_ENGINE_CAPI            0x00002000L
 365 # define OPENSSL_INIT_ENGINE_PADLOCK         0x00004000L
 366 # define OPENSSL_INIT_ENGINE_AFALG           0x00008000L
 367 /* OPENSSL_INIT flag 0x00010000 reserved for internal use */
 368 /* OPENSSL_INIT flag range 0xfff00000 reserved for OPENSSL_init_ssl() */
 369 /* Max OPENSSL_INIT flag value is 0x80000000 */
 370
 371 /* openssl and dasync not counted as builtin */
 372 # define OPENSSL_INIT_ENGINE_ALL_BUILTIN \
 373     (OPENSSL_INIT_ENGINE_RDRAND | OPENSSL_INIT_ENGINE_DYNAMIC \
 374     | OPENSSL_INIT_ENGINE_CRYPTODEV | OPENSSL_INIT_ENGINE_CAPI | \
 375     OPENSSL_INIT_ENGINE_PADLOCK)
 376
 377
 378 /* Library initialisation functions */
 379 void OPENSSL_cleanup(void);
 380 int OPENSSL_init_crypto(uint64_t opts, const OPENSSL_INIT_SETTINGS *settings);
 381 int OPENSSL_atexit(void (*handler)(void));
 382 void OPENSSL_thread_stop(void);
 383
 384 /* Low-level control of initialization */
 385 OPENSSL_INIT_SETTINGS *OPENSSL_INIT_new(void);
 386 # ifndef OPENSSL_NO_STDIO
 387 int OPENSSL_INIT_set_config_appname(OPENSSL_INIT_SETTINGS *settings,
 388                                     const char *config_file);
 389 # endif
 390 void OPENSSL_INIT_free(OPENSSL_INIT_SETTINGS *settings);
 391
 392 # if defined(OPENSSL_THREADS) && !defined(CRYPTO_TDEBUG)
 393 #  if defined(_WIN32)
 394 #   if defined(BASETYPES) || defined(_WINDEF_H)
 395 /* application has to include <windows.h> in order to use this */
 396 typedef DWORD CRYPTO_THREAD_LOCAL;
 397 typedef DWORD CRYPTO_THREAD_ID;
 398
 399 typedef LONG CRYPTO_ONCE;
 400 #    define CRYPTO_ONCE_STATIC_INIT 0
 401 #   endif
 402 #  else
 403 #   include <pthread.h>
 404 typedef pthread_once_t CRYPTO_ONCE;
 405 typedef pthread_key_t CRYPTO_THREAD_LOCAL;
 406 typedef pthread_t CRYPTO_THREAD_ID;
 407
 408 #   define CRYPTO_ONCE_STATIC_INIT PTHREAD_ONCE_INIT
 409 #  endif
 410 # endif
 411
 412 # if !defined(CRYPTO_ONCE_STATIC_INIT)
 413 typedef unsigned int CRYPTO_ONCE;
 414 typedef unsigned int CRYPTO_THREAD_LOCAL;
 415 typedef unsigned int CRYPTO_THREAD_ID;
 416 #  define CRYPTO_ONCE_STATIC_INIT 0
 417 # endif
 418
 419 int CRYPTO_THREAD_run_once(CRYPTO_ONCE *once, void (*init)(void));
 420
 421 int CRYPTO_THREAD_init_local(CRYPTO_THREAD_LOCAL *key, void (*cleanup)(void *));
 422 void *CRYPTO_THREAD_get_local(CRYPTO_THREAD_LOCAL *key);
 423 int CRYPTO_THREAD_set_local(CRYPTO_THREAD_LOCAL *key, void *val);
 424 int CRYPTO_THREAD_cleanup_local(CRYPTO_THREAD_LOCAL *key);
 425
 426 CRYPTO_THREAD_ID CRYPTO_THREAD_get_current_id(void);
 427 int CRYPTO_THREAD_compare_id(CRYPTO_THREAD_ID a, CRYPTO_THREAD_ID b);
 428
 429 int ERR_load_CRYPTO_strings(void);
 430
 431 # ifdef  __cplusplus
 432 }
 433 # endif
 434 #endif