crypto/err/err.c

   1 /*
   2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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 #include "internal/ctype.h"
  23 #include "internal/constant_time_locl.h"
  24 #include "e_os.h"
  25
  26 static int err_load_strings(const ERR_STRING_DATA *str);
  27
  28 static void ERR_STATE_free(ERR_STATE *s);
  29 #ifndef OPENSSL_NO_ERR
  30 static ERR_STRING_DATA ERR_str_libraries[] = {
  31     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
  32     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
  33     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
  34     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
  35     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
  36     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
  37     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
  38     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
  39     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
  40     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
  41     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
  42     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
  43     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
  44     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
  45     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
  46     {ERR_PACK(ERR_LIB_ECDSA, 0, 0), "ECDSA routines"},
  47     {ERR_PACK(ERR_LIB_ECDH, 0, 0), "ECDH routines"},
  48     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
  49     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
  50     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
  51     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
  52     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
  53     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
  54     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
  55     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
  56     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
  57     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
  58     {ERR_PACK(ERR_LIB_UI, 0, 0), "UI routines"},
  59     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
  60     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
  61     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
  62     {ERR_PACK(ERR_LIB_CT, 0, 0), "CT routines"},
  63     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
  64     {ERR_PACK(ERR_LIB_KDF, 0, 0), "KDF routines"},
  65     {ERR_PACK(ERR_LIB_OSSL_STORE, 0, 0), "STORE routines"},
  66     {ERR_PACK(ERR_LIB_SM2, 0, 0), "SM2 routines"},
  67     {ERR_PACK(ERR_LIB_ESS, 0, 0), "ESS routines"},
  68     {0, NULL},
  69 };
  70
  71 static ERR_STRING_DATA ERR_str_functs[] = {
  72     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
  73     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
  74     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
  75     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
  76     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
  77     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
  78     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
  79     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
  80 # ifdef OPENSSL_SYS_WINDOWS
  81     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
  82 # endif
  83     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
  84     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
  85     {ERR_PACK(0, SYS_F_GETADDRINFO, 0), "getaddrinfo"},
  86     {ERR_PACK(0, SYS_F_GETNAMEINFO, 0), "getnameinfo"},
  87     {ERR_PACK(0, SYS_F_SETSOCKOPT, 0), "setsockopt"},
  88     {ERR_PACK(0, SYS_F_GETSOCKOPT, 0), "getsockopt"},
  89     {ERR_PACK(0, SYS_F_GETSOCKNAME, 0), "getsockname"},
  90     {ERR_PACK(0, SYS_F_GETHOSTBYNAME, 0), "gethostbyname"},
  91     {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
  92     {ERR_PACK(0, SYS_F_OPEN, 0), "open"},
  93     {ERR_PACK(0, SYS_F_CLOSE, 0), "close"},
  94     {ERR_PACK(0, SYS_F_IOCTL, 0), "ioctl"},
  95     {ERR_PACK(0, SYS_F_STAT, 0), "stat"},
  96     {ERR_PACK(0, SYS_F_FCNTL, 0), "fcntl"},
  97     {ERR_PACK(0, SYS_F_FSTAT, 0), "fstat"},
  98     {0, NULL},
  99 };
 100
 101 static ERR_STRING_DATA ERR_str_reasons[] = {
 102     {ERR_R_SYS_LIB, "system lib"},
 103     {ERR_R_BN_LIB, "BN lib"},
 104     {ERR_R_RSA_LIB, "RSA lib"},
 105     {ERR_R_DH_LIB, "DH lib"},
 106     {ERR_R_EVP_LIB, "EVP lib"},
 107     {ERR_R_BUF_LIB, "BUF lib"},
 108     {ERR_R_OBJ_LIB, "OBJ lib"},
 109     {ERR_R_PEM_LIB, "PEM lib"},
 110     {ERR_R_DSA_LIB, "DSA lib"},
 111     {ERR_R_X509_LIB, "X509 lib"},
 112     {ERR_R_ASN1_LIB, "ASN1 lib"},
 113     {ERR_R_EC_LIB, "EC lib"},
 114     {ERR_R_BIO_LIB, "BIO lib"},
 115     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
 116     {ERR_R_X509V3_LIB, "X509V3 lib"},
 117     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 118     {ERR_R_UI_LIB, "UI lib"},
 119     {ERR_R_OSSL_STORE_LIB, "STORE lib"},
 120     {ERR_R_ECDSA_LIB, "ECDSA lib"},
 121
 122     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 123     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 124
 125     {ERR_R_FATAL, "fatal"},
 126     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 127     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 128      "called a function you should not call"},
 129     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 130     {ERR_R_INTERNAL_ERROR, "internal error"},
 131     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 132     {ERR_R_INIT_FAIL, "init fail"},
 133     {ERR_R_OPERATION_FAIL, "operation fail"},
 134
 135     {0, NULL},
 136 };
 137 #endif
 138
 139 static CRYPTO_ONCE err_init = CRYPTO_ONCE_STATIC_INIT;
 140 static int set_err_thread_local;
 141 static CRYPTO_THREAD_LOCAL err_thread_local;
 142
 143 static CRYPTO_ONCE err_string_init = CRYPTO_ONCE_STATIC_INIT;
 144 static CRYPTO_RWLOCK *err_string_lock;
 145
 146 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 147
 148 /*
 149  * The internal state
 150  */
 151
 152 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 153 static int int_err_library_number = ERR_LIB_USER;
 154
 155 static unsigned long get_error_values(int inc, int top, const char **file,
 156                                       int *line, const char **data,
 157                                       int *flags);
 158
 159 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 160 {
 161     unsigned long ret, l;
 162
 163     l = a->error;
 164     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
 165     return (ret ^ ret % 19 * 13);
 166 }
 167
 168 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 169                                const ERR_STRING_DATA *b)
 170 {
 171     if (a->error == b->error)
 172         return 0;
 173     return a->error > b->error ? 1 : -1;
 174 }
 175
 176 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 177 {
 178     ERR_STRING_DATA *p = NULL;
 179
 180     CRYPTO_THREAD_read_lock(err_string_lock);
 181     p = lh_ERR_STRING_DATA_retrieve(int_error_hash, d);
 182     CRYPTO_THREAD_unlock(err_string_lock);
 183
 184     return p;
 185 }
 186
 187 #ifndef OPENSSL_NO_ERR
 188 /* A measurement on Linux 2018-11-21 showed about 3.5kib */
 189 # define SPACE_SYS_STR_REASONS 4 * 1024
 190 # define NUM_SYS_STR_REASONS 127
 191
 192 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 193 /*
 194  * SYS_str_reasons is filled with copies of strerror() results at
 195  * initialization. 'errno' values up to 127 should cover all usual errors,
 196  * others will be displayed numerically by ERR_error_string. It is crucial
 197  * that we have something for each reason code that occurs in
 198  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 199  * which always gets an errno value and never one of those 'standard' reason
 200  * codes.
 201  */
 202
 203 static void build_SYS_str_reasons(void)
 204 {
 205     /* OPENSSL_malloc cannot be used here, use static storage instead */
 206     static char strerror_pool[SPACE_SYS_STR_REASONS];
 207     char *cur = strerror_pool;
 208     size_t cnt = 0;
 209     static int init = 1;
 210     int i;
 211     int saveerrno = get_last_sys_error();
 212
 213     CRYPTO_THREAD_write_lock(err_string_lock);
 214     if (!init) {
 215         CRYPTO_THREAD_unlock(err_string_lock);
 216         return;
 217     }
 218
 219     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 220         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 221
 222         str->error = ERR_PACK(ERR_LIB_SYS, 0, i);
 223         if (str->string == NULL) {
 224             if (openssl_strerror_r(i, cur, sizeof(strerror_pool) - cnt)) {
 225                 size_t l = strlen(cur);
 226
 227                 str->string = cur;
 228                 cnt += l;
 229                 if (cnt > sizeof(strerror_pool))
 230                     cnt = sizeof(strerror_pool);
 231                 cur += l;
 232
 233                 /*
 234                  * VMS has an unusual quirk of adding spaces at the end of
 235                  * some (most? all?) messages.  Lets trim them off.
 236                  */
 237                 while (ossl_isspace(cur[-1])) {
 238                     cur--;
 239                     cnt--;
 240                 }
 241                 *cur++ = '\0';
 242                 cnt++;
 243             }
 244         }
 245         if (str->string == NULL)
 246             str->string = "unknown";
 247     }
 248
 249     /*
 250      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 251      * required by ERR_load_strings.
 252      */
 253
 254     init = 0;
 255
 256     CRYPTO_THREAD_unlock(err_string_lock);
 257     /* openssl_strerror_r could change errno, but we want to preserve it */
 258     set_sys_error(saveerrno);
 259     err_load_strings(SYS_str_reasons);
 260 }
 261 #endif
 262
 263 #define err_clear_data(p, i) \
 264         do { \
 265             if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) {\
 266                 OPENSSL_free((p)->err_data[i]); \
 267                 (p)->err_data[i] = NULL; \
 268             } \
 269             (p)->err_data_flags[i] = 0; \
 270         } while (0)
 271
 272 #define err_clear(p, i) \
 273         do { \
 274             err_clear_data(p, i); \
 275             (p)->err_flags[i] = 0; \
 276             (p)->err_buffer[i] = 0; \
 277             (p)->err_file[i] = NULL; \
 278             (p)->err_line[i] = -1; \
 279         } while (0)
 280
 281 static void ERR_STATE_free(ERR_STATE *s)
 282 {
 283     int i;
 284
 285     if (s == NULL)
 286         return;
 287     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 288         err_clear_data(s, i);
 289     }
 290     OPENSSL_free(s);
 291 }
 292
 293 DEFINE_RUN_ONCE_STATIC(do_err_strings_init)
 294 {
 295     if (!OPENSSL_init_crypto(0, NULL))
 296         return 0;
 297     err_string_lock = CRYPTO_THREAD_lock_new();
 298     if (err_string_lock == NULL)
 299         return 0;
 300     int_error_hash = lh_ERR_STRING_DATA_new(err_string_data_hash,
 301                                             err_string_data_cmp);
 302     if (int_error_hash == NULL) {
 303         CRYPTO_THREAD_lock_free(err_string_lock);
 304         err_string_lock = NULL;
 305         return 0;
 306     }
 307     return 1;
 308 }
 309
 310 void err_cleanup(void)
 311 {
 312     if (set_err_thread_local != 0)
 313         CRYPTO_THREAD_cleanup_local(&err_thread_local);
 314     CRYPTO_THREAD_lock_free(err_string_lock);
 315     err_string_lock = NULL;
 316     lh_ERR_STRING_DATA_free(int_error_hash);
 317     int_error_hash = NULL;
 318 }
 319
 320 /*
 321  * Legacy; pack in the library.
 322  */
 323 static void err_patch(int lib, ERR_STRING_DATA *str)
 324 {
 325     unsigned long plib = ERR_PACK(lib, 0, 0);
 326
 327     for (; str->error != 0; str++)
 328         str->error |= plib;
 329 }
 330
 331 /*
 332  * Hash in |str| error strings. Assumes the URN_ONCE was done.
 333  */
 334 static int err_load_strings(const ERR_STRING_DATA *str)
 335 {
 336     CRYPTO_THREAD_write_lock(err_string_lock);
 337     for (; str->error; str++)
 338         (void)lh_ERR_STRING_DATA_insert(int_error_hash,
 339                                        (ERR_STRING_DATA *)str);
 340     CRYPTO_THREAD_unlock(err_string_lock);
 341     return 1;
 342 }
 343
 344 int ERR_load_ERR_strings(void)
 345 {
 346 #ifndef OPENSSL_NO_ERR
 347     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 348         return 0;
 349
 350     err_load_strings(ERR_str_libraries);
 351     err_load_strings(ERR_str_reasons);
 352     err_patch(ERR_LIB_SYS, ERR_str_functs);
 353     err_load_strings(ERR_str_functs);
 354     build_SYS_str_reasons();
 355 #endif
 356     return 1;
 357 }
 358
 359 int ERR_load_strings(int lib, ERR_STRING_DATA *str)
 360 {
 361     if (ERR_load_ERR_strings() == 0)
 362         return 0;
 363
 364     err_patch(lib, str);
 365     err_load_strings(str);
 366     return 1;
 367 }
 368
 369 int ERR_load_strings_const(const ERR_STRING_DATA *str)
 370 {
 371     if (ERR_load_ERR_strings() == 0)
 372         return 0;
 373     err_load_strings(str);
 374     return 1;
 375 }
 376
 377 int ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 378 {
 379     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 380         return 0;
 381
 382     CRYPTO_THREAD_write_lock(err_string_lock);
 383     /*
 384      * We don't need to ERR_PACK the lib, since that was done (to
 385      * the table) when it was loaded.
 386      */
 387     for (; str->error; str++)
 388         (void)lh_ERR_STRING_DATA_delete(int_error_hash, str);
 389     CRYPTO_THREAD_unlock(err_string_lock);
 390
 391     return 1;
 392 }
 393
 394 void err_free_strings_int(void)
 395 {
 396     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 397         return;
 398 }
 399
 400 /********************************************************/
 401
 402 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 403 {
 404     ERR_STATE *es;
 405
 406 #ifdef _OSD_POSIX
 407     /*
 408      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 409      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 410      * something sensible. @@@ We shouldn't modify a const string, though.
 411      */
 412     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 413         char *end;
 414
 415         /* Skip the "*POSIX(" prefix */
 416         file += sizeof("*POSIX(") - 1;
 417         end = &file[strlen(file) - 1];
 418         if (*end == ')')
 419             *end = '\0';
 420         /* Optional: use the basename of the path only. */
 421         if ((end = strrchr(file, '/')) != NULL)
 422             file = &end[1];
 423     }
 424 #endif
 425     es = ERR_get_state();
 426     if (es == NULL)
 427         return;
 428
 429     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 430     if (es->top == es->bottom)
 431         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 432     es->err_flags[es->top] = 0;
 433     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 434     es->err_file[es->top] = file;
 435     es->err_line[es->top] = line;
 436     err_clear_data(es, es->top);
 437 }
 438
 439 void ERR_clear_error(void)
 440 {
 441     int i;
 442     ERR_STATE *es;
 443
 444     es = ERR_get_state();
 445     if (es == NULL)
 446         return;
 447
 448     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 449         err_clear(es, i);
 450     }
 451     es->top = es->bottom = 0;
 452 }
 453
 454 unsigned long ERR_get_error(void)
 455 {
 456     return get_error_values(1, 0, NULL, NULL, NULL, NULL);
 457 }
 458
 459 unsigned long ERR_get_error_line(const char **file, int *line)
 460 {
 461     return get_error_values(1, 0, file, line, NULL, NULL);
 462 }
 463
 464 unsigned long ERR_get_error_line_data(const char **file, int *line,
 465                                       const char **data, int *flags)
 466 {
 467     return get_error_values(1, 0, file, line, data, flags);
 468 }
 469
 470 unsigned long ERR_peek_error(void)
 471 {
 472     return get_error_values(0, 0, NULL, NULL, NULL, NULL);
 473 }
 474
 475 unsigned long ERR_peek_error_line(const char **file, int *line)
 476 {
 477     return get_error_values(0, 0, file, line, NULL, NULL);
 478 }
 479
 480 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 481                                        const char **data, int *flags)
 482 {
 483     return get_error_values(0, 0, file, line, data, flags);
 484 }
 485
 486 unsigned long ERR_peek_last_error(void)
 487 {
 488     return get_error_values(0, 1, NULL, NULL, NULL, NULL);
 489 }
 490
 491 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 492 {
 493     return get_error_values(0, 1, file, line, NULL, NULL);
 494 }
 495
 496 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 497                                             const char **data, int *flags)
 498 {
 499     return get_error_values(0, 1, file, line, data, flags);
 500 }
 501
 502 static unsigned long get_error_values(int inc, int top, const char **file,
 503                                       int *line, const char **data,
 504                                       int *flags)
 505 {
 506     int i = 0;
 507     ERR_STATE *es;
 508     unsigned long ret;
 509
 510     es = ERR_get_state();
 511     if (es == NULL)
 512         return 0;
 513
 514     if (inc && top) {
 515         if (file)
 516             *file = "";
 517         if (line)
 518             *line = 0;
 519         if (data)
 520             *data = "";
 521         if (flags)
 522             *flags = 0;
 523
 524         return ERR_R_INTERNAL_ERROR;
 525     }
 526
 527     if (es->bottom == es->top)
 528         return 0;
 529     if (top)
 530         i = es->top;            /* last error */
 531     else
 532         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 533
 534     ret = es->err_buffer[i];
 535     if (inc) {
 536         es->bottom = i;
 537         es->err_buffer[i] = 0;
 538     }
 539
 540     if (file != NULL && line != NULL) {
 541         if (es->err_file[i] == NULL) {
 542             *file = "NA";
 543             *line = 0;
 544         } else {
 545             *file = es->err_file[i];
 546             *line = es->err_line[i];
 547         }
 548     }
 549
 550     if (data == NULL) {
 551         if (inc) {
 552             err_clear_data(es, i);
 553         }
 554     } else {
 555         if (es->err_data[i] == NULL) {
 556             *data = "";
 557             if (flags != NULL)
 558                 *flags = 0;
 559         } else {
 560             *data = es->err_data[i];
 561             if (flags != NULL)
 562                 *flags = es->err_data_flags[i];
 563         }
 564     }
 565     return ret;
 566 }
 567
 568 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 569 {
 570     char lsbuf[64], fsbuf[64], rsbuf[64];
 571     const char *ls, *fs, *rs;
 572     unsigned long l, f, r;
 573
 574     if (len == 0)
 575         return;
 576
 577     l = ERR_GET_LIB(e);
 578     ls = ERR_lib_error_string(e);
 579     if (ls == NULL) {
 580         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 581         ls = lsbuf;
 582     }
 583
 584     fs = ERR_func_error_string(e);
 585     f = ERR_GET_FUNC(e);
 586     if (fs == NULL) {
 587         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 588         fs = fsbuf;
 589     }
 590
 591     rs = ERR_reason_error_string(e);
 592     r = ERR_GET_REASON(e);
 593     if (rs == NULL) {
 594         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 595         rs = rsbuf;
 596     }
 597
 598     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls, fs, rs);
 599     if (strlen(buf) == len - 1) {
 600         /* Didn't fit; use a minimal format. */
 601         BIO_snprintf(buf, len, "err:%lx:%lx:%lx:%lx", e, l, f, r);
 602     }
 603 }
 604
 605 /*
 606  * ERR_error_string_n should be used instead for ret != NULL as
 607  * ERR_error_string cannot know how large the buffer is
 608  */
 609 char *ERR_error_string(unsigned long e, char *ret)
 610 {
 611     static char buf[256];
 612
 613     if (ret == NULL)
 614         ret = buf;
 615     ERR_error_string_n(e, ret, (int)sizeof(buf));
 616     return ret;
 617 }
 618
 619 const char *ERR_lib_error_string(unsigned long e)
 620 {
 621     ERR_STRING_DATA d, *p;
 622     unsigned long l;
 623
 624     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 625         return NULL;
 626     }
 627
 628     l = ERR_GET_LIB(e);
 629     d.error = ERR_PACK(l, 0, 0);
 630     p = int_err_get_item(&d);
 631     return ((p == NULL) ? NULL : p->string);
 632 }
 633
 634 const char *ERR_func_error_string(unsigned long e)
 635 {
 636     ERR_STRING_DATA d, *p;
 637     unsigned long l, f;
 638
 639     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 640         return NULL;
 641     }
 642
 643     l = ERR_GET_LIB(e);
 644     f = ERR_GET_FUNC(e);
 645     d.error = ERR_PACK(l, f, 0);
 646     p = int_err_get_item(&d);
 647     return ((p == NULL) ? NULL : p->string);
 648 }
 649
 650 const char *ERR_reason_error_string(unsigned long e)
 651 {
 652     ERR_STRING_DATA d, *p = NULL;
 653     unsigned long l, r;
 654
 655     if (!RUN_ONCE(&err_string_init, do_err_strings_init)) {
 656         return NULL;
 657     }
 658
 659     l = ERR_GET_LIB(e);
 660     r = ERR_GET_REASON(e);
 661     d.error = ERR_PACK(l, 0, r);
 662     p = int_err_get_item(&d);
 663     if (!p) {
 664         d.error = ERR_PACK(0, 0, r);
 665         p = int_err_get_item(&d);
 666     }
 667     return ((p == NULL) ? NULL : p->string);
 668 }
 669
 670 void err_delete_thread_state(void)
 671 {
 672     ERR_STATE *state = CRYPTO_THREAD_get_local(&err_thread_local);
 673     if (state == NULL)
 674         return;
 675
 676     CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 677     ERR_STATE_free(state);
 678 }
 679
 680 #if !OPENSSL_API_1_1_0
 681 void ERR_remove_thread_state(void *dummy)
 682 {
 683 }
 684 #endif
 685
 686 #if !OPENSSL_API_1_0_0
 687 void ERR_remove_state(unsigned long pid)
 688 {
 689 }
 690 #endif
 691
 692 DEFINE_RUN_ONCE_STATIC(err_do_init)
 693 {
 694     set_err_thread_local = 1;
 695     return CRYPTO_THREAD_init_local(&err_thread_local, NULL);
 696 }
 697
 698 ERR_STATE *ERR_get_state(void)
 699 {
 700     ERR_STATE *state;
 701     int saveerrno = get_last_sys_error();
 702
 703     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 704         return NULL;
 705
 706     if (!RUN_ONCE(&err_init, err_do_init))
 707         return NULL;
 708
 709     state = CRYPTO_THREAD_get_local(&err_thread_local);
 710     if (state == (ERR_STATE*)-1)
 711         return NULL;
 712
 713     if (state == NULL) {
 714         if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 715             return NULL;
 716
 717         if ((state = OPENSSL_zalloc(sizeof(*state))) == NULL) {
 718             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 719             return NULL;
 720         }
 721
 722         if (!ossl_init_thread_start(OPENSSL_INIT_THREAD_ERR_STATE)
 723                 || !CRYPTO_THREAD_set_local(&err_thread_local, state)) {
 724             ERR_STATE_free(state);
 725             CRYPTO_THREAD_set_local(&err_thread_local, NULL);
 726             return NULL;
 727         }
 728
 729         /* Ignore failures from these */
 730         OPENSSL_init_crypto(OPENSSL_INIT_LOAD_CRYPTO_STRINGS, NULL);
 731     }
 732
 733     set_sys_error(saveerrno);
 734     return state;
 735 }
 736
 737 /*
 738  * err_shelve_state returns the current thread local error state
 739  * and freezes the error module until err_unshelve_state is called.
 740  */
 741 int err_shelve_state(void **state)
 742 {
 743     int saveerrno = get_last_sys_error();
 744
 745     /*
 746      * Note, at present our only caller is OPENSSL_init_crypto(), indirectly
 747      * via ossl_init_load_crypto_nodelete(), by which point the requested
 748      * "base" initialization has already been performed, so the below call is a
 749      * NOOP, that re-enters OPENSSL_init_crypto() only to quickly return.
 750      *
 751      * If are no other valid callers of this function, the call below can be
 752      * removed, avoiding the re-entry into OPENSSL_init_crypto().  If there are
 753      * potential uses that are not from inside OPENSSL_init_crypto(), then this
 754      * call is needed, but some care is required to make sure that the re-entry
 755      * remains a NOOP.
 756      */
 757     if (!OPENSSL_init_crypto(OPENSSL_INIT_BASE_ONLY, NULL))
 758         return 0;
 759
 760     if (!RUN_ONCE(&err_init, err_do_init))
 761         return 0;
 762
 763     *state = CRYPTO_THREAD_get_local(&err_thread_local);
 764     if (!CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)-1))
 765         return 0;
 766
 767     set_sys_error(saveerrno);
 768     return 1;
 769 }
 770
 771 /*
 772  * err_unshelve_state restores the error state that was returned
 773  * by err_shelve_state previously.
 774  */
 775 void err_unshelve_state(void* state)
 776 {
 777     if (state != (void*)-1)
 778         CRYPTO_THREAD_set_local(&err_thread_local, (ERR_STATE*)state);
 779 }
 780
 781 int ERR_get_next_error_library(void)
 782 {
 783     int ret;
 784
 785     if (!RUN_ONCE(&err_string_init, do_err_strings_init))
 786         return 0;
 787
 788     CRYPTO_THREAD_write_lock(err_string_lock);
 789     ret = int_err_library_number++;
 790     CRYPTO_THREAD_unlock(err_string_lock);
 791     return ret;
 792 }
 793
 794 void ERR_set_error_data(char *data, int flags)
 795 {
 796     ERR_STATE *es;
 797     int i;
 798
 799     es = ERR_get_state();
 800     if (es == NULL)
 801         return;
 802
 803     i = es->top;
 804
 805     err_clear_data(es, i);
 806     es->err_data[i] = data;
 807     es->err_data_flags[i] = flags;
 808 }
 809
 810 void ERR_add_error_data(int num, ...)
 811 {
 812     va_list args;
 813     va_start(args, num);
 814     ERR_add_error_vdata(num, args);
 815     va_end(args);
 816 }
 817
 818 void ERR_add_error_vdata(int num, va_list args)
 819 {
 820     int i, n, s;
 821     char *str, *p, *a;
 822
 823     s = 80;
 824     if ((str = OPENSSL_malloc(s + 1)) == NULL) {
 825         /* ERRerr(ERR_F_ERR_ADD_ERROR_VDATA, ERR_R_MALLOC_FAILURE); */
 826         return;
 827     }
 828     str[0] = '\0';
 829
 830     n = 0;
 831     for (i = 0; i < num; i++) {
 832         a = va_arg(args, char *);
 833         if (a == NULL)
 834             a = "<NULL>";
 835         n += strlen(a);
 836         if (n > s) {
 837             s = n + 20;
 838             p = OPENSSL_realloc(str, s + 1);
 839             if (p == NULL) {
 840                 OPENSSL_free(str);
 841                 return;
 842             }
 843             str = p;
 844         }
 845         OPENSSL_strlcat(str, a, (size_t)s + 1);
 846     }
 847     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
 848 }
 849
 850 int ERR_set_mark(void)
 851 {
 852     ERR_STATE *es;
 853
 854     es = ERR_get_state();
 855     if (es == NULL)
 856         return 0;
 857
 858     if (es->bottom == es->top)
 859         return 0;
 860     es->err_flags[es->top] |= ERR_FLAG_MARK;
 861     return 1;
 862 }
 863
 864 int ERR_pop_to_mark(void)
 865 {
 866     ERR_STATE *es;
 867
 868     es = ERR_get_state();
 869     if (es == NULL)
 870         return 0;
 871
 872     while (es->bottom != es->top
 873            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 874         err_clear(es, es->top);
 875         es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 876     }
 877
 878     if (es->bottom == es->top)
 879         return 0;
 880     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
 881     return 1;
 882 }
 883
 884 int ERR_clear_last_mark(void)
 885 {
 886     ERR_STATE *es;
 887     int top;
 888
 889     es = ERR_get_state();
 890     if (es == NULL)
 891         return 0;
 892
 893     top = es->top;
 894     while (es->bottom != top
 895            && (es->err_flags[top] & ERR_FLAG_MARK) == 0) {
 896         top = top > 0 ? top - 1 : ERR_NUM_ERRORS - 1;
 897     }
 898
 899     if (es->bottom == top)
 900         return 0;
 901     es->err_flags[top] &= ~ERR_FLAG_MARK;
 902     return 1;
 903 }
 904
 905 #ifdef UINTPTR_T
 906 # undef UINTPTR_T
 907 #endif
 908 /*
 909  * uintptr_t is the answer, but unfortunately C89, current "least common
 910  * denominator" doesn't define it. Most legacy platforms typedef it anyway,
 911  * so that attempt to fill the gaps means that one would have to identify
 912  * that track these gaps, which would be undesirable. Macro it is...
 913  */
 914 #if defined(__VMS) && __INITIAL_POINTER_SIZE==64
 915 /*
 916  * But we can't use size_t on VMS, because it adheres to sizeof(size_t)==4
 917  * even in 64-bit builds, which means that it won't work as mask.
 918  */
 919 # define UINTPTR_T unsigned long long
 920 #else
 921 # define UINTPTR_T size_t
 922 #endif
 923
 924 void err_clear_last_constant_time(int clear)
 925 {
 926     ERR_STATE *es;
 927     int top;
 928
 929     es = ERR_get_state();
 930     if (es == NULL)
 931         return;
 932
 933     top = es->top;
 934
 935     es->err_flags[top] &= ~(0 - clear);
 936     es->err_buffer[top] &= ~(0UL - clear);
 937     es->err_file[top] = (const char *)((UINTPTR_T)es->err_file[top] &
 938                                        ~((UINTPTR_T)0 - clear));
 939     es->err_line[top] |= 0 - clear;
 940
 941     es->top = (top + ERR_NUM_ERRORS - clear) % ERR_NUM_ERRORS;
 942 }