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