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