include/internal/cryptlib.h

   1 /*
   2  * Copyright 1995-2021 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(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
  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
 105 # ifdef FIPS_MODULE
 106 #  define OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX    8
 107 # endif
 108 # define OSSL_LIB_CTX_FIPS_PROV_INDEX                9
 109 # define OSSL_LIB_CTX_ENCODER_STORE_INDEX           10
 110 # define OSSL_LIB_CTX_DECODER_STORE_INDEX           11
 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
 115 # define OSSL_LIB_CTX_PROVIDER_CONF_INDEX           16
 116 # define OSSL_LIB_CTX_BIO_CORE_INDEX                17
 117 # define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX          18
 118 # define OSSL_LIB_CTX_MAX_INDEXES                   19
 119
 120 # define OSSL_LIB_CTX_METHOD_LOW_PRIORITY          -1
 121 # define OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY       0
 122 # define OSSL_LIB_CTX_METHOD_PRIORITY_1             1
 123 # define OSSL_LIB_CTX_METHOD_PRIORITY_2             2
 124
 125 typedef struct ossl_lib_ctx_method {
 126     int priority;
 127     void *(*new_func)(OSSL_LIB_CTX *ctx);
 128     void (*free_func)(void *);
 129 } OSSL_LIB_CTX_METHOD;
 130
 131 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx);
 132 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
 133 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);
 134
 135 /* Functions to retrieve pointers to data by index */
 136 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */,
 137                             const OSSL_LIB_CTX_METHOD * ctx);
 138
 139 void ossl_lib_ctx_default_deinit(void);
 140 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx);
 141 typedef int (ossl_lib_ctx_run_once_fn)(OSSL_LIB_CTX *ctx);
 142 typedef void (ossl_lib_ctx_onfree_fn)(OSSL_LIB_CTX *ctx);
 143
 144 int ossl_lib_ctx_run_once(OSSL_LIB_CTX *ctx, unsigned int idx,
 145                           ossl_lib_ctx_run_once_fn run_once_fn);
 146 int ossl_lib_ctx_onfree(OSSL_LIB_CTX *ctx, ossl_lib_ctx_onfree_fn onfreefn);
 147 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx);
 148
 149 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad);
 150 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
 151                                CRYPTO_EX_DATA *ad);
 152 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
 153                                     long argl, void *argp,
 154                                     CRYPTO_EX_new *new_func,
 155                                     CRYPTO_EX_dup *dup_func,
 156                                     CRYPTO_EX_free *free_func,
 157                                     int priority);
 158 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);
 159
 160 /* Function for simple binary search */
 161
 162 /* Flags */
 163 # define OSSL_BSEARCH_VALUE_ON_NOMATCH            0x01
 164 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH        0x02
 165
 166 const void *ossl_bsearch(const void *key, const void *base, int num,
 167                          int size, int (*cmp) (const void *, const void *),
 168                          int flags);
 169
 170 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
 171                                    const char *sep, size_t max_len);
 172 char *ossl_ipaddr_to_asc(unsigned char *p, int len);
 173
 174 char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep);
 175 unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen,
 176                                    const char sep);
 177
 178 #endif