crypto/err/err.c

   1 /*
   2  * Copyright 1995-2018 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 #include <stdio.h>
  11 #include <stdarg.h>
  12 #include <string.h>
  13 #include "internal/cryptlib_int.h"
  14 #include "internal/err.h"
  15 #include "internal/err_int.h"
  16 #include <openssl/err.h>
  17 #include <openssl/crypto.h>
  18 #include <openssl/buffer.h>
  19 #include <openssl/bio.h>
  20 #include <openssl/opensslconf.h>
  21 #include "internal/thread_once.h"
  22 #include "internal/ctype.h"
  23 #include "internal/constant_time_locl.h"
  24 #include "e_os.h"
  25
  26 static int err_load_strings(const ERR_STRING_DATA *str);
  27
  28 static void ERR_STATE_free(ERR_STATE *s);
  29 #ifndef OPENSSL_NO_ERR
  30 static ERR_STRING_DATA ERR_str_libraries[] = {
  31     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
  32     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
  33     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
  34     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
  35     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
  36     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
  37     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
  38     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
  39     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
  40     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
  41     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
  42     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
  43     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
  44     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
  45     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
  46     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
  47     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
  48     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
  49     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
  50     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
  51     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
  52     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
  53     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
  54     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
  55     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
  56     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
  57     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
  58     {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
  59     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
  60     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
  61     {ERR_PACK(ERR_LIB_CRMF, 0, 0), "CRMF routines"},
  62     {ERR_PACK(ERR_LIB_CMP, 0, 0), "CMP routines"},
  63     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
  64     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
  65     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
  66     {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
  67     {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
  68     {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"},
  69     {ERR_PACK(ERR_LIB_ESS, 0, 0), "ESS routines"},
  70     {ERR_PACK(ERR_LIB_PROV, 0, 0), "Provider routines"},
  71     {0, NULL},
  72 };
  73
  74 static ERR_STRING_DATA ERR_str_functs[] = {
  75     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
  76     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
  77     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
  78     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
  79     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
  80     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
  81     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
  82     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
  83 # ifdef OPENSSL_SYS_WINDOWS
  84     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
  85 # endif
  86     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
  87     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
  88     {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
  89     {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
  90     {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
  91     {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
  92     {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
  93     {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
  94     {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
  95     {ERR_PACK(0, SYS_F_OPEN, 0), "open"},
  96     {ERR_PACK(0, SYS_F_CLOSE, 0), "close"},
  97     {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"},
  98     {ERR_PACK(0, SYS_F_STAT, 0), "stat"},
  99     {ERR_PACK(0, SYS_F_FCNTL, 0), "fcntl"},
 100     {ERR_PACK(0, SYS_F_FSTAT, 0), "fstat"},
 101     {0, NULL},
 102 };
 103
 104 static ERR_STRING_DATA ERR_str_reasons[] = {
 105     {ERR_R_SYS_LIB, "system lib"},
 106     {ERR_R_BN_LIB, "BN lib"},
 107     {ERR_R_RSA_LIB, "RSA lib"},
 108     {ERR_R_DH_LIB, "DH lib"},
 109     {ERR_R_EVP_LIB, "EVP lib"},
 110     {ERR_R_BUF_LIB, "BUF lib"},
 111     {ERR_R_OBJ_LIB, "OBJ lib"},
 112     {ERR_R_PEM_LIB, "PEM lib"},
 113     {ERR_R_DSA_LIB, "DSA lib"},
 114     {ERR_R_X509_LIB, "X509 lib"},
 115     {ERR_R_ASN1_LIB, "ASN1 lib"},
 116     {ERR_R_EC_LIB, "EC lib"},
 117     {ERR_R_BIO_LIB, "BIO lib"},
 118     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
 119     {ERR_R_X509V3_LIB, "X509V3 lib"},
 120     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 121     {ERR_R_UI_LIB, "UI lib"},
 122     {ERR_R_OSSL_STORE_LIB, "STORE lib"},
 123     {ERR_R_ECDSA_LIB, "ECDSA lib"},
 124
 125     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 126     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 127
 128     {ERR_R_FATAL, "fatal"},
 129     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 130     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 131      "called a function you should not call"},
 132     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 133     {ERR_R_INTERNAL_ERROR, "internal error"},
 134     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 135     {ERR_R_INIT_FAIL, "init fail"},
 136     {ERR_R_OPERATION_FAIL, "operation fail"},
 137
 138     {0, NULL},
 139 };
 140 #endif
 141
 142 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
 143 static int set_err_thread_local;
 144 static CRYPTO_THREAD_LOCAL err_thread_local;
 145
 146 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
 147 static CRYPTO_RWLOCK *err_string_lock;
 148
 149 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 150
 151 /*
 152  * The internal state
 153  */
 154
 155 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 156 static int int_err_library_number = ERR_LIB_USER;
 157
 158 static unsigned long get_error_values(int inc, int top, const char **file,
 159                                       int *line, const char **data,
 160                                       int *flags);
 161
 162 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 163 {
 164     unsigned long ret, l;
 165
 166     l = a->error;
 167     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
 168     return (ret ^ ret % 19 * 13);
 169 }
 170
 171 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 172                                const ERR_STRING_DATA *b)
 173 {
 174     if (a->error == b->error)
 175         return 0;
 176     return a->error > b->error ? 1 : -1;
 177 }
 178
 179 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 180 {
 181     ERR_STRING_DATA *p = NULL;
 182
 183     CRYPTO_THREAD_read_lock(err_string_lock);
 184     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
 185     CRYPTO_THREAD_unlock(err_string_lock);
 186
 187     return p;
 188 }
 189
 190 #ifndef OPENSSL_NO_ERR
 191 /* 2019-05-21: Russian and Ukrainian locales on Linux require more than 6,5 kB */
 192 # define SPACE_SYS_STR_REASONS 8 * 1024
 193 # define NUM_SYS_STR_REASONS 127
 194
 195 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 196 /*
 197  * SYS_str_reasons is filled with copies of strerror() results at
 198  * initialization. 'errno' values up to 127 should cover all usual errors,
 199  * others will be displayed numerically by ERR_error_string. It is crucial
 200  * that we have something for each reason code that occurs in
 201  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 202  * which always gets an errno value and never one of those 'standard' reason
 203  * codes.
 204  */
 205
 206 static void build_SYS_str_reasons(void)
 207 {
 208     /* OPENSSL_malloc cannot be used here, use static storage instead */
 209     static char strerror_pool[SPACE_SYS_STR_REASONS];
 210     char *cur = strerror_pool;
 211     size_t cnt = 0;
 212     static int init = 1;
 213     int i;
 214     int saveerrno = get_last_sys_error();
 215
 216     CRYPTO_THREAD_write_lock(err_string_lock);
 217     if (!init) {
 218         CRYPTO_THREAD_unlock(err_string_lock);
 219         return;
 220     }
 221
 222     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 223         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 224
 225         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
 226         /*
 227          * If we have used up all the space in strerror_pool,
 228          * there's no point in calling openssl_strerror_r()
 229          */
 230         if (str->string == NULL && cnt < sizeof(strerror_pool)) {
 231             if (openssl_strerror_r(i, cur, sizeof(strerror_pool) - cnt)) {
 232                 size_t l = strlen(cur);
 233
 234                 str->string = cur;
 235                 cnt += l;
 236                 cur += l;
 237
 238                 /*
 239                  * VMS has an unusual quirk of adding spaces at the end of
 240                  * some (most? all?) messages. Lets trim them off.
 241                  */
 242                 while (cur > strerror_pool && ossl_isspace(cur[-1])) {
 243                     cur--;
 244                     cnt--;
 245                 }
 246                 *cur++ = '\0';
 247                 cnt++;
 248             }
 249         }
 250         if (str->string == NULL)
 251             str->string = "unknown";
 252     }
 253
 254     /*
 255      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 256      * required by ERR_load_strings.
 257      */
 258
 259     init = 0;
 260
 261     CRYPTO_THREAD_unlock(err_string_lock);
 262     /* openssl_strerror_r could change errno, but we want to preserve it */
 263     set_sys_error(saveerrno);
 264     err_load_strings(SYS_str_reasons);
 265 }
 266 #endif
 267
 268 #define err_clear_data(p, i) \
 269         do { \
 270             if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) {\
 271                 OPENSSL_free((p)->err_data[i]); \
 272                 (p)->err_data[i] = NULL; \
 273             } \
 274             (p)->err_data_flags[i] = 0; \
 275         } while (0)
 276
 277 #define err_clear(p, i) \
 278         do { \
 279             err_clear_data(p, i); \
 280             (p)->err_flags[i] = 0; \
 281             (p)->err_buffer[i] = 0; \
 282             (p)->err_file[i] = NULL; \
 283             (p)->err_line[i] = -1; \
 284         } while (0)
 285
 286 static void ERR_STATE_free(ERR_STATE *s)
 287 {
 288     int i;
 289
 290     if (s == NULL)
 291         return;
 292     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 293         err_clear_data(s, i);
 294     }
 295     OPENSSL_free(s);
 296 }
 297
 298 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 299 {
 300     if (!OPENSSL_init_crypto(0, NULL))
 301         return 0;
 302     err_string_lock = CRYPTO_THREAD_lock_new();
 303     if (err_string_lock == NULL)
 304         return 0;
 305     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 306                                             err_string_data_cmp);
 307     if (int_error_hash == NULL) {
 308         CRYPTO_THREAD_lock_free(err_string_lock);
 309         err_string_lock = NULL;
 310         return 0;
 311     }
 312     return 1;
 313 }
 314
 315 void err_cleanup(void)
 316 {
 317     if (set_err_thread_local != 0)
 318         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 319     CRYPTO_THREAD_lock_free(err_string_lock);
 320     err_string_lock = NULL;
 321     lh_ERR_STRING_DATA_free(int_error_hash);
 322     int_error_hash = NULL;
 323 }
 324
 325 /*
 326  * Legacy; pack in the library.
 327  */
 328 static void err_patch(int lib, ERR_STRING_DATA *str)
 329 {
 330     unsigned long plib = ERR_PACK(lib, 0, 0);
 331
 332     for (; str->error != 0; str++)
 333         str->error |= plib;
 334 }
 335
 336 /*
 337  * Hash in |str| error strings. Assumes the URN_ONCE was done.
 338  */
 339 static int err_load_strings(const ERR_STRING_DATA *str)
 340 {
 341     CRYPTO_THREAD_write_lock(err_string_lock);
 342     for (; str->error; str++)
 343         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 344                                        (ERR_STRING_DATA *)str);
 345     CRYPTO_THREAD_unlock(err_string_lock);
 346     return 1;
 347 }
 348
 349 int ERR_load_ERR_strings(void)
 350 {
 351 #ifndef OPENSSL_NO_ERR
 352     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 353         return 0;
 354
 355     err_load_strings(ERR_str_libraries);
 356     err_load_strings(ERR_str_reasons);
 357     err_patch(ERR_LIB_SYS, ERR_str_functs);
 358     err_load_strings(ERR_str_functs);
 359     build_SYS_str_reasons();
 360 #endif
 361     return 1;
 362 }
 363
 364 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 365 {
 366     if (ERR_load_ERR_strings() == 0)
 367         return 0;
 368
 369     err_patch(lib, str);
 370     err_load_strings(str);
 371     return 1;
 372 }
 373
 374 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 375 {
 376     if (ERR_load_ERR_strings() == 0)
 377         return 0;
 378     err_load_strings(str);
 379     return 1;
 380 }
 381
 382 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 383 {
 384     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 385         return 0;
 386
 387     CRYPTO_THREAD_write_lock(err_string_lock);
 388     /*
 389      * We don't need to ERR_PACK the lib, since that was done (to
 390      * the table) when it was loaded.
 391      */
 392     for (; str->error; str++)
 393         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 394     CRYPTO_THREAD_unlock(err_string_lock);
 395
 396     return 1;
 397 }
 398
 399 void err_free_strings_int(void)
 400 {
 401     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 402         return;
 403 }
 404
 405 /********************************************************/
 406
 407 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 408 {
 409     ERR_STATE *es;
 410
 411 #ifdef _OSD_POSIX
 412     /*
 413      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 414      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 415      * something sensible. @@@ We shouldn't modify a const string, though.
 416      */
 417     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 418         char *end;
 419
 420         /* Skip the "*POSIX(" prefix */
 421         file += sizeof("*POSIX(") - 1;
 422         end = &file[strlen(file) - 1];
 423         if (*end == ')')
 424             *end = '\0';
 425         /* Optional: use the basename of the path only. */
 426         if ((end = strrchr(file, '/')) != NULL)
 427             file = &end[1];
 428     }
 429 #endif
 430     es = ERR_get_state();
 431     if (es == NULL)
 432         return;
 433
 434     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 435     if (es->top == es->bottom)
 436         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 437     es->err_flags[es->top] = 0;
 438     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 439     es->err_file[es->top] = file;
 440     es->err_line[es->top] = line;
 441     err_clear_data(es, es->top);
 442 }
 443
 444 void ERR_clear_error(void)
 445 {
 446     int i;
 447     ERR_STATE *es;
 448
 449     es = ERR_get_state();
 450     if (es == NULL)
 451         return;
 452
 453     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 454         err_clear(es, i);
 455     }
 456     es->top = es->bottom = 0;
 457 }
 458
 459 unsigned long ERR_get_error(void)
 460 {
 461     return get_error_values(1, 0, NULL, NULL, NULL, NULL);
 462 }
 463
 464 unsigned long ERR_get_error_line(const char **file, int *line)
 465 {
 466     return get_error_values(1, 0, file, line, NULL, NULL);
 467 }
 468
 469 unsigned long ERR_get_error_line_data(const char **file, int *line,
 470                                       const char **data, int *flags)
 471 {
 472     return get_error_values(1, 0, file, line, data, flags);
 473 }
 474
 475 unsigned long ERR_peek_error(void)
 476 {
 477     return get_error_values(0, 0, NULL, NULL, NULL, NULL);
 478 }
 479
 480 unsigned long ERR_peek_error_line(const char **file, int *line)
 481 {
 482     return get_error_values(0, 0, file, line, NULL, NULL);
 483 }
 484
 485 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 486                                        const char **data, int *flags)
 487 {
 488     return get_error_values(0, 0, file, line, data, flags);
 489 }
 490
 491 unsigned long ERR_peek_last_error(void)
 492 {
 493     return get_error_values(0, 1, NULL, NULL, NULL, NULL);
 494 }
 495
 496 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 497 {
 498     return get_error_values(0, 1, file, line, NULL, NULL);
 499 }
 500
 501 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 502                                             const char **data, int *flags)
 503 {
 504     return get_error_values(0, 1, file, line, data, flags);
 505 }
 506
 507 static unsigned long get_error_values(int inc, int top, const char **file,
 508                                       int *line, const char **data,
 509                                       int *flags)
 510 {
 511     int i = 0;
 512     ERR_STATE *es;
 513     unsigned long ret;
 514
 515     es = ERR_get_state();
 516     if (es == NULL)
 517         return 0;
 518
 519     if (inc && top) {
 520         if (file)
 521             *file = "";
 522         if (line)
 523             *line = 0;
 524         if (data)
 525             *data = "";
 526         if (flags)
 527             *flags = 0;
 528
 529         return ERR_R_INTERNAL_ERROR;
 530     }
 531
 532     while (es->bottom != es->top) {
 533         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
 534             err_clear(es, es->top);
 535             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 536             continue;
 537         }
 538         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 539         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
 540             es->bottom = i;
 541             err_clear(es, es->bottom);
 542             continue;
 543         }
 544         break;
 545     }
 546
 547     if (es->bottom == es->top)
 548         return 0;
 549
 550     if (top)
 551         i = es->top;            /* last error */
 552     else
 553         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 554
 555     ret = es->err_buffer[i];
 556     if (inc) {
 557         es->bottom = i;
 558         es->err_buffer[i] = 0;
 559     }
 560
 561     if (file != NULL && line != NULL) {
 562         if (es->err_file[i] == NULL) {
 563             *file = "NA";
 564             *line = 0;
 565         } else {
 566             *file = es->err_file[i];
 567             *line = es->err_line[i];
 568         }
 569     }
 570
 571     if (data == NULL) {
 572         if (inc) {
 573             err_clear_data(es, i);
 574         }
 575     } else {
 576         if (es->err_data[i] == NULL) {
 577             *data = "";
 578             if (flags != NULL)
 579                 *flags = 0;
 580         } else {
 581             *data = es->err_data[i];
 582             if (flags != NULL)
 583                 *flags = es->err_data_flags[i];
 584         }
 585     }
 586     return ret;
 587 }
 588
 589 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 590 {
 591     char lsbuf[64], fsbuf[64], rsbuf[64];
 592     const char *ls, *fs, *rs;
 593     unsigned long l, f, r;
 594
 595     if (len == 0)
 596         return;
 597
 598     l = ERR_GET_LIB(e);
 599     ls = ERR_lib_error_string(e);
 600     if (ls == NULL) {
 601         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 602         ls = lsbuf;
 603     }
 604
 605     fs = ERR_func_error_string(e);
 606     f = ERR_GET_FUNC(e);
 607     if (fs == NULL) {
 608         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 609         fs = fsbuf;
 610     }
 611
 612     rs = ERR_reason_error_string(e);
 613     r = ERR_GET_REASON(e);
 614     if (rs == NULL) {
 615         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 616         rs = rsbuf;
 617     }
 618
 619     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs);
 620     if (strlen(buf) == len - 1) {
 621         /* Didn't fit; use a minimal format. */
 622         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
 623     }
 624 }
 625
 626 /*
 627  * ERR_error_string_n should be used instead for ret != NULL as
 628  * ERR_error_string cannot know how large the buffer is
 629  */
 630 char *ERR_error_string(unsigned long e, char *ret)
 631 {
 632     static char buf[256];
 633
 634     if (ret == NULL)
 635         ret = buf;
 636     ERR_error_string_n(e, ret, (int)sizeof(buf));
 637     return ret;
 638 }
 639
 640 const char *ERR_lib_error_string(unsigned long e)
 641 {
 642     ERR_STRING_DATA d, *p;
 643     unsigned long l;
 644
 645     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 646         return NULL;
 647     }
 648
 649     l = ERR_GET_LIB(e);
 650     d.error = ERR_PACK(l, 0, 0);
 651     p = int_err_get_item(&d);
 652     return ((p == NULL) ? NULL : p->string);
 653 }
 654
 655 const char *ERR_func_error_string(unsigned long e)
 656 {
 657     ERR_STRING_DATA d, *p;
 658     unsigned long l, f;
 659
 660     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 661         return NULL;
 662     }
 663
 664     l = ERR_GET_LIB(e);
 665     f = ERR_GET_FUNC(e);
 666     d.error = ERR_PACK(l, f, 0);
 667     p = int_err_get_item(&d);
 668     return ((p == NULL) ? NULL : p->string);
 669 }
 670
 671 const char *ERR_reason_error_string(unsigned long e)
 672 {
 673     ERR_STRING_DATA d, *p = NULL;
 674     unsigned long l, r;
 675
 676     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 677         return NULL;
 678     }
 679
 680     l = ERR_GET_LIB(e);
 681     r = ERR_GET_REASON(e);
 682     d.error = ERR_PACK(l, 0, r);
 683     p = int_err_get_item(&d);
 684     if (!p) {
 685         d.error = ERR_PACK(0, 0, r);
 686         p = int_err_get_item(&d);
 687     }
 688     return ((p == NULL) ? NULL : p->string);
 689 }
 690
 691 /* TODO(3.0): arg ignored for now */
 692 static void err_delete_thread_state(void *arg)
 693 {
 694     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 695     if (state == NULL)
 696         return;
 697
 698     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 699     ERR_STATE_free(state);
 700 }
 701
 702 #if !OPENSSL_API_1_1_0
 703 void ERR_remove_thread_state(void *dummy)
 704 {
 705 }
 706 #endif
 707
 708 #if !OPENSSL_API_1_0_0
 709 void ERR_remove_state(unsigned long pid)
 710 {
 711 }
 712 #endif
 713
 714 DEFINE_RUN_ONCE_STATIC(err_do_init)
 715 {
 716     set_err_thread_local = 1;
 717     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 718 }
 719
 720 ERR_STATE *ERR_get_state(void)
 721 {
 722     ERR_STATE *state;
 723     int saveerrno = get_last_sys_error();
 724
 725     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 726         return NULL;
 727
 728     if (!RUN_ONCE(&err_init, err_do_init))
 729         return NULL;
 730
 731     state = CRYPTO_THREAD_get_local(&err_thread_local);
 732     if (state == (ERR_STATE*)-1)
 733         return NULL;
 734
 735     if (state == NULL) {
 736         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 737             return NULL;
 738
 739         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
 740             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 741             return NULL;
 742         }
 743
 744         if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state)
 745                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 746             ERR_STATE_free(state);
 747             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 748             return NULL;
 749         }
 750
 751         /* Ignore failures from these */
 752         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 753     }
 754
 755     set_sys_error(saveerrno);
 756     return state;
 757 }
 758
 759 /*
 760  * err_shelve_state returns the current thread local error state
 761  * and freezes the error module until err_unshelve_state is called.
 762  */
 763 int err_shelve_state(void **state)
 764 {
 765     int saveerrno = get_last_sys_error();
 766
 767     /*
 768      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
 769      * via ossl_init_load_crypto_nodelete(), by which point the requested
 770      * "base" initialization has already been performed, so the below call is a
 771      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
 772      *
 773      * If are no other valid callers of this function, the call below can be
 774      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
 775      * potential uses that are not from inside OPENSSL_init_crypto(), then this
 776      * call is needed, but some care is required to make sure that the re-entry
 777      * remains a NOOP.
 778      */
 779     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 780         return 0;
 781
 782     if (!RUN_ONCE(&err_init, err_do_init))
 783         return 0;
 784
 785     *state = CRYPTO_THREAD_get_local(&err_thread_local);
 786     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 787         return 0;
 788
 789     set_sys_error(saveerrno);
 790     return 1;
 791 }
 792
 793 /*
 794  * err_unshelve_state restores the error state that was returned
 795  * by err_shelve_state previously.
 796  */
 797 void err_unshelve_state(void* state)
 798 {
 799     if (state != (void*)-1)
 800         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
 801 }
 802
 803 int ERR_get_next_error_library(void)
 804 {
 805     int ret;
 806
 807     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 808         return 0;
 809
 810     CRYPTO_THREAD_write_lock(err_string_lock);
 811     ret = int_err_library_number++;
 812     CRYPTO_THREAD_unlock(err_string_lock);
 813     return ret;
 814 }
 815
 816 static int err_set_error_data_int(char *data, int flags)
 817 {
 818     ERR_STATE *es;
 819     int i;
 820
 821     es = ERR_get_state();
 822     if (es == NULL)
 823         return 0;
 824
 825     i = es->top;
 826
 827     err_clear_data(es, i);
 828     es->err_data[i] = data;
 829     es->err_data_flags[i] = flags;
 830
 831     return 1;
 832 }
 833
 834 void ERR_set_error_data(char *data, int flags)
 835 {
 836     /*
 837      * This function is void so we cannot propagate the error return. Since it
 838      * is also in the public API we can't change the return type.
 839      */
 840     err_set_error_data_int(data, flags);
 841 }
 842
 843 void ERR_add_error_data(int num, ...)
 844 {
 845     va_list args;
 846     va_start(args, num);
 847     ERR_add_error_vdata(num, args);
 848     va_end(args);
 849 }
 850
 851 void ERR_add_error_vdata(int num, va_list args)
 852 {
 853     int i, len, size;
 854     char *str, *p, *arg;
 855     ERR_STATE *es;
 856
 857     /* Get the current error data; if an allocated string get it. */
 858     es = ERR_get_state();
 859     if (es == NULL)
 860         return;
 861     i = es->top;
 862     p = es->err_data_flags[i] == (ERR_TXT_MALLOCED | ERR_TXT_STRING)
 863             ? es->err_data[i] : "";
 864
 865     /* Start with initial (or empty) string and allocate a new buffer */
 866     size = 80 + strlen(p);
 867     if ((str = OPENSSL_malloc(size + 1)) == NULL) {
 868         /* ERRerr(ERR_F_ERR_ADD_ERROR_VDATA, ERR_R_MALLOC_FAILURE); */
 869         return;
 870     }
 871     strcpy(str, p);
 872
 873     for (len = 0; --num >= 0; ) {
 874         arg = va_arg(args, char *);
 875         if (arg == NULL)
 876             arg = "<NULL>";
 877         len += strlen(arg);
 878         if (len > size) {
 879             size = len + 20;
 880             p = OPENSSL_realloc(str, size + 1);
 881             if (p == NULL) {
 882                 OPENSSL_free(str);
 883                 return;
 884             }
 885             str = p;
 886         }
 887         OPENSSL_strlcat(str, arg, (size_t)size + 1);
 888     }
 889     if (!err_set_error_data_int(str, ERR_TXT_MALLOCED | ERR_TXT_STRING))
 890         OPENSSL_free(str);
 891 }
 892
 893 int ERR_set_mark(void)
 894 {
 895     ERR_STATE *es;
 896
 897     es = ERR_get_state();
 898     if (es == NULL)
 899         return 0;
 900
 901     if (es->bottom == es->top)
 902         return 0;
 903     es->err_flags[es->top] |= ERR_FLAG_MARK;
 904     return 1;
 905 }
 906
 907 int ERR_pop_to_mark(void)
 908 {
 909     ERR_STATE *es;
 910
 911     es = ERR_get_state();
 912     if (es == NULL)
 913         return 0;
 914
 915     while (es->bottom != es->top
 916            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 917         err_clear(es, es->top);
 918         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 919     }
 920
 921     if (es->bottom == es->top)
 922         return 0;
 923     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 924     return 1;
 925 }
 926
 927 int ERR_clear_last_mark(void)
 928 {
 929     ERR_STATE *es;
 930     int top;
 931
 932     es = ERR_get_state();
 933     if (es == NULL)
 934         return 0;
 935
 936     top = es->top;
 937     while (es->bottom != top
 938            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
 939         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 940     }
 941
 942     if (es->bottom == top)
 943         return 0;
 944     es->err_flags[top] &= ~ERR_FLAG_MARK;
 945     return 1;
 946 }
 947
 948 void err_clear_last_constant_time(int clear)
 949 {
 950     ERR_STATE *es;
 951     int top;
 952
 953     es = ERR_get_state();
 954     if (es == NULL)
 955         return;
 956
 957     top = es->top;
 958
 959     /*
 960      * Flag error as cleared but remove it elsewhere to avoid two errors
 961      * accessing the same error stack location, revealing timing information.
 962      */
 963     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
 964                                      0, ERR_FLAG_CLEAR);
 965     es->err_flags[top] |= clear;
 966 }