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