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