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