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