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 #include "err_locl.h"
  26
  27 static int err_load_strings(const ERR_STRING_DATA *str);
  28
  29 static void ERR_STATE_free(ERR_STATE *s);
  30 #ifndef OPENSSL_NO_ERR
  31 static ERR_STRING_DATA ERR_str_libraries[] = {
  32     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
  33     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
  34     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
  35     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
  36     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
  37     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
  38     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
  39     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
  40     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
  41     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
  42     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
  43     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
  44     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
  45     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
  46     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
  47     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
  48     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
  49     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
  50     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
  51     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
  52     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
  53     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
  54     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
  55     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
  56     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
  57     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
  58     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
  59     {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
  60     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
  61     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
  62     {ERR_PACK(ERR_LIB_CRMF, 0, 0), "CRMF routines"},
  63     {ERR_PACK(ERR_LIB_CMP, 0, 0), "CMP routines"},
  64     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
  65     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
  66     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC 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 static void ERR_STATE_free(ERR_STATE *s)
 239 {
 240     int i;
 241
 242     if (s == NULL)
 243         return;
 244     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 245         err_clear_data(s, i, 1);
 246     }
 247     OPENSSL_free(s);
 248 }
 249
 250 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 251 {
 252     if (!OPENSSL_init_crypto(0, NULL))
 253         return 0;
 254     err_string_lock = CRYPTO_THREAD_lock_new();
 255     if (err_string_lock == NULL)
 256         return 0;
 257     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 258                                             err_string_data_cmp);
 259     if (int_error_hash == NULL) {
 260         CRYPTO_THREAD_lock_free(err_string_lock);
 261         err_string_lock = NULL;
 262         return 0;
 263     }
 264     return 1;
 265 }
 266
 267 void err_cleanup(void)
 268 {
 269     if (set_err_thread_local != 0)
 270         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 271     CRYPTO_THREAD_lock_free(err_string_lock);
 272     err_string_lock = NULL;
 273     lh_ERR_STRING_DATA_free(int_error_hash);
 274     int_error_hash = NULL;
 275 }
 276
 277 /*
 278  * Legacy; pack in the library.
 279  */
 280 static void err_patch(int lib, ERR_STRING_DATA *str)
 281 {
 282     unsigned long plib = ERR_PACK(lib, 0, 0);
 283
 284     for (; str->error != 0; str++)
 285         str->error |= plib;
 286 }
 287
 288 /*
 289  * Hash in |str| error strings. Assumes the URN_ONCE was done.
 290  */
 291 static int err_load_strings(const ERR_STRING_DATA *str)
 292 {
 293     CRYPTO_THREAD_write_lock(err_string_lock);
 294     for (; str->error; str++)
 295         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 296                                        (ERR_STRING_DATA *)str);
 297     CRYPTO_THREAD_unlock(err_string_lock);
 298     return 1;
 299 }
 300
 301 int ERR_load_ERR_strings(void)
 302 {
 303 #ifndef OPENSSL_NO_ERR
 304     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 305         return 0;
 306
 307     err_load_strings(ERR_str_libraries);
 308     err_load_strings(ERR_str_reasons);
 309     build_SYS_str_reasons();
 310 #endif
 311     return 1;
 312 }
 313
 314 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 315 {
 316     if (ERR_load_ERR_strings() == 0)
 317         return 0;
 318
 319     err_patch(lib, str);
 320     err_load_strings(str);
 321     return 1;
 322 }
 323
 324 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 325 {
 326     if (ERR_load_ERR_strings() == 0)
 327         return 0;
 328     err_load_strings(str);
 329     return 1;
 330 }
 331
 332 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 333 {
 334     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 335         return 0;
 336
 337     CRYPTO_THREAD_write_lock(err_string_lock);
 338     /*
 339      * We don't need to ERR_PACK the lib, since that was done (to
 340      * the table) when it was loaded.
 341      */
 342     for (; str->error; str++)
 343         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 344     CRYPTO_THREAD_unlock(err_string_lock);
 345
 346     return 1;
 347 }
 348
 349 void err_free_strings_int(void)
 350 {
 351     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 352         return;
 353 }
 354
 355 /********************************************************/
 356
 357 void ERR_clear_error(void)
 358 {
 359     int i;
 360     ERR_STATE *es;
 361
 362     es = ERR_get_state();
 363     if (es == NULL)
 364         return;
 365
 366     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 367         err_clear(es, i, 0);
 368     }
 369     es->top = es->bottom = 0;
 370 }
 371
 372 unsigned long ERR_get_error(void)
 373 {
 374     return get_error_values(1, 0, NULL, NULL, NULL, NULL);
 375 }
 376
 377 unsigned long ERR_get_error_line(const char **file, int *line)
 378 {
 379     return get_error_values(1, 0, file, line, NULL, NULL);
 380 }
 381
 382 unsigned long ERR_get_error_line_data(const char **file, int *line,
 383                                       const char **data, int *flags)
 384 {
 385     return get_error_values(1, 0, file, line, data, flags);
 386 }
 387
 388 unsigned long ERR_peek_error(void)
 389 {
 390     return get_error_values(0, 0, NULL, NULL, NULL, NULL);
 391 }
 392
 393 unsigned long ERR_peek_error_line(const char **file, int *line)
 394 {
 395     return get_error_values(0, 0, file, line, NULL, NULL);
 396 }
 397
 398 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 399                                        const char **data, int *flags)
 400 {
 401     return get_error_values(0, 0, file, line, data, flags);
 402 }
 403
 404 unsigned long ERR_peek_last_error(void)
 405 {
 406     return get_error_values(0, 1, NULL, NULL, NULL, NULL);
 407 }
 408
 409 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 410 {
 411     return get_error_values(0, 1, file, line, NULL, NULL);
 412 }
 413
 414 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 415                                             const char **data, int *flags)
 416 {
 417     return get_error_values(0, 1, file, line, data, flags);
 418 }
 419
 420 static unsigned long get_error_values(int inc, int top, const char **file,
 421                                       int *line, const char **data,
 422                                       int *flags)
 423 {
 424     int i = 0;
 425     ERR_STATE *es;
 426     unsigned long ret;
 427
 428     es = ERR_get_state();
 429     if (es == NULL)
 430         return 0;
 431
 432     if (inc && top) {
 433         if (file)
 434             *file = "";
 435         if (line)
 436             *line = 0;
 437         if (data)
 438             *data = "";
 439         if (flags)
 440             *flags = 0;
 441
 442         return ERR_R_INTERNAL_ERROR;
 443     }
 444
 445     while (es->bottom != es->top) {
 446         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
 447             err_clear(es, es->top, 0);
 448             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 449             continue;
 450         }
 451         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 452         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
 453             es->bottom = i;
 454             err_clear(es, es->bottom, 0);
 455             continue;
 456         }
 457         break;
 458     }
 459
 460     if (es->bottom == es->top)
 461         return 0;
 462
 463     if (top)
 464         i = es->top;            /* last error */
 465     else
 466         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 467
 468     ret = es->err_buffer[i];
 469     if (inc) {
 470         es->bottom = i;
 471         es->err_buffer[i] = 0;
 472     }
 473
 474     if (file != NULL && line != NULL) {
 475         if (es->err_file[i] == NULL) {
 476             *file = "NA";
 477             *line = 0;
 478         } else {
 479             *file = es->err_file[i];
 480             *line = es->err_line[i];
 481         }
 482     }
 483
 484     if (data == NULL) {
 485         if (inc) {
 486             err_clear_data(es, i, 0);
 487         }
 488     } else {
 489         if (es->err_data[i] == NULL) {
 490             *data = "";
 491             if (flags != NULL)
 492                 *flags = 0;
 493         } else {
 494             *data = es->err_data[i];
 495             if (flags != NULL)
 496                 *flags = es->err_data_flags[i];
 497         }
 498     }
 499     return ret;
 500 }
 501
 502 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 503 {
 504     char lsbuf[64], rsbuf[64];
 505     const char *ls, *rs;
 506     unsigned long f = 0, l, r;
 507
 508     if (len == 0)
 509         return;
 510
 511     l = ERR_GET_LIB(e);
 512     ls = ERR_lib_error_string(e);
 513     if (ls == NULL) {
 514         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 515         ls = lsbuf;
 516     }
 517
 518     rs = ERR_reason_error_string(e);
 519     r = ERR_GET_REASON(e);
 520     if (rs == NULL) {
 521         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 522         rs = rsbuf;
 523     }
 524
 525     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, "", rs);
 526     if (strlen(buf) == len - 1) {
 527         /* Didn't fit; use a minimal format. */
 528         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
 529     }
 530 }
 531
 532 /*
 533  * ERR_error_string_n should be used instead for ret != NULL as
 534  * ERR_error_string cannot know how large the buffer is
 535  */
 536 char *ERR_error_string(unsigned long e, char *ret)
 537 {
 538     static char buf[256];
 539
 540     if (ret == NULL)
 541         ret = buf;
 542     ERR_error_string_n(e, ret, (int)sizeof(buf));
 543     return ret;
 544 }
 545
 546 const char *ERR_lib_error_string(unsigned long e)
 547 {
 548     ERR_STRING_DATA d, *p;
 549     unsigned long l;
 550
 551     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 552         return NULL;
 553     }
 554
 555     l = ERR_GET_LIB(e);
 556     d.error = ERR_PACK(l, 0, 0);
 557     p = int_err_get_item(&d);
 558     return ((p == NULL) ? NULL : p->string);
 559 }
 560
 561 const char *ERR_func_error_string(unsigned long e)
 562 {
 563     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 564         return NULL;
 565     return ERR_GET_LIB(e) == ERR_LIB_SYS ? "system library" : NULL;
 566 }
 567
 568 const char *ERR_reason_error_string(unsigned long e)
 569 {
 570     ERR_STRING_DATA d, *p = NULL;
 571     unsigned long l, r;
 572
 573     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 574         return NULL;
 575     }
 576
 577     l = ERR_GET_LIB(e);
 578     r = ERR_GET_REASON(e);
 579     d.error = ERR_PACK(l, 0, r);
 580     p = int_err_get_item(&d);
 581     if (!p) {
 582         d.error = ERR_PACK(0, 0, r);
 583         p = int_err_get_item(&d);
 584     }
 585     return ((p == NULL) ? NULL : p->string);
 586 }
 587
 588 /* TODO(3.0): arg ignored for now */
 589 static void err_delete_thread_state(void *arg)
 590 {
 591     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 592     if (state == NULL)
 593         return;
 594
 595     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 596     ERR_STATE_free(state);
 597 }
 598
 599 #if !OPENSSL_API_1_1_0
 600 void ERR_remove_thread_state(void *dummy)
 601 {
 602 }
 603 #endif
 604
 605 #if !OPENSSL_API_1_0_0
 606 void ERR_remove_state(unsigned long pid)
 607 {
 608 }
 609 #endif
 610
 611 DEFINE_RUN_ONCE_STATIC(err_do_init)
 612 {
 613     set_err_thread_local = 1;
 614     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 615 }
 616
 617 ERR_STATE *ERR_get_state(void)
 618 {
 619     ERR_STATE *state;
 620     int saveerrno = get_last_sys_error();
 621
 622     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 623         return NULL;
 624
 625     if (!RUN_ONCE(&err_init, err_do_init))
 626         return NULL;
 627
 628     state = CRYPTO_THREAD_get_local(&err_thread_local);
 629     if (state == (ERR_STATE*)-1)
 630         return NULL;
 631
 632     if (state == NULL) {
 633         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 634             return NULL;
 635
 636         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
 637             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 638             return NULL;
 639         }
 640
 641         if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state)
 642                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 643             ERR_STATE_free(state);
 644             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 645             return NULL;
 646         }
 647
 648         /* Ignore failures from these */
 649         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 650     }
 651
 652     set_sys_error(saveerrno);
 653     return state;
 654 }
 655
 656 /*
 657  * err_shelve_state returns the current thread local error state
 658  * and freezes the error module until err_unshelve_state is called.
 659  */
 660 int err_shelve_state(void **state)
 661 {
 662     int saveerrno = get_last_sys_error();
 663
 664     /*
 665      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
 666      * via ossl_init_load_crypto_nodelete(), by which point the requested
 667      * "base" initialization has already been performed, so the below call is a
 668      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
 669      *
 670      * If are no other valid callers of this function, the call below can be
 671      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
 672      * potential uses that are not from inside OPENSSL_init_crypto(), then this
 673      * call is needed, but some care is required to make sure that the re-entry
 674      * remains a NOOP.
 675      */
 676     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 677         return 0;
 678
 679     if (!RUN_ONCE(&err_init, err_do_init))
 680         return 0;
 681
 682     *state = CRYPTO_THREAD_get_local(&err_thread_local);
 683     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 684         return 0;
 685
 686     set_sys_error(saveerrno);
 687     return 1;
 688 }
 689
 690 /*
 691  * err_unshelve_state restores the error state that was returned
 692  * by err_shelve_state previously.
 693  */
 694 void err_unshelve_state(void* state)
 695 {
 696     if (state != (void*)-1)
 697         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
 698 }
 699
 700 int ERR_get_next_error_library(void)
 701 {
 702     int ret;
 703
 704     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 705         return 0;
 706
 707     CRYPTO_THREAD_write_lock(err_string_lock);
 708     ret = int_err_library_number++;
 709     CRYPTO_THREAD_unlock(err_string_lock);
 710     return ret;
 711 }
 712
 713 static int err_set_error_data_int(char *data, size_t size, int flags,
 714                                   int deallocate)
 715 {
 716     ERR_STATE *es;
 717
 718     es = ERR_get_state();
 719     if (es == NULL)
 720         return 0;
 721
 722     err_clear_data(es, es->top, deallocate);
 723     err_set_data(es, es->top, data, size, flags);
 724
 725     return 1;
 726 }
 727
 728 void ERR_set_error_data(char *data, int flags)
 729 {
 730     /*
 731      * This function is void so we cannot propagate the error return. Since it
 732      * is also in the public API we can't change the return type.
 733      *
 734      * We estimate the size of the data.  If it's not flagged as allocated,
 735      * then this is safe, and if it is flagged as allocated, then our size
 736      * may be smaller than the actual allocation, but that doesn't matter
 737      * too much, the buffer will remain untouched or will eventually be
 738      * reallocated to a new size.
 739      *
 740      * callers should be advised that this function takes over ownership of
 741      * the allocated memory, i.e. they can't count on the pointer to remain
 742      * valid.
 743      */
 744     err_set_error_data_int(data, strlen(data) + 1, flags, 1);
 745 }
 746
 747 void ERR_add_error_data(int num, ...)
 748 {
 749     va_list args;
 750     va_start(args, num);
 751     ERR_add_error_vdata(num, args);
 752     va_end(args);
 753 }
 754
 755 void ERR_add_error_vdata(int num, va_list args)
 756 {
 757     int i, len, size;
 758     int flags = ERR_TXT_MALLOCED | ERR_TXT_STRING;
 759     char *str, *arg;
 760     ERR_STATE *es;
 761
 762     /* Get the current error data; if an allocated string get it. */
 763     es = ERR_get_state();
 764     if (es == NULL)
 765         return;
 766     i = es->top;
 767
 768     /*
 769      * If err_data is allocated already, re-use the space.
 770      * Otherwise, allocate a small new buffer.
 771      */
 772     if ((es->err_data_flags[i] & flags) == flags) {
 773         str = es->err_data[i];
 774         size = es->err_data_size[i];
 775
 776         /*
 777          * To protect the string we just grabbed from tampering by other
 778          * functions we may call, or to protect them from freeing a pointer
 779          * that may no longer be valid at that point, we clear away the
 780          * data pointer and the flags.  We will set them again at the end
 781          * of this function.
 782          */
 783         es->err_data[i] = NULL;
 784         es->err_data_flags[i] = 0;
 785     } else if ((str = OPENSSL_malloc(size = 81)) == NULL) {
 786         return;
 787     } else {
 788         str[0] = '\0';
 789     }
 790     len = strlen(str);
 791
 792     while (--num >= 0) {
 793         arg = va_arg(args, char *);
 794         if (arg == NULL)
 795             arg = "<NULL>";
 796         len += strlen(arg);
 797         if (len >= size) {
 798             char *p;
 799
 800             size = len + 20;
 801             p = OPENSSL_realloc(str, size);
 802             if (p == NULL) {
 803                 OPENSSL_free(str);
 804                 return;
 805             }
 806             str = p;
 807         }
 808         OPENSSL_strlcat(str, arg, (size_t)size);
 809     }
 810     if (!err_set_error_data_int(str, size, flags, 0))
 811         OPENSSL_free(str);
 812 }
 813
 814 int ERR_set_mark(void)
 815 {
 816     ERR_STATE *es;
 817
 818     es = ERR_get_state();
 819     if (es == NULL)
 820         return 0;
 821
 822     if (es->bottom == es->top)
 823         return 0;
 824     es->err_flags[es->top] |= ERR_FLAG_MARK;
 825     return 1;
 826 }
 827
 828 int ERR_pop_to_mark(void)
 829 {
 830     ERR_STATE *es;
 831
 832     es = ERR_get_state();
 833     if (es == NULL)
 834         return 0;
 835
 836     while (es->bottom != es->top
 837            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 838         err_clear(es, es->top, 0);
 839         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 840     }
 841
 842     if (es->bottom == es->top)
 843         return 0;
 844     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 845     return 1;
 846 }
 847
 848 int ERR_clear_last_mark(void)
 849 {
 850     ERR_STATE *es;
 851     int top;
 852
 853     es = ERR_get_state();
 854     if (es == NULL)
 855         return 0;
 856
 857     top = es->top;
 858     while (es->bottom != top
 859            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
 860         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 861     }
 862
 863     if (es->bottom == top)
 864         return 0;
 865     es->err_flags[top] &= ~ERR_FLAG_MARK;
 866     return 1;
 867 }
 868
 869 void err_clear_last_constant_time(int clear)
 870 {
 871     ERR_STATE *es;
 872     int top;
 873
 874     es = ERR_get_state();
 875     if (es == NULL)
 876         return;
 877
 878     top = es->top;
 879
 880     /*
 881      * Flag error as cleared but remove it elsewhere to avoid two errors
 882      * accessing the same error stack location, revealing timing information.
 883      */
 884     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
 885                                      0, ERR_FLAG_CLEAR);
 886     es->err_flags[top] |= clear;
 887 }