crypto/err/err.c

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