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_error(int lib, int func, int reason, const char *file, int line)
 376 {
 377     ERR_STATE *es;
 378
 379 #ifdef _OSD_POSIX
 380     /*
 381      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 382      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 383      * something sensible. @@@ We shouldn't modify a const string, though.
 384      */
 385     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 386         char *end;
 387
 388         /* Skip the "*POSIX(" prefix */
 389         file += sizeof("*POSIX(") - 1;
 390         end = &file[strlen(file) - 1];
 391         if (*end == ')')
 392             *end = '\0';
 393         /* Optional: use the basename of the path only. */
 394         if ((end = strrchr(file, '/')) != NULL)
 395             file = &end[1];
 396     }
 397 #endif
 398     es = ERR_get_state();
 399     if (es == NULL)
 400         return;
 401
 402     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 403     if (es->top == es->bottom)
 404         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 405     es->err_flags[es->top] = 0;
 406     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 407     es->err_file[es->top] = file;
 408     es->err_line[es->top] = line;
 409     err_clear_data(es, es->top);
 410 }
 411
 412 void ERR_clear_error(void)
 413 {
 414     int i;
 415     ERR_STATE *es;
 416
 417     es = ERR_get_state();
 418     if (es == NULL)
 419         return;
 420
 421     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 422         err_clear(es, i);
 423     }
 424     es->top = es->bottom = 0;
 425 }
 426
 427 unsigned long ERR_get_error(void)
 428 {
 429     return get_error_values(1, 0, NULL, NULL, NULL, NULL);
 430 }
 431
 432 unsigned long ERR_get_error_line(const char **file, int *line)
 433 {
 434     return get_error_values(1, 0, file, line, NULL, NULL);
 435 }
 436
 437 unsigned long ERR_get_error_line_data(const char **file, int *line,
 438                                       const char **data, int *flags)
 439 {
 440     return get_error_values(1, 0, file, line, data, flags);
 441 }
 442
 443 unsigned long ERR_peek_error(void)
 444 {
 445     return get_error_values(0, 0, NULL, NULL, NULL, NULL);
 446 }
 447
 448 unsigned long ERR_peek_error_line(const char **file, int *line)
 449 {
 450     return get_error_values(0, 0, file, line, NULL, NULL);
 451 }
 452
 453 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 454                                        const char **data, int *flags)
 455 {
 456     return get_error_values(0, 0, file, line, data, flags);
 457 }
 458
 459 unsigned long ERR_peek_last_error(void)
 460 {
 461     return get_error_values(0, 1, NULL, NULL, NULL, NULL);
 462 }
 463
 464 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 465 {
 466     return get_error_values(0, 1, file, line, NULL, NULL);
 467 }
 468
 469 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 470                                             const char **data, int *flags)
 471 {
 472     return get_error_values(0, 1, file, line, data, flags);
 473 }
 474
 475 static unsigned long get_error_values(int inc, int top, const char **file,
 476                                       int *line, const char **data,
 477                                       int *flags)
 478 {
 479     int i = 0;
 480     ERR_STATE *es;
 481     unsigned long ret;
 482
 483     es = ERR_get_state();
 484     if (es == NULL)
 485         return 0;
 486
 487     if (inc && top) {
 488         if (file)
 489             *file = "";
 490         if (line)
 491             *line = 0;
 492         if (data)
 493             *data = "";
 494         if (flags)
 495             *flags = 0;
 496
 497         return ERR_R_INTERNAL_ERROR;
 498     }
 499
 500     while (es->bottom != es->top) {
 501         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
 502             err_clear(es, es->top);
 503             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 504             continue;
 505         }
 506         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 507         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
 508             es->bottom = i;
 509             err_clear(es, es->bottom);
 510             continue;
 511         }
 512         break;
 513     }
 514
 515     if (es->bottom == es->top)
 516         return 0;
 517
 518     if (top)
 519         i = es->top;            /* last error */
 520     else
 521         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 522
 523     ret = es->err_buffer[i];
 524     if (inc) {
 525         es->bottom = i;
 526         es->err_buffer[i] = 0;
 527     }
 528
 529     if (file != NULL && line != NULL) {
 530         if (es->err_file[i] == NULL) {
 531             *file = "NA";
 532             *line = 0;
 533         } else {
 534             *file = es->err_file[i];
 535             *line = es->err_line[i];
 536         }
 537     }
 538
 539     if (data == NULL) {
 540         if (inc) {
 541             err_clear_data(es, i);
 542         }
 543     } else {
 544         if (es->err_data[i] == NULL) {
 545             *data = "";
 546             if (flags != NULL)
 547                 *flags = 0;
 548         } else {
 549             *data = es->err_data[i];
 550             if (flags != NULL)
 551                 *flags = es->err_data_flags[i];
 552         }
 553     }
 554     return ret;
 555 }
 556
 557 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 558 {
 559     char lsbuf[64], rsbuf[64];
 560     const char *ls, *rs;
 561     unsigned long f = 0, l, r;
 562
 563     if (len == 0)
 564         return;
 565
 566     l = ERR_GET_LIB(e);
 567     ls = ERR_lib_error_string(e);
 568     if (ls == NULL) {
 569         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 570         ls = lsbuf;
 571     }
 572
 573     rs = ERR_reason_error_string(e);
 574     r = ERR_GET_REASON(e);
 575     if (rs == NULL) {
 576         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 577         rs = rsbuf;
 578     }
 579
 580     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, "", rs);
 581     if (strlen(buf) == len - 1) {
 582         /* Didn't fit; use a minimal format. */
 583         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
 584     }
 585 }
 586
 587 /*
 588  * ERR_error_string_n should be used instead for ret != NULL as
 589  * ERR_error_string cannot know how large the buffer is
 590  */
 591 char *ERR_error_string(unsigned long e, char *ret)
 592 {
 593     static char buf[256];
 594
 595     if (ret == NULL)
 596         ret = buf;
 597     ERR_error_string_n(e, ret, (int)sizeof(buf));
 598     return ret;
 599 }
 600
 601 const char *ERR_lib_error_string(unsigned long e)
 602 {
 603     ERR_STRING_DATA d, *p;
 604     unsigned long l;
 605
 606     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 607         return NULL;
 608     }
 609
 610     l = ERR_GET_LIB(e);
 611     d.error = ERR_PACK(l, 0, 0);
 612     p = int_err_get_item(&d);
 613     return ((p == NULL) ? NULL : p->string);
 614 }
 615
 616 const char *ERR_func_error_string(unsigned long e)
 617 {
 618     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 619         return NULL;
 620     return ERR_GET_LIB(e) == ERR_LIB_SYS ? "system library" : NULL;
 621 }
 622
 623 const char *ERR_reason_error_string(unsigned long e)
 624 {
 625     ERR_STRING_DATA d, *p = NULL;
 626     unsigned long l, r;
 627
 628     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 629         return NULL;
 630     }
 631
 632     l = ERR_GET_LIB(e);
 633     r = ERR_GET_REASON(e);
 634     d.error = ERR_PACK(l, 0, r);
 635     p = int_err_get_item(&d);
 636     if (!p) {
 637         d.error = ERR_PACK(0, 0, r);
 638         p = int_err_get_item(&d);
 639     }
 640     return ((p == NULL) ? NULL : p->string);
 641 }
 642
 643 /* TODO(3.0): arg ignored for now */
 644 static void err_delete_thread_state(void *arg)
 645 {
 646     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 647     if (state == NULL)
 648         return;
 649
 650     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 651     ERR_STATE_free(state);
 652 }
 653
 654 #if !OPENSSL_API_1_1_0
 655 void ERR_remove_thread_state(void *dummy)
 656 {
 657 }
 658 #endif
 659
 660 #if !OPENSSL_API_1_0_0
 661 void ERR_remove_state(unsigned long pid)
 662 {
 663 }
 664 #endif
 665
 666 DEFINE_RUN_ONCE_STATIC(err_do_init)
 667 {
 668     set_err_thread_local = 1;
 669     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 670 }
 671
 672 ERR_STATE *ERR_get_state(void)
 673 {
 674     ERR_STATE *state;
 675     int saveerrno = get_last_sys_error();
 676
 677     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 678         return NULL;
 679
 680     if (!RUN_ONCE(&err_init, err_do_init))
 681         return NULL;
 682
 683     state = CRYPTO_THREAD_get_local(&err_thread_local);
 684     if (state == (ERR_STATE*)-1)
 685         return NULL;
 686
 687     if (state == NULL) {
 688         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 689             return NULL;
 690
 691         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
 692             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 693             return NULL;
 694         }
 695
 696         if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state)
 697                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 698             ERR_STATE_free(state);
 699             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 700             return NULL;
 701         }
 702
 703         /* Ignore failures from these */
 704         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 705     }
 706
 707     set_sys_error(saveerrno);
 708     return state;
 709 }
 710
 711 /*
 712  * err_shelve_state returns the current thread local error state
 713  * and freezes the error module until err_unshelve_state is called.
 714  */
 715 int err_shelve_state(void **state)
 716 {
 717     int saveerrno = get_last_sys_error();
 718
 719     /*
 720      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
 721      * via ossl_init_load_crypto_nodelete(), by which point the requested
 722      * "base" initialization has already been performed, so the below call is a
 723      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
 724      *
 725      * If are no other valid callers of this function, the call below can be
 726      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
 727      * potential uses that are not from inside OPENSSL_init_crypto(), then this
 728      * call is needed, but some care is required to make sure that the re-entry
 729      * remains a NOOP.
 730      */
 731     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 732         return 0;
 733
 734     if (!RUN_ONCE(&err_init, err_do_init))
 735         return 0;
 736
 737     *state = CRYPTO_THREAD_get_local(&err_thread_local);
 738     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 739         return 0;
 740
 741     set_sys_error(saveerrno);
 742     return 1;
 743 }
 744
 745 /*
 746  * err_unshelve_state restores the error state that was returned
 747  * by err_shelve_state previously.
 748  */
 749 void err_unshelve_state(void* state)
 750 {
 751     if (state != (void*)-1)
 752         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
 753 }
 754
 755 int ERR_get_next_error_library(void)
 756 {
 757     int ret;
 758
 759     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 760         return 0;
 761
 762     CRYPTO_THREAD_write_lock(err_string_lock);
 763     ret = int_err_library_number++;
 764     CRYPTO_THREAD_unlock(err_string_lock);
 765     return ret;
 766 }
 767
 768 static int err_set_error_data_int(char *data, int flags)
 769 {
 770     ERR_STATE *es;
 771     int i;
 772
 773     es = ERR_get_state();
 774     if (es == NULL)
 775         return 0;
 776
 777     i = es->top;
 778
 779     err_clear_data(es, i);
 780     es->err_data[i] = data;
 781     es->err_data_flags[i] = flags;
 782
 783     return 1;
 784 }
 785
 786 void ERR_set_error_data(char *data, int flags)
 787 {
 788     /*
 789      * This function is void so we cannot propagate the error return. Since it
 790      * is also in the public API we can't change the return type.
 791      */
 792     err_set_error_data_int(data, flags);
 793 }
 794
 795 void ERR_add_error_data(int num, ...)
 796 {
 797     va_list args;
 798     va_start(args, num);
 799     ERR_add_error_vdata(num, args);
 800     va_end(args);
 801 }
 802
 803 void ERR_add_error_vdata(int num, va_list args)
 804 {
 805     int i, len, size;
 806     char *str, *p, *arg;
 807     ERR_STATE *es;
 808
 809     /* Get the current error data; if an allocated string get it. */
 810     es = ERR_get_state();
 811     if (es == NULL)
 812         return;
 813     i = es->top;
 814     p = es->err_data_flags[i] == (ERR_TXT_MALLOCED | ERR_TXT_STRING)
 815             ? es->err_data[i] : "";
 816
 817     /* Start with initial (or empty) string and allocate a new buffer */
 818     size = 80 + strlen(p);
 819     if ((str = OPENSSL_malloc(size + 1)) == NULL) {
 820         /* ERRerr(ERR_F_ERR_ADD_ERROR_VDATA, ERR_R_MALLOC_FAILURE); */
 821         return;
 822     }
 823     strcpy(str, p);
 824
 825     for (len = 0; --num >= 0; ) {
 826         arg = va_arg(args, char *);
 827         if (arg == NULL)
 828             arg = "<NULL>";
 829         len += strlen(arg);
 830         if (len > size) {
 831             size = len + 20;
 832             p = OPENSSL_realloc(str, size + 1);
 833             if (p == NULL) {
 834                 OPENSSL_free(str);
 835                 return;
 836             }
 837             str = p;
 838         }
 839         OPENSSL_strlcat(str, arg, (size_t)size + 1);
 840     }
 841     if (!err_set_error_data_int(str, ERR_TXT_MALLOCED | ERR_TXT_STRING))
 842         OPENSSL_free(str);
 843 }
 844
 845 int ERR_set_mark(void)
 846 {
 847     ERR_STATE *es;
 848
 849     es = ERR_get_state();
 850     if (es == NULL)
 851         return 0;
 852
 853     if (es->bottom == es->top)
 854         return 0;
 855     es->err_flags[es->top] |= ERR_FLAG_MARK;
 856     return 1;
 857 }
 858
 859 int ERR_pop_to_mark(void)
 860 {
 861     ERR_STATE *es;
 862
 863     es = ERR_get_state();
 864     if (es == NULL)
 865         return 0;
 866
 867     while (es->bottom != es->top
 868            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 869         err_clear(es, es->top);
 870         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 871     }
 872
 873     if (es->bottom == es->top)
 874         return 0;
 875     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 876     return 1;
 877 }
 878
 879 int ERR_clear_last_mark(void)
 880 {
 881     ERR_STATE *es;
 882     int top;
 883
 884     es = ERR_get_state();
 885     if (es == NULL)
 886         return 0;
 887
 888     top = es->top;
 889     while (es->bottom != top
 890            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
 891         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 892     }
 893
 894     if (es->bottom == top)
 895         return 0;
 896     es->err_flags[top] &= ~ERR_FLAG_MARK;
 897     return 1;
 898 }
 899
 900 void err_clear_last_constant_time(int clear)
 901 {
 902     ERR_STATE *es;
 903     int top;
 904
 905     es = ERR_get_state();
 906     if (es == NULL)
 907         return;
 908
 909     top = es->top;
 910
 911     /*
 912      * Flag error as cleared but remove it elsewhere to avoid two errors
 913      * accessing the same error stack location, revealing timing information.
 914      */
 915     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
 916                                      0, ERR_FLAG_CLEAR);
 917     es->err_flags[top] |= clear;
 918 }