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