crypto/err/err.c

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