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