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