include/internal/cryptlib.h

   1 /*
   2  * Copyright 1995-2022 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 # include "crypto/asn1.h"
  23
  24 # include <openssl/crypto.h>
  25 # include <openssl/buffer.h>
  26 # include <openssl/bio.h>
  27 # include <openssl/asn1.h>
  28 # include <openssl/err.h>
  29
  30 typedef struct ex_callback_st EX_CALLBACK;
  31 DEFINE_STACK_OF(EX_CALLBACK)
  32
  33 typedef struct mem_st MEM;
  34 DEFINE_LHASH_OF_EX(MEM);
  35
  36 void OPENSSL_cpuid_setup(void);
  37 #if defined(__i386)   || defined(__i386__)   || defined(_M_IX86) || \
  38     defined(__x86_64) || defined(__x86_64__) || \
  39     defined(_M_AMD64) || defined(_M_X64)
  40 extern unsigned int OPENSSL_ia32cap_P[];
  41 #endif
  42 void OPENSSL_showfatal(const char *fmta, ...);
  43 int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx);
  44 void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx);
  45 int openssl_init_fork_handlers(void);
  46 int openssl_get_fork_id(void);
  47
  48 char *ossl_safe_getenv(const char *name);
  49
  50 extern CRYPTO_RWLOCK *memdbg_lock;
  51 int openssl_strerror_r(int errnum, char *buf, size_t buflen);
  52 # if !defined(OPENSSL_NO_STDIO)
  53 FILE *openssl_fopen(const char *filename, const char *mode);
  54 # else
  55 void *openssl_fopen(const char *filename, const char *mode);
  56 # endif
  57
  58 uint32_t OPENSSL_rdtsc(void);
  59 size_t OPENSSL_instrument_bus(unsigned int *, size_t);
  60 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
  61
  62 /* ex_data structures */
  63
  64 /*
  65  * Each structure type (sometimes called a class), that supports
  66  * exdata has a stack of callbacks for each instance.
  67  */
  68 struct ex_callback_st {
  69     long argl;                  /* Arbitrary long */
  70     void *argp;                 /* Arbitrary void * */
  71     int priority;               /* Priority ordering for freeing */
  72     CRYPTO_EX_new *new_func;
  73     CRYPTO_EX_free *free_func;
  74     CRYPTO_EX_dup *dup_func;
  75 };
  76
  77 /*
  78  * The state for each class.  This could just be a typedef, but
  79  * a structure allows future changes.
  80  */
  81 typedef struct ex_callbacks_st {
  82     STACK_OF(EX_CALLBACK) *meth;
  83 } EX_CALLBACKS;
  84
  85 typedef struct ossl_ex_data_global_st {
  86     CRYPTO_RWLOCK *ex_data_lock;
  87     EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
  88 } OSSL_EX_DATA_GLOBAL;
  89
  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 # define OSSL_LIB_CTX_RAND_CRNGT_INDEX               7
 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_MAX_INDEXES                   20
 121
 122 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx);
 123 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
 124 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);
 125
 126 /* Functions to retrieve pointers to data by index */
 127 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */);
 128
 129 void ossl_lib_ctx_default_deinit(void);
 130 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx);
 131
 132 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx);
 133
 134 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad);
 135 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
 136                                CRYPTO_EX_DATA *ad);
 137 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
 138                                     long argl, void *argp,
 139                                     CRYPTO_EX_new *new_func,
 140                                     CRYPTO_EX_dup *dup_func,
 141                                     CRYPTO_EX_free *free_func,
 142                                     int priority);
 143 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);
 144
 145 /* Function for simple binary search */
 146
 147 /* Flags */
 148 # define OSSL_BSEARCH_VALUE_ON_NOMATCH            0x01
 149 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH        0x02
 150
 151 const void *ossl_bsearch(const void *key, const void *base, int num,
 152                          int size, int (*cmp) (const void *, const void *),
 153                          int flags);
 154
 155 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
 156                                    const char *sep, size_t max_len);
 157 char *ossl_ipaddr_to_asc(unsigned char *p, int len);
 158
 159 char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep);
 160 unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen,
 161                                    const char sep);
 162 #endif