crypto/err/err.c

   1 /*
   2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the OpenSSL license (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <stdio.h>
  11 #include <stdarg.h>
  12 #include <string.h>
  13 #include <internal/cryptlib_int.h>
  14 #include <internal/err.h>
  15 #include <internal/err_int.h>
  16 #include <openssl/lhash.h>
  17 #include <openssl/err.h>
  18 #include <openssl/crypto.h>
  19 #include <openssl/buffer.h>
  20 #include <openssl/bio.h>
  21 #include <openssl/opensslconf.h>
  22 #include <internal/thread_once.h>
  23
  24 static int err_load_strings(const ERR_STRING_DATA *str);
  25
  26 static void ERR_STATE_free(ERR_STATE *s);
  27 #ifndef OPENSSL_NO_ERR
  28 static ERR_STRING_DATA ERR_str_libraries[] = {
  29     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
  30     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
  31     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
  32     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
  33     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
  34     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
  35     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
  36     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
  37     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
  38     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
  39     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
  40     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
  41     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
  42     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
  43     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
  44     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
  45     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
  46     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
  47     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
  48     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
  49     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
  50     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
  51     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
  52     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
  53     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
  54     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
  55     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
  56     {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
  57     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
  58     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
  59     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
  60     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
  61     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
  62     {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
  63     {0, NULL},
  64 };
  65
  66 static ERR_STRING_DATA ERR_str_functs[] = {
  67     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
  68     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
  69     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
  70     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
  71     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
  72     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
  73     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
  74     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
  75 # ifdef OPENSSL_SYS_WINDOWS
  76     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
  77 # endif
  78     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
  79     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
  80     {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
  81     {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
  82     {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
  83     {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
  84     {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
  85     {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
  86     {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
  87     {0, NULL},
  88 };
  89
  90 static ERR_STRING_DATA ERR_str_reasons[] = {
  91     {ERR_R_SYS_LIB, "system lib"},
  92     {ERR_R_BN_LIB, "BN lib"},
  93     {ERR_R_RSA_LIB, "RSA lib"},
  94     {ERR_R_DH_LIB, "DH lib"},
  95     {ERR_R_EVP_LIB, "EVP lib"},
  96     {ERR_R_BUF_LIB, "BUF lib"},
  97     {ERR_R_OBJ_LIB, "OBJ lib"},
  98     {ERR_R_PEM_LIB, "PEM lib"},
  99     {ERR_R_DSA_LIB, "DSA lib"},
 100     {ERR_R_X509_LIB, "X509 lib"},
 101     {ERR_R_ASN1_LIB, "ASN1 lib"},
 102     {ERR_R_EC_LIB, "EC lib"},
 103     {ERR_R_BIO_LIB, "BIO lib"},
 104     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
 105     {ERR_R_X509V3_LIB, "X509V3 lib"},
 106     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 107     {ERR_R_ECDSA_LIB, "ECDSA lib"},
 108
 109     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 110     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 111
 112     {ERR_R_FATAL, "fatal"},
 113     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 114     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 115      "called a function you should not call"},
 116     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 117     {ERR_R_INTERNAL_ERROR, "internal error"},
 118     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 119     {ERR_R_INIT_FAIL, "init fail"},
 120     {ERR_R_OPERATION_FAIL, "operation fail"},
 121
 122     {0, NULL},
 123 };
 124 #endif
 125
 126 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
 127 static int set_err_thread_local;
 128 static CRYPTO_THREAD_LOCAL err_thread_local;
 129
 130 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
 131 static CRYPTO_RWLOCK *err_string_lock;
 132
 133 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 134
 135 /*
 136  * The internal state
 137  */
 138
 139 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 140 static int int_err_library_number = ERR_LIB_USER;
 141
 142 static unsigned long get_error_values(int inc, int top, const char **file,
 143                                       int *line, const char **data,
 144                                       int *flags);
 145
 146 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 147 {
 148     unsigned long ret, l;
 149
 150     l = a->error;
 151     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
 152     return (ret ^ ret % 19 * 13);
 153 }
 154
 155 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 156                                const ERR_STRING_DATA *b)
 157 {
 158     return (int)(a->error - b->error);
 159 }
 160
 161 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 162 {
 163     ERR_STRING_DATA *p = NULL;
 164
 165     CRYPTO_THREAD_read_lock(err_string_lock);
 166     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
 167     CRYPTO_THREAD_unlock(err_string_lock);
 168
 169     return p;
 170 }
 171
 172 #ifndef OPENSSL_NO_ERR
 173 # define NUM_SYS_STR_REASONS 127
 174 # define LEN_SYS_STR_REASON 32
 175
 176 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 177 /*
 178  * SYS_str_reasons is filled with copies of strerror() results at
 179  * initialization. 'errno' values up to 127 should cover all usual errors,
 180  * others will be displayed numerically by ERR_error_string. It is crucial
 181  * that we have something for each reason code that occurs in
 182  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 183  * which always gets an errno value and never one of those 'standard' reason
 184  * codes.
 185  */
 186
 187 static void build_SYS_str_reasons(void)
 188 {
 189     /* OPENSSL_malloc cannot be used here, use static storage instead */
 190     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
 191     static int init = 1;
 192     int i;
 193
 194     CRYPTO_THREAD_write_lock(err_string_lock);
 195     if (!init) {
 196         CRYPTO_THREAD_unlock(err_string_lock);
 197         return;
 198     }
 199
 200     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 201         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 202
 203         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
 204         if (str->string == NULL) {
 205             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
 206             if (openssl_strerror_r(i, *dest, sizeof(*dest)))
 207                 str->string = *dest;
 208         }
 209         if (str->string == NULL)
 210             str->string = "unknown";
 211     }
 212
 213     /*
 214      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 215      * required by ERR_load_strings.
 216      */
 217
 218     init = 0;
 219
 220     CRYPTO_THREAD_unlock(err_string_lock);
 221     err_load_strings(SYS_str_reasons);
 222 }
 223 #endif
 224
 225 #define err_clear_data(p,i) \
 226         do { \
 227         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
 228                 {  \
 229                 OPENSSL_free((p)->err_data[i]); \
 230                 (p)->err_data[i]=NULL; \
 231                 } \
 232         (p)->err_data_flags[i]=0; \
 233         } while(0)
 234
 235 #define err_clear(p,i) \
 236         do { \
 237         (p)->err_flags[i]=0; \
 238         (p)->err_buffer[i]=0; \
 239         err_clear_data(p,i); \
 240         (p)->err_file[i]=NULL; \
 241         (p)->err_line[i]= -1; \
 242         } while(0)
 243
 244 static void ERR_STATE_free(ERR_STATE *s)
 245 {
 246     int i;
 247
 248     if (s == NULL)
 249         return;
 250
 251     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 252         err_clear_data(s, i);
 253     }
 254     OPENSSL_free(s);
 255 }
 256
 257 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 258 {
 259     OPENSSL_init_crypto(0, NULL);
 260     err_string_lock = CRYPTO_THREAD_lock_new();
 261     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 262                                             err_string_data_cmp);
 263     return err_string_lock != NULL && int_error_hash != NULL;
 264 }
 265
 266 void err_cleanup(void)
 267 {
 268     if (set_err_thread_local != 0)
 269         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 270     CRYPTO_THREAD_lock_free(err_string_lock);
 271     err_string_lock = NULL;
 272     lh_ERR_STRING_DATA_free(int_error_hash);
 273     int_error_hash = NULL;
 274 }
 275
 276 /*
 277  * Legacy; pack in the library.
 278  */
 279 static void err_patch(int lib, ERR_STRING_DATA *str)
 280 {
 281     unsigned long plib = ERR_PACK(lib, 0, 0);
 282
 283     for (; str->error != 0; str++)
 284         str->error |= plib;
 285 }
 286
 287 /*
 288  * Hash in |str| error strings. Assumes the URN_ONCE was done.
 289  */
 290 static int err_load_strings(const ERR_STRING_DATA *str)
 291 {
 292     CRYPTO_THREAD_write_lock(err_string_lock);
 293     for (; str->error; str++)
 294         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 295                                        (ERR_STRING_DATA *)str);
 296     CRYPTO_THREAD_unlock(err_string_lock);
 297     return 1;
 298 }
 299
 300 int ERR_load_ERR_strings(void)
 301 {
 302 #ifndef OPENSSL_NO_ERR
 303     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 304         return 0;
 305
 306     err_load_strings(ERR_str_libraries);
 307     err_load_strings(ERR_str_reasons);
 308     err_patch(ERR_LIB_SYS, ERR_str_functs);
 309     err_load_strings(ERR_str_functs);
 310     build_SYS_str_reasons();
 311 #endif
 312     return 1;
 313 }
 314
 315 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 316 {
 317     if (ERR_load_ERR_strings() == 0)
 318         return 0;
 319
 320     err_patch(lib, str);
 321     err_load_strings(str);
 322     return 1;
 323 }
 324
 325 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 326 {
 327     if (ERR_load_ERR_strings() == 0)
 328         return 0;
 329     err_load_strings(str);
 330     return 1;
 331 }
 332
 333 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 334 {
 335     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 336         return 0;
 337
 338     CRYPTO_THREAD_write_lock(err_string_lock);
 339     /*
 340      * We don't need to ERR_PACK the lib, since that was done (to
 341      * the table) when it was loaded.
 342      */
 343     for (; str->error; str++)
 344         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 345     CRYPTO_THREAD_unlock(err_string_lock);
 346
 347     return 1;
 348 }
 349
 350 void err_free_strings_int(void)
 351 {
 352     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 353         return;
 354 }
 355
 356 /********************************************************/
 357
 358 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 359 {
 360     ERR_STATE *es;
 361
 362 #ifdef _OSD_POSIX
 363     /*
 364      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 365      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 366      * something sensible. @@@ We shouldn't modify a const string, though.
 367      */
 368     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 369         char *end;
 370
 371         /* Skip the "*POSIX(" prefix */
 372         file += sizeof("*POSIX(") - 1;
 373         end = &file[strlen(file) - 1];
 374         if (*end == ')')
 375             *end = '\0';
 376         /* Optional: use the basename of the path only. */
 377         if ((end = strrchr(file, '/')) != NULL)
 378             file = &end[1];
 379     }
 380 #endif
 381     es = ERR_get_state();
 382     if (es == NULL)
 383         return;
 384
 385     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 386     if (es->top == es->bottom)
 387         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 388     es->err_flags[es->top] = 0;
 389     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 390     es->err_file[es->top] = file;
 391     es->err_line[es->top] = line;
 392     err_clear_data(es, es->top);
 393 }
 394
 395 void ERR_clear_error(void)
 396 {
 397     int i;
 398     ERR_STATE *es;
 399
 400     es = ERR_get_state();
 401     if (es == NULL)
 402         return;
 403
 404     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 405         err_clear(es, i);
 406     }
 407     es->top = es->bottom = 0;
 408 }
 409
 410 unsigned long ERR_get_error(void)
 411 {
 412     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
 413 }
 414
 415 unsigned long ERR_get_error_line(const char **file, int *line)
 416 {
 417     return (get_error_values(1, 0, file, line, NULL, NULL));
 418 }
 419
 420 unsigned long ERR_get_error_line_data(const char **file, int *line,
 421                                       const char **data, int *flags)
 422 {
 423     return (get_error_values(1, 0, file, line, data, flags));
 424 }
 425
 426 unsigned long ERR_peek_error(void)
 427 {
 428     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
 429 }
 430
 431 unsigned long ERR_peek_error_line(const char **file, int *line)
 432 {
 433     return (get_error_values(0, 0, file, line, NULL, NULL));
 434 }
 435
 436 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 437                                        const char **data, int *flags)
 438 {
 439     return (get_error_values(0, 0, file, line, data, flags));
 440 }
 441
 442 unsigned long ERR_peek_last_error(void)
 443 {
 444     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
 445 }
 446
 447 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 448 {
 449     return (get_error_values(0, 1, file, line, NULL, NULL));
 450 }
 451
 452 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 453                                             const char **data, int *flags)
 454 {
 455     return (get_error_values(0, 1, file, line, data, flags));
 456 }
 457
 458 static unsigned long get_error_values(int inc, int top, const char **file,
 459                                       int *line, const char **data,
 460                                       int *flags)
 461 {
 462     int i = 0;
 463     ERR_STATE *es;
 464     unsigned long ret;
 465
 466     es = ERR_get_state();
 467     if (es == NULL)
 468         return 0;
 469
 470     if (inc && top) {
 471         if (file)
 472             *file = "";
 473         if (line)
 474             *line = 0;
 475         if (data)
 476             *data = "";
 477         if (flags)
 478             *flags = 0;
 479
 480         return ERR_R_INTERNAL_ERROR;
 481     }
 482
 483     if (es->bottom == es->top)
 484         return 0;
 485     if (top)
 486         i = es->top;            /* last error */
 487     else
 488         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 489
 490     ret = es->err_buffer[i];
 491     if (inc) {
 492         es->bottom = i;
 493         es->err_buffer[i] = 0;
 494     }
 495
 496     if ((file != NULL) && (line != NULL)) {
 497         if (es->err_file[i] == NULL) {
 498             *file = "NA";
 499             if (line != NULL)
 500                 *line = 0;
 501         } else {
 502             *file = es->err_file[i];
 503             if (line != NULL)
 504                 *line = es->err_line[i];
 505         }
 506     }
 507
 508     if (data == NULL) {
 509         if (inc) {
 510             err_clear_data(es, i);
 511         }
 512     } else {
 513         if (es->err_data[i] == NULL) {
 514             *data = "";
 515             if (flags != NULL)
 516                 *flags = 0;
 517         } else {
 518             *data = es->err_data[i];
 519             if (flags != NULL)
 520                 *flags = es->err_data_flags[i];
 521         }
 522     }
 523     return ret;
 524 }
 525
 526 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 527 {
 528     char lsbuf[64], fsbuf[64], rsbuf[64];
 529     const char *ls, *fs, *rs;
 530     unsigned long l, f, r;
 531
 532     if (len == 0)
 533         return;
 534
 535     l = ERR_GET_LIB(e);
 536     f = ERR_GET_FUNC(e);
 537     r = ERR_GET_REASON(e);
 538
 539     ls = ERR_lib_error_string(e);
 540     fs = ERR_func_error_string(e);
 541     rs = ERR_reason_error_string(e);
 542
 543     if (ls == NULL)
 544         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 545     if (fs == NULL)
 546         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 547     if (rs == NULL)
 548         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 549
 550     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
 551                  fs ? fs : fsbuf, rs ? rs : rsbuf);
 552     if (strlen(buf) == len - 1) {
 553         /*
 554          * output may be truncated; make sure we always have 5
 555          * colon-separated fields, i.e. 4 colons ...
 556          */
 557 #define NUM_COLONS 4
 558         if (len > NUM_COLONS) { /* ... if possible */
 559             int i;
 560             char *s = buf;
 561
 562             for (i = 0; i < NUM_COLONS; i++) {
 563                 char *colon = strchr(s, ':');
 564                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
 565                     /*
 566                      * set colon no. i at last possible position (buf[len-1]
 567                      * is the terminating 0)
 568                      */
 569                     colon = &buf[len - 1] - NUM_COLONS + i;
 570                     *colon = ':';
 571                 }
 572                 s = colon + 1;
 573             }
 574         }
 575     }
 576 }
 577
 578 /*
 579  * ERR_error_string_n should be used instead for ret != NULL as
 580  * ERR_error_string cannot know how large the buffer is
 581  */
 582 char *ERR_error_string(unsigned long e, char *ret)
 583 {
 584     static char buf[256];
 585
 586     if (ret == NULL)
 587         ret = buf;
 588     ERR_error_string_n(e, ret, 256);
 589
 590     return ret;
 591 }
 592
 593 const char *ERR_lib_error_string(unsigned long e)
 594 {
 595     ERR_STRING_DATA d, *p;
 596     unsigned long l;
 597
 598     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 599         return NULL;
 600     }
 601
 602     l = ERR_GET_LIB(e);
 603     d.error = ERR_PACK(l, 0, 0);
 604     p = int_err_get_item(&d);
 605     return ((p == NULL) ? NULL : p->string);
 606 }
 607
 608 const char *ERR_func_error_string(unsigned long e)
 609 {
 610     ERR_STRING_DATA d, *p;
 611     unsigned long l, f;
 612
 613     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 614         return NULL;
 615     }
 616
 617     l = ERR_GET_LIB(e);
 618     f = ERR_GET_FUNC(e);
 619     d.error = ERR_PACK(l, f, 0);
 620     p = int_err_get_item(&d);
 621     return ((p == NULL) ? NULL : p->string);
 622 }
 623
 624 const char *ERR_reason_error_string(unsigned long e)
 625 {
 626     ERR_STRING_DATA d, *p = NULL;
 627     unsigned long l, r;
 628
 629     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 630         return NULL;
 631     }
 632
 633     l = ERR_GET_LIB(e);
 634     r = ERR_GET_REASON(e);
 635     d.error = ERR_PACK(l, 0, r);
 636     p = int_err_get_item(&d);
 637     if (!p) {
 638         d.error = ERR_PACK(0, 0, r);
 639         p = int_err_get_item(&d);
 640     }
 641     return ((p == NULL) ? NULL : p->string);
 642 }
 643
 644 void err_delete_thread_state(void)
 645 {
 646     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 647     if (state == NULL)
 648         return;
 649
 650     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 651     ERR_STATE_free(state);
 652 }
 653
 654 #if OPENSSL_API_COMPAT < 0x10100000L
 655 void ERR_remove_thread_state(void *dummy)
 656 {
 657 }
 658 #endif
 659
 660 #if OPENSSL_API_COMPAT < 0x10000000L
 661 void ERR_remove_state(unsigned long pid)
 662 {
 663 }
 664 #endif
 665
 666 DEFINE_RUN_ONCE_STATIC(err_do_init)
 667 {
 668     set_err_thread_local = 1;
 669     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 670 }
 671
 672 ERR_STATE *ERR_get_state(void)
 673 {
 674     ERR_STATE *state = NULL;
 675
 676     if (!RUN_ONCE(&err_init, err_do_init))
 677         return NULL;
 678
 679     state = CRYPTO_THREAD_get_local(&err_thread_local);
 680
 681     if (state == NULL) {
 682         state = OPENSSL_zalloc(sizeof(*state));
 683         if (state == NULL)
 684             return NULL;
 685
 686         if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
 687             || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 688             ERR_STATE_free(state);
 689             return NULL;
 690         }
 691
 692         /* Ignore failures from these */
 693         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 694     }
 695
 696     return state;
 697 }
 698
 699 int ERR_get_next_error_library(void)
 700 {
 701     int ret;
 702
 703     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 704         return 0;
 705     }
 706
 707     CRYPTO_THREAD_write_lock(err_string_lock);
 708     ret = int_err_library_number++;
 709     CRYPTO_THREAD_unlock(err_string_lock);
 710     return ret;
 711 }
 712
 713 void ERR_set_error_data(char *data, int flags)
 714 {
 715     ERR_STATE *es;
 716     int i;
 717
 718     es = ERR_get_state();
 719     if (es == NULL)
 720         return;
 721
 722     i = es->top;
 723     if (i == 0)
 724         i = ERR_NUM_ERRORS - 1;
 725
 726     err_clear_data(es, i);
 727     es->err_data[i] = data;
 728     es->err_data_flags[i] = flags;
 729 }
 730
 731 void ERR_add_error_data(int num, ...)
 732 {
 733     va_list args;
 734     va_start(args, num);
 735     ERR_add_error_vdata(num, args);
 736     va_end(args);
 737 }
 738
 739 void ERR_add_error_vdata(int num, va_list args)
 740 {
 741     int i, n, s;
 742     char *str, *p, *a;
 743
 744     s = 80;
 745     str = OPENSSL_malloc(s + 1);
 746     if (str == NULL)
 747         return;
 748     str[0] = '\0';
 749
 750     n = 0;
 751     for (i = 0; i < num; i++) {
 752         a = va_arg(args, char *);
 753         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
 754         if (a != NULL) {
 755             n += strlen(a);
 756             if (n > s) {
 757                 s = n + 20;
 758                 p = OPENSSL_realloc(str, s + 1);
 759                 if (p == NULL) {
 760                     OPENSSL_free(str);
 761                     return;
 762                 }
 763                 str = p;
 764             }
 765             OPENSSL_strlcat(str, a, (size_t)s + 1);
 766         }
 767     }
 768     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
 769 }
 770
 771 int ERR_set_mark(void)
 772 {
 773     ERR_STATE *es;
 774
 775     es = ERR_get_state();
 776     if (es == NULL)
 777         return 0;
 778
 779     if (es->bottom == es->top)
 780         return 0;
 781     es->err_flags[es->top] |= ERR_FLAG_MARK;
 782     return 1;
 783 }
 784
 785 int ERR_pop_to_mark(void)
 786 {
 787     ERR_STATE *es;
 788
 789     es = ERR_get_state();
 790     if (es == NULL)
 791         return 0;
 792
 793     while (es->bottom != es->top
 794            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 795         err_clear(es, es->top);
 796         es->top -= 1;
 797         if (es->top == -1)
 798             es->top = ERR_NUM_ERRORS - 1;
 799     }
 800
 801     if (es->bottom == es->top)
 802         return 0;
 803     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 804     return 1;
 805 }