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     {ERR_PACK(0, SYS_F_OPEN, 0), "open"},
  88     {ERR_PACK(0, SYS_F_CLOSE, 0), "close"},
  89     {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"},
  90     {0, NULL},
  91 };
  92
  93 static ERR_STRING_DATA ERR_str_reasons[] = {
  94     {ERR_R_SYS_LIB, "system lib"},
  95     {ERR_R_BN_LIB, "BN lib"},
  96     {ERR_R_RSA_LIB, "RSA lib"},
  97     {ERR_R_DH_LIB, "DH lib"},
  98     {ERR_R_EVP_LIB, "EVP lib"},
  99     {ERR_R_BUF_LIB, "BUF lib"},
 100     {ERR_R_OBJ_LIB, "OBJ lib"},
 101     {ERR_R_PEM_LIB, "PEM lib"},
 102     {ERR_R_DSA_LIB, "DSA lib"},
 103     {ERR_R_X509_LIB, "X509 lib"},
 104     {ERR_R_ASN1_LIB, "ASN1 lib"},
 105     {ERR_R_EC_LIB, "EC lib"},
 106     {ERR_R_BIO_LIB, "BIO lib"},
 107     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
 108     {ERR_R_X509V3_LIB, "X509V3 lib"},
 109     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 110     {ERR_R_UI_LIB, "UI lib"},
 111     {ERR_R_ECDSA_LIB, "ECDSA lib"},
 112
 113     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 114     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 115
 116     {ERR_R_FATAL, "fatal"},
 117     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 118     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 119      "called a function you should not call"},
 120     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 121     {ERR_R_INTERNAL_ERROR, "internal error"},
 122     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 123     {ERR_R_INIT_FAIL, "init fail"},
 124     {ERR_R_OPERATION_FAIL, "operation fail"},
 125
 126     {0, NULL},
 127 };
 128 #endif
 129
 130 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
 131 static int set_err_thread_local;
 132 static CRYPTO_THREAD_LOCAL err_thread_local;
 133
 134 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
 135 static CRYPTO_RWLOCK *err_string_lock;
 136
 137 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 138
 139 /*
 140  * The internal state
 141  */
 142
 143 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 144 static int int_err_library_number = ERR_LIB_USER;
 145
 146 static unsigned long get_error_values(int inc, int top, const char **file,
 147                                       int *line, const char **data,
 148                                       int *flags);
 149
 150 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 151 {
 152     unsigned long ret, l;
 153
 154     l = a->error;
 155     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
 156     return (ret ^ ret % 19 * 13);
 157 }
 158
 159 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 160                                const ERR_STRING_DATA *b)
 161 {
 162     return (int)(a->error - b->error);
 163 }
 164
 165 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 166 {
 167     ERR_STRING_DATA *p = NULL;
 168
 169     CRYPTO_THREAD_read_lock(err_string_lock);
 170     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
 171     CRYPTO_THREAD_unlock(err_string_lock);
 172
 173     return p;
 174 }
 175
 176 #ifndef OPENSSL_NO_ERR
 177 # define NUM_SYS_STR_REASONS 127
 178 # define LEN_SYS_STR_REASON 32
 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_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
 195     static int init = 1;
 196     int i;
 197
 198     CRYPTO_THREAD_write_lock(err_string_lock);
 199     if (!init) {
 200         CRYPTO_THREAD_unlock(err_string_lock);
 201         return;
 202     }
 203
 204     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 205         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 206
 207         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
 208         if (str->string == NULL) {
 209             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
 210             if (openssl_strerror_r(i, *dest, sizeof(*dest)))
 211                 str->string = *dest;
 212         }
 213         if (str->string == NULL)
 214             str->string = "unknown";
 215     }
 216
 217     /*
 218      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 219      * required by ERR_load_strings.
 220      */
 221
 222     init = 0;
 223
 224     CRYPTO_THREAD_unlock(err_string_lock);
 225     err_load_strings(SYS_str_reasons);
 226 }
 227 #endif
 228
 229 #define err_clear_data(p,i) \
 230         do { \
 231         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
 232                 {  \
 233                 OPENSSL_free((p)->err_data[i]); \
 234                 (p)->err_data[i]=NULL; \
 235                 } \
 236         (p)->err_data_flags[i]=0; \
 237         } while(0)
 238
 239 #define err_clear(p,i) \
 240         do { \
 241         (p)->err_flags[i]=0; \
 242         (p)->err_buffer[i]=0; \
 243         err_clear_data(p,i); \
 244         (p)->err_file[i]=NULL; \
 245         (p)->err_line[i]= -1; \
 246         } while(0)
 247
 248 static void ERR_STATE_free(ERR_STATE *s)
 249 {
 250     int i;
 251
 252     if (s == NULL)
 253         return;
 254
 255     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 256         err_clear_data(s, i);
 257     }
 258     OPENSSL_free(s);
 259 }
 260
 261 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 262 {
 263     OPENSSL_init_crypto(0, NULL);
 264     err_string_lock = CRYPTO_THREAD_lock_new();
 265     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 266                                             err_string_data_cmp);
 267     return err_string_lock != NULL && int_error_hash != NULL;
 268 }
 269
 270 void err_cleanup(void)
 271 {
 272     if (set_err_thread_local != 0)
 273         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 274     CRYPTO_THREAD_lock_free(err_string_lock);
 275     err_string_lock = NULL;
 276     lh_ERR_STRING_DATA_free(int_error_hash);
 277     int_error_hash = NULL;
 278 }
 279
 280 /*
 281  * Legacy; pack in the library.
 282  */
 283 static void err_patch(int lib, ERR_STRING_DATA *str)
 284 {
 285     unsigned long plib = ERR_PACK(lib, 0, 0);
 286
 287     for (; str->error != 0; str++)
 288         str->error |= plib;
 289 }
 290
 291 /*
 292  * Hash in |str| error strings. Assumes the URN_ONCE was done.
 293  */
 294 static int err_load_strings(const ERR_STRING_DATA *str)
 295 {
 296     CRYPTO_THREAD_write_lock(err_string_lock);
 297     for (; str->error; str++)
 298         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 299                                        (ERR_STRING_DATA *)str);
 300     CRYPTO_THREAD_unlock(err_string_lock);
 301     return 1;
 302 }
 303
 304 int ERR_load_ERR_strings(void)
 305 {
 306 #ifndef OPENSSL_NO_ERR
 307     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 308         return 0;
 309
 310     err_load_strings(ERR_str_libraries);
 311     err_load_strings(ERR_str_reasons);
 312     err_patch(ERR_LIB_SYS, ERR_str_functs);
 313     err_load_strings(ERR_str_functs);
 314     build_SYS_str_reasons();
 315 #endif
 316     return 1;
 317 }
 318
 319 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 320 {
 321     if (ERR_load_ERR_strings() == 0)
 322         return 0;
 323
 324     err_patch(lib, str);
 325     err_load_strings(str);
 326     return 1;
 327 }
 328
 329 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 330 {
 331     if (ERR_load_ERR_strings() == 0)
 332         return 0;
 333     err_load_strings(str);
 334     return 1;
 335 }
 336
 337 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 338 {
 339     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 340         return 0;
 341
 342     CRYPTO_THREAD_write_lock(err_string_lock);
 343     /*
 344      * We don't need to ERR_PACK the lib, since that was done (to
 345      * the table) when it was loaded.
 346      */
 347     for (; str->error; str++)
 348         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 349     CRYPTO_THREAD_unlock(err_string_lock);
 350
 351     return 1;
 352 }
 353
 354 void err_free_strings_int(void)
 355 {
 356     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 357         return;
 358 }
 359
 360 /********************************************************/
 361
 362 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 363 {
 364     ERR_STATE *es;
 365
 366 #ifdef _OSD_POSIX
 367     /*
 368      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 369      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 370      * something sensible. @@@ We shouldn't modify a const string, though.
 371      */
 372     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 373         char *end;
 374
 375         /* Skip the "*POSIX(" prefix */
 376         file += sizeof("*POSIX(") - 1;
 377         end = &file[strlen(file) - 1];
 378         if (*end == ')')
 379             *end = '\0';
 380         /* Optional: use the basename of the path only. */
 381         if ((end = strrchr(file, '/')) != NULL)
 382             file = &end[1];
 383     }
 384 #endif
 385     es = ERR_get_state();
 386     if (es == NULL)
 387         return;
 388
 389     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 390     if (es->top == es->bottom)
 391         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 392     es->err_flags[es->top] = 0;
 393     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 394     es->err_file[es->top] = file;
 395     es->err_line[es->top] = line;
 396     err_clear_data(es, es->top);
 397 }
 398
 399 void ERR_clear_error(void)
 400 {
 401     int i;
 402     ERR_STATE *es;
 403
 404     es = ERR_get_state();
 405     if (es == NULL)
 406         return;
 407
 408     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 409         err_clear(es, i);
 410     }
 411     es->top = es->bottom = 0;
 412 }
 413
 414 unsigned long ERR_get_error(void)
 415 {
 416     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
 417 }
 418
 419 unsigned long ERR_get_error_line(const char **file, int *line)
 420 {
 421     return (get_error_values(1, 0, file, line, NULL, NULL));
 422 }
 423
 424 unsigned long ERR_get_error_line_data(const char **file, int *line,
 425                                       const char **data, int *flags)
 426 {
 427     return (get_error_values(1, 0, file, line, data, flags));
 428 }
 429
 430 unsigned long ERR_peek_error(void)
 431 {
 432     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
 433 }
 434
 435 unsigned long ERR_peek_error_line(const char **file, int *line)
 436 {
 437     return (get_error_values(0, 0, file, line, NULL, NULL));
 438 }
 439
 440 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 441                                        const char **data, int *flags)
 442 {
 443     return (get_error_values(0, 0, file, line, data, flags));
 444 }
 445
 446 unsigned long ERR_peek_last_error(void)
 447 {
 448     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
 449 }
 450
 451 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 452 {
 453     return (get_error_values(0, 1, file, line, NULL, NULL));
 454 }
 455
 456 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 457                                             const char **data, int *flags)
 458 {
 459     return (get_error_values(0, 1, file, line, data, flags));
 460 }
 461
 462 static unsigned long get_error_values(int inc, int top, const char **file,
 463                                       int *line, const char **data,
 464                                       int *flags)
 465 {
 466     int i = 0;
 467     ERR_STATE *es;
 468     unsigned long ret;
 469
 470     es = ERR_get_state();
 471     if (es == NULL)
 472         return 0;
 473
 474     if (inc && top) {
 475         if (file)
 476             *file = "";
 477         if (line)
 478             *line = 0;
 479         if (data)
 480             *data = "";
 481         if (flags)
 482             *flags = 0;
 483
 484         return ERR_R_INTERNAL_ERROR;
 485     }
 486
 487     if (es->bottom == es->top)
 488         return 0;
 489     if (top)
 490         i = es->top;            /* last error */
 491     else
 492         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 493
 494     ret = es->err_buffer[i];
 495     if (inc) {
 496         es->bottom = i;
 497         es->err_buffer[i] = 0;
 498     }
 499
 500     if ((file != NULL) && (line != NULL)) {
 501         if (es->err_file[i] == NULL) {
 502             *file = "NA";
 503             if (line != NULL)
 504                 *line = 0;
 505         } else {
 506             *file = es->err_file[i];
 507             if (line != NULL)
 508                 *line = es->err_line[i];
 509         }
 510     }
 511
 512     if (data == NULL) {
 513         if (inc) {
 514             err_clear_data(es, i);
 515         }
 516     } else {
 517         if (es->err_data[i] == NULL) {
 518             *data = "";
 519             if (flags != NULL)
 520                 *flags = 0;
 521         } else {
 522             *data = es->err_data[i];
 523             if (flags != NULL)
 524                 *flags = es->err_data_flags[i];
 525         }
 526     }
 527     return ret;
 528 }
 529
 530 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 531 {
 532     char lsbuf[64], fsbuf[64], rsbuf[64];
 533     const char *ls, *fs, *rs;
 534     unsigned long l, f, r;
 535
 536     if (len == 0)
 537         return;
 538
 539     l = ERR_GET_LIB(e);
 540     f = ERR_GET_FUNC(e);
 541     r = ERR_GET_REASON(e);
 542
 543     ls = ERR_lib_error_string(e);
 544     fs = ERR_func_error_string(e);
 545     rs = ERR_reason_error_string(e);
 546
 547     if (ls == NULL)
 548         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 549     if (fs == NULL)
 550         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 551     if (rs == NULL)
 552         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 553
 554     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
 555                  fs ? fs : fsbuf, rs ? rs : rsbuf);
 556     if (strlen(buf) == len - 1) {
 557         /*
 558          * output may be truncated; make sure we always have 5
 559          * colon-separated fields, i.e. 4 colons ...
 560          */
 561 #define NUM_COLONS 4
 562         if (len > NUM_COLONS) { /* ... if possible */
 563             int i;
 564             char *s = buf;
 565
 566             for (i = 0; i < NUM_COLONS; i++) {
 567                 char *colon = strchr(s, ':');
 568                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
 569                     /*
 570                      * set colon no. i at last possible position (buf[len-1]
 571                      * is the terminating 0)
 572                      */
 573                     colon = &buf[len - 1] - NUM_COLONS + i;
 574                     *colon = ':';
 575                 }
 576                 s = colon + 1;
 577             }
 578         }
 579     }
 580 }
 581
 582 /*
 583  * ERR_error_string_n should be used instead for ret != NULL as
 584  * ERR_error_string cannot know how large the buffer is
 585  */
 586 char *ERR_error_string(unsigned long e, char *ret)
 587 {
 588     static char buf[256];
 589
 590     if (ret == NULL)
 591         ret = buf;
 592     ERR_error_string_n(e, ret, 256);
 593
 594     return ret;
 595 }
 596
 597 const char *ERR_lib_error_string(unsigned long e)
 598 {
 599     ERR_STRING_DATA d, *p;
 600     unsigned long l;
 601
 602     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 603         return NULL;
 604     }
 605
 606     l = ERR_GET_LIB(e);
 607     d.error = ERR_PACK(l, 0, 0);
 608     p = int_err_get_item(&d);
 609     return ((p == NULL) ? NULL : p->string);
 610 }
 611
 612 const char *ERR_func_error_string(unsigned long e)
 613 {
 614     ERR_STRING_DATA d, *p;
 615     unsigned long l, f;
 616
 617     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 618         return NULL;
 619     }
 620
 621     l = ERR_GET_LIB(e);
 622     f = ERR_GET_FUNC(e);
 623     d.error = ERR_PACK(l, f, 0);
 624     p = int_err_get_item(&d);
 625     return ((p == NULL) ? NULL : p->string);
 626 }
 627
 628 const char *ERR_reason_error_string(unsigned long e)
 629 {
 630     ERR_STRING_DATA d, *p = NULL;
 631     unsigned long l, r;
 632
 633     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 634         return NULL;
 635     }
 636
 637     l = ERR_GET_LIB(e);
 638     r = ERR_GET_REASON(e);
 639     d.error = ERR_PACK(l, 0, r);
 640     p = int_err_get_item(&d);
 641     if (!p) {
 642         d.error = ERR_PACK(0, 0, r);
 643         p = int_err_get_item(&d);
 644     }
 645     return ((p == NULL) ? NULL : p->string);
 646 }
 647
 648 void err_delete_thread_state(void)
 649 {
 650     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 651     if (state == NULL)
 652         return;
 653
 654     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 655     ERR_STATE_free(state);
 656 }
 657
 658 #if OPENSSL_API_COMPAT < 0x10100000L
 659 void ERR_remove_thread_state(void *dummy)
 660 {
 661 }
 662 #endif
 663
 664 #if OPENSSL_API_COMPAT < 0x10000000L
 665 void ERR_remove_state(unsigned long pid)
 666 {
 667 }
 668 #endif
 669
 670 DEFINE_RUN_ONCE_STATIC(err_do_init)
 671 {
 672     set_err_thread_local = 1;
 673     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 674 }
 675
 676 ERR_STATE *ERR_get_state(void)
 677 {
 678     ERR_STATE *state = NULL;
 679
 680     if (!RUN_ONCE(&err_init, err_do_init))
 681         return NULL;
 682
 683     state = CRYPTO_THREAD_get_local(&err_thread_local);
 684
 685     if (state == NULL) {
 686         state = OPENSSL_zalloc(sizeof(*state));
 687         if (state == NULL)
 688             return NULL;
 689
 690         if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
 691             || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 692             ERR_STATE_free(state);
 693             return NULL;
 694         }
 695
 696         /* Ignore failures from these */
 697         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 698     }
 699
 700     return state;
 701 }
 702
 703 int ERR_get_next_error_library(void)
 704 {
 705     int ret;
 706
 707     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 708         return 0;
 709     }
 710
 711     CRYPTO_THREAD_write_lock(err_string_lock);
 712     ret = int_err_library_number++;
 713     CRYPTO_THREAD_unlock(err_string_lock);
 714     return ret;
 715 }
 716
 717 void ERR_set_error_data(char *data, int flags)
 718 {
 719     ERR_STATE *es;
 720     int i;
 721
 722     es = ERR_get_state();
 723     if (es == NULL)
 724         return;
 725
 726     i = es->top;
 727     if (i == 0)
 728         i = ERR_NUM_ERRORS - 1;
 729
 730     err_clear_data(es, i);
 731     es->err_data[i] = data;
 732     es->err_data_flags[i] = flags;
 733 }
 734
 735 void ERR_add_error_data(int num, ...)
 736 {
 737     va_list args;
 738     va_start(args, num);
 739     ERR_add_error_vdata(num, args);
 740     va_end(args);
 741 }
 742
 743 void ERR_add_error_vdata(int num, va_list args)
 744 {
 745     int i, n, s;
 746     char *str, *p, *a;
 747
 748     s = 80;
 749     str = OPENSSL_malloc(s + 1);
 750     if (str == NULL)
 751         return;
 752     str[0] = '\0';
 753
 754     n = 0;
 755     for (i = 0; i < num; i++) {
 756         a = va_arg(args, char *);
 757         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
 758         if (a != NULL) {
 759             n += strlen(a);
 760             if (n > s) {
 761                 s = n + 20;
 762                 p = OPENSSL_realloc(str, s + 1);
 763                 if (p == NULL) {
 764                     OPENSSL_free(str);
 765                     return;
 766                 }
 767                 str = p;
 768             }
 769             OPENSSL_strlcat(str, a, (size_t)s + 1);
 770         }
 771     }
 772     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
 773 }
 774
 775 int ERR_set_mark(void)
 776 {
 777     ERR_STATE *es;
 778
 779     es = ERR_get_state();
 780     if (es == NULL)
 781         return 0;
 782
 783     if (es->bottom == es->top)
 784         return 0;
 785     es->err_flags[es->top] |= ERR_FLAG_MARK;
 786     return 1;
 787 }
 788
 789 int ERR_pop_to_mark(void)
 790 {
 791     ERR_STATE *es;
 792
 793     es = ERR_get_state();
 794     if (es == NULL)
 795         return 0;
 796
 797     while (es->bottom != es->top
 798            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 799         err_clear(es, es->top);
 800         es->top -= 1;
 801         if (es->top == -1)
 802             es->top = ERR_NUM_ERRORS - 1;
 803     }
 804
 805     if (es->bottom == es->top)
 806         return 0;
 807     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 808     return 1;
 809 }