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