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_line(const char **file, int *line)
 316 {
 317     return get_error_values(EV_POP, file, line, NULL, NULL, NULL);
 318 }
 319
 320 unsigned long ERR_get_error_func(const char **func)
 321 {
 322     return get_error_values(EV_POP, NULL, NULL, func, NULL, NULL);
 323 }
 324
 325 unsigned long ERR_get_error_data(const char **data, int *flags)
 326 {
 327     return get_error_values(EV_POP, NULL, NULL, NULL, data, flags);
 328 }
 329
 330 unsigned long ERR_get_error_all(const char **file, int *line,
 331                                 const char **func,
 332                                 const char **data, int *flags)
 333 {
 334     return get_error_values(EV_POP, file, line, func, data, flags);
 335 }
 336
 337 #ifndef OPENSSL_NO_DEPRECATED_3_0
 338 unsigned long ERR_get_error_line_data(const char **file, int *line,
 339                                       const char **data, int *flags)
 340 {
 341     return get_error_values(EV_POP, file, line, NULL, data, flags);
 342 }
 343 #endif
 344
 345 unsigned long ERR_peek_error(void)
 346 {
 347     return get_error_values(EV_PEEK, NULL, NULL, NULL, NULL, NULL);
 348 }
 349
 350 unsigned long ERR_peek_error_line(const char **file, int *line)
 351 {
 352     return get_error_values(EV_PEEK, file, line, NULL, NULL, NULL);
 353 }
 354
 355 unsigned long ERR_peek_error_func(const char **func)
 356 {
 357     return get_error_values(EV_PEEK, NULL, NULL, func, NULL, NULL);
 358 }
 359
 360 unsigned long ERR_peek_error_data(const char **data, int *flags)
 361 {
 362     return get_error_values(EV_PEEK, NULL, NULL, NULL, data, flags);
 363 }
 364
 365 unsigned long ERR_peek_error_all(const char **file, int *line,
 366                                  const char **func,
 367                                  const char **data, int *flags)
 368 {
 369     return get_error_values(EV_PEEK, file, line, func, data, flags);
 370 }
 371
 372 #ifndef OPENSSL_NO_DEPRECATED_3_0
 373 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 374                                        const char **data, int *flags)
 375 {
 376     return get_error_values(EV_PEEK, file, line, NULL, data, flags);
 377 }
 378 #endif
 379
 380 unsigned long ERR_peek_last_error(void)
 381 {
 382     return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, NULL, NULL);
 383 }
 384
 385 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 386 {
 387     return get_error_values(EV_PEEK_LAST, file, line, NULL, NULL, NULL);
 388 }
 389
 390 unsigned long ERR_peek_last_error_func(const char **func)
 391 {
 392     return get_error_values(EV_PEEK_LAST, NULL, NULL, func, NULL, NULL);
 393 }
 394
 395 unsigned long ERR_peek_last_error_data(const char **data, int *flags)
 396 {
 397     return get_error_values(EV_PEEK_LAST, NULL, NULL, NULL, data, flags);
 398 }
 399
 400 unsigned long ERR_peek_last_error_all(const char **file, int *line,
 401                                       const char **func,
 402                                       const char **data, int *flags)
 403 {
 404     return get_error_values(EV_PEEK_LAST, file, line, func, data, flags);
 405 }
 406
 407 #ifndef OPENSSL_NO_DEPRECATED_3_0
 408 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 409                                             const char **data, int *flags)
 410 {
 411     return get_error_values(EV_PEEK_LAST, file, line, NULL, data, flags);
 412 }
 413 #endif
 414
 415 static unsigned long get_error_values(ERR_GET_ACTION g,
 416                                       const char **file, int *line,
 417                                       const char **func,
 418                                       const char **data, int *flags)
 419 {
 420     int i = 0;
 421     ERR_STATE *es;
 422     unsigned long ret;
 423
 424     es = err_get_state_int();
 425     if (es == NULL)
 426         return 0;
 427
 428     /*
 429      * Clear anything that should have been cleared earlier. We do this
 430      * here because this doesn't have constant-time issues.
 431      */
 432     while (es->bottom != es->top) {
 433         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
 434             err_clear(es, es->top, 0);
 435             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 436             continue;
 437         }
 438         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 439         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
 440             es->bottom = i;
 441             err_clear(es, es->bottom, 0);
 442             continue;
 443         }
 444         break;
 445     }
 446
 447     /* If everything has been cleared, the stack is empty. */
 448     if (es->bottom == es->top)
 449         return 0;
 450
 451     /* Which error, the top of stack (latest one) or the first one? */
 452     if (g == EV_PEEK_LAST)
 453         i = es->top;
 454     else
 455         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 456
 457     ret = es->err_buffer[i];
 458     if (g == EV_POP) {
 459         es->bottom = i;
 460         es->err_buffer[i] = 0;
 461     }
 462
 463     if (file != NULL) {
 464         *file = es->err_file[i];
 465         if (*file == NULL)
 466             *file = "";
 467     }
 468     if (line != NULL)
 469         *line = es->err_line[i];
 470     if (func != NULL) {
 471         *func = es->err_func[i];
 472         if (*func == NULL)
 473             *func = "";
 474     }
 475     if (flags != NULL)
 476         *flags = es->err_data_flags[i];
 477     if (data == NULL) {
 478         if (g == EV_POP) {
 479             err_clear_data(es, i, 0);
 480         }
 481     } else {
 482         *data = es->err_data[i];
 483         if (*data == NULL) {
 484             *data = "";
 485             if (flags != NULL)
 486                 *flags = 0;
 487         }
 488     }
 489     return ret;
 490 }
 491
 492 void ossl_err_string_int(unsigned long e, const char *func,
 493                          char *buf, size_t len)
 494 {
 495     char lsbuf[64], rsbuf[256];
 496     const char *ls, *rs = NULL;
 497     unsigned long l, r;
 498
 499     if (len == 0)
 500         return;
 501
 502     l = ERR_GET_LIB(e);
 503     ls = ERR_lib_error_string(e);
 504     if (ls == NULL) {
 505         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 506         ls = lsbuf;
 507     }
 508
 509     /*
 510      * ERR_reason_error_string() can't safely return system error strings,
 511      * since it would call openssl_strerror_r(), which needs a buffer for
 512      * thread safety.  So for system errors, we call openssl_strerror_r()
 513      * directly instead.
 514      */
 515     r = ERR_GET_REASON(e);
 516 #ifndef OPENSSL_NO_ERR
 517     if (ERR_SYSTEM_ERROR(e)) {
 518         if (openssl_strerror_r(r, rsbuf, sizeof(rsbuf)))
 519             rs = rsbuf;
 520     } else {
 521         rs = ERR_reason_error_string(e);
 522     }
 523 #endif
 524     if (rs == NULL) {
 525         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 526         rs = rsbuf;
 527     }
 528
 529     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, func, rs);
 530     if (strlen(buf) == len - 1) {
 531         /* Didn't fit; use a minimal format. */
 532         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, 0L, r);
 533     }
 534 }
 535
 536
 537 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 538 {
 539     ossl_err_string_int(e, "", buf, len);
 540 }
 541
 542 /*
 543  * ERR_error_string_n should be used instead for ret != NULL as
 544  * ERR_error_string cannot know how large the buffer is
 545  */
 546 char *ERR_error_string(unsigned long e, char *ret)
 547 {
 548     static char buf[256];
 549
 550     if (ret == NULL)
 551         ret = buf;
 552     ERR_error_string_n(e, ret, (int)sizeof(buf));
 553     return ret;
 554 }
 555
 556 const char *ERR_lib_error_string(unsigned long e)
 557 {
 558     ERR_STRING_DATA d, *p;
 559     unsigned long l;
 560
 561     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 562         return NULL;
 563     }
 564
 565     l = ERR_GET_LIB(e);
 566     d.error = ERR_PACK(l, 0, 0);
 567     p = int_err_get_item(&d);
 568     return ((p == NULL) ? NULL : p->string);
 569 }
 570
 571 #ifndef OPENSSL_NO_DEPRECATED_3_0
 572 const char *ERR_func_error_string(unsigned long e)
 573 {
 574     return NULL;
 575 }
 576 #endif
 577
 578 const char *ERR_reason_error_string(unsigned long e)
 579 {
 580     ERR_STRING_DATA d, *p = NULL;
 581     unsigned long l, r;
 582
 583     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 584         return NULL;
 585     }
 586
 587     /*
 588      * ERR_reason_error_string() can't safely return system error strings,
 589      * since openssl_strerror_r() needs a buffer for thread safety, and we
 590      * haven't got one that would serve any sensible purpose.
 591      */
 592     if (ERR_SYSTEM_ERROR(e))
 593         return NULL;
 594
 595     l = ERR_GET_LIB(e);
 596     r = ERR_GET_REASON(e);
 597     d.error = ERR_PACK(l, 0, r);
 598     p = int_err_get_item(&d);
 599     if (p == NULL) {
 600         d.error = ERR_PACK(0, 0, r);
 601         p = int_err_get_item(&d);
 602     }
 603     return ((p == NULL) ? NULL : p->string);
 604 }
 605
 606 /* TODO(3.0): arg ignored for now */
 607 static void err_delete_thread_state(void *arg)
 608 {
 609     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 610     if (state == NULL)
 611         return;
 612
 613     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 614     ERR_STATE_free(state);
 615 }
 616
 617 #ifndef OPENSSL_NO_DEPRECATED_1_1_0
 618 void ERR_remove_thread_state(void *dummy)
 619 {
 620 }
 621 #endif
 622
 623 #ifndef OPENSSL_NO_DEPRECATED_1_0_0
 624 void ERR_remove_state(unsigned long pid)
 625 {
 626 }
 627 #endif
 628
 629 DEFINE_RUN_ONCE_STATIC(err_do_init)
 630 {
 631     set_err_thread_local = 1;
 632     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 633 }
 634
 635 ERR_STATE *err_get_state_int(void)
 636 {
 637     ERR_STATE *state;
 638     int saveerrno = get_last_sys_error();
 639
 640     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 641         return NULL;
 642
 643     if (!RUN_ONCE(&err_init, err_do_init))
 644         return NULL;
 645
 646     state = CRYPTO_THREAD_get_local(&err_thread_local);
 647     if (state == (ERR_STATE*)-1)
 648         return NULL;
 649
 650     if (state == NULL) {
 651         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 652             return NULL;
 653
 654         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
 655             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 656             return NULL;
 657         }
 658
 659         if (!ossl_init_thread_start(NULL, NULL, err_delete_thread_state)
 660                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 661             ERR_STATE_free(state);
 662             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 663             return NULL;
 664         }
 665
 666         /* Ignore failures from these */
 667         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 668     }
 669
 670     set_sys_error(saveerrno);
 671     return state;
 672 }
 673
 674 #ifndef OPENSSL_NO_DEPRECATED_3_0
 675 ERR_STATE *ERR_get_state(void)
 676 {
 677     return err_get_state_int();
 678 }
 679 #endif
 680
 681
 682 /*
 683  * err_shelve_state returns the current thread local error state
 684  * and freezes the error module until err_unshelve_state is called.
 685  */
 686 int err_shelve_state(void **state)
 687 {
 688     int saveerrno = get_last_sys_error();
 689
 690     /*
 691      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
 692      * via ossl_init_load_crypto_nodelete(), by which point the requested
 693      * "base" initialization has already been performed, so the below call is a
 694      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
 695      *
 696      * If are no other valid callers of this function, the call below can be
 697      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
 698      * potential uses that are not from inside OPENSSL_init_crypto(), then this
 699      * call is needed, but some care is required to make sure that the re-entry
 700      * remains a NOOP.
 701      */
 702     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 703         return 0;
 704
 705     if (!RUN_ONCE(&err_init, err_do_init))
 706         return 0;
 707
 708     *state = CRYPTO_THREAD_get_local(&err_thread_local);
 709     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 710         return 0;
 711
 712     set_sys_error(saveerrno);
 713     return 1;
 714 }
 715
 716 /*
 717  * err_unshelve_state restores the error state that was returned
 718  * by err_shelve_state previously.
 719  */
 720 void err_unshelve_state(void* state)
 721 {
 722     if (state != (void*)-1)
 723         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
 724 }
 725
 726 int ERR_get_next_error_library(void)
 727 {
 728     int ret;
 729
 730     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 731         return 0;
 732
 733     CRYPTO_THREAD_write_lock(err_string_lock);
 734     ret = int_err_library_number++;
 735     CRYPTO_THREAD_unlock(err_string_lock);
 736     return ret;
 737 }
 738
 739 static int err_set_error_data_int(char *data, size_t size, int flags,
 740                                   int deallocate)
 741 {
 742     ERR_STATE *es;
 743
 744     es = err_get_state_int();
 745     if (es == NULL)
 746         return 0;
 747
 748     err_clear_data(es, es->top, deallocate);
 749     err_set_data(es, es->top, data, size, flags);
 750
 751     return 1;
 752 }
 753
 754 void ERR_set_error_data(char *data, int flags)
 755 {
 756     /*
 757      * This function is void so we cannot propagate the error return. Since it
 758      * is also in the public API we can't change the return type.
 759      *
 760      * We estimate the size of the data.  If it's not flagged as allocated,
 761      * then this is safe, and if it is flagged as allocated, then our size
 762      * may be smaller than the actual allocation, but that doesn't matter
 763      * too much, the buffer will remain untouched or will eventually be
 764      * reallocated to a new size.
 765      *
 766      * callers should be advised that this function takes over ownership of
 767      * the allocated memory, i.e. they can't count on the pointer to remain
 768      * valid.
 769      */
 770     err_set_error_data_int(data, strlen(data) + 1, flags, 1);
 771 }
 772
 773 void ERR_add_error_data(int num, ...)
 774 {
 775     va_list args;
 776     va_start(args, num);
 777     ERR_add_error_vdata(num, args);
 778     va_end(args);
 779 }
 780
 781 void ERR_add_error_vdata(int num, va_list args)
 782 {
 783     int i, len, size;
 784     int flags = ERR_TXT_MALLOCED | ERR_TXT_STRING;
 785     char *str, *arg;
 786     ERR_STATE *es;
 787
 788     /* Get the current error data; if an allocated string get it. */
 789     es = err_get_state_int();
 790     if (es == NULL)
 791         return;
 792     i = es->top;
 793
 794     /*
 795      * If err_data is allocated already, re-use the space.
 796      * Otherwise, allocate a small new buffer.
 797      */
 798     if ((es->err_data_flags[i] & flags) == flags) {
 799         str = es->err_data[i];
 800         size = es->err_data_size[i];
 801
 802         /*
 803          * To protect the string we just grabbed from tampering by other
 804          * functions we may call, or to protect them from freeing a pointer
 805          * that may no longer be valid at that point, we clear away the
 806          * data pointer and the flags.  We will set them again at the end
 807          * of this function.
 808          */
 809         es->err_data[i] = NULL;
 810         es->err_data_flags[i] = 0;
 811     } else if ((str = OPENSSL_malloc(size = 81)) == NULL) {
 812         return;
 813     } else {
 814         str[0] = '\0';
 815     }
 816     len = strlen(str);
 817
 818     while (--num >= 0) {
 819         arg = va_arg(args, char *);
 820         if (arg == NULL)
 821             arg = "<NULL>";
 822         len += strlen(arg);
 823         if (len >= size) {
 824             char *p;
 825
 826             size = len + 20;
 827             p = OPENSSL_realloc(str, size);
 828             if (p == NULL) {
 829                 OPENSSL_free(str);
 830                 return;
 831             }
 832             str = p;
 833         }
 834         OPENSSL_strlcat(str, arg, (size_t)size);
 835     }
 836     if (!err_set_error_data_int(str, size, flags, 0))
 837         OPENSSL_free(str);
 838 }
 839
 840 int ERR_set_mark(void)
 841 {
 842     ERR_STATE *es;
 843
 844     es = err_get_state_int();
 845     if (es == NULL)
 846         return 0;
 847
 848     if (es->bottom == es->top)
 849         return 0;
 850     es->err_marks[es->top]++;
 851     return 1;
 852 }
 853
 854 int ERR_pop_to_mark(void)
 855 {
 856     ERR_STATE *es;
 857
 858     es = err_get_state_int();
 859     if (es == NULL)
 860         return 0;
 861
 862     while (es->bottom != es->top
 863            && es->err_marks[es->top] == 0) {
 864         err_clear(es, es->top, 0);
 865         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 866     }
 867
 868     if (es->bottom == es->top)
 869         return 0;
 870     es->err_marks[es->top]--;
 871     return 1;
 872 }
 873
 874 int ERR_clear_last_mark(void)
 875 {
 876     ERR_STATE *es;
 877     int top;
 878
 879     es = err_get_state_int();
 880     if (es == NULL)
 881         return 0;
 882
 883     top = es->top;
 884     while (es->bottom != top
 885            && es->err_marks[top] == 0) {
 886         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 887     }
 888
 889     if (es->bottom == top)
 890         return 0;
 891     es->err_marks[top]--;
 892     return 1;
 893 }
 894
 895 void err_clear_last_constant_time(int clear)
 896 {
 897     ERR_STATE *es;
 898     int top;
 899
 900     es = err_get_state_int();
 901     if (es == NULL)
 902         return;
 903
 904     top = es->top;
 905
 906     /*
 907      * Flag error as cleared but remove it elsewhere to avoid two errors
 908      * accessing the same error stack location, revealing timing information.
 909      */
 910     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
 911                                      0, ERR_FLAG_CLEAR);
 912     es->err_flags[top] |= clear;
 913 }