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 extern unsigned int OPENSSL_ia32cap_P[];
88 void OPENSSL_showfatal(const char *fmta, ...);
89 int do_ex_data_init(OPENSSL_CTX *ctx);
90 void crypto_cleanup_all_ex_data_int(OPENSSL_CTX *ctx);
91 int openssl_init_fork_handlers(void);
93 char *ossl_safe_getenv(const char *name);
95 extern CRYPTO_RWLOCK *memdbg_lock;
96 int openssl_strerror_r(int errnum, char *buf, size_t buflen);
97 # if !defined(OPENSSL_NO_STDIO)
98 FILE *openssl_fopen(const char *filename, const char *mode);
100 void *openssl_fopen(const char *filename, const char *mode);
103 uint32_t OPENSSL_rdtsc(void);
104 size_t OPENSSL_instrument_bus(unsigned int *, size_t);
105 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
107 /* ex_data structures */
110 * Each structure type (sometimes called a class), that supports
111 * exdata has a stack of callbacks for each instance.
113 struct ex_callback_st {
114 long argl; /* Arbitrary long */
115 void *argp; /* Arbitrary void * */
116 CRYPTO_EX_new *new_func;
117 CRYPTO_EX_free *free_func;
118 CRYPTO_EX_dup *dup_func;
122 * The state for each class. This could just be a typedef, but
123 * a structure allows future changes.
125 typedef struct ex_callbacks_st {
126 STACK_OF(EX_CALLBACK) *meth;
129 typedef struct ossl_ex_data_global_st {
130 CRYPTO_RWLOCK *ex_data_lock;
131 EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
132 } OSSL_EX_DATA_GLOBAL;
137 # define OPENSSL_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0
138 # define OPENSSL_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1
139 # define OPENSSL_CTX_METHOD_STORE_RUN_ONCE_INDEX 2
140 # define OPENSSL_CTX_MAX_RUN_ONCE 3
142 # define OPENSSL_CTX_DEFAULT_METHOD_STORE_INDEX 0
143 # define OPENSSL_CTX_PROVIDER_STORE_INDEX 1
144 # define OPENSSL_CTX_PROPERTY_DEFN_INDEX 2
145 # define OPENSSL_CTX_PROPERTY_STRING_INDEX 3
146 # define OPENSSL_CTX_NAMEMAP_INDEX 4
147 # define OPENSSL_CTX_DRBG_INDEX 5
148 # define OPENSSL_CTX_DRBG_NONCE_INDEX 6
149 # define OPENSSL_CTX_RAND_CRNGT_INDEX 7
150 # define OPENSSL_CTX_THREAD_EVENT_HANDLER_INDEX 8
151 # define OPENSSL_CTX_FIPS_PROV_INDEX 9
152 # define OPENSSL_CTX_MAX_INDEXES 10
154 typedef struct openssl_ctx_method {
155 void *(*new_func)(OPENSSL_CTX *ctx);
156 void (*free_func)(void *);
157 } OPENSSL_CTX_METHOD;
159 OPENSSL_CTX *openssl_ctx_get_concrete(OPENSSL_CTX *ctx);
161 /* Functions to retrieve pointers to data by index */
162 void *openssl_ctx_get_data(OPENSSL_CTX *, int /* index */,
163 const OPENSSL_CTX_METHOD * ctx);
165 void openssl_ctx_default_deinit(void);
166 OSSL_EX_DATA_GLOBAL *openssl_ctx_get_ex_data_global(OPENSSL_CTX *ctx);
167 typedef int (openssl_ctx_run_once_fn)(OPENSSL_CTX *ctx);
168 typedef void (openssl_ctx_onfree_fn)(OPENSSL_CTX *ctx);
170 int openssl_ctx_run_once(OPENSSL_CTX *ctx, unsigned int idx,
171 openssl_ctx_run_once_fn run_once_fn);
172 int openssl_ctx_onfree(OPENSSL_CTX *ctx, openssl_ctx_onfree_fn onfreefn);
174 OPENSSL_CTX *crypto_ex_data_get_openssl_ctx(const CRYPTO_EX_DATA *ad);
175 int crypto_new_ex_data_ex(OPENSSL_CTX *ctx, int class_index, void *obj,
177 int crypto_get_ex_new_index_ex(OPENSSL_CTX *ctx, int class_index,
178 long argl, void *argp,
179 CRYPTO_EX_new *new_func,
180 CRYPTO_EX_dup *dup_func,
181 CRYPTO_EX_free *free_func);
182 int crypto_free_ex_index_ex(OPENSSL_CTX *ctx, int class_index, int idx);
184 /* Function for simple binary search */
187 # define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01
188 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02
190 const void *ossl_bsearch(const void *key, const void *base, int num,
191 int size, int (*cmp) (const void *, const void *),