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