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