1 /* 2 * Copyright 1995-2024 The OpenSSL Project Authors. All Rights Reserved. 3 * 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 8 */ 9 10 #ifndef OSSL_INTERNAL_CRYPTLIB_H 11 # define OSSL_INTERNAL_CRYPTLIB_H 12 # pragma once 13 14 # ifdef OPENSSL_USE_APPLINK 15 # define BIO_FLAGS_UPLINK_INTERNAL 0x8000 16 # include "ms/uplink.h" 17 # else 18 # define BIO_FLAGS_UPLINK_INTERNAL 0 19 # endif 20 21 # include "internal/common.h" 22 23 # include <openssl/crypto.h> 24 # include <openssl/buffer.h> 25 # include <openssl/bio.h> 26 # include <openssl/asn1.h> 27 # include <openssl/err.h> 28 29 typedef struct ex_callback_st EX_CALLBACK; 30 DEFINE_STACK_OF(EX_CALLBACK) 31 32 typedef struct mem_st MEM; 33 DEFINE_LHASH_OF_EX(MEM); 34 35 void OPENSSL_cpuid_setup(void); 36 #if defined(__i386) || defined(__i386__) || defined(_M_IX86) || \ 37 defined(__x86_64) || defined(__x86_64__) || \ 38 defined(_M_AMD64) || defined(_M_X64) 39 # define OPENSSL_IA32CAP_P_MAX_INDEXES 10 40 extern unsigned int OPENSSL_ia32cap_P[]; 41 #endif 42 43 void OPENSSL_showfatal(const char *fmta, ...); 44 int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx); 45 void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx); 46 int openssl_init_fork_handlers(void); 47 int openssl_get_fork_id(void); 48 49 char *ossl_safe_getenv(const char *name); 50 51 extern CRYPTO_RWLOCK *memdbg_lock; 52 int openssl_strerror_r(int errnum, char *buf, size_t buflen); 53 # if !defined(OPENSSL_NO_STDIO) 54 FILE *openssl_fopen(const char *filename, const char *mode); 55 # else 56 void *openssl_fopen(const char *filename, const char *mode); 57 # endif 58 59 uint32_t OPENSSL_rdtsc(void); 60 size_t OPENSSL_instrument_bus(unsigned int *, size_t); 61 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t); 62 63 /* ex_data structures */ 64 65 /* 66 * Each structure type (sometimes called a class), that supports 67 * exdata has a stack of callbacks for each instance. 68 */ 69 struct ex_callback_st { 70 long argl; /* Arbitrary long */ 71 void *argp; /* Arbitrary void * */ 72 int priority; /* Priority ordering for freeing */ 73 CRYPTO_EX_new *new_func; 74 CRYPTO_EX_free *free_func; 75 CRYPTO_EX_dup *dup_func; 76 }; 77 78 /* 79 * The state for each class. This could just be a typedef, but 80 * a structure allows future changes. 81 */ 82 typedef struct ex_callbacks_st { 83 STACK_OF(EX_CALLBACK) *meth; 84 } EX_CALLBACKS; 85 86 typedef struct ossl_ex_data_global_st { 87 CRYPTO_RWLOCK *ex_data_lock; 88 EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT]; 89 } OSSL_EX_DATA_GLOBAL; 90 91 /* OSSL_LIB_CTX */ 92 93 # define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0 94 # define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1 95 # define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX 2 96 # define OSSL_LIB_CTX_MAX_RUN_ONCE 3 97 98 # define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX 0 99 # define OSSL_LIB_CTX_PROVIDER_STORE_INDEX 1 100 # define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX 2 101 # define OSSL_LIB_CTX_PROPERTY_STRING_INDEX 3 102 # define OSSL_LIB_CTX_NAMEMAP_INDEX 4 103 # define OSSL_LIB_CTX_DRBG_INDEX 5 104 # define OSSL_LIB_CTX_DRBG_NONCE_INDEX 6 105 /* slot 7 unused, was CRNG test data and can be reused */ 106 # ifdef FIPS_MODULE 107 # define OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX 8 108 # endif 109 # define OSSL_LIB_CTX_FIPS_PROV_INDEX 9 110 # define OSSL_LIB_CTX_ENCODER_STORE_INDEX 10 111 # define OSSL_LIB_CTX_DECODER_STORE_INDEX 11 112 # define OSSL_LIB_CTX_SELF_TEST_CB_INDEX 12 113 # define OSSL_LIB_CTX_BIO_PROV_INDEX 13 114 # define OSSL_LIB_CTX_GLOBAL_PROPERTIES 14 115 # define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX 15 116 # define OSSL_LIB_CTX_PROVIDER_CONF_INDEX 16 117 # define OSSL_LIB_CTX_BIO_CORE_INDEX 17 118 # define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX 18 119 # define OSSL_LIB_CTX_THREAD_INDEX 19 120 # define OSSL_LIB_CTX_DECODER_CACHE_INDEX 20 121 # define OSSL_LIB_CTX_COMP_METHODS 21 122 # define OSSL_LIB_CTX_INDICATOR_CB_INDEX 22 123 # define OSSL_LIB_CTX_MAX_INDEXES 22 124 125 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx); 126 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx); 127 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx); 128 129 /* Functions to retrieve pointers to data by index */ 130 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */); 131 132 void ossl_lib_ctx_default_deinit(void); 133 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx); 134 135 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx); 136 CRYPTO_THREAD_LOCAL *ossl_lib_ctx_get_rcukey(OSSL_LIB_CTX *libctx); 137 138 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad); 139 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj, 140 CRYPTO_EX_DATA *ad); 141 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index, 142 long argl, void *argp, 143 CRYPTO_EX_new *new_func, 144 CRYPTO_EX_dup *dup_func, 145 CRYPTO_EX_free *free_func, 146 int priority); 147 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx); 148 149 /* Function for simple binary search */ 150 151 /* Flags */ 152 # define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01 153 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02 154 155 const void *ossl_bsearch(const void *key, const void *base, int num, 156 int size, int (*cmp) (const void *, const void *), 157 int flags); 158 159 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text, 160 const char *sep, size_t max_len); 161 char *ossl_ipaddr_to_asc(unsigned char *p, int len); 162 163 char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep); 164 unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen, 165 const char sep); 166 167 /** 168 * Writes |n| value in hex format into |buf|, 169 * and returns the number of bytes written 170 */ 171 size_t ossl_to_hex(char *buf, uint8_t n); 172 173 STACK_OF(SSL_COMP) *ossl_load_builtin_compressions(void); 174 void ossl_free_compression_methods_int(STACK_OF(SSL_COMP) *methods); 175 176 #endif 177
