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