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