crypto/err/err.c

   1 /*
   2  * Copyright 1995-2020 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 "crypto/cryptlib.h"
  17 #include "internal/err.h"
  18 #include "crypto/err.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 "crypto/ctype.h"
  26 #include "internal/constant_time.h"
  27 #include "e_os.h"
  28 #include "err_local.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_KDF, 0, 0), "KDF routines"},
  74     {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
  75     {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"},
  76     {ERR_PACK(ERR_LIB_ESS, 0, 0), "ESS routines"},
  77     {ERR_PACK(ERR_LIB_PROV, 0, 0), "Provider routines"},
  78     {ERR_PACK(ERR_LIB_OSSL_ENCODER, 0, 0), "ENCODER routines"},
  79     {ERR_PACK(ERR_LIB_OSSL_DECODER, 0, 0), "DECODER routines"},
  80     {ERR_PACK(ERR_LIB_HTTP, 0, 0), "HTTP routines"},
  81     {0, NULL},
  82 };
  83
  84 static ERR_STRING_DATA ERR_str_reasons[] = {
  85     {ERR_R_SYS_LIB, "system lib"},
  86     {ERR_R_BN_LIB, "BN lib"},
  87     {ERR_R_RSA_LIB, "RSA lib"},
  88     {ERR_R_DH_LIB, "DH lib"},
  89     {ERR_R_EVP_LIB, "EVP lib"},
  90     {ERR_R_BUF_LIB, "BUF lib"},
  91     {ERR_R_OBJ_LIB, "OBJ lib"},
  92     {ERR_R_PEM_LIB, "PEM lib"},
  93     {ERR_R_DSA_LIB, "DSA lib"},
  94     {ERR_R_X509_LIB, "X509 lib"},
  95     {ERR_R_ASN1_LIB, "ASN1 lib"},
  96     {ERR_R_EC_LIB, "EC lib"},
  97     {ERR_R_BIO_LIB, "BIO lib"},
  98     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
  99     {ERR_R_X509V3_LIB, "X509V3 lib"},
 100     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 101     {ERR_R_UI_LIB, "UI lib"},
 102     {ERR_R_OSSL_STORE_LIB, "STORE lib"},
 103     {ERR_R_ECDSA_LIB, "ECDSA lib"},
 104
 105     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 106     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 107
 108     {ERR_R_FATAL, "fatal"},
 109     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 110     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 111      "called a function you should not call"},
 112     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 113     {ERR_R_INTERNAL_ERROR, "internal error"},
 114     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 115     {ERR_R_INIT_FAIL, "init fail"},
 116     {ERR_R_OPERATION_FAIL, "operation fail"},
 117     {ERR_R_INVALID_PROVIDER_FUNCTIONS, "invalid provider functions"},
 118     {ERR_R_INTERRUPTED_OR_CANCELLED, "interrupted or cancelled"},
 119
 120     {0, NULL},
 121 };
 122 #endif
 123
 124 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
 125 static int set_err_thread_local;
 126 static CRYPTO_THREAD_LOCAL err_thread_local;
 127
 128 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
 129 static CRYPTO_RWLOCK *err_string_lock;
 130
 131 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 132
 133 /*
 134  * The internal state
 135  */
 136
 137 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 138 static int int_err_library_number = ERR_LIB_USER;
 139
 140 typedef enum ERR_GET_ACTION_e {
 141     EV_POP, EV_PEEK, EV_PEEK_LAST
 142 } ERR_GET_ACTION;
 143
 144 static unsigned long get_error_values(ERR_GET_ACTION g,
 145                                       const char **file, int *line,
 146                                       const char **func, const char **data,
 147                                       int *flags);
 148
 149 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 150 {
 151     unsigned long ret, l;
 152
 153     l = a->error;
 154     ret = l ^ ERR_GET_LIB(l);
 155     return (ret ^ ret % 19 * 13);
 156 }
 157
 158 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 159                                const ERR_STRING_DATA *b)
 160 {
 161     if (a->error == b->error)
 162         return 0;
 163     return a->error > b->error ? 1 : -1;
 164 }
 165
 166 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 167 {
 168     ERR_STRING_DATA *p = NULL;
 169
 170     CRYPTO_THREAD_read_lock(err_string_lock);
 171     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
 172     CRYPTO_THREAD_unlock(err_string_lock);
 173
 174     return p;
 175 }
 176
 177 static void ERR_STATE_free(ERR_STATE *s)
 178 {
 179     int i;
 180
 181     if (s == NULL)
 182         return;
 183     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 184         err_clear_data(s, i, 1);
 185     }
 186     OPENSSL_free(s);
 187 }
 188
 189 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 190 {
 191     if (!OPENSSL_init_crypto(0, NULL))
 192         return 0;
 193     err_string_lock = CRYPTO_THREAD_lock_new();
 194     if (err_string_lock == NULL)
 195         return 0;
 196     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 197                                             err_string_data_cmp);
 198     if (int_error_hash == NULL) {
 199         CRYPTO_THREAD_lock_free(err_string_lock);
 200         err_string_lock = NULL;
 201         return 0;
 202     }
 203     return 1;
 204 }
 205
 206 void err_cleanup(void)
 207 {
 208     if (set_err_thread_local != 0)
 209         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 210     CRYPTO_THREAD_lock_free(err_string_lock);
 211     err_string_lock = NULL;
 212     lh_ERR_STRING_DATA_free(int_error_hash);
 213     int_error_hash = NULL;
 214 }
 215
 216 /*
 217  * Legacy; pack in the library.
 218  */
 219 static void err_patch(int lib, ERR_STRING_DATA *str)
 220 {
 221     unsigned long plib = ERR_PACK(lib, 0, 0);
 222
 223     for (; str->error != 0; str++)
 224         str->error |= plib;
 225 }
 226
 227 /*
 228  * Hash in |str| error strings. Assumes the RUN_ONCE was done.
 229  */
 230 static int err_load_strings(const ERR_STRING_DATA *str)
 231 {
 232     CRYPTO_THREAD_write_lock(err_string_lock);
 233     for (; str->error; str++)
 234         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 235                                        (ERR_STRING_DATA *)str);
 236     CRYPTO_THREAD_unlock(err_string_lock);
 237     return 1;
 238 }
 239
 240 int err_load_ERR_strings_int(void)
 241 {
 242 #ifndef OPENSSL_NO_ERR
 243     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 244         return 0;
 245
 246     err_load_strings(ERR_str_libraries);
 247     err_load_strings(ERR_str_reasons);
 248 #endif
 249     return 1;
 250 }
 251
 252 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 253 {
 254     if (err_load_ERR_strings_int() == 0)
 255         return 0;
 256
 257     err_patch(lib, str);
 258     err_load_strings(str);
 259     return 1;
 260 }
 261
 262 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 263 {
 264     if (err_load_ERR_strings_int() == 0)
 265         return 0;
 266     err_load_strings(str);
 267     return 1;
 268 }
 269
 270 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 271 {
 272     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 273         return 0;
 274
 275     CRYPTO_THREAD_write_lock(err_string_lock);
 276     /*
 277      * We don't need to ERR_PACK the lib, since that was done (to
 278      * the table) when it was loaded.
 279      */
 280     for (; str->error; str++)
 281         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 282     CRYPTO_THREAD_unlock(err_string_lock);
 283
 284     return 1;
 285 }
 286
 287 void err_free_strings_int(void)
 288 {
 289     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 290         return;
 291 }
 292
 293 /********************************************************/
 294
 295 void ERR_clear_error(void)
 296 {
 297     int i;
 298     ERR_STATE *es;
 299
 300     es = err_get_state_int();
 301     if (es == NULL)
 302         return;
 303
 304     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 305         err_clear(es, i, 0);
 306     }
 307     es->top = es->bottom = 0;
 308 }
 309
 310 unsigned long ERR_get_error(void)
 311 {
 312     return get_error_values(EV_POP, NULL, NULL, NULL, NULL, NULL);
 313 }
 314
 315 unsigned long ERR_get_error_all(const char **file, int *line,
 316                                 const char **func,
 317                                 const char **data, int *flags)
 318 {
 319     return get_error_values(EV_POP, file, line, func, data, flags);
 320 }
 321
 322 #ifndef OPENSSL_NO_DEPRECATED_3_0
 323 unsigned long ERR_get_error_line(const char **file, int *line)
 324 {
 325     return get_error_values(EV_POP, file, line, NULL, NULL, NULL);
 326 }
 327
 328 unsigned long ERR_get_error_line_data(const char **file, int *line,
 329                                       const char **data, int *flags)
 330 {
 331     return get_error_values(EV_POP, file, line, NULL, data, flags);
 332 }
 333 #endif
 334
 335 unsigned long ERR_peek_error(void)
 336 {
 337     return get_error_values(EV_PEEK, NULL, NULL, NULL, NULL, NULL);
 338 }
 339
 340 unsigned long ERR_peek_error_line(const char **file, int *line)
 341 {
 342     return get_error_values(EV_PEEK, file, line, NULL, NULL, NULL);
 343 }
 344
 345 unsigned long ERR_peek_error_func(const char **func)
 346 {
 347     return get_error_values(EV_PEEK, NULL, NULL, func, NULL, NULL);
 348 }
 349
 350 unsigned long ERR_peek_error_data(const char **data, int *flags)
 351 {
 352     return get_error_values(EV_PEEK, NULL, NULL, NULL, data, flags);
 353 }
 354
 355 unsigned long ERR_peek_error_all(const char **file, int *line,
 356                                  const char **func,
 357                                  const char **data, int *flags)
 358 {
 359     return get_error_values(EV_PEEK, file, line, func, data, flags);
 360 }
 361
 362 #ifndef OPENSSL_NO_DEPRECATED_3_0
 363 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 364                                        const char **data, int *flags)
 365 {
 366     return get_error_values(EV_PEEK, file, line, NULL, data, flags);
 367 }
 368 #endif
 369
 370 unsigned long ERR_peek_last_error(void)
 371 {
 372     return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, NULL, NULL);
 373 }
 374
 375 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 376 {
 377     return get_error_values(EV_PEEK_LAST, file, line, NULL, NULL, NULL);
 378 }
 379
 380 unsigned long ERR_peek_last_error_func(const char **func)
 381 {
 382     return get_error_values(EV_PEEK_LAST, NULL, NULL, func, NULL, NULL);
 383 }
 384
 385 unsigned long ERR_peek_last_error_data(const char **data, int *flags)
 386 {
 387     return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, data, flags);
 388 }
 389
 390 unsigned long ERR_peek_last_error_all(const char **file, int *line,
 391                                       const char **func,
 392                                       const char **data, int *flags)
 393 {
 394     return get_error_values(EV_PEEK_LAST, file, line, func, data, flags);
 395 }
 396
 397 #ifndef OPENSSL_NO_DEPRECATED_3_0
 398 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 399                                             const char **data, int *flags)
 400 {
 401     return get_error_values(EV_PEEK_LAST, file, line, NULL, data, flags);
 402 }
 403 #endif
 404
 405 static unsigned long get_error_values(ERR_GET_ACTION g,
 406                                       const char **file, int *line,
 407                                       const char **func,
 408                                       const char **data, int *flags)
 409 {
 410     int i = 0;
 411     ERR_STATE *es;
 412     unsigned long ret;
 413
 414     es = err_get_state_int();
 415     if (es == NULL)
 416         return 0;
 417
 418     /*
 419      * Clear anything that should have been cleared earlier. We do this
 420      * here because this doesn't have constant-time issues.
 421      */
 422     while (es->bottom != es->top) {
 423         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
 424             err_clear(es, es->top, 0);
 425             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 426             continue;
 427         }
 428         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 429         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
 430             es->bottom = i;
 431             err_clear(es, es->bottom, 0);
 432             continue;
 433         }
 434         break;
 435     }
 436
 437     /* If everything has been cleared, the stack is empty. */
 438     if (es->bottom == es->top)
 439         return 0;
 440
 441     /* Which error, the top of stack (latest one) or the first one? */
 442     if (g == EV_PEEK_LAST)
 443         i = es->top;
 444     else
 445         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 446
 447     ret = es->err_buffer[i];
 448     if (g == EV_POP) {
 449         es->bottom = i;
 450         es->err_buffer[i] = 0;
 451     }
 452
 453     if (file != NULL) {
 454         *file = es->err_file[i];
 455         if (*file == NULL)
 456             *file = "";
 457     }
 458     if (line != NULL)
 459         *line = es->err_line[i];
 460     if (func != NULL) {
 461         *func = es->err_func[i];
 462         if (*func == NULL)
 463             *func = "";
 464     }
 465     if (flags != NULL)
 466         *flags = es->err_data_flags[i];
 467     if (data == NULL) {
 468         if (g == EV_POP) {
 469             err_clear_data(es, i, 0);
 470         }
 471     } else {
 472         *data = es->err_data[i];
 473         if (*data == NULL) {
 474             *data = "";
 475             if (flags != NULL)
 476                 *flags = 0;
 477         }
 478     }
 479     return ret;
 480 }
 481
 482 void ossl_err_string_int(unsigned long e, const char *func,
 483                          char *buf, size_t len)
 484 {
 485     char lsbuf[64], rsbuf[256];
 486     const char *ls, *rs = NULL;
 487     unsigned long l, r;
 488
 489     if (len == 0)
 490         return;
 491
 492     l = ERR_GET_LIB(e);
 493     ls = ERR_lib_error_string(e);
 494     if (ls == NULL) {
 495         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 496         ls = lsbuf;
 497     }
 498
 499     /*
 500      * ERR_reason_error_string() can't safely return system error strings,
 501      * since it would call openssl_strerror_r(), which needs a buffer for
 502      * thread safety.  So for system errors, we call openssl_strerror_r()
 503      * directly instead.
 504      */
 505     r = ERR_GET_REASON(e);
 506 #ifndef OPENSSL_NO_ERR
 507     if (ERR_SYSTEM_ERROR(e)) {
 508         if (openssl_strerror_r(r, rsbuf, sizeof(rsbuf)))
 509             rs = rsbuf;
 510     } else {
 511         rs = ERR_reason_error_string(e);
 512     }
 513 #endif
 514     if (rs == NULL) {
 515         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 516         rs = rsbuf;
 517     }
 518
 519     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, func, rs);
 520     if (strlen(buf) == len - 1) {
 521         /* Didn't fit; use a minimal format. */
 522         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, 0L, r);
 523     }
 524 }
 525
 526
 527 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 528 {
 529     ossl_err_string_int(e, "", buf, len);
 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 #ifndef OPENSSL_NO_DEPRECATED_3_0
 562 const char *ERR_func_error_string(unsigned long e)
 563 {
 564     return NULL;
 565 }
 566 #endif
 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     /*
 578      * ERR_reason_error_string() can't safely return system error strings,
 579      * since openssl_strerror_r() needs a buffer for thread safety, and we
 580      * haven't got one that would serve any sensible purpose.
 581      */
 582     if (ERR_SYSTEM_ERROR(e))
 583         return NULL;
 584
 585     l = ERR_GET_LIB(e);
 586     r = ERR_GET_REASON(e);
 587     d.error = ERR_PACK(l, 0, r);
 588     p = int_err_get_item(&d);
 589     if (p == NULL) {
 590         d.error = ERR_PACK(0, 0, r);
 591         p = int_err_get_item(&d);
 592     }
 593     return ((p == NULL) ? NULL : p->string);
 594 }
 595
 596 static void err_delete_thread_state(void *unused)
 597 {
 598     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 599     if (state == NULL)
 600         return;
 601
 602     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 603     ERR_STATE_free(state);
 604 }
 605
 606 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
 607 void ERR_remove_thread_state(void *dummy)
 608 {
 609 }
 610 #endif
 611
 612 #ifndef OPENSSL_NO_DEPRECATED_1_0_0
 613 void ERR_remove_state(unsigned long pid)
 614 {
 615 }
 616 #endif
 617
 618 DEFINE_RUN_ONCE_STATIC(err_do_init)
 619 {
 620     set_err_thread_local = 1;
 621     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 622 }
 623
 624 ERR_STATE *err_get_state_int(void)
 625 {
 626     ERR_STATE *state;
 627     int saveerrno = get_last_sys_error();
 628
 629     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 630         return NULL;
 631
 632     if (!RUN_ONCE(&err_init, err_do_init))
 633         return NULL;
 634
 635     state = CRYPTO_THREAD_get_local(&err_thread_local);
 636     if (state == (ERR_STATE*)-1)
 637         return NULL;
 638
 639     if (state == NULL) {
 640         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 641             return NULL;
 642
 643         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
 644             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 645             return NULL;
 646         }
 647
 648         if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state)
 649                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 650             ERR_STATE_free(state);
 651             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 652             return NULL;
 653         }
 654
 655         /* Ignore failures from these */
 656         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 657     }
 658
 659     set_sys_error(saveerrno);
 660     return state;
 661 }
 662
 663 #ifndef OPENSSL_NO_DEPRECATED_3_0
 664 ERR_STATE *ERR_get_state(void)
 665 {
 666     return err_get_state_int();
 667 }
 668 #endif
 669
 670
 671 /*
 672  * err_shelve_state returns the current thread local error state
 673  * and freezes the error module until err_unshelve_state is called.
 674  */
 675 int err_shelve_state(void **state)
 676 {
 677     int saveerrno = get_last_sys_error();
 678
 679     /*
 680      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
 681      * via ossl_init_load_crypto_nodelete(), by which point the requested
 682      * "base" initialization has already been performed, so the below call is a
 683      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
 684      *
 685      * If are no other valid callers of this function, the call below can be
 686      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
 687      * potential uses that are not from inside OPENSSL_init_crypto(), then this
 688      * call is needed, but some care is required to make sure that the re-entry
 689      * remains a NOOP.
 690      */
 691     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 692         return 0;
 693
 694     if (!RUN_ONCE(&err_init, err_do_init))
 695         return 0;
 696
 697     *state = CRYPTO_THREAD_get_local(&err_thread_local);
 698     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 699         return 0;
 700
 701     set_sys_error(saveerrno);
 702     return 1;
 703 }
 704
 705 /*
 706  * err_unshelve_state restores the error state that was returned
 707  * by err_shelve_state previously.
 708  */
 709 void err_unshelve_state(void* state)
 710 {
 711     if (state != (void*)-1)
 712         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
 713 }
 714
 715 int ERR_get_next_error_library(void)
 716 {
 717     int ret;
 718
 719     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 720         return 0;
 721
 722     CRYPTO_THREAD_write_lock(err_string_lock);
 723     ret = int_err_library_number++;
 724     CRYPTO_THREAD_unlock(err_string_lock);
 725     return ret;
 726 }
 727
 728 static int err_set_error_data_int(char *data, size_t size, int flags,
 729                                   int deallocate)
 730 {
 731     ERR_STATE *es;
 732
 733     es = err_get_state_int();
 734     if (es == NULL)
 735         return 0;
 736
 737     err_clear_data(es, es->top, deallocate);
 738     err_set_data(es, es->top, data, size, flags);
 739
 740     return 1;
 741 }
 742
 743 void ERR_set_error_data(char *data, int flags)
 744 {
 745     /*
 746      * This function is void so we cannot propagate the error return. Since it
 747      * is also in the public API we can't change the return type.
 748      *
 749      * We estimate the size of the data.  If it's not flagged as allocated,
 750      * then this is safe, and if it is flagged as allocated, then our size
 751      * may be smaller than the actual allocation, but that doesn't matter
 752      * too much, the buffer will remain untouched or will eventually be
 753      * reallocated to a new size.
 754      *
 755      * callers should be advised that this function takes over ownership of
 756      * the allocated memory, i.e. they can't count on the pointer to remain
 757      * valid.
 758      */
 759     err_set_error_data_int(data, strlen(data) + 1, flags, 1);
 760 }
 761
 762 void ERR_add_error_data(int num, ...)
 763 {
 764     va_list args;
 765     va_start(args, num);
 766     ERR_add_error_vdata(num, args);
 767     va_end(args);
 768 }
 769
 770 void ERR_add_error_vdata(int num, va_list args)
 771 {
 772     int i, len, size;
 773     int flags = ERR_TXT_MALLOCED | ERR_TXT_STRING;
 774     char *str, *arg;
 775     ERR_STATE *es;
 776
 777     /* Get the current error data; if an allocated string get it. */
 778     es = err_get_state_int();
 779     if (es == NULL)
 780         return;
 781     i = es->top;
 782
 783     /*
 784      * If err_data is allocated already, re-use the space.
 785      * Otherwise, allocate a small new buffer.
 786      */
 787     if ((es->err_data_flags[i] & flags) == flags) {
 788         str = es->err_data[i];
 789         size = es->err_data_size[i];
 790
 791         /*
 792          * To protect the string we just grabbed from tampering by other
 793          * functions we may call, or to protect them from freeing a pointer
 794          * that may no longer be valid at that point, we clear away the
 795          * data pointer and the flags.  We will set them again at the end
 796          * of this function.
 797          */
 798         es->err_data[i] = NULL;
 799         es->err_data_flags[i] = 0;
 800     } else if ((str = OPENSSL_malloc(size = 81)) == NULL) {
 801         return;
 802     } else {
 803         str[0] = '\0';
 804     }
 805     len = strlen(str);
 806
 807     while (--num >= 0) {
 808         arg = va_arg(args, char *);
 809         if (arg == NULL)
 810             arg = "<NULL>";
 811         len += strlen(arg);
 812         if (len >= size) {
 813             char *p;
 814
 815             size = len + 20;
 816             p = OPENSSL_realloc(str, size);
 817             if (p == NULL) {
 818                 OPENSSL_free(str);
 819                 return;
 820             }
 821             str = p;
 822         }
 823         OPENSSL_strlcat(str, arg, (size_t)size);
 824     }
 825     if (!err_set_error_data_int(str, size, flags, 0))
 826         OPENSSL_free(str);
 827 }
 828
 829 int ERR_set_mark(void)
 830 {
 831     ERR_STATE *es;
 832
 833     es = err_get_state_int();
 834     if (es == NULL)
 835         return 0;
 836
 837     if (es->bottom == es->top)
 838         return 0;
 839     es->err_marks[es->top]++;
 840     return 1;
 841 }
 842
 843 int ERR_pop_to_mark(void)
 844 {
 845     ERR_STATE *es;
 846
 847     es = err_get_state_int();
 848     if (es == NULL)
 849         return 0;
 850
 851     while (es->bottom != es->top
 852            && es->err_marks[es->top] == 0) {
 853         err_clear(es, es->top, 0);
 854         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 855     }
 856
 857     if (es->bottom == es->top)
 858         return 0;
 859     es->err_marks[es->top]--;
 860     return 1;
 861 }
 862
 863 int ERR_clear_last_mark(void)
 864 {
 865     ERR_STATE *es;
 866     int top;
 867
 868     es = err_get_state_int();
 869     if (es == NULL)
 870         return 0;
 871
 872     top = es->top;
 873     while (es->bottom != top
 874            && es->err_marks[top] == 0) {
 875         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 876     }
 877
 878     if (es->bottom == top)
 879         return 0;
 880     es->err_marks[top]--;
 881     return 1;
 882 }
 883
 884 void err_clear_last_constant_time(int clear)
 885 {
 886     ERR_STATE *es;
 887     int top;
 888
 889     es = err_get_state_int();
 890     if (es == NULL)
 891         return;
 892
 893     top = es->top;
 894
 895     /*
 896      * Flag error as cleared but remove it elsewhere to avoid two errors
 897      * accessing the same error stack location, revealing timing information.
 898      */
 899     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
 900                                      0, ERR_FLAG_CLEAR);
 901     es->err_flags[top] |= clear;
 902 }