crypto/err/err.c

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