2 * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
4 * Licensed under the Apache License 2.0 (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
10 #ifndef OSSL_INTERNAL_CRYPTLIB_H
11 # define OSSL_INTERNAL_CRYPTLIB_H
17 # ifdef OPENSSL_USE_APPLINK
18 # define BIO_FLAGS_UPLINK_INTERNAL 0x8000
19 # include "ms/uplink.h"
21 # define BIO_FLAGS_UPLINK_INTERNAL 0
24 # include <openssl/crypto.h>
25 # include <openssl/buffer.h>
26 # include <openssl/bio.h>
27 # include <openssl/asn1.h>
28 # include <openssl/err.h>
29 # include "internal/nelem.h"
32 # define ossl_assert(x) ((x) != 0)
34 __owur static ossl_inline int ossl_assert_int(int expr, const char *exprstr,
35 const char *file, int line)
38 OPENSSL_die(exprstr, file, line);
43 # define ossl_assert(x) ossl_assert_int((x) != 0, "Assertion failed: "#x, \
49 * Use this inside a union with the field that needs to be aligned to a
50 * reasonable boundary for the platform. The most pessimistic alignment
51 * of the listed types will be used by the compiler.
53 # define OSSL_UNION_ALIGN \
55 ossl_uintmax_t align_int; \
58 typedef struct ex_callback_st EX_CALLBACK;
59 DEFINE_STACK_OF(EX_CALLBACK)
61 typedef struct mem_st MEM;
64 # define OPENSSL_CONF "openssl.cnf"
66 # ifndef OPENSSL_SYS_VMS
67 # define X509_CERT_AREA OPENSSLDIR
68 # define X509_CERT_DIR OPENSSLDIR "/certs"
69 # define X509_CERT_FILE OPENSSLDIR "/cert.pem"
70 # define X509_PRIVATE_DIR OPENSSLDIR "/private"
71 # define CTLOG_FILE OPENSSLDIR "/ct_log_list.cnf"
73 # define X509_CERT_AREA "OSSL$DATAROOT:[000000]"
74 # define X509_CERT_DIR "OSSL$DATAROOT:[CERTS]"
75 # define X509_CERT_FILE "OSSL$DATAROOT:[000000]cert.pem"
76 # define X509_PRIVATE_DIR "OSSL$DATAROOT:[PRIVATE]"
77 # define CTLOG_FILE "OSSL$DATAROOT:[000000]ct_log_list.cnf"
80 # define X509_CERT_DIR_EVP "SSL_CERT_DIR"
81 # define X509_CERT_FILE_EVP "SSL_CERT_FILE"
82 # define CTLOG_FILE_EVP "CTLOG_FILE"
84 /* size of string representations */
85 # define DECIMAL_SIZE(type) ((sizeof(type)*8+2)/3+1)
86 # define HEX_SIZE(type) (sizeof(type)*2)
88 void OPENSSL_cpuid_setup(void);
89 #if defined(__i386) || defined(__i386__) || defined(_M_IX86) || \
90 defined(__x86_64) || defined(__x86_64__) || \
91 defined(_M_AMD64) || defined(_M_X64)
92 extern unsigned int OPENSSL_ia32cap_P[];
94 void OPENSSL_showfatal(const char *fmta, ...);
95 int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx);
96 void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx);
97 int openssl_init_fork_handlers(void);
98 int openssl_get_fork_id(void);
100 char *ossl_safe_getenv(const char *name);
102 extern CRYPTO_RWLOCK *memdbg_lock;
103 int openssl_strerror_r(int errnum, char *buf, size_t buflen);
104 # if !defined(OPENSSL_NO_STDIO)
105 FILE *openssl_fopen(const char *filename, const char *mode);
107 void *openssl_fopen(const char *filename, const char *mode);
110 uint32_t OPENSSL_rdtsc(void);
111 size_t OPENSSL_instrument_bus(unsigned int *, size_t);
112 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
114 /* ex_data structures */
117 * Each structure type (sometimes called a class), that supports
118 * exdata has a stack of callbacks for each instance.
120 struct ex_callback_st {
121 long argl; /* Arbitrary long */
122 void *argp; /* Arbitrary void * */
123 CRYPTO_EX_new *new_func;
124 CRYPTO_EX_free *free_func;
125 CRYPTO_EX_dup *dup_func;
129 * The state for each class. This could just be a typedef, but
130 * a structure allows future changes.
132 typedef struct ex_callbacks_st {
133 STACK_OF(EX_CALLBACK) *meth;
136 typedef struct ossl_ex_data_global_st {
137 CRYPTO_RWLOCK *ex_data_lock;
138 EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
139 } OSSL_EX_DATA_GLOBAL;
144 # define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0
145 # define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1
146 # define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX 2
147 # define OSSL_LIB_CTX_MAX_RUN_ONCE 3
149 # define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX 0
150 # define OSSL_LIB_CTX_PROVIDER_STORE_INDEX 1
151 # define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX 2
152 # define OSSL_LIB_CTX_PROPERTY_STRING_INDEX 3
153 # define OSSL_LIB_CTX_NAMEMAP_INDEX 4
154 # define OSSL_LIB_CTX_DRBG_INDEX 5
155 # define OSSL_LIB_CTX_DRBG_NONCE_INDEX 6
156 # define OSSL_LIB_CTX_RAND_CRNGT_INDEX 7
157 # define OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX 8
158 # define OSSL_LIB_CTX_FIPS_PROV_INDEX 9
159 # define OSSL_LIB_CTX_ENCODER_STORE_INDEX 10
160 # define OSSL_LIB_CTX_DECODER_STORE_INDEX 11
161 # define OSSL_LIB_CTX_SELF_TEST_CB_INDEX 12
162 # define OSSL_LIB_CTX_BIO_PROV_INDEX 13
163 # define OSSL_LIB_CTX_GLOBAL_PROPERTIES 14
164 # define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX 15
165 # define OSSL_LIB_CTX_PROVIDER_CONF_INDEX 16
166 # define OSSL_LIB_CTX_MAX_INDEXES 17
168 typedef struct ossl_lib_ctx_method {
169 void *(*new_func)(OSSL_LIB_CTX *ctx);
170 void (*free_func)(void *);
171 } OSSL_LIB_CTX_METHOD;
173 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx);
174 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
175 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);
177 /* Functions to retrieve pointers to data by index */
178 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */,
179 const OSSL_LIB_CTX_METHOD * ctx);
181 void ossl_lib_ctx_default_deinit(void);
182 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx);
183 typedef int (ossl_lib_ctx_run_once_fn)(OSSL_LIB_CTX *ctx);
184 typedef void (ossl_lib_ctx_onfree_fn)(OSSL_LIB_CTX *ctx);
186 int ossl_lib_ctx_run_once(OSSL_LIB_CTX *ctx, unsigned int idx,
187 ossl_lib_ctx_run_once_fn run_once_fn);
188 int ossl_lib_ctx_onfree(OSSL_LIB_CTX *ctx, ossl_lib_ctx_onfree_fn onfreefn);
189 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx);
191 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad);
192 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
194 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
195 long argl, void *argp,
196 CRYPTO_EX_new *new_func,
197 CRYPTO_EX_dup *dup_func,
198 CRYPTO_EX_free *free_func);
199 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);
201 /* Function for simple binary search */
204 # define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01
205 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02
207 const void *ossl_bsearch(const void *key, const void *base, int num,
208 int size, int (*cmp) (const void *, const void *),
211 /* system-specific variants defining ossl_sleep() */
212 #ifdef OPENSSL_SYS_UNIX
214 static ossl_inline void ossl_sleep(unsigned long millis)
216 # ifdef OPENSSL_SYS_VXWORKS
218 ts.tv_sec = (long int) (millis / 1000);
219 ts.tv_nsec = (long int) (millis % 1000) * 1000000ul;
220 nanosleep(&ts, NULL);
221 # elif defined(__TANDEM)
222 # if !defined(_REENTRANT)
223 # include <cextdecs.h(PROCESS_DELAY_)>
224 /* HPNS does not support usleep for non threaded apps */
225 PROCESS_DELAY_(millis * 1000);
226 # elif defined(_SPT_MODEL_)
227 # include <spthread.h>
228 # include <spt_extensions.h>
229 usleep(millis * 1000);
231 usleep(millis * 1000);
234 usleep(millis * 1000);
237 #elif defined(_WIN32)
238 # include <windows.h>
239 static ossl_inline void ossl_sleep(unsigned long millis)
244 /* Fallback to a busy wait */
245 static ossl_inline void ossl_sleep(unsigned long millis)
247 struct timeval start, now;
248 unsigned long elapsedms;
250 gettimeofday(&start, NULL);
252 gettimeofday(&now, NULL);
253 elapsedms = (((now.tv_sec - start.tv_sec) * 1000000)
254 + now.tv_usec - start.tv_usec) / 1000;
255 } while (elapsedms < millis);
257 #endif /* defined OPENSSL_SYS_UNIX */
259 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
260 const char *sep, size_t max_len);
261 char *ossl_ipaddr_to_asc(unsigned char *p, int len);
263 char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep);
264 unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen,
267 static ossl_inline int ossl_ends_with_dirsep(const char *path)
270 path += strlen(path) - 1;
272 if (*path == ']' || *path == '>' || *path == ':')
274 # elif defined _WIN32
281 static ossl_inline int ossl_is_absolute_path(const char *path)
284 if (strchr(path, ':') != NULL
285 || ((path[0] == '[' || path[0] == '<')
286 && path[1] != '.' && path[1] != '-'
287 && path[1] != ']' && path[1] != '>'))
289 # elif defined _WIN32
291 || (path[0] != '\0' && path[1] == ':'))
294 return path[0] == '/';