2 * Copyright 1995-2019 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 HEADER_CRYPTLIB_H
11 # define HEADER_CRYPTLIB_H
16 # ifdef OPENSSL_USE_APPLINK
17 # define BIO_FLAGS_UPLINK_INTERNAL 0x8000
18 # include "ms/uplink.h"
20 # define BIO_FLAGS_UPLINK_INTERNAL 0
23 # include <openssl/crypto.h>
24 # include <openssl/buffer.h>
25 # include <openssl/bio.h>
26 # include <openssl/err.h>
27 # include "internal/nelem.h"
30 # define ossl_assert(x) ((x) != 0)
32 __owur static ossl_inline int ossl_assert_int(int expr, const char *exprstr,
33 const char *file, int line)
36 OPENSSL_die(exprstr, file, line);
41 # define ossl_assert(x) ossl_assert_int((x) != 0, "Assertion failed: "#x, \
47 * Use this inside a union with the field that needs to be aligned to a
48 * reasonable boundary for the platform. The most pessimistic alignment
49 * of the listed types will be used by the compiler.
51 # define OSSL_UNION_ALIGN \
53 ossl_uintmax_t align_int; \
56 typedef struct ex_callback_st EX_CALLBACK;
57 DEFINE_STACK_OF(EX_CALLBACK)
59 typedef struct mem_st MEM;
62 # define OPENSSL_CONF "openssl.cnf"
64 # ifndef OPENSSL_SYS_VMS
65 # define X509_CERT_AREA OPENSSLDIR
66 # define X509_CERT_DIR OPENSSLDIR "/certs"
67 # define X509_CERT_FILE OPENSSLDIR "/cert.pem"
68 # define X509_PRIVATE_DIR OPENSSLDIR "/private"
69 # define CTLOG_FILE OPENSSLDIR "/ct_log_list.cnf"
71 # define X509_CERT_AREA "OSSL$DATAROOT:[000000]"
72 # define X509_CERT_DIR "OSSL$DATAROOT:[CERTS]"
73 # define X509_CERT_FILE "OSSL$DATAROOT:[000000]cert.pem"
74 # define X509_PRIVATE_DIR "OSSL$DATAROOT:[PRIVATE]"
75 # define CTLOG_FILE "OSSL$DATAROOT:[000000]ct_log_list.cnf"
78 # define X509_CERT_DIR_EVP "SSL_CERT_DIR"
79 # define X509_CERT_FILE_EVP "SSL_CERT_FILE"
80 # define CTLOG_FILE_EVP "CTLOG_FILE"
82 /* size of string representations */
83 # define DECIMAL_SIZE(type) ((sizeof(type)*8+2)/3+1)
84 # define HEX_SIZE(type) (sizeof(type)*2)
86 void OPENSSL_cpuid_setup(void);
87 #if defined(__i386) || defined(__i386__) || defined(_M_IX86) || \
88 defined(__x86_64) || defined(__x86_64__) || \
89 defined(_M_AMD64) || defined(_M_X64)
90 extern unsigned int OPENSSL_ia32cap_P[];
92 void OPENSSL_showfatal(const char *fmta, ...);
93 int do_ex_data_init(OPENSSL_CTX *ctx);
94 void crypto_cleanup_all_ex_data_int(OPENSSL_CTX *ctx);
95 int openssl_init_fork_handlers(void);
97 char *ossl_safe_getenv(const char *name);
99 extern CRYPTO_RWLOCK *memdbg_lock;
100 int openssl_strerror_r(int errnum, char *buf, size_t buflen);
101 # if !defined(OPENSSL_NO_STDIO)
102 FILE *openssl_fopen(const char *filename, const char *mode);
104 void *openssl_fopen(const char *filename, const char *mode);
107 uint32_t OPENSSL_rdtsc(void);
108 size_t OPENSSL_instrument_bus(unsigned int *, size_t);
109 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
111 /* ex_data structures */
114 * Each structure type (sometimes called a class), that supports
115 * exdata has a stack of callbacks for each instance.
117 struct ex_callback_st {
118 long argl; /* Arbitrary long */
119 void *argp; /* Arbitrary void * */
120 CRYPTO_EX_new *new_func;
121 CRYPTO_EX_free *free_func;
122 CRYPTO_EX_dup *dup_func;
126 * The state for each class. This could just be a typedef, but
127 * a structure allows future changes.
129 typedef struct ex_callbacks_st {
130 STACK_OF(EX_CALLBACK) *meth;
133 typedef struct ossl_ex_data_global_st {
134 CRYPTO_RWLOCK *ex_data_lock;
135 EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
136 } OSSL_EX_DATA_GLOBAL;
141 # define OPENSSL_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0
142 # define OPENSSL_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1
143 # define OPENSSL_CTX_METHOD_STORE_RUN_ONCE_INDEX 2
144 # define OPENSSL_CTX_MAX_RUN_ONCE 3
146 # define OPENSSL_CTX_DEFAULT_METHOD_STORE_INDEX 0
147 # define OPENSSL_CTX_PROVIDER_STORE_INDEX 1
148 # define OPENSSL_CTX_PROPERTY_DEFN_INDEX 2
149 # define OPENSSL_CTX_PROPERTY_STRING_INDEX 3
150 # define OPENSSL_CTX_NAMEMAP_INDEX 4
151 # define OPENSSL_CTX_DRBG_INDEX 5
152 # define OPENSSL_CTX_DRBG_NONCE_INDEX 6
153 # define OPENSSL_CTX_RAND_CRNGT_INDEX 7
154 # define OPENSSL_CTX_THREAD_EVENT_HANDLER_INDEX 8
155 # define OPENSSL_CTX_FIPS_PROV_INDEX 9
156 # define OPENSSL_CTX_MAX_INDEXES 10
158 typedef struct openssl_ctx_method {
159 void *(*new_func)(OPENSSL_CTX *ctx);
160 void (*free_func)(void *);
161 } OPENSSL_CTX_METHOD;
163 OPENSSL_CTX *openssl_ctx_get_concrete(OPENSSL_CTX *ctx);
165 /* Functions to retrieve pointers to data by index */
166 void *openssl_ctx_get_data(OPENSSL_CTX *, int /* index */,
167 const OPENSSL_CTX_METHOD * ctx);
169 void openssl_ctx_default_deinit(void);
170 OSSL_EX_DATA_GLOBAL *openssl_ctx_get_ex_data_global(OPENSSL_CTX *ctx);
171 typedef int (openssl_ctx_run_once_fn)(OPENSSL_CTX *ctx);
172 typedef void (openssl_ctx_onfree_fn)(OPENSSL_CTX *ctx);
174 int openssl_ctx_run_once(OPENSSL_CTX *ctx, unsigned int idx,
175 openssl_ctx_run_once_fn run_once_fn);
176 int openssl_ctx_onfree(OPENSSL_CTX *ctx, openssl_ctx_onfree_fn onfreefn);
178 OPENSSL_CTX *crypto_ex_data_get_openssl_ctx(const CRYPTO_EX_DATA *ad);
179 int crypto_new_ex_data_ex(OPENSSL_CTX *ctx, int class_index, void *obj,
181 int crypto_get_ex_new_index_ex(OPENSSL_CTX *ctx, int class_index,
182 long argl, void *argp,
183 CRYPTO_EX_new *new_func,
184 CRYPTO_EX_dup *dup_func,
185 CRYPTO_EX_free *free_func);
186 int crypto_free_ex_index_ex(OPENSSL_CTX *ctx, int class_index, int idx);
188 /* Function for simple binary search */
191 # define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01
192 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02
194 const void *ossl_bsearch(const void *key, const void *base, int num,
195 int size, int (*cmp) (const void *, const void *),