crypto/err/err.c

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