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