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 # define NUM_SYS_STR_REASONS 127
 185 # define LEN_SYS_STR_REASON 32
 186
 187 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 188 /*
 189  * SYS_str_reasons is filled with copies of strerror() results at
 190  * initialization. 'errno' values up to 127 should cover all usual errors,
 191  * others will be displayed numerically by ERR_error_string. It is crucial
 192  * that we have something for each reason code that occurs in
 193  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 194  * which always gets an errno value and never one of those 'standard' reason
 195  * codes.
 196  */
 197
 198 static void build_SYS_str_reasons(void)
 199 {
 200     /* OPENSSL_malloc cannot be used here, use static storage instead */
 201     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
 202     static int init = 1;
 203     int i;
 204
 205     CRYPTO_THREAD_write_lock(err_string_lock);
 206     if (!init) {
 207         CRYPTO_THREAD_unlock(err_string_lock);
 208         return;
 209     }
 210
 211     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 212         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 213
 214         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
 215         if (str->string == NULL) {
 216             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
 217             if (openssl_strerror_r(i, *dest, sizeof(*dest)))
 218                 str->string = *dest;
 219         }
 220         if (str->string == NULL)
 221             str->string = "unknown";
 222     }
 223
 224     /*
 225      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 226      * required by ERR_load_strings.
 227      */
 228
 229     init = 0;
 230
 231     CRYPTO_THREAD_unlock(err_string_lock);
 232     err_load_strings(SYS_str_reasons);
 233 }
 234 #endif
 235
 236 #define err_clear_data(p,i) \
 237         do { \
 238         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
 239                 {  \
 240                 OPENSSL_free((p)->err_data[i]); \
 241                 (p)->err_data[i]=NULL; \
 242                 } \
 243         (p)->err_data_flags[i]=0; \
 244         } while(0)
 245
 246 #define err_clear(p,i) \
 247         do { \
 248         (p)->err_flags[i]=0; \
 249         (p)->err_buffer[i]=0; \
 250         err_clear_data(p,i); \
 251         (p)->err_file[i]=NULL; \
 252         (p)->err_line[i]= -1; \
 253         } while(0)
 254
 255 static void ERR_STATE_free(ERR_STATE *s)
 256 {
 257     int i;
 258
 259     if (s == NULL)
 260         return;
 261
 262     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 263         err_clear_data(s, i);
 264     }
 265     OPENSSL_free(s);
 266 }
 267
 268 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 269 {
 270     OPENSSL_init_crypto(0, NULL);
 271     err_string_lock = CRYPTO_THREAD_lock_new();
 272     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 273                                             err_string_data_cmp);
 274     return err_string_lock != NULL && int_error_hash != NULL;
 275 }
 276
 277 void err_cleanup(void)
 278 {
 279     if (set_err_thread_local != 0)
 280         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 281     CRYPTO_THREAD_lock_free(err_string_lock);
 282     err_string_lock = NULL;
 283     lh_ERR_STRING_DATA_free(int_error_hash);
 284     int_error_hash = NULL;
 285 }
 286
 287 /*
 288  * Legacy; pack in the library.
 289  */
 290 static void err_patch(int lib, ERR_STRING_DATA *str)
 291 {
 292     unsigned long plib = ERR_PACK(lib, 0, 0);
 293
 294     for (; str->error != 0; str++)
 295         str->error |= plib;
 296 }
 297
 298 /*
 299  * Hash in |str| error strings. Assumes the URN_ONCE was done.
 300  */
 301 static int err_load_strings(const ERR_STRING_DATA *str)
 302 {
 303     CRYPTO_THREAD_write_lock(err_string_lock);
 304     for (; str->error; str++)
 305         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 306                                        (ERR_STRING_DATA *)str);
 307     CRYPTO_THREAD_unlock(err_string_lock);
 308     return 1;
 309 }
 310
 311 int ERR_load_ERR_strings(void)
 312 {
 313 #ifndef OPENSSL_NO_ERR
 314     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 315         return 0;
 316
 317     err_load_strings(ERR_str_libraries);
 318     err_load_strings(ERR_str_reasons);
 319     err_patch(ERR_LIB_SYS, ERR_str_functs);
 320     err_load_strings(ERR_str_functs);
 321     build_SYS_str_reasons();
 322 #endif
 323     return 1;
 324 }
 325
 326 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 327 {
 328     if (ERR_load_ERR_strings() == 0)
 329         return 0;
 330
 331     err_patch(lib, str);
 332     err_load_strings(str);
 333     return 1;
 334 }
 335
 336 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 337 {
 338     if (ERR_load_ERR_strings() == 0)
 339         return 0;
 340     err_load_strings(str);
 341     return 1;
 342 }
 343
 344 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 345 {
 346     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 347         return 0;
 348
 349     CRYPTO_THREAD_write_lock(err_string_lock);
 350     /*
 351      * We don't need to ERR_PACK the lib, since that was done (to
 352      * the table) when it was loaded.
 353      */
 354     for (; str->error; str++)
 355         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 356     CRYPTO_THREAD_unlock(err_string_lock);
 357
 358     return 1;
 359 }
 360
 361 void err_free_strings_int(void)
 362 {
 363     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 364         return;
 365 }
 366
 367 /********************************************************/
 368
 369 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 370 {
 371     ERR_STATE *es;
 372
 373 #ifdef _OSD_POSIX
 374     /*
 375      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 376      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 377      * something sensible. @@@ We shouldn't modify a const string, though.
 378      */
 379     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 380         char *end;
 381
 382         /* Skip the "*POSIX(" prefix */
 383         file += sizeof("*POSIX(") - 1;
 384         end = &file[strlen(file) - 1];
 385         if (*end == ')')
 386             *end = '\0';
 387         /* Optional: use the basename of the path only. */
 388         if ((end = strrchr(file, '/')) != NULL)
 389             file = &end[1];
 390     }
 391 #endif
 392     es = ERR_get_state();
 393     if (es == NULL)
 394         return;
 395
 396     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 397     if (es->top == es->bottom)
 398         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 399     es->err_flags[es->top] = 0;
 400     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 401     es->err_file[es->top] = file;
 402     es->err_line[es->top] = line;
 403     err_clear_data(es, es->top);
 404 }
 405
 406 void ERR_clear_error(void)
 407 {
 408     int i;
 409     ERR_STATE *es;
 410
 411     es = ERR_get_state();
 412     if (es == NULL)
 413         return;
 414
 415     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 416         err_clear(es, i);
 417     }
 418     es->top = es->bottom = 0;
 419 }
 420
 421 unsigned long ERR_get_error(void)
 422 {
 423     return get_error_values(1, 0, NULL, NULL, NULL, NULL);
 424 }
 425
 426 unsigned long ERR_get_error_line(const char **file, int *line)
 427 {
 428     return get_error_values(1, 0, file, line, NULL, NULL);
 429 }
 430
 431 unsigned long ERR_get_error_line_data(const char **file, int *line,
 432                                       const char **data, int *flags)
 433 {
 434     return get_error_values(1, 0, file, line, data, flags);
 435 }
 436
 437 unsigned long ERR_peek_error(void)
 438 {
 439     return get_error_values(0, 0, NULL, NULL, NULL, NULL);
 440 }
 441
 442 unsigned long ERR_peek_error_line(const char **file, int *line)
 443 {
 444     return get_error_values(0, 0, file, line, NULL, NULL);
 445 }
 446
 447 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 448                                        const char **data, int *flags)
 449 {
 450     return get_error_values(0, 0, file, line, data, flags);
 451 }
 452
 453 unsigned long ERR_peek_last_error(void)
 454 {
 455     return get_error_values(0, 1, NULL, NULL, NULL, NULL);
 456 }
 457
 458 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 459 {
 460     return get_error_values(0, 1, file, line, NULL, NULL);
 461 }
 462
 463 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 464                                             const char **data, int *flags)
 465 {
 466     return get_error_values(0, 1, file, line, data, flags);
 467 }
 468
 469 static unsigned long get_error_values(int inc, int top, const char **file,
 470                                       int *line, const char **data,
 471                                       int *flags)
 472 {
 473     int i = 0;
 474     ERR_STATE *es;
 475     unsigned long ret;
 476
 477     es = ERR_get_state();
 478     if (es == NULL)
 479         return 0;
 480
 481     if (inc && top) {
 482         if (file)
 483             *file = "";
 484         if (line)
 485             *line = 0;
 486         if (data)
 487             *data = "";
 488         if (flags)
 489             *flags = 0;
 490
 491         return ERR_R_INTERNAL_ERROR;
 492     }
 493
 494     if (es->bottom == es->top)
 495         return 0;
 496     if (top)
 497         i = es->top;            /* last error */
 498     else
 499         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 500
 501     ret = es->err_buffer[i];
 502     if (inc) {
 503         es->bottom = i;
 504         es->err_buffer[i] = 0;
 505     }
 506
 507     if (file != NULL && line != NULL) {
 508         if (es->err_file[i] == NULL) {
 509             *file = "NA";
 510             *line = 0;
 511         } else {
 512             *file = es->err_file[i];
 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     ls = ERR_lib_error_string(e);
 546     if (ls == NULL) {
 547         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 548         ls = lsbuf;
 549     }
 550
 551     fs = ERR_func_error_string(e);
 552     f = ERR_GET_FUNC(e);
 553     if (fs == NULL) {
 554         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 555         fs = fsbuf;
 556     }
 557
 558     rs = ERR_reason_error_string(e);
 559     r = ERR_GET_REASON(e);
 560     if (rs == NULL) {
 561         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 562         rs = rsbuf;
 563     }
 564
 565     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs);
 566     if (strlen(buf) == len - 1) {
 567         /* Didn't fit; use a minimal format. */
 568         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
 569     }
 570 }
 571
 572 /*
 573  * ERR_error_string_n should be used instead for ret != NULL as
 574  * ERR_error_string cannot know how large the buffer is
 575  */
 576 char *ERR_error_string(unsigned long e, char *ret)
 577 {
 578     static char buf[256];
 579
 580     if (ret == NULL)
 581         ret = buf;
 582     ERR_error_string_n(e, ret, (int)sizeof(buf));
 583     return ret;
 584 }
 585
 586 const char *ERR_lib_error_string(unsigned long e)
 587 {
 588     ERR_STRING_DATA d, *p;
 589     unsigned long l;
 590
 591     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 592         return NULL;
 593     }
 594
 595     l = ERR_GET_LIB(e);
 596     d.error = ERR_PACK(l, 0, 0);
 597     p = int_err_get_item(&d);
 598     return ((p == NULL) ? NULL : p->string);
 599 }
 600
 601 const char *ERR_func_error_string(unsigned long e)
 602 {
 603     ERR_STRING_DATA d, *p;
 604     unsigned long l, f;
 605
 606     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 607         return NULL;
 608     }
 609
 610     l = ERR_GET_LIB(e);
 611     f = ERR_GET_FUNC(e);
 612     d.error = ERR_PACK(l, f, 0);
 613     p = int_err_get_item(&d);
 614     return ((p == NULL) ? NULL : p->string);
 615 }
 616
 617 const char *ERR_reason_error_string(unsigned long e)
 618 {
 619     ERR_STRING_DATA d, *p = NULL;
 620     unsigned long l, r;
 621
 622     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 623         return NULL;
 624     }
 625
 626     l = ERR_GET_LIB(e);
 627     r = ERR_GET_REASON(e);
 628     d.error = ERR_PACK(l, 0, r);
 629     p = int_err_get_item(&d);
 630     if (!p) {
 631         d.error = ERR_PACK(0, 0, r);
 632         p = int_err_get_item(&d);
 633     }
 634     return ((p == NULL) ? NULL : p->string);
 635 }
 636
 637 void err_delete_thread_state(void)
 638 {
 639     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 640     if (state == NULL)
 641         return;
 642
 643     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 644     ERR_STATE_free(state);
 645 }
 646
 647 #if OPENSSL_API_COMPAT < 0x10100000L
 648 void ERR_remove_thread_state(void *dummy)
 649 {
 650 }
 651 #endif
 652
 653 #if OPENSSL_API_COMPAT < 0x10000000L
 654 void ERR_remove_state(unsigned long pid)
 655 {
 656 }
 657 #endif
 658
 659 DEFINE_RUN_ONCE_STATIC(err_do_init)
 660 {
 661     set_err_thread_local = 1;
 662     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 663 }
 664
 665 ERR_STATE *ERR_get_state(void)
 666 {
 667     ERR_STATE *state = NULL;
 668
 669     if (!RUN_ONCE(&err_init, err_do_init))
 670         return NULL;
 671
 672     /*
 673      * If base OPENSSL_init_crypto() hasn't been called yet, be sure to call
 674      * it now to avoid state to be doubly allocated and thereby leak memory.
 675      * Needed on any platform that doesn't define OPENSSL_USE_NODELETE.
 676      */
 677     if (!OPENSSL_init_crypto(0, NULL))
 678         return NULL;
 679
 680     state = CRYPTO_THREAD_get_local(&err_thread_local);
 681
 682     if (state == NULL) {
 683         state = OPENSSL_zalloc(sizeof(*state));
 684         if (state == NULL)
 685             return NULL;
 686
 687         if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
 688             || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 689             ERR_STATE_free(state);
 690             return NULL;
 691         }
 692
 693         /* Ignore failures from these */
 694         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 695     }
 696
 697     return state;
 698 }
 699
 700 int ERR_get_next_error_library(void)
 701 {
 702     int ret;
 703
 704     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 705         return 0;
 706     }
 707
 708     CRYPTO_THREAD_write_lock(err_string_lock);
 709     ret = int_err_library_number++;
 710     CRYPTO_THREAD_unlock(err_string_lock);
 711     return ret;
 712 }
 713
 714 void ERR_set_error_data(char *data, int flags)
 715 {
 716     ERR_STATE *es;
 717     int i;
 718
 719     es = ERR_get_state();
 720     if (es == NULL)
 721         return;
 722
 723     i = es->top;
 724
 725     err_clear_data(es, i);
 726     es->err_data[i] = data;
 727     es->err_data_flags[i] = flags;
 728 }
 729
 730 void ERR_add_error_data(int num, ...)
 731 {
 732     va_list args;
 733     va_start(args, num);
 734     ERR_add_error_vdata(num, args);
 735     va_end(args);
 736 }
 737
 738 void ERR_add_error_vdata(int num, va_list args)
 739 {
 740     int i, n, s;
 741     char *str, *p, *a;
 742
 743     s = 80;
 744     str = OPENSSL_malloc(s + 1);
 745     if (str == NULL)
 746         return;
 747     str[0] = '\0';
 748
 749     n = 0;
 750     for (i = 0; i < num; i++) {
 751         a = va_arg(args, char *);
 752         if (a == NULL)
 753             a = "<NULL>";
 754         n += strlen(a);
 755         if (n > s) {
 756             s = n + 20;
 757             p = OPENSSL_realloc(str, s + 1);
 758             if (p == NULL) {
 759                 OPENSSL_free(str);
 760                 return;
 761             }
 762             str = p;
 763         }
 764         OPENSSL_strlcat(str, a, (size_t)s + 1);
 765     }
 766     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
 767 }
 768
 769 int ERR_set_mark(void)
 770 {
 771     ERR_STATE *es;
 772
 773     es = ERR_get_state();
 774     if (es == NULL)
 775         return 0;
 776
 777     if (es->bottom == es->top)
 778         return 0;
 779     es->err_flags[es->top] |= ERR_FLAG_MARK;
 780     return 1;
 781 }
 782
 783 int ERR_pop_to_mark(void)
 784 {
 785     ERR_STATE *es;
 786
 787     es = ERR_get_state();
 788     if (es == NULL)
 789         return 0;
 790
 791     while (es->bottom != es->top
 792            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 793         err_clear(es, es->top);
 794         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 795     }
 796
 797     if (es->bottom == es->top)
 798         return 0;
 799     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 800     return 1;
 801 }
 802
 803 int ERR_clear_last_mark(void)
 804 {
 805     ERR_STATE *es;
 806     int top;
 807
 808     es = ERR_get_state();
 809     if (es == NULL)
 810         return 0;
 811
 812     top = es->top;
 813     while (es->bottom != top
 814            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
 815         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 816     }
 817
 818     if (es->bottom == top)
 819         return 0;
 820     es->err_flags[top] &= ~ERR_FLAG_MARK;
 821     return 1;
 822 }