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