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 "internal/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     {ERR_PACK(ERR_LIB_ASYNC, 0, 0), "ASYNC routines"},
 161     {0, NULL},
 162 };
 163
 164 static ERR_STRING_DATA ERR_str_functs[] = {
 165     {ERR_PACK(0, SYS_F_FOPEN, 0), "fopen"},
 166     {ERR_PACK(0, SYS_F_CONNECT, 0), "connect"},
 167     {ERR_PACK(0, SYS_F_GETSERVBYNAME, 0), "getservbyname"},
 168     {ERR_PACK(0, SYS_F_SOCKET, 0), "socket"},
 169     {ERR_PACK(0, SYS_F_IOCTLSOCKET, 0), "ioctlsocket"},
 170     {ERR_PACK(0, SYS_F_BIND, 0), "bind"},
 171     {ERR_PACK(0, SYS_F_LISTEN, 0), "listen"},
 172     {ERR_PACK(0, SYS_F_ACCEPT, 0), "accept"},
 173 # ifdef OPENSSL_SYS_WINDOWS
 174     {ERR_PACK(0, SYS_F_WSASTARTUP, 0), "WSAstartup"},
 175 # endif
 176     {ERR_PACK(0, SYS_F_OPENDIR, 0), "opendir"},
 177     {ERR_PACK(0, SYS_F_FREAD, 0), "fread"},
 178     {0, NULL},
 179 };
 180
 181 static ERR_STRING_DATA ERR_str_reasons[] = {
 182     {ERR_R_SYS_LIB, "system lib"},
 183     {ERR_R_BN_LIB, "BN lib"},
 184     {ERR_R_RSA_LIB, "RSA lib"},
 185     {ERR_R_DH_LIB, "DH lib"},
 186     {ERR_R_EVP_LIB, "EVP lib"},
 187     {ERR_R_BUF_LIB, "BUF lib"},
 188     {ERR_R_OBJ_LIB, "OBJ lib"},
 189     {ERR_R_PEM_LIB, "PEM lib"},
 190     {ERR_R_DSA_LIB, "DSA lib"},
 191     {ERR_R_X509_LIB, "X509 lib"},
 192     {ERR_R_ASN1_LIB, "ASN1 lib"},
 193     {ERR_R_CONF_LIB, "CONF lib"},
 194     {ERR_R_CRYPTO_LIB, "CRYPTO lib"},
 195     {ERR_R_EC_LIB, "EC lib"},
 196     {ERR_R_SSL_LIB, "SSL lib"},
 197     {ERR_R_BIO_LIB, "BIO lib"},
 198     {ERR_R_PKCS7_LIB, "PKCS7 lib"},
 199     {ERR_R_X509V3_LIB, "X509V3 lib"},
 200     {ERR_R_PKCS12_LIB, "PKCS12 lib"},
 201     {ERR_R_RAND_LIB, "RAND lib"},
 202     {ERR_R_DSO_LIB, "DSO lib"},
 203     {ERR_R_ENGINE_LIB, "ENGINE lib"},
 204     {ERR_R_OCSP_LIB, "OCSP lib"},
 205     {ERR_R_TS_LIB, "TS lib"},
 206     {ERR_R_ECDSA_LIB, "ECDSA lib"},
 207
 208     {ERR_R_NESTED_ASN1_ERROR, "nested asn1 error"},
 209     {ERR_R_BAD_ASN1_OBJECT_HEADER, "bad asn1 object header"},
 210     {ERR_R_BAD_GET_ASN1_OBJECT_CALL, "bad get asn1 object call"},
 211     {ERR_R_EXPECTING_AN_ASN1_SEQUENCE, "expecting an asn1 sequence"},
 212     {ERR_R_ASN1_LENGTH_MISMATCH, "asn1 length mismatch"},
 213     {ERR_R_MISSING_ASN1_EOS, "missing asn1 eos"},
 214
 215     {ERR_R_FATAL, "fatal"},
 216     {ERR_R_MALLOC_FAILURE, "malloc failure"},
 217     {ERR_R_SHOULD_NOT_HAVE_BEEN_CALLED,
 218      "called a function you should not call"},
 219     {ERR_R_PASSED_NULL_PARAMETER, "passed a null parameter"},
 220     {ERR_R_INTERNAL_ERROR, "internal error"},
 221     {ERR_R_DISABLED, "called a function that was disabled at compile-time"},
 222
 223     {0, NULL},
 224 };
 225 #endif
 226
 227 /* Predeclarations of the "err_defaults" functions */
 228 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit);
 229 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *);
 230 static LHASH_OF(ERR_STATE) *int_thread_get(int create, int lockit);
 231 static void int_thread_release(LHASH_OF(ERR_STATE) **hash);
 232 static ERR_STATE *int_thread_get_item(const ERR_STATE *);
 233 static ERR_STATE *int_thread_set_item(ERR_STATE *);
 234 static void int_thread_del_item(const ERR_STATE *);
 235
 236 /*
 237  * The internal state
 238  */
 239 static LHASH_OF(ERR_STRING_DATA) *int_error_hash = NULL;
 240 static LHASH_OF(ERR_STATE) *int_thread_hash = NULL;
 241 static int int_thread_hash_references = 0;
 242 static int int_err_library_number = ERR_LIB_USER;
 243
 244 /*
 245  * These are the callbacks provided to "lh_new()" when creating the LHASH
 246  * tables internal to the "err_defaults" implementation.
 247  */
 248
 249 static unsigned long get_error_values(int inc, int top, const char **file,
 250                                       int *line, const char **data,
 251                                       int *flags);
 252
 253 static unsigned long err_string_data_hash(const ERR_STRING_DATA *a)
 254 {
 255     unsigned long ret, l;
 256
 257     l = a->error;
 258     ret = l ^ ERR_GET_LIB(l) ^ ERR_GET_FUNC(l);
 259     return (ret ^ ret % 19 * 13);
 260 }
 261
 262 static IMPLEMENT_LHASH_HASH_FN(err_string_data, ERR_STRING_DATA)
 263
 264 static int err_string_data_cmp(const ERR_STRING_DATA *a,
 265                                const ERR_STRING_DATA *b)
 266 {
 267     return (int)(a->error - b->error);
 268 }
 269
 270 static IMPLEMENT_LHASH_COMP_FN(err_string_data, ERR_STRING_DATA)
 271
 272 static LHASH_OF(ERR_STRING_DATA) *get_hash(int create, int lockit)
 273 {
 274     LHASH_OF(ERR_STRING_DATA) *ret = NULL;
 275
 276     if (lockit)
 277         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 278     if (!int_error_hash && create) {
 279         int_error_hash = lh_ERR_STRING_DATA_new();
 280     }
 281     if (int_error_hash != NULL)
 282         ret = int_error_hash;
 283     if (lockit)
 284         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 285
 286     return ret;
 287 }
 288
 289 static ERR_STRING_DATA *int_err_get_item(const ERR_STRING_DATA *d)
 290 {
 291     ERR_STRING_DATA *p = NULL;
 292     LHASH_OF(ERR_STRING_DATA) *hash;
 293
 294     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 295     hash = get_hash(0, 0);
 296     if (hash)
 297         p = lh_ERR_STRING_DATA_retrieve(hash, d);
 298     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 299
 300     return p;
 301 }
 302
 303 static unsigned long err_state_hash(const ERR_STATE *a)
 304 {
 305     return CRYPTO_THREADID_hash(&a->tid) * 13;
 306 }
 307
 308 static IMPLEMENT_LHASH_HASH_FN(err_state, ERR_STATE)
 309
 310 static int err_state_cmp(const ERR_STATE *a, const ERR_STATE *b)
 311 {
 312     return CRYPTO_THREADID_cmp(&a->tid, &b->tid);
 313 }
 314
 315 static IMPLEMENT_LHASH_COMP_FN(err_state, ERR_STATE)
 316
 317 static LHASH_OF(ERR_STATE) *int_thread_get(int create, int lockit)
 318 {
 319     LHASH_OF(ERR_STATE) *ret = NULL;
 320
 321     if (lockit)
 322         CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 323     if (!int_thread_hash && create) {
 324         int_thread_hash = lh_ERR_STATE_new();
 325     }
 326     if (int_thread_hash != NULL) {
 327         int_thread_hash_references++;
 328         ret = int_thread_hash;
 329     }
 330     if (lockit)
 331         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 332     return ret;
 333 }
 334
 335 static void int_thread_release(LHASH_OF(ERR_STATE) **hash)
 336 {
 337     int i;
 338
 339     if (hash == NULL || *hash == NULL)
 340         return;
 341
 342     i = CRYPTO_add(&int_thread_hash_references, -1, CRYPTO_LOCK_ERR);
 343
 344 #ifdef REF_PRINT
 345     fprintf(stderr, "%4d:%s\n", int_thread_hash_references, "ERR");
 346 #endif
 347     if (i > 0)
 348         return;
 349 #ifdef REF_CHECK
 350     if (i < 0) {
 351         fprintf(stderr, "int_thread_release, bad reference count\n");
 352         abort();                /* ok */
 353     }
 354 #endif
 355     *hash = NULL;
 356 }
 357
 358 static ERR_STATE *int_thread_get_item(const ERR_STATE *d)
 359 {
 360     ERR_STATE *p = NULL;
 361     LHASH_OF(ERR_STATE) *hash;
 362
 363     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 364     hash = int_thread_get(0, 0);
 365     if (hash)
 366         p = lh_ERR_STATE_retrieve(hash, d);
 367     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 368
 369     int_thread_release(&hash);
 370     return p;
 371 }
 372
 373 static ERR_STATE *int_thread_set_item(ERR_STATE *d)
 374 {
 375     ERR_STATE *p = NULL;
 376     LHASH_OF(ERR_STATE) *hash;
 377
 378     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 379     hash = int_thread_get(1, 0);
 380     if (hash)
 381         p = lh_ERR_STATE_insert(hash, d);
 382     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 383
 384     int_thread_release(&hash);
 385     return p;
 386 }
 387
 388 static void int_thread_del_item(const ERR_STATE *d)
 389 {
 390     ERR_STATE *p = NULL;
 391     LHASH_OF(ERR_STATE) *hash;
 392
 393     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 394     hash = int_thread_get(0, 0);
 395     if (hash) {
 396         p = lh_ERR_STATE_delete(hash, d);
 397         /* If there are no other references, and we just removed the
 398          * last item, delete the int_thread_hash */
 399         if (int_thread_hash_references == 1
 400             && int_thread_hash
 401             && lh_ERR_STATE_num_items(int_thread_hash) == 0) {
 402             int_thread_hash_references = 0;
 403             lh_ERR_STATE_free(int_thread_hash);
 404             int_thread_hash = NULL;
 405             hash = NULL;
 406         }
 407     }
 408     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 409
 410     int_thread_release(&hash);
 411     ERR_STATE_free(p);
 412 }
 413
 414 #ifndef OPENSSL_NO_ERR
 415 # define NUM_SYS_STR_REASONS 127
 416 # define LEN_SYS_STR_REASON 32
 417
 418 static ERR_STRING_DATA SYS_str_reasons[NUM_SYS_STR_REASONS + 1];
 419 /*
 420  * SYS_str_reasons is filled with copies of strerror() results at
 421  * initialization. 'errno' values up to 127 should cover all usual errors,
 422  * others will be displayed numerically by ERR_error_string. It is crucial
 423  * that we have something for each reason code that occurs in
 424  * ERR_str_reasons, or bogus reason strings will be returned for SYSerr(),
 425  * which always gets an errno value and never one of those 'standard' reason
 426  * codes.
 427  */
 428
 429 static void build_SYS_str_reasons(void)
 430 {
 431     /* OPENSSL_malloc cannot be used here, use static storage instead */
 432     static char strerror_tab[NUM_SYS_STR_REASONS][LEN_SYS_STR_REASON];
 433     static int init = 1;
 434     int i;
 435
 436     CRYPTO_r_lock(CRYPTO_LOCK_ERR);
 437     if (!init) {
 438         CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 439         return;
 440     }
 441
 442     CRYPTO_r_unlock(CRYPTO_LOCK_ERR);
 443     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 444     if (!init) {
 445         CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 446         return;
 447     }
 448
 449     for (i = 1; i <= NUM_SYS_STR_REASONS; i++) {
 450         ERR_STRING_DATA *str = &SYS_str_reasons[i - 1];
 451
 452         str->error = (unsigned long)i;
 453         if (str->string == NULL) {
 454             char (*dest)[LEN_SYS_STR_REASON] = &(strerror_tab[i - 1]);
 455             char *src = strerror(i);
 456             if (src != NULL) {
 457                 strncpy(*dest, src, sizeof(*dest));
 458                 (*dest)[sizeof(*dest) - 1] = '\0';
 459                 str->string = *dest;
 460             }
 461         }
 462         if (str->string == NULL)
 463             str->string = "unknown";
 464     }
 465
 466     /*
 467      * Now we still have SYS_str_reasons[NUM_SYS_STR_REASONS] = {0, NULL}, as
 468      * required by ERR_load_strings.
 469      */
 470
 471     init = 0;
 472
 473     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 474 }
 475 #endif
 476
 477 #define err_clear_data(p,i) \
 478         do { \
 479         if ((p)->err_data_flags[i] & ERR_TXT_MALLOCED) \
 480                 {  \
 481                 OPENSSL_free((p)->err_data[i]); \
 482                 (p)->err_data[i]=NULL; \
 483                 } \
 484         (p)->err_data_flags[i]=0; \
 485         } while(0)
 486
 487 #define err_clear(p,i) \
 488         do { \
 489         (p)->err_flags[i]=0; \
 490         (p)->err_buffer[i]=0; \
 491         err_clear_data(p,i); \
 492         (p)->err_file[i]=NULL; \
 493         (p)->err_line[i]= -1; \
 494         } while(0)
 495
 496 static void ERR_STATE_free(ERR_STATE *s)
 497 {
 498     int i;
 499
 500     if (s == NULL)
 501         return;
 502
 503     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 504         err_clear_data(s, i);
 505     }
 506     OPENSSL_free(s);
 507 }
 508
 509 void ERR_load_ERR_strings(void)
 510 {
 511 #ifndef OPENSSL_NO_ERR
 512     err_load_strings(0, ERR_str_libraries);
 513     err_load_strings(0, ERR_str_reasons);
 514     err_load_strings(ERR_LIB_SYS, ERR_str_functs);
 515     build_SYS_str_reasons();
 516     err_load_strings(ERR_LIB_SYS, SYS_str_reasons);
 517 #endif
 518 }
 519
 520 static void err_load_strings(int lib, ERR_STRING_DATA *str)
 521 {
 522     LHASH_OF(ERR_STRING_DATA) *hash;
 523
 524     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 525     hash = get_hash(1, 0);
 526     if (hash) {
 527         for (; str->error; str++) {
 528             if (lib)
 529                 str->error |= ERR_PACK(lib, 0, 0);
 530             (void)lh_ERR_STRING_DATA_insert(hash, str);
 531         }
 532     }
 533     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 534 }
 535
 536 void ERR_load_strings(int lib, ERR_STRING_DATA *str)
 537 {
 538     ERR_load_ERR_strings();
 539     err_load_strings(lib, str);
 540 }
 541
 542 void ERR_unload_strings(int lib, ERR_STRING_DATA *str)
 543 {
 544     LHASH_OF(ERR_STRING_DATA) *hash;
 545
 546     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 547     hash = get_hash(0, 0);
 548     if (hash) {
 549         for (; str->error; str++) {
 550             if (lib)
 551                 str->error |= ERR_PACK(lib, 0, 0);
 552             (void)lh_ERR_STRING_DATA_delete(hash, str);
 553         }
 554     }
 555     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 556 }
 557
 558 void ERR_free_strings(void)
 559 {
 560     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 561     lh_ERR_STRING_DATA_free(int_error_hash);
 562     int_error_hash = NULL;
 563     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 564 }
 565
 566 /********************************************************/
 567
 568 void ERR_put_error(int lib, int func, int reason, const char *file, int line)
 569 {
 570     ERR_STATE *es;
 571
 572 #ifdef _OSD_POSIX
 573     /*
 574      * In the BS2000-OSD POSIX subsystem, the compiler generates path names
 575      * in the form "*POSIX(/etc/passwd)". This dirty hack strips them to
 576      * something sensible. @@@ We shouldn't modify a const string, though.
 577      */
 578     if (strncmp(file, "*POSIX(", sizeof("*POSIX(") - 1) == 0) {
 579         char *end;
 580
 581         /* Skip the "*POSIX(" prefix */
 582         file += sizeof("*POSIX(") - 1;
 583         end = &file[strlen(file) - 1];
 584         if (*end == ')')
 585             *end = '\0';
 586         /* Optional: use the basename of the path only. */
 587         if ((end = strrchr(file, '/')) != NULL)
 588             file = &end[1];
 589     }
 590 #endif
 591     es = ERR_get_state();
 592
 593     es->top = (es->top + 1) % ERR_NUM_ERRORS;
 594     if (es->top == es->bottom)
 595         es->bottom = (es->bottom + 1) % ERR_NUM_ERRORS;
 596     es->err_flags[es->top] = 0;
 597     es->err_buffer[es->top] = ERR_PACK(lib, func, reason);
 598     es->err_file[es->top] = file;
 599     es->err_line[es->top] = line;
 600     err_clear_data(es, es->top);
 601 }
 602
 603 void ERR_clear_error(void)
 604 {
 605     int i;
 606     ERR_STATE *es;
 607
 608     es = ERR_get_state();
 609
 610     for (i = 0; i < ERR_NUM_ERRORS; i++) {
 611         err_clear(es, i);
 612     }
 613     es->top = es->bottom = 0;
 614 }
 615
 616 unsigned long ERR_get_error(void)
 617 {
 618     return (get_error_values(1, 0, NULL, NULL, NULL, NULL));
 619 }
 620
 621 unsigned long ERR_get_error_line(const char **file, int *line)
 622 {
 623     return (get_error_values(1, 0, file, line, NULL, NULL));
 624 }
 625
 626 unsigned long ERR_get_error_line_data(const char **file, int *line,
 627                                       const char **data, int *flags)
 628 {
 629     return (get_error_values(1, 0, file, line, data, flags));
 630 }
 631
 632 unsigned long ERR_peek_error(void)
 633 {
 634     return (get_error_values(0, 0, NULL, NULL, NULL, NULL));
 635 }
 636
 637 unsigned long ERR_peek_error_line(const char **file, int *line)
 638 {
 639     return (get_error_values(0, 0, file, line, NULL, NULL));
 640 }
 641
 642 unsigned long ERR_peek_error_line_data(const char **file, int *line,
 643                                        const char **data, int *flags)
 644 {
 645     return (get_error_values(0, 0, file, line, data, flags));
 646 }
 647
 648 unsigned long ERR_peek_last_error(void)
 649 {
 650     return (get_error_values(0, 1, NULL, NULL, NULL, NULL));
 651 }
 652
 653 unsigned long ERR_peek_last_error_line(const char **file, int *line)
 654 {
 655     return (get_error_values(0, 1, file, line, NULL, NULL));
 656 }
 657
 658 unsigned long ERR_peek_last_error_line_data(const char **file, int *line,
 659                                             const char **data, int *flags)
 660 {
 661     return (get_error_values(0, 1, file, line, data, flags));
 662 }
 663
 664 static unsigned long get_error_values(int inc, int top, const char **file,
 665                                       int *line, const char **data,
 666                                       int *flags)
 667 {
 668     int i = 0;
 669     ERR_STATE *es;
 670     unsigned long ret;
 671
 672     es = ERR_get_state();
 673
 674     if (inc && top) {
 675         if (file)
 676             *file = "";
 677         if (line)
 678             *line = 0;
 679         if (data)
 680             *data = "";
 681         if (flags)
 682             *flags = 0;
 683
 684         return ERR_R_INTERNAL_ERROR;
 685     }
 686
 687     if (es->bottom == es->top)
 688         return 0;
 689     if (top)
 690         i = es->top;            /* last error */
 691     else
 692         i = (es->bottom + 1) % ERR_NUM_ERRORS; /* first error */
 693
 694     ret = es->err_buffer[i];
 695     if (inc) {
 696         es->bottom = i;
 697         es->err_buffer[i] = 0;
 698     }
 699
 700     if ((file != NULL) && (line != NULL)) {
 701         if (es->err_file[i] == NULL) {
 702             *file = "NA";
 703             if (line != NULL)
 704                 *line = 0;
 705         } else {
 706             *file = es->err_file[i];
 707             if (line != NULL)
 708                 *line = es->err_line[i];
 709         }
 710     }
 711
 712     if (data == NULL) {
 713         if (inc) {
 714             err_clear_data(es, i);
 715         }
 716     } else {
 717         if (es->err_data[i] == NULL) {
 718             *data = "";
 719             if (flags != NULL)
 720                 *flags = 0;
 721         } else {
 722             *data = es->err_data[i];
 723             if (flags != NULL)
 724                 *flags = es->err_data_flags[i];
 725         }
 726     }
 727     return ret;
 728 }
 729
 730 void ERR_error_string_n(unsigned long e, char *buf, size_t len)
 731 {
 732     char lsbuf[64], fsbuf[64], rsbuf[64];
 733     const char *ls, *fs, *rs;
 734     unsigned long l, f, r;
 735
 736     l = ERR_GET_LIB(e);
 737     f = ERR_GET_FUNC(e);
 738     r = ERR_GET_REASON(e);
 739
 740     ls = ERR_lib_error_string(e);
 741     fs = ERR_func_error_string(e);
 742     rs = ERR_reason_error_string(e);
 743
 744     if (ls == NULL)
 745         BIO_snprintf(lsbuf, sizeof(lsbuf), "lib(%lu)", l);
 746     if (fs == NULL)
 747         BIO_snprintf(fsbuf, sizeof(fsbuf), "func(%lu)", f);
 748     if (rs == NULL)
 749         BIO_snprintf(rsbuf, sizeof(rsbuf), "reason(%lu)", r);
 750
 751     BIO_snprintf(buf, len, "error:%08lX:%s:%s:%s", e, ls ? ls : lsbuf,
 752                  fs ? fs : fsbuf, rs ? rs : rsbuf);
 753     if (strlen(buf) == len - 1) {
 754         /*
 755          * output may be truncated; make sure we always have 5
 756          * colon-separated fields, i.e. 4 colons ...
 757          */
 758 #define NUM_COLONS 4
 759         if (len > NUM_COLONS) { /* ... if possible */
 760             int i;
 761             char *s = buf;
 762
 763             for (i = 0; i < NUM_COLONS; i++) {
 764                 char *colon = strchr(s, ':');
 765                 if (colon == NULL || colon > &buf[len - 1] - NUM_COLONS + i) {
 766                     /*
 767                      * set colon no. i at last possible position (buf[len-1]
 768                      * is the terminating 0)
 769                      */
 770                     colon = &buf[len - 1] - NUM_COLONS + i;
 771                     *colon = ':';
 772                 }
 773                 s = colon + 1;
 774             }
 775         }
 776     }
 777 }
 778
 779 /* BAD for multi-threading: uses a local buffer if ret == NULL */
 780 /*
 781  * ERR_error_string_n should be used instead for ret != NULL as
 782  * ERR_error_string cannot know how large the buffer is
 783  */
 784 char *ERR_error_string(unsigned long e, char *ret)
 785 {
 786     static char buf[256];
 787
 788     if (ret == NULL)
 789         ret = buf;
 790     ERR_error_string_n(e, ret, 256);
 791
 792     return ret;
 793 }
 794
 795 LHASH_OF(ERR_STRING_DATA) *ERR_get_string_table(void)
 796 {
 797     return get_hash(0, 1);
 798 }
 799
 800 LHASH_OF(ERR_STATE) *ERR_get_err_state_table(void)
 801 {
 802     return int_thread_get(0, 1);
 803 }
 804
 805 void ERR_release_err_state_table(LHASH_OF(ERR_STATE) **hash)
 806 {
 807     int_thread_release(hash);
 808 }
 809
 810 const char *ERR_lib_error_string(unsigned long e)
 811 {
 812     ERR_STRING_DATA d, *p;
 813     unsigned long l;
 814
 815     l = ERR_GET_LIB(e);
 816     d.error = ERR_PACK(l, 0, 0);
 817     p = int_err_get_item(&d);
 818     return ((p == NULL) ? NULL : p->string);
 819 }
 820
 821 const char *ERR_func_error_string(unsigned long e)
 822 {
 823     ERR_STRING_DATA d, *p;
 824     unsigned long l, f;
 825
 826     l = ERR_GET_LIB(e);
 827     f = ERR_GET_FUNC(e);
 828     d.error = ERR_PACK(l, f, 0);
 829     p = int_err_get_item(&d);
 830     return ((p == NULL) ? NULL : p->string);
 831 }
 832
 833 const char *ERR_reason_error_string(unsigned long e)
 834 {
 835     ERR_STRING_DATA d, *p = NULL;
 836     unsigned long l, r;
 837
 838     l = ERR_GET_LIB(e);
 839     r = ERR_GET_REASON(e);
 840     d.error = ERR_PACK(l, 0, r);
 841     p = int_err_get_item(&d);
 842     if (!p) {
 843         d.error = ERR_PACK(0, 0, r);
 844         p = int_err_get_item(&d);
 845     }
 846     return ((p == NULL) ? NULL : p->string);
 847 }
 848
 849 void ERR_remove_thread_state(const CRYPTO_THREADID *id)
 850 {
 851     ERR_STATE tmp;
 852
 853     if (id)
 854         CRYPTO_THREADID_cpy(&tmp.tid, id);
 855     else
 856         CRYPTO_THREADID_current(&tmp.tid);
 857     /*
 858      * thread_del_item automatically destroys the LHASH if the number of
 859      * items reaches zero.
 860      */
 861     int_thread_del_item(&tmp);
 862 }
 863
 864 #ifndef OPENSSL_NO_DEPRECATED
 865 void ERR_remove_state(unsigned long pid)
 866 {
 867     ERR_remove_thread_state(NULL);
 868 }
 869 #endif
 870
 871 ERR_STATE *ERR_get_state(void)
 872 {
 873     static ERR_STATE fallback;
 874     ERR_STATE *ret, tmp, *tmpp = NULL;
 875     int i;
 876     CRYPTO_THREADID tid;
 877
 878     CRYPTO_THREADID_current(&tid);
 879     CRYPTO_THREADID_cpy(&tmp.tid, &tid);
 880     ret = int_thread_get_item(&tmp);
 881
 882     /* ret == the error state, if NULL, make a new one */
 883     if (ret == NULL) {
 884         ret = OPENSSL_malloc(sizeof(*ret));
 885         if (ret == NULL)
 886             return (&fallback);
 887         CRYPTO_THREADID_cpy(&ret->tid, &tid);
 888         ret->top = 0;
 889         ret->bottom = 0;
 890         for (i = 0; i < ERR_NUM_ERRORS; i++) {
 891             ret->err_data[i] = NULL;
 892             ret->err_data_flags[i] = 0;
 893         }
 894         tmpp = int_thread_set_item(ret);
 895         /* To check if insertion failed, do a get. */
 896         if (int_thread_get_item(ret) != ret) {
 897             ERR_STATE_free(ret); /* could not insert it */
 898             return (&fallback);
 899         }
 900         /*
 901          * If a race occurred in this function and we came second, tmpp is
 902          * the first one that we just replaced.
 903          */
 904         ERR_STATE_free(tmpp);
 905     }
 906     return ret;
 907 }
 908
 909 int ERR_get_next_error_library(void)
 910 {
 911     int ret;
 912
 913     CRYPTO_w_lock(CRYPTO_LOCK_ERR);
 914     ret = int_err_library_number++;
 915     CRYPTO_w_unlock(CRYPTO_LOCK_ERR);
 916     return ret;
 917 }
 918
 919 void ERR_set_error_data(char *data, int flags)
 920 {
 921     ERR_STATE *es;
 922     int i;
 923
 924     es = ERR_get_state();
 925
 926     i = es->top;
 927     if (i == 0)
 928         i = ERR_NUM_ERRORS - 1;
 929
 930     err_clear_data(es, i);
 931     es->err_data[i] = data;
 932     es->err_data_flags[i] = flags;
 933 }
 934
 935 void ERR_add_error_data(int num, ...)
 936 {
 937     va_list args;
 938     va_start(args, num);
 939     ERR_add_error_vdata(num, args);
 940     va_end(args);
 941 }
 942
 943 void ERR_add_error_vdata(int num, va_list args)
 944 {
 945     int i, n, s;
 946     char *str, *p, *a;
 947
 948     s = 80;
 949     str = OPENSSL_malloc(s + 1);
 950     if (str == NULL)
 951         return;
 952     str[0] = '\0';
 953
 954     n = 0;
 955     for (i = 0; i < num; i++) {
 956         a = va_arg(args, char *);
 957         /* ignore NULLs, thanks to Bob Beck <beck@obtuse.com> */
 958         if (a != NULL) {
 959             n += strlen(a);
 960             if (n > s) {
 961                 s = n + 20;
 962                 p = OPENSSL_realloc(str, s + 1);
 963                 if (p == NULL) {
 964                     OPENSSL_free(str);
 965                     return;
 966                 }
 967                 str = p;
 968             }
 969             OPENSSL_strlcat(str, a, (size_t)s + 1);
 970         }
 971     }
 972     ERR_set_error_data(str, ERR_TXT_MALLOCED | ERR_TXT_STRING);
 973 }
 974
 975 int ERR_set_mark(void)
 976 {
 977     ERR_STATE *es;
 978
 979     es = ERR_get_state();
 980
 981     if (es->bottom == es->top)
 982         return 0;
 983     es->err_flags[es->top] |= ERR_FLAG_MARK;
 984     return 1;
 985 }
 986
 987 int ERR_pop_to_mark(void)
 988 {
 989     ERR_STATE *es;
 990
 991     es = ERR_get_state();
 992
 993     while (es->bottom != es->top
 994            && (es->err_flags[es->top] & ERR_FLAG_MARK) == 0) {
 995         err_clear(es, es->top);
 996         es->top -= 1;
 997         if (es->top == -1)
 998             es->top = ERR_NUM_ERRORS - 1;
 999     }
1000
1001     if (es->bottom == es->top)
1002         return 0;
1003     es->err_flags[es->top] &= ~ERR_FLAG_MARK;
1004     return 1;
1005 }