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 extern unsigned int OPENSSL_ia32cap_P[]; 40 #endif 41 void OPENSSL_showfatal(const char *fmta, ...); 42 int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx); 43 void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx); 44 int openssl_init_fork_handlers(void); 45 int openssl_get_fork_id(void); 46 47 char *ossl_safe_getenv(const char *name); 48 49 extern CRYPTO_RWLOCK *memdbg_lock; 50 int openssl_strerror_r(int errnum, char *buf, size_t buflen); 51 # if !defined(OPENSSL_NO_STDIO) 52 FILE *openssl_fopen(const char *filename, const char *mode); 53 # else 54 void *openssl_fopen(const char *filename, const char *mode); 55 # endif 56 57 uint32_t OPENSSL_rdtsc(void); 58 size_t OPENSSL_instrument_bus(unsigned int *, size_t); 59 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t); 60 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 */ 67 struct ex_callback_st { 68 long argl; /* Arbitrary long */ 69 void *argp; /* Arbitrary void * */ 70 int priority; /* Priority ordering for freeing */ 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 */ 80 typedef struct ex_callbacks_st { 81 STACK_OF(EX_CALLBACK) *meth; 82 } EX_CALLBACKS; 83 84 typedef 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 /* OSSL_LIB_CTX */ 90 91 # define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX 0 92 # define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX 1 93 # define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX 2 94 # define OSSL_LIB_CTX_MAX_RUN_ONCE 3 95 96 # define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX 0 97 # define OSSL_LIB_CTX_PROVIDER_STORE_INDEX 1 98 # define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX 2 99 # define OSSL_LIB_CTX_PROPERTY_STRING_INDEX 3 100 # define OSSL_LIB_CTX_NAMEMAP_INDEX 4 101 # define OSSL_LIB_CTX_DRBG_INDEX 5 102 # define OSSL_LIB_CTX_DRBG_NONCE_INDEX 6 103 /* slot 7 unused, was CRNG test data and can be reused */ 104 # ifdef FIPS_MODULE 105 # define OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX 8 106 # endif 107 # define OSSL_LIB_CTX_FIPS_PROV_INDEX 9 108 # define OSSL_LIB_CTX_ENCODER_STORE_INDEX 10 109 # define OSSL_LIB_CTX_DECODER_STORE_INDEX 11 110 # define OSSL_LIB_CTX_SELF_TEST_CB_INDEX 12 111 # define OSSL_LIB_CTX_BIO_PROV_INDEX 13 112 # define OSSL_LIB_CTX_GLOBAL_PROPERTIES 14 113 # define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX 15 114 # define OSSL_LIB_CTX_PROVIDER_CONF_INDEX 16 115 # define OSSL_LIB_CTX_BIO_CORE_INDEX 17 116 # define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX 18 117 # define OSSL_LIB_CTX_THREAD_INDEX 19 118 # define OSSL_LIB_CTX_DECODER_CACHE_INDEX 20 119 # define OSSL_LIB_CTX_COMP_METHODS 21 120 # define OSSL_LIB_CTX_INDICATOR_CB_INDEX 22 121 # define OSSL_LIB_CTX_MAX_INDEXES 22 122 123 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx); 124 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx); 125 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx); 126 127 /* Functions to retrieve pointers to data by index */ 128 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */); 129 130 void ossl_lib_ctx_default_deinit(void); 131 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx); 132 133 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx); 134 CRYPTO_THREAD_LOCAL *ossl_lib_ctx_get_rcukey(OSSL_LIB_CTX *libctx); 135 136 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad); 137 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj, 138 CRYPTO_EX_DATA *ad); 139 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index, 140 long argl, void *argp, 141 CRYPTO_EX_new *new_func, 142 CRYPTO_EX_dup *dup_func, 143 CRYPTO_EX_free *free_func, 144 int priority); 145 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx); 146 147 /* Function for simple binary search */ 148 149 /* Flags */ 150 # define OSSL_BSEARCH_VALUE_ON_NOMATCH 0x01 151 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH 0x02 152 153 const void *ossl_bsearch(const void *key, const void *base, int num, 154 int size, int (*cmp) (const void *, const void *), 155 int flags); 156 157 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text, 158 const char *sep, size_t max_len); 159 char *ossl_ipaddr_to_asc(unsigned char *p, int len); 160 161 char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep); 162 unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen, 163 const char sep); 164 165 /** 166 * Writes |n| value in hex format into |buf|, 167 * and returns the number of bytes written 168 */ 169 size_t ossl_to_hex(char *buf, uint8_t n); 170 171 STACK_OF(SSL_COMP) *ossl_load_builtin_compressions(void); 172 void ossl_free_compression_methods_int(STACK_OF(SSL_COMP) *methods); 173 174 #endif 175
