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