]> git.ipfire.org Git - thirdparty/openssl.git/blame - include/internal/cryptlib.h
Add deprecation macro for 3.1 and deprecate OPENSSL_LH_stats
[thirdparty/openssl.git] / include / internal / cryptlib.h
CommitLineData
aa6bb135 1/*
fecb3aae 2 * Copyright 1995-2022 The OpenSSL Project Authors. All Rights Reserved.
d02b48c6 3 *
48f4ad77 4 * Licensed under the Apache License 2.0 (the "License"). You may not use
aa6bb135
RS
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
d02b48c6
RE
8 */
9
ae4186b0
DMSP
10#ifndef OSSL_INTERNAL_CRYPTLIB_H
11# define OSSL_INTERNAL_CRYPTLIB_H
3a111aad 12# pragma once
d02b48c6 13
0f113f3e 14# ifdef OPENSSL_USE_APPLINK
b1132792 15# define BIO_FLAGS_UPLINK_INTERNAL 0x8000
0f113f3e 16# include "ms/uplink.h"
b1132792
BE
17# else
18# define BIO_FLAGS_UPLINK_INTERNAL 0
0f113f3e 19# endif
ea1b02db 20
af16097f
DDO
21# include "internal/common.h"
22
0f113f3e
MC
23# include <openssl/crypto.h>
24# include <openssl/buffer.h>
25# include <openssl/bio.h>
da42c2a3 26# include <openssl/asn1.h>
0f113f3e 27# include <openssl/err.h>
39147079 28
4a1f3f27 29typedef struct ex_callback_st EX_CALLBACK;
4a1f3f27
DSH
30DEFINE_STACK_OF(EX_CALLBACK)
31
e6b5c341 32typedef struct mem_st MEM;
5317b6ee 33DEFINE_LHASH_OF_EX(MEM);
4a1f3f27 34
2b247cf8 35void OPENSSL_cpuid_setup(void);
24fd8541
BE
36#if defined(__i386) || defined(__i386__) || defined(_M_IX86) || \
37 defined(__x86_64) || defined(__x86_64__) || \
38 defined(_M_AMD64) || defined(_M_X64)
e303f55f 39extern unsigned int OPENSSL_ia32cap_P[];
24fd8541 40#endif
0f113f3e 41void OPENSSL_showfatal(const char *fmta, ...);
e4bec869
SL
42int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx);
43void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx);
2915fe19 44int openssl_init_fork_handlers(void);
84952925 45int openssl_get_fork_id(void);
2b247cf8 46
5c39a55d
P
47char *ossl_safe_getenv(const char *name);
48
0e598a3d 49extern CRYPTO_RWLOCK *memdbg_lock;
7d37818d 50int openssl_strerror_r(int errnum, char *buf, size_t buflen);
09487816
AP
51# if !defined(OPENSSL_NO_STDIO)
52FILE *openssl_fopen(const char *filename, const char *mode);
53# else
54void *openssl_fopen(const char *filename, const char *mode);
55# endif
7d37818d 56
360fc9f4 57uint32_t OPENSSL_rdtsc(void);
c8f37048
BE
58size_t OPENSSL_instrument_bus(unsigned int *, size_t);
59size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
d807db26 60
1aedc35f
MC
61/* ex_data structures */
62
63/*
64 * Each structure type (sometimes called a class), that supports
65 * exdata has a stack of callbacks for each instance.
66 */
67struct ex_callback_st {
68 long argl; /* Arbitrary long */
69 void *argp; /* Arbitrary void * */
a16d2174 70 int priority; /* Priority ordering for freeing */
1aedc35f
MC
71 CRYPTO_EX_new *new_func;
72 CRYPTO_EX_free *free_func;
73 CRYPTO_EX_dup *dup_func;
74};
75
76/*
77 * The state for each class. This could just be a typedef, but
78 * a structure allows future changes.
79 */
80typedef struct ex_callbacks_st {
81 STACK_OF(EX_CALLBACK) *meth;
82} EX_CALLBACKS;
83
84typedef struct ossl_ex_data_global_st {
85 CRYPTO_RWLOCK *ex_data_lock;
86 EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
87} OSSL_EX_DATA_GLOBAL;
88
89
b4250010
DMSP
90/* OSSL_LIB_CTX */
91
92# define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0
93# define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1
94# define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX 2
95# define OSSL_LIB_CTX_MAX_RUN_ONCE 3
96
97# define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX 0
98# define OSSL_LIB_CTX_PROVIDER_STORE_INDEX 1
99# define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX 2
100# define OSSL_LIB_CTX_PROPERTY_STRING_INDEX 3
101# define OSSL_LIB_CTX_NAMEMAP_INDEX 4
102# define OSSL_LIB_CTX_DRBG_INDEX 5
103# define OSSL_LIB_CTX_DRBG_NONCE_INDEX 6
104# define OSSL_LIB_CTX_RAND_CRNGT_INDEX 7
ec91f1ae
P
105# ifdef FIPS_MODULE
106# define OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX 8
107# endif
b4250010 108# define OSSL_LIB_CTX_FIPS_PROV_INDEX 9
b0ee1de9
MC
109# define OSSL_LIB_CTX_ENCODER_STORE_INDEX 10
110# define OSSL_LIB_CTX_DECODER_STORE_INDEX 11
b4250010
DMSP
111# define OSSL_LIB_CTX_SELF_TEST_CB_INDEX 12
112# define OSSL_LIB_CTX_BIO_PROV_INDEX 13
113# define OSSL_LIB_CTX_GLOBAL_PROPERTIES 14
114# define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX 15
460d2fbc 115# define OSSL_LIB_CTX_PROVIDER_CONF_INDEX 16
b0ee1de9 116# define OSSL_LIB_CTX_BIO_CORE_INDEX 17
f12a5690
MC
117# define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX 18
118# define OSSL_LIB_CTX_MAX_INDEXES 19
b4250010 119
b4250010
DMSP
120OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx);
121int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
122int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);
d4c051ce 123
d64b6299 124/* Functions to retrieve pointers to data by index */
927d0566 125void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */);
d64b6299 126
b4250010
DMSP
127void ossl_lib_ctx_default_deinit(void);
128OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx);
b8fe36fe 129
d6d42cda 130const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx);
1aedc35f 131
e4bec869
SL
132OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad);
133int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
134 CRYPTO_EX_DATA *ad);
135int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
136 long argl, void *argp,
137 CRYPTO_EX_new *new_func,
138 CRYPTO_EX_dup *dup_func,
a16d2174
MC
139 CRYPTO_EX_free *free_func,
140 int priority);
e4bec869 141int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);
5c3f1e34
RL
142
143/* Function for simple binary search */
144
145/* Flags */
146# define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01
147# define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02
148
149const void *ossl_bsearch(const void *key, const void *base, int num,
150 int size, int (*cmp) (const void *, const void *),
151 int flags);
152
adf7e6d1
SL
153char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
154 const char *sep, size_t max_len);
9500c823 155char *ossl_ipaddr_to_asc(unsigned char *p, int len);
e8d0819d 156
9500c823
SL
157char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep);
158unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen,
159 const char sep);
d02b48c6 160#endif