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