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