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