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