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 # include <stdlib.h>
  15 # include <string.h>
  16
  17 # ifdef OPENSSL_USE_APPLINK
  18 #  define BIO_FLAGS_UPLINK_INTERNAL 0x8000
  19 #  include "ms/uplink.h"
  20 # else
  21 #  define BIO_FLAGS_UPLINK_INTERNAL 0
  22 # endif
  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 # include "internal/nelem.h"
  30
  31 #ifdef NDEBUG
  32 # define ossl_assert(x) ((x) != 0)
  33 #else
  34 __owur static ossl_inline int ossl_assert_int(int expr, const char *exprstr,
  35                                               const char *file, int line)
  36 {
  37     if (!expr)
  38         OPENSSL_die(exprstr, file, line);
  39
  40     return expr;
  41 }
  42
  43 # define ossl_assert(x) ossl_assert_int((x) != 0, "Assertion failed: "#x, \
  44                                          __FILE__, __LINE__)
  45
  46 #endif
  47
  48 /*
  49  * Use this inside a union with the field that needs to be aligned to a
  50  * reasonable boundary for the platform.  The most pessimistic alignment
  51  * of the listed types will be used by the compiler.
  52  */
  53 # define OSSL_UNION_ALIGN       \
  54     double align;               \
  55     ossl_uintmax_t align_int;   \
  56     void *align_ptr
  57
  58 typedef struct ex_callback_st EX_CALLBACK;
  59 DEFINE_STACK_OF(EX_CALLBACK)
  60
  61 typedef struct mem_st MEM;
  62 DEFINE_LHASH_OF(MEM);
  63
  64 # define OPENSSL_CONF             "openssl.cnf"
  65
  66 # ifndef OPENSSL_SYS_VMS
  67 #  define X509_CERT_AREA          OPENSSLDIR
  68 #  define X509_CERT_DIR           OPENSSLDIR "/certs"
  69 #  define X509_CERT_FILE          OPENSSLDIR "/cert.pem"
  70 #  define X509_PRIVATE_DIR        OPENSSLDIR "/private"
  71 #  define CTLOG_FILE              OPENSSLDIR "/ct_log_list.cnf"
  72 # else
  73 #  define X509_CERT_AREA          "OSSL$DATAROOT:[000000]"
  74 #  define X509_CERT_DIR           "OSSL$DATAROOT:[CERTS]"
  75 #  define X509_CERT_FILE          "OSSL$DATAROOT:[000000]cert.pem"
  76 #  define X509_PRIVATE_DIR        "OSSL$DATAROOT:[PRIVATE]"
  77 #  define CTLOG_FILE              "OSSL$DATAROOT:[000000]ct_log_list.cnf"
  78 # endif
  79
  80 # define X509_CERT_DIR_EVP        "SSL_CERT_DIR"
  81 # define X509_CERT_FILE_EVP       "SSL_CERT_FILE"
  82 # define CTLOG_FILE_EVP           "CTLOG_FILE"
  83
  84 /* size of string representations */
  85 # define DECIMAL_SIZE(type)      ((sizeof(type)*8+2)/3+1)
  86 # define HEX_SIZE(type)          (sizeof(type)*2)
  87
  88 void OPENSSL_cpuid_setup(void);
  89 #if defined(__i386)   || defined(__i386__)   || defined(_M_IX86) || \
  90     defined(__x86_64) || defined(__x86_64__) || \
  91     defined(_M_AMD64) || defined(_M_X64)
  92 extern unsigned int OPENSSL_ia32cap_P[];
  93 #endif
  94 void OPENSSL_showfatal(const char *fmta, ...);
  95 int ossl_do_ex_data_init(OSSL_LIB_CTX *ctx);
  96 void ossl_crypto_cleanup_all_ex_data_int(OSSL_LIB_CTX *ctx);
  97 int openssl_init_fork_handlers(void);
  98 int openssl_get_fork_id(void);
  99
 100 char *ossl_safe_getenv(const char *name);
 101
 102 extern CRYPTO_RWLOCK *memdbg_lock;
 103 int openssl_strerror_r(int errnum, char *buf, size_t buflen);
 104 # if !defined(OPENSSL_NO_STDIO)
 105 FILE *openssl_fopen(const char *filename, const char *mode);
 106 # else
 107 void *openssl_fopen(const char *filename, const char *mode);
 108 # endif
 109
 110 uint32_t OPENSSL_rdtsc(void);
 111 size_t OPENSSL_instrument_bus(unsigned int *, size_t);
 112 size_t OPENSSL_instrument_bus2(unsigned int *, size_t, size_t);
 113
 114 /* ex_data structures */
 115
 116 /*
 117  * Each structure type (sometimes called a class), that supports
 118  * exdata has a stack of callbacks for each instance.
 119  */
 120 struct ex_callback_st {
 121     long argl;                  /* Arbitrary long */
 122     void *argp;                 /* Arbitrary void * */
 123     int priority;               /* Priority ordering for freeing */
 124     CRYPTO_EX_new *new_func;
 125     CRYPTO_EX_free *free_func;
 126     CRYPTO_EX_dup *dup_func;
 127 };
 128
 129 /*
 130  * The state for each class.  This could just be a typedef, but
 131  * a structure allows future changes.
 132  */
 133 typedef struct ex_callbacks_st {
 134     STACK_OF(EX_CALLBACK) *meth;
 135 } EX_CALLBACKS;
 136
 137 typedef struct ossl_ex_data_global_st {
 138     CRYPTO_RWLOCK *ex_data_lock;
 139     EX_CALLBACKS ex_data[CRYPTO_EX_INDEX__COUNT];
 140 } OSSL_EX_DATA_GLOBAL;
 141
 142
 143 /* OSSL_LIB_CTX */
 144
 145 # define OSSL_LIB_CTX_PROVIDER_STORE_RUN_ONCE_INDEX          0
 146 # define OSSL_LIB_CTX_DEFAULT_METHOD_STORE_RUN_ONCE_INDEX    1
 147 # define OSSL_LIB_CTX_METHOD_STORE_RUN_ONCE_INDEX            2
 148 # define OSSL_LIB_CTX_MAX_RUN_ONCE                           3
 149
 150 # define OSSL_LIB_CTX_EVP_METHOD_STORE_INDEX         0
 151 # define OSSL_LIB_CTX_PROVIDER_STORE_INDEX           1
 152 # define OSSL_LIB_CTX_PROPERTY_DEFN_INDEX            2
 153 # define OSSL_LIB_CTX_PROPERTY_STRING_INDEX          3
 154 # define OSSL_LIB_CTX_NAMEMAP_INDEX                  4
 155 # define OSSL_LIB_CTX_DRBG_INDEX                     5
 156 # define OSSL_LIB_CTX_DRBG_NONCE_INDEX               6
 157 # define OSSL_LIB_CTX_RAND_CRNGT_INDEX               7
 158 # define OSSL_LIB_CTX_THREAD_EVENT_HANDLER_INDEX     8
 159 # define OSSL_LIB_CTX_FIPS_PROV_INDEX                9
 160 # define OSSL_LIB_CTX_ENCODER_STORE_INDEX           10
 161 # define OSSL_LIB_CTX_DECODER_STORE_INDEX           11
 162 # define OSSL_LIB_CTX_SELF_TEST_CB_INDEX            12
 163 # define OSSL_LIB_CTX_BIO_PROV_INDEX                13
 164 # define OSSL_LIB_CTX_GLOBAL_PROPERTIES             14
 165 # define OSSL_LIB_CTX_STORE_LOADER_STORE_INDEX      15
 166 # define OSSL_LIB_CTX_PROVIDER_CONF_INDEX           16
 167 # define OSSL_LIB_CTX_BIO_CORE_INDEX                17
 168 # define OSSL_LIB_CTX_CHILD_PROVIDER_INDEX          18
 169 # define OSSL_LIB_CTX_MAX_INDEXES                   19
 170
 171 # define OSSL_LIB_CTX_METHOD_LOW_PRIORITY          -1
 172 # define OSSL_LIB_CTX_METHOD_DEFAULT_PRIORITY       0
 173 # define OSSL_LIB_CTX_METHOD_PRIORITY_1             1
 174 # define OSSL_LIB_CTX_METHOD_PRIORITY_2             2
 175
 176 typedef struct ossl_lib_ctx_method {
 177     int priority;
 178     void *(*new_func)(OSSL_LIB_CTX *ctx);
 179     void (*free_func)(void *);
 180 } OSSL_LIB_CTX_METHOD;
 181
 182 OSSL_LIB_CTX *ossl_lib_ctx_get_concrete(OSSL_LIB_CTX *ctx);
 183 int ossl_lib_ctx_is_default(OSSL_LIB_CTX *ctx);
 184 int ossl_lib_ctx_is_global_default(OSSL_LIB_CTX *ctx);
 185
 186 /* Functions to retrieve pointers to data by index */
 187 void *ossl_lib_ctx_get_data(OSSL_LIB_CTX *, int /* index */,
 188                             const OSSL_LIB_CTX_METHOD * ctx);
 189
 190 void ossl_lib_ctx_default_deinit(void);
 191 OSSL_EX_DATA_GLOBAL *ossl_lib_ctx_get_ex_data_global(OSSL_LIB_CTX *ctx);
 192 typedef int (ossl_lib_ctx_run_once_fn)(OSSL_LIB_CTX *ctx);
 193 typedef void (ossl_lib_ctx_onfree_fn)(OSSL_LIB_CTX *ctx);
 194
 195 int ossl_lib_ctx_run_once(OSSL_LIB_CTX *ctx, unsigned int idx,
 196                           ossl_lib_ctx_run_once_fn run_once_fn);
 197 int ossl_lib_ctx_onfree(OSSL_LIB_CTX *ctx, ossl_lib_ctx_onfree_fn onfreefn);
 198 const char *ossl_lib_ctx_get_descriptor(OSSL_LIB_CTX *libctx);
 199
 200 OSSL_LIB_CTX *ossl_crypto_ex_data_get_ossl_lib_ctx(const CRYPTO_EX_DATA *ad);
 201 int ossl_crypto_new_ex_data_ex(OSSL_LIB_CTX *ctx, int class_index, void *obj,
 202                                CRYPTO_EX_DATA *ad);
 203 int ossl_crypto_get_ex_new_index_ex(OSSL_LIB_CTX *ctx, int class_index,
 204                                     long argl, void *argp,
 205                                     CRYPTO_EX_new *new_func,
 206                                     CRYPTO_EX_dup *dup_func,
 207                                     CRYPTO_EX_free *free_func,
 208                                     int priority);
 209 int ossl_crypto_free_ex_index_ex(OSSL_LIB_CTX *ctx, int class_index, int idx);
 210
 211 /* Function for simple binary search */
 212
 213 /* Flags */
 214 # define OSSL_BSEARCH_VALUE_ON_NOMATCH            0x01
 215 # define OSSL_BSEARCH_FIRST_VALUE_ON_MATCH        0x02
 216
 217 const void *ossl_bsearch(const void *key, const void *base, int num,
 218                          int size, int (*cmp) (const void *, const void *),
 219                          int flags);
 220
 221 char *ossl_sk_ASN1_UTF8STRING2text(STACK_OF(ASN1_UTF8STRING) *text,
 222                                    const char *sep, size_t max_len);
 223 char *ossl_ipaddr_to_asc(unsigned char *p, int len);
 224
 225 char *ossl_buf2hexstr_sep(const unsigned char *buf, long buflen, char sep);
 226 unsigned char *ossl_hexstr2buf_sep(const char *str, long *buflen,
 227                                    const char sep);
 228
 229 static ossl_inline int ossl_ends_with_dirsep(const char *path)
 230 {
 231     if (*path != '\0')
 232         path += strlen(path) - 1;
 233 # if defined __VMS
 234     if (*path == ']' || *path == '>' || *path == ':')
 235         return 1;
 236 # elif defined _WIN32
 237     if (*path == '\\')
 238         return 1;
 239 # endif
 240     return *path == '/';
 241 }
 242
 243 static ossl_inline int ossl_is_absolute_path(const char *path)
 244 {
 245 # if defined __VMS
 246     if (strchr(path, ':') != NULL
 247         || ((path[0] == '[' || path[0] == '<')
 248             && path[1] != '.' && path[1] != '-'
 249             && path[1] != ']' && path[1] != '>'))
 250         return 1;
 251 # elif defined _WIN32
 252     if (path[0] == '\\'
 253         || (path[0] != '\0' && path[1] == ':'))
 254         return 1;
 255 # endif
 256     return path[0] == '/';
 257 }
 258
 259 #endif