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