crypto/err/err.c

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