crypto/openssl/crypto/err/err.c

   1 /* crypto/err/err.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58 /* ====================================================================
  59  * Copyright (c) 1998-2019 The OpenSSL Project.  All rights reserved.
  60  *
  61  * Redistribution and use in source and binary forms, with or without
  62  * modification, are permitted provided that the following conditions
  63  * are met:
  64  *
  65  * 1. Redistributions of source code must retain the above copyright
  66  *    notice, this list of conditions and the following disclaimer.
  67  *
  68  * 2. Redistributions in binary form must reproduce the above copyright
  69  *    notice, this list of conditions and the following disclaimer in
  70  *    the documentation and/or other materials provided with the
  71  *    distribution.
  72  *
  73  * 3. All advertising materials mentioning features or use of this
  74  *    software must display the following acknowledgment:
  75  *    "This product includes software developed by the OpenSSL Project
  76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  77  *
  78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  79  *    endorse or promote products derived from this software without
  80  *    prior written permission. For written permission, please contact
  81  *    openssl-core@openssl.org.
  82  *
  83  * 5. Products derived from this software may not be called "OpenSSL"
  84  *    nor may "OpenSSL" appear in their names without prior written
  85  *    permission of the OpenSSL Project.
  86  *
  87  * 6. Redistributions of any form whatsoever must retain the following
  88  *    acknowledgment:
  89  *    "This product includes software developed by the OpenSSL Project
  90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  91  *
  92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 103  * OF THE POSSIBILITY OF SUCH DAMAGE.
 104  * ====================================================================
 105  *
 106  * This product includes cryptographic software written by Eric Young
 107  * (eay@cryptsoft.com).  This product includes software written by Tim
 108  * Hudson (tjh@cryptsoft.com).
 109  *
 110  */
 111
 112 #include <stdio.h>
 113 #include <stdarg.h>
 114 #include <string.h>
 115 #include "cryptlib.h"
 116 #include <openssl/lhash.h>
 117 #include <openssl/crypto.h>
 118 #include <openssl/buffer.h>
 119 #include <openssl/bio.h>
 120 #include <openssl/err.h>
 121 #include "constant_time_locl.h"
 122
 123 DECLARE_LHASH_OF(ERR_STRING_DATA);
 124 DECLARE_LHASH_OF(ERR_STATE);
 125
 126 static void err_load_strings(int lib, ERR_STRING_DATA *str);
 127
 128 static void ERR_STATE_free(ERR_STATE *s);
 129 #ifndef OPENSSL_NO_ERR
 130 static ERR_STRING_DATA ERR_str_libraries[] = {
 131     {ERR_PACK(ERR_LIB_NONE, 0, 0), "unknown library"},
 132     {ERR_PACK(ERR_LIB_SYS, 0, 0), "system library"},
 133     {ERR_PACK(ERR_LIB_BN, 0, 0), "bignum routines"},
 134     {ERR_PACK(ERR_LIB_RSA, 0, 0), "rsa routines"},
 135     {ERR_PACK(ERR_LIB_DH, 0, 0), "Diffie-Hellman routines"},
 136     {ERR_PACK(ERR_LIB_EVP, 0, 0), "digital envelope routines"},
 137     {ERR_PACK(ERR_LIB_BUF, 0, 0), "memory buffer routines"},
 138     {ERR_PACK(ERR_LIB_OBJ, 0, 0), "object identifier routines"},
 139     {ERR_PACK(ERR_LIB_PEM, 0, 0), "PEM routines"},
 140     {ERR_PACK(ERR_LIB_DSA, 0, 0), "dsa routines"},
 141     {ERR_PACK(ERR_LIB_X509, 0, 0), "x509 certificate routines"},
 142     {ERR_PACK(ERR_LIB_ASN1, 0, 0), "asn1 encoding routines"},
 143     {ERR_PACK(ERR_LIB_CONF, 0, 0), "configuration file routines"},
 144     {ERR_PACK(ERR_LIB_CRYPTO, 0, 0), "common libcrypto routines"},
 145     {ERR_PACK(ERR_LIB_EC, 0, 0), "elliptic curve routines"},
 146     {ERR_PACK(ERR_LIB_SSL, 0, 0), "SSL routines"},
 147     {ERR_PACK(ERR_LIB_BIO, 0, 0), "BIO routines"},
 148     {ERR_PACK(ERR_LIB_PKCS7, 0, 0), "PKCS7 routines"},
 149     {ERR_PACK(ERR_LIB_X509V3, 0, 0), "X509 V3 routines"},
 150     {ERR_PACK(ERR_LIB_PKCS12, 0, 0), "PKCS12 routines"},
 151     {ERR_PACK(ERR_LIB_RAND, 0, 0), "random number generator"},
 152     {ERR_PACK(ERR_LIB_DSO, 0, 0), "DSO support routines"},
 153     {ERR_PACK(ERR_LIB_TS, 0, 0), "time stamp routines"},
 154     {ERR_PACK(ERR_LIB_ENGINE, 0, 0), "engine routines"},
 155     {ERR_PACK(ERR_LIB_OCSP, 0, 0), "OCSP routines"},
 156     {ERR_PACK(ERR_LIB_FIPS, 0, 0), "FIPS routines"},
 157     {ERR_PACK(ERR_LIB_CMS, 0, 0), "CMS routines"},
 158     {ERR_PACK(ERR_LIB_HMAC, 0, 0), "HMAC routines"},
 159     {0, NULL},
 160 };
 161
 162 static ERR_STRING_DATA ERR_str_functs[] = {
 163     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
 164     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
 165     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
 166     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
 167     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
 168     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
 169     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
 170     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
 171 # ifdef OPENSSL_SYS_WINDOWS
 172     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
 173 # endif
 174     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
 175     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
 176     {ERR_PACK(0, SYS_F_FFLUSH, 0), "fflush"},
 177     {0, NULL},
 178 };
 179
 180 static ERR_STRING_DATA ERR_str_reasons[] = {
 181     {ERR_R_SYS_LIB, "system lib"},
 182     {ERR_R_BN_LIB, "BN lib"},
 183     {ERR_R_RSA_LIB, "RSA lib"},
 184     {ERR_R_DH_LIB, "DH lib"},
 185     {ERR_R_EVP_LIB, "EVP lib"},
 186     {ERR_R_BUF_LIB, "BUF lib"},
 187     {ERR_R_OBJ_LIB, "OBJ lib"},
 188     {ERR_R_PEM_LIB, "PEM lib"},
 189     {ERR_R_DSA_LIB, "DSA lib"},
 190     {ERR_R_X509_LIB, "X509 lib"},
 191     {ERR_R_ASN1_LIB, "ASN1 lib"},
 192     {ERR_R_CONF_LIB, "CONF lib"},
 193     {ERR_R_CRYPTO_LIB, "CRYPTO lib"},
 194     {ERR_R_EC_LIB, "EC lib"},
 195     {ERR_R_SSL_LIB, "SSL lib"},
 196     {ERR_R_BIO_LIB, "BIO lib"},
 197     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
 198     {ERR_R_X509V3_LIB, "X509V3 lib"},
 199     {ERR_R_PKCS12_LIB, "PKCS12 lib"},
 200     {ERR_R_RAND_LIB, "RAND lib"},
 201     {ERR_R_DSO_LIB, "DSO lib"},
 202     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 203     {ERR_R_OCSP_LIB, "OCSP lib"},
 204     {ERR_R_TS_LIB, "TS lib"},
 205
 206     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 207     {ERR_R_BAD_ASN1_OBJECT_HEADER, "bad asn1 object header"},
 208     {ERR_R_BAD_GET_ASN1_OBJECT_CALL, "bad get asn1 object call"},
 209     {ERR_R_EXPECTING_AN_ASN1_SEQUENCE, "expecting an asn1 sequence"},
 210     {ERR_R_ASN1_LENGTH_MISMATCH, "asn1 length mismatch"},
 211     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 212
 213     {ERR_R_FATAL, "fatal"},
 214     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 215     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 216      "called a function you should not call"},
 217     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 218     {ERR_R_INTERNAL_ERROR, "internal error"},
 219     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 220
 221     {0, NULL},
 222 };
 223 #endif
 224
 225 /* Define the predeclared (but externally opaque) "ERR_FNS" type */
 226 struct st_ERR_FNS {
 227     /* Works on the "error_hash" string table */
 228     LHASH_OF(ERR_STRING_DATA) *(*cb_err_get) (int create);
 229     void (*cb_err_del) (void);
 230     ERR_STRING_DATA *(*cb_err_get_item) (const ERR_STRING_DATA *);
 231     ERR_STRING_DATA *(*cb_err_set_item) (ERR_STRING_DATA *);
 232     ERR_STRING_DATA *(*cb_err_del_item) (ERR_STRING_DATA *);
 233     /* Works on the "thread_hash" error-state table */
 234     LHASH_OF(ERR_STATE) *(*cb_thread_get) (int create);
 235     void (*cb_thread_release) (LHASH_OF(ERR_STATE) **hash);
 236     ERR_STATE *(*cb_thread_get_item) (const ERR_STATE *);
 237     ERR_STATE *(*cb_thread_set_item) (ERR_STATE *);
 238     void (*cb_thread_del_item) (const ERR_STATE *);
 239     /* Returns the next available error "library" numbers */
 240     int (*cb_get_next_lib) (void);
 241 };
 242
 243 /* Predeclarations of the "err_defaults" functions */
 244 static LHASH_OF(ERR_STRING_DATA) *int_err_get(int create);
 245 static void int_err_del(void);
 246 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 247 static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *);
 248 static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *);
 249 static LHASH_OF(ERR_STATE) *int_thread_get(int create);
 250 static void int_thread_release(LHASH_OF(ERR_STATE) **hash);
 251 static ERR_STATE *int_thread_get_item(const ERR_STATE *);
 252 static ERR_STATE *int_thread_set_item(ERR_STATE *);
 253 static void int_thread_del_item(const ERR_STATE *);
 254 static int int_err_get_next_lib(void);
 255 /* The static ERR_FNS table using these defaults functions */
 256 static const ERR_FNS err_defaults = {
 257     int_err_get,
 258     int_err_del,
 259     int_err_get_item,
 260     int_err_set_item,
 261     int_err_del_item,
 262     int_thread_get,
 263     int_thread_release,
 264     int_thread_get_item,
 265     int_thread_set_item,
 266     int_thread_del_item,
 267     int_err_get_next_lib
 268 };
 269
 270 /* The replacable table of ERR_FNS functions we use at run-time */
 271 static const ERR_FNS *err_fns = NULL;
 272
 273 /* Eg. rather than using "err_get()", use "ERRFN(err_get)()". */
 274 #define ERRFN(a) err_fns->cb_##a
 275
 276 /*
 277  * The internal state used by "err_defaults" - as such, the setting, reading,
 278  * creating, and deleting of this data should only be permitted via the
 279  * "err_defaults" functions. This way, a linked module can completely defer
 280  * all ERR state operation (together with requisite locking) to the
 281  * implementations and state in the loading application.
 282  */
 283 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 284 static LHASH_OF(ERR_STATE) *int_thread_hash = NULL;
 285 static int int_thread_hash_references = 0;
 286 static int int_err_library_number = ERR_LIB_USER;
 287
 288 /*
 289  * Internal function that checks whether "err_fns" is set and if not, sets it
 290  * to the defaults.
 291  */
 292 static void err_fns_check(void)
 293 {
 294     if (err_fns)
 295         return;
 296
 297     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 298     if (!err_fns)
 299         err_fns = &err_defaults;
 300     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 301 }
 302
 303 /* API functions to get or set the underlying ERR functions. */
 304
 305 const ERR_FNS *ERR_get_implementation(void)
 306 {
 307     err_fns_check();
 308     return err_fns;
 309 }
 310
 311 int ERR_set_implementation(const ERR_FNS *fns)
 312 {
 313     int ret = 0;
 314
 315     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 316     /*
 317      * It's too late if 'err_fns' is non-NULL. BTW: not much point setting an
 318      * error is there?!
 319      */
 320     if (!err_fns) {
 321         err_fns = fns;
 322         ret = 1;
 323     }
 324     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 325     return ret;
 326 }
 327
 328 /*
 329  * These are the callbacks provided to "lh_new()" when creating the LHASH
 330  * tables internal to the "err_defaults" implementation.
 331  */
 332
 333 static unsigned long get_error_values(int inc, int top, const char **file,
 334                                       int *line, const char **data,
 335                                       int *flags);
 336
 337 /* The internal functions used in the "err_defaults" implementation */
 338
 339 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 340 {
 341     unsigned long ret, l;
 342
 343     l = a->error;
 344     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
 345     return (ret ^ ret % 19 * 13);
 346 }
 347
 348 static IMPLEMENT_LHASH_HASH_FN(err_string_data, ERR_STRING_DATA)
 349
 350 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 351                                const ERR_STRING_DATA *b)
 352 {
 353     return (int)(a->error - b->error);
 354 }
 355
 356 static IMPLEMENT_LHASH_COMP_FN(err_string_data, ERR_STRING_DATA)
 357
 358 static LHASH_OF(ERR_STRING_DATA) *int_err_get(int create)
 359 {
 360     LHASH_OF(ERR_STRING_DATA) *ret = NULL;
 361
 362     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 363     if (!int_error_hash && create) {
 364         CRYPTO_push_info("int_err_get (err.c)");
 365         int_error_hash = lh_ERR_STRING_DATA_new();
 366         CRYPTO_pop_info();
 367     }
 368     if (int_error_hash)
 369         ret = int_error_hash;
 370     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 371
 372     return ret;
 373 }
 374
 375 static void int_err_del(void)
 376 {
 377     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 378     if (int_error_hash) {
 379         lh_ERR_STRING_DATA_free(int_error_hash);
 380         int_error_hash = NULL;
 381     }
 382     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 383 }
 384
 385 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 386 {
 387     ERR_STRING_DATA *p;
 388     LHASH_OF(ERR_STRING_DATA) *hash;
 389
 390     err_fns_check();
 391     hash = ERRFN(err_get) (0);
 392     if (!hash)
 393         return NULL;
 394
 395     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 396     p = lh_ERR_STRING_DATA_retrieve(hash, d);
 397     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 398
 399     return p;
 400 }
 401
 402 static ERR_STRING_DATA *int_err_set_item(ERR_STRING_DATA *d)
 403 {
 404     ERR_STRING_DATA *p;
 405     LHASH_OF(ERR_STRING_DATA) *hash;
 406
 407     err_fns_check();
 408     hash = ERRFN(err_get) (1);
 409     if (!hash)
 410         return NULL;
 411
 412     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 413     p = lh_ERR_STRING_DATA_insert(hash, d);
 414     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 415
 416     return p;
 417 }
 418
 419 static ERR_STRING_DATA *int_err_del_item(ERR_STRING_DATA *d)
 420 {
 421     ERR_STRING_DATA *p;
 422     LHASH_OF(ERR_STRING_DATA) *hash;
 423
 424     err_fns_check();
 425     hash = ERRFN(err_get) (0);
 426     if (!hash)
 427         return NULL;
 428
 429     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 430     p = lh_ERR_STRING_DATA_delete(hash, d);
 431     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 432
 433     return p;
 434 }
 435
 436 static unsigned long err_state_hash(const ERR_STATE *a)
 437 {
 438     return CRYPTO_THREADID_hash(&a->tid) * 13;
 439 }
 440
 441 static IMPLEMENT_LHASH_HASH_FN(err_state, ERR_STATE)
 442
 443 static int err_state_cmp(const ERR_STATE *a, const ERR_STATE *b)
 444 {
 445     return CRYPTO_THREADID_cmp(&a->tid, &b->tid);
 446 }
 447
 448 static IMPLEMENT_LHASH_COMP_FN(err_state, ERR_STATE)
 449
 450 static LHASH_OF(ERR_STATE) *int_thread_get(int create)
 451 {
 452     LHASH_OF(ERR_STATE) *ret = NULL;
 453
 454     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 455     if (!int_thread_hash && create) {
 456         CRYPTO_push_info("int_thread_get (err.c)");
 457         int_thread_hash = lh_ERR_STATE_new();
 458         CRYPTO_pop_info();
 459     }
 460     if (int_thread_hash) {
 461         int_thread_hash_references++;
 462         ret = int_thread_hash;
 463     }
 464     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 465     return ret;
 466 }
 467
 468 static void int_thread_release(LHASH_OF(ERR_STATE) **hash)
 469 {
 470     int i;
 471
 472     if (hash == NULL || *hash == NULL)
 473         return;
 474
 475     i = CRYPTO_add(&int_thread_hash_references, -1, CRYPTO_LOCK_ERR);
 476
 477 #ifdef REF_PRINT
 478     fprintf(stderr, "%4d:%s\n", int_thread_hash_references, "ERR");
 479 #endif
 480     if (i > 0)
 481         return;
 482 #ifdef REF_CHECK
 483     if (i < 0) {
 484         fprintf(stderr, "int_thread_release, bad reference count\n");
 485         abort();                /* ok */
 486     }
 487 #endif
 488     *hash = NULL;
 489 }
 490
 491 static ERR_STATE *int_thread_get_item(const ERR_STATE *d)
 492 {
 493     ERR_STATE *p;
 494     LHASH_OF(ERR_STATE) *hash;
 495
 496     err_fns_check();
 497     hash = ERRFN(thread_get) (0);
 498     if (!hash)
 499         return NULL;
 500
 501     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 502     p = lh_ERR_STATE_retrieve(hash, d);
 503     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 504
 505     ERRFN(thread_release) (&hash);
 506     return p;
 507 }
 508
 509 static ERR_STATE *int_thread_set_item(ERR_STATE *d)
 510 {
 511     ERR_STATE *p;
 512     LHASH_OF(ERR_STATE) *hash;
 513
 514     err_fns_check();
 515     hash = ERRFN(thread_get) (1);
 516     if (!hash)
 517         return NULL;
 518
 519     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 520     p = lh_ERR_STATE_insert(hash, d);
 521     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 522
 523     ERRFN(thread_release) (&hash);
 524     return p;
 525 }
 526
 527 static void int_thread_del_item(const ERR_STATE *d)
 528 {
 529     ERR_STATE *p;
 530     LHASH_OF(ERR_STATE) *hash;
 531
 532     err_fns_check();
 533     hash = ERRFN(thread_get) (0);
 534     if (!hash)
 535         return;
 536
 537     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 538     p = lh_ERR_STATE_delete(hash, d);
 539     /* make sure we don't leak memory */
 540     if (int_thread_hash_references == 1
 541         && int_thread_hash && lh_ERR_STATE_num_items(int_thread_hash) == 0) {
 542         lh_ERR_STATE_free(int_thread_hash);
 543         int_thread_hash = NULL;
 544     }
 545     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 546
 547     ERRFN(thread_release) (&hash);
 548     if (p)
 549         ERR_STATE_free(p);
 550 }
 551
 552 static int int_err_get_next_lib(void)
 553 {
 554     int ret;
 555
 556     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 557     ret = int_err_library_number++;
 558     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 559
 560     return ret;
 561 }
 562
 563 #ifndef OPENSSL_NO_ERR
 564 # define NUM_SYS_STR_REASONS 127
 565 # define LEN_SYS_STR_REASON 32
 566
 567 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 568 /*
 569  * SYS_str_reasons is filled with copies of strerror() results at
 570  * initialization. 'errno' values up to 127 should cover all usual errors,
 571  * others will be displayed numerically by ERR_error_string. It is crucial
 572  * that we have something for each reason code that occurs in
 573  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 574  * which always gets an errno value and never one of those 'standard' reason
 575  * codes.
 576  */
 577
 578 static void build_SYS_str_reasons(void)
 579 {
 580     /* OPENSSL_malloc cannot be used here, use static storage instead */
 581     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
 582     int i;
 583     static int init = 1;
 584
 585     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 586     if (!init) {
 587         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 588         return;
 589     }
 590
 591     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 592     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 593     if (!init) {
 594         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 595         return;
 596     }
 597
 598     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 599         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 600
 601         str->error = (unsigned long)i;
 602         if (str->string == NULL) {
 603             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
 604             char *src = strerror(i);
 605             if (src != NULL) {
 606                 strncpy(*dest, src, sizeof(*dest));
 607                 (*dest)[sizeof(*dest) - 1] = '\0';
 608                 str->string = *dest;
 609             }
 610         }
 611         if (str->string == NULL)
 612             str->string = "unknown";
 613     }
 614
 615     /*
 616      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 617      * required by ERR_load_strings.
 618      */
 619
 620     init = 0;
 621
 622     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 623 }
 624 #endif
 625
 626 #define err_clear_data(p,i) \
 627         do { \
 628         if (((p)->err_data[i] != NULL) && \
 629                 (p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
 630                 {  \
 631                 OPENSSL_free((p)->err_data[i]); \
 632                 (p)->err_data[i]=NULL; \
 633                 } \
 634         (p)->err_data_flags[i]=0; \
 635         } while(0)
 636
 637 #define err_clear(p,i) \
 638         do { \
 639         (p)->err_flags[i]=0; \
 640         (p)->err_buffer[i]=0; \
 641         err_clear_data(p,i); \
 642         (p)->err_file[i]=NULL; \
 643         (p)->err_line[i]= -1; \
 644         } while(0)
 645
 646 static void ERR_STATE_free(ERR_STATE *s)
 647 {
 648     int i;
 649
 650     if (s == NULL)
 651         return;
 652
 653     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 654         err_clear_data(s, i);
 655     }
 656     OPENSSL_free(s);
 657 }
 658
 659 void ERR_load_ERR_strings(void)
 660 {
 661     err_fns_check();
 662 #ifndef OPENSSL_NO_ERR
 663     err_load_strings(0, ERR_str_libraries);
 664     err_load_strings(0, ERR_str_reasons);
 665     err_load_strings(ERR_LIB_SYS, ERR_str_functs);
 666     build_SYS_str_reasons();
 667     err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
 668 #endif
 669 }
 670
 671 static void err_load_strings(int lib, ERR_STRING_DATA *str)
 672 {
 673     while (str->error) {
 674         if (lib)
 675             str->error |= ERR_PACK(lib, 0, 0);
 676         ERRFN(err_set_item) (str);
 677         str++;
 678     }
 679 }
 680
 681 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
 682 {
 683     ERR_load_ERR_strings();
 684     err_load_strings(lib, str);
 685 }
 686
 687 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 688 {
 689     while (str->error) {
 690         if (lib)
 691             str->error |= ERR_PACK(lib, 0, 0);
 692         ERRFN(err_del_item) (str);
 693         str++;
 694     }
 695 }
 696
 697 void ERR_free_strings(void)
 698 {
 699     err_fns_check();
 700     ERRFN(err_del) ();
 701 }
 702
 703 /********************************************************/
 704
 705 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 706 {
 707     ERR_STATE *es;
 708
 709 #ifdef _OSD_POSIX
 710     /*
 711      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 712      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 713      * something sensible. @@@ We shouldn't modify a const string, though.
 714      */
 715     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 716         char *end;
 717
 718         /* Skip the "*POSIX(" prefix */
 719         file += sizeof("*POSIX(") - 1;
 720         end = &file[strlen(file) - 1];
 721         if (*end == ')')
 722             *end = '\0';
 723         /* Optional: use the basename of the path only. */
 724         if ((end = strrchr(file, '/')) != NULL)
 725             file = &end[1];
 726     }
 727 #endif
 728     es = ERR_get_state();
 729     if (es == NULL)
 730         return;
 731
 732     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 733     if (es->top == es->bottom)
 734         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 735     es->err_flags[es->top] = 0;
 736     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 737     es->err_file[es->top] = file;
 738     es->err_line[es->top] = line;
 739     err_clear_data(es, es->top);
 740 }
 741
 742 void ERR_clear_error(void)
 743 {
 744     int i;
 745     ERR_STATE *es;
 746
 747     es = ERR_get_state();
 748     if (es == NULL)
 749         return;
 750
 751     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 752         err_clear(es, i);
 753     }
 754     es->top = es->bottom = 0;
 755 }
 756
 757 unsigned long ERR_get_error(void)
 758 {
 759     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
 760 }
 761
 762 unsigned long ERR_get_error_line(const char **file, int *line)
 763 {
 764     return (get_error_values(1, 0, file, line, NULL, NULL));
 765 }
 766
 767 unsigned long ERR_get_error_line_data(const char **file, int *line,
 768                                       const char **data, int *flags)
 769 {
 770     return (get_error_values(1, 0, file, line, data, flags));
 771 }
 772
 773 unsigned long ERR_peek_error(void)
 774 {
 775     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
 776 }
 777
 778 unsigned long ERR_peek_error_line(const char **file, int *line)
 779 {
 780     return (get_error_values(0, 0, file, line, NULL, NULL));
 781 }
 782
 783 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 784                                        const char **data, int *flags)
 785 {
 786     return (get_error_values(0, 0, file, line, data, flags));
 787 }
 788
 789 unsigned long ERR_peek_last_error(void)
 790 {
 791     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
 792 }
 793
 794 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 795 {
 796     return (get_error_values(0, 1, file, line, NULL, NULL));
 797 }
 798
 799 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 800                                             const char **data, int *flags)
 801 {
 802     return (get_error_values(0, 1, file, line, data, flags));
 803 }
 804
 805 static unsigned long get_error_values(int inc, int top, const char **file,
 806                                       int *line, const char **data,
 807                                       int *flags)
 808 {
 809     int i = 0;
 810     ERR_STATE *es;
 811     unsigned long ret;
 812
 813     es = ERR_get_state();
 814     if (es == NULL)
 815         return 0;
 816
 817     if (inc && top) {
 818         if (file)
 819             *file = "";
 820         if (line)
 821             *line = 0;
 822         if (data)
 823             *data = "";
 824         if (flags)
 825             *flags = 0;
 826
 827         return ERR_R_INTERNAL_ERROR;
 828     }
 829
 830     while (es->bottom != es->top) {
 831         if (es->err_flags[es->top] & ERR_FLAG_CLEAR) {
 832             err_clear(es, es->top);
 833             es->top = es->top > 0 ? es->top - 1 : ERR_NUM_ERRORS - 1;
 834             continue;
 835         }
 836         i = (es->bottom + 1) % ERR_NUM_ERRORS;
 837         if (es->err_flags[i] & ERR_FLAG_CLEAR) {
 838             es->bottom = i;
 839             err_clear(es, es->bottom);
 840             continue;
 841         }
 842         break;
 843     }
 844
 845     if (es->bottom == es->top)
 846         return 0;
 847
 848     if (top)
 849         i = es->top;            /* last error */
 850     else
 851         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 852
 853     ret = es->err_buffer[i];
 854     if (inc) {
 855         es->bottom = i;
 856         es->err_buffer[i] = 0;
 857     }
 858
 859     if ((file != NULL) && (line != NULL)) {
 860         if (es->err_file[i] == NULL) {
 861             *file = "NA";
 862             if (line != NULL)
 863                 *line = 0;
 864         } else {
 865             *file = es->err_file[i];
 866             if (line != NULL)
 867                 *line = es->err_line[i];
 868         }
 869     }
 870
 871     if (data == NULL) {
 872         if (inc) {
 873             err_clear_data(es, i);
 874         }
 875     } else {
 876         if (es->err_data[i] == NULL) {
 877             *data = "";
 878             if (flags != NULL)
 879                 *flags = 0;
 880         } else {
 881             *data = es->err_data[i];
 882             if (flags != NULL)
 883                 *flags = es->err_data_flags[i];
 884         }
 885     }
 886     return ret;
 887 }
 888
 889 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 890 {
 891     char lsbuf[64], fsbuf[64], rsbuf[64];
 892     const char *ls, *fs, *rs;
 893     unsigned long l, f, r;
 894
 895     if (len == 0)
 896         return;
 897
 898     l = ERR_GET_LIB(e);
 899     f = ERR_GET_FUNC(e);
 900     r = ERR_GET_REASON(e);
 901
 902     ls = ERR_lib_error_string(e);
 903     fs = ERR_func_error_string(e);
 904     rs = ERR_reason_error_string(e);
 905
 906     if (ls == NULL)
 907         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 908     if (fs == NULL)
 909         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 910     if (rs == NULL)
 911         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 912
 913     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
 914                  fs ? fs : fsbuf, rs ? rs : rsbuf);
 915     if (strlen(buf) == len - 1) {
 916         /*
 917          * output may be truncated; make sure we always have 5
 918          * colon-separated fields, i.e. 4 colons ...
 919          */
 920 #define NUM_COLONS 4
 921         if (len > NUM_COLONS) { /* ... if possible */
 922             int i;
 923             char *s = buf;
 924
 925             for (i = 0; i < NUM_COLONS; i++) {
 926                 char *colon = strchr(s, ':');
 927                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
 928                     /*
 929                      * set colon no. i at last possible position (buf[len-1]
 930                      * is the terminating 0)
 931                      */
 932                     colon = &buf[len - 1] - NUM_COLONS + i;
 933                     *colon = ':';
 934                 }
 935                 s = colon + 1;
 936             }
 937         }
 938     }
 939 }
 940
 941 /* BAD for multi-threading: uses a local buffer if ret == NULL */
 942 /*
 943  * ERR_error_string_n should be used instead for ret != NULL as
 944  * ERR_error_string cannot know how large the buffer is
 945  */
 946 char *ERR_error_string(unsigned long e, char *ret)
 947 {
 948     static char buf[256];
 949
 950     if (ret == NULL)
 951         ret = buf;
 952     ERR_error_string_n(e, ret, 256);
 953
 954     return ret;
 955 }
 956
 957 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
 958 {
 959     err_fns_check();
 960     return ERRFN(err_get) (0);
 961 }
 962
 963 LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void)
 964 {
 965     err_fns_check();
 966     return ERRFN(thread_get) (0);
 967 }
 968
 969 void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash)
 970 {
 971     err_fns_check();
 972     ERRFN(thread_release) (hash);
 973 }
 974
 975 const char *ERR_lib_error_string(unsigned long e)
 976 {
 977     ERR_STRING_DATA d, *p;
 978     unsigned long l;
 979
 980     err_fns_check();
 981     l = ERR_GET_LIB(e);
 982     d.error = ERR_PACK(l, 0, 0);
 983     p = ERRFN(err_get_item) (&d);
 984     return ((p == NULL) ? NULL : p->string);
 985 }
 986
 987 const char *ERR_func_error_string(unsigned long e)
 988 {
 989     ERR_STRING_DATA d, *p;
 990     unsigned long l, f;
 991
 992     err_fns_check();
 993     l = ERR_GET_LIB(e);
 994     f = ERR_GET_FUNC(e);
 995     d.error = ERR_PACK(l, f, 0);
 996     p = ERRFN(err_get_item) (&d);
 997     return ((p == NULL) ? NULL : p->string);
 998 }
 999
1000 const char *ERR_reason_error_string(unsigned long e)
1001 {
1002     ERR_STRING_DATA d, *p = NULL;
1003     unsigned long l, r;
1004
1005     err_fns_check();
1006     l = ERR_GET_LIB(e);
1007     r = ERR_GET_REASON(e);
1008     d.error = ERR_PACK(l, 0, r);
1009     p = ERRFN(err_get_item) (&d);
1010     if (!p) {
1011         d.error = ERR_PACK(0, 0, r);
1012         p = ERRFN(err_get_item) (&d);
1013     }
1014     return ((p == NULL) ? NULL : p->string);
1015 }
1016
1017 void ERR_remove_thread_state(const CRYPTO_THREADID *id)
1018 {
1019     ERR_STATE tmp;
1020
1021     if (id)
1022         CRYPTO_THREADID_cpy(&tmp.tid, id);
1023     else
1024         CRYPTO_THREADID_current(&tmp.tid);
1025     err_fns_check();
1026     /*
1027      * thread_del_item automatically destroys the LHASH if the number of
1028      * items reaches zero.
1029      */
1030     ERRFN(thread_del_item) (&tmp);
1031 }
1032
1033 #ifndef OPENSSL_NO_DEPRECATED
1034 void ERR_remove_state(unsigned long pid)
1035 {
1036     ERR_remove_thread_state(NULL);
1037 }
1038 #endif
1039
1040 ERR_STATE *ERR_get_state(void)
1041 {
1042     ERR_STATE *ret, tmp, *tmpp = NULL;
1043     int i;
1044     CRYPTO_THREADID tid;
1045
1046     err_fns_check();
1047     CRYPTO_THREADID_current(&tid);
1048     CRYPTO_THREADID_cpy(&tmp.tid, &tid);
1049     ret = ERRFN(thread_get_item) (&tmp);
1050
1051     /* ret == the error state, if NULL, make a new one */
1052     if (ret == NULL) {
1053         ret = (ERR_STATE *)OPENSSL_malloc(sizeof(ERR_STATE));
1054         if (ret == NULL)
1055             return NULL;
1056         CRYPTO_THREADID_cpy(&ret->tid, &tid);
1057         ret->top = 0;
1058         ret->bottom = 0;
1059         for (i = 0; i < ERR_NUM_ERRORS; i++) {
1060             ret->err_data[i] = NULL;
1061             ret->err_data_flags[i] = 0;
1062         }
1063         tmpp = ERRFN(thread_set_item) (ret);
1064         /* To check if insertion failed, do a get. */
1065         if (ERRFN(thread_get_item) (ret) != ret) {
1066             ERR_STATE_free(ret); /* could not insert it */
1067             return NULL;
1068         }
1069         /*
1070          * If a race occured in this function and we came second, tmpp is the
1071          * first one that we just replaced.
1072          */
1073         if (tmpp)
1074             ERR_STATE_free(tmpp);
1075     }
1076     return ret;
1077 }
1078
1079 int ERR_get_next_error_library(void)
1080 {
1081     err_fns_check();
1082     return ERRFN(get_next_lib) ();
1083 }
1084
1085 void ERR_set_error_data(char *data, int flags)
1086 {
1087     ERR_STATE *es;
1088     int i;
1089
1090     es = ERR_get_state();
1091     if (es == NULL)
1092         return;
1093
1094     i = es->top;
1095
1096     err_clear_data(es, i);
1097     es->err_data[i] = data;
1098     es->err_data_flags[i] = flags;
1099 }
1100
1101 void ERR_add_error_data(int num, ...)
1102 {
1103     va_list args;
1104     va_start(args, num);
1105     ERR_add_error_vdata(num, args);
1106     va_end(args);
1107 }
1108
1109 void ERR_add_error_vdata(int num, va_list args)
1110 {
1111     int i, n, s;
1112     char *str, *p, *a;
1113
1114     s = 80;
1115     str = OPENSSL_malloc(s + 1);
1116     if (str == NULL)
1117         return;
1118     str[0] = '\0';
1119
1120     n = 0;
1121     for (i = 0; i < num; i++) {
1122         a = va_arg(args, char *);
1123         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
1124         if (a != NULL) {
1125             n += strlen(a);
1126             if (n > s) {
1127                 s = n + 20;
1128                 p = OPENSSL_realloc(str, s + 1);
1129                 if (p == NULL) {
1130                     OPENSSL_free(str);
1131                     return;
1132                 } else
1133                     str = p;
1134             }
1135             BUF_strlcat(str, a, (size_t)s + 1);
1136         }
1137     }
1138     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
1139 }
1140
1141 int ERR_set_mark(void)
1142 {
1143     ERR_STATE *es;
1144
1145     es = ERR_get_state();
1146     if (es == NULL)
1147         return 0;
1148
1149     if (es->bottom == es->top)
1150         return 0;
1151     es->err_flags[es->top] |= ERR_FLAG_MARK;
1152     return 1;
1153 }
1154
1155 int ERR_pop_to_mark(void)
1156 {
1157     ERR_STATE *es;
1158
1159     es = ERR_get_state();
1160     if (es == NULL)
1161         return 0;
1162
1163     while (es->bottom != es->top
1164            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
1165         err_clear(es, es->top);
1166         es->top -= 1;
1167         if (es->top == -1)
1168             es->top = ERR_NUM_ERRORS - 1;
1169     }
1170
1171     if (es->bottom == es->top)
1172         return 0;
1173     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
1174     return 1;
1175 }
1176
1177 void err_clear_last_constant_time(int clear)
1178 {
1179     ERR_STATE *es;
1180     int top;
1181
1182     es = ERR_get_state();
1183     if (es == NULL)
1184         return;
1185
1186     top = es->top;
1187
1188     /*
1189      * Flag error as cleared but remove it elsewhere to avoid two errors
1190      * accessing the same error stack location, revealing timing information.
1191      */
1192     clear = constant_time_select_int(constant_time_eq_int(clear, 0),
1193                                      0, ERR_FLAG_CLEAR);
1194     es->err_flags[top] |= clear;
1195 }