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