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