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